A declarative host provisioning system.

Go to file

Scott Hussey 6d29229b09 Augment document schemas - Update schemas to add some missing allowed properties - Use additionalProperties field to enforce structure of storage devices and network interfaces - Remove duplicate unit tests Change-Id: I8fb98205bc4a99208fc0e26a5724f6c0960a8278		2017-12-01 10:51:09 -06:00
alembic	Implement bootaction API	2017-11-20 16:29:54 -06:00
charts/drydock	Images: Remove Kolla-Toolbox image as not required	2017-11-16 12:08:17 -05:00
docs/source	Implement bootaction API	2017-11-20 16:29:54 -06:00
drydock_provisioner	Augment document schemas	2017-12-01 10:51:09 -06:00
etc/drydock	NoAuth filter for PasteDeploy	2017-11-27 10:12:19 -05:00
examples	Add config generation to tox.ini	2017-08-21 14:35:56 -05:00
tests	Augment document schemas	2017-12-01 10:51:09 -06:00
.dockerignore	Add config generation to tox.ini	2017-08-21 14:35:56 -05:00
.gitignore	Drydock documentation via build_sphinx.	2017-10-06 15:05:41 -04:00
.gitreview	Add gitreview file	2017-08-11 01:14:21 -05:00
.style.yapf	Fix issues failing CI pipeline	2017-08-24 10:18:11 -05:00
alembic.ini	DRYD47 - Task persistance and refactor	2017-10-26 14:54:25 -05:00
Dockerfile	Implement bootaction API	2017-11-20 16:29:54 -06:00
entrypoint.sh	Add config generation to tox.ini	2017-08-21 14:35:56 -05:00
LICENSE	Initial commit	2017-02-14 17:23:35 -05:00
README.md	Refactor orchestrator	2017-10-26 15:00:39 -05:00
requirements-direct.txt	Implement bootaction API	2017-11-20 16:29:54 -06:00
requirements-lock.txt	Create schemas for Drydock YAML docs	2017-11-20 11:14:04 -06:00
requirements-test.txt	Drydock documentation via build_sphinx.	2017-10-06 15:05:41 -04:00
setup.py	Refactor orchestrator	2017-10-26 15:00:39 -05:00
tox.ini	Implement bootaction API	2017-11-20 16:29:54 -06: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 in docs/source/index.rst.

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.2+

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 UCP services provides additional functionality for deploying (Armada) and using (Promenade, Deckhand) Drydock.

You can see an example of a full UCP deployment in the UCP Integration repository.

Stand up Kubernetes

Use the UCP 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 UCP 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