From ccdab161f67146d2c0a9923d2d9e8169c63bc880 Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Fri, 7 Feb 2025 14:52:43 +0000 Subject: [PATCH] Update content --- .../managing_stacks/deleting_a_stack.rst | 3 +- .../deleting_a_template.rst | 3 +- .../viewing_template_details.rst | 2 +- ...eating_a_user_and_granting_permissions.rst | 2 +- umn/source/service_overview/permission.rst | 125 +++++++++--------- .../supported_provider_versions.rst | 2 +- 6 files changed, 71 insertions(+), 66 deletions(-) diff --git a/umn/source/managing_stacks/deleting_a_stack.rst b/umn/source/managing_stacks/deleting_a_stack.rst index 5b2fab1..b236c35 100644 --- a/umn/source/managing_stacks/deleting_a_stack.rst +++ b/umn/source/managing_stacks/deleting_a_stack.rst @@ -58,7 +58,7 @@ If a stack is no longer needed, you can perform the following steps to delete it Alternatively, go to the stack details page by clicking the name of the stack and click **Delete** in the upper right corner -6. In the dialog box displayed, as shown in \ :ref:`Figure Dialog box for deleting a stack `, +6. In the dialog box displayed, as shown in \ :ref:`Figure Dialog box for deleting a stack `, a. select the desired deletion option: @@ -66,6 +66,7 @@ If a stack is no longer needed, you can perform the following steps to delete it b. and confirm the deletion by entering **Delete** in the text box and click **OK**. + .. _en-us_topic_0000001991890809__fig172072292519: .. figure:: /_static/images/en-us_image_0000002166698096.png :alt: **Figure 6** Dialog box for deleting a stack diff --git a/umn/source/managing_templates/deleting_a_template.rst b/umn/source/managing_templates/deleting_a_template.rst index da921b8..173184d 100644 --- a/umn/source/managing_templates/deleting_a_template.rst +++ b/umn/source/managing_templates/deleting_a_template.rst @@ -45,8 +45,9 @@ If a template is no longer in use, RFS supports deleting it. You can choose to d **Figure 4** RFS Private Templates -#. In the dialog box displayed, click **Yes** as shown in :ref:`Figure Dialog box for deleting a template `. The template(s) and all versions will be deleted. +#. In the dialog box displayed, click **Yes** as shown in :ref:`Figure Dialog box for deleting a template `. The template(s) and all versions will be deleted. + .. _en-us_topic_0000002082821521__fig199231122185119: .. figure:: /_static/images/en-us_image_0000002166704124.png :alt: **Figure 5** Dialog box for deleting a template diff --git a/umn/source/managing_templates/viewing_template_details.rst b/umn/source/managing_templates/viewing_template_details.rst index 9052196..caff338 100644 --- a/umn/source/managing_templates/viewing_template_details.rst +++ b/umn/source/managing_templates/viewing_template_details.rst @@ -30,7 +30,7 @@ Viewing Template Details There are three function modules on the template details page: a. **Basic Information**: displays basic information about the template, such as \ **Template Name**\ , \ **Template ID**\ , \ **Template Description**\ , etc, as shown in :ref:`Figure Template Details `. You can modify the template description here. - b. **Version Info**: displays all the version information of this template. You can view the content of any version in **Version** **Preview** by clicking the preview icon for that version. You can also perform different operations on the template versions, such as create, edit, delete or export a stack. + b. **Version Info**: displays all the version information of this template. You can view the content of any version in **Version** **Preview** by clicking the preview icon for that version. You can also perform different operations on the template versions, such as edit, delete, export or create a stack. c. **Version Preview**: displays the template content of the specified version .. _en-us_topic_0000002119404102__fig045261413418: diff --git a/umn/source/permission_management/creating_a_user_and_granting_permissions.rst b/umn/source/permission_management/creating_a_user_and_granting_permissions.rst index 1e57c34..5d23863 100644 --- a/umn/source/permission_management/creating_a_user_and_granting_permissions.rst +++ b/umn/source/permission_management/creating_a_user_and_granting_permissions.rst @@ -28,7 +28,7 @@ Before granting permissions, learn about the RFS permissions and select the perm **Figure 1** Granting RFS permissions -#. On the IAM console, `create a user group and assigning permissions `__. Here, RFS ReadOnlyAccess permissions are used as an example. +#. On the IAM console, `create a user group and assigning permissions `__. Here, **RFS ReadOnlyAccess** permissions are used as an example. #. `Create an IAM user and add it to the created user group `__. diff --git a/umn/source/service_overview/permission.rst b/umn/source/service_overview/permission.rst index b8c71b4..d4871e0 100644 --- a/umn/source/service_overview/permission.rst +++ b/umn/source/service_overview/permission.rst @@ -100,67 +100,70 @@ The following table lists fine-grained actions and dependencies for RFS. .. table:: **Table 3** RFS fine-grained actions - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | System-defined Permission | Description | Dependencies | Scenario | - +========================================+=====================================================+==============+==============================================================================================================+ - | rf:privateTemplate:create | Grant permissions to create a template | None | Creating a template | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:createVersion | Grant permissions to create a template version | None | Creating a template version | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:delete | Grant permissions to delete a template | None | Delete a template | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:deleteVersion | Grant permissions to delete a template version | None | Delete a template version | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:list | Grant permissions to list templates | None | List templates | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:listVersions | Grant permissions to list template versions | None | List template versions | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:showMetadata | Grant permissions to show template metadata | None | Show template properties such as template ID and description | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:showVersionContent | Grant permissions to show template version content | None | Show template version content | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:showVersionMetadata | Grant permissions to show template version metadata | None | Show template version properties such as template ID, template name and version description | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:privateTemplate:updateMetadata | Grant permissions to update template metadata | None | Update template properties such as template description | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:template:parseTemplateVariables | Grant permissions to parse template variables | None | Parse template variables | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:applyExecutionPlan | Grant permissions to apply execution plan | None | Deploy a stack via applying an execution plan | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:createExecutionPlan | Grant permissions to create execution plan | None | Create execution plan | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:deleteExecutionPlan | Grant permissions to delete execution plan | None | Delete execution plan | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:getExecutionPlan | Grant permissions to get execution plan | None | Get execution plan which provides a preview of stack changes such as operations to be performed on resources | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:getExecutionPlanMetadata | Grant permissions to get execution plan metadata | None | Get execution plan properties such as stack id, execution plan id and description. | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:listExecutionPlans | Grant permissions to list execution plans | None | List execution plans | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:createStack | Grant permissions to create stack | None | Create stack | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:deleteStack | Grant permissions to delete stack | None | Delete stack | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:deployStack | Grant permissions to deploy stack | None | Deploy stack directly | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:continueDeployStack | Grant permissions to continue to deploy stack | None | Retry failed stack deployment | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:continueRollbackStack | Grant permissions to continue to rollback stack | None | Retry failed stack rollback | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:getStackMetadata | Grant permissions to get stack metadata | None | Get stack properties such as stack id, name and description | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:getStackTemplate | Grant permissions to get stack template | None | Get stack template | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:listStackEvents | Grant permissions to list stack events | None | List stack events | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:listStackOutputs | Grant permissions to list stack outputs | None | List stack outputs | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:listStackResources | Grant permissions to list stack resources | None | List stack resources | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:listStacks | Grant permissions to list stacks | None | List stacks | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ - | rf:stack:updateStack | Grant permissions to update stack | None | Update stack properties such as description, auto-rollback and deletion protection | - +----------------------------------------+-----------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------+ + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | System-defined Permission | Description | Dependencies | Scenario | + +========================================+=====================================================+================================================+=================================================================================================================+ + | rf:privateTemplate:create | Grant permissions to create a template | None | Create a template | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:createVersion | Grant permissions to create a template version | None | Create a template version | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:delete | Grant permissions to delete a template | None | Delete a template | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:deleteVersion | Grant permissions to delete a template version | None | Delete a template version | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:list | Grant permissions to list templates | None | List templates | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:listVersions | Grant permissions to list template versions | None | List template versions | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:showMetadata | Grant permissions to show template metadata | None | Show template properties such as template ID and description | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:showVersionContent | Grant permissions to show template version content | None | Show template version content | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:showVersionMetadata | Grant permissions to show template version metadata | None | Show template version properties such as template ID, template name and version description | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:privateTemplate:updateMetadata | Grant permissions to update template metadata | None | Update template properties such as template description | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:template:parseTemplateVariables | Grant permissions to parse template variables | None | Parse template variables | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:applyExecutionPlan | Grant permissions to apply execution plan | None | Deploy a stack via applying an execution plan | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:createExecutionPlan | Grant permissions to create execution plan | None | Create an execution plan | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:deleteExecutionPlan | Grant permissions to delete execution plan | None | Delete an execution plan | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:getExecutionPlan | Grant permissions to get execution plan | None | Get an execution plan which provides a preview of stack changes such as operations to be performed on resources | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:getExecutionPlanMetadata | Grant permissions to get execution plan metadata | None | Get execution plan properties such as stack id, execution plan id and description | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:listExecutionPlans | Grant permissions to list execution plans | None | List execution plans | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:createStack | Grant permissions to create stack | Required only for template resource encryption | Create a stack | + | | | | | + | | | - kms:cmk:list | | + | | | - kms:dek:create | | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:deleteStack | Grant permissions to delete stack | None | Delete a stack | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:deployStack | Grant permissions to deploy stack | None | Deploy stack directly | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:continueDeployStack | Grant permissions to continue to deploy stack | None | Retry failed stack deployment | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:continueRollbackStack | Grant permissions to continue to rollback stack | None | Retry failed stack rollback | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:getStackMetadata | Grant permissions to get stack metadata | None | Get stack properties such as stack id, name and description | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:getStackTemplate | Grant permissions to get stack template | None | Get stack template | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:listStackEvents | Grant permissions to list stack events | None | List stack events | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:listStackOutputs | Grant permissions to list stack outputs | None | List stack outputs | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:listStackResources | Grant permissions to list stack resources | None | List stack resources | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:listStacks | Grant permissions to list stacks | None | List stacks | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ + | rf:stack:updateStack | Grant permissions to update stack | None | Update stack properties such as description, auto-rollback and deletion protection | + +----------------------------------------+-----------------------------------------------------+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ Related Documents ----------------- diff --git a/umn/source/service_overview/supported_provider_versions.rst b/umn/source/service_overview/supported_provider_versions.rst index 1e53d75..87a9eac 100644 --- a/umn/source/service_overview/supported_provider_versions.rst +++ b/umn/source/service_overview/supported_provider_versions.rst @@ -7,7 +7,7 @@ Supported Provider Versions A Provider is a plug-in that encapsulates various resource APIs (such as CRUD APIs of resources) for the resource formation engine to call. -The following table lists the Provider types and versions supported by RFS. +RFS will be updated monthly to keep the provider version up-to-date. The following table lists the current Provider types and versions supported by RFS. .. table:: **Table 1** Supported Provider Versions