A declarative host provisioning system.
Go to file
Dimitrios Markou a995d86b37 [Bug fix] Remove "clean" from "chart" target
In Makefile there is a "clean" target as prerequisite to "chart"
target. That causes problems because it removes the "build" directory
that was created at the begining of the file and the helm_install.sh
script cannot write to the "build" directory in subsequent step [0].

[0]: https://github.com/openstack/airship-drydock/blob/master/tools/helm_install.sh#L30

Change-Id: Ic608630c38ff3ad7caf3a4d42e0b318d0d9d4d7e
Signed-off-by: Dimitrios Markou <dm844v@att.com>
2018-11-02 13:38:14 -05:00
alembic (format): yapf reformat 2018-07-27 20:16:25 -05:00
charts/drydock Merge "Add release uuid to pods and rc objects (drydock)" 2018-10-04 21:27:18 +00:00
docs Merge "Support multiple rack controllers" 2018-10-23 18:52:25 +00:00
etc/drydock Catchup YAPF formatting 2018-09-26 08:57:51 -05:00
go/src/baclient Bootaction client initial implementation 2018-09-06 16:33:15 -05:00
images/drydock Merge "Fix: git commit id labels on images" 2018-10-03 00:14:27 +00:00
python Merge "Support multiple rack controllers" 2018-10-23 18:52:25 +00:00
tools Merge "Add release uuid to pods and rc objects (drydock)" 2018-10-04 21:27:18 +00:00
.dockerignore Refactor build to include Go 2018-09-04 13:13:21 -05:00
.gitignore Refactor build to include Go 2018-09-04 13:13:21 -05:00
.gitreview Update .gitreview for openstack infra 2018-05-17 19:23:48 +01:00
.style.yapf Fix issues failing CI pipeline 2017-08-24 10:18:11 -05:00
.zuul.yaml (zuul) Consolidate tests 2018-07-20 08:52:44 -05:00
LICENSE Initial commit 2017-02-14 17:23:35 -05:00
Makefile [Bug fix] Remove "clean" from "chart" target 2018-11-02 13:38:14 -05:00
README.md Fix: various documentation and URL fixes 2018-09-26 08:21:14 +00:00
alembic.ini DRYD47 - Task persistance and refactor 2017-10-26 14:54:25 -05:00
entrypoint.sh uWSGI http-timeout option 2018-02-07 13:38:13 -06:00
hostdeps.sh (zuul) Improve image building 2018-08-10 21:09:50 +00:00
requirements-host-test.txt (zuul) Improve image building 2018-08-10 21:09:50 +00:00
requirements-host.txt Security update: Update pyghmi to avoid pycrypto 2018-09-11 20:37:08 -05:00
tox.ini Security update: Update pyghmi to avoid pycrypto 2018-09-11 20:37:08 -05:00

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