Felipe Monteiro 6b56f1d1ab Update README to correct typos and deprecated, misleading sections

This PS simply updates the README to correct typos (intgration =>
integration) and reword misleading sections, as well as update
deprecated sections. Finally, new sections related to Barbican
have been added.

Change-Id: I92611cf2aecf5ee1295ba9014002cd0e18f3a6af

2018-04-30 18:42:58 +00:00

3.2 KiB

Raw Blame History

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.

Find more documentation for Deckhand on Read the Docs.

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.

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

Integration Points

Deckhand has the following integration points:

Barbican (OpenStack Key Manager) provides secure storage for sensitive data.

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 back-ends 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.

3.2 KiB Raw Blame History