Learn about components to setup local development environment here.

Basic Components of the OnBots Framework:

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:

Hardware Configuration

Kubernetes Master & Node configuration
No. of instances 4 (1 – Master & Bot Framework; 3- Nodes) AWS Instance type m3.xlarge
OS Ubuntu 16.04 Xenial (64bit) Storage 100 GB
Mem (GiB) 16GB
vCPU 4
Software configuration
Kubernetes version: 1.7.3
Docker version Required: 1.12.6
Npm Version: 3.5.2
Node Version: 4.2.6
Elasticsearch Version: 5.4.1

Network Ports

Kubernetes Master	6443
Kubernetes Slave	6443
Bots Web App (http/https) Middleware App for Approval Flow (http/https)	3000
Elastic Search	9200
MongoDB	27017

All ports must be opened to each other for both private and public ip.

Installation of Kubernetes Cluster

Step 1: Installing kubelet and kubeadm on your hosts(to be followed in both Master and Slave)

apt-get update && apt-get install -y apt-transport-https
curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add -
cat <<EOF >/etc/apt/sources.list.d/kubernetes.list
deb http://apt.kubernetes.io/ kubernetes-xenial main EOF
apt-get update
apt-get install docker.io
apt-get install -y kubelet kubeadm kubectl kubernetes-cni

apt-get install for kubernete utilities(kubeadm,kubectl,kubelet,kubernetes-cni) without specifying version will take the latest version. To Install a specific version refer the following example commands:
apt-get install -y kubeadm=1.6.4-00 kubectl=1.6.4-00 kubelet=1.6.4-00 kubernetes-cni

apt-get install -y kubeadm=1.7.3-01 kubectl=1.7.3-01 kubelet=1.7.3-01 kubernetes-cni

Check available Versions:

curl -sL https://apt.kubernetes.io/dists/kubernetes-xenial/main/binary-amd64/Packages | grep -E 'Package|Version'

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
In case, kubernetes cluster configuration located in $HOME/.kube/config then run the following command
To start using your cluster, you need to run (as a regular user):
mkdir -p $HOME/.kube
sudo cp -i /etc/kubernetes/admin.conf $HOME/.kube/config

sudo chown $(id -u):$(id -g) $HOME/.kube/config

export KUBECONFIG=$HOME/.kube/config

Add "export KUBECONFIG=$HOME/.kube/config" to ~/.bashrc file in order to export the conf file. If this is not added, the export will be applicable only to the current putty session. For a new session, the Kubernetes API will be unreachable.

In case, kubernetes configuration located in $HOME/admin.conf then run the following commands:
To start using your cluster, run below commands as root user or prefix with sudo:
cp /etc/kubernetes/admin.conf $HOME/

chown $(id -u):$(id -g) $HOME/admin.conf

export KUBECONFIG=$HOME/admin.conf

Add "export KUBECONFIG=$HOME/admin.conf" to ~/.bashrc file in order to export the conf file. If this is not added, the export will be applicable only to the current putty session. For a new session, the Kubernetes API will be unreachable.

2. Kubernetes dashboard is an optional step. To create Kubernetes dashboard, refer "Deploying the Dashboard UI" in https://kubernetes.io/docs/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

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"'

1. kubectl create clusterrolebinding serviceaccounts-cluster-admin --clusterrole=cluster-admin --group=system:serviceaccounts
2. 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 -

MongoDB Setup

Run the following commands:
1) sudo apt-get update
2) sudo apt-get install -y mongodb
3) modify the following lines in the file: /etc/mongodb.conf

# 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

Here, assign bind_ip with public IP of your machine. Specify the dbpath and logpath according to your choice.
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

ElasticSearch Setup

Run the below commands to install Java 8 in your Ubuntu machine:
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:

{
"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"
}

Nodeservices setup

Install npm and nodejs by executing the following commands:
1. apt-get install npm
2. apt-get install nodejs

The recommended versions for node and npm are Node 8.x.x and npm5.x.x. If you are getting lower versions using apt-get install, remove existing node setup from your machine and then run the following:

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -

apt-get install nodejs

Clone OnBots from github
1. git clone of chatops respository (git clone –b master https://github.com/CognizantOneDevOps/OnBot.git)
2. Copy $HOME/admin.conf file generated by installing kuberentes inside masterbot folder
3. Update Configurations in OnBots/frameworkservices/masterbot/app/config/config.json
Configuration settings

Configuration

NodeServices config file	location	Description
config.json	app/config/config.json	config.json template is available. Update your environment specific values which are required to start NodeServices To enable approval flow for mattermost adapter set "APPROVAL_APP_URL=http://middleware-ip:port/approval" in config.json
certificate.pem , key.pem	must be placed in root of the project which is parallel to app.js	Generate certificate and private key pem files. Used to start the service as httpsServer. pem files are not needed for httpServer. This can be changed in app.js
admin.conf	must be placed in root of the project which is parallel to app.js	It can be found in kubernets master node instance. Path: /home/ubuntu/admin.conf or /etc/kubernetes/admin.conf
ubuntu.yaml	app/config/ubuntu.yaml which is parallel to config.json	Sample file already available. To create bots containers of kind “pod”

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)

Scripts/Controller	Description
deploybot.js	Used to add/delete/stop the bot
elasticApi.js	Connects to elasticsearch to fetch the metrics , hitmiss ratio and chatlogs of a bot
hubotscripts.js	Construct shell scripts to start/stop/restart bot. Also, copying the workflow.json into container after edit.
kubectlapi.js	Performs all container specific actions like create container, get logs from container, copying scripts into container, execute bot start/restart scripts in container,. using the Kubernetes.
routes.js	mongodb query executions to add bot info as document, fetch document, update document and appending new values to a document.

Run Application
1. Install npm modules by running the following from Bots folder
npm install
2. Run application
nodejs app
This will run application in specified port

Browser not supported