diff --git a/umn/source/_static/images/en-us_image_0000001973577904.png b/umn/source/_static/images/en-us_image_0000001973577904.png new file mode 100644 index 0000000..05bd386 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577904.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577908.png b/umn/source/_static/images/en-us_image_0000001973577908.png new file mode 100644 index 0000000..5a472bc Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577908.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577912.png b/umn/source/_static/images/en-us_image_0000001973577912.png new file mode 100644 index 0000000..9641721 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577912.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577916.png b/umn/source/_static/images/en-us_image_0000001973577916.png new file mode 100644 index 0000000..2b3cfe5 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577916.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577920.png b/umn/source/_static/images/en-us_image_0000001973577920.png new file mode 100644 index 0000000..a53ddc0 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577920.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577924.png b/umn/source/_static/images/en-us_image_0000001973577924.png new file mode 100644 index 0000000..a53ddc0 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577924.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577928.png b/umn/source/_static/images/en-us_image_0000001973577928.png new file mode 100644 index 0000000..fb71ee9 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577928.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577932.png b/umn/source/_static/images/en-us_image_0000001973577932.png new file mode 100644 index 0000000..03eb286 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577932.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577936.png b/umn/source/_static/images/en-us_image_0000001973577936.png new file mode 100644 index 0000000..004fe20 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577936.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973577940.png b/umn/source/_static/images/en-us_image_0000001973577940.png new file mode 100644 index 0000000..764e21c Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973577940.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973579160.png b/umn/source/_static/images/en-us_image_0000001973579160.png new file mode 100644 index 0000000..61207c0 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973579160.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737644.png b/umn/source/_static/images/en-us_image_0000001973737644.png new file mode 100644 index 0000000..32f66d8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737644.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737648.png b/umn/source/_static/images/en-us_image_0000001973737648.png new file mode 100644 index 0000000..302608a Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737648.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737652.png b/umn/source/_static/images/en-us_image_0000001973737652.png new file mode 100644 index 0000000..5d469e0 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737652.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737660.png b/umn/source/_static/images/en-us_image_0000001973737660.png new file mode 100644 index 0000000..4e5b049 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737660.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737664.png b/umn/source/_static/images/en-us_image_0000001973737664.png new file mode 100644 index 0000000..36b7eed Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737664.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737668.png b/umn/source/_static/images/en-us_image_0000001973737668.png new file mode 100644 index 0000000..305083e Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737668.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737672.png b/umn/source/_static/images/en-us_image_0000001973737672.png new file mode 100644 index 0000000..cf323f6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737672.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737676.png b/umn/source/_static/images/en-us_image_0000001973737676.png new file mode 100644 index 0000000..3f98b99 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737676.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737680.png b/umn/source/_static/images/en-us_image_0000001973737680.png new file mode 100644 index 0000000..df747ab Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737680.png differ diff --git a/umn/source/_static/images/en-us_image_0000001973737684.png b/umn/source/_static/images/en-us_image_0000001973737684.png new file mode 100644 index 0000000..65d4430 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001973737684.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098105.png b/umn/source/_static/images/en-us_image_0000002010098105.png new file mode 100644 index 0000000..bcd708f Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098105.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098109.png b/umn/source/_static/images/en-us_image_0000002010098109.png new file mode 100644 index 0000000..0ef3668 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098109.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098117.png b/umn/source/_static/images/en-us_image_0000002010098117.png new file mode 100644 index 0000000..8ce7a59 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098117.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098121.png b/umn/source/_static/images/en-us_image_0000002010098121.png new file mode 100644 index 0000000..1ae56c9 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098121.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098125.png b/umn/source/_static/images/en-us_image_0000002010098125.png new file mode 100644 index 0000000..a039652 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098125.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098129.png b/umn/source/_static/images/en-us_image_0000002010098129.png new file mode 100644 index 0000000..0a18405 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098129.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098133.png b/umn/source/_static/images/en-us_image_0000002010098133.png new file mode 100644 index 0000000..712e249 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098133.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098137.png b/umn/source/_static/images/en-us_image_0000002010098137.png new file mode 100644 index 0000000..47bc0b2 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098137.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098141.png b/umn/source/_static/images/en-us_image_0000002010098141.png new file mode 100644 index 0000000..27868d9 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098141.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010098145.png b/umn/source/_static/images/en-us_image_0000002010098145.png new file mode 100644 index 0000000..cde92c6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010098145.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217609.png b/umn/source/_static/images/en-us_image_0000002010217609.png new file mode 100644 index 0000000..52c4dbf Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217609.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217613.png b/umn/source/_static/images/en-us_image_0000002010217613.png new file mode 100644 index 0000000..7e74cb0 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217613.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217617.png b/umn/source/_static/images/en-us_image_0000002010217617.png new file mode 100644 index 0000000..2c6695b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217617.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217621.png b/umn/source/_static/images/en-us_image_0000002010217621.png new file mode 100644 index 0000000..5a472bc Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217621.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217625.png b/umn/source/_static/images/en-us_image_0000002010217625.png new file mode 100644 index 0000000..92342a3 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217625.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217629.png b/umn/source/_static/images/en-us_image_0000002010217629.png new file mode 100644 index 0000000..c301765 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217629.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217637.png b/umn/source/_static/images/en-us_image_0000002010217637.png new file mode 100644 index 0000000..b7da3cb Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217637.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217641.png b/umn/source/_static/images/en-us_image_0000002010217641.png new file mode 100644 index 0000000..46461f6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217641.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217645.png b/umn/source/_static/images/en-us_image_0000002010217645.png new file mode 100644 index 0000000..e6f78b4 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217645.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217649.png b/umn/source/_static/images/en-us_image_0000002010217649.png new file mode 100644 index 0000000..7bbd96a Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217649.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010217653.png b/umn/source/_static/images/en-us_image_0000002010217653.png new file mode 100644 index 0000000..ab5dc81 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010217653.png differ diff --git a/umn/source/_static/images/en-us_image_0000002010219181.png b/umn/source/_static/images/en-us_image_0000002010219181.png new file mode 100644 index 0000000..61207c0 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002010219181.png differ diff --git a/umn/source/change_history.rst b/umn/source/change_history.rst new file mode 100644 index 0000000..16f98fa --- /dev/null +++ b/umn/source/change_history.rst @@ -0,0 +1,12 @@ +:original_name: en-us_topic_0000001980286018.html + +.. _en-us_topic_0000001980286018: + +Change History +============== + +========== ============== +Date Change History +========== ============== +2024-07-30 First release +========== ============== diff --git a/umn/source/conf.py b/umn/source/conf.py old mode 100755 new mode 100644 diff --git a/umn/source/docutils.conf b/umn/source/docutils.conf new file mode 100644 index 0000000..7cbe4c1 --- /dev/null +++ b/umn/source/docutils.conf @@ -0,0 +1,2 @@ +[html writers] +table-style: table, caption-top \ No newline at end of file diff --git a/umn/source/index.rst b/umn/source/index.rst index a90356d..46f35c8 100644 --- a/umn/source/index.rst +++ b/umn/source/index.rst @@ -1,3 +1,9 @@ -========================================================== -Welcome to the documentation of resource-formation-service -========================================================== +======================================= +Resource Formation Service - User Guide +======================================= + +.. toctree:: + :maxdepth: 1 + + resource_formation_service/index + change_history diff --git a/umn/source/resource_formation_service/auditing/index.rst b/umn/source/resource_formation_service/auditing/index.rst new file mode 100644 index 0000000..e45886b --- /dev/null +++ b/umn/source/resource_formation_service/auditing/index.rst @@ -0,0 +1,16 @@ +:original_name: en-us_topic_0000002010098101.html + +.. _en-us_topic_0000002010098101: + +Auditing +======== + +- :ref:`RFS Operations Supported by CTS ` +- :ref:`Viewing RFS Logs in CTS ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + rfs_operations_supported_by_cts + viewing_rfs_logs_in_cts diff --git a/umn/source/resource_formation_service/auditing/rfs_operations_supported_by_cts.rst b/umn/source/resource_formation_service/auditing/rfs_operations_supported_by_cts.rst new file mode 100644 index 0000000..b8319eb --- /dev/null +++ b/umn/source/resource_formation_service/auditing/rfs_operations_supported_by_cts.rst @@ -0,0 +1,23 @@ +:original_name: en-us_topic_0000002010217605.html + +.. _en-us_topic_0000002010217605: + +RFS Operations Supported by CTS +=============================== + +Cloud Trace Service (CTS) records all operations performed on cloud services, providing data support for customers in fault locating, resource management, and security auditing. When you enable CTS, it begins to record operations performed on RFS resources. + +.. table:: **Table 1** RFS operations supported by CTS + + ===================== =============================== + Operation Description + ===================== =============================== + createStack Creating a stack + deployStack Deploying a stack + deleteStack Deleting a stack + continueRollbackStack Continuing to roll back a stack + createExecutionPlan Creating an execution plan + applyExecutionPlan Executing an execution plan + deleteExecutionPlan Deleting an execution plan + useAgency Recording user agency + ===================== =============================== diff --git a/umn/source/resource_formation_service/auditing/viewing_rfs_logs_in_cts.rst b/umn/source/resource_formation_service/auditing/viewing_rfs_logs_in_cts.rst new file mode 100644 index 0000000..bf85d37 --- /dev/null +++ b/umn/source/resource_formation_service/auditing/viewing_rfs_logs_in_cts.rst @@ -0,0 +1,69 @@ +:original_name: en-us_topic_0000001973737640.html + +.. _en-us_topic_0000001973737640: + +Viewing RFS Logs in CTS +======================= + +When you enable CTS, it begins to record operations performed on RFS resources. On the CTS console, you can query operation records from the last 7 days by performing the following operations. + +Procedure +--------- + +#. Log in to the CTS console. + +#. In the navigation pane, click **Trace List**. + +#. Filter the desired operation events. + + The trace list supports four filter types: + + - **Trace Source**, **Resource Type**, and **Search By** + + Select the search criteria from the drop-down lists. For example, select **RFS** from the **Trace Source** drop-down list box. + + From the **Search By** drop-down list, select a trace name. From the **Search By** drop-down list, select or enter a specific resource ID. From the **Search By** drop-down list, select or enter a specific resource name. + + - **Trace Status**: Select one of **All trace statuses**, **Normal**, **Warning**, and **Incident**. + + - **Operator**: Select a specific operator (a user other than an account). + + - **Time Range**: You can query traces generated during any time range of the last seven days. + +#. Click |image1| on the left of a trace to expand its details. + +#. Click **View Trace** in the **Operation** column. A dialog box is displayed to show trace structure details. + + .. code-block:: + + { + "trace_id": "3f499b8b-4383-11ef-8963-376e339dc244", + "code": "200", + "trace_name": "parseTemplateVariables", + "resource_type": "template", + "trace_rating": "normal", + "source_ip": "10.206.212.216", + "domain_id": "c76728f39d95407c841f9395481207ab", + "trace_type": "ConsoleAction", + "service_type": "RF", + "event_type": "system", + "project_id": "96f0d33e74db4ed78e1c1a30e0ef793b", + "read_only": false, + "response": "{\"variables\":[{\"default\":\"rf_teststack_vpc\",\"description\":\"vpc name\",\"name\":\"vpc_name\",\"nullable\":false,\"sensitive\":true,\"type\":\"string\"},{\"default\":\"rf_teststack_subnet\",\"description\":\"subnet name\",\"name\":\"subnet_name\",\"nullable\":true,\"sensitive\":false,\"type\":\"string\"},{\"default\":\"rf_teststack_ecs\",\"description\":\"ecs name\",\"name\":\"ecs_name\",\"nullable\":true,\"sensitive\":false,\"type\":\"string\"},{\"description\":\"ecs passwd\",\"name\":\"ecs_admin_passwd\",\"nullable\":true,\"sensitive\":false,\"type\":\"string\"}]}", + "resource_id": "", + "tracker_name": "system", + "resource_account_id": "c76728f39d95407c841f9395481207ab", + "time": 1721141698198, + "resource_name": "", + "user": { + "domain": { + "name": "test", + "id": "c76728*********395481207ab" + }, + "name": "test", + "id": "a46d94423c*********f9a06051cc036" + }, + "record_time": 1721141698198 + } + +.. |image1| image:: /_static/images/en-us_image_0000002010098141.png diff --git a/umn/source/resource_formation_service/getting_started/accessing_resource_formation_service_rfs.rst b/umn/source/resource_formation_service/getting_started/accessing_resource_formation_service_rfs.rst new file mode 100644 index 0000000..60fad66 --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/accessing_resource_formation_service_rfs.rst @@ -0,0 +1,16 @@ +:original_name: en-us_topic_0000001973577888.html + +.. _en-us_topic_0000001973577888: + +Accessing Resource Formation Service (RFS) +========================================== + +1. Log in to the OpenTelekomCloud Console and choose **Service List** > **Management & Governance** > **Resource Formation Service**. + +The supported OpenTelekomCloud regions for RFS are described in the following table. + +=========== =========== =========== +Site Region Name Region Code +=========== =========== =========== +OpenTelekom eu-de eu-de +=========== =========== =========== diff --git a/umn/source/resource_formation_service/getting_started/creating_a_stack.rst b/umn/source/resource_formation_service/getting_started/creating_a_stack.rst new file mode 100644 index 0000000..7076904 --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/creating_a_stack.rst @@ -0,0 +1,334 @@ +:original_name: en-us_topic_0000002010217597.html + +.. _en-us_topic_0000002010217597: + +Creating a Stack +================ + +On the stack list page, click **Create Stack** in the upper right corner, as shown in :ref:`Figure 1 `. + +.. _en-us_topic_0000002010217597_____d0e536: + +.. figure:: /_static/images/en-us_image_0000002010098105.png + :alt: **Figure 1** Creating a stack + + **Figure 1** Creating a stack + +#. Select a template. + + There are three ways to select a template, as shown in :ref:`Figure 2 `: (1). Enter a URL of an OBS template. (2). Upload a local template file. (3). Select a template from **My Templates**. + +.. _en-us_topic_0000002010217597_____d0e557: + +.. figure:: /_static/images/en-us_image_0000002010217609.png + :alt: **Figure 2** Selecting a template + + **Figure 2** Selecting a template + +The following is an example of uploading a local template file. In this example, the **vpc_test.tf.json** file is uploaded. The template content is as follows: + +{ + +"terraform": { + +"required_providers": { + +"opentelekomcloud": { + +"source": "opentelekomcloud/provider/opentelekomcloud", + +"version": "1.36.15" + +} + +} + +}, + +"provider": { + +"opentelekomcloud": { + +"region": "eu-de", + +"insecure": true, + +"auth_url": "https://iam.eu-de.otctest.t-systems.com/v3", + +"tenant_name": "eu-de", + +"domain_name": "{{domain name}}", + +"user_name": "{{user name}}" + +} + +}, + +"variable": { + +"vpc_name": { + +"type": "string", + +"description": "vpc name", + +"default": "rf_teststack_vpc", + +"nullable": false + +}, + +"subnet_name": { + +"type": "string", + +"description": "subnet name", + +"default": "rf_teststack_subnet" + +} + +}, + +"resource": { + +"opentelekomcloud_vpc_v1": { + +"rf_doc_vpc": { + +"name": "${var.vpc_name}", + +"cidr": "192.168.0.0/16" + +} + +}, + +"opentelekomcloud_vpc_subnet_v1": { + +"rf_doc_subnet": { + +"name": "${var.subnet_name}", + +"vpc_id": "${opentelekomcloud_vpc_v1.rf_doc_vpc.id}", + +"cidr": "192.168.1.0/24", + +"gateway_ip": "192.168.1.1" + +} + +} + +}, + +"output": { + +"vpc_id": { + +"value": "${opentelekomcloud_vpc_subnet_v1.rf_doc_vpc.id}" + +} + +} + +} + +.. caution:: + + The sample template contains charged resources. Check whether resources need to be enabled before using the template. + +The template consists of five parts: + +#. **opentelekomcloud_vpc_v1** in **resource** indicates VPC information. + +#. **opentelekomcloud_vpc_subnet_v1** in **resource** indicates information about a subnet defined in the VPC. A subnet is a segment within the IP address range of the VPC. + +#. **variable** indicates variables defined by users in templates during stack creation and deployment. + +#. **output** defines the outputs of templates. After a stack is created, its output is generated based on the definition and displayed on the :ref:`Outputs ` tab page. + +#. Configure parameters. + + Click **Next** to go to the parameter configuration page, where you can modify the stack name and description, as shown in :ref:`Figure 3 `. + +.. caution:: + + The stack name must start with a letter and can contain a maximum of 128 characters, including letters, digits, underscores (_), and hyphens (-). The name must be unique. + + A stack description can contain a maximum of 1024 characters. + +.. _en-us_topic_0000002010217597_____d0e626: + +.. figure:: /_static/images/en-us_image_0000001973737644.png + :alt: **Figure 3** Configuring parameters + + **Figure 3** Configuring parameters + +Parameters marked with a red asterisk (``*``) are mandatory. Set these parameters to valid values. + +If a value is invalid, the corresponding text box will turn red (as shown in :ref:`Figure 4 `) and page redirection will not be triggered after you click **Next**. + +.. _en-us_topic_0000002010217597_____d0e644: + +.. figure:: /_static/images/en-us_image_0000001973577904.png + :alt: **Figure 4** Text box with an invalid value + + **Figure 4** Text box with an invalid value + +Click **Next**. The **Configure Stack** page is displayed. + +.. caution:: + + If the stack name or description is imported using a URL and contains special characters, the characters must be encoded following the HTTP encoding rules first. For example, **test&123** must be converted to **test%26123**, as shown in :ref:`Figure 5 `. (The same verification rules are applied to imported and manually input stack names and descriptions.) + +.. _en-us_topic_0000002010217597_____d0e668: + +.. figure:: /_static/images/en-us_image_0000002010098109.png + :alt: **Figure 5** Stack description imported using a URL + + **Figure 5** Stack description imported using a URL + +Check whether the default VPC, subnet names used on this page already exist on the corresponding consoles. If the names already exist, change them to unique ones to prevent creation failures. + +#. Configure the stack. + + Click **Next** to go to the **Advanced Settings** page, as shown in :ref:`Figure 6 `. + +.. _en-us_topic_0000002010217597_____d0e688: + +.. figure:: /_static/images/en-us_image_0000002010217613.png + :alt: **Figure 6** Configuring the stack + + **Figure 6** Configuring the stack + +Optional parameters: + +**IAM Permission Agency**: An agency can clearly define operation permissions of RFS (such as creation, update, and deletion) on stack resources. If the agency permissions are insufficient, subsequent operations may fail. + +**Deletion Protection**: prevents the stack from being deleted accidentally. After a stack is created, you can update this configuration by clicking **Update** in the **Operation** column. + +**Auto-Rollback**: If auto-rollback is enabled, the stack automatically rolls back to the previous successful resource status when an operation fails. + +Click **Next** to go to the **Confirm Configurations** page. + +#. Confirm the configurations. + + After you confirm the configurations, you can click either **Create Execution Plan** or **Directly Deploy Stack**. + + a. If you click **Directly Deploy Stack**, a confirmation dialog box will be displayed. + + + .. figure:: /_static/images/en-us_image_0000001973737648.png + :alt: **Figure 7** Directly deploy stack + + **Figure 7** Directly deploy stack + + Click **Yes**. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure 8 `. + + .. _en-us_topic_0000002010217597_____d0e756: + + .. figure:: /_static/images/en-us_image_0000001973577908.png + :alt: **Figure 8** Deployment in progress + + **Figure 8** Deployment in progress + + Then, the status changes to **Deployment Complete**, as shown in :ref:`Figure 9 `. + + .. _en-us_topic_0000002010217597_____d0e768: + + **Figure 9** Deployment complete + + |image1| + + b. If you click **Create Execution Plan**, a dialog box of creating execution plan will be displayed. In this dialog box, you can set the name and description of the execution plan, as shown in :ref:`Figure 10 `. + + .. _en-us_topic_0000002010217597_____d0e780: + + .. figure:: /_static/images/en-us_image_0000002010217617.png + :alt: **Figure 10** Create Execution Plan dialog box + + **Figure 10** Create Execution Plan dialog box + + Click **OK**. The **Execution Plans** tab page is displayed. Wait until the execution plan is created and refresh the page. The execution plan status changes to **Available**, as shown in :ref:`Figure 11 `. + + .. _en-us_topic_0000002010217597_____d0e800: + + .. figure:: /_static/images/en-us_image_0000001973737652.png + :alt: **Figure 11** Available + + **Figure 11** Available + + Return to the stack list page. The stack status is **Creation Complete**, as shown in :ref:`Figure 12 `. + + .. _en-us_topic_0000002010217597_____d0e813: + + .. figure:: /_static/images/en-us_image_0000001973577912.png + :alt: **Figure 12** Stack list + + **Figure 12** Stack list + +.. caution:: + + **Creating an execution plan** can preview the resource attribute changes of the entire stack and evaluate the impact. If the execution plan meets your expectations, you can execute the plan. Creating an execution plan does not incur fees. The system changes your stack only when you execute the plan. + +Click **Deploy** in the **Operation** column of the execution plan to deploy it, as shown in :ref:`Figure 13 `. + +.. _en-us_topic_0000002010217597_____d0e835: + +.. figure:: /_static/images/en-us_image_0000002010098117.png + :alt: **Figure 13** Execution plan dialog box + + **Figure 13** Execution plan dialog box + +In the **Execution Plan** dialog box, click **Execute**. A message indicating that the execution plan is being deployed is displayed in the upper right corner. Return to the stack list page. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure 14 `. + +.. _en-us_topic_0000002010217597_____d0e853: + +.. figure:: /_static/images/en-us_image_0000002010217621.png + :alt: **Figure 14** Deployment in progress + + **Figure 14** Deployment in progress + +Then, the stack status changes to **Deployment Complete**, as shown in :ref:`Figure 15 `. + +.. _en-us_topic_0000002010217597_____d0e866: + +**Figure 15** Deployment complete + +|image2| + +On the **Execution Plans** tab page of the stack details page, the execution plan status is **Applied**, as shown in :ref:`Figure 16 `. + +.. _en-us_topic_0000002010217597_____d0e882: + +.. figure:: /_static/images/en-us_image_0000001973577916.png + :alt: **Figure 16** Applied + + **Figure 16** Applied + +Click the **Events** tab. The event list shows that resources of the stack are deployed, as shown in :ref:`Figure 17 `. + +.. _en-us_topic_0000002010217597_____d0e895: + +.. figure:: /_static/images/en-us_image_0000002010098121.png + :alt: **Figure 17** Resources deployed + + **Figure 17** Resources deployed + +You can view details on the console of the corresponding cloud service. + +#. In the service list, locate and click **Virtual Private Cloud**. On the displayed page, view the deployed VPC, as shown in :ref:`Figure 18 `. + + .. _en-us_topic_0000002010217597_____d0e912: + + .. figure:: /_static/images/en-us_image_0000002010217625.png + :alt: **Figure 18** VPC + + **Figure 18** VPC + + Resources of the stack are deployed. + +.. |image1| image:: /_static/images/en-us_image_0000001973579160.png +.. |image2| image:: /_static/images/en-us_image_0000002010219181.png diff --git a/umn/source/resource_formation_service/getting_started/creating_an_execution_plan.rst b/umn/source/resource_formation_service/getting_started/creating_an_execution_plan.rst new file mode 100644 index 0000000..51f8bc0 --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/creating_an_execution_plan.rst @@ -0,0 +1,37 @@ +:original_name: en-us_topic_0000002010098097.html + +.. _en-us_topic_0000002010098097: + +Creating an Execution Plan +========================== + +On the stack list page, click the name of the stack to go to its details page. Click **Update Template/Parameter** in the upper right corner to go to the page for creating an execution plan, as shown in :ref:`Figure 1 `. + +.. _en-us_topic_0000002010098097_____d0e1116: + +.. figure:: /_static/images/en-us_image_0000001973577924.png + :alt: **Figure 1** Page for creating an execution plan + + **Figure 1** Page for creating an execution plan + +The subsequent steps are the same as those for creating a stack, except for one difference that you need to click **Create Execution Plan** instead of **Directly Deploy Stack**. + +Then, an execution plan is generated, but the stack is not directly deployed. If you create multiple execution plans, they will exist in the same stack, as shown in :ref:`Figure 2 `. + +.. _en-us_topic_0000002010098097_____d0e1136: + +.. figure:: /_static/images/en-us_image_0000002010098129.png + :alt: **Figure 2** Execution plan list + + **Figure 2** Execution plan list + +Locate the row that contains the generated execution plan and click **Deploy** in the **Operation** column if you want to deploy tour execution plan. + +If an execution plan is no longer used, click **Delete** in the **Operation** column. Click **OK** in the dialog box displayed, as shown in :ref:`Figure 3 `. + +.. _en-us_topic_0000002010098097_____d0e1163: + +.. figure:: /_static/images/en-us_image_0000002010217637.png + :alt: **Figure 3** Deleting an execution plan + + **Figure 3** Deleting an execution plan diff --git a/umn/source/resource_formation_service/getting_started/deleting_a_stack.rst b/umn/source/resource_formation_service/getting_started/deleting_a_stack.rst new file mode 100644 index 0000000..e3ce78b --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/deleting_a_stack.rst @@ -0,0 +1,39 @@ +:original_name: en-us_topic_0000002010217601.html + +.. _en-us_topic_0000002010217601: + +Deleting a Stack +================ + +1. When **Deletion Protection** is disabled: + +On the stack list page, locate the created stack and click **Delete** in the **Operation** column. In the dialog box displayed, enter **Delete** in the text box and click **OK**. + +Alternatively, go to the stack details page and click **Delete** in the upper right corner, as shown in :ref:`Figure 1 `. + +.. _en-us_topic_0000002010217601_____d0e1485: + +.. figure:: /_static/images/en-us_image_0000001973737668.png + :alt: **Figure 1** Dialog box for deleting a stack + + **Figure 1** Dialog box for deleting a stack + +2. When **Deletion Protection** is enabled: + +:ref:`Figure 2 ` shows that the **Enabled** status of **Deletion Protection**. + +.. _en-us_topic_0000002010217601_____d0e1504: + +.. figure:: /_static/images/en-us_image_0000001973577928.png + :alt: **Figure 2** Deletion protection + + **Figure 2** Deletion protection + +If you delete a resource stack with deletion protection enabled, an error message will be displayed, as shown in :ref:`Figure 3 `. + +.. _en-us_topic_0000002010217601_____d0e1513: + +.. figure:: /_static/images/en-us_image_0000002010098133.png + :alt: **Figure 3** Deletion failed + + **Figure 3** Deletion failed diff --git a/umn/source/resource_formation_service/getting_started/index.rst b/umn/source/resource_formation_service/getting_started/index.rst new file mode 100644 index 0000000..8a95092 --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/index.rst @@ -0,0 +1,28 @@ +:original_name: en-us_topic_0000001973737624.html + +.. _en-us_topic_0000001973737624: + +Getting Started +=============== + +- :ref:`Accessing Resource Formation Service (RFS) ` +- :ref:`Viewing the Stack Status ` +- :ref:`Creating a Stack ` +- :ref:`Querying a Stack ` +- :ref:`Updating a Template or Parameter ` +- :ref:`Creating an Execution Plan ` +- :ref:`Deleting a Stack ` +- :ref:`Viewing Stack Details ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + accessing_resource_formation_service_rfs + viewing_the_stack_status + creating_a_stack + querying_a_stack + updating_a_template_or_parameter + creating_an_execution_plan + deleting_a_stack + viewing_stack_details diff --git a/umn/source/resource_formation_service/getting_started/querying_a_stack.rst b/umn/source/resource_formation_service/getting_started/querying_a_stack.rst new file mode 100644 index 0000000..6d6fee0 --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/querying_a_stack.rst @@ -0,0 +1,17 @@ +:original_name: en-us_topic_0000001973737632.html + +.. _en-us_topic_0000001973737632: + +Querying a Stack +================ + +Log in to the RFS console and click **Stacks** in the navigation pane on the left. The stack list page is displayed. + +In the search box above the stack list, enter the name of the target stack and click the search button, as shown in :ref:`Figure 1 `. + +.. _en-us_topic_0000001973737632_____d0e956: + +.. figure:: /_static/images/en-us_image_0000001973737660.png + :alt: **Figure 1** Querying a stack + + **Figure 1** Querying a stack diff --git a/umn/source/resource_formation_service/getting_started/updating_a_template_or_parameter.rst b/umn/source/resource_formation_service/getting_started/updating_a_template_or_parameter.rst new file mode 100644 index 0000000..8598145 --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/updating_a_template_or_parameter.rst @@ -0,0 +1,54 @@ +:original_name: en-us_topic_0000001973577892.html + +.. _en-us_topic_0000001973577892: + +Updating a Template or Parameter +================================ + +.. caution:: + + Stack change records are not available. If you want to view change details, you are recommended to create an execution plan. + +You can add cloud service resources or change resource specifications in either of the following ways: Go to the stack list page, locate the target stack, and click **Update** in the **Operation** column. Alternatively, go to the stack details page and click **Update Template/Parameter** in the upper right corner to enter the page for updating the resource stack, as shown in :ref:`Figure 1 `. + +.. _en-us_topic_0000001973577892_____d0e1006: + +.. figure:: /_static/images/en-us_image_0000001973577920.png + :alt: **Figure 1** Selecting a template + + **Figure 1** Selecting a template + +You can select **Current Template** or **Replace Current Template** (use a new template) to update the stack. + +Solution 1: Using the current template + +#. Click **Next** to go to the **Configure Parameters** page and modify parameters on it, as shown in :ref:`Figure 2 `. + +.. _en-us_topic_0000001973577892_____d0e1035: + +.. figure:: /_static/images/en-us_image_0000002010098125.png + :alt: **Figure 2** Configuring parameters + + **Figure 2** Configuring parameters + +#. Click **Next** to go to the **Confirm Configurations** page, as shown in :ref:`Figure 3 `. + +.. _en-us_topic_0000001973577892_____d0e1051: + +.. figure:: /_static/images/en-us_image_0000002010217629.png + :alt: **Figure 3** Confirming configurations + + **Figure 3** Confirming configurations + +#. Click **Directly Deploy Stack**. The **Events** page is displayed. + + The status changes to **Update Complete**, as shown in :ref:`Figure 4 `. + + .. _en-us_topic_0000001973577892_____d0e1072: + + .. figure:: /_static/images/en-us_image_0000001973737664.png + :alt: **Figure 4** Update complete + + **Figure 4** Update complete + +Solution 2: Replacing the current template (see :ref:`Creating a Stack `) diff --git a/umn/source/resource_formation_service/getting_started/viewing_stack_details.rst b/umn/source/resource_formation_service/getting_started/viewing_stack_details.rst new file mode 100644 index 0000000..839f23e --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/viewing_stack_details.rst @@ -0,0 +1,75 @@ +:original_name: en-us_topic_0000001973737636.html + +.. _en-us_topic_0000001973737636: + +Viewing Stack Details +===================== + +#. Viewing Stack Details + + There are six function modules on the stack details page (The stack named **stack_20240428_1517_39wa** is an example here.): + + a. **Basic Information**: displays basic information about the stack, as shown in :ref:`Figure 1 `. + + .. _en-us_topic_0000001973737636_____d0e1560: + + .. figure:: /_static/images/en-us_image_0000002010217641.png + :alt: **Figure 1** Basic information + + **Figure 1** Basic information + + b. **Resources**: displays information about cloud services or resources generated during plan execution and stack deployment, as shown in :ref:`Figure 2 `. + + .. _en-us_topic_0000001973737636_____d0e1571: + + .. figure:: /_static/images/en-us_image_0000001973737672.png + :alt: **Figure 2** Resources + + **Figure 2** Resources + + c. **Events**: displays log information generated during plan execution and stack deployment. Events are updated in real time based on the stack status. For example, :ref:`Figure 3 ` shows that three resources are created. + + .. _en-us_topic_0000001973737636_____d0e1583: + + .. figure:: /_static/images/en-us_image_0000001973577932.png + :alt: **Figure 3** Events + + **Figure 3** Events + + d. .. _en-us_topic_0000001973737636__d0e1588: + + **Outputs**: displays output parameters in the template, as shown in :ref:`Figure 4 `: + + .. _en-us_topic_0000001973737636_____d0e1595: + + .. figure:: /_static/images/en-us_image_0000002010098137.png + :alt: **Figure 4** Outputs + + **Figure 4** Outputs + + e. **Template**: displays the template content used for creating a stack, as shown in :ref:`Figure 5 `. + + .. _en-us_topic_0000001973737636_____d0e1606: + + .. figure:: /_static/images/en-us_image_0000002010217645.png + :alt: **Figure 5** Template + + **Figure 5** Template + + f. **Execution Plans**: displays different execution plans. After an execution plan is generated, you need to click **Deploy** to create resources in the template. After an execution plan is executed, its status changes from **Available** to **Applied** and the **Deploy** button disappears, as shown in :ref:`Figure 6 `. + + .. _en-us_topic_0000001973737636_____d0e1629: + + .. figure:: /_static/images/en-us_image_0000001973737676.png + :alt: **Figure 6** Execution plans + + **Figure 6** Execution plans + + Click the execution plan name. The execution plan details page is displayed, as shown in :ref:`Figure 7 `. + + .. _en-us_topic_0000001973737636_____d0e1639: + + .. figure:: /_static/images/en-us_image_0000001973577936.png + :alt: **Figure 7** Execution plan details + + **Figure 7** Execution plan details diff --git a/umn/source/resource_formation_service/getting_started/viewing_the_stack_status.rst b/umn/source/resource_formation_service/getting_started/viewing_the_stack_status.rst new file mode 100644 index 0000000..de38ace --- /dev/null +++ b/umn/source/resource_formation_service/getting_started/viewing_the_stack_status.rst @@ -0,0 +1,43 @@ +:original_name: en-us_topic_0000002010098093.html + +.. _en-us_topic_0000002010098093: + +Viewing the Stack Status +======================== + +You can manage stack lifecycle (such as creation, update, deletion, and query) and the lifecycle of execution plans of a stack (such as creation, deletion, and query). + +:ref:`Table 1 ` describes stack statuses. + +:ref:`Table 2 ` describes execution plan statuses. + +.. _en-us_topic_0000002010098093_____d0e380: + +.. table:: **Table 1** Stack statuses + + ====================== ============================================ + Status Description + ====================== ============================================ + Creation Complete The stack has been created but not deployed. + Deployment In Progress Stack deployment is in progress. + Deployment Complete The stack has been deployed. + Deployment Failed The stack deployment failed. + Deletion In Progress Stack deletion is in progress. + Deletion Failed Stack deletion failed. + Rollback In Progress Stack rollback is in progress. + Rollback Failed Stack rollback failed. + Rollback Complete The stack has been rolled back. + ====================== ============================================ + +.. _en-us_topic_0000002010098093_____d0e458: + +.. table:: **Table 2** Execution plan statuses + + ==================== ================================================= + Status Description + ==================== ================================================= + Creation In Progress Execution plan creation is in progress. + Creation Failed Execution plan creation failed. + Available The execution plan is created and to be deployed. + Applied The execution plan has been deployed. + ==================== ================================================= diff --git a/umn/source/resource_formation_service/iam_agency.rst b/umn/source/resource_formation_service/iam_agency.rst new file mode 100644 index 0000000..0108388 --- /dev/null +++ b/umn/source/resource_formation_service/iam_agency.rst @@ -0,0 +1,69 @@ +:original_name: en-us_topic_0000001973577900.html + +.. _en-us_topic_0000001973577900: + +IAM Agency +========== + +By creating an agency, you can share your resources with another account, or delegate an individual or team to manage your resources. You do not need to share your security credentials (the password and access keys) with the delegated party. Instead, the delegated party can log in with its own account credentials and then switches the role to your account and manage your resources. + +With RFS, you can create a stack to bind an agency with a provider and update the binding relationship by updating the stack. + +RFS uses an agency only in resource operation requests, such as creating a stack (triggering deployment), creating an execution plan, deploying a stack, and deleting a stack. The agency applies only to resource operations performed by the bound provider. If the permissions provided by the agency are insufficient, resource operations may fail. + +**Procedure** + +#. Log in to the IAM console. +#. On the IAM console, choose **Agencies** from the navigation pane on the left, and click **Create Agency** in the upper right corner. + + +.. figure:: /_static/images/en-us_image_0000002010217649.png + :alt: **Figure 1** Creating an agency + + **Figure 1** Creating an agency + +#. Enter an agency name.Set **Cloud Service** to **RFS**. + + + .. figure:: /_static/images/en-us_image_0000001973737680.png + :alt: **Figure 2** Creating an agency + + **Figure 2** Creating an agency + +.. caution:: + + The agency name is user-defined. + + If **op_svc_iac** has been used for registration, you are advised to change it to **RFS**. + +2. Click **Next**. The **Authorize Agency** page is displayed. You can grant permissions to the agency on this page. + + +.. figure:: /_static/images/en-us_image_0000001973577940.png + :alt: **Figure 3** Agency authorization + + **Figure 3** Agency authorization + +3. Filter specific permissions and grant them to the agency. + + +.. figure:: /_static/images/en-us_image_0000002010098145.png + :alt: **Figure 4** Selecting policies + + **Figure 4** Selecting policies + +You can determine the permissions to be granted to an agency. OpenTelekom cloud best practices do not advise you to automatically create agencies with the Tenant Administrator permission for users. The best practice is to grant management permissions (including read and write operations) to resources that may be used in a stack. + +4. Set the authorization scope. You can select **All resources** or **Region-specific projects**. + + +.. figure:: /_static/images/en-us_image_0000002010217653.png + :alt: **Figure 5** Authorization scope + + **Figure 5** Authorization scope + +5. Click **OK**. The agency is created. + +|image1| + +.. |image1| image:: /_static/images/en-us_image_0000001973737684.png diff --git a/umn/source/resource_formation_service/index.rst b/umn/source/resource_formation_service/index.rst new file mode 100644 index 0000000..8ff7ecd --- /dev/null +++ b/umn/source/resource_formation_service/index.rst @@ -0,0 +1,46 @@ +:original_name: en-us_topic_0000002010217593.html + +.. _en-us_topic_0000002010217593: + +Resource Formation Service +========================== + +:ref:`Getting Started ` + +:ref:`Managing a Stack ` + +:ref:`Managing a Stack ` + +:ref:`Auditing ` + +:ref:`IAM Agency ` + +:ref:`Getting Started ` + +:ref:`Managing a Stack ` + +:ref:`Auditing ` + +:ref:`IAM Agency ` + +:ref:`Getting Started ` + +:ref:`Managing a Stack ` + +:ref:`Auditing ` + +:ref:`IAM Agency ` + +- :ref:`Getting Started ` +- :ref:`Managing a Stack ` +- :ref:`Auditing ` +- :ref:`IAM Agency ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + getting_started/index + managing_a_stack + auditing/index + iam_agency diff --git a/umn/source/resource_formation_service/managing_a_stack.rst b/umn/source/resource_formation_service/managing_a_stack.rst new file mode 100644 index 0000000..20d60eb --- /dev/null +++ b/umn/source/resource_formation_service/managing_a_stack.rst @@ -0,0 +1,67 @@ +:original_name: en-us_topic_0000001973577896.html + +.. _en-us_topic_0000001973577896: + +Managing a Stack +================ + +Stack management consists of two aspects. One is lifecycle management of created stacks, including deleting and changing. The other is viewing stack details to obtain their running statuses. + +Modifying a Stack +----------------- + +After a stack is created successfully (that is, in the normal status), you can change the parameters of the stack as needed. + +#. Log in to the RFS console. + +#. In the navigation pane on the left, click **Stacks**. + +#. In the stack list, click the stack to be changed. + +#. On the stack details page, click **Update Template/Parameter**. + +#. Change the template version or input parameters, and click **Next**. + +#. Confirm the configurations and then click **Create Execution Plan**. + +#. On the **Execution Plans** tab page of the stack details page, select the created execution plan and click **Deploy** in the **Operation** column. + + On the **Events** tab page, you can view the detailed operation events related to stack changes. + +Deleting a Stack +---------------- + +Deleted stacks cannot be restored. Exercise caution when deleting a stack. + +#. Log in to the RFS console. + +#. In the navigation pane on the left, click **Stacks**. + +#. In the stack list, select the stack to be deleted and click **Delete** in the **Operation** column. + +#. In the dialog box displayed, enter **Delete** and click **OK**. + + Check the stack name carefully. The deletion cannot be revoked. + + On the **Events** tab page, you can view the detailed operation events related to stack deletion. + +Viewing Stack Details +--------------------- + +After a stack is created, you can view its data and resources on the stack details page. + +- Resources + + Elements of a stack, such as applications and cloud services + +- Outputs + + Output parameters and their values in the stack template + +- Template + + Details of the template used to create the stack + +- Events + + You can view stack events to monitor the stack operation progress. For example, when you create a stack, all important steps during the stack creation are displayed on the **Events** tab page. The events are sorted in chronological order with the latest event being displayed at the top.