airship
/
drydock
Code Issues Proposed changes
A declarative host provisioning system.
410 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 0f39a55942 Refactor build to include Go 
Adding the baclient code to Drydock requires a refactor
of the build automation to support multiple languages
and multiple artifacts included in a single Docker image

NOTE: the go source here is a placeholder 'hello world' sample

Change-Id: I1b4883f018b33b3d4fcd7cbcb6cba660fcdc93de
 		2018-09-04 13:13:21 -05:00
alembic (format): yapf reformat 2018-07-27 20:16:25 -05:00
charts/drydock Update Keystone API ports in Drydock chart 2018-08-27 15:49:05 -05:00
docs Add destroy_node config items to sample 2018-08-30 10:26:32 -05:00
etc/drydock Add destroy_node config items to sample 2018-08-30 10:26:32 -05:00
go/src/baclient Refactor build to include Go 2018-09-04 13:13:21 -05:00
images/drydock Refactor build to include Go 2018-09-04 13:13:21 -05:00
python Refactor build to include Go 2018-09-04 13:13:21 -05:00
tools Refactor build to include Go 2018-09-04 13:13:21 -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 Update .gitreview for openstack infra 2018-05-17 19:23:48 +01:00
.style.yapf Fix issues failing CI pipeline 2017-08-24 10:18:11 -05:00
.zuul.yaml (zuul) Consolidate tests 2018-07-20 08:52:44 -05:00
LICENSE Initial commit 2017-02-14 17:23:35 -05:00
Makefile Refactor build to include Go 2018-09-04 13:13:21 -05:00
README.md Zuul: Initial Airship-Drydock checks 2018-05-24 16:59:12 -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
requirements-host-test.txt (zuul) Improve image building 2018-08-10 21:09:50 +00:00
requirements-host.txt (zuul) Improve image building 2018-08-10 21:09:50 +00:00
tox.ini Refactor build to include Go 2018-09-04 13:13:21 -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 http://att-comdev-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 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