The guide covers the installation details which are related to Enterprise Applications on Lightweight 5G Telco Edge (EALTEdge) 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 MECM Node with other as MEC Host.
Figure: EALTEdge Deployment Architecture
Note: EALTEdge 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 Enterprise Applications on Lightweight 5G Telco Edge (EALTEdge) 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 MECM Cluster with one or multiple MEC Host clusters.
The minimum number of nodes required for a complete EALTEdge Topology is three. (Bare-Metal or Virtual Machines)
1) Deployment Node
2) Center Node
3) Edge Node
Note: The Hardware details provided are of Virtual Machine configurations.
CENTER 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 |
EDGE 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 EALTEdge CI / CD environment. User can try lower configuration considering lightweight components being used.
CENTER 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 |
EDGE 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 EALTEdge blueprint components.
Note: EALTEdge 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 | CENTER Node |
3 | EDGE Node |
All the nodes should have internet connectivity , network interface and network connectivity between the VM's.
In this release providing two ways to install the EALTEdge environment.
i) EALTEdge Deployment using Ansible-Playbook single command.
ii) EALTEdge Deployment using CLI
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
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
1. git clone the ealt-edge repo, to download the software to install the EALTEdge Environment.
root@akraino-mec-0002:~# git clone "https://gerrit.akraino.org/r/ealt-edge"
2. go to the below directory
root@akraino-mec-0002:~# cd ealt/infra/playbooks
3. Modify the Configuration File : ealt-inventory.ini with the details of CENTER and EDGE Nodes.
root@akraino-mec-0002:~# vi ealt-inventory.ini
4. Execute the below command
**Setup environment -
root@akraino-mec-0002:~# ansible-playbook ealt-all.yml -i ealt-inventory.ini --extra-vars "operation=install"
Once the execution is completed in console will see prompt "EALTEdge Environment Installed , Components Install CENTER and EDGE Nodes Successfully"
Other Options:
To Install only Edge node
root@akraino-mec-0002:~# ansible-playbook ealt-all.yml -i ealt-inventory.ini --tags "edge" --extra-vars "operation=install"
1. git clone the ealt-edge repo, to download the software to install the EALTEdge Environment.
root@akraino-mec-0002:~# git clone "https://gerrit.akraino.org/r/ealt-edge"
2. go to CLI directory
root@akraino-mec-0002:~#cd ealt/infra/cli/
root@akraino-mec-0002:~#chmod +x build _cli.sh
root@akraino-mec-0002:~#source build_cli.sh
root@akraino-mec-0002:~#cd ~/ealt-edge/ocd/infra/playbooks
Note: The CLI Commands to setup the environment should be executed only from above path.
3. Edit the Configuration File : ealt-inventory.ini with the details of MECM and MEC Hosts.
root@akraino-mec-0002:~#vi ealt-inventory.ini
4. Execute the below command to install EALTEdge Environment
root@akraino-mec-0002:~#ealt init all
Above command will install the various component. Refer the below table for detail information.
Other CLI Commands:
Command to Install only Edge Node
root@akraino-mec-0002:~#ealt init edge
This feature is currently not supported in Release 4. Will be modified based on the upstream EdgeGallery Project's feature on the next Release.
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 CENTER Node
Components and Services running EDGE Node
root@akraino-mec-0002:~#ansible-playbook ealt-all-uninstall.yml -i ealt-inventory.ini --extra-vars "operation=uninstall"
root@akraino-mec-0002:~#ansible-playbook ealt-all-uninstall.yml -i ealt-inventory.ini --tags "edge" --extra-vars "operation=uninstall"
root@akraino-mec-0002:~#ealt clean all
root@akraino-mec-0002:~#ealt clean edge
N/A
N/A
N/A
N/A
N/A
Any software developed by the "Akraino Enterprise Applications on Lightweight 5G Telco Edge Project 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 EALTEdge Blueprint Components
OCD Host
S. No | Software | Type | Version | License | Remarks |
1. | Kubespray | K8S Tool | 2.13 | Apache 2.0 license | |
2. | Helm | Application Package Manager | 3.0.2 | Apache 2.0 license |
CENTER Node
Center Node consists of 3 components . MECM , Appstore and Developer Portal.
Refer:
MECM Edge Gallery http://docs.edgegallery.org/zh_CN/latest/Projects/MECM/MECM.html#
S. No | Software | Type | Version | License | Remarks |
1. | Docker | CRI | 19.03+ | Apache 2.0 license | |
2. | Kubernetes | Orchestration | 1.19.3 | Apache 2.0 license | |
3. | Helm | Application Package Manager | 3.0.2 | Apache 2.0 license | |
4. | Grafana | Monitoring MEC-Graphana | 8-7.66.0 | Apache 2.0 license | Code part of Edge Gallery |
5. | Calico | CNI Plugin | Apache 2.0 license | ||
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 |
Edge Node
S. No | Software | Type | Version | License Information | Remarks |
1. | Docker | CRI | 19.03+ | Apache 2.0 license | |
2. | K3S | Orchestration | Apache 2.0 license | ||
3. | Helm | Application Package Manager | 3.0.2 | Apache 2.0 license | |
4. | cAdvisor | Container Metrics | v0.36.0 | Apache 2.0 license | |
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 | 9.6 | 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 |
Abbreviations