693bdaf947
This change organizes the orchestration docs by topic rather than letting autodoc organize methods by the order they appear in the _proxy.py file. Change-Id: Ia7df2887c0b1fa1d4eb04a9372dab247f21311a4
51 lines
2.1 KiB
ReStructuredText
51 lines
2.1 KiB
ReStructuredText
Orchestration API
|
|
=================
|
|
|
|
For details on how to use orchestration, see :doc:`/users/guides/orchestration`
|
|
|
|
.. automodule:: openstack.orchestration.v1._proxy
|
|
|
|
The Orchestration Class
|
|
-----------------------
|
|
|
|
The orchestration high-level interface is available through the
|
|
``orchestration`` member of a :class:`~openstack.connection.Connection`
|
|
object. The ``orchestration`` member will only be added if the service
|
|
is detected.
|
|
|
|
Stack Operations
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
|
|
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_stack
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.check_stack
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.update_stack
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_stack
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.find_stack
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_stack
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.stacks
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.validate_template
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.resources
|
|
|
|
Software Configuration Operations
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
|
|
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_software_config
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_software_config
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_software_config
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.software_configs
|
|
|
|
Software Deployment Operations
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
|
|
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.create_software_deployment
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.update_software_deployment
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.delete_software_deployment
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.get_software_deployment
|
|
.. automethod:: openstack.orchestration.v1._proxy.Proxy.software_deployments
|