diff --git a/umn/source/_static/images/en-us_image_0000002124611690.png b/umn/source/_static/images/en-us_image_0000002124611690.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002124611690.png differ diff --git a/umn/source/_static/images/en-us_image_0000001955571506.png b/umn/source/_static/images/en-us_image_0000002124611694.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001955571506.png rename to umn/source/_static/images/en-us_image_0000002124611694.png diff --git a/umn/source/_static/images/en-us_image_0000002124611726.png b/umn/source/_static/images/en-us_image_0000002124611726.png new file mode 100644 index 0000000..6b5e70b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002124611726.png differ diff --git a/umn/source/_static/images/en-us_image_0000002124611734.png b/umn/source/_static/images/en-us_image_0000002124611734.png new file mode 100644 index 0000000..6b5e70b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002124611734.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121444564.png b/umn/source/_static/images/en-us_image_0000002124611738.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002121444564.png rename to umn/source/_static/images/en-us_image_0000002124611738.png diff --git a/umn/source/_static/images/en-us_image_0000002124769858.png b/umn/source/_static/images/en-us_image_0000002124769858.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002124769858.png differ diff --git a/umn/source/_static/images/en-us_image_0000002124769866.png b/umn/source/_static/images/en-us_image_0000002124769866.png new file mode 100644 index 0000000..92e22e4 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002124769866.png differ diff --git a/umn/source/_static/images/en-us_image_0000001991890845.png b/umn/source/_static/images/en-us_image_0000002124769882.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001991890845.png rename to umn/source/_static/images/en-us_image_0000002124769882.png diff --git a/umn/source/_static/images/en-us_image_0000002121602684.png b/umn/source/_static/images/en-us_image_0000002124769894.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002121602684.png rename to umn/source/_static/images/en-us_image_0000002124769894.png diff --git a/umn/source/_static/images/en-us_image_0000002124769898.png b/umn/source/_static/images/en-us_image_0000002124769898.png new file mode 100644 index 0000000..3e0389b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002124769898.png differ diff --git a/umn/source/_static/images/en-us_image_0000002156844341.png b/umn/source/_static/images/en-us_image_0000002124769902.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002156844341.png rename to umn/source/_static/images/en-us_image_0000002124769902.png diff --git a/umn/source/_static/images/en-us_image_0000002155926273.png b/umn/source/_static/images/en-us_image_0000002155926273.png deleted file mode 100644 index 457a8ab..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002155926273.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157176621.png b/umn/source/_static/images/en-us_image_0000002157176621.png deleted file mode 100644 index a5f452b..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157176621.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002159891413.png b/umn/source/_static/images/en-us_image_0000002159891413.png new file mode 100644 index 0000000..92e22e4 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002159891413.png differ diff --git a/umn/source/_static/images/en-us_image_0000002159891417.png b/umn/source/_static/images/en-us_image_0000002159891417.png new file mode 100644 index 0000000..92e22e4 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002159891417.png differ diff --git a/umn/source/_static/images/en-us_image_0000002159891445.png b/umn/source/_static/images/en-us_image_0000002159891445.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002159891445.png differ diff --git a/umn/source/_static/images/en-us_image_0000002159891453.png b/umn/source/_static/images/en-us_image_0000002159891453.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002159891453.png differ diff --git a/umn/source/_static/images/en-us_image_0000002159891457.png b/umn/source/_static/images/en-us_image_0000002159891457.png new file mode 100644 index 0000000..6b5e70b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002159891457.png differ diff --git a/umn/source/_static/images/en-us_image_0000002159988909.png b/umn/source/_static/images/en-us_image_0000002159988909.png new file mode 100644 index 0000000..92e22e4 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002159988909.png differ diff --git a/umn/source/_static/images/en-us_image_0000002160009777.png b/umn/source/_static/images/en-us_image_0000002160009777.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002160009777.png differ diff --git a/umn/source/_static/images/en-us_image_0000002160009781.png b/umn/source/_static/images/en-us_image_0000002160009781.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002160009781.png differ diff --git a/umn/source/_static/images/en-us_image_0000001991770665.png b/umn/source/_static/images/en-us_image_0000002160009809.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001991770665.png rename to umn/source/_static/images/en-us_image_0000002160009809.png diff --git a/umn/source/_static/images/en-us_image_0000002160009817.png b/umn/source/_static/images/en-us_image_0000002160009817.png new file mode 100644 index 0000000..3e0389b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002160009817.png differ diff --git a/umn/source/_static/images/en-us_image_0000002160009821.png b/umn/source/_static/images/en-us_image_0000002160009821.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002160009821.png differ diff --git a/umn/source/auditing/index.rst b/umn/source/auditing/index.rst index d71a219..2feab3d 100644 --- a/umn/source/auditing/index.rst +++ b/umn/source/auditing/index.rst @@ -11,4 +11,4 @@ Auditing :maxdepth: 1 :hidden: - rfs_operations_supported_by_cts/index + rfs_operations_supported_by_cts diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/supported_tms_operations.rst b/umn/source/auditing/rfs_operations_supported_by_cts.rst similarity index 65% rename from umn/source/auditing/rfs_operations_supported_by_cts/supported_tms_operations.rst rename to umn/source/auditing/rfs_operations_supported_by_cts.rst index be52999..6461e05 100644 --- a/umn/source/auditing/rfs_operations_supported_by_cts/supported_tms_operations.rst +++ b/umn/source/auditing/rfs_operations_supported_by_cts.rst @@ -1,9 +1,11 @@ -:original_name: en-us_topic_0000002121687316.html +:original_name: en-us_topic_0000002119244962.html -.. _en-us_topic_0000002121687316: +.. _en-us_topic_0000002119244962: -Supported TMS Operations -======================== +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 @@ -27,3 +29,5 @@ Supported TMS Operations deleteTemplateVersion Deleting a template version useAgency Recording user agency ====================== =============================== + +Querying Traces: See \ `Querying Real-Time Traces `__\ . diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/index.rst b/umn/source/auditing/rfs_operations_supported_by_cts/index.rst deleted file mode 100644 index 5ae609a..0000000 --- a/umn/source/auditing/rfs_operations_supported_by_cts/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: en-us_topic_0000002119244962.html - -.. _en-us_topic_0000002119244962: - -RFS Operations Supported by CTS -=============================== - -- :ref:`Scenario ` -- :ref:`Prerequisites ` -- :ref:`Supported TMS Operations ` -- :ref:`Querying Traces ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - scenario - prerequisites - supported_tms_operations - querying_traces diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/prerequisites.rst b/umn/source/auditing/rfs_operations_supported_by_cts/prerequisites.rst deleted file mode 100644 index 57b4cbc..0000000 --- a/umn/source/auditing/rfs_operations_supported_by_cts/prerequisites.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0000002121529208.html - -.. _en-us_topic_0000002121529208: - -Prerequisites -============= - -You have enabled CTS. diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/querying_traces.rst b/umn/source/auditing/rfs_operations_supported_by_cts/querying_traces.rst deleted file mode 100644 index 9896d7c..0000000 --- a/umn/source/auditing/rfs_operations_supported_by_cts/querying_traces.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0000002157007381.html - -.. _en-us_topic_0000002157007381: - -Querying Traces -=============== - -See \ `Querying Real-Time Traces `__\ . diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/scenario.rst b/umn/source/auditing/rfs_operations_supported_by_cts/scenario.rst deleted file mode 100644 index 3461c7f..0000000 --- a/umn/source/auditing/rfs_operations_supported_by_cts/scenario.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0000002156928981.html - -.. _en-us_topic_0000002156928981: - -Scenario -======== - -With Cloud Trace Service (CTS), you can record operations associated with RFS for later query, audit, and backtrack operations. diff --git a/umn/source/conf.py b/umn/source/conf.py index 768dab8..5227d13 100644 --- a/umn/source/conf.py +++ b/umn/source/conf.py @@ -115,7 +115,7 @@ html_copy_source = False latex_documents = [ ('index', 'rfs-umn.tex', - u'Resource Formation Service - User Guide', + u'Resource Formation Service - User Guide', u'OpenTelekomCloud', 'manual'), ] diff --git a/umn/source/index.rst b/umn/source/index.rst index fb1c9fb..12770b4 100644 --- a/umn/source/index.rst +++ b/umn/source/index.rst @@ -15,4 +15,3 @@ Resource Formation Service - User Guide faqs/index change_history glossary - managing_a_stack diff --git a/umn/source/managing_a_stack.rst b/umn/source/managing_a_stack.rst deleted file mode 100644 index 0bc99ac..0000000 --- a/umn/source/managing_a_stack.rst +++ /dev/null @@ -1,67 +0,0 @@ -:original_name: en-us_topic_0000001955571474.html - -.. _en-us_topic_0000001955571474: - -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. diff --git a/umn/source/managing_stacks/creating_a_stack.rst b/umn/source/managing_stacks/creating_a_stack.rst index 714cb83..7120e0f 100644 --- a/umn/source/managing_stacks/creating_a_stack.rst +++ b/umn/source/managing_stacks/creating_a_stack.rst @@ -5,7 +5,24 @@ Creating a Stack ================ -#. Start creating a stack +#. Log in to the management console. + +#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. + + + .. figure:: /_static/images/en-us_image_0000002160009781.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard + +#. In the left navigation pane, choose **Stacks**\ . + + + **Figure 2** RFS Stacks + + |image1| + +4. Start creating a stack There are four ways to start creating a stack here: @@ -17,32 +34,32 @@ Creating a Stack .. _en-us_topic_0000001955571466__fig1102195810527: .. figure:: /_static/images/en-us_image_0000002156043281.png - :alt: **Figure 1** Creating a stack on Dashboard + :alt: **Figure 3** Creating a stack on Dashboard - **Figure 1** Creating a stack on Dashboard + **Figure 3** Creating a stack on Dashboard .. _en-us_topic_0000001955571466__fig14448537155319: .. figure:: /_static/images/en-us_image_0000002155961665.png - :alt: **Figure 2** Creating a stack on Stacks page + :alt: **Figure 4** Creating a stack on Stacks page - **Figure 2** Creating a stack on Stacks page + **Figure 4** Creating a stack on Stacks page .. _en-us_topic_0000001955571466__fig103713552537: .. figure:: /_static/images/en-us_image_0000002120721540.png - :alt: **Figure 3** Creating a stack on My Templates page + :alt: **Figure 5** Creating a stack on My Templates page - **Figure 3** Creating a stack on My Templates page + **Figure 5** Creating a stack on My Templates page .. _en-us_topic_0000001955571466__fig107841574534: .. figure:: /_static/images/en-us_image_0000002120563432.png - :alt: **Figure 4** Creating a stack on template details page + :alt: **Figure 6** Creating a stack on template details page - **Figure 4** Creating a stack on template details page + **Figure 6** Creating a stack on template details page -2. Select Template +5. Select Template There are three ways to select a template, as shown in :ref:`Figure Selecting a template `: @@ -63,9 +80,9 @@ Creating a Stack .. _en-us_topic_0000001955571466__fig133342145369: .. figure:: /_static/images/en-us_image_0000002156043285.png - :alt: **Figure 5** Selecting a template + :alt: **Figure 7** Selecting a template - **Figure 5** Selecting a template + **Figure 7** Selecting a template .. caution:: @@ -202,7 +219,7 @@ The template consists of eight parts: For detailed usage of other resources, please refer to `OpenTelekom Cloud Provider `__. -3. Configure parameters +6. Configure parameters On the parameter configuration page, you can modify the stack name and description and can configure the template parameters, as shown in :ref:`Figure Configuring parameters `. @@ -215,9 +232,9 @@ For detailed usage of other resources, please refer to `OpenTelekom Cloud Provid .. _en-us_topic_0000001955571466__fig179172325107: .. figure:: /_static/images/en-us_image_0000002120705156.png - :alt: **Figure 6** Configuring parameters + :alt: **Figure 8** Configuring parameters - **Figure 6** Configuring parameters + **Figure 8** Configuring parameters Parameters for which the 'nullable' field is set to 'false' in template is marked with a red asterisk (``*``) are mandatory. Set these parameters to valid values. @@ -226,28 +243,28 @@ When certain variables in the template have the field 'sensitive' set to true, K .. _en-us_topic_0000001955571466__fig15774183016141: .. figure:: /_static/images/en-us_image_0000002156056533.png - :alt: **Figure 7** Encrypt requirements + :alt: **Figure 9** Encrypt requirements - **Figure 7** Encrypt requirements + **Figure 9** Encrypt requirements -If a value is invalid, the corresponding text box will turn red (as shown in :ref:`Figure 8 `) and page redirection will not be triggered after you click **Next**. +If a value is invalid, the corresponding text box will turn red (as shown in :ref:`Figure 10 `) and page redirection will not be triggered after you click **Next**. .. _en-us_topic_0000001955571466____d0e644: .. figure:: /_static/images/en-us_image_0000001991770641.png - :alt: **Figure 8** Text box with an invalid value + :alt: **Figure 10** Text box with an invalid value - **Figure 8** Text box with an invalid value + **Figure 10** Text box with an invalid value Check whether the default VPC, subnet, and ECS 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. Then click **Next**. The **Configure Stack** page is displayed. -4. .. _en-us_topic_0000001955571466__li459mcpsimp: +7. .. _en-us_topic_0000001955571466__li459mcpsimp: Configure the stack. - Optional parameters , as shown in :ref:`Figure 9 `: + Optional parameters , as shown in :ref:`Figure 11 `: **IAM Agency (Optional)**: 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. For more details of how to create agency, see :ref:`create an agency `. @@ -262,11 +279,11 @@ Then click **Next**. The **Configure Stack** page is displayed. .. _en-us_topic_0000001955571466____d0e688: .. figure:: /_static/images/en-us_image_0000001991890825.png - :alt: **Figure 9** Configuring the stack + :alt: **Figure 11** Configuring the stack - **Figure 9** Configuring the stack + **Figure 11** Configuring the stack -5. Check the configuration and make sure everything is set correctly. +8. Check the configuration and make sure everything is set correctly. After you confirm the configurations, you can click either **Create Execution Plan** or **Directly Deploy Stack**. @@ -275,41 +292,41 @@ Then click **Next**. The **Configure Stack** page is displayed. .. _en-us_topic_0000001955571466__fig38972020557: .. figure:: /_static/images/en-us_image_0000002156063229.png - :alt: **Figure 10** Directly deploy stack + :alt: **Figure 12** Directly deploy stack - **Figure 10** Directly deploy stack + **Figure 12** Directly deploy stack - a. Click **Yes**. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure 11 `. And it will redirect to the stack events page, as shown in :ref:`Figure Stack Events `. + a. Click **Yes**. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure 13 `. And it will redirect to the stack events page, as shown in :ref:`Figure Stack Events `. .. _en-us_topic_0000001955571466____d0e756: - **Figure 11** Deployment in progress + **Figure 13** Deployment in progress - |image1| + |image2| .. _en-us_topic_0000001955571466__fig173401257402: .. figure:: /_static/images/en-us_image_0000002120746402.png - :alt: **Figure 12** Stack Events + :alt: **Figure 14** Stack Events - **Figure 12** Stack Events + **Figure 14** Stack Events b. Then, if everything goes well, the status changes to **Deployment Complete**, as shown in :ref:`Figure Deployment complete `. .. _en-us_topic_0000001955571466__fig73237820229: - **Figure 13** Deployment complete + **Figure 15** Deployment complete - |image2| + |image3| - 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 Create Execution Plan dialog box `. .. _en-us_topic_0000001955571466__fig1032312852212: .. figure:: /_static/images/en-us_image_0000002156141609.png - :alt: **Figure 14** Create Execution Plan dialog box + :alt: **Figure 16** Create Execution Plan dialog box - **Figure 14** Create Execution Plan dialog box + **Figure 16** Create Execution Plan dialog box .. caution:: @@ -320,79 +337,80 @@ Then click **Next**. The **Configure Stack** page is displayed. .. _en-us_topic_0000001955571466__fig432318842212: - **Figure 15** Execution Plan Available + **Figure 17** Execution Plan Available - |image3| + |image4| - c. Return to the stack list page. The stack status is **Creation Complete**, as shown in :ref:`Figure 16 `. + c. Return to the stack list page. The stack status is **Creation Complete**, as shown in :ref:`Figure 18 `. .. _en-us_topic_0000001955571466____d0e813: - **Figure 16** Stack list + **Figure 18** Stack list - |image4| + |image5| .. 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. - d. Click **Deploy** in the **Operation** column of the execution plan to deploy it, as shown in :ref:`Figure 17 `. + d. Click **Deploy** in the **Operation** column of the execution plan to deploy it, as shown in :ref:`Figure 19 `. .. _en-us_topic_0000001955571466____d0e835: .. figure:: /_static/images/en-us_image_0000002120743398.png - :alt: **Figure 17** Execution plan dialog box + :alt: **Figure 19** Execution plan dialog box - **Figure 17** Execution plan dialog box + **Figure 19** Execution plan dialog box e. 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 Deployment in progress `. .. _en-us_topic_0000001955571466__fig65231214111516: .. figure:: /_static/images/en-us_image_0000002156141613.png - :alt: **Figure 18** Deployment in progress + :alt: **Figure 20** Deployment in progress - **Figure 18** Deployment in progress + **Figure 20** Deployment in progress - f. Then, the stack status changes to **Deployment Complete**, as shown in :ref:`Figure 19 `. + f. Then, the stack status changes to **Deployment Complete**, as shown in :ref:`Figure 21 `. .. _en-us_topic_0000001955571466____d0e866: - **Figure 19** Deployment complete + **Figure 21** Deployment complete - |image5| + |image6| - g. On the **Execution Plans** tab page of the stack details page, the execution plan status is **Applied**, as shown in :ref:`Figure 20 `. + g. On the **Execution Plans** tab page of the stack details page, the execution plan status is **Applied**, as shown in :ref:`Figure 22 `. .. _en-us_topic_0000001955571466____d0e882: .. figure:: /_static/images/en-us_image_0000002120901494.png - :alt: **Figure 20** Applied + :alt: **Figure 22** Applied - **Figure 20** Applied + **Figure 22** Applied -Click the **Events** tab. The event list shows that resources of the stack are deployed, as shown in :ref:`Figure 21 `. +Click the **Events** tab. The event list shows that resources of the stack are deployed, as shown in :ref:`Figure 23 `. .. _en-us_topic_0000001955571466____d0e895: -**Figure 21** Resources deployed +**Figure 23** Resources deployed -|image6| +|image7| You can view additional details on the console of the corresponding cloud service.(:ref:`Figure ECS `\ shows the deployed resources on the ECS console for the above example). .. _en-us_topic_0000001955571466__fig1268133163913: .. figure:: /_static/images/en-us_image_0000002120901474.png - :alt: **Figure 22** ECS + :alt: **Figure 24** ECS - **Figure 22** ECS + **Figure 24** ECS Resources of the stack are deployed. -.. |image1| image:: /_static/images/en-us_image_0000002120901486.png -.. |image2| image:: /_static/images/en-us_image_0000002120743394.png -.. |image3| image:: /_static/images/en-us_image_0000002156064705.png -.. |image4| image:: /_static/images/en-us_image_0000002120745830.png -.. |image5| image:: /_static/images/en-us_image_0000002156063237.png -.. |image6| image:: /_static/images/en-us_image_0000002120743374.png +.. |image1| image:: /_static/images/en-us_image_0000002159988909.png +.. |image2| image:: /_static/images/en-us_image_0000002120901486.png +.. |image3| image:: /_static/images/en-us_image_0000002120743394.png +.. |image4| image:: /_static/images/en-us_image_0000002156064705.png +.. |image5| image:: /_static/images/en-us_image_0000002120745830.png +.. |image6| image:: /_static/images/en-us_image_0000002156063237.png +.. |image7| image:: /_static/images/en-us_image_0000002120743374.png diff --git a/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/creating_an_execution_plan.rst b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/creating_an_execution_plan.rst index 2599f55..5ba92bd 100644 --- a/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/creating_an_execution_plan.rst +++ b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/creating_an_execution_plan.rst @@ -5,25 +5,43 @@ Creating an Execution Plan ========================== -To create an execution plan for an existing stack, you can use either of the following ways: +#. Log in to the management console. -- 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. +#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. -.. figure:: /_static/images/en-us_image_0000002121602684.png - :alt: **Figure 1** Page for creating an execution plan + .. figure:: /_static/images/en-us_image_0000002160009821.png + :alt: **Figure 1** RFS Dashboard - **Figure 1** Page for creating an execution plan + **Figure 1** RFS Dashboard -The subsequent steps are the same as those for **Updating the Stack Template or its Parameters**, except for one difference that you need to click **Create Execution Plan** instead of **Directly Deploy Stack** in the Confirm Configurations step. +#. In the left navigation pane, choose Stacks. -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_0000002121580000____d0e1136: + .. figure:: /_static/images/en-us_image_0000002159891457.png + :alt: **Figure 2** RFS Stacks -**Figure 2** Execution plan list + **Figure 2** RFS Stacks -|image1| +#. To create an execution plan for an existing stack, you can use either of the following ways: -.. |image1| image:: /_static/images/en-us_image_0000002121444564.png + - 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. + + + .. figure:: /_static/images/en-us_image_0000002124769894.png + :alt: **Figure 3** Page for creating an execution plan + + **Figure 3** Page for creating an execution plan + + The subsequent steps are the same as those for **Updating the Stack Template or its Parameters**, except for one difference that you need to click **Create Execution Plan** instead of **Directly Deploy Stack** in the Confirm Configurations step. + + 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 4 `. + + .. _en-us_topic_0000002121580000____d0e1136: + + **Figure 4** Execution plan list + + |image1| + +.. |image1| image:: /_static/images/en-us_image_0000002124611738.png diff --git a/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deleting_an_execution_plan.rst b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deleting_an_execution_plan.rst index 585bff0..5063ac7 100644 --- a/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deleting_an_execution_plan.rst +++ b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deleting_an_execution_plan.rst @@ -5,15 +5,42 @@ Deleting an Execution Plan ========================== -If an execution plan is no longer used, click **Delete** in the **Operation** column. In the Delete Execution Plan dialog window, click OK to confirm the deletion, as shown in :ref:`Figure Deleting an execution plan `. +#. Log in to the management console. -.. _en-us_topic_0000002156780069____d0e1163: +#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. -.. figure:: /_static/images/en-us_image_0000002156844341.png - :alt: **Figure 1** Deleting an execution plan - **Figure 1** Deleting an execution plan + .. figure:: /_static/images/en-us_image_0000002159891445.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard + +#. In the left navigation pane, choose Stacks. + + + .. figure:: /_static/images/en-us_image_0000002124611726.png + :alt: **Figure 2** RFS Stacks + + **Figure 2** RFS Stacks + +#. Click the name of the desired stack to delete its execution plan. + + + **Figure 3** Execution plan list + + |image1| + +#. If an execution plan is no longer used, click **Delete** in the **Operation** column. In the Delete Execution Plan dialog window, click OK to confirm the deletion, as shown in :ref:`Figure Deleting an execution plan `. + + .. _en-us_topic_0000002156780069____d0e1163: + + .. figure:: /_static/images/en-us_image_0000002124769902.png + :alt: **Figure 4** Deleting an execution plan + + **Figure 4** Deleting an execution plan .. warning:: Execution plans cannot be restored once deleted. Exercise caution when performing this operation. + +.. |image1| image:: /_static/images/en-us_image_0000002160009817.png diff --git a/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deploying_an_execution_plan.rst b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deploying_an_execution_plan.rst index ed9562f..a1c971c 100644 --- a/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deploying_an_execution_plan.rst +++ b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deploying_an_execution_plan.rst @@ -5,10 +5,37 @@ Deploying an Execution Plan =========================== -Locate the row that contains the desired execution plan and either click Deploy in the Operation column or select it and click Deploy above the table. +#. Log in to the management console. -After an execution plan is executed, its status changes from Available to Applied and the Deploy options will no longer available for the plan. +#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. + + + .. figure:: /_static/images/en-us_image_0000002159891453.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard + +#. In the left navigation pane, choose Stacks. + + + .. figure:: /_static/images/en-us_image_0000002124611734.png + :alt: **Figure 2** RFS Stacks + + **Figure 2** RFS Stacks + +#. Click the name of the desired stack to deploy its execution plan. + + + **Figure 3** Execution plan list + + |image1| + +#. Locate the row that contains the desired execution plan and either click Deploy in the Operation column or select it and click Deploy above the table. + + After an execution plan is executed, its status changes from Available to Applied and the Deploy options will no longer available for the plan. .. caution:: The execution plans can only be deployed once, but if the deployment fails, there is a possibility to retry the deployment on the Stack List page by clicking on the Continue Deployment link under the Operation column. + +.. |image1| image:: /_static/images/en-us_image_0000002124769898.png diff --git a/umn/source/managing_stacks/modifying_the_basic_parameters_of_a_stack.rst b/umn/source/managing_stacks/modifying_the_basic_parameters_of_a_stack.rst index 586b890..8df2fb2 100644 --- a/umn/source/managing_stacks/modifying_the_basic_parameters_of_a_stack.rst +++ b/umn/source/managing_stacks/modifying_the_basic_parameters_of_a_stack.rst @@ -5,13 +5,33 @@ Modifying the basic parameters of a Stack ========================================= -On the **Stack Detail** page, under **Basic Information** function module, you can click the **Edit** button in the top-right corner to edit the **Basic Information**. +#. Log in to the management console. -It supports changing the stack's **Agency**, modifying the stack's **Description**, as well as toggling the **Auto-Rollback** and **Deletion Protection** settings, as shown in :ref:`Figure Editing Basic Information `.After editing, click **Save** in the top-right corner. +#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. + + + .. figure:: /_static/images/en-us_image_0000002160009777.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard + +#. In the left navigation pane, choose **Stacks**\ on the left, you can see all the stacks created under the current account, as shown in \ :ref:`Figure RFS Stacks `\ . + + .. _en-us_topic_0000002154604281__fig89226538129: + + **Figure 2** RFS Stacks + + |image1| + +#. Click the name of the desired stack to modify, on the **Stack Detail** page, under **Basic Information** function module, you can click the **Edit** button in the top-right corner to edit the **Basic Information**. + + It supports changing the stack's **Agency**, modifying the stack's **Description**, as well as toggling the **Auto-Rollback** and **Deletion Protection** settings, as shown in :ref:`Figure Editing Basic Information `.After editing, click **Save** in the top-right corner. .. _en-us_topic_0000002154604281__fig14388172452918: .. figure:: /_static/images/en-us_image_0000002155949165.png - :alt: **Figure 1** Editing Basic Information + :alt: **Figure 3** Editing Basic Information - **Figure 1** Editing Basic Information + **Figure 3** Editing Basic Information + +.. |image1| image:: /_static/images/en-us_image_0000002124769866.png diff --git a/umn/source/managing_stacks/updating_the_stack_template_or_its_parameters.rst b/umn/source/managing_stacks/updating_the_stack_template_or_its_parameters.rst index 151212c..e1f4036 100644 --- a/umn/source/managing_stacks/updating_the_stack_template_or_its_parameters.rst +++ b/umn/source/managing_stacks/updating_the_stack_template_or_its_parameters.rst @@ -9,41 +9,61 @@ Updating the Stack Template or its Parameters Stack change records are not available. If you want to view change details, you are recommended to create an execution plan. -You can update the stack template or its parameters in either of the following ways: +#. Log in to the management console. -- 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. - -You can change the current template associated with the stack or modify the parameter configuration of the current template. +#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. -.. figure:: /_static/images/en-us_image_0000001955571506.png - :alt: **Figure 1** Selecting a template + .. figure:: /_static/images/en-us_image_0000002124769858.png + :alt: **Figure 1** RFS Dashboard - **Figure 1** Selecting a template + **Figure 1** RFS Dashboard -You can select **Current Template** or **Replace Current Template** (use a new template) to update the stack. +#. In the left navigation pane, click **Stacks**\ on the left, you can see all the stacks created under the current account, as shown in \ :ref:`Figure RFS Stacks `\ . -Case 1: Using the current template + .. _en-us_topic_0000001991770625__fig89226538129: -#. After you select Current Template, click **Next** to go to the **Configure Parameters** page and modify parameters on it, as shown in :ref:`Figure 2 `. For further details, see \ :ref:`Creating a Stack `\ . + **Figure 2** RFS Stacks -.. _en-us_topic_0000001991770625____d0e1035: + |image1| -.. figure:: /_static/images/en-us_image_0000001991890845.png - :alt: **Figure 2** Configuring parameters +#. You can update the stack template or its parameters in either of the following ways: - **Figure 2** Configuring parameters + - 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. -2. Click **Next** to go to the **Confirm Configurations** page, as shown in :ref:`Figure 3 `. For further details, see \ :ref:`Creating a Stack `\ . + You can change the current template associated with the stack or modify the parameter configuration of the current template. -.. _en-us_topic_0000001991770625____d0e1051: -.. figure:: /_static/images/en-us_image_0000001991770665.png - :alt: **Figure 3** Confirming configurations + .. figure:: /_static/images/en-us_image_0000002124611694.png + :alt: **Figure 3** Selecting a template - **Figure 3** Confirming configurations + **Figure 3** Selecting a template -3. Click **Directly Deploy Stack** or **Create Execution Plan**. For further details, see \ :ref:`Creating a Stack `\ . + You can select **Current Template** or **Replace Current Template** (use a new template) to update the stack. -Case 2: Replacing the current template (see :ref:`Creating a Stack `) + Case 1: Using the current template + + a. After you select Current Template, click **Next** to go to the **Configure Parameters** page and modify parameters on it, as shown in :ref:`Figure 4 `. For further details, see \ :ref:`Creating a Stack `\ . + + .. _en-us_topic_0000001991770625____d0e1035: + + .. figure:: /_static/images/en-us_image_0000002124769882.png + :alt: **Figure 4** Configuring parameters + + **Figure 4** Configuring parameters + + b. Click **Next** to go to the **Confirm Configurations** page, as shown in :ref:`Figure 5 `. For further details, see \ :ref:`Creating a Stack `\ . + + .. _en-us_topic_0000001991770625____d0e1051: + + .. figure:: /_static/images/en-us_image_0000002160009809.png + :alt: **Figure 5** Confirming configurations + + **Figure 5** Confirming configurations + + c. Click **Directly Deploy Stack** or **Create Execution Plan**. For further details, see \ :ref:`Creating a Stack `\ . + + Case 2: Replacing the current template (see :ref:`Creating a Stack `) + +.. |image1| image:: /_static/images/en-us_image_0000002159891413.png diff --git a/umn/source/managing_stacks/viewing_stacks.rst b/umn/source/managing_stacks/viewing_stacks.rst index 92acd6a..4daf463 100644 --- a/umn/source/managing_stacks/viewing_stacks.rst +++ b/umn/source/managing_stacks/viewing_stacks.rst @@ -5,14 +5,23 @@ Viewing Stacks ============== -By clicking on "Stacks" on the left, you can see all the stacks created under the current account, as shown in :ref:`Figure Stacks `. +#. Log in to the management console. -.. _en-us_topic_0000002154685877__fig198696414206: +#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. -.. figure:: /_static/images/en-us_image_0000002155926273.png - :alt: **Figure 1** Stacks - **Figure 1** Stacks + .. figure:: /_static/images/en-us_image_0000002124611690.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard + +#. In the left navigation pane, choose **Stacks**\ on the left, you can see all the stacks created under the current account, as shown in \ :ref:`Figure RFS Stacks `\ . + + .. _en-us_topic_0000002154685877__fig89226538129: + + **Figure 2** RFS Stacks + + |image1| :ref:`Table 1 ` describes stack statuses.. @@ -33,3 +42,5 @@ By clicking on "Stacks" on the left, you can see all the stacks created under th Rollback Failed Stack rollback failed. Rollback Complete The stack has been rolled back. ====================== ============================================ + +.. |image1| image:: /_static/images/en-us_image_0000002159891417.png diff --git a/umn/source/managing_templates/replicating_a_template.rst b/umn/source/managing_templates/replicating_a_template.rst index 41e7afd..d46af22 100644 --- a/umn/source/managing_templates/replicating_a_template.rst +++ b/umn/source/managing_templates/replicating_a_template.rst @@ -34,21 +34,20 @@ Replicating a Template |image3| - |image4|\ Then, Click **Save Template** in the upper right corner to save this change, as shown in :ref:`Figure 4 `. + Then, Click **Save Template** in the upper right corner to save this change, as shown in :ref:`Figure 4 `. .. _en-us_topic_0000002154685881__fig146836389569: **Figure 4** Saving Template + |image4| + +#. After clicking 'Save Template', the dialog box of 'Save Template' will be displayed. In this dialog box, you can set the tenplate name, description and version description of the template. Then a new template will be created, you can check in by :ref:`viewing templates `. + |image5| -#. After clicking 'Save Template', the dialog box of 'Save Template' will be displayed. In this dialog box, you can set the description and version description of the template. Then a new template will be created, you can check in by :ref:`viewing stacks `. - - |image6| - .. |image1| image:: /_static/images/en-us_image_0000002157176633.png .. |image2| image:: /_static/images/en-us_image_0000002157073633.png .. |image3| image:: /_static/images/en-us_image_0000002121776826.png -.. |image4| image:: /_static/images/en-us_image_0000002157176621.png -.. |image5| image:: /_static/images/en-us_image_0000002157215025.png -.. |image6| image:: /_static/images/en-us_image_0000002157074637.png +.. |image4| image:: /_static/images/en-us_image_0000002157215025.png +.. |image5| image:: /_static/images/en-us_image_0000002157074637.png diff --git a/umn/source/managing_templates/viewing_template_details.rst b/umn/source/managing_templates/viewing_template_details.rst index 5c63838..58d6794 100644 --- a/umn/source/managing_templates/viewing_template_details.rst +++ b/umn/source/managing_templates/viewing_template_details.rst @@ -32,7 +32,7 @@ Viewing Template Details **Figure 3** Template Details - There are six function modules on the template details page: + There are two 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 preview the content of any version by clicking the preview button for that version in the content section. 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. diff --git a/umn/source/quotas.rst b/umn/source/quotas.rst index e5990d7..164608a 100644 --- a/umn/source/quotas.rst +++ b/umn/source/quotas.rst @@ -4,3 +4,31 @@ Quotas ====== + +RFS limits the number of stacks for a single user, as shown in the following table. + ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| Resource | Item | Quota | ++================+========================================================================================================================+==========================+ +| Template | Maximum number of templates that can be created by a Open Telekom Cloud account | 100 | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum length of a template name | 128 characters | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum length of a template file name | 255 bytes | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum length of a template URL | 2048 bytes | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum size of the file pointed to by the **template_uri** used in APIs for creating a template or a template version | 1 MB after decompression | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum size of the file containing **template_body** used in APIs for creating a template or template version | 50 KB | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| Stack | Maximum number of stacks that can be created by a Open Telekom Cloud account | 100 | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Timeout interval for creating a stack | 6 hours | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum length of a stack name | 128 characters | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| Execution plan | Maximum length of an execution plan name | 255 bytes | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum number of execution plans that can be created in each stack | 100 | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+