A configuration management service with support for secrets.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Zuul 177fb31d1a Merge "Update HTK stable commit" 1 month ago
.github Add SECURITY.md 6 months ago
alembic Fix typo 2 years ago
charts/deckhand Scaling deckhand uwsgi workers 1 month ago
deckhand [FIX] Image build checks missing setuptools 2 months ago
doc Remove unused code for policy validation as feature not implemented 4 months ago
etc/deckhand Redacts Raw Documents 1 year ago
images/deckhand (fix) Address uwsgi and other gating issues 6 months ago
releasenotes style(pep8): remove identation ignores 2 years ago
tools Update HTK stable commit 1 month ago
.coveragerc Add Deckhand coverage job 3 years ago
.dockerignore Collect profile data on DH requests 2 years ago
.gitignore docs: Use sphinx-apidoc library for autodoc compatibility 1 year ago
.gitreview OpenDev Migration Patch 1 year ago
.stestr.conf Switch to stestr 2 years ago
.zuul.yaml Re-enable all Zuul CI tests 6 months ago
HACKING.rst Update url in HACKING.rst 1 year ago
LICENSE Update Apache LICENSE 2 years ago
Makefile Add support for Ubuntu bionic base image 7 months ago
README.rst Merge "docs: Reorganize documentation structure" 1 year ago
REVIEWING.rst docs: Add developer overview documentation 2 years ago
alembic.ini [396582] Add alembic support to Deckhand 2 years ago
bindep.txt Embed UML generated diagrams into docs, fix docs build 1 year ago
entrypoint.sh Scaling deckhand uwsgi workers 1 month ago
requirements.txt Scaling deckhand uwsgi workers 1 month ago
setup.cfg Remove Python 2.x support 11 months ago
setup.py Oslo config integration (#1) 3 years ago
test-requirements.txt [FIX] Image build checks missing setuptools 2 months ago
tox.ini Remove Python 2.x support 11 months ago

README.rst

Deckhand

Docker Repository on Quay Doc Status

Deckhand provides document revision management, storage and mutation functionality upon which the rest of the Airship components rely for orchestration of infrastructure provisioning. Deckhand understands declarative YAML documents that define, end-to-end, the configuration of sites: from the hardware -- encompassing network topology and hardware and host profile information -- up to the software level that comprises the overcloud.

Core Responsibilities

  • layering - helps reduce duplication in configuration by applying the notion of inheritance to documents
  • substitution - provides separation between secret data and other configuration data for security purposes and reduces data duplication by allowing common data to be defined once and substituted elsewhere dynamically
  • revision history - maintains well-defined collections of documents within immutable revisions that are meant to operate together, while providing the ability to rollback to previous revisions
  • validation - allows services to implement and register different kinds of validations and report errors
  • secret management - leverages existing OpenStack APIs -- namely Barbican -- to reliably and securely store sensitive data

Getting Started

For more detailed installation and setup information, please refer to the Getting Started guide.

Integration Points

Deckhand has the following integration points:

Note

Currently, other database back-ends are not supported.

Though, being a low-level service, has many other Airship services that integrate with it, including:

  • Drydock is orchestrated by Shipyard to perform bare metal node provisioning.
  • Promenade is indirectly orchestrated by Shipyard to configure and join Kubernetes nodes.
  • Armada is orchestrated by Shipyard to deploy and test Kubernetes workloads.

Further Reading

Airship.