Magma Orchastrator (v1.2.0) on Docker Swarm

Step-by-Step Installation Notes

Links:
Magma Platform: https://github.com/magma/magma
Docker Swarm: https://docs.docker.com/engine/install/debian/

Originally Orchestrator enviroment is designed for deployment on AWS platform.
This guide provides steps and describes how to deploy Orchestrator on your local cloud.

Prerequisites

1. Built and published Orchestrator Containers. See https://magma.github.io/magma/docs/orc8r/deploy_build
2. At least one VM with Debian 10.5 or Ubuntu Server 20.04 installed. It is recommended two or more VMs.

1. MariaDB installation and configuration

All steps are executed on orch1 server only.
1.1 apt install mariadb-server -y
1.2 mysql -u root -p

1.3.create database magma;
1.4 CREATE USER 'magma'@'%' IDENTIFIED BY 'magmaPass'; ### Change 'magmaPass'
1.5 GRANT ALL PRIVILEGES ON magma.* TO 'magma'@'%';

1.6 create database nms;
1.7 CREATE USER 'nms'@'%' IDENTIFIED BY 'nmsPass'; ### Change 'nmsPass'
1.8 GRANT ALL PRIVILEGES ON nms.* TO nms@'%';
1.9 FLUSH PRIVILEGES;
1.10 exit

1.11 In a file /etc/mysql/mariadb.cnf. Put to the end sql_mode="ANSI_QUOTES"
1.12 In a file /etc/mysql/my.cnf put bind-address = 0.0.0.0 in [mysqld] section.
1.13 service mariadb restart

2. Docker Swarm Installation

All steps are executed on both servers, orch1 and orch2

2.1 apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common -y
2.2 curl -fsSL https://download.docker.com/linux/debian/gpg | apt-key add -
2.3 add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable"
2.4 apt update
2.5 apt install docker-ce docker-ce-cli containerd.io -y
2.6 systemctl start docker && systemctl enable docker

3. Docker Swarm Activation

On orch1 VM. (Please don't forget to change IP address):

3.1 docker swarm init --advertise-addr 172.18.10.2
Orch1 became Master Swarm node
3.2 Copy output string from previous command (something like "docker swarm join --token XXXXX")
Then, on orch2 VM:
3.3 Apply the command which you've copied on step 3.2
On orch1, label nodes:
3.4 docker node update --label-add controller=true orch1
3.5 docker node update --label-add metrics=true orch2

4. Metrics node preconfiguration

On orch2:

4.1 mkdir -p /magma
4.2 mkdir -p /magma/userGrafanaData
4.3 mkdir -p /magma/prometheus
4.4 mkdir -p /magma/prometheus-configurer/config
4.5 mkdir -p /magma/alertmanager-configurer/configs
4.6 wget https://raw.githubusercontent.com/magma/magma/v1.2/orc8r/cloud/docker/metrics-configs/prometheus.yml -P /magma/prometheus-configurer/configs/
4.7 wget https://raw.githubusercontent.com/magma/magma/v1.2/orc8r/cloud/docker/metrics-configs/alertmanager.yml -P /magma/alertmanager-configurer/configs/
4.8 wget https://raw.githubusercontent.com/magma/magma/v1.2/orc8r/cloud/docker/fluentd/conf/fluent.conf -P /magma/fluentd/conf/
4.9 chmod -R 777 /magma

5. Controller node preconfiguration

On Orch1:

5.1 mkdir -p /magma
5.2 mkdir -p /magma/certs
5.3 mkdir -p /magma/fluentd
5.4 mkdir -p /magma/fluentd/conf
5.5 mkdir -p /magma/docker_ssl_proxy
5.6 wget https://raw.githubusercontent.com/magma/magma/v1.2/orc8r/cloud/docker/fluentd/conf/fluent.conf -P /magma/fluentd/conf/
5.7 wget https://raw.githubusercontent.com/magma/magma/v1.2/nms/app/packages/magmalte/docker/docker_ssl_proxy/proxy_ssl.conf -P /magma/docker_ssl_proxy
5.8 wget https://raw.githubusercontent.com/magma/magma/v1.2/nms/app/packages/magmalte/docker/docker_ssl_proxy/cert.pem -P /magma/docker_ssl_proxy
5.9 wget https://raw.githubusercontent.com/magma/magma/v1.2/nms/app/packages/magmalte/docker/docker_ssl_proxy/key.pem -P /magma/docker_ssl_proxy

6. Create Certificate chain

On Orch1:

6.1 wget https://raw.githubusercontent.com/edaspb/Magma-Orchastrator-in-a-Docker-Swarm/master/scripts/certs.sh
6.2 Open certs.sh script, put your data: Country, Company, email, etc.
6.3 chmod +x certs.sh
6.4 ./certs.sh

7. Roll out Controller and Metrics stack

On Orch1:

7.1 wget https://raw.githubusercontent.com/edaspb/Magma-Orchastrator-in-a-Docker-Swarm/master/compose/docker-compose-controller.yml
7.2 wget https://raw.githubusercontent.com/edaspb/Magma-Orchastrator-in-a-Docker-Swarm/master/compose/docker-compose-metrics.yml

Please modify docker-compose-controller.yml and docker-compose-metrics.yml according to your repo/images/lables names.

7.3 docker stack deploy --compose-file docker-compose-controller.yml magma
7.4 docker stack deploy --compose-file docker-compose-metrics.yml magma

8. Create NMS Certificate

On Orch1:

8.1 export cntrl_con=magma_controller.1.$(docker service ps -f 'name=magma_controller.1' magma_controller -q --no-trunc | head -n1)
8.2 docker exec -it $cntrl_con bash -c "envdir /var/opt/magma/envdir /var/opt/magma/bin/accessc add-admin -duration 3650 -cert /var/opt/magma/bin/admin_operator admin_operator"
8.3 docker exec -it $cntrl_con bash -c "openssl pkcs12 -export -out /var/opt/magma/bin/admin_operator.pfx -inkey /var/opt/magma/bin/admin_operator.key.pem -in /var/opt/magma/bin/admin_operator.pem"
(press Enter twice)
8.4 for certfile in admin_operator.pem admin_operator.key.pem admin_operator.pfx; do docker cp ${cntrl_con}:/var/opt/magma/bin/${certfile} /magma/certs/${certfile}; done

9 Roll out NMS stack

On Orch1:

9.1 wget https://raw.githubusercontent.com/edaspb/Magma-Orchastrator-in-a-Docker-Swarm/master/compose/docker-compose-nms.yml

Please modify docker-compose-nms.yml according to your repo/images/lables names.

9.2 docker stack deploy --compose-file docker-compose-nms.yml magma
Wait few minutes...
9.3 export nms_con=magma_magmalte.1.$(docker service ps -f 'name=magma_magmalte.1' magma_magmalte -q --no-trunc | head -n1)
9.4 docker exec -it $nms_con yarn migrate
9.5 docker exec -it $nms_con yarn setAdminPassword master [email protected] YourPassNot1234