A declarative host provisioning system.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Prateek Dodda 67716a7841 Add Docker default AppArmor profile to drydock 3 weken geleden
alembic (format): yapf reformat 1 jaar geleden
charts/drydock Add Docker default AppArmor profile to drydock 1 week geleden
doc Fix: Drydock Exceptions docs rendering on RTD 6 maanden geleden
etc/drydock Add Redfish as OOB driver 1 jaar geleden
go/src/baclient Bootaction client initial implementation 1 jaar geleden
images/drydock Add support for ubuntu bionic base image 1 maand geleden
python Merge "Improve error logging during validation" 4 maanden geleden
tools Add Docker default AppArmor profile to drydock 1 week geleden
.dockerignore Refactor build to include Go 1 jaar geleden
.gitignore Refactor build to include Go 1 jaar geleden
.gitreview OpenDev Migration Patch 10 maanden geleden
.readthedocs.yaml Change RTD config to use Python requirements 5 maanden geleden
.style.yapf Fix issues failing CI pipeline 2 jaren geleden
.zuul.yaml Add Docker default AppArmor profile to drydock 1 week geleden
LICENSE Initial commit 3 jaren geleden
Makefile Add support for ubuntu bionic base image 1 maand geleden
README.md Fix: various documentation and URL fixes 1 jaar geleden
alembic.ini DRYD47 - Task persistance and refactor 2 jaren geleden
entrypoint.sh uWSGI http-timeout option 2 jaren geleden
hostdeps.sh Update image build script to run in a docker 1 maand geleden
requirements-host-test.txt (zuul) Improve image building 1 jaar geleden
requirements-host.txt (fix) Use endpoint for MAAS URL 1 jaar geleden
tox.ini Fix: Drydock Exceptions docs rendering on RTD 6 maanden geleden

README.md

drydock_provisioner

A python REST orchestrator to translate a YAML host topology to a provisioned set of hosts and provide a set of post-provisioning instructions.

See full documentation at https://airship-drydock.readthedocs.io/.

Required

  • Python 3.5+
  • A running instance of Postgres v9.5+
  • A running instance of Openstack Keystone w/ the v3 API enabled
  • A running instance of Canonical MaaS v2.3+
  • A running Kubernetes cluster with Helm initialized
  • Familiarity with the Airship platform suite of services

Building

This service is intended to be built as a Docker container, not as a standalone Python package. That being said, instructions are included below for building as a package and as an image.

Virtualenv

To build and install Drydock locally in a virtualenv first generate configuration and policy file templates to be customized

$ tox -e genconfig
$ tox -e genpolicy
$ virtualenv -p python3.5 /var/tmp/drydock
$ . /var/tmp/drydock/bin/activate
$ pip install -r requirements-lock.txt
$ pip install .
$ cp -r etc/drydock /etc/drydock

Docker image

$ docker build . -t drydock

Running

The preferred deployment pattern of Drydock is via a Helm chart to deploy Drydock into a Kubernetes cluster. Additionally use of the rest of the Airship services provides additional functionality for deploying (Armada) and using (Promenade, Deckhand) Drydock.

You can see an example of a full Airship deployment in the Airship in a Bottle repository.

Stand up Kubernetes

Use the Airship Promenade tool for starting a self-hosted Kubernetes cluster with Kubernetes Helm deployed.

Deploy Drydock Dependencies

There are Helm charts for deploying all the dependencies of Dryodck. Use them for preparing your Kuberentes cluster to host Drydock.

Deploy Drydock

Ideally you will use the Airship Armada tool for deploying the Drydock chart with proper overrides, but if not you can use the helm CLI tool. The below are overrides needed during deployment

  • values.labels.node_selector_key: This is the kubernetes label assigned to the node you expect to host Drydock
  • values.conf.dryodck.maasdriver: This is URL Drydock will use to access the MAAS API (including the URL path)
  • values.images.drydock: The Drydock docker image to use
  • values.images.drydock_db_sync: The Drydock docker image to use