drydock/docs/source/index.rst

72 lines
1.5 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 Drydock's documentation!
====================================
Drydock is a python REST orchestrator to translate a YAML host topology to a
provisioned set of hosts and provide a set of cloud-init post-provisioning
instructions.
User's Guide
============
Drydock Configuration Guide
---------------------------
.. toctree::
:maxdepth: 2
getting_started
configuration
sampleconf
policy-enforcement
exceptions/index
API Documentation
-----------------
.. toctree::
:maxdepth: 1
API
task
bootaction
validatedesign
Developer Overview
------------------
.. toctree::
:maxdepth: 1
development
Client Documentation
--------------------
.. toctree::
:maxdepth: 1
drydock_client
Topology Documentation
----------------------
.. toctree::
:maxdepth: 1
topology