The guide covers the installation details which are related to Enterprise Applications on Lightweight 5G Telco Edge (EALTEdge) Blueprint.
This is the first release for this blueprint, the 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, MECM and MEC Hosts will be installed. The number of nodes in MECM cluster and MEC Host cluster is configurable.
The MECM is a K8s Cluster and MEC host 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 R3 - 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) MECM
3) MEC Host
Note: The Hardware details provided are of Virtual Machine configurations.
MECM | |
---|---|
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 |
MEC Host(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.
MECM | |
---|---|
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 |
MEC Host(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 | Jump Host (One Click Deployment Node) |
2 | MECM (Controller) |
3 | MEC Host (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
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 MECM and MEC Hosts.
root@akraino-mec-0002:~# vi ealt-inventory.ini
4. Execute the below command
**Setup develop environment -
root@akraino-mec-0002:~# ansible-playbook ealt-all.yml -i ealt-inventory.ini --extra-vars "operation=install mode=dev"
Once the execution is completed in console will see prompt "EALTEdge Environment Installed in unsecured mode , Components Install MECM and MEC Hosts Successfully"
**Setup Production environment
root@akraino-mec-0002:~# ansible-playbook ealt-all.yml -i ealt-inventory.ini --extra-vars "operation=install mode=prod"
Once the execution is completed in console will see prompt "EALTEdge Environment Installed in secured mode , Components Install MECM and MEC Hosts Successfully"
Other Options:
To Install only MECM Node
** Install in unsecured mode - Dev mode
root@akraino-mec-0002:~# ansible-playbook ealt-all.yml -i ealt-inventory.ini --tags "mecm" --extra-vars "operation=install mode=dev"
** Install in secured mode
root@akraino-mec-0002:~# ansible-playbook ealt-all.yml -i ealt-inventory.ini --tags "mecm" --extra-vars "operation=install mode=prod"
To Install only MEC Host
** Install in unsecured mode
root@akraino-mec-0002:~# ansible-playbook ealt-all.yml -i ealt-inventory.ini --tags "mep" --extra-vars "operation=install mode=dev"
** Install in secured mode
root@akraino-mec-0002:~# ansible-playbook ealt-all.yml -i ealt-inventory.ini --tags "mep" --extra-vars "operation=install mode=prod"
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
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:
root@akraino-mec-0002:~#ealt init mecm
root@akraino-mec-0002:~#ealt init mep
Following packages will be installed in the cluster in the respective nodes:-
MECM pkgs: Docker, Kubernetes , Helm, Grafana, Calico, PostgresSQL and AppLCM.
MEC Host pkgs: Docker, K3S, Helm, RabbitMQ, Prometheus, CAdvisor, Kong, Vault, Cert-Manager , PostgresSQL, MEP Server and MEP Agent.
Prerequisite : The EALTEdge Environment should be installed. One MECM and one MEC Host atleast.
Pre-configuration : Need to set the below parameters as environment variables on VM where EALTEdge CLI is being installed.
export ONBOARDPACKAGEPATH= <Path where Application CSAR Package is kept in the Node where CLI is running>
export MECMClusterIP=<IP of MECM Node> #IP of Node where MECM is installed.
export MECMClusterPort=30001 #(Node Port of applcm service running on MECM)
To enable HTTPS Mode while using CLI, additional configurations have to be done. The configurations are as follows:
export CertificateKeyFile=<Path of CA Cert>
export EALTSSLMode=1 #If need to disable https mode modify the flag to 0
export MECMClusterIP='edgegallery.org' #Map the DNS Name to the MECM IP in /etc/hosts file.
Command Supported:-
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.
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 "infra" --extra-vars "operation=uninstall"
root@akraino-mec-0002:~#ansible-playbook ealt-all-uninstall.yml -i ealt-inventory.ini --tags "mecm" --extra-vars "operation=uninstall"
root@akraino-mec-0002:~#ansible-playbook ealt-all-uninstall.yml -i ealt-inventory.ini --tags "mep" --extra-vars "operation=uninstall"
root@akraino-mec-0002:~#ealt clean all
root@akraino-mec-0002:~#ealt clean mecm
root@akraino-mec-0002:~#ealt clean mep
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 |
MECM
S. No | Software | Type | Version | License | Remarks |
1. | Docker | CRI | 18.06 | Apache 2.0 license | |
2. | Kubernetes | Orchestration | 1.16 | Apache 2.0 license | |
3. | Helm | Application Package Manager | 3.0.2 | Apache 2.0 license | |
4. | Grafana | Monitoring | 8-7.66.0 | Apache 2.0 license | |
5. | Calico | CNI Plugin | 3.14.0 | Apache 2.0 license | |
6. | PostgresSQL | DB | 9.6 | PostgreSQL License | |
7. | AppLCM | MECM-Service | 1.0 | Apache 2.0 license | Code is part of Akraino Code Repo. Includes Broker, Helm Plugin and Catalog |
MEC Host
S. No | Software | Type | Version | License Information | Remarks |
1. | Docker | CRI | 19.03 | Apache 2.0 license | |
2. | K3S | Orchestration | 1.18.2 | 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 | Internally its installing following metrics exporter NodeExporter, alertManager, kubeStateMetrics, pushgateway |
7 | Kong | API Gateway | 1.5.1 | Apache 2.0 license | |
8 | Vault | Secret Management | 0.5.0 | Mozilla Public License 2.0 | No code modifications done. Vault image is deployed as is. |
9 | Cert-Manager | Certificate Management | 0.15.0 | Apache 2.0 license | |
10. | Postgres SQL | Database | 9.6 | PostgreSQL License | |
10 | MEP Server | EALTEdge MEP Platform Service | 1.0 | Apache 2.0 license | Code is part of Akraino Code Repository. |
11 | MEP Agent | EALTEdge MEP Agent Library | 1.0 | Apache 2.0 license | Code is part of Akraino Code Repository. |
Abbreviations