airship/drydock
Code Issues Proposed changes
A declarative host provisioning system.
505 Commits 2 Branches 0 Tags 9.5 MiB
Python 97.2%
Go 1.3%
Shell 0.8%
Makefile 0.3%
Smarty 0.3%
45d470069e
Go to file
Scott Hussey 45d470069e Improve error logging during validation 
- Currently several failure paths won't log any messages
  when doing a site validation. Add these messages

- Also, for validation steps that are dependent on external resources
  make the resource inaccessibility a warning rather than a failure.

Change-Id: I431ed188e2f6cd3fc3fa41ae2729f3a099fdfbf5
2019-09-21 21:59:53 -05:00
alembic (format): yapf reformat 2018-07-27 20:16:25 -05:00
charts/drydock Merge "Add release uuid annotation to POD spec" 2019-06-26 21:37:20 +00:00
docs Fix small inconsistency in API documentation 2019-08-19 14:59:38 -05:00
etc/drydock Add Redfish as OOB driver 2018-12-08 21:19:30 +05:30
go/src/baclient Bootaction client initial implementation 2018-09-06 16:33:15 -05:00
images/drydock images: Allow base image substitution for Drydock 2019-03-07 12:09:52 -06:00
python Improve error logging during validation 2019-09-21 21:59:53 -05:00
tools Move to helm 2.14.0 2019-05-21 13:52:45 -05: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 OpenDev Migration Patch 2019-04-19 19:52:21 +00:00
.style.yapf Fix issues failing CI pipeline 2017-08-24 10:18:11 -05:00
.zuul.yaml Encrypt git mirroring ssh_key to specific project 2019-05-23 12:09:47 -05: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
LICENSE Initial commit 2017-02-14 17:23:35 -05:00
Makefile images: Allow base image substitution for Drydock 2019-03-07 12:09:52 -06:00
README.md Fix: various documentation and URL fixes 2018-09-26 08:21:14 +00:00
requirements-host-test.txt (zuul) Improve image building 2018-08-10 21:09:50 +00:00
requirements-host.txt (fix) Use endpoint for MAAS URL 2018-11-27 12:04:38 -06: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+

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