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.
Phil Sphicas 5cd799cc5d Allow source substring extraction 6 months ago
.github Add SECURITY.md 2 years ago
alembic Fix pep8 gate running on py3.8 2 years ago
charts/deckhand Helm 3: Fix Job labels 9 months ago
deckhand Allow source substring extraction 6 months ago
doc Allow source substring extraction 6 months ago
etc/deckhand Redacts Raw Documents 4 years ago
images/deckhand Deckhand gate fix 10 months ago
releasenotes style(pep8): remove identation ignores 4 years ago
tools Update HTK stable commit (Ingress) 9 months ago
.coveragerc Add Deckhand coverage job 5 years ago
.dockerignore Collect profile data on DH requests 4 years ago
.gitignore docs: Use sphinx-apidoc library for autodoc compatibility 4 years ago
.gitreview OpenDev Migration Patch 3 years ago
.stestr.conf Switch to stestr 4 years ago
.zuul.yaml Make failing Zuul job non-voting 6 months ago
HACKING.rst Update url in HACKING.rst 4 years ago
LICENSE Update Apache LICENSE 4 years ago
Makefile Add support for Ubuntu bionic base image 2 years ago
README.rst Merge "docs: Reorganize documentation structure" 4 years ago
REVIEWING.rst docs: Add developer overview documentation 4 years ago
alembic.ini [396582] Add alembic support to Deckhand 4 years ago
bindep.txt Embed UML generated diagrams into docs, fix docs build 3 years ago
entrypoint.sh Scaling deckhand uwsgi workers 2 years ago
requirements.txt Revert jsonschema to 3.2.0 10 months ago
setup.cfg Remove Python 2.x support 3 years ago
setup.py Oslo config integration (#1) 5 years ago
test-requirements.txt Gate fixes 1 year ago
tox.ini Drop Python 3.5, make xenial/opensuse non-voting 9 months ago



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:


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