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 K8s Cluster worker node.
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 ELIOT R6 - IoT Gateway Test Document 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 2. (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 2 Virtual machines, following are the virtual machines(OCD and Master on same node) 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 :
2. Setup password-less login -
# Open file: vi /etc/ssh/sshd_config
- PermitRootLogin yes
- PasswordAuthentication yes
# Restart ssh service:
- sudo systemctl restart ssh.service
For EdgeGallery AIO mode:
Login from ocd to center and ocd to edge in a single node.
For EdgeGallery Muno mode:
Login from ocd to center in a controller node
Login from ocd to edge in a edge node
3. These command are require in both AIO and MUNO(Controller and Edge Node ) mode.
cp -p /etc/passwd /etc/passwd.bkp
cp -p /etc/group /etc/group.bkp
id ubuntu
groupmod -g 600 ubuntu
id ubuntu
4. Review and Change Parameters
For EdgeGallery AIO Mode:
eliot/blueprints/iotgateway/playbooks/hosts-aio
eliot/blueprints/iotgateway/playbooks/var.yml
eliot/blueprints/iotgateway/playbooks/password-var.yml
&
in it. Otherwise, the deployment will failed because of these simple passwords.
For EdgeGallery MUNO Mode:
eliot/blueprints/iotgateway/playbooks/muno-config/controller/hosts-muno-controller
eliot/blueprints/iotgateway/playbooks/muno-config/controller/var.yml
CONTROLLER_MASTER_IP: Uncomment the PORTAL_IP and use private IP of a the Controller node
eliot/blueprints/iotgateway/playbooks/muno-config/edge/hosts-muno-edge
eliot/blueprints/iotgateway/playbooks/muno-config/edge/var.yml
eliot/blueprints/iotgateway/playbooks/password-var.yml
&
in it. Otherwise, the deployment will failed because of these simple passwords.
For ELIOT stack:
eliot/blueprints/iotgateway/playbooks/eliot-inventory.ini
1. git clone the eliot repo, to download the software to install the ELIOT Environment.
root@akraino-mec-0001:~# git clone "https://gerrit.akraino.org/r/eliot"
2. go to the below directory
root@akraino-mec-0001:~# 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
For Edge Gallery installation:
MUNO-Mode:
Execute the below command:
cd eliot/blueprints/iotgateway/playbooks
ansible-playbook -i muno-config/controller/hosts-muno-controller eliot-eg-muno-controller.yml --extra-vars "operation=install" -e "ansible_user=root"
ansible-playbook -i muno-config/edge/hosts-muno-edge eliot-eg-muno-edge.yml --extra-vars "operation=install" -e "ansible_user=root"
For AIO mode:
Execute the below command
cd ealt-edge/ocd/infra/playbooks
ansible-playbook eliot-eg-aio-latest.yml -i hosts-aio --extra-vars "operation=install" -e "ansible_user=root"
FOR ELIOT Stack:
Execute the below command
Setup environment -
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"
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
Currently the verification is manually done.
For muno mode
Components and Services running in ELIOT Controller node
Components and Services running ELIOT Edge Node
Deploy Application in ELIOT
1.1 click on Systems ->App LCM ->New Registration
Name: Applcm(any general name)
IP: applcm"public ip"
Port: 30204
1.2. click on Systems ->App Store ->New Registration
App Store Name: appstore(any general name)
IP: Appstore public ip
Port: 30099
Appstore Repo: {HarborIP:443}(192.168.1.1:443)
Repo Name: appstore(any general name)
Repo Username: admin(harbor user name)
Repo Password: Harbor12345(harbor password)
Vendor: vendor(any general name)
2. Login to Developer Portal https://ip:30092
2.1. Add sandbox env to deploy application before publish
Click System ->Host Management ->Add Host
Name: general name
System: k8s
Lcmip: sandbox ip(for testing purpose can provide edge ip, if no sandbox env)
mecHost: sandbox ip(for testing purpose can provide edge ip, if no sandbox env)
Port: 31252
Protocol: https
Architecture: X86
Status: Normal
Port Range: leave as it is
Address: Bangalore
UploadConfig File: upload sandboxenvkubeconfig file
3. Login to MECM Portal https://ip:30093
3.1. Add k8s node:
Click on Edge Nodes ->New Rgistration
VM: k8s
Name: edge1
IP: edge public ip
Location: select from drop down
Address: yanta
Coordinates: 116.39,39.90
Architecture: x86
Capabilities: select none
MEPM: select applcm node from dropdown
3.2. Download /root/.kube/config file from edge node
And click on Upload config file to upload.
4. Demonstration of application Development & Deployment
4.1 Application Development
link - https://www.youtube.com/watch?v=AjQNG5d3p84&t=23s
4.2 Application Deployment
link - https://www.youtube.com/watch?v=PbxKpslVnmc&t=31s
root@akraino-mec-0001:~#ansible-playbook eliot-all-uninstall.yml -i eliot-inventory.ini --extra-vars "operation=uninstall"
For MUNO Mode
root@akraino-mec-0001:~#ansible-playbook -i muno-config/controller/hosts-muno-controller eliot-eg-muno-controller.yml --extra-vars "operation=uninstall" -e "ansible_user=root"
root@akraino-mec-0001:~#ansible-playbook -i muno-config/edge/hosts-muno-edge eliot-eg-muno-edge.yml --extra-vars "operation=uninstall" -e "ansible_user=root"
For AIO Mode
root@akraino-mec-0001:~#ansible-playbook -i hosts-aio eliot-eg-aio-latest.yml --extra-vars "operation=uninstall" -e "ansible_user=root"
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
ELIOT Master Node
S. No | Software | Type | Version | License | Remarks |
1. | Docker | CRI | 18.09 | Apache 2.0 license | No code modifications done |
2. | Kubernetes | Orchestration | v1.18.7 | Apache 2.0 license | No code modifications done |
3. | Edge Gallery | Open Source MEC Platform | 1.1.1 | Apache 2.0 license | Open Source MEC Platform |
4. | Grafana | Monitoring | 7.1.1 | Apache 2.0 license |
EDGE / IotGateway Node
S. No | Software | Type | Version | License Information | Remarks |
1. | Docker | CRI | 18.09 | Apache 2.0 license | No code modifications done |
2. | K8s | Orchestration | 1.18.7 | Apache 2.0 license | No code modifications done |
3. | Edge Gallery | Open Source MEC Platform | 1.1.1 | 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. | OPC-UA | IoT Protocol | Geneva | Apache 2.0 license | Upstream |
11 | EdgeX | Services | Edinburgh | Apache 2.0 license | Upstream |
Abbreviations