diff --git a/umn/source/_static/images/en-us_image_0000002120721540.png b/umn/source/_static/images/en-us_image_0000002120721540.png deleted file mode 100644 index ebf973e..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002120721540.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121747944.png b/umn/source/_static/images/en-us_image_0000002121747944.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121747944.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121776110.png b/umn/source/_static/images/en-us_image_0000002121776110.png deleted file mode 100644 index ae2f625..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121776110.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121776830.png b/umn/source/_static/images/en-us_image_0000002121776830.png deleted file mode 100644 index 1f8c0c1..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121776830.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121776838.png b/umn/source/_static/images/en-us_image_0000002121776838.png deleted file mode 100644 index 1f8c0c1..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121776838.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121900316.png b/umn/source/_static/images/en-us_image_0000002121900316.png deleted file mode 100644 index a09a77d..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121900316.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121903204.png b/umn/source/_static/images/en-us_image_0000002121903204.png deleted file mode 100644 index f83097c..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121903204.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121903472.png b/umn/source/_static/images/en-us_image_0000002121903472.png deleted file mode 100644 index 5ca57f8..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121903472.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121912836.png b/umn/source/_static/images/en-us_image_0000002121912836.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121912836.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121933970.png b/umn/source/_static/images/en-us_image_0000002121933970.png deleted file mode 100644 index fd83346..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121933970.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121934982.png b/umn/source/_static/images/en-us_image_0000002121934982.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121934982.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002121934990.png b/umn/source/_static/images/en-us_image_0000002121934990.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002121934990.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002155961665.png b/umn/source/_static/images/en-us_image_0000002155961665.png deleted file mode 100644 index e64e01b..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002155961665.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002156043281.png b/umn/source/_static/images/en-us_image_0000002156043281.png deleted file mode 100644 index 83d6e8c..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002156043281.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002156043285.png b/umn/source/_static/images/en-us_image_0000002156043285.png deleted file mode 100644 index 52c4dbf..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002156043285.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002156141609.png b/umn/source/_static/images/en-us_image_0000002156141609.png deleted file mode 100644 index 2c6695b..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002156141609.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157055181.png b/umn/source/_static/images/en-us_image_0000002157055181.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157055181.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157066129.png b/umn/source/_static/images/en-us_image_0000002157066129.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157066129.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157073633.png b/umn/source/_static/images/en-us_image_0000002157073633.png deleted file mode 100644 index 1f8c0c1..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157073633.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157154517.png b/umn/source/_static/images/en-us_image_0000002157154517.png deleted file mode 100644 index dd166f9..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157154517.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157176625.png b/umn/source/_static/images/en-us_image_0000002157176625.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157176625.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157176629.png b/umn/source/_static/images/en-us_image_0000002157176629.png deleted file mode 100644 index 1f8c0c1..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157176629.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157176633.png b/umn/source/_static/images/en-us_image_0000002157176633.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157176633.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157215025.png b/umn/source/_static/images/en-us_image_0000002157215025.png deleted file mode 100644 index dd166f9..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157215025.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002157215033.png b/umn/source/_static/images/en-us_image_0000002157215033.png deleted file mode 100644 index bd741ec..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002157215033.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002159988909.png b/umn/source/_static/images/en-us_image_0000002158650788.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002159988909.png rename to umn/source/_static/images/en-us_image_0000002158650788.png diff --git a/umn/source/_static/images/en-us_image_0000002158802688.png b/umn/source/_static/images/en-us_image_0000002158802688.png new file mode 100644 index 0000000..1303a51 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158802688.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158816218.png b/umn/source/_static/images/en-us_image_0000002158816218.png new file mode 100644 index 0000000..20ab12b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158816218.png differ diff --git a/umn/source/_static/images/en-us_image_0000001991890825.png b/umn/source/_static/images/en-us_image_0000002158816238.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001991890825.png rename to umn/source/_static/images/en-us_image_0000002158816238.png diff --git a/umn/source/_static/images/en-us_image_0000002158817102.png b/umn/source/_static/images/en-us_image_0000002158817102.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158817102.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158817114.png b/umn/source/_static/images/en-us_image_0000002158817114.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158817114.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158817118.png b/umn/source/_static/images/en-us_image_0000002158817118.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158817118.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158819098.png b/umn/source/_static/images/en-us_image_0000002158819098.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158819098.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158820094.png b/umn/source/_static/images/en-us_image_0000002158820094.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158820094.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158820098.png b/umn/source/_static/images/en-us_image_0000002158820098.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158820098.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158820394.png b/umn/source/_static/images/en-us_image_0000002158820394.png new file mode 100644 index 0000000..90490cd Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158820394.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158823458.png b/umn/source/_static/images/en-us_image_0000002158823458.png new file mode 100644 index 0000000..51cffd8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158823458.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158823486.png b/umn/source/_static/images/en-us_image_0000002158823486.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158823486.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158823498.png b/umn/source/_static/images/en-us_image_0000002158823498.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158823498.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158823542.png b/umn/source/_static/images/en-us_image_0000002158823542.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158823542.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158823546.png b/umn/source/_static/images/en-us_image_0000002158823546.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158823546.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120745830.png b/umn/source/_static/images/en-us_image_0000002158975566.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002120745830.png rename to umn/source/_static/images/en-us_image_0000002158975566.png diff --git a/umn/source/_static/images/en-us_image_0000002158975806.png b/umn/source/_static/images/en-us_image_0000002158975806.png new file mode 100644 index 0000000..3923753 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158975806.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158976894.png b/umn/source/_static/images/en-us_image_0000002158976894.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158976894.png differ diff --git a/umn/source/_static/images/en-us_image_0000002155949165.png b/umn/source/_static/images/en-us_image_0000002158978150.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002155949165.png rename to umn/source/_static/images/en-us_image_0000002158978150.png diff --git a/umn/source/_static/images/en-us_image_0000002121934986.png b/umn/source/_static/images/en-us_image_0000002158978858.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002121934986.png rename to umn/source/_static/images/en-us_image_0000002158978858.png diff --git a/umn/source/_static/images/en-us_image_0000002158979842.png b/umn/source/_static/images/en-us_image_0000002158979842.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158979842.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158979846.png b/umn/source/_static/images/en-us_image_0000002158979846.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158979846.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157146149.png b/umn/source/_static/images/en-us_image_0000002158983038.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002157146149.png rename to umn/source/_static/images/en-us_image_0000002158983038.png diff --git a/umn/source/_static/images/en-us_image_0000002158983306.png b/umn/source/_static/images/en-us_image_0000002158983306.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158983306.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158983366.png b/umn/source/_static/images/en-us_image_0000002158983366.png new file mode 100644 index 0000000..51cffd8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158983366.png differ diff --git a/umn/source/_static/images/en-us_image_0000002158983474.png b/umn/source/_static/images/en-us_image_0000002158983474.png new file mode 100644 index 0000000..51cffd8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002158983474.png differ diff --git a/umn/source/_static/images/en-us_image_0000002159668284.png b/umn/source/_static/images/en-us_image_0000002159668284.png new file mode 100644 index 0000000..e54525e Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002159668284.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194091645.png b/umn/source/_static/images/en-us_image_0000002194091645.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194091645.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120563432.png b/umn/source/_static/images/en-us_image_0000002194091653.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002120563432.png rename to umn/source/_static/images/en-us_image_0000002194091653.png diff --git a/umn/source/_static/images/en-us_image_0000002194180509.png b/umn/source/_static/images/en-us_image_0000002194180509.png new file mode 100644 index 0000000..9fa5dbc Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194180509.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194183289.png b/umn/source/_static/images/en-us_image_0000002194183289.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194183289.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194183665.png b/umn/source/_static/images/en-us_image_0000002194183665.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194183665.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194186605.png b/umn/source/_static/images/en-us_image_0000002194186605.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194186605.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194186609.png b/umn/source/_static/images/en-us_image_0000002194186609.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194186609.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194187417.png b/umn/source/_static/images/en-us_image_0000002194187417.png new file mode 100644 index 0000000..4912110 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194187417.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194189973.png b/umn/source/_static/images/en-us_image_0000002194189973.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194189973.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194190049.png b/umn/source/_static/images/en-us_image_0000002194190049.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194190049.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194190061.png b/umn/source/_static/images/en-us_image_0000002194190061.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194190061.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194191125.png b/umn/source/_static/images/en-us_image_0000002194191125.png new file mode 100644 index 0000000..21460cb Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194191125.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194218013.png b/umn/source/_static/images/en-us_image_0000002194218013.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194218013.png differ diff --git a/umn/source/_static/images/en-us_image_0000002156988229.png b/umn/source/_static/images/en-us_image_0000002194220965.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000002156988229.png rename to umn/source/_static/images/en-us_image_0000002194220965.png diff --git a/umn/source/_static/images/en-us_image_0000002194220969.png b/umn/source/_static/images/en-us_image_0000002194220969.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194220969.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194220973.png b/umn/source/_static/images/en-us_image_0000002194220973.png new file mode 100644 index 0000000..582b161 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194220973.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194224409.png b/umn/source/_static/images/en-us_image_0000002194224409.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194224409.png differ diff --git a/umn/source/_static/images/en-us_image_0000002194226997.png b/umn/source/_static/images/en-us_image_0000002194226997.png new file mode 100644 index 0000000..884c294 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002194226997.png differ diff --git a/umn/source/auditing.rst b/umn/source/auditing.rst new file mode 100644 index 0000000..b0ac579 --- /dev/null +++ b/umn/source/auditing.rst @@ -0,0 +1,62 @@ +:original_name: en-us_topic_0000002154653061.html + +.. _en-us_topic_0000002154653061: + +Auditing +======== + +Scenario +-------- + +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 resource + +Prerequisites +------------- + +You have enabled CTS. + +Supported RFS Operations +------------------------ + +.. table:: **Table 1** RFS operations supported by CTS + + +------------------------+---------------+------------------------------------------------+ + | Trace Name | Resource Type | Operation | + +========================+===============+================================================+ + | createStack | Stack | Creating a stack | + +------------------------+---------------+------------------------------------------------+ + | deployStack | Stack | Deploying a stack | + +------------------------+---------------+------------------------------------------------+ + | deleteStack | Stack | Deleting a stack | + +------------------------+---------------+------------------------------------------------+ + | updateStack | Stack | Updating a stack | + +------------------------+---------------+------------------------------------------------+ + | continueRollbackStack | Stack | Continuing to roll back a stack | + +------------------------+---------------+------------------------------------------------+ + | continueDeployStack | Stack | Continuing to deploy a stack | + +------------------------+---------------+------------------------------------------------+ + | createExecutionPlan | ExecutionPlan | Creating an execution plan | + +------------------------+---------------+------------------------------------------------+ + | applyExecutionPlan | ExecutionPlan | Executing an execution plan | + +------------------------+---------------+------------------------------------------------+ + | deleteExecutionPlan | ExecutionPlan | Deleting an execution plan | + +------------------------+---------------+------------------------------------------------+ + | createTemplate | Template | Creating a template | + +------------------------+---------------+------------------------------------------------+ + | deleteTemplate | Template | Deleting a template | + +------------------------+---------------+------------------------------------------------+ + | updateTemplate | Template | Updating template metadata such as description | + +------------------------+---------------+------------------------------------------------+ + | createTemplateVersion | Template | Creating a template version | + +------------------------+---------------+------------------------------------------------+ + | deleteTemplateVersion | Template | Deleting a template version | + +------------------------+---------------+------------------------------------------------+ + | parseTemplateVariables | Template | Parsing template variables | + +------------------------+---------------+------------------------------------------------+ + | useAgency | Agency | Recording user agency | + +------------------------+---------------+------------------------------------------------+ + +Querying Traces +--------------- + +See \ `Querying Real-Time Traces `__\ . diff --git a/umn/source/auditing/index.rst b/umn/source/auditing/index.rst deleted file mode 100644 index 2feab3d..0000000 --- a/umn/source/auditing/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -:original_name: en-us_topic_0000002154653061.html - -.. _en-us_topic_0000002154653061: - -Auditing -======== - -- :ref:`RFS Operations Supported by CTS ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - rfs_operations_supported_by_cts diff --git a/umn/source/auditing/rfs_operations_supported_by_cts.rst b/umn/source/auditing/rfs_operations_supported_by_cts.rst deleted file mode 100644 index 6461e05..0000000 --- a/umn/source/auditing/rfs_operations_supported_by_cts.rst +++ /dev/null @@ -1,33 +0,0 @@ -:original_name: en-us_topic_0000002119244962.html - -.. _en-us_topic_0000002119244962: - -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 - updateStack Updating a stack - parseTemplateVariables Parsing template variables - continueRollbackStack Continuing to roll back a stack - continuedeployStack Continuing to deploy a stack - createExecutionPlan Creating an execution plan - applyExecutionPlan Executing an execution plan - deleteExecutionPlan Deleting an execution plan - createTemplate Creating a template - deleteTemplate Deleting a template - updateTemplate Updating a template - createTemplateVersion Creating a template version - deleteTemplateVersion Deleting a template version - useAgency Recording user agency - ====================== =============================== - -Querying Traces: See \ `Querying Real-Time Traces `__\ . diff --git a/umn/source/change_history.rst b/umn/source/change_history.rst index 5c32723..5e162a9 100644 --- a/umn/source/change_history.rst +++ b/umn/source/change_history.rst @@ -5,8 +5,8 @@ Change History ============== -=========== ================================================== +=========== =================================== Released On Description -=========== ================================================== -2024-12-14 Open Telekom Cloud Provider v1.35.13 is supported. -=========== ================================================== +=========== =================================== +2024-12-14 This is the first official release. +=========== =================================== diff --git a/umn/source/conf.py b/umn/source/conf.py index 5227d13..768dab8 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/faqs/how_can_i_update_a_resource_stack.rst b/umn/source/faqs/how_can_i_update_a_resource_stack.rst index acf7eb0..1bd30e9 100644 --- a/umn/source/faqs/how_can_i_update_a_resource_stack.rst +++ b/umn/source/faqs/how_can_i_update_a_resource_stack.rst @@ -6,3 +6,5 @@ How Can I Update a Resource Stack? ================================== RFS supports updating stacks. To update a stack, modify your stack template first by modifying its parameter values, or adding or deleting resources specified in the template. Then, click **Update** and select the modified template to update the stack. + +For further information about the stack update procedure, check \ :ref:`Updating the Stack Template or its Parameters `. diff --git a/umn/source/faqs/how_will_i_be_charged_for_using_rfs.rst b/umn/source/faqs/how_will_i_be_charged_for_using_rfs.rst index c3a7029..3b66753 100644 --- a/umn/source/faqs/how_will_i_be_charged_for_using_rfs.rst +++ b/umn/source/faqs/how_will_i_be_charged_for_using_rfs.rst @@ -5,4 +5,4 @@ How Will I Be Charged for Using RFS? ==================================== -RFS itself is free of charge. However, when you use a template to create a stack, RFS will create cloud service resources as specified in the template. These resources are charged at the pricing of the corresponding cloud services. +RFS itself is free of charge. However, when you use a template to deploy your service, RFS will create cloud service resources as specified in the template. These resources are charged at the pricing of the corresponding cloud services. diff --git a/umn/source/faqs/index.rst b/umn/source/faqs/index.rst index a7b005e..8b461d2 100644 --- a/umn/source/faqs/index.rst +++ b/umn/source/faqs/index.rst @@ -7,7 +7,7 @@ FAQs - :ref:`How Will I Be Charged for Using RFS? ` - :ref:`How Can I Update a Resource Stack? ` -- :ref:`What Are the Differences Between Creating an Execution Plan, Creating a Resource Stack, and Updating a Resource Stack? ` +- :ref:`What Are the Differences Between Creating an Execution Plan, Applying an Execution Plan, Creating a Stack, and Deploying a Stack? ` .. toctree:: :maxdepth: 1 @@ -15,4 +15,4 @@ FAQs how_will_i_be_charged_for_using_rfs how_can_i_update_a_resource_stack - what_are_the_differences_between_creating_an_execution_plan_creating_a_resource_stack_and_updating_a_resource_stack + what_are_the_differences_between_creating_an_execution_plan_applying_an_execution_plan_creating_a_stack_and_deploying_a_stack diff --git a/umn/source/faqs/what_are_the_differences_between_creating_an_execution_plan_creating_a_resource_stack_and_updating_a_resource_stack.rst b/umn/source/faqs/what_are_the_differences_between_creating_an_execution_plan_applying_an_execution_plan_creating_a_stack_and_deploying_a_stack.rst similarity index 55% rename from umn/source/faqs/what_are_the_differences_between_creating_an_execution_plan_creating_a_resource_stack_and_updating_a_resource_stack.rst rename to umn/source/faqs/what_are_the_differences_between_creating_an_execution_plan_applying_an_execution_plan_creating_a_stack_and_deploying_a_stack.rst index 1843c74..1ffda17 100644 --- a/umn/source/faqs/what_are_the_differences_between_creating_an_execution_plan_creating_a_resource_stack_and_updating_a_resource_stack.rst +++ b/umn/source/faqs/what_are_the_differences_between_creating_an_execution_plan_applying_an_execution_plan_creating_a_stack_and_deploying_a_stack.rst @@ -2,11 +2,13 @@ .. _en-us_topic_0000002154684701: -What Are the Differences Between Creating an Execution Plan, Creating a Resource Stack, and Updating a Resource Stack? -====================================================================================================================== +What Are the Differences Between Creating an Execution Plan, Applying an Execution Plan, Creating a Stack, and Deploying a Stack? +================================================================================================================================= **Creating an execution plan:** Generate an execution plan. You can browse the entire plan in advance to evaluate the impact on ongoing resources. Creating an execution plan will not change the stack. The system changes the stack only when the execution plan is executed. +**Applying an Exection Plan**: Trigger stack deployment based on a template in available state. + **Creating a stack:** Provide an initial template to create and deploy a stack. -**Updating a stack:** Provide a new template or new parameters to trigger a new deployment for directly modifying the stack. +**Deploying a stack:** Trigger a new deployment by either deploying a stack directly or applying an execution plan. diff --git a/umn/source/iam_agency.rst b/umn/source/iam_agency.rst index 6b29604..82cbadf 100644 --- a/umn/source/iam_agency.rst +++ b/umn/source/iam_agency.rst @@ -22,9 +22,10 @@ RFS uses an agency only in resource operation requests, such as creating a stack **Figure 1** Creating an agency -3. Enter an agency name. +3. Enter an agency name, - Set the Agency Type to Cloud Service, and set **Cloud Service** to **RFS**. + - the \ **Agency Type**\ is set to \ **Cloud Service** + - the **Cloud Service** is set to **RFS**. **Figure 2** Creating an agency @@ -55,7 +56,7 @@ You can determine the permissions to be granted to an agency. OpenTelekom cloud **Figure 4** Authorization scope -6. Click **OK**. The agency is created. Now you can use it in \ :ref:`Configure the stack. `. +6. Click **OK**. The agency is created. Now you can use it in \ :ref:`Configure the stack. ` |image2|\ For more information about IAM Agencies, see: `Cloud Service Agency `__. diff --git a/umn/source/index.rst b/umn/source/index.rst index 12770b4..2ae3e27 100644 --- a/umn/source/index.rst +++ b/umn/source/index.rst @@ -8,8 +8,8 @@ Resource Formation Service - User Guide service_overview/index managing_stacks/index managing_templates/index - permission_management - auditing/index + permission_management/index + auditing quotas iam_agency faqs/index diff --git a/umn/source/managing_stacks/creating_a_stack.rst b/umn/source/managing_stacks/creating_a_stack.rst index 7120e0f..12a4d76 100644 --- a/umn/source/managing_stacks/creating_a_stack.rst +++ b/umn/source/managing_stacks/creating_a_stack.rst @@ -7,7 +7,9 @@ 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**\ . + + The **Dashboard** page is displayed. .. figure:: /_static/images/en-us_image_0000002160009781.png @@ -15,256 +17,251 @@ Creating a Stack **Figure 1** RFS Dashboard -#. In the left navigation pane, choose **Stacks**\ . +#. There are several ways to start creating a stack + + a. On the **Dashboard** page: + + - click **Create Stack** in the upper right corner. + - click **Create Stack** in the **Select Template** title of the **Guide to Create a Stack** flow chart. + + b. On the **Stacks** page, click **Create Stack** in the upper right corner. - **Figure 2** RFS Stacks + **Figure 2** Creating a stack on Stacks page - |image1| + |image2| -4. Start creating a stack + c. On the **Templates** -> **Private Templates** page: - There are four ways to start creating a stack here: + - click **Create Stack** under the **Operation** column associated with an existing template. - a. On the Dashboard page, click Create Stack in the upper right corner, as shown in :ref:`Figure Creating a stack on Dashboard `. - b. On the Stacks page , click Create Stack in the upper right corner, as shown in :ref:`Figure Creating a stack on Stacks page `. - c. On the Templates -> My Templates page, click Create Stack under the Operation column associated with an existing template, as shown in :ref:`Figure Creating a stack on My Templates page `. - d. On the template details page, click Create Stack under the Operation column associated with a specific template version, as shown in :ref:`Figure Creating a stack on template details page `. -.. _en-us_topic_0000001955571466__fig1102195810527: + .. figure:: /_static/images/en-us_image_0000002194226997.png + :alt: **Figure 3** Creating a stack on Private Templates page -.. figure:: /_static/images/en-us_image_0000002156043281.png - :alt: **Figure 3** Creating a stack on Dashboard + **Figure 3** Creating a stack on Private Templates page - **Figure 3** Creating a stack on Dashboard + - click the name of the desired template to navigate to its details page, and then click **Create Stack** under the **Operation** column associated with a specific template version. -.. _en-us_topic_0000001955571466__fig14448537155319: -.. figure:: /_static/images/en-us_image_0000002155961665.png - :alt: **Figure 4** Creating a stack on Stacks page + .. figure:: /_static/images/en-us_image_0000002194091653.png + :alt: **Figure 4** Creating a stack on Template Details page - **Figure 4** Creating a stack on Stacks page + **Figure 4** Creating a stack on Template Details page -.. _en-us_topic_0000001955571466__fig103713552537: +4. .. _en-us_topic_0000001955571466__li7334814113611: -.. figure:: /_static/images/en-us_image_0000002120721540.png - :alt: **Figure 5** Creating a stack on My Templates page + There are three ways to select a template. - **Figure 5** Creating a stack on My Templates page -.. _en-us_topic_0000001955571466__fig107841574534: + .. figure:: /_static/images/en-us_image_0000002194180509.png + :alt: **Figure 5** Selecting a template -.. figure:: /_static/images/en-us_image_0000002120563432.png - :alt: **Figure 6** Creating a stack on template details page + **Figure 5** Selecting a template - **Figure 6** Creating a stack on template details page - -5. Select Template - - There are three ways to select a template, as shown in :ref:`Figure Selecting a template `: - - a. Select a template from **My Templates**: Template name and version selector dropdowns. + a. Select a template from **Private Templates**: Template name and version selector dropdowns. b. Enter a URL of an OBS template: Template URL dropdown. (The URL must contain at least the deployment code file, and the file size cannot exceed 1 MB.) Example: https://test-stack-template.obs.eu-de.otc.t-systems.com/main.tf - c. Upload a local template file: click "Add File" button. + c. Upload a local template file or zip by clicking **Add File**\ button. + + .. important:: + + - The .tf, .tf.json, and .zip files are supported. + - At least the deployment code file needs to be uploaded. + - The size of a file cannot exceed 50 KB. + - The size of a decompressed .zip file cannot exceed 1 MB. Then click **Next** to go to the parameter configuration page. -.. important:: + .. caution:: - The .tf, .tf.json, and .zip files are supported. At least the deployment code file needs to be uploaded. The size of a file cannot exceed 50 KB. The size of a decompressed .zip file cannot exceed 1 MB. + - A stack is created using a template. The template must contain the deployment code file which file name extension is tf or tf.json. + - The deployment code file must use the open source HCL syntax. After the file is imported, the corresponding resource configuration table is generated for users to configure resource parameters. This file must be provided in URL or via template upload. + - When using the RFS service, users do not need to specify the "access_key" and "secret_key" fields under the **provider block** in the template. + - RFS only uses the data you upload for resource management. -.. _en-us_topic_0000001955571466__fig133342145369: + The following is an example of uploading a local template file. In this example, the **ecs_test.tf.json** file is uploaded. The template content is as follows: -.. figure:: /_static/images/en-us_image_0000002156043285.png - :alt: **Figure 7** Selecting a template + .. code-block:: - **Figure 7** Selecting a template - -.. caution:: - - - A stack is created using a template. The template must contain the deployment code file which file name extension is tf or tf.json. - - The deployment code file must use the open source HCL syntax. After the file is imported, the corresponding resource configuration table is generated for users to configure resource parameters. This file must be provided in URL or via template upload. - - When using the RFS service, users do not need to specify the "access_key" and "secret_key" fields under the **provider block** in the template. - - RFS only uses the data you upload for resource management. - -The following is an example of uploading a local template file. In this example, the **ecs_test.tf.json** file is uploaded. The template content is as follows: - -.. code-block:: - - { - "terraform": { - "required_providers": { - "opentelekomcloud": { - "source": "opentelekomcloud/provider/opentelekomcloud", - "version": "1.35.13" - } - } - }, - "provider": { - "opentelekomcloud": { - "region": "eu-de", - "insecure": true, - "auth_url": "https://iam.eu-de.otc.t-systems.com/v3", - "tenant_name": "eu-de", - "domain_name": "OTC-EU-DE-xxxxxxxxxxxxxxxxxxxx", - "user_name": "xxxxxxxxxx" - } - }, - "variable": { - "vpc_name": { - "type": "string", - "description": "vpc name", - "default": "rf_test_stack_example_vpc", - "sensitive": true, - "nullable": false - }, - "subnet_name": { - "type": "string", - "description": "subnet name", - "default": "rf_test_stack_example_subnet" - }, - "ecs_name": { - "type": "string", - "description": "ecs name", - "default": "rf_test_stack_example_ecs" - }, - "compute_keypair_name": { - "type": "string", - "description": "ecs compute key pair name", - "default": "rf_test_stack_example_keypair" - }, - "storage_volume_name": { - "type": "string", - "description": "storage volume name", - "default": "rf_test_stack_example_volume" - } - }, - "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" - } - }, - "opentelekomcloud_compute_keypair_v2": { - "rf_doc_keypair": { - "name": "${var.compute_keypair_name}" - } - }, - "opentelekomcloud_compute_instance_v2": { - "rf_doc_ecs": { - "name": "${var.ecs_name}", - "flavor_id": "s2.large.1", - "image_id": "c93ca99f-c5ee-451b-96e6-08c772edaec9", - "availability_zone": "eu-de-01", - "key_pair": "${opentelekomcloud_compute_keypair_v2.rf_doc_keypair.name}", - "security_groups": ["default"], - "network": { - "uuid": "${opentelekomcloud_vpc_subnet_v1.rf_doc_subnet.id}" + { + "terraform": { + "required_providers": { + "opentelekomcloud": { + "source": "opentelekomcloud/provider/opentelekomcloud", + "version": "1.35.13" } - } - }, - "opentelekomcloud_blockstorage_volume_v2": { - "rf_doc_volume": { - "name": "${var.storage_volume_name}", - "size": 4, - "availability_zone": "eu-de-01" - } - }, - "opentelekomcloud_compute_volume_attach_v2": { - "rf_doc_volume_attach": { - "instance_id": "${opentelekomcloud_compute_instance_v2.rf_doc_ecs.id}", - "volume_id": "${opentelekomcloud_blockstorage_volume_v2.rf_doc_volume.id}" - } - } - }, - "output": { - "ecs_address": { - "value": "${opentelekomcloud_compute_instance_v2.rf_doc_ecs.access_ip_v4}", - "description": "The ecs private address." - }, - "ecs_id": { - "value": "${opentelekomcloud_compute_instance_v2.rf_doc_ecs.id}", - "description": "The ecs resource id." - } - } - } + } + }, + "provider": { + "opentelekomcloud": { + "region": "eu-de", + "insecure": true, + "auth_url": "https://iam.eu-de.otc.t-systems.com/v3", + "tenant_name": "eu-de", + "domain_name": "OTC-EU-DE-xxxxxxxxxxxxxxxxxxxx", + "user_name": "xxxxxxxxxx" + } + }, + "variable": { + "vpc_name": { + "type": "string", + "description": "vpc name", + "default": "rf_test_stack_example_vpc", + "sensitive": true, + "nullable": false + }, + "subnet_name": { + "type": "string", + "description": "subnet name", + "default": "rf_test_stack_example_subnet" + }, + "ecs_name": { + "type": "string", + "description": "ecs name", + "default": "rf_test_stack_example_ecs" + }, + "compute_keypair_name": { + "type": "string", + "description": "ecs compute key pair name", + "default": "rf_test_stack_example_keypair" + }, + "storage_volume_name": { + "type": "string", + "description": "storage volume name", + "default": "rf_test_stack_example_volume" + } + }, + "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" + } + }, + "opentelekomcloud_compute_keypair_v2": { + "rf_doc_keypair": { + "name": "${var.compute_keypair_name}" + } + }, + "opentelekomcloud_compute_instance_v2": { + "rf_doc_ecs": { + "name": "${var.ecs_name}", + "flavor_id": "s2.large.1", + "image_id": "bf0f71bd-f08a-4cd0-9594-ca2caa00b9d7", + "availability_zone": "eu-de-01", + "key_pair": "${opentelekomcloud_compute_keypair_v2.rf_doc_keypair.name}", + "security_groups": ["default"], + "network": { + "uuid": "${opentelekomcloud_vpc_subnet_v1.rf_doc_subnet.id}" + } + } + }, + "opentelekomcloud_blockstorage_volume_v2": { + "rf_doc_volume": { + "name": "${var.storage_volume_name}", + "size": 4, + "availability_zone": "eu-de-01" + } + }, + "opentelekomcloud_compute_volume_attach_v2": { + "rf_doc_volume_attach": { + "instance_id": "${opentelekomcloud_compute_instance_v2.rf_doc_ecs.id}", + "volume_id": "${opentelekomcloud_blockstorage_volume_v2.rf_doc_volume.id}" + } + } + }, + "output": { + "ecs_address": { + "value": "${opentelekomcloud_compute_instance_v2.rf_doc_ecs.access_ip_v4}", + "description": "The ecs private address." + }, + "ecs_id": { + "value": "${opentelekomcloud_compute_instance_v2.rf_doc_ecs.id}", + "description": "The ecs resource id." + } + } + } -.. caution:: + .. caution:: - The sample template contains charged resources. Check whether resources need to be enabled before using the template. + The sample template contains charged resources. Check whether resources need to be enabled before using the template. -The template consists of eight parts: + The template consists of eight parts: -- **opentelekomcloud_vpc_v1** in **resource** indicates VPC information. -- **opentelekomcloud_vpc_subnet_v1** in **resource** indicates information about a subnet defined in the VPC. -- **opentelekomcloud_compute_keypair_v2** in **resource** indicates information about compute keypair defined in the template. -- **opentelekomcloud_compute_instance_v2** in **resource** indicates information about an ECS defined in the template. -- **opentelekomcloud_blockstorage_volume_v2** in **resource** indicates information about an EVS storage volume defined in the template. -- **opentelekomcloud_compute_volume_attach_v2** in **resource** indicates the binding relationship between EVS storage volumes and ECS. -- **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. + - **opentelekomcloud_vpc_v1** in **resource** indicates VPC information. + - **opentelekomcloud_vpc_subnet_v1** in **resource** indicates information about a subnet defined in the VPC. + - **opentelekomcloud_compute_keypair_v2** in **resource** indicates information about compute keypair defined in the template. + - **opentelekomcloud_compute_instance_v2** in **resource** indicates information about an ECS defined in the template. + - **opentelekomcloud_blockstorage_volume_v2** in **resource** indicates information about an EVS storage volume defined in the template. + - **opentelekomcloud_compute_volume_attach_v2** in **resource** indicates the binding relationship between EVS storage volume and ECS. + - **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. -For detailed usage of other resources, please refer to `OpenTelekom Cloud Provider `__. + For detailed usage of other resources, please refer to `OpenTelekom Cloud Provider `__. -6. Configure parameters +5. .. _en-us_topic_0000001955571466__li43272049164914: - 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 `. + Configure parameters -.. caution:: + On the parameter configuration page, you can modify the stack name and description and configure the template parameters. - 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. + .. caution:: - A stack description can contain a maximum of 255 characters. + 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. -.. _en-us_topic_0000001955571466__fig179172325107: + A stack description can contain a maximum of 255 characters. -.. figure:: /_static/images/en-us_image_0000002120705156.png - :alt: **Figure 8** Configuring parameters - **Figure 8** Configuring parameters + .. figure:: /_static/images/en-us_image_0000002120705156.png + :alt: **Figure 6** 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. + **Figure 6** Configuring parameters -When certain variables in the template have the field 'sensitive' set to true, KMS encryption can be selected, as shown in :ref:`Figure Encrypt requirements `. After encryption is enabled, RFS uses KMS to encrypt parameters whose sensitive is set to true in the template, to ensure that data is transmitted and stored in ciphertext. + Parameters whose **nullable** field is set to **false** in template are marked with a red asterisk (``*``) as mandatory. Valid values must be set to these parameters. -.. _en-us_topic_0000001955571466__fig15774183016141: + If there are variables whose **sensitive** field is set to **true** in template, KMS encryption can be selected, as shown in :ref:`Figure Encrypt requirements `. If encryption is enabled, RFS will use KMS to encrypt those senstitive parameters to ensure their secure transmission and storage. -.. figure:: /_static/images/en-us_image_0000002156056533.png - :alt: **Figure 9** Encrypt requirements + .. _en-us_topic_0000001955571466__fig15774183016141: - **Figure 9** Encrypt requirements + .. figure:: /_static/images/en-us_image_0000002156056533.png + :alt: **Figure 7** Encrypt requirements -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**. + **Figure 7** Encrypt requirements -.. _en-us_topic_0000001955571466____d0e644: + 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**. -.. figure:: /_static/images/en-us_image_0000001991770641.png - :alt: **Figure 10** Text box with an invalid value + .. _en-us_topic_0000001955571466____d0e644: - **Figure 10** Text box with an invalid value + .. figure:: /_static/images/en-us_image_0000001991770641.png + :alt: **Figure 8** 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. + **Figure 8** Text box with an invalid value -Then click **Next**. The **Configure Stack** page is displayed. + 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. -7. .. _en-us_topic_0000001955571466__li459mcpsimp: + Then click **Next** and the **Configure Stack** page is displayed. + +6. .. _en-us_topic_0000001955571466__li459mcpsimp: Configure the stack. - Optional parameters , as shown in :ref:`Figure 11 `: + + .. figure:: /_static/images/en-us_image_0000002158816238.png + :alt: **Figure 9** Configuring the stack + + **Figure 9** Configuring the stack **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 `. @@ -272,145 +269,145 @@ Then click **Next**. The **Configure Stack** page is displayed. **Auto-Rollback**: If auto-rollback is enabled, the stack automatically rolls back to the previous successful resource status when an operation fails. - After the stack is created, you can modify the stack configurations on its details page. + After the stack is created, you can modify the stack configurations on its details page, see \ :ref:`Modifying the basic parameters of a Stack `. Click **Next** to go to the **Confirm Configurations** page. - .. _en-us_topic_0000001955571466____d0e688: - .. figure:: /_static/images/en-us_image_0000001991890825.png - :alt: **Figure 11** Configuring the stack + .. figure:: /_static/images/en-us_image_0000002158975806.png + :alt: **Figure 10** Confirm Configurations - **Figure 11** Configuring the stack + **Figure 10** Confirm Configurations -8. Check the configuration and make sure everything is set correctly. +7. .. _en-us_topic_0000001955571466__li7775101171312: + + 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**. - If you click **Directly Deploy Stack**, a :ref:`confirmation dialog box ` will be displayed. - .. _en-us_topic_0000001955571466__fig38972020557: + .. _en-us_topic_0000001955571466__fig38972020557: - .. figure:: /_static/images/en-us_image_0000002156063229.png - :alt: **Figure 12** Directly deploy stack + .. figure:: /_static/images/en-us_image_0000002156063229.png + :alt: **Figure 11** Directly deploy stack - **Figure 12** Directly deploy stack + **Figure 11** Directly deploy stack - 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 `. + a. Click **Yes**. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure 12 `. And it will redirect to the stack events page, as shown in :ref:`Figure Stack Events `. - .. _en-us_topic_0000001955571466____d0e756: + .. _en-us_topic_0000001955571466____d0e756: - **Figure 13** Deployment in progress + **Figure 12** Deployment in progress - |image2| + |image3| - .. _en-us_topic_0000001955571466__fig173401257402: + .. _en-us_topic_0000001955571466__fig173401257402: - .. figure:: /_static/images/en-us_image_0000002120746402.png - :alt: **Figure 14** Stack Events + .. figure:: /_static/images/en-us_image_0000002120746402.png + :alt: **Figure 13** Stack Events - **Figure 14** Stack Events + **Figure 13** Stack Events - b. Then, if everything goes well, the status changes to **Deployment Complete**, as shown in :ref:`Figure Deployment complete `. + b. If everything goes well, the status will change to **Deployment Complete**, as shown in :ref:`Figure Deployment complete `. - .. _en-us_topic_0000001955571466__fig73237820229: + .. _en-us_topic_0000001955571466__fig73237820229: - **Figure 15** Deployment complete + **Figure 14** Deployment complete - |image3| + |image4| - 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 16** Create Execution Plan dialog box + .. figure:: /_static/images/en-us_image_0000002158816218.png + :alt: **Figure 15** Create Execution Plan dialog box - **Figure 16** Create Execution Plan dialog box + **Figure 15** Create Execution Plan dialog box - .. caution:: + .. caution:: - The execution plan name must start with a letter and can contain a maximum of 128 characters,eincluding only letters, digits, underscores(_), and hyphens (-). + The execution plan name must start with a letter and can contain a maximum of 128 characters, including only letters, digits, underscores (_), and hyphens (-). - a. Click **OK**. The **Execution Plans** tab page is displayed. - b. Wait until the execution plan is created and refresh the page. The execution plan status changes to **Available**, as shown in :ref:`Figure Execution Plan Available `. + a. Click **OK**. The **Execution Plans** tab page is displayed. - .. _en-us_topic_0000001955571466__fig432318842212: + b. Wait until the execution plan is created and refresh the page. The execution plan status will change to **Available**, as shown in :ref:`Figure Execution Plan Available `. - **Figure 17** Execution Plan Available + .. _en-us_topic_0000001955571466__fig432318842212: - |image4| + **Figure 16** Execution Plan Available - c. Return to the stack list page. The stack status is **Creation Complete**, as shown in :ref:`Figure 18 `. + |image5| - .. _en-us_topic_0000001955571466____d0e813: + c. Return to the stack list page. A stack is generated and its stack status is **Creation Complete**, as shown in :ref:`Figure 17 `. - **Figure 18** Stack list + .. _en-us_topic_0000001955571466____d0e813: - |image5| + **Figure 17** Stack list - .. caution:: + |image6| - **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. + .. caution:: - d. Click **Deploy** in the **Operation** column of the execution plan to deploy it, as shown in :ref:`Figure 19 `. + **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. - .. _en-us_topic_0000001955571466____d0e835: + d. Go back to the **Execution Plans** tab page of the stack and click **Deploy** in the **Operation** column of the execution plan to deploy it, as shown in :ref:`Figure 18 `. - .. figure:: /_static/images/en-us_image_0000002120743398.png - :alt: **Figure 19** Execution plan dialog box + .. _en-us_topic_0000001955571466____d0e835: - **Figure 19** Execution plan dialog box + .. figure:: /_static/images/en-us_image_0000002120743398.png + :alt: **Figure 18** 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 `. + **Figure 18** Execution plan dialog box - .. _en-us_topic_0000001955571466__fig65231214111516: + #. 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. The stack status is **Deployment In Progress**, as shown in :ref:`Figure Deployment in progress `. - .. figure:: /_static/images/en-us_image_0000002156141613.png - :alt: **Figure 20** Deployment in progress + .. _en-us_topic_0000001955571466__fig65231214111516: - **Figure 20** Deployment in progress + .. figure:: /_static/images/en-us_image_0000002156141613.png + :alt: **Figure 19** Deployment in progress - f. Then, the stack status changes to **Deployment Complete**, as shown in :ref:`Figure 21 `. + **Figure 19** Deployment in progress - .. _en-us_topic_0000001955571466____d0e866: + #. Then, the stack status changes to **Deployment Complete**, as shown in :ref:`Figure 20 `. - **Figure 21** Deployment complete + .. _en-us_topic_0000001955571466____d0e866: - |image6| + **Figure 20** Deployment complete - g. On the **Execution Plans** tab page of the stack details page, the execution plan status is **Applied**, as shown in :ref:`Figure 22 `. + |image7| - .. _en-us_topic_0000001955571466____d0e882: + e. On the **Execution Plans** tab page of the stack details page, the execution plan status is **Applied**, as shown in :ref:`Figure 21 `. - .. figure:: /_static/images/en-us_image_0000002120901494.png - :alt: **Figure 22** Applied + .. _en-us_topic_0000001955571466____d0e882: - **Figure 22** Applied + .. figure:: /_static/images/en-us_image_0000002120901494.png + :alt: **Figure 21** Applied -Click the **Events** tab. The event list shows that resources of the stack are deployed, as shown in :ref:`Figure 23 `. + **Figure 21** Applied -.. _en-us_topic_0000001955571466____d0e895: +8. Click the **Resources** tab. The event list shows that resources of the stack are deployed, as shown in :ref:`Figure 22 `. -**Figure 23** Resources deployed + .. _en-us_topic_0000001955571466____d0e895: -|image7| + **Figure 22** Resources deployed -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). + |image8| -.. _en-us_topic_0000001955571466__fig1268133163913: + 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). -.. figure:: /_static/images/en-us_image_0000002120901474.png - :alt: **Figure 24** ECS + .. _en-us_topic_0000001955571466__fig1268133163913: - **Figure 24** ECS + .. figure:: /_static/images/en-us_image_0000002120901474.png + :alt: **Figure 23** ECS -Resources of the stack are deployed. + **Figure 23** ECS -.. |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 +.. |image1| image:: /_static/images/en-us_image_0000002194091645.png +.. |image2| image:: /_static/images/en-us_image_0000002158650788.png +.. |image3| image:: /_static/images/en-us_image_0000002120901486.png +.. |image4| image:: /_static/images/en-us_image_0000002120743394.png +.. |image5| image:: /_static/images/en-us_image_0000002156064705.png +.. |image6| image:: /_static/images/en-us_image_0000002158975566.png +.. |image7| image:: /_static/images/en-us_image_0000002156063237.png +.. |image8| 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 5ba92bd..28840c7 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 @@ -7,7 +7,9 @@ Creating an Execution Plan #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002160009821.png @@ -15,7 +17,7 @@ Creating an Execution Plan **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Stacks. +#. In the left navigation pane, choose **Stacks**. .. figure:: /_static/images/en-us_image_0000002159891457.png @@ -25,8 +27,8 @@ Creating an Execution Plan #. To create an execution plan for an existing stack, you can use 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. + - 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 @@ -34,7 +36,7 @@ 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. + The subsequent steps are same as those in :ref:`Updating the Stack Template or its Parameters `, except 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 `. @@ -42,6 +44,7 @@ Creating an Execution Plan **Figure 4** Execution plan list - |image1| + |image2| -.. |image1| image:: /_static/images/en-us_image_0000002124611738.png +.. |image1| image:: /_static/images/en-us_image_0000002158976894.png +.. |image2| 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 5063ac7..852339a 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 @@ -7,7 +7,9 @@ Deleting an Execution Plan #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002159891445.png @@ -15,7 +17,7 @@ Deleting an Execution Plan **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Stacks. +#. In the left navigation pane, choose **Stacks**. .. figure:: /_static/images/en-us_image_0000002124611726.png @@ -23,14 +25,14 @@ Deleting an Execution Plan **Figure 2** RFS Stacks -#. Click the name of the desired stack to delete its execution plan. +#. Click the name of the desired stack to navigate to the **Execution Plans** tab. **Figure 3** Execution plan list - |image1| + |image2| -#. 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 `. +#. If an execution plan is no longer used, click **Delete** in the **Operation** column. In the Delete Execution Plan dialog window, click \ **Yes**\ to confirm the deletion, as shown in :ref:`Figure Deleting an execution plan `. .. _en-us_topic_0000002156780069____d0e1163: @@ -43,4 +45,5 @@ Deleting an Execution Plan Execution plans cannot be restored once deleted. Exercise caution when performing this operation. -.. |image1| image:: /_static/images/en-us_image_0000002160009817.png +.. |image1| image:: /_static/images/en-us_image_0000002194183665.png +.. |image2| 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 a1c971c..c7fd1ef 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 @@ -7,7 +7,9 @@ Deploying an Execution Plan #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002159891453.png @@ -15,7 +17,7 @@ Deploying an Execution Plan **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Stacks. +#. In the left navigation pane, choose **Stacks**. .. figure:: /_static/images/en-us_image_0000002124611734.png @@ -23,19 +25,21 @@ Deploying an Execution Plan **Figure 2** RFS Stacks -#. Click the name of the desired stack to deploy its execution plan. +#. Click the name of the desired stack and navigate to the **Execution Plans** tab. **Figure 3** Execution plan list - |image1| + |image2| -#. 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. +#. Locate the row that contains the desired execution plan and click **Deploy** in the **Operation** column. Alternatively, you can click the name of the desired execution plan to navigate to its details page and then click **Deploy** in the **Basic Information** section. After an execution plan is executed, its status changes from Available to Applied and the Deploy options will no longer available for the plan. .. 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. + - Execution plan can only be deployed once. However, if it fails, it is allowed to retry the deployment on the Stack List page by clicking on the \ **Continue Deployment**\ link under the \ **Operation**\ column. + - If there are multiple execution plans in the available state, deploying one of them will cause the other execution plans to expire, even though they remain in the available state. -.. |image1| image:: /_static/images/en-us_image_0000002124769898.png +.. |image1| image:: /_static/images/en-us_image_0000002194218013.png +.. |image2| image:: /_static/images/en-us_image_0000002124769898.png diff --git a/umn/source/managing_stacks/deleting_a_stack.rst b/umn/source/managing_stacks/deleting_a_stack.rst index 632ba52..03ee8ce 100644 --- a/umn/source/managing_stacks/deleting_a_stack.rst +++ b/umn/source/managing_stacks/deleting_a_stack.rst @@ -9,7 +9,9 @@ If a stack is no longer needed, you can perform the following steps to delete it #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002157142509.png @@ -17,7 +19,7 @@ If a stack is no longer needed, you can perform the following steps to delete it **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Stacks. +#. In the left navigation pane, choose **Stacks**. .. figure:: /_static/images/en-us_image_0000002121742716.png @@ -36,7 +38,7 @@ If a stack is no longer needed, you can perform the following steps to delete it **Figure 3** Deletion failed - a. Click the name of the desired stack to view its details and check the Deletion Protection value in the Basic Information tab. + a. Click the name of the desired stack to view its details and check the **Deletion Protection** value in the **Basic Information** tab. .. figure:: /_static/images/en-us_image_0000002156909017.png @@ -44,7 +46,7 @@ If a stack is no longer needed, you can perform the following steps to delete it **Figure 4** Deletion protection - b. If it is enabled, click Edit in the top right corner of the Basic Information tab, disable the deletion protection and click Save in the top right corner of the Basic Information tab. + b. If it is enabled, click **Edit** in the top right corner of the **Basic Information** tab, disable the deletion protection and click **Save** in the top right corner of the **Basic Information** tab. .. figure:: /_static/images/en-us_image_0000002121663600.png @@ -52,26 +54,27 @@ If a stack is no longer needed, you can perform the following steps to delete it **Figure 5** Edit basic information -5. On the stack list page, locate the stack to be deleted and click Delete in the Operation column. +5. On the stack list page, locate the stack to be deleted and click **Delete** in the **Operation** column. - Alternatively, go to the stack details page by clicking the name of the stack and click Delete in the upper right corner + Alternatively, go to the stack details page by clicking the name of the stack and click **Delete** in the upper right corner -6. In the dialog box displayed, as shown in \ :ref:`Figure Dialog box for deleting a stack `. - - .. _en-us_topic_0000001991890809____d0e1485: - - **Figure 6** Dialog box for deleting a stack - - |image1| +6. In the dialog box displayed, as shown in \ :ref:`Figure Dialog box for deleting a stack `, a. select the desired deletion option: If you choose to delete resources, RFS will destroy all the resources in the stack. If you choose to retain resources, we will only delete the stack without destroying the resources. Therefore, these resources will no longer be managed by RFS. - b. and confirm the deletion by entering Delete in the text box and click OK. + b. and confirm the deletion by entering **Delete** in the text box and click **OK**. + + .. _en-us_topic_0000001991890809____d0e1485: + + **Figure 6** Dialog box for deleting a stack + + |image2| .. warning:: Stacks cannot be restored after being deleted. Exercise caution when performing this operation. -.. |image1| image:: /_static/images/en-us_image_0000002156988229.png +.. |image1| image:: /_static/images/en-us_image_0000002158817102.png +.. |image2| image:: /_static/images/en-us_image_0000002194220965.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 8df2fb2..ea4555a 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 @@ -9,6 +9,8 @@ Modifying the basic parameters of a Stack #. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. + The \ **Dashboard**\ page is displayed. + .. figure:: /_static/images/en-us_image_0000002160009777.png :alt: **Figure 1** RFS Dashboard @@ -23,15 +25,17 @@ Modifying the basic parameters of a Stack |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**. +#. 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. + 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: + .. _en-us_topic_0000002154604281__fig14388172452918: -.. figure:: /_static/images/en-us_image_0000002155949165.png - :alt: **Figure 3** Editing Basic Information + .. figure:: /_static/images/en-us_image_0000002158978150.png + :alt: **Figure 3** Editing Basic Information - **Figure 3** Editing Basic Information + **Figure 3** Editing Basic Information + +#. After editing, click **Save** in the top-right corner. .. |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 e1f4036..060fdf8 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 @@ -11,7 +11,9 @@ Updating the Stack Template or its Parameters #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002124769858.png @@ -25,12 +27,12 @@ Updating the Stack Template or its Parameters **Figure 2** RFS Stacks - |image1| + |image2| #. You can update the stack template or its parameters 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. + - 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. @@ -42,28 +44,31 @@ Updating the Stack Template or its Parameters You can select **Current Template** or **Replace Current Template** (use a new template) to update the stack. - Case 1: Using the current template + a. 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 `\ . + - 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: + .. _en-us_topic_0000001991770625____d0e1035: - .. figure:: /_static/images/en-us_image_0000002124769882.png - :alt: **Figure 4** Configuring parameters + .. figure:: /_static/images/en-us_image_0000002124769882.png + :alt: **Figure 4** Configuring parameters - **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 `\ . + - Click **Next** to go to the **Confirm Configurations** page, as shown in :ref:`Figure 5 `. - .. _en-us_topic_0000001991770625____d0e1051: + .. _en-us_topic_0000001991770625____d0e1051: - .. figure:: /_static/images/en-us_image_0000002160009809.png - :alt: **Figure 5** Confirming configurations + .. figure:: /_static/images/en-us_image_0000002160009809.png + :alt: **Figure 5** Confirming configurations - **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 `\ . + - Click **Directly Deploy Stack** or **Create Execution Plan**. For further details, please follow the procedure in \ :ref:`Creating a Stack `\ . - Case 2: Replacing the current template (see :ref:`Creating a Stack `) + b. Replacing the current template -.. |image1| image:: /_static/images/en-us_image_0000002159891413.png + For further details about the configuration steps, please follow the procedure in \ :ref:`Creating a Stack `\ . + +.. |image1| image:: /_static/images/en-us_image_0000002158817118.png +.. |image2| image:: /_static/images/en-us_image_0000002159891413.png diff --git a/umn/source/managing_stacks/viewing_stack_details.rst b/umn/source/managing_stacks/viewing_stack_details.rst index 015092e..7f6d839 100644 --- a/umn/source/managing_stacks/viewing_stack_details.rst +++ b/umn/source/managing_stacks/viewing_stack_details.rst @@ -9,7 +9,9 @@ To navigate the details page of a stack, perform the following steps: #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002121673112.png @@ -17,7 +19,7 @@ To navigate the details page of a stack, perform the following steps: **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Stacks. +#. In the left navigation pane, choose **Stacks**. .. figure:: /_static/images/en-us_image_0000002156993381.png @@ -27,15 +29,16 @@ To navigate the details page of a stack, perform the following steps: #. Click the name of the desired stack to view its details and select the tab needed. -There are six function modules on the stack details page: +Function modules on the stack details page +------------------------------------------ -#. **Basic Information**: displays basic information about the stack, such as Stack Name, Stack ID, Status, Auto-Rollback and Deletion Protection settings, etc, as shown in :ref:`Figure 3 `. +#. **Basic Information**: displays basic information about the stack, such as \ **Stack Name**\ , \ **Stack ID**\ , \ **Status**\ , \ **Auto-Rollback**\ and \ **Deletion Protection**\ settings, etc, as shown in :ref:`Figure 3 `. .. _en-us_topic_0000001991770629____d0e1560: **Figure 3** Basic information - |image1| + |image2| #. **Resources**: displays the elements of the stack, such as applications, cloud services or resources generated during deployment, as shown in :ref:`Figure 4 `. @@ -43,7 +46,7 @@ There are six function modules on the stack details page: **Figure 4** Resources - |image2| + |image3| #. .. _en-us_topic_0000001991770629__li167036103014: @@ -53,7 +56,7 @@ There are six function modules on the stack details page: **Figure 5** Outputs - |image3| + |image4| #. **Events**: displays log information about stack events (for example stack creation, or deployment related events), so that you can monitor the stack operation progress. The events are sorted in chronological order with the latest event being displayed at the top. @@ -65,7 +68,7 @@ There are six function modules on the stack details page: **Figure 6** Events - |image4| + |image5| .. _en-us_topic_0000001991770629__fig1958919547213: @@ -74,13 +77,13 @@ There are six function modules on the stack details page: **Figure 7** Filter Events -#. **Template**: displays the template content used for creating the stack, as shown in :ref:`Figure 8 `. +#. **Template**: displays the latest template content, what has been deployed with the stack, as shown in :ref:`Figure 8 `. .. _en-us_topic_0000001991770629____d0e1606: **Figure 8** Template - |image5| + |image6| #. **Execution Plans**: displays the different execution plans associated with the stack, as shown in :ref:`Figure 9 `. To see how to deploy or delete an execution plan, check :ref:`Creating, Deploying and Deleting an Execution Plan `. @@ -88,7 +91,9 @@ There are six function modules on the stack details page: **Figure 9** Execution plans - |image6|\ You can filter execution plans by execution plans name in the top-right corner, as shown in :ref:`Figure Filter Execution plans `. + |image7| + + You can filter execution plans by execution plans name in the top-right corner, as shown in :ref:`Figure Filter Execution plans `. .. _en-us_topic_0000001991770629__fig17920107173512: @@ -97,33 +102,37 @@ There are six function modules on the stack details page: **Figure 10** Filter Execution plans - :ref:`Table 1 ` describes execution plan statuses. + :ref:`Table 1 ` describes the possible execution plan statuses. .. _en-us_topic_0000001991770629____d0e458: .. table:: **Table 1** 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 applied. - ==================== ================================================= + +----------------------+-------------------------------------------------------------+ + | Status | Description | + +======================+=============================================================+ + | Creation In Progress | Execution plan creation is in progress. | + +----------------------+-------------------------------------------------------------+ + | Creation Failed | Execution plan creation failed. | + +----------------------+-------------------------------------------------------------+ + | Available | The execution plan is created and ready for the deployment. | + +----------------------+-------------------------------------------------------------+ + | Applied | The execution plan has been applied. | + +----------------------+-------------------------------------------------------------+ -To check the details of an execution plan, you can click the execution plan name to open its details, as shown in :ref:`Figure 11 `. + To check the details of an execution plan, you can click the execution plan name to open its details, as shown in :ref:`Figure 11 `. -.. _en-us_topic_0000001991770629____d0e1639: + .. _en-us_topic_0000001991770629____d0e1639: -**Figure 11** Execution plan details + **Figure 11** Execution plan details -|image7| + |image8| -.. |image1| image:: /_static/images/en-us_image_0000002120707020.png -.. |image2| image:: /_static/images/en-us_image_0000002155947169.png -.. |image3| image:: /_static/images/en-us_image_0000002120549060.png -.. |image4| image:: /_static/images/en-us_image_0000002155947473.png -.. |image5| image:: /_static/images/en-us_image_0000002156029369.png -.. |image6| image:: /_static/images/en-us_image_0000002155948217.png -.. |image7| image:: /_static/images/en-us_image_0000002121525200.png +.. |image1| image:: /_static/images/en-us_image_0000002158817114.png +.. |image2| image:: /_static/images/en-us_image_0000002120707020.png +.. |image3| image:: /_static/images/en-us_image_0000002155947169.png +.. |image4| image:: /_static/images/en-us_image_0000002120549060.png +.. |image5| image:: /_static/images/en-us_image_0000002155947473.png +.. |image6| image:: /_static/images/en-us_image_0000002156029369.png +.. |image7| image:: /_static/images/en-us_image_0000002155948217.png +.. |image8| image:: /_static/images/en-us_image_0000002121525200.png diff --git a/umn/source/managing_stacks/viewing_stacks.rst b/umn/source/managing_stacks/viewing_stacks.rst index 4daf463..57e0493 100644 --- a/umn/source/managing_stacks/viewing_stacks.rst +++ b/umn/source/managing_stacks/viewing_stacks.rst @@ -7,7 +7,9 @@ Viewing Stacks #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The **Dashboard** page is displayed. .. figure:: /_static/images/en-us_image_0000002124611690.png @@ -21,9 +23,9 @@ Viewing Stacks **Figure 2** RFS Stacks - |image1| + |image2| -:ref:`Table 1 ` describes stack statuses.. +:ref:`Table 1 ` describes the possible stack statuses. .. _en-us_topic_0000002154685877____d0e380: @@ -43,4 +45,5 @@ Viewing Stacks Rollback Complete The stack has been rolled back. ====================== ============================================ -.. |image1| image:: /_static/images/en-us_image_0000002159891417.png +.. |image1| image:: /_static/images/en-us_image_0000002194183289.png +.. |image2| image:: /_static/images/en-us_image_0000002159891417.png diff --git a/umn/source/managing_templates/creating_a_stack_from_a_template.rst b/umn/source/managing_templates/creating_a_stack_from_a_template.rst index af08453..b129e59 100644 --- a/umn/source/managing_templates/creating_a_stack_from_a_template.rst +++ b/umn/source/managing_templates/creating_a_stack_from_a_template.rst @@ -9,7 +9,9 @@ RFS supports linkage between the stack and the template in console. Users can di #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002157215021.png @@ -17,32 +19,27 @@ RFS supports linkage between the stack and the template in console. Users can di **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Templates -> Private Templates. You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. +#. In the left navigation pane, choose \ **Templates**\ -> **Private Templates**\ . You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. - .. _en-us_topic_0000002046584002__fig89226538129: - **Figure 2** RFS Private Templates + .. figure:: /_static/images/en-us_image_0000002158983306.png + :alt: **Figure 2** RFS Private Templates - |image1| + **Figure 2** RFS Private Templates -#. Click the More->CreateStack in the Operation column of the desired template using to create stack. - - |image2| - - Next, the console will then automatically jump to the Create Stack page, where the latest version of the current template is preselected by default as shown in :ref:`Figure 3 `. +#. Click the **CreateStack** in the **Operation** column of the desired template using to initiate the creation of a new stack based on the latest template version. You will be automatically redirected to the Create Stack page, where the latest version of the current template is preselected by default as shown in :ref:`Figure 3 `. .. _en-us_topic_0000002046584002__fig14609152010154: **Figure 3** Selecting Template - |image3| + |image2| - Then for more details, go to :ref:`creating a stack `. + For more information about the entire stack creation procedure, check \ :ref:`Creating a Stack `\ . -.. caution:: + .. note:: - Creating a stack will by default use the latest template version, if you want to uses a version which is not the latest, please go to \ :ref:`View the Template Details `\ . + Creating a stack from a template will by default use the latest template version. If you want to use other versions, please go to \ :ref:`View the Template Details `\ . -.. |image1| image:: /_static/images/en-us_image_0000002121934982.png -.. |image2| image:: /_static/images/en-us_image_0000002121776830.png -.. |image3| image:: /_static/images/en-us_image_0000002157215037.png +.. |image1| image:: /_static/images/en-us_image_0000002158979842.png +.. |image2| image:: /_static/images/en-us_image_0000002157215037.png diff --git a/umn/source/managing_templates/creating_a_template.rst b/umn/source/managing_templates/creating_a_template.rst index 177c4fc..06408ab 100644 --- a/umn/source/managing_templates/creating_a_template.rst +++ b/umn/source/managing_templates/creating_a_template.rst @@ -7,7 +7,9 @@ Creating a Template #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002121900840.png @@ -15,71 +17,70 @@ Creating a Template **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Templates -> Private Templates. +#. In the left navigation pane, choose \ **Templates**\ -> **Private Templates**\ . - **Figure 2** RFS Private Templates + .. figure:: /_static/images/en-us_image_0000002158823486.png + :alt: **Figure 2** RFS Private Templates - |image1| + **Figure 2** RFS Private Templates -#. On the Private Templates page, click Create Template in the upper right corner, as shown in :ref:`Figure 3 `. - -.. _en-us_topic_0000002046740822____d0e536: - -**Figure 3** Creating a template - -|image2| - -5. On the Create Template page, select the Source: - - a. URL: Enter a URL of an OBS template. When the OBS URL is correct, the corresponding template content from OBS will be displayed in the content section below. (The URL must contain at least the deployment code file, and the file size cannot exceed 1 MB.) +#. On the \ **Private Templates**\ page, click \ **Create Template**\ in the upper right corner. - .. figure:: /_static/images/en-us_image_0000002121900316.png - :alt: **Figure 4** Template URL + **Figure 3** Creating a template - **Figure 4** Template URL + |image2| - b. Upload Template: Upload a local template file. After your upload, the corresponding template content will be displayed in the content section below. (The files in the format of .tf, .tf.json, and .zip are supported. At least the deployment code file needs to be uploaded. The size of a file cannot exceed 50 KB. The size of a decompressed .zip file cannot exceed 1 MB.) +5. On the **Create Template** page, select the **Source**: - |image3| - - c. Input Template: Input templatge. You can create, rename, and delete files and folders here, which helps in organizing the template file structure better, and you can also export the templates. + a. **URL**\ : Enter a URL of an OBS template. When the OBS URL is correct, the corresponding template content from OBS will be displayed in the content section below. (The URL must contain at least the deployment code file or zip, and the file size cannot exceed 1 MB.) - .. figure:: /_static/images/en-us_image_0000002157144325.png - :alt: **Figure 5** Input template + .. figure:: /_static/images/en-us_image_0000002158820394.png + :alt: **Figure 4** Template URL - **Figure 5** Input template + **Figure 4** Template URL - Next, you can modify the template name, description and version description, as shown in :ref:`Figure 6 `. + b. **Upload Template**: Upload a local template file or zip. After your upload, the corresponding template content will be displayed in the content section below. (The files in the format of .tf, .tf.json, and .zip are supported. At least the deployment code file needs to be uploaded. The size of a file cannot exceed 50 KB. The size of a decompressed .zip file cannot exceed 1 MB.) + + + .. figure:: /_static/images/en-us_image_0000002194187417.png + :alt: **Figure 5** Upload template + + **Figure 5** Upload template + + c. **Input Template**: Input template. You can create, rename, and delete files and folders here, which helps in organizing the template file structure better, and you can also export the templates. + + + .. figure:: /_static/images/en-us_image_0000002157144325.png + :alt: **Figure 6** Input template + + **Figure 6** Input template + +6. Next, you can modify the template name, description and version description, as shown in :ref:`Figure 7 `. .. _en-us_topic_0000002046740822__fig197685819172: - **Figure 6** Configuring parameters + **Figure 7** Configuring parameters - |image4| + |image3| - .. caution:: + .. note:: - The template 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. + - The template 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. + - The template name cannot be changed after the template is created. + - A template description can contain a maximum of 1024 characters. + - A template version description can contain a maximum of 1024 characters. - The template name cannot be changed after the template is created. +7. Click **Create Now** to create a template. - A template description can contain a maximum of 1024 characters. - A template version description can contain a maximum of 1024 characters. + .. figure:: /_static/images/en-us_image_0000002158823498.png + :alt: **Figure 8** Template list -6. Click **Create Now** to create a template, as shown in :ref:`Figure 7 `. + **Figure 8** Template list - .. _en-us_topic_0000002046740822__fig441630162416: - - **Figure 7** Template list - -|image5| - -.. |image1| image:: /_static/images/en-us_image_0000002157055181.png +.. |image1| image:: /_static/images/en-us_image_0000002194220973.png .. |image2| image:: /_static/images/en-us_image_0000002157056257.png -.. |image3| image:: /_static/images/en-us_image_0000002121903204.png -.. |image4| image:: /_static/images/en-us_image_0000002121739696.png -.. |image5| image:: /_static/images/en-us_image_0000002121903472.png +.. |image3| image:: /_static/images/en-us_image_0000002121739696.png diff --git a/umn/source/managing_templates/deleting_a_template.rst b/umn/source/managing_templates/deleting_a_template.rst index bb54100..dd29d95 100644 --- a/umn/source/managing_templates/deleting_a_template.rst +++ b/umn/source/managing_templates/deleting_a_template.rst @@ -5,13 +5,13 @@ Deleting a Template =================== -If the template is no longer in use, RFS supports deleting the template. You can choose to delete the templates one by one or in batches. - -**Delete a template**: +If a template is no longer in use, RFS supports deleting it. You can choose to delete the templates one by one or in batches. #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002157215029.png @@ -19,65 +19,44 @@ If the template is no longer in use, RFS supports deleting the template. You can **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Templates -> Private Templates. You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. +#. In the left navigation pane, choose \ **Templates**\ -> **Private Templates**\ . You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. - .. _en-us_topic_0000002082821521__fig89226538129: - **Figure 2** RFS Private Templates + .. figure:: /_static/images/en-us_image_0000002158823542.png + :alt: **Figure 2** RFS Private Templates - |image1| + **Figure 2** RFS Private Templates -#. Click the More->Export in the Operation column of the desired template to delete it. +#. You can delete a single template or multiple templates in batches: + + a. To delete a single template, click \ **More**\ -> **Delete**\ in the \ **Operation**\ column. + + + .. figure:: /_static/images/en-us_image_0000002158983474.png + :alt: **Figure 3** RFS Private Templates + + **Figure 3** RFS Private Templates + + b. To delete multiple templates in batches, select the desired templates and click the \ **Delete**\ in the upper left corner above the template table. + + + .. figure:: /_static/images/en-us_image_0000002194191125.png + :alt: **Figure 4** RFS Private Templates + + **Figure 4** RFS Private Templates + +#. In the dialog box displayed, click **Yes** in the text box as shown in :ref:`Figure Dialog box for deleting a template `. The Template(s) and all versions will be deleted. + + .. _en-us_topic_0000002082821521____d0e1006: + + **Figure 5** Dialog box for deleting a template |image2| -#. In the dialog box displayed, click **Yes** in the text box as shown in :ref:`Figure Dialog box for deleting a template `. Template and all versions will be deleted. + .. caution:: -.. _en-us_topic_0000002082821521____d0e1006: + - Deleting a template will delete all versions in the template and the deleted versions cannot be restored. Exercise caution when performing this operation. + - If you just want to delete a template version, please go to \ :ref:`View the Template Details `\ . -**Figure 3** Dialog box for deleting a template - -|image3| - -.. caution:: - - If you just want to delete a template version, please go to \ :ref:`View the Template Details `\ . - -**Delete multiple templates**: - -#. 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_0000002121934986.png - :alt: **Figure 4** RFS Dashboard - - **Figure 4** RFS Dashboard - -#. In the left navigation pane, choose Templates -> Private Templates. You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. - - .. _en-us_topic_0000002082821521__fig4794165812196: - - **Figure 5** RFS Private Templates - - |image4| - -#. Select several templates and click the **Delete** in upper left corner above the template table. - - |image5| - -#. In the dialog box displayed, click **Yes** in the text box as shown in :ref:`Figure Dialog box for deleting multiple templates `. Template and all versions will be deleted. - - .. _en-us_topic_0000002082821521__fig75916272317: - - **Figure 6** Dialog box for deleting multiple templates - - |image6| - -.. |image1| image:: /_static/images/en-us_image_0000002121934990.png -.. |image2| image:: /_static/images/en-us_image_0000002157176629.png -.. |image3| image:: /_static/images/en-us_image_0000002121759436.png -.. |image4| image:: /_static/images/en-us_image_0000002157176625.png -.. |image5| image:: /_static/images/en-us_image_0000002121933970.png -.. |image6| image:: /_static/images/en-us_image_0000002121776110.png +.. |image1| image:: /_static/images/en-us_image_0000002194186605.png +.. |image2| image:: /_static/images/en-us_image_0000002121759436.png diff --git a/umn/source/managing_templates/exporting_a_template.rst b/umn/source/managing_templates/exporting_a_template.rst index b1897df..7ffb1da 100644 --- a/umn/source/managing_templates/exporting_a_template.rst +++ b/umn/source/managing_templates/exporting_a_template.rst @@ -9,7 +9,9 @@ RFS support export an existing template to user's local area. #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002121776834.png @@ -17,25 +19,27 @@ RFS support export an existing template to user's local area. **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Templates -> Private Templates. You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. +#. In the left navigation pane, choose \ **Templates**\ -> **Private Templates**\ . You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. - .. _en-us_topic_0000002082662957__fig89226538129: - **Figure 2** RFS Private Templates + .. figure:: /_static/images/en-us_image_0000002194189973.png + :alt: **Figure 2** RFS Private Templates - |image1| + **Figure 2** RFS Private Templates -#. Click the More->Export in the Operation column of the desired template to replicate it. +#. Click the **More** -> **Export** in the **Operation** column of the desired template to request an export from the latest version of the template. - |image2| + + .. figure:: /_static/images/en-us_image_0000002158823458.png + :alt: **Figure 3** RFS Private Templates + + **Figure 3** RFS Private Templates Next, the template will be automatically downloaded to the user's local area. -.. caution:: + .. note:: - The file name will be the name of the '{template_name}-{template_version}' and the file extension will be ".zip". + - The naming convention of the export file is: "{template_name}-{template_version}" and the file extension will be ".zip". + - Only the latest version of the template will be exported by default. If you want to export other versions, please go to \ :ref:`View the Template Details `\ . - Only the latest version of the template will be exported by default, if you want to export a version which is not the latest, please go to \ :ref:`View the Template Details `\ . - -.. |image1| image:: /_static/images/en-us_image_0000002157215033.png -.. |image2| image:: /_static/images/en-us_image_0000002121776838.png +.. |image1| image:: /_static/images/en-us_image_0000002158820094.png diff --git a/umn/source/managing_templates/modifying_a_template.rst b/umn/source/managing_templates/modifying_a_template.rst index 995670f..1fc6757 100644 --- a/umn/source/managing_templates/modifying_a_template.rst +++ b/umn/source/managing_templates/modifying_a_template.rst @@ -9,7 +9,9 @@ You can edit an existing template and update its content by following these step #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002121754732.png @@ -17,32 +19,27 @@ You can edit an existing template and update its content by following these step **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Templates -> Private Templates. You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. +#. In the left navigation pane, choose \ **Templates**\ -> **Private Templates**\ . You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. - .. _en-us_topic_0000002046742302__fig89226538129: - **Figure 2** RFS Private Templates + .. figure:: /_static/images/en-us_image_0000002194190061.png + :alt: **Figure 2** RFS Private Templates - |image1| + **Figure 2** RFS Private Templates -#. Click the edit in the Operation column of the desired template to modify its content, as shown in :ref:`Figure Edit Template Content `. Next, you can edit the template content directly on the page. And you can create, rename, and delete files and folders here. +#. Click the **Edit** in the **Operation** column of the desired template to modify its content based on the latest version, as shown in :ref:`Figure Edit Template Content `. In the Content Editor, you can directly edit the template content and you can create, rename, and delete files and folders or request an export if needed. .. _en-us_topic_0000002046742302__fig045261413418: **Figure 3** Edit Template Content - |image2|\ Then, Click **Save Template** in the upper right corner to save this change, as shown in :ref:`Figure 4 `. + |image2| - .. _en-us_topic_0000002046742302__fig146836389569: +#. When the modification is done, click **Save Template** in the upper right corner to save this changes. - **Figure 4** Saving Template + .. note:: - |image3| + Template editing is always based on the latest version of the template. If you want to modify other versions, please go to \ :ref:`View the Template Details `\ . - .. caution:: - - Only the latest version of the template will be modified by default, if you want to edit a version which is not the latest, please go to \ :ref:`View the Template Details `\ . - -.. |image1| image:: /_static/images/en-us_image_0000002121912836.png +.. |image1| image:: /_static/images/en-us_image_0000002194186609.png .. |image2| image:: /_static/images/en-us_image_0000002121909700.png -.. |image3| image:: /_static/images/en-us_image_0000002157154517.png diff --git a/umn/source/managing_templates/replicating_a_template.rst b/umn/source/managing_templates/replicating_a_template.rst index d46af22..4f590db 100644 --- a/umn/source/managing_templates/replicating_a_template.rst +++ b/umn/source/managing_templates/replicating_a_template.rst @@ -7,7 +7,9 @@ Replicating a Template #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002121934994.png @@ -15,39 +17,42 @@ Replicating a Template **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Templates -> Private Templates. You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. +#. In the left navigation pane, choose \ **Templates**\ -> **Private Templates**\ . You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. - .. _en-us_topic_0000002154685881__fig89226538129: - **Figure 2** RFS Private Templates + .. figure:: /_static/images/en-us_image_0000002194224409.png + :alt: **Figure 2** RFS Private Templates - |image1| + **Figure 2** RFS Private Templates -#. Click the More->Replicate in the Operation column of the desired template to replicate it. +#. Click the **More** -> **Replicate** in the **Operation** column of the desired template to make a copy of it based on the latest template version. + + + .. figure:: /_static/images/en-us_image_0000002158983366.png + :alt: **Figure 3** RFS Private Templates + + **Figure 3** RFS Private Templates + +#. In the Content Editor, you can directly edit the template content and you can create, rename, and delete files and folders or request an export if needed. + + + **Figure 4** Edit Template Content |image2| -#. Next, you can edit the template content directly on the page. And you can create, rename, and delete files and folders here. +#. When the modification is done, click **Save Template** in the upper right corner to save this changes. +#. A dialog box is displayed where you can specify the name, description and version description of the new template.\ |image3| - **Figure 3** Edit Template Content + .. note:: - |image3| + - The template 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. + - The template name cannot be changed after the template is created. + - A template description can contain a maximum of 1024 characters. + - A template version description can contain a maximum of 1024 characters. - Then, Click **Save Template** in the upper right corner to save this change, as shown in :ref:`Figure 4 `. +#. After you click **OK** in the **Save Template** dialog box, the new template will be created, and you can check in the **Private Templates** page. - .. _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| - -.. |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_0000002157215025.png -.. |image5| image:: /_static/images/en-us_image_0000002157074637.png +.. |image1| image:: /_static/images/en-us_image_0000002194220969.png +.. |image2| image:: /_static/images/en-us_image_0000002121776826.png +.. |image3| 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 58d6794..4ef13f2 100644 --- a/umn/source/managing_templates/viewing_template_details.rst +++ b/umn/source/managing_templates/viewing_template_details.rst @@ -7,7 +7,9 @@ Viewing Template Details #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002157147725.png @@ -15,26 +17,43 @@ Viewing Template Details **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Templates -> Private Templates. You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. +#. In the left navigation pane, choose \ **Templates**\ -> **Private Templates**\ . You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. - .. _en-us_topic_0000002119404102__fig89226538129: - **Figure 2** RFS Private Templates + .. figure:: /_static/images/en-us_image_0000002158823546.png + :alt: **Figure 2** RFS Private Templates - |image1| + **Figure 2** RFS Private Templates #. Click the name of the desired template to view its details. + There are three function modules on the template details page: + + a. **Basic Information**: displays basic information about the template, such as \ **Template Name**\ , \ **Template ID**\ , \ **Template Description**\ , etc, as shown in :ref:`Figure Template Details `. You can modify the template description here. + b. **Version Info**: displays all the version information of this template. You can view the content of any version in **Version** **Preview** by clicking the preview icon for that version. You can 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. + c. **Version Preview**: displays the template content of the specified version + .. _en-us_topic_0000002119404102__fig045261413418: - .. figure:: /_static/images/en-us_image_0000002157146149.png + .. figure:: /_static/images/en-us_image_0000002158983038.png :alt: **Figure 3** Template Details **Figure 3** Template Details - There are two function modules on the template details page: + You can perform the following operations on the template versions: - 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. + - **Editing a version**: this will create a new template version based on the selected version. To start editing a specific template version, click **Edit** in the **Operation** column of the desired version. For more details, check :ref:`Modifying a Template `. + - **Exporting a version**: this will export the selected template version in a zip file format. The naming convention of the export file is: “{TEMPLATE_NAME}-{TEMPLATE_VERSION}.zip”. To export a specific template version, click **More** -> **Export** in the **Operation** column of the desired version. + - **Deleting a version**: this will delete the selected template version. You can delete a single version or multiple versions in batches: -.. |image1| image:: /_static/images/en-us_image_0000002157066129.png + a. To delete a single template version, click **More** -> **Delete** in the **Operation** column. + b. To delete multiple template versions in batches, select the desired template versions and click the **Delete** in the upper left corner above the version table. + + .. caution:: + + - The deletion cannot be undone. + - If a template has only one version, the deletion of that version will result in the deletion of the entire template. + + - **Creating a stack**: this will initiate the creation of a new stack based on the selected template version. To start creating a stack based on a specific template version, click **Create Stack** in the **Operation** column of the desired version. For more information about the entire stack creation procedure, check :ref:`Creating a Stack from a Template. ` + +.. |image1| image:: /_static/images/en-us_image_0000002158979846.png diff --git a/umn/source/managing_templates/viewing_templates.rst b/umn/source/managing_templates/viewing_templates.rst index d36920e..634a5c2 100644 --- a/umn/source/managing_templates/viewing_templates.rst +++ b/umn/source/managing_templates/viewing_templates.rst @@ -7,7 +7,9 @@ Viewing Templates #. 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. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**. + + The \ **Dashboard**\ page is displayed. .. figure:: /_static/images/en-us_image_0000002121906076.png @@ -15,12 +17,25 @@ Viewing Templates **Figure 1** RFS Dashboard -#. In the left navigation pane, choose Templates -> Private Templates. You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. +#. In the left navigation pane, choose \ **Templates**\ -> **Private Templates**\ . You can see all the templates created under the current account, as shown in :ref:`Figure RFS Private Templates `. Additionally, for each template, you can obtain the **Description**, **Version**, **Version Description**, etc. - .. _en-us_topic_0000002119245982__fig89226538129: - **Figure 2** RFS Private Templates + .. figure:: /_static/images/en-us_image_0000002194190049.png + :alt: **Figure 2** RFS Private Templates - |image1| + **Figure 2** RFS Private Templates -.. |image1| image:: /_static/images/en-us_image_0000002121747944.png + You can perform the following operations on the templates: + + - **Modifying a template**: this will create a new template version based on the latest version of the selected template. For more details, check :ref:`Modifying a Template `. + - **Replicating a template**: this will create a brand new template based on the latest version of the selected template. For more details, check :ref:`Replicating a Template `. + - **Exporting a template**: this will export the latest template version of the selected template in a zip file format. For more details, check :ref:`Exporting a Template `. + - **Deleting a template**: this will delete the entire template. For more details, check :ref:`Deleting a Template `. + + .. caution:: + + Deleting a template will delete all versions in the template and the deleted versions cannot be restored. Exercise caution when performing this operation. + + - **Creating a stack**: this will initiate the creation of a new stack based on the latest template version of the selected template. For more information about the entire stack creation procedure, check :ref:`Creating a Stack from a Template `. + +.. |image1| image:: /_static/images/en-us_image_0000002158820098.png diff --git a/umn/source/permission_management.rst b/umn/source/permission_management.rst deleted file mode 100644 index 28a8b43..0000000 --- a/umn/source/permission_management.rst +++ /dev/null @@ -1,6 +0,0 @@ -:original_name: en-us_topic_0000002154571445.html - -.. _en-us_topic_0000002154571445: - -Permission Management -===================== diff --git a/umn/source/permission_management/creating_a_user_and_granting_permissions.rst b/umn/source/permission_management/creating_a_user_and_granting_permissions.rst new file mode 100644 index 0000000..1e57c34 --- /dev/null +++ b/umn/source/permission_management/creating_a_user_and_granting_permissions.rst @@ -0,0 +1,40 @@ +:original_name: en-us_topic_0000002158796408.html + +.. _en-us_topic_0000002158796408: + +Creating a User and Granting Permissions +======================================== + +This section describes how to use IAM to implement fine-grained permissions control for RF service. With IAM, you can: + +- Create IAM users for employees based on your organizational structure. Each IAM user has their own security credentials for accessing RF service. +- Granting users only the permissions required to perform a given task based on their job responsibilities. +- Entrust an account or a cloud service to perform operations for your RF service. + +If your account does not need indivitual IAM users, skip this section. + +:ref:`Figure 1 ` shows the process flow for granting permissions. + +**Prerequisites** + +Before granting permissions, learn about the RFS permissions and select the permissions as required. For details about the system-defined permissions supported by RFS, see :ref:`RFS Permissions `. To grant permissions for other services, you can see `permissions `__. + +**Flowchart** + +.. _en-us_topic_0000002158796408__fig14490220011: + +.. figure:: /_static/images/en-us_image_0000002159668284.png + :alt: **Figure 1** Granting RFS permissions + + **Figure 1** Granting RFS permissions + +#. On the IAM console, `create a user group and assigning permissions `__. Here, RFS ReadOnlyAccess permissions are used as an example. + +#. `Create an IAM user and add it to the created user group `__. + +#. `Log in `__ and verify permissions. + + The created user logs in to the console and verifies permissions as described below: + + - Choose **Service List** > **Resource Formation Service**. In the navigation pane on the left, click **Stacks**. In the upper right corner of the displayed page, click **Create Stack**. If a message appears indicating that you have insufficient permissions to perform the operation, and if you can view existing stacks in the **Stacks** page, the **RFS ReadOnlyAccess** policy is in effect. + - Choose another service from **Service List**. If a message appears indicating that you have insufficient permissions to access the service, the **RFS ReadOnlyAccess** policy is in effect. diff --git a/umn/source/permission_management/custom_policies.rst b/umn/source/permission_management/custom_policies.rst new file mode 100644 index 0000000..98ab30b --- /dev/null +++ b/umn/source/permission_management/custom_policies.rst @@ -0,0 +1,73 @@ +:original_name: en-us_topic_0000002158636644.html + +.. _en-us_topic_0000002158636644: + +Custom Policies +=============== + +The following lists examples of custom policies for RFS. + +**Example Custom Policies** + +- Example 1: Granting permission to view stacks + + .. code-block:: + + { + "Version": "1.1", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "rf:stack:listStacks" + ] + } + ] + } + +- Example 2: Granting permission to deny stack deletion + + .. code-block:: + + { + "Version": "1.1", + "Statement": [ + { + "Effect": "Deny", + "Action": [ + "rf:stack:deleteStack" + ] + } + ] + } + +- Example 3: Creating a custom policy containing multiple actions. + + A custom policy can contain actions of one or more services. To grant permissions of multiple services in a policy, ensure that the services are all of the same level (global or project). + + The following shows an example policy that contains multiple actions. + + .. code-block:: + + { + "Version": "1.1", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "rf:stack:updateStack", + "rf:stack:createStack", + "rf:stack:deployStack", + "rf:stack:deleteStack", + "rf:stack:listStacks" + ] + }, + { + "Effect": "Allow", + "Action": [ + "kms:dek:create", + "kms:cmk:list" + ] + } + ] + } diff --git a/umn/source/permission_management/index.rst b/umn/source/permission_management/index.rst new file mode 100644 index 0000000..a8a847d --- /dev/null +++ b/umn/source/permission_management/index.rst @@ -0,0 +1,16 @@ +:original_name: en-us_topic_0000002154571445.html + +.. _en-us_topic_0000002154571445: + +Permission Management +===================== + +- :ref:`Creating a User and Granting Permissions ` +- :ref:`Custom Policies ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_user_and_granting_permissions + custom_policies diff --git a/umn/source/quotas.rst b/umn/source/quotas.rst index 164608a..8bbc14f 100644 --- a/umn/source/quotas.rst +++ b/umn/source/quotas.rst @@ -5,30 +5,16 @@ Quotas ====== -RFS limits the number of stacks for a single user, as shown in the following table. +RFS limits the number of resources 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 | -+----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ ++------------------+---------------------------------------------------------------------------------+-------+ +| Resource | Item | Quota | ++==================+=================================================================================+=======+ +| Template | Maximum number of templates that can be created by a Open Telekom Cloud account | 100 | ++------------------+---------------------------------------------------------------------------------+-------+ +| Template Version | Maximum number of template versions that can be created for each template | 100 | ++------------------+---------------------------------------------------------------------------------+-------+ +| Stack | Maximum number of stacks that can be created by a Open Telekom Cloud account | 100 | ++------------------+---------------------------------------------------------------------------------+-------+ +| Execution Plan | Maximum number of execution plans that can be created in each stack | 100 | ++------------------+---------------------------------------------------------------------------------+-------+ diff --git a/umn/source/service_overview/accessing_rfs.rst b/umn/source/service_overview/accessing_rfs.rst index 9a4eed4..838fddd 100644 --- a/umn/source/service_overview/accessing_rfs.rst +++ b/umn/source/service_overview/accessing_rfs.rst @@ -9,12 +9,20 @@ To access the RFS console, perform the following steps: #. Log in to the OpenTelekomCloud Console. -#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. +#. In the upper left corner of the page, click |image1|, and then click **Management & Deployment** > **Resource Formation Service**\ . - The RFS console is displayed. + The **Dashboard** page is displayed. + + + .. figure:: /_static/images/en-us_image_0000002158978858.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard =========== =========== =========== Site Region Name Region Code =========== =========== =========== OpenTelekom eu-de eu-de =========== =========== =========== + +.. |image1| image:: /_static/images/en-us_image_0000002158819098.png diff --git a/umn/source/service_overview/constraints_and_limitations.rst b/umn/source/service_overview/constraints_and_limitations.rst index b3355db..77135f5 100644 --- a/umn/source/service_overview/constraints_and_limitations.rst +++ b/umn/source/service_overview/constraints_and_limitations.rst @@ -8,19 +8,17 @@ Constraints and Limitations Permissions ----------- -To use RFS, :ref:`create an agency `. +If it is needed, :ref:`create an agency `. -Quotas ------- +Constraints +----------- -RFS limits the number of stacks for a single user, as shown in the following table. +The following are basic constraints of RFS. +----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| Resource | Item | Quota | +| Resource | Item | Limit | +================+========================================================================================================================+==========================+ -| Template | Maximum number of templates that can be created by a Open Telekom Cloud account | 100 | -+----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ -| | Maximum length of a template name | 128 characters | +| Template | Maximum length of a template name | 128 characters | +----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ | | Maximum length of a template file name | 255 bytes | +----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ @@ -30,13 +28,9 @@ RFS limits the number of stacks for a single user, as shown in the following tab +----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ | | 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 | +| Stack | 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 | +| Execution plan | Maximum length of an execution plan name | 128 characters | +----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ diff --git a/umn/source/service_overview/index.rst b/umn/source/service_overview/index.rst index 0e0cd1f..8305457 100644 --- a/umn/source/service_overview/index.rst +++ b/umn/source/service_overview/index.rst @@ -14,6 +14,7 @@ Service Overview - :ref:`Constraints and Limitations ` - :ref:`Accessing RFS ` - :ref:`Permission ` +- :ref:`Supported Provider Versions ` .. toctree:: :maxdepth: 1 @@ -28,3 +29,4 @@ Service Overview constraints_and_limitations accessing_rfs permission + supported_provider_versions diff --git a/umn/source/service_overview/permission.rst b/umn/source/service_overview/permission.rst index fa1bcf3..e1a495d 100644 --- a/umn/source/service_overview/permission.rst +++ b/umn/source/service_overview/permission.rst @@ -14,149 +14,165 @@ You can grant permissions by using roles and policies. - Roles: A coarse-grained authorization mechanism that defines permissions related to user responsibilities. This mechanism provides a limited number of service-level roles for authorization. Open Telekom Cloud services depend on each other. When you grant permissions using roles, you may need to attach any existing role dependencies. However, roles are not ideal for fine-grained authorization and least privilege access. - Policies: A fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This type of authorization is more flexible and is ideal for least privilege access. -.. table:: **Table 1** RFS permissions +.. table:: **Table 1** RFS system-defined permissions - +------------------------------------+------------------------------------------------------------------------------------------+---------------------+ - | Item | Description | Type | - +====================================+==========================================================================================+=====================+ - | RF FullAccess | All permissions for RFS. | System-defined role | - +------------------------------------+------------------------------------------------------------------------------------------+---------------------+ - | RF DeployByExecutionPlanOperations | Create, apply, and read permissions for execution plans and read permissions for stacks. | System-defined role | - +------------------------------------+------------------------------------------------------------------------------------------+---------------------+ - | RF ReadOnlyAccess | Read-only permissions for RFS. | System-defined role | - +------------------------------------+------------------------------------------------------------------------------------------+---------------------+ - -RF FullAccess Policy Details - -.. code-block:: - - { - "Version": "1.1", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "rf:*:*" - ] - } - ] - } - -RF DeployByExecutionPlanOperations Policy Details - -.. code-block:: - - { - "Version": "1.1", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "rf:stack:listStacks", - "rf:stack:getStackMetadata", - "rf:stack:listStackEvents", - "rf:stack:getStackTemplate", - "rf:stack:listStackResources", - "rf:stack:listStackOutputs", - "rf:stack:createExecutionPlan", - "rf:stack:getExecutionPlan", - "rf:stack:getExecutionPlanMetadata", - "rf:stack:applyExecutionPlan", - "rf:stack:listExecutionPlans" - ] - } - ] - } - -RF ReadOnlyAccess Policy Details - -.. code-block:: - - { - "Version": "1.1", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "rf:*:get*", - "rf:*:list*" - ] - } - ] - } + +------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ + | Item | Description | Type | + +====================================+==========================================================================================+=======================+ + | RF FullAccess | All permissions for RFS. | System-defined policy | + +------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ + | RF DeployByExecutionPlanOperations | Create, apply, and read permissions for execution plans and read permissions for stacks. | System-defined policy | + +------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ + | RF ReadOnlyAccess | Read-only permissions for RFS. | System-defined policy | + +------------------------------------+------------------------------------------------------------------------------------------+-----------------------+ :ref:`Table 2 ` lists the common operations supported by each system-defined policy of RFS. Please choose proper policies according to this table. -.. _en-us_topic_0000002154657157__table65762630: - .. table:: **Table 2** Common RFS operations supported by system-defined permissions - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | System-defined Permission | RF DeployByExecutionPlanOperations | RF FullAccess | RF ReadOnlyAccess | RF StackSetFullAccess | RF StackSetReadOnly | - +========================================+====================================+===============+===================+=======================+=====================+ - | rf:privateTemplate:create | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:createVersion | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:delete | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:deleteVersion | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:list | Y | x | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:listVersions | Y | x | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:showMetadata | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:showVersionContent | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:showVersionMetadata | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:privateTemplate:updateMetadata | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:applyExecutionPlan | Y | Y | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:continueDeployStack | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:continueRollbackStack | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:createExecutionPlan | Y | Y | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:createStack | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:deleteExecutionPlan | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:deleteStack | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:deployStack | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:estimateExecutionPlanPrice | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:getExecutionPlan | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:getExecutionPlanMetadata | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:getExecutionPlanTemplate | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:getStackMetadata | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:getStackTemplate | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:importResources | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:listExecutionPlans | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:listStackEvents | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:listStackOutputs | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:listStackResources | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:listStacks | Y | Y | Y | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:updateStack | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:stack:updateStackDeletionProtection | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ - | rf:template:parseTemplateVariables | Y | x | x | x | x | - +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ + +----------------------------------+---------------+------------------------------------+-------------------+ + | Operation | RF FullAccess | RF DeployByExecutionPlanOperations | RF ReadOnlyAccess | + +==================================+===============+====================================+===================+ + | Creating a template | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Creating a template version | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Delete a template | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Delete a template version | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | List templates | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | List template versions | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Show template metadata | Y | x | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Show template version content | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Show template version metadata | Y | x | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Update template metadata | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Parse template variables | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Apply execution plan | Y | Y | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Create execution plan | Y | Y | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Delete execution plan | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Get execution plan | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Get execution plan metadata | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | List execution plans | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Create stack | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Delete stack | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Deploy stack | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Continue to deploy stack | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Continue to rollback stack | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Get stack metadata | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Get stack template | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | List stack events | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | List stack outputs | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | List stack resources | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | List stacks | Y | Y | Y | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Update stack | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Update stack deletion protection | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + | Import stack resources | Y | x | x | + +----------------------------------+---------------+------------------------------------+-------------------+ + +If predefined permissions cannot meet your requirements, you can create custom policies. Custom policies allow you to perform fine-grained access control flexibly. For details about how to create a custom policy, see \ `Creating a Custom Policy `__\ . For details about RFS example custom policies, see \ :ref:`Custom Policies `\ . + +The following table lists fine-grained actions and dependencies for RFS. + +.. _en-us_topic_0000002154657157__table65762630: + +.. table:: **Table 3** RFS fine-grained actions + + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | System-defined Permission | Description | Dependencies | Scenario | + +========================================+=======================================================+==============+==================================+ + | rf:privateTemplate:create | Grant permissions to create a template | None | Creating a template | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:createVersion | Grant permissions to create a template version | None | Creating a template version | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:delete | Grant permissions to delete a template | None | Delete a template | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:deleteVersion | Grant permissions to delete a template version | None | Delete a template version | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:list | Grant permissions to list templates | None | List templates | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:listVersions | Grant permissions to list template versions | None | List template versions | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:showMetadata | Grant permissions to show template metadata | None | Show template metadata | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:showVersionContent | Grant permissions to show template version content | None | Show template version content | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:showVersionMetadata | Grant permissions to show template version metadata | None | Show template version metadata | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:privateTemplate:updateMetadata | Grant permissions to update template metadata | None | Update template metadata | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:template:parseTemplateVariables | Grant permissions to parse template variables | None | Parse template variables | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:applyExecutionPlan | Grant permissions to apply execution plan | None | Apply execution plan | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:createExecutionPlan | Grant permissions to create execution plan | None | Create execution plan | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:deleteExecutionPlan | Grant permissions to delete execution plan | None | Delete execution plan | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:getExecutionPlan | Grant permissions to get execution plan | None | Get execution plan | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:getExecutionPlanMetadata | Grant permissions to get execution plan metadata | None | Get execution plan metadata | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:listExecutionPlans | Grant permissions to list execution plans | None | List execution plans | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:createStack | Grant permissions to create stack | None | Create stack | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:deleteStack | Grant permissions to delete stack | None | Delete stack | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:deployStack | Grant permissions to deploy stack | None | Deploy stack | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:continueDeployStack | Grant permissions to continue to deploy stack | None | Continue to deploy stack | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:continueRollbackStack | Grant permissions to continue to rollback stack | None | Continue to rollback stack | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:getStackMetadata | Grant permissions to get stack metadata | None | Get stack metadata | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:getStackTemplate | Grant permissions to get stack template | None | Get stack template | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:listStackEvents | Grant permissions to list stack events | None | List stack events | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:listStackOutputs | Grant permissions to list stack outputs | None | List stack outputs | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:listStackResources | Grant permissions to list stack resources | None | List stack resources | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:listStacks | Grant permissions to list stacks | None | List stacks | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:updateStack | Grant permissions to update stack | None | Update stack | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:updateStackDeletionProtection | Grant permissions to update stack deletion protection | None | Update stack deletion protection | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + | rf:stack:importResources | Grant permissions to import stack resources | None | Import stack resources | + +----------------------------------------+-------------------------------------------------------+--------------+----------------------------------+ + +Related Documents +----------------- + +To learn about the IAM service, see `What Is IAM? `__. + +For details about how to create a user or a user group and how to grant RFS permissions, see :ref:`Creating a User and Granting Permissions `. diff --git a/umn/source/service_overview/product_advantages.rst b/umn/source/service_overview/product_advantages.rst index 8ab04f3..810dd50 100644 --- a/umn/source/service_overview/product_advantages.rst +++ b/umn/source/service_overview/product_advantages.rst @@ -13,7 +13,7 @@ Product Advantages **Rich ecosystem:** The southbound ecosystem supports mainstream Open Telekom Cloud services. For details, see `OpenTelekom Cloud Provider `__. The northbound ecosystem is fully compatible with the HCL syntax, eliminating a learning curve. -**Easy to use:** Wizard-based operations, comprehensive documentation, and sample auxiliary system help you to manage resources in five steps. +**Easy to use:** With comprehensive documentation and samples, resource management can be completed in five steps. **Full hosting and cloud-based services:** You do not need to install any software, prepare executors, or manage underlying files and data. diff --git a/umn/source/service_overview/region_and_az.rst b/umn/source/service_overview/region_and_az.rst index dafeb13..02b87e0 100644 --- a/umn/source/service_overview/region_and_az.rst +++ b/umn/source/service_overview/region_and_az.rst @@ -4,3 +4,37 @@ Region and AZ ============= + +Concept +------- + +A region and availability zone (AZ) identify the location of a data center. You can create resources in a specific region and AZ. + +- A region is a physical data center, which is completely isolated to improve fault tolerance and stability. The region that is selected during resource creation cannot be changed after the resource is created. +- An AZ is a physical location where resources use independent power supplies and networks. A region contains one or more AZs that are physically isolated but interconnected through internal networks. Because AZs are isolated from each other, any fault that occurs in one AZ will not affect others. + +Figure 1 shows the relationship between regions and AZs. + + +.. figure:: /_static/images/en-us_image_0000002158802688.png + :alt: **Figure 1** Regions and AZs + + **Figure 1** Regions and AZs + +Selecting a Region +------------------ + +Select a region closest to your target users for lower network latency and quick access. + +Selecting an AZ +--------------- + +When deploying resources, consider your applications' requirements on disaster recovery (DR) and network latency. + +- For high DR capability, deploy resources in different AZs within the same region. +- For lower network latency, deploy resources in the same AZ. + +Regions and Endpoints +--------------------- + +Before you use an API to call resources, specify its region and endpoint. For more details, see `Regions and Endpoints `__\ l. diff --git a/umn/source/service_overview/rfs_and_other_services.rst b/umn/source/service_overview/rfs_and_other_services.rst index 5f1d63c..91df29b 100644 --- a/umn/source/service_overview/rfs_and_other_services.rst +++ b/umn/source/service_overview/rfs_and_other_services.rst @@ -4,3 +4,9 @@ RFS and Other Services ====================== + +- OBS: RFS uses OBS buckets to download template files and dump logs. +- CTS: RFS converts user operations including API calls into audit logs and sends these logs to CTS. +- IAM: RFS uses IAM for user authentication and fine-grained authorization. +- KMS: RFS uses KMS to encrypt sensitive information (in variables or other data) before transmission. +- Config: RFS interconnects with Config service to enable unified management of RFS resources. diff --git a/umn/source/service_overview/supported_provider_versions.rst b/umn/source/service_overview/supported_provider_versions.rst new file mode 100644 index 0000000..5749931 --- /dev/null +++ b/umn/source/service_overview/supported_provider_versions.rst @@ -0,0 +1,20 @@ +:original_name: en-us_topic_0000002194972413.html + +.. _en-us_topic_0000002194972413: + +Supported Provider Versions +=========================== + +A Provider is a plug-in that encapsulates various resource APIs (such as CRUD APIs of resources) for the resource formation engine to call. + +The following table lists the Provider types and versions supported by RFS. + +.. table:: **Table 1** Supported Provider Versions + + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ + | Type | Introduction | Version | + +===========================+=======================================================================================================================================================================+======================================================================================================+ + | OpenTelekomCloud Provider | Users can use OpenTelekomCloud Provider to interact with various resources on Open Telekom Cloud. Before using the provider, configure the corresponding permissions. | `1.35.13 `__ | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ + | | | `1.36.15 `__ | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/service_overview/what_is_rfs.rst b/umn/source/service_overview/what_is_rfs.rst index 3733cb6..58de1e1 100644 --- a/umn/source/service_overview/what_is_rfs.rst +++ b/umn/source/service_overview/what_is_rfs.rst @@ -5,6 +5,6 @@ What Is RFS? ============ -Resource Formation Service (RFS) is fully supports Terraform (HCL and Provider), which is a de facto standard. It manages system and service resources (all physical or logical entities that can be located and described, such as databases, VPCs, pipelines, and IAM roles). RFS automatically deploys specified cloud service resources based on the template which uses the HCL (an open ecosystem) syntax. +Resource Formation Service (RFS) fully supports Terraform (HCL and Provider), which is a de facto standard. It manages system and service resources (all physical or logical entities that can be located and described, such as databases, VPCs, pipelines, and IAM roles). RFS automatically deploys specified cloud service resources based on the template which uses the HCL (an open ecosystem) syntax. RFS focuses on automatically building Open Telekom Cloud resources in batches. It helps you create, manage, and upgrade required resources in an efficient, secure, and consistent manner, improving resource management efficiency and reducing security risks caused by resource management changes.