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 2f7ec5fb16 Merge "Add "labels" to Drydock deployment" 4 weeks ago
.github Update Airship vulnerability link 1 year ago
alembic (format): yapf reformat 3 years ago
charts/drydock Add "labels" to Drydock deployment 3 months ago
doc Support binary prefixes for node storage size 1 year ago
etc/drydock Add Redfish as OOB driver 3 years ago
go/src/baclient Bootaction client initial implementation 3 years ago
images/drydock Gate Fixes for Drydock 2 months ago
python Gate Fixes for Drydock 2 months ago
tools Update HTK stable commit 1 year ago
.dockerignore Add config generation to tox.ini 4 years ago
.gitignore Refactor build to include Go 3 years ago
.gitreview OpenDev Migration Patch 2 years ago
.readthedocs.yaml Change RTD config to use Python requirements 2 years ago
.style.yapf Fix issues failing CI pipeline 4 years ago
.zuul.yaml Add Docker default AppArmor profile to drydock 1 year ago
LICENSE Initial commit 5 years ago
Makefile Add support for ubuntu bionic base image 2 years ago
README.md Fix: various documentation and URL fixes 3 years ago
alembic.ini DRYD47 - Task persistance and refactor 4 years ago
entrypoint.sh uWSGI http-timeout option 4 years ago
hostdeps.sh Update image build script to run in a docker 2 years ago
requirements-host-test.txt (zuul) Improve image building 3 years ago
requirements-host.txt Security update: Update pyghmi to avoid pycrypto 3 years ago
tox.ini Fix: Drydock Exceptions docs rendering on RTD 2 years 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+
  • 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