A configuration management service with support for secrets.
Go to file
Felipe Monteiro fbfb9e79af Fix abstract parent documents substitutions not propagating
This is to fix abstract parent documents that have registered
substitutions but are not propagating those substitutions
down to concrete children that rely on that substituted data
(whereas it is irrelevant to the end user whether the abstract
parent receives those substitutions or not).

After this change abstract documents will always undergo
substitution such that their concrete children documents should
inherit those changes.

A unit test has been added for regression.

Change-Id: I73ed8d4caa6923492cc5ff042ecc57fbfeeb7c1c
2018-03-06 18:03:43 -05:00
charts/deckhand Add resource declaration to deckhand job-ks-service chart template 2018-03-03 22:20:42 -05:00
deckhand Fix abstract parent documents substitutions not propagating 2018-03-06 18:03:43 -05:00
doc Remove microversions from document versions 2018-02-27 12:37:43 -05:00
etc/deckhand Rename Deckhand bucket endpoint to buckets for consistency 2017-10-27 19:21:03 +01:00
images/deckhand Update Deckhand Dockerfile 2018-02-27 09:46:10 -05:00
releasenotes Only allow one LayeringPolicy to exist in the system. 2017-10-26 17:38:24 -04:00
tools Merge "Improve document validation module." 2018-01-19 13:04:06 -05: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 Add resource declaration to deckhand job-ks-service chart template 2018-03-03 22:20:42 -05:00
.gitreview Add gitreview file 2017-08-11 01:22:26 -05:00
.testr.conf Allow unit tests to be run against in-memory sqlite 2018-02-12 22:10:29 -05:00
HACKING.rst Add sphinx job for auto-generating docs 2017-09-21 16:16:23 +01:00
LICENSE Initial commit 2017-06-16 08:29:03 -07:00
Makefile Update Deckhand Dockerfile 2018-02-27 09:46:10 -05:00
README.rst Docs: Update README and create Getting Started docs 2018-02-21 15:26:22 -05:00
entrypoint.sh Fix: Inject secret payload rather than reference into document 2018-02-26 10:17:50 -05:00
requirements.txt Collect profile data on DH requests 2018-02-15 13:09:16 -05:00
setup.cfg Integrate Deckhand with keystone auth 2017-10-16 19:54:46 +01:00
setup.py Oslo config integration (#1) 2017-06-26 16:57:50 -07:00
test-requirements.txt Bump up package requirements versions 2018-02-13 22:54:44 -05:00
tox.ini Fix tox -v skipping over sqlite unit test jobs 2018-02-16 20:12:44 -05:00

README.rst

Deckhand

Deckhand is a storage service for YAML-based configuration documents, which are managed through version control and automatically validated. Deckhand provides users with a variety of different document types that describe complex configurations using the features listed below.

Core Responsibilities

  • layering - helps reduce duplication in configuration while maintaining auditability across many sites
  • substitution - provides separation between secret data and other configuration data, while allowing a simple interface for clients
  • revision history - improves auditability and enables services to provide functional validation of a well-defined collection of documents that are meant to operate together
  • validation - allows services to implement and register different kinds of validations and report errors

Getting Started

For more detailed installation and setup information, please refer to the Getting Started guide.

Testing

Automated Testing

To run unit tests using sqlite, execute:

$ tox -epy27
$ tox -epy35

against a py27- or py35-backed environment, respectively. To run individual unit tests, run:

$ tox -e py27 -- deckhand.tests.unit.db.test_revisions

for example.

To run functional tests:

$ tox -e functional

You can also run a subset of tests via a regex:

$ tox -e functional -- gabbi.suitemaker.test_gabbi_document-crud-success-multi-bucket

Intgration Points

Deckhand has the following integration points:

Note

Currently, other database backends are not supported.

Though, being a low-level service, has many other UCP 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

Undercloud Platform (UCP).