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:
@@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
#'sphinx.ext.intersphinx',
|
#'sphinx.ext.intersphinx',
|
||||||
|
'stevedore.sphinxext',
|
||||||
'oslosphinx'
|
'oslosphinx'
|
||||||
]
|
]
|
||||||
|
|
||||||
|
11
doc/source/heat-templates.rst
Normal file
11
doc/source/heat-templates.rst
Normal 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:
|
@@ -78,3 +78,4 @@ Developer Info
|
|||||||
dev/dev-quickstart
|
dev/dev-quickstart
|
||||||
dev/dev-manual-devstack
|
dev/dev-manual-devstack
|
||||||
contributing
|
contributing
|
||||||
|
heat-templates
|
||||||
|
@@ -363,6 +363,8 @@ class BaseTemplateDefinition(TemplateDefinition):
|
|||||||
|
|
||||||
|
|
||||||
class AtomicK8sTemplateDefinition(BaseTemplateDefinition):
|
class AtomicK8sTemplateDefinition(BaseTemplateDefinition):
|
||||||
|
"""Kubernetes template for a Fedora Atomic VM."""
|
||||||
|
|
||||||
provides = [
|
provides = [
|
||||||
{'server_type': 'vm',
|
{'server_type': 'vm',
|
||||||
'os': 'fedora-atomic',
|
'os': 'fedora-atomic',
|
||||||
@@ -442,6 +444,8 @@ class AtomicK8sTemplateDefinition(BaseTemplateDefinition):
|
|||||||
|
|
||||||
|
|
||||||
class CoreOSK8sTemplateDefinition(AtomicK8sTemplateDefinition):
|
class CoreOSK8sTemplateDefinition(AtomicK8sTemplateDefinition):
|
||||||
|
"""Kubernetes template for CoreOS VM."""
|
||||||
|
|
||||||
provides = [
|
provides = [
|
||||||
{'server_type': 'vm', 'os': 'coreos', 'coe': 'kubernetes'},
|
{'server_type': 'vm', 'os': 'coreos', 'coe': 'kubernetes'},
|
||||||
]
|
]
|
||||||
@@ -476,6 +480,8 @@ class CoreOSK8sTemplateDefinition(AtomicK8sTemplateDefinition):
|
|||||||
|
|
||||||
|
|
||||||
class AtomicSwarmTemplateDefinition(BaseTemplateDefinition):
|
class AtomicSwarmTemplateDefinition(BaseTemplateDefinition):
|
||||||
|
"""Docker swarm template for a Fedora Atomic VM."""
|
||||||
|
|
||||||
provides = [
|
provides = [
|
||||||
{'server_type': 'vm', 'os': 'fedora-atomic', 'coe': 'swarm'},
|
{'server_type': 'vm', 'os': 'fedora-atomic', 'coe': 'swarm'},
|
||||||
]
|
]
|
||||||
@@ -544,6 +550,8 @@ class AtomicSwarmTemplateDefinition(BaseTemplateDefinition):
|
|||||||
|
|
||||||
|
|
||||||
class UbuntuMesosTemplateDefinition(BaseTemplateDefinition):
|
class UbuntuMesosTemplateDefinition(BaseTemplateDefinition):
|
||||||
|
"""Mesos template for Ubuntu VM."""
|
||||||
|
|
||||||
provides = [
|
provides = [
|
||||||
{'server_type': 'vm', 'os': 'ubuntu', 'coe': 'mesos'},
|
{'server_type': 'vm', 'os': 'ubuntu', 'coe': 'mesos'},
|
||||||
]
|
]
|
||||||
|
Reference in New Issue
Block a user