https://github.com/victorshinya/instance-scheduler
IBM Cloud Virtual Server Instance scheduler to power off and power on automatically.
https://github.com/victorshinya/instance-scheduler
ibm-cloud instance-scheduler power-off power-on serverless serverless-functions softlayer
Last synced: 8 months ago
JSON representation
IBM Cloud Virtual Server Instance scheduler to power off and power on automatically.
- Host: GitHub
- URL: https://github.com/victorshinya/instance-scheduler
- Owner: victorshinya
- License: apache-2.0
- Created: 2020-08-26T03:05:07.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-10-06T23:37:37.000Z (over 4 years ago)
- Last Synced: 2025-01-09T07:49:19.741Z (about 1 year ago)
- Topics: ibm-cloud, instance-scheduler, power-off, power-on, serverless, serverless-functions, softlayer
- Language: Go
- Homepage:
- Size: 562 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IBM Cloud Instance Scheduler
[](https://cloud.ibm.com)
[](https://developer.ibm.com/?s=golang/)
[](https://goreportcard.com/report/github.com/victorshinya/instance-scheduler)
[](https://github.com/victorshinya/instance-scheduler/blob/master/LICENSE)
[](https://github.com/victorshinya/instance-scheduler/pulls)
A Serverless function to automatically start and stop IBM Cloud Virtual Server Instances.
## Deploy to IBM Cloud
Before you get started, you need to install [IBM Cloud CLI](https://cloud.ibm.com/docs/cli/reference/ibmcloud/download_cli.html#install_use) and [IBM Cloud Functions CLI](https://cloud.ibm.com/openwhisk/learn/cli) in your local machine. Then, you need to login in your IBM Cloud account on IBM Cloud CLI (if you haven't already done, run `ibmcloud login`).
### 1. Clone the repository
Download the source code from Github and access the project folder.
```sh
git clone https://github.com/victorshinya/instance-scheduler.git
cd instance-scheduler
```
### 2. Get Username and generate Classic Infrastructure API key
As you can manage your infrastructure using a SDK or API, you have to authenticate with a `username` and `apikey`. To get your username for the current account and generate the classic infrastructure API key. Go to [Manage > Access (IAM) > Users](https://cloud.ibm.com/iam/users) and click on your name on the list.
1. Scroll down to the `VPN password` section and copy the `Username`. This is going to be used on Instance Scheduler.
2. Scroll down to the `API keys` section and click on `Create classic infrastructure key` to automatically generate your API key. Copy the key. You are going to use it with `username`.
### 3. Set up the environment variables to deploy them as function's parameters
Run the following command with the classic infrastructure username and API key, and the list with all Virtual Servers to power on/off:
- SOFTLAYER_USERNAME is the `Username` field that you copied from previous step.
- SOFTLAYER_APIKEY is the `API key`, generated in the previous step.
- VSIS_NAME is the list with all Virtual Servers on Classic IaaS (Softlayer) that you'd like to power on/off - e.g. `'["VSI NAME 01", "VSI NAME 02", "SO ON, AND ON"]'`.
```sh
export SOFTLAYER_USERNAME="" SOFTLAYER_APIKEY="" VSIS_NAME='[""]'
```
### 4. Set the time to power off and power on the VSI
In [`manifest.yml`](manifest.yml) file, it is set (by default) to power off the VSI at 03:00 AM (00:00 AM GMT-3) and to power on the VSI at 09:00 AM (06:00 AM GMT-3). Update if you need to run both actions at the desire hour.
### 5. Deploy the Action, Triggers and Rules
Run the following command to deploy `handler.go` function and to set up the Triggers and Rules.
> As you are using IBM Cloud Functions, you don't need to install any package or setup a package.json. The platform already has all libraries required to run the source code.
```sh
ibmcloud fn deploy --manifest manifest.yml
```
## LICENSE
Copyright 2021 Victor Shinya
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.