hubot-ibmcloud-virtualserver

Script package that exposes various IBM Cloud Virtual Server functionality through Hubot.

Getting Started

• Usage
• Commands
• Hubot Adapter Setup
• Cognitive Setup
• Development
• License
• Contribute

Usage

If you are new to Hubot visit the getting started content to get a basic bot up and running. Next, follow these steps for adding this external script into your hubot:

1. cd into your hubot directory
2. Install this package via npm install hubot-ibmcloud-virtualserver --save
3. Add hubot-ibmcloud-virtualserver to your external-scripts.json
4. Add the necessary environment variables:

HUBOT_BLUEMIX_API=<Bluemix API URL>
HUBOT_BLUEMIX_ORG=<Bluemix Organization>
HUBOT_BLUEMIX_SPACE=<Bluemix space>
HUBOT_BLUEMIX_USER=<Bluemix User ID>
HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
HUBOT_VIRTUAL_SERVER_REGION=<Bluemix Virtual Server region, OS_REGION_NAME in rcfile>
HUBOT_VIRTUAL_SERVER_AUTH_URL=<Bluemix Virtual Server authentication url, OS_AUTH_URL in rcfile>
HUBOT_VIRTUAL_SERVER_DOMAIN_NAME=<Bluemix Virtual Server domain name, OS_USER_DOMAIN_NAME in rcfile>

Note: for virtual server related variables, follow this to get rcfile.

1. Start up your bot & off to the races!

Commands

• hubot virtual server delete|destroy|remove [virtualserver] - Deletes a virtual server.
• hubot virtual server list|show - Lists all of the virtual servers.
• hubot virtual server reboot [virtualserver] - Restarts the virtual server.
• hubot virtual server start [virtualserver] - Starts the virtual server.
• hubot virtual server stop [virtualserver] - Stops the virtual server.
• hubot virtual server help - Show available virtual server commands.

Hubot Adapter Setup

Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:

• Slack setup
• Facebook Messenger setup

Cognitive Setup

This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.

Development

Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:

Configuration Setup

1. Create config folder in root of this project.
2. Create env in the config folder, with the following contents:

export HUBOT_BLUEMIX_API=<Bluemix API URL>
export HUBOT_BLUEMIX_ORG=<Bluemix Organization>
export HUBOT_BLUEMIX_SPACE=<Bluemix space>
export HUBOT_BLUEMIX_USER=<Bluemix User ID>
export HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
export HUBOT_VIRTUAL_SERVER_REGION=<Bluemix Virtual Server region, OS_REGION_NAME in rcfile>
export HUBOT_VIRTUAL_SERVER_AUTH_URL=<Bluemix Virtual Server authentication url, OS_AUTH_URL in rcfile>
export HUBOT_VIRTUAL_SERVER_DOMAIN_NAME=<Bluemix Virtual Server domain name, OS_USER_DOMAIN_NAME in rcfile>

Note: for virtual server related variables, follow these directions to get rcfile

1. In order to view content in chat clients you will need to add hubot-ibmcloud-formatter to your external-scripts.json file. Additionally, if you want to use hubot-help to make sure your command documentation is correct. Create external-scripts.json in the root of this project, with the following contents:

[
    "hubot-help",
    "hubot-ibmcloud-formatter"
]

1. Lastly, run npm install to obtain all the dependent node modules.

Running Hubot with Adapters

Hubot supports a variety of adapters to connect to popular chat clients.

If you just want to use:

• Terminal: run npm run start
• Slack: link to setup instructions
• Facebook Messenger: link to setup instructions

License

See LICENSE.txt for license information.

Contribute

Please check out our Contribution Guidelines for detailed information on how you can lend a hand.