Added missing stack documentation

and rewrite stack proxy document

- software_config
- software_deployment
- stack_environment
- stack_files
- stack_template
- template

Change-Id: I9675af84623831113ad72ca07ea95849eca05f9d
This commit is contained in:
Seungju Baek 2024-06-12 22:29:33 +09:00 committed by Baek Seung Ju
parent dfef1d36e8
commit 53a2ea6f6e
8 changed files with 109 additions and 5 deletions

View File

@ -18,10 +18,23 @@ Stack Operations
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
:noindex:
:members: create_stack, check_stack, update_stack, delete_stack, find_stack, suspend_stack, resume_stack,
get_stack, get_stack_environment, get_stack_files,
get_stack_template, stacks, validate_template, resources,
export_stack
:members: create_stack, stacks,find_stack, update_stack, delete_stack,
get_stack, export_stack,
get_stack_template, get_stack_environment
Stack Resource Operations
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
:noindex:
:members: resources
Stack Action Operations
^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
:noindex:
:members: suspend_stack, resume_stack, check_stack
Stack Event Operations
^^^^^^^^^^^^^^^^^^^^^^
@ -30,6 +43,13 @@ Stack Event Operations
:noindex:
:members: stack_events
Stack Template Operations
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.orchestration.v1._proxy.Proxy
:noindex:
:members: validate_template
Software Configuration Operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -4,6 +4,12 @@ Orchestration Resources
.. toctree::
:maxdepth: 1
v1/stack
v1/resource
v1/software_config
v1/software_deployment
v1/stack
v1/stack_environment
v1/stack_event
v1/stack_files
v1/stack_template
v1/template

View File

@ -0,0 +1,13 @@
openstack.orchestration.v1.software_config
==========================================
.. automodule:: openstack.orchestration.v1.software_config
The SoftwareConfig Class
------------------------
The ``SoftwareConfig`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.orchestration.v1.software_config.SoftwareConfig
:members:

View File

@ -0,0 +1,13 @@
openstack.orchestration.v1.software_deployment
==============================================
.. automodule:: openstack.orchestration.v1.software_deployment
The SoftwareDeployment Class
----------------------------
The ``SoftwareDeployment`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.orchestration.v1.software_deployment.SoftwareDeployment
:members:

View File

@ -0,0 +1,13 @@
openstack.orchestration.v1.stack_environment
============================================
.. automodule:: openstack.orchestration.v1.stack_environment
The StackEnvironment Class
--------------------------
The ``StackEnvironment`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.orchestration.v1.stack_environment.StackEnvironment
:members:

View File

@ -0,0 +1,13 @@
openstack.orchestration.v1.stack_files
======================================
.. automodule:: openstack.orchestration.v1.stack_files
The StackFiles Class
--------------------
The ``StackFiles`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.orchestration.v1.stack_files.StackFiles
:members:

View File

@ -0,0 +1,13 @@
openstack.orchestration.v1.stack_template
=========================================
.. automodule:: openstack.orchestration.v1.stack_template
The StackTemplate Class
-----------------------
The ``StackTemplate`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.orchestration.v1.stack_template.StackTemplate
:members:

View File

@ -0,0 +1,13 @@
openstack.orchestration.v1.template
===================================
.. automodule:: openstack.orchestration.v1.template
The Template Class
------------------
The ``Template`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.orchestration.v1.template.Template
:members: