A configuration management service with support for secrets.
Go to file
Zuul 9ab4180a8f Merge "Fix: proper ordering: tagging after build" 2018-11-15 21:13:41 +00:00
alembic Fix typo 2018-09-09 23:02:08 -04:00
charts/deckhand Fix: various documentation and URL fixes 2018-09-25 11:44:57 +02:00
deckhand Merge "fix wrong spelling" 2018-11-13 15:06:38 +00:00
doc Merge "docs: Add config documentation to operator's section" 2018-11-05 18:05:49 +00:00
etc/deckhand Redacts Raw Documents 2018-10-19 23:56:12 -05:00
images/deckhand Fix: git commit id labels on images 2018-09-21 03:31:12 +02:00
releasenotes style(pep8): remove identation ignores 2018-06-01 22:08:42 +00:00
tools Create Makefile target to install Helm binary 2018-11-09 15:10:02 -06:00
.coveragerc Add Deckhand coverage job 2017-08-15 16:11:35 -04:00
.dockerignore Collect profile data on DH requests 2018-02-15 13:09:16 -05:00
.gitignore docs: Use sphinx-apidoc library for autodoc compatibility 2018-10-27 22:52:39 +01:00
.gitreview Update .gitreview for openstack infra 2018-05-17 19:21:56 +01:00
.stestr.conf Switch to stestr 2018-03-28 13:06:46 -04:00
.zuul.yaml Fix: proper ordering: tagging after build 2018-11-13 15:54:40 +01:00
HACKING.rst Update url in HACKING.rst 2018-11-15 00:22:41 +08:00
LICENSE Update Apache LICENSE 2018-05-10 22:25:14 +01:00
Makefile Create Makefile target to install Helm binary 2018-11-09 15:10:02 -06:00
README.rst Merge "docs: Reorganize documentation structure" 2018-10-05 20:49:07 +00:00
REVIEWING.rst docs: Add developer overview documentation 2018-06-20 15:00:46 -04:00
alembic.ini [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00
entrypoint.sh [fix] Drop deckhand.conf from default DECKHAND_CONF_DIR path 2018-04-07 00:20:47 -04:00
requirements.txt requirements: Update pinned requirements 2018-10-26 20:53:43 +00:00
setup.cfg Fix: various documentation and URL fixes 2018-09-25 11:44:57 +02:00
setup.py Oslo config integration (#1) 2017-06-26 16:57:50 -07:00
test-requirements.txt fix: Pin down Deckhand package requirements 2018-10-18 02:36:35 +01:00
tox.ini Replace Chinese quotes with English quotes 2018-09-20 07:29:27 -04:00

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.