airship
/
drydock
Code Issues Proposed changes
A declarative host provisioning system.
343 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 cd9770a979 Zuul: Initial Airship-Drydock checks 
This PS adds the skeleton for a set of zuul checks and gates for
Airship, using the framework from OpenStack-Helm.

[Fix] Zuul lint fix

- Fix whitespace linting errors
- Update docuemtation errors
- Remove dead tests

Change-Id: Id1ed3aa2321d518ed15fcbb3b698b49709bed287
Signed-off-by: Pete Birley <pete@port.direct>
 		2018-05-24 16:59:12 -05:00
alembic Zuul: Initial Airship-Drydock checks 2018-05-24 16:59:12 -05:00
charts/drydock [Chart] SSH private key support 2018-05-01 21:18:13 +00:00
docs/source Change POST nodefilter Input 2018-05-08 10:32:26 -05:00
drydock_provisioner Zuul: Initial Airship-Drydock checks 2018-05-24 16:59:12 -05:00
etc/drydock Migrating Health Check to UCP Standards 2018-03-13 16:37:39 -04:00
images/drydock [Fix] Adhere to UCP spec for validation status 2018-03-23 10:31:27 -05:00
tests Zuul: Initial Airship-Drydock checks 2018-05-24 16:59:12 -05:00
tools Zuul: Initial Airship-Drydock checks 2018-05-24 16:59:12 -05:00
.dockerignore [390773] Support SRIOV fields in definition profiles 2018-03-14 14:12:51 -05:00
.gitignore [390136] Drydock client timeout options 2018-03-07 16:59:15 -06: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: Initial Airship-Drydock checks 2018-05-24 16:59:12 -05:00
LICENSE Initial commit 2017-02-14 17:23:35 -05:00
Makefile [Chart] SSH private key support 2018-05-01 21:18:13 +00: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
requirements-direct.txt [Fix] Migrate to pymongo BSON library 2018-04-19 09:30:18 -05:00
requirements-lock.txt Updating requirements-lock.txt 2018-05-17 15:37:28 -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 Updating requirements-lock.txt 2018-05-17 15:37:28 -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