Introduction

The guide covers the installation details which are related to Enterprise Applications on Lightweight 5G Telco Edge (EALT) 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 MEP nodes will be installed. The number of nodes in MECM cluster and MEP cluster is configurable. 

The MECM is a K8S Cluster and MEP is as 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.

Two types of installation mechanisms are provided in this release 

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

Deployment Architecture

The Deployment Architecture consists of three nodes One Click Deployment Node,  MECM and a single MEP Edge Node.

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 MEP Edge Node.

Pre-Installation Requirements

Hardware Requirements

Number of Hardware requirements depends mainly on the Use Case Scenario and the enterprise scale. A use case can have one MECM Cluster ,  with single or multiple MEP Edge Nodes cluster.

Minimum number of nodes required for a complete EALT Topology is three. (Bare-Metal or Virtual Machines) 

1) Deployment Node

2) MECM

3) MEP Edge Node

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

Minimum Hardware Requirements

Recommended Hardware Requirements

Software Prerequisites

• Virtual Machines preinstalled with Ubuntu 16.04 or 18.04
• root user created in the Deployment Node, MEC Node and MEP 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.12) installed in Jump Host, required for CLI.

Database Prerequisites

Schema scripts

N/A

Other Installation Requirements

Jump Host Requirements

Network Requirements

• Internet connectivity in Jump Host, MECM  and MEP Nodes.
• The MECM Master Node and MEP Master 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 single command and command line interface for installing the EALT blueprint components.

Bare Metal Deployment Guide

Install Bare Metal Jump Host

Currently EALT Blueprint Deployment have been done in Huawei Cloud Virtual Machines. The scripts will run successfully in bare metal hardware too, if the hardware and software prerequisites are met. Refer section Virtual Deployment Guide for deployment steps.

Note : EALT blueprint installation is not done or tested in Bare-Metal Environment.

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 providing two ways to install the EALT environment. 

i)  EALT Deployment using Ansible-Playbook single command.

ii) EALT Deployment using CLI

Standard Deployment Overview

Jump Host Software Installations:

Login to the Jump Host and perform the below steps:

1. Install Ansible > 2.5.[ https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html]
2. Install git
3. Install GoLang > 1.12
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 :

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

Installing Mode : EALT using Ansible-Playbooks

1. git clone the ealt repo, to download the software to install the EALT 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 MEP Nodes. 

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

4. Execute the below command 

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 "EALT Environment Installed  , Components Install MECM and MEP Nodes Successfully"

Other Options:

To Install only MECM Node

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

To Install only MEP Node

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

Installing Mode : EALT using CLI

1. git clone the ealt repo, to download the software to install the EALT 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 MEP Nodes. 

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

4. Execute the below command to install EALT 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

MEP

Deploying Application Packages : Using CLI

Precondition : The EALT Environment should be installed.  One MECM and one MEP Node atleast.

Pre-configuration : Need to set the below parameters as environment variables on VM where EALT 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)

Command Supported:-

Application Package Management CLI Commands:

1. Package On Boarding : root@akraino-mec-0002:~#ealt app create -f "sample_app.csar "
2. Package Info Query: root@akraino-mec-0002:~#ealt app info -i "<package id number>"
3. Package Delete: root@akraino-mec-0002:~#ealt app delete -i "<package id number>"

Application Life Cycle Management CLI Commands:

1. Application Instance Creation on MEP Node: root@akraino-mec-0002:~#ealt applcm create -i appdid "<id>" -n "<name>" -d "<description>"
2. To start the application instance on MEP Node: root@akraino-mec-0002:~#ealt applcm start -i appid "<id>" -n "<hostname>" -o "<hostip>"
3. To get the application instance details : root@akraino-mec-0002:~#ealt applcm info -i appid "<id>"
4. To terminate the application instance: root@akraino-mec-0002:~#ealt applcm kill -i appid "<id>"
5. To delete the application on MEP Node: root@akraino-mec-0002:~#ealt applcm delete -i appid "<id>"

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

Currently the verification is manually done. 

1. Login to the MECM Node and check whether K8S cluster is installed. 
2. Check grafana and AppLCM services are running as PODS. 
3. Login to MEP Node and check K3S is installed. 

Developer  Guide and Troubleshooting

Uninstall Guide

Using Ansible Playbooks

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"

Using CLI

root@akraino-mec-0002:~#ealt clean all 
root@akraino-mec-0002:~#ealt clean mecm
root@akraino-mec-0002:~#ealt clean mep

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

References

Definitions, acronyms and abbreviations

Abbreviations

• EALTEdge - Enterpreise Application on Lightweight 5G Telco Edge (EALTEdge).
• MECM - Mobile Access Edge Controller Manager.
• MEP - Mobile Access Edge Platform.