Add heat template plugins to documentation

As per:
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html

Pull in the plugins and document them based on their docstrings.

Change-Id: I6b17961b1c366b629139b8ef7ca27c30d31e9da0
This commit is contained in:
Ronald Bradford 2015-09-28 16:44:53 -04:00
parent c61cdea2f1
commit 505fbe905f
4 changed files with 21 additions and 0 deletions

View File

@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'stevedore.sphinxext',
'oslosphinx'
]

View File

@ -0,0 +1,11 @@
===========================
Heat Template Definitions
===========================
Heat Templates are what Magnum uses to generate a Bay. These various template
definitions provide a mapping of Magnum object attributes to Heat templates
parameters, along with Magnum consumable template outputs. The result of a
Heat template should be a full Container Orchestration Environment.
.. list-plugins:: magnum.template_definitions
:detailed:

View File

@ -78,3 +78,4 @@ Developer Info
dev/dev-quickstart
dev/dev-manual-devstack
contributing
heat-templates

View File

@ -363,6 +363,8 @@ class BaseTemplateDefinition(TemplateDefinition):
class AtomicK8sTemplateDefinition(BaseTemplateDefinition):
"""Kubernetes template for a Fedora Atomic VM."""
provides = [
{'server_type': 'vm',
'os': 'fedora-atomic',
@ -442,6 +444,8 @@ class AtomicK8sTemplateDefinition(BaseTemplateDefinition):
class CoreOSK8sTemplateDefinition(AtomicK8sTemplateDefinition):
"""Kubernetes template for CoreOS VM."""
provides = [
{'server_type': 'vm', 'os': 'coreos', 'coe': 'kubernetes'},
]
@ -476,6 +480,8 @@ class CoreOSK8sTemplateDefinition(AtomicK8sTemplateDefinition):
class AtomicSwarmTemplateDefinition(BaseTemplateDefinition):
"""Docker swarm template for a Fedora Atomic VM."""
provides = [
{'server_type': 'vm', 'os': 'fedora-atomic', 'coe': 'swarm'},
]
@ -544,6 +550,8 @@ class AtomicSwarmTemplateDefinition(BaseTemplateDefinition):
class UbuntuMesosTemplateDefinition(BaseTemplateDefinition):
"""Mesos template for Ubuntu VM."""
provides = [
{'server_type': 'vm', 'os': 'ubuntu', 'coe': 'mesos'},
]