A configuration management service with support for secrets.
Go to file
Sergiy Markin ac4edb0c64 [focal] Deckhand project updates
- adjusted .gitignore to keep fresh egg-info and omit build artifacts
- fresh egg-info data is needed for promenade that depends on Deckhand
- restored deckhand-functional-uwsgi-py38 gate
- restored deckhand-integration-uwsgi-py38 gate
- made deckhand-airskiff-deployment gate voting ( treasuremap project
  has been updated)
- removed bionic gates
- updated focal dockerfile
- added more binary deps into bindep.txt
- updated deckhand chart values to latest images - focal and wallaby
- fixed python code to compy with CVE's found by fresh version of bandit
- implemented pip freeze approach
- added tox -e freeze profile to manage it
- requirements-frozen.txt is now main file with requirements
- requirements-direct.txt is the file to control deps
- updated setup.cfg to adjust to newer version of setuptools
- fixed airskiff-deploy gate
- fixed docker-image-build playbook to restore Quay repo image publish
- updated other playbooks to include roles from zuul/base-jobs in order
  to setup build hosts properly
- removed workaround with hardcoded dns resolver ip 10.96.0.10 as it
  became obsolette due to recent fix in openstack-helm-infra
- adjusted tools/whitespace-linter.sh script
- tox.ini has been brought to compliance with tox4 requirements
- replaced str() calls with six.text_type() according to D325 Deckhand specific
  commandment from Hacking.rst
- locked python-barbicanclient version with 5.2.0 because of breaking
  changes in the upper versions

Change-Id: I1cd3c97e83569c4db7e958b3400bdd4b7ea5e668
2023-04-20 19:39:43 +00:00
.github Add SECURITY.md 2020-03-02 16:32:42 +00:00
Deckhand.egg-info [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
alembic [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
charts [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
deckhand [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
doc [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
etc/deckhand Redacts Raw Documents 2018-10-19 23:56:12 -05:00
images/deckhand [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
releasenotes style(pep8): remove identation ignores 2018-06-01 22:08:42 +00:00
tools [focal] Deckhand project updates 2023-04-20 19:39:43 +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 [focal] Deckhand project updates 2023-04-20 19:39:43 +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 [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
ChangeLog [focal] Deckhand project updates 2023-04-20 19:39:43 +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 [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
requirements-frozen.txt [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
requirements.txt [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
setup.cfg [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
setup.py update to focal and python 3.8 2023-02-24 10:51:57 -05:00
test-requirements.txt [focal] Deckhand project updates 2023-04-20 19:39:43 +00:00
tox.ini [focal] Deckhand project updates 2023-04-20 19:39:43 +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.