Table of Contents
Introduction
The 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 in such a way that mostly it to covers both the blueprints IoT Gateway and SD-WAN / WAN Edge and uCPE Blueprints.
In Common features are added in ELIOT Release 2.0, currently following features are included :-
...
ELIOT Manager acts as the Controller Node managing the ELIOT Edge Node(s) and the containerized applications running on the various ELIOT Edge Nodes.
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.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
...
| Note |
|---|
The hardware requirements mentioned here are the extra nodes which are required apart from ELIOT Cluster required for installing the ELIOT Operation and Maintenance Features. Hardware requirements ELIOT Cluster nodes are mentioned in the respective blueprint Installation Documents. ELIOT Release 2 - IoT Gateway Installation Guide |
ELIOT
...
Portal (Front End)
The Hardware requirements is same as the number of nodes required for ELIOT Cluster.
...
Minimum Hardware Requirements
| ELIOT ManagerPortal Front End | |
|---|---|
| Hardware Aspect | Requirements |
| # of Node(s) | A virtualized machine hosted in any Cloud Provider having internet connectivity. |
| CPU | Minimum 1 socket x86_AMD64 or ARM64 with Virtualization support. |
| RAM | 4 GB, it depends on the number of ELIOT Edge nodes which will be managed by ELIOT Manager.For Deployment in Development environment 8 GB is sufficient. |
| Disk | 120 GB ~ 512GB (Depending on the overall ELIOT Topology) |
| Networks | 1 |
1 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.
Recommended Hardware Requirements
| ELIOT ManagerPortal Front End | |||
|---|---|---|---|
| HW Aspect | Requirementscc | ||
| No. of Nodes | A virtualized machine hosted in any Cloud Provider having internet connectivity. | ||
| CPU | Minimum 1 socket x86_AMD64 or ARM64 with Virtualization support. | ||
| RAM | 8 GB ~ 64 GB it depends on the number of ELIOT Edge nodes which will be managed by ELIOT Manager.32 GB For Deployment in Development environment 4 GB is sufficient. | ||
| Disk | 120 GB ~ 512GB (Depending on the overall ELIOT Topology) | ||
| Networks | 2 to 4 Network Interfaces with public IP. | ELIOT Edge Node(s) | HW Aspect|
#of Node(s) | 1 Eliot Edge Node | ||
| CPU | Minimum 1 socket x86_AMD64 or ARM64 with Virtualization support. | RAM | |
| Disk | 20 GB ~ 256GB (Depending on the overall ELIOT Topology) | ||
| Networks | 2 Network Interfaces . |
Software Prerequisites
| Note |
|---|
The software prerequisites mentioned here are the once which are required for the ELIOT Operation & Maintenance features to work successfully. |
ELIOT CLI
- Virtual Machines (ELIOT Manager + ELIOT Edge Node) 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 Machines Machine installed with Ubuntu 16.04.
...
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
...
| No Format |
|---|
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
...
<eliotedgenodeusername>|<eliotedgenodeip>|<eliotedgenodepassword>
eliotedgenodeusername \u2013 :- ELIOT Edge Node User Name. Example : akraino-slave-002
eliotedgenodeip \u2013 :- 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.
...
| Code Block |
|---|
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:
...
ELIOT Cluster should be setup first before Installing ELIOT Portal Setup
ELIOT Portal Front-End:
Packages To Be Installed :-
...
| No Format |
|---|
root@akraino-slave-001:# git clone "https://gerrit/.akraino.org/r/eliot" root@akraino-slave-001:# cd eliot/common/eliot-ui/frontend-src root@akraino-slave-001:# npm install root@akraino-slave-001:# npm start |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
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/releases/v1.1.0/eliotuiblueprint/common/eliot-ui/be/src/eliotk8sclient/ root@akraino-slave-001:# tarmvn -xvzf eliotui-be-$version-$OS-$ARCH.tar.gzclean install root@akraino-slave-001:# cd target root@akraino-slave-001:# jar -jar eliotk8sclient-0.0.1.jar. [The command will start the ELIOT Portal Backend which is a Spring Boot Application.] |
...
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.
...
Developer Guide and Troubleshooting
...