diff --git a/umn/source/_static/images/en-us_image_0284275232.png b/umn/source/_static/images/en-us_image_0000001095974032.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275232.png rename to umn/source/_static/images/en-us_image_0000001095974032.png diff --git a/umn/source/_static/images/en-us_image_0000001095974034.png b/umn/source/_static/images/en-us_image_0000001095974034.png new file mode 100644 index 0000000..602fca1 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001095974034.png differ diff --git a/umn/source/_static/images/en-us_image_0000001095974038.png b/umn/source/_static/images/en-us_image_0000001095974038.png new file mode 100644 index 0000000..149fbd8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001095974038.png differ diff --git a/umn/source/_static/images/en-us_image_0000001095974050.png b/umn/source/_static/images/en-us_image_0000001095974050.png new file mode 100644 index 0000000..6bd6ebf Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001095974050.png differ diff --git a/umn/source/_static/images/en-us_image_0284275046.png b/umn/source/_static/images/en-us_image_0000001095974074.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275046.png rename to umn/source/_static/images/en-us_image_0000001095974074.png diff --git a/umn/source/_static/images/en-us_image_0284275075.png b/umn/source/_static/images/en-us_image_0000001095974076.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275075.png rename to umn/source/_static/images/en-us_image_0000001095974076.png diff --git a/umn/source/_static/images/en-us_image_0000001095974104.png b/umn/source/_static/images/en-us_image_0000001095974104.png new file mode 100644 index 0000000..670c402 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001095974104.png differ diff --git a/umn/source/_static/images/en-us_image_0000001095974106.png b/umn/source/_static/images/en-us_image_0000001095974106.png new file mode 100644 index 0000000..cb13f7b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001095974106.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096133860.png b/umn/source/_static/images/en-us_image_0000001096133860.png new file mode 100644 index 0000000..149fbd8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096133860.png differ diff --git a/umn/source/_static/images/en-us_image_0284275280.png b/umn/source/_static/images/en-us_image_0000001096133868.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275280.png rename to umn/source/_static/images/en-us_image_0000001096133868.png diff --git a/umn/source/_static/images/en-us_image_0284275219.png b/umn/source/_static/images/en-us_image_0000001096133880.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275219.png rename to umn/source/_static/images/en-us_image_0000001096133880.png diff --git a/umn/source/_static/images/en-us_image_0284275173.png b/umn/source/_static/images/en-us_image_0000001096133892.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275173.png rename to umn/source/_static/images/en-us_image_0000001096133892.png diff --git a/umn/source/_static/images/en-us_image_0000001096133894.png b/umn/source/_static/images/en-us_image_0000001096133894.png new file mode 100644 index 0000000..6bd6ebf Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096133894.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096133896.png b/umn/source/_static/images/en-us_image_0000001096133896.png new file mode 100644 index 0000000..62e9a46 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096133896.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096133902.png b/umn/source/_static/images/en-us_image_0000001096133902.png new file mode 100644 index 0000000..851e7d6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096133902.png differ diff --git a/umn/source/_static/images/en-us_image_0284275079.png b/umn/source/_static/images/en-us_image_0000001096133908.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275079.png rename to umn/source/_static/images/en-us_image_0000001096133908.png diff --git a/umn/source/_static/images/en-us_image_0284274943.png b/umn/source/_static/images/en-us_image_0000001096133910.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284274943.png rename to umn/source/_static/images/en-us_image_0000001096133910.png diff --git a/umn/source/_static/images/en-us_image_0284274981.png b/umn/source/_static/images/en-us_image_0000001096133912.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284274981.png rename to umn/source/_static/images/en-us_image_0000001096133912.png diff --git a/umn/source/_static/images/en-us_image_0284275018.png b/umn/source/_static/images/en-us_image_0000001096133926.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275018.png rename to umn/source/_static/images/en-us_image_0000001096133926.png diff --git a/umn/source/_static/images/en-us_image_0000001096133932.png b/umn/source/_static/images/en-us_image_0000001096133932.png new file mode 100644 index 0000000..2480f08 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096133932.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096293844.png b/umn/source/_static/images/en-us_image_0000001096293844.png new file mode 100644 index 0000000..602fca1 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096293844.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096293846.png b/umn/source/_static/images/en-us_image_0000001096293846.png new file mode 100644 index 0000000..6bd6ebf Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096293846.png differ diff --git a/umn/source/_static/images/en-us_image_0284275172.png b/umn/source/_static/images/en-us_image_0000001096293848.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275172.png rename to umn/source/_static/images/en-us_image_0000001096293848.png diff --git a/umn/source/_static/images/en-us_image_0284275249.png b/umn/source/_static/images/en-us_image_0000001096293854.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275249.png rename to umn/source/_static/images/en-us_image_0000001096293854.png diff --git a/umn/source/_static/images/en-us_image_0000001096293856.png b/umn/source/_static/images/en-us_image_0000001096293856.png new file mode 100644 index 0000000..90425eb Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096293856.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096293872.png b/umn/source/_static/images/en-us_image_0000001096293872.png new file mode 100644 index 0000000..670c402 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096293872.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096293880.png b/umn/source/_static/images/en-us_image_0000001096293880.png new file mode 100644 index 0000000..6bd6ebf Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096293880.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096453840.png b/umn/source/_static/images/en-us_image_0000001096453840.png new file mode 100644 index 0000000..a80ad72 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096453840.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096453842.png b/umn/source/_static/images/en-us_image_0000001096453842.png new file mode 100644 index 0000000..a80ad72 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096453842.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096453848.png b/umn/source/_static/images/en-us_image_0000001096453848.png new file mode 100644 index 0000000..7e9d2d8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096453848.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096453856.png b/umn/source/_static/images/en-us_image_0000001096453856.png new file mode 100644 index 0000000..851e7d6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096453856.png differ diff --git a/umn/source/_static/images/en-us_image_0284275038.png b/umn/source/_static/images/en-us_image_0000001096453866.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275038.png rename to umn/source/_static/images/en-us_image_0000001096453866.png diff --git a/umn/source/_static/images/en-us_image_0284274973.png b/umn/source/_static/images/en-us_image_0000001096453870.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284274973.png rename to umn/source/_static/images/en-us_image_0000001096453870.png diff --git a/umn/source/_static/images/en-us_image_0000001096453876.png b/umn/source/_static/images/en-us_image_0000001096453876.png new file mode 100644 index 0000000..8cea5d7 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096453876.png differ diff --git a/umn/source/_static/images/en-us_image_0000001096453878.png b/umn/source/_static/images/en-us_image_0000001096453878.png new file mode 100644 index 0000000..b2c33a5 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096453878.png differ diff --git a/umn/source/_static/images/en-us_image_0284275085.png b/umn/source/_static/images/en-us_image_0000001096453886.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275085.png rename to umn/source/_static/images/en-us_image_0000001096453886.png diff --git a/umn/source/_static/images/en-us_image_0000001096453892.png b/umn/source/_static/images/en-us_image_0000001096453892.png new file mode 100644 index 0000000..7c24340 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001096453892.png differ diff --git a/umn/source/_static/images/en-us_image_0284275178.png b/umn/source/_static/images/en-us_image_0000001096453900.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275178.png rename to umn/source/_static/images/en-us_image_0000001096453900.png diff --git a/umn/source/_static/images/en-us_image_0000001142773895.png b/umn/source/_static/images/en-us_image_0000001142773895.png new file mode 100644 index 0000000..62e9a46 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142773895.png differ diff --git a/umn/source/_static/images/en-us_image_0000001142773899.png b/umn/source/_static/images/en-us_image_0000001142773899.png new file mode 100644 index 0000000..62e9a46 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142773899.png differ diff --git a/umn/source/_static/images/en-us_image_0284274974.png b/umn/source/_static/images/en-us_image_0000001142773901.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284274974.png rename to umn/source/_static/images/en-us_image_0000001142773901.png diff --git a/umn/source/_static/images/en-us_image_0000001142773903.png b/umn/source/_static/images/en-us_image_0000001142773903.png new file mode 100644 index 0000000..4079a9b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142773903.png differ diff --git a/umn/source/_static/images/en-us_image_0000001142773909.png b/umn/source/_static/images/en-us_image_0000001142773909.png new file mode 100644 index 0000000..4079a9b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142773909.png differ diff --git a/umn/source/_static/images/en-us_image_0000001142773911.png b/umn/source/_static/images/en-us_image_0000001142773911.png new file mode 100644 index 0000000..753ff78 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142773911.png differ diff --git a/umn/source/_static/images/en-us_image_0000001142773917.png b/umn/source/_static/images/en-us_image_0000001142773917.png new file mode 100644 index 0000000..62e9a46 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142773917.png differ diff --git a/umn/source/_static/images/en-us_image_0284275120.png b/umn/source/_static/images/en-us_image_0000001142773925.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275120.png rename to umn/source/_static/images/en-us_image_0000001142773925.png diff --git a/umn/source/_static/images/en-us_image_0284275119.png b/umn/source/_static/images/en-us_image_0000001142773933.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275119.png rename to umn/source/_static/images/en-us_image_0000001142773933.png diff --git a/umn/source/_static/images/en-us_image_0000001142773935.png b/umn/source/_static/images/en-us_image_0000001142773935.png new file mode 100644 index 0000000..b2c33a5 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142773935.png differ diff --git a/umn/source/_static/images/en-us_image_0000001142773955.png b/umn/source/_static/images/en-us_image_0000001142773955.png new file mode 100644 index 0000000..851e7d6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142773955.png differ diff --git a/umn/source/_static/images/en-us_image_0284275185.png b/umn/source/_static/images/en-us_image_0000001142773957.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275185.png rename to umn/source/_static/images/en-us_image_0000001142773957.png diff --git a/umn/source/_static/images/en-us_image_0271515222.png b/umn/source/_static/images/en-us_image_0000001142773959.png similarity index 100% rename from umn/source/_static/images/en-us_image_0271515222.png rename to umn/source/_static/images/en-us_image_0000001142773959.png diff --git a/umn/source/_static/images/en-us_image_0000001142893853.png b/umn/source/_static/images/en-us_image_0000001142893853.png new file mode 100644 index 0000000..6bd6ebf Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142893853.png differ diff --git a/umn/source/_static/images/en-us_image_0000001142893865.png b/umn/source/_static/images/en-us_image_0000001142893865.png new file mode 100644 index 0000000..90425eb Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142893865.png differ diff --git a/umn/source/_static/images/en-us_image_0269983210.png b/umn/source/_static/images/en-us_image_0000001142893879.png similarity index 100% rename from umn/source/_static/images/en-us_image_0269983210.png rename to umn/source/_static/images/en-us_image_0000001142893879.png diff --git a/umn/source/_static/images/en-us_image_0000001142893889.png b/umn/source/_static/images/en-us_image_0000001142893889.png new file mode 100644 index 0000000..6639c73 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142893889.png differ diff --git a/umn/source/_static/images/en-us_image_0284274985.png b/umn/source/_static/images/en-us_image_0000001142893899.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284274985.png rename to umn/source/_static/images/en-us_image_0000001142893899.png diff --git a/umn/source/_static/images/en-us_image_0271492125.png b/umn/source/_static/images/en-us_image_0000001142893907.png similarity index 100% rename from umn/source/_static/images/en-us_image_0271492125.png rename to umn/source/_static/images/en-us_image_0000001142893907.png diff --git a/umn/source/_static/images/en-us_image_0284275230.png b/umn/source/_static/images/en-us_image_0000001142893909.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275230.png rename to umn/source/_static/images/en-us_image_0000001142893909.png diff --git a/umn/source/_static/images/en-us_image_0000001142893921.png b/umn/source/_static/images/en-us_image_0000001142893921.png new file mode 100644 index 0000000..5d7e29c Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001142893921.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143053799.png b/umn/source/_static/images/en-us_image_0000001143053799.png new file mode 100644 index 0000000..851e7d6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053799.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143053801.png b/umn/source/_static/images/en-us_image_0000001143053801.png new file mode 100644 index 0000000..851e7d6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053801.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143053813.png b/umn/source/_static/images/en-us_image_0000001143053813.png new file mode 100644 index 0000000..7e9d2d8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053813.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143053817.png b/umn/source/_static/images/en-us_image_0000001143053817.png new file mode 100644 index 0000000..6bd6ebf Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053817.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143053819.png b/umn/source/_static/images/en-us_image_0000001143053819.png new file mode 100644 index 0000000..62e9a46 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053819.png differ diff --git a/umn/source/_static/images/en-us_image_0271515223.png b/umn/source/_static/images/en-us_image_0000001143053823.png similarity index 100% rename from umn/source/_static/images/en-us_image_0271515223.png rename to umn/source/_static/images/en-us_image_0000001143053823.png diff --git a/umn/source/_static/images/en-us_image_0000001143053829.png b/umn/source/_static/images/en-us_image_0000001143053829.png new file mode 100644 index 0000000..01bbfe6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053829.png differ diff --git a/umn/source/_static/images/en-us_image_0284275122.png b/umn/source/_static/images/en-us_image_0000001143053837.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275122.png rename to umn/source/_static/images/en-us_image_0000001143053837.png diff --git a/umn/source/_static/images/en-us_image_0000001143053839.png b/umn/source/_static/images/en-us_image_0000001143053839.png new file mode 100644 index 0000000..8cea5d7 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053839.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143053843.png b/umn/source/_static/images/en-us_image_0000001143053843.png new file mode 100644 index 0000000..670c402 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053843.png differ diff --git a/umn/source/_static/images/en-us_image_0284275307.png b/umn/source/_static/images/en-us_image_0000001143053849.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275307.png rename to umn/source/_static/images/en-us_image_0000001143053849.png diff --git a/umn/source/_static/images/en-us_image_0000001143053853.png b/umn/source/_static/images/en-us_image_0000001143053853.png new file mode 100644 index 0000000..aa2b82d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053853.png differ diff --git a/umn/source/_static/images/en-us_image_0284275146.png b/umn/source/_static/images/en-us_image_0000001143053861.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275146.png rename to umn/source/_static/images/en-us_image_0000001143053861.png diff --git a/umn/source/_static/images/en-us_image_0000001143053863.png b/umn/source/_static/images/en-us_image_0000001143053863.png new file mode 100644 index 0000000..3840f49 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143053863.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143133809.png b/umn/source/_static/images/en-us_image_0000001143133809.png new file mode 100644 index 0000000..851e7d6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133809.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143133815.png b/umn/source/_static/images/en-us_image_0000001143133815.png new file mode 100644 index 0000000..753ff78 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133815.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143133823.png b/umn/source/_static/images/en-us_image_0000001143133823.png new file mode 100644 index 0000000..7f4e9b8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133823.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143133827.png b/umn/source/_static/images/en-us_image_0000001143133827.png new file mode 100644 index 0000000..aa2b82d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133827.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143133833.png b/umn/source/_static/images/en-us_image_0000001143133833.png new file mode 100644 index 0000000..62e9a46 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133833.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143133835.png b/umn/source/_static/images/en-us_image_0000001143133835.png new file mode 100644 index 0000000..4079a9b Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133835.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143133837.png b/umn/source/_static/images/en-us_image_0000001143133837.png new file mode 100644 index 0000000..851e7d6 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133837.png differ diff --git a/umn/source/_static/images/en-us_image_0000001143133839.png b/umn/source/_static/images/en-us_image_0000001143133839.png new file mode 100644 index 0000000..6639c73 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133839.png differ diff --git a/umn/source/_static/images/en-us_image_0284274967.png b/umn/source/_static/images/en-us_image_0000001143133849.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284274967.png rename to umn/source/_static/images/en-us_image_0000001143133849.png diff --git a/umn/source/_static/images/en-us_image_0000001143133859.png b/umn/source/_static/images/en-us_image_0000001143133859.png new file mode 100644 index 0000000..ad79b27 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001143133859.png differ diff --git a/umn/source/_static/images/en-us_image_0000001193533703.png b/umn/source/_static/images/en-us_image_0000001193533703.png new file mode 100644 index 0000000..aa2b82d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001193533703.png differ diff --git a/umn/source/_static/images/en-us_image_0000001193610755.png b/umn/source/_static/images/en-us_image_0000001193610755.png new file mode 100644 index 0000000..aa2b82d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001193610755.png differ diff --git a/umn/source/_static/images/en-us_image_0284275286.png b/umn/source/_static/images/en-us_image_0000001224411716.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275286.png rename to umn/source/_static/images/en-us_image_0000001224411716.png diff --git a/umn/source/_static/images/en-us_image_0000001224531664.png b/umn/source/_static/images/en-us_image_0000001224531664.png new file mode 100644 index 0000000..4b159e1 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001224531664.png differ diff --git a/umn/source/_static/images/en-us_image_0284275295.png b/umn/source/_static/images/en-us_image_0000001236135268.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275295.png rename to umn/source/_static/images/en-us_image_0000001236135268.png diff --git a/umn/source/_static/images/en-us_image_0000001236447314.png b/umn/source/_static/images/en-us_image_0000001236447314.png new file mode 100644 index 0000000..aa2b82d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001236447314.png differ diff --git a/umn/source/_static/images/en-us_image_0284275118.png b/umn/source/_static/images/en-us_image_0000001268771757.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275118.png rename to umn/source/_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/_static/images/en-us_image_0000001269051821.png b/umn/source/_static/images/en-us_image_0000001269051821.png new file mode 100644 index 0000000..62f127d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001269051821.png differ diff --git a/umn/source/_static/images/en-us_image_0000001280327773.png b/umn/source/_static/images/en-us_image_0000001280327773.png new file mode 100644 index 0000000..aa2b82d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001280327773.png differ diff --git a/umn/source/_static/images/en-us_image_0284275123.png b/umn/source/_static/images/en-us_image_0000001280455205.png similarity index 100% rename from umn/source/_static/images/en-us_image_0284275123.png rename to umn/source/_static/images/en-us_image_0000001280455205.png diff --git a/umn/source/_static/images/en-us_image_0000001490031014.png b/umn/source/_static/images/en-us_image_0000001490031014.png new file mode 100644 index 0000000..5b1e4ce Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001490031014.png differ diff --git a/umn/source/_static/images/en-us_image_0284274979.png b/umn/source/_static/images/en-us_image_0284274979.png deleted file mode 100644 index 7cabd61..0000000 Binary files a/umn/source/_static/images/en-us_image_0284274979.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284274989.png b/umn/source/_static/images/en-us_image_0284274989.png deleted file mode 100644 index 9735874..0000000 Binary files a/umn/source/_static/images/en-us_image_0284274989.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275009.png b/umn/source/_static/images/en-us_image_0284275009.png deleted file mode 100644 index 9735874..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275009.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275043.png b/umn/source/_static/images/en-us_image_0284275043.png deleted file mode 100644 index 30c3d92..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275043.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275089.png b/umn/source/_static/images/en-us_image_0284275089.png deleted file mode 100644 index b26f87f..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275089.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275156.png b/umn/source/_static/images/en-us_image_0284275156.png deleted file mode 100644 index 1909444..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275156.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275158.png b/umn/source/_static/images/en-us_image_0284275158.png deleted file mode 100644 index 680a1e3..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275158.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275220.png b/umn/source/_static/images/en-us_image_0284275220.png deleted file mode 100644 index 9735874..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275220.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275243.png b/umn/source/_static/images/en-us_image_0284275243.png deleted file mode 100644 index 30c3d92..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275243.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275259.png b/umn/source/_static/images/en-us_image_0284275259.png deleted file mode 100644 index b7fd23a..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275259.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275268.png b/umn/source/_static/images/en-us_image_0284275268.png deleted file mode 100644 index 247a08a..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275268.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275296.png b/umn/source/_static/images/en-us_image_0284275296.png deleted file mode 100644 index 9735874..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275296.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0284275300.png b/umn/source/_static/images/en-us_image_0284275300.png deleted file mode 100644 index 9735874..0000000 Binary files a/umn/source/_static/images/en-us_image_0284275300.png and /dev/null differ diff --git a/umn/source/account_management/creating_a_database_account_using_commands.rst b/umn/source/account_management/creating_a_database_account_using_commands.rst new file mode 100644 index 0000000..52485f3 --- /dev/null +++ b/umn/source/account_management/creating_a_database_account_using_commands.rst @@ -0,0 +1,114 @@ +:original_name: dds_03_0057.html + +.. _dds_03_0057: + +Creating a Database Account Using Commands +========================================== + +Scenarios +--------- + +This section describes how to create a database account and change the account password using commands after the DDS DB instances are created. + +.. note:: + + When creating a database account for a specified DB instance, you are advised to enable the SSL connection to improve data security. + +**Prerequisites** +----------------- + +A DDS DB instance has been connected. + +- For details on how to connect to a cluster instance, see :ref:`Connecting to a Cluster Instance Over Private Networks `. +- For details on how to connect to a replica set instance, see :ref:`Connecting to a Replica Set Instance Over Private Networks `. +- For details on how to connect to a single node instance, see :ref:`Connecting to a Single Node Instance Over Private Networks `. + +Account Description +------------------- + +To manage DDS DB instances, users **root**, **monitor**, and **backup** are automatically created when you create a DDS DB instance. Attempting to delete, rename, change the passwords, or change privileges for these accounts will result in errors. + +You can change the password of the database administrator **rwuser** and any accounts you create. + +Setting Password Strength for Database Accounts +----------------------------------------------- + +- The administrator password must meet the following password policy: + + - Contains 8 to 32 characters. + - Must be a combination of uppercase letters, lowercase letters, digits, and special characters: ``~!@#%^*-_=+?`` + +- The database user created on the client must meet the following password policy: + + - Contains 8 to 32 characters. + - Must be a combination of uppercase letters, lowercase letters, digits, and special characters: ``~@#%-_!*+=^?`` + +When you create a DB instance, DDS automatically checks your password strength. You can change the password as user **rwuser**. For security reasons, you are advised to set up a strong password. + +Creating an Account +------------------- + +#. Log in to the DDS. + +#. Run the following command to select the admin database: + + **use admin** + +#. Run the following command to create a database account (**user1** as an example): + + **db.createUser({user: "user1", pwd: "**\ ``**********``\ **", passwordDigestor:"server", roles:[{role: "root", db: "admin"}]})** + + - **server**: indicates that the password is encrypted on the server. + - **roles** restrict the rights of the account. If an empty array is specified, the account does not have any permission. + +#. Check the result: + + The account is successfully created if the following information is displayed: + + .. code-block:: + + Successfully added user: { + "user" : "user1", + "passwordDigestor" : "server", + "roles" : [ + { + "role" : "root", + "db" : "admin" + } + ] + } + +Changing a Password +------------------- + +#. Log in to the DDS. + +#. Run the following command to select the admin database: + + **use admin** + +#. Uses user **user1** as an example. Run the following command to change its password: + + **db.updateUser("user1", {passwordDigestor:"server",pwd:"**********"})** + + **server**: indicates that the password is encrypted on the server. + +#. Check the setting result. The password is successfully changed if the following information is displayed: + + - Cluster + + .. code-block:: + + mongos> + + - Replica set + + .. code-block:: + + replica:PRIMARY> + + - Single node + + .. code-block:: + + replica:PRIMARY> diff --git a/umn/source/account_management/index.rst b/umn/source/account_management/index.rst new file mode 100644 index 0000000..6a0daa5 --- /dev/null +++ b/umn/source/account_management/index.rst @@ -0,0 +1,16 @@ +:original_name: dds_03_0001.html + +.. _dds_03_0001: + +Account Management +================== + +- :ref:`Creating a Database Account Using Commands ` +- :ref:`Resetting the Administrator Password ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_database_account_using_commands + resetting_the_administrator_password diff --git a/umn/source/managing_dds_db_instances/security/resetting_the_administrator_password.rst b/umn/source/account_management/resetting_the_administrator_password.rst similarity index 54% rename from umn/source/managing_dds_db_instances/security/resetting_the_administrator_password.rst rename to umn/source/account_management/resetting_the_administrator_password.rst index 9d8f07b..abfcef2 100644 --- a/umn/source/managing_dds_db_instances/security/resetting_the_administrator_password.rst +++ b/umn/source/account_management/resetting_the_administrator_password.rst @@ -1,6 +1,6 @@ -:original_name: en-us_topic_reset_password.html +:original_name: dds_03_reset_password.html -.. _en-us_topic_reset_password: +.. _dds_03_reset_password: Resetting the Administrator Password ==================================== @@ -8,7 +8,9 @@ Resetting the Administrator Password **Scenarios** ------------- -You are advised to change administrator passwords periodically to prevent password cracking, ensuring system security. You cannot reset the administrator password under the following circumstances: +For security reasons, you are advised to periodically change administrator passwords. + +You cannot reset the administrator password under the following circumstances: - Restarting - Adding node @@ -26,7 +28,7 @@ Method 1 #. Enter and confirm the new administrator password and click **OK**. - The password is a string of 8 to 32 characters. It must be a combination of uppercase letters, lowercase letters, digits, and special characters. You can also use the following special characters: ``~!@#%^*-_=+?`` + The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ``~!@#%^*-_=+?`` Method 2 -------- @@ -39,4 +41,4 @@ Method 2 #. Enter and confirm the new administrator password and click **OK**. - The password is a string of 8 to 32 characters. It must be a combination of uppercase letters, lowercase letters, digits, and special characters. You can also use the following special characters: ``~!@#%^*-_=+?`` + The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ``~!@#%^*-_=+?`` diff --git a/umn/source/monitoring/interconnecting_with_cts/index.rst b/umn/source/auditing/index.rst similarity index 63% rename from umn/source/monitoring/interconnecting_with_cts/index.rst rename to umn/source/auditing/index.rst index 7ce6480..a41a4c9 100644 --- a/umn/source/monitoring/interconnecting_with_cts/index.rst +++ b/umn/source/auditing/index.rst @@ -2,15 +2,13 @@ .. _dds_03_0028: -Interconnecting with CTS -======================== +Auditing +======== - :ref:`Key Operations Recorded by CTS ` -- :ref:`Querying Traces ` .. toctree:: :maxdepth: 1 :hidden: key_operations_recorded_by_cts - querying_traces diff --git a/umn/source/monitoring/interconnecting_with_cts/key_operations_recorded_by_cts.rst b/umn/source/auditing/key_operations_recorded_by_cts.rst similarity index 86% rename from umn/source/monitoring/interconnecting_with_cts/key_operations_recorded_by_cts.rst rename to umn/source/auditing/key_operations_recorded_by_cts.rst index 7d59232..95065ba 100644 --- a/umn/source/monitoring/interconnecting_with_cts/key_operations_recorded_by_cts.rst +++ b/umn/source/auditing/key_operations_recorded_by_cts.rst @@ -5,7 +5,7 @@ Key Operations Recorded by CTS ============================== -With CTS, you can record operations associated with DDS for later query, audit, and backtrack operations. +With Cloud Trace Service (CTS), you can record operations associated with DDS for later query, audit, and backtrack operations. .. table:: **Table 1** Key operations on DDS @@ -38,21 +38,21 @@ With CTS, you can record operations associated with DDS for later query, audit, +--------------------------------------+----------------+--------------------------+ | Setting a backup policy | backup | ddsSetBackupPolicy | +--------------------------------------+----------------+--------------------------+ - | Applying a parameter group | parameterGroup | ddsApplyConfigurations | + | Applying a parameter template | parameterGroup | ddsApplyConfigurations | +--------------------------------------+----------------+--------------------------+ - | Replicating a parameter group | parameterGroup | ddsCopyConfigurations | + | Replicating a parameter template | parameterGroup | ddsCopyConfigurations | +--------------------------------------+----------------+--------------------------+ - | Resetting a parameter group | parameterGroup | ddsResetConfigurations | + | Resetting a parameter template | parameterGroup | ddsResetConfigurations | +--------------------------------------+----------------+--------------------------+ - | Creating a parameter group | parameterGroup | ddsCreateConfigurations | + | Creating a parameter template | parameterGroup | ddsCreateConfigurations | +--------------------------------------+----------------+--------------------------+ - | Deleting a parameter group | parameterGroup | ddsDeleteConfigurations | + | Deleting a parameter template | parameterGroup | ddsDeleteConfigurations | +--------------------------------------+----------------+--------------------------+ - | Updating a parameter group | parameterGroup | ddsUpdateConfigurations | + | Updating a parameter template | parameterGroup | ddsUpdateConfigurations | +--------------------------------------+----------------+--------------------------+ - | Binding an EIP | instance | ddsBindIP | + | Binding an EIP | instance | ddsBindEIP | +--------------------------------------+----------------+--------------------------+ - | Unbinding an EIP | instance | ddsUnbindIP | + | Unbinding an EIP | instance | ddsUnBindEIP | +--------------------------------------+----------------+--------------------------+ | Adding a tag | tag | ddsAddTag | +--------------------------------------+----------------+--------------------------+ @@ -68,3 +68,7 @@ With CTS, you can record operations associated with DDS for later query, audit, +--------------------------------------+----------------+--------------------------+ | Changing DB instance classes | instance | ddsResizeInstance | +--------------------------------------+----------------+--------------------------+ + +.. note:: + + ddsAddTag and ddsDeleteTag are respectively used to add and delete tags for all resources. ddsAddInstanceTag and ddsDeleteInstanceTag are respectively used to add and delete tags for a single instance. diff --git a/umn/source/managing_dds_db_instances/backup_and_restore/creating_a_manual_backup.rst b/umn/source/backup_and_restore/creating_a_manual_backup.rst similarity index 64% rename from umn/source/managing_dds_db_instances/backup_and_restore/creating_a_manual_backup.rst rename to umn/source/backup_and_restore/creating_a_manual_backup.rst index cea193f..07a04d5 100644 --- a/umn/source/managing_dds_db_instances/backup_and_restore/creating_a_manual_backup.rst +++ b/umn/source/backup_and_restore/creating_a_manual_backup.rst @@ -8,7 +8,7 @@ Creating a Manual Backup **Scenarios** ------------- -This section guides you on how to create a manual backup. Creating a backup for a DB instance helps ensure data can be restored if needed, ensuring data reliability. +This section describes how to create a manual backup. Creating a backup for a DB instance helps ensure data can be restored if needed, ensuring data reliability. .. note:: @@ -19,15 +19,15 @@ Method 1 #. :ref:`Log in to the DDS console. ` #. On the **Instance Management** page, locate an available DB instance and click **Create Backup** or choose **More** > **Create Backup**. -#. In the displayed dialog box, specify **Backup Name** and **Description** and click **OK**. +#. In the displayed dialog box, specify **Backup Name** and **Description** (optional) and click **OK**. - The manual backup name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). - The description contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= #. Check the result: - - During the creation of a manual backup, you can query the backup status on the **Backup Management** or the **Backups & Restorations** page. The backup status is **Backing up**. The time it takes to complete the backup depends on the size of the job. - - If the manual backup is successfully created, the backup status is **Complete**. The manual backup type is **Manual** and the backup method is **Physical**. + - During the creation of a manual backup, you can check the backup status on the **Backup Management** or an instance's **Backups & Restorations** page. The backup status is **Backing up**. The time it takes to complete the backup depends on the size of the job. + - If the manual backup is successfully created, the backup status is **Completed**. The manual backup type is **Manual**. Method 2 -------- @@ -35,7 +35,7 @@ Method 2 #. :ref:`Log in to the DDS console. ` #. In the navigation pane on the left, click **Backup Management**. #. On the **Backup Management** page, click **Create Backup**. -#. In the displayed dialog box, specify **DB Instance Type**, **DB Instance Name**, **Backup Name** and **Description** and click **OK**. +#. In the displayed dialog box, specify **DB Instance Type**, **DB Instance Name**, **Backup Name** and **Description** (optional) and click **OK**. - Only DB instances in **Available** status can be manually backed up. - The manual backup name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). @@ -43,8 +43,8 @@ Method 2 #. Check the result: - - During the creation of a manual backup, you can query the backup status on the **Backup Management** or the **Backups & Restorations** page. The backup status is **Backing up**. The time it takes to complete the backup depends on the size of the job. - - If the manual backup is successfully created, the backup status is **Complete**. The manual backup type is **Manual** and the backup method is **Physical**. + - During the creation of a manual backup, you can check the backup status on the **Backup Management** or an instance's **Backups & Restorations** page. The backup status is **Backing up**. The time it takes to complete the backup depends on the size of the job. + - If the manual backup is successfully created, the backup status is **Completed**. The manual backup type is **Manual**. Method 3 -------- @@ -53,12 +53,12 @@ Method 3 #. On the **Instance Management** page, click an available DB instance. #. In the navigation pane on the left, click **Backups & Restorations**. #. On the **Backups & Restorations** page, click **Create Backup**. -#. In the displayed dialog box, specify **Backup Name** and **Description** and click **OK**. +#. In the displayed dialog box, specify **Backup Name** and **Description** (optional) and click **OK**. - The manual backup name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). - The description contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= #. Check the result: - - During the creation of a manual backup, you can query the backup status on the **Backup Management** or the **Backups & Restorations** page. The backup status is **Backing up**. The time it takes to complete the backup depends on the size of the job. - - If the manual backup is successfully created, the backup status is **Complete**. The manual backup type is **Manual** and the backup method is **Physical**. + - During the creation of a manual backup, you can check the backup status on the **Backup Management** or an instance's **Backups & Restorations** page. The backup status is **Backing up**. The time it takes to complete the backup depends on the size of the job. + - If the manual backup is successfully created, the backup status is **Completed**. The manual backup type is **Manual**. diff --git a/umn/source/managing_dds_db_instances/backup_and_restore/deleting_a_manual_backup.rst b/umn/source/backup_and_restore/deleting_a_manual_backup.rst similarity index 83% rename from umn/source/managing_dds_db_instances/backup_and_restore/deleting_a_manual_backup.rst rename to umn/source/backup_and_restore/deleting_a_manual_backup.rst index 8746617..1302578 100644 --- a/umn/source/managing_dds_db_instances/backup_and_restore/deleting_a_manual_backup.rst +++ b/umn/source/backup_and_restore/deleting_a_manual_backup.rst @@ -36,7 +36,7 @@ Method 2 #. In the navigation pane on the left, click **Backup Management**. -#. On the **Backup Management** page, click the **Clusters** or **Replica Sets** tab, locate the manual backup you want to delete and click **Delete** in the **Operation** column. +#. On the **Backup Management** page, click the **Clusters**, **Replica Sets**, or **Single Nodes** tab, locate the manual backup to be deleted, and click **Delete** in the **Operation** column. Backups being used to recover instances cannot be deleted. diff --git a/umn/source/managing_dds_db_instances/backup_and_restore/deleting_an_automated_backup.rst b/umn/source/backup_and_restore/deleting_an_automated_backup.rst similarity index 73% rename from umn/source/managing_dds_db_instances/backup_and_restore/deleting_an_automated_backup.rst rename to umn/source/backup_and_restore/deleting_an_automated_backup.rst index 6ebe4c8..13ee27f 100644 --- a/umn/source/managing_dds_db_instances/backup_and_restore/deleting_an_automated_backup.rst +++ b/umn/source/backup_and_restore/deleting_an_automated_backup.rst @@ -8,7 +8,7 @@ Deleting an Automated Backup **Scenarios** ------------- -This section guides you on how to delete an automated backup. If the automated backup policy is disabled, DDS allows you to delete stored automated backups to release storage space. +This section describes how to delete an automated backup. If the automated backup policy is disabled, DDS allows you to delete stored automated backups to release storage space. If the automated backup policy is enabled, DDS will delete automated backups as they expire. You cannot delete them manually. @@ -38,7 +38,7 @@ Method 2 #. In the navigation pane on the left, click **Backup Management**. -#. On the **Backup Management** page, click the **Clusters** or **Replica Sets** tab, locate the automated backup you want to delete and click **Delete** in the **Operation** column. +#. On the **Backup Management** page, click the **Clusters**, **Replica Sets**, or **Single Nodes** tab, locate the automated backup to be deleted, and click **Delete** in the **Operation** column. Backups being used to recover instances cannot be deleted. diff --git a/umn/source/managing_dds_db_instances/backup_and_restore/downloading_backup_files.rst b/umn/source/backup_and_restore/downloading_backup_files.rst similarity index 86% rename from umn/source/managing_dds_db_instances/backup_and_restore/downloading_backup_files.rst rename to umn/source/backup_and_restore/downloading_backup_files.rst index dd7db49..42e2a15 100644 --- a/umn/source/managing_dds_db_instances/backup_and_restore/downloading_backup_files.rst +++ b/umn/source/backup_and_restore/downloading_backup_files.rst @@ -17,7 +17,7 @@ Procedure #. In the navigation pane on the left, click **Backup Management**. -#. On the **Backup Management** page, click the **Clusters** or **Replica Sets** tab, locate the available backup you want to download and click **Download** in the **Operation** column. +#. On the **Backup Management** page, click the **Clusters**, **Replica Sets**, or **Single Nodes** tab, locate the target backup you want to download and click **Download** in the **Operation** column. #. Download `OBS Browser `__ and install it. @@ -43,4 +43,4 @@ Procedure In the search box on the right of OBS Browser, enter the backup file name displayed on **Download Backup File** of the DDS console. -#. After the backup file is downloaded, enable OBS Browser certificate verification. +#. Enable OBS Browser certificate verification after the backup files are downloaded. diff --git a/umn/source/managing_dds_db_instances/backup_and_restore/index.rst b/umn/source/backup_and_restore/index.rst similarity index 76% rename from umn/source/managing_dds_db_instances/backup_and_restore/index.rst rename to umn/source/backup_and_restore/index.rst index 0d20963..a3d6d45 100644 --- a/umn/source/managing_dds_db_instances/backup_and_restore/index.rst +++ b/umn/source/backup_and_restore/index.rst @@ -9,6 +9,8 @@ Backup and Restore - :ref:`Creating a Manual Backup ` - :ref:`Restoring a Cluster Instance from a Backup ` - :ref:`Restoring a Replica Set Instance from a Backup ` +- :ref:`Restoring Replica Set Instance to a Point in Time ` +- :ref:`Restoring a Single Node Instance from a Backup ` - :ref:`Downloading Backup Files ` - :ref:`Deleting a Manual Backup ` - :ref:`Deleting an Automated Backup ` @@ -21,6 +23,8 @@ Backup and Restore creating_a_manual_backup restoring_a_cluster_instance_from_a_backup restoring_a_replica_set_instance_from_a_backup + restoring_replica_set_instance_to_a_point_in_time + restoring_a_single_node_instance_from_a_backup downloading_backup_files deleting_a_manual_backup deleting_an_automated_backup diff --git a/umn/source/backup_and_restore/restoring_a_cluster_instance_from_a_backup.rst b/umn/source/backup_and_restore/restoring_a_cluster_instance_from_a_backup.rst new file mode 100644 index 0000000..6a359a6 --- /dev/null +++ b/umn/source/backup_and_restore/restoring_a_cluster_instance_from_a_backup.rst @@ -0,0 +1,80 @@ +:original_name: dds_03_0042.html + +.. _dds_03_0042: + +Restoring a Cluster Instance from a Backup +========================================== + +**Scenarios** +------------- + +This section describes how to restore a cluster instance from a backup. + +Restoration Precautions +----------------------- + +- When you restore the DB instance from a backup file, a full backup file is downloaded from OBS and then restored to the DB instance at an average speed of 40 MB/s. + +Method 1 +-------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click the target cluster instance. +#. In the navigation pane on the left, click **Backups & Restorations**. +#. On the **Backups & Restorations** page, locate the target backup and click **Restore** in the **Operation** column. +#. Select either of the following restoration methods and click **OK**. + + - Create New Instance + + The **Create New Instance** page is displayed for you to create a DB instance using the backup data. The new DB instance is independent from the original one. + + - The database type, DB instance type, compatible MongoDB version, storage engine, storage type, and shard quantity must be the same as those of the original and cannot be changed. + - The number of mongos nodes is 2 by default and ranges from 2 to 32. You can specify the quantity. + - The storage space is the same as that of the original instance by default. You can only increase the storage space. + - Other settings have default values and can be modified. For details, see section :ref:`Creating a Cluster Instance `. + + - Restore to Original + + .. important:: + + - Restoring to the original DB instance will overwrite all existing data and the DB instance will be temporarily unavailable during the restoration. + - The administrator password of the database instance remains unchanged after the restoration. + - If IP address is enabled both for the shards and config, the related password has to be changed for both of them. + +Method 2 +-------- + +#. :ref:`Log in to the DDS console. ` + +#. In the navigation pane on the left, click **Backup Management**. + +#. On the **Backup Management** page, locate the target backup on the **Clusters** tab and click **Restore** in the **Operation** column. + + - If you use an automated backup, go to :ref:`4 `. + - If you use a manual backup, check whether the original instance of the manual backup exists: + + - If so, then go to :ref:`4 `. + - If not, then you can only restore the backup to a new DB instance. Go to :ref:`Create New Instance ` step under :ref:`4 `. + +#. .. _dds_03_0042__l02b85d494b33478aa0354867be338dda: + + Select either of the following restoration methods and click **OK**. + + - .. _dds_03_0042__li969750316413: + + Create New Instance + + The **Create New Instance** page is displayed for you to create a DB instance using the backup data. The new DB instance is independent from the original one. + + - The database type, DB instance type, compatible MongoDB version, storage engine, storage type, and shard quantity must be the same as those of the original and cannot be changed. + - The number of mongos nodes is 2 by default and ranges from 2 to 32. You can specify the quantity. + - The storage space is the same as that of the original instance by default. You can only increase the storage space. + - Other settings have default values and can be modified. For details, see section :ref:`Creating a Cluster Instance `. + + - Restore to Original + + .. important:: + + - Restoring to the original DB instance will overwrite all existing data and the DB instance will be temporarily unavailable during the restoration. + - The administrator password of the database instance remains unchanged after the restoration. + - If IP address is enabled both for the shards and config, the related password has to be changed for both of them. diff --git a/umn/source/backup_and_restore/restoring_a_replica_set_instance_from_a_backup.rst b/umn/source/backup_and_restore/restoring_a_replica_set_instance_from_a_backup.rst new file mode 100644 index 0000000..e4ce2a7 --- /dev/null +++ b/umn/source/backup_and_restore/restoring_a_replica_set_instance_from_a_backup.rst @@ -0,0 +1,76 @@ +:original_name: dds_03_0043.html + +.. _dds_03_0043: + +Restoring a Replica Set Instance from a Backup +============================================== + +**Scenarios** +------------- + +This section describes how to restore a replica set instance from a backup. + +Restoration Precautions +----------------------- + +- When you restore the DB instance from a backup file, a full backup file is downloaded from OBS and then restored to the DB instance at an average speed of 40 MB/s. + +Method 1 +-------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click the target replica set instance. +#. In the navigation pane on the left, click **Backups & Restorations**. +#. On the **Backups & Restorations** page, locate the target backup and click **Restore** in the **Operation** column. +#. Select either of the following restoration methods and click **OK**. + + - Create New Instance + + The **Create New Instance** page is displayed for you to create a DB instance using the backup data. The new DB instance is independent from the original one. + + - The database type, DB instance type, compatible MongoDB version, storage engine, and storage type must be the same as those of the original and cannot be changed. + - The storage space is the same as that of the original instance by default. You can only increase the storage space. + - Other settings have default values and can be modified. For details, see section :ref:`Creating a Replica Set Instance `. + + - Restore to Original + + .. important:: + + - Restoring to the original DB instance will overwrite all existing data and the DB instance will be temporarily unavailable during the restoration. + - The administrator password of the database instance remains unchanged after the restoration. + +Method 2 +-------- + +#. :ref:`Log in to the DDS console. ` + +#. In the navigation pane on the left, click **Backup Management**. + +#. On the **Backup Management** page, locate the target backup on the **Replica Sets** tab and click **Restore** in the **Operation** column. + + - If you use an automated backup, go to :ref:`4 `. + - If you use a manual backup, check whether the original instance of the manual backup exists: + + - If yes, go to :ref:`4 `. + - If no, you can only restore the backup to a new DB instance. Go to :ref:`Create New Instance ` step under Step 4. + +#. .. _dds_03_0043__l02b85d494b33478aa0354867be338dda: + + Select either of the following restoration methods and click **OK**. + + - .. _dds_03_0043__li969750316413: + + Create New Instance + + The **Create New Instance** page is displayed for you to create a DB instance using the backup data. The new DB instance is independent from the original one. + + - The database type, DB instance type, compatible MongoDB version, storage engine, and storage type must be the same as those of the original and cannot be changed. + - The storage space is the same as that of the original instance by default. You can only increase the storage space. + - Other settings have default values and can be modified. For details, see section :ref:`Creating a Replica Set Instance `. + + - Restore to Original + + .. important:: + + - Restoring to the original DB instance will overwrite all existing data and the DB instance will be temporarily unavailable during the restoration. + - The administrator password of the database instance remains unchanged after the restoration. diff --git a/umn/source/backup_and_restore/restoring_a_single_node_instance_from_a_backup.rst b/umn/source/backup_and_restore/restoring_a_single_node_instance_from_a_backup.rst new file mode 100644 index 0000000..b1aacc4 --- /dev/null +++ b/umn/source/backup_and_restore/restoring_a_single_node_instance_from_a_backup.rst @@ -0,0 +1,63 @@ +:original_name: dds_03_0031.html + +.. _dds_03_0031: + +Restoring a Single Node Instance from a Backup +============================================== + +Scenarios +--------- + +This section describes how to restore a single node instance from a backup. + +Restoration Precautions +----------------------- + +- When you restore the DB instance from a backup file, a full backup file is downloaded from OBS and then restored to the DB instance at an average speed of 40 MB/s. + +Method 1 +-------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click the target single node instance. +#. In the navigation pane on the left, click **Backups & Restorations**. +#. On the **Backups & Restorations** page, locate the target backup and click **Restore** in the **Operation** column. +#. In the displayed window, select a restoration mode and click **OK**. + + - Create New Instance + + The **Create New Instance** page is displayed for you to create a DB instance using the backup data. The new DB instance is independent from the original one. + + - The database type, DB instance type, compatible MongoDB version, storage engine, and storage type must be the same as those of the original and cannot be changed. + - The storage space is the same as that of the original instance by default. You can only increase the storage space. + - Other settings have default values and can be modified. For details, see section :ref:`Creating a Single Node Instance `. + + - Restore to Original + + .. important:: + + - Restoring to the original DB instance will overwrite all existing data and the DB instance will be temporarily unavailable during the restoration. + - The administrator password of the database instance remains unchanged after the restoration. + +Method 2 +-------- + +#. :ref:`Log in to the DDS console. ` +#. In the navigation pane on the left, click **Backup Management**. +#. On the **Backup Management** page, locate the target backup on the **Single Nodes** tab and click **Restore** in the **Operation** column. +#. In the displayed window, select a restoration mode and click **OK**. + + - Create New Instance + + The **Create New Instance** page is displayed for you to create a DB instance using the backup data. The new DB instance is independent from the original one. + + - The database type, DB instance type, compatible MongoDB version, storage engine, and storage type must be the same as those of the original and cannot be changed. + - The storage space is the same as that of the original instance by default. You can only increase the storage space. + - Other settings have default values and can be modified. For details, see section :ref:`Creating a Single Node Instance `. + + - Restore to Original + + .. important:: + + - Restoring to the original DB instance will overwrite all existing data and the DB instance will be temporarily unavailable during the restoration. + - The administrator password of the database instance remains unchanged after the restoration. diff --git a/umn/source/backup_and_restore/restoring_replica_set_instance_to_a_point_in_time.rst b/umn/source/backup_and_restore/restoring_replica_set_instance_to_a_point_in_time.rst new file mode 100644 index 0000000..b72f2ac --- /dev/null +++ b/umn/source/backup_and_restore/restoring_replica_set_instance_to_a_point_in_time.rst @@ -0,0 +1,54 @@ +:original_name: dds_03_0064.html + +.. _dds_03_0064: + +Restoring Replica Set Instance to a Point in Time +================================================= + +**Scenarios** +------------- + +You can restore the data of a replica set instance to a specified time point. + +Restoration Precautions +----------------------- + +- Currently, you can restore a replica set instance to a new or original DB instance at a point in time. +- In case of point-in-time recovery, the "local" database (which is a default database in DDS instances) will not be restored. +- When you enter the time point that you want to restore the DB instance to, DDS downloads the latest full backup file before the specified time point from OBS to the DB instance. Then, incremental backups are also restored to the specified point in time on the DB instance. Data is restored at an average speed of 30 MB/s. + +Constraints +----------- + +Data can be restored to a specified time point only after the automated backup policy is enabled. + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, click the target replica set instance. + +#. In the navigation pane on the left, click **Backups & Restorations**. + +#. On the **Backups & Restorations** page, click **Restore to Point In Time**. + +#. .. _dds_03_0064__li101168184011: + + Select the date and time range, select or enter a time point within the acceptable range, and select **Create New Instance** or **Restore to Original**. + +#. On the displayed page, the DB instance is restored based on the restoration method you selected in :ref:`5 `. + + - Create New Instance + + The **Create New Instance** page is displayed for you to create a DB instance using the backup data. The new DB instance is independent from the original one. + + - The database type, DB instance type, compatible MongoDB version, storage engine, and storage type must be the same as those of the original and cannot be changed. + - The storage space is the same as that of the original instance by default. You can only increase the storage space. + + - Restore to Original + + .. important:: + + - Restoring to the original DB instance will overwrite all existing data and the DB instance will be temporarily unavailable during the restoration. + - The administrator password of the database instance remains unchanged after the restoration. diff --git a/umn/source/managing_dds_db_instances/backup_and_restore/setting_automated_backup_policy.rst b/umn/source/backup_and_restore/setting_automated_backup_policy.rst similarity index 52% rename from umn/source/managing_dds_db_instances/backup_and_restore/setting_automated_backup_policy.rst rename to umn/source/backup_and_restore/setting_automated_backup_policy.rst index d39fb18..16ceb72 100644 --- a/umn/source/managing_dds_db_instances/backup_and_restore/setting_automated_backup_policy.rst +++ b/umn/source/backup_and_restore/setting_automated_backup_policy.rst @@ -5,22 +5,26 @@ Setting Automated Backup Policy =============================== -**Scenarios** -------------- +DDS backs up data automatically based on the automated backup policy you set. You are advised to regularly back up data in your database. If the database becomes faulty or data is damaged, you can restore it with the backup. -DDS backs up data automatically based on the automated backup policy you set. You are advised to regularly back up data in your database. If the database becomes faulty or data is damaged, you can restore it with the backup, ensuring data reliability. +The automated backup policy for DDS is enabled by default. After an instance is created, you can :ref:`modify ` or :ref:`disable ` the automated backup policy as required. -.. important:: +The default automated backup policy is as follows: - - DDS checks existing automated backup files. If the retention period of a file exceeds the backup retention period you set, DDS will delete the file. - - After the backup policy is modified, an automated backup will be triggered based on the new backup policy. The retention period of the previously generated automated backups remains unchanged. +- Retention period: 7 days +- Time window: The default time window is a one hour time interval within 24 hours, for example, 01:00-02:00. The backup time is in UTC format. +- Backup cycle: Each day of the week. -- Backup files are stored in OBS buckets. -- When a DB instance is created, DDS enables the automated backup policy by default. The default settings of the parameters are as follows. You can modify them after a DB instance is created. +Once the automated backup policy is enabled, a full backup is triggered immediately. After that, full backups will be created based on the backup window and backup cycle you specify. When an instance is being backed up, data is copied and then compressed and uploaded to OBS. The length of time the backup data is kept for depends on the backup retention period you configure. The backup duration depends on the amount of data, and the average backup speed is 60 MB/s. After the automated backup policy is enabled, an incremental backup is automatically performed every 5 minutes to ensure data reliability. - - Backups are retained for 7 days by default. - - The time window is in UTC by default. - - Data is backed up every day by default. +Precautions +----------- + +- The backup process does not affect services. +- DDS checks existing automated backup files. If the retention period of a file exceeds the backup retention period you set, DDS will delete the file. +- After the backup policy is modified, an automated backup will be triggered based on the new backup policy. The retention period of the previously generated automated backups remains unchanged. + +.. _en-us_topic_backup_restore__section553508110238: Enabling or Modifying an Automated Backup Policy ------------------------------------------------ @@ -33,7 +37,7 @@ Enabling or Modifying an Automated Backup Policy #. On the **Backups & Restorations** page, click **Modify Backup Policy**. If you want to enable the automated backup policy, click |image1|. - Retention period refers to the number of days that data is kept. You can increase the retention period to improve data reliability. + **Retention Period** refers to the number of days that data is kept. You can increase the retention period to improve data reliability. The backup retention period can range from 1 to 732 days, with a time window of one hour. The backup cycle varies according to the retention period you have set. @@ -46,26 +50,21 @@ Enabling or Modifying an Automated Backup Policy - If the automated backup policy is enabled, an automated full backup is immediately triggered. The time it takes to complete the backup depends on the size of the job. - If the automated backup policy is modified, an automated full backup is randomly triggered during the time window you set. The time it takes to complete the backup depends on the size of the job. - - During the creation of an automated backup, you can query the backup status on the **Backup Management** page or the **Backups & Restorations** tab. The backup status is **Backing up**. - - In the upper right corner of the backup list, click |image2| to refresh the list. The backup status changes to **Complete**. The backup type is **Automated** and the backup method is **Physical**. + - During the creation of an automated backup, you can check the backup status on the **Backup Management** page or the **Backups & Restorations** tab. The backup status is **Backing up**. + - In the upper right corner of the backup list, click |image2| to refresh the list. The backup status changes to **Completed**. The backup type is **Automated**. + +.. _en-us_topic_backup_restore__section5411044193812: Disabling an Automated Backup Policy ------------------------------------ -.. important:: - - Observe the following constraints when disabling the automated backup policy: - - - Your data cannot be backed up. - - If you choose to delete all the existing automated backup when disabling the automated backup policy, related restoration or download operations will fail. - #. :ref:`Log in to the DDS console. ` #. On the **Instance Management** page, click the target DB instance. #. In the navigation pane on the left, click **Backups & Restorations**. -#. On the **Backups & Restorations** page, click **Modify Backup Policy**. On the displayed page, click |image3| to disable the automated backup policy. +#. On the **Backups & Restorations** page, click **Modify Backup Policy**. On the displayed dialog box, click |image3| to disable the automated backup policy. You can determine whether to delete all automated backup files: @@ -74,6 +73,6 @@ Disabling an Automated Backup Policy #. Click **OK**. -.. |image1| image:: /_static/images/en-us_image_0284275158.png -.. |image2| image:: /_static/images/en-us_image_0284275185.png -.. |image3| image:: /_static/images/en-us_image_0284274973.png +.. |image1| image:: /_static/images/en-us_image_0000001142893879.png +.. |image2| image:: /_static/images/en-us_image_0000001096133892.png +.. |image3| image:: /_static/images/en-us_image_0000001096453870.png diff --git a/umn/source/change_history.rst b/umn/source/change_history.rst index f95f6af..54005c7 100644 --- a/umn/source/change_history.rst +++ b/umn/source/change_history.rst @@ -5,193 +5,260 @@ Change History ============== -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Released On | Description | -+===================================+=================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ -| 2020-10-15 | Modified the following content: | -| | | -| | - Supported a maximum of 20 tags for each instance in sections :ref:`Creating a Cluster Instance `, :ref:`Creating a Replica Set Instance `, and :ref:`Tag `. | -| | - Supported a maximum of 16 mongos and 16 shards in a cluster instance in sections :ref:`Cluster Architecture `, :ref:`Cluster `, :ref:`Creating a Cluster Instance `, and :ref:`Adding Cluster Instance Nodes `. | -| | - Optimized the procedures based on the **Connections** tab in sections :ref:`Binding and Unbinding an EIP `, :ref:`Enabling or Disabling SSL `, :ref:`Binding and Unbinding an EIP `, :ref:`Enabling or Disabling SSL `, :ref:`Changing the Database Port `, and :ref:`Changing a Security Group `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-11-07 | Modified the following content: | -| | | -| | Supported DB instances that are compatible with MongoDB 3.4 Community Edition in sections :ref:`Database Engine and Version `, :ref:`Creating a Cluster Instance `, :ref:`Creating a Replica Set Instance `, and :ref:`How Can I Install a MongoDB Client? ` | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-09-16 | Modified the following content: | -| | | -| | - Added the description of disabling OBS Browser certificate verification and the procedure for enabling the certificate verification in section :ref:`Downloading Backup Files `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-08-19 | Added the following content: | -| | | -| | - :ref:`Binding and Unbinding an EIP ` | -| | - :ref:`Binding and Unbinding an EIP ` | -| | | -| | Modified the following content: | -| | | -| | - Supported binding and unbinding an EIP in sections :ref:`Service Process `, :ref:`Restrictions `, :ref:`Creating a Cluster Instance `, :ref:`Connecting to a DB Instance Through a Client `, :ref:`Service Process `, :ref:`Restrictions `, :ref:`Creating a Replica Set Instance `, :ref:`Connecting to a DB Instance Through a Client `, :ref:`Migrating Data `, :ref:`Key Operations Recorded by CTS `, and :ref:`Can an External Server Access the DDS DB Instance? ` | -| | - Added the procedure for disabling certificate verification on OBS Browser in section :ref:`Downloading Backup Files `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-07-24 | Modified the following content: | -| | | -| | - Modified the description of the DB instance status **Changing private IP address** in section :ref:`Database Status `. | -| | - Modified the description of **AZ** in section :ref:`Creating a Replica Set Instance `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-07-17 | Modified the following content: | -| | | -| | - Supported the deployment of a replica set instance across three AZs in sections :ref:`Regions and AZs ` and :ref:`Creating a Replica Set Instance `. | -| | - Optimized the description of the parameter group status **In-Sync** in section :ref:`Database Status `. | -| | - Modified the description of the **DB Instance Type** parameter in section :ref:`Creating a Replica Set Instance `. | -| | - Optimized the description and steps in :ref:`Manually Switching the Primary and Secondary Nodes of a Replica Set `. | -| | - Optimized the description and steps in :ref:`Migrating Data `. | -| | - Optimized the application scenarios in section :ref:`Task Center `. | -| | - Optimized figures in this document. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-07-03 | Added the following content: | -| | | -| | - :ref:`Manually Switching the Primary and Secondary Nodes of a Replica Set ` | -| | - :ref:`Changing the CPU or Memory of a Cluster DB Instance ` | -| | - :ref:`Changing the CPU or Memory of a Replica Set DB Instance ` | -| | - :ref:`Task Center ` | -| | | -| | Modified the following content: | -| | | -| | - Modified DB instance statuses in section :ref:`Database Status `. | -| | | -| | - Modified the parameter description of DB instance class and the description of subnet in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | -| | - Added the description of the parameter group in sections :ref:`Creating a Cluster Instance `, :ref:`Creating a Replica Set Instance `, and :ref:`Adding Cluster Instance Nodes `. | -| | - Optimized the procedures for buying, restarting, deleting, backing up, and restoring a DB instance, and managing parameter groups, and operations related to storage space, security groups, tags, task centers, and monitoring metrics. | -| | - Moved the subsection "Managing Database Accounts" from section *Getting Started* to :ref:`Managing Database Accounts `. | -| | - Moved the subsection "Migrating Data" in section *Getting Started* to :ref:`Migrating Data `. | -| | - Divided chapter "Getting Started" into sections :ref:`Getting Started with Clusters ` and :ref:`Getting Started with Replica Sets `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-03-12 | Accepted in OTC-4.0/Agile. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-15 | Modified the following content: | -| | | -| | - Modified the description of the **Tags** parameter in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | -| | - Optimized the tag scenario in section :ref:`Tag `. | -| | - Deleted the description of specification confirmation in sections :ref:`Adding Cluster Instance Nodes ` and :ref:`Scaling Up Storage Space `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-01-31 | Modified the following content: | -| | | -| | - Added parameter **Tags** in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | -| | - Supported retaining backups for a maximum of 732 days in section :ref:`Setting Automated Backup Policy `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-12-29 | Added the following content: | -| | | -| | - :ref:`Changing a Security Group ` | -| | - :ref:`Downloading Backup Files ` | -| | | -| | Modified the following content: | -| | | -| | - Added parameter **SSL** in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-10-08 | Modified the following content: | -| | | -| | - Modified the command for connecting to a DB instance using SSL and added the description in section :ref:`Connecting to a DB Instance Through a Client `. | -| | - Modified the note in section :ref:`Replica Set Architecture `. | -| | - Accepted in OTC-3.2. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-09-10 | Modified the following content: | -| | | -| | - Deleted the release numbers and retained the release dates only in accordance with the unified public cloud style. | -| | - Modified the description about the parameter group quotas in section :ref:`Creating a Parameter Group `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-31 | Added the following content: | -| | | -| | - :ref:`Changing a Parameter Group Description ` | -| | | -| | Modified the following content: | -| | | -| | - Supported case-sensitive manual backup names in section :ref:`Creating a Manual Backup `. | -| | - Modified commands supported and restricted by DDS in section :ref:`Which Commands are Supported or Restricted by DDS? ` | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-17 | Modified the following content: | -| | | -| | - Modified the description of high-availability replica sets in section :ref:`Replica Set Architecture `. | -| | - Modified the description about the parameter group quotas in section :ref:`Creating a Parameter Group `. | -| | - Optimized the description of the step following the successful creation of a DB instance in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | -| | - Changed **HA Type** to **DB Instance Type** displayed on the page for creating a DB instance, optimized the buttons of the warning dialog box of restart and delete operations, and synchronized the changes to the document. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-03 | Added the following content: | -| | | -| | - :ref:`Replica Set Architecture ` | -| | - :ref:`Creating a Replica Set Instance ` | -| | - :ref:`Restoring a Replica Set Instance from a Backup ` | -| | - :ref:`What Is the Time Delay for Primary/Secondary Synchronization in a Replica Set? ` | -| | - :ref:`Tag ` | -| | | -| | Modified the following content: | -| | | -| | - Supported the creation of the replica set DB instance in sections :ref:`Modifying the DB Instance Name `, :ref:`Restarting a DB Instance or a Node `, :ref:`Deleting a DB instance `, :ref:`Setting Automated Backup Policy `, :ref:`Creating a Manual Backup `, :ref:`Deleting a Manual Backup `, :ref:`Deleting an Automated Backup `, :ref:`Parameter Group `, :ref:`Scaling Up Storage Space `, :ref:`Security `, :ref:`Security `, and :ref:`DDS Metrics `. | -| | - Supported disk encryption in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | -| | - Changed the length of the instance name to 4 to 64 characters in sections :ref:`Creating a Cluster Instance `, :ref:`Creating a Replica Set Instance `, and :ref:`Modifying the DB Instance Name `. | -| | - Supported the batch querying of error logs of all nodes, all mongos, all shards, and all configs of a cluster instance and supported the querying of error logs of all nodes of a replica set instance in section :ref:`Error Log `. | -| | - Supported the batch querying of slow query logs of all nodes of a replica set instance in section :ref:`Slow Query Log `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-03 | Accepted in OTC-3.1. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-27 | Added the following content: | -| | | -| | - :ref:`Deleting an Automated Backup ` | -| | | -| | Modified the following content: | -| | | -| | - Changed the number of days for retaining automated backups and the restriction on the backup cycle in section :ref:`Setting Automated Backup Policy `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-21 | Modified the following content: | -| | | -| | - Modified the procedure for creating a DB instance and fixed the storage space of config at 20 GB in section :ref:`Creating a Cluster Instance `. | -| | - Supported the enabling or disabling the automated backup policy in section :ref:`Setting Automated Backup Policy `. | -| | - Moved the subsection "Monitoring" in chapter "Managing DDS DB Instances" to a new section :ref:`Monitoring `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-04 | Modified the following content: | -| | | -| | - Modified the description of disk encryption and detailed the description of the HA type and storage type in section :ref:`Creating a Cluster Instance `. | -| | - Modified the description of the **pwd** parameter in section :ref:`Managing Database Accounts `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-05-04 | Added the following content: | -| | | -| | - :ref:`Managing Database Accounts ` | -| | - :ref:`Reverting Cluster Instance Nodes ` | -| | | -| | Modified the following content: | -| | | -| | - Supported disk encryption, enabled the setting of DB instance name on the page for creating a DB instance, and changed the range of the config storage space in section :ref:`Creating a Cluster Instance `. | -| | - Supported the deletion of node that fails to be added in section :ref:`Adding Cluster Instance Nodes `. | -| | - Supported the viewing of slow logs of all shards in section :ref:`Slow Query Log `. | -| | - Modified commands supported and restricted by DDS in section :ref:`Which Commands are Supported or Restricted by DDS? ` | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-03-09 | Modified the following content: | -| | | -| | - Modified the description of DDS and changed its location in section :ref:`What Is DDS? ` | -| | - Added the tag editing function in section :ref:`Tag `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-23 | Added the following content: | -| | | -| | - :ref:`Tag ` | -| | | -| | Modified the following content: | -| | | -| | - Added the description in section :ref:`Setting Automated Backup Policy `: If you set the retention period to one or more days, the backup policy is enabled and a full automated backup is triggered instantly. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-19 | Accepted in OTC-3.0. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-09 | Modified the following content: | -| | | -| | - Optimized commands in sections :ref:`Connecting to a DB Instance Through a Client ` and :ref:`Migrating Data `. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-02 | Added the following content: | -| | | -| | - :ref:`Glossary ` | -| | | -| | Modified the following content: | -| | | -| | - Added the description of DDS in section :ref:`What Is DDS? ` | -| | - Modified the definition of cluster in section :ref:`Cluster Architecture `. | -| | - Modified the description of the automated backup policy in section :ref:`Setting Automated Backup Policy `. | -| | - Modified the description of effect on backups when instances and cloud account are deleted in sections :ref:`Deleting a DB instance ` and :ref:`Will My Backups Be Deleted If I Delete My Cloud Account? ` | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-01-30 | This issue is the first official release. | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+===============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2022-10-30 | Modified the following content: | +| | | +| | - :ref:`DB Instance Status ` | +| | - :ref:`Changing a Single Node DB Instance Class ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-06-16 | Modified the following content: | +| | | +| | - Added a warning about password risks when you connect to a DB instance. | +| | - Added the description about the recycle bin principle in sections :ref:`Recycling a DB Instance ` | +| | - Modified the description of the backup policy in sections :ref:`Setting Automated Backup Policy ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-05-10 | Added the description of database password. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-04-14 | Added the following content: | +| | | +| | :ref:`Method 2 ` | +| | | +| | Modified the following content: | +| | | +| | - Added the description of driver in sections :ref:`System Architecture ` | +| | - Modified the error description in sections :ref:`Parameter Template Management ` | +| | - Added the tasks overviews in sections :ref:`Task Center ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-03-29 | Modified the following content: | +| | | +| | - Modified the shard and mongos specifications in sections :ref:`Cluster ` | +| | - Added the description of adding or deleting tags in sections :ref:`Key Operations Recorded by CTS ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-03-22 | Added the following content: | +| | | +| | :ref:`Replica Set Instance ` | +| | | +| | Modified the following content: | +| | | +| | - Modified the description of the CIDR blocks in sections :ref:`Configuring Cross-CIDR Access for Replica Set Instances ` | +| | - Changed parameter group to parameter template. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-07-15 | Added the following content: | +| | | +| | - :ref:`Viewing Parameter Change History ` | +| | - :ref:`Exporting a Parameter Template ` | +| | - :ref:`Applying a Parameter Template ` | +| | - :ref:`Viewing Application Records of a Parameter Template ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-06-22 | Modified the following content: | +| | | +| | - Modified the description of the Administrator Password, Enterprise Project and AZ in sections :ref:`Creating a Cluster Instance ` , :ref:`Creating a Replica Set Instance ` and :ref:`Creating a Single Node Instance ` | +| | - Modified the procedure of the setting a security group in sections :ref:`Setting a Security Group ` , :ref:`Setting a Security Group ` and :ref:`Setting a Security Group ` | +| | - Modified Commands and Descriptions about SSL in sections :ref:`Connecting to a Cluster Instance Over Private Networks `, :ref:`Connecting to a Cluster Instance Over Public Networks `, :ref:`Connecting to a Replica Set Instance Over Private Networks `, :ref:`Connecting to a Replica Set Instance Over Public Networks `, :ref:`Connecting to a Single Node Instance Over Private Networks ` and :ref:`Connecting to a Single Node Instance Over Public Networks ` | +| | - Added another method to obtain the SSL certificate, database port, and IP address in sections :ref:`Connecting to a Cluster Instance Over Private Networks `, :ref:`Connecting to a Cluster Instance Over Public Networks `, :ref:`Connecting to a Replica Set Instance Over Private Networks `, :ref:`Connecting to a Replica Set Instance Over Public Networks `, :ref:`Connecting to a Single Node Instance Over Private Networks ` and :ref:`Connecting to a Single Node Instance Over Public Networks ` | +| | - Modified the Text Structure in sections :ref:`Changing the DB Instance Class ` | +| | - Removed description about version 4.0. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-04-13 | Added the following content: | +| | | +| | - :ref:`Single Node Architecture ` | +| | - :ref:`Getting Started with Single Nodes ` | +| | | +| | Modified the following content: | +| | | +| | - The Storage Space for Creating a DB Instance in section :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | +| | - Password Descriptions in section :ref:`Creating a Database Account Using Commands `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-03-29 | Modified the following content: | +| | | +| | Supported Cross-CIDR Access in section :ref:`Creating a Replica Set Instance `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-03-24 | Added the following content: | +| | | +| | :ref:`Configuring Cross-CIDR Access for Replica Set Instances ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-10-15 | Modified the following content: | +| | | +| | - Supported a maximum of 20 tags for each instance in sections :ref:`Creating a Cluster Instance `, :ref:`Creating a Replica Set Instance `, and :ref:`Tag Management `. | +| | - Supported a maximum of 16 mongos and 16 shards in a cluster instance in sections :ref:`Cluster `, :ref:`Cluster `, :ref:`Creating a Cluster Instance `, and :ref:`Adding Nodes to a Cluster `. | +| | - Optimized the procedures based on the Connections tab in sections :ref:`Binding an EIP `, :ref:`Binding an EIP `, :ref:`Enabling or Disabling SSL `, :ref:`Changing the Database Port `, and :ref:`Changing a Security Group `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-11-07 | Modified the following content: | +| | | +| | Supported DB instances that are compatible with MongoDB 3.4 Community Edition in sections :ref:`Database Engine and Version `, :ref:`Creating a Cluster Instance `, :ref:`Creating a Replica Set Instance `, and :ref:`How Can I Install a MongoDB Client? ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-09-16 | Modified the following content: | +| | | +| | - Added the description of disabling OBS Browser certificate verification and the procedure for enabling the certificate verification in section :ref:`Downloading Backup Files `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-08-19 | Added the following content: | +| | | +| | - :ref:`Binding an EIP ` | +| | - :ref:`Binding an EIP ` | +| | | +| | Modified the following content: | +| | | +| | - Supported binding and unbinding an EIP to or from a cluster or replica set instance in sections :ref:`Overview `, :ref:`Constraints and Recommendations `, :ref:`Creating a Cluster Instance `, :ref:`Connecting to a Cluster Instance Over Private Networks `, :ref:`Overview `, :ref:`Constraints and Recommendations `, :ref:`Creating a Replica Set Instance `, :ref:`Connecting to a Replica Set Instance Over Private Networks `, :ref:`Migrating Data `, :ref:`Key Operations Recorded by CTS `. | +| | - Added the procedure for disabling certificate verification on OBS Browser in section :ref:`Downloading Backup Files `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-07-24 | Modified the following content: | +| | | +| | - Modified the description of the DB instance status **Changing private IP address** in section :ref:`DB Instance Status `. | +| | - Modified the description of **AZ** in section :ref:`Creating a Replica Set Instance `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-07-17 | Modified the following content: | +| | | +| | - Supported the deployment of a replica set instance across three AZs in sections :ref:`Regions and AZs ` and :ref:`Creating a Replica Set Instance `. | +| | - Optimized the description of the parameter group status **In-Sync** in section :ref:`DB Instance Status `. | +| | - Modified the description of the **DB Instance Type** parameter in section :ref:`Creating a Replica Set Instance `. | +| | - Optimized the description and steps in :ref:`Manually Switching the Primary and Secondary Nodes of a Replica Set `. | +| | - Optimized the description and steps in :ref:`Migrating Data `. | +| | - Optimized the application scenarios in section :ref:`Task Center `. | +| | - Optimized figures in this document. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-07-03 | Added the following content: | +| | | +| | - :ref:`Manually Switching the Primary and Secondary Nodes of a Replica Set ` | +| | - :ref:`Changing a Cluster DB Instance Class ` | +| | - :ref:`Changing a Replica Set DB Instance Class ` | +| | - :ref:`Task Center ` | +| | | +| | Modified the following content: | +| | | +| | - Modified DB instance statuses in section :ref:`DB Instance Status `. | +| | | +| | - Modified the parameter description of DB instance class and the description of subnet in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | +| | - Added the description of the parameter group in sections :ref:`Creating a Cluster Instance `, :ref:`Creating a Replica Set Instance `, and :ref:`Adding Nodes to a Cluster `. | +| | - Updated the procedures for buying, restarting, deleting, backing up, and restoring a DB instance, and managing parameter groups, and operations related to storage space, security groups, tags, task centers, and monitoring metrics. | +| | - Moved the subsection "Managing Database Accounts" from section *Getting Started* to :ref:`Creating a Database Account Using Commands `. | +| | - Moved the subsection "Migrating Data" in section *Getting Started* to :ref:`Migrating Data `. | +| | - Divided chapter "Getting Started" into sections :ref:`Getting Started with Clusters ` and :ref:`Getting Started with Replica Sets `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-03-12 | Accepted in OTC-4.0/Agile. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-02-15 | Modified the following content: | +| | | +| | - Modified the description of the **Tags** parameter in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | +| | - Optimized the tag scenario in section :ref:`Tag Management `. | +| | - Deleted the description of specification confirmation in sections :ref:`Adding Nodes to a Cluster ` and :ref:`Scaling Up Storage Space `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-01-31 | Modified the following content: | +| | | +| | - Added parameter **Tags** in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | +| | - Supported retaining backups for a maximum of 732 days in section :ref:`Setting Automated Backup Policy `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-12-29 | Added the following content: | +| | | +| | - :ref:`Changing a Security Group ` | +| | - :ref:`Downloading Backup Files ` | +| | | +| | Modified the following content: | +| | | +| | - Added parameter **SSL** in :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-10-08 | Modified the following content: | +| | | +| | - Modified the command for connecting to a DB instance using SSL and added the description in section :ref:`Connecting to a Cluster Instance Over Private Networks `. | +| | - Modified the note in section :ref:`Replica Set `. | +| | - Accepted in OTC-3.2. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-09-10 | Modified the following content: | +| | | +| | - Deleted the release numbers and retained the release dates only in accordance with the unified public cloud style. | +| | - Modified the description about the parameter group quotas in section :ref:`Creating a Parameter Template `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-08-31 | Modified the following content: | +| | | +| | - Supported case-sensitive manual backup names in section :ref:`Creating a Manual Backup `. | +| | - Modified commands supported and restricted by DDS in section :ref:`Which Commands are Supported or Restricted by DDS? ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-08-17 | Modified the following content: | +| | | +| | - Modified the description of high-availability replica sets in section :ref:`Replica Set `. | +| | - Modified the description about the parameter group quotas in section :ref:`Creating a Manual Backup `. | +| | - Optimized the description of the step following the successful creation of a DB instance in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | +| | - Changed **HA Type** to **DB Instance Type** displayed on the page for creating a DB instance, optimized the buttons of the warning dialog box of restart and delete operations, and synchronized the changes to the document. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-08-03 | Added the following content: | +| | | +| | - :ref:`Replica Set ` | +| | - :ref:`Creating a Replica Set Instance ` | +| | - :ref:`Restoring a Replica Set Instance from a Backup ` | +| | - :ref:`What Is the Time Delay for Primary/Secondary Synchronization in a Replica Set? ` | +| | - :ref:`Tag Management ` | +| | | +| | Modified the following content: | +| | | +| | - Supported the creation of the replica set DB instance in sections :ref:`Changing a DB Instance Name `, :ref:`Restarting a DB Instance or a Node `, :ref:`Deleting a DB Instance `, :ref:`Setting Automated Backup Policy `, :ref:`Creating a Manual Backup `, :ref:`Deleting a Manual Backup `, :ref:`Deleting an Automated Backup `, :ref:`Scaling Up Storage Space `, :ref:`Connection Management `, and :ref:`DDS Metrics `. | +| | - Supported disk encryption in sections :ref:`Creating a Cluster Instance ` and :ref:`Creating a Replica Set Instance `. | +| | - Changed the length of the instance name to 4 to 64 characters in sections :ref:`Creating a Cluster Instance `, :ref:`Creating a Replica Set Instance `, and :ref:`Changing a DB Instance Name `. | +| | - Supported the batch querying of error logs of all nodes, all mongos, all shards, and all configs of a cluster instance and supported the querying of error logs of all nodes of a replica set instance in section :ref:`Error Log `. | +| | - Supported the batch querying of slow query logs of all nodes of a replica set instance in section :ref:`Slow Query Log `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-07-03 | Accepted in OTC-3.1. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-06-27 | Added the following content: | +| | | +| | - :ref:`Deleting an Automated Backup ` | +| | | +| | Modified the following content: | +| | | +| | - Changed the number of days for retaining automated backups and the restriction on the backup cycle in section :ref:`Setting Automated Backup Policy `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-06-21 | Modified the following content: | +| | | +| | - Modified the procedure for creating a DB instance and fixed the storage space of config at 20 GB in section :ref:`Creating a Cluster Instance `. | +| | - Supported the enabling or disabling the automated backup policy in section :ref:`Setting Automated Backup Policy `. | +| | - Moved the subsection "Monitoring" in chapter "Managing DDS DB Instances" to a new section :ref:`Monitoring and Alarm Reporting `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-06-04 | Modified the following content: | +| | | +| | - Modified the description of disk encryption and detailed the description of the HA type and storage type in section :ref:`Creating a Cluster Instance `. | +| | - Modified the description of the **pwd** parameter in section :ref:`Creating a Database Account Using Commands `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-05-04 | Added the following content: | +| | | +| | - :ref:`Creating a Database Account Using Commands ` | +| | - :ref:`Reverting and Deleting Failed Cluster Instance Nodes ` | +| | | +| | Modified the following content: | +| | | +| | - Supported disk encryption, enabled the setting of DB instance name on the page for creating a DB instance, and changed the range of the config storage space in section :ref:`Creating a Cluster Instance `. | +| | - Supported the deletion of node that fails to be added in section :ref:`Adding Nodes to a Cluster `. | +| | - Supported the viewing of slow logs of all shards in section :ref:`Slow Query Log `. | +| | - Modified commands supported and restricted by DDS in section :ref:`Which Commands are Supported or Restricted by DDS? ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-03-09 | Modified the following content: | +| | | +| | - Modified the description of DDS and changed its location in section :ref:`What Is DDS? ` | +| | - Added the tag editing function in section :ref:`Tag Management `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-02-23 | Added the following content: | +| | | +| | - :ref:`Tag Management ` | +| | | +| | Modified the following content: | +| | | +| | - Added the description in section :ref:`Setting Automated Backup Policy `: If you set the retention period to one or more days, the backup policy is enabled and a full automated backup is triggered instantly. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-02-19 | Accepted in OTC-3.0. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-02-09 | Modified the following content: | +| | | +| | - Optimized commands in sections :ref:`Connecting to a Cluster Instance Over Private Networks ` and :ref:`Migrating Data `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-02-02 | Added the following content: | +| | | +| | - :ref:`Glossary ` | +| | | +| | Modified the following content: | +| | | +| | - Added the description of DDS in section :ref:`What Is DDS? ` | +| | - Modified the definition of cluster in section :ref:`Cluster `. | +| | - Modified the description of the automated backup policy in section :ref:`Setting Automated Backup Policy `. | +| | - Modified the description of effect on backups when instances and cloud account are deleted in sections :ref:`Deleting a DB Instance ` and :ref:`Will My Backups Be Deleted If I Delete My Cloud Account? ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-01-30 | This issue is the first official release. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/connection_management/changing_a_private_ip_address.rst b/umn/source/connection_management/changing_a_private_ip_address.rst new file mode 100644 index 0000000..13dc9d9 --- /dev/null +++ b/umn/source/connection_management/changing_a_private_ip_address.rst @@ -0,0 +1,31 @@ +:original_name: dds_03_0070.html + +.. _dds_03_0070: + +Changing a Private IP Address +============================= + +**Scenarios** +------------- + +After a database is migrated from on-premises or other cloud platforms to DDS, the private IP address of the database may be changed. DDS allows you to change the private IP address, reducing migration costs. + +Constraints +----------- + +Changing the private IP address of a node will invalidate the previous private IP address. After the change, the new private IP address is bound to the EIP. + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` + +#. In the left navigation pane, choose **Instance Management**. In the DB instance list, click the target cluster instance to go to the **Basic Information** page. + + Alternatively, on the **Basic Information** page, in the navigation pane on the left, click **Connections**. + +#. In the **Node Information** area, locate the target node and in the **Operation** column, click **Change Private IP Address**. + +#. In the displayed dialog box, enter a private IP address that is not in use and click **OK**. + +#. In the **Node Information** area, locate the target node and view the new private IP address. diff --git a/umn/source/connection_management/changing_a_security_group.rst b/umn/source/connection_management/changing_a_security_group.rst new file mode 100644 index 0000000..a6212e2 --- /dev/null +++ b/umn/source/connection_management/changing_a_security_group.rst @@ -0,0 +1,39 @@ +:original_name: dds_03_change_security_group.html + +.. _dds_03_change_security_group: + +Changing a Security Group +========================= + +**Scenarios** +------------- + +This section guides you on how to change a security group for cluster, replica set, and single node instances. If any of the following operations is in progress, do not change the security group: + +- Adding nodes +- Migrating data + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, click the instance name. The **Basic Information** page is displayed. + +#. In the **Network Information** area on the **Basic Information** page, click |image1| to select the security group to which the DB instance belongs. + + You can also choose **Connections** in the navigation pane on the left. On the **Private Connection** tab, in the **Security Group** area, click |image2| to select the security group to which the DB instance belongs. + + .. important:: + + Ensure that the new security group does not affect the DB instance connection. Otherwise, the connection may be interrupted. + + - To submit the change, click |image3|. This process takes about 1 to 3 minutes. + - To cancel the change, click |image4|. + +#. View the modification result. + +.. |image1| image:: /_static/images/en-us_image_0000001280327773.png +.. |image2| image:: /_static/images/en-us_image_0000001236447314.png +.. |image3| image:: /_static/images/en-us_image_0000001143053837.png +.. |image4| image:: /_static/images/en-us_image_0000001142773933.png diff --git a/umn/source/connection_management/changing_the_database_port.rst b/umn/source/connection_management/changing_the_database_port.rst new file mode 100644 index 0000000..e0b1159 --- /dev/null +++ b/umn/source/connection_management/changing_the_database_port.rst @@ -0,0 +1,45 @@ +:original_name: dds_03_change_database_port.html + +.. _dds_03_change_database_port: + +Changing the Database Port +========================== + +**Scenarios** +------------- + +This section guides you on how to modify the database port. The database port cannot be changed when the instance is in any of the following statuses: + +- Restarting +- Adding node +- Switching SSL +- Changing instance class +- Deleting node +- Creation failed + +- Creating + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed. + +#. In the **Network Information** area, click |image1| to right of the **Database Port** field. + + Alternatively, in the navigation pane on the left, choose **Connections.** + +#. In the **Basic Information** area, click |image2| to right of the **Database Port** field. + + The database port range is 2100 to 9500. + + - To submit the change, click |image3|. This process takes about 1 to 5 minutes. + - To cancel the change, click |image4|. + +#. View the modification result. + +.. |image1| image:: /_static/images/en-us_image_0000001193610755.png +.. |image2| image:: /_static/images/en-us_image_0000001143053853.png +.. |image3| image:: /_static/images/en-us_image_0000001096133910.png +.. |image4| image:: /_static/images/en-us_image_0000001096133912.png diff --git a/umn/source/connection_management/configuring_cross-cidr_access_for_replica_set_instances.rst b/umn/source/connection_management/configuring_cross-cidr_access_for_replica_set_instances.rst new file mode 100644 index 0000000..4de5492 --- /dev/null +++ b/umn/source/connection_management/configuring_cross-cidr_access_for_replica_set_instances.rst @@ -0,0 +1,37 @@ +:original_name: dds_03_0100.html + +.. _dds_03_0100: + +Configuring Cross-CIDR Access for Replica Set Instances +======================================================= + +If a client and a replica set instance are deployed in different CIDR blocks and the client is not in 192.168.0.0/16, 172.16.0.0/24, or 10.0.0.0/8, configure Cross-CIDR Access for the instance to communicate with the client. + +Precautions +----------- + +- During the configuration of cross-CIDR access, services are running properly without interruption or intermittent disconnection. +- If the client and replica set instance are in different VPCs and CIDR blocks, configure a VPC peering connection by referring to **VPC Peering Connection** in *Virtual Private Cloud User Guide*. + +**Procedure** +------------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, click the target replica set instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. On the **Address** area, click **Enable** to the right of **Cross-CIDR Access** and specify the client CIDR block details. + + .. note:: + + Up to 30 CIDR blocks can be configured, and each of them can overlap but they cannot be the same. That is, the source CIDR blocks can overlap but cannot be the same. + +#. After cross-CIDR access is enabled, **Enabled** is displayed to the right of **Cross-CIDR Access**. + + If you need to change the client CIDR block, click **Change** to the right of **Cross-CIDR Access**. + + .. note:: + + - To ensure the ECS and the DB instance can communicate with each other, configure the connection by referring to section "VPC Peering Connection Overview" in the *Virtual Private Cloud User Guide*. diff --git a/umn/source/connection_management/enabling_ip_addresses_of_shard_and_config_nodes.rst b/umn/source/connection_management/enabling_ip_addresses_of_shard_and_config_nodes.rst new file mode 100644 index 0000000..d0856b4 --- /dev/null +++ b/umn/source/connection_management/enabling_ip_addresses_of_shard_and_config_nodes.rst @@ -0,0 +1,102 @@ +:original_name: dds_02_0100.html + +.. _dds_02_0100: + +Enabling IP Addresses of shard and config Nodes +=============================================== + +Scenarios +--------- + +A cluster instance of Community Edition consists of mongos, shard, and config nodes. When your services need to read and write data from and into databases, connect to the mongos node. In certain scenarios, you need to read data from the shard or config node. Therefore, obtaining the IP address of the corresponding node is necessary. + +This section describes how to obtain the IP addresses of the shard and config nodes. + +Before You Start +---------------- + +- DDS supports cluster instances of Community Edition 3.2, 3.4, 4.0, and 4.2. +- DDS creates two connection addresses for the primary node and secondary node in a shard respectively. +- Once the connection addresses are assigned to your nodes, they cannot be modified or deleted. +- The connection address is accessible from private networks only. + +Enabling shard IP Address +------------------------- + +#. :ref:`Log in to the DDS console. ` + +#. In the left navigation pane, choose **Instance Management**. In the DB instance list, click the target cluster instance to go to the **Basic Information** page. + + Alternatively, on the **Basic Information** page, in the navigation pane on the left, click **Connections**. + +#. In the **Node Information** area, click the **shard** tab. + +#. Click **Show shard IP Address**. In the displayed dialog box, enter and confirm the password for connecting to the node. + + .. note:: + + - After the shard IP address is enabled, you need to restart the corresponding shard nodes for the configuration to take effect. + - The shard IP address cannot be modified or disabled after being enabled, and the password cannot be modified. + - After the shard IP address is enabled and new shard nodes are added, you need to manually locate the newly added shard node and choose **More** > **Show shard IP Address** in the **Operation** column to show the shard IP address. + - After the shard IP address is enabled, all shard nodes in the current instance apply for connection addresses. + +#. .. _dds_02_0100__li79582518253: + + Obtain the private IP address of the shard node. + + After the shard IP address is enabled, you can click **Connections** in the navigation pane on the left or on the current page to expand the node drop-down list and obtain the private IP address. + +#. Obtain the connection address of a shard node. + + Example: + + Based on the private IP address obtained in :ref:`5 `, the connection address of the current shard node is as follows: + + mongodb://**sharduser:@192.168.237.15:8637,192.168.255.217:8637**/test?authSource=admin&replicaSet=shard_? + + .. note:: + + - **sharduser** is the default user when setting up "show shard IP address" function. + - ****\ indicates the password of the sharduser. + - **192.168.237.15** and **192.168.255.217** are the private IP addresses of the shard's primary and secondary nodes. + - **8637** is the port of the shard node and cannot be changed. + - **shard_?** indicates the name of the shard node to be connected, for example, shard_1. + +Enabling config IP Address +-------------------------- + +#. :ref:`Log in to the DDS console. ` + +#. In the left navigation pane, choose **Instance Management**. In the DB instance list, click the target cluster instance to go to the **Basic Information** page. + + Alternatively, on the **Basic Information** page, in the navigation pane on the left, click **Connections**. + +#. In the **Node Information** area, click the **config** tab. + +#. Click **Show config IP Address**. In the displayed dialog box, enter and confirm the password for connecting to the node. + + .. note:: + + - After the config IP address is enabled, you need to restart the corresponding config node for the configuration to take effect. + - The config IP address cannot be modified or disabled after being enabled, and the password cannot be modified. + +#. .. _dds_02_0100__li1225175894219: + + Obtain the private IP address of the config node. + + After the config IP address is enabled, you can click **Connections** in the navigation pane on the left or on the current page to expand the node drop-down list and obtain the private IP address. + +#. Obtain the connection address of a config node. + + Example: + + Based on the private IP address obtained in :ref:`5 `, the connection address of the current config node is as follows: + + mongodb://**csuser:@192.168.154.71:8636,192.168.143.227:8636**/test?authSource=admin&replicaSet=config + + .. note:: + + - **csuser** indicates the username of the current config node. + - ****\ indicates the password of the csuser. + - **192.168.154.71** and **192.168.143.227** are the private IP addresses of the current node. + - **8636** is the port of the config node and cannot be changed. diff --git a/umn/source/connection_management/enabling_or_disabling_ssl.rst b/umn/source/connection_management/enabling_or_disabling_ssl.rst new file mode 100644 index 0000000..6342d99 --- /dev/null +++ b/umn/source/connection_management/enabling_or_disabling_ssl.rst @@ -0,0 +1,54 @@ +:original_name: dds_03_0074.html + +.. _dds_03_0074: + +Enabling or Disabling SSL +========================= + +**Scenarios** +------------- + +DDS allows you to use SSL to encrypt connections to a DB instance to protect your data. + +- If SSL is enabled, you can connect to a DB instance using SSL. For details, see sections about connecting to a DB instance using SSL over public or private networks in this document. +- If SSL is disabled, you can connect to the DB instance using an unencrypted connection. For details, see sections about connecting to a DB instance using an unencrypted connection over public or private networks in this document. + +.. important:: + + - For security purposes, disabling SSL is not advised. + - Enabling or disabling SSL will cause DB instance restart. Exercise caution when you perform this operation. + +.. _dds_03_0074__en-us_topic_0049044698_section45421719172826: + +Enabling SSL +------------ + +#. On the **Instance Management** page, click the target DB instance. + +#. In the **DB Information** area on the **Basic Information** page, click |image1| next to the **SSL** field. + + Alternatively, in the navigation pane on the left, choose **Connections**. In the **Basic Information** area, click |image2| next to the **SSL** field. + +#. In the displayed dialog box, click **Yes**. + +#. In the **Basic Information** area, view the modification result. + +.. _dds_03_0074__section4225593518277: + +Disabling SSL +------------- + +#. On the **Instance Management** page, click the target DB instance. + +#. In the **DB Information** area on the **Basic Information** page, click |image3| next to the **SSL** field. + + Alternatively, in the navigation pane on the left, choose **Connections**. In the **Basic Information** area, click |image4| next to the **SSL** field. + +#. In the displayed dialog box, click **Yes**. + +#. In the **Basic Information** area, view the modification result. + +.. |image1| image:: /_static/images/en-us_image_0000001142893907.png +.. |image2| image:: /_static/images/en-us_image_0000001143133859.png +.. |image3| image:: /_static/images/en-us_image_0000001142773959.png +.. |image4| image:: /_static/images/en-us_image_0000001143053861.png diff --git a/umn/source/connection_management/index.rst b/umn/source/connection_management/index.rst new file mode 100644 index 0000000..d45edb2 --- /dev/null +++ b/umn/source/connection_management/index.rst @@ -0,0 +1,24 @@ +:original_name: dds_03_0019.html + +.. _dds_03_0019: + +Connection Management +===================== + +- :ref:`Enabling or Disabling SSL ` +- :ref:`Configuring Cross-CIDR Access for Replica Set Instances ` +- :ref:`Enabling IP Addresses of shard and config Nodes ` +- :ref:`Changing a Private IP Address ` +- :ref:`Changing the Database Port ` +- :ref:`Changing a Security Group ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + enabling_or_disabling_ssl + configuring_cross-cidr_access_for_replica_set_instances + enabling_ip_addresses_of_shard_and_config_nodes + changing_a_private_ip_address + changing_the_database_port + changing_a_security_group diff --git a/umn/source/database_commands/index.rst b/umn/source/database_commands/index.rst new file mode 100644 index 0000000..5676a23 --- /dev/null +++ b/umn/source/database_commands/index.rst @@ -0,0 +1,14 @@ +:original_name: dds_03_0080.html + +.. _dds_03_0080: + +Database Commands +================= + +- :ref:`Which Commands are Supported or Restricted by DDS? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + which_commands_are_supported_or_restricted_by_dds diff --git a/umn/source/database_commands/which_commands_are_supported_or_restricted_by_dds.rst b/umn/source/database_commands/which_commands_are_supported_or_restricted_by_dds.rst new file mode 100644 index 0000000..035c744 --- /dev/null +++ b/umn/source/database_commands/which_commands_are_supported_or_restricted_by_dds.rst @@ -0,0 +1,334 @@ +:original_name: dds_03_0033.html + +.. _dds_03_0033: + +Which Commands are Supported or Restricted by DDS? +================================================== + +The following tables list the commands supported and restricted by DDS. + +For more information, see `official MongoDB documentation `__. + +.. note:: + + Users cannot execute a system command. + +.. table:: **Table 1** Commands supported and restricted by DDS + + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Type | Command | Supported | Description | + +====================================+================================+===========+===============================================================================================================================================================+ + | Aggregates Commands | aggregate | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | count | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | distinct | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | group | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | mapReduce | Y | This command can be used only when the **security.javascriptEnabled** parameter in the parameter template associated with the DB instance is set to **true**. | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Geospatial Commands | geoNear | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | geoSearch | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Query and Write Operation Commands | find | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | insert | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | update | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | delete | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | findAndModify | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getMore | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getLastError | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | resetError | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getPrevError | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | parallelCollectionScan | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Query Plan Cache Commands | planCacheListFilters | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | planCacheSetFilter | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | planCacheClearFilters | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | planCacheListQueryShapes | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | planCacheListPlans | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | planCacheClear | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Authentication Commands | logout | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | authenticate | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | copydbgetnonce | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getnonce | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | authSchemaUpgrade | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | User Management Commands | createUser | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | updateUser | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dropUser | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dropAllUsersFromDatabase | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | grantRolesToUser | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | revokeRolesFromUser | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | usersInfo | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Role Management Commands | invalidateUserCache | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | createRole | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | updateRole | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dropRole | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dropAllRolesFromDatabase | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | grantPrivilegesToRole | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | revokePrivilegesFromRole | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | grantRolesToRole | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | revokeRolesFromRole | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | rolesInfo | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Replication Commands | replSetElect | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetUpdatePosition | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | appendOplogNote | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetFreeze | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetGetStatus | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetInitiate | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetMaintenance | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetReconfig | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetStepDown | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetSyncFrom | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetRequestVotes | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetDeclareElectionWinner | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | resync | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | applyOps | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | isMaster | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetGetConfig | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Sharding Commands | flushRouterConfig | x | High-risk commands | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | addShard | x | Unauthorized operation | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | addShardToZone | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | balancerStart | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | balancerStatus | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | balancerStop | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | removeShardFromZone | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | updateZoneKeyRange | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | cleanupOrphaned | x | High-risk commands | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | checkShardingIndex | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | enableSharding | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | listShards | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | removeShard | x | High-risk commands | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getShardMap | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getShardVersion | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | mergeChunks | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | setShardVersion | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | shardCollection | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | shardingState | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | unsetSharding | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | split | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | splitChunk | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | splitVector | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | moveChunk | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | movePrimary | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | isdbgrid | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Administration Commands | setFeatureCompatibilityVersion | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | renameCollection | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dropDatabase | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | listCollections | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | drop | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | create | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | clone | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | cloneCollection | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | cloneCollectionAsCapped | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | convertToCapped | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | filemd5 | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | createIndexes | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | listIndexes | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dropIndexes | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | fsync | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | clean | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | connPoolSync | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | connectionStatus | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | compact | x | High-risk commands | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | collMod | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | reIndex | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | setParameter | x | System configuration command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getParameter | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | repairDatabase | x | High-risk commands | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | repairCursor | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | touch | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | shutdown | x | High-risk commands | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | logRotate | x | High-risk commands | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | killOp | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Diagnostic Commands | availableQueryOptions | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | buildInfo | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | collStats | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | connPoolStats | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | cursorInfo | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dataSize | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dbHash | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | dbStats | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | diagLogging | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | driverOIDTest | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | explain | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | features | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getCmdLineOpts | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | getLog | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | hostInfo | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | isSelf | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | listCommands | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | listDatabases | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | netstat | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ping | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | profile | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | serverStatus | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | shardConnPoolStats | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | top | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | validate | x | System configuration command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | whatsmyuri | Y | ``-`` | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Internal Commands | handshake | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | \_recvChunkAbort | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | \_recvChunkCommit | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | \_recvChunkStart | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | \_recvChunkStatus | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | \_replSetFresh | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | mapreduce.shardedfinish | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | \_transferMods | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetHeartbeat | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetGetRBID | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | \_migrateClone | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | replSetElect | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | writeBacksQueued | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | writebacklisten | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | System Events Auditing Commands | logApplicationMessage | x | System command | + +------------------------------------+--------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/faqs/backup_and_restoration/how_do_i_back_up_dds_databases_to_an_ecs.rst b/umn/source/faqs/backup_and_restoration/how_do_i_back_up_dds_databases_to_an_ecs.rst new file mode 100644 index 0000000..d0e048b --- /dev/null +++ b/umn/source/faqs/backup_and_restoration/how_do_i_back_up_dds_databases_to_an_ecs.rst @@ -0,0 +1,8 @@ +:original_name: dds_faq_0025.html + +.. _dds_faq_0025: + +How Do I Back Up DDS Databases to an ECS? +========================================= + +You can store DDS backup data on the ECS using mongoexport. However, you are advised not to store database backups on ECSs. To ensure high data reliability and service assurance, you can use the DDS backup function to store backups to a professional storage object, such as OBS. diff --git a/umn/source/faqs/storage_faqs/how_long_does_dds_store_backup_data_for.rst b/umn/source/faqs/backup_and_restoration/how_long_does_dds_store_backup_data_for.rst similarity index 100% rename from umn/source/faqs/storage_faqs/how_long_does_dds_store_backup_data_for.rst rename to umn/source/faqs/backup_and_restoration/how_long_does_dds_store_backup_data_for.rst diff --git a/umn/source/faqs/backup_and_restoration/index.rst b/umn/source/faqs/backup_and_restoration/index.rst new file mode 100644 index 0000000..9674035 --- /dev/null +++ b/umn/source/faqs/backup_and_restoration/index.rst @@ -0,0 +1,16 @@ +:original_name: dds_faq_0109.html + +.. _dds_faq_0109: + +Backup and Restoration +====================== + +- :ref:`How Do I Back Up DDS Databases to an ECS? ` +- :ref:`How Long Does DDS Store Backup Data For? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + how_do_i_back_up_dds_databases_to_an_ecs + how_long_does_dds_store_backup_data_for diff --git a/umn/source/faqs/common_faqs/can_i_use_a_template_to_create_dds_db_instances.rst b/umn/source/faqs/common_faqs/can_i_use_a_template_to_create_dds_db_instances.rst deleted file mode 100644 index e291c1d..0000000 --- a/umn/source/faqs/common_faqs/can_i_use_a_template_to_create_dds_db_instances.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: dds_faq_0003.html - -.. _dds_faq_0003: - -Can I Use a Template to Create DDS DB Instances? -================================================ - -You do not need a template to create DDS DB instances. When you create a DB instance, DDS provides different DB instance specifications which are similar to templates. diff --git a/umn/source/faqs/connection_and_access_faqs/can_an_external_server_access_the_dds_db_instance.rst b/umn/source/faqs/connection_and_access_faqs/can_an_external_server_access_the_dds_db_instance.rst deleted file mode 100644 index d11d5ec..0000000 --- a/umn/source/faqs/connection_and_access_faqs/can_an_external_server_access_the_dds_db_instance.rst +++ /dev/null @@ -1,11 +0,0 @@ -:original_name: dds_faq_0011.html - -.. _dds_faq_0011: - -Can an External Server Access the DDS DB Instance? -================================================== - -You can access the DDS DB instance using the following methods: - -- Create a DDS DB instance and an ECS in the same VPC to enable the ECS to access the instance. -- If the DDS DB instance has an EIP assigned, you can access the instance through the EIP. diff --git a/umn/source/faqs/connection_and_access_faqs/do_applications_need_to_support_automatic_reconnecting_to_the_dds_database.rst b/umn/source/faqs/connection_and_access_faqs/do_applications_need_to_support_automatic_reconnecting_to_the_dds_database.rst deleted file mode 100644 index 0a86ad8..0000000 --- a/umn/source/faqs/connection_and_access_faqs/do_applications_need_to_support_automatic_reconnecting_to_the_dds_database.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: dds_faq_0017.html - -.. _dds_faq_0017: - -Do Applications Need to Support Automatic Reconnecting to the DDS Database? -=========================================================================== - -It is recommended that your applications support automatic reconnections to the database. After a database reboot, your applications will automatically reconnect to the database to increase service availability and continuity. - -In addition, you are advised to set your applications to connect to the database using a long connection to reduce resource consumption and improve performance. diff --git a/umn/source/faqs/connection_and_access_faqs/how_can_i_create_and_log_in_to_an_ecs.rst b/umn/source/faqs/connection_and_access_faqs/how_can_i_create_and_log_in_to_an_ecs.rst deleted file mode 100644 index 8fc01fb..0000000 --- a/umn/source/faqs/connection_and_access_faqs/how_can_i_create_and_log_in_to_an_ecs.rst +++ /dev/null @@ -1,12 +0,0 @@ -:original_name: dds_faq_0034.html - -.. _dds_faq_0034: - -How Can I Create and Log In to an ECS? -====================================== - -For details on how to create and log in to an ECS, see "Creating and Logging In to a Windows ECS" or "Creating and Logging In to a Linux ECS" in the *Elastic Cloud Server User Guide*. - -- The ECS to be created must be in the same VPC with the DDS DB instance to which it connects. -- When you create an ECS, select an OS, such as Red Hat 6.6, and bind an EIP to it. -- Configure the security group to enable the ECS to access the DB instance through the private IP address, that is, the value of **Private IP Address** of mongos on the **Basic Information** page. diff --git a/umn/source/faqs/connection_and_access_faqs/how_can_my_applications_access_a_dds_db_instance_in_a_vpc.rst b/umn/source/faqs/connection_and_access_faqs/how_can_my_applications_access_a_dds_db_instance_in_a_vpc.rst deleted file mode 100644 index 260e194..0000000 --- a/umn/source/faqs/connection_and_access_faqs/how_can_my_applications_access_a_dds_db_instance_in_a_vpc.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: dds_faq_0016.html - -.. _dds_faq_0016: - -How Can My Applications Access a DDS DB Instance in a VPC? -========================================================== - -Ensure that the ECS where in which your applications are located is in the same VPC and subnet as the DDS DB instance. If the ECS and the DDS DB instance are in different subnets or VPCs, modify the VPC route table and network access control list (ACL) to ensure the ECS can access the DDS DB instance. diff --git a/umn/source/faqs/connection_and_access_faqs/index.rst b/umn/source/faqs/connection_and_access_faqs/index.rst deleted file mode 100644 index f735e4b..0000000 --- a/umn/source/faqs/connection_and_access_faqs/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -:original_name: dds_faq_0104.html - -.. _dds_faq_0104: - -Connection and Access FAQs -========================== - -- :ref:`Can an External Server Access the DDS DB Instance? ` -- :ref:`What Is the Number of DDS Database Connections? ` -- :ref:`What Should I Do If the ECS Cannot Connect to a DDS DB Instance? ` -- :ref:`What Should I Do If a Database Client Problem Causes a Connection Failure? ` -- :ref:`What Should I Do If a DDS Server Problem Causes a Connection Failure? ` -- :ref:`How Can My Applications Access a DDS DB Instance in a VPC? ` -- :ref:`Do Applications Need to Support Automatic Reconnecting to the DDS Database? ` -- :ref:`How Can I Create and Log In to an ECS? ` -- :ref:`How Can I Install a MongoDB Client? ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - can_an_external_server_access_the_dds_db_instance - what_is_the_number_of_dds_database_connections - what_should_i_do_if_the_ecs_cannot_connect_to_a_dds_db_instance - what_should_i_do_if_a_database_client_problem_causes_a_connection_failure - what_should_i_do_if_a_dds_server_problem_causes_a_connection_failure - how_can_my_applications_access_a_dds_db_instance_in_a_vpc - do_applications_need_to_support_automatic_reconnecting_to_the_dds_database - how_can_i_create_and_log_in_to_an_ecs - how_can_i_install_a_mongodb_client diff --git a/umn/source/faqs/connection_and_access_faqs/what_is_the_number_of_dds_database_connections.rst b/umn/source/faqs/connection_and_access_faqs/what_is_the_number_of_dds_database_connections.rst deleted file mode 100644 index a086974..0000000 --- a/umn/source/faqs/connection_and_access_faqs/what_is_the_number_of_dds_database_connections.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: dds_faq_0012.html - -.. _dds_faq_0012: - -What Is the Number of DDS Database Connections? -=============================================== - -The number of DDS database connections indicates the number of applications that can be simultaneously connected to the database. Generally, it indicates the number of connections to mongos. The number of DDS connections is irrelevant to the maximum number of users allowed by applications or websites. diff --git a/umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_a_database_client_problem_causes_a_connection_failure.rst b/umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_a_database_client_problem_causes_a_connection_failure.rst deleted file mode 100644 index 8eaa623..0000000 --- a/umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_a_database_client_problem_causes_a_connection_failure.rst +++ /dev/null @@ -1,22 +0,0 @@ -:original_name: dds_faq_0014.html - -.. _dds_faq_0014: - -What Should I Do If a Database Client Problem Causes a Connection Failure? -========================================================================== - -Identify a DDS DB instance connection failure caused by a client problem from the following aspects. - -#. ECS Security Policy - - In Windows, check whether the DDS port is enabled in the Windows security policy. - - In Linux, run the **iptables** command to check whether the DDS port is enabled in firewall settings. - -#. Application Configuration - - Check whether the IP address, port parameter, and Java database connectivity (JDBC) are configured correctly. - -.. note:: - - If the problem persists, contact post-sales technical support. diff --git a/umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_the_ecs_cannot_connect_to_a_dds_db_instance.rst b/umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_the_ecs_cannot_connect_to_a_dds_db_instance.rst deleted file mode 100644 index 21b0a2b..0000000 --- a/umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_the_ecs_cannot_connect_to_a_dds_db_instance.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: dds_faq_0013.html - -.. _dds_faq_0013: - -What Should I Do If the ECS Cannot Connect to a DDS DB Instance? -================================================================ - -Perform the following steps to identify the problem: The following uses the cluster instance as an example. - -#. Check whether the ECS and DDS DB instance are located in the same VPC. - - - If they are in the same VPC, go to :ref:`2 `. - - If they are in different VPCs, create an ECS in the VPC where the DDS DB instance is located. - -#. .. _dds_faq_0013__li10923237103639: - - Check whether a security group has been added to the ECS. - - - If yes, check whether its configuration rules are suitable. For details, see the security group description in section :ref:`Setting a Security Group `. Then, go to :ref:`3 `. - - If no security group has been added, go to the VPC console from the ECS details page and click **Security Groups** to add a security group. - -#. .. _dds_faq_0013__li2748172710406: - - On the ECS, check whether the DDS DB instance address port can be connected. - - .. code-block:: - - telnet {8635} - - - If the port can be connected, the network is normal. Check the database account and password. For details, see section :ref:`Connecting to a DB Instance Through a Client `. - - If the port cannot be connected, contact post-sales technical support for troubleshooting. diff --git a/umn/source/faqs/creation_and_deletion/index.rst b/umn/source/faqs/creation_and_deletion/index.rst new file mode 100644 index 0000000..8e3963b --- /dev/null +++ b/umn/source/faqs/creation_and_deletion/index.rst @@ -0,0 +1,16 @@ +:original_name: dds_faq_0103.html + +.. _dds_faq_0103: + +Creation and Deletion +===================== + +- :ref:`Why Is Data Missing from My Database? ` +- :ref:`Will My Backups Be Deleted If I Delete My Cloud Account? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + why_is_data_missing_from_my_database + will_my_backups_be_deleted_if_i_delete_my_cloud_account diff --git a/umn/source/faqs/management_faqs/why_is_data_missing_from_my_database.rst b/umn/source/faqs/creation_and_deletion/why_is_data_missing_from_my_database.rst similarity index 85% rename from umn/source/faqs/management_faqs/why_is_data_missing_from_my_database.rst rename to umn/source/faqs/creation_and_deletion/why_is_data_missing_from_my_database.rst index b4918e7..e3b28e9 100644 --- a/umn/source/faqs/management_faqs/why_is_data_missing_from_my_database.rst +++ b/umn/source/faqs/creation_and_deletion/why_is_data_missing_from_my_database.rst @@ -9,5 +9,5 @@ DDS does not delete or perform any operations on any user data. If this problem Solution: -- Use the DDS restoration function to restore data. For details, see section :ref:`Restoring a Cluster Instance from a Backup `. +- Use the DDS restoration function to restore data. For details, see chapter "Backup and Restore" in the *Document Database Service User Guide*. - Import backups to DDS. For details, see section :ref:`Migrating Data `. diff --git a/umn/source/faqs/management_faqs/will_my_backups_be_deleted_if_i_delete_my_cloud_account.rst b/umn/source/faqs/creation_and_deletion/will_my_backups_be_deleted_if_i_delete_my_cloud_account.rst similarity index 100% rename from umn/source/faqs/management_faqs/will_my_backups_be_deleted_if_i_delete_my_cloud_account.rst rename to umn/source/faqs/creation_and_deletion/will_my_backups_be_deleted_if_i_delete_my_cloud_account.rst diff --git a/umn/source/faqs/connection_and_access_faqs/how_can_i_install_a_mongodb_client.rst b/umn/source/faqs/database_connection/how_can_i_install_a_mongodb_client.rst similarity index 74% rename from umn/source/faqs/connection_and_access_faqs/how_can_i_install_a_mongodb_client.rst rename to umn/source/faqs/database_connection/how_can_i_install_a_mongodb_client.rst index e0ce751..574c357 100644 --- a/umn/source/faqs/connection_and_access_faqs/how_can_i_install_a_mongodb_client.rst +++ b/umn/source/faqs/database_connection/how_can_i_install_a_mongodb_client.rst @@ -14,26 +14,27 @@ Procedure #. Obtain the installation package. - a. Log in at https://www.mongodb.com/download-center#community. + a. Log in at https://www.mongodb.com/download-center/community. b. Choose **Server**, select **RHEL 7.0 Linux 64-bit x64** for **OS**, and click **All version binaries**. :ref:`Figure 1 ` shows an example. .. _dds_faq_0018__fig129943125910: - .. figure:: /_static/images/en-us_image_0284275178.png + .. figure:: /_static/images/en-us_image_0000001096453900.png :alt: **Figure 1** MongoDB official webpage **Figure 1** MongoDB official webpage - c. Open the downloading page, click **linux/mongodb-linux-x86_64-rhel70-3.4.0.tgz** to download the binary installation package of MongoDB 3.4.0. + c. Open the downloading page, click **linux/mongodb-linux-x86_64-rhel70-3.4.0.tgz** to download the binary installation package of MongoDB 3.4.0. :ref:`Figure 2 ` shows an example. + .. _dds_faq_0018__fig12339163313218: - .. figure:: /_static/images/en-us_image_0284275230.png + .. figure:: /_static/images/en-us_image_0000001142893909.png :alt: **Figure 2** Downloading page **Figure 2** Downloading page -#. Upload the installation package to the ECS. For details about how to log in to an ECS, see :ref:`How Can I Create and Log In to an ECS? ` +#. Upload the installation package to the ECS. For details about how to log in to an ECS. #. Decompress the installation package on the ECS. @@ -57,5 +58,6 @@ Procedure #. Connect to a DB instance through the installed client. - - For details on how to connect to a cluster instance, see :ref:`Connecting to a DB Instance Through a Client `. - - For details on how to connect to a replica set instance, see :ref:`Connecting to a DB Instance Through a Client `. + - For details on how to connect to a cluster instance, see :ref:`Connecting to a Cluster Instance Over Private Networks `. + - For details on how to connect to a replica set instance, see :ref:`Connecting to a Replica Set Instance Over Private Networks `. + - For details on how to connect to a single node instance, see :ref:`Connecting to a Single Node Instance Over Private Networks `. diff --git a/umn/source/faqs/database_connection/how_do_i_install_robo_3t.rst b/umn/source/faqs/database_connection/how_do_i_install_robo_3t.rst new file mode 100644 index 0000000..18e2435 --- /dev/null +++ b/umn/source/faqs/database_connection/how_do_i_install_robo_3t.rst @@ -0,0 +1,43 @@ +:original_name: dds_faq_0039.html + +.. _dds_faq_0039: + +How Do I Install Robo 3T? +========================= + +This section describes how to obtain the Robo 3T installation package and install Robo 3T. + +Procedure +--------- + +#. Download Robo 3T from https://robomongo.org/download. + + + .. figure:: /_static/images/en-us_image_0000001095974106.png + :alt: **Figure 1** Downloading page + + **Figure 1** Downloading page + +#. In the displayed dialog box, download **robo3t-1.3.1-windows-x86_64-7419c406.exe**. + + + .. figure:: /_static/images/en-us_image_0000001096133932.png + :alt: **Figure 2** Downloading Robo 3T + + **Figure 2** Downloading Robo 3T + +#. Double-click the **robo3t-1.3.1-windows-x86_64-7419c406.exe** file to start the installation. + +#. After the installation is complete, start the tool. + + + .. figure:: /_static/images/en-us_image_0000001142893921.png + :alt: **Figure 3** Main window + + **Figure 3** Main window + +#. Connect to a DB instance. + + - For details on how to connect to a cluster instance, see :ref:`Connecting to a Cluster Instance Over Public Networks `. + - For details on how to connect to a replica set instance, see :ref:`Connecting to a Replica Set Instance Over Public Networks `. + - For details on how to connect to a single node instance, see :ref:`Connecting to a Single Node Instance Over Public Networks `. diff --git a/umn/source/faqs/database_connection/index.rst b/umn/source/faqs/database_connection/index.rst new file mode 100644 index 0000000..3c437bf --- /dev/null +++ b/umn/source/faqs/database_connection/index.rst @@ -0,0 +1,22 @@ +:original_name: dds_faq_0104.html + +.. _dds_faq_0104: + +Database Connection +=================== + +- :ref:`What Is the Number of DDS Database Connections? ` +- :ref:`What Should I Do If an ECS Cannot Connect to a DDS DB Instance? ` +- :ref:`What Should I Do If a DDS Server Problem Causes a Connection Failure? ` +- :ref:`How Can I Install a MongoDB Client? ` +- :ref:`How Do I Install Robo 3T? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + what_is_the_number_of_dds_database_connections + what_should_i_do_if_an_ecs_cannot_connect_to_a_dds_db_instance + what_should_i_do_if_a_dds_server_problem_causes_a_connection_failure + how_can_i_install_a_mongodb_client + how_do_i_install_robo_3t diff --git a/umn/source/faqs/database_connection/what_is_the_number_of_dds_database_connections.rst b/umn/source/faqs/database_connection/what_is_the_number_of_dds_database_connections.rst new file mode 100644 index 0000000..a0c3b9c --- /dev/null +++ b/umn/source/faqs/database_connection/what_is_the_number_of_dds_database_connections.rst @@ -0,0 +1,12 @@ +:original_name: dds_faq_0012.html + +.. _dds_faq_0012: + +What Is the Number of DDS Database Connections? +=============================================== + +The number of connections indicates the number of applications that can be simultaneously connected to the database. The number of connections is irrelevant to the maximum number of users allowed by your applications or websites. + +- For a cluster instance, the number of connections indicates the number of connections between the client and the mongos. +- For a replica set instance, the number of connections indicates the number of connections between the client and the primary and secondary nodes. +- For a single-node instance, the number of connections indicates the number of connections between the client and the node. diff --git a/umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_a_dds_server_problem_causes_a_connection_failure.rst b/umn/source/faqs/database_connection/what_should_i_do_if_a_dds_server_problem_causes_a_connection_failure.rst similarity index 74% rename from umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_a_dds_server_problem_causes_a_connection_failure.rst rename to umn/source/faqs/database_connection/what_should_i_do_if_a_dds_server_problem_causes_a_connection_failure.rst index 1e34d06..96c9b6c 100644 --- a/umn/source/faqs/connection_and_access_faqs/what_should_i_do_if_a_dds_server_problem_causes_a_connection_failure.rst +++ b/umn/source/faqs/database_connection/what_should_i_do_if_a_dds_server_problem_causes_a_connection_failure.rst @@ -11,6 +11,4 @@ Check whether the following problems occur on the DDS database. Check the follow **Solution**: Use the Cloud Eye resource monitoring function to check whether the number of current connections and the CPU usage are normal. If the number of connections or CPU usage reaches the maximum, restart the DDS database, disconnect DB instances, or increase the node quantity. -#. DB instance status is normal, such as a restarting or system failure. - - **Solution**: Restart the DB instance to see if the problem is resolved. If the problem persists, contact post-sales technical support. +#. Otherwise try to restart the DB instance to see if the problem is resolved. If the problem persists, contact post-sales technical support. diff --git a/umn/source/faqs/database_connection/what_should_i_do_if_an_ecs_cannot_connect_to_a_dds_db_instance.rst b/umn/source/faqs/database_connection/what_should_i_do_if_an_ecs_cannot_connect_to_a_dds_db_instance.rst new file mode 100644 index 0000000..a706efe --- /dev/null +++ b/umn/source/faqs/database_connection/what_should_i_do_if_an_ecs_cannot_connect_to_a_dds_db_instance.rst @@ -0,0 +1,69 @@ +:original_name: dds_faq_0013.html + +.. _dds_faq_0013: + +What Should I Do If an ECS Cannot Connect to a DDS DB Instance? +=============================================================== + +Perform the following steps to identify the problem: + +.. _dds_faq_0013__section10677164802818: + +Replica Set Instance +-------------------- + +#. Check whether the ECS and replica set instance are in the same VPC. + + - If yes, go to :ref:`3 `. + - If no, configure the VPC peering connection. For details, see "VPC Peering Connection" in *Virtual Private Cloud User Guide*. Then, go to :ref:`2 `. + +#. .. _dds_faq_0013__li484115308155: + + Check whether the client and replica set instance are deployed in different CIDR blocks and whether the CIDR block of the client is not 192.168.0.0/16, 172.16.0.0/24, or 10.0.0.0/8. + + - If yes, go to :ref:`Configuring Cross-CIDR Access for Replica Set Instances ` and then go to :ref:`3 `. + - If no, go to :ref:`3 `. + +#. .. _dds_faq_0013__li78427303150: + + Check whether a security group has been associated with the ECS. + + - If yes, check whether the security group rules are suitable. For details, see :ref:`Setting a Security Group `. Then, go to :ref:`4 `. + - If no, go to the VPC console from the ECS details page and click **Security Groups** to add a security group. + +#. .. _dds_faq_0013__li984263071514: + + On the ECS, check whether the DDS instance address port can be connected. + + .. code-block:: + + telnet {8635} + + - If yes, the network is normal. Check the database username and password. For details, see :ref:`Connecting to a Replica Set Instance Over Private Networks `. + - If the ECS still cannot connect to the instance port, contact technical support. + +Cluster and Single Node Instances +--------------------------------- + +#. Check whether the ECS and DDS instance are located in the same VPC. + + - If yes, go to :ref:`2 `. + - If no, create an ECS in the VPC where the DDS instance is located. + +#. .. _dds_faq_0013__li10923237103639: + + Check whether a security group has been associated with the ECS. + + - If yes, check whether the security group rules are suitable. For details, see :ref:`Setting a Security Group `. Then, go to :ref:`3 `. + - If no, go to the VPC console from the ECS details page and click **Security Groups** to add a security group. + +#. .. _dds_faq_0013__li2748172710406: + + On the ECS, check whether the DDS instance address port can be connected. + + .. code-block:: + + telnet {8635} + + - If yes, the network is normal. Check the database username and password. For details, see :ref:`Connecting to a Cluster Instance Over Private Networks `. + - If the ECS still cannot connect to the instance port, contact technical support. diff --git a/umn/source/faqs/database_performance/index.rst b/umn/source/faqs/database_performance/index.rst new file mode 100644 index 0000000..350aab5 --- /dev/null +++ b/umn/source/faqs/database_performance/index.rst @@ -0,0 +1,16 @@ +:original_name: dds_faq_0102.html + +.. _dds_faq_0102: + +Database Performance +==================== + +- :ref:`What Should I Do If My Query Is Slow? ` +- :ref:`What Is the Time Delay for Primary/Secondary Synchronization in a Replica Set? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + what_should_i_do_if_my_query_is_slow + what_is_the_time_delay_for_primary_secondary_synchronization_in_a_replica_set diff --git a/umn/source/faqs/management_faqs/what_is_the_time_delay_for_primary_secondary_synchronization_in_a_replica_set.rst b/umn/source/faqs/database_performance/what_is_the_time_delay_for_primary_secondary_synchronization_in_a_replica_set.rst similarity index 84% rename from umn/source/faqs/management_faqs/what_is_the_time_delay_for_primary_secondary_synchronization_in_a_replica_set.rst rename to umn/source/faqs/database_performance/what_is_the_time_delay_for_primary_secondary_synchronization_in_a_replica_set.rst index 9e1a7d9..17fb125 100644 --- a/umn/source/faqs/management_faqs/what_is_the_time_delay_for_primary_secondary_synchronization_in_a_replica_set.rst +++ b/umn/source/faqs/database_performance/what_is_the_time_delay_for_primary_secondary_synchronization_in_a_replica_set.rst @@ -14,4 +14,4 @@ The delay for primary/secondary synchronization cannot be calculated using a for If the primary node bears heavy pressure within a period and executes a large number of transactions per second, the synchronization to the secondary node is delayed. -You can view **Delay Between Primary and Secondary Nodes** of the secondary node on the Cloud Eye console to know the synchronization delay. +You can view **Replication Lag** of the secondary node on the Cloud Eye console to know the synchronization delay. diff --git a/umn/source/faqs/management_faqs/what_should_i_do_if_my_query_is_slow.rst b/umn/source/faqs/database_performance/what_should_i_do_if_my_query_is_slow.rst similarity index 94% rename from umn/source/faqs/management_faqs/what_should_i_do_if_my_query_is_slow.rst rename to umn/source/faqs/database_performance/what_should_i_do_if_my_query_is_slow.rst index c18ede2..9b954ef 100644 --- a/umn/source/faqs/management_faqs/what_should_i_do_if_my_query_is_slow.rst +++ b/umn/source/faqs/database_performance/what_should_i_do_if_my_query_is_slow.rst @@ -9,4 +9,4 @@ What Should I Do If My Query Is Slow? For details on DDS log queries, see section :ref:`Slow Query Log `. -- You can also view CPU usage metrics of DDS DB instances to facilitate problem locating. For details, see section :ref:`Viewing DDS Metrics `. +- You can also view CPU usage metrics of DDS DB instances to facilitate problem locating. For details, see section :ref:`Viewing DDS Metrics `. diff --git a/umn/source/faqs/database_storage/index.rst b/umn/source/faqs/database_storage/index.rst new file mode 100644 index 0000000..7691b31 --- /dev/null +++ b/umn/source/faqs/database_storage/index.rst @@ -0,0 +1,20 @@ +:original_name: dds_faq_0107.html + +.. _dds_faq_0107: + +Database Storage +================ + +- :ref:`What Is the DDS DB Instance Storage Configuration? ` +- :ref:`What Should I Do If My Data Exceeds the Database Storage Space of a DDS DB Instance? ` +- :ref:`Which Items Occupy the Storage Space of DDS DB Instances? ` +- :ref:`What Overhead Does the Storage Space Have After I Applied for a DDS DB Instance? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + what_is_the_dds_db_instance_storage_configuration + what_should_i_do_if_my_data_exceeds_the_database_storage_space_of_a_dds_db_instance + which_items_occupy_the_storage_space_of_dds_db_instances + what_overhead_does_the_storage_space_have_after_i_applied_for_a_dds_db_instance diff --git a/umn/source/faqs/storage_faqs/what_is_the_dds_db_instance_storage_configuration.rst b/umn/source/faqs/database_storage/what_is_the_dds_db_instance_storage_configuration.rst similarity index 70% rename from umn/source/faqs/storage_faqs/what_is_the_dds_db_instance_storage_configuration.rst rename to umn/source/faqs/database_storage/what_is_the_dds_db_instance_storage_configuration.rst index d7d7693..831444b 100644 --- a/umn/source/faqs/storage_faqs/what_is_the_dds_db_instance_storage_configuration.rst +++ b/umn/source/faqs/database_storage/what_is_the_dds_db_instance_storage_configuration.rst @@ -7,4 +7,4 @@ What Is the DDS DB Instance Storage Configuration? The EVS is used for data storage of DDS DB instances. For details on the EVS, see *Elastic Volume Service User Guide*. -The DDS DB instance backup data is stored in the OBS and does not occupy the storage space you purchased. For details on the DDS DB instance storage configuration, see the *Object Storage Service User Guide*. +The DDS DB instance backup data is stored in the OBS and does not occupy the storage space you have. For details on the DDS DB instance storage configuration, see the *Object Storage Service User Guide*. diff --git a/umn/source/faqs/storage_faqs/what_overhead_does_the_storage_space_have_after_i_applied_for_a_dds_db_instance.rst b/umn/source/faqs/database_storage/what_overhead_does_the_storage_space_have_after_i_applied_for_a_dds_db_instance.rst similarity index 100% rename from umn/source/faqs/storage_faqs/what_overhead_does_the_storage_space_have_after_i_applied_for_a_dds_db_instance.rst rename to umn/source/faqs/database_storage/what_overhead_does_the_storage_space_have_after_i_applied_for_a_dds_db_instance.rst diff --git a/umn/source/faqs/storage_faqs/what_should_i_do_if_my_data_exceeds_the_database_storage_space_of_a_dds_db_instance.rst b/umn/source/faqs/database_storage/what_should_i_do_if_my_data_exceeds_the_database_storage_space_of_a_dds_db_instance.rst similarity index 100% rename from umn/source/faqs/storage_faqs/what_should_i_do_if_my_data_exceeds_the_database_storage_space_of_a_dds_db_instance.rst rename to umn/source/faqs/database_storage/what_should_i_do_if_my_data_exceeds_the_database_storage_space_of_a_dds_db_instance.rst diff --git a/umn/source/faqs/database_storage/which_items_occupy_the_storage_space_of_dds_db_instances.rst b/umn/source/faqs/database_storage/which_items_occupy_the_storage_space_of_dds_db_instances.rst new file mode 100644 index 0000000..dafbd45 --- /dev/null +++ b/umn/source/faqs/database_storage/which_items_occupy_the_storage_space_of_dds_db_instances.rst @@ -0,0 +1,12 @@ +:original_name: dds_faq_0030.html + +.. _dds_faq_0030: + +Which Items Occupy the Storage Space of DDS DB Instances? +========================================================= + +The following types of data will occupy the storage space: + +- User data except backups +- Data required for ensuring DB instance proper running occupy, such as system database data, rollback logs, and indexes +- Log output files that are generated by DDS ensure the stable operating of DDS DB instances. For example, Oplogs occupy 10% of storage space and cannot be resized. diff --git a/umn/source/faqs/management_faqs/are_my_dds_db_instances_available_when_scaling.rst b/umn/source/faqs/database_usage/are_my_dds_db_instances_available_when_scaling.rst similarity index 100% rename from umn/source/faqs/management_faqs/are_my_dds_db_instances_available_when_scaling.rst rename to umn/source/faqs/database_usage/are_my_dds_db_instances_available_when_scaling.rst diff --git a/umn/source/faqs/database_usage/index.rst b/umn/source/faqs/database_usage/index.rst new file mode 100644 index 0000000..5f2dbc2 --- /dev/null +++ b/umn/source/faqs/database_usage/index.rst @@ -0,0 +1,14 @@ +:original_name: dds_faq_0105.html + +.. _dds_faq_0105: + +Database Usage +============== + +- :ref:`Are My DDS DB Instances Available When Scaling? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + are_my_dds_db_instances_available_when_scaling diff --git a/umn/source/faqs/index.rst b/umn/source/faqs/index.rst index 4f13903..4ca26d4 100644 --- a/umn/source/faqs/index.rst +++ b/umn/source/faqs/index.rst @@ -5,22 +5,28 @@ FAQs ==== -- :ref:`Common FAQs ` -- :ref:`Management FAQs ` -- :ref:`Connection and Access FAQs ` -- :ref:`Parameter and Metric FAQs ` -- :ref:`Network and Security FAQs ` -- :ref:`Storage FAQs ` -- :ref:`Which Commands are Supported or Restricted by DDS? ` +- :ref:`Product Consulting ` +- :ref:`Database Performance ` +- :ref:`Creation and Deletion ` +- :ref:`Database Connection ` +- :ref:`Database Usage ` +- :ref:`Database Storage ` +- :ref:`Backup and Restoration ` +- :ref:`Network Security ` +- :ref:`Resource Monitoring ` +- :ref:`Log Management ` .. toctree:: :maxdepth: 1 :hidden: - common_faqs/index - management_faqs/index - connection_and_access_faqs/index - parameter_and_metric_faqs/index - network_and_security_faqs/index - storage_faqs/index - which_commands_are_supported_or_restricted_by_dds + product_consulting/index + database_performance/index + creation_and_deletion/index + database_connection/index + database_usage/index + database_storage/index + backup_and_restoration/index + network_security/index + resource_monitoring/index + log_management/index diff --git a/umn/source/faqs/log_management/index.rst b/umn/source/faqs/log_management/index.rst new file mode 100644 index 0000000..8a5beed --- /dev/null +++ b/umn/source/faqs/log_management/index.rst @@ -0,0 +1,14 @@ +:original_name: dds_faq_0112.html + +.. _dds_faq_0112: + +Log Management +============== + +- :ref:`Which Types of Logs and Files Occupy DDS DB Instance Storage Space? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + which_types_of_logs_and_files_occupy_dds_db_instance_storage_space diff --git a/umn/source/faqs/storage_faqs/which_types_of_logs_and_files_occupy_dds_db_instance_storage_space.rst b/umn/source/faqs/log_management/which_types_of_logs_and_files_occupy_dds_db_instance_storage_space.rst similarity index 100% rename from umn/source/faqs/storage_faqs/which_types_of_logs_and_files_occupy_dds_db_instance_storage_space.rst rename to umn/source/faqs/log_management/which_types_of_logs_and_files_occupy_dds_db_instance_storage_space.rst diff --git a/umn/source/faqs/management_faqs/does_dds_support_read_write_splitting.rst b/umn/source/faqs/management_faqs/does_dds_support_read_write_splitting.rst deleted file mode 100644 index 94baf2c..0000000 --- a/umn/source/faqs/management_faqs/does_dds_support_read_write_splitting.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: dds_faq_0010.html - -.. _dds_faq_0010: - -Does DDS Support Read/Write Splitting? -====================================== - -Yes. DDS can perform write operations only on the primary node in a replica set. You can configure DDS to perform read operations on the secondary node to split read and write operations. diff --git a/umn/source/faqs/management_faqs/index.rst b/umn/source/faqs/management_faqs/index.rst deleted file mode 100644 index 790115a..0000000 --- a/umn/source/faqs/management_faqs/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -:original_name: dds_faq_0102.html - -.. _dds_faq_0102: - -Management FAQs -=============== - -- :ref:`What Should I Do If My Query Is Slow? ` -- :ref:`What Is the Time Delay for Primary/Secondary Synchronization in a Replica Set? ` -- :ref:`Why Is Data Missing from My Database? ` -- :ref:`Will My Backups Be Deleted If I Delete My Cloud Account? ` -- :ref:`Are My DDS DB Instances Available When Scaling? ` -- :ref:`Does DDS Support Read/Write Splitting? ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - what_should_i_do_if_my_query_is_slow - what_is_the_time_delay_for_primary_secondary_synchronization_in_a_replica_set - why_is_data_missing_from_my_database - will_my_backups_be_deleted_if_i_delete_my_cloud_account - are_my_dds_db_instances_available_when_scaling - does_dds_support_read_write_splitting diff --git a/umn/source/faqs/network_and_security_faqs/do_i_need_to_use_dds_in_a_vpc.rst b/umn/source/faqs/network_and_security_faqs/do_i_need_to_use_dds_in_a_vpc.rst deleted file mode 100644 index 2bd4382..0000000 --- a/umn/source/faqs/network_and_security_faqs/do_i_need_to_use_dds_in_a_vpc.rst +++ /dev/null @@ -1,12 +0,0 @@ -:original_name: dds_faq_0022.html - -.. _dds_faq_0022: - -Do I Need to Use DDS in a VPC? -============================== - -A VPC allows you to create virtual network environment in a private and isolated network to control the private IP address range, subnets, route tables, and network gateways. The VPC also allows you to define the virtual network topology and network configuration to make the network similar to the traditional IP network you are operating in the data center. - -You may need to use DDS in the VPC in the following cases: - -You want to run Internet-oriented web applications and retain the backend server that the public cannot access. To do so, you can create an ECS and a DDS DB instance in the same VPC, allocate a public IP address for the ECS, and deploy a web server on the ECS. diff --git a/umn/source/faqs/network_and_security_faqs/how_do_i_ensure_the_security_of_dds_in_a_vpc.rst b/umn/source/faqs/network_security/how_do_i_ensure_the_security_of_dds_in_a_vpc.rst similarity index 100% rename from umn/source/faqs/network_and_security_faqs/how_do_i_ensure_the_security_of_dds_in_a_vpc.rst rename to umn/source/faqs/network_security/how_do_i_ensure_the_security_of_dds_in_a_vpc.rst diff --git a/umn/source/faqs/network_and_security_faqs/index.rst b/umn/source/faqs/network_security/index.rst similarity index 70% rename from umn/source/faqs/network_and_security_faqs/index.rst rename to umn/source/faqs/network_security/index.rst index 6db1dd9..54ce969 100644 --- a/umn/source/faqs/network_and_security_faqs/index.rst +++ b/umn/source/faqs/network_security/index.rst @@ -2,11 +2,10 @@ .. _dds_faq_0110: -Network and Security FAQs -========================= +Network Security +================ - :ref:`What Security Protection Policies Does DDS Have? ` -- :ref:`Do I Need to Use DDS in a VPC? ` - :ref:`How Do I Ensure the Security of DDS in a VPC? ` .. toctree:: @@ -14,5 +13,4 @@ Network and Security FAQs :hidden: what_security_protection_policies_does_dds_have - do_i_need_to_use_dds_in_a_vpc how_do_i_ensure_the_security_of_dds_in_a_vpc diff --git a/umn/source/faqs/network_and_security_faqs/what_security_protection_policies_does_dds_have.rst b/umn/source/faqs/network_security/what_security_protection_policies_does_dds_have.rst similarity index 100% rename from umn/source/faqs/network_and_security_faqs/what_security_protection_policies_does_dds_have.rst rename to umn/source/faqs/network_security/what_security_protection_policies_does_dds_have.rst diff --git a/umn/source/faqs/common_faqs/index.rst b/umn/source/faqs/product_consulting/index.rst similarity index 77% rename from umn/source/faqs/common_faqs/index.rst rename to umn/source/faqs/product_consulting/index.rst index e56a463..4618512 100644 --- a/umn/source/faqs/common_faqs/index.rst +++ b/umn/source/faqs/product_consulting/index.rst @@ -2,12 +2,11 @@ .. _dds_faq_0101: -Common FAQs -=========== +Product Consulting +================== - :ref:`What Precautions Should Be Taken When Using DDS? ` - :ref:`What Is the Availability of DDS DB Instances? ` -- :ref:`Can I Use a Template to Create DDS DB Instances? ` - :ref:`Will My DDS DB Instances Be Affected by Other Users' DDS DB Instances? ` .. toctree:: @@ -16,5 +15,4 @@ Common FAQs what_precautions_should_be_taken_when_using_dds what_is_the_availability_of_dds_db_instances - can_i_use_a_template_to_create_dds_db_instances will_my_dds_db_instances_be_affected_by_other_users_dds_db_instances diff --git a/umn/source/faqs/common_faqs/what_is_the_availability_of_dds_db_instances.rst b/umn/source/faqs/product_consulting/what_is_the_availability_of_dds_db_instances.rst similarity index 100% rename from umn/source/faqs/common_faqs/what_is_the_availability_of_dds_db_instances.rst rename to umn/source/faqs/product_consulting/what_is_the_availability_of_dds_db_instances.rst diff --git a/umn/source/faqs/common_faqs/what_precautions_should_be_taken_when_using_dds.rst b/umn/source/faqs/product_consulting/what_precautions_should_be_taken_when_using_dds.rst similarity index 54% rename from umn/source/faqs/common_faqs/what_precautions_should_be_taken_when_using_dds.rst rename to umn/source/faqs/product_consulting/what_precautions_should_be_taken_when_using_dds.rst index 660ffd9..d0c662b 100644 --- a/umn/source/faqs/common_faqs/what_precautions_should_be_taken_when_using_dds.rst +++ b/umn/source/faqs/product_consulting/what_precautions_should_be_taken_when_using_dds.rst @@ -5,14 +5,6 @@ What Precautions Should Be Taken When Using DDS? ================================================ -#. Failover - - DDS uses multiple mongos, replica sets, and shards to ensure data reliability. When a mongos is faulty, the other mongos takes over services immediately to ensure service continuity. A replica set consists of a primary, a secondary, and a hidden node. When the primary node is faulty, DDS selects the secondary node as the new primary within 30 seconds. - -#. ECSs used for DB instances are invisible to you. Your applications can access the IP addresses and ports corresponding to the database only. - -#. Backup files stored on OBS are invisible to you. They are only visible in the DDS backend management system. - #. Precautions after applying for DDS: After purchasing DDS DB instances, you do not need to perform basic database O&M operations, such as HA and security patches. You need to pay attention to the following: diff --git a/umn/source/faqs/common_faqs/will_my_dds_db_instances_be_affected_by_other_users_dds_db_instances.rst b/umn/source/faqs/product_consulting/will_my_dds_db_instances_be_affected_by_other_users_dds_db_instances.rst similarity index 100% rename from umn/source/faqs/common_faqs/will_my_dds_db_instances_be_affected_by_other_users_dds_db_instances.rst rename to umn/source/faqs/product_consulting/will_my_dds_db_instances_be_affected_by_other_users_dds_db_instances.rst diff --git a/umn/source/faqs/parameter_and_metric_faqs/index.rst b/umn/source/faqs/resource_monitoring/index.rst similarity index 66% rename from umn/source/faqs/parameter_and_metric_faqs/index.rst rename to umn/source/faqs/resource_monitoring/index.rst index 2ed68ea..5c4cf81 100644 --- a/umn/source/faqs/parameter_and_metric_faqs/index.rst +++ b/umn/source/faqs/resource_monitoring/index.rst @@ -1,9 +1,9 @@ -:original_name: dds_faq_0108.html +:original_name: dds_faq_0111.html -.. _dds_faq_0108: +.. _dds_faq_0111: -Parameter and Metric FAQs -========================= +Resource Monitoring +=================== - :ref:`What DB Instance Monitoring Metrics Do I Need to Pay Attention To? ` diff --git a/umn/source/faqs/parameter_and_metric_faqs/what_db_instance_monitoring_metrics_do_i_need_to_pay_attention_to.rst b/umn/source/faqs/resource_monitoring/what_db_instance_monitoring_metrics_do_i_need_to_pay_attention_to.rst similarity index 100% rename from umn/source/faqs/parameter_and_metric_faqs/what_db_instance_monitoring_metrics_do_i_need_to_pay_attention_to.rst rename to umn/source/faqs/resource_monitoring/what_db_instance_monitoring_metrics_do_i_need_to_pay_attention_to.rst diff --git a/umn/source/faqs/storage_faqs/how_do_i_back_up_dds_to_ecs.rst b/umn/source/faqs/storage_faqs/how_do_i_back_up_dds_to_ecs.rst deleted file mode 100644 index 07d93c2..0000000 --- a/umn/source/faqs/storage_faqs/how_do_i_back_up_dds_to_ecs.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: dds_faq_0025.html - -.. _dds_faq_0025: - -How Do I Back Up DDS to ECS? -============================ - -You can store DDS backup data on the ECS using mongoexport. However, you are advised not to store database backups on ECSs. You are advised to use the DDS backup function to store backups to a professional storage object, such as the OBS, to ensure high data reliability and service assurance. diff --git a/umn/source/faqs/storage_faqs/index.rst b/umn/source/faqs/storage_faqs/index.rst deleted file mode 100644 index 4c0bb5b..0000000 --- a/umn/source/faqs/storage_faqs/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -:original_name: dds_faq_0109.html - -.. _dds_faq_0109: - -Storage FAQs -============ - -- :ref:`How Do I Back Up DDS to ECS? ` -- :ref:`How Long Does DDS Store Backup Data For? ` -- :ref:`What Is the DDS DB Instance Storage Configuration? ` -- :ref:`What Should I Do If My Data Exceeds the Database Storage Space of a DDS DB Instance? ` -- :ref:`Which Items Occupy the Storage Space on My Purchased DDS DB Instances? ` -- :ref:`What Overhead Does the Storage Space Have After I Applied for a DDS DB Instance? ` -- :ref:`Which Types of Logs and Files Occupy DDS DB Instance Storage Space? ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - how_do_i_back_up_dds_to_ecs - how_long_does_dds_store_backup_data_for - what_is_the_dds_db_instance_storage_configuration - what_should_i_do_if_my_data_exceeds_the_database_storage_space_of_a_dds_db_instance - which_items_occupy_the_storage_space_on_my_purchased_dds_db_instances - what_overhead_does_the_storage_space_have_after_i_applied_for_a_dds_db_instance - which_types_of_logs_and_files_occupy_dds_db_instance_storage_space diff --git a/umn/source/faqs/storage_faqs/which_items_occupy_the_storage_space_on_my_purchased_dds_db_instances.rst b/umn/source/faqs/storage_faqs/which_items_occupy_the_storage_space_on_my_purchased_dds_db_instances.rst deleted file mode 100644 index 19cfd06..0000000 --- a/umn/source/faqs/storage_faqs/which_items_occupy_the_storage_space_on_my_purchased_dds_db_instances.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: dds_faq_0030.html - -.. _dds_faq_0030: - -Which Items Occupy the Storage Space on My Purchased DDS DB Instances? -====================================================================== - -Both your common data (excluding backup data) and data required for ensuring DB instance proper running occupy the storage space on your purchased DDS DB instances. To ensure DB instance proper running, system database data, rollback logs, and indexes are required. Logs generated by DDS also occupy the DB instance storage space. These files ensure that DB instances run stably. diff --git a/umn/source/faqs/which_commands_are_supported_or_restricted_by_dds.rst b/umn/source/faqs/which_commands_are_supported_or_restricted_by_dds.rst deleted file mode 100644 index a72d322..0000000 --- a/umn/source/faqs/which_commands_are_supported_or_restricted_by_dds.rst +++ /dev/null @@ -1,230 +0,0 @@ -:original_name: dds_faq_0033.html - -.. _dds_faq_0033: - -Which Commands are Supported or Restricted by DDS? -================================================== - -The following tables list the commands supported and restricted by DDS. - -.. table:: **Table 1** Commands supported and restricted by DDS - - +------------------------------------+--------------------------+-------------------------+ - | Type | Supported Command | Restricted Command | - +====================================+==========================+=========================+ - | Aggregates Commands | aggregate | mapReduce | - | | | | - | | count | | - | | | | - | | distinct | | - | | | | - | | group | | - +------------------------------------+--------------------------+-------------------------+ - | Geospatial Commands | geoNear | geoSearch | - +------------------------------------+--------------------------+-------------------------+ - | Query and Write Operation Commands | find | getPrevError | - | | | | - | | insert | eval | - | | | | - | | update | parallelCollectionScan | - | | | | - | | delete | | - | | | | - | | findAndModify | | - | | | | - | | getMore | | - | | | | - | | getLastError | | - | | | | - | | resetError | | - +------------------------------------+--------------------------+-------------------------+ - | Query Plan Cache Commands | planCacheListFilters | ``-`` | - | | | | - | | planCacheSetFilter | | - | | | | - | | planCacheClearFilters | | - | | | | - | | planCacheListQueryShapes | | - | | | | - | | planCacheListPlans | | - | | | | - | | planCacheClear | | - +------------------------------------+--------------------------+-------------------------+ - | Authentication Commands | logout | authSchemaUpgrade | - | | | | - | | authenticate | copydbgetnonce | - | | | | - | | getnonce | | - +------------------------------------+--------------------------+-------------------------+ - | User Management Commands | createUser | ``-`` | - | | | | - | | updateUser | | - | | | | - | | dropUser | | - | | | | - | | dropAllUsersFromDatabase | | - | | | | - | | grantRolesToUser | | - | | | | - | | revokeRolesFromUser | | - | | | | - | | usersInfo | | - +------------------------------------+--------------------------+-------------------------+ - | Role Management Commands | invalidateUserCache | ``-`` | - | | | | - | | createRole | | - | | | | - | | updateRole | | - | | | | - | | dropRole | | - | | | | - | | dropAllRolesFromDatabase | | - | | | | - | | grantPrivilegesToRole | | - | | | | - | | revokePrivilegesFromRole | | - | | | | - | | grantRolesToRole | | - | | | | - | | revokeRolesFromRole | | - | | | | - | | rolesInfo | | - +------------------------------------+--------------------------+-------------------------+ - | Replication Commands | isMaster | replSetElect | - | | | | - | | | replSetUpdatePosition | - | | | | - | | | appendOplogNote | - | | | | - | | | replSetFreeze | - | | | | - | | | replSetGetStatus | - | | | | - | | | replSetInitiate | - | | | | - | | | replSetMaintenance | - | | | | - | | | replSetReconfig | - | | | | - | | | replSetStepDown | - | | | | - | | | replSetSyncFrom | - | | | | - | | | resync | - | | | | - | | | applyOps | - | | | | - | | | replSetGetConfig | - +------------------------------------+--------------------------+-------------------------+ - | Sharding Commands | enableSharding | flushRouterConfig | - | | | | - | | getShardVersion | addShard | - | | | | - | | mergeChunks | cleanupOrphaned | - | | | | - | | shardCollection | checkShardingIndex | - | | | | - | | split | listShards | - | | | | - | | splitChunk | removeShard | - | | | | - | | splitVector | getShardMap | - | | | | - | | moveChunk | setShardVersion | - | | | | - | | movePrimary | shardingState | - | | | | - | | isdbgrid | unsetSharding | - +------------------------------------+--------------------------+-------------------------+ - | Administration Commands | renameCollection | clone | - | | | | - | | dropDatabase | cloneCollection | - | | | | - | | listCollections | clean | - | | | | - | | drop | connPoolSync | - | | | | - | | create | compact | - | | | | - | | convertToCapped | setParameter | - | | | | - | | filemd5 | repairDatabase | - | | | | - | | createIndexes | repairCursor | - | | | | - | | listIndexes | touch | - | | | | - | | dropIndexes | shutdown | - | | | | - | | fsync | cloneCollectionAsCapped | - | | | | - | | connectionStatus | copydb | - | | | | - | | collMod | logRotate | - | | | | - | | reIndex | | - | | | | - | | getParameter | | - | | | | - | | currentOp | | - | | | | - | | killOp | | - +------------------------------------+--------------------------+-------------------------+ - | Diagnostic Commands | availableQueryOptions | connPoolStats | - | | | | - | | buildInfo | cursorInfo | - | | | | - | | collStats | dbHash | - | | | | - | | dataSize | diagLogging | - | | | | - | | dbStats | driverOIDTest | - | | | | - | | explain | getCmdLineOpts | - | | | | - | | features | getLog | - | | | | - | | listCommands | hostInfo | - | | | | - | | listDatabases | isSelf | - | | | | - | | ping | netstat | - | | | | - | | serverStatus | profile | - | | | | - | | whatsmyuri | shardConnPoolStats | - | | | | - | | | top | - | | | | - | | | validate | - +------------------------------------+--------------------------+-------------------------+ - | Internal Commands | ``-`` | handshake | - | | | | - | | | \_recvChunkAbort | - | | | | - | | | \_recvChunkCommit | - | | | | - | | | \_recvChunkStart | - | | | | - | | | \_recvChunkStatus | - | | | | - | | | \_replSetFresh | - | | | | - | | | mapreduce.shardedfinish | - | | | | - | | | \_transferMods | - | | | | - | | | replSetHeartbeat | - | | | | - | | | replSetGetRBID | - | | | | - | | | \_migrateClone | - | | | | - | | | replSetElect | - | | | | - | | | writeBacksQueued | - | | | | - | | | writebacklisten | - +------------------------------------+--------------------------+-------------------------+ - | System Events Auditing Commands | ``-`` | logApplicationMessage | - +------------------------------------+--------------------------+-------------------------+ diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/binding_and_unbinding_an_eip.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/binding_and_unbinding_an_eip.rst deleted file mode 100644 index d7d552c..0000000 --- a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/binding_and_unbinding_an_eip.rst +++ /dev/null @@ -1,62 +0,0 @@ -:original_name: dds_02_0006.html - -.. _dds_02_0006: - -Binding and Unbinding an EIP -============================ - -.. _dds_02_0006__section055104935914: - -**Scenarios** -------------- - -You can access DDS through a private IP address or an EIP. The application scenario of the connection address is as follows: - -- Use a private IP address when: - - DDS provides a private IP address by default. - - Your applications are deployed on an ECS in a region where your cluster instance is located. - -- Use an EIP when: - - - Your applications are deployed on an ECS in a region separated from the region where your cluster instance is located. - - Your applications are deployed on another cloud platform. - -Precautions ------------ - -- Before accessing a database, you need to apply for an EIP on the VPC console. Then, add an inbound rule to allow the IP addresses or IP address ranges of ECSs. For details, see section :ref:`Setting a Security Group `. -- In the cluster instance, only mongos can be bound to an EIP. To change the EIP that has been bound to a node, you need to unbind it from the node first. - -.. _dds_02_0006__section0463161611514: - -Binding an EIP --------------- - -#. On the **Instance Management** page, click the target cluster instance. - -#. In the navigation pane on the left, choose **Connections**. - -#. In the **Basic Information** area, locate the target mongos node and click **Bind EIP** in the **Operation** column. - -#. In the displayed dialog box, all EIPs in the unbound status are listed. Select the required EIP and click **OK**. If no available EIPs are displayed, click **View EIP** and create an EIP on the VPC console. - -#. In the **EIP** column on the **mongos** tab, view the EIP that is successfully bound. - - To unbind an EIP from the DB instance, see :ref:`Unbinding an EIP `. - -.. _dds_02_0006__section1139494151519: - -Unbinding an EIP ----------------- - -#. On the **Instance Management** page, click the target cluster instance. - -#. In the navigation pane on the left, choose **Connections**. - -#. In the **Basic Information** area, locate the target mongos node and click **Unbind EIP** in the **Operation** column. - -#. In the displayed dialog box, click **OK** to unbind the EIP. - - To bind an EIP to the DB instance again, see :ref:`Binding an EIP `. diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/connecting_to_a_db_instance_through_a_client.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/connecting_to_a_db_instance_through_a_client.rst deleted file mode 100644 index 2d52914..0000000 --- a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/connecting_to_a_db_instance_through_a_client.rst +++ /dev/null @@ -1,132 +0,0 @@ -:original_name: en-us_topic_0044018334.html - -.. _en-us_topic_0044018334: - -Connecting to a DB Instance Through a Client -============================================ - -**Scenarios** -------------- - -This section guides you on how to connect to DB instances through a database client using a common connection or an SSL connection. You are advised to use SSL to encrypt connections to ensure data security. - -Based on the application scenario, you can determine whether to access a DB instance through an EIP. For details, see :ref:`Scenarios `. - -This section uses the Linux OS as an example to describe how to connect to a cluster instance. - -Restrictions ------------- - -For details about restrictions on connecting to a DB instance, see :ref:`Restrictions `. - -**Prerequisites** ------------------ - -#. An ECS or a device that can access DDS is ready for use. - - - To connect to a DDS DB instance from an ECS, you need to create and log in to the ECS. For details, see :ref:`How Can I Create and Log In to an ECS? ` - - To connect to a DB instance through an EIP: - - a. For details on how to bind an EIP, see section :ref:`Binding an EIP `. - b. Ensure that your local device can access the EIP that has been bound to the DB instance. - -#. A MongoDB client has been installed on the prepared ECS or the device. - - For details on how to install a MongoDB client, see section :ref:`How Can I Install a MongoDB Client? ` - -.. _en-us_topic_0044018334__section1640311061419: - -SSL Connection --------------- - -#. On the **Instance Management** page, click the target DB instance. - -#. In the navigation pane on the left, choose **Connections**. - -#. In the **Basic Information** area, click |image1| next to the **SSL** field to download the root certificate. - -#. Upload the root certificate to the ECS that connects to the DB instance or save the root certificate to a local device that can access DDS. - - The following describes how to upload the certificate to a Linux and Window ECS: - - - In Linux, run the following command: - - **scp** ** **\ **@**\ **\ **:**\ ** - - .. note:: - - - **IDENTITY_FILE** indicates the directory where the root certificate locates. The file access permission is 600. - - **REMOTE_USER** indicates the ECS OS user. - - **REMOTE_ADDRESS** indicates the ECS address. - - **REMOTE_DIR** indicates the directory of the ECS to which the root certificate is uploaded. - - - In Windows, upload the root certificate using file transfer tools. - -#. Connect to the DB instance in the directory where the MongoDB client is located. - - The Linux OS is used as an example. - - **./mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** **--ssl --sslCAFile** <*FILE_PATH*> - - Enter the database account password when prompted: - - .. code-block:: - - Enter password: - - .. note:: - - - A cluster instance uses the management IP address to generate SSL certificate. **--sslAllowInvalidHostnames** is needed for the SSL connection through an EIP. - - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. If a device can access the DB instance through an EIP, set this parameter to the EIP displayed in **EIP** column in the node list on the **Connections** page. - - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. - - **DB_USER** indicates the database account name. The default value is **rwuser**. - - **FILE_PATH** indicates the path where the root certificate is stored. - - Example: - - **./mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin --ssl --sslCAFile /tmp/ca.crt** - -#. Check the connection result. If the following information is displayed, the connection is successful. - - .. code-block:: - - mongos> - -.. _en-us_topic_0044018334__sfc3bfb212a8440799f49320d91fc096c: - -Common Connection ------------------ - -.. important:: - - To use the common connection mode, you need to disable the SSL connection. For details, see section :ref:`Disabling SSL `. - -#. Log in to the prepared ECS or the device that can access the document database. - -#. Connect to the DB instance in the directory where the MongoDB client is located. - - **./mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** - - Enter the database account password when prompted: - - .. code-block:: - - Enter password: - - .. note:: - - - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. If a device can access the DB instance through an EIP, set this parameter to the EIP displayed in **EIP** column in the node list on the **Connections** page. - - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. - - **DB_USER** indicates the database account name. The default value is **rwuser**. - - Example: - - **./mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin** - -#. Check the connection result. If the following information is displayed, the connection is successful. - - .. code-block:: - - mongos> - -.. |image1| image:: /_static/images/en-us_image_0284275280.png diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/enabling_or_disabling_ssl.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/enabling_or_disabling_ssl.rst deleted file mode 100644 index e051918..0000000 --- a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/enabling_or_disabling_ssl.rst +++ /dev/null @@ -1,51 +0,0 @@ -:original_name: dds_02_0007.html - -.. _dds_02_0007: - -Enabling or Disabling SSL -========================= - -**Scenarios** -------------- - -DDS allows you to use SSL to encrypt connections to a DB instance to protect your data. - -- If SSL is enabled, you can connect to a database using SSL. For details, see :ref:`SSL Connection `. -- If SSL is disabled, you can connect to the database using a common connection. For details, see :ref:`Common Connection `. - -.. important:: - - Enabling or disabling SSL will cause DB instance restart. Exercise caution when you perform this operation. - -Enabling SSL ------------- - -#. On the **Instance Management** page, click the target DB instance. - -#. In the **DB Information** area on the **Basic Information** page, click |image1| to enable SSL in the **SSL** field. - - Alternatively, in the navigation pane on the left, choose **Connections**. In the **Basic Information** area, click |image2| next to the **SSL** field. - -#. In the displayed dialog box, click **Yes**. - -#. In the **Basic Information** area, view the modification result. - -.. _dds_02_0007__section10934168947: - -Disabling SSL -------------- - -#. On the **Instance Management** page, click the target DB instance. - -#. In the **DB Information** area on the **Basic Information** page, click |image3| to enable SSL in the **SSL** field. - - Alternatively, in the navigation pane on the left, choose **Connections**. In the **Basic Information** area, click |image4| next to the **SSL** field. - -#. In the displayed dialog box, click **Yes**. - -#. In the **Basic Information** area, view the modification result. - -.. |image1| image:: /_static/images/en-us_image_0271492125.png -.. |image2| image:: /_static/images/en-us_image_0269983210.png -.. |image3| image:: /_static/images/en-us_image_0271515223.png -.. |image4| image:: /_static/images/en-us_image_0271515222.png diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/index.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/index.rst deleted file mode 100644 index 60d6635..0000000 --- a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -:original_name: dds_02_0009.html - -.. _dds_02_0009: - -Connecting to a Cluster Instance -================================ - -- :ref:`Binding and Unbinding an EIP ` -- :ref:`Enabling or Disabling SSL ` -- :ref:`Connecting to a DB Instance Through a Client ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - binding_and_unbinding_an_eip - enabling_or_disabling_ssl - connecting_to_a_db_instance_through_a_client diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/connecting_to_a_cluster_instance_over_private_networks.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/connecting_to_a_cluster_instance_over_private_networks.rst new file mode 100644 index 0000000..d7b6d3e --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/connecting_to_a_cluster_instance_over_private_networks.rst @@ -0,0 +1,165 @@ +:original_name: en-us_topic_0044018334.html + +.. _en-us_topic_0044018334: + +Connecting to a Cluster Instance Over Private Networks +====================================================== + +Scenarios +--------- + +This section describes how to connect to a cluster instance using the MongoDB client over private networks. + +The MongoDB client can connect to a DB instance with an unencrypted connection or an encrypted connection (SSL). To improve data transmission security, you are advised to connect to DB instances using the SSL connection. + +**Different OS scenarios**: Examples include Linux and Windows clients. + +Constraints +----------- + +For details about constraints on connecting to a DB instance, see :ref:`Constraints and Recommendations `. + +Prerequisites +------------- + +#. For details on how to create and log in to an ECS, see "Creating and Logging In to a Windows ECS" or "Creating and Logging In to a Linux ECS" in the *Elastic Cloud Server User Guide*. + +#. Install the MongoDB client on the ECS. + + For details on how to install a MongoDB client, see :ref:`How Can I Install a MongoDB Client? ` + + .. note:: + + If you use a :ref:`connection address ` to connect to a cluster instance, download the MongoDB client of version later than 3.4. + +Connecting to a DB Instance Using the MongoDB Client (SSL) +---------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. On the **Instance Management** page, click the target DB instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, click |image1| next to the **SSL** field. + + .. note:: + + The certificate can also be downloaded from the **Node Information** area on the **Basic Information** page. + +#. Upload the root certificate to the ECS to be connected to the DB instance. + + The following describes how to upload the certificate to a Linux and Window ECS: + + - In Linux, run the following command: + + **scp** ** **\ **@**\ **\ **:**\ ** + + .. note:: + + - **IDENTITY_FILE** indicates the directory where the root certificate resides. The file access permission is 600. + - **REMOTE_USER** indicates the ECS OS user. + - **REMOTE_ADDRESS** indicates the ECS address. + - **REMOTE_DIR** indicates the directory of the ECS to which the root certificate is uploaded. + + - In Windows, upload the root certificate using the remote connection tool. + +#. Connect to the DB instance in the directory where the MongoDB client is located. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format. + + **mongo mongodb://rwuser:@**\ **\ **:**\ **\ **,**\ **\ **:**\ **\ **/test?authSource=admin** **--ssl --sslCAFile** ** **--sslAllowInvalidHostnames** + + The connection information can be obtained in the **Address** column on the **Instance Management** page. + + A connection address indicates that one of the mongos nodes will be randomly connected. If you use this method to connect to a DB instance, use the MongoDB client of version later than 3.4. + + .. note:: + + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + - **FILE_PATH** indicates the path where the root certificate is stored. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin --ssl --sslCAFile /tmp/ca.crt** **--sslAllowInvalidHostnames** + + - Using standard URI format + + **mongo** **mongodb://rwuser:@\ 192.168.1.6:8635/test?authSource=admin** **--ssl --sslCAFile /tmp/ca.crt --sslAllowInvalidHostnames** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + .. code-block:: + + mongos> + +Connecting to a DB Instance Using the MongoDB Client (Non-SSL) +-------------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Connect to the DB instance in the directory where the MongoDB client is located. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - .. _en-us_topic_0044018334__li122297367491: + + Method 2: Using standard URI format + + **mongo** **mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **,**\ **\ **:**\ **\ **/test?authSource=admin** + + The connection information can be obtained in the **Address** column on the **Instance Management** page. + + A connection address indicates that one of the mongos nodes will be randomly connected. If you use this method to connect to a DB instance, use the MongoDB client of version later than 3.4. + + .. note:: + + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin** + + - Using standard URI format: + + **mongo** **mongodb://rwuser:@\ 192.168.1.6:8635/test?authSource=admin** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + .. code-block:: + + mongos> + +.. |image1| image:: /_static/images/en-us_image_0000001095974032.png diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/creating_a_cluster_instance.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/creating_a_cluster_instance.rst new file mode 100644 index 0000000..4e6e63e --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/creating_a_cluster_instance.rst @@ -0,0 +1,179 @@ +:original_name: en-us_topic_0044018333.html + +.. _en-us_topic_0044018333: + +Creating a Cluster Instance +=========================== + +Scenarios +--------- + +This section describes how to create a Community Edition cluster instance on the DDS management console. DDS allows you to tailor your compute resources and storage space to your business needs. + +You can use your account to create up to 10 cluster instances. To create more cluster instances, click |image1| in the upper right corner of the management console. On the **Service Quota** page, click **Increase Quota** to apply for quotas. + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click Create DB Instance. +#. On the displayed page, select your DB instance specifications and click **Create Now**. + + .. table:: **Table 1** Basic information + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=============================================================================================================================================================================================================================+ + | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs `. | + | | | + | | .. note:: | + | | | + | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Exercise caution when selecting a region. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | + | | | + | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Database Type | Community Edition | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Type | Select **Cluster**. | + | | | + | | A cluster instance includes three types of nodes: mongos, shard, and config. Each shard and config is a three-node replica set to ensure high availability. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Compatible MongoDB Version | - 4.2 | + | | - 4.0 | + | | - 3.4 | + | | - 3.2 | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Type | Ultra-high I/O | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Engine | WiredTiger | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | AZ | An AZ is a part of a region with its own independent power supply and network. AZs are physically isolated but can communicate through an internal network. For details, see section :ref:`Regions and AZs `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Disk Encryption | - **Disabled**: Disable the encryption function. | + | | | + | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | + | | | + | | **Key Name**: Select or create a private key, which is the tenant key. | + | | | + | | .. note:: | + | | | + | | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | + | | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | + | | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 2** Specifications + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=============================================================================================================================================================================================================================================================================+ + | mongos node class | For details about the mongos CPU and memory, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing a Cluster DB Instance Class `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mongos nodes | The number of mongos nodes. The value ranges from 2 to 32. After a DB instance is created, you can add mongos nodes if necessary. For details, see section :ref:`Adding Nodes to a Cluster `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mongos parameter template | The parameters that apply to the mongos nodes. After a DB instance is created, you can change the parameter template of a node to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard node class | For details about the shard CPU and memory, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing a Cluster DB Instance Class `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard storage space | The value ranges from 10 GB to 2000 GB and must be a multiple of 10. After a DB instance is created, you can scale up its storage space. For details, see section :ref:`Scaling Up Storage Space `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard nodes | The number of shard nodes. The shard node stores user data but cannot be accessed directly. | + | | | + | | The value ranges from 2 to 32. After a DB instance is created, you can add shard nodes if necessary. For details, see section :ref:`Adding Nodes to a Cluster `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard parameter template | The parameters that apply to the shard nodes. After a DB instance is created, you can change the parameter template of a node to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | config node class | The CPU and memory of a config node. The config node stores the DB instance configurations but cannot be accessed directly. For details, see :ref:`DB Instance Specifications `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | config storage space | The storage space is 20 GB and cannot be scaled up. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | config parameter template | The parameters that apply to the config nodes. After a DB instance is created, you can change the parameter template of a node to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 3** Network + + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | VPC | The VPC where your DB instances are located. A VPC isolates networks for different services, so you can easily manage and configure internal networks and change network configuration. You need to create or select the required VPC. For details about how to create a VPC, see section "Creating a VPC" in the *Virtual Private Cloud User Guide*. For details about the constraints on the use of VPCs, see :ref:`Connection Methods `. | + | | | + | | .. note:: | + | | | + | | After the DDS instance is created, the VPC cannot be changed. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subnet | A subnet provides dedicated network resources that are logically isolated from other networks for network security. | + | | | + | | After the instance is created, you can change the private IP address assigned by the subnet. For details, see :ref:`Changing a Private IP Address `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security Group | A security group controls access between DDS and other services for security. | + | | | + | | .. note:: | + | | | + | | Ensure that the security group rule you set allows clients to access DB instances. For example, select the TCP protocol with inbound direction, input the default port number **8635**, and enter a subnet IP address or select a security group that the DB instance belongs to. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SSL | Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission. | + | | | + | | You can enable SSL to improve data security. After a DB instance is created, you can connect to it using SSL. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 4** Database configuration + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=================================================================================================================================================================================================================+ + | Administrator | The default account is **rwuser**. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Administrator Password | Set a password for the administrator. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ``~!@#%^*-_=+?`` | + | | | + | | Keep this password secure. If lost, the system cannot retrieve it for you. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Confirm Password | Enter the administrator password again. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 5** Tag + + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+======================================================================================================================================================================================================================+ + | Tags | This setting is optional. Adding tags helps you better identify and manage your DB instances. Up to 20 tags can be added for a DB instance. | + | | | + | | A tag is composed of a key-value pair. | + | | | + | | - Key: Mandatory if the DB instance is going to be tagged | + | | | + | | - Each tag key must be unique for each DB instance. | + | | - A tag key consists of up to 36 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | - Value: Optional if the DB instance is going to be tagged | + | | | + | | - The value consists of up to 43 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | After a DB instance is created, you can view its tag details on the **Tags** tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see :ref:`Tag Management `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. note:: + + DB instance performance is determined by how you configure it during the creation. The hardware configuration items that can be selected include the node class and storage space. + +#. On the displayed page, confirm the DB instance information. + + - If you need to modify the specifications, click **Previous** to return to the previous page. + - If you do not need to modify the specifications, click **Submit** to start the instance creation. + +#. After a DDS DB instance is created, you can view and manage it on the **Instance Management** page. + + - When a DB instance is being created, the status displayed in the **Status** column is **Creating**. This process takes about 15 minutes. After the creation is complete, the status changes to **Available**. + - DDS enables the automated backup policy by default. After a DB instance is created, you can modify or disable the automated backup policy. An automated full backup is immediately triggered after the creation of a DB instance. + - The default DDS port is 8635, but this port can be modified if necessary. If you change the port, you need to add the security group rule to enable access. + +.. |image1| image:: /_static/images/en-us_image_0000001096453892.png diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/index.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/index.rst new file mode 100644 index 0000000..f509249 --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/index.rst @@ -0,0 +1,20 @@ +:original_name: dds_02_0009.html + +.. _dds_02_0009: + +Connecting to a Cluster Instance Over Private Networks +====================================================== + +- :ref:`Overview ` +- :ref:`Creating a Cluster Instance ` +- :ref:`Setting a Security Group ` +- :ref:`Connecting to a Cluster Instance Over Private Networks ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + overview + creating_a_cluster_instance + setting_a_security_group + connecting_to_a_cluster_instance_over_private_networks diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/overview.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/overview.rst new file mode 100644 index 0000000..2e047d5 --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/overview.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0010.html + +.. _dds_02_0010: + +Overview +======== + +**Scenarios** +------------- + +This section describes how to create a cluster instance on the management console, set a security group, and connect to a cluster instance over private networks. + +Process +------- + +The following describes the steps from creating a DB instance to using it. + + +.. figure:: /_static/images/en-us_image_0000001143053843.png + :alt: **Figure 1** Accessing DB instances from a private network + + **Figure 1** Accessing DB instances from a private network diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/setting_a_security_group.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/setting_a_security_group.rst new file mode 100644 index 0000000..19c0eb3 --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_private_networks/setting_a_security_group.rst @@ -0,0 +1,25 @@ +:original_name: dds_02_0022.html + +.. _dds_02_0022: + +Setting a Security Group +======================== + +Scenarios +--------- + +This section explains how to add a security group rule to control access to and from the DDS DB instances associated with a security group. + +Precautions +----------- + +The default security group rule allows all outgoing data packets. ECSs and DDS DB instances in the same security group can access each other. After a security group is created, you can create different rules for that security group, which allows you to control access to the DB instances that are in it. + +To access a DB instance in a security group from a source outside of that group, you need to create an inbound rule. + +For details about the constraints on using security groups, see "Security Group Overview" in the *Virtual Private Cloud User Guide*. + +Procedure +--------- + +For details about setting a security group, see "Adding a Security Group Rule" in the *Virtual Private Cloud User Guide*. diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/binding_an_eip.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/binding_an_eip.rst new file mode 100644 index 0000000..21d2e71 --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/binding_an_eip.rst @@ -0,0 +1,50 @@ +:original_name: dds_02_0046.html + +.. _dds_02_0046: + +Binding an EIP +============== + +**Scenarios** +------------- + +After you create a DB instance, you can bind it to an EIP to allow external access. If you want to prohibit external access later, you can also unbind the EIP from the DB instance. + +Precautions +----------- + +- Before accessing a database, you need to apply for an EIP on the VPC console. Then, add an inbound rule to allow the IP addresses or IP address ranges of ECSs. For details, see section :ref:`Setting a Security Group `. +- In the cluster instance, only mongos can be bound to an EIP. To change the EIP that has been bound to a node, you need to unbind it from the node first. + +.. _dds_02_0046__section3199593620428: + + +Binding an EIP +-------------- + +#. On the **Instance Management** page, click the target cluster instance. + +#. In the navigation pane on the left, choose **Connections**. In the **Basic Information** area, locate the target mongos node and click **Bind EIP** in the **Operation** column. + + Or in the **Node Information** area on the **Basic Information** page, locate the target mongos node and choose **More** > **Bind EIP** in the **Operation** column. + +#. In the displayed dialog box, all available unbound EIPs are listed. Select the required EIP and click **OK**. If no available EIPs are displayed, click **View EIP** and create an EIP on the VPC console. + +#. In the **EIP** column on the **mongos** tab, view the EIP that is successfully bound. + + To unbind an EIP from the DB instance, see :ref:`Unbinding an EIP `. + +.. _dds_02_0046__section186511510267: + +Unbinding an EIP +---------------- + +#. On the **Instance Management** page, click the target cluster instance. + +#. In the navigation pane on the left, choose **Connections**. In the **Basic Information** area, locate the target mongos node and click **Unbind EIP** in the **Operation** column. + + Or in the **Node Information** area on the **Basic Information** page, locate the target mongos node and choose **More** > **Unbind EIP** in the **Operation** column. + +#. In the displayed dialog box, click **Yes**. + + To bind an EIP to the DB instance again, see :ref:`Binding an EIP `. diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/connecting_to_a_cluster_instance_over_public_networks.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/connecting_to_a_cluster_instance_over_public_networks.rst new file mode 100644 index 0000000..cd5c011 --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/connecting_to_a_cluster_instance_over_public_networks.rst @@ -0,0 +1,286 @@ +:original_name: dds_02_0006.html + +.. _dds_02_0006: + +Connecting to a Cluster Instance Over Public Networks +===================================================== + +Scenarios +--------- + +This section describes how to connect to a cluster instance using the MongoDB client and Robo 3T over public networks. + +The MongoDB client and Robo 3T can connect to a DB instance with an unencrypted connection or an encrypted connection (SSL). To improve data transmission security, you are advised to connect to DB instances using the SSL connection. + +**Different OS scenarios**: Examples include Linux and Windows clients. + +Prerequisites +------------- + +#. :ref:`Bind an EIP ` to the cluster instance and :ref:`set security group rules ` to ensure that the EIP can be accessed with the DB client application. + +#. Install the MongoDB client or Robo 3T. + + **MongoDB client** + + a. For details on how to create and log in to an ECS, see "Creating and Logging In to a Windows ECS" or "Creating and Logging In to a Linux ECS" in the *Elastic Cloud Server User Guide*. + + b. Install the MongoDB client on the ECS. + + For details on how to install a MongoDB client, see :ref:`How Can I Install a MongoDB Client? ` + + .. note:: + + If you use a :ref:`connection address ` to connect to a cluster instance, download the MongoDB client of version later than 3.4. + + **Robo 3T** + + For details on how to install Robo 3T, see :ref:`How Do I Install Robo 3T? ` + +#. If SSL is enabled, download the SSL certificate on the DDS console. + + a. On the **Instance Management** page, click the target DB instance. + b. In the navigation pane on the left, choose **Connections**. + c. In the **Basic Information** area, click |image1| next to the **SSL** field. + + .. note:: + + The certificate can also be downloaded from the **Node Information** area on the **Basic Information** page. + +Connecting to a DB Instance Using Robo 3T (SSL) +----------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. Run the installed Robo 3T. On the displayed dialog box, click **Create**. + + + .. figure:: /_static/images/en-us_image_0000001095974050.png + :alt: **Figure 1** Connections + + **Figure 1** Connections + +#. In the **Connection Settings** dialog box, set the parameters of the new connection. + + a. On the **Connection** tab, enter the name of the new connection in the **Name** text box and enter the EIP and database port that are bound to the DDS DB instance in the **Address** text box. + + + .. figure:: /_static/images/en-us_image_0000001143133815.png + :alt: **Figure 2** Connection + + **Figure 2** Connection + + b. On the **Authentication** tab, set **Database** to **admin**, **User Name** to **rwuser**, and **Password** to the administrator password you set during the creation of the cluster instance. + + + .. figure:: /_static/images/en-us_image_0000001142773917.png + :alt: **Figure 3** Authentication + + **Figure 3** Authentication + + c. On the **SSL** tab, upload the SSL certificate and select **Allowed** for **Invalid Hostnames**. + + + .. figure:: /_static/images/en-us_image_0000001142773909.png + :alt: **Figure 4** SSL + + **Figure 4** SSL + + d. Click **Save**. + +#. On the **MongoDB Connections** page, click **Connect** to connect to the cluster instance. + + + .. figure:: /_static/images/en-us_image_0000001096453848.png + :alt: **Figure 5** Connections + + **Figure 5** Connections + +#. If the cluster instance is successfully connected, the page shown in :ref:`Figure 6 ` is displayed. + + .. _dds_02_0006__fig156158172016: + + .. figure:: /_static/images/en-us_image_0000001096293856.png + :alt: **Figure 6** Connection succeeded + + **Figure 6** Connection succeeded + +Connecting to a DB Instance Using Robo 3T (Non-SSL) +--------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Run the installed Robo 3T. On the displayed dialog box, click **Create**. + + + .. figure:: /_static/images/en-us_image_0000001143053817.png + :alt: **Figure 7** Connections + + **Figure 7** Connections + +#. In the **Connection Settings** dialog box, set the parameters of the new connection. + + a. On the **Connection** tab, enter the name of the new connection in the **Name** text box and enter the EIP and database port that are bound to the DDS DB instance in the **Address** text box. + + + .. figure:: /_static/images/en-us_image_0000001142773911.png + :alt: **Figure 8** Connection + + **Figure 8** Connection + + b. On the **Authentication** tab, set **Database** to **admin**, **User Name** to **rwuser**, and **Password** to the administrator password you set during the creation of the cluster instance. + + + .. figure:: /_static/images/en-us_image_0000001143053819.png + :alt: **Figure 9** Authentication + + **Figure 9** Authentication + + c. Click **Save**. + +#. On the **MongoDB Connections** page, click **Connect** to connect to the cluster instance. + + + .. figure:: /_static/images/en-us_image_0000001143053813.png + :alt: **Figure 10** Connections + + **Figure 10** Connections + +#. If the cluster instance is successfully connected, the page shown in :ref:`Figure 11 ` is displayed. + + .. _dds_02_0006__fig6991458155017: + + .. figure:: /_static/images/en-us_image_0000001142893865.png + :alt: **Figure 11** Connection succeeded + + **Figure 11** Connection succeeded + +Connecting to a DB Instance Using the MongoDB Client (SSL) +---------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. On the **Instance Management** page, click the target DB instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, click |image2| next to the **SSL** field. + +#. Upload the root certificate to the ECS to be connected to the DB instance. + + The following describes how to upload the certificate to a Linux and Window ECS: + + - In Linux, run the following command: + + **scp** ** **\ **@**\ **\ **:**\ ** + + .. note:: + + - **IDENTITY_FILE** indicates the directory where the root certificate resides. The file access permission is 600. + - **REMOTE_USER** indicates the ECS OS user. + - **REMOTE_ADDRESS** indicates the ECS address. + - **REMOTE_DIR** indicates the directory of the ECS to which the root certificate is uploaded. + + - In Windows, upload the root certificate using the remote connection tool. + +#. Connect to the DB instance in the directory where the MongoDB client is located. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format + + **mongo mongodb://rwuser:@**\ **\ **:**\ **\ **/test?authSource=admin** **--ssl --sslCAFile** ** **--sslAllowInvalidHostnames** + + To obtain the public connection address, click the instance name and choose **Connections**. The address is displayed in **Public Network Connection Address** field on the **Public Connection** tab. + + .. note:: + + - A cluster instance uses the management IP address to generate SSL certificate. **--sslAllowInvalidHostnames** is needed for the SSL connection in a public network. + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **EIP** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + - **FILE_PATH** indicates the path where the root certificate is stored. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin --ssl --sslCAFile /tmp/ca.crt** **--sslAllowInvalidHostnames** + + - Using standard URI format: + + **mongo** **mongodb://rwuser:@\ 192.168.1.80:8635/test?authSource=admin** **--ssl --sslCAFile /tmp/ca.crt --sslAllowInvalidHostnames** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + .. code-block:: + + mongos> + +Connecting to a DB Instance Using the MongoDB Client (Non-SSL) +-------------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Connect to the DB instance in the directory where the MongoDB client is located. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - .. _dds_02_0006__li122297367491: + + Method 2: Using standard URI format + + **./mongo** **mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **/test?authSource=admin** + + To obtain the public connection address, click the instance name and choose **Connections**. The address is displayed in **Public Network Connection Address** field on the **Public Connection** tab. + + .. note:: + + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **EIP** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the **Node Information** area on the **Basic Information** page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin** + + - Using standard URI format: + + **mongo** **mongodb://rwuser:@\ 192.168.1.80:8635/test?authSource=admin** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + .. code-block:: + + mongos> + +.. |image1| image:: /_static/images/en-us_image_0000001143133809.png +.. |image2| image:: /_static/images/en-us_image_0000001096453856.png diff --git a/umn/source/getting_started_with_clusters/creating_a_cluster_instance.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/creating_a_cluster_instance.rst similarity index 72% rename from umn/source/getting_started_with_clusters/creating_a_cluster_instance.rst rename to umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/creating_a_cluster_instance.rst index 7e2e896..6dbeb69 100644 --- a/umn/source/getting_started_with_clusters/creating_a_cluster_instance.rst +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/creating_a_cluster_instance.rst @@ -1,177 +1,179 @@ -:original_name: dds_02_0008.html +:original_name: dds_02_0016.html -.. _dds_02_0008: +.. _dds_02_0016: Creating a Cluster Instance =========================== -**Scenarios** -------------- +Scenarios +--------- -This section describes how to create a DDS cluster instance of Community Edition on the DDS management console. DDS allows you to tailor your computing resources and storage space to your business needs. +This section describes how to create a Community Edition cluster instance on the DDS management console. DDS allows you to tailor your compute resources and storage space to your business needs. -You can use your account to create a maximum of 10 cluster instances. To create more cluster instances, click |image1| in the upper right corner of the management console. On the **Service Quota** page, click **Increase Quota** to apply for quotas. +You can use your account to create up to 10 cluster instances. To create more cluster instances, click |image1| in the upper right corner of the management console. On the **Service Quota** page, click **Increase Quota** to apply for quotas. -**Procedure** -------------- +Procedure +--------- #. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click **Create** **DB Instance**. -#. On the displayed page, configure parameters about DB instance specifications. Then, click **Create Now**. +#. On the **Instance Management** page, click Create DB Instance. +#. On the displayed page, select your DB instance specifications and click **Create Now**. .. table:: **Table 1** Basic information - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+===============================================================================================================================================================================================================================+ - | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs `. | - | | | - | | .. note:: | - | | | - | | DB instances in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Therefore, exercise caution when selecting a region. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | - | | | - | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Modifying the DB Instance Name `. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Database Type | Community Edition | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DB Instance Type | Select **Cluster**. | - | | | - | | A cluster instance includes three types of nodes: mongos, shard, and config. shard and config use the three-node replica set architecture to ensure high availability. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Compatible MongoDB Version | - 3.4 | - | | - 3.2 | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Storage Engine | WiredTiger | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | AZ | A physical region where resources use independent power supply and networks. AZs are physically isolated but interconnected through the internal network. For details, see section :ref:`Regions and AZs `. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Disk Encryption | - **Disable**: Disable the encryption function. | - | | | - | | - **Enable**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | - | | | - | | **Key Name**: Select or create a private key, which is the tenant key. | - | | | - | | .. note:: | - | | | - | | - After a DB instance is created, the disk encryption status and the key cannot be changed. Backup data stored on OBS is not encrypted. | - | | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | - | | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=============================================================================================================================================================================================================================+ + | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs `. | + | | | + | | .. note:: | + | | | + | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Exercise caution when selecting a region. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | + | | | + | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Database Type | Community Edition | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Type | Select **Cluster**. | + | | | + | | A cluster instance includes three types of nodes: mongos, shard, and config. Each shard and config is a three-node replica set to ensure high availability. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Compatible MongoDB Version | - 4.2 | + | | - 4.0 | + | | - 3.4 | + | | - 3.2 | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Type | Ultra-high I/O | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Engine | WiredTiger | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | AZ | An AZ is a part of a region with its own independent power supply and network. AZs are physically isolated but can communicate through an internal network. For details, see section :ref:`Regions and AZs `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Disk Encryption | - **Disabled**: Disable the encryption function. | + | | | + | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | + | | | + | | **Key Name**: Select or create a private key, which is the tenant key. | + | | | + | | .. note:: | + | | | + | | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | + | | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | + | | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Specifications - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Item | Description | - +===================================+============================================================================================================================================================================================================================================================================================+ - | mongos class | For details about the mongos CPU and memory, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing the CPU or Memory of a Cluster DB Instance `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mongos quantity | The value ranges from 2 to 16. After a DB instance is created, you can add nodes. For details, see section :ref:`Adding Cluster Instance Nodes `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mongos parameter group | Parameters in a mongos parameter group can be applied to mongos nodes. After a DB instance is created, you can change the parameter group of a node. For a parameter group created by users, you can modify the parameters in the parameter group to bring out the best performance. | - | | | - | | For details, see :ref:`Parameter Group `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shard class | For details about the shard CPU and memory, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing the CPU or Memory of a Cluster DB Instance `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shard storage type | Ultra-high I/O: uses the SSD disk type. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shard storage space | The value ranges from 10 GB to 1,000 GB and must be a multiple of 10. After a DB instance is created, you can scale up its storage space. For details, see section :ref:`Scaling Up Storage Space `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shard quantity | shard stores user data but cannot be accessed directly by you. | - | | | - | | The value ranges from 2 to 16. After a DB instance is created, you can add nodes. For details, see section :ref:`Adding Cluster Instance Nodes `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shard parameter group | Parameters in a shard parameter group can be applied to shard nodes. After a DB instance is created, you can change the parameter group of a node. For a parameter group created by users, you can modify the parameters in the parameter group to bring out the best performance. | - | | | - | | For details, see :ref:`Parameter Group `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config class | config stores DB instance configurations but cannot be accessed directly by you. For details, see :ref:`DB Instance Specifications `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config storage type | Ultra-high I/O: uses the SSD disk type. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config storage space | The storage space is 20 GB and cannot be scaled up. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config parameter group | Parameters in a config parameter group can be applied to config nodes. After a DB instance is created, you can change the parameter group of a node. For a parameter group created by users, you can modify the parameters in the parameter group to bring out the best performance. | - | | | - | | For details, see :ref:`Parameter Group `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=============================================================================================================================================================================================================================================================================+ + | mongos node class | For details about the mongos CPU and memory, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing a Cluster DB Instance Class `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mongos nodes | The number of mongos nodes. The value ranges from 2 to 32. After a DB instance is created, you can add mongos nodes if necessary. For details, see section :ref:`Adding Nodes to a Cluster `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mongos parameter template | The parameters that apply to the mongos nodes. After a DB instance is created, you can change the parameter template of a node to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard node class | For details about the shard CPU and memory, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing a Cluster DB Instance Class `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard storage space | The value ranges from 10 GB to 2000 GB and must be a multiple of 10. After a DB instance is created, you can scale up its storage space. For details, see section :ref:`Scaling Up Storage Space `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard nodes | The number of shard nodes. The shard node stores user data but cannot be accessed directly. | + | | | + | | The value ranges from 2 to 32. After a DB instance is created, you can add shard nodes if necessary. For details, see section :ref:`Adding Nodes to a Cluster `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard parameter template | The parameters that apply to the shard nodes. After a DB instance is created, you can change the parameter template of a node to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | config node class | The CPU and memory of a config node. The config node stores the DB instance configurations but cannot be accessed directly. For details, see :ref:`DB Instance Specifications `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | config storage space | The storage space is 20 GB and cannot be scaled up. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | config parameter template | The parameters that apply to the config nodes. After a DB instance is created, you can change the parameter template of a node to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 3** Network - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+========================================================================================================================================================================================================================================================================================================================================================================+ - | VPC | The VPC to which a DB instance belongs isolates networks for different services. It allows user to manage and configure internal networks and change network configuration, simplifying network management. You need to create or select the required VPC. For details on how to create a VPC, see section "Creating a VPC" in the *Virtual Private Cloud User Guide*. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Subnet | A subnet provides dedicated network resources that are logically isolated from other networks, improving network security. After a DB instance is created, you can click the DB instance name and change the private IP address assigned by the subnet to the mongos node on the **Basic Information** page. | - | | | - | | .. note:: | - | | | - | | Changing the private IP address of a node will invalidate the previous private IP address. If an EIP is bound to the node, do not unbind the EIP during the change of the private IP address. After the change, the new private IP address is bound to the EIP. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Security Group | A security group controls access between DDS and other services for security. | - | | | - | | .. note:: | - | | | - | | Ensure that the security group rule you set allows clients to access DB instances. For example, select the TCP protocol with inbound direction, input the default port number **8635**, and enter a subnet IP address or select a security group that the DB instance belongs to. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | SSL | Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission. | - | | | - | | You can enable SSL to improve data security. After a DB instance is created, you can connect to it in SSL mode. For details, see :ref:`Connecting to a DB Instance Through a Client `. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | VPC | The VPC where your DB instances are located. A VPC isolates networks for different services, so you can easily manage and configure internal networks and change network configuration. You need to create or select the required VPC. For details about how to create a VPC, see section "Creating a VPC" in the *Virtual Private Cloud User Guide*. For details about the constraints on the use of VPCs, see :ref:`Connection Methods `. | + | | | + | | .. note:: | + | | | + | | After the DDS instance is created, the VPC cannot be changed. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subnet | A subnet provides dedicated network resources that are logically isolated from other networks for network security. | + | | | + | | After the instance is created, you can change the private IP address assigned by the subnet. For details, see :ref:`Changing a Private IP Address `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security Group | A security group controls access between DDS and other services for security. | + | | | + | | .. note:: | + | | | + | | Ensure that the security group rule you set allows clients to access DB instances. For example, select the TCP protocol with inbound direction, input the default port number **8635**, and enter a subnet IP address or select a security group that the DB instance belongs to. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SSL | Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission. | + | | | + | | You can enable SSL to improve data security. After a DB instance is created, you can connect to it using SSL. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Database configuration - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=======================================================================================================================================================================================================================+ - | Administrator | The default account is **rwuser**. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Administrator Password | The password is a string of 8 to 32 characters. It must be a combination of uppercase letters, lowercase letters, digits, and special characters. You can also use the following special characters: ``~!@#%^*-_=+?`` | - | | | - | | The system cannot save you password. Keep the password secure. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Confirm Password | The value of this parameter must be the same as the **Administrator Password**. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=================================================================================================================================================================================================================+ + | Administrator | The default account is **rwuser**. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Administrator Password | Set a password for the administrator. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ``~!@#%^*-_=+?`` | + | | | + | | Keep this password secure. If lost, the system cannot retrieve it for you. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Confirm Password | Enter the administrator password again. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 5** Tag - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+===========================================================================================================================================================================================================+ - | Tags | Tags a DDS DB instance. This configuration is optional. Adding tags to DDS DB instances helps you better identify and manage them. Each DB instance can have up to 20 tags. | - | | | - | | A tag is composed of a key-value pair. | - | | | - | | - Key: Mandatory if the DB instance is going to be tagged | - | | | - | | - For each DB instance, each tag key is unique. | - | | - A tag key consists of a maximum of 36 characters. | - | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | - | | | - | | - Value: Optional if the DB instance is going to be tagged | - | | | - | | - The value consists of a maximum of 43 characters. | - | | - The value can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | - | | | - | | After a DB instance is created, you can view its tag details on the **Tags** tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see :ref:`Tag `. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+======================================================================================================================================================================================================================+ + | Tags | This setting is optional. Adding tags helps you better identify and manage your DB instances. Up to 20 tags can be added for a DB instance. | + | | | + | | A tag is composed of a key-value pair. | + | | | + | | - Key: Mandatory if the DB instance is going to be tagged | + | | | + | | - Each tag key must be unique for each DB instance. | + | | - A tag key consists of up to 36 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | - Value: Optional if the DB instance is going to be tagged | + | | | + | | - The value consists of up to 43 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | After a DB instance is created, you can view its tag details on the **Tags** tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see :ref:`Tag Management `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: - DB instance performance is determined by the configurations you set during its creation, including the node class and storage space. + DB instance performance is determined by how you configure it during the creation. The hardware configuration items that can be selected include the node class and storage space. #. On the displayed page, confirm the DB instance information. - - If you need to modify the specifications, click **Previous** to modify parameters. + - If you need to modify the specifications, click **Previous** to return to the previous page. - If you do not need to modify the specifications, click **Submit** to start the instance creation. #. After a DDS DB instance is created, you can view and manage it on the **Instance Management** page. - When a DB instance is being created, the status displayed in the **Status** column is **Creating**. This process takes about 15 minutes. After the creation is complete, the status changes to **Available**. - DDS enables the automated backup policy by default. After a DB instance is created, you can modify or disable the automated backup policy. An automated full backup is immediately triggered after the creation of a DB instance. - - You can change the database port after the DB instance is created. DDS uses port 8635 by default, which is different from the default port numbers used by databases. To ensure database accessibility, you need to add the required security group rule. + - The default DDS port is 8635, but this port can be modified if necessary. If you change the port, you need to add the security group rule to enable access. -.. |image1| image:: /_static/images/en-us_image_0284275249.png +.. |image1| image:: /_static/images/en-us_image_0000001096453892.png diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/index.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/index.rst new file mode 100644 index 0000000..e91adac --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/index.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0013.html + +.. _dds_02_0013: + +Connecting to a Cluster Instance Over Public Networks +===================================================== + +- :ref:`Overview ` +- :ref:`Creating a Cluster Instance ` +- :ref:`Binding an EIP ` +- :ref:`Setting a Security Group ` +- :ref:`Connecting to a Cluster Instance Over Public Networks ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + overview + creating_a_cluster_instance + binding_an_eip + setting_a_security_group + connecting_to_a_cluster_instance_over_public_networks diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/overview.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/overview.rst new file mode 100644 index 0000000..1422093 --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/overview.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0014.html + +.. _dds_02_0014: + +Overview +======== + +**Scenarios** +------------- + +This section describes how to create a cluster instance on the management console, set a security group, bind an EIP, and connect to a cluster instance over public networks. + +Process +------- + +The following describes the steps from creating a DB instance to using it. + + +.. figure:: /_static/images/en-us_image_0000001142773901.png + :alt: **Figure 1** Accessing DB instances from a public network + + **Figure 1** Accessing DB instances from a public network diff --git a/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/setting_a_security_group.rst b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/setting_a_security_group.rst new file mode 100644 index 0000000..7311e05 --- /dev/null +++ b/umn/source/getting_started_with_clusters/connecting_to_a_cluster_instance_over_public_networks/setting_a_security_group.rst @@ -0,0 +1,25 @@ +:original_name: dds_02_0019.html + +.. _dds_02_0019: + +Setting a Security Group +======================== + +Scenarios +--------- + +This section explains how to add a security group rule to control access to and from the DDS DB instances associated with a security group. + +Precautions +----------- + +The default security group rule allows all outgoing data packets. ECSs and DDS DB instances in the same security group can access each other. After a security group is created, you can create different rules for that security group, which allows you to control access to the DB instances that are in it. + +To access a DB instance in a security group from a source outside of that group, you need to create an inbound rule. + +For details about the constraints on using security groups, see "Security Group Overview" in the *Virtual Private Cloud User Guide*. + +Procedure +--------- + +For details about setting a security group, see "Adding a Security Group Rule" in the *Virtual Private Cloud User Guide*. diff --git a/umn/source/getting_started_with_clusters/connection_methods.rst b/umn/source/getting_started_with_clusters/connection_methods.rst new file mode 100644 index 0000000..f8f12a6 --- /dev/null +++ b/umn/source/getting_started_with_clusters/connection_methods.rst @@ -0,0 +1,27 @@ +:original_name: dds_02_0001.html + +.. _dds_02_0001: + +Connection Methods +================== + +You can access DDS over private or public networks. + +.. table:: **Table 1** Connection methods + + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Method | IP Address | Scenario | Description | + +=================+====================+=======================================================================================================================================================================================================+===================================================================================================================================================================================================================+ + | Private network | Private IP address | DDS provides a private IP address by default. | Secure and excellent performance | + | | | | | + | | | - You are advised to use private IP address in following scenarios: | | + | | | | | + | | | - Your ECS instance is in the same VPC subnet as the DDS DB instance. | | + | | | - ECS subnet and DDS subnet are connected to each other by VPC peering. | | + | | | | | + | | | - By default, DDS is not accessible from ECSs that are not in the same security group. If the ECS is not in the same security group, you need to add an inbound rule to enable access. | | + | | | - The default DDS port is 8635, but this port can be modified if necessary. You are advised to modify the port to ensure database security. | | + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Public network | EIP | - If your applications are running on an ECS that is in a different region from the one where the DB instance is located, you are advised to use an EIP to connect the ECS to your DDS DB instances. | - Low security | + | | | - If your applications are deployed on another cloud platform, EIP is recommended. | - For faster transmission and improved security, you are advised to migrate your applications to an ECS that is in the same subnet as your DDS instance and use a private IP address to access the DDS instance. | + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/getting_started_with_clusters/index.rst b/umn/source/getting_started_with_clusters/index.rst index c22e442..bad6288 100644 --- a/umn/source/getting_started_with_clusters/index.rst +++ b/umn/source/getting_started_with_clusters/index.rst @@ -5,18 +5,14 @@ Getting Started with Clusters ============================= -- :ref:`Service Process ` -- :ref:`Restrictions ` -- :ref:`Creating a Cluster Instance ` -- :ref:`Setting a Security Group ` -- :ref:`Connecting to a Cluster Instance ` +- :ref:`Connection Methods ` +- :ref:`Connecting to a Cluster Instance Over Private Networks ` +- :ref:`Connecting to a Cluster Instance Over Public Networks ` .. toctree:: :maxdepth: 1 :hidden: - service_process - restrictions - creating_a_cluster_instance - setting_a_security_group - connecting_to_a_cluster_instance/index + connection_methods + connecting_to_a_cluster_instance_over_private_networks/index + connecting_to_a_cluster_instance_over_public_networks/index diff --git a/umn/source/getting_started_with_clusters/restrictions.rst b/umn/source/getting_started_with_clusters/restrictions.rst deleted file mode 100644 index 1933e3c..0000000 --- a/umn/source/getting_started_with_clusters/restrictions.rst +++ /dev/null @@ -1,36 +0,0 @@ -:original_name: dds_02_0002.html - -.. _dds_02_0002: - -Restrictions -============ - -To improve the stability and security of DB instances, there are some restrictions on the use of DDS. For details, see :ref:`Table 1 `. - -.. _dds_02_0002__table60364850123535: - -.. table:: **Table 1** Function restrictions - - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Operation | Restrictions | - +==============================================+======================================================================================================================================================================+ - | Connecting to a DB instance through a client | - To access a DDS DB instance which is not publicly accessible from an ECS, the instance must be in the same VPC subnet as the ECS. | - | | - By default, DDS cannot be accessed through an ECS in a different security group. You need to add an inbound rule to the DDS security group. | - | | - The default DDS port number is 8635. You can change it if you want to access DDS through another port. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Deployment | ECSs in which DB instances are deployed are not visible to you. Your applications can access the database only through an IP address and port. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Obtaining permissions of user **rwuser** | Only the **rwuser** user permissions are provided on the instance creation page. | - | | | - | | For details about the related commands, see :ref:`Which Commands are Supported or Restricted by DDS? ` | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Setting database parameters | Most database parameters in the parameter groups you created can be modified. For details, see section :ref:`Editing a Parameter Group `. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Migrating data | You can use command line tools, including mongoexport and mongoimport, to migrate data. For details, see section :ref:`Migrating Data `. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Storage engine | The WiredTiger storage engine is supported. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Restarting a DB instance or a node | A DDS DB instance must be restarted on the DDS console. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Viewing DDS backup files | You can download and view the backup files on the DDS console. For details, see section :ref:`Downloading Backup Files `. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/getting_started_with_clusters/service_process.rst b/umn/source/getting_started_with_clusters/service_process.rst deleted file mode 100644 index 17c6d1e..0000000 --- a/umn/source/getting_started_with_clusters/service_process.rst +++ /dev/null @@ -1,32 +0,0 @@ -:original_name: dds_02_0003.html - -.. _dds_02_0003: - -Service Process -=============== - -This section describes how to create a cluster instance, set a security group, and connect to a cluster instance. - -Intended Audience ------------------ - -- Users who create the DDS DB instance for the first time. -- Users who need to perform the initial configuration after a DB instance is created. -- Users who want to know how to connect to the DDS DB instances. - -Process -------- - -The following describes the steps from creating a DB instance to using it. - - -.. figure:: /_static/images/en-us_image_0284274985.png - :alt: **Figure 1** Accessing DB instances from a public network - - **Figure 1** Accessing DB instances from a public network - - -.. figure:: /_static/images/en-us_image_0284275243.png - :alt: **Figure 2** Accessing DB instances from a private network - - **Figure 2** Accessing DB instances from a private network diff --git a/umn/source/getting_started_with_clusters/setting_a_security_group.rst b/umn/source/getting_started_with_clusters/setting_a_security_group.rst deleted file mode 100644 index b4a5e11..0000000 --- a/umn/source/getting_started_with_clusters/setting_a_security_group.rst +++ /dev/null @@ -1,63 +0,0 @@ -:original_name: dds_02_0005.html - -.. _dds_02_0005: - -Setting a Security Group -======================== - -Scenarios ---------- - -This section guides you on how to add a security group rule to control access from and to DDS DB instances in a security group. - -Background Information ----------------------- - -You can access a DDS DB instance in either of the following ways: - -- Public network -- Internal network - -Precautions ------------ - -The default security group rule allows all outgoing data packets. ECSs and DDS DB instances can access each other in the same security group. After a security group is created, you can add security group rules to control the access from and to the DDS DB instances in the security group. - -By default, a tenant can create a maximum of 500 security group rules. An excessive number of security group rules increases the network latency of the first packet. It is recommended that you add a maximum of 50 rules for each security group. - -To access the DDS DB instances in a security group from external resources, create an inbound rule for the security group. - -**Procedure** -------------- - -#. Log in to the management console. -#. Click |image1| in the upper left corner and select a region and project. -#. Click **Service List**. Under **Network**, click **Virtual Private Cloud**. -#. In the navigation pane on the left, choose **Access Control** > **Security Groups**. -#. On the **Security Group** page, click the security group name. -#. On the **Inbound Rules** tab, click **Add Rule**. In the displayed **Add Inbound Rule** dialog box, set required parameters to add inbound rules. On the **Outbound Rules** tab, click **Add Rule**. In the displayed **Add Outbound Rule** dialog box, set required parameters to add outbound rules. -#. Add a security group rule as prompted. - - .. table:: **Table 1** Field description - - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Parameter | Description | Value Example | - +=======================+==================================================================================================================================================+=======================+ - | Protocol | Specifies the network protocol. Allows all traffic or supports user-defined protocols, TCP, UDP, ICMP, and SSH. | TCP | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Port | Specifies the port allowing the access to ECSs or external devices. | 8635 | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Source/Destination | Specifies the supported IP address and security group. | - 192.168.10.0/24 | - | | | - default | - | | - **IP address**: indicates that the security group rule takes effect in a specified IP address range. | | - | | | | - | | - xxx.xxx.xxx.xxx/32 (IPv4) | | - | | - xxx.xxx.xxx.0/24 (subnet) | | - | | - 0.0.0.0/0 (any IP address) | | - | | | | - | | - **Security group**: indicates that this rule allows all IP addresses of ECSs to access DDS DB instances in the same specified security group. | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - -#. Click **OK**. - -.. |image1| image:: /_static/images/en-us_image_0284275123.png diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/binding_and_unbinding_an_eip.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/binding_and_unbinding_an_eip.rst deleted file mode 100644 index 30e5895..0000000 --- a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/binding_and_unbinding_an_eip.rst +++ /dev/null @@ -1,62 +0,0 @@ -:original_name: dds_02_0015.html - -.. _dds_02_0015: - -Binding and Unbinding an EIP -============================ - -.. _dds_02_0015__section055104935914: - -**Scenarios** -------------- - -You can access DDS through a private IP address or an EIP. The application scenario of the connection address is as follows: - -- Use a private IP address when: - - DDS provides a private IP address by default. - - Your applications are deployed on an ECS in a region where your replica set instance is located. - -- Use an EIP when: - - - Your applications are deployed on an ECS in a region separated from the region where your replica set instance is located. - - Your applications are deployed on another cloud platform. - -Precautions ------------ - -- Before accessing a database, you need to apply for an EIP on the VPC console. Then, add an inbound rule to allow the IP addresses or IP address ranges of ECSs. For details, see section :ref:`Setting a Security Group `. -- In the replica set instance, only primary and secondary nodes can be bound to an EIP. To change the EIP that has been bound to a node, you need to unbind it from the node first. - -.. _dds_02_0015__section0350133891310: - -Binding an EIP --------------- - -#. On the **Instance Management** page, click the target replica set instance. - -#. In the navigation pane on the left, choose **Connections**. - -#. In the **Basic Information** area, locate the target node and click **Bind EIP** in the **Operation** column. - -#. In the displayed dialog box, all EIPs in the unbound status are listed. Select the required EIP and click **OK**. If no available EIPs are displayed, click **View EIP** and create an EIP on the VPC console. - -#. In the **EIP** column, check that the EIP is successfully bound. - - To unbind an EIP from the DB instance, see :ref:`Unbinding an EIP `. - -.. _dds_02_0015__section142610351410: - -Unbinding an EIP ----------------- - -#. On the **Instance Management** page, click the replica set instance that has been bound with an EIP. - -#. In the navigation pane on the left, choose **Connections**. - -#. In the **Basic Information** area, locate the target node and click **Unbind EIP** in the **Operation** column. - -#. In the displayed dialog box, click **OK** to unbind the EIP. - - To bind an EIP to the DB instance again, see :ref:`Binding an EIP `. diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/connecting_to_a_db_instance_through_a_client.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/connecting_to_a_db_instance_through_a_client.rst deleted file mode 100644 index 6661c7a..0000000 --- a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/connecting_to_a_db_instance_through_a_client.rst +++ /dev/null @@ -1,150 +0,0 @@ -:original_name: en-us_topic_0105284966.html - -.. _en-us_topic_0105284966: - -Connecting to a DB Instance Through a Client -============================================ - -**Scenarios** -------------- - -This section guides you on how to connect to DB instances through a database client using a common connection or an SSL connection. You are advised to use SSL to encrypt connections to ensure data security. - -Based on the application scenario, you can determine whether to access a DB instance through an EIP. For details, see :ref:`Scenarios `. - -You can directly perform operations on the primary and secondary nodes. Primary nodes are used for processing read and write requests. Secondary nodes replicate data from the primary and are used for processing read requests only. - -This section uses the Linux OS as an example to describe how to connect to a replica set instance. - -Restrictions ------------- - -For details about restrictions on connecting to a DB instance, see :ref:`Restrictions `. - -**Prerequisites** ------------------ - -#. An ECS or a device that can access DDS is ready for use. - - - To connect to a DDS DB instance from an ECS, you need to create and log in to the ECS. For details, see :ref:`How Can I Create and Log In to an ECS? ` - - To connect to a DB instance through an EIP: - - a. Bind an EIP to a DB instance node. For details, see section :ref:`Binding an EIP `. - b. Ensure that your local device can access the EIP that has been bound to the DB instance. - -#. A MongoDB client has been installed on the prepared ECS or the device. - - For details on how to install a MongoDB client, see :ref:`How Can I Install a MongoDB Client? ` - -.. _en-us_topic_0105284966__section3730754113815: - -SSL Connection --------------- - -#. On the **Instance Management** page, click the target DB instance. - -#. In the navigation pane on the left, choose **Connections**. - -#. In the **Basic Information** area, click |image1| next to the **SSL** field to download the root certificate. - -#. Upload the root certificate to the ECS that connects to the DB instance or save the root certificate to a local device that can access DDS. - - The following describes how to upload the certificate to a Linux and Window ECS: - - - In Linux, run the following command: - - **scp** ** **\ **@**\ **\ **:**\ ** - - .. note:: - - - **IDENTITY_FILE** indicates the directory where the root certificate locates. The file access permission is 600. - - **REMOTE_USER** indicates the ECS OS user. - - **REMOTE_ADDRESS** indicates the ECS address. - - **REMOTE_DIR** indicates the directory of the ECS to which the root certificate is uploaded. - - - In Windows, upload the root certificate using file transfer tools. - -#. Connect to a DDS DB instance. - - The Linux OS is used as an example. - - **./mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** - - Enter the database account password when prompted: - - .. code-block:: - - Enter password: - - .. note:: - - - A replica set instance uses the management IP address to generate SSL certificate. **--sslAllowInvalidHostnames** is needed for the SSL connection. - - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. If a device can access the DB instance through an EIP, set this parameter to the EIP displayed in **EIP** column in the node list on the **Connections** page. - - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. - - **DB_USER** indicates the database account name. The default value is **rwuser**. - - **FILE_PATH** indicates the path where the root certificate is stored. - - Example: - - **./mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin --ssl --sslCAFile /tmp/ca.crt** **--sslAllowInvalidHostnames** - -#. Check the connection result. If the following information is displayed, the connection is successful. - - - Result from connecting the primary node in a replica set: - - .. code-block:: - - replica:PRIMARY> - - - Result from connecting the secondary node in a replica set: - - .. code-block:: - - replica:SECONDARY> - -.. _en-us_topic_0105284966__en-us_topic_0085335422_sfc3bfb212a8440799f49320d91fc096c: - -Common Connection ------------------ - -.. important:: - - To use the common connection mode, you need to disable the SSL connection. For details, see section :ref:`Disabling SSL `. - -#. Log in to the prepared ECS or the device that can access the document database. - -#. Connect to a DDS DB instance. - - **./mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** - - Enter the database account password when prompted: - - .. code-block:: - - Enter password: - - .. note:: - - - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. If a device can access the DB instance through an EIP, set this parameter to the EIP displayed in **EIP** column in the node list on the **Connections** page. - - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. - - **DB_USER** indicates the database account name. The default value is **rwuser**. - - Example: - - **./mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin** - -#. Check the connection result. If the following information is displayed, the connection is successful. - - - Result from connecting the primary node in a replica set: - - .. code-block:: - - replica:PRIMARY> - - - Result from connecting the secondary node in a replica set: - - .. code-block:: - - replica:SECONDARY> - -.. |image1| image:: /_static/images/en-us_image_0284275232.png diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/enabling_or_disabling_ssl.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/enabling_or_disabling_ssl.rst deleted file mode 100644 index bcdc9ba..0000000 --- a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/enabling_or_disabling_ssl.rst +++ /dev/null @@ -1,41 +0,0 @@ -:original_name: dds_02_0016.html - -.. _dds_02_0016: - -Enabling or Disabling SSL -========================= - -Scenarios ---------- - -DDS allows you to use SSL to encrypt connections to a DB instance to protect your data. - -- If SSL is enabled, you can connect to a database using SSL. For details, see :ref:`SSL Connection `. -- If SSL is disabled, you can connect to the database using a common connection. For details, see :ref:`Common Connection `. - -.. important:: - - Enabling or disabling SSL will cause DB instance restart. Exercise caution when you perform this operation. - -Enabling SSL ------------- - -#. On the **Instance Management** page, click the target replica set instance. -#. In the navigation pane on the left, choose **Connections**. -#. In the **Basic Information** area, click |image1| next to the **SSL** field. -#. In the displayed dialog box, click **Yes**. -#. In the **Basic Information** area, view the modification result. - -.. _dds_02_0016__section584914451250: - -Disabling SSL -------------- - -#. On the **Instance Management** page, click the target replica set instance. -#. In the navigation pane on the left, choose **Connections**. -#. In the **Basic Information** area, click |image2| next to the **SSL** field. -#. In the displayed dialog box, click **Yes**. -#. In the **Basic Information** area, view the modification result. - -.. |image1| image:: /_static/images/en-us_image_0284275089.png -.. |image2| image:: /_static/images/en-us_image_0284275146.png diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/index.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/index.rst deleted file mode 100644 index e6dfa62..0000000 --- a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -:original_name: dds_02_0014.html - -.. _dds_02_0014: - -Connecting to a Replica Set Instance -==================================== - -- :ref:`Binding and Unbinding an EIP ` -- :ref:`Enabling or Disabling SSL ` -- :ref:`Connecting to a DB Instance Through a Client ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - binding_and_unbinding_an_eip - enabling_or_disabling_ssl - connecting_to_a_db_instance_through_a_client diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/connecting_to_a_replica_set_instance_over_private_networks.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/connecting_to_a_replica_set_instance_over_private_networks.rst new file mode 100644 index 0000000..0e9b887 --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/connecting_to_a_replica_set_instance_over_private_networks.rst @@ -0,0 +1,170 @@ +:original_name: en-us_topic_0105284966.html + +.. _en-us_topic_0105284966: + +Connecting to a Replica Set Instance Over Private Networks +========================================================== + +Scenarios +--------- + +This section describes how to connect to a replica set instance using the MongoDB client over private networks. + +You can directly perform operations on the primary and secondary nodes. Primary nodes are used for processing read and write requests. Secondary nodes replicate data from the primary and are used for processing read requests only. + +The MongoDB client can connect to a DB instance with an unencrypted connection or an encrypted connection (SSL). To improve data transmission security, you are advised to connect to DB instances using the SSL connection. + +**Different OS scenarios**: The following uses Linux ECS and Window client as an example. + +Constraints +----------- + +For details about constraints on connecting to a replica set instance over private networks, see :ref:`Constraints and Recommendations `. + +Prerequisites +------------- + +#. For details on how to create and log in to an ECS, see "Creating and Logging In to a Windows ECS" or "Creating and Logging In to a Linux ECS" in the *Elastic Cloud Server User Guide*. + +#. Install the MongoDB client on the ECS. + + For details on how to install a MongoDB client, see :ref:`How Can I Install a MongoDB Client? ` + +Connecting to a DB Instance Using the MongoDB Client (SSL) +---------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. On the **Instance Management** page, click the target DB instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, click |image1| next to the **SSL** field. + +#. Upload the root certificate to the ECS to be connected to the DB instance. + + The following describes how to upload the certificate to a Linux and Window ECS: + + - In Linux, run the following command: + + **scp** ** **\ **@**\ **\ **:**\ ** + + .. note:: + + - **IDENTITY_FILE** indicates the directory where the root certificate resides. The file access permission is 600. + - **REMOTE_USER** indicates the ECS OS user. + - **REMOTE_ADDRESS** indicates the ECS address. + - **REMOTE_DIR** indicates the directory of the ECS to which the root certificate is uploaded. + + - In Windows, upload the root certificate using the remote connection tool. + +#. Connect to a DDS DB instance. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format + + **mongo** **"mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **,**\ **\ **:**\ **\ **/test?authSource=admin&replicaSet=replica"** **--ssl --sslCAFile** ** **--sslAllowInvalidHostnames** + + If the DB instance is connected using the connection address, add double quotation marks before and after the connection information. The connection information can be obtained in the **Address** column on the **Instance Management** page. + + .. note:: + + - A replica set instance uses the management IP address to generate SSL certificate. **--sslAllowInvalidHostnames** is needed for the SSL connection through a private network. + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + - **FILE_PATH** indicates the path where the root certificate is stored. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin --ssl --sslCAFile /tmp/ca.crt** **--sslAllowInvalidHostnames** + + - Connect to the DB instance using standard URI format. The following is an example command: + + **mongo** **"mongodb://rwuser:@192.168.1.6:8635,\ 192.168.1.80:8635/test?authSource=admin&replicaSet=replica\ "** **--ssl --sslCAFile** **/tmp/ca.crt** **--sslAllowInvalidHostnames** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + - Result from connecting to the primary node in a replica set or connecting to the whole replica set: + + .. code-block:: + + replica:PRIMARY> + + - Result from connecting the secondary node in a replica set: + + .. code-block:: + + replica:SECONDARY> + +Connecting to a DB Instance Using the MongoDB Client (Non-SSL) +-------------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Connect to a DDS DB instance. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using unencrypted connection + + **mongo "mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **,**\ **\ **:**\ **\ **/test?authSource=admin&replicaSet=replica"** + + If the DB instance is connected using the connection address, add double quotation marks before and after the connection information. The connection information can be obtained in the **Address** column on the **Instance Management** page. + + .. note:: + + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin** + + - Connect to the DB instance using standard URI format. The following is an example command: + + **mongo "mongodb://rwuser:@192.168.1.6:8635,\ 192.168.1.80:8635/test?authSource=admin&replicaSet=replica"** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + - Result from connecting to the primary node in a replica set or connecting to the whole replica set: + + .. code-block:: + + replica:PRIMARY> + + - Result from connecting the secondary node in a replica set: + + .. code-block:: + + replica:SECONDARY> + +.. |image1| image:: /_static/images/en-us_image_0000001096133868.png diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/creating_a_replica_set_instance.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/creating_a_replica_set_instance.rst new file mode 100644 index 0000000..889af38 --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/creating_a_replica_set_instance.rst @@ -0,0 +1,174 @@ +:original_name: dds_02_0012.html + +.. _dds_02_0012: + +Creating a Replica Set Instance +=============================== + +Scenarios +--------- + +This section describes how to create a replica set instance on the DDS management console. DDS allows you to tailor your compute resources and storage space to your business needs. + +You can use your account to create up to 50 replica set instances. To create more replica set instances, click |image1| in the upper right corner of the management console. On the **Service Quota** page, click **Increase Quota** to apply for quotas. + +**Procedure** +------------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click **Create DB Instance**. +#. On the displayed page, select your DB instance specifications and click **Create Now**. + + .. table:: **Table 1** Basic information + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+===============================================================================================================================================================================================================================================================================================================================================+ + | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs `. | + | | | + | | .. note:: | + | | | + | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Exercise caution when selecting a region. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | + | | | + | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Database Type | Community Edition | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Type | Select **Replica set**. | + | | | + | | A replica set consists of the primary node, secondary node, and hidden node. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Compatible MongoDB Version | - 4.2 | + | | - 4.0 | + | | - 3.4 | + | | - 3.2 | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Type | Ultra-high I/O | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Engine | WiredTiger | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs `. | + | | | + | | - Instances can be deployed in one or three AZ(s). Selecting multiple AZs distributes the nodes between them. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Disk Encryption | - **Disabled**: Disable the encryption function. | + | | | + | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | + | | | + | | **Key Name**: Select or create a private key, which is the tenant key. | + | | | + | | .. note:: | + | | | + | | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | + | | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | + | | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 2** Specifications + + +---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===============+======================================================================================================================================================================================================================================================================================+ + | Node Class | For details about the DB instance specifications, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing a Replica Set DB Instance Class `. | + +---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Space | The value ranges from 10 GB to 3000 GB and must be a multiple of 10. | + +---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 3** Network + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+===========================================================================================================================================================================================================================================================================================================================================================================================================+ + | VPC | The VPC where your DB instances are located. A VPC isolates networks for different services, so you can easily manage and configure internal networks and change network configuration. For details about how to create a VPC, see section "Creating a VPC" in the *Virtual Private Cloud User Guide*. For details about the constraints on the use of VPCs, see :ref:`Connection Methods `. | + | | | + | | .. note:: | + | | | + | | After the DDS instance is created, the VPC cannot be changed. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subnet | A subnet provides dedicated network resources that are logically isolated from other networks for network security. | + | | | + | | After the instance is created, you can change the private IP address assigned by the subnet. For details, see :ref:`Changing a Private IP Address `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security Group | A security group controls access between DDS and other services for security. | + | | | + | | .. note:: | + | | | + | | Ensure that the security group rule you set allows clients to access DB instances. For example, select the TCP protocol with inbound direction, input the default port number **8635**, and enter a subnet IP address or select a security group that the DB instance belongs to. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SSL | Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission. | + | | | + | | You can enable SSL to improve data security. After a DB instance is created, you can connect to it using SSL. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Cross-CIDR Access | - Configure | + | | | + | | Add the VPC CIDR block of your client. Ensure that the ECS where your client is installed can connect to the DB instance. | + | | | + | | .. note:: | + | | | + | | - To ensure the ECS and the DB instance can communicate with each other, configure a VPC peering connection by referring to section "VPC Peering Connection Overview" in the *Virtual Private Cloud User Guide*. | + | | - Up to 30 CIDR blocks can be configured, and each of them can overlap but they cannot be the same. That is, the source CIDR blocks can overlap but cannot be the same. | + | | | + | | - Skip | + | | | + | | Configure the subnet of the client later. After a DB instance is created, you can configure cross-CIDR access by referring to :ref:`Configuring Cross-CIDR Access for Replica Set Instances `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 4** Database configuration + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=================================================================================================================================================================================================================+ + | Administrator | The default account is **rwuser**. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Administrator Password | Set a password for the administrator. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ``~!@#%^*-_=+?`` | + | | | + | | Keep this password secure. If lost, the system cannot retrieve it for you. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Confirm Password | Enter the administrator password again. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Replica Set Parameter Template | The parameters that apply to the replica set instances. After a DB instance is created, you can change the parameter template you configured for the DB instance to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 5** Tag + + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+======================================================================================================================================================================================================================+ + | Tags | This setting is optional. Adding tags helps you better identify and manage your DB instances. Up to 20 tags can be added for a DB instance. | + | | | + | | A tag is composed of a key-value pair. | + | | | + | | - Key: Mandatory if the DB instance is going to be tagged | + | | | + | | - Each tag key must be unique for each DB instance. | + | | - A tag key consists of up to 36 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | - Value: Optional if the DB instance is going to be tagged | + | | | + | | - The value consists of up to 43 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | After a DB instance is created, you can view its tag details on the **Tags** tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see :ref:`Tag Management `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. note:: + + DB instance performance is determined by how you configure it during the creation. The hardware configuration items that can be selected include the class and storage space of the replica set. + +#. On the displayed page, confirm the DB instance information. + + - If you need to modify the specifications, click **Previous** to return to the previous page. + - If you do not need to modify the specifications, click **Submit** to start the instance creation. + +#. After a DDS DB instance is created, you can view and manage it on the **Instance Management** page. + + - When a DB instance is being created, the status displayed in the **Status** column is **Creating**. This process takes about 15 minutes. After the creation is complete, the status changes to **Available**. + - DDS enables the automated backup policy by default. After a DB instance is created, you can modify or disable the automated backup policy. An automated full backup is immediately triggered after the creation of a DB instance. + - The default DDS port is 8635, but this port can be modified if necessary. If you change the port, you need to add the security group rule to enable access. + +.. |image1| image:: /_static/images/en-us_image_0000001096293848.png diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/index.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/index.rst new file mode 100644 index 0000000..d4c1a3a --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/index.rst @@ -0,0 +1,20 @@ +:original_name: dds_02_0055.html + +.. _dds_02_0055: + +Connecting to a Replica Set Instance Over Private Networks +========================================================== + +- :ref:`Overview ` +- :ref:`Creating a Replica Set Instance ` +- :ref:`Setting a Security Group ` +- :ref:`Connecting to a Replica Set Instance Over Private Networks ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + overview + creating_a_replica_set_instance + setting_a_security_group + connecting_to_a_replica_set_instance_over_private_networks diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/overview.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/overview.rst new file mode 100644 index 0000000..2b5be66 --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/overview.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0057.html + +.. _dds_02_0057: + +Overview +======== + +**Scenarios** +------------- + +This section describes how to create a replica set instance on the management console, set a security group, and connect to a replica set instance over private networks. + +Process +------- + +The following describes the steps from creating a DB instance to using it. + + +.. figure:: /_static/images/en-us_image_0000001096293872.png + :alt: **Figure 1** Accessing DB instances from a private network + + **Figure 1** Accessing DB instances from a private network diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/setting_a_security_group.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/setting_a_security_group.rst new file mode 100644 index 0000000..b1c2184 --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_private_networks/setting_a_security_group.rst @@ -0,0 +1,25 @@ +:original_name: dds_02_0049.html + +.. _dds_02_0049: + +Setting a Security Group +======================== + +**Scenarios** +------------- + +This section guides you on how to add a security group rule to control access from and to DDS DB instances associated with a security group. The following describes how to set security groups. + +Precautions +----------- + +The default security group rule allows all outgoing data packets. By default\ **,** ECSs and DDS DB instances in the same security group can access each other. After a security group is created, you can create different rules for that security group, which allows you to control access to the DB instances that are in it. + +To access a DB instance in a security group from a source outside of that group, you need to create an inbound rule. + +For details about the constraints on using security groups, see "Security Group Overview" in the *Virtual Private Cloud User Guide*. + +Procedure +--------- + +For details about setting a security group, see "Adding a Security Group Rule" in the *Virtual Private Cloud User Guide*. diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/binding_an_eip.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/binding_an_eip.rst new file mode 100644 index 0000000..029cd29 --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/binding_an_eip.rst @@ -0,0 +1,54 @@ +:original_name: dds_02_0053.html + +.. _dds_02_0053: + +Binding an EIP +============== + +**Scenarios** +------------- + +After you create a DB instance, you can bind it to an EIP to allow external access. If later you want to prohibit external access, you can also unbind the EIP from the DB instance. + +Precautions +----------- + +- Before accessing a database, you need to apply for an EIP on the VPC console. Then, add an inbound rule to allow the IP addresses or IP address ranges of ECSs. For details, see section :ref:`Setting a Security Group `. +- In the replica set instance, only primary and secondary nodes can be bound to an EIP. To change the EIP that has been bound to a node, you need to unbind it from the node first. + +.. _dds_02_0053__section33192668203259: + + +Binding an EIP +-------------- + +#. On the **Instance Management** page, click the target replica set instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, locate the target node and click **Bind EIP** in the **Operation** column. + + Or in the **Node Information** area on the **Basic Information** page, locate the target node and choose **More** > **Bind EIP** in the **Operation** column. + +#. In the displayed dialog box, all available unbound EIPs are listed. Select the required EIP and click **OK**. If no available EIPs are displayed, click **View EIP** and create an EIP on the VPC console. + +#. Locate the target node, in the **EIP** column, view the EIP that is successfully bound. + + To unbind an EIP from the DB instance, see :ref:`Unbinding an EIP `. + +.. _dds_02_0053__section186511510267: + +Unbinding an EIP +---------------- + +#. On the **Instance Management** page, click the replica set instance that has been bound with an EIP. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, locate the target node and click **Unbind EIP** in the **Operation** column. + + Or in the **Node Information** area on the **Basic Information** page, locate the target node and choose **More** > **Bind EIP** in the **Operation** column. + +#. In the displayed dialog box, click **Yes**. + + To bind an EIP to the DB instance again, see :ref:`Binding an EIP `. diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/connecting_to_a_replica_set_instance_over_public_networks.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/connecting_to_a_replica_set_instance_over_public_networks.rst new file mode 100644 index 0000000..e6baca5 --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/connecting_to_a_replica_set_instance_over_public_networks.rst @@ -0,0 +1,298 @@ +:original_name: dds_02_0047.html + +.. _dds_02_0047: + +Connecting to a Replica Set Instance Over Public Networks +========================================================= + +**Scenarios** +------------- + +This section describes how to connect to a replica set instance using the MongoDB client and Robo 3T over public networks. + +You can directly perform operations on the primary and secondary nodes. Primary nodes are used for processing read and write requests. Secondary nodes replicate data from the primary and are used for processing read requests only. + +The MongoDB client and Robo 3T can connect to a DB instance with an unencrypted connection or an encrypted connection (SSL). To improve data transmission security, you are advised to connect to DB instances using the SSL connection. + +**Different OS scenarios**: Examples include Linux and Windows clients. + +**Prerequisites** +----------------- + +#. :ref:`Bind an EIP ` to the Replica set instance and :ref:`set security group rules ` to ensure that the EIP can be accessed with the DB client application. + +#. Install the MongoDB client or Robo 3T. + + **MongoDB client** + + a. For details on how to create and log in to an ECS, see "Creating and Logging In to a Windows ECS" or "Creating and Logging In to a Linux ECS" in the *Elastic Cloud Server User Guide*. + + b. Install the MongoDB client on the ECS. + + For details on how to install a MongoDB client, see :ref:`How Can I Install a MongoDB Client? ` + + **Robo 3T** + + For details on how to install Robo 3T, see :ref:`How Do I Install Robo 3T? ` + +#. If SSL is enabled, download the SSL certificate on the DDS console. + + a. On the **Instance Management** page, click the target DB instance. + b. In the navigation pane on the left, choose **Connections**. + c. In the **Basic Information** area, click |image1| next to the **SSL** field. + + .. note:: + + The certificate can also be downloaded from the Node Information area on the Basic Information page. + +Connecting to a DB Instance Using Robo 3T (SSL) +----------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. Run the installed Robo 3T. On the displayed dialog box, click **Create**. + + + .. figure:: /_static/images/en-us_image_0000001142893853.png + :alt: **Figure 1** Connections + + **Figure 1** Connections + +#. In the **Connection Settings** dialog box, set the parameters of the new connection. + + a. On the **Connection** tab, enter the name of the new connection in the **Name** text box and enter the EIP and database port that are bound to the replica set instance in the **Address** text box. + + + .. figure:: /_static/images/en-us_image_0000001096453842.png + :alt: **Figure 2** Connection + + **Figure 2** Connection + + b. On the **Authentication** tab, set **Database** to **admin**, **User Name** to **rwuser**, and **Password** to the administrator password you set during the creation of the replica set instance. + + + .. figure:: /_static/images/en-us_image_0000001142773895.png + :alt: **Figure 3** Authentication + + **Figure 3** Authentication + + c. On the **SSL** tab, upload the SSL certificate and select **Allowed** for **Invalid Hostnames**. + + + .. figure:: /_static/images/en-us_image_0000001142773903.png + :alt: **Figure 4** SSL + + **Figure 4** SSL + + d. Click **Save**. + +#. On the **MongoDB Connections** page, click **Connect** to connect to the replica set instance. + + + .. figure:: /_static/images/en-us_image_0000001095974038.png + :alt: **Figure 5** Connections + + **Figure 5** Connections + +#. If the replica set instance is successfully connected, the page shown in :ref:`Figure 6 ` is displayed. + + .. _dds_02_0047__fig78478367495: + + .. figure:: /_static/images/en-us_image_0000001095974034.png + :alt: **Figure 6** Connection succeeded + + **Figure 6** Connection succeeded + +Connecting to a DB Instance Using Robo 3T (Non-SSL) +--------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Run the installed Robo 3T. On the displayed dialog box, click **Create**. + + + .. figure:: /_static/images/en-us_image_0000001096293846.png + :alt: **Figure 7** Connections + + **Figure 7** Connections + +#. In the **Connection Settings** dialog box, set the parameters of the new connection. + + a. On the **Connection** tab, enter the name of the new connection in the **Name** text box and enter the EIP and database port that are bound to the replica set instance in the **Address** text box. + + + .. figure:: /_static/images/en-us_image_0000001096453840.png + :alt: **Figure 8** Connection + + **Figure 8** Connection + + b. On the **Authentication** tab, set **Database** to **admin**, **User Name** to **rwuser**, and **Password** to the administrator password you set during the creation of the replica set instance. + + + .. figure:: /_static/images/en-us_image_0000001142773899.png + :alt: **Figure 9** Authentication + + **Figure 9** Authentication + + c. Click **Save**. + +#. On the **MongoDB Connections** page, click **Connect** to connect to the replica set instance. + + + .. figure:: /_static/images/en-us_image_0000001096133860.png + :alt: **Figure 10** Connections + + **Figure 10** Connections + +#. If the replica set instance is successfully connected, the page shown in :ref:`Figure 11 ` is displayed. + + .. _dds_02_0047__fig1450295643717: + + .. figure:: /_static/images/en-us_image_0000001096293844.png + :alt: **Figure 11** Connection succeeded + + **Figure 11** Connection succeeded + +Connecting to a DB Instance Using the MongoDB Client (SSL) +---------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. On the **Instance Management** page, click the target DB instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, click |image2| next to the **SSL** field. + +#. Upload the root certificate to the ECS to be connected to the DB instance. + + The following describes how to upload the certificate to a Linux and Window ECS: + + - In Linux, run the following command: + + **scp** ** **\ **@**\ **\ **:**\ ** + + .. note:: + + - **IDENTITY_FILE** indicates the directory where the root certificate resides. The file access permission is 600. + - **REMOTE_USER** indicates the ECS OS user. + - **REMOTE_ADDRESS** indicates the ECS address. + - **REMOTE_DIR** indicates the directory of the ECS to which the root certificate is uploaded. + + - In Windows, upload the root certificate using the remote connection tool. + +#. Connect to the DB instance in the directory where the MongoDB client is located. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format + + **mongo** **"mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **/test?authSource=admin&replicaSet=replica"** **--ssl --sslCAFile** ** **--sslAllowInvalidHostnames** + + To obtain the public connection address, click the instance name and choose **Connections**. The address is displayed in **Public Network Connection Address** field on the **Public Connection** tab. + + .. note:: + + - A replica set instance uses the management IP address to generate SSL certificate. **--sslAllowInvalidHostnames** is needed for the SSL connection through a public network. + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **EIP** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + - **FILE_PATH** indicates the path where the root certificate is stored. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo** **--host replica/192.168.1.6,192.168.1.80 --port 8635 -u rwuser -p --authenticationDatabase admin --ssl --sslCAFile /tmp/ca.crt** **--sslAllowInvalidHostnames** + + - Connect to the DB instance Using standard URI format. The following is an example command: + + **mongo** **"mongodb://rwuser:@\ 192.168.1.80:8635/test?authSource=admin&replicaSet=replica\ "** **--ssl --sslCAFile** **/tmp/ca.crt** **--sslAllowInvalidHostnames** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + - Result from connecting to the primary node in a replica set or connecting to the whole replica set: + + .. code-block:: + + replica:PRIMARY> + + - Result from connecting the secondary node in a replica set: + + .. code-block:: + + replica:SECONDARY> + +Connecting to a DB Instance Using the MongoDB Client (Non-SSL) +-------------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Connect to a DDS DB instance. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format + + **mongo "mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **/test?authSource=admin&replicaSet=replica"** + + To obtain the public connection address, click the instance name and choose **Connections**. The address is displayed in **Public Network Connection Address** field on the **Public Connection** tab. + + .. note:: + + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **EIP** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo** **--host replica/192.168.1.6,192.168.1.80 --port 8635 -u rwuser -p --authenticationDatabase admin** + + - Connect to the DB instance Using standard URI format. The following is an example command: + + **mongo "mongodb://rwuser:@\ 192.168.1.80:8635/test?authSource=admin&replicaSet=replica"** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + - Result from connecting to the primary node in a replica set or connecting to the whole replica set: + + .. code-block:: + + replica:PRIMARY> + + - Result from connecting the secondary node in a replica set: + + .. code-block:: + + replica:SECONDARY> + +.. |image1| image:: /_static/images/en-us_image_0000001143053801.png +.. |image2| image:: /_static/images/en-us_image_0000001143053799.png diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/creating_a_replica_set_instance.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/creating_a_replica_set_instance.rst new file mode 100644 index 0000000..04b51cc --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/creating_a_replica_set_instance.rst @@ -0,0 +1,174 @@ +:original_name: dds_02_0052.html + +.. _dds_02_0052: + +Creating a Replica Set Instance +=============================== + +Scenarios +--------- + +This section describes how to create a replica set instance on the DDS management console. DDS allows you to tailor your compute resources and storage space to your business needs. + +You can use your account to create up to 50 replica set instances. To create more replica set instances, click |image1| in the upper right corner of the management console. On the **Service Quota** page, click **Increase Quota** to apply for quotas. + +**Procedure** +------------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click **Create DB Instance**. +#. On the displayed page, select your DB instance specifications and click **Create Now**. + + .. table:: **Table 1** Basic information + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+===============================================================================================================================================================================================================================================================================================================================================+ + | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs `. | + | | | + | | .. note:: | + | | | + | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Exercise caution when selecting a region. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | + | | | + | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Database Type | Community Edition | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Type | Select **Replica set**. | + | | | + | | A replica set consists of the primary node, secondary node, and hidden node. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Compatible MongoDB Version | - 4.2 | + | | - 4.0 | + | | - 3.4 | + | | - 3.2 | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Type | Ultra-high I/O | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Engine | WiredTiger | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs `. | + | | | + | | - Instances can be deployed in one or three AZ(s). Selecting multiple AZs distributes the nodes between them. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Disk Encryption | - **Disabled**: Disable the encryption function. | + | | | + | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | + | | | + | | **Key Name**: Select or create a private key, which is the tenant key. | + | | | + | | .. note:: | + | | | + | | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | + | | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | + | | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 2** Specifications + + +---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===============+======================================================================================================================================================================================================================================================================================+ + | Node Class | For details about the DB instance specifications, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing a Replica Set DB Instance Class `. | + +---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Space | The value ranges from 10 GB to 3000 GB and must be a multiple of 10. | + +---------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 3** Network + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+===========================================================================================================================================================================================================================================================================================================================================================================================================+ + | VPC | The VPC where your DB instances are located. A VPC isolates networks for different services, so you can easily manage and configure internal networks and change network configuration. For details about how to create a VPC, see section "Creating a VPC" in the *Virtual Private Cloud User Guide*. For details about the constraints on the use of VPCs, see :ref:`Connection Methods `. | + | | | + | | .. note:: | + | | | + | | After the DDS instance is created, the VPC cannot be changed. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subnet | A subnet provides dedicated network resources that are logically isolated from other networks for network security. | + | | | + | | After the instance is created, you can change the private IP address assigned by the subnet. For details, see :ref:`Changing a Private IP Address `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security Group | A security group controls access between DDS and other services for security. | + | | | + | | .. note:: | + | | | + | | Ensure that the security group rule you set allows clients to access DB instances. For example, select the TCP protocol with inbound direction, input the default port number **8635**, and enter a subnet IP address or select a security group that the DB instance belongs to. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SSL | Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission. | + | | | + | | You can enable SSL to improve data security. After a DB instance is created, you can connect to it using SSL. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Cross-CIDR Access | - Configure | + | | | + | | Add the VPC CIDR block of your client. Ensure that the ECS where your client is installed can connect to the DB instance. | + | | | + | | .. note:: | + | | | + | | - To ensure the ECS and the DB instance can communicate with each other, configure a VPC peering connection by referring to section "VPC Peering Connection Overview" in the *Virtual Private Cloud User Guide*. | + | | - Up to 30 CIDR blocks can be configured, and each of them can overlap but they cannot be the same. That is, the source CIDR blocks can overlap but cannot be the same. | + | | | + | | - Skip | + | | | + | | Configure the subnet of the client later. After a DB instance is created, you can configure cross-CIDR access by referring to :ref:`Configuring Cross-CIDR Access for Replica Set Instances `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 4** Database configuration + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=================================================================================================================================================================================================================+ + | Administrator | The default account is **rwuser**. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Administrator Password | Set a password for the administrator. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ``~!@#%^*-_=+?`` | + | | | + | | Keep this password secure. If lost, the system cannot retrieve it for you. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Confirm Password | Enter the administrator password again. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Replica Set Parameter Template | The parameters that apply to the replica set instances. After a DB instance is created, you can change the parameter template you configured for the DB instance to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 5** Tag + + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+======================================================================================================================================================================================================================+ + | Tags | This setting is optional. Adding tags helps you better identify and manage your DB instances. Up to 20 tags can be added for a DB instance. | + | | | + | | A tag is composed of a key-value pair. | + | | | + | | - Key: Mandatory if the DB instance is going to be tagged | + | | | + | | - Each tag key must be unique for each DB instance. | + | | - A tag key consists of up to 36 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | - Value: Optional if the DB instance is going to be tagged | + | | | + | | - The value consists of up to 43 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | After a DB instance is created, you can view its tag details on the **Tags** tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see :ref:`Tag Management `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. note:: + + DB instance performance is determined by how you configure it during the creation. The hardware configuration items that can be selected include the class and storage space of the replica set. + +#. On the displayed page, confirm the DB instance information. + + - If you need to modify the specifications, click **Previous** to return to the previous page. + - If you do not need to modify the specifications, click **Submit** to start the instance creation. + +#. After a DDS DB instance is created, you can view and manage it on the **Instance Management** page. + + - When a DB instance is being created, the status displayed in the **Status** column is **Creating**. This process takes about 15 minutes. After the creation is complete, the status changes to **Available**. + - DDS enables the automated backup policy by default. After a DB instance is created, you can modify or disable the automated backup policy. An automated full backup is immediately triggered after the creation of a DB instance. + - The default DDS port is 8635, but this port can be modified if necessary. If you change the port, you need to add the security group rule to enable access. + +.. |image1| image:: /_static/images/en-us_image_0000001096293848.png diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/index.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/index.rst new file mode 100644 index 0000000..4ba43fd --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/index.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0050.html + +.. _dds_02_0050: + +Connecting to a Replica Set Instance Over Public Networks +========================================================= + +- :ref:`Overview ` +- :ref:`Creating a Replica Set Instance ` +- :ref:`Binding an EIP ` +- :ref:`Setting a Security Group ` +- :ref:`Connecting to a Replica Set Instance Over Public Networks ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + overview + creating_a_replica_set_instance + binding_an_eip + setting_a_security_group + connecting_to_a_replica_set_instance_over_public_networks diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/overview.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/overview.rst new file mode 100644 index 0000000..98bf573 --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/overview.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0051.html + +.. _dds_02_0051: + +Overview +======== + +**Scenarios** +------------- + +This section describes how to create a replica set instance on the management console, set a security group, bind an EIP, and connect to a replica set instance over public networks. + +Process +------- + +The following describes the steps from creating a DB instance to using it. + + +.. figure:: /_static/images/en-us_image_0000001143053829.png + :alt: **Figure 1** Accessing DB instances from a public network + + **Figure 1** Accessing DB instances from a public network diff --git a/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/setting_a_security_group.rst b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/setting_a_security_group.rst new file mode 100644 index 0000000..00d747c --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connecting_to_a_replica_set_instance_over_public_networks/setting_a_security_group.rst @@ -0,0 +1,25 @@ +:original_name: dds_02_0054.html + +.. _dds_02_0054: + +Setting a Security Group +======================== + +**Scenarios** +------------- + +This section guides you on how to add a security group rule to control access from and to DDS DB instances associated with a security group. The following describes how to set security groups. + +Precautions +----------- + +The default security group rule allows all outgoing data packets. By default\ **,** ECSs and DDS DB instances in the same security group can access each other. After a security group is created, you can create different rules for that security group, which allows you to control access to the DB instances that are in it. + +To access a DB instance in a security group from a source outside of that group, you need to create an inbound rule. + +For details about the constraints on using security groups, see "Security Group Overview" in the *Virtual Private Cloud User Guide*. + +Procedure +--------- + +For details about setting a security group, see "Adding a Security Group Rule" in the *Virtual Private Cloud User Guide*. diff --git a/umn/source/getting_started_with_replica_sets/connection_methods.rst b/umn/source/getting_started_with_replica_sets/connection_methods.rst new file mode 100644 index 0000000..e915229 --- /dev/null +++ b/umn/source/getting_started_with_replica_sets/connection_methods.rst @@ -0,0 +1,27 @@ +:original_name: dds_02_0042.html + +.. _dds_02_0042: + +Connection Methods +================== + +You can access DDS over private or public networks. + +.. table:: **Table 1** Connection methods + + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Method | IP Address | Scenario | Description | + +=================+====================+=======================================================================================================================================================================================================+===============================================================================================================================================================================================================+ + | Private network | Private IP address | DDS provides a private IP address by default. | Secure and excellent performance | + | | | | | + | | | - You are advised to use private IP address in following scenarios: | | + | | | | | + | | | - Your ECS instance is in the same VPC subnet as the DDS DB instance | | + | | | - ECS subnet and DDS subnet are connected to each other by VPC peering. | | + | | | | | + | | | - By default, DDS is not accessible from ECSs that are not in the same security group. If the ECS is not in the same group, you need to add an inbound rule to enable access. | | + | | | - The default DDS port is 8635, but this port can be modified if necessary. | | + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Public network | EIP | - If your applications are running on an ECS that is in a different region from the one where the DB instance is located, you are advised to use an EIP to connect the ECS to your DDS DB instances. | - Low security | + | | | - If your applications are deployed on another cloud platform, EIP is recommended. | - For faster transmission and improved security, you are advised to migrate your applications to an ECS that is in the same subnet as your DDS instance and use a private IP address to access the instance. | + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/getting_started_with_replica_sets/index.rst b/umn/source/getting_started_with_replica_sets/index.rst index 8f646b2..5e97858 100644 --- a/umn/source/getting_started_with_replica_sets/index.rst +++ b/umn/source/getting_started_with_replica_sets/index.rst @@ -5,18 +5,14 @@ Getting Started with Replica Sets ================================= -- :ref:`Service Process ` -- :ref:`Restrictions ` -- :ref:`Creating a Replica Set Instance ` -- :ref:`Setting a Security Group ` -- :ref:`Connecting to a Replica Set Instance ` +- :ref:`Connection Methods ` +- :ref:`Connecting to a Replica Set Instance Over Private Networks ` +- :ref:`Connecting to a Replica Set Instance Over Public Networks ` .. toctree:: :maxdepth: 1 :hidden: - service_process - restrictions - creating_a_replica_set_instance - setting_a_security_group - connecting_to_a_replica_set_instance/index + connection_methods + connecting_to_a_replica_set_instance_over_private_networks/index + connecting_to_a_replica_set_instance_over_public_networks/index diff --git a/umn/source/getting_started_with_replica_sets/restrictions.rst b/umn/source/getting_started_with_replica_sets/restrictions.rst deleted file mode 100644 index 928e333..0000000 --- a/umn/source/getting_started_with_replica_sets/restrictions.rst +++ /dev/null @@ -1,36 +0,0 @@ -:original_name: dds_02_0011.html - -.. _dds_02_0011: - -Restrictions -============ - -To improve the stability and security of DB instances, there are some restrictions on the use of DDS. For details, see :ref:`Table 1 `. - -.. _dds_02_0011__en-us_topic_0105284934_table60364850123535: - -.. table:: **Table 1** Function restrictions - - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Operation | Restrictions | - +==============================================+======================================================================================================================================================================+ - | Connecting to a DB instance through a client | - To access a DDS DB instance which is not publicly accessible from an ECS, the instance must be in the same VPC subnet as the ECS. | - | | - By default, DDS cannot be accessed through an ECS in a different security group. You need to add an inbound rule to the DDS security group. | - | | - The default DDS port number is 8635. You can change it if you want to access DDS through another port. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Deployment | ECSs in which DB instances are deployed are not visible to you. Your applications can access the database only through an IP address and port. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Obtaining permissions of user **rwuser** | Only the **rwuser** user permissions are provided on the instance creation page. | - | | | - | | For details about the related commands, see :ref:`Which Commands are Supported or Restricted by DDS? ` | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Setting database parameters | Most database parameters in the parameter groups you created can be modified. For details, see section :ref:`Editing a Parameter Group `. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Migrating data | You can use command line tools, including mongoexport and mongoimport, to migrate data. For details, see section :ref:`Migrating Data `. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Storage engine | Currently, DDS supports the WiredTiger storage engine only. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Restarting a DB instance or a node | A DDS DB instance must be restarted on the DDS console. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Viewing DDS backup files | You can download and view the backup files on the DDS console. For details, see section :ref:`Downloading Backup Files `. | - +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/getting_started_with_replica_sets/service_process.rst b/umn/source/getting_started_with_replica_sets/service_process.rst deleted file mode 100644 index 9cfa78a..0000000 --- a/umn/source/getting_started_with_replica_sets/service_process.rst +++ /dev/null @@ -1,33 +0,0 @@ -:original_name: dds_02_0010.html - -.. _dds_02_0010: - -Service Process -=============== - -This section describes how to create a replica set instance, set a security group, and connect to a replica set instance. - -Intended Audience ------------------ - -- Users who create the DDS DB instance for the first time. -- Users who need to perform the initial configuration after a DB instance is created. -- Users who want to know how to connect to the DDS DB instances. - - -Service Process ---------------- - -The following describes the steps from creating a DB instance to using it. - - -.. figure:: /_static/images/en-us_image_0284274974.png - :alt: **Figure 1** Accessing DB instances from a public network - - **Figure 1** Accessing DB instances from a public network - - -.. figure:: /_static/images/en-us_image_0284275043.png - :alt: **Figure 2** Accessing DB instances from a private network - - **Figure 2** Accessing DB instances from a private network diff --git a/umn/source/getting_started_with_replica_sets/setting_a_security_group.rst b/umn/source/getting_started_with_replica_sets/setting_a_security_group.rst deleted file mode 100644 index 59f9ceb..0000000 --- a/umn/source/getting_started_with_replica_sets/setting_a_security_group.rst +++ /dev/null @@ -1,63 +0,0 @@ -:original_name: dds_02_0013.html - -.. _dds_02_0013: - -Setting a Security Group -======================== - -**Scenarios** -------------- - -This section guides you on how to add a security group rule to control access from and to DDS DB instances in a security group. This document describes how to set security groups. - -Background Information ----------------------- - -You can access a DDS DB instance in either of the following ways: - -- Public network -- Internal network - -Precautions ------------ - -The default security group rule allows all outgoing data packets. ECSs and DDS DB instances can access each other in the same security group. After a security group is created, you can add security group rules to control the access from and to the DDS DB instances in the security group. - -By default, a tenant can create a maximum of 500 security group rules. An excessive number of security group rules increases the network latency of the first packet. It is recommended that you add a maximum of 50 rules for each security group. - -To access the DDS DB instances in a security group from external resources, create an inbound rule for the security group. - -**Procedure** -------------- - -#. Log in to the management console. -#. Click |image1| in the upper left corner and select a region and project. -#. Click **Service List**. Under **Network**, click **Virtual Private Cloud**. -#. In the navigation pane on the left, choose **Access Control** > **Security Groups**. -#. On the **Security Group** page, click the security group name. -#. On the **Inbound Rules** tab, click **Add Rule**. In the displayed **Add Inbound Rule** dialog box, set required parameters to add inbound rules. On the **Outbound Rules** tab, click **Add Rule**. In the displayed **Add Outbound Rule** dialog box, set required parameters to add outbound rules. -#. Add a security group rule as prompted. - - .. table:: **Table 1** Parameter description - - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Parameter | Description | Value Example | - +=======================+==================================================================================================================================================+=======================+ - | Protocol | Specifies the network protocol. Allows all traffic or supports user-defined protocols, TCP, UDP, ICMP, and SSH. | TCP | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Port | Specifies the port allowing the access to ECSs or external devices. | 8635 | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Source/Destination | Specifies the supported IP address and security group. | - 192.168.10.0/24 | - | | | - default | - | | - **IP address**: indicates that the security group rule takes effect in a specified IP address range. | | - | | | | - | | - xxx.xxx.xxx.xxx/32 (IPv4) | | - | | - xxx.xxx.xxx.0/24 (subnet) | | - | | - 0.0.0.0/0 (any IP address) | | - | | | | - | | - **Security group**: indicates that this rule allows all IP addresses of ECSs to access DDS DB instances in the same specified security group. | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - -#. Click **OK**. - -.. |image1| image:: /_static/images/en-us_image_0284275018.png diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/connecting_to_a_single_node_instance_over_private_networks.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/connecting_to_a_single_node_instance_over_private_networks.rst new file mode 100644 index 0000000..3107c76 --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/connecting_to_a_single_node_instance_over_private_networks.rst @@ -0,0 +1,156 @@ +:original_name: dds_02_0028.html + +.. _dds_02_0028: + +Connecting to a Single Node Instance Over Private Networks +========================================================== + +Scenarios +--------- + +This section describes how to connect to a single-node instance using the MongoDB client over private networks. + +The MongoDB client can connect to a DB instance with an unencrypted connection or an encrypted connection (SSL). To improve data transmission security, you are advised to connect to DB instances using the SSL connection. + +**Different OS scenarios**: Examples include Linux and Windows clients. + +Constraints +----------- + +For details about constraints on connecting to a single node instance, see :ref:`Constraints and Recommendations `. + +Prerequisites +------------- + +#. For details on how to create and log in to an ECS, see "Creating and Logging In to a Windows ECS" or "Creating and Logging In to a Linux ECS" in the *Elastic Cloud Server User Guide*. + +#. Install the MongoDB client on the ECS. + + For details on how to install a MongoDB client, see :ref:`How Can I Install a MongoDB Client? ` + +Connecting to a DB Instance Using the MongoDB Client (SSL) +---------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. On the **Instance Management** page, click the target DB instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, click |image1| next to the **SSL** field. + + .. note:: + + The certificate can also be downloaded from the Node Information area on the Basic Information page. + +#. Upload the root certificate to the ECS to be connected to the DB instance. + + The following describes how to upload the certificate to a Linux and Window ECS: + + - In Linux, run the following command: + + **scp** ** **\ **@**\ **\ **:**\ ** + + .. note:: + + - **IDENTITY_FILE** indicates the directory where the root certificate resides. The file access permission is 600. + - **REMOTE_USER** indicates the ECS OS user. + - **REMOTE_ADDRESS** indicates the ECS address. + - **REMOTE_DIR** indicates the directory of the ECS to which the root certificate is uploaded. + + - In Windows, upload the root certificate using the remote connection tool. + +#. Connect to a DDS DB instance. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format + + **mongo** **mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **/test?authSource=admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** + + The connection information can be obtained in the **Address** column on the **Instance Management** page. + + .. note:: + + - A single node instance uses the management IP address to generate SSL certificate. **--sslAllowInvalidHostnames** is needed for the SSL connection over private networks. + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + - **FILE_PATH** indicates the path where the root certificate is stored. + + - Connect to the DB instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin --ssl --sslCAFile /tmp/ca.crt** **--sslAllowInvalidHostnames** + + - Connect to the DB instance using standard URI format. The following is an example command: + + **mongo** **mongodb://rwuser:@192.168.1.6:8635/test?authSource=admin** **--ssl --sslCAFile** **/tmp/ca.crt** **--sslAllowInvalidHostnames** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + .. code-block:: + + replica:PRIMARY> + +Connecting to a DB Instance Using the MongoDB Client (Non-SSL) +-------------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Connect to a DDS DB instance. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format + + **mongo** **mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **/test?authSource=admin** + + The connection information can be obtained in the **Address** column on the **Instance Management** page. + + .. note:: + + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **Private IP Address** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + + - Connect to the DB instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin** + + - Connect to the DB instance using standard URI format. The following is an example command: + + **mongo** **mongodb://rwuser:@192.168.1.6:8635/test?authSource=admin** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + .. code-block:: + + replica:PRIMARY> + +.. |image1| image:: /_static/images/en-us_image_0000001142773955.png diff --git a/umn/source/getting_started_with_replica_sets/creating_a_replica_set_instance.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/creating_a_single_node_instance.rst similarity index 72% rename from umn/source/getting_started_with_replica_sets/creating_a_replica_set_instance.rst rename to umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/creating_a_single_node_instance.rst index a432caf..3249cbd 100644 --- a/umn/source/getting_started_with_replica_sets/creating_a_replica_set_instance.rst +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/creating_a_single_node_instance.rst @@ -1,157 +1,161 @@ -:original_name: dds_02_0012.html +:original_name: dds_02_0023.html -.. _dds_02_0012: +.. _dds_02_0023: -Creating a Replica Set Instance +Creating a Single Node Instance =============================== -**Scenarios** -------------- +Scenarios +--------- -This section describes how to create a DDS replica set instance on the DDS management console. DDS allows you to tailor your computing resources and storage space to your business needs. +This section describes how to create a single node instance on the DDS management console. DDS allows you to tailor your computing resources and storage space to your business needs. -You can use your account to create a maximum of 50 replica set instances in total. To create more replica set instances, click |image1| in the upper right corner of the management console. On the **Service Quota** page, click **Increase Quota** to apply for quotas. +You can use your account to create a maximum of 20 single nodes in total. To create more single node instances, click |image1| in the upper right corner of the management console. On the **Service Quota** page, click **Increase Quota** to apply for quotas. -**Procedure** -------------- +Procedure +--------- #. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click **Create** **DB Instance**. -#. On the displayed page, configure parameters about DB instance specifications. Then, click **Create Now**. +#. On the **Instance Management** page, click **Create DB Instance**. +#. On the displayed page, select your DB instance specifications and click **Create Now**. .. table:: **Table 1** Basic information - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+===============================================================================================================================================================================================================================================================================================================================================+ - | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs `. | - | | | - | | .. note:: | - | | | - | | DB instances in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Therefore, exercise caution when selecting a region. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | - | | | - | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Modifying the DB Instance Name `. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Database Type | Community Edition | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DB Instance Type | Select **Replica set**. | - | | | - | | A replica set consists of the primary node, secondary node, and hidden node. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Compatible MongoDB Version | - 3.4 | - | | - 3.2 | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Storage Engine | WiredTiger | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | AZ | A physical region where resources use independent power supply and networks. AZs are physically isolated but interconnected through the internal network. For details, see section :ref:`Regions and AZs `. | - | | | - | | A replica set instance can be deployed in one AZ or three AZs only. If the replica set instance is deployed across three AZs, the primary, secondary, and hidden nodes are deployed in three AZs respectively for high availability. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Disk Encryption | - **Disable**: Disable the encryption function. | - | | | - | | - **Enable**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | - | | | - | | **Key Name**: Select or create a private key, which is the tenant key. | - | | | - | | .. note:: | - | | | - | | - After a DB instance is created, the disk encryption status and the key cannot be changed. Backup data stored on OBS is not encrypted. | - | | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | - | | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+===================================================================================================================================================================================================================================================+ + | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs `. | + | | | + | | .. note:: | + | | | + | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Therefore, you should exercise caution when selecting a region. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | + | | | + | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name `. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Database Type | Community Edition | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Type | Select **Single Node**. | + | | | + | | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Compatible MongoDB Version | - 4.2 | + | | - 4.0 | + | | - 3.4 | + | | - 3.2 | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Type | Ultra-high I/O | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Engine | WiredTiger | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs `. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Disk Encryption | - **Disabled**: Disable the encryption function. | + | | | + | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | + | | | + | | **Key Name**: Select or create a private key, which is the tenant key. | + | | | + | | .. note:: | + | | | + | | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | + | | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | + | | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Specifications - +---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===============+=====================================================================================================================================================================================================================================================================================================+ - | Node Class | For details about the DB instance specifications, see section :ref:`DB Instance Specifications `. After a DB instance is created, you can change its CPU and memory. For details, see section :ref:`Changing the CPU or Memory of a Replica Set DB Instance `. | - +---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Storage Type | Ultra-high I/O: uses the SSD disk type. | - +---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Storage Space | Ranges from 10 GB to 2,000 GB. The value must be a multiple of 10. | - +---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------+----------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===============+================================================================================================================+ + | Node Class | For details about the DB instance specifications, see section :ref:`DB Instance Specifications `. | + +---------------+----------------------------------------------------------------------------------------------------------------+ + | Storage Space | The value ranges from 10 GB to 1,000 GB and must be a multiple of 10. | + +---------------+----------------------------------------------------------------------------------------------------------------+ .. table:: **Table 3** Network - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+========================================================================================================================================================================================================================================================================================================================================================================+ - | VPC | The VPC to which a DB instance belongs isolates networks for different services. It allows user to manage and configure internal networks and change network configuration, simplifying network management. You need to create or select the required VPC. For details on how to create a VPC, see section "Creating a VPC" in the *Virtual Private Cloud User Guide*. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Subnet | A subnet provides dedicated network resources that are logically isolated from other networks, improving network security. After a DB instance is created, you can click the DB instance name and change the private IP address assigned by the subnet to the node on the **Basic Information** page. | - | | | - | | .. note:: | - | | | - | | Changing the private IP address of a node will invalidate the previous private IP address. If an EIP is bound to the node, do not unbind the EIP during the change of the private IP address. After the change, the new private IP address is bound to the EIP. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Security Group | A security group controls access between DDS and other services for security. | - | | | - | | .. note:: | - | | | - | | Ensure that the security group rule you set allows clients to access DB instances. For example, select the TCP protocol with inbound direction, input the default port number **8635**, and enter a subnet IP address or select a security group that the DB instance belongs to. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | SSL | Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission. | - | | | - | | You can enable SSL to improve data security. After a DB instance is created, you can connect to it in SSL mode. For details, see :ref:`Connecting to a DB Instance Through a Client `. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | VPC | The VPC where your DB instances are located. A VPC isolates networks for different services, so you can easily manage and configure internal networks and change network configuration. You need to create or select the required VPC. For details about how to create a VPC, see section "Creating a VPC" in the *Virtual Private Cloud User Guide*. For details about the constraints on the use of VPCs, see :ref:`Connection Methods `. | + | | | + | | If there are no VPCs available, DDS allocates resources to you by default. | + | | | + | | .. note:: | + | | | + | | After the DDS instance is created, the VPC cannot be changed. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subnet | A subnet provides dedicated network resources that are logically isolated from other networks for network security. | + | | | + | | After the instance is created, you can change the private IP address assigned by the subnet. For details, see :ref:`Changing a Private IP Address `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security Group | A security group controls access between DDS and other services for security. | + | | | + | | .. note:: | + | | | + | | Ensure that the security group rule you set allows clients to access DB instances. For example, select the TCP protocol with inbound direction, input the default port number **8635**, and enter a subnet IP address or select a security group that the DB instance belongs to. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SSL | Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission. | + | | | + | | You can enable SSL to improve data security. After a DB instance is created, you can connect to it using SSL. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Database configuration - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=============================================================================================================================================================================================================================================================================================================+ - | Administrator | The default account is **rwuser**. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Administrator Password | The password is a string of 8 to 32 characters. It must be a combination of uppercase letters, lowercase letters, digits, and special characters. You can also use the following special characters: ``~!@#%^*-_=+?`` | - | | | - | | The system cannot save you password. Keep the password secure. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Confirm Password | The value of this parameter must be the same as the **Administrator Password**. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Replica Set Parameter Group | The parameters in the replica set parameter group are applied to replica set instances. After a DB instance is created, you can change the parameter group of the instance. For a parameter group created by users, you can modify the parameters in the parameter group to bring out the best performance. | - | | | - | | For details, see :ref:`Parameter Group `. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=================================================================================================================================================================================================================+ + | Administrator | The default account is **rwuser**. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Administrator Password | Set a password for the administrator. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ``~!@#%^*-_=+?`` | + | | | + | | Keep this password secure. If lost, the system cannot retrieve it for you. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Confirm Password | Enter the administrator password again. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Single Node Parameter Template | The parameters that apply to single node instances. After a DB instance is created, you can change the parameter template you configured for the DB instance to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 5** Tag - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+===========================================================================================================================================================================================================+ - | Tags | Tags a DDS DB instance. This configuration is optional. Adding tags to DDS DB instances helps you better identify and manage them. Each DB instance can have up to 20 tags. | - | | | - | | A tag is composed of a key-value pair. | - | | | - | | - Key: Mandatory if the DB instance is going to be tagged | - | | | - | | - For each DB instance, each tag key is unique. | - | | - A tag key consists of a maximum of 36 characters. | - | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | - | | | - | | - Value: Optional if the DB instance is going to be tagged | - | | | - | | - The value consists of a maximum of 43 characters. | - | | - The value can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | - | | | - | | After a DB instance is created, you can view its tag details on the **Tags** tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see :ref:`Tag `. | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+======================================================================================================================================================================================================================+ + | Tags | This setting is optional. Adding tags helps you better identify and manage your DB instances. Up to 20 tags can be added for a DB instance. | + | | | + | | A tag is composed of a key-value pair. | + | | | + | | - Key: Mandatory if the DB instance is going to be tagged | + | | | + | | - Each tag key must be unique for each DB instance. | + | | - A tag key consists of up to 36 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | - Value: Optional if the DB instance is going to be tagged | + | | | + | | - The value consists of up to 43 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | After a DB instance is created, you can view its tag details on the **Tags** tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see :ref:`Tag Management `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: - The performance of your DB instance is determined by how you configure it during the creation. The hardware configuration items that can be selected include the class and storage space of the replica set. + DB instance performance is determined by how you configure it during the creation. The hardware configuration items that can be selected include the node class and storage space. #. On the displayed page, confirm the DB instance information. - - If you need to modify the specifications, click **Previous** to modify parameters. + - If you need to modify the specifications, click **Previous** to return to the previous page. - If you do not need to modify the specifications, click **Submit** to start the instance creation. #. After a DDS DB instance is created, you can view and manage it on the **Instance Management** page. - When a DB instance is being created, the status displayed in the **Status** column is **Creating**. This process takes about 15 minutes. After the creation is complete, the status changes to **Available**. - DDS enables the automated backup policy by default. After a DB instance is created, you can modify or disable the automated backup policy. An automated full backup is immediately triggered after the creation of a DB instance. - - You can change the database port after the DB instance is created. DDS uses port 8635 by default, which is different from the default port numbers used by databases. To ensure database accessibility, you need to add the required security group rule. + - The default DDS port is 8635, but this port can be modified if necessary. If you change the port, you need to add the security group rule to enable access. -.. |image1| image:: /_static/images/en-us_image_0284275172.png +.. |image1| image:: /_static/images/en-us_image_0000001096293854.png diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/index.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/index.rst new file mode 100644 index 0000000..4d955ff --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/index.rst @@ -0,0 +1,20 @@ +:original_name: dds_02_0074.html + +.. _dds_02_0074: + +Connecting to a Single-Node Instance Over Private Networks +========================================================== + +- :ref:`Overview ` +- :ref:`Creating a Single Node Instance ` +- :ref:`Setting a Security Group ` +- :ref:`Connecting to a Single Node Instance Over Private Networks ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + overview + creating_a_single_node_instance + setting_a_security_group + connecting_to_a_single_node_instance_over_private_networks diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/overview.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/overview.rst new file mode 100644 index 0000000..a7585f4 --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/overview.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0075.html + +.. _dds_02_0075: + +Overview +======== + +**Scenarios** +------------- + +This section describes how to create a single node instance on the management console, set a security group, and connect to a single node instance over private networks. + +Process +------- + +The following describes the steps from creating a DB instance to using it. + + +.. figure:: /_static/images/en-us_image_0000001095974104.png + :alt: **Figure 1** Accessing DB instances from a private network + + **Figure 1** Accessing DB instances from a private network diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/setting_a_security_group.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/setting_a_security_group.rst new file mode 100644 index 0000000..589033d --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single-node_instance_over_private_networks/setting_a_security_group.rst @@ -0,0 +1,25 @@ +:original_name: dds_02_0024.html + +.. _dds_02_0024: + +Setting a Security Group +======================== + +Scenarios +--------- + +This section guides you on how to add a security group rule to control access from and to DDS DB instances in a security group. + +Precautions +----------- + +The default security group rule allows all outgoing data packets. ECSs and DDS DB instances in the same security group can access each other. After a security group is created, you can create different rules for that security group, which allows you to control access to the DB instances that are in it. + +To access a DB instance in a security group from a source outside of that group, you need to create an inbound rule. + +For details about the constraints on using security groups, see "Security Group Overview" in the *Virtual Private Cloud User Guide*. + +Procedure +--------- + +For details about setting a security group, see "Adding a Security Group Rule" in the *Virtual Private Cloud User Guide*. diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/binding_an_eip.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/binding_an_eip.rst new file mode 100644 index 0000000..9c05f39 --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/binding_an_eip.rst @@ -0,0 +1,54 @@ +:original_name: dds_02_0026.html + +.. _dds_02_0026: + +Binding an EIP +============== + +Scenarios +--------- + +After you create a DB instance, you can bind it to an EIP to allow external access. If later you want to prohibit external access, you can also unbind the EIP from the DB instance. + +Precautions +----------- + +- Before accessing a database, you need to apply for an EIP on the VPC console. Then, add an inbound rule to allow the IP addresses or IP address ranges of ECSs. For details, see section :ref:`Setting a Security Group `. +- To change the EIP that has been bound to a node, you need to unbind it from the node first. + +.. _dds_02_0026__section3199593620428: + + +Binding an EIP +-------------- + +#. On the **Instance Management** page, click the target single node instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, locate the target node and click **Bind EIP** in the **Operation** column. + + Or in the **Node Information** area on the **Basic Information** page, locate the target node and choose **More** > **Bind EIP** in the **Operation** column. + +#. In the displayed dialog box, all available unbound EIPs are listed. Select the required EIP and click **OK**. If no available EIPs are displayed, click **View EIP** and create an EIP on the VPC console. + +#. Locate the target node, in the **EIP** column, view the EIP that is successfully bound. + + To unbind an EIP from the DB instance, see :ref:`Unbinding an EIP `. + +.. _dds_02_0026__section35191234134216: + +Unbinding an EIP +---------------- + +#. On the **Instance Management** page, click the target single node instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, locate the target node and click **Unbind EIP** in the **Operation** column. + + Or in the **Node Information** area on the **Basic Information** page, locate the target node and choose **More** > **Bind EIP** in the **Operation** column. + +#. In the displayed dialog box, click **Yes**. + + To bind an EIP to the DB instance again, see :ref:`Binding an EIP `. diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/connecting_to_a_single_node_instance_over_public_networks.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/connecting_to_a_single_node_instance_over_public_networks.rst new file mode 100644 index 0000000..a206f43 --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/connecting_to_a_single_node_instance_over_public_networks.rst @@ -0,0 +1,280 @@ +:original_name: dds_02_0048.html + +.. _dds_02_0048: + +Connecting to a Single Node Instance Over Public Networks +========================================================= + +**Scenarios** +------------- + +This section describes how to connect to a single-node instance using the MongoDB client and Robo 3T over public networks. + +The MongoDB client and Robo 3T can connect to a DB instance with an unencrypted connection or an encrypted connection (SSL). To improve data transmission security, you are advised to connect to DB instances using the SSL connection. + +**Different OS scenarios**: Examples include Linux and Windows clients. + +**Prerequisites** +----------------- + +#. :ref:`Bind an EIP ` to the Single node instance and :ref:`set security group rules ` to ensure that the EIP can be accessed with the DB client application. + +#. Install the MongoDB client or Robo 3T. + + **MongoDB client** + + a. For details on how to create and log in to an ECS, see "Creating and Logging In to a Windows ECS" or "Creating and Logging In to a Linux ECS" in the *Elastic Cloud Server User Guide*. + + b. Install the MongoDB client on the ECS. + + For details on how to install a MongoDB client, see :ref:`How Can I Install a MongoDB Client? ` + + **Robo 3T** + + For details on how to install Robo 3T, see :ref:`How Do I Install Robo 3T? ` + +#. If SSL is enabled, download the SSL certificate on the DDS console. + + a. On the **Instance Management** page, click the target DB instance. + b. In the navigation pane on the left, choose **Connections**. + c. In the **Basic Information** area, click |image1| next to the **SSL** field. + + .. note:: + + The certificate can also be downloaded from the Node Information area on the Basic Information page. + +Connecting to a DB Instance Using Robo 3T (SSL) +----------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. Run the installed Robo 3T. On the displayed dialog box, click **Create**. + + + .. figure:: /_static/images/en-us_image_0000001096133894.png + :alt: **Figure 1** Connections + + **Figure 1** Connections + +#. In the **Connection Settings** dialog box, set the parameters of the new connection. + + a. On the **Connection** tab, enter the name of the new connection in the **Name** text box and enter the EIP and database port that are bound to the single-node instance in the **Address** text box. + + + .. figure:: /_static/images/en-us_image_0000001142893889.png + :alt: **Figure 2** Connection + + **Figure 2** Connection + + b. On the **Authentication** tab, set **Database** to **admin**, **User Name** to **rwuser**, and **Password** to the administrator password you set during the creation of the single-node instance. + + + .. figure:: /_static/images/en-us_image_0000001096133896.png + :alt: **Figure 3** Authentication + + **Figure 3** Authentication + + c. On the **SSL** tab, upload the SSL certificate and select **Allowed** for **Invalid Hostnames**. + + + .. figure:: /_static/images/en-us_image_0000001143133835.png + :alt: **Figure 4** SSL + + **Figure 4** SSL + + d. Click **Save**. + +#. On the **MongoDB Connections** page, click **Connect** to connect to the single-node instance. + + + .. figure:: /_static/images/en-us_image_0000001143053839.png + :alt: **Figure 5** Connections + + **Figure 5** Connections + +#. If the single-node instance is successfully connected, the page shown in :ref:`Figure 6 ` is displayed. + + .. _dds_02_0048__fig167418454527: + + .. figure:: /_static/images/en-us_image_0000001142773935.png + :alt: **Figure 6** Connection succeeded + + **Figure 6** Connection succeeded + +Connecting to a DB Instance Using Robo 3T (Non-SSL) +--------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Run the installed Robo 3T. On the displayed dialog box, click **Create**. + + + .. figure:: /_static/images/en-us_image_0000001096293880.png + :alt: **Figure 7** Connections + + **Figure 7** Connections + +#. In the **Connection Settings** dialog box, set the parameters of the new connection. + + a. On the **Connection** tab, enter the name of the new connection in the **Name** text box and enter the EIP and database port that are bound to the single-node instance in the **Address** text box. + + + .. figure:: /_static/images/en-us_image_0000001143133839.png + :alt: **Figure 8** Connection + + **Figure 8** Connection + + b. On the **Authentication** tab, set **Database** to **admin**, **User Name** to **rwuser**, and **Password** to the administrator password you set during the creation of the single-node instance. + + + .. figure:: /_static/images/en-us_image_0000001143133833.png + :alt: **Figure 9** Authentication + + **Figure 9** Authentication + + c. Click **Save**. + +#. On the **MongoDB Connections** page, click **Connect** to connect to the single-node instance. + + + .. figure:: /_static/images/en-us_image_0000001096453876.png + :alt: **Figure 10** Connections + + **Figure 10** Connections + +#. If the single-node instance is successfully connected, the page shown in :ref:`Figure 11 ` is displayed. + + .. _dds_02_0048__fig17236526175520: + + .. figure:: /_static/images/en-us_image_0000001096453878.png + :alt: **Figure 11** Connection succeeded + + **Figure 11** Connection succeeded + +Connecting to a DB Instance Using the MongoDB Client (SSL) +---------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, enable the SSL connection. For details, see section :ref:`Enabling SSL `. + +#. On the **Instance Management** page, click the target DB instance. + +#. In the navigation pane on the left, choose **Connections**. + +#. In the **Basic Information** area, click |image2| next to the **SSL** field. + +#. Upload the root certificate to the ECS to be connected to the DB instance. + + The following describes how to upload the certificate to a Linux and Window ECS: + + - In Linux, run the following command: + + **scp** ** **\ **@**\ **\ **:**\ ** + + .. note:: + + - **IDENTITY_FILE** indicates the directory where the root certificate resides. The file access permission is 600. + - **REMOTE_USER** indicates the ECS OS user. + - **REMOTE_ADDRESS** indicates the ECS address. + - **REMOTE_DIR** indicates the directory of the ECS to which the root certificate is uploaded. + + - In Windows, upload the root certificate using the remote connection tool. + +#. Connect to the DB instance in the directory where the MongoDB client is located. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format + + **mongo** **mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **/test?authSource=admin** **--ssl --sslCAFile** <*FILE_PATH*> **--sslAllowInvalidHostnames** + + To obtain the public connection address, click the instance name and choose **Connections**. The address is displayed in **Public Network Connection Address** field on the **Public Connection** tab. + + .. note:: + + - A single node instance uses the management IP address to generate SSL certificate. **--sslAllowInvalidHostnames** is needed for the SSL connection through a public network. + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **EIP** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the Node Information area on the Basic Information page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + - **FILE_PATH** indicates the path where the root certificate is stored. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin --ssl --sslCAFile /tmp/ca.crt** **--sslAllowInvalidHostnames** + + - Connect to the DB instance using standard URI format. The following is an example command: + + **mongo** **mongodb://rwuser:@192.168.1.80:8635/test?authSource=admin** **--ssl --sslCAFile** **/tmp/ca.crt** **--sslAllowInvalidHostnames** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + .. code-block:: + + replica:PRIMARY> + +Connecting to a DB Instance Using the MongoDB Client (Non-SSL) +-------------------------------------------------------------- + +.. important:: + + If you connect to a DB instance using this method, disable the SSL connection. For details, see section :ref:`Disabling SSL `. + +#. Connect to a DDS DB instance. + + - Method 1: Using standard parameters + + **mongo --host** <*DB_HOST*> **--port** <*DB_PORT*> **-u** <*DB_USER*> **-p** **--authenticationDatabase** **admin** + + Enter the database account password when prompted: + + .. code-block:: + + Enter password: + + - Method 2: Using standard URI format + + **mongo** **mongodb://rwuser:**\ \ **@**\ **\ **:**\ **\ **/test?authSource=admin** + + To obtain the public connection address, click the instance name and choose **Connections**. The address is displayed in **Public Network Connection Address** field on the **Public Connection** tab. + + .. note:: + + - **DB_HOST** indicates the IP address of the remotely connected DB instance. Obtain the value from the **EIP** column in the node list on the **Connections** page. + - **DB_PORT** indicates the port number. Obtain the value from **Database Port** in the **Basic Information** area on the **Connections** page. + - **DB_HOST** and **DB_PORT** can also be obtained from the **Node Information** area on the **Basic Information** page. + - **DB_USER** indicates the database account name. The default value is **rwuser**. + - **** indicates the password of the database account. If the password contains at signs (@),exclamation marks (!), or percent signs (%), replace them with hexadecimal URL codes %40, %21, and %25 respectively. + - If user inputs this command then the password will be stored in logfiles and can be found in linux history, and in process list. So please note that plaintext passwords are risky. + + - Connect to the instance using standard parameters. The following is an example command: + + **mongo --host 192.168.1.6 --port 8635 -u rwuser -p --authenticationDatabase admin** + + - Connect to the DB instance using standard URI format. The following is an example command: + + **mongo** **mongodb://rwuser:@192.168.1.80:8635/test?authSource=admin** + +#. Check the connection result. If the following information is displayed, the connection is successful. + + .. code-block:: + + replica:PRIMARY> + +.. |image1| image:: /_static/images/en-us_image_0000001096133902.png +.. |image2| image:: /_static/images/en-us_image_0000001143133837.png diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/creating_a_single_node_instance.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/creating_a_single_node_instance.rst new file mode 100644 index 0000000..20bde1f --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/creating_a_single_node_instance.rst @@ -0,0 +1,161 @@ +:original_name: dds_02_0079.html + +.. _dds_02_0079: + +Creating a Single Node Instance +=============================== + +Scenarios +--------- + +This section describes how to create a single node instance on the DDS management console. DDS allows you to tailor your computing resources and storage space to your business needs. + +You can use your account to create a maximum of 20 single nodes in total. To create more single node instances, click |image1| in the upper right corner of the management console. On the **Service Quota** page, click **Increase Quota** to apply for quotas. + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click **Create DB Instance**. +#. On the displayed page, select your DB instance specifications and click **Create Now**. + + .. table:: **Table 1** Basic information + + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+===================================================================================================================================================================================================================================================+ + | Region | A region where the tenant is located. It can be changed in the upper left corner. For details, see section :ref:`Regions and AZs `. | + | | | + | | .. note:: | + | | | + | | DB instances deployed in different regions cannot communicate with each other through a private network, and you cannot change the region of a DB instance once it is created. Therefore, you should exercise caution when selecting a region. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Name | The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). | + | | | + | | After the DB instance is created, you can change the DB instance name. For details, see section :ref:`Changing a DB Instance Name `. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Database Type | Community Edition | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DB Instance Type | Select **Single Node**. | + | | | + | | The single node architecture is another option for you, helping you reduce costs while ensuring data reliability. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Compatible MongoDB Version | - 4.2 | + | | - 4.0 | + | | - 3.4 | + | | - 3.2 | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Type | Ultra-high I/O | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage Engine | WiredTiger | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | AZ | An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection. For details, see section :ref:`Regions and AZs `. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Disk Encryption | - **Disabled**: Disable the encryption function. | + | | | + | | - **Enabled**: Enable the encryption function. This feature improves data security but slightly affects read/write performance. | + | | | + | | **Key Name**: Select or create a private key, which is the tenant key. | + | | | + | | .. note:: | + | | | + | | - After a DB instance is created, the disk encryption status and the key cannot be changed. The backup data stored in OBS is not encrypted. | + | | - The key cannot be disabled or deleted when being used. Otherwise, the database becomes unavailable. | + | | - For details about how to create a key, see the "Creating a CMK" section in the *Key Management Service User Guide*. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 2** Specifications + + +---------------+----------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===============+================================================================================================================+ + | Node Class | For details about the DB instance specifications, see section :ref:`DB Instance Specifications `. | + +---------------+----------------------------------------------------------------------------------------------------------------+ + | Storage Space | The value ranges from 10 GB to 1,000 GB and must be a multiple of 10. | + +---------------+----------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 3** Network + + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | VPC | The VPC where your DB instances are located. A VPC isolates networks for different services, so you can easily manage and configure internal networks and change network configuration. You need to create or select the required VPC. For details about how to create a VPC, see section "Creating a VPC" in the *Virtual Private Cloud User Guide*. For details about the constraints on the use of VPCs, see :ref:`Connection Methods `. | + | | | + | | If there are no VPCs available, DDS allocates resources to you by default. | + | | | + | | .. note:: | + | | | + | | After the DDS instance is created, the VPC cannot be changed. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subnet | A subnet provides dedicated network resources that are logically isolated from other networks for network security. | + | | | + | | After the instance is created, you can change the private IP address assigned by the subnet. For details, see :ref:`Changing a Private IP Address `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security Group | A security group controls access between DDS and other services for security. | + | | | + | | .. note:: | + | | | + | | Ensure that the security group rule you set allows clients to access DB instances. For example, select the TCP protocol with inbound direction, input the default port number **8635**, and enter a subnet IP address or select a security group that the DB instance belongs to. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SSL | Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission. | + | | | + | | You can enable SSL to improve data security. After a DB instance is created, you can connect to it using SSL. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 4** Database configuration + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=================================================================================================================================================================================================================+ + | Administrator | The default account is **rwuser**. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Administrator Password | Set a password for the administrator. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ``~!@#%^*-_=+?`` | + | | | + | | Keep this password secure. If lost, the system cannot retrieve it for you. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Confirm Password | Enter the administrator password again. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Single Node Parameter Template | The parameters that apply to single node instances. After a DB instance is created, you can change the parameter template you configured for the DB instance to bring out the best performance. | + | | | + | | For details, see :ref:`Modifying a Parameter Template `. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. table:: **Table 5** Tag + + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+======================================================================================================================================================================================================================+ + | Tags | This setting is optional. Adding tags helps you better identify and manage your DB instances. Up to 20 tags can be added for a DB instance. | + | | | + | | A tag is composed of a key-value pair. | + | | | + | | - Key: Mandatory if the DB instance is going to be tagged | + | | | + | | - Each tag key must be unique for each DB instance. | + | | - A tag key consists of up to 36 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | - Value: Optional if the DB instance is going to be tagged | + | | | + | | - The value consists of up to 43 characters. | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | + | | | + | | After a DB instance is created, you can view its tag details on the **Tags** tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see :ref:`Tag Management `. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. note:: + + DB instance performance is determined by how you configure it during the creation. The hardware configuration items that can be selected include the node class and storage space. + +#. On the displayed page, confirm the DB instance information. + + - If you need to modify the specifications, click **Previous** to return to the previous page. + - If you do not need to modify the specifications, click **Submit** to start the instance creation. + +#. After a DDS DB instance is created, you can view and manage it on the **Instance Management** page. + + - When a DB instance is being created, the status displayed in the **Status** column is **Creating**. This process takes about 15 minutes. After the creation is complete, the status changes to **Available**. + - DDS enables the automated backup policy by default. After a DB instance is created, you can modify or disable the automated backup policy. An automated full backup is immediately triggered after the creation of a DB instance. + - The default DDS port is 8635, but this port can be modified if necessary. If you change the port, you need to add the security group rule to enable access. + +.. |image1| image:: /_static/images/en-us_image_0000001096293854.png diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/index.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/index.rst new file mode 100644 index 0000000..f866bd1 --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/index.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0077.html + +.. _dds_02_0077: + +Connecting to a Single Node Instance Over Public Networks +========================================================= + +- :ref:`Overview ` +- :ref:`Creating a Single Node Instance ` +- :ref:`Binding an EIP ` +- :ref:`Setting a Security Group ` +- :ref:`Connecting to a Single Node Instance Over Public Networks ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + overview + creating_a_single_node_instance + binding_an_eip + setting_a_security_group + connecting_to_a_single_node_instance_over_public_networks diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/overview.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/overview.rst new file mode 100644 index 0000000..7da458c --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/overview.rst @@ -0,0 +1,22 @@ +:original_name: dds_02_0078.html + +.. _dds_02_0078: + +Overview +======== + +**Scenarios** +------------- + +This section describes how to create a single node instance on the management console, set a security group, bind an EIP, and connect to a single node instance over public networks. + +Process +------- + +The following describes the steps from creating a DB instance to using it. + + +.. figure:: /_static/images/en-us_image_0000001142893899.png + :alt: **Figure 1** Accessing DB instances from a public network + + **Figure 1** Accessing DB instances from a public network diff --git a/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/setting_a_security_group.rst b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/setting_a_security_group.rst new file mode 100644 index 0000000..f9f3f05 --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connecting_to_a_single_node_instance_over_public_networks/setting_a_security_group.rst @@ -0,0 +1,25 @@ +:original_name: dds_02_0080.html + +.. _dds_02_0080: + +Setting a Security Group +======================== + +Scenarios +--------- + +This section guides you on how to add a security group rule to control access from and to DDS DB instances in a security group. + +Precautions +----------- + +The default security group rule allows all outgoing data packets. ECSs and DDS DB instances in the same security group can access each other. After a security group is created, you can create different rules for that security group, which allows you to control access to the DB instances that are in it. + +To access a DB instance in a security group from a source outside of that group, you need to create an inbound rule. + +For details about the constraints on using security groups, see "Security Group Overview" in the *Virtual Private Cloud User Guide*. + +Procedure +--------- + +For details about setting a security group, see "Adding a Security Group Rule" in the *Virtual Private Cloud User Guide*. diff --git a/umn/source/getting_started_with_single_nodes/connection_methods.rst b/umn/source/getting_started_with_single_nodes/connection_methods.rst new file mode 100644 index 0000000..029a1c3 --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/connection_methods.rst @@ -0,0 +1,27 @@ +:original_name: dds_02_0070.html + +.. _dds_02_0070: + +Connection Methods +================== + +You can access DDS over private or public networks. + +.. table:: **Table 1** Connection methods + + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Method | IP Address | Scenario | Description | + +=================+====================+=======================================================================================================================================================================================================+===============================================================================================================================================================================================================+ + | Private network | Private IP address | DDS provides a private IP address by default. | Secure and excellent performance | + | | | | | + | | | - You are advised to use private IP address in following scenarios: | | + | | | | | + | | | - Your ECS instance is in the same VPC subnet as the DDS DB instance | | + | | | - ECS subnet and DDS subnet are connected to each other by VPC peering. | | + | | | | | + | | | - By default, DDS is not accessible from ECSs that are not in the same security group. If the ECS is not in the same group, you need to add an inbound rule to enable access. | | + | | | - The default DDS port is 8635, but this port can be modified if necessary. | | + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Public network | EIP | - If your applications are running on an ECS that is in a different region from the one where the DB instance is located, you are advised to use an EIP to connect the ECS to your DDS DB instances. | - Low security | + | | | - If your applications are deployed on another cloud platform, EIP is recommended. | - For faster transmission and improved security, you are advised to migrate your applications to an ECS that is in the same subnet as your DDS instance and use a private IP address to access the instance. | + +-----------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/getting_started_with_single_nodes/index.rst b/umn/source/getting_started_with_single_nodes/index.rst new file mode 100644 index 0000000..2e4ab10 --- /dev/null +++ b/umn/source/getting_started_with_single_nodes/index.rst @@ -0,0 +1,18 @@ +:original_name: dds_02_single_node.html + +.. _dds_02_single_node: + +Getting Started with Single Nodes +================================= + +- :ref:`Connection Methods ` +- :ref:`Connecting to a Single-Node Instance Over Private Networks ` +- :ref:`Connecting to a Single Node Instance Over Public Networks ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + connection_methods + connecting_to_a_single-node_instance_over_private_networks/index + connecting_to_a_single_node_instance_over_public_networks/index diff --git a/umn/source/index.rst b/umn/source/index.rst index 9dbfd98..55f7fbe 100644 --- a/umn/source/index.rst +++ b/umn/source/index.rst @@ -9,8 +9,20 @@ Document Database Service - User Guide logging_in_to_the_dds_console getting_started_with_clusters/index getting_started_with_replica_sets/index - managing_dds_db_instances/index - monitoring/index + getting_started_with_single_nodes/index + permissions_management/index + connection_management/index + database_commands/index + migrating_data + account_management/index + instance_management/index + backup_and_restore/index + parameter_template_management/index + task_center + monitoring_and_alarm_reporting/index + auditing/index + log_management/index + tag_management faqs/index change_history glossary diff --git a/umn/source/managing_dds_db_instances/storage/adding_cluster_instance_nodes.rst b/umn/source/instance_management/adding_nodes_to_a_cluster.rst similarity index 56% rename from umn/source/managing_dds_db_instances/storage/adding_cluster_instance_nodes.rst rename to umn/source/instance_management/adding_nodes_to_a_cluster.rst index 97970b8..ac71542 100644 --- a/umn/source/managing_dds_db_instances/storage/adding_cluster_instance_nodes.rst +++ b/umn/source/instance_management/adding_nodes_to_a_cluster.rst @@ -2,18 +2,19 @@ .. _en-us_topic_increase_nodes: -Adding Cluster Instance Nodes -============================= +Adding Nodes to a Cluster +========================= **Scenarios** ------------- -This section guides you on how to add nodes to a DB instance. +This section describes how to add nodes to a cluster instance. .. note:: - You can add nodes when the instance status is **Available**, **Deleting backup**, or **Checking restoration**. - - A DB instance cannot be deleted when one or more nodes are being added. + - A DB instance cannot be deleted when nodes are being added. + - Mongos and shard nodes that are successfully added cannot be deleted. Add mongos ---------- @@ -24,16 +25,16 @@ Add mongos #. On the **mongos** tab in the **Node Information** area, click **Add mongos**. -#. On the displayed page, specify **Node Class**, **mongos Quantity**, and **Parameter Group**. Then, click **Submit**. +#. On the displayed page, specify **Node Class**, **Nodes**, and **Parameter Template** and click **Submit**. - A cluster instance of Community Edition supports a maximum of 16 mongos nodes. + A cluster instance of Community Edition supports up to 32 mongos nodes. #. View the result of adding nodes. - - This process takes about 10 to 15 minutes. The status of the DB instance in the instance list is **Adding node**. + - This process takes up to 15 minutes. The status of the DB instance in the instance list is **Adding node**. - In the upper right corner of the DB instance list, click |image1| to refresh the list. The instance status changes to **Available**. - On the **mongos** tab in the **Node Information** area, view the information about the node you added. - - If the mongos fail to be added, you can revert them in batches or delete them one by one. For details, see section :ref:`Reverting Cluster Instance Nodes `. + - If the mongos fail to be added, you can revert them in batches or delete them one by one. For details, see section :ref:`Reverting and Deleting Failed Cluster Instance Nodes `. Add shard --------- @@ -41,17 +42,17 @@ Add shard #. :ref:`Log in to the DDS console. ` #. On the **Instance Management** page, click the target cluster instance. #. On the **shard** tab in the **Node Information** area, click **Add shard**. -#. On the displayed page, specify **Node Class**, **Storage Space**, **shard Quantity**, and **Parameter Group**. Then, click **Submit**. +#. Specify **Node Class**, **Storage Space**, **Nodes**, and **Parameter Template** and click **Submit**. - - The storage space you applied for will contain the system overhead required for inode, reserved block, and database operation. The storage space must be an integer multiple of 10. - - A cluster instance of Community Edition supports a maximum of 16 shard nodes. + - The storage space you applied for will contain the system overhead. The storage space can be configured from 10 GB to 2000 GB and must be an integer multiple of 10. + - A cluster instance of Community Edition supports up to 32 shard nodes. #. View the result of adding nodes. - - This process takes about 10 to 15 minutes. The status of the DB instance in the instance list is **Adding node**. + - This process takes up to 15 minutes. The status of the DB instance in the instance list is **Adding node**. - In the upper right corner of the DB instance list, click |image2| to refresh the list. The instance status changes to **Available**. - On the **shard** tab in the **Node Information** area, view the information about the node you added. - - If the shards fail to be added, you can revert them in batches or delete them one by one. For details, see section :ref:`Reverting Cluster Instance Nodes `. + - If the shards fail to be added, you can revert them in batches or delete them one by one. For details, see section :ref:`Reverting and Deleting Failed Cluster Instance Nodes `. -.. |image1| image:: /_static/images/en-us_image_0284275075.png -.. |image2| image:: /_static/images/en-us_image_0284275075.png +.. |image1| image:: /_static/images/en-us_image_0000001142773957.png +.. |image2| image:: /_static/images/en-us_image_0000001142773957.png diff --git a/umn/source/instance_management/changing_a_db_instance_name.rst b/umn/source/instance_management/changing_a_db_instance_name.rst new file mode 100644 index 0000000..5863477 --- /dev/null +++ b/umn/source/instance_management/changing_a_db_instance_name.rst @@ -0,0 +1,39 @@ +:original_name: dds_03_0075.html + +.. _dds_03_0075: + +Changing a DB Instance Name +=========================== + +**Scenarios** +------------- + +This section describes how to change a DB instance name to identify different DB instances. + +Method 1 +-------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, hover the mouse over the DDS instance name you wish to change and click the icon |image1| that is displayed next to the DB instance. + + - If you want to submit the change, click **OK**. The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). + - If you want to cancel the change, click **Cancel**. + +#. View the change result on the **Instance Management** page. + +Method 2 +-------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click the target DB instance. +#. In the **DB Information** area on the **Basic Information** page, click |image2| in the **DB Instance Name** field to change the instance name. + + - To submit the change, click |image3|. The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). + - To cancel the change, click |image4|. + +#. View the results on the **Instance Management** page. + +.. |image1| image:: /_static/images/en-us_image_0000001193533703.png +.. |image2| image:: /_static/images/en-us_image_0000001143133827.png +.. |image3| image:: /_static/images/en-us_image_0000001142773925.png +.. |image4| image:: /_static/images/en-us_image_0000001096453866.png diff --git a/umn/source/managing_dds_db_instances/changing_db_instance_classes/changing_the_cpu_or_memory_of_a_cluster_db_instance.rst b/umn/source/instance_management/changing_the_db_instance_class/changing_a_cluster_db_instance_class.rst similarity index 56% rename from umn/source/managing_dds_db_instances/changing_db_instance_classes/changing_the_cpu_or_memory_of_a_cluster_db_instance.rst rename to umn/source/instance_management/changing_the_db_instance_class/changing_a_cluster_db_instance_class.rst index fe5b1db..048ef7c 100644 --- a/umn/source/managing_dds_db_instances/changing_db_instance_classes/changing_the_cpu_or_memory_of_a_cluster_db_instance.rst +++ b/umn/source/instance_management/changing_the_db_instance_class/changing_a_cluster_db_instance_class.rst @@ -2,19 +2,8 @@ .. _en-us_topic_0104472218: -Changing the CPU or Memory of a Cluster DB Instance -=================================================== - -Scenarios ---------- - -This section guides you on how to change the CPU or memory of a cluster instance. - -.. note:: - - - A DB instance cannot be deleted when you are changing its CPU or memory. - - Instances can be both scaled up and down. - - Services will be interrupted for 5 to 10 minutes when you change DB instance CPU and memory. You are advised to perform this operation during off-peak hours. +Changing a Cluster DB Instance Class +==================================== Changing mongos --------------- @@ -22,12 +11,12 @@ Changing mongos #. :ref:`Log in to the DDS console. ` #. On the **Instance Management** page, click the target cluster instance. #. In the **Node Information** area on the **Basic Information** page, click the **mongos** tab, locate the target mongos, and click **Change Instance Class** in the **Operation** column. -#. On the displayed page, modify required parameters and click **Submit**. -#. View the DB instance CPU or memory modification result. +#. On the displayed page, select the new instance class and click **Submit**. +#. View the DB instance class change result. - - When the CPU or memory of a DB instance is being changed, the status displayed in the **Status** column is **Changing instance class**. This process takes about 10 minutes. + - When the CPU or memory of a DB instance is being changed, the status displayed in the **Status** column is **Changing instance class**. This process takes up to 10 minutes. - In the upper right corner of the DB instance list, click |image1| to refresh the list. The instance status changes to **Available**. - - In the **Node Information** area on the **Basic Information** page, click the **mongos** tab and check whether the scaling up is successful. + - In the **Node Information** area on the **Basic Information** page, click the **mongos** tab and view the new instance class. Changing shard -------------- @@ -35,12 +24,12 @@ Changing shard #. :ref:`Log in to the DDS console. ` #. On the **Instance Management** page, click the target cluster instance. #. In the **Node Information** area on the **Basic Information** page, click the **shard** tab, locate the target shard, and click **Change Instance Class** in the **Operation** column. -#. On the displayed page, modify required parameters and click **Submit**. -#. View the DB instance CPU or memory modification result. +#. On the displayed page, select the new instance class and click **Submit**. +#. View the DB instance class change result. - - When the CPU or memory of a DB instance is being changed, the status displayed in the **Status** column is **Changing instance class**. This process takes about 25 to 30 minutes. + - When the CPU or memory of a DB instance is being changed, the status displayed in the **Status** column is **Changing instance class**. This process takes up to 30 minutes. - In the upper right corner of the DB instance list, click |image2| to refresh the list. The instance status changes to **Available**. - - Go to the **Basic Information** page of the cluster instance you scaled up, click the **shard** tab in the **Node Information** area, and check whether the scaling up is successful. + - Go to the **Basic Information** page of the cluster instance you scaled up, click the **shard** tab in the **Node Information** area, and view the new instance class. -.. |image1| image:: /_static/images/en-us_image_0284275046.png -.. |image2| image:: /_static/images/en-us_image_0284275046.png +.. |image1| image:: /_static/images/en-us_image_0000001095974074.png +.. |image2| image:: /_static/images/en-us_image_0000001095974074.png diff --git a/umn/source/instance_management/changing_the_db_instance_class/changing_a_replica_set_db_instance_class.rst b/umn/source/instance_management/changing_the_db_instance_class/changing_a_replica_set_db_instance_class.rst new file mode 100644 index 0000000..432bb27 --- /dev/null +++ b/umn/source/instance_management/changing_the_db_instance_class/changing_a_replica_set_db_instance_class.rst @@ -0,0 +1,25 @@ +:original_name: en-us_topic_0104721795.html + +.. _en-us_topic_0104721795: + +Changing a Replica Set DB Instance Class +======================================== + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, locate the replica set instance and choose **More** > **Change Instance Class** in the **Operation** column. + + Alternatively, on the **Instance Management** page, click the name of the replica set instance. In the **DB Information** area on the **Basic Information** page, click **Change** to the right of the **Node Class** field. + +#. On the displayed page, modify required parameters and click **Submit**. + +#. View the DB instance class change result. + + - When the CPU or memory of a DB instance is being changed, the status displayed in the **Status** column is **Changing instance class**. This process takes up to 30 minutes. + - In the upper right corner of the DB instance list, click |image1| to refresh the list. The instance status changes to **Available**. + - Go to the **Basic Information** page of the replica set instance you scaled up and check whether the scaling up is successful in the **DB Information** area. + +.. |image1| image:: /_static/images/en-us_image_0000001095974074.png diff --git a/umn/source/instance_management/changing_the_db_instance_class/changing_a_single_node_db_instance_class.rst b/umn/source/instance_management/changing_the_db_instance_class/changing_a_single_node_db_instance_class.rst new file mode 100644 index 0000000..233c03a --- /dev/null +++ b/umn/source/instance_management/changing_the_db_instance_class/changing_a_single_node_db_instance_class.rst @@ -0,0 +1,25 @@ +:original_name: dds_03_0030.html + +.. _dds_03_0030: + +Changing a Single Node DB Instance Class +======================================== + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, locate the target single node instance and click **Change Instance Class** in the **Operation** column. + + Alternatively, on the **Instance Management** page, click the name of the single node instance. In the **DB Information** area on the **Basic Information** page, click **Change** to the right of the **Node Class** field. + +#. On the displayed page, modify required parameters and click **Submit**. + +#. View the DB instance class change result. + + - When the CPU or memory of a DB instance is being changed, the status displayed in the **Status** column is **Changing instance class**. This process takes up to 10 minutes. + - In the upper right corner of the DB instance list, click |image1| to refresh the list. The instance status changes to **Available**. + - Go to the **Basic Information** page of the single node you scaled up and check whether the scaling process is successful in the **Configuration** area. + +.. |image1| image:: /_static/images/en-us_image_0000001095974074.png diff --git a/umn/source/instance_management/changing_the_db_instance_class/index.rst b/umn/source/instance_management/changing_the_db_instance_class/index.rst new file mode 100644 index 0000000..8e34bc7 --- /dev/null +++ b/umn/source/instance_management/changing_the_db_instance_class/index.rst @@ -0,0 +1,30 @@ +:original_name: en-us_topic_0000001159335385.html + +.. _en-us_topic_0000001159335385: + +Changing the DB Instance Class +============================== + +Scenarios +--------- + +This section describes how to change the DB instance class. + +.. note:: + + - A DB instance cannot be deleted when you are changing its instance class. + - Instances can be scaled up or down. + - For cluster and replica set instances, when the DB instance class is changed, a primary/secondary switchover may occur and the database connection will be interrupted for up to 30s. You are advised to change the specifications during off-peak hours to reduce impacts and ensure that your client can reconnect to the database if the connection is interrupted. + - For a single node instance, services will be interrupted up to 10 minutes when you change DB instance class. You are advised to perform this operation during off-peak hours. After the restart is complete, the cached memory will be automatically cleared. The DB instance needs to be warmed up to prevent congestion during peak hours. + +- :ref:`Changing a Cluster DB Instance Class ` +- :ref:`Changing a Replica Set DB Instance Class ` +- :ref:`Changing a Single Node DB Instance Class ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + changing_a_cluster_db_instance_class + changing_a_replica_set_db_instance_class + changing_a_single_node_db_instance_class diff --git a/umn/source/managing_dds_db_instances/db_instance_operations/deleting_a_db_instance.rst b/umn/source/instance_management/deleting_a_db_instance.rst similarity index 82% rename from umn/source/managing_dds_db_instances/db_instance_operations/deleting_a_db_instance.rst rename to umn/source/instance_management/deleting_a_db_instance.rst index 72959bd..48093e0 100644 --- a/umn/source/managing_dds_db_instances/db_instance_operations/deleting_a_db_instance.rst +++ b/umn/source/instance_management/deleting_a_db_instance.rst @@ -2,7 +2,7 @@ .. _dds_03_0004: -Deleting a DB instance +Deleting a DB Instance ====================== **Scenarios** @@ -12,11 +12,16 @@ This section guides you on how to delete a DB instance no longer used to release - Cluster instance - Replica set instance +- Single node instance .. important:: + - DB instances cannot be deleted when operations are being performed on them. They can be deleted only after the operations are completed. + - After you delete an instance, all nodes in the instance are also deleted. + - After you delete the DB instance, all data in it and all automated backups are automatically deleted and cannot be restored. Exercise caution when performing this operation. + - By default, all manual backups are retained in DDS. You can use a backup to restore a deleted instance. **Procedure** diff --git a/umn/source/instance_management/exporting_db_instance_information.rst b/umn/source/instance_management/exporting_db_instance_information.rst new file mode 100644 index 0000000..4f71970 --- /dev/null +++ b/umn/source/instance_management/exporting_db_instance_information.rst @@ -0,0 +1,57 @@ +:original_name: dds_03_0051.html + +.. _dds_03_0051: + +Exporting DB Instance Information +================================= + +**Scenarios** +------------- + +This section describes how to export DB instance information for analysis. The following information can be exported: + +- Database Type +- DB Instance Name +- DB Instance ID +- DB Instance Type +- DB Engine Version +- Billing Mode +- Node ID +- Status +- Node Name +- Node Status +- Created +- Database Port +- VPC +- AZ +- Security Group +- Subnet +- VP CID +- Connection +- Node Class +- Role +- Storage Type +- Private IP Address +- EIP +- Parameter_Group +- Storage Space Usage + + +Exporting DB Instance Information +--------------------------------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click |image1| in the upper right corner of the instance list. +#. In the pop-up box, select the desired items and click **OK**. +#. View the .xls file exported to your local PC. + +Export Specified Instance +------------------------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, select the target DB instance and click |image2| in the upper right corner of the instance list. +#. In the pop-up box, select the desired items and click **OK**. +#. View the .xls file exported to your local PC. + +.. |image1| image:: /_static/images/en-us_image_0000001143053849.png +.. |image2| image:: /_static/images/en-us_image_0000001096133908.png diff --git a/umn/source/instance_management/index.rst b/umn/source/instance_management/index.rst new file mode 100644 index 0000000..adeb00b --- /dev/null +++ b/umn/source/instance_management/index.rst @@ -0,0 +1,32 @@ +:original_name: dds_03_0002.html + +.. _dds_03_0002: + +Instance Management +=================== + +- :ref:`Changing a DB Instance Name ` +- :ref:`Adding Nodes to a Cluster ` +- :ref:`Reverting and Deleting Failed Cluster Instance Nodes ` +- :ref:`Scaling Up Storage Space ` +- :ref:`Changing the DB Instance Class ` +- :ref:`Manually Switching the Primary and Secondary Nodes of a Replica Set ` +- :ref:`Exporting DB Instance Information ` +- :ref:`Restarting a DB Instance or a Node ` +- :ref:`Deleting a DB Instance ` +- :ref:`Recycling a DB Instance ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + changing_a_db_instance_name + adding_nodes_to_a_cluster + reverting_and_deleting_failed_cluster_instance_nodes + scaling_up_storage_space + changing_the_db_instance_class/index + manually_switching_the_primary_and_secondary_nodes_of_a_replica_set + exporting_db_instance_information + restarting_a_db_instance_or_a_node + deleting_a_db_instance + recycling_a_db_instance diff --git a/umn/source/managing_dds_db_instances/db_instance_operations/manually_switching_the_primary_and_secondary_nodes_of_a_replica_set.rst b/umn/source/instance_management/manually_switching_the_primary_and_secondary_nodes_of_a_replica_set.rst similarity index 77% rename from umn/source/managing_dds_db_instances/db_instance_operations/manually_switching_the_primary_and_secondary_nodes_of_a_replica_set.rst rename to umn/source/instance_management/manually_switching_the_primary_and_secondary_nodes_of_a_replica_set.rst index 0909854..9dc2f14 100644 --- a/umn/source/managing_dds_db_instances/db_instance_operations/manually_switching_the_primary_and_secondary_nodes_of_a_replica_set.rst +++ b/umn/source/instance_management/manually_switching_the_primary_and_secondary_nodes_of_a_replica_set.rst @@ -12,9 +12,9 @@ A replica set consists of the primary node, secondary node, and hidden node. Pri .. note:: - - You can perform a switchover when the DB instance status is **Available**, and **Changing a security group**. - - Services may be interrupted during the switchover. Ensure that your client supports reconnection. - - The longer the delay for primary/secondary synchronization, the more time is needed for a primary/secondary switchover. Therefore, if the primary to secondary synchronization delay exceeds 300s, the primary/secondary switchover is not allowed. For details about the delay for the primary/secondary synchronization, see :ref:`What Is the Time Delay for Primary/Secondary Synchronization in a Replica Set? ` + - You can perform a switchover when the DB instance status is **Available**, or **Changing a security group**. + - The database connection may be interrupted during the switchover. Ensure that your client supports reconnection. + - The longer the delay for primary/secondary synchronization, the more time is needed for a primary/secondary switchover. Therefore, if the primary to secondary synchronization delay exceeds 300s, the primary/secondary switchover is not allowed. For details about the synchronization delay, see :ref:`What Is the Time Delay for Primary/Secondary Synchronization in a Replica Set? ` Procedure --------- @@ -27,4 +27,4 @@ Procedure - During the switchover process, the DB instance status changes to **Switchover in progress**. After the switchover is complete, the status is restored to **Available**. - In the **Node Information** area, you can view the switchover result. - - After the switchover, the previous primary node becomes the secondary node. You need to reconnect to the primary node. For details, see :ref:`Connecting to a DB Instance Through a Client `. + - After the switchover, the previous primary node becomes the secondary node. You need to reconnect to the primary node. For details, see :ref:`Connecting to a Replica Set Instance Over Private Networks ` and :ref:`Connecting to a Replica Set Instance Over Public Networks `. diff --git a/umn/source/instance_management/recycling_a_db_instance.rst b/umn/source/instance_management/recycling_a_db_instance.rst new file mode 100644 index 0000000..d657eb6 --- /dev/null +++ b/umn/source/instance_management/recycling_a_db_instance.rst @@ -0,0 +1,50 @@ +:original_name: dds_03_0101.html + +.. _dds_03_0101: + +Recycling a DB Instance +======================= + +DDS can move deleted DB instances to the recycle bin, so you can restore them easily. + +Precautions +----------- + +- The recycling policy is enabled by default and cannot be disabled. Instances in the recycle bin are retained for 7 days by default, and this will not generate any charges. + +- Up to 100 instances can be moved to the recycle bin. Once the recycle bin is full, you can still delete instances, but they cannot be placed in the recycle bin, so the deletions will be permanent. + +Modifying the Recycling Policy +------------------------------ + +.. important:: + + You can modify the retention period, and the changes only apply to the DB instances deleted after the changes, so exercise caution when performing this operation. + +#. :ref:`Log in to the DDS console `. +#. In the navigation pane on the left, choose **Recycling Management**. +#. On the **Recycling Management** page, click **Modify Recycling Policy**. In the displayed dialog box, set the retention period for the deleted DB instances from 1 day to 7 days. Then, click **OK**. + +Rebuilding a DB Instance +------------------------ + +You can rebuild DB instances from the recycle bin within the retention period to restore data. + +#. :ref:`Log in to the DDS console `. +#. In the navigation pane on the left, choose **Recycling Management**. +#. On the **Recycling Management** page, locate the DB instance to be rebuilt and in the **Operation** column, click **Rebuild**. +#. On the displayed page, set required parameters and submit the rebuilding task. + + - The database type, DB instance type, compatible MongoDB version, storage engine, and storage type must be the same as those of the original and cannot be changed. + - The storage space is the same as that of the original instance by default. You can only increase the storage space. + - Other settings have default values and can be modified. For details, see the following sections. + + - :ref:`Creating a Cluster Instance ` + - :ref:`Creating a Replica Set Instance ` + - :ref:`Creating a Single Node Instance ` + + - A full backup is triggered after the new instance is created. + + .. note:: + + After the instance has been rebuilt, it also stays in the recycle bin and cannot be deleted. diff --git a/umn/source/managing_dds_db_instances/db_instance_operations/restarting_a_db_instance_or_a_node.rst b/umn/source/instance_management/restarting_a_db_instance_or_a_node.rst similarity index 57% rename from umn/source/managing_dds_db_instances/db_instance_operations/restarting_a_db_instance_or_a_node.rst rename to umn/source/instance_management/restarting_a_db_instance_or_a_node.rst index c2836d1..a11fffe 100644 --- a/umn/source/managing_dds_db_instances/db_instance_operations/restarting_a_db_instance_or_a_node.rst +++ b/umn/source/instance_management/restarting_a_db_instance_or_a_node.rst @@ -8,23 +8,23 @@ Restarting a DB Instance or a Node **Scenarios** ------------- -You may need to restart a DB instance for maintenance purposes. After modifying some parameters, you must restart the DB instance for the modifications to take effect on the management console. +You may need to occasionally restart a DB instance to perform routine maintenance. For example, after modifying certain parameters, you must restart the DB instance for the modifications to take effect on the management console. You can restart a DB instance only when its status is **Available**. .. important:: - - After you restart a DB instance, services will be interrupted. Exercise caution when performing this operation. - - If you restart a DB instance, all nodes in the instance will be restarted. + - Restarting a DB instance interrupts services, so you should exercise caution when performing this operation. + - If you restart a DB instance, all nodes in the instance are also restarted. Restarting a DB Instance ------------------------ #. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, locate the target DB instance and choose **More** > **Restart** in the **Operation** column. +#. On the **Instance Management** page, locate the target DB instance and in the **Operation** column, choose **More** > **Restart**. - Alternatively, click the target DB instance. On the displayed **Basic Information** page, click **Restart** in the upper right corner of the page. + Alternatively, click the target DB instance and on the displayed **Basic Information** page, click **Restart** in the upper right corner of the page. #. In the displayed dialog box, click **Yes**. @@ -40,7 +40,7 @@ Restarting a Node (Cluster) #. On the **Instance Management** page, click the target cluster instance. -#. In the **Node Information** area on the **Basic Information** page, click **mongos**, **shard**, or **config**, locate the target node, and click **Restart**. +#. In the **Node Information** area on the **Basic Information** page, click the **mongos**, **shard**, or **config** tab, locate the target node, and in the **Operation** column, click **Restart**. #. In the displayed dialog box, click **Yes**. diff --git a/umn/source/managing_dds_db_instances/storage/reverting_cluster_instance_nodes.rst b/umn/source/instance_management/reverting_and_deleting_failed_cluster_instance_nodes.rst similarity index 66% rename from umn/source/managing_dds_db_instances/storage/reverting_cluster_instance_nodes.rst rename to umn/source/instance_management/reverting_and_deleting_failed_cluster_instance_nodes.rst index 2a69474..6ccd3b4 100644 --- a/umn/source/managing_dds_db_instances/storage/reverting_cluster_instance_nodes.rst +++ b/umn/source/instance_management/reverting_and_deleting_failed_cluster_instance_nodes.rst @@ -2,13 +2,13 @@ .. _dds_03_0018: -Reverting Cluster Instance Nodes -================================ +Reverting and Deleting Failed Cluster Instance Nodes +==================================================== Scenarios --------- -This section guides you on how to revert nodes that fail to be added. +This section describes how to revert nodes that fail to be added. Reverting Nodes in Batches -------------------------- @@ -19,16 +19,16 @@ Reverting Nodes in Batches #. In the displayed dialog box, click **Yes**. - During reversal, the node status is **Deleting node**. This process takes about 1 to 3 minutes. + During reversal, the instance status is **Deleting node**. This process takes about 1 to 3 minutes. -Deleting a Single Node ----------------------- +Deleting Failed Cluster Instance Nodes +-------------------------------------- #. :ref:`Log in to the DDS console. ` #. On the **Instance Management** page, click the target cluster instance to which the node fails to be added. -#. In the **Node Information** area on the **Basic Information** tab, click the **mongos** or **shard** tab, locate the mongos or shard that fail to be added, and choose **More** > **Delete**. +#. In the **Node Information** area on the **Basic Information** tab, click the **mongos** or **shard** tab, locate the mongos or shard that failed to be added, and choose **More** > **Delete**. #. In the displayed dialog box, click **Yes**. diff --git a/umn/source/instance_management/scaling_up_storage_space.rst b/umn/source/instance_management/scaling_up_storage_space.rst new file mode 100644 index 0000000..286b633 --- /dev/null +++ b/umn/source/instance_management/scaling_up_storage_space.rst @@ -0,0 +1,81 @@ +:original_name: en-us_topic_increase_storage.html + +.. _en-us_topic_increase_storage: + +Scaling Up Storage Space +======================== + +**Scenarios** +------------- + +This section describes how to scale up the storage space of a DB instance to suit your service requirements. + +.. note:: + + - You can scale up a DB instance a maximum of eight times. + - You cannot scale up a DB instance in **Creating**, **Changing instance class**, **Adding node**, or **Deleting node** status. + - Storage space can only be scaled up. It cannot be scaled down. + - If you scale up a DB instance with disks encrypted, the expanded storage space will be encrypted using the original encryption key. + - You cannot scale up the storage space of a config for the cluster instances. + - During the scale-up process, the DB instance will not restart, and your services will not be interrupted. + +Cluster +------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, click the target cluster instance. + +#. In the **Node Information** area on the **Basic Information** page, click the **shard** tab, locate the target shard, and click **Scale Storage Space** in the **Operation** column. + +#. On the displayed page, specify the desired storage space, and click **Submit**. + + You must add a minimum of 10 GB each time you scale up, and only multiples of 10 GB are allowed. The maximum amount of storage space is 2000 GB. + +#. Check the scale-up result. + + - This process takes up to 5 minutes. The status of the DB instance in the instance list is **Scaling up**. + - In the upper right corner of the DB instance list, click |image1| to refresh the list. The instance status changes to **Available**. + - In the **Node Information** area on the **Basic Information** page, click the **shard** tab and check whether the scale up was successful. + +Replica Set +----------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, locate the target replica set instance and click **Scale Storage Space** in the **Operation** column. + + Alternatively, you can click the target cluster instance, in the **Storage Space** area on the **Basic Information** page, click on the **Scale** button. + +#. On the displayed page, specify the desired storage space, and click **Submit**. + + You must add a minimum of 10 GB each time you scale up, and only multiples of 10 GB are allowed. The maximum amount of storage space is 3000 GB. + +#. Check the scale-up result. + + - This process takes up to 5 minutes. The status of the DB instance in the instance list is **Scaling up**. + - In the upper right corner of the DB instance list, click |image2| to refresh the list. The instance status changes to **Available**. + - In the **Storage Space** area on the **Basic Information** page, check whether the scaling up is successful. + +Single Node +----------- + +#. :ref:`Log in to the DDS console. ` + +#. On the **Instance Management** page, locate the target single node instance and click **Scale Storage Space** in the **Operation** column. + + Alternatively, you can click the target cluster instance, in the **Storage Space** area on the **Basic Information** page, click on the **Scale** button. + +#. On the displayed page, specify the desired storage space and click **Submit**. + + You must add a minimum of 10 GB each time you scale up, and only multiples of 10 GB are allowed. The maximum amount of storage space is 1000 GB. + +#. Check the scale-up result. + + - This process takes up to 5 minutes. The status of the DB instance in the instance list is **Scaling up**. + - In the upper right corner of the DB instance list, click |image3| to refresh the list. The instance status changes to **Available**. + - In the **Storage Space** area on the **Basic Information** page, check whether the scaling up is successful. + +.. |image1| image:: /_static/images/en-us_image_0000001095974074.png +.. |image2| image:: /_static/images/en-us_image_0000001095974076.png +.. |image3| image:: /_static/images/en-us_image_0000001095974074.png diff --git a/umn/source/introduction/basic_concepts/cluster.rst b/umn/source/introduction/basic_concepts/cluster.rst index eb85594..3033971 100644 --- a/umn/source/introduction/basic_concepts/cluster.rst +++ b/umn/source/introduction/basic_concepts/cluster.rst @@ -5,10 +5,10 @@ Cluster ======= -DDS cluster instances consist of mongos, config, and shard nodes. The following diagram shows the node relationships. +Each DDS cluster consists of a config node, and multiple mongos and shard nodes. The following diagram shows the node relationships. -.. figure:: /_static/images/en-us_image_0284275219.png +.. figure:: /_static/images/en-us_image_0000001096133880.png :alt: **Figure 1** Diagram of node relationships **Figure 1** Diagram of node relationships @@ -18,7 +18,7 @@ mongos A mongos is a router for reading and writing data, providing a unified interface for accessing DB instances. -- Each DB instance has 2 to 16 mongos. You can specify the quantity. +- Each DB instance has 2 to 32 mongos. You can specify the quantity. - A mongos reads configuration settings from configs and allocates read and write requests to shards. You can connect to a mongos directly. config @@ -34,6 +34,6 @@ shard In the cluster instance, shards are used to store user data. -- Each DB instance has 2 to 16 shards. You can specify the quantity. +- Each cluster instance has 2 to 32 shards. You can specify the quantity. - Each shard is deployed as a replica set to ensure data redundancy and high reliability. - You cannot connect to a shard directly. diff --git a/umn/source/introduction/basic_concepts/database_parameter_group.rst b/umn/source/introduction/basic_concepts/database_parameter_group.rst deleted file mode 100644 index b2bf9f1..0000000 --- a/umn/source/introduction/basic_concepts/database_parameter_group.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: dds_01_0005.html - -.. _dds_01_0005: - -Database Parameter Group -======================== - -A database parameter group is a collection of configuration parameters and values and can be applied to multiple DB instances. diff --git a/umn/source/introduction/basic_concepts/database_parameter_template.rst b/umn/source/introduction/basic_concepts/database_parameter_template.rst new file mode 100644 index 0000000..774e21d --- /dev/null +++ b/umn/source/introduction/basic_concepts/database_parameter_template.rst @@ -0,0 +1,8 @@ +:original_name: dds_01_0005.html + +.. _dds_01_0005: + +Database Parameter Template +=========================== + +A database parameter template is a collection of configuration parameters and values and can be applied to multiple DB instances. diff --git a/umn/source/introduction/basic_concepts/index.rst b/umn/source/introduction/basic_concepts/index.rst index fe770a6..7ce5ed9 100644 --- a/umn/source/introduction/basic_concepts/index.rst +++ b/umn/source/introduction/basic_concepts/index.rst @@ -6,7 +6,7 @@ Basic Concepts ============== - :ref:`Cluster ` -- :ref:`Database Parameter Group ` +- :ref:`Database Parameter Template ` - :ref:`Regions and AZs ` .. toctree:: @@ -14,5 +14,5 @@ Basic Concepts :hidden: cluster - database_parameter_group + database_parameter_template regions_and_azs diff --git a/umn/source/introduction/basic_concepts/regions_and_azs.rst b/umn/source/introduction/basic_concepts/regions_and_azs.rst index 2b37a36..86c559f 100644 --- a/umn/source/introduction/basic_concepts/regions_and_azs.rst +++ b/umn/source/introduction/basic_concepts/regions_and_azs.rst @@ -7,8 +7,8 @@ Regions and AZs A region is a geographic area in which resources used by DDS are located. -Each region comprises one or more AZs and is completely isolated from other regions. AZs within the same region can communicate with one another through an internal network, while those in different regions cannot communicate with one another through an internal network. +Each region comprises one or more AZs and is completely isolated from other regions. AZs within the same region can communicate with one another through an internal network. -Public cloud data centers are deployed worldwide. DDS applies to different regions. Provisioning DDS to specific regions can better meet user requirements. For example, applications can be designed to better meet specific user requirements or comply with local laws and other demands. +Cloud service platform data centers are deployed worldwide. DDS applies to different regions. Provisioning DDS to specific regions can better meet user requirements. For example, applications can be designed to better meet specific user requirements or comply with local laws and other demands. -Each region contains many AZs where power and networks are physically isolated. AZs in the same region can communicate with each other over an intranet. Each AZ provides cost-effective and low-latency network connections that are unaffected by faults in other AZs. As a result, provisioning DDS in separate AZs protects your applications against local faults that occur in a single location. DDS supports the deployment of a replica set instance across three AZs. It means that the primary, secondary, and hidden nodes are deployed in three AZs for disaster recovery. +Each region contains many AZs where power and networks are physically isolated. AZs in the same region can communicate with each other over an intranet. Each AZ provides cost-effective and low-latency network connections that are unaffected by faults in other AZs. As a result, provisioning DDS in separate AZs protects your applications against local faults that occur in a single location. DDS allows you to deploy replica sets across three AZs for disaster recovery. diff --git a/umn/source/introduction/constraints_and_recommendations.rst b/umn/source/introduction/constraints_and_recommendations.rst new file mode 100644 index 0000000..4a28743 --- /dev/null +++ b/umn/source/introduction/constraints_and_recommendations.rst @@ -0,0 +1,38 @@ +:original_name: dds_01_0022.html + +.. _dds_01_0022: + +Constraints and Recommendations +=============================== + +To improve the stability and security of DB instances, there are some constraints on the use of DDS. For details, see :ref:`Table 1 `. + +.. _dds_01_0022__table60364850123535: + +.. table:: **Table 1** Function constraints + + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Topic | Constraints | + +==========================================+=============================================================================================================================================================================================================================+ + | Connecting to a DB instance | - When connecting to a DB instance over private networks, bind an EIP to the prepared ECS. | + | | - By default, DDS is not accessible from ECSs that are not in the same security group. If the ECS is not in the same security group, you need to add an inbound rule to enable access. | + | | - The default DDS port is 8635, but this port can be modified if necessary. | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Deployment | ECS instances in which DB instances are deployed are not visible to you. Your applications can access the database only through an IP address and port. | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Obtaining permissions of user **rwuser** | Only the **rwuser** user permissions are provided on the instance creation page. | + | | | + | | For details about the related commands, see :ref:`Which Commands are Supported or Restricted by DDS? ` | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Setting database parameters | Most database parameters in the parameter templates you created can be modified. For details, see section :ref:`Modifying a Parameter Template `. | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Migrating data | You can use multiple tools to migrate your data between databases, such as mongoexport and mongoimport. For details, see section :ref:`Migrating Data `. | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Storage engine | DDS supports the WiredTiger storage engine. | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Nodes | Mongos and shard nodes that are successfully added cannot be deleted. | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Restarting a DB instance or a node | DB instances cannot be restarted using commands. They must be restarted on the management console. | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Viewing DDS backup files | DDS backups are saved in OBS buckets but these cannot be accessed directly. You can download and view the files on the DDS console. For details, see section :ref:`Downloading Backup Files `. | + +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/introduction/dds_db_instance/database_engine_and_version.rst b/umn/source/introduction/dds_db_instance/database_engine_and_version.rst index daa5c46..9836bf0 100644 --- a/umn/source/introduction/dds_db_instance/database_engine_and_version.rst +++ b/umn/source/introduction/dds_db_instance/database_engine_and_version.rst @@ -5,4 +5,4 @@ Database Engine and Version =========================== -Currently, DDS is compatible with MongoDB 3.2 and 3.4 Community Edition and supports the WiredTiger storage engine, so you need to use a driver compatible with MongoDB 3.0 or later to access DDS. +DDS is compatible with MongoDB 3.2, 3.4, 4.0, and 4.2 Community Edition and supports the WiredTiger storage engine, so you need to use a driver compatible with MongoDB 3.0 or later to access DDS. diff --git a/umn/source/introduction/dds_db_instance/database_status.rst b/umn/source/introduction/dds_db_instance/database_status.rst deleted file mode 100644 index d8c1116..0000000 --- a/umn/source/introduction/dds_db_instance/database_status.rst +++ /dev/null @@ -1,60 +0,0 @@ -:original_name: dds_01_0026.html - -.. _dds_01_0026: - -Database Status -=============== - -DB Instance Status ------------------- - -.. table:: **Table 1** Status and description - - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Status | Description | - +=============================+===================================================================================================================================================+ - | Available | A DB instance is running properly. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Abnormal | A DB instance is faulty. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Creating | A DB instance is being created. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Creation failed | A DB instance fails to be created. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Restarting | A DB instance is being restarted because of a customer request or a modification that requires restarting it for the modification to take effect. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Switchover in progress | The primary and secondary nodes of a replica set instance are being switched. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Adding node | shards or mongos are being added to a DDS cluster instance. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Deleting node | The node that failed to be added is being deleted. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Scaling up | The storage space of instance nodes is being expanded. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Changing instance class | The CPU or memory of a DB instance is being changed. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Backing up | A backup file is being created. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Checking restoration | The backup of the current DB instance is being restored to a new DB instance. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Switching SSL | The SSL channel is being enabled or disabled. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Changing private IP address | The private IP address of a node is being changed. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Changing port | The DB instance port is being changed. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Changing a security group | The security group is being changed. | - +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - -Parameter Group Status ----------------------- - -.. table:: **Table 2** Status and description - - +-----------------+-----------------------------------------------------------------------------------------------------------+ - | Status | Description | - +=================+===========================================================================================================+ - | In-Sync | A database parameter change has taken effect. | - +-----------------+-----------------------------------------------------------------------------------------------------------+ - | Pending restart | A database parameter is waiting for the DB instance to be restarted before its modification takes effect. | - +-----------------+-----------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/introduction/dds_db_instance/db_instance_specifications.rst b/umn/source/introduction/dds_db_instance/db_instance_specifications.rst index a2aacd7..69009b6 100644 --- a/umn/source/introduction/dds_db_instance/db_instance_specifications.rst +++ b/umn/source/introduction/dds_db_instance/db_instance_specifications.rst @@ -9,38 +9,48 @@ DB instance specifications are listed in the following table. .. note:: - DB instance specifications vary depending on the actual environment. + The DB instance specifications depend on service requirements. + + You can change the maximum number of connections of a DB instance by modifying the **net.maxIncomingConnections** parameter. For details about how to change the parameter value, see :ref:`Modifying a Parameter Template `. + +.. _dds_01_0024__section87233314314: Cluster ------- -For details about the cluster instance specifications, see :ref:`Table 1 ` and :ref:`Table 2 `. +For details about the cluster instance specifications, see :ref:`Table 1 ` and :ref:`Table 2 `. -.. _dds_01_0024__table147993911564: +.. _dds_01_0024__table93922044142815: .. table:: **Table 1** config specifications - =============== =========== ========================== - Number of vCPUs Memory (GB) Max. Number of Connections - =============== =========== ========================== - 2 4 1000 - =============== =========== ========================== + ======== ===== =========== ===================================== + CPU Type vCPUs Memory (GB) Default Maximum Number of Connections + ======== ===== =========== ===================================== + x86 2 4 600 + Kunpeng + ======== ===== =========== ===================================== -.. _dds_01_0024__table196721422132317: +.. _dds_01_0024__table3885614174718: .. table:: **Table 2** shard and mongos specifications - =============== =========== ========================== - Number of vCPUs Memory (GB) Max. Number of Connections - =============== =========== ========================== - 1 4 400 - 2 8 400 - 4 16 1000 - 8 32 4000 - 16 64 8000 - =============== =========== ========================== + ===== =========== ===================================== + vCPUs Memory (GB) Default Maximum Number of Connections + ===== =========== ===================================== + 1 4 400 + 2 8 400 + 4 16 1000 + 8 32 4000 + 16 64 8000 + ===== =========== ===================================== Replica Set ----------- -The supported replica set specifications are the same as those of shard and mongos nodes. For details, see :ref:`Table 2 `. +The specifications supported by a replica set are the same as those supported by shard and mongos. For details, see :ref:`Table 2 `. + +Single Node +----------- + +The specifications supported by a single node are the same as those supported by shard and mongos. For details, see :ref:`Table 2 `. diff --git a/umn/source/introduction/dds_db_instance/db_instance_status.rst b/umn/source/introduction/dds_db_instance/db_instance_status.rst new file mode 100644 index 0000000..261d573 --- /dev/null +++ b/umn/source/introduction/dds_db_instance/db_instance_status.rst @@ -0,0 +1,73 @@ +:original_name: dds_01_0026.html + +.. _dds_01_0026: + +DB Instance Status +================== + + +DB Instance Status +------------------ + +.. table:: **Table 1** Status and description + + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Status | Description | + +===================================+=======================================================================================================================================================+ + | Available | A DB instance is running properly. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Abnormal | A DB instance is faulty. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Creating | A DB instance is being created. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Creation failed | A DB instance fails to be created. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Backing up | An instance backup is being created. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Restarting | A DB instance is being restarted because of a modification that requires restarting it for the modification to take effect. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Switchover in progress | The primary and standby nodes of the replica set instance or the primary and standby shards or configs of a cluster instance are being switched over. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Adding node | shard or mongos nodes are being added to a DDS cluster instance. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Deleting node | The node that failed to be added is being deleted. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Scaling up | The storage space of instance nodes is being expanded. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing instance class | The CPU or memory of a DB instance is being changed. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Checking restoration | The backup of the current DB instance is being restored to a new DB instance. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Restoring | The backup is being restored to the existing DB instance. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Restoration failed | Restoring to the existing DB instance failed. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Switching SSL | The SSL channel is being enabled or disabled. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Querying original slow query logs | Show Original Log is being enabled or disabled. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing private IP address | The private IP address of a node is being changed. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing port | The DB instance port is being changed. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing a security group | The security group is being changed. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Enabling shard IP Address | The shard IP address is being enabled. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Enabling config IP Address | The config IP address is being enabled. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing the oplog size | The oplog size is being changed. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Parameter Template Status +------------------------- + +.. table:: **Table 2** Status and description + + +-----------------+-----------------------------------------------------------------------------------------------------------+ + | Status | Description | + +=================+===========================================================================================================+ + | In-Sync | A database parameter change has taken effect. | + +-----------------+-----------------------------------------------------------------------------------------------------------+ + | Pending restart | A database parameter is waiting for the DB instance to be restarted before its modification takes effect. | + +-----------------+-----------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/introduction/dds_db_instance/index.rst b/umn/source/introduction/dds_db_instance/index.rst index 0107c01..e33ec3c 100644 --- a/umn/source/introduction/dds_db_instance/index.rst +++ b/umn/source/introduction/dds_db_instance/index.rst @@ -7,7 +7,7 @@ DDS DB Instance - :ref:`DB Instance Specifications ` - :ref:`Database Engine and Version ` -- :ref:`Database Status ` +- :ref:`DB Instance Status ` .. toctree:: :maxdepth: 1 @@ -15,4 +15,4 @@ DDS DB Instance db_instance_specifications database_engine_and_version - database_status + db_instance_status diff --git a/umn/source/introduction/functions_and_features.rst b/umn/source/introduction/functions_and_features.rst new file mode 100644 index 0000000..c1bb8f6 --- /dev/null +++ b/umn/source/introduction/functions_and_features.rst @@ -0,0 +1,57 @@ +:original_name: dds_01_0006.html + +.. _dds_01_0006: + +Functions and Features +====================== + +Three Architectures +------------------- + +DDS supports three deployment architectures: cluster, replica set, and single node. They meet requirements of different service scenarios. + +- Cluster + + A cluster consists of three types of nodes: mongos, shard, and config. You can select the number and configuration of mongos and shard nodes to create cluster instances with different levels of service performance. + +- Replica set + + DDS automatically builds the replica set architecture, and you can directly operate the primary and secondary nodes. DDS provides you with advanced functions such as high availability (HA) and disaster recovery (DR) switchover, and is invisible to applications. + +- Single node + + A database that is deployed on a single VM does not have the HA feature. To ensure data consistency during full backup, tables are locked to prevent data from being changed. The single-node architecture features low costs and is a preferred option for R&D and testing environment, learning and training environment, and internal systems of small-sized enterprises. + +Elastic Scaling +--------------- + +With the development of your services, you can change CPU and memory specifications of instances, expand storage space, and add mongos and shard nodes of cluster DB instances in real time. You are advised to perform the change during off-peak hours to avoid the impact of changes on your services. + +Key Features +------------ + +.. table:: **Table 1** Key feature description + + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Features | Description | + +============================================+==========================================================================================================================================================================================================================================================================================+ + | SLA | 99.95% | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Instant availability | You can create a DB instance on the management console and access DDS through an Elastic Cloud Server (ECS) to reduce the application response time. If you need to access a DB instance from your local devices, you can bind an elastic IP address (EIP) to the instance. | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | High compatibility | DDS is a document-oriented NoSQL database. It is fully compatible with MongoDB. | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Visualized operation and maintenance (O&M) | You can easily perform restart, backup, and data recovery operations on instances using a graphical user interface (GUI) | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Data security | - A security protection system consists of VPCs, subnets, security groups, storage encryption, SSL, and DDoS protection, which is capable of defending against various malicious attacks and ensuring data security. | + | | - DDS supports fine-grained permission control. | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | High availability | The cluster and replica set support high availability. If the primary node is faulty, the secondary node takes over services in a short time. The switchover process is invisible to applications. | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Metric monitoring | DDS monitors key performance metrics of DB instances and DB engines in real time, including the CPU usage, memory usage, storage space usage, command execution frequency, delete statement execution frequency, insert statement execution frequency, and number of active connections. | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Backups and restorations | - DDS supports automated backup and manual backup. The maximum retention period of an automated backup is 732 days. There is no limit on the manual backup retention period. You can delete manual backup files as needed. | + | | - DB instances can be restored using backup data. | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Setting parameters | DDS allows you to manage parameter Templates and modify configuration parameters on the console. | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/introduction/index.rst b/umn/source/introduction/index.rst index 5ccf919..e479a6d 100644 --- a/umn/source/introduction/index.rst +++ b/umn/source/introduction/index.rst @@ -8,11 +8,13 @@ Introduction - :ref:`What Is DDS? ` - :ref:`System Architecture ` - :ref:`Basic Concepts ` -- :ref:`Product Advantages ` -- :ref:`DDS DB Instance ` +- :ref:`Functions and Features ` - :ref:`Typical Application Scenarios ` -- :ref:`Related Services ` +- :ref:`DDS DB Instance ` +- :ref:`Constraints and Recommendations ` - :ref:`User Permissions ` +- :ref:`Permissions Management ` +- :ref:`Related Services ` .. toctree:: :maxdepth: 1 @@ -21,8 +23,10 @@ Introduction what_is_dds system_architecture/index basic_concepts/index - product_advantages/index - dds_db_instance/index + functions_and_features typical_application_scenarios - related_services + dds_db_instance/index + constraints_and_recommendations user_permissions + permissions_management + related_services diff --git a/umn/source/introduction/permissions_management.rst b/umn/source/introduction/permissions_management.rst new file mode 100644 index 0000000..6e544c6 --- /dev/null +++ b/umn/source/introduction/permissions_management.rst @@ -0,0 +1,227 @@ +:original_name: dds_01_0019.html + +.. _dds_01_0019: + +Permissions Management +====================== + +If you need to assign different permissions to employees in your enterprise to access your DDS resources, IAM is a good choice for fine-grained permissions management. IAM provides identity authentication, permissions management, and access control, helping you secure access to your resources. + +With IAM, you can use your account to create IAM users for your employees, and assign permissions to the users to control their access to specific resource types. For example, some software developers in your enterprise need to use DDS resources but must not delete them or perform any high-risk operations. To achieve this result, you can create IAM users for the software developers and grant them only the permissions required for using DDS resources. + +If your account does not need individual IAM users for permissions management, you may skip over this topic. + +IAM can be used free of charge. You pay only for the resources in your account. + +DDS Permissions +--------------- + +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. + +DDS is a project-level service deployed and accessed in specific physical regions. To assign GaussDB NoSQL 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 DDS, users need to switch to a region where they have been authorized to use DDS. + +You can grant users permissions by using roles and policies. + +- Roles: A type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. This mechanism provides only a limited number of service-level roles for authorization. When using roles to grant permissions, you need to also assign other roles on which the permissions depend to take effect. However, roles are not an ideal choice for fine-grained authorization and secure access control. +- Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for more flexible policy-based authorization, meeting requirements for secure access control. For example, you can grant DDS users only the permissions for managing a certain type of resources. + +:ref:`Table 1 ` lists all the system-defined roles and policies supported by DDS. + +.. _dds_01_0019__table19889139134716: + +.. table:: **Table 1** System-defined roles and policies supported by DDS + + +-------------------------+--------------------------------------------------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------+ + | Policy Name/System Role | Description | Type | Dependency | + +=========================+==================================================================================================+=======================+==========================================================================================+ + | DDS FullAccess | All operations on DDS. | System-defined policy | None | + +-------------------------+--------------------------------------------------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------+ + | DDS ReadOnlyAccess | Read-only permissions for DDS resources. Users granted these permissions can only view DDS data. | System-defined policy | None | + +-------------------------+--------------------------------------------------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------+ + | DDS ManageAccess | DBA permissions on DDS except the DDS DB instance deletion operations. | System-defined policy | None | + +-------------------------+--------------------------------------------------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------+ + | DDS Administrator | DDS administrator, who has all permissions of the service. | System-defined role | The Tenant Guest and Tenant Administrator roles need to be assigned in the same project. | + +-------------------------+--------------------------------------------------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------+ + +:ref:`Table 2 ` lists the common operations supported by each system-defined policy or role of DDS. Select the policies or roles as required. + +.. _dds_01_0019__table11709164134815: + +.. table:: **Table 2** Common operations supported by the DDS system policy + + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Operation | DDS FullAccess | DDS ReadOnlyAccess | DDS ManageAccess | DDS Administrator | + +===========================================================================+================+====================+==================+===================+ + | Creating an instance | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Querying DB instances | Y | Y | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Deleting a DB instance | Y | x | x | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Restarting a DB instance | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Performing a primary/secondary switchover | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Modifying the port | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Resetting a password | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Modified SSL | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Modifying a security group | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Binding and unbinding an EIP | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Scaling up storage space | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Changing DB instance classes | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Adding nodes | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Deleting the node that fails to be added | Y | x | x | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Modifying an automated backup policy | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Renaming a DB instance | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Changing a private IP address | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Changing the parameter template associated with the node in a DB instance | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Showing original slow logs | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Enabling or disabling local log auditing | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Downloading audit logs | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Deleting audit logs | Y | x | x | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Downloading a backup file | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Creating a manual backup | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Querying the backup list | Y | Y | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Restoring data to a new DB instance | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Restoring to an existing DB instance | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Deleting a backup | Y | x | x | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Creating a parameter template | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Viewing parameter templates | Y | Y | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Modifying a parameter template | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Deleting a parameter template | Y | x | x | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + | Task Center list | Y | x | Y | Y | + +---------------------------------------------------------------------------+----------------+--------------------+------------------+-------------------+ + +:ref:`Table 3 ` lists common DDS operations and corresponding actions. You can refer to this table to customize permission policies. + +.. _dds_01_0019__table1164310390542: + +.. table:: **Table 3** Common Operations and actions + + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Operation | Actions | Description | + +===========================================================================+===========================================+=============================================================================================================================================+ + | Instance creation page | - vpc:vpcs:list | The VPC, subnet, and security group are displayed on the instance creation page. | + | | - vpc:subnets:get | | + | | - vpc:securityGroups:get | | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Creating an instance | - dds:instance:create | If the default VPC, subnet, and security group are used, the vpc:``*``:create permission must be configured. | + | | - vpc:vpcs:list | | + | | - vpc:vpcs:get | To create an encrypted instance, configure the KMS Administrator permission for the project. | + | | - vpc:subnets:get | | + | | - vpc:securityGroups:get | | + | | - vpc:ports:get | | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Querying DB instances | dds:instance:list | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Querying details of a DB instance | dds:instance:list | If the VPC, subnet, and security group need to be displayed on the instance details page, add the vpc:``*``:get and vpc:``*``:list actions. | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Exporting DB instance lists | dds:instance:list | If the VPC, subnet, and security group are required, add the vpc:``*``:get and vpc:``*``:list actions. | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Deleting a DB instance | dds:instance:deleteInstance | When deleting a DB instance, delete the IP address on the data side. | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Restarting a DB instance | dds:instance:reboot | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Performing a primary/secondary switchover | dds:instance:switchover | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing a port | dds:instance:modifyPort | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Resetting a password | dds:instance:resetPasswd | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Modified SSL | dds:instance:modifySSL | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Modifying a security group | dds:instance:modifySecurityGroup | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Binding an EIP | dds:instance:bindPublicIp | When binding an EIP, you need to query the created EIP. | + | | | | + | | | - Enterprise projects are not supported. | + | | | - Fine-grained authentication is not supported. | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Unbinding an EIP | dds:instance:unbindPublicIp | - Enterprise projects are not supported. | + | | | - Fine-grained authentication is not supported. | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Scaling up storage space | dds:instance:extendVolume | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing DB instance classes | dds:instance:modifySpec | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Adding nodes | - dds:instance:extendNode | ``-`` | + | | - vpc:vpcs:list | | + | | - vpc:vpcs:get | | + | | - vpc:subnets:get | | + | | - vpc:securityGroups:get | | + | | - vpc:ports:get | | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Deleting the node that fails to be added | dds:instance:extendNode | If the IP address has been created but the subsequent procedure fails, delete the IP address on the data side. | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Modifying an automated backup policy | dds:instance:modifyBackupPolicy | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Renaming a DB instance | dds:instance:modify | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing a private IP address | - dds:instance:modifyVIP | Before changing the private IP address, query available IP addresses. | + | | - vpc:subnets:get | | + | | - vpc:ports:get | | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Changing the parameter template associated with the node in a DB instance | dds:instance:modifyParameter | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Showing original slow logs | dds:instance:modifySlowLogPlaintextSwitch | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Enabling or disabling local log auditing | dds:instances:modifyAuditLogSwitch | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Downloading audit logs | dds:instances:downloadAuditLog | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Deleting audit logs | dds:instance:deleteAuditLog | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Downloading a backup file | dds:backup:download | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Creating a Manual Backup | dds:instance:createManualBackup | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Querying the backup list | dds:backup:list | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Restoring data to a new DB instance | - dds:backup:createInstanceFromBackup | The KMS Administrator permission needs to be configured for the encrypted instance in the project. | + | | - vpc:vpcs:list | | + | | - vpc:vpcs:get | | + | | - vpc:subnets:get | | + | | - vpc:securityGroups:get | | + | | - vpc:ports:get | | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Restoring to an existing DB instance | dds:backup:refreshInstanceFromBackup | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Deleting a backup | dds:backup:delete | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Creating a parameter template | dds:param:create | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Viewing parameter templates | dds:param:list | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Modifying a parameter template | dds:param:modify | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Deleting a parameter template | dds:param:delete | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Task Center list | dds:task:list | ``-`` | + +---------------------------------------------------------------------------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/introduction/product_advantages/ease_of_use.rst b/umn/source/introduction/product_advantages/ease_of_use.rst deleted file mode 100644 index 328b0cb..0000000 --- a/umn/source/introduction/product_advantages/ease_of_use.rst +++ /dev/null @@ -1,21 +0,0 @@ -:original_name: dds_01_0010.html - -.. _dds_01_0010: - -Ease of Use -=========== - -Instant Availability --------------------- - -You can create a DB instance on the management console and access DDS through an Elastic Cloud Server (ECS) to reduce the application response time. If you need to access a DB instance from your local devices, you can bind an elastic IP address (EIP) to the instance. - -High Compatibility ------------------- - -DDS is a document-oriented NoSQL database. It is fully compatible with MongoDB. - -Easy O&M --------- - -You can easily perform restart, backup, and data recovery operations on instances using a graphical user interface (GUI) diff --git a/umn/source/introduction/product_advantages/high_reliability.rst b/umn/source/introduction/product_advantages/high_reliability.rst deleted file mode 100644 index d5b6e78..0000000 --- a/umn/source/introduction/product_advantages/high_reliability.rst +++ /dev/null @@ -1,30 +0,0 @@ -:original_name: dds_01_0007.html - -.. _dds_01_0007: - -High Reliability -================ - -Failover --------- - -The three-node replica set architecture of DDS ensures high service availability. - -In a replica set, both the primary and secondary nodes provide services. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. - -Multi-Copy Redundancy ---------------------- - -config and shard use the three-node replica set HA architecture. Using this architecture, nodes are deployed on different servers and racks. - -Data Backups ------------- - -Data can be backed up automatically or manually. Automated backups execute full backups on DB instances. A manual backup is a full backup of DB instances initiated by users. These backups can be used to restore DB instances with a few clicks. - -Backups are stored in Object Storage Service (OBS), improving the data disaster recovery capabilities while reducing the needed storage space. When a DB instance is created, the automated backup policy is enabled by default. After the DB instance is created, an automated full backup is triggered instantly. The backup retention period is 7 days by default. You can set the backup retention period and modify the backup policy. In addition, you can initiate backup at any time according to your service requirements. Manual backups are saved until you manually delete them. - -Data Restore ------------- - -You can use backup data to restore instance data. Restored data is the same as the original data. diff --git a/umn/source/introduction/product_advantages/high_security.rst b/umn/source/introduction/product_advantages/high_security.rst deleted file mode 100644 index 21880eb..0000000 --- a/umn/source/introduction/product_advantages/high_security.rst +++ /dev/null @@ -1,37 +0,0 @@ -:original_name: dds_01_0008.html - -.. _dds_01_0008: - -High Security -============= - -Network Isolation ------------------ - -DDS uses Virtual Private Clouds (VPCs) and network security groups to isolate your DB instances. VPCs allow you to configure IP address ranges that are allowed access to DDS. You can run your DB instances in a VPC to improve security. To further enhance database security, you can configure subnets and security groups to control access to DB instances. - -Access Control --------------- - -VPC security groups can have rules that govern both inbound and outbound traffic of DB instances. - -Transmission Encryption ------------------------ - -DDS uses Secure Sockets Layer (SSL) to encrypt transmitted data. You can download a certificate authority (CA) from the DDS console and upload it for authentication when connecting to a database. - -Security Protection -------------------- - -DDS provides a multi-layer network protection against various malicious attacks. The protection system consists of VPCs, subnets, security groups, DDoS protection, and SSL. - -- VPC is used to isolate tenants and control access to databases. -- The SSL connection ensures data security and integrity. -- Security group rules restrict traffic to specific IP addresses and ports, securing connections between DDS and other services. - -Performance Monitoring ----------------------- - -DDS monitors instance performance, reducing O&M activities by as much as 60%. It provides real-time monitoring information about CPU utilization, disk usage, IOPS, and number of active connections, allowing you to check instance status at any time. - -In asynchronous disk scenarios, DDS provides excellent plugin performance and process memory databases. It also provides the secondary index function to meet dynamic query requirements. diff --git a/umn/source/introduction/product_advantages/index.rst b/umn/source/introduction/product_advantages/index.rst deleted file mode 100644 index 3fff802..0000000 --- a/umn/source/introduction/product_advantages/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: dds_01_0006.html - -.. _dds_01_0006: - -Product Advantages -================== - -- :ref:`High Reliability ` -- :ref:`High Security ` -- :ref:`Ease of Use ` -- :ref:`Scalability ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - high_reliability - high_security - ease_of_use - scalability diff --git a/umn/source/introduction/product_advantages/scalability.rst b/umn/source/introduction/product_advantages/scalability.rst deleted file mode 100644 index 732079c..0000000 --- a/umn/source/introduction/product_advantages/scalability.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: dds_01_0009.html - -.. _dds_01_0009: - -Scalability -=========== - -Elastic Scaling ---------------- - -DDS supports the cluster mode. You can select multiple mongos and shards. When your service changes or the current instance configuration cannot meet the application performance requirements, DDS allows you to scale up storage space of shards, or add new shards. During the expansion, your services will not be interrupted. - -On-demand Scaling ------------------ - -DDS supports the three-node replica set mode. You can scale up the storage space based on your service requirements and only pay for the resources you consumed. If the storage space of the current DB instance cannot meet your application requirements, you can expand the storage capacity. During the expansion, your services will not be interrupted. diff --git a/umn/source/introduction/related_services.rst b/umn/source/introduction/related_services.rst index 42e779c..4c700c9 100644 --- a/umn/source/introduction/related_services.rst +++ b/umn/source/introduction/related_services.rst @@ -5,51 +5,24 @@ Related Services ================ -ECS ---- +.. table:: **Table 1** Related services -ECS provides DDS with elastic computing resources. DDS needs to apply for resources from ECS to build a running environment for DB instances. - -For more information, see the *Elastic Cloud Server User Guide*. - -EVS ---- - -Elastic Volume Service (EVS) provides DDS with elastic storage resources. DDS needs to apply for resources from EVS to build a running environment for DB instances. - -For more information, see the *Elastic Volume Service User Guide*. - -VPC ---- - -Virtual Private Cloud (VPC) provides DDS with elastic network resources and implements network isolation and access control for your DB instances. - -For more information, see the *Virtual Private Cloud User Guide*. - -OBS ---- - -OBS stores your DDS DB instance backup files. - -For more information, see the *Object Storage Service User Guide*. - -Cloud Eye ---------- - -Cloud Eye serves as a monitoring platform, monitoring DDS resources for you. Cloud Eye supports multiple alarm rules to ensure timely pre-warning and normal service running. - -For more information, see the *Cloud Eye User Guide*. - -IAM ---- - -Identity and Access Management (IAM) provides the permission management function for DDS. - -For more information, see the *Identity and Access Management User Guide*. - -CTS ---- - -Cloud Trace Service (CTS) records operations related to DDS, facilitating your further queries, audits, and retrievals. - -For more information, see the *Cloud Trace Service User Guide*. + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Service Name | Function | + +======================================+========================================================================================================================================================================================+ + | Elastic Cloud Service (ECS) | ECS provides DDS with elastic computing resources and a running environment for DB instances. | + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Virtual Private Cloud (VPC) | VPC provides DDS with elastic network resources and implements network isolation and access control for your DB instances. | + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Object Storage Service (OBS) | OBS stores your DDS DB instance backup files. | + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Cloud Eye | Cloud Eye serves as a monitoring platform, monitoring DDS resources for you in real time. It reports alarms and issues warnings promptly to ensure that services are running properly. | + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Identity and Access Management (IAM) | IAM provides the permission management function for DDS. | + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Cloud Trace Service (CTS) | CTS records operations related to DDS, facilitating your further queries, audits, and retrievals. | + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Data Replication Service (DRS) | DRS smoothly migrates databases to the cloud. Source databases remain operational during migration, minimizing downtime and impact. | + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Key Management Service (KMS) | KMS is a secure, reliable, and easy-to-use cloud service that helps users create, manage, and protect keys in a centralized manner. | + +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/introduction/system_architecture/cluster.rst b/umn/source/introduction/system_architecture/cluster.rst new file mode 100644 index 0000000..45c9d50 --- /dev/null +++ b/umn/source/introduction/system_architecture/cluster.rst @@ -0,0 +1,24 @@ +:original_name: dds_01_0011.html + +.. _dds_01_0011: + +Cluster +======= + +Each DDS cluster is an independent document database. A sharded cluster consists of a config node, and multiple mongos and shard nodes. + +Data read and write requests are forwarded by the mongos nodes, which read configuration settings from config, and then allocate the read and write requests to the shards, making it easy to cope with high concurrency scenarios. In addition, each config node, along with the shards in its cluster, is replicated in triplicate to ensure high availability. The following figure shows the DDS cluster architecture. + + +.. figure:: /_static/images/en-us_image_0000001143133849.png + :alt: **Figure 1** Cluster architecture + + **Figure 1** Cluster architecture + +- A driver handles all interactions between your application and the database in a language appropriate to the application. For details, see `official documents `__. +- Each mongos is a single node, but you can provision multiple mongos nodes for load balancing and failovers. A single cluster can contain 2 to 32 mongos nodes. +- Each shard is a three-node replica set, and each cluster can contain 2 to 32 shards. +- A config node is a necessary part of a cluster instance, and is also deployed as a replica set. The config node stores instance configuration data. +- The number of mongos and shard nodes can be increased from the management console. You do not need to use native commands. +- You can :ref:`enable IP addresses of shards and the config node ` to directly access the shards and the config node. +- A three-node replica set cannot be directly upgraded to a cluster. diff --git a/umn/source/introduction/system_architecture/cluster_architecture.rst b/umn/source/introduction/system_architecture/cluster_architecture.rst deleted file mode 100644 index 50fc416..0000000 --- a/umn/source/introduction/system_architecture/cluster_architecture.rst +++ /dev/null @@ -1,23 +0,0 @@ -:original_name: dds_01_0011.html - -.. _dds_01_0011: - -Cluster Architecture -==================== - -Each DDS cluster is an independent document database. A sharded cluster consists of mongos, config, and shard. - -Data read and write requests are forwarded by mongos. A mongos reads configuration settings from configs and allocates the read and write requests to shards, making it easy to cope with high concurrency scenarios. In addition, each config and shard is a replica set that provides high availability. The following figure shows the DDS cluster architecture. - - -.. figure:: /_static/images/en-us_image_0284274967.png - :alt: **Figure 1** Cluster architecture - - **Figure 1** Cluster architecture - -- Each mongos is a single node. To realize load balancing and automatic failover, you can provision multiple mongos. A single cluster supports 2 to 16 mongos. -- Each shard is a three-node replica set. A single cluster supports 2 to 16 shards. -- config is mandatory in a cluster instance. It stores instance configuration information and consists of one replica set. -- mongos and shards cannot be added using native commands but can be scaled out on the DDS console. -- You cannot connect to a config and shard. Data operations can only be delivered by connecting to mongos. -- Currently, a three-node replica set cannot be directly upgraded to a cluster. diff --git a/umn/source/introduction/system_architecture/index.rst b/umn/source/introduction/system_architecture/index.rst index f38ca67..41a6abb 100644 --- a/umn/source/introduction/system_architecture/index.rst +++ b/umn/source/introduction/system_architecture/index.rst @@ -5,12 +5,14 @@ System Architecture =================== -- :ref:`Cluster Architecture ` -- :ref:`Replica Set Architecture ` +- :ref:`Cluster ` +- :ref:`Replica Set ` +- :ref:`Single Node Architecture ` .. toctree:: :maxdepth: 1 :hidden: - cluster_architecture - replica_set_architecture + cluster + replica_set + single_node_architecture diff --git a/umn/source/introduction/system_architecture/replica_set.rst b/umn/source/introduction/system_architecture/replica_set.rst new file mode 100644 index 0000000..1e256c8 --- /dev/null +++ b/umn/source/introduction/system_architecture/replica_set.rst @@ -0,0 +1,32 @@ +:original_name: dds_01_0012.html + +.. _dds_01_0012: + +Replica Set +=========== + +A replica set consists of a set of mongod processes. It is a collection of nodes that help ensure data redundancy and reliability. + +.. note:: + + For details about the mongod process, see the MongoDB `official document `__. + +A replica set consists of three nodes: primary, secondary, and hidden. The three-node architecture is set up automatically, and the three nodes automatically synchronize data with each other to ensure data reliability. + +- Primary node: Primary nodes are used to process both read and write requests. +- Secondary node: Secondary nodes are used to process read requests only. +- Hidden node: Hidden nodes are used to back up data. + +You can perform operations on the primary and secondary nodes. If a primary node goes down or becomes faulty, the replica set elects a secondary node as a new primary node and continues normal operations. If there are no secondary nodes available, a hidden node will take over the role of the secondary node to ensure high availability. The following figure shows the replica set architecture. + + +.. figure:: /_static/images/en-us_image_0000001096453886.png + :alt: **Figure 1** Replica set architecture + + **Figure 1** Replica set architecture + +- A driver handles all interactions between your application and the database in a language appropriate to the application. For details, see `official documents `__. +- You can perform multiple management and control tasks, such as creating instances, changing configurations, and backing up instances. The system flexibly controls and tracks tasks, and manages exceptions based on the operations delivered by you. +- You can monitor performance information about DB instances, including basic metrics, storage space, access requests, and the number of operations. +- DDS collects slow query logs and access control logs, recording DB instance running status. +- You can back up DB instance data and upload them to OBS buckets. DDS supports automated and manual backup creation. Automated backups are kept for seven days by default. diff --git a/umn/source/introduction/system_architecture/replica_set_architecture.rst b/umn/source/introduction/system_architecture/replica_set_architecture.rst deleted file mode 100644 index d72fa47..0000000 --- a/umn/source/introduction/system_architecture/replica_set_architecture.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: dds_01_0012.html - -.. _dds_01_0012: - -Replica Set Architecture -======================== - -A replica set consists of a set of mongod processes and provides a collection of data nodes to ensure data redundancy and reliability. - -.. note:: - - For details about the mongod process, visit https://docs.mongodb.com/v3.2/tutorial/manage-mongodb-processes/index.html. - -A replica set consists of three nodes: primary, secondary, and hidden. The three-node architecture is automatically set up, and the three nodes synchronize data with each other automatically to ensure data reliability. - -- The primary node is used to read and write requests. -- The secondary node is used to read requests. -- The hidden node is used to back up data. - -You can directly perform operations on the primary and secondary nodes. If a primary node goes down or becomes faulty, a secondary node is automatically assigned to the primary role and continues normal operation. If a secondary node is unavailable, a hidden node will take the role of the secondary to ensure high availability. The following figure shows the replica set architecture. - - -.. figure:: /_static/images/en-us_image_0284275085.png - :alt: **Figure 1** Replica set architecture - - **Figure 1** Replica set architecture - -- Supports multiple management and control tasks, such as creating instances, changing configurations, and backing up instances. The system flexibly controls and tracks tasks, and manages exceptions based on the operations delivered by users. -- Collects performance monitoring information about DB instances, including basic metrics, storage space, access requests, and the number of operations. -- Collects slow query logs and access control logs, recording DB instance running status. -- Backs up DB instance data and uploads it to OBS buckets. Currently, DDS supports automated and manual backup. Automated backups are kept for seven days by default. diff --git a/umn/source/introduction/system_architecture/single_node_architecture.rst b/umn/source/introduction/system_architecture/single_node_architecture.rst new file mode 100644 index 0000000..300fb55 --- /dev/null +++ b/umn/source/introduction/system_architecture/single_node_architecture.rst @@ -0,0 +1,20 @@ +:original_name: dds_01_0025.html + +.. _dds_01_0025: + +Single Node Architecture +======================== + +A single node instance, as its name suggests, contains only one node which can be accessed directly. + +As a supplement to the cluster and replica set architectures, the single-node architecture applies to R&D, testing, and non-core data storage of enterprises. While not as robust as replica sets, the single node architecture can be a less expensive way to visualize O&M and provide elastic scaling. + +.. note:: + + A driver handles all interactions between your application and the database in a language appropriate to the application. For details, see `official documents `__. + + +.. figure:: /_static/images/en-us_image_0000001143053863.png + :alt: **Figure 1** Single node architecture + + **Figure 1** Single node architecture diff --git a/umn/source/introduction/typical_application_scenarios.rst b/umn/source/introduction/typical_application_scenarios.rst index 38419bf..1d12114 100644 --- a/umn/source/introduction/typical_application_scenarios.rst +++ b/umn/source/introduction/typical_application_scenarios.rst @@ -5,18 +5,40 @@ Typical Application Scenarios ============================= -- **Mobile Apps and Maps** +Games +----- - DDS supports two-dimensional space indexes for mobile applications (Apps) and maps that have location query requests. In addition, the dynamic storage mode of DDS is suitable for storing heterogeneous data of multiple systems, meeting the requirements of this scenario. +Game players' information generated from game applications, such as players' equipment and bonus points, are stored in DDS databases. During peak hours, DDS cluster instances can handle large amounts of concurrent requests. DDS cluster and replica set provide high availability to ensure the stable running of games in high-concurrency scenarios. -- **IoT** +In addition, DDS is compatible with MongoDB and provides the non-schema mode, which frees you from changing table structure when the game play mode changes. DDS can totally meet the flexible gaming requirements. You can store structured data with fixed patterns in RDS, services with flexible patterns in DDS, and hot data in Distributed Cache Service (DCS) to facilitate access to service data and reduce data storage costs. - Internet of Things (IoT) applications generate terabytes of data and have high requirements on data write performance and low requirements on data read performance. DDS provides high write performance and shard-based DB instances to meet IoT requirements. +Advantages: -- **CMS** +- Supports embedded documents that eliminate the need to use joins to reduce application development complexity. Flexible schemas also facilitate rapid development and iteration. +- Sharded clusters provide enough capacity to store data into the TB range. - Content management system (CMS) has a large amount of data and queries and the data is non-structured and diverse. DDS provides high performance Schema-free, GridFS, and shards to support CMS applications. +IoT +--- -- **Game Industry** +DDS is compatible with MongoDB and provides the high-performance and asynchronous data write function. In certain scenarios, DDS can process data in the memory database. In addition, cluster instances can dynamically add the number of mongos and shard nodes or upgrade specifications. The performance and storage space can be quickly expanded, making cluster instances suitable for IoT scenarios with high concurrent writes. - DDS provides schema-free to meet ever-changing requirements in the gaming industry, shortening R&D periods and reducing R&D costs. +Intelligent IoT terminals need to collect various types of data, store device logs, and analyze information in multiple dimensions. In recent years, IoT services have grown rapidly, with huge volumes of data and increasing access traffic that require horizontal expansion capabilities for data storage. + +DDS provides the secondary index to meet dynamic query requirements and uses the MapReduce aggregation framework that is compatible with MongoDB to analyze data from multiple dimensions. + +Advantages: + +- **High Write Performance**: DDS sharded cluster provides high write performance to meet the requirements of terabyte-scale databases. +- **High Performance and Scalability**: DDS supports applications with high QPS rates, and its sharding architecture can be scaled in or out to flexibly cope with application changes. + +Internet +-------- + +DDS replica set uses the three-node HA architecture. Three data nodes form an anti-affinity group and are deployed on different physical servers to automatically synchronize data. The primary and secondary nodes provide services. Each node has a private IP address and works with Driver to allocate read workloads. + +Many organizations need to process and store data into the TB range, requiring data to be written to databases in real time and dynamic analysis capabilities in big data computing. + +Advantages: + +- **MapReduce:** With a complete data analysis utility, you can query statements or scripts, and distribute requests to DDS. +- **Excellent Scalability**: DDS DB instances can be scaled up to support growing services and data volumes in content management systems. diff --git a/umn/source/introduction/user_permissions.rst b/umn/source/introduction/user_permissions.rst index 174691a..c3e8921 100644 --- a/umn/source/introduction/user_permissions.rst +++ b/umn/source/introduction/user_permissions.rst @@ -5,7 +5,7 @@ User Permissions ================ -DDS provides two types of user permissions by default: user management and resource management. +IAM provides two types of user permissions by default: user management and resource management. - User management refers to the management of users, user groups, and user group rights. - Resource management refers to the control operations that can be performed by users on cloud service resources. diff --git a/umn/source/introduction/what_is_dds.rst b/umn/source/introduction/what_is_dds.rst index b93be38..b28a644 100644 --- a/umn/source/introduction/what_is_dds.rst +++ b/umn/source/introduction/what_is_dds.rst @@ -5,13 +5,13 @@ What Is DDS? ============ -Document Database Service (DDS) is compatible with MongoDB and is secure, highly available, reliable, scalable, and easy to use. It provides DB instance creation, scaling, redundancy, backup, restoration, monitoring, and alarm reporting functions with just a few clicks on the DDS console. +Document Database Service (DDS) is a high availability DBaaS, which provides a secure, reliable and scalable solution, compatible with MongoDB. It provides functions such as one-click deployment, elastic capacity expansion, disaster recovery, backup, restoration, monitoring, and alarm reporting. -DDS has the following characteristics: +DDS has the following features: -- Automatically sets up three-node replica set architecture. DDS supports fast deployment, high availability (HA) data storage, data redundancy, and failover support. -- Provides sharded cluster instances consisting of shard, mongos, and config, enabling you to easily enhance read and write performance and build a distributed DDS database system. -- Provides database backup and restoration functions on the DDS console. -- Provides performance metrics and sets alarms on any of the metrics to send you notification. You can quickly monitor instance status and identify issues at a glance. +- DDS automatically establishes the three-node replica set architecture. It supports fast deployment, high availability (HA) data storage, data redundancy, and failover. +- DDS provides sharded cluster instances comprised of a config node paired with multiple shards and mongos nodes. These clusters can be easily scaled up to enhance read and write performance. +- DDS lets you back up or restore a database from the management console in just a few clicks. +- DDS provides performance metrics and you can configure alarm notifications to make it easier to keep abreast of instance statuses. -For details about the supported DB engines and versions, see :ref:`Database Engine and Version `. +For details about the compatible DB engines and versions, see :ref:`Database Engine and Version `. diff --git a/umn/source/log_management/error_log.rst b/umn/source/log_management/error_log.rst new file mode 100644 index 0000000..7739195 --- /dev/null +++ b/umn/source/log_management/error_log.rst @@ -0,0 +1,24 @@ +:original_name: en-us_topic_error_log.html + +.. _en-us_topic_error_log: + +Error Log +========= + +**Scenarios** +------------- + +DDS log management allows you to view database-level logs, including warning- and error-level logs generated during database running, which help you analyze system problems. + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click the target DB instance. +#. In the navigation pane on the left, click **Error Logs**. +#. On the displayed page, click **Error Logs**. Then, view the log details. + + - For a cluster instance, you can view error logs of the mongos, shard, and config nodes. + - For a replica set instance, you can view the error logs of the primary, secondary, and hidden nodes. + - For a single node instance, you can view error logs of the current node. + - You can view up to 2,000 error logs of a specified node type, at a specified level, and within a specified period. diff --git a/umn/source/monitoring/index.rst b/umn/source/log_management/index.rst similarity index 53% rename from umn/source/monitoring/index.rst rename to umn/source/log_management/index.rst index e598bd6..a75f495 100644 --- a/umn/source/monitoring/index.rst +++ b/umn/source/log_management/index.rst @@ -2,11 +2,9 @@ .. _dds_03_0024: -Monitoring -========== +Log Management +============== -- :ref:`Interconnected with Cloud Eye ` -- :ref:`Interconnecting with CTS ` - :ref:`Error Log ` - :ref:`Slow Query Log ` @@ -14,7 +12,5 @@ Monitoring :maxdepth: 1 :hidden: - interconnected_with_cloud_eye/index - interconnecting_with_cts/index error_log slow_query_log diff --git a/umn/source/log_management/slow_query_log.rst b/umn/source/log_management/slow_query_log.rst new file mode 100644 index 0000000..7ebc374 --- /dev/null +++ b/umn/source/log_management/slow_query_log.rst @@ -0,0 +1,37 @@ +:original_name: en-us_topic_slow_query_log.html + +.. _en-us_topic_slow_query_log: + +Slow Query Log +============== + +**Scenarios** +------------- + +Slow query logs record statements whose execution period exceeds the value of **operationProfiling.slowOpThresholdMs** (100 ms by default). With slow query logs, you can identify and optimize slowly executed statements. + +.. note:: + + If the user would like to change this, they can do this in Section :ref:`Modifying a Parameter Template `. + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click the target DB instance. +#. In the navigation pane on the left, click **Slow Query Logs**. +#. On the **Slow Query Logs** page, set search criteria and click **Search** to view log information. + + - Log records of all shards or a shard-specific node of a cluster instance + - Log records of all nodes of a replica set instance + - Slow query statements of the following level + + - All statements + - INSERT + - QUERY + - UPDATE + - REMOVE + - GETMORE + - COMMAND + + - You can view up to 2,000 slow query logs of a specified node type, of a specified statement type, and within a specified period. diff --git a/umn/source/logging_in_to_the_dds_console.rst b/umn/source/logging_in_to_the_dds_console.rst index 2017646..10e9700 100644 --- a/umn/source/logging_in_to_the_dds_console.rst +++ b/umn/source/logging_in_to_the_dds_console.rst @@ -2,7 +2,7 @@ .. _dds_02_0043: -Logging In to the DDS Console +Logging in to the DDS Console ============================= **Prerequisites** @@ -10,7 +10,7 @@ Logging In to the DDS Console You have registered an account. -For the first time you use DDS, register an account at the official website. After the registration, your account has permissions to access the DDS service, as well as all other cloud services. +For the first time you use DDS, apply for an account at the official website. After the application is successful, your account has permissions to access the DDS service, as well as all other cloud services. Procedure --------- @@ -19,4 +19,4 @@ Procedure #. Click |image1| in the upper left corner and select a region and a project. #. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. -.. |image1| image:: /_static/images/en-us_image_0284275118.png +.. |image1| image:: /_static/images/en-us_image_0000001096133926.png diff --git a/umn/source/managing_dds_db_instances/backup_and_restore/restoring_a_cluster_instance_from_a_backup.rst b/umn/source/managing_dds_db_instances/backup_and_restore/restoring_a_cluster_instance_from_a_backup.rst deleted file mode 100644 index 5838697..0000000 --- a/umn/source/managing_dds_db_instances/backup_and_restore/restoring_a_cluster_instance_from_a_backup.rst +++ /dev/null @@ -1,44 +0,0 @@ -:original_name: dds_03_0042.html - -.. _dds_03_0042: - -Restoring a Cluster Instance from a Backup -========================================== - -**Scenarios** -------------- - -This section guides you on how to restore a DB instance from a backup. - -.. note:: - - Currently, DDS only supports restoring backups to a new DB instance. - -Method 1 --------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click the target cluster instance. -#. In the navigation pane on the left, click **Backups & Restorations**. -#. On the **Backups & Restorations** page, locate the target backup in the backup list and click **Restore** in the **Operation** column. In the displayed dialog box, click **OK**. -#. On the displayed page, create a DB instance using the same configurations as the backup. The new DB instance is independent from the original one. - - - You are recommended to deploy the restored DB instance in a different AZ to ensure that applications will not be adversely affected by the failure in any single AZ, improving data reliability. - - The database type, DB instance type, compatible MongoDB version, storage engine, storage type, and shard quantity must be the same as those of the original and cannot be changed. - - The quantity of mongos is 2 by default and ranges from 2 to 16. You can specify the quantity. - - The storage space is the same as that of the original instance by default. You can only increase the storage space. - - Other settings are the same as those of the original DB instance by default and can be modified. For details, see section :ref:`Creating a Cluster Instance `. - -Method 2 --------- - -#. :ref:`Log in to the DDS console. ` -#. In the navigation pane on the left, click **Backup Management**. -#. On the **Backup Management** page, locate the backup to restore on the **Clusters** tab and click **Restore** in the **Operation** column. In the displayed dialog box, click **OK**. -#. On the displayed page, create a DB instance using the same configurations as the backup. The new DB instance is independent from the original one. - - - You are recommended to deploy the restored DB instance in a different AZ to ensure that applications will not be adversely affected by the failure in any single AZ, improving data reliability. - - The database type, DB instance type, compatible MongoDB version, storage engine, storage type, and shard quantity must be the same as those of the original and cannot be changed. - - The quantity of mongos is 2 by default and ranges from 2 to 16. You can specify the quantity. - - The storage space is the same as that of the original instance by default. You can only increase the storage space. - - Other settings are the same as those of the original DB instance by default and can be modified. For details, see section :ref:`Creating a Cluster Instance `. diff --git a/umn/source/managing_dds_db_instances/backup_and_restore/restoring_a_replica_set_instance_from_a_backup.rst b/umn/source/managing_dds_db_instances/backup_and_restore/restoring_a_replica_set_instance_from_a_backup.rst deleted file mode 100644 index 9ba0d76..0000000 --- a/umn/source/managing_dds_db_instances/backup_and_restore/restoring_a_replica_set_instance_from_a_backup.rst +++ /dev/null @@ -1,42 +0,0 @@ -:original_name: dds_03_0043.html - -.. _dds_03_0043: - -Restoring a Replica Set Instance from a Backup -============================================== - -**Scenarios** -------------- - -This section guides you on how to restore a replica set instance from a backup. - -.. note:: - - Currently, DDS only supports restoring backups to a new DB instance. - -Method 1 --------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click the target replica set instance. -#. In the navigation pane on the left, click **Backups & Restorations**. -#. On the **Backups & Restorations** page, locate the target backup in the backup list and click **Restore** in the **Operation** column. In the displayed dialog box, click **OK**. -#. On the displayed page, create a DB instance using the same configurations as the backup. The new DB instance is independent from the original one. - - - You are recommended to deploy the restored DB instance in a different AZ to ensure that applications will not be adversely affected by the failure in any single AZ, improving data reliability. - - The database type, DB instance type, compatible MongoDB version, storage engine, and storage type must be the same as those of the original and cannot be changed. - - The storage space is the same as that of the original instance by default. You can only increase the storage space. - - Other settings are the same as those of the original DB instance by default and can be modified. For details, see section :ref:`Creating a Replica Set Instance `. - -Method 2 --------- - -#. :ref:`Log in to the DDS console. ` -#. In the navigation pane on the left, click **Backup Management**. -#. On the **Backup Management** page, click the **Replica Sets** tab, locate the backup to restore, and click **Restore** in the **Operation** column. In the displayed dialog box, click **OK**. -#. On the displayed page, create a DB instance using the same configurations as the backup. The new DB instance is independent from the original one. - - - You are recommended to deploy the restored DB instance in a different AZ to ensure that applications will not be adversely affected by the failure in any single AZ, improving data reliability. - - The database type, DB instance type, compatible MongoDB version, storage engine, and storage type must be the same as those of the original and cannot be changed. - - The storage space is the same as that of the original instance by default. You can only increase the storage space. - - Other settings are the same as those of the original DB instance by default and can be modified. For details, see section :ref:`Creating a Replica Set Instance `. diff --git a/umn/source/managing_dds_db_instances/changing_db_instance_classes/changing_the_cpu_or_memory_of_a_replica_set_db_instance.rst b/umn/source/managing_dds_db_instances/changing_db_instance_classes/changing_the_cpu_or_memory_of_a_replica_set_db_instance.rst deleted file mode 100644 index beec0f5..0000000 --- a/umn/source/managing_dds_db_instances/changing_db_instance_classes/changing_the_cpu_or_memory_of_a_replica_set_db_instance.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: en-us_topic_0104721795.html - -.. _en-us_topic_0104721795: - -Changing the CPU or Memory of a Replica Set DB Instance -======================================================= - -**Scenarios** -------------- - -This section guides you on how to change the CPU or memory of your replica set instance. - -.. note:: - - - A DB instance cannot be deleted when you are changing its CPU or memory. - - Instances can be both scaled up and down. - - Services will be interrupted for 5 to 10 minutes when you change DB instance CPU and memory. You are advised to perform this operation during off-peak hours. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, locate the target replica set instance and choose **Change Instance Class** in the **Operation** column. -#. On the displayed page, modify required parameters and click **Submit**. -#. View the DB instance CPU or memory modification result. - - - When the CPU or memory of a DB instance is being changed, the status displayed in the **Status** column is **Changing instance class**. This process takes about 25 to 30 minutes. - - In the upper right corner of the DB instance list, click |image1| to refresh the list. The instance status changes to **Available**. - - Go to the **Basic Information** page of the replica set instance you scaled up and check whether the scaling up is successful in the **DB Information** area. - -.. |image1| image:: /_static/images/en-us_image_0284275046.png diff --git a/umn/source/managing_dds_db_instances/changing_db_instance_classes/index.rst b/umn/source/managing_dds_db_instances/changing_db_instance_classes/index.rst deleted file mode 100644 index b32f4e1..0000000 --- a/umn/source/managing_dds_db_instances/changing_db_instance_classes/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: dds_08_0001.html - -.. _dds_08_0001: - -Changing DB Instance Classes -============================ - -- :ref:`Changing the CPU or Memory of a Cluster DB Instance ` -- :ref:`Changing the CPU or Memory of a Replica Set DB Instance ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - changing_the_cpu_or_memory_of_a_cluster_db_instance - changing_the_cpu_or_memory_of_a_replica_set_db_instance diff --git a/umn/source/managing_dds_db_instances/db_instance_operations/exporting_db_instance_information.rst b/umn/source/managing_dds_db_instances/db_instance_operations/exporting_db_instance_information.rst deleted file mode 100644 index dd6f198..0000000 --- a/umn/source/managing_dds_db_instances/db_instance_operations/exporting_db_instance_information.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: dds_03_0051.html - -.. _dds_03_0051: - -Exporting DB Instance Information -================================= - -**Scenarios** -------------- - -This section guides you on how to export DB instance information for analysis. - - -Exporting DB Instance Information ---------------------------------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click |image1| in the upper right corner of the instance list. -#. In the pop-up box, select the desired items and click **OK**. -#. View the .xls file exported to your local PC. - -Export the specified instance on the current page. --------------------------------------------------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click |image2| in the upper right corner of the instance list. -#. In the pop-up box, select the desired items and click **OK**. -#. View the .xls file exported to your local PC. - -.. |image1| image:: /_static/images/en-us_image_0284275079.png -.. |image2| image:: /_static/images/en-us_image_0284275307.png diff --git a/umn/source/managing_dds_db_instances/db_instance_operations/index.rst b/umn/source/managing_dds_db_instances/db_instance_operations/index.rst deleted file mode 100644 index 007d8c1..0000000 --- a/umn/source/managing_dds_db_instances/db_instance_operations/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -:original_name: dds_03_0002.html - -.. _dds_03_0002: - -DB Instance Operations -====================== - -- :ref:`Modifying the DB Instance Name ` -- :ref:`Exporting DB Instance Information ` -- :ref:`Manually Switching the Primary and Secondary Nodes of a Replica Set ` -- :ref:`Restarting a DB Instance or a Node ` -- :ref:`Deleting a DB instance ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - modifying_the_db_instance_name - exporting_db_instance_information - manually_switching_the_primary_and_secondary_nodes_of_a_replica_set - restarting_a_db_instance_or_a_node - deleting_a_db_instance diff --git a/umn/source/managing_dds_db_instances/db_instance_operations/modifying_the_db_instance_name.rst b/umn/source/managing_dds_db_instances/db_instance_operations/modifying_the_db_instance_name.rst deleted file mode 100644 index e88eac2..0000000 --- a/umn/source/managing_dds_db_instances/db_instance_operations/modifying_the_db_instance_name.rst +++ /dev/null @@ -1,39 +0,0 @@ -:original_name: dds_03_0075.html - -.. _dds_03_0075: - -Modifying the DB Instance Name -============================== - -**Scenarios** -------------- - -This section guides you on how to modify the DB instance name to identify different DB instances. - -Method 1 --------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click |image1| next to the specified DB instance name. - - - If you want to submit the change, click **OK**. The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). - - If you want to cancel the change, click **Cancel**. - -#. View the change result on the **Instance Management** page. - -Method 2 --------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click the target DB instance. -#. In the **DB Information** area on the **Basic Information** page, click |image2| in the **DB Instance Name** field to change the instance name. - - - If you want to submit the change, click |image3|. The DB instance name can be 4 to 64 characters long. It must start with a letter and can contain only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). - - If you want to cancel the change, click |image4|. - -#. View the modification result. - -.. |image1| image:: /_static/images/en-us_image_0284275220.png -.. |image2| image:: /_static/images/en-us_image_0284275009.png -.. |image3| image:: /_static/images/en-us_image_0284275286.png -.. |image4| image:: /_static/images/en-us_image_0284274981.png diff --git a/umn/source/managing_dds_db_instances/index.rst b/umn/source/managing_dds_db_instances/index.rst deleted file mode 100644 index 1c3663f..0000000 --- a/umn/source/managing_dds_db_instances/index.rst +++ /dev/null @@ -1,32 +0,0 @@ -:original_name: dds_03_0001.html - -.. _dds_03_0001: - -Managing DDS DB Instances -========================= - -- :ref:`DB Instance Operations ` -- :ref:`Managing Database Accounts ` -- :ref:`Migrating Data ` -- :ref:`Backup and Restore ` -- :ref:`Parameter Group ` -- :ref:`Storage ` -- :ref:`Changing DB Instance Classes ` -- :ref:`Security ` -- :ref:`Tag ` -- :ref:`Task Center ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - db_instance_operations/index - managing_database_accounts - migrating_data - backup_and_restore/index - parameter_group/index - storage/index - changing_db_instance_classes/index - security/index - tag - task_center diff --git a/umn/source/managing_dds_db_instances/managing_database_accounts.rst b/umn/source/managing_dds_db_instances/managing_database_accounts.rst deleted file mode 100644 index 31891c5..0000000 --- a/umn/source/managing_dds_db_instances/managing_database_accounts.rst +++ /dev/null @@ -1,105 +0,0 @@ -:original_name: dds_03_0057.html - -.. _dds_03_0057: - -Managing Database Accounts -========================== - -Scenarios ---------- - -This section guides you through how to create a database account and change the account password to manage the instances you created. - -.. note:: - - When creating a database account for a specified DB instance, you are advised to enable the SSL connection to improve data security. - -**Prerequisites** ------------------ - -A DDS DB instance has been connected. - -- For details on how to connect to a cluster instance, see :ref:`Connecting to a DB Instance Through a Client `. -- For details on how to connect to a replica set instance, see :ref:`Connecting to a DB Instance Through a Client `. - -Account Description -------------------- - -To provide management services for DDS DB instances, users **root**, **monitor**, and **backup** are created when you create a DDS DB instance. Attempting to delete, rename, change the passwords, or change privileges for these accounts will result in errors. - -You can change the password of the database administrator **rwuser** and any accounts you create. - -Setting Password Strength for Database Accounts ------------------------------------------------ - -- The administrator password must meet the following password policy: - - - 8 to 32 characters in length - - A combination of uppercase letters, lowercase letters, digits, and special characters: ``~!@#%^*-_=+?`` - -- The DDS instance database uses comprehensive password security policies. The password of a DDS instance database account must meet the following conditions: - - - 8 to 32 characters in length - - A combination of uppercase letters, lowercase letters, digits, and special characters: ``~!@#%^*-_=+?`` - -When you create a DB instance, the system automatically checks your password strength. You can change the password as user **rwuser**. For security reasons, you are advised to set up a strong password. - -Creating an Account -------------------- - -#. Run the following command to select the admin database: - - **use admin** - -#. Run the following command to create a database account (**user1** as an example): - - **db.createUser({user: "user1", pwd: "**\ *Test_12345*\ **", passwordDigestor:"server", roles:[{role: "root", db: "admin"}]})** - - - **server**: indicates that the password is encrypted on the server. - - **Test_12345**: indicates the example new password. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and special characters, such as ``~@#%-_!*+=^?`` - - **roles** restricts the rights of the account. If an empty array is specified, the account does not have any permission. - -#. Check the result: - - The account is successfully created if the following information is displayed: - - .. code-block:: - - Successfully added user: { - "user" : "user1", - "passwordDigestor" : "server", - "roles" : [ - { - "role" : "root", - "db" : "admin" - } - ] - } - -Changing a Password -------------------- - -#. Run the following command to select the admin database: - - **use admin** - -#. Uses user **user1** as an example. Run the following command to change its password: - - **db.updateUser("user1", {passwordDigestor:"server",pwd:"newPasswd12#"})** - - - **server**: indicates that the password is encrypted on the server. - - **newPasswd12#**: indicates the example new password. The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and special characters, such as ``~@#%-_!*+=^?`` - -#. Check the setting result. The password is successfully changed if the following information is displayed: - - - Cluster - - .. code-block:: - - mongos> - - - Replica set - - .. code-block:: - - replica:PRIMARY> diff --git a/umn/source/managing_dds_db_instances/parameter_group/changing_a_parameter_group_description.rst b/umn/source/managing_dds_db_instances/parameter_group/changing_a_parameter_group_description.rst deleted file mode 100644 index 2e35cd7..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/changing_a_parameter_group_description.rst +++ /dev/null @@ -1,25 +0,0 @@ -:original_name: dds_03_0044.html - -.. _dds_03_0044: - -Changing a Parameter Group Description -====================================== - -.. note:: - - The description of a default parameter group cannot be modified. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` -#. In the navigation pane on the left, click **Parameter Group Management**. -#. On the **Parameter Group Management** page, select the **Clusters** or **Replica Sets** tab, locate the parameter group you created and click |image1| in the **Description** column. -#. Enter new description information. The parameter group description contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= - - - If you want to submit the change, click |image2|. After the modification is successful, you can view the new description in the **Description** column of the parameter group list. - - If you want to cancel the change, click |image3|. - -.. |image1| image:: /_static/images/en-us_image_0284274989.png -.. |image2| image:: /_static/images/en-us_image_0284275120.png -.. |image3| image:: /_static/images/en-us_image_0284275038.png diff --git a/umn/source/managing_dds_db_instances/parameter_group/changing_associated_parameter_group.rst b/umn/source/managing_dds_db_instances/parameter_group/changing_associated_parameter_group.rst deleted file mode 100644 index aa84e39..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/changing_associated_parameter_group.rst +++ /dev/null @@ -1,40 +0,0 @@ -:original_name: dds_03_0014.html - -.. _dds_03_0014: - -Changing Associated Parameter Group -=================================== - -**Scenarios** -------------- - -After a DB instance is created, you can change the parameter group associated with the DB instance to achieve optimal performance. The parameter group associated with the DB instance cannot be changed in any of the following cases: - -- A DB instance is being restarted. -- A backup file is being created. -- Cluster instance nodes are being added. -- The storage space is being expanded. -- The instance class is being changed. -- An SSL connection is being enabled or disabled. -- The port is being changed. - -Cluster -------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click the target cluster instance. -#. In the **Node Information** area on the **Basic Information** page, click **mongos**, **shard**, or **config**, locate the target node, and click **Change Parameter Group**. -#. On the displayed dialog box, select the parameter group to be modified and click **OK**. - - - If the static parameter value is changed in the new parameter group, restart the instance for the modification to take effect. - - If no parameter groups are available for **New Parameter Group**, create a parameter group. For details, see section :ref:`Creating a Parameter Group `. - -Replica Set ------------ - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, locate the target replica set instance, and choose **More** > **Change Parameter Group** in the **Operation** column. -#. On the displayed dialog box, select the parameter group to be modified and click **OK**. - - - If the static parameter value is changed in the new parameter group, restart the instance for the modification to take effect. - - If no parameter groups are available for **New Parameter Group**, create a parameter group. For details, see section :ref:`Creating a Parameter Group `. diff --git a/umn/source/managing_dds_db_instances/parameter_group/comparing_two_parameter_groups.rst b/umn/source/managing_dds_db_instances/parameter_group/comparing_two_parameter_groups.rst deleted file mode 100644 index 2036656..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/comparing_two_parameter_groups.rst +++ /dev/null @@ -1,24 +0,0 @@ -:original_name: dds_03_0012.html - -.. _dds_03_0012: - -Comparing Two Parameter Groups -============================== - -**Scenarios** -------------- - -This section guides you on how to compare two parameter groups of the same node type and DB engine version to know their current settings. - -**Procedure** -------------- - -#. :ref:`Log in to the DDS console. ` - -#. In the navigation pane on the left, click **Parameter Group Management**. - -#. On the **Parameter Group Management** page, select the **Clusters** or **Replica Sets** tab and locate the parameter group you created and click **Compare** in the **Operation** column. - -#. In the displayed **Compare Parameter Group** dialog box, select a parameter group for **Group2** and click **OK**. - - If the settings of the two parameter groups are different, the parameter names and values of group 1 and group 2 parameter groups are displayed. If the settings are the same, no data is displayed. diff --git a/umn/source/managing_dds_db_instances/parameter_group/creating_a_parameter_group.rst b/umn/source/managing_dds_db_instances/parameter_group/creating_a_parameter_group.rst deleted file mode 100644 index 9075040..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/creating_a_parameter_group.rst +++ /dev/null @@ -1,43 +0,0 @@ -:original_name: en-us_topic_parameter_group.html - -.. _en-us_topic_parameter_group: - -Creating a Parameter Group -========================== - -**Scenarios** -------------- - -DB parameter groups act as a container for engine configuration values that are applied to one or more DB instances. This section guides you on how to create a parameter group to manage your DB instance configurations. - -.. note:: - - - DDS does not share parameter group quotas with RDS. - - Each account can create up to 100 DDS parameter groups for the cluster and replica set instances to share. - -Cluster -------- - -#. :ref:`Log in to the DDS console. ` -#. In the navigation pane on the left, click **Parameter Group Management**. -#. On the **Parameter Group Management** page, click **Create Parameter Group**. -#. Select a DB engine version from the **DB Engine Version** drop-down list, **Cluster** for **DB Instance Type**, specify **Node Type**, **Parameter Group Name**, and **Description**, and then click **OK**. - - - **Node Type**: specifies the node type that this parameter group will apply to. For example, to create a parameter group applying to config, select **config**. - - **Parameter Group Name**: specifies the parameter group name, which is a string of 1 to 64 characters composed of only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.). - - **Description**: contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= - -#. On the **Parameter Group Management** page, view and manage parameter groups on the **Clusters** tab. - -Replica Set ------------ - -#. :ref:`Log in to the DDS console. ` -#. In the navigation pane on the left, click **Parameter Group Management**. -#. On the **Parameter Group Management** page, click **Create Parameter Group**. -#. Select a DB engine version from the **DB Engine Version** drop-down list, **Replica set** for **DB Instance Type**, specify **Parameter Group Name** and **Description**, and then click **OK**. - - - **Parameter Group Name**: specifies the parameter group name, which is a string of 1 to 64 characters composed of only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.). - - **Description**: contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= - -#. On the **Parameter Group Management** page, view and manage parameter groups on the **Replica Sets** tab. diff --git a/umn/source/managing_dds_db_instances/parameter_group/deleting_a_parameter_group.rst b/umn/source/managing_dds_db_instances/parameter_group/deleting_a_parameter_group.rst deleted file mode 100644 index 7e6337f..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/deleting_a_parameter_group.rst +++ /dev/null @@ -1,26 +0,0 @@ -:original_name: dds_03_0016.html - -.. _dds_03_0016: - -Deleting a Parameter Group -========================== - -**Scenarios** -------------- - -This section guides you on how to delete a parameter group. The following parameter groups cannot be deleted. - -- Default parameter groups -- Parameter groups associated with DB instances - -.. important:: - - Deleted parameter groups cannot be restored. Exercise caution when performing this operation. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` -#. In the navigation pane on the left, click **Parameter Group Management**. -#. On the **Parameter Group Management** page, select the **Clusters** or **Replica Sets** tab, locate the parameter group you want to delete and choose **More** > **Delete** in the **Operation** column. -#. In the displayed dialog box, click **Yes**. diff --git a/umn/source/managing_dds_db_instances/parameter_group/editing_a_parameter_group.rst b/umn/source/managing_dds_db_instances/parameter_group/editing_a_parameter_group.rst deleted file mode 100644 index 1c6ddd0..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/editing_a_parameter_group.rst +++ /dev/null @@ -1,43 +0,0 @@ -:original_name: en-us_topic_configuration.html - -.. _en-us_topic_configuration: - -Editing a Parameter Group -========================= - -**Scenarios** -------------- - -This section guides you on how to edit parameters in the parameter groups that you have created to meet your service requirements and achieve optimal performance. - -.. note:: - - Default parameter groups are unchangeable. You can only view them by clicking their names. If inappropriate settings of user-created parameter groups lead to a database reboot failure, you can refer to the settings of the default parameter groups to reset them. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` - -#. In the navigation pane on the left, click **Parameter Group Management**. - -#. On the **Parameter Group Management** page, select the **Clusters** or **Replica Sets** tab and click the parameter group you created. - -#. Modify the required parameters. - - Related parameters are described as follows: - - - For details on parameter descriptions, visit `MongoDB official website `__. - - The default value of the **net.maxIncomingConnections** parameter varies according to DB instance specifications. Therefore, this parameter is set to **default** before being specified. - - Possible operations are as follows: - - - If you want to save the modifications, click **Save**. - - If you want to cancel the modifications, click **Cancel**. - - If you want to preview the modifications, click **Preview**. - - .. note:: - - For details on the description of parameter group status, see section :ref:`Database Status `. - - After modifying a parameter, you need to view the associated instance status in the instance list. If **Pending restart** is displayed, you need to restart the instance for the modification to take effect. diff --git a/umn/source/managing_dds_db_instances/parameter_group/index.rst b/umn/source/managing_dds_db_instances/parameter_group/index.rst deleted file mode 100644 index 23a9460..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -:original_name: dds_03_0010.html - -.. _dds_03_0010: - -Parameter Group -=============== - -- :ref:`Creating a Parameter Group ` -- :ref:`Editing a Parameter Group ` -- :ref:`Comparing Two Parameter Groups ` -- :ref:`Replicating a Parameter Group ` -- :ref:`Changing Associated Parameter Group ` -- :ref:`Resetting a Parameter Group ` -- :ref:`Changing a Parameter Group Description ` -- :ref:`Deleting a Parameter Group ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - creating_a_parameter_group - editing_a_parameter_group - comparing_two_parameter_groups - replicating_a_parameter_group - changing_associated_parameter_group - resetting_a_parameter_group - changing_a_parameter_group_description - deleting_a_parameter_group diff --git a/umn/source/managing_dds_db_instances/parameter_group/replicating_a_parameter_group.rst b/umn/source/managing_dds_db_instances/parameter_group/replicating_a_parameter_group.rst deleted file mode 100644 index bf18430..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/replicating_a_parameter_group.rst +++ /dev/null @@ -1,24 +0,0 @@ -:original_name: dds_03_0013.html - -.. _dds_03_0013: - -Replicating a Parameter Group -============================= - -**Scenarios** -------------- - -This section guides you on how to replicate a parameter group you created and assign it a name different from that of original group. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` -#. In the navigation pane on the left, click **Parameter Group Management**. -#. On the **Parameter Group Management** page, select the **Clusters** or **Replica Sets** tab, locate the parameter group you want to replicate and click **Replicate** in the **Operation** column. -#. Enter the new parameter group name and description and click **OK**. - - - **Parameter Group Name**: specifies the parameter group name, which is a string of 1 to 64 characters composed of only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.). - - **Description**: contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= - -#. After the creation is complete, you can manage the parameter group in the parameter group list on the corresponding tab. diff --git a/umn/source/managing_dds_db_instances/parameter_group/resetting_a_parameter_group.rst b/umn/source/managing_dds_db_instances/parameter_group/resetting_a_parameter_group.rst deleted file mode 100644 index 00efe08..0000000 --- a/umn/source/managing_dds_db_instances/parameter_group/resetting_a_parameter_group.rst +++ /dev/null @@ -1,23 +0,0 @@ -:original_name: dds_03_0015.html - -.. _dds_03_0015: - -Resetting a Parameter Group -=========================== - -**Scenarios** -------------- - -This section guides you on how to reset all parameters in a parameter group you create to the default settings as needed. - -.. important:: - - Resetting the parameter group will restore the default values. Exercise caution when performing this operation. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` -#. In the navigation pane on the left, click **Parameter Group Management**. -#. On the **Parameter Group Management** page, select the **Clusters** or **Replica Sets** tab, locate the parameter group you want to reset and choose **More** > **Reset** in the **Operation** column. -#. In the displayed dialog box, click **Yes**. diff --git a/umn/source/managing_dds_db_instances/security/changing_a_security_group.rst b/umn/source/managing_dds_db_instances/security/changing_a_security_group.rst deleted file mode 100644 index 79a127b..0000000 --- a/umn/source/managing_dds_db_instances/security/changing_a_security_group.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: en-us_topic_change_security_group.html - -.. _en-us_topic_change_security_group: - -Changing a Security Group -========================= - -**Scenarios** -------------- - -This section guides you on how to change the security group of a DB instance. If any of the following operations is in progress, do not change the security group: - -- Adding nodes -- Migrating data - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click the target DB instance. -#. In the navigation pane on the left, choose **Connections**. -#. In the **Security Group** area, click |image1| to select the security group to which the DB instance belongs. - - - If you want to submit the change, click |image2|. This process takes about 1 to 3 minutes. - - If you want to cancel the change, click |image3|. - -#. View the modification result. - -.. |image1| image:: /_static/images/en-us_image_0284275300.png -.. |image2| image:: /_static/images/en-us_image_0284275122.png -.. |image3| image:: /_static/images/en-us_image_0284275119.png diff --git a/umn/source/managing_dds_db_instances/security/changing_the_database_port.rst b/umn/source/managing_dds_db_instances/security/changing_the_database_port.rst deleted file mode 100644 index bf0bd95..0000000 --- a/umn/source/managing_dds_db_instances/security/changing_the_database_port.rst +++ /dev/null @@ -1,39 +0,0 @@ -:original_name: en-us_topic_change_database_port.html - -.. _en-us_topic_change_database_port: - -Changing the Database Port -========================== - -**Scenarios** -------------- - -This section guides you on how to modify the database port to ensure system security. The database port cannot be changed when the instance is in any of the following statuses: - -- Restarting -- Adding nodes -- Switching SSL -- Changing instance class -- Deleting node - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` - -#. On the **Instance Management** page, click the target DB instance. - -#. In the navigation pane on the left, choose **Connections**. - -#. In the **Basic Information** area, click |image1| to right of the **Database Port** field to modify the database port. - - The database port range is 2100 to 9500. - - - If you want to submit the change, click |image2|. This process takes about 1 to 5 minutes. - - If you want to cancel the change, click |image3|. - -#. View the modification result. - -.. |image1| image:: /_static/images/en-us_image_0284275296.png -.. |image2| image:: /_static/images/en-us_image_0284274943.png -.. |image3| image:: /_static/images/en-us_image_0284275268.png diff --git a/umn/source/managing_dds_db_instances/security/index.rst b/umn/source/managing_dds_db_instances/security/index.rst deleted file mode 100644 index 59a0834..0000000 --- a/umn/source/managing_dds_db_instances/security/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -:original_name: dds_03_0019.html - -.. _dds_03_0019: - -Security -======== - -- :ref:`Resetting the Administrator Password ` -- :ref:`Changing the Database Port ` -- :ref:`Changing a Security Group ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - resetting_the_administrator_password - changing_the_database_port - changing_a_security_group diff --git a/umn/source/managing_dds_db_instances/storage/index.rst b/umn/source/managing_dds_db_instances/storage/index.rst deleted file mode 100644 index 5077a7f..0000000 --- a/umn/source/managing_dds_db_instances/storage/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -:original_name: dds_03_0017.html - -.. _dds_03_0017: - -Storage -======= - -- :ref:`Adding Cluster Instance Nodes ` -- :ref:`Reverting Cluster Instance Nodes ` -- :ref:`Scaling Up Storage Space ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - adding_cluster_instance_nodes - reverting_cluster_instance_nodes - scaling_up_storage_space diff --git a/umn/source/managing_dds_db_instances/storage/scaling_up_storage_space.rst b/umn/source/managing_dds_db_instances/storage/scaling_up_storage_space.rst deleted file mode 100644 index 9169ca8..0000000 --- a/umn/source/managing_dds_db_instances/storage/scaling_up_storage_space.rst +++ /dev/null @@ -1,58 +0,0 @@ -:original_name: en-us_topic_increase_storage.html - -.. _en-us_topic_increase_storage: - -Scaling Up Storage Space -======================== - -**Scenarios** -------------- - -This section guides you on how to scale up the storage space of a DB instance to suit your service requirements. - -.. note:: - - - You can scale up a DB instance a maximum of eight times. - - You cannot scale up a DB instance in **Creating**, **Changing instance class**, **Adding node**, or **Deleting node** status. - - You cannot scale down storage space. - - If you scale up a DB instance with disks encrypted, the expanded storage space will be encrypted using the original encryption key. - - You cannot scale up the storage space of a config for the cluster instances. - -Cluster -------- - -#. :ref:`Log in to the DDS console. ` - -#. On the **Instance Management** page, click the target cluster instance. - -#. In the **Node Information** area on the **Basic Information** page, click the **shard** tab, locate the target shard, and click **Scale Storage Space** in the **Operation** column. - -#. On the displayed page, specify the desired storage space, and click **Submit**. - - You must add a minimum of 10 GB each time you scale up, and only multiples of 10 GB are allowed. The maximum amount of storage space is 1,000 GB. - -#. Check the scaling-up result. - - - This process takes about 3 to 5 minutes. The status of the DB instance in the instance list is **Scaling up**. - - In the upper right corner of the DB instance list, click |image1| to refresh the list. The instance status changes to **Available**. - - In the **Node Information** area on the **Basic Information** page, click the **shard** tab and check whether the scaling up is successful. - -Replica Set ------------ - -#. :ref:`Log in to the DDS console. ` - -#. On the **Instance Management** page, locate the target replica set instance and click **Scale Storage Space** in the **Operation** column. - -#. On the displayed page, specify the desired storage space, and click **Submit**. - - You must add a minimum of 10 GB each time you scale up, and only multiples of 10 GB are allowed. The maximum amount of storage space is 2,000 GB. - -#. Check the scaling-up result. - - - This process takes about 3 to 5 minutes. The status of the DB instance in the instance list is **Scaling up**. - - In the upper right corner of the DB instance list, click |image2| to refresh the list. The instance status changes to **Available**. - - In the **Storage Space** area on the **Basic Information** page, check whether the scaling up is successful. - -.. |image1| image:: /_static/images/en-us_image_0284275046.png -.. |image2| image:: /_static/images/en-us_image_0284275173.png diff --git a/umn/source/managing_dds_db_instances/task_center.rst b/umn/source/managing_dds_db_instances/task_center.rst deleted file mode 100644 index 9bd5049..0000000 --- a/umn/source/managing_dds_db_instances/task_center.rst +++ /dev/null @@ -1,37 +0,0 @@ -:original_name: dds_03_0040.html - -.. _dds_03_0040: - -Task Center -=========== - -**Scenarios** -------------- - -This section describes how to view the progress and result of asynchronous tasks on the **Task Center** page. - -Currently, only the following tasks can be viewed: - -- Creating a cluster instance -- Creating a replica set instance -- Scaling up the storage space for a shard node of a cluster instance -- Scaling up the storage space of a replica set instance - -.. note:: - - Tasks that fail to be executed will be retained for seven days by default. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` - -#. In the navigation pane on the left, click **Task Center**. - -#. On the **Task Center** page, locate the target task and click |image1| to expand its details. - - To identify the target task, you can use the task name and DB instance name/ID or select task status or types in the drop-down list in the upper right corner. - -#. View the execution progress and result of the task. - -.. |image1| image:: /_static/images/en-us_image_0284274979.png diff --git a/umn/source/managing_dds_db_instances/migrating_data.rst b/umn/source/migrating_data.rst similarity index 62% rename from umn/source/managing_dds_db_instances/migrating_data.rst rename to umn/source/migrating_data.rst index 81b2bc6..93e6890 100644 --- a/umn/source/managing_dds_db_instances/migrating_data.rst +++ b/umn/source/migrating_data.rst @@ -8,22 +8,25 @@ Migrating Data **Scenarios** ------------- -DDS supports access through EIPs by enabling public accessibility. You can also access a database through an ECS in the private network. +DDS is accessible through an EIP in a public network or an ECS in a private network. -Before migrating data from a MongoDB database to DDS, transfer data to a .json file using the mongoexport tool. This section guides you on how to import the data from the JSON files to DDS using the mongoimport tool on the ECS or the device that can access DDS. +MongoDB can export data from a database into a JSON file. Such a JSON file can then be used to import the data to MongoDB databases. This section describes how to import the data from the JSON files to DDS using the mongoimport tool on the ECS or from some other devices that can access DDS. -**Preparations** ----------------- +**Prerequisites** +----------------- #. An ECS or a device that can access DDS is ready for use. - - To connect to a DDS DB instance from an ECS, you need to create and log in to the ECS. For details, see :ref:`How Can I Create and Log In to an ECS? ` - - To bind an EIP to a DB instance: + - To connect your DDS DB instance through a private network: - a. Bind an EIP to a node in the DB instance. For details about how to bind an EIP to a node, see "Binding and Unbinding an EIP" in section "Cluster" or "Replica Set". + Create and log in to an ECS. For details, see "Creating and Logging In to a Windows ECS" or "Creating and Logging In to a Linux ECS" in the *Elastic Cloud Server User Guide*. + + - To connect to your DDS DB instance through an EIP: + + a. Bind an EIP to a node in the DB instance. For details about how to bind an EIP to a node, see "Binding an EIP" in the *Document Database Service Getting Started*. b. Ensure that your local device can access the EIP that has been bound to the DB instance. -#. A migration tool has been installed on the prepared ECS or the device. +#. A migration tool has been installed on the prepared ECS. For details on how to install the migration tool, see :ref:`How Can I Install a MongoDB Client? ` @@ -31,16 +34,16 @@ Before migrating data from a MongoDB database to DDS, transfer data to a .json f The MongoDB client provides the mongoexport and mongoimport tools. -Exporting Data --------------- +Exporting Data (Linux example) +------------------------------ #. Log in to the ECS or the device that can access DDS. #. Use the mongoexport tool to transfer data from the source database to a .json file. - The SSL connection is used as an example. If you select a common connection, delete **--ssl --sslAllowInvalidCertificates** from the following command. + The SSL connection is used as an example. If you select an unencrypted connection, delete **--ssl --sslAllowInvalidCertificates** from the following command. - ./**mongoexport** **--host** ** **--\ port** ** **--\ ssl** **--sslAllowInvalidCertificates** **--type json** **--authenticationDatabase** * **-u** ** **--db** <*DB_NAME*> **--collection** <*DB_COLLECTION*> **--out** <*DB_PATH*> + **mongoexport** **--host** ** **--\ port** ** **--\ ssl** **--sslAllowInvalidCertificates** **--type json** **--authenticationDatabase** * **-u** ** **--db** <*DB_NAME*> **--collection** <*DB_COLLECTION*> **--out** <*DB_PATH*> - **DB_ADDRESS** indicates the database address. - **DB_PORT** indicates the database port. @@ -58,7 +61,7 @@ Exporting Data The following is an example. After the command is executed, the **exportfile.json** file will be generated: - **./mongoexport --host 192.168.1.21 --port 8635 --ssl --sslAllowInvalidCertificates --type json --authenticationDatabase admin -u rwuser --db test02 --collection Test --out /tmp/mongodb/export/exportfile.json** + **mongoexport --host 192.168.1.21 --port 8635 --ssl --sslAllowInvalidCertificates --type json --authenticationDatabase admin -u rwuser --db test02 --collection Test --out /tmp/mongodb/export/exportfile.json** #. Check the result. @@ -98,9 +101,9 @@ Importing Data #. Import the JSON file to the DDS database. - The SSL connection is used as an example. If you select a common connection, delete **--ssl --sslAllowInvalidCertificates** from the following command. + The SSL connection is used as an example. If you select an unencrypted connection, delete **--ssl --sslAllowInvalidCertificates** from the following command. - ./**mongoimport --host** <*DB_ADDRESS*> **--port** <*DB_PORT*> **--ssl --sslAllowInvalidCertificates --type json --authenticationDatabase** <*AUTH_DB*> **-u** <*DB_USER*> **--db** <*DB_NAME*> **--collection** <*DB_COLLECTION*> **--file** <*DB_PATH*> + **mongoimport --host** <*DB_ADDRESS*> **--port** <*DB_PORT*> **--ssl --sslAllowInvalidCertificates --type json --authenticationDatabase** <*AUTH_DB*> **-u** <*DB_USER*> **--db** <*DB_NAME*> **--collection** <*DB_COLLECTION*> **--file** <*DB_PATH*> - **DB_ADDRESS** indicates the DB instance IP address. - **DB_PORT** indicates the database port. @@ -118,7 +121,7 @@ Importing Data The following is an example: - **./mongoimport --host 192.168.1.21 --port 8635 --ssl --sslAllowInvalidCertificates --type json --authenticationDatabase admin -u rwuser --db test02 --collection Test --file /tmp/mongodb/export/exportfile.json** + **mongoimport --host 192.168.1.21 --port 8635 --ssl --sslAllowInvalidCertificates --type json --authenticationDatabase admin -u rwuser --db test02 --collection Test --file /tmp/mongodb/export/exportfile.json** #. Check the result. diff --git a/umn/source/monitoring/error_log.rst b/umn/source/monitoring/error_log.rst deleted file mode 100644 index 470afef..0000000 --- a/umn/source/monitoring/error_log.rst +++ /dev/null @@ -1,27 +0,0 @@ -:original_name: en-us_topic_error_log.html - -.. _en-us_topic_error_log: - -Error Log -========= - -DDS log management allows you to view database-level logs, including warning- and error-level logs generated during database running, which help you analyze system problems. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click the target DB instance. -#. In the navigation pane on the left, click **Error Logs**. -#. On the displayed page, click **Error Logs**. Then, view the log details. - - - Log records of different node types of a cluster instance in batches - - - If you select **All nodes**, the logs of all nodes in the cluster instance are displayed. - - If you select **All mongos**, the logs of all mongos in the cluster instance are displayed. - - If you select **All shards**, the logs of all shards in the cluster instance are displayed. - - If you select **All configs**, the logs of all configs in the cluster instance are displayed. - - - Log records of all nodes of a replica set instance - - Log records of a node in different time periods - - Time, levels, and descriptions of the logs diff --git a/umn/source/monitoring/interconnected_with_cloud_eye/dds_metrics.rst b/umn/source/monitoring/interconnected_with_cloud_eye/dds_metrics.rst deleted file mode 100644 index 10bd0cc..0000000 --- a/umn/source/monitoring/interconnected_with_cloud_eye/dds_metrics.rst +++ /dev/null @@ -1,205 +0,0 @@ -:original_name: dds_03_0026.html - -.. _dds_03_0026: - -DDS Metrics -=========== - -Cluster -------- - -- :ref:`Table 1 ` lists the DB instance monitoring metrics. - - .. _dds_03_0026__table40856249142242: - - .. table:: **Table 1** DB instance monitoring metrics - - ======================================= ======= - Metrics Unit - ======================================= ======= - COMMAND Statements per Second Count/s - DELETE Statements per Second Count/s - INSERT Statements per Second Count/s - QUERY Statements per Second Count/s - UPDATE Statements per Second Count/s - GETMORE Statements per Second Count/s - Chunks of Shard 1 Count - Chunks of Shard 2 Count - Chunks of Shard 3 Count - Chunks of Shard 4 Count - Chunks of Shard 5 Count - Chunks of Shard 6 Count - Chunks of Shard 7 Count - Chunks of Shard 8 Count - Chunks of Shard 9 Count - Chunks of Shard 10 Count - Chunks of Shard 11 Count - Chunks of Shard 12 Count - Active Instance Connections Count - Chunk Migration Failures in Last 24 hrs Count - ======================================= ======= - -- The monitoring metrics of the primary nodes in the config's and shard's replica sets are as follows: - - - :ref:`Table 2 ` lists the ECS monitoring metrics. - - - - - .. _dds_03_0026__table884454374119: - - .. table:: **Table 2** ECS monitoring metrics - - =========================== ======= - Metrics Unit - =========================== ======= - CPU Usage Percent - Memory Usage Percent - Network Output Throughput bytes/s - Network Input Throughput bytes/s - Disk Utilization Percent - IOPS Count/s - Disk Read Throughput bytes/s - Disk Write Throughput bytes/s - Average Time per Disk Read s - Average Time per Disk Write s - Total Disk Size GB - Disk Usage GB - =========================== ======= - - - :ref:`Table 3 ` lists database metrics. - - .. _dds_03_0026__table58063690142242: - - .. table:: **Table 3** Database metrics - - ================================================ ======= - Metrics Unit - ================================================ ======= - COMMAND Statements per Second Count/s - DELETE Statements per Second Count/s - INSERT Statements per Second Count/s - QUERY Statements per Second Count/s - UPDATE Statements per Second Count/s - GETMORE Statements per Second Count/s - Active Connections Count - Resident Memory MB - Virtual Memory MB - Regular Asserts per Second Count/s - Warning Asserts per Second Count/s - Message Asserts per Second Count/s - User Asserts per Second Count/s - Number of Operations Queued Waiting for the Lock Count - Operations Queued Waiting for a Read Lock Count - Operations Queued Waiting for a Write Lock Count - Page Faults Count - Slow Queries Count - Maintained Cursors Count - Timeout Cursors Count - Bytes in WiredTiger Cache MB - Tracked Dirty Bytes in WiredTiger Cache MB - Bytes Written Into Cache per Second bytes/s - Bytes Written From Cache per Second bytes/s - Oplog Window h - Oplog Growth Rate MB/h - ================================================ ======= - -- The monitoring metrics of the secondary or hidden nodes in the config's and shard's replica sets are as follows: - - - The ECS monitoring metrics are the same as those of the primary nodes in the config's and shard's replica sets. For details, see :ref:`Table 2 `. - - - :ref:`Table 4 ` lists database metrics. - - .. _dds_03_0026__table44287116142242: - - .. table:: **Table 4** Database metrics - - ========================================== ======= - Metrics Unit - ========================================== ======= - COMMAND Statements per Second Count/s - DELETE Statements per Second Count/s - INSERT Statements per Second Count/s - QUERY Statements per Second Count/s - UPDATE Statements per Second Count/s - GETMORE Statements per Second Count/s - Active Node Connections Count - Resident Memory MB - Virtual Memory MB - Regular Asserts per Second Count/s - Warning Asserts per Second Count/s - Message Asserts per Second Count/s - User Asserts per Second Count/s - Operations Queued Waiting for a Lock Count - Operations Queued Waiting for a Read Lock Count - Operations Queued Waiting for a Write Lock Count - Page Faults Count - Slow Queries Count - Maintained Cursors Count - Timeout Cursors Count - Bytes in WiredTiger Cache MB - Tracked Dirty Bytes in WiredTiger Cache MB - Bytes Written Into Cache per Second bytes/s - Bytes Written From Cache per Second bytes/s - Replication Headroom s - Replication Lag s - Replicated COMMAND Statements per Second Count/s - Replicated UPDATE Statements per Second Count/s - Replicated DELETE Statements per Second Count/s - Replicated INSERT Statements per Second Count/s - ========================================== ======= - -- mongos metrics are as follows: - - - :ref:`Table 5 ` lists the ECS monitoring metrics. - - - - - .. _dds_03_0026__table1066175075416: - - .. table:: **Table 5** ECS monitoring metrics - - ========================= ======= - Metrics Unit - ========================= ======= - CPU Usage Percent - Memory Usage Percent - Network Output Throughput bytes/s - Network Input Throughput bytes/s - ========================= ======= - - - :ref:`Table 6 ` lists database metrics. - - .. _dds_03_0026__table22601657142329: - - .. table:: **Table 6** Database metrics - - ============================= ======= - Metrics Unit - ============================= ======= - COMMAND Statements per Second Count/s - DELETE Statements per Second Count/s - INSERT Statements per Second Count/s - QUERY Statements per Second Count/s - UPDATE Statements per Second Count/s - GETMORE Statements per Second Count/s - Active Node Connections Count - Resident Memory MB - Virtual Memory MB - Regular Asserts per Second Count/s - Warning Asserts per Second Count/s - Message Asserts per Second Count/s - User Asserts per Second Count/s - ============================= ======= - -Replica Set ------------ - -- Monitoring metrics of the primary node - - - :ref:`Table 2 ` lists the ECS monitoring metrics. - - :ref:`Table 3 ` lists database metrics. - -- Monitoring metrics of the secondary or hidden node - - - :ref:`Table 2 ` lists the ECS monitoring metrics. - - :ref:`Table 4 ` lists database metrics. diff --git a/umn/source/monitoring/interconnected_with_cloud_eye/setting_alarm_rules.rst b/umn/source/monitoring/interconnected_with_cloud_eye/setting_alarm_rules.rst deleted file mode 100644 index be1053a..0000000 --- a/umn/source/monitoring/interconnected_with_cloud_eye/setting_alarm_rules.rst +++ /dev/null @@ -1,36 +0,0 @@ -:original_name: dds_03_0027.html - -.. _dds_03_0027: - -Setting Alarm Rules -=================== - -Scenarios ---------- - -You can set DDS alarm rules to customize the monitored objects and notification policies. Then, you can learn DDS running status in a timely manner. - -The DDS alarm rules include alarm rule name, instance, metric, threshold, monitoring interval and whether to send notification. This section describes how to set DDS alarm rules. - -.. note:: - - For more information about DDS alarm rules, see *Cloud Eye User Guide*. - -Procedure ---------- - -#. Log in to the management console. - -#. Under **Management & Deployment**, click **Cloud Eye**. - -#. In the navigation pane on the left, choose **Alarm Management** > **Alarm Rules**. - -#. On the **Alarm Rules** page, click **Create Alarm Rule** to create an alarm rule, or modify an existing alarm rule. - - The following operations use the modification of an existing alarm rule as an example. - - Locate the alarm rule to be modified and choose **More** > **Modify**. - - Click **OK**. - -#. After the alarm rule is set, the system automatically notifies you when an alarm is triggered. diff --git a/umn/source/monitoring/interconnected_with_cloud_eye/viewing_dds_metrics.rst b/umn/source/monitoring/interconnected_with_cloud_eye/viewing_dds_metrics.rst deleted file mode 100644 index 1e2a61a..0000000 --- a/umn/source/monitoring/interconnected_with_cloud_eye/viewing_dds_metrics.rst +++ /dev/null @@ -1,48 +0,0 @@ -:original_name: dds_03_0078.html - -.. _dds_03_0078: - -Viewing DDS Metrics -=================== - -Scenarios ---------- - -Cloud Eye monitors DDS running statuses. You can obtain the monitoring metrics of DDS on the management console. - -Monitored data requires a period of time for transmission and display. The status of DDS displayed on the Cloud Eye page is the status obtained 5 to 10 minutes before. You can view the monitored data of a newly created DB instance 5 to 10 minutes later. - -**Prerequisites** ------------------ - -- The DDS DB instance is running properly. - - Cloud Eye does not display the metrics of a faulty or deleted DB instance or node. You can view the monitoring information only after the instance is restarted or recovered. - -.. note:: - - Cloud Eye will delete a DDS DB instance or node that becomes faulty for 24 hours from the monitoring list and will not monitor it any more. However, you need to manually clear its alarm rules. - -- The DB instance has been properly running for at least 10 minutes. - - For a newly created DB instance, you need to wait for a while before viewing the monitoring metrics. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select a region and a project. - -#. Under **Management & Deployment**, click **Cloud Eye**. - -#. In the navigation pane on the left, choose **Cloud Service Monitoring** > **Document Database Service**. - -#. On the displayed page, locate the target instance and click **View Metric** in the **Operation** column. - -#. In the DDS monitoring area, you can select a duration to view the monitoring data. - - You can view the monitoring data of DDS in the recent 1 hour, 3 hours, or 12 hours. To view the monitoring curve of a longer time range, click |image2| to enlarge the graph. - -.. |image1| image:: /_static/images/en-us_image_0284275156.png -.. |image2| image:: /_static/images/en-us_image_0284275295.png diff --git a/umn/source/monitoring/interconnecting_with_cts/querying_traces.rst b/umn/source/monitoring/interconnecting_with_cts/querying_traces.rst deleted file mode 100644 index 2ed2b3c..0000000 --- a/umn/source/monitoring/interconnecting_with_cts/querying_traces.rst +++ /dev/null @@ -1,44 +0,0 @@ -:original_name: dds_03_0032.html - -.. _dds_03_0032: - -Querying Traces -=============== - -Scenarios ---------- - -After CTS is enabled, the tracker starts recording operations on cloud resources. Operation records for the last 7 days are stored on the CTS console. - -This section describes how to query operation records for the last 7 days on the CTS console. - -Procedure ---------- - -#. Log in to the management console. -#. Click |image1| in the upper left corner and select a region and a project. -#. Click **Service List**. Under **Management & Deployment**, click **Cloud Trace Service**. -#. Choose **Trace List** in the navigation pane on the left. -#. Specify the filters used for querying traces. The following four filters are available: - - - **Trace Source**, **Resource Type**, **Search By**, and **Operator** - - Select the filter from the drop-down list. - - When you select **Trace name** for **Search By**, you also need to select a specific trace name. - - When you select **Resource ID** for **Search By**, you also need to select or enter a specific resource ID. - - When you select **Resource name** for **Search By**, you also need to select or enter a specific resource name. - - - **Operator**: Select a specific operator (a user rather than tenant). - - - **Trace Status**: Available options include **All trace statuses**, **normal**, **warning**, and **incident**. You can only select one of them. - - - Start time and end time: You can specify the time period for query traces. - -#. Click |image2| on the left of the record to be queried to extend its details. -#. Locate a trace and click **View Trace** in the **Operation** column. - -.. |image1| image:: /_static/images/en-us_image_0284275156.png -.. |image2| image:: /_static/images/en-us_image_0284275259.png diff --git a/umn/source/monitoring/slow_query_log.rst b/umn/source/monitoring/slow_query_log.rst deleted file mode 100644 index 77bec44..0000000 --- a/umn/source/monitoring/slow_query_log.rst +++ /dev/null @@ -1,29 +0,0 @@ -:original_name: en-us_topic_slow_query_log.html - -.. _en-us_topic_slow_query_log: - -Slow Query Log -============== - -Slow query logs record statements whose execution period exceeds the value of **slowms** (100 ms by default), allowing you identify and optimize slowly executed statements. - -Procedure ---------- - -#. :ref:`Log in to the DDS console. ` -#. On the **Instance Management** page, click the target DB instance. -#. In the navigation pane on the left, click **Slow Query Logs**. -#. On the displayed page, click **Slow Query Logs**. Then, view the log details. - - - Log records of all shards of a cluster instance - - Log records of all nodes of a replica set instance - - Log records of a node in different time periods - - Statements of the following level - - - All statement type - - INSERT - - QUERY - - UPDATE - - REMOVE - - GETMORE - - COMMAND diff --git a/umn/source/monitoring_and_alarm_reporting/dds_metrics.rst b/umn/source/monitoring_and_alarm_reporting/dds_metrics.rst new file mode 100644 index 0000000..f36f228 --- /dev/null +++ b/umn/source/monitoring_and_alarm_reporting/dds_metrics.rst @@ -0,0 +1,415 @@ +:original_name: dds_03_0026.html + +.. _dds_03_0026: + +DDS Metrics +=========== + +Function +-------- + +This section describes metrics reported by Document Database Service (DDS) to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the metrics of the monitored object and alarms generated for DDS. + +Namespace +--------- + +SYS.DDS + +Monitoring Metrics +------------------ + ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| Metrics | Metrics Name | Description | Value Range | Remarks | Monitoring Interval (Raw Data) | ++=================================+============================================+==============================================================================================================================+==============+========================================+================================+ +| mongo001_command_ps | COMMAND Statements per Second | Number of COMMAND statements executed per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - DDS DB instance | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo002_delete_ps | DELETE Statements per Second | Number of DELETE statements executed per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - DDS DB instance | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo003_insert_ps | INSERT Statements per Second | Number of INSERT statements executed per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - DDS DB instance | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo004_query_ps | QUERY Statements per Second | Number of QUERY statements executed per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - DDS DB instance | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo005_update_ps | UPDATE Statements per Second | Number of UPDATE statements executed per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - DDS DB instance | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo006_getmore_ps | GETMORE Statements per Second | Number of GETMORE statements executed per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - DDS DB instance | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num1 | Chunks of Shard 1 | Number of chunks in shard 1 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num2 | Chunks of Shard 2 | Number of chunks in shard 2 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num3 | Chunks of Shard 3 | Number of chunks in shard 3 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num4 | Chunks of Shard 4 | Number of chunks in shard 4 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num5 | Chunks of Shard 5 | Number of chunks in shard 5 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num6 | Chunks of Shard 6 | Number of chunks in shard 6 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num7 | Chunks of Shard 7 | Number of chunks in shard 7 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num8 | Chunks of Shard 8 | Number of chunks in shard 8 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num9 | Chunks of Shard 9 | Number of chunks in shard 9 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num10 | Chunks of Shard 10 | Number of chunks in shard 10 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num11 | Chunks of Shard 11 | Number of chunks in shard 11 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_chunk_num12 | Chunks of Shard 12 | Number of chunks in shard 12 | 0-64 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo008_connections | Active Instance Connections | Total number of connections attempting to connect to a DDS DB instance | 0-200 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo009_migFail_num | Chunk Migration Failures in Last 24 hrs | Number of chunk migration failures in the last 24 hours | >= 0 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: DDS DB instance | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo007_connections | Active Node Connections | Total number of connections attempting to connect to a DDS DB instance node | 0-200 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo008_mem_resident | Resident Memory | Size of resident memory in MB | >= 0 MB | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo009_mem_virtual | Virtual Memory | Size of virtual memory in MB | >= 0 MB | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo010_regular_asserts_ps | Regular Asserts per Second | Number of regular asserts per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo011_warning_asserts_ps | Warning Asserts per Second | Number of warning asserts per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo012_msg_asserts_ps | Message Asserts per Second | Number of message asserts per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo013_user_asserts_ps | User Asserts per Second | Number of user asserts per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo014_queues_total | Operations Queued Waiting for a Lock | Number of operations queued waiting for a lock | >= 0 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo015_queues_readers | Operations Queued Waiting for a Read Lock | Number of operations queued waiting for a read lock | >= 0 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo016_queues_writers | Operations Queued Waiting for a Write Lock | Number of operations queued waiting for a write lock | >= 0 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo017_page_faults | Page Faults | Number of page faults on the monitored nodes | >= 0 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo018_porfling_num | Slow Queries | Number of slow queries on the monitored nodes | >= 0 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo019_cursors_open | Maintained Cursors | Number of maintained cursors on the monitored nodes | >= 0 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo020_cursors_timeOut | Timeout Cursors | Number of timed out cursors on the monitored nodes | >= 0 Counts | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo021_wt_cahe_usage | Bytes in WiredTiger Cache | Size of data in the WiredTiger cache in MB | >= 0 MB | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo022_wt_cahe_dirty | Tracked Dirty Bytes in WiredTiger Cache | Size of tracked dirty data in the WiredTiger cache in MB | >= 0 MB | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo023_wInto_wtCache | Bytes Written Into Cache per Second | Bytes written into WiredTiger cache per second | >= 0 bytes/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo024_wFrom_wtCache | Bytes Written From Cache per Second | Bytes written from the WiredTiger cache to the disk per second | >= 0 bytes/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo025_repl_oplog_win | Oplog Window | Available time in hour in the monitored primary node's oplog | >= 0 Hours | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: primary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo026_oplog_size_ph | Oplog Growth Rate | Speed in MB/hour at which oplogs are generated on the monitored primary node | >= 0 MB/Hour | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: primary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo025_repl_headroom | Replication Headroom | Time difference in seconds between the primary's oplog window and the replication lag of the secondary | >= 0 Seconds | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo026_repl_lag | Replication Lag | A delay in seconds between an operation on the primary and the application of that operation from the oplog to the secondary | >= 0 Seconds | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo027_repl_command_ps | Replicated COMMAND Statements per Second | Number of replicated COMMAND statements executed on the secondary node per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo028_repl_update_ps | Replicated UPDATE Statements per Second | Number of replicated UPDATE statements executed on the secondary node per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo029_repl_delete_ps | Replicated DELETE Statements per Second | Number of replicated DELETE statements executed on the secondary node per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo030_repl_insert_ps | Replicated INSERT Statements per Second | Number of replicated INSERT statements executed on the secondary node per second | >= 0 Count/s | Monitored object: database | 1 minute | +| | | | | | | +| | | | | Monitored object type: secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo031_cpu_usage | CPU Usage | CPU usage of the monitored object | 0-1 | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo032_mem_usage | Memory Usage | Memory usage of the monitored object | 0-1 | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo033_bytes_out | Network Output Throughput | Outgoing traffic in bytes per second | >= 0 bytes/s | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo034_bytes_in | Network Input Throughput | Incoming traffic in bytes per second | >= 0 bytes/s | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo035_disk_usage | Disk Utilization | Disk usage of the monitored object | 0-1 | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo036_iops | IOPS | Average number of I/O requests processed by the system in a specified period | >= 0 Count/s | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo037_read_throughput | Disk Read Throughput | Number of bytes read from the disk per second | >= 0 bytes/s | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo038_write_throughput | Disk Write Throughput | Number of bytes written into the disk per second | >= 0 bytes/s | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo039_avg_disk_sec_per_read | Average Time per Disk Read | Average time required for each disk read in a specified period | >= 0 Seconds | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo040_avg_disk_sec_per_write | Average Time per Disk Write | Average time required for each disk write in a specified period | >= 0 Seconds | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo042_disk_total_size | Total Storage Space | Total storage space of the monitored object | 0-1000 GB | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo043_disk_used_size | Used Storage Space | Used storage space of the monitored object | 0-1000 GB | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - Primary node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ +| mongo044_swap_usage | SWAP Usage | Swap usage, in percentage. | 0-1 | Monitored object: ECS | 1 minute | +| | | | | | | +| | | | | Monitored object type: | | +| | | | | | | +| | | | | - mongos node | | +| | | | | - Secondary node | | ++---------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+--------------+----------------------------------------+--------------------------------+ + +Dimensions +---------- + ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| Key | Value | ++===================================+======================================================================================================================+ +| mongodb_cluster_id | DDS DB instance ID | +| | | +| | Supported the cluster, replica set, and single node instance types. | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| mongos_instance_id | mongos node ID | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| mongod_primary_instance_id | Primary node ID | +| | | +| | Includes the primary config and shard nodes of cluster instances and the primary nodes of replica set instances. | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ +| mongod_secondary_instance_id | Secondary node ID | +| | | +| | Includes the secondary config and shard nodes of cluster instances and the secondary nodes of replica set instances. | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/monitoring/interconnected_with_cloud_eye/index.rst b/umn/source/monitoring_and_alarm_reporting/index.rst similarity index 69% rename from umn/source/monitoring/interconnected_with_cloud_eye/index.rst rename to umn/source/monitoring_and_alarm_reporting/index.rst index 365d65f..b31846d 100644 --- a/umn/source/monitoring/interconnected_with_cloud_eye/index.rst +++ b/umn/source/monitoring_and_alarm_reporting/index.rst @@ -2,17 +2,17 @@ .. _dds_03_0025: -Interconnected with Cloud Eye -============================= +Monitoring and Alarm Reporting +============================== +- :ref:`Viewing DDS Metrics ` - :ref:`DDS Metrics ` - :ref:`Setting Alarm Rules ` -- :ref:`Viewing DDS Metrics ` .. toctree:: :maxdepth: 1 :hidden: + viewing_dds_metrics dds_metrics setting_alarm_rules - viewing_dds_metrics diff --git a/umn/source/monitoring_and_alarm_reporting/setting_alarm_rules.rst b/umn/source/monitoring_and_alarm_reporting/setting_alarm_rules.rst new file mode 100644 index 0000000..c408f74 --- /dev/null +++ b/umn/source/monitoring_and_alarm_reporting/setting_alarm_rules.rst @@ -0,0 +1,33 @@ +:original_name: dds_03_0027.html + +.. _dds_03_0027: + +Setting Alarm Rules +=================== + +Scenarios +--------- + +- You can enable the alarm reporting function in one click. After alarms are triggered, Simple Message Notification (SMN) can send notifications to specified cloud account. +- You can set DDS alarm rules to customize the monitored objects and notification policies. Then, you can learn DDS running status in a timely manner. + +.. note:: + + For more information about DDS alarm rules, see *Cloud Eye User Guide*. + +Enable Basic Alarm Reporting +---------------------------- + +#. :ref:`Log in to the DDS console `. +#. On the **Instance Management** page, click the target DB instance. +#. In the navigation pane on the left, choose **Advanced O&M**. +#. On the **Advanced O&M** page, click the **Alarms** tab and click |image1| next to the target alarm policy to enable alarm reporting function. +#. If you want to disable the alarm reporting function, click |image2|. + +Setting Custom Alarm Rules +-------------------------- + +For more information about alarm rules, see *Cloud Eye User Guide*. + +.. |image1| image:: /_static/images/en-us_image_0000001143133823.png +.. |image2| image:: /_static/images/en-us_image_0000001143053823.png diff --git a/umn/source/monitoring_and_alarm_reporting/viewing_dds_metrics.rst b/umn/source/monitoring_and_alarm_reporting/viewing_dds_metrics.rst new file mode 100644 index 0000000..dbe2f6f --- /dev/null +++ b/umn/source/monitoring_and_alarm_reporting/viewing_dds_metrics.rst @@ -0,0 +1,55 @@ +:original_name: dds_03_0076.html + +.. _dds_03_0076: + +Viewing DDS Metrics +=================== + +Scenarios +--------- + +Cloud Eye monitors DDS instance metrics. You can obtain the monitoring metrics of DDS on the management console. + +Monitored data requires a period of time for transmission and display. + +**Prerequisites** +----------------- + +- Cloud Eye does not display the metrics of a deleted DB instance or node. You can view the monitoring information only after the instance is restarted or recovered. + +- The DDS instance metrics are displayed on the Cloud Eye page with 5-10 minutes delay. + +Method 1 +-------- + +#. :ref:`Log in to the DDS console. ` +#. On the **Instance Management** page, click the target DB instance. +#. In the navigation pane on the left, choose **Advanced O&M**. +#. On the **Real-Time Monitoring** tab, view metrics of DDS instances and/or instance specific nodes if there are any. +#. On the **Real-Time Monitoring** tab, you can select a duration to view the monitoring data. + + - You can view the monitoring data of the last 1 hour, 3 hours, and 12 hours. + - After the automatic refresh function is enabled, monitoring data is automatically refreshed at an interval of 60s. + - For more metric information, click :ref:`View details ` to switch to the Cloud Eye console. + +.. _dds_03_0076__section1657925514410: + +Method 2 +-------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner and select a region and a project. + +#. Under **Management & Deployment**, click **Cloud Eye**. + +#. In the navigation pane on the left, choose **Cloud Service Monitoring** > **Document Database Service**. + +#. On the displayed page, locate the target instance and click **View Metric** in the **Operation** column. + +#. In the DDS monitoring area, you can select a duration to view the monitoring data. + + You can view the monitoring data of DDS in the recent 1 hour, 3 hours, or 12 hours. To view the monitoring curve of a longer time range, click |image2| to enlarge the graph. + +.. |image1| image:: /_static/images/en-us_image_0000001280455205.png +.. |image2| image:: /_static/images/en-us_image_0000001236135268.png diff --git a/umn/source/parameter_template_management/applying_a_parameter_template.rst b/umn/source/parameter_template_management/applying_a_parameter_template.rst new file mode 100644 index 0000000..2031f49 --- /dev/null +++ b/umn/source/parameter_template_management/applying_a_parameter_template.rst @@ -0,0 +1,33 @@ +:original_name: dds_03_0014.html + +.. _dds_03_0014: + +Applying a Parameter Template +============================= + +Modifications to parameters in a custom parameter template take effect for DB instances only after you have applied the template to the target DB instances or target nodes. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner and select a region and a project. + +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. + +#. In the navigation pane on the left, click **Parameter Template Management**. + +#. On the **Parameter Template Management** page, apply a default template or a custom template to the target DB instance: + + - To apply a default template, click the **Default Templates** tab, locate the required parameter template, and click **Apply** in the **Operation** column. + - To apply a custom template, click **Custom Templates**, locate the target parameter template, and in the **Operation** column, choose **More** > **Apply**. + + A parameter template can be applied to one or more nodes and instances. + +#. In the displayed dialog box, select the node or instance to which the parameter template will be applied and click **OK**. + + - After the parameter template is successfully applied, you can view the application records by referring to :ref:`Viewing Application Records of a Parameter Template `. + - For some parameters a reboot of target nodes or the target DB instance could be required, see :ref:`Restarting a DB Instance or a Node `. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/comparing_parameter_templates.rst b/umn/source/parameter_template_management/comparing_parameter_templates.rst new file mode 100644 index 0000000..e8f5292 --- /dev/null +++ b/umn/source/parameter_template_management/comparing_parameter_templates.rst @@ -0,0 +1,23 @@ +:original_name: dds_03_0012.html + +.. _dds_03_0012: + +Comparing Parameter Templates +============================= + +This section describes how to compare two parameter templates of the same node type and DB engine version. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, click **Parameter Template Management**. +#. On the **Parameter Template Management** page, select the **Clusters**, **Replica Sets**, or **Single Nodes** tab and locate the parameter templates you created and click **Compare** in the **Operation** column. +#. In the displayed dialog box, select a parameter template that uses the same DB engine as the target template and click **OK**. + + - If their settings are different, the parameter names and values of both parameter templates are displayed. + - If their settings are the same, no data is displayed. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/creating_a_parameter_template.rst b/umn/source/parameter_template_management/creating_a_parameter_template.rst new file mode 100644 index 0000000..19c9ce7 --- /dev/null +++ b/umn/source/parameter_template_management/creating_a_parameter_template.rst @@ -0,0 +1,64 @@ +:original_name: en-us_topic_parameter_group.html + +.. _en-us_topic_parameter_group: + +Creating a Parameter Template +============================= + +DB parameter templates act as a container for engine configuration values that are applied to one or more DB instances. + +Precautions +----------- + +- DDS does not share parameter template quotas with RDS. +- Each account can create up to 100 DDS parameter templates for the cluster, replica set, and single node instances. + +Cluster +------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, choose **Parameter Template Management**. +#. On the **Parameter Template Management** page, click **Create Parameter Template**. +#. Select **Cluster** for **DB Instance Type**, specify **DB Engine Version**, **Node Type**, **New Parameter Template**, and **Description** (optional), and then click **OK**. + + - **Node Type**: specifies the node type that this parameter template will apply to. For example, to create a parameter template applying to config, select **config**. + - **New Parameter Template**: The template name can be 4 to 64 characters long and starts with a letter. It can contain only letters, digits, hyphens (-), underscores (_), and periods (.). + - **Description**: contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= + +#. On the **Parameter Template Management** page, view and manage parameter templates on the **Clusters** tab. + +Replica Set +----------- + +#. Log in to the management console. +#. Click |image2| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, choose **Parameter Template Management**. +#. On the **Parameter Template Management** page, click **Create Parameter Template**. +#. Select **Replica set** for **DB Instance Type**, specify **DB Engine Version**, **New Parameter Template**, and **Description** (optional), and then click **OK**. + + - **New Parameter Template**: The template name can be 4 to 64 characters long and starts with a letter. It can contain only letters, digits, hyphens (-), underscores (_), and periods (.). + - **Description**: contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= + +#. On the **Parameter Template Management** page, view and manage parameter templates on the **Replica Sets** tab. + +Single Node +----------- + +#. Log in to the management console. +#. Click |image3| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, choose **Parameter Template Management**. +#. On the **Parameter Template Management** page, click **Create Parameter Template** . +#. Select **Single node** for **DB Instance Type**, specify **DB Engine Version**, **New Parameter Template**, and **Description** (optional), and then click **OK**. + + - **New Parameter Template**: The template name can be 4 to 64 characters long and starts with a letter. It can contain only letters, digits, hyphens (-), underscores (_), and periods (.). + - **Description**: contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= + +#. On the **Parameter Template Management** page, view and manage parameter templates on the **Single Nodes** tab. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png +.. |image2| image:: /_static/images/en-us_image_0000001268771757.png +.. |image3| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/deleting_a_parameter_template.rst b/umn/source/parameter_template_management/deleting_a_parameter_template.rst new file mode 100644 index 0000000..6781de1 --- /dev/null +++ b/umn/source/parameter_template_management/deleting_a_parameter_template.rst @@ -0,0 +1,26 @@ +:original_name: dds_03_0016.html + +.. _dds_03_0016: + +Deleting a Parameter Template +============================= + +You can delete a custom parameter template that is no longer used. + +Precautions +----------- + +- Default parameter templates and parameter templates applied to instances cannot be deleted. +- Deleted parameter templates cannot be restored. Exercise caution when performing this operation. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, click **Parameter Template Management**. +#. On the **Parameter Template Management** page, select the **Clusters**, **Replica Sets**, or **Single Nodes** tab, locate the parameter template you want to delete and choose **More** > **Delete** in the **Operation** column. +#. In the displayed dialog box, click **Yes**. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/exporting_a_parameter_template.rst b/umn/source/parameter_template_management/exporting_a_parameter_template.rst new file mode 100644 index 0000000..a44cc61 --- /dev/null +++ b/umn/source/parameter_template_management/exporting_a_parameter_template.rst @@ -0,0 +1,39 @@ +:original_name: dds_03_0111.html + +.. _dds_03_0111: + +Exporting a Parameter Template +============================== + +- You can export a parameter template of a DB instance for future use. You can also apply the exported parameter template to other instances by referring to :ref:`Applying a Parameter Template `. +- You can export parameter template details (parameter names, values, and descriptions) of an instance to a CSV file for review and analysis. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, choose **Instance Management**. On the displayed page, click the target instance. The **Basic Information** page is displayed. +#. In the navigation pane on the left, choose **Parameters**. On the **Parameters** tab, above the parameter list, click **Export**. + + - Exporting to a custom template Export the parameter list of the instance to a parameter template for future use. + + In the displayed dialog box, configure required details and click **OK**. + + .. note:: + + - **New Parameter Template**: The template name can be 4 to 64 characters long and starts with a letter. It can contain only letters, digits, hyphens (-), underscores (_), and periods (.). + - **Description**: The template description consists of a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'= + + After the parameter template is exported, a new template is generated in the list on the **Parameter Template Management** page. + + - Exporting to a file: You can export the parameter template details (parameter names, values, and descriptions) of a DB instance to a CSV file for review and analysis. + + In the displayed dialog box, enter the file name and click **OK**. + + .. note:: + + The file name must start with a letter and consist of 4 to 81 characters. It can contain only letters, digits, hyphens (-), and underscores (_). + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/index.rst b/umn/source/parameter_template_management/index.rst new file mode 100644 index 0000000..febaa9d --- /dev/null +++ b/umn/source/parameter_template_management/index.rst @@ -0,0 +1,34 @@ +:original_name: dds_03_0010.html + +.. _dds_03_0010: + +Parameter Template Management +============================= + +- :ref:`Creating a Parameter Template ` +- :ref:`Modifying a Parameter Template ` +- :ref:`Viewing Parameter Change History ` +- :ref:`Exporting a Parameter Template ` +- :ref:`Comparing Parameter Templates ` +- :ref:`Replicating a Parameter Template ` +- :ref:`Resetting a Parameter Template ` +- :ref:`Applying a Parameter Template ` +- :ref:`Viewing Application Records of a Parameter Template ` +- :ref:`Modifying the Description of a Parameter Template ` +- :ref:`Deleting a Parameter Template ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_parameter_template + modifying_a_parameter_template + viewing_parameter_change_history + exporting_a_parameter_template + comparing_parameter_templates + replicating_a_parameter_template + resetting_a_parameter_template + applying_a_parameter_template + viewing_application_records_of_a_parameter_template + modifying_the_description_of_a_parameter_template + deleting_a_parameter_template diff --git a/umn/source/parameter_template_management/modifying_a_parameter_template.rst b/umn/source/parameter_template_management/modifying_a_parameter_template.rst new file mode 100644 index 0000000..4b76c64 --- /dev/null +++ b/umn/source/parameter_template_management/modifying_a_parameter_template.rst @@ -0,0 +1,87 @@ +:original_name: en-us_topic_configuration.html + +.. _en-us_topic_configuration: + +Modifying a Parameter Template +============================== + +You can modify parameters in custom parameter templates as needed to get the most out of DDS performance. + +You can modify parameters in either of the following ways: + +- Directly modify the parameters of a specified instance. + + If you change a dynamic parameter value in a parameter template and save the change, the change takes effect immediately regardless of the **Effective upon Reboot** setting. If you modify static parameters on the **Parameters** page of an instance and save the modifications, the modifications take effect only after you manually restart the target instance. + +- Modify the parameters in a parameter template and apply the template to the instance. + + The changes only take effect after you apply the template to the instance. If you modify static parameters in a custom parameter template on the **Parameter Template Management** page and save the modifications, the modifications take effect only after you apply the parameter template to instances and manually restart the instances. For operation details, see :ref:`Applying a Parameter Template `. + +Precautions +----------- + +- You can change parameter values in custom parameter templates but cannot change the default parameter templates provided by the system. You can only click the name of a default parameter template to view its details. +- If a custom parameter template is set incorrectly, the instance associated with the template may fail to start. You can re-configure the custom parameter template according to the configurations of the default parameter template. + +Modifying Parameters of an Instance +----------------------------------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner and select a region and a project. + +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. + +#. In the navigation pane on the left, choose **Instance Management**. On the displayed page, click the DB instance whose parameters you wish to modify. + +#. In the navigation pane on the left, choose **Parameters**. On the displayed page, modify parameters as required. + + - To save the modifications, click **Save**. + - If you want to cancel the modifications, click **Cancel**. + - If you want to preview the modifications, click **Preview**. + +#. After parameters are modified, click **Change History** to view parameter modification details. + + For details about how to view parameter modification details, see :ref:`Viewing Parameter Change History `. + + .. important:: + + After you modify instance parameters, the modifications immediately take effect for the instance. + + Check the value in the **Effective upon Restart** column. + + - If the value is **Yes** and the instance status on the **Instance Management** page is **Pending restart**, restart the DB instance for the modifications to take effect. + - If the value is **No**, the modifications take effect immediately. + +Modifying Parameters in a Custom Parameter Template +--------------------------------------------------- + +#. Log in to the management console. + +#. Click |image2| in the upper left corner and select a region and a project. + +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. + +#. In the navigation pane on the left, click **Parameter Template Management**. + +#. On the **Parameter Template Management** page, click **Custom Templates**. Select the **Clusters**, **Replica Sets**, or **Single Nodes** sub-tab and click the parameter template you created. + +#. Modify the required parameters. + + - If you want to save the modifications, click **Save**. + - If you want to cancel the modifications, click **Cancel**. + - If you want to preview the modifications, click **Preview**. + +#. After parameters are modified, click **Change History** to view parameter modification details. + + For details about how to view parameter modification details, see :ref:`Viewing Parameter Change History `. + + .. important:: + + - The modifications take effect only after you apply the parameter template to instances. For details, see :ref:`Applying a Parameter Template `. + - The change history page displays only the modifications of the last seven days. + - For details about the parameter template statuses, see :ref:`DB Instance Status `. + - After modifying a parameter, view the associated instance status in the instance list. If **Pending restart** is displayed, restart the instance for the modification to take effect. For details, see :ref:`Restarting a DB Instance or a Node `. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png +.. |image2| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/modifying_the_description_of_a_parameter_template.rst b/umn/source/parameter_template_management/modifying_the_description_of_a_parameter_template.rst new file mode 100644 index 0000000..e4020c6 --- /dev/null +++ b/umn/source/parameter_template_management/modifying_the_description_of_a_parameter_template.rst @@ -0,0 +1,29 @@ +:original_name: dds_03_0044.html + +.. _dds_03_0044: + +Modifying the Description of a Parameter Template +================================================= + +Precautions +----------- + +The description of a default parameter template cannot be modified. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, click **Parameter Template Management**. +#. On the **Parameter Template Management** page, locate the target parameter template, and click |image2| in the **Description** column. +#. Enter new description information. The parameter template description contains a maximum of 256 characters and cannot contain the carriage return character and the following special characters: >!<"&'= + + - To submit the change, click |image3|. After the modification is successful, you can view the new description in the **Description** column of the parameter template list. + - To cancel the change, click |image4|. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png +.. |image2| image:: /_static/images/en-us_image_0000001224531664.png +.. |image3| image:: /_static/images/en-us_image_0000001224411716.png +.. |image4| image:: /_static/images/en-us_image_0000001269051821.png diff --git a/umn/source/parameter_template_management/replicating_a_parameter_template.rst b/umn/source/parameter_template_management/replicating_a_parameter_template.rst new file mode 100644 index 0000000..fe9dcdd --- /dev/null +++ b/umn/source/parameter_template_management/replicating_a_parameter_template.rst @@ -0,0 +1,32 @@ +:original_name: dds_03_0013.html + +.. _dds_03_0013: + +Replicating a Parameter Template +================================ + +You can replicate a parameter template you have created. + +Default parameter templates cannot be replicated, but you can create parameter templates based on the default ones. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner and select a region and a project. + +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. + +#. In the navigation pane on the left, click **Parameter Template Management**. + +#. On the **Parameter Template Management** page, select the **Clusters**, **Replica Sets**, or **Single Nodes** tab, locate the parameter template you want to replicate and click **Replicate** in the **Operation** column. + +#. In the displayed dialog box, enter the parameter template name and description and click **OK**. + + - **New Parameter Template**: The template name can be 4 to 64 characters long and starts with a letter. It can contain only letters, digits, hyphens (-), underscores (_), and periods (.). + - **Description**: The description contains a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'= + + After the parameter template is replicated, a new template is generated in the list on the **Parameter Template Management** page. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/resetting_a_parameter_template.rst b/umn/source/parameter_template_management/resetting_a_parameter_template.rst new file mode 100644 index 0000000..27df7d0 --- /dev/null +++ b/umn/source/parameter_template_management/resetting_a_parameter_template.rst @@ -0,0 +1,25 @@ +:original_name: dds_03_0015.html + +.. _dds_03_0015: + +Resetting a Parameter Template +============================== + +This section describes how to reset all parameters in a parameter template you create to the default settings as needed. + +Precautions +----------- + +Resetting a parameter template will restore all parameters in the parameter template to their default values. Exercise caution when performing this operation. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, click **Parameter Template Management**. +#. On the **Parameter Template Management** page, select the **Clusters**, **Replica Sets**, or **Single Nodes** tab, locate the parameter template you want to reset and choose **More** > **Reset** in the **Operation** column. +#. In the displayed dialog box, click **Yes**. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/viewing_application_records_of_a_parameter_template.rst b/umn/source/parameter_template_management/viewing_application_records_of_a_parameter_template.rst new file mode 100644 index 0000000..1970572 --- /dev/null +++ b/umn/source/parameter_template_management/viewing_application_records_of_a_parameter_template.rst @@ -0,0 +1,24 @@ +:original_name: dds_03_0113.html + +.. _dds_03_0113: + +Viewing Application Records of a Parameter Template +=================================================== + +An application record contains information about performed apply operations. You can view the application records of a parameter template. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. In the navigation pane on the left, click **Parameter Template Management**. +#. On the **Parameter Template Management** page, select the parameter template for which you want to view application records. + + - Click **Default Templates**. Locate the target parameter template and click **View Application Record**. + - Click **Custom Templates**. Locate the target parameter template and choose **More** > **View Application Record**. + +#. You can view the name or ID of the DB instance that the parameter template applies to, as well as the application status, application time, and the causes of any failures that have occurred. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/parameter_template_management/viewing_parameter_change_history.rst b/umn/source/parameter_template_management/viewing_parameter_change_history.rst new file mode 100644 index 0000000..9318028 --- /dev/null +++ b/umn/source/parameter_template_management/viewing_parameter_change_history.rst @@ -0,0 +1,40 @@ +:original_name: dds_03_0110.html + +.. _dds_03_0110: + +Viewing Parameter Change History +================================ + +You can view the change history of a parameter template. + +Precautions +----------- + +In a newly exported or created parameter template, the change history is blank. + +Viewing Change History of a Custom Parameter Template +----------------------------------------------------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner and select a region and a project. + +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. + +#. On the **Parameter Template Management** page, click **Custom Templates**. Locate the target parameter template and click its name. + +#. In the navigation pane on the left, choose **Change History**. Then, view the parameter name, original parameter value, new parameter value, modification status, and modification time. + + You can apply the parameter template to DB instances as required by referring to section :ref:`Applying a Parameter Template `. + +Viewing Change History of DB Instance Parameters +------------------------------------------------ + +#. Log in to the management console. +#. Click |image2| in the upper left corner and select a region and a project. +#. Click **Service List**. Under **Database**, click **Document Database Service** to go to the DDS console. +#. On the **Instance Management** page, click the target DB instance. The **Basic Information** page is displayed. +#. In the navigation pane on the left, click **Parameters**. On the **Change History** tab, view the parameter name, original parameter value, new parameter value, modification status, and modification time. + +.. |image1| image:: /_static/images/en-us_image_0000001268771757.png +.. |image2| image:: /_static/images/en-us_image_0000001268771757.png diff --git a/umn/source/permissions_management/creating_a_custom_policy.rst b/umn/source/permissions_management/creating_a_custom_policy.rst new file mode 100644 index 0000000..664f4d4 --- /dev/null +++ b/umn/source/permissions_management/creating_a_custom_policy.rst @@ -0,0 +1,98 @@ +:original_name: dds_03_0061.html + +.. _dds_03_0061: + +Creating a Custom Policy +======================== + +Custom policies can be created as a supplement to the system policies of DDS. For the actions supported for custom policies, see `DDS Actions `__. + +You can create custom policies in either of the following ways: + +- Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy syntax. +- JSON: Edit JSON policies from scratch or based on an existing policy. + +For details, see Creating a Custom Policy. The following section contains examples of common DDS custom policies. + +Example Custom Policies +----------------------- + +- Example 1: Allowing users to create DDS DB instances + + .. code-block:: text + + { + "Version": "1.1", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "dds:instance:create" + ] + } + ] + } + +- Example 2: Denying DDS DB instance deletion + + A deny policy must be used in conjunction with other policies to take effect. If the permissions assigned to a user contain both "Allow" and "Deny", the "Deny" permissions take precedence over the "Allow" permissions. + + The following method can be used if you need to assign permissions of the **DDS FullAccess** policy to a user but also forbid the user from deleting DDS DB instances. Create a custom policy for denying DDS DB instance deletion, and assign both policies to the group the user belongs to. Then the user can perform all operations on DDS except deleting DDS instances. The following is an example deny policy: + + .. code-block:: text + + { + "Version": "1.1", + "Statement": [ + { + "Effect": "Deny" + "Action": [ + "dds:instance:deleteInstance" + ], + } + ] + } + +- Example 3: Defining permissions for multiple services in a policy + + A custom policy can contain actions of multiple services that are all of the global or project-level type. The following is an example policy containing actions of multiple services: + + .. code-block:: text + + { + "Version": "1.1", + "Statement": [ + { + "Action": [ + "dds:instance:create", + "dds:instance:modify", + "dds:instance:deleteInstance", + "vpc:publicIps:list", + "vpc:publicIps:update" + ], + "Effect": "Allow" + } + ] + } + Example 4: Setting resource policies + A custom policy can be used to set resource policies, indicating the operation permissions on the resources under the current action. Currently, the instance name can be configured, and the asterisk (*) can be used as a wildcard. The following is an example resource policy: + { + "Version": "1.1", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "dds:instance:list" + ] + }, + { + "Effect": "Allow", + "Action": [ + "dds:instance:modify" + ], + "Resource": [ + "DDS:*:*:instanceName:dds-*" + ] + } + ] + } diff --git a/umn/source/permissions_management/creating_a_user_and_granting_permissions.rst b/umn/source/permissions_management/creating_a_user_and_granting_permissions.rst new file mode 100644 index 0000000..f09479b --- /dev/null +++ b/umn/source/permissions_management/creating_a_user_and_granting_permissions.rst @@ -0,0 +1,53 @@ +:original_name: dds_03_0060.html + +.. _dds_03_0060: + +Creating a User and Granting Permissions +======================================== + +This section describes how to use IAM to implement fine-grained permissions control for your DDS resources. With IAM, you can: + +- Create IAM users for employees based on the organizational structure of your enterprise. Each IAM user has their own security credentials, providing access to DDS resources. +- Grant only the permissions required for users to perform a task. +- Entrust an account or cloud service to perform professional and efficient O&M on your DDS resources. + +If your account does not need individual IAM users, then you may skip over this topic. + +This section describes the procedure for granting permissions (see :ref:`Figure 1 `). + +**Prerequisites** +----------------- + +Learn about the permissions (see :ref:`Permissions Management `) supported by DDS and choose policies or roles according to your requirements. For the system policies of other services, see Permissions Policies. + +Process Flow +------------ + +.. _dds_03_0060__fig15125554595: + +.. figure:: /_static/images/en-us_image_0000001490031014.png + :alt: **Figure 1** Process for granting DDS permissions + + **Figure 1** Process for granting DDS permissions + +#. .. _dds_03_0060__li124716231010: + + `Create a user group and assign permissions `__ to it. + + Create a user group on the IAM console, and assign the **DDS FullAccess** policy to the group. + + .. note:: + + To use some interconnected services, you also need to configure permissions of such services. + + For example, when using DAS to connect to a DB instance, you need to configure the DDS FullAccess and DAS FullAccess permissions. + +#. `Create an IAM user `__ and add it to a user group. + + Create a user on the IAM console and add the user to the group created in :ref:`1 `. + +#. `Log in `__ and verify permissions. + + Log in to the DDS console by using the newly created user, and verify that the user only has read permissions for DDS. + + Choose **Service List** > **Document Database Service** and click **Buy DB Instance**. If you can buy a DDS DB instance, the required permission policies have taken effect. diff --git a/umn/source/permissions_management/index.rst b/umn/source/permissions_management/index.rst new file mode 100644 index 0000000..988fd9c --- /dev/null +++ b/umn/source/permissions_management/index.rst @@ -0,0 +1,16 @@ +:original_name: dds_03_0062.html + +.. _dds_03_0062: + +Permissions Management +====================== + +- :ref:`Creating a User and Granting Permissions ` +- :ref:`Creating a Custom Policy ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_user_and_granting_permissions + creating_a_custom_policy diff --git a/umn/source/managing_dds_db_instances/tag.rst b/umn/source/tag_management.rst similarity index 56% rename from umn/source/managing_dds_db_instances/tag.rst rename to umn/source/tag_management.rst index 42f7300..7654f43 100644 --- a/umn/source/managing_dds_db_instances/tag.rst +++ b/umn/source/tag_management.rst @@ -2,36 +2,35 @@ .. _dds_03_0023: -Tag -=== +Tag Management +============== **Scenarios** ------------- -Tag Management Service (TMS) enables you to use tags on the management console to manage resources. TMS works with other cloud services to manage tags. TMS manages tags globally and other cloud services manage their own tags. +Tag Management Service (TMS) enables you to use tags on the management console to manage resources. Every cloud service is responsible for managing their own tags while TMS is responsible for the global tag management. Adding tags to DDS DB instances helps you better identify and manage them. A DB instance can be tagged during or after it is created. - You are advised to set predefined tags on the TMS console. - A tag consists of a key and value. You can add only one value for each key. For details about the naming rules of tag keys and tag values, see :ref:`Table 1 `. -- Each DB instance can have up to 20 tags. +- Up to 20 tags can be added for a DB instance. .. _dds_03_0023__table197401426182516: .. table:: **Table 1** Naming rules - +-----------------------+--------------------------------------------------------------------------------------------------+-----------------------+ - | Parameter | Requirement | Example | - +=======================+==================================================================================================+=======================+ - | Tag key | - Cannot be left blank. | Organization | - | | - For each DB instance, each tag key is unique. | | - | | - Consists of a maximum of 36 characters. | | - | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | | - +-----------------------+--------------------------------------------------------------------------------------------------+-----------------------+ - | Tag value | - Can be empty. | dds_01 | - | | - Consists of a maximum of 43 characters. | | - | | - The value can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | | - +-----------------------+--------------------------------------------------------------------------------------------------+-----------------------+ + +-----------------------+------------------------------------------------------------------------------------------------+-----------------------+ + | Parameter | Requirement | Example | + +=======================+================================================================================================+=======================+ + | Tag key | - The key cannot be left blank. | Organization | + | | - Each tag key must be unique for each DB instance. | | + | | - A tag key consists of up to 36 characters. | | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | | + +-----------------------+------------------------------------------------------------------------------------------------+-----------------------+ + | Tag value | - The value consists of up to 43 characters. | dds_01 | + | | - The key can only consist of digits, letters, underscores (_), hyphens (-), and at sign (@). | | + +-----------------------+------------------------------------------------------------------------------------------------+-----------------------+ Adding a Tag ------------ @@ -39,7 +38,7 @@ Adding a Tag #. :ref:`Log in to the DDS console. ` #. On the **Instance Management** page, click the target DB instance. #. In the navigation pane on the left, click **Tags**. -#. On the **Tags** page, click **Add Tag**. In the displayed dialog box, enter a tag key and value, and click **OK**. +#. On the **Tags** page, click **Add Tag**. In the displayed dialog box, enter a tag key and value (optional), and click **OK**. #. View and manage tags on the **Tags** page. Editing a Tag diff --git a/umn/source/task_center.rst b/umn/source/task_center.rst new file mode 100644 index 0000000..4f542aa --- /dev/null +++ b/umn/source/task_center.rst @@ -0,0 +1,53 @@ +:original_name: dds_03_0040.html + +.. _dds_03_0040: + +Task Center +=========== + +**Scenarios** +------------- + +This section describes how to view the progress and result of asynchronous tasks on the **Task Center** page. + +Tasks Overview +-------------- + +- Creating a snapshot backup +- Creating a cluster Instance +- Creating a replica set instance +- Creating a single node instance +- Scaling up storage space +- Changing the Community Edition instance +- Adding nodes +- Adding standby nodes to a replica set +- Restarting a cluster instance +- Restarting cluster nodes +- Restart a cluster node +- Restarting a replica set instance +- Restarting a single-node instance +- Switch Primary and Secondary Nodes +- Change Private IP Address +- Changing a security group +- Changing a database port +- Bind EIP +- Change AZ +- Enabling the shard/config IP address +- Modifying the oplog size +- Restoring to a new cluster instance +- Restoring to a new replica set instance +- Restoring to a new single-node instance +- Restoring a replica set instance to a point in time +- Creating a physical backup +- Creating a snapshot backup +- Restore Database and Table + +.. note:: + + Tasks that fail to be executed will be retained for seven days by default. + +Procedure +--------- + +#. :ref:`Log in to the DDS console. ` +#. In the navigation pane on the left, choose **Task Center**. Then, view the task progresses and results.