Tip |
---|
Every Bot has default Help command, which will explain users about what the bot can actually do by giving list of Commands and Actions. In case Bot does not understand user commands then bot can guide users with default replies. |
...
Below are the Bots Available in OnBots . Below pages will guide you on what a bot can do for you
...
Master Bot
...
Panel |
---|
borderColor | #7BD9F5 |
---|
bgColor | #F7F9D8 |
---|
borderWidth | 2 |
---|
borderStyle | solid | title |
---|
|
Introduction: As we proceed with the bots hubots coupled with tools to make our tasks easier in the form of chattingconversations, we realised there needs to be someone who should do the management activity for the other bots and voila! Say hello to the Master Bot , the bot for deploying and managinf all other bots. This bot is designed to let you manage all your other bots and gather consolidated information about them by just chatting with it. Sounds fun? Let us dig deep into how this that there is a need of a framework which should manage other bots. Therefore, conversing with Master Bot will assist you to manage all your other bots. Master Bot deployment: Panel |
---|
- Install hubot into your server (Refer here)
- Pull your desired scripts-<adapter> folder from our github repository
- Copy the content of scripts-<adapter> into your <newly_installed_hubot_folder>/scripts
- Set the following environment variables:
ONBOTS_URL: The url where OnBots services are running AUTH_TOKEN: Personal access token of your adapter(must permissions to get uploaded file content from the adapter) (for genearating this token in slack Click here, for mattermost Click here, for Hipchat Click here) HUBOT_SLACK_TOKEN: To add new app/bot to slack workspace. (for generating this token in slack, Go to https://api.slack.com/apps --> Create New App --> Give app name and Choose Workspace --> "Install your app to your workspace" : use proper permissions(oAuth) and register your apps. you will get token starts with "xoxb-" ) 5. Install the desired npm-module for your adapter. Master can work with Slack, Hipchat or Mattemost. Execute the following command inside your bot folder: npm install hubot-<adapter> (where <adapter> can be slack, hipchat or mattermost. Refer this page to to learn more about how to connect your bot to a chat application.) You are all set now. Execute the following to start the bot with your chat adapter: ./bin/hubot -a <adapter> |
How it works: 1)You will need the masterbot and the OnBots services running in your serversKubernetes master server. Warning |
---|
Your Masterbot and OnBots services should be running on the same server. This is because the Master needs to interact with the Kubernetes Environment for fetching bots related data and doing performing management activities for the bots. If both are not in same machine, even if you have ports opened and allow connection between the servers, kubernetes . Kubernetes will block the master OnBots services from accessing it, if it is deployed in different servers even if ports are allowed in firewall. |
2) Connect it to slackadapters like Slack, Hipchat or mattermostMattermost 3) Now you can interact with the bot through commands Let us have a look at what are all Below are the commands supported by our Master Bot: Commands | Description |
---|
getDeployedBots | get list of all deployed bots | getBots | get bot types available in onBots | getConfig Template <botname> | get Json template for adding a particular type of bot | addBot <json_fileid> | adds a bot with the given configuration in Json file | getConfig Template getBotDetails <botname> | get | Json template for adding a particular type of botdelete <botname> | delete the configuration and other details for a bot | getLogs <botname> | get deployment logs of the given bot | getChatlog <botname> | get chat logs of the given bot | stop <botname> | stop an active bot if it is running | container status restart <botname> | give the container status in which the bot is deployed | getMetrics <botname> | get system metrices for the given botrestart the bot with the details stored in mongodb | getHitmiss <botname> | get hit-miss ratio of conversations of the given bot | getLogs getMetrics <botname> | get | deployment logs of the given botgetChatlog <botname> | get chat logs of system metrices for the given bot | getBots | get bot types available in onBots | getBotDetails <botname> | get configuration and other details for a bot | editbot <botname> <json_fileid> | edit the bot configuration details in mongodb from the given json file | restart <botname> | restart the bot with the details stored in mongodb | tail <number_of_lines> <botname> | To get last <number_of_lines> of the logs of <botname> | delete <botname> | delete the bot | container status <botname> | give the container status in which the bot is deployed | help | list all the commands the master can perform |
Image Added → Actions available by default Image Added → Actions enriched by OneDevOps | OnBot |
Bots which can be deployed using the Master Bot:
Panel |
---|
borderColor | #7BD9F5 |
---|
borderStyle | dashed |
---|
|
Below are the Bots Available in OnBots. Click on specific botnames to know more: |
Tip |
---|
Every Bot has default Help command, which will explain users about what the bot can actually do by giving list of Commands and Actions. In case Bot does not understand user commands then bot can guide users with default replies. |