Felipe Monteiro 6c45569ecd docs: Add developer overview documentation

This patchset adds developer overview documentation for providing
a high-level introduction to Deckhand, including its architecture,
modules, test utilities, Helm utilities, and other errata. This
work is based off this Drydock patchset:

  https://review.openstack.org/#/c/571298/

Change-Id: Ic3382d4e04edf02a65184651d272fe9cd1db56a4

2018-06-20 15:00:46 -04:00

1.9 KiB

Raw Blame History

Welcome to Deckhand's documentation!

Deckhand is a document-based configuration storage service built with auditability and validation in mind. It serves as the back-end storage service for UCP.

Deckhand's primary responsibilities include validating and storing YAML documents that are layered together to produce finalized documents, containing site configuration data, including sensitive data. Secrets can be stored using specialized secret storage management services like Barbican and later substituted into finalized or "rendered" documents.

The service understands a variety of document formats, the combination of which describe the manner in which Deckhand renders finalized documents for consumption by other UCP services.

User's Guide

getting-started overview revision-history documents document-types encryption validation rendering substitution layering replacement api_ref api_client exceptions

Developer's Guide

HACKING REVIEWING developer-overview policy-enforcement testing

Release Notes

releasenotes/index.rst

Glossary

glossary

1.9 KiB Raw Blame History