airship/maas
Code Issues Proposed changes
Kubernetes deployment artifacts for Canonical's MaaS.
158 Commits 1 Branch 0 Tags 3.6 MiB
Smarty 54.3%
Dockerfile 28.9%
Makefile 5.7%
Shell 5.6%
Python 5.5%
2bef79e523
Go to file
Drew Walters 2bef79e523 Add SECURITY.md 
All Airship projects are moving to GitHub issues. This change adds a
GitHub security policy that links to the official Airship vulnerability
management process [0]. When users on GitHub click "New Issue" on this
GitHub repository, they will see an option to report a security
vulnerability, which will direct them to our official policy.

[0] https://airship-docs.readthedocs.io/en/latest/security/vulnerabilities.html

Change-Id: Iaf060dd0085c21f0c4f18f100e3e053b5ceedbed
Signed-off-by: Drew Walters <andrew.walters@att.com>
2020-02-20 17:09:47 -06:00
.github Add SECURITY.md 2020-02-20 17:09:47 -06:00
charts/maas Merge "Add log_level attribute in the Chart to allow overwrite of default" 2020-02-17 17:28:17 +00:00
images maas-rack image: improve IPMI error handling 2019-11-29 09:42:45 -08:00
tools Added YAML file linting to maas 2020-01-16 16:36:53 +00:00
.gitignore Add .gitignore to repo 2018-08-22 21:24:27 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:52:21 +00:00
.zuul.yaml Added YAML file linting to maas 2020-01-16 16:36:53 +00:00
LICENSE Initial commit 2017-10-19 11:42:23 -05:00
Makefile (cache) Configurable Ubuntu release 2019-09-27 19:19:46 +00:00
README.md Add image cache sidecar 2017-12-04 12:50:30 -06:00

README.md

MaaS Helm Artifacts

This repository holds artifacts supporting the deployment of Canonical MaaS in a Kubernetes cluster.

Images

The MaaS install is made up of two required imags and one optional image. The Dockerfiles in this repo can be used to build all three. These images are intended to be deployed via a Kubernetes Helm chart.

MaaS Region Controller

The regiond Dockerfile builds a systemD-based Docker image to run the MaaS Region API server and metadata server.

MaaS Rack Controller

The rackd Dockerfile builds a systemD-based Docker image to run the MaaS Rack controller and dependent services (DHCPd, TFTPd, etc...). This image needs to be run in privileged host networking mode to function.

MaaS Image Cache

The cache image Dockerfile simply provides a point-in-time mirror of the maas.io image repository so that if you are deploying MaaS somewhere without network connectivity, you have a local copy of Ubuntu. Currently this only mirrors Ubuntu 16.04 Xenial and does not update the mirror after image creation.

Charts

Also provided is a Kubernetes Helm chart to deploy the MaaS pieces and integrates them. This chart depends on a previous deployment of Postgres. The recommended avenue for this is the Openstack Helm Postgres chart but any Postgres instance should work.

Overrides

Chart overrides are likely required to deploy MaaS into your environment

  • values.labels.rack.node_selector_key - This is the Kubernetes label key for selecting nodes to deploy the rack controller
  • values.labels.rack.node_selector_value - This is the Kubernetges label value for selecting nodes to deploy the rack controller
  • values.labels.region.node_selector_key - this is the Kubernetes label key for selecting nodes to deploy the region controller
  • values.labels.region.node_selector_value - This is the Kubernetes label value for selecting nodes to deploy the region controller
  • values.conf.cache.enabled - Boolean on whether to use the repo cache image in the deployment
  • values.conf.maas.url.maas_url - The URL rack controllers and nodes should use for accessing the region API (e.g. http://10.10.10.10:8080/MAAS)

Deployment Flow

During deployment, the chart executes the below steps:

  1. Initializes the Postgres DB for MaaS
  2. Starts a Pod with the region controller and optionally the image cache sidecar container
  3. Once the region controller is running, deploy a Pod with the rack controller and join it to the region controller.
  4. Initialize the configuration of MaaS and start the image sync
  5. Export an API key into a Kubernetes secret so other Pods can access the API if needed