Introduction
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-1.0 the scope of the guide covers two ELIOT deployments one is using Kubernetes and the other one using Kubeedge (Lightweight Kubernetes).
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
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
Number of Hardware requirements depends mainly on the Use Case Scenario. A use case can have one to multiple ELIOT Edge Nodes
Note: For ELIOT Release 1.0 ELIOT Manager is acting a dual role Jump server (to execute the setup script) and as the Kubernetes Master. Also currently the below hardware capability are mentioned for the Virtual Machines.
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 Manager | |
|---|---|
| HW 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 |
| ELIOT Edge Node(s) | |
|---|---|
| HW Aspect | Requirements |
| # of Node(s) | 1 Eliot Edge Node |
| CPU | Minimum 1 socket x86_AMD64 or ARM64. |
| RAM | 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. |
| Disk | 20 GB ~ 256 GB |
| Network | 1 |
Recommended Hardware Requirements
| ELIOT Manager | |
|---|---|
| HW Aspect | Requirements |
| cc | 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. 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 | 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 |
| Disk | 20 GB ~ 256GB (Depending on the overall ELIOT Topology) |
| Networks | 2 Network Interfaces . |
Software Prerequisites
Database Prerequisites
Schema scripts
N/A
Other Installation Requirements
Jump Host Requirements
N/A
Network Requirements
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
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 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
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
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
Frequently Asked Questions
N/A
License
ELIOT source Code is licensed under the Apache Version 2 License. ELIOT Blueprint Documentation is licensed under the Creative Commons Attribution 4.0 International License.