c69f29e92f
This PS updates all Deckhand documentation to be sphinx-compliant so that it can be rendered into HTML automatically for hosting. This PS also removes deprecated/redundant/unhelpful documentation and upates README to a bit more informative and helpful. The design.md file has been broken up into different sections with deckhand/docs for easier consumption. Change-Id: I44afcd22a7f5f05e44563342bb98b30fd806f598
1.7 KiB
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
documents document_types buckets validation substitution layering revision_history api_ref
Developer's Guide
HACKING policy-enforcement testing
Glossary
glossary