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.
Zuul 7ddf8083d1 Merge "[opendev] Update .gitreview with new URL and repo" 1 day ago
alembic (format): yapf reformat 8 months ago
charts/drydock Add possibility to check response code in auth test 1 week ago
docs Support multiple rack controllers 6 months ago
etc/drydock Add Redfish as OOB driver 4 months ago
go/src/baclient Bootaction client initial implementation 7 months ago
images/drydock images: Allow base image substitution for Drydock 1 month ago
python End user logging for audit traceabilty 3 weeks ago
tools (zuul) Fix image publish post pipeline 2 weeks ago
.dockerignore Refactor build to include Go 7 months ago
.gitignore Refactor build to include Go 7 months ago
.gitreview [opendev] Update .gitreview with new URL and repo 1 day ago
.style.yapf Fix issues failing CI pipeline 1 year ago
.zuul.yaml CI: Add chart build job for latest Helm toolkit 2 weeks ago
LICENSE Initial commit 2 years ago
Makefile images: Allow base image substitution for Drydock 1 month ago
README.md Fix: various documentation and URL fixes 6 months ago
alembic.ini DRYD47 - Task persistance and refactor 1 year ago
entrypoint.sh uWSGI http-timeout option 1 year ago
hostdeps.sh (zuul) Improve image building 8 months ago
requirements-host-test.txt (zuul) Improve image building 8 months ago
requirements-host.txt (fix) Use endpoint for MAAS URL 4 months ago
tox.ini Security update: Update pyghmi to avoid pycrypto 7 months ago

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+

Recommended

  • 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