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 a03e9b427f Merge "Fix deckhand-integration-uwsgi-py35 tests" 1 month ago
.github Add SECURITY.md 1 month ago
alembic Fix typo 1 year ago
charts/deckhand Add Docker default AppArmor profile to deckhand 1 month ago
deckhand Fix deckhand-integration-uwsgi-py35 tests 1 month ago
doc Add support for Ubuntu bionic base image 2 months ago
etc/deckhand Redacts Raw Documents 1 year ago
images/deckhand (fix) Address uwsgi and other gating issues 1 month ago
releasenotes style(pep8): remove identation ignores 1 year ago
tools (fix) Address uwsgi and other gating issues 1 month ago
.coveragerc Add Deckhand coverage job 2 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 11 months ago
.stestr.conf Switch to stestr 2 years ago
.zuul.yaml (fix) Address uwsgi and other gating issues 1 month ago
HACKING.rst Update url in HACKING.rst 1 year ago
LICENSE Update Apache LICENSE 1 year ago
Makefile Add support for Ubuntu bionic base image 2 months ago
README.rst Merge "docs: Reorganize documentation structure" 1 year ago
REVIEWING.rst docs: Add developer overview documentation 1 year 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 [fix] Drop deckhand.conf from default DECKHAND_CONF_DIR path 2 years ago
requirements.txt (fix) Address uwsgi and other gating issues 1 month ago
setup.cfg Remove Python 2.x support 6 months ago
setup.py Oslo config integration (#1) 2 years ago
test-requirements.txt Gate fixes: pin amqp, use barbican deploy script 2 months ago
tox.ini Remove Python 2.x support 6 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.