airship
/
drydock
Code Issues Proposed changes
A declarative host provisioning system.
320 Commits 2 Branches 0 Tags 9.5 MiB
Python 97.2%
Go 1.3%
Shell 0.8%
Smarty 0.3%
Makefile 0.3%
Go to file
Scott Hussey c27c8e6c9b Use new validator model for validation 
- Update all validator rules to publish messages using
  new format
- Update unit tests to follow new validation framework
- Add validation for no tagged VLANs on non-trunked links
- Add validation for node interfaces attaching to networks
  not allowed on the interface link
- Unit test change to work around an issue where coverage testing
  and unit testing show different results

- Update tox to skip E126 to match YAPF formatting

Change-Id: Ifef21112896b88c2bd2b361630e041806ebb6663
 		2018-03-14 14:12:51 -05:00
alembic Statemgmt access to build data 2018-01-08 13:57:21 -06:00
charts/drydock Migrating Health Check to UCP Standards 2018-03-13 16:37:39 -04:00
docs/source Lower cased dock in Drydock 2018-03-13 15:53:01 -05:00
drydock_provisioner Use new validator model for validation 2018-03-14 14:12:51 -05:00
etc/drydock Migrating Health Check to UCP Standards 2018-03-13 16:37:39 -04:00
examples Add config generation to tox.ini 2017-08-21 14:35:56 -05:00
images/drydock Update image and chart mgmt 2017-12-15 15:33:14 -06:00
tests Use new validator model for validation 2018-03-14 14:12:51 -05:00
tools Update Makefile 2018-02-25 20:08:04 -05:00
.dockerignore Add config generation to tox.ini 2017-08-21 14:35:56 -05:00
.gitignore [390136] Drydock client timeout options 2018-03-07 16:59:15 -06: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
LICENSE Initial commit 2017-02-14 17:23:35 -05:00
Makefile Update Makefile 2018-02-25 20:08:04 -05:00
README.md Refactor orchestrator 2017-10-26 15:00:39 -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
requirements-direct.txt Gets a dictionary of device aliases to logicalnames for the site_design. 2018-02-26 10:09:12 -05:00
requirements-lock.txt Gets a dictionary of device aliases to logicalnames for the site_design. 2018-02-26 10:09:12 -05:00
requirements-test.txt Implement routedomain support 2017-12-14 13:45:38 -06:00
setup.py Refactor orchestrator 2017-10-26 15:00:39 -05:00
tox.ini Use new validator model for validation 2018-03-14 14:12:51 -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 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+

Recommended

  • A running Kubernetes cluster with Helm initialized
  • Familiarity with the AT&T Community Undercloud Platform (UCP) 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 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