A configuration management service with support for secrets.
Go to file
Sergiy Markin 06b1631d8a Restored ubuntu_bionic image build
This PS restores image build for ubuntu_bionic and adds appropriate
gates to keep it tested by appropriate functional and integrational
tests.

Also the latest osh-infra commit was used with kubernetes 1.27.1 for
integration tests.

Change-Id: Ia2c951f27b96774b553e7c0c7c6809172312f753
2023-05-20 05:27:20 +00:00
.github Add SECURITY.md 2020-03-02 16:32:42 +00:00
alembic [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
charts Deckhand updates 2023-04-28 22:18:29 +00:00
deckhand [focal] Fix requests.body attribute deprecation 2023-05-11 21:02:16 +00:00
doc Sync requirements with shipyard 2023-04-25 13:11:36 +00:00
etc/deckhand Deckhand updates 2023-04-28 22:18:29 +00:00
images/deckhand Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00:00
releasenotes style(pep8): remove identation ignores 2018-06-01 22:08:42 +00:00
tools Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00:00
.coveragerc Add Deckhand coverage job 2017-08-15 16:11:35 -04:00
.dockerignore update to focal and python 3.8 2023-02-24 10:51:57 -05:00
.gitignore Removing egg-info folder 2023-04-26 22:23:30 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:52:20 +00:00
.stestr.conf Switch to stestr 2018-03-28 13:06:46 -04:00
.zuul.yaml Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00:00
ChangeLog [focal] Fix requests.body attribute deprecation 2023-05-11 21:02:16 +00:00
HACKING.rst [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
LICENSE Update Apache LICENSE 2018-05-10 22:25:14 +01:00
Makefile [focal] Deckhand project updates 2023-04-20 19:39:43 +00: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
bindep.txt [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
entrypoint.sh Scaling deckhand uwsgi workers 2020-08-05 22:05:57 +00:00
requirements-direct.txt Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00:00
requirements-frozen-bionic.txt Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00:00
requirements-frozen.txt Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00:00
requirements.txt [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
setup.cfg Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00:00
setup.py update to focal and python 3.8 2023-02-24 10:51:57 -05:00
test-requirements.txt Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00:00
tox.ini Restored ubuntu_bionic image build 2023-05-20 05:27:20 +00: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.