Table of Contents

Introduction

The guide covers the installation details for common components for ELIOT which are applicable the Blueprints ELIOT IOT Gateway and ELIOT SD-WAN.

This guide provides the information for setting up the ELIOT Environment which includes ELIOT Manager and ELIOT Edge Node(s) with details of software and hardware specifications.

For Release-2.0 the scope of the guide covers two ELIOT deployments one is using Kubernetes and the other one using Kubeedge (Lightweight Kubernetes).  

The common components include ELIOT Lightweight Tailored OS, ELIOT UI , ELIOT Command Line Interface to bootstrap the ELIOT Cluster Installation.

The ELIOT Manager can be any Cloud Virtual Machine having Ubuntu OS 16.04 and should be able to ping and SSH to the Eliot Edge Node.  The ELIOT Edge Node will be a Virtual Machine having Ubuntu 0S 16.04.

For Kubernetes setup Kubeadm tool is being used and for Container Networking Interface Calico plugin is being used.

For KubeEdge the connection between the ELIOT Manager and ELIOT Edge Node is being established via Web Socket. Currently KubeEdge does not support Container Networking Interface.

How to use this document

The document includes details of prerequisites /pre-installation, installation and uninstalls steps.

The prerequisites and pre-installation software and hardware should be ready before executing the installation steps.

For Installation, there are two mode Auto Deployment installation script steps and manual installation.

Deployment Architecture

main scope of ELIOT  Operation & Management Features is to provide an ecosystem for the end user to operate and manage the ELIOT Topology which can include like checking the health status of ELIOT Edge Nodes, health status of services running on various Edge Nodes, Deploying Application in the ELIOT Cluster (Application deployment in a Kubernetes Cluster) etc.  The features are still evolving and ideas / proposals are always welcome.

The features are to be designed to covers both the blueprints  IoT Gateway and SD-WAN / WAN Edge and uCPE Blueprints.

Common features are added in ELIOT Release 2.0, currently following features are included :-

• ELIOT Portal
• ELIOT CLI (Command Line Interface) (Applicable for IoT Gateway Blueprint)

In Release 2.0 both the features have given some basic operations ; enhancements are planned for future releases.

ELIOT Portal :-

ELIOT UI currently provides a GUI in which we can query the various Kubernetes Nodes, Pods and Services are there in the ELIOT Cluster. There are other options which are under development for future releases.

ELIOT CLI :-

ELIOT CLI (Command Line Interface) provide command line interface to setup the ELIOT Cluster. It In the current release following options are available

• Setup of ELIOT Cluster; setting up of ELIOT Manager and ELIOT Edge Node
• Reset of ELIOT Cluster - This will reset the ELIOT Cluster - Kubernetes Node Details, Pods , Services.
• Cleanup of ELIOT Cluster. (This will reset the ELIOT Cluster and uninstall the software in each nodes of the ELIOT Cluster)

How to use this document

The document includes details of prerequisites /pre-installation, installation and uninstalls steps.

The prerequisites and pre-installation software and hardware should be ready before executing the installation steps.

Deployment Architecture

For Release 2.0 the Deployment Architecture consists of two nodes  ELIOT Manager and a For Release 1.0 the Deployment Architecture consists of two nodes  ELIOT Manager and a single ELIOT Edge Node.

ELIOT Manager acts as the Controller Node managing the ELIOT Edge Node(s) and the containerized applications running on the various ELIOT Edge Nodes.

Pre-Installation Requirements

Hardware Requirements

ELIOT Manager - One VM - 8 vCPU - 32 GB RAM (can be hosted in any cloud provider) with Ubuntu OS having internet and network connectivity with ELIOT Edge Node.

ELIOT Edge Node - Ubuntu OS 16.04 / 18.04 installed with networking capability and internet capability.

Minimum Hardware Requirements

ELIOT CLI has to be installed in the ELIOT Manager Node.

ELIOT Portal has two modules ELIOT UI Front End and ELIOT UI Back End. It is recommended to install the ELIOT UI Front End and Back End in separate Virtual Machines or Bare Metal which are able to ping each other and able to do ssh. ELIOT UI Backend module has to be installed on the ELIOT Manager only.

To deploy the common features one extra node (Bare metal or Virtual Machine) is required for ELIOT UI Front End Module, it is recommended. If one extra node is not available than it can be installed in any cloud Virtual Machine, in which the ELIOT Manager is present.

Pre-Installation Requirements

Hardware Requirements

ELIOT Portal (Front End)

The Hardware requirements is same as the number of nodes required for ELIOT Cluster.

ELIOT Manager - One VM - 8 vCPU - 32 GB RAM (can be hosted in any cloud provider) with Ubuntu OS having internet and network connectivity with ELIOT Edge Node.

ELIOT Edge Node - Ubuntu OS 16.04  installed with networking capability and internet capability.

Detail of Hardware requirements can be referred

Minimum Hardware Requirements

Recommended Hardware Requirements

Software Prerequisites

ELIOT CLI

• Virtual Machines (ELIOT Manager + ELIOT Edge Node

...

#of Node(s)

...

2 GB ~ 16 GB it depends on the number of ELIOT Edge nodes which will be managed by ELIOT Manager.

For Deployment in Development environment 4 GB is sufficient

...

• ) preinstalled with Ubuntu 16.04.
• SSH Server running on both the Nodes (ELIOT Manager and ELIOT Edge Node)
• sshpass installed in ELIOT Manager
• SCP installed in ELIOT Manager and ELIOT Edge Node
• GO Lang Version greater 1.12 installed in ELIOT Manager. [https://tecadmin.net/install-go-on-ubuntu/]
• Git should be installed in ELIOT Manager and ELIOT Edge Node.

ELIOT UI

• Virtual Machine installed with Ubuntu 16.04.

Database Prerequisites

Schema scripts

N/A

Other Installation Requirements

Jump Host Requirements

N/A

Network Requirements

• Internet Connectivity in both

Software Prerequisites

• Virtual Machines preinstalled with Ubuntu 16.04
• root user created in the ELIOT Manager and ELIOT Edge Node
• SSH Server running in both the Nodes.
• sshpass installed in ELIOT Manager
• scp installed in ELIOT Manager and ELIOT Edge NodeGO Lang installed in
• ELIOT Manager and ELIOT Edge Node (Note : This is required when we are setting up the ELIOT using KubeEdge.)
• git should be installed in ELIOT Manager and ELIOT Edge Node.

Database Prerequisites

• should be able to ping each other. Same network
• ELIOT Portal Front End Virtual Machine or Bare Metal should be able to ping to the ELIOT Manager Node where ELIOT Portal Back End is Installed.

Bare Metal Node Requirements

...

N/A

Other Installation Requirements

Jump Host Requirements

Execution Requirements (Bare Metal Only)

N/A

Network Requirements

• Internet Connectivity in both ELIOT Manager and ELIOT Edge Node
• ELIOT Manager and ELIOT Node should be able to ping each other. Same network

Bare Metal Node Requirements

N/A

Execution Requirements (Bare Metal Only)

N/A

Installation High-Level Overview

In ELIOT Release 1.0 for deployment 2 Ubuntu 16.04 Virtual Machines are used.

The steps includes to setup the following two environments : 

• ELIOT Deployment using Kubernetes. 
• ELIOT Deployment using KubeEdge

Bare Metal Deployment Guide

Install Bare Metal Jump Host

Currently ELIOT Deployment have been done in Virtual Machines only but the installation steps and scripts will hold good for execution in Bare Metal also if the hardware and software prerequisites are met.

Creating a Node Inventory File

N/A

Creating the Settings Files

N/A

Running

N/A

Virtual Deployment Guide

For Virtual Deployment two Ubuntu VM's are required one for ELIOT Manager and ELIOT Edge Node both the node should have internet connectivity , network interface and network connectivity between the two VM's

Standard Deployment Overview

ELIOT Portal Setup:

ELIOT Portal Front-End:

Pre-requisites - Open source softwares required:

Node Packet Manager ( npm )         -     6.10.2 / any latest version

Node.js                                                       -     12.9.0 / any latest version

Angular8                                                    -     8.2.2 / any latest version

Install nvm - Node Version Manager

Node Version Manager helps to manage the version of node and also used to switch between the versions with ease.

root@akraino-slave-001:$ curl https://raw.githubusercontent.com/creationix/nvm/v0.33.4/install.sh | bash

Close and reopen the terminal.

root@akraino-slave-001:$ source ~/.profile
root@akraino-slave-001:$ nvm --version

Install nodejs server

Nodejs will play the role of server to run our ELIOT Portal UI

Below command will install latest version of npm (Node Packet manager) and nodejs

root@akraino-slave-001:# nvm install v12.9.0

Install Angular 8:

Angular 8 is a open source framework used to create responsive dynamic single page web applications.  It internally uses typescript.  

Installation High-Level Overview

The installation guide provide steps to install ELIOT CLI and ELIOT Portal Feature.

ELIOT CLI Package is installed on the ELIOT Manager Node

ELIOT Portal has two modules ELIOT Portal Front-End and ELIOT Portal Back-End. ELIOT Portal Front End is recommended to be installed on a separate Virtual Machine and ELIOT Portal Back End has to be installed on ELIOT Manager Node. Currently this document

Bare Metal Deployment Guide

Install Bare Metal Jump Host

Currently ELIOT Deployment have been done in Virtual Machines only but the installation steps and scripts will hold good for execution in Bare Metal also if the hardware and software prerequisites are met.

Creating a Node Inventory File

N/A

Creating the Settings Files

N/A

Running

N/A

Virtual Deployment Guide

For Virtual Deployment two Ubuntu VM's are required one for ELIOT Manager and ELIOT Edge Node both the node should have internet connectivity , network interface and network connectivity between the two VM's

Standard Deployment Overview

ELIOT CLI Installation:

Setup the ELIOT CLI and build the ELIOT CLI binary.

root@akraino-slave-001:# git clone "https://gerrit.akraino.org/r/eliot"
root@akraino-slave-001:# cd eliot/blueprints/eliot/common/elcli/
root@akraino-slave-001:# cp -r elcli $GO_HOME/src
root@akraino-slave-001:# go install [this command will build the elcli binary package]

ELIOT CLI Pre-Configuration

Edit the nodelist file with ELIOT Edge Node details. Replace the below contents with the actual value with '|' separated.

<eliotedgenodeusername>|<eliotedgenodeip>|<eliotedgenodepassword>

eliotedgenodeusername :- ELIOT Edge Node User Name. Example : akraino-slave-002
eliotedgenodeip :-  ELIOT Edge Node IP. Example : 159.123.1.50
eliotedgenodepassword :- ELIOT Edge Node Password used in setup.sh script to login to ELIOT Edge node from ELIOT Manager to execute scripts in ELIOT Edge node.

The ELIOT Edge Node should be reachable from ELIOT Manager and ssh should work from ELIOT Manager to ELIOT Edge node as a prerequisite.

root@akraino-slave-001:#cd eliot/blueprints/iotgateway/scripts
root@akraino-slave-001:~/eliot/blueprints/iotgateway/scripts#vim nodelist

Once the above configurations are done, we can execute the ELIOT CLI Commands for installing , reset and clean up of ELIOT Cluster.

ELIOT CLI Commands Details:

Setup ELIOT Cluster

root@akraino-slave-001:#cd go/src/elcli
root@akraino-slave-001:#elcli init

Reset ELIOT Cluster

root@akraino-slave-001:#cd go/src/elcli
root@akraino-slave-001:#elcli reset

Cleanup ELIOT Cluster

root@akraino-slave-001:#cd go/src/elcli
root@akraino-slave-001:#elcli cleanup

ELIOT Portal Setup:

ELIOT Cluster should be setup first before Installing ELIOT Portal Setup

ELIOT Portal Front-End:

Packages To Be Installed :-

• Node Packet Manager ( npm )      -     6.10.2 / any latest version

• Node.js                                                       -     12.9.0 / any latest version

• Angular8                                                   -     8.2.2 / any latest version

Install nvm - Node Version Manager

Node Version Manager helps to manage the version of node and also used to switch between the versions with ease.Below command will install Angular 8 which is an open source software distribution by google

root@akraino-slave-001:#$ npm install -g @angular/cli@latest

Setup ELIOT Portal by downloading the node modules as dependencies:

ELIOT portal UI code of angular8 requires some dependency packages of node modules. By executing the following commands, dependency node modules will get downloaded automatically

curl https://raw.githubusercontent.com/creationix/nvm/v0.33.4/install.sh | bash

Close and reopen the terminal.

root@akraino-slave-001:# git clone "https://gerrit/akraino.org/r/eliot"
root@akraino-slave-001:#$ cdsource eliot/common/eliot-ui/frontend-src~/.profile
root@akraino-slave-001:#$ npmnvm install
root@akraino-slave-001:# npm start
-version

ELIOT Portal Backend Setup:

The ELIOT Portal Back-End module has to be executed on the ELIOT Manager Node. The backend server will receive REST API requests from ELIOT Frontend and response back the results of the ELIOT Cluster.

...

Install nodejs server

Nodejs will play the role of server to run our ELIOT Portal UI

Below command will install latest version of npm (Node Packet manager) and nodejs

root@akraino-slave-001:# nvm install v12.9.0

Install Angular 8:

Angular 8 is a open source framework used to create responsive dynamic single page web applications.  It internally uses typescript.  

Below command will install Angular 8 which is an open source software distribution by google

root@akraino-slave-001:# npm install -g @angular/cli@latest

Setup ELIOT Portal by downloading the node modules as dependencies:

ELIOT portal UI code of angular8 requires some dependency packages of node modules. By executing the following commands, dependency node modules will get downloaded automatically

git clone "https://gerrit/akraino.org/r/eliot" [If this step is already executed can be ignored]
root@akraino-slave-001:# cd eliot/releases/v1.1.0/eliotui/be/git clone "https://gerrit.akraino.org/r/eliot"
root@akraino-slave-001:# tarcd -xvzf eliotui-be-$version-$OS-$ARCH.tar.gzeliot/common/eliot-ui/frontend-src
root@akraino-slave-001:# jarnpm -jar eliotk8sclient.jar. [The command will start the Spring Boot Application.]

ELIOT Minimal OS setup:

              In ELIOT , we are minimalising the CentOS Minimal iso by removing the unnecessary packages and we have builded Bootable iso.  ELIOT Minimal OS helps to make nodes as Lightweight and also increases the  productivity of Edge Nodes.  ELIOT Nodes will ideally use Minimal OS.   

Download ELIOT Minimal OS:

Download the ELIOT Minimal OS from ftp server and store the iso.  

For ELIOT edge nodes, we can use ELIOT Minimal OS .  Then, ELIOT topology can be setup as described below in ELIOT Deployment section.

Create VM's from ELIOT Minimal OS iso:

Vm's can be created on Edge nodes using Virtual Box as well as other VM creator tools.  

Virtual Box is a powerful Virtualization Open source tool ( Professional solution ).  Below are the procedures to create ELIOT Edge VM's using Virtual box

1. Click New → Enter the below credentials and Click Next
   1. Name      → ELIOT Minimal Node 1
   2. Type        → Linux
   3. Version   → Other Linux (64 bit)
2. Memory Size     → 1512 MB  ( Memory size depends on the usage ).  Click Next
3. Click Create button click next
4. Choose Hard disk file type as VDI and click next
5. Storage → Fixed size
6. File size  → 15 GB ( Depends on the usage it may vary ).  Click Create
7. Right click ELIOT Minimal Node 1 → settings 
8. Select Storage and attach ELIOT Minimal iso downloaded in Controller: IDE → Optical Drive option
9. Settings → Network and select Bridged network and select Name as wlp3s0
10. Click ELIOT Minimal Node 1 → start

Note: Configuring Network will give you proper IP for your created ELIOT Node

Repeat the same procedure to create number of ELIOT Nodes

ELIOT Deployment using Kubernetes

Clone the ELIOT git repo in ELIOT Manager node. It will create eliot folder, for executing the script go to $HOME/eliot/scripts folder.

Edit the nodelist file with ELIOT Edge Node details.  Replace the below contents with the actual value with '|' separated. 

The below details are required in the setup.sh for sshpass command. The details are required by sshpass to login to ELIOT Edge Node from ELIOT Manager and execute the deployment scripts in the ELIOT Edge Node.

<eliotedgenodeusername>|<eliotedgenodeip>|<eliotedgenodepassword>

• eliotedgenodeusername – ELIOT Edge Node User Name.
• eliotedgenodeip – ELIOT Edge Node IP
• eliotedgenodepassword - ELIOT Edge Node Password used in setup.sh script to login to ELIOT Edge node from ELIOT Manager to execute scripts in ELIOT Edge node.

The ELIOT Edge Node should be reachable from ELIOT Manager and ssh should work from ELIOT Manager to ELIOT Edge node as a prerequisite.

root@akraino-slave-001:#git clone "https://gerrit.akraino.org/r/eliot"
root@akraino-slave-001:#cd eliot/scripts
root@akraino-slave-001:~/eliot/scripts#vim nodelist

After editing the nodelist file , execute the setup.sh script.  The setup.sh script internally installs Docker and Kubernetes with Calico CNI plugin and RBAC for authorization.

root@akraino-slave-001:~/eliot/scripts#./setup.sh

ELIOT Deployment using KubeEdge

Clone the ELIOT git repo in ELIOT Manager node. It will create eliot folder, for executing the script go to $HOME/eliot/scripts/src folder.

Edit the config_kubeedge file with ELIOT Manager and ELIOT Edge Node

The format of config_kubeedge file is as follows :

edgenodeusr=""

edgenodeip=""

edgenodepassword=""

masternodeusr=""

masternodeip=""

masternodepassword=""

root@akraino-slave-001:#git clone "https://gerrit.akraino.org/r/eliot" 
root@akraino-slave-001:#cd eliot/scripts/ 
root@akraino-slave-001:~/eliot/scripts#vim config_kubeedge
root@akraino-slave-001:~/eliot/scripts#./kubeedge_setup.sh

Snapshot Deployment Overview

There are two images created for Manager and Node machines. These are .qcow2 files. After deploying the VMs using these images, your setup for ELIOT is ready in minutes. Following is the link to the document to use these images:

         https://docs.google.com/document/d/1TwtDRvxJ_0IFzc5KvO7aaOh3If-jhpCSrccjttQA4LE/edit?usp=sharing

Special Requirements for Virtual Deployments

N/A

Install Jump Host

N/A

Verifying the Setup - VM's

N/A

Upstream Deployment Guide

Upstream Deployment Key Features

N/A

Special Requirements for Upstream Deployments

N/A

Scenarios and Deploy Settings for Upstream Deployments

N/A

Including Upstream Patches with Deployment

N/A

Running

N/A

Interacting with Containerized Overcloud

N/A

Verifying the Setup

Verifying ELIOT Kubernetes Deployment

The setup.sh script will install the ELIOT Manager and one ELIOT Edge Node. After script execution is completed the kubernetes cluster setup can be checked by executing kubectl get nodes. It will show both the ELIOT Manager and the ELIOT Edge Node as ready.

The setup script also deploys NGINX server on the ELIOT Edge Node and verifies whether its deployed successful or not.

Developer  Guide and Troubleshooting

Uninstall Guide

Following two files can be used to revert the changes made by ELIOT deployment through kubernetes.

...

install
root@akraino-slave-001:# npm start

ELIOT Portal Backend Setup:

The ELIOT Portal Back-End module has to be executed on the ELIOT Manager Node. The backend server will receive REST API requests from ELIOT Frontend and response back the results of the ELIOT Cluster.

Software Prerequisites:

1. Java Version 1.8 [ https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html]

Note: Other software prerequisites are similar to the one mentioned required for ELIOT Manager node.

Steps to Run ELIOT UI Backend Server:

root@akraino-slave-001:# git clone "https://gerrit.akraino.org/r/eliot" [If this step is already executed can be ignored]
root@akraino-slave-001:# cd eliot/blueprint/common/eliot-ui/be/src/eliotk8sclient/
root@akraino-slave-001:# mvn clean install
root@akraino-slave-001:# cd target
root@akraino-slave-001:# jar -jar eliotk8sclient-0.0.1.jar. [The command will start ELIOT Portal Backend which is a Spring Boot Application.]

Snapshot Deployment Overview

N/A

Special Requirements for Virtual Deployments

N/A

Install Jump Host

N/A

Verifying the Setup - VM's

N/A

Upstream Deployment Guide

Upstream Deployment Key Features

N/A

Special Requirements for Upstream Deployments

N/A

Scenarios and Deploy Settings for Upstream Deployments

N/A

Including Upstream Patches with Deployment

N/A

Running

N/A

Interacting with Containerized Overcloud

N/A

Verifying the Setup

Developer  Guide and Troubleshooting

Uninstall Guide

...

Troubleshooting

N/A

Error Message Guide

N/A

Maintenance

Blueprint Package Maintenance

Software maintenance

N/A

Hardware maintenance

N/A

Blueprint Deployment Maintenance

N/A

Frequently Asked Questions

N/A

License

Any software developed by the "Akraino ELIOT" Project is licensed under the
Apache License, Version 2.0 (the "License");
you may not use the content of this software bundle except in compliance with the License.
You may obtain a copy of the License at <https://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.

References

Definitions, acronyms and abbreviations