Felipe Monteiro cda4f9e431 Rename docs to doc to align with OpenStack standard

This patchset updates docs to doc to align with OpenStack
standard. Follow-up patchset will be needed to publish
documentation to OpenStack [0].

[0] https://docs.openstack.org/doc-contrib-guide/project-guides.html

Change-Id: Ia191ac1cc4536af1232aedd4bb491f3829651730

2018-06-05 13:19:24 -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 validation substitution layering replacement api_ref api_client exceptions

Developer's Guide

HACKING policy-enforcement testing

Release Notes

releasenotes/index.rst

Glossary

glossary

1.9 KiB Raw Blame History