nbobkova/resource-formation-service
1
0
Fork 0
forked from docs/resource-formation-service
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2025-02-05 16:41:11 +00:00
parent 6f320287f7
commit 024a359658
18 changed files with 147 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
umn/source/_static/images/en-us_image_0000002157215037.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 99 KiB

BIN
umn/source/_static/images/en-us_image_0000002200348205.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

72
umn/source/auditing.rst
View File

@ -20,41 +20,43 @@ Supported RFS Operations
.. table:: **Table 1** RFS operations supported by CTS
+------------------------+---------------+------------------------------------------------+
| Trace Name | Resource Type | Operation |
+========================+===============+================================================+
| createStack | Stack | Creating a stack |
+------------------------+---------------+------------------------------------------------+
| deployStack | Stack | Deploying a stack |
+------------------------+---------------+------------------------------------------------+
| deleteStack | Stack | Deleting a stack |
+------------------------+---------------+------------------------------------------------+
| updateStack | Stack | Updating a stack |
+------------------------+---------------+------------------------------------------------+
| continueRollbackStack | Stack | Continuing to roll back a stack |
+------------------------+---------------+------------------------------------------------+
| continueDeployStack | Stack | Continuing to deploy a stack |
+------------------------+---------------+------------------------------------------------+
| createExecutionPlan | ExecutionPlan | Creating an execution plan |
+------------------------+---------------+------------------------------------------------+
| applyExecutionPlan | ExecutionPlan | Executing an execution plan |
+------------------------+---------------+------------------------------------------------+
| deleteExecutionPlan | ExecutionPlan | Deleting an execution plan |
+------------------------+---------------+------------------------------------------------+
| createTemplate | Template | Creating a template |
+------------------------+---------------+------------------------------------------------+
| deleteTemplate | Template | Deleting a template |
+------------------------+---------------+------------------------------------------------+
| updateTemplate | Template | Updating template metadata such as description |
+------------------------+---------------+------------------------------------------------+
| createTemplateVersion | Template | Creating a template version |
+------------------------+---------------+------------------------------------------------+
| deleteTemplateVersion | Template | Deleting a template version |
+------------------------+---------------+------------------------------------------------+
| parseTemplateVariables | Template | Parsing template variables |
+------------------------+---------------+------------------------------------------------+
| useAgency | Agency | Recording user agency |
+------------------------+---------------+------------------------------------------------+
+------------------------+---------------+-------------------------------------------------------+
| Trace Name | Resource Type | Operation |
+========================+===============+=======================================================+
| createStack | stack | Creating a stack |
+------------------------+---------------+-------------------------------------------------------+
| deployStack | stack | Deploying a stack directly |
+------------------------+---------------+-------------------------------------------------------+
| deleteStack | stack | Deleting a stack starts |
+------------------------+---------------+-------------------------------------------------------+
| deleteStackEnd | stack | Deleting a stack finished |
+------------------------+---------------+-------------------------------------------------------+
| updateStack | stack | Updating a stack |
+------------------------+---------------+-------------------------------------------------------+
| continueRollbackStack | stack | Retrying a failed rollback. Available only via API. |
+------------------------+---------------+-------------------------------------------------------+
| continueDeployStack | stack | Retrying a failed deployment. Available only via API. |
+------------------------+---------------+-------------------------------------------------------+
| createExecutionPlan | executionPlan | Creating an execution plan |
+------------------------+---------------+-------------------------------------------------------+
| applyExecutionPlan | executionPlan | Executing an execution plan |
+------------------------+---------------+-------------------------------------------------------+
| deleteExecutionPlan | executionPlan | Deleting an execution plan |
+------------------------+---------------+-------------------------------------------------------+
| createTemplate | rf-template | Creating a template |
+------------------------+---------------+-------------------------------------------------------+
| deleteTemplate | rf-template | Deleting a template |
+------------------------+---------------+-------------------------------------------------------+
| updateTemplate | rf-template | Updating template metadata such as description |
+------------------------+---------------+-------------------------------------------------------+
| createTemplateVersion | rf-template | Creating a template version |
+------------------------+---------------+-------------------------------------------------------+
| deleteTemplateVersion | rf-template | Deleting a template version |
+------------------------+---------------+-------------------------------------------------------+
| parseTemplateVariables | template | Parsing template variables |
+------------------------+---------------+-------------------------------------------------------+
| useAgency | agency | Recording user agency |
+------------------------+---------------+-------------------------------------------------------+
Querying Traces
---------------

2
umn/source/faqs/index.rst
View File

@ -8,6 +8,7 @@ FAQs
- :ref:`How Will I Be Charged for Using RFS? <en-us_topic_0000002119244806>`
- :ref:`How Can I Update a Resource Stack? <en-us_topic_0000002154603105>`
- :ref:`What Are the Differences Between Creating an Execution Plan, Applying an Execution Plan, Creating a Stack, and Deploying a Stack? <en-us_topic_0000002154684701>`
- :ref:`Why is the timeout for stack creation six hours? <en-us_topic_0000002165114252>`
.. toctree::
:maxdepth: 1
@ -16,3 +17,4 @@ FAQs
how_will_i_be_charged_for_using_rfs
how_can_i_update_a_resource_stack
what_are_the_differences_between_creating_an_execution_plan_applying_an_execution_plan_creating_a_stack_and_deploying_a_stack
why_is_the_timeout_for_stack_creation_six_hours

2
umn/source/faqs/what_are_the_differences_between_creating_an_execution_plan_applying_an_execution_plan_creating_a_stack_and_deploying_a_stack.rst
View File

@ -7,7 +7,7 @@ What Are the Differences Between Creating an Execution Plan, Applying an Executi
**Creating an execution plan:** Generate an execution plan. You can browse the entire plan in advance to evaluate the impact on ongoing resources. Creating an execution plan will not change the stack. The system changes the stack only when the execution plan is executed.
**Applying an Exection Plan**: Trigger stack deployment based on a template in available state.
**Applying an Exection Plan**: Trigger stack deployment based on an execution plan in available state.
**Creating a stack:** Provide an initial template to create and deploy a stack.

8
umn/source/faqs/why_is_the_timeout_for_stack_creation_six_hours.rst Normal file
View File

@ -0,0 +1,8 @@
:original_name: en-us_topic_0000002165114252.html
.. _en-us_topic_0000002165114252:
Why is the timeout for stack creation six hours?
================================================
Since there are some large templates that require a long processing time, the provider will time out in six hours

4
umn/source/managing_stacks/creating_a_stack.rst
View File

@ -22,7 +22,7 @@ Creating a Stack
a. On the **Dashboard** page:
- click **Create Stack** in the upper right corner.
- click **Create Stack** in the **Select Template** title of the **Guide to Create a Stack** flow chart.
- click **Create Stack** in the **Select Template** tile of the **Guide to Create a Stack** flow chart.
b. On the **Stacks** page, click **Create Stack** in the upper right corner.
@ -386,7 +386,7 @@ Creating a Stack
**Figure 21** Applied
8. Click the **Resources** tab. The event list shows that resources of the stack are deployed, as shown in :ref:`Figure 22 <en-us_topic_0000001955571466____d0e895>`.
8. Click the **Resources** tab. The resource list shows that resources of the stack are deployed, as shown in :ref:`Figure 22 <en-us_topic_0000001955571466____d0e895>`.
.. _en-us_topic_0000001955571466____d0e895:

2
umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deploying_an_execution_plan.rst
View File

@ -34,7 +34,7 @@ Deploying an Execution Plan
#. Locate the row that contains the desired execution plan and click **Deploy** in the **Operation** column. Alternatively, you can click the name of the desired execution plan to navigate to its details page and then click **Deploy** in the **Basic Information** section.
After an execution plan is executed, its status changes from Available to Applied and the Deploy options will no longer available for the plan.
After an execution plan is executed, its status changes from Available to Applied and the Deploy options will no longer be available for the plan.
.. caution::

2
umn/source/managing_stacks/modifying_the_basic_parameters_of_a_stack.rst
View File

@ -11,8 +11,6 @@ Modifying the basic parameters of a Stack
The \ **Dashboard**\ page is displayed.
The \ **Dashboard**\ page is displayed.
.. figure:: /_static/images/en-us_image_0000002160009777.png
:alt: **Figure 1** RFS Dashboard

10
umn/source/managing_templates/creating_a_stack_from_a_template.rst
View File

@ -27,13 +27,14 @@ RFS supports linkage between the stack and the template in console. Users can di
**Figure 2** RFS Private Templates
#. Click the **CreateStack** in the **Operation** column of the desired template using to initiate the creation of a new stack based on the latest template version. You will be automatically redirected to the Create Stack page, where the latest version of the current template is preselected by default as shown in :ref:`Figure 3 <en-us_topic_0000002046584002__fig14609152010154>`.
#. Click **Create Stack** in the **Operation** column of the desired template to initiate the creation of a new stack based on the latest template version. You will be automatically redirected to the \ **Create Stack**\ page, where the latest version of the current template is preselected by default as shown in :ref:`Figure 3 <en-us_topic_0000002046584002__fig18834113282211>`.
.. _en-us_topic_0000002046584002__fig14609152010154:
.. _en-us_topic_0000002046584002__fig18834113282211:
**Figure 3** Selecting Template
.. figure:: /_static/images/en-us_image_0000002200348205.png
:alt: **Figure 3** Selecting Template
|image2|
**Figure 3** Selecting Template
For more information about the entire stack creation procedure, check \ :ref:`Creating a Stack <en-us_topic_0000001955571466>`\ .
@ -42,4 +43,3 @@ RFS supports linkage between the stack and the template in console. Users can di
Creating a stack from a template will by default use the latest template version. If you want to use other versions, please go to \ :ref:`View the Template Details <en-us_topic_0000002119404102>`\ .
.. |image1| image:: /_static/images/en-us_image_0000002158979842.png
.. |image2| image:: /_static/images/en-us_image_0000002157215037.png

2
umn/source/managing_templates/deleting_a_template.rst
View File

@ -45,7 +45,7 @@ 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** in the text box as shown in :ref:`Figure Dialog box for deleting a template <en-us_topic_0000002082821521____d0e1006>`. 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 <en-us_topic_0000002082821521____d0e1006>`. The template(s) and all versions will be deleted.
.. _en-us_topic_0000002082821521____d0e1006:

8
umn/source/managing_templates/exporting_a_template.rst
View File

@ -5,7 +5,7 @@
Exporting a Template
====================
RFS support export an existing template to user's local area.
RFS supports exporting an existing template to local computer.
#. Log in to the management console.
@ -35,11 +35,11 @@ RFS support export an existing template to user's local area.
**Figure 3** RFS Private Templates
Next, the template will be automatically downloaded to the user's local area.
Next, the template will be automatically downloaded to local computer.
.. note::
- The naming convention of the export file is: "{template_name}-{template_version}" and the file extension will be ".zip".
- Only the latest version of the template will be exported by default. If you want to export other versions, please go to \ :ref:`View the Template Details <en-us_topic_0000002119404102>`\ .
- The naming convention of the export file is: "{TEMPLATE_NAME}-{TEMPLATE_VERSION}" and the file extension will be ".zip".
- The latest version of the template will be exported by default. If you want to export other versions, please go to \ :ref:`View the Template Details <en-us_topic_0000002119404102>`\ .
.. |image1| image:: /_static/images/en-us_image_0000002158820094.png

4
umn/source/managing_templates/replicating_a_template.rst
View File

@ -42,7 +42,9 @@ Replicating a Template
#. When the modification is done, click **Save Template** in the upper right corner to save this changes.
#. A dialog box is displayed where you can specify the name, description and version description of the new template.\ |image3|
#. A dialog box is displayed where you can specify the name, description and version description of the new template.
|image3|
.. note::

4
umn/source/managing_templates/viewing_template_details.rst
View File

@ -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 <en-us_topic_0000002119404102__fig045261413418>`. 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 edit the template version here (which will create a new version), export and delete it (If a template has only one version and the deletion of that version will result in the deletion of the entire template), and also use the specified version of the template to directly create 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 create, edit, delete or export a stack.
c. **Version Preview**: displays the template content of the specified version
.. _en-us_topic_0000002119404102__fig045261413418:
@ -42,7 +42,7 @@ Viewing Template Details
You can perform the following operations on the template versions:
- **Editing a version**: this will create a new template version based on the selected version. To start editing a specific template version, click **Edit** in the **Operation** column of the desired version. For more details, check :ref:`Modifying a Template <en-us_topic_0000002046742302>`.
- **Editing a version**: this will create a new template version based on the selected version. To start editing a specific template version, click **Edit** in the **Operation** column of the desired version.
- **Exporting a version**: this will export the selected template version in a zip file format. The naming convention of the export file is: “{TEMPLATE_NAME}-{TEMPLATE_VERSION}.zip”. To export a specific template version, click **More** -> **Export** in the **Operation** column of the desired version.
- **Deleting a version**: this will delete the selected template version. You can delete a single version or multiple versions in batches:

4
umn/source/permission_management/custom_policies.rst
View File

@ -27,6 +27,10 @@ The following lists examples of custom policies for RFS.
- Example 2: Granting permission to deny stack deletion
“Deny” permissions should be used together with “Allow” permissions. If “Deny” and “Allow” permissions are both assigned, the “Deny” permissions take precedence over the “Allow” permissions.
Assume that you want to grant the RF FullAccess permissions to users but do not want them to delete stacks. You can create a custom policy for denying stack deletion, and attach this policy together with the RF FullAccess policy to the users. As an explicit deny in any policy overrides any allows, the users can perform all operations on stacks except deleting them. The following shows an example policy for denying stack deletion.
.. code-block::
{

130
umn/source/service_overview/permission.rst
View File

File diff suppressed because it is too large Load Diff

10
umn/source/service_overview/rfs_and_other_services.rst
View File

@ -5,8 +5,8 @@
RFS and Other Services
======================
- OBS: RFS uses OBS buckets to download template files and dump logs.
- CTS: RFS converts user operations including API calls into audit logs and sends these logs to CTS.
- IAM: RFS uses IAM for user authentication and fine-grained authorization.
- KMS: RFS uses KMS to encrypt sensitive information (in variables or other data) before transmission.
- Config: RFS interconnects with Config service to enable unified management of RFS resources.
- **OBS**: RFS uses OBS buckets to download template files and dump logs.
- **CTS**: RFS converts user operations including API calls into audit logs and sends these logs to CTS.
- **IAM**: RFS uses IAM for user authentication and fine-grained authorization.
- **KMS**: RFS uses KMS to encrypt sensitive information (in variables or other data) before transmission.
- **Config**: RFS interconnects with Config service to enable unified management of RFS resources.

14
umn/source/service_overview/supported_provider_versions.rst
View File

@ -11,10 +11,10 @@ The following table lists the Provider types and versions supported by RFS.
.. table:: **Table 1** Supported Provider Versions
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| Type | Introduction | Version |
+===========================+=======================================================================================================================================================================+======================================================================================================+
| OpenTelekomCloud Provider | Users can use OpenTelekomCloud Provider to interact with various resources on Open Telekom Cloud. Before using the provider, configure the corresponding permissions. | `1.35.13 <https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.35.13/docs>`__ |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| | | `1.36.15 <https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.15/docs>`__ |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| Type | Introduction | Version |
+===========================+======================================================================================================================================================================+======================================================================================================+
| OpenTelekomCloud Provider | Users can use OpenTelekomCloud Provider to interact with various resources on Open Telekom Cloud. Before using the provider, configure the corresponding permissions | `1.35.13 <https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.35.13/docs>`__ |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| | | `1.36.15 <https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/1.36.15/docs>`__ |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+