From 53a2ea6f6e2566adec5ae453366c3fd41fdccf90 Mon Sep 17 00:00:00 2001 From: Seungju Baek Date: Wed, 12 Jun 2024 22:29:33 +0900 Subject: [PATCH] Added missing stack documentation and rewrite stack proxy document - software_config - software_deployment - stack_environment - stack_files - stack_template - template Change-Id: I9675af84623831113ad72ca07ea95849eca05f9d --- doc/source/user/proxies/orchestration.rst | 28 ++++++++++++++++--- .../user/resources/orchestration/index.rst | 8 +++++- .../orchestration/v1/software_config.rst | 13 +++++++++ .../orchestration/v1/software_deployment.rst | 13 +++++++++ .../orchestration/v1/stack_environment.rst | 13 +++++++++ .../orchestration/v1/stack_files.rst | 13 +++++++++ .../orchestration/v1/stack_template.rst | 13 +++++++++ .../resources/orchestration/v1/template.rst | 13 +++++++++ 8 files changed, 109 insertions(+), 5 deletions(-) create mode 100644 doc/source/user/resources/orchestration/v1/software_config.rst create mode 100644 doc/source/user/resources/orchestration/v1/software_deployment.rst create mode 100644 doc/source/user/resources/orchestration/v1/stack_environment.rst create mode 100644 doc/source/user/resources/orchestration/v1/stack_files.rst create mode 100644 doc/source/user/resources/orchestration/v1/stack_template.rst create mode 100644 doc/source/user/resources/orchestration/v1/template.rst diff --git a/doc/source/user/proxies/orchestration.rst b/doc/source/user/proxies/orchestration.rst index c9f3fa41f..76e555e93 100644 --- a/doc/source/user/proxies/orchestration.rst +++ b/doc/source/user/proxies/orchestration.rst @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/source/user/resources/orchestration/index.rst b/doc/source/user/resources/orchestration/index.rst index d0c53f6b8..4323a99ac 100644 --- a/doc/source/user/resources/orchestration/index.rst +++ b/doc/source/user/resources/orchestration/index.rst @@ -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 diff --git a/doc/source/user/resources/orchestration/v1/software_config.rst b/doc/source/user/resources/orchestration/v1/software_config.rst new file mode 100644 index 000000000..b38adcc36 --- /dev/null +++ b/doc/source/user/resources/orchestration/v1/software_config.rst @@ -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: diff --git a/doc/source/user/resources/orchestration/v1/software_deployment.rst b/doc/source/user/resources/orchestration/v1/software_deployment.rst new file mode 100644 index 000000000..d39bd89a3 --- /dev/null +++ b/doc/source/user/resources/orchestration/v1/software_deployment.rst @@ -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: diff --git a/doc/source/user/resources/orchestration/v1/stack_environment.rst b/doc/source/user/resources/orchestration/v1/stack_environment.rst new file mode 100644 index 000000000..a159e0401 --- /dev/null +++ b/doc/source/user/resources/orchestration/v1/stack_environment.rst @@ -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: diff --git a/doc/source/user/resources/orchestration/v1/stack_files.rst b/doc/source/user/resources/orchestration/v1/stack_files.rst new file mode 100644 index 000000000..2144747e4 --- /dev/null +++ b/doc/source/user/resources/orchestration/v1/stack_files.rst @@ -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: diff --git a/doc/source/user/resources/orchestration/v1/stack_template.rst b/doc/source/user/resources/orchestration/v1/stack_template.rst new file mode 100644 index 000000000..ac2af5c9b --- /dev/null +++ b/doc/source/user/resources/orchestration/v1/stack_template.rst @@ -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: diff --git a/doc/source/user/resources/orchestration/v1/template.rst b/doc/source/user/resources/orchestration/v1/template.rst new file mode 100644 index 000000000..ae9f2b453 --- /dev/null +++ b/doc/source/user/resources/orchestration/v1/template.rst @@ -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: