5c411dd05b
Currently, if a document has a parent but no layering actions, the document immediately inherents its parents' data, which is a bug. Instead, the child document should only layer with its parent's data and then update its own data if it has at least one layering action. In addition, the base_schema.yaml under `deckhand.schemas` has been updated to require that actions be required and contain at least 1 layering action when parentSelector is provided and that parentSelector be required when actions is provided and that at least one key-value pair be provided. (Empty actions array or empty parentSelector object is meaningless and should be disallowed/discouraged.) This means that actions and parentSelector must always both be provided (though providing neither is also legal because layering is optional). Unit tests have been added to verify the schema updates. Change-Id: I77d54e2b216efc54b466f94d82ee8d36ca169c26 |
||
---|---|---|
charts/deckhand | ||
deckhand | ||
docs | ||
etc/deckhand | ||
images/deckhand | ||
releasenotes | ||
tools | ||
.coveragerc | ||
.dockerignore | ||
.gitignore | ||
.gitreview | ||
.testr.conf | ||
HACKING.rst | ||
LICENSE | ||
Makefile | ||
README.rst | ||
entrypoint.sh | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
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:
- Keystone (OpenStack Identity service) provides authentication and support for role based authorization.
- PostgreSQL is used to persist information to correlate workflows with users and history of workflow commands.
Note
Currently, other database backends are not supported.
Though, being a low-level service, has many other UCP services that integrate with it, including: