diff --git a/umn/source/_static/images/en-us_image_0000001955571490.png b/umn/source/_static/images/en-us_image_0000001955571490.png deleted file mode 100644 index 5a472bc..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001955571490.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001955571494.png b/umn/source/_static/images/en-us_image_0000001955571494.png deleted file mode 100644 index 5d469e0..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001955571494.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001955571498.png b/umn/source/_static/images/en-us_image_0000001955571498.png deleted file mode 100644 index 5a472bc..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001955571498.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001955571502.png b/umn/source/_static/images/en-us_image_0000001955571502.png deleted file mode 100644 index 0cae059..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001955571502.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001955571510.png b/umn/source/_static/images/en-us_image_0000001955571510.png deleted file mode 100644 index 53393c8..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001955571510.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001955571522.png b/umn/source/_static/images/en-us_image_0000001955571522.png deleted file mode 100644 index 678a318..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001955571522.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001955571526.png b/umn/source/_static/images/en-us_image_0000001955571526.png deleted file mode 100644 index 3f98b99..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001955571526.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991770637.png b/umn/source/_static/images/en-us_image_0000001991770637.png deleted file mode 100644 index bcd708f..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991770637.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991770661.png b/umn/source/_static/images/en-us_image_0000001991770661.png deleted file mode 100644 index 4e5b049..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991770661.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991770669.png b/umn/source/_static/images/en-us_image_0000001991770669.png deleted file mode 100644 index 0a18405..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991770669.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991770673.png b/umn/source/_static/images/en-us_image_0000001991770673.png deleted file mode 100644 index fb71ee9..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991770673.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991770677.png b/umn/source/_static/images/en-us_image_0000001991770677.png deleted file mode 100644 index 061687e..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991770677.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991770681.png b/umn/source/_static/images/en-us_image_0000001991770681.png deleted file mode 100644 index 2f9f786..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991770681.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991770685.png b/umn/source/_static/images/en-us_image_0000001991770685.png deleted file mode 100644 index 27868d9..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991770685.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991770689.png b/umn/source/_static/images/en-us_image_0000001991770689.png deleted file mode 100644 index 764e21c..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991770689.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890821.png b/umn/source/_static/images/en-us_image_0000001991890821.png deleted file mode 100644 index 8961d4c..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890821.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890829.png b/umn/source/_static/images/en-us_image_0000001991890829.png deleted file mode 100644 index d19d6dc..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890829.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890833.png b/umn/source/_static/images/en-us_image_0000001991890833.png deleted file mode 100644 index 9641721..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890833.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890837.png b/umn/source/_static/images/en-us_image_0000001991890837.png deleted file mode 100644 index d19d6dc..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890837.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890841.png b/umn/source/_static/images/en-us_image_0000001991890841.png deleted file mode 100644 index 46a46e7..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890841.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890853.png b/umn/source/_static/images/en-us_image_0000001991890853.png deleted file mode 100644 index 305083e..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890853.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890857.png b/umn/source/_static/images/en-us_image_0000001991890857.png deleted file mode 100644 index 46461f6..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890857.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890861.png b/umn/source/_static/images/en-us_image_0000001991890861.png deleted file mode 100644 index a22e807..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890861.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890865.png b/umn/source/_static/images/en-us_image_0000001991890865.png deleted file mode 100644 index aa6128f..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890865.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001991890869.png b/umn/source/_static/images/en-us_image_0000001991890869.png deleted file mode 100644 index df747ab..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001991890869.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002046583090.png b/umn/source/_static/images/en-us_image_0000002046583090.png deleted file mode 100644 index f603de3..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002046583090.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002046741362.png b/umn/source/_static/images/en-us_image_0000002046741362.png deleted file mode 100644 index 76f69b6..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002046741362.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002046752570.png b/umn/source/_static/images/en-us_image_0000002046752570.png deleted file mode 100644 index cece33a..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002046752570.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002046754798.png b/umn/source/_static/images/en-us_image_0000002046754798.png deleted file mode 100644 index 38aa3c3..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002046754798.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002047112604.png b/umn/source/_static/images/en-us_image_0000002047112604.png deleted file mode 100644 index 6319996..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002047112604.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002047151338.png b/umn/source/_static/images/en-us_image_0000002047151338.png deleted file mode 100644 index f07bf6a..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002047151338.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002082662057.png b/umn/source/_static/images/en-us_image_0000002082662057.png deleted file mode 100644 index 6d5e31c..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002082662057.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002082672533.png b/umn/source/_static/images/en-us_image_0000002082672533.png deleted file mode 100644 index 28df12c..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002082672533.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002082673825.png b/umn/source/_static/images/en-us_image_0000002082673825.png deleted file mode 100644 index 43ea6fe..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002082673825.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002082820613.png b/umn/source/_static/images/en-us_image_0000002082820613.png deleted file mode 100644 index e824e56..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002082820613.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002083156329.png b/umn/source/_static/images/en-us_image_0000002083156329.png deleted file mode 100644 index e2b6aa9..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002083156329.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002083259861.png b/umn/source/_static/images/en-us_image_0000002083259861.png deleted file mode 100644 index 00ade0f..0000000 Binary files a/umn/source/_static/images/en-us_image_0000002083259861.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000002119222466.png b/umn/source/_static/images/en-us_image_0000002119222466.png new file mode 100644 index 0000000..77ff706 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002119222466.png differ diff --git a/umn/source/_static/images/en-us_image_0000002119380574.png b/umn/source/_static/images/en-us_image_0000002119380574.png new file mode 100644 index 0000000..45fc248 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002119380574.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120549060.png b/umn/source/_static/images/en-us_image_0000002120549060.png new file mode 100644 index 0000000..e3f19bb Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120549060.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120563432.png b/umn/source/_static/images/en-us_image_0000002120563432.png new file mode 100644 index 0000000..64f3a69 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120563432.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120705156.png b/umn/source/_static/images/en-us_image_0000002120705156.png new file mode 100644 index 0000000..3e169fb Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120705156.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120707020.png b/umn/source/_static/images/en-us_image_0000002120707020.png new file mode 100644 index 0000000..1e5bc1d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120707020.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120721540.png b/umn/source/_static/images/en-us_image_0000002120721540.png new file mode 100644 index 0000000..ebf973e Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120721540.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120743374.png b/umn/source/_static/images/en-us_image_0000002120743374.png new file mode 100644 index 0000000..1734887 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120743374.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120743394.png b/umn/source/_static/images/en-us_image_0000002120743394.png new file mode 100644 index 0000000..e80b7fd Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120743394.png differ diff --git a/umn/source/_static/images/en-us_image_0000001991770653.png b/umn/source/_static/images/en-us_image_0000002120743398.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001991770653.png rename to umn/source/_static/images/en-us_image_0000002120743398.png diff --git a/umn/source/_static/images/en-us_image_0000002120745830.png b/umn/source/_static/images/en-us_image_0000002120745830.png new file mode 100644 index 0000000..dc83743 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120745830.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120746402.png b/umn/source/_static/images/en-us_image_0000002120746402.png new file mode 100644 index 0000000..7422648 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120746402.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120901474.png b/umn/source/_static/images/en-us_image_0000002120901474.png new file mode 100644 index 0000000..558f248 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120901474.png differ diff --git a/umn/source/_static/images/en-us_image_0000002120901486.png b/umn/source/_static/images/en-us_image_0000002120901486.png new file mode 100644 index 0000000..87207a2 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002120901486.png differ diff --git a/umn/source/_static/images/en-us_image_0000001991770657.png b/umn/source/_static/images/en-us_image_0000002120901494.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001991770657.png rename to umn/source/_static/images/en-us_image_0000002120901494.png diff --git a/umn/source/_static/images/en-us_image_0000002121444564.png b/umn/source/_static/images/en-us_image_0000002121444564.png new file mode 100644 index 0000000..3e0389b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121444564.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121519232.png b/umn/source/_static/images/en-us_image_0000002121519232.png new file mode 100644 index 0000000..b49631d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121519232.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121525200.png b/umn/source/_static/images/en-us_image_0000002121525200.png new file mode 100644 index 0000000..5d01d5b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121525200.png differ diff --git a/umn/source/_static/images/en-us_image_0000001991890849.png b/umn/source/_static/images/en-us_image_0000002121602684.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001991890849.png rename to umn/source/_static/images/en-us_image_0000002121602684.png diff --git a/umn/source/_static/images/en-us_image_0000002121663600.png b/umn/source/_static/images/en-us_image_0000002121663600.png new file mode 100644 index 0000000..d423cec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121663600.png differ diff --git a/umn/source/_static/images/en-us_image_0000001955571518.png b/umn/source/_static/images/en-us_image_0000002121667372.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001955571518.png rename to umn/source/_static/images/en-us_image_0000002121667372.png diff --git a/umn/source/_static/images/en-us_image_0000002121673112.png b/umn/source/_static/images/en-us_image_0000002121673112.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121673112.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121681612.png b/umn/source/_static/images/en-us_image_0000002121681612.png new file mode 100644 index 0000000..b2e5a2c Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121681612.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121739696.png b/umn/source/_static/images/en-us_image_0000002121739696.png new file mode 100644 index 0000000..de006bc Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121739696.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121742716.png b/umn/source/_static/images/en-us_image_0000002121742716.png new file mode 100644 index 0000000..6b5e70b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121742716.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121747944.png b/umn/source/_static/images/en-us_image_0000002121747944.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121747944.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121754732.png b/umn/source/_static/images/en-us_image_0000002121754732.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121754732.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121759436.png b/umn/source/_static/images/en-us_image_0000002121759436.png new file mode 100644 index 0000000..ba1ef66 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121759436.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121776110.png b/umn/source/_static/images/en-us_image_0000002121776110.png new file mode 100644 index 0000000..ae2f625 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121776110.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121776826.png b/umn/source/_static/images/en-us_image_0000002121776826.png new file mode 100644 index 0000000..a5f452b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121776826.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121776830.png b/umn/source/_static/images/en-us_image_0000002121776830.png new file mode 100644 index 0000000..1f8c0c1 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121776830.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121776834.png b/umn/source/_static/images/en-us_image_0000002121776834.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121776834.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121776838.png b/umn/source/_static/images/en-us_image_0000002121776838.png new file mode 100644 index 0000000..1f8c0c1 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121776838.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121900316.png b/umn/source/_static/images/en-us_image_0000002121900316.png new file mode 100644 index 0000000..a09a77d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121900316.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121900840.png b/umn/source/_static/images/en-us_image_0000002121900840.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121900840.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121903204.png b/umn/source/_static/images/en-us_image_0000002121903204.png new file mode 100644 index 0000000..f83097c Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121903204.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121903472.png b/umn/source/_static/images/en-us_image_0000002121903472.png new file mode 100644 index 0000000..5ca57f8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121903472.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121906076.png b/umn/source/_static/images/en-us_image_0000002121906076.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121906076.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121909700.png b/umn/source/_static/images/en-us_image_0000002121909700.png new file mode 100644 index 0000000..a5f452b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121909700.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121912836.png b/umn/source/_static/images/en-us_image_0000002121912836.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121912836.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121933970.png b/umn/source/_static/images/en-us_image_0000002121933970.png new file mode 100644 index 0000000..fd83346 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121933970.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121934982.png b/umn/source/_static/images/en-us_image_0000002121934982.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121934982.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121934986.png b/umn/source/_static/images/en-us_image_0000002121934986.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121934986.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121934990.png b/umn/source/_static/images/en-us_image_0000002121934990.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121934990.png differ diff --git a/umn/source/_static/images/en-us_image_0000002121934994.png b/umn/source/_static/images/en-us_image_0000002121934994.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002121934994.png differ diff --git a/umn/source/_static/images/en-us_image_0000002155926273.png b/umn/source/_static/images/en-us_image_0000002155926273.png new file mode 100644 index 0000000..457a8ab Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002155926273.png differ diff --git a/umn/source/_static/images/en-us_image_0000002155947169.png b/umn/source/_static/images/en-us_image_0000002155947169.png new file mode 100644 index 0000000..7650adf Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002155947169.png differ diff --git a/umn/source/_static/images/en-us_image_0000002155947473.png b/umn/source/_static/images/en-us_image_0000002155947473.png new file mode 100644 index 0000000..7422648 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002155947473.png differ diff --git a/umn/source/_static/images/en-us_image_0000002155948217.png b/umn/source/_static/images/en-us_image_0000002155948217.png new file mode 100644 index 0000000..c419a77 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002155948217.png differ diff --git a/umn/source/_static/images/en-us_image_0000002155949165.png b/umn/source/_static/images/en-us_image_0000002155949165.png new file mode 100644 index 0000000..d5dfb23 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002155949165.png differ diff --git a/umn/source/_static/images/en-us_image_0000002155961665.png b/umn/source/_static/images/en-us_image_0000002155961665.png new file mode 100644 index 0000000..e64e01b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002155961665.png differ diff --git a/umn/source/_static/images/en-us_image_0000002156029369.png b/umn/source/_static/images/en-us_image_0000002156029369.png new file mode 100644 index 0000000..07eca99 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156029369.png differ diff --git a/umn/source/_static/images/en-us_image_0000002156043281.png b/umn/source/_static/images/en-us_image_0000002156043281.png new file mode 100644 index 0000000..83d6e8c Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156043281.png differ diff --git a/umn/source/_static/images/en-us_image_0000001955571482.png b/umn/source/_static/images/en-us_image_0000002156043285.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001955571482.png rename to umn/source/_static/images/en-us_image_0000002156043285.png diff --git a/umn/source/_static/images/en-us_image_0000002156056533.png b/umn/source/_static/images/en-us_image_0000002156056533.png new file mode 100644 index 0000000..093d37d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156056533.png differ diff --git a/umn/source/_static/images/en-us_image_0000001991770645.png b/umn/source/_static/images/en-us_image_0000002156063229.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001991770645.png rename to umn/source/_static/images/en-us_image_0000002156063229.png diff --git a/umn/source/_static/images/en-us_image_0000002156063237.png b/umn/source/_static/images/en-us_image_0000002156063237.png new file mode 100644 index 0000000..e80b7fd Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156063237.png differ diff --git a/umn/source/_static/images/en-us_image_0000002156064705.png b/umn/source/_static/images/en-us_image_0000002156064705.png new file mode 100644 index 0000000..ea24224 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156064705.png differ diff --git a/umn/source/_static/images/en-us_image_0000001991770649.png b/umn/source/_static/images/en-us_image_0000002156141609.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001991770649.png rename to umn/source/_static/images/en-us_image_0000002156141609.png diff --git a/umn/source/_static/images/en-us_image_0000002156141613.png b/umn/source/_static/images/en-us_image_0000002156141613.png new file mode 100644 index 0000000..87207a2 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156141613.png differ diff --git a/umn/source/_static/images/en-us_image_0000001955571514.png b/umn/source/_static/images/en-us_image_0000002156844341.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001955571514.png rename to umn/source/_static/images/en-us_image_0000002156844341.png diff --git a/umn/source/_static/images/en-us_image_0000002156909017.png b/umn/source/_static/images/en-us_image_0000002156909017.png new file mode 100644 index 0000000..a8e4a4d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156909017.png differ diff --git a/umn/source/_static/images/en-us_image_0000002156930225.png b/umn/source/_static/images/en-us_image_0000002156930225.png new file mode 100644 index 0000000..ef66143 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156930225.png differ diff --git a/umn/source/_static/images/en-us_image_0000002156988229.png b/umn/source/_static/images/en-us_image_0000002156988229.png new file mode 100644 index 0000000..565319d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156988229.png differ diff --git a/umn/source/_static/images/en-us_image_0000002156993381.png b/umn/source/_static/images/en-us_image_0000002156993381.png new file mode 100644 index 0000000..6b5e70b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002156993381.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157055181.png b/umn/source/_static/images/en-us_image_0000002157055181.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157055181.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157056257.png b/umn/source/_static/images/en-us_image_0000002157056257.png new file mode 100644 index 0000000..9e4d9d6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157056257.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157066129.png b/umn/source/_static/images/en-us_image_0000002157066129.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157066129.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157073633.png b/umn/source/_static/images/en-us_image_0000002157073633.png new file mode 100644 index 0000000..1f8c0c1 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157073633.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157074637.png b/umn/source/_static/images/en-us_image_0000002157074637.png new file mode 100644 index 0000000..29c0d07 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157074637.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157142509.png b/umn/source/_static/images/en-us_image_0000002157142509.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157142509.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157144325.png b/umn/source/_static/images/en-us_image_0000002157144325.png new file mode 100644 index 0000000..543c529 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157144325.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157146149.png b/umn/source/_static/images/en-us_image_0000002157146149.png new file mode 100644 index 0000000..5bd14a0 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157146149.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157147725.png b/umn/source/_static/images/en-us_image_0000002157147725.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157147725.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157154517.png b/umn/source/_static/images/en-us_image_0000002157154517.png new file mode 100644 index 0000000..dd166f9 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157154517.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157176621.png b/umn/source/_static/images/en-us_image_0000002157176621.png new file mode 100644 index 0000000..a5f452b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157176621.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157176625.png b/umn/source/_static/images/en-us_image_0000002157176625.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157176625.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157176629.png b/umn/source/_static/images/en-us_image_0000002157176629.png new file mode 100644 index 0000000..1f8c0c1 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157176629.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157176633.png b/umn/source/_static/images/en-us_image_0000002157176633.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157176633.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157215021.png b/umn/source/_static/images/en-us_image_0000002157215021.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157215021.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157215025.png b/umn/source/_static/images/en-us_image_0000002157215025.png new file mode 100644 index 0000000..dd166f9 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157215025.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157215029.png b/umn/source/_static/images/en-us_image_0000002157215029.png new file mode 100644 index 0000000..331b957 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157215029.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157215033.png b/umn/source/_static/images/en-us_image_0000002157215033.png new file mode 100644 index 0000000..bd741ec Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157215033.png differ diff --git a/umn/source/_static/images/en-us_image_0000002157215037.png b/umn/source/_static/images/en-us_image_0000002157215037.png new file mode 100644 index 0000000..c7d1f3d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000002157215037.png differ diff --git a/umn/source/auditing/index.rst b/umn/source/auditing/index.rst new file mode 100644 index 0000000..d71a219 --- /dev/null +++ b/umn/source/auditing/index.rst @@ -0,0 +1,14 @@ +: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/index diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/index.rst b/umn/source/auditing/rfs_operations_supported_by_cts/index.rst new file mode 100644 index 0000000..5ae609a --- /dev/null +++ b/umn/source/auditing/rfs_operations_supported_by_cts/index.rst @@ -0,0 +1,20 @@ +:original_name: en-us_topic_0000002119244962.html + +.. _en-us_topic_0000002119244962: + +RFS Operations Supported by CTS +=============================== + +- :ref:`Scenario ` +- :ref:`Prerequisites ` +- :ref:`Supported TMS Operations ` +- :ref:`Querying Traces ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + scenario + prerequisites + supported_tms_operations + querying_traces diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/prerequisites.rst b/umn/source/auditing/rfs_operations_supported_by_cts/prerequisites.rst new file mode 100644 index 0000000..57b4cbc --- /dev/null +++ b/umn/source/auditing/rfs_operations_supported_by_cts/prerequisites.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0000002121529208.html + +.. _en-us_topic_0000002121529208: + +Prerequisites +============= + +You have enabled CTS. diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/querying_traces.rst b/umn/source/auditing/rfs_operations_supported_by_cts/querying_traces.rst new file mode 100644 index 0000000..9896d7c --- /dev/null +++ b/umn/source/auditing/rfs_operations_supported_by_cts/querying_traces.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0000002157007381.html + +.. _en-us_topic_0000002157007381: + +Querying Traces +=============== + +See \ `Querying Real-Time Traces `__\ . diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/scenario.rst b/umn/source/auditing/rfs_operations_supported_by_cts/scenario.rst new file mode 100644 index 0000000..3461c7f --- /dev/null +++ b/umn/source/auditing/rfs_operations_supported_by_cts/scenario.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0000002156928981.html + +.. _en-us_topic_0000002156928981: + +Scenario +======== + +With Cloud Trace Service (CTS), you can record operations associated with RFS for later query, audit, and backtrack operations. diff --git a/umn/source/auditing/rfs_operations_supported_by_cts/supported_tms_operations.rst b/umn/source/auditing/rfs_operations_supported_by_cts/supported_tms_operations.rst new file mode 100644 index 0000000..be52999 --- /dev/null +++ b/umn/source/auditing/rfs_operations_supported_by_cts/supported_tms_operations.rst @@ -0,0 +1,29 @@ +:original_name: en-us_topic_0000002121687316.html + +.. _en-us_topic_0000002121687316: + +Supported TMS Operations +======================== + +.. 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 + ====================== =============================== diff --git a/umn/source/change_history.rst b/umn/source/change_history.rst new file mode 100644 index 0000000..5c32723 --- /dev/null +++ b/umn/source/change_history.rst @@ -0,0 +1,12 @@ +:original_name: en-us_topic_0000002154653065.html + +.. _en-us_topic_0000002154653065: + +Change History +============== + +=========== ================================================== +Released On Description +=========== ================================================== +2024-12-14 Open Telekom Cloud Provider v1.35.13 is supported. +=========== ================================================== 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 new file mode 100644 index 0000000..acf7eb0 --- /dev/null +++ b/umn/source/faqs/how_can_i_update_a_resource_stack.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0000002154603105.html + +.. _en-us_topic_0000002154603105: + +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. 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 new file mode 100644 index 0000000..c3a7029 --- /dev/null +++ b/umn/source/faqs/how_will_i_be_charged_for_using_rfs.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0000002119244806.html + +.. _en-us_topic_0000002119244806: + +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. diff --git a/umn/source/faqs/index.rst b/umn/source/faqs/index.rst new file mode 100644 index 0000000..a7b005e --- /dev/null +++ b/umn/source/faqs/index.rst @@ -0,0 +1,18 @@ +:original_name: en-us_topic_0000002154571449.html + +.. _en-us_topic_0000002154571449: + +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? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + 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 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_creating_a_resource_stack_and_updating_a_resource_stack.rst new file mode 100644 index 0000000..1843c74 --- /dev/null +++ b/umn/source/faqs/what_are_the_differences_between_creating_an_execution_plan_creating_a_resource_stack_and_updating_a_resource_stack.rst @@ -0,0 +1,12 @@ +:original_name: en-us_topic_0000002154684701.html + +.. _en-us_topic_0000002154684701: + +What Are the Differences Between Creating an Execution Plan, Creating a Resource Stack, and Updating a Resource 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. + +**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. diff --git a/umn/source/glossary.rst b/umn/source/glossary.rst new file mode 100644 index 0000000..8147c35 --- /dev/null +++ b/umn/source/glossary.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0000002119213168.html + +.. _en-us_topic_0000002119213168: + +Glossary +======== + +For details about the glossaries in this document, see `Glossary `__. diff --git a/umn/source/resource_formation_service/iam_agency.rst b/umn/source/iam_agency.rst similarity index 65% rename from umn/source/resource_formation_service/iam_agency.rst rename to umn/source/iam_agency.rst index 340fbb2..6b29604 100644 --- a/umn/source/resource_formation_service/iam_agency.rst +++ b/umn/source/iam_agency.rst @@ -22,15 +22,14 @@ RFS uses an agency only in resource operation requests, such as creating a stack **Figure 1** Creating an agency -#. Enter an agency name. +3. Enter an agency name. - Set **Cloud Service** to **RFS**. + Set the Agency Type to Cloud Service, and set **Cloud Service** to **RFS**. - .. figure:: /_static/images/en-us_image_0000001991890869.png - :alt: **Figure 2** Creating an agency + **Figure 2** Creating an agency - **Figure 2** Creating an agency + |image1| .. caution:: @@ -38,34 +37,27 @@ RFS uses an agency only in resource operation requests, such as creating a stack If **op_svc_iac** has been used for registration, you are advised to change it to **RFS**. -#. Click **Next**. The **Authorize Agency** page is displayed. You can grant permissions to the agency on this page. - - -.. figure:: /_static/images/en-us_image_0000001991770689.png - :alt: **Figure 3** Agency authorization - - **Figure 3** Agency authorization - -#. Filter specific permissions and grant them to the agency. +4. Click **Next**. The **Authorize Agency** page is displayed. You can grant permissions to the agency on this page. Filter specific permissions and grant them to the agency. .. figure:: /_static/images/en-us_image_0000001955571534.png - :alt: **Figure 4** Selecting policies + :alt: **Figure 3** Selecting policies and roles - **Figure 4** Selecting policies + **Figure 3** Selecting policies and roles You can determine the permissions to be granted to an agency. OpenTelekom cloud best practices do not advise you to automatically create agencies with the Tenant Administrator permission for users. The best practice is to grant management permissions (including read and write operations) to resources that may be used in a stack. -#. Set the authorization scope. You can select **All resources** or **Region-specific projects**. +5. Set the authorization scope. You can select **All resources** or **Region-specific projects**. .. figure:: /_static/images/en-us_image_0000001991890873.png - :alt: **Figure 5** Authorization scope + :alt: **Figure 4** Authorization scope - **Figure 5** Authorization scope + **Figure 4** Authorization scope -#. Click **OK**. The agency is created. +6. Click **OK**. The agency is created. Now you can use it in \ :ref:`Configure the stack. `. - |image1| + |image2|\ For more information about IAM Agencies, see: `Cloud Service Agency `__. -.. |image1| image:: /_static/images/en-us_image_0000001991770693.png +.. |image1| image:: /_static/images/en-us_image_0000002156930225.png +.. |image2| image:: /_static/images/en-us_image_0000001991770693.png diff --git a/umn/source/index.rst b/umn/source/index.rst index a671799..fb1c9fb 100644 --- a/umn/source/index.rst +++ b/umn/source/index.rst @@ -5,4 +5,14 @@ Resource Formation Service - User Guide .. toctree:: :maxdepth: 1 - resource_formation_service/index + service_overview/index + managing_stacks/index + managing_templates/index + permission_management + auditing/index + quotas + iam_agency + faqs/index + change_history + glossary + managing_a_stack diff --git a/umn/source/resource_formation_service/managing_a_stack.rst b/umn/source/managing_a_stack.rst similarity index 100% rename from umn/source/resource_formation_service/managing_a_stack.rst rename to umn/source/managing_a_stack.rst diff --git a/umn/source/managing_stacks/creating_a_stack.rst b/umn/source/managing_stacks/creating_a_stack.rst new file mode 100644 index 0000000..de05348 --- /dev/null +++ b/umn/source/managing_stacks/creating_a_stack.rst @@ -0,0 +1,397 @@ +:original_name: en-us_topic_0000001955571466.html + +.. _en-us_topic_0000001955571466: + +Creating a Stack +================ + +#. Start creating a stack + + There are four ways to start creating a stack here: + + 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_0000002156043281.png + :alt: **Figure 1** Creating a stack on Dashboard + + **Figure 1** Creating a stack on Dashboard + +.. _en-us_topic_0000001955571466__fig14448537155319: + +.. figure:: /_static/images/en-us_image_0000002155961665.png + :alt: **Figure 2** Creating a stack on Stacks page + + **Figure 2** Creating a stack on Stacks page + +.. _en-us_topic_0000001955571466__fig103713552537: + +.. figure:: /_static/images/en-us_image_0000002120721540.png + :alt: **Figure 3** Creating a stack on My Templates page + + **Figure 3** Creating a stack on My Templates page + +.. _en-us_topic_0000001955571466__fig107841574534: + +.. figure:: /_static/images/en-us_image_0000002120563432.png + :alt: **Figure 4** Creating a stack on template details page + + **Figure 4** Creating a stack on template details page + +2. Select Template + + There are three ways to select a template, as shown in :ref:`#EN-US_TOPIC_0000001955571466/__d0e557 `: + + a. Select a template from **My 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. + + Then click **Next** to go to the parameter configuration page. + +.. 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. + + +.. figure:: /_static/images/en-us_image_0000002156043285.png + :alt: **Figure 5** Selecting a template + + **Figure 5** 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}" + } + } + }, + "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:: + + The sample template contains charged resources. Check whether resources need to be enabled before using the template. + +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. + +For detailed usage of other resources, please refer to `OpenTelekom Cloud Provider `__. + +3. Configure parameters + + On the parameter configuration page, you can modify the stack name and description and can configure the template parameters, as shown in :ref:`Figure Configuring parameters `. + +.. caution:: + + The stack name must start with a letter and can contain a maximum of 128 characters, including letters, digits, underscores (_), and hyphens (-). The name must be unique. + + A stack description can contain a maximum of 255 characters. + +.. _en-us_topic_0000001955571466__fig179172325107: + +.. figure:: /_static/images/en-us_image_0000002120705156.png + :alt: **Figure 6** Configuring parameters + + **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. + +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. + +.. _en-us_topic_0000001955571466__fig15774183016141: + +.. figure:: /_static/images/en-us_image_0000002156056533.png + :alt: **Figure 7** Encrypt requirements + + **Figure 7** Encrypt requirements + +If a value is invalid, the corresponding text box will turn red (as shown in :ref:`Figure 8 `) and page redirection will not be triggered after you click **Next**. + +.. _en-us_topic_0000001955571466____d0e644: + +.. figure:: /_static/images/en-us_image_0000001991770641.png + :alt: **Figure 8** Text box with an invalid value + + **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. + +Then click **Next**. The **Configure Stack** page is displayed. + +4. .. _en-us_topic_0000001955571466__li459mcpsimp: + + Configure the stack. + + Optional parameters , as shown in :ref:`Figure 9 `: + + **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 `. + + **Deletion Protection**: prevents the stack from being deleted accidentally. After a stack is created, You can modify it on the stack details page. + + **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. + + Click **Next** to go to the **Confirm Configurations** page. + + .. _en-us_topic_0000001955571466____d0e688: + + .. figure:: /_static/images/en-us_image_0000001991890825.png + :alt: **Figure 9** Configuring the stack + + **Figure 9** Configuring the stack + +5. 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: + + .. figure:: /_static/images/en-us_image_0000002156063229.png + :alt: **Figure 10** Directly deploy stack + + **Figure 10** Directly deploy stack + + a. Click **Yes**. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure 11 `. And it will redirect to the stack events page, as shown in :ref:`Figure Stack Events `. + + .. _en-us_topic_0000001955571466____d0e756: + + **Figure 11** Deployment in progress + + |image1| + + .. _en-us_topic_0000001955571466__fig173401257402: + + .. figure:: /_static/images/en-us_image_0000002120746402.png + :alt: **Figure 12** Stack Events + + **Figure 12** Stack Events + + b. Then, if everything goes well, the status changes to **Deployment Complete**, as shown in :ref:`Figure Deployment complete `. + + .. _en-us_topic_0000001955571466__fig73237820229: + + **Figure 13** Deployment complete + + |image2| + + - If you click **Create Execution Plan**, a dialog box of creating execution plan will be displayed. In this dialog box, you can set the name and description of the execution plan, as shown in :ref:`Figure Create Execution Plan dialog box `. + + .. _en-us_topic_0000001955571466__fig1032312852212: + + .. figure:: /_static/images/en-us_image_0000002156141609.png + :alt: **Figure 14** Create Execution Plan dialog box + + **Figure 14** Create Execution Plan dialog box + + .. 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 (-). + + 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 `. + + .. _en-us_topic_0000001955571466__fig432318842212: + + **Figure 15** Execution Plan Available + + |image3| + + c. Return to the stack list page. The stack status is **Creation Complete**, as shown in :ref:`Figure 16 `. + + .. _en-us_topic_0000001955571466____d0e813: + + **Figure 16** Stack list + + |image4| + + .. caution:: + + **Creating an execution plan** can preview the resource attribute changes of the entire stack and evaluate the impact. If the execution plan meets your expectations, you can execute the plan. Creating an execution plan does not incur fees. The system changes your stack only when you execute the plan. + + d. Click **Deploy** in the **Operation** column of the execution plan to deploy it, as shown in :ref:`Figure 17 `. + + .. _en-us_topic_0000001955571466____d0e835: + + .. figure:: /_static/images/en-us_image_0000002120743398.png + :alt: **Figure 17** Execution plan dialog box + + **Figure 17** Execution plan dialog box + + e. In the **Execution Plan** dialog box, click **Execute**. A message indicating that the execution plan is being deployed is displayed in the upper right corner. Return to the stack list page. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure Deployment in progress `. + + .. _en-us_topic_0000001955571466__fig65231214111516: + + .. figure:: /_static/images/en-us_image_0000002156141613.png + :alt: **Figure 18** Deployment in progress + + **Figure 18** Deployment in progress + + f. Then, the stack status changes to **Deployment Complete**, as shown in :ref:`Figure 19 `. + + .. _en-us_topic_0000001955571466____d0e866: + + **Figure 19** Deployment complete + + |image5| + + g. On the **Execution Plans** tab page of the stack details page, the execution plan status is **Applied**, as shown in :ref:`Figure 20 `. + + .. _en-us_topic_0000001955571466____d0e882: + + .. figure:: /_static/images/en-us_image_0000002120901494.png + :alt: **Figure 20** Applied + + **Figure 20** Applied + +Click the **Events** tab. The event list shows that resources of the stack are deployed, as shown in :ref:`Figure 21 `. + +.. _en-us_topic_0000001955571466____d0e895: + +**Figure 21** Resources deployed + +|image6| + +You can view additional details on the console of the corresponding cloud service.(:ref:`Figure ECS `\ shows the deployed resources on the ECS console for the above example). + +.. _en-us_topic_0000001955571466__fig1268133163913: + +.. figure:: /_static/images/en-us_image_0000002120901474.png + :alt: **Figure 22** ECS + + **Figure 22** ECS + +Resources of the stack are deployed. + +.. |image1| image:: /_static/images/en-us_image_0000002120901486.png +.. |image2| image:: /_static/images/en-us_image_0000002120743394.png +.. |image3| image:: /_static/images/en-us_image_0000002156064705.png +.. |image4| image:: /_static/images/en-us_image_0000002120745830.png +.. |image5| image:: /_static/images/en-us_image_0000002156063237.png +.. |image6| image:: /_static/images/en-us_image_0000002120743374.png 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 new file mode 100644 index 0000000..2599f55 --- /dev/null +++ b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/creating_an_execution_plan.rst @@ -0,0 +1,29 @@ +:original_name: en-us_topic_0000002121580000.html + +.. _en-us_topic_0000002121580000: + +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. + + +.. figure:: /_static/images/en-us_image_0000002121602684.png + :alt: **Figure 1** Page for creating an execution plan + + **Figure 1** Page for creating an execution plan + +The subsequent steps are the same as those for **Updating the Stack Template or its Parameters**, except for one difference that you need to click **Create Execution Plan** instead of **Directly Deploy Stack** in the Confirm Configurations step. + +Then, an execution plan is generated, but the stack is not directly deployed. If you create multiple execution plans, they will exist in the same stack, as shown in :ref:`Figure 2 `. + +.. _en-us_topic_0000002121580000____d0e1136: + +**Figure 2** Execution plan list + +|image1| + +.. |image1| image:: /_static/images/en-us_image_0000002121444564.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 new file mode 100644 index 0000000..585bff0 --- /dev/null +++ b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deleting_an_execution_plan.rst @@ -0,0 +1,19 @@ +:original_name: en-us_topic_0000002156780069.html + +.. _en-us_topic_0000002156780069: + +Deleting an Execution Plan +========================== + +If an execution plan is no longer used, click **Delete** in the **Operation** column. In the Delete Execution Plan dialog window, click OK to confirm the deletion, as shown in :ref:`Figure Deleting an execution plan `. + +.. _en-us_topic_0000002156780069____d0e1163: + +.. figure:: /_static/images/en-us_image_0000002156844341.png + :alt: **Figure 1** Deleting an execution plan + + **Figure 1** Deleting an execution plan + +.. warning:: + + Execution plans cannot be restored once deleted. Exercise caution when performing this operation. 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 new file mode 100644 index 0000000..ed9562f --- /dev/null +++ b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/deploying_an_execution_plan.rst @@ -0,0 +1,14 @@ +:original_name: en-us_topic_0000002121421892.html + +.. _en-us_topic_0000002121421892: + +Deploying an Execution Plan +=========================== + +Locate the row that contains the desired execution plan and either click Deploy in the Operation column or select it and click Deploy above the table. + +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. diff --git a/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/index.rst b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/index.rst new file mode 100644 index 0000000..a0ae8d9 --- /dev/null +++ b/umn/source/managing_stacks/creating_deploying_and_deleting_an_execution_plan/index.rst @@ -0,0 +1,18 @@ +:original_name: en-us_topic_0000001955571470.html + +.. _en-us_topic_0000001955571470: + +Creating, Deploying and Deleting an Execution Plan +================================================== + +- :ref:`Creating an Execution Plan ` +- :ref:`Deploying an Execution Plan ` +- :ref:`Deleting an Execution Plan ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_an_execution_plan + deploying_an_execution_plan + deleting_an_execution_plan diff --git a/umn/source/managing_stacks/deleting_a_stack.rst b/umn/source/managing_stacks/deleting_a_stack.rst new file mode 100644 index 0000000..632ba52 --- /dev/null +++ b/umn/source/managing_stacks/deleting_a_stack.rst @@ -0,0 +1,77 @@ +:original_name: en-us_topic_0000001991890809.html + +.. _en-us_topic_0000001991890809: + +Deleting a Stack +================ + +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. + + + .. figure:: /_static/images/en-us_image_0000002157142509.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard + +#. In the left navigation pane, choose Stacks. + + + .. figure:: /_static/images/en-us_image_0000002121742716.png + :alt: **Figure 2** RFS Stacks + + **Figure 2** RFS Stacks + +4. (Optional) Check whether the deletion protection is enabled for the stack. + + Those stacks, where the deletion protection is enabled, cannot be deleted. If you attempt to delete such stack, an error message will be displayed, as shown in :ref:`Figure Deletion failed `. + + .. _en-us_topic_0000001991890809____d0e1513: + + .. figure:: /_static/images/en-us_image_0000002121667372.png + :alt: **Figure 3** Deletion failed + + **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. + + + .. figure:: /_static/images/en-us_image_0000002156909017.png + :alt: **Figure 4** Deletion protection + + **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. + + + .. figure:: /_static/images/en-us_image_0000002121663600.png + :alt: **Figure 5** Edit basic information + + **Figure 5** Edit basic information + +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 + +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| + + 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. + +.. warning:: + + Stacks cannot be restored after being deleted. Exercise caution when performing this operation. + +.. |image1| image:: /_static/images/en-us_image_0000002156988229.png diff --git a/umn/source/managing_stacks/index.rst b/umn/source/managing_stacks/index.rst new file mode 100644 index 0000000..b80620f --- /dev/null +++ b/umn/source/managing_stacks/index.rst @@ -0,0 +1,26 @@ +:original_name: en-us_topic_0000002119213160.html + +.. _en-us_topic_0000002119213160: + +Managing Stacks +=============== + +- :ref:`Creating a Stack ` +- :ref:`Viewing Stacks ` +- :ref:`Viewing Stack Details ` +- :ref:`Modifying the basic parameters of a Stack ` +- :ref:`Updating the Stack Template or its Parameters ` +- :ref:`Creating, Deploying and Deleting an Execution Plan ` +- :ref:`Deleting a Stack ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_stack + viewing_stacks + viewing_stack_details + modifying_the_basic_parameters_of_a_stack + updating_the_stack_template_or_its_parameters + creating_deploying_and_deleting_an_execution_plan/index + deleting_a_stack 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 new file mode 100644 index 0000000..586b890 --- /dev/null +++ b/umn/source/managing_stacks/modifying_the_basic_parameters_of_a_stack.rst @@ -0,0 +1,17 @@ +:original_name: en-us_topic_0000002154604281.html + +.. _en-us_topic_0000002154604281: + +Modifying the basic parameters of a Stack +========================================= + +On the **Stack Detail** page, under **Basic Information** function module, you can click the **Edit** button in the top-right corner to edit the **Basic Information**. + +It supports changing the stack's **Agency**, modifying the stack's **Description**, as well as toggling the **Auto-Rollback** and **Deletion Protection** settings, as shown in :ref:`Figure Editing Basic Information `.After editing, click **Save** in the top-right corner. + +.. _en-us_topic_0000002154604281__fig14388172452918: + +.. figure:: /_static/images/en-us_image_0000002155949165.png + :alt: **Figure 1** Editing Basic Information + + **Figure 1** Editing Basic Information 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 new file mode 100644 index 0000000..151212c --- /dev/null +++ b/umn/source/managing_stacks/updating_the_stack_template_or_its_parameters.rst @@ -0,0 +1,49 @@ +:original_name: en-us_topic_0000001991770625.html + +.. _en-us_topic_0000001991770625: + +Updating the Stack Template or its Parameters +============================================= + +.. caution:: + + Stack change records are not available. If you want to view change details, you are recommended to create an execution plan. + +You can update the stack template or its parameters in either of the following ways: + +- 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. + + +.. figure:: /_static/images/en-us_image_0000001955571506.png + :alt: **Figure 1** Selecting a template + + **Figure 1** Selecting a template + +You can select **Current Template** or **Replace Current Template** (use a new template) to update the stack. + +Case 1: Using the current template + +#. After you select Current Template, click **Next** to go to the **Configure Parameters** page and modify parameters on it, as shown in :ref:`Figure 2 `. For further details, see \ :ref:`Creating a Stack `\ . + +.. _en-us_topic_0000001991770625____d0e1035: + +.. figure:: /_static/images/en-us_image_0000001991890845.png + :alt: **Figure 2** Configuring parameters + + **Figure 2** Configuring parameters + +2. Click **Next** to go to the **Confirm Configurations** page, as shown in :ref:`Figure 3 `. For further details, see \ :ref:`Creating a Stack `\ . + +.. _en-us_topic_0000001991770625____d0e1051: + +.. figure:: /_static/images/en-us_image_0000001991770665.png + :alt: **Figure 3** Confirming configurations + + **Figure 3** Confirming configurations + +3. Click **Directly Deploy Stack** or **Create Execution Plan**. For further details, see \ :ref:`Creating a Stack `\ . + +Case 2: Replacing the current template (see :ref:`Creating a Stack `) diff --git a/umn/source/managing_stacks/viewing_stack_details.rst b/umn/source/managing_stacks/viewing_stack_details.rst new file mode 100644 index 0000000..d045c84 --- /dev/null +++ b/umn/source/managing_stacks/viewing_stack_details.rst @@ -0,0 +1,127 @@ +:original_name: en-us_topic_0000001991770629.html + +.. _en-us_topic_0000001991770629: + +Viewing Stack Details +===================== + +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. + + + .. figure:: /_static/images/en-us_image_0000002121673112.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard + +#. In the left navigation pane, choose Stacks. + + + .. figure:: /_static/images/en-us_image_0000002156993381.png + :alt: **Figure 2** RFS Stacks + + **Figure 2** RFS Stacks + +#. 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: + +#. **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| + +#. **Resources**: displays the elements of the stack, such as applications, cloud services or resources generated during deployment, as shown in :ref:`Figure 4 `. + + .. _en-us_topic_0000001991770629____d0e1571: + + **Figure 4** Resources + + |image2| + +#. **Outputs**: displays the output parameters and their values defined in the stack template, as shown in :ref:`Figure 5 `. + + .. _en-us_topic_0000001991770629____d0e1595: + + **Figure 5** Outputs + + |image3| + +#. **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. + + For example, :ref:`Figure 6 ` shows the creation process of each resource. + + You can filter events by resource name or resource type in the top-right corner, as shown in :ref:`Figure Filter Events `. + + .. _en-us_topic_0000001991770629____d0e1583: + + **Figure 6** Events + + |image4| + + .. _en-us_topic_0000001991770629__fig1958919547213: + + .. figure:: /_static/images/en-us_image_0000002121519232.png + :alt: **Figure 7** Filter Events + + **Figure 7** Filter Events + +#. **Template**: displays the template content used for creating the stack, as shown in :ref:`Figure 8 `. + + .. _en-us_topic_0000001991770629____d0e1606: + + **Figure 8** Template + + |image5| + +#. **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 `. + + .. _en-us_topic_0000001991770629____d0e1629: + + **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 `. + + .. _en-us_topic_0000001991770629__fig17920107173512: + + .. figure:: /_static/images/en-us_image_0000002121681612.png + :alt: **Figure 10** Filter Execution plans + + **Figure 10** Filter Execution plans + + :ref:`Table 1 ` describes 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. + ==================== ================================================= + +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: + +**Figure 11** Execution plan details + +|image7| + +.. |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 diff --git a/umn/source/managing_stacks/viewing_stacks.rst b/umn/source/managing_stacks/viewing_stacks.rst new file mode 100644 index 0000000..92acd6a --- /dev/null +++ b/umn/source/managing_stacks/viewing_stacks.rst @@ -0,0 +1,35 @@ +:original_name: en-us_topic_0000002154685877.html + +.. _en-us_topic_0000002154685877: + +Viewing Stacks +============== + +By clicking on "Stacks" on the left, you can see all the stacks created under the current account, as shown in :ref:`Figure Stacks `. + +.. _en-us_topic_0000002154685877__fig198696414206: + +.. figure:: /_static/images/en-us_image_0000002155926273.png + :alt: **Figure 1** Stacks + + **Figure 1** Stacks + +:ref:`Table 1 ` describes stack statuses.. + +.. _en-us_topic_0000002154685877____d0e380: + +.. table:: **Table 1** Stack statuses + + ====================== ============================================ + Status Description + ====================== ============================================ + Creation Complete The stack has been created but not deployed. + Deployment In Progress Stack deployment is in progress. + Deployment Complete The stack has been deployed. + Deployment Failed The stack deployment failed. + Deletion In Progress Stack deletion is in progress. + Deletion Failed Stack deletion failed. + Rollback In Progress Stack rollback is in progress. + Rollback Failed Stack rollback failed. + Rollback Complete The stack has been rolled back. + ====================== ============================================ 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 new file mode 100644 index 0000000..af08453 --- /dev/null +++ b/umn/source/managing_templates/creating_a_stack_from_a_template.rst @@ -0,0 +1,48 @@ +:original_name: en-us_topic_0000002046584002.html + +.. _en-us_topic_0000002046584002: + +Creating a Stack from a Template +================================ + +RFS supports linkage between the stack and the template in console. Users can directly select templates to create and deploy a stack. + +#. Log in to the management console. + +#. In the upper left corner of the page, click hamburger icon image, and then click Management & Deployment > Resource Formation Service. + + + .. figure:: /_static/images/en-us_image_0000002157215021.png + :alt: **Figure 1** RFS Dashboard + + **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 `. + + .. _en-us_topic_0000002046584002__fig89226538129: + + **Figure 2** RFS Private Templates + + |image1| + +#. 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 `. + + .. _en-us_topic_0000002046584002__fig14609152010154: + + **Figure 3** Selecting Template + + |image3| + + Then for more details, go to :ref:`creating a stack `. + +.. caution:: + + 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 `\ . + +.. |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 diff --git a/umn/source/managing_templates/creating_a_template.rst b/umn/source/managing_templates/creating_a_template.rst new file mode 100644 index 0000000..177c4fc --- /dev/null +++ b/umn/source/managing_templates/creating_a_template.rst @@ -0,0 +1,85 @@ +:original_name: en-us_topic_0000002046740822.html + +.. _en-us_topic_0000002046740822: + +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. + + + .. figure:: /_static/images/en-us_image_0000002121900840.png + :alt: **Figure 1** RFS Dashboard + + **Figure 1** RFS Dashboard + +#. In the left navigation pane, choose Templates -> Private Templates. + + + **Figure 2** RFS Private Templates + + |image1| + +#. 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.) + + + .. figure:: /_static/images/en-us_image_0000002121900316.png + :alt: **Figure 4** Template URL + + **Figure 4** Template URL + + 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.) + + |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. + + + .. figure:: /_static/images/en-us_image_0000002157144325.png + :alt: **Figure 5** Input template + + **Figure 5** Input template + + Next, you can modify the template name, description and version description, as shown in :ref:`Figure 6 `. + + .. _en-us_topic_0000002046740822__fig197685819172: + + **Figure 6** Configuring parameters + + |image4| + + .. caution:: + + 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. + +6. Click **Create Now** to create a template, as shown in :ref:`Figure 7 `. + + .. _en-us_topic_0000002046740822__fig441630162416: + + **Figure 7** Template list + +|image5| + +.. |image1| image:: /_static/images/en-us_image_0000002157055181.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 diff --git a/umn/source/managing_templates/deleting_a_template.rst b/umn/source/managing_templates/deleting_a_template.rst new file mode 100644 index 0000000..bb54100 --- /dev/null +++ b/umn/source/managing_templates/deleting_a_template.rst @@ -0,0 +1,83 @@ +:original_name: en-us_topic_0000002082821521.html + +.. _en-us_topic_0000002082821521: + +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**: + +#. 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_0000002157215029.png + :alt: **Figure 1** RFS Dashboard + + **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 `. + + .. _en-us_topic_0000002082821521__fig89226538129: + + **Figure 2** RFS Private Templates + + |image1| + +#. Click the More->Export in the Operation column of the desired template to delete it. + + |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. + +.. _en-us_topic_0000002082821521____d0e1006: + +**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 diff --git a/umn/source/managing_templates/exporting_a_template.rst b/umn/source/managing_templates/exporting_a_template.rst new file mode 100644 index 0000000..b1897df --- /dev/null +++ b/umn/source/managing_templates/exporting_a_template.rst @@ -0,0 +1,41 @@ +:original_name: en-us_topic_0000002082662957.html + +.. _en-us_topic_0000002082662957: + +Exporting a Template +==================== + +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. + + + .. figure:: /_static/images/en-us_image_0000002121776834.png + :alt: **Figure 1** RFS Dashboard + + **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 `. + + .. _en-us_topic_0000002082662957__fig89226538129: + + **Figure 2** RFS Private Templates + + |image1| + +#. Click the More->Export in the Operation column of the desired template to replicate it. + + |image2| + + Next, the template will be automatically downloaded to the user's local area. + +.. caution:: + + The file name will be the name of the '{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 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 diff --git a/umn/source/managing_templates/index.rst b/umn/source/managing_templates/index.rst new file mode 100644 index 0000000..9d7252a --- /dev/null +++ b/umn/source/managing_templates/index.rst @@ -0,0 +1,28 @@ +:original_name: en-us_topic_0000002119371248.html + +.. _en-us_topic_0000002119371248: + +Managing Templates +================== + +- :ref:`Creating a Template ` +- :ref:`Viewing Templates ` +- :ref:`Viewing Template Details ` +- :ref:`Modifying a Template ` +- :ref:`Replicating a Template ` +- :ref:`Exporting a Template ` +- :ref:`Creating a Stack from a Template ` +- :ref:`Deleting a Template ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_template + viewing_templates + viewing_template_details + modifying_a_template + replicating_a_template + exporting_a_template + creating_a_stack_from_a_template + deleting_a_template diff --git a/umn/source/managing_templates/modifying_a_template.rst b/umn/source/managing_templates/modifying_a_template.rst new file mode 100644 index 0000000..995670f --- /dev/null +++ b/umn/source/managing_templates/modifying_a_template.rst @@ -0,0 +1,48 @@ +:original_name: en-us_topic_0000002046742302.html + +.. _en-us_topic_0000002046742302: + +Modifying a Template +==================== + +You can edit an existing template and update its content by following these 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. + + + .. figure:: /_static/images/en-us_image_0000002121754732.png + :alt: **Figure 1** RFS Dashboard + + **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 `. + + .. _en-us_topic_0000002046742302__fig89226538129: + + **Figure 2** RFS Private Templates + + |image1| + +#. 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. + + .. _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 `. + + .. _en-us_topic_0000002046742302__fig146836389569: + + **Figure 4** Saving Template + + |image3| + + .. 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 +.. |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 new file mode 100644 index 0000000..41e7afd --- /dev/null +++ b/umn/source/managing_templates/replicating_a_template.rst @@ -0,0 +1,54 @@ +:original_name: en-us_topic_0000002154685881.html + +.. _en-us_topic_0000002154685881: + +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. + + + .. figure:: /_static/images/en-us_image_0000002121934994.png + :alt: **Figure 1** RFS Dashboard + + **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 `. + + .. _en-us_topic_0000002154685881__fig89226538129: + + **Figure 2** RFS Private Templates + + |image1| + +#. Click the More->Replicate in the Operation column of the desired template to replicate it. + + |image2| + +#. Next, you can edit the template content directly on the page. And you can create, rename, and delete files and folders here. + + + **Figure 3** Edit Template Content + + |image3| + + |image4|\ Then, Click **Save Template** in the upper right corner to save this change, as shown in :ref:`Figure 4 `. + + .. _en-us_topic_0000002154685881__fig146836389569: + + **Figure 4** Saving Template + + |image5| + +#. After clicking 'Save Template', the dialog box of 'Save Template' will be displayed. In this dialog box, you can set the description and version description of the template. Then a new template will be created, you can check in by :ref:`viewing stacks `. + + |image6| + +.. |image1| image:: /_static/images/en-us_image_0000002157176633.png +.. |image2| image:: /_static/images/en-us_image_0000002157073633.png +.. |image3| image:: /_static/images/en-us_image_0000002121776826.png +.. |image4| image:: /_static/images/en-us_image_0000002157176621.png +.. |image5| image:: /_static/images/en-us_image_0000002157215025.png +.. |image6| image:: /_static/images/en-us_image_0000002157074637.png diff --git a/umn/source/managing_templates/viewing_template_details.rst b/umn/source/managing_templates/viewing_template_details.rst new file mode 100644 index 0000000..5c63838 --- /dev/null +++ b/umn/source/managing_templates/viewing_template_details.rst @@ -0,0 +1,40 @@ +:original_name: en-us_topic_0000002119404102.html + +.. _en-us_topic_0000002119404102: + +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. + + + .. figure:: /_static/images/en-us_image_0000002157147725.png + :alt: **Figure 1** RFS Dashboard + + **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 `. + + .. _en-us_topic_0000002119404102__fig89226538129: + + **Figure 2** RFS Private Templates + + |image1| + +#. Click the name of the desired template to view its details. + + .. _en-us_topic_0000002119404102__fig045261413418: + + .. figure:: /_static/images/en-us_image_0000002157146149.png + :alt: **Figure 3** Template Details + + **Figure 3** Template Details + + There are six function modules on the template details page: + + a. **Basic Information**: displays basic information about the template, such as Template Name, Template ID, Template Description etc, as shown in :ref:`Figure Template Details `. You can modify the template description here. + b. **Version Info**: displays all the version information of this template. You can preview the content of any version by clicking the preview button for that version in the content section. You can edit the template version here (which will create a new version), export and delete it (If a template has only one version and the deletion of that version will result in the deletion of the entire template), and also use the specified version of the template to directly create a stack. + +.. |image1| image:: /_static/images/en-us_image_0000002157066129.png diff --git a/umn/source/managing_templates/viewing_templates.rst b/umn/source/managing_templates/viewing_templates.rst new file mode 100644 index 0000000..d36920e --- /dev/null +++ b/umn/source/managing_templates/viewing_templates.rst @@ -0,0 +1,26 @@ +:original_name: en-us_topic_0000002119245982.html + +.. _en-us_topic_0000002119245982: + +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. + + + .. figure:: /_static/images/en-us_image_0000002121906076.png + :alt: **Figure 1** RFS Dashboard + + **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 `. + + .. _en-us_topic_0000002119245982__fig89226538129: + + **Figure 2** RFS Private Templates + + |image1| + +.. |image1| image:: /_static/images/en-us_image_0000002121747944.png diff --git a/umn/source/permission_management.rst b/umn/source/permission_management.rst new file mode 100644 index 0000000..28a8b43 --- /dev/null +++ b/umn/source/permission_management.rst @@ -0,0 +1,6 @@ +:original_name: en-us_topic_0000002154571445.html + +.. _en-us_topic_0000002154571445: + +Permission Management +===================== diff --git a/umn/source/quotas.rst b/umn/source/quotas.rst new file mode 100644 index 0000000..e5990d7 --- /dev/null +++ b/umn/source/quotas.rst @@ -0,0 +1,6 @@ +:original_name: en-us_topic_0000002119213164.html + +.. _en-us_topic_0000002119213164: + +Quotas +====== diff --git a/umn/source/resource_formation_service/auditing/index.rst b/umn/source/resource_formation_service/auditing/index.rst deleted file mode 100644 index 2e92271..0000000 --- a/umn/source/resource_formation_service/auditing/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: en-us_topic_0000001991890813.html - -.. _en-us_topic_0000001991890813: - -Auditing -======== - -- :ref:`RFS Operations Supported by CTS ` -- :ref:`Viewing RFS Logs in CTS ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - rfs_operations_supported_by_cts - viewing_rfs_logs_in_cts diff --git a/umn/source/resource_formation_service/auditing/rfs_operations_supported_by_cts.rst b/umn/source/resource_formation_service/auditing/rfs_operations_supported_by_cts.rst deleted file mode 100644 index a85b3dd..0000000 --- a/umn/source/resource_formation_service/auditing/rfs_operations_supported_by_cts.rst +++ /dev/null @@ -1,23 +0,0 @@ -:original_name: en-us_topic_0000001991770633.html - -.. _en-us_topic_0000001991770633: - -RFS Operations Supported by CTS -=============================== - -Cloud Trace Service (CTS) records all operations performed on cloud services, providing data support for customers in fault locating, resource management, and security auditing. When you enable CTS, it begins to record operations performed on RFS resources. - -.. table:: **Table 1** RFS operations supported by CTS - - ===================== =============================== - Operation Description - ===================== =============================== - createStack Creating a stack - deployStack Deploying a stack - deleteStack Deleting a stack - continueRollbackStack Continuing to roll back a stack - createExecutionPlan Creating an execution plan - applyExecutionPlan Executing an execution plan - deleteExecutionPlan Deleting an execution plan - useAgency Recording user agency - ===================== =============================== diff --git a/umn/source/resource_formation_service/auditing/viewing_rfs_logs_in_cts.rst b/umn/source/resource_formation_service/auditing/viewing_rfs_logs_in_cts.rst deleted file mode 100644 index 49b7e76..0000000 --- a/umn/source/resource_formation_service/auditing/viewing_rfs_logs_in_cts.rst +++ /dev/null @@ -1,69 +0,0 @@ -:original_name: en-us_topic_0000001955571478.html - -.. _en-us_topic_0000001955571478: - -Viewing RFS Logs in CTS -======================= - -When you enable CTS, it begins to record operations performed on RFS resources. On the CTS console, you can query operation records from the last 7 days by performing the following operations. - -Procedure ---------- - -#. Log in to the CTS console. - -#. In the navigation pane, click **Trace List**. - -#. Filter the desired operation events. - - The trace list supports four filter types: - - - **Trace Source**, **Resource Type**, and **Search By** - - Select the search criteria from the drop-down lists. For example, select **RFS** from the **Trace Source** drop-down list box. - - From the **Search By** drop-down list, select a trace name. From the **Search By** drop-down list, select or enter a specific resource ID. From the **Search By** drop-down list, select or enter a specific resource name. - - - **Trace Status**: Select one of **All trace statuses**, **Normal**, **Warning**, and **Incident**. - - - **Operator**: Select a specific operator (a user other than an account). - - - **Time Range**: You can query traces generated during any time range of the last seven days. - -#. Click |image1| on the left of a trace to expand its details. - -#. Click **View Trace** in the **Operation** column. A dialog box is displayed to show trace structure details. - - .. code-block:: - - { - "trace_id": "3f499b8b-4383-11ef-8963-376e339dc244", - "code": "200", - "trace_name": "parseTemplateVariables", - "resource_type": "template", - "trace_rating": "normal", - "source_ip": "10.206.212.216", - "domain_id": "c76728f39d95407c841f9395481207ab", - "trace_type": "ConsoleAction", - "service_type": "RF", - "event_type": "system", - "project_id": "96f0d33e74db4ed78e1c1a30e0ef793b", - "read_only": false, - "response": "{\"variables\":[{\"default\":\"rf_teststack_vpc\",\"description\":\"vpc name\",\"name\":\"vpc_name\",\"nullable\":false,\"sensitive\":true,\"type\":\"string\"},{\"default\":\"rf_teststack_subnet\",\"description\":\"subnet name\",\"name\":\"subnet_name\",\"nullable\":true,\"sensitive\":false,\"type\":\"string\"},{\"default\":\"rf_teststack_ecs\",\"description\":\"ecs name\",\"name\":\"ecs_name\",\"nullable\":true,\"sensitive\":false,\"type\":\"string\"},{\"description\":\"ecs passwd\",\"name\":\"ecs_admin_passwd\",\"nullable\":true,\"sensitive\":false,\"type\":\"string\"}]}", - "resource_id": "", - "tracker_name": "system", - "resource_account_id": "c76728f39d95407c841f9395481207ab", - "time": 1721141698198, - "resource_name": "", - "user": { - "domain": { - "name": "test", - "id": "c76728*********395481207ab" - }, - "name": "test", - "id": "a46d94423c*********f9a06051cc036" - }, - "record_time": 1721141698198 - } - -.. |image1| image:: /_static/images/en-us_image_0000001991770685.png diff --git a/umn/source/resource_formation_service/getting_started/accessing_resource_formation_service_rfs.rst b/umn/source/resource_formation_service/getting_started/accessing_resource_formation_service_rfs.rst deleted file mode 100644 index bb762fa..0000000 --- a/umn/source/resource_formation_service/getting_started/accessing_resource_formation_service_rfs.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: en-us_topic_0000001991890801.html - -.. _en-us_topic_0000001991890801: - -Accessing Resource Formation Service (RFS) -========================================== - -1. Log in to the OpenTelekomCloud Console and choose **Service List** > **Management & Governance** > **Resource Formation Service**. - -The supported OpenTelekomCloud regions for RFS are described in the following table. - -=========== =========== =========== -Site Region Name Region Code -=========== =========== =========== -OpenTelekom eu-de eu-de -=========== =========== =========== diff --git a/umn/source/resource_formation_service/getting_started/creating_a_stack.rst b/umn/source/resource_formation_service/getting_started/creating_a_stack.rst deleted file mode 100644 index ac0ce10..0000000 --- a/umn/source/resource_formation_service/getting_started/creating_a_stack.rst +++ /dev/null @@ -1,386 +0,0 @@ -:original_name: en-us_topic_0000001955571466.html - -.. _en-us_topic_0000001955571466: - -Creating a Stack -================ - -On the stack list page, click **Create Stack** in the upper right corner, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000001955571466____d0e536: - -.. figure:: /_static/images/en-us_image_0000001991770637.png - :alt: **Figure 1** Creating a stack - - **Figure 1** Creating a stack - -#. Select a template. - - There are three ways to select a template, as shown in :ref:`Figure 2 `: (1). Enter a URL of an OBS template. (2). Upload a local template file. (3). Select a template from **My Templates**. - - .. _en-us_topic_0000001955571466____d0e557: - - .. figure:: /_static/images/en-us_image_0000001955571482.png - :alt: **Figure 2** Selecting a template - - **Figure 2** Selecting a template - - The following is an example of uploading a local template file. In this example, the **ecs_test.tf.json** file is uploaded. The template content is as follows: - - { - - "terraform": { - - "required_providers": { - - "opentelekomcloud": { - - "source": "opentelekomcloud/provider/opentelekomcloud", - - "version": "1.35.13" - - } - - } - - }, - - "provider": { - - "opentelekomcloud": { - - "cloud": "otc", - - "insecure": true - - } - - }, - - "variable": { - - "vpc_name": { - - "type": "string", - - "description": "vpc name", - - "default": "rf_teststack_vpc", - - "sensitive": true, - - "nullable": false - - }, - - "subnet_name": { - - "type": "string", - - "description": "subnet name", - - "default": "rf_teststack_subnet" - - }, - - "ecs_name": { - - "type": "string", - - "description": "ecs name", - - "default": "rf_teststack_ecs" - - }, - - "ecs_admin_passwd": { - - "type": "string", - - "description": "ecs passwd" - - } - - }, - - "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_instance_v2": { - - "rf_doc_ecs": { - - "name": "${var.ecs_name}", - - "flavor_id": "c7.large.2", - - "admin_pass": "${var.ecs_admin_passwd}", - - "image_id": "cecc4bcf-b055-4d35-bd5f-693d4412eaef", - - "network": { - - "uuid": "${opentelekomcloud_vpc_subnet_v1.rf_doc_subnet.id}" - - }, - - "system_disk_type": "SAS", - - "system_disk_size": 100, - - "stop_before_destroy": false, - - "delete_disks_on_termination": true, - - "charging_mode": "postPaid", - - "auto_renew": false - - } - - } - - }, - - "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:: - - The sample template contains charged resources. Check whether resources need to be enabled before using the template. - -The template consists of five parts: - -#. **opentelekomcloud_vpc_v1** in **resource** indicates VPC information. - -#. **opentelekomcloud_vpc_subnet_v1** in **resource** indicates information about a subnet defined in the VPC. A subnet is a segment within the IP address range of the VPC. - -#. **opentelekomcloud_compute_instance_v2** in **resource** indicates information about an ECS defined in the template. - -#. **variable** indicates variables defined by users in templates during stack creation and deployment. - -#. **output** defines the outputs of templates. After a stack is created, its output is generated based on the definition and displayed on the :ref:`Outputs ` tab page. - -#. Configure parameters. - - Click **Next** to go to the parameter configuration page, where you can modify the stack name and description, as shown in :ref:`Figure 3 `. - -.. caution:: - - The stack name must start with a letter and can contain a maximum of 128 characters, including letters, digits, underscores (_), and hyphens (-). The name must be unique. - - A stack description can contain a maximum of 1024 characters. - -.. _en-us_topic_0000001955571466____d0e626: - -.. figure:: /_static/images/en-us_image_0000001991890821.png - :alt: **Figure 3** Configuring parameters - - **Figure 3** Configuring parameters - -Parameters marked with a red asterisk (``*``) are mandatory. Set these parameters to valid values. - -If a value is invalid, the corresponding text box will turn red (as shown in :ref:`Figure 4 `) and page redirection will not be triggered after you click **Next**. - -.. _en-us_topic_0000001955571466____d0e644: - -.. figure:: /_static/images/en-us_image_0000001991770641.png - :alt: **Figure 4** Text box with an invalid value - - **Figure 4** Text box with an invalid value - -Click **Next**. The **Configure Stack** page is displayed. - -.. caution:: - - If the stack name or description is imported using a URL and contains special characters, the characters must be encoded following the HTTP encoding rules first. For example, **test&123** must be converted to **test%26123**. (The same verification rules are applied to imported and manually input stack names and descriptions.) - -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. - -#. Configure the stack. - - Click **Next** to go to the **Advanced Settings** page, as shown in :ref:`Figure 5 `. - - .. _en-us_topic_0000001955571466____d0e688: - - .. figure:: /_static/images/en-us_image_0000001991890825.png - :alt: **Figure 5** Configuring the stack - - **Figure 5** Configuring the stack - - Optional parameters: - - **IAM Permission Agency**: An agency can clearly define operation permissions of RFS (such as creation, update, and deletion) on stack resources. If the agency permissions are insufficient, subsequent operations may fail. - - **Deletion Protection**: prevents the stack from being deleted accidentally. After a stack is created, you can update this configuration by clicking **Update** in the **Operation** column. - - **Auto-Rollback**: If auto-rollback is enabled, the stack automatically rolls back to the previous successful resource status when an operation fails. - - Click **Next** to go to the **Confirm Configurations** page. - -#. Confirm the configurations. - - After you confirm the configurations, you can click either **Create Execution Plan** or **Directly Deploy Stack**. - - a. If you click **Directly Deploy Stack**, a confirmation dialog box will be displayed. - - - .. figure:: /_static/images/en-us_image_0000001991770645.png - :alt: **Figure 6** Directly deploy stack - - **Figure 6** Directly deploy stack - - Click **Yes**. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure 7 `. - - .. _en-us_topic_0000001955571466____d0e756: - - .. figure:: /_static/images/en-us_image_0000001955571490.png - :alt: **Figure 7** Deployment in progress - - **Figure 7** Deployment in progress - - Then, the status changes to **Deployment Complete**, as shown in :ref:`Figure 8 `. - - .. _en-us_topic_0000001955571466____d0e768: - - .. figure:: /_static/images/en-us_image_0000001991890829.png - :alt: **Figure 8** Deployment complete - - **Figure 8** Deployment complete - - b. If you click **Create Execution Plan**, a dialog box of creating execution plan will be displayed. In this dialog box, you can set the name and description of the execution plan, as shown in :ref:`Figure 9 `. - - .. _en-us_topic_0000001955571466____d0e780: - - .. figure:: /_static/images/en-us_image_0000001991770649.png - :alt: **Figure 9** Create Execution Plan dialog box - - **Figure 9** Create Execution Plan dialog box - - Click **OK**. The **Execution Plans** tab page is displayed. - - Wait until the execution plan is created and refresh the page. The execution plan status changes to **Available**, as shown in :ref:`Figure 10 `. - - .. _en-us_topic_0000001955571466____d0e800: - - .. figure:: /_static/images/en-us_image_0000001955571494.png - :alt: **Figure 10** Available - - **Figure 10** Available - - Return to the stack list page. The stack status is **Creation Complete**, as shown in :ref:`Figure 11 `. - -.. _en-us_topic_0000001955571466____d0e813: - -.. figure:: /_static/images/en-us_image_0000001991890833.png - :alt: **Figure 11** Stack list - - **Figure 11** Stack list - -.. caution:: - - **Creating an execution plan** can preview the resource attribute changes of the entire stack and evaluate the impact. If the execution plan meets your expectations, you can execute the plan. Creating an execution plan does not incur fees. The system changes your stack only when you execute the plan. - -Click **Deploy** in the **Operation** column of the execution plan to deploy it, as shown in :ref:`Figure 12 `. - -.. _en-us_topic_0000001955571466____d0e835: - -.. figure:: /_static/images/en-us_image_0000001991770653.png - :alt: **Figure 12** Execution plan dialog box - - **Figure 12** Execution plan dialog box - -In the **Execution Plan** dialog box, click **Execute**. A message indicating that the execution plan is being deployed is displayed in the upper right corner. Return to the stack list page. A new stack is generated and its status is **Deployment In Progress**, as shown in :ref:`Figure 13 `. - -.. _en-us_topic_0000001955571466____d0e853: - -.. figure:: /_static/images/en-us_image_0000001955571498.png - :alt: **Figure 13** Deployment in progress - - **Figure 13** Deployment in progress - -Then, the stack status changes to **Deployment Complete**, as shown in :ref:`Figure 14 `. - -.. _en-us_topic_0000001955571466____d0e866: - -.. figure:: /_static/images/en-us_image_0000001991890837.png - :alt: **Figure 14** Deployment complete - - **Figure 14** Deployment complete - -On the **Execution Plans** tab page of the stack details page, the execution plan status is **Applied**, as shown in :ref:`Figure 15 `. - -.. _en-us_topic_0000001955571466____d0e882: - -.. figure:: /_static/images/en-us_image_0000001991770657.png - :alt: **Figure 15** Applied - - **Figure 15** Applied - -Click the **Events** tab. The event list shows that resources of the stack are deployed, as shown in :ref:`Figure 16 `. - -.. _en-us_topic_0000001955571466____d0e895: - -.. figure:: /_static/images/en-us_image_0000001955571502.png - :alt: **Figure 16** Resources deployed - - **Figure 16** Resources deployed - -You can view details on the console of the corresponding cloud service. - -#. In the service list, locate and click **Elastic Cloud Server**. On the displayed page, view the deployed ECS, as shown in :ref:`Figure 17 `. - - .. _en-us_topic_0000001955571466____d0e912: - - .. figure:: /_static/images/en-us_image_0000001991890841.png - :alt: **Figure 17** ECS - - **Figure 17** ECS - - Resources of the stack are deployed. diff --git a/umn/source/resource_formation_service/getting_started/creating_an_execution_plan.rst b/umn/source/resource_formation_service/getting_started/creating_an_execution_plan.rst deleted file mode 100644 index b13c235..0000000 --- a/umn/source/resource_formation_service/getting_started/creating_an_execution_plan.rst +++ /dev/null @@ -1,37 +0,0 @@ -:original_name: en-us_topic_0000001955571470.html - -.. _en-us_topic_0000001955571470: - -Creating an Execution Plan -========================== - -On the stack list page, click the name of the stack to go to its details page. Click **Update Template/Parameter** in the upper right corner to go to the page for creating an execution plan, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000001955571470____d0e1116: - -.. figure:: /_static/images/en-us_image_0000001991890849.png - :alt: **Figure 1** Page for creating an execution plan - - **Figure 1** Page for creating an execution plan - -The subsequent steps are the same as those for creating a stack, except for one difference that you need to click **Create Execution Plan** instead of **Directly Deploy Stack**. - -Then, an execution plan is generated, but the stack is not directly deployed. If you create multiple execution plans, they will exist in the same stack, as shown in :ref:`Figure 2 `. - -.. _en-us_topic_0000001955571470____d0e1136: - -.. figure:: /_static/images/en-us_image_0000001991770669.png - :alt: **Figure 2** Execution plan list - - **Figure 2** Execution plan list - -Locate the row that contains the generated execution plan and click **Deploy** in the **Operation** column if you want to deploy tour execution plan. - -If an execution plan is no longer used, click **Delete** in the **Operation** column. Click **OK** in the dialog box displayed, as shown in :ref:`Figure 3 `. - -.. _en-us_topic_0000001955571470____d0e1163: - -.. figure:: /_static/images/en-us_image_0000001955571514.png - :alt: **Figure 3** Deleting an execution plan - - **Figure 3** Deleting an execution plan diff --git a/umn/source/resource_formation_service/getting_started/deleting_a_stack.rst b/umn/source/resource_formation_service/getting_started/deleting_a_stack.rst deleted file mode 100644 index 0fa4691..0000000 --- a/umn/source/resource_formation_service/getting_started/deleting_a_stack.rst +++ /dev/null @@ -1,39 +0,0 @@ -:original_name: en-us_topic_0000001991890809.html - -.. _en-us_topic_0000001991890809: - -Deleting a Stack -================ - -1. When **Deletion Protection** is disabled: - -On the stack list page, locate the created stack and click **Delete** in the **Operation** column. In the dialog box displayed, enter **Delete** in the text box and click **OK**. - -Alternatively, go to the stack details page and click **Delete** in the upper right corner, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000001991890809____d0e1485: - -.. figure:: /_static/images/en-us_image_0000001991890853.png - :alt: **Figure 1** Dialog box for deleting a stack - - **Figure 1** Dialog box for deleting a stack - -2. When **Deletion Protection** is enabled: - -:ref:`Figure 2 ` shows that the **Enabled** status of **Deletion Protection**. - -.. _en-us_topic_0000001991890809____d0e1504: - -.. figure:: /_static/images/en-us_image_0000001991770673.png - :alt: **Figure 2** Deletion protection - - **Figure 2** Deletion protection - -If you delete a resource stack with deletion protection enabled, an error message will be displayed, as shown in :ref:`Figure 3 `. - -.. _en-us_topic_0000001991890809____d0e1513: - -.. figure:: /_static/images/en-us_image_0000001955571518.png - :alt: **Figure 3** Deletion failed - - **Figure 3** Deletion failed diff --git a/umn/source/resource_formation_service/getting_started/index.rst b/umn/source/resource_formation_service/getting_started/index.rst deleted file mode 100644 index 21c1b96..0000000 --- a/umn/source/resource_formation_service/getting_started/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -:original_name: en-us_topic_0000001955571462.html - -.. _en-us_topic_0000001955571462: - -Getting Started -=============== - -- :ref:`Accessing Resource Formation Service (RFS) ` -- :ref:`Viewing the Stack Status ` -- :ref:`Creating a Stack ` -- :ref:`Querying a Stack ` -- :ref:`Updating a Template or Parameter ` -- :ref:`Creating an Execution Plan ` -- :ref:`Deleting a Stack ` -- :ref:`Viewing Stack Details ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - accessing_resource_formation_service_rfs - viewing_the_stack_status - creating_a_stack - querying_a_stack - updating_a_template_or_parameter - creating_an_execution_plan - deleting_a_stack - viewing_stack_details diff --git a/umn/source/resource_formation_service/getting_started/querying_a_stack.rst b/umn/source/resource_formation_service/getting_started/querying_a_stack.rst deleted file mode 100644 index 1684cd9..0000000 --- a/umn/source/resource_formation_service/getting_started/querying_a_stack.rst +++ /dev/null @@ -1,17 +0,0 @@ -:original_name: en-us_topic_0000001991890805.html - -.. _en-us_topic_0000001991890805: - -Querying a Stack -================ - -Log in to the RFS console and click **Stacks** in the navigation pane on the left. The stack list page is displayed. - -In the search box above the stack list, enter the name of the target stack and click the search button, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000001991890805____d0e956: - -.. figure:: /_static/images/en-us_image_0000001991770661.png - :alt: **Figure 1** Querying a stack - - **Figure 1** Querying a stack diff --git a/umn/source/resource_formation_service/getting_started/updating_a_template_or_parameter.rst b/umn/source/resource_formation_service/getting_started/updating_a_template_or_parameter.rst deleted file mode 100644 index 001ca49..0000000 --- a/umn/source/resource_formation_service/getting_started/updating_a_template_or_parameter.rst +++ /dev/null @@ -1,54 +0,0 @@ -:original_name: en-us_topic_0000001991770625.html - -.. _en-us_topic_0000001991770625: - -Updating a Template or Parameter -================================ - -.. caution:: - - Stack change records are not available. If you want to view change details, you are recommended to create an execution plan. - -You can add cloud service resources or change resource specifications in either of the following ways: Go to the stack list page, locate the target stack, and click **Update** in the **Operation** column. Alternatively, go to the stack details page and click **Update Template/Parameter** in the upper right corner to enter the page for updating the resource stack, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000001991770625____d0e1006: - -.. figure:: /_static/images/en-us_image_0000001955571506.png - :alt: **Figure 1** Selecting a template - - **Figure 1** Selecting a template - -You can select **Current Template** or **Replace Current Template** (use a new template) to update the stack. - -Solution 1: Using the current template - -#. Click **Next** to go to the **Configure Parameters** page and modify parameters on it, as shown in :ref:`Figure 2 `. - -.. _en-us_topic_0000001991770625____d0e1035: - -.. figure:: /_static/images/en-us_image_0000001991890845.png - :alt: **Figure 2** Configuring parameters - - **Figure 2** Configuring parameters - -#. Click **Next** to go to the **Confirm Configurations** page, as shown in :ref:`Figure 3 `. - -.. _en-us_topic_0000001991770625____d0e1051: - -.. figure:: /_static/images/en-us_image_0000001991770665.png - :alt: **Figure 3** Confirming configurations - - **Figure 3** Confirming configurations - -#. Click **Directly Deploy Stack**. The **Events** page is displayed. - - The status changes to **Update Complete**, as shown in :ref:`Figure 4 `. - - .. _en-us_topic_0000001991770625____d0e1072: - - .. figure:: /_static/images/en-us_image_0000001955571510.png - :alt: **Figure 4** Update complete - - **Figure 4** Update complete - -Solution 2: Replacing the current template (see :ref:`Creating a Stack `) diff --git a/umn/source/resource_formation_service/getting_started/viewing_stack_details.rst b/umn/source/resource_formation_service/getting_started/viewing_stack_details.rst deleted file mode 100644 index 733b6fa..0000000 --- a/umn/source/resource_formation_service/getting_started/viewing_stack_details.rst +++ /dev/null @@ -1,75 +0,0 @@ -:original_name: en-us_topic_0000001991770629.html - -.. _en-us_topic_0000001991770629: - -Viewing Stack Details -===================== - -#. Viewing Stack Details - - There are six function modules on the stack details page (The stack named **stack_20240428_1517_39wa** is an example here.): - - a. **Basic Information**: displays basic information about the stack, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000001991770629____d0e1560: - -.. figure:: /_static/images/en-us_image_0000001991890857.png - :alt: **Figure 1** Basic information - - **Figure 1** Basic information - -#. **Resources**: displays information about cloud services or resources generated during plan execution and stack deployment, as shown in :ref:`Figure 2 `. - - .. _en-us_topic_0000001991770629____d0e1571: - - .. figure:: /_static/images/en-us_image_0000001991770677.png - :alt: **Figure 2** Resources - - **Figure 2** Resources - -#. **Events**: displays log information generated during plan execution and stack deployment. Events are updated in real time based on the stack status. For example, :ref:`Figure 3 ` shows that three resources are created. - - .. _en-us_topic_0000001991770629____d0e1583: - - .. figure:: /_static/images/en-us_image_0000001955571522.png - :alt: **Figure 3** Events - - **Figure 3** Events - -#. .. _en-us_topic_0000001991770629__d0e1588: - - **Outputs**: displays output parameters in the template, as shown in :ref:`Figure 4 `: - - .. _en-us_topic_0000001991770629____d0e1595: - - .. figure:: /_static/images/en-us_image_0000001991890861.png - :alt: **Figure 4** Outputs - - **Figure 4** Outputs - -#. **Template**: displays the template content used for creating a stack, as shown in :ref:`Figure 5 `. - - .. _en-us_topic_0000001991770629____d0e1606: - - .. figure:: /_static/images/en-us_image_0000001991770681.png - :alt: **Figure 5** Template - - **Figure 5** Template - -#. **Execution Plans**: displays different execution plans. After an execution plan is generated, you need to click **Deploy** to create resources in the template. After an execution plan is executed, its status changes from **Available** to **Applied** and the **Deploy** button disappears, as shown in :ref:`Figure 6 `. - - .. _en-us_topic_0000001991770629____d0e1629: - - .. figure:: /_static/images/en-us_image_0000001955571526.png - :alt: **Figure 6** Execution plans - - **Figure 6** Execution plans - - Click the execution plan name. The execution plan details page is displayed, as shown in :ref:`Figure 7 `. - - .. _en-us_topic_0000001991770629____d0e1639: - - .. figure:: /_static/images/en-us_image_0000001991890865.png - :alt: **Figure 7** Execution plan details - - **Figure 7** Execution plan details diff --git a/umn/source/resource_formation_service/getting_started/viewing_the_stack_status.rst b/umn/source/resource_formation_service/getting_started/viewing_the_stack_status.rst deleted file mode 100644 index 7587668..0000000 --- a/umn/source/resource_formation_service/getting_started/viewing_the_stack_status.rst +++ /dev/null @@ -1,43 +0,0 @@ -:original_name: en-us_topic_0000001991770621.html - -.. _en-us_topic_0000001991770621: - -Viewing the Stack Status -======================== - -You can manage stack lifecycle (such as creation, update, deletion, and query) and the lifecycle of execution plans of a stack (such as creation, deletion, and query). - -:ref:`Table 1 ` describes stack statuses. - -:ref:`Table 2 ` describes execution plan statuses. - -.. _en-us_topic_0000001991770621____d0e380: - -.. table:: **Table 1** Stack statuses - - ====================== ============================================ - Status Description - ====================== ============================================ - Creation Complete The stack has been created but not deployed. - Deployment In Progress Stack deployment is in progress. - Deployment Complete The stack has been deployed. - Deployment Failed The stack deployment failed. - Deletion In Progress Stack deletion is in progress. - Deletion Failed Stack deletion failed. - Rollback In Progress Stack rollback is in progress. - Rollback Failed Stack rollback failed. - Rollback Complete The stack has been rolled back. - ====================== ============================================ - -.. _en-us_topic_0000001991770621____d0e458: - -.. table:: **Table 2** Execution plan statuses - - ==================== ================================================= - Status Description - ==================== ================================================= - Creation In Progress Execution plan creation is in progress. - Creation Failed Execution plan creation failed. - Available The execution plan is created and to be deployed. - Applied The execution plan has been deployed. - ==================== ================================================= diff --git a/umn/source/resource_formation_service/index.rst b/umn/source/resource_formation_service/index.rst deleted file mode 100644 index f53fde8..0000000 --- a/umn/source/resource_formation_service/index.rst +++ /dev/null @@ -1,32 +0,0 @@ -:original_name: en-us_topic_0000001991770617.html - -.. _en-us_topic_0000001991770617: - -Resource Formation Service -========================== - -:ref:`Getting Started ` - -:ref:`Managing a Stack ` - -:ref:`Managing a Template ` - -:ref:`Auditing ` - -:ref:`IAM Agency ` - -- :ref:`Getting Started ` -- :ref:`Managing a Stack ` -- :ref:`Managing a Template ` -- :ref:`Auditing ` -- :ref:`IAM Agency ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - getting_started/index - managing_a_stack - managing_a_template/index - auditing/index - iam_agency diff --git a/umn/source/resource_formation_service/managing_a_template/creating_a_stack.rst b/umn/source/resource_formation_service/managing_a_template/creating_a_stack.rst deleted file mode 100644 index fdf6053..0000000 --- a/umn/source/resource_formation_service/managing_a_template/creating_a_stack.rst +++ /dev/null @@ -1,27 +0,0 @@ -:original_name: en-us_topic_0000002046584002.html - -.. _en-us_topic_0000002046584002: - -Creating a Stack -================ - -RFS supports linkage between the stack and the template in console. Users can directly select templates to create and deploy a stack. Click **Create Stack** under **Operation** column as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000002046584002____d0e1006: - -**Figure 1** Creating Stack - -|image1| - -Next, the console will then automatically jump to the creation stack and select the latest version of the current template by default as shown in :ref:`Figure 2 `. - -.. _en-us_topic_0000002046584002__fig14609152010154: - -**Figure 2** Selecting Template - -|image2| - -Next, click **Next** to continue to create stack. - -.. |image1| image:: /_static/images/en-us_image_0000002047112604.png -.. |image2| image:: /_static/images/en-us_image_0000002083156329.png diff --git a/umn/source/resource_formation_service/managing_a_template/creating_a_template.rst b/umn/source/resource_formation_service/managing_a_template/creating_a_template.rst deleted file mode 100644 index 7030a5e..0000000 --- a/umn/source/resource_formation_service/managing_a_template/creating_a_template.rst +++ /dev/null @@ -1,229 +0,0 @@ -:original_name: en-us_topic_0000002046740822.html - -.. _en-us_topic_0000002046740822: - -Creating a Template -=================== - -On the template page, click **Create Template** in the upper right corner, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000002046740822____d0e536: - -.. figure:: /_static/images/en-us_image_0000002046583090.png - :alt: **Figure 1** Creating a template - - **Figure 1** Creating a template - -#. Select a template. - - There are three ways to select a template, as shown in :ref:`Figure 2 `: (1). Enter a URL of an OBS template. (2). Upload a local template file. (3). Input templatge. - - .. _en-us_topic_0000002046740822____d0e557: - - **Figure 2** Selecting a template - - |image1| - - 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: - - { - - "terraform": { - - "required_providers": { - - "opentelekomcloud": { - - "source": "opentelekomcloud/provider/opentelekomcloud", - - "version": "1.35.13" - - } - - } - - }, - - "provider": { - - "opentelekomcloud": { - - "cloud": "otc", - - "insecure": true - - } - - }, - - "variable": { - - "vpc_name": { - - "type": "string", - - "description": "vpc name", - - "default": "rf_teststack_vpc", - - "sensitive": true, - - "nullable": false - - }, - - "subnet_name": { - - "type": "string", - - "description": "subnet name", - - "default": "rf_teststack_subnet" - - }, - - "ecs_name": { - - "type": "string", - - "description": "ecs name", - - "default": "rf_teststack_ecs" - - }, - - "ecs_admin_passwd": { - - "type": "string", - - "description": "ecs passwd" - - } - - }, - - "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_instance_v2": { - - "rf_doc_ecs": { - - "name": "${var.ecs_name}", - - "flavor_id": "c7.large.2", - - "admin_pass": "${var.ecs_admin_passwd}", - - "image_id": "cecc4bcf-b055-4d35-bd5f-693d4412eaef", - - "network": { - - "uuid": "${opentelekomcloud_vpc_subnet_v1.rf_doc_subnet.id}" - - }, - - "system_disk_type": "SAS", - - "system_disk_size": 100, - - "stop_before_destroy": false, - - "delete_disks_on_termination": true, - - "charging_mode": "postPaid", - - "auto_renew": false - - } - - } - - }, - - "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." - - } - - } - - } - - The template consists of five parts: - - a. **opentelekomcloud_vpc_v1** in **resource** indicates VPC information. - b. **opentelekomcloud_vpc_subnet_v1** in **resource** indicates information about a subnet defined in the VPC. A subnet is a segment within the IP address range of the VPC. - c. **opentelekomcloud_compute_instance_v2** in **resource** indicates information about an ECS defined in the template. - d. **variable** indicates variables defined by users in templates during stack creation and deployment. - e. **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. - - Next, you can modify the template name, description and version description, as shown in :ref:`Figure 3 `. - - .. _en-us_topic_0000002046740822__fig197685819172: - - **Figure 3** Configuring parameters - - |image2| - - .. caution:: - - 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. - -Click **Create Now** to create a template, as shown in :ref:`Figure 4 `. - -.. _en-us_topic_0000002046740822__fig441630162416: - -**Figure 4** Template list - -|image3| - -.. |image1| image:: /_static/images/en-us_image_0000002046741362.png -.. |image2| image:: /_static/images/en-us_image_0000002082662057.png -.. |image3| image:: /_static/images/en-us_image_0000002082820613.png diff --git a/umn/source/resource_formation_service/managing_a_template/deleting_a_template.rst b/umn/source/resource_formation_service/managing_a_template/deleting_a_template.rst deleted file mode 100644 index af6e1f1..0000000 --- a/umn/source/resource_formation_service/managing_a_template/deleting_a_template.rst +++ /dev/null @@ -1,25 +0,0 @@ -:original_name: en-us_topic_0000002082821521.html - -.. _en-us_topic_0000002082821521: - -Deleting a Template -=================== - -On the template list page, locate the created template and click **More** in the right under **Operation** column and click **Delete**. In the dialog box displayed, click **Yes** in the text box as shown in :ref:`Figure 1 `. Template and all versions will be deleted. - -.. _en-us_topic_0000002082821521____d0e1006: - -**Figure 1** Dialog box for deleting a stack - -|image1| - -Alternatively, go to the template details page and click **More** in the right under **Operation** column and click **Delete**, as shown in :ref:`Figure 2 `. - -.. _en-us_topic_0000002082821521__fig15352192845520: - -**Figure 2** Template details for deleting a template - -|image2| - -.. |image1| image:: /_static/images/en-us_image_0000002047151338.png -.. |image2| image:: /_static/images/en-us_image_0000002083259861.png diff --git a/umn/source/resource_formation_service/managing_a_template/editing_a_template.rst b/umn/source/resource_formation_service/managing_a_template/editing_a_template.rst deleted file mode 100644 index 1208a65..0000000 --- a/umn/source/resource_formation_service/managing_a_template/editing_a_template.rst +++ /dev/null @@ -1,34 +0,0 @@ -:original_name: en-us_topic_0000002046742302.html - -.. _en-us_topic_0000002046742302: - -Editing a Template -================== - -You can edit an existing template and update the template content. Click **Edit** in the right under operation list to enter the page for updating the template content, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000002046742302____d0e1006: - -**Figure 1** Editing a template - -|image1| - -Next, you can edit the template content directly on the page, as shown in :ref:`Figure 2 `. - -.. _en-us_topic_0000002046742302__fig2416252550: - -**Figure 2** Updating template content - -|image2| - -Then, Click **Save Template** in the upper right corner to save this change, as shown in :ref:`Figure 3 `. - -.. _en-us_topic_0000002046742302__fig146836389569: - -**Figure 3** Saving Template - -|image3| - -.. |image1| image:: /_static/images/en-us_image_0000002082672533.png -.. |image2| image:: /_static/images/en-us_image_0000002046752570.png -.. |image3| image:: /_static/images/en-us_image_0000002082673825.png diff --git a/umn/source/resource_formation_service/managing_a_template/exporting_a_template.rst b/umn/source/resource_formation_service/managing_a_template/exporting_a_template.rst deleted file mode 100644 index d84295b..0000000 --- a/umn/source/resource_formation_service/managing_a_template/exporting_a_template.rst +++ /dev/null @@ -1,22 +0,0 @@ -:original_name: en-us_topic_0000002082662957.html - -.. _en-us_topic_0000002082662957: - -Exporting a Template -==================== - -RFS support export an existing template to user local area. Click **More** in the right under **Operation** column and click **Export**, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0000002082662957____d0e1006: - -**Figure 1** Exporting a template - -|image1| - -Next, the template will be automatically downloaded to the user's local area. - -.. caution:: - - Only the latest version of the template will be exported by default - -.. |image1| image:: /_static/images/en-us_image_0000002046754798.png diff --git a/umn/source/resource_formation_service/managing_a_template/index.rst b/umn/source/resource_formation_service/managing_a_template/index.rst deleted file mode 100644 index 2df5b9c..0000000 --- a/umn/source/resource_formation_service/managing_a_template/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -:original_name: en-us_topic_0000002082819549.html - -.. _en-us_topic_0000002082819549: - -Managing a Template -=================== - -- :ref:`Creating a Template ` -- :ref:`Editing a Template ` -- :ref:`Exporting a Template ` -- :ref:`Deleting a Template ` -- :ref:`Creating a Stack ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - creating_a_template - editing_a_template - exporting_a_template - deleting_a_template - creating_a_stack diff --git a/umn/source/service_overview/accessing_rfs.rst b/umn/source/service_overview/accessing_rfs.rst new file mode 100644 index 0000000..9a4eed4 --- /dev/null +++ b/umn/source/service_overview/accessing_rfs.rst @@ -0,0 +1,20 @@ +:original_name: en-us_topic_0000002119217234.html + +.. _en-us_topic_0000002119217234: + +Accessing RFS +============= + +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. + + The RFS console is displayed. + +=========== =========== =========== +Site Region Name Region Code +=========== =========== =========== +OpenTelekom eu-de eu-de +=========== =========== =========== diff --git a/umn/source/service_overview/application_scenarios.rst b/umn/source/service_overview/application_scenarios.rst new file mode 100644 index 0000000..cf83522 --- /dev/null +++ b/umn/source/service_overview/application_scenarios.rst @@ -0,0 +1,75 @@ +:original_name: en-us_topic_0000002154657153.html + +.. _en-us_topic_0000002154657153: + +Application Scenarios +===================== + +Migrating Applications to the Cloud +----------------------------------- + +**Description** + +Migrating applications to the cloud involves repetitive manual work, such as the destruction and rebuild of environments and configuring new instances one by one when scaling out applications. These manual operations are error-prone. + +Some operations, such as creating databases or VMs, could be time-consuming. You may have to wait for a long time when these demanding operations need to be performed one by one. + +**Solution** + +RFS implements tool-based and process-based work for the preceding scenarios. It uses templates to describe resources required by applications in a unified manner. The stack management function enables automatic deployment or destruction for various resources. RFS allows you to define a large number of resource instances of different services and specifications in a template. You can also use RFS to realize automatic creation, quick deployment, and flexible configuration of resources. + +**Advantages** + +- **Easy to use** + + Design your applications and schedule resources by writing templates. Organize and manage the service easily and efficiently. + +- **Highly efficient** + + Automatically deploy or delete a template with a wizard to reduce repetitive work and manual misoperations. + +- **Quick replication of applications** + + Replicate a template to automatically deploy the same applications and resources to different data centers, improving efficiency. + + +**Figure 1** Migrating applications to the cloud + +|image1| + +ISV Resource Provisioning +------------------------- + +**Description** + +Independent software vendors (ISVs) need to deploy resources required by software on the cloud for their customers to use. The traditional delivery method is that ISVs provide the software code and platform building guides on their official websites for customers to download. This could be time demanding and costly, because ISVs have to configure networks, deliver resources, and deploy software all on themselves. + +**Solution** + +RFS enables ISVs to deliver software and required resources in a standard manner. ISVs can convert software services to templates. The stack deployment capability of RFS enables quick service provisioning and streamlines the delivery process. RFS uses a code template to describe the entire delivery environment, facilitating ISVs to integrate delivery with the CI/CD process. + +**Advantages** + +- **Standardized delivery** + + Templates and stacks standardize software delivery processes, which can be summarized into best practices for wider use. + +- **Better efficiency** + + Templates are used to automatically provision resources. ISVs only need to deploy stacks to complete service delivery, improving delivery efficiency. + +- **Error-proof creation** + + ISV software and resources required for the software are defined in a template to prevent mistakes introduced through manual work. + +- **CI/CD integration** + + RFS can be integrated into the existing tool chain to improve automation. + + +**Figure 2** ISV resource provisioning scenario + +|image2| + +.. |image1| image:: /_static/images/en-us_image_0000002119222466.png +.. |image2| image:: /_static/images/en-us_image_0000002119380574.png diff --git a/umn/source/service_overview/basic_concepts.rst b/umn/source/service_overview/basic_concepts.rst new file mode 100644 index 0000000..b37d777 --- /dev/null +++ b/umn/source/service_overview/basic_concepts.rst @@ -0,0 +1,18 @@ +:original_name: en-us_topic_0000002154575553.html + +.. _en-us_topic_0000002154575553: + +Basic Concepts +============== + ++----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Concept | Description | ++================+======================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| Resource | A cloud service may have multiple types of resources, such as VPCs, VMs, microservice applications, or high-level data models like security policies and DNS records. | ++----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Template | A template is a text file written using HCL syntax and describes your cloud resources. Its format can be tf, tf.json, or zip. RFS creates cloud resources based on templates. | ++----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Stack | A stack is a collection of cloud service resources. It creates, deletes, updates, and queries all cloud service resources described in a template as a whole. | ++----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Execution plan | An execution plan provides a preview of stack changes. It displays the comparison between the current template and online resources, and clearly shows the operations (such as addition, modification, and deletion) to be performed on resources and attributes during resource formation. Before executing a plan, you can preview it to check whether it meets your expectation. During execution, RFS creates and modifies resources as defined in the template. | ++----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/service_overview/constraints_and_limitations.rst b/umn/source/service_overview/constraints_and_limitations.rst new file mode 100644 index 0000000..b3355db --- /dev/null +++ b/umn/source/service_overview/constraints_and_limitations.rst @@ -0,0 +1,42 @@ +:original_name: en-us_topic_0000002119375338.html + +.. _en-us_topic_0000002119375338: + +Constraints and Limitations +=========================== + +Permissions +----------- + +To use RFS, :ref:`create an agency `. + +Quotas +------ + +RFS limits the number of stacks for a single user, as shown in the following table. + ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| Resource | Item | Quota | ++================+========================================================================================================================+==========================+ +| Template | Maximum number of templates that can be created by a Open Telekom Cloud account | 100 | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum length of a template name | 128 characters | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum length of a template file name | 255 bytes | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum length of a template URL | 2048 bytes | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum size of the file pointed to by the **template_uri** used in APIs for creating a template or a template version | 1 MB after decompression | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum size of the file containing **template_body** used in APIs for creating a template or template version | 50 KB | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| Stack | Maximum number of stacks that can be created by a Open Telekom Cloud account | 100 | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Timeout interval for creating a stack | 6 hours | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum length of a stack name | 128 characters | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| Execution plan | Maximum length of an execution plan name | 255 bytes | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ +| | Maximum number of execution plans that can be created in each stack | 100 | ++----------------+------------------------------------------------------------------------------------------------------------------------+--------------------------+ diff --git a/umn/source/service_overview/index.rst b/umn/source/service_overview/index.rst new file mode 100644 index 0000000..0e0cd1f --- /dev/null +++ b/umn/source/service_overview/index.rst @@ -0,0 +1,30 @@ +:original_name: en-us_topic_0000001991770617.html + +.. _en-us_topic_0000001991770617: + +Service Overview +================ + +- :ref:`Basic Concepts ` +- :ref:`What Is RFS? ` +- :ref:`Product Advantages ` +- :ref:`Region and AZ ` +- :ref:`Application Scenarios ` +- :ref:`RFS and Other Services ` +- :ref:`Constraints and Limitations ` +- :ref:`Accessing RFS ` +- :ref:`Permission ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + basic_concepts + what_is_rfs + product_advantages + region_and_az + application_scenarios + rfs_and_other_services + constraints_and_limitations + accessing_rfs + permission diff --git a/umn/source/service_overview/permission.rst b/umn/source/service_overview/permission.rst new file mode 100644 index 0000000..fa1bcf3 --- /dev/null +++ b/umn/source/service_overview/permission.rst @@ -0,0 +1,162 @@ +:original_name: en-us_topic_0000002154657157.html + +.. _en-us_topic_0000002154657157: + +Permission +========== + +By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions. + +RFS is a project-level service accessed in specific physical regions. To assign RFS permissions to a user group, specify the scope as region-specific projects and select projects for the permissions to take effect. If **All projects** is selected, the permissions will take effect for the user group in all region-specific projects. When accessing RFS, the users need to switch to a region where they have been authorized to use this service. + +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 + + +------------------------------------+------------------------------------------------------------------------------------------+---------------------+ + | 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*" + ] + } + ] + } + +: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 | + +----------------------------------------+------------------------------------+---------------+-------------------+-----------------------+---------------------+ diff --git a/umn/source/service_overview/product_advantages.rst b/umn/source/service_overview/product_advantages.rst new file mode 100644 index 0000000..8ab04f3 --- /dev/null +++ b/umn/source/service_overview/product_advantages.rst @@ -0,0 +1,20 @@ +:original_name: en-us_topic_0000002119375334.html + +.. _en-us_topic_0000002119375334: + +Product Advantages +================== + +**Declarative:** You only need to intuitively describe the final state of required resources, freeing you from the complex request process and simplifying resource management. + +**Idempotent:** The idempotent effect of invoking the resource description code for multiple times ensures that resources are not repeatedly applied for. + +**Secure and reliable:** Visualized audit, security, and compliance control policies prevent security risks caused by resource changes. + +**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. + +**Full hosting and cloud-based services:** You do not need to install any software, prepare executors, or manage underlying files and data. + +**Automatic rollback:** If deployment fails for resources, RFS automatically returns the status of all resources to that of the previous successful deployment. diff --git a/umn/source/service_overview/region_and_az.rst b/umn/source/service_overview/region_and_az.rst new file mode 100644 index 0000000..dafeb13 --- /dev/null +++ b/umn/source/service_overview/region_and_az.rst @@ -0,0 +1,6 @@ +:original_name: en-us_topic_0000002119217230.html + +.. _en-us_topic_0000002119217230: + +Region and AZ +============= diff --git a/umn/source/service_overview/rfs_and_other_services.rst b/umn/source/service_overview/rfs_and_other_services.rst new file mode 100644 index 0000000..5f1d63c --- /dev/null +++ b/umn/source/service_overview/rfs_and_other_services.rst @@ -0,0 +1,6 @@ +:original_name: en-us_topic_0000002154575557.html + +.. _en-us_topic_0000002154575557: + +RFS and Other Services +====================== diff --git a/umn/source/service_overview/what_is_rfs.rst b/umn/source/service_overview/what_is_rfs.rst new file mode 100644 index 0000000..3733cb6 --- /dev/null +++ b/umn/source/service_overview/what_is_rfs.rst @@ -0,0 +1,10 @@ +:original_name: en-us_topic_0000002154657149.html + +.. _en-us_topic_0000002154657149: + +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. + +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.