9d91a072cd
This package is used for generation autodoc documentation automatically which can be linked to by Deckhand documentation from other places. This is to make autodoc generation work in RTD. More info: https://pypi.org/project/sphinxcontrib-apidoc/ Change-Id: I43aac82728e5935a5a2626f2fd29d7a7188d19f9
82 lines
1.9 KiB
ReStructuredText
82 lines
1.9 KiB
ReStructuredText
..
|
|
Copyright 2017 AT&T Intellectual Property.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
====================================
|
|
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 Airship.
|
|
|
|
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 types, the combination of which
|
|
describe the manner in which Deckhand renders finalized documents for
|
|
consumption by other Airship services.
|
|
|
|
Overview
|
|
========
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
overview
|
|
|
|
User's Guide
|
|
============
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
users/index
|
|
|
|
Operator's Guide
|
|
================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
operators/index
|
|
|
|
Contrbitutor's Guide
|
|
====================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
contributor/index
|
|
|
|
Release Notes
|
|
=============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
releasenotes/index
|
|
|
|
Glossary
|
|
========
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
glossary
|