Update content

This commit is contained in:
OpenTelekomCloud Proposal Bot 2024-12-20 09:36:36 +00:00
parent 4423c20aeb
commit 7d58b27c68
43 changed files with 300 additions and 240 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

View File

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

View File

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 333 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 226 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

View File

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

View File

@ -11,4 +11,4 @@ Auditing
:maxdepth: 1
:hidden:
rfs_operations_supported_by_cts/index
rfs_operations_supported_by_cts

View File

@ -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 <https://docs.otc.t-systems.com/cloud-trace-service/umn/getting_started/querying_real-time_traces.html>`__\ .

View File

@ -1,20 +0,0 @@
:original_name: en-us_topic_0000002119244962.html
.. _en-us_topic_0000002119244962:
RFS Operations Supported by CTS
===============================
- :ref:`Scenario <en-us_topic_0000002156928981>`
- :ref:`Prerequisites <en-us_topic_0000002121529208>`
- :ref:`Supported TMS Operations <en-us_topic_0000002121687316>`
- :ref:`Querying Traces <en-us_topic_0000002157007381>`
.. toctree::
:maxdepth: 1
:hidden:
scenario
prerequisites
supported_tms_operations
querying_traces

View File

@ -1,8 +0,0 @@
:original_name: en-us_topic_0000002121529208.html
.. _en-us_topic_0000002121529208:
Prerequisites
=============
You have enabled CTS.

View File

@ -1,8 +0,0 @@
:original_name: en-us_topic_0000002157007381.html
.. _en-us_topic_0000002157007381:
Querying Traces
===============
See \ `Querying Real-Time Traces <https://docs.otc.t-systems.com/cloud-trace-service/umn/getting_started/querying_real-time_traces.html>`__\ .

View File

@ -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.

View File

@ -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'),
]

View File

@ -15,4 +15,3 @@ Resource Formation Service - User Guide
faqs/index
change_history
glossary
managing_a_stack

View File

@ -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.

File diff suppressed because it is too large Load Diff

View File

@ -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>`.
.. _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>`.
.. _en-us_topic_0000002121580000____d0e1136:
**Figure 4** Execution plan list
|image1|
.. |image1| image:: /_static/images/en-us_image_0000002124611738.png

View File

@ -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 <en-us_topic_0000002156780069____d0e1163>`.
#. 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>`.
.. _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

View File

@ -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

View File

@ -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 <en-us_topic_0000002154604281__fig14388172452918>`.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>`\ .
.. _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 <en-us_topic_0000002154604281__fig14388172452918>`.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

View File

@ -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 <en-us_topic_0000001991770625__fig89226538129>`\ .
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 <en-us_topic_0000001991770625____d0e1035>`. For further details, see \ :ref:`Creating a Stack <en-us_topic_0000001955571466>`\ .
**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 <en-us_topic_0000001991770625____d0e1051>`. For further details, see \ :ref:`Creating a Stack <en-us_topic_0000001955571466>`\ .
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 <en-us_topic_0000001955571466>`\ .
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 <en-us_topic_0000001955571466>`)
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 <en-us_topic_0000001991770625____d0e1035>`. For further details, see \ :ref:`Creating a Stack <en-us_topic_0000001955571466>`\ .
.. _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 <en-us_topic_0000001991770625____d0e1051>`. For further details, see \ :ref:`Creating a Stack <en-us_topic_0000001955571466>`\ .
.. _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 <en-us_topic_0000001955571466>`\ .
Case 2: Replacing the current template (see :ref:`Creating a Stack <en-us_topic_0000001955571466>`)
.. |image1| image:: /_static/images/en-us_image_0000002159891413.png

View File

@ -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 <en-us_topic_0000002154685877__fig198696414206>`.
#. 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>`\ .
.. _en-us_topic_0000002154685877__fig89226538129:
**Figure 2** RFS Stacks
|image1|
:ref:`Table 1 <en-us_topic_0000002154685877____d0e380>` 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

View File

@ -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 <en-us_topic_0000002154685881__fig146836389569>`.
Then, Click **Save Template** in the upper right corner to save this change, as shown in :ref:`Figure 4 <en-us_topic_0000002154685881__fig146836389569>`.
.. _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 <en-us_topic_0000002119245982>`.
|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 <en-us_topic_0000002119245982>`.
|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

View File

@ -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 <en-us_topic_0000002119404102__fig045261413418>`. You can modify the template description here.
b. **Version Info**: displays all the version information of this template. You can 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.

View File

@ -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 |
+----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+