Learn about components to setup local development environment here.
...
Kubernetes Environment-Creates base environment required to execute and maintain Bots. Kubernetes spawn docker image with base Ubuntu 16.04 with additional software's like NodeJS,CoffeeScript,npm e.tc.
Elastic Search-Holds logs,metrics related information
MongoDB - Used to maintain Approval flow. Generates and Maintain Ticket related information.
MiddleWare Application - Act as a interceptor to read admin response and manages communication between various
Bots.
This section will help you to setup Environment for OnBot. Browse various categories provided below:
Expand | ||
---|---|---|
| ||
Kubernetes Master & Node configuration |
...
Expand | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
Step 1: Installing kubelet and kubeadm on your hosts(to be followed in both Master and Slave)
Step 2: Initializing the master (Below Commands applicable only for master)To initialize the master, pick one of the machines you previously installed kubeadm on, and run: 1. # kubeadm init sudo chown $(id -u):$(id -g) $HOME/.kube/config export KUBECONFIG=$HOME/.kube/config
In case, kubernetes configuration located in $HOME/admin.conf then run the following commands: chown $(id -u):$(id -g) $HOME/admin.conf export KUBECONFIG=$HOME/admin.conf
3. Create a cluster role and bind all services then allow anonymous user to access Kube API
Execute the following commands in the Slave machines to connect to the Master machine: # kubeadm join --token <token id> <Primary IP>:6443 Above token helps slave to join master node. Token should run in all slaves once step 3 completes. Master Isolation: By default, your cluster will not schedule pods on the master for security reasons. If you want to be able to schedule pods on the master, e.g. a single-machine Kubernetes cluster for development, run:
This will remove the node-role.kubernetes.io/master taint from any nodes that have it, including the master node, meaning that the scheduler will then be able to schedule pods everywhere Step 3: Installing a pod network(Below Commands applicable only for master)You must install a pod network add-on so that your pods can communicate with each other. go to addon hyperlink and get weave.net kubectl apply -f https://git.io/weave-kube-1.6 Step 4: Adding Slaves to Master node(Below Commands applicable only for slaves)Run the obtained token given below from Step 2 in all slave nodes not needed to run in add-on server: kubeadm join --token <token id> <Primary IP>:6443 You will get an output similar to the one shown below - | |||||||||||||||||||
Expand | |||||||||||||||||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
# Where to store the data.
dbpath=/var/lib/mongodb
#where to log
logpath=/var/log/mongodb/mongodb.log
logappend=true
bind_ip = <public_IP_of_your_machine>
port = 27017
# Enable journaling,
http://www.mongodb.org/display/DOCS/Journaling
journal=true |
4) Make the mongodb user as mongodb. Usually the user will be mongodb by default. You may check it and skip this step if not required:
chown -R mongodb:mongodb /var/lib/mongodb
5) Start mongodb as a service:
sudo service mongodb start
You can check the status after starting mongodb by this command: sudo service mongodb status
6) Export your existing collections from your pre-existing mongodb service (if any):
sudo mongoexport -db <db_name> -c <collection_name> --out <filename>.json
[eg sudo mongoexport --db botstore -c BotCategory --out BotCat_bkp.json]
This will export all your collection data into a json file inside the present working directory. Now copy that json file into the machine where you have newly installed mongodb and execute the following command:
sudo mongoimport --db <db_name> --collection <collection_name> < /path/to/exported_json
[eg - sudo mongoimport --db botstore --collection BotCategory < /home/487398/BotCat_bkp.json]
This will import all you data into the new mongodb installation.
7) Restart the mongodb service:
sudo service mongodb restart
title | ElasticSearch Setup |
---|
1) sudo apt-get update
2) sudo apt-get install openjdk-8-jre
The binary packages of Elasticsearch have only one dependency: Java. The minimum supported version is Java 8
Now run the below commands to download and install elasticsearch (steps shown for elasticsearch version-5.4.1):
1) curl -L -O{*}https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.4.1.deb*
2) sudo dpkg -i elasticsearch-5.4.1.deb
Go inside /etc/elasticsearch folder and open elasticsearch.yml file. Next, edit the following lines in it:
path.data: /home/487398/elasticsearch-5.4.1/data path.logs: /home/487398/elasticsearch-5.4.1/logs network.host: 0.0.0.0
http.port: 9200
data will specify storage location for elasticsearch indices logs will specify storage location of elasticsearch logs
host should be set to 0.0.0.0 for remotely connecting with the installed elasticsearch port will specify on which port elasticsearch is running
Start the elasticsearch by giving the following:
1) sudo /etc/init.d/elasticsearch start
Verify whether elasticsearch is running by the following command:
curl http://localhost:9200
You should get the following JSON body as response:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"name" : "_mykWLH",
"cluster_name" : "elasticsearch", "cluster_uuid" : "vwEaY6m1TJ6HpKuduu9MGQ", "version" : {
"number" : "5.4.1", "build_hash" : "2cfe0df",
"build_date" : "2017-05-29T16:05:51.443Z", "build_snapshot" : false,
"lucene_version" : "6.5.1"
},
"tagline" : "You Know, for Search"
} |
title | OnBots Framework Setup |
---|
1. apt-get install npm
2. apt-get install nodejs
Clone OnBots from github
1. git clone of chatops respository (git clone –b <branchname> <cloning link>)
2. Copy $HOME/admin.conf file generated by installing kuberentes inside Bots folder of webapp
3. Update Configurations in Bots\app\config\config.json
Configuration settings
Map your configuration in config.json file from app/config directory: ElasticSearch : elasticsearch url
Kubernetes_End_Point : Kubernetes url
MongoDB : mongodb Host
MONITOR_INTERVAL : Time Interval for monitoring bot
MONITOR_RETENSION : mapped to 1 (stores a jsonobj in elasticsearch which has all hubot metrics of a current second)
MONGO_DB_URL : mongodb database name for approval process of bot actions
MONGO_COLL : mongodb collection name for approval process of bot actions
MONGO_COUNTER : mongodb collection name for storing the number of next ticket to be generated
MONGO_TICKETIDGEN : stores the Id of the collection referred by MONGO_COUNTER
APPROVAL_APP_URL: middleware application endpoint which will handle approval flow in mattermost
MONGO_DB_NAME: The database name which has MONGO_COLL and MONGO_COUNTER in it
Certificate_Path: Path to certificate.pem file
PrivateKey_path: Path to key.pem file
https_port: The port number where OnBots will run if started with https
http_port: The port number where OnBots will run if started with http
botCollections: The array of collections that are used by OnBots (["BotStore","Bots","users","MyBots","BotCategory"])
dbName: The mongodb database name which contains botCollections
exposeIP: The IP to which kubernetes services will be exposed (For bots operating with mattermost)tasks/access-application-cluster/web-ui-dashboard/ to know the correct kubernetes-dashboard.yaml github url. (OR) https://github.com/kubernetes/dashboard/wiki/Installation
Run the following commands: -
# kubectl create -f https://raw.githubusercontent.com/kubernetes/dashboard/v2.0.0-beta1/aio/deploy/recommended.yaml
(OR)
# kubectl create -f https://raw.githubusercontent.com/kubernetes/dashboard/v1.10.1/src/deploy/alternative/kubernetes-dashboard.yaml
Note | ||
---|---|---|
| ||
Dashboard will run as a Kube service either in the Master or in any one of the Slaves. Run “kubectl get svc --all-namespaces” to identify the PORT number of the dashboard. Access the dashboard through https://IP:PORT. |
3. Create a cluster role and bind all services then allow anonymous user to access Kube API
If the below kubectl commands are not executed, you will get an error -U'ser "system:serviceaccount:default:default" cannot list pods in the namespace "default"'
- kubectl create clusterrolebinding serviceaccounts-cluster-admin --clusterrole=cluster-admin --group=system:serviceaccounts
- kubectl create rolebinding bob-admin-binding --clusterrole=admin --user=system:anonymous --namespace=default
Execute the following commands in the Slave machines to connect to the Master machine:
1. After kubeadm init, you will obtain a token as shown below-
# kubeadm join --token <token id> <Primary IP>:6443
Above token helps slave to join master node. Token should run in all slaves once step 3 completes.
Master Isolation:
By default, your cluster will not schedule pods on the master for security reasons. If you want to be able to schedule pods on the master, e.g. a single-machine Kubernetes cluster for development, run:- kubectl taint nodes --all node-role.kubernetes.io/master-
This will remove the node-role.kubernetes.io/master taint from any nodes that have it, including the master node, meaning that the scheduler will then be able to schedule pods everywhere
Step 3: Installing a pod network(Below Commands applicable only for master)
You must install a pod network add-on so that your pods can communicate with each other.
go to addon hyperlink and get weave.net
kubectl apply -f https://git.io/weave-kube-1.6
Step 4: Adding Slaves to Master node(Below Commands applicable only for slaves)
Run the obtained token given below from Step 2 in all slave nodes not needed to run in add-on server:
kubeadm join --token <token id> <Primary IP>:6443
1. Post execution, go to the Master machine and run"kubectl get nodes", and verify if the nodes have joined the cluster.
2. Verify if all pods are up and running.
#kubectl get pods --all-namespaces
You will get an output similar to the one shown below -
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Run the following commands:
Here, assign bind_ip with public IP of your machine. Specify the dbpath and logpath according to your choice. sudo mongoexport -db <db_name> -c <collection_name> --out <filename>.json [eg sudo mongoexport --db botstore -c BotCategory --out BotCat_bkp.json] |
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Run the below commands to install Java 8 in your Ubuntu machine:
|
Expand | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
Install npm and nodejs by executing the following commands:
Clone OnBots from github
ElasticSearch : elasticsearch url APPROVAL_APP_URL: middleware application endpoint which will handle approval flow in mattermost MONGO_DB_NAME: The database name which has MONGO_COLL and MONGO_COUNTER in it Certificate_Path: Path to certificate.pem file dbName: The mongodb database name which contains botCollections
Run Application |
...