Introduction

The guide covers the installation details which are related to ELIOT Iot Gateway Blueprint.  

This guide covers detailed information of the various types of deployments, detailed steps and what are the various components it will install. In addition, the guide provides information on hardware requirements, prerequisite software and minimum hardware requirements. On successful deployment, Center and Edge Nodes will be installed. The number of nodes in Center cluster and Edge node in the cluster is configurable. 

The CENTER Node is a K8s Cluster and EDGE Node is a K3s 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.

In BP first release Two types of installation mechanisms are provided, as below 

1. Ansible-Playbook single command
2. Command Line Interface (CLI)

Deployment Architecture

The Deployment Architecture consists of the following nodes

• One-Click Deployment Node
• ELIOT Master Node
• IotGateway Node

Note: For Development environment two nodes  is sufficient, where one node plays a dual role of One-Click Deployment Node and  Master Node with other as IotGateway Node.

                                                 Figure: ELIOT Deployment Architecture

Note: ELIOT IotGateway Blueprint Deployment has been tested on Cloud VM and is not tested on Bare-Metal Environment. Though, theoretically deployment should work  in bare metal,  provided hardware and software prerequisites are met. Kindly refer R4 - Test Documentation of Edge Lightweight IotGateway (ELIOT) to get details on the tested deployment.

Pre-Installation Requirements

Hardware Requirements

The number of Hardware requirements depends mainly on the Use Case Scenario and the enterprise scale. A use case can have one Deployment node, ELIOT Master or controller node  with one or multiple IotGateway nodes.

The minimum number of nodes required for a complete ELIOT Topology is three. (Bare-Metal or Virtual Machines) 

1) Deployment Node

2) ELIOT Master

3) ELIOT IotGateway node

Note: The Hardware details provided are of Virtual Machine configurations.

Minimum Hardware Requirements

Note: The above specifications are given considering the ELIOT CI / CD environment. User can try lower configuration considering lightweight components being used.

Recommended Hardware Requirements

Software Prerequisites

• Virtual Machines preinstalled with Ubuntu 16.04 /18.04 for MECM Node.
• Virtual Machines preinstalled with Ubuntu 16.04 / 18.04 or CentOS 7.X for MEC Host Nodes
• root user created in the Deployment Node, MEC Node and MEC Host Node.
• SSH Server running in all the Nodes.
• Ansible > 2.5 installed in One Click Deployment Node (Jump Host)
• git installed in Jump Host.
• Kubespray code is downloaded (https://github.com/kubernetes-sigs/kubespray.git)
• GO Lang (version greater than 1.14.2) installed in Jump Host, required for CLI.

Database Prerequisites

Schema scripts

N/A

Other Installation Requirements

Jump Host Requirements

Network Requirements

• Internet connectivity in OCD Host, ELIOT Master  and IOTGateway Nodes.
• The ELIOT Master Node and EDGE/IotGateway Node should be able to ping each other.

Bare Metal Node Requirements

N/A

Execution Requirements (Bare Metal Only)

N/A

Installation High-Level Overview

The blueprint provides one click deployment and command-line interface for installing the ELIOT blueprint components.

Bare Metal Deployment Guide

Install Bare Metal Jump Host

Note: ELIOT Blueprint Deployment has been tested on Huawei Cloud Virtual Machines and is not tested on Bare-Metal Environment. 

Though theoretically deployment should run successfully in bare metal too provided 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 minimum three Virtual machines, following are the virtual machines and their usage

All the nodes should have internet connectivity , network interface and network connectivity between the  VM's. 

In this release to install the ELIOT environment. 

i)  ELIOT Deployment using Ansible-Playbook single command

Standard Deployment Overview

Jump Host Software Installations:

Login to the Jump Host and perform the below steps:

1. Install Ansible > 2.9.6 [ https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html]
2. Install git
3. Install GoLang > 1.14+
4. Git clone the Kubespray repo. [https://github.com/kubernetes-sigs/kubespray.git]
5. Install python3 and pip3
6. cd kubespray && pip install -r requirements.txt

Jump Host Pre-Configurations for MECM Components Installation 

Login to the Jump Host and perform the below configuration steps (Steps : as below-

1. Generate public key : #ssh-keygen

2. Copy the ssh key to all the nodes in the MECM Cluster, using ssh-copy-id. (example : #ssh-copy-id root@159.178.17.16)

3. Kubespray configuration

      cd kubespray && cp -rfp inventory/sample inventory/mycluster

      Update ansible inventory file provided in kubesrpay repo with MECM Cluster node IP's 

      Example: 

       declare -a IPS=(158.176.15.55 158.176.15.56 158.176.15.57)

       CONFIG_FILE=inventory/mycluster/hosts.yaml python3 contrib/inventory_builder/inventory.py ${IPS[@]}

4. Review and Change Parameters under inventory/mycluster/group_vars

        cat inventory/mycluster/group_vars/all/all.yml
        cat inventory/mycluster/group_vars/k8s-cluster/k8s-cluster.yml

5. Alter the config.yml and change parameters under path NEED TO BE PROVIDED

Installing Mode : ELIOT using Ansible-Playbooks

1. git clone the eliot repo, to download the software to install the ELIOT Environment.

root@akraino-mec-0002:~# git clone "https://gerrit.akraino.org/r/eliot"

2. go to the below directory 

root@akraino-mec-0002:~# cd eliot/blueprints/iotgateway/playbooks

3. Modify the Configuration File : eliot-inventory.ini with the details of Master and Edge/IotGateway Nodes. 

root@akraino-mec-0002:~# vi eliot-inventory.ini

4. Execute the below command 
Setup environment - 

root@akraino-mec-0002:~# ansible-playbook eliot-all.yml -i eliot-inventory.ini --extra-vars "operation=install"

Once the execution is completed in console will see prompt "ELIOTEdge Environment Installed  , Components Install ELIOT Master and EDGE Nodes Successfully"

Other Options:

To Install only Edge node
root@akraino-mec-0002:~# ansible-playbook eliot-all.yml -i eliot-inventory.ini --tags "edge" --extra-vars "operation=install"

Snapshot Deployment Overview

Not Applicable

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 IotGateway Deployment

Currently the verification is manually done. 

1. Login to the Master Node and check whether K8S cluster is installed. 
2. Check the below mentioned components and services are running as Pods / Services in Kubernetes cluster
   1. PostgresSQL
   2. AppLCM
   3. Appo
   4. Inventory
   5. Apm
   6. MECM - FrontEnd
   7. Appstore
   8. Developer Portal
   9. Service Center
   10. User Management
   11. Hawkbit
3. Login to Edge Host and check K3S is installed. 

Components and Services running in ELIOT Master Node

Components and Services running ELIOT IotGateway/ Edge Node

Developer  Guide and Troubleshooting

Uninstall Guide

Using Ansible Playbooks

root@akraino-mec-0002:~#ansible-playbook eliot-all-uninstall.yml -i eliot-inventory.ini --extra-vars "operation=uninstall"
root@akraino-mec-0002:~#ansible-playbook eliot-all-uninstall.yml -i eliot-inventory.ini --tags "edge" --extra-vars "operation=uninstall"

Troubleshooting

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 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.

License information of ELIOT Blueprint  Components

OCD Host

ELIOT Master Node

EDGE / IotGateway Node

References

Definitions, acronyms and abbreviations

Abbreviations

• ELIOT - Edge Lightweight IotGateway
• MECM - Multi Access Edge Computing Manager.
• MEC - Multi Access Edge Computing.
• MEP - Multi Access Edge Platform.