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.
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
The Deployment Architecture consists of the following nodes
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.
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.
ELIOT Master Node | |
---|---|
HW Aspect | Requirements |
# of Node(s) | A virtual machine hosted in any Cloud Provider having internet connectivity. |
# of CPU | 8 |
Architecture | x86_AMD64 or ARM64. |
RAM | 8 GB |
Disk | 120 GB ~ 512GB |
Networks | 1 |
IOTGateway Node(s) | |
---|---|
HW Aspect | Requirements |
# of Node(s) | 1 MEC Host |
# of CPU | 4 |
Architecture | x86_AMD64 or ARM64. |
RAM | 4 GB |
Disk | 20 GB ~ 256 GB |
Network | 1 |
Note: The above specifications are given considering the ELIOT CI / CD environment. User can try lower configuration considering lightweight components being used.
ELIOT Master Node | |
---|---|
HW Aspect | Requirements |
# of Node(s) | A virtual machine hosted in any Cloud Provider having internet connectivity. |
# of CPU | 8 |
Architecture | x86_AMD64 or ARM64. |
RAM | 8 GB |
Disk | 120 GB ~ 512GB |
Networks | 1 |
IOTGateway Node(s) | |
---|---|
HW Aspect | Requirements |
# of Node(s) | 1 MEC Host |
# of CPU | 4 |
Architecture | x86_AMD64 or ARM64. |
RAM | 4 GB |
Disk | 20 GB ~ 256 GB |
Network | 1 |
N/A
N/A
N/A
The blueprint provides one click deployment and command-line interface for installing the ELIOT blueprint components.
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.
N/A
N/A
N/A
For Virtual Deployment minimum three Virtual machines, following are the virtual machines and their usage
No | Usage |
---|---|
1 | One Click Deployment Node |
2 | ELIOT Master Node |
3 | IotGateway Node |
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
Login to the Jump Host and perform the below steps:
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
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 eliot/blueprints/iotgateway/playbooks/config.yml
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
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
Currently the verification is manually done.
Components and Services running in ELIOT Master Node
Components and Services running ELIOT IotGateway/ Edge Node
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"
N/A
N/A
N/A
N/A
N/A
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
S. No | Software | Type | Version | License | Remarks |
1. | Kubespray | K8S Tool | 2.14.2 | Apache 2.0 license | No code modifications done |
2. | Helm | Application Package Manager | 3.0.2 | Apache 2.0 license | No code modifications done |
ELIOT Master Node
S. No | Software | Type | Version | License | Remarks |
1. | Docker | CRI | 19.03+ | Apache 2.0 license | No code modifications done |
2. | Kubernetes | Orchestration | v1.17.2 | Apache 2.0 license | No code modifications done |
3. | Helm | Application Package Manager | 3.0.2 | Apache 2.0 license | No code modifications done |
4. | Grafana | Monitoring MEC-Graphana | 7.1.1 | Apache 2.0 license | Code part of Edge Gallery |
5. | Calico | CNI Plugin | 3.16.5 | Apache 2.0 license | No code modifications done |
6. | PostgresSQL | MECM-Service | 12.3 | PostgreSQL License | Code part of Edge Gallery |
7. | AppLCM | MECM-Service | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
8. | Appo | MECM-Service (MECM-Appo) | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
9 | Inventory | MECM-Service | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
10 | Apm | MECM-Service | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
11 | User Management | Part of Center Node | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
12 | MECM - FrontEnd | MECM-Service | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
13. | Appstore | Service (Part of Center Node) | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
14. | Developer Portal | Service (Part of Center Node) | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
15 | Service Center | Service (Part of Center Node) | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
16 | Hawkbit | Kubernetes Pod | latest container 0.3.0M6 | Apache 2.0 license |
EDGE / IotGateway Node
S. No | Software | Type | Version | License Information | Remarks |
1. | Docker | CRI | 19.03+ | Apache 2.0 license | No code modifications done |
2. | K3S | Orchestration | 1.19.4+ | Apache 2.0 license | No code modifications done |
3. | Helm | Application Package Manager | 3.0.2 | Apache 2.0 license | No code modifications done |
4. | cAdvisor | Container Metrics | v0.36.0 | Apache 2.0 license | No code modifications done |
5 | RabbitMQ | Message Broker | 3.7 | Mozilla Public License | No code modifications done. RabbitMQ image is deployed as is. |
6 | Prometheus | Metrics Collector | 9.3.1 | Apache 2.0 license | Code part of Edge Gallery |
7 | mepm-postgres | Service Database | 12.3 | PostgreSQL License | Code part of Edge Gallery |
8 | MEP | Pod | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
9 | MECM-MEPM | MEPM-Service | 0.9 | Apache 2.0 license | Code part of Edge Gallery |
10 | OPC-UA | IoT Protocol | Geneva | Apache 2.0 license | Upstream |
11 | EdgeX | Services | Edinburgh | Apache 2.0 license | Upstream |
Abbreviations