Charmed Magma Orchestrator

Don't have Juju installed?

Overview

Orchestrator is a Magma service that provides a simple and consistent way to configure and monitor the wireless network securely. The metrics acquired through the platform allows you to see the analytics and traffic flows of the wireless users through the Magma web UI. For more information about Magma, see the official documentation here.

This charm bundle makes it easy to deploy the Orchestrator component in any Kubernetes environment, and it has been tested with all major public cloud platforms.

Usage

Deploy the bundle

From your Ubuntu machine, create an overlay.yaml file that contains the following content:

applications:
  fluentd:
    options:
    domain: <your domain name>
    elasticsearch-url: <your elasticsearch https url>
    fluentd-chunk-limit-size: "2M"
    fluentd-queue-limit-length: 8
  orc8r-certifier:
    options:
      domain: <your domain name>
  orc8r-eventd:
    options:
      elasticsearch-url: <your elasticsearch http url>
  orc8r-nginx:
    options:
      domain: <your domain name>
  tls-certificates-operator:
    options:
      generate-self-signed-certificates: true
      ca-common-name: rootca.<your domain name>

Warning: This configuration is unsecure because it uses self-signed certificates.

Deploy Orchestrator:

Note: Elasticsearch is not part of magma-orc8r bundle and needs to be deployed prior to deploying the bundle. Elasticsearch needs to support both http and https requests.

juju deploy magma-orc8r --overlay overlay.yaml --trust --channel=edge

The deployment is completed when all services are in the Active-Idle state.

Import the admin operator HTTPS certificate

Retrieve the PFX package and password that contains the certificates to authenticate against Magma Orchestrator:

juju scp --container="magma-orc8r-certifier" orc8r-certifier/0:/var/opt/magma/certs/admin_operator.pfx admin_operator.pfx
juju run-action orc8r-certifier/leader get-pfx-package-password --wait

The pfx package was copied to your current working directory and can now be loaded in your browser.

Setup DNS

Retrieve the services that need to be exposed:

juju run-action orc8r-orchestrator/leader get-load-balancer-services --wait

In your domain registrar, create A records for the following Kubernetes services:

Address	Hostname
<orc8r-bootstrap-nginx External IP>	bootstrapper-controller.<your domain>
<orc8r-nginx-proxy External IP>	api.<your domain>
<orc8r-clientcert-nginx External IP>	controller.<your domain>
<nginx-proxy External IP>	*.nms.<your domain>
<fluentd External IP>	fluentd.<your domain>

Verify the deployment

Get the host organization's username and password:

juju run-action nms-magmalte/leader get-host-admin-credentials --wait

Confirm successful deployment by visiting https://host.nms.<your domain> and logging in with the admin-username and admin-password outputted here.