A configuration management service with support for secrets.
Go to file
Bryan Strassner 4d642f849a [fix] Add uwsgi entrypoint options
Changes the entrypoint.sh options for uwsgi to include:
 -b 32768 : for larger header/url handling
 --die-on-term : for more 'normal'  handling of SIGTERM
 --lazy-apps : to delay init of python until after forking workers
 --master : to provide a master process for handling request dispatch

The purpose of these changes is intended to avoid some crash behavior
that is occuring when the process being forked has an open db connection.
The --lazy-apps option should delay initialization. The other options are
recommended by uwsgi documentation, specicially the --master option.
The larger buffer size is not strictly recommended, but matters when large
headers are included.

The die-on-term option should provide better behavior in the container
environment.

Related-Change: I60adeffff5461fdda957124232bc5a606baae413
Change-Id: I70510246576a8fb6aa216e7c9c7e97c1c9ab791c
2018-04-03 09:19:28 -04:00
charts/deckhand Enable multiple threads, disabled muliple workers 2018-04-02 12:38:20 -04:00
deckhand [fix] Add uwsgi entrypoint options 2018-04-03 09:19:28 -04:00
docs Enable multiple threads, disabled muliple workers 2018-04-02 12:38:20 -04: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 Enable multiple threads, disabled muliple workers 2018-04-02 12:38:20 -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
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
entrypoint.sh [fix] Add uwsgi entrypoint options 2018-04-03 09:19:28 -04:00
requirements.txt Collect profile data on DH requests 2018-02-15 13:09:16 -05: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 Switch to stestr 2018-03-28 13:06:46 -04:00

README.rst

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