A declarative host provisioning system.

Go to file

Sergiy Markin 29aa06194b Published docker image tags This PS removes static tags from published docker image. We only want to have branch name and commitid as tags for the images in this branch. Change-Id: I0d002792d4d0219cfe0e9f9e639327d6ae632384		2023-08-25 14:57:50 +00:00
.github	Update Airship vulnerability link	2020-05-18 21:24:48 +00:00
alembic	Drydock focal related upgrades	2023-04-26 22:32:49 +00:00
charts	Add ttlSecondsAfterFinished field to cronjob	2023-06-27 16:20:22 -04:00
doc	Drydock updates	2023-04-28 18:39:25 +00:00
etc/drydock	Drydock updates	2023-04-28 18:39:25 +00:00
go/src/baclient	[focal] Python modules sync with Airship project	2023-04-08 08:20:22 +00:00
images/drydock	Drydock updates	2023-08-24 01:45:45 +00:00
python	Restored ubuntu_bionic image build	2023-05-24 18:37:21 +00:00
tools	Drydock updates	2023-08-24 01:45:45 +00:00
.dockerignore	Refactor build to include Go	2018-09-04 13:13:21 -05:00
.gitignore	[focal] Python modules sync with Airship project	2023-04-08 08:20:22 +00:00
.gitreview	OpenDev Migration Patch	2019-04-19 19:52:21 +00:00
.readthedocs.yaml	Drydock focal related upgrades	2023-04-26 22:32:49 +00:00
.style.yapf	Fix issues failing CI pipeline	2017-08-24 10:18:11 -05:00
.zuul.yaml	Published docker image tags	2023-08-25 14:57:50 +00:00
LICENSE	Initial commit	2017-02-14 17:23:35 -05:00
Makefile	Restored ubuntu_bionic image build	2023-05-24 18:37:21 +00:00
README.md	Drydock focal related upgrades	2023-04-26 22:32:49 +00:00
alembic.ini	DRYD47 - Task persistance and refactor	2017-10-26 14:54:25 -05:00
bindep.txt	Restored ubuntu_bionic image build	2023-05-24 18:37:21 +00:00
entrypoint.sh	uWSGI http-timeout option	2018-02-07 13:38:13 -06:00
tox.ini	Restored ubuntu_bionic image build	2023-05-24 18:37:21 +00: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+

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-frozen.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