drydock/doc/source/getting_started.rst
Roman Gorshunov 161326fe06 Fix: Drydock Exceptions docs rendering on RTD
Readthedocs failed to render Drydock exceptions with error:
> WARNING: autodoc: failed to import exception xxx from module
> 'drydock_provisioner'; the following exception was raised: No module
> named 'drydock_provisioner'

Trying to add Drydock requirements to the installed requirements list,
so that Readthedocs has all modules, including those needed for the
Drydock itself.

Unify docs building by utilizing Zuul docs-on-readthedocs template job.

Cosmetic readability changes:
1. combined all Makefile .PHONY targets into one
2. merged multiple LABEL instructions in Dockerfile into one

Change-Id: I6a9b47cffc66d739968fa886c51e25b1e09ef124
2019-08-27 22:56:32 +02:00

2.6 KiB

Installing Drydock in a Dev Environment

Bootstrap Kubernetes

You can bootstrap your Helm-enabled Kubernetes cluster via the Openstack-Helm AIO or the Promenade tools.

Deploy Drydock and Dependencies

Drydock is most easily deployed using Armada to deploy the Drydock container into a Kubernetes cluster via Helm charts. The Drydock chart is in the charts/drydock directory. It depends on the deployments of the MaaS chart and the Keystone chart.

A integrated deployment of these charts can be accomplished using the Armada tool. An example integration chart can be found in the Airship in a Bottle repo in the ./manifests/dev_single_node directory.

Load Site

To use Drydock for site configuration, you must craft and load a site topology YAML. An example of this is in ./test/yaml_samples/deckhand_fullsite.yaml.

Documentation on building your topology document is at topology_label.

Drydock requires that the YAML topology be hosted somewhere, either the preferred method of using Deckhand or through a simple HTTP server like Nginx or Apache.

Use the CLI to create tasks to deploy your site

# drydock task create -d <design_url> -a verify_site
# drydock task create -d <design_url> -a prepare_site
# drydock task create -d <design_url> -a prepare_nodes
# drydock task create -d <design_url> -a deploy_nodes

A demo of this process is available at https://asciinema.org/a/133906