A configuration management service with support for secrets.
Go to file
Bryan Strassner 5f1fbbee3c [396582] Add alembic support to Deckhand
Updates Deckhand to use alembic to manage database upgrades.
Moves from creating tables at startup of Deckhand to the
db-sync job.

Change-Id: I6f4cb237fadc46fbee81d1c33096f48a720f589f
2018-04-06 23:30:16 -04:00
alembic [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00
charts/deckhand [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00
deckhand [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00
docs [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00
etc/deckhand Rename Deckhand bucket endpoint to buckets for consistency 2017-10-27 19:21:03 +01:00
images/deckhand [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00
releasenotes Only allow one LayeringPolicy to exist in the system. 2017-10-26 17:38:24 -04:00
tools [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04: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 Trivial: Rename doc to docs to align with UCP standard 2018-03-15 15:03:29 +00:00
.gitreview Add gitreview file 2017-08-11 01:22:26 -05:00
.stestr.conf Switch to stestr 2018-03-28 13:06:46 -04:00
alembic.ini [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00
entrypoint.sh [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04: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 Makefile - Dryrun 2018-03-29 21:22:23 -04:00
README.rst Add readthedocs link to Deckhand readme 2018-03-16 12:41:20 -04:00
requirements.txt [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00
setup.cfg Trivial: Rename doc to docs to align with UCP standard 2018-03-15 15:03:29 +00: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 [396582] Add alembic support to Deckhand 2018-04-06 23:30:16 -04:00

Deckhand

Doc Status

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.

Find more documentation for Deckhand on Read the Docs.

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).