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.
Drew Walters 080ba9f0ca CI: Update OSH relative paths for OpenDev 3 days ago
alembic Fix typo 7 months ago
charts/deckhand Merge "Implement Security Context for Deckhand" 6 days ago
deckhand Log client-id in UCP API endpoints 3 weeks ago
doc Embed UML generated diagrams into docs, fix docs build 2 months ago
etc/deckhand Redacts Raw Documents 6 months ago
images/deckhand Remove proxy ARG and ENV from Dockerfile 5 months ago
releasenotes style(pep8): remove identation ignores 10 months ago
tools CI: Add chart build jobs 3 weeks ago
.coveragerc Add Deckhand coverage job 1 year ago
.dockerignore Collect profile data on DH requests 1 year ago
.gitignore docs: Use sphinx-apidoc library for autodoc compatibility 6 months ago
.gitreview OpenDev Migration Patch 6 days ago
.stestr.conf Switch to stestr 1 year ago
.zuul.yaml CI: Update OSH relative paths for OpenDev 3 days ago
HACKING.rst Update url in HACKING.rst 5 months ago
LICENSE Update Apache LICENSE 11 months ago
Makefile Embed UML generated diagrams into docs, fix docs build 2 months ago
README.rst Merge "docs: Reorganize documentation structure" 6 months ago
REVIEWING.rst docs: Add developer overview documentation 10 months ago
alembic.ini [396582] Add alembic support to Deckhand 1 year ago
bindep.txt Embed UML generated diagrams into docs, fix docs build 2 months ago
entrypoint.sh [fix] Drop deckhand.conf from default DECKHAND_CONF_DIR path 1 year ago
requirements.txt [ad-hoc] Update oslo.utils ver to 3.40.2 1 month ago
setup.cfg Add openstack-discuss 3 months ago
setup.py Oslo config integration (#1) 1 year ago
test-requirements.txt fix: Pin down Deckhand package requirements 6 months ago
tox.ini Add Python 3.6 classifier to setup.cfg 5 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.