From be9e14a440918fc08f5e16d9433b898a6433db32 Mon Sep 17 00:00:00 2001 From: Kanchana Sekhar Date: Wed, 14 Sep 2022 10:05:30 -0700 Subject: [PATCH 001/212] DOCSP-24941 Add support for Chocholatey to the installation options --- source/install-atlas-cli.txt | 47 ++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index 2f8d9671..4964244a 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -52,6 +52,20 @@ To check whether your operating system is compatible with the sudo apt-get install gnupg + .. tab:: Chocolatey + :tabid: chocolatey + + Complete the Prerequisites + ~~~~~~~~~~~~~~~~~~~~~~~~~~ + + To install the {+atlas-cli+} using Chocolatey, you must do the + following: + + 1. Ensure that your system meets the `requirements + `__ for installing Chocolatey. + #. Install Chocolatey using ``cmd.exe`` or ``PowerShell.exe``. To + learn more, see `Installing Chocolatey `__. + .. tab:: Download Binary :tabid: download-binary @@ -358,6 +372,23 @@ Follow These Steps .. include:: /includes/steps-verify-atlas-cli.rst + .. tab:: Chocolatey + :tabid: chocolatey + + .. procedure:: + + .. step:: Install the {+atlas-cli+}. + + .. code-block:: shell + + choco install mongodb-atlas + + .. step:: When prompted, enter ``A`` to confirm installation. + + .. step:: Close and reopen your terminal after the installation to see the changes in your path. + + .. include:: /includes/steps-verify-atlas-cli.rst + .. tab:: Download Binary :tabid: download-binary @@ -495,6 +526,22 @@ method you used to install the {+atlas-cli+}: .. include:: /includes/steps-verify-update-atlas-cli.rst + .. tab:: Chocolatey + :tabid: chocolatey + + Follow These Steps + ~~~~~~~~~~~~~~~~~~ + + .. procedure:: + + .. step:: Install the {+atlas-cli+}. + + .. code-block:: shell + + choco upgrade mongodb-atlas + + .. include:: /includes/steps-verify-update-atlas-cli.rst + .. tab:: Download Binary :tabid: download-binary From b46cb45f440066d974536a798d4f97b21f200acb Mon Sep 17 00:00:00 2001 From: David Hou Date: Tue, 20 Sep 2022 16:48:25 -0400 Subject: [PATCH 002/212] add deb 11, remove deb 9 --- source/compatibility.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/compatibility.txt b/source/compatibility.txt index c94fcc4a..0679977b 100644 --- a/source/compatibility.txt +++ b/source/compatibility.txt @@ -23,7 +23,7 @@ systems: - 2 - ``x86-64``, ``ARM`` * - Debian - - 9, 10 + - 10, 11 - ``x86-64``, ``ARM`` * - MacOS - 10.0 and later From 0c87f16920f0725a3048c9247d11b908e4b3ab81 Mon Sep 17 00:00:00 2001 From: Kanchana Sekhar Date: Wed, 21 Sep 2022 12:48:40 -0700 Subject: [PATCH 003/212] DOCSP-25235 Add section on how to specifying a config file path --- source/atlas-cli-save-connection-settings.txt | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/source/atlas-cli-save-connection-settings.txt b/source/atlas-cli-save-connection-settings.txt index 821fec00..0006ed49 100644 --- a/source/atlas-cli-save-connection-settings.txt +++ b/source/atlas-cli-save-connection-settings.txt @@ -58,15 +58,22 @@ location depending on your operating system: $XDG_CONFIG_HOME/atlascli + By default, {+atlas-cli+} saves the configuration file in the + path defined in the ``$XDG_CONFIG_HOME`` environment variable. + You can modify the path defined in the ``$XDG_CONFIG_HOME`` + variable to your preferred location. To learn more about + modifying the ``$XDG_CONFIG_HOME`` variable, see `XDG Base + Directory Specification `__. + If ``$XDG_CONFIG_HOME`` is not set, the {+atlas-cli+} uses: .. code-block:: $HOME/.config/atlascli -The -{+atlas-cli+} grants the user who ran the command read and write access to -the file. + +The {+atlas-cli+} grants the user who ran the command read and write +access to the file. .. _atlas-cli-set-profile: From 165e3d498bc3e897c844c90c8f635eb5457cc8d3 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Sun, 16 Oct 2022 22:55:25 -0400 Subject: [PATCH 004/212] (DOCSP-25843) Release notes, source contstant updates for version 1.2.1 --- snooty.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index c0859fec..5c53abef 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,7 +25,7 @@ toc_landing_pages = [ aagent = "Automation Agent" atlas-cli = "Atlas CLI" atlas-cli-full = "MongoDB Atlas CLI" -atlas-cli-version = "1.1.7" +atlas-cli-version = "1.2.1" cloudgov = ":atlas:`MongoDB Atlas for Government `" cloudgov-short = "AtlasGov" cluster = "cluster" From 6b3139659bdc89151e3854bdab1d8d971ce5d38d Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Sun, 16 Oct 2022 22:57:58 -0400 Subject: [PATCH 005/212] Set submodule to 1.2.1 --- submodules/mongodb-atlas-cli | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index 2ac7d5cf..4b99a369 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit 2ac7d5cf94baa17b50e783a0f8a579695d9d0b4e +Subproject commit 4b99a36973db3b4014101d8721eb30c24f069b56 From 60f17951f325a9c1796081dcfd2df16740ad9f00 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Sun, 16 Oct 2022 23:11:58 -0400 Subject: [PATCH 006/212] Added release notes --- .vscode/settings.json | 3 +++ source/atlas-cli-changelog.txt | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/.vscode/settings.json b/.vscode/settings.json index e69de29b..a7d0fc7b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "esbonio.sphinx.confDir": "" +} \ No newline at end of file diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index e5a634af..5b704953 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -12,6 +12,38 @@ :depth: 1 :class: singlecol +.. _atlas-cli-1.2.1: + +{+atlas-cli+} 1.2.1 +------------------- + +Released 14 October 2022 + +{+atlas-cli+} v1.2.1 +-------------------- + +- Fixes internal release tooling. +- Makes ARM binaries available for installation with ``apt yum`` and ``dnf``. +- Adds support for Debian 11. + +{+atlas-cli+} v1.2.0 +-------------------- + +- Fixes a bug with the :ref:`atlas-customerDbRoles-list` command that + prevented printing the command's results. +- Fixes an issue with the :ref:`atlas-privateEndpoints-azure-interfaces-describe` + command where the output didn't display correctly. +- Adds the :ref:`atlas-processes-describe` command. +- Drops support for Debian 9. +- Fixes a bug where inviting users issued an error. +- Improves help text for the :ref:`atlas-backup-snapshot-create` command. +- Fixes a bug where login information wasn't stored at early exit while + asking about project ID and org ID. +- Adds a command to open the config file in your proffered editor. +- Adds a :ref:`backups-restores-watch` command. +- Adds the :ref:`atlas-alerts-settings-enable` and :ref:`atlas-alerts-settings-disable` + commands. + .. _atlas-cli-1.1.7: {+atlas-cli+} 1.1.7 From 3c1beb006bf402f00a063a372bc4fdf8f1ef5a62 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Sun, 16 Oct 2022 23:29:21 -0400 Subject: [PATCH 007/212] Removed vscode settings file that got added by mistake --- .vscode/settings.json | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index a7d0fc7b..00000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "esbonio.sphinx.confDir": "" -} \ No newline at end of file From 7632a174d2933019548b623ec21e0793c32629c0 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Sun, 16 Oct 2022 23:32:08 -0400 Subject: [PATCH 008/212] trigger build From 0c6bfd7a1e3564cd0b5556f485457c779ea062bf Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Mon, 17 Oct 2022 07:27:46 -0400 Subject: [PATCH 009/212] Tech review --- source/atlas-cli-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index 5b704953..edadf30f 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -39,7 +39,7 @@ Released 14 October 2022 - Improves help text for the :ref:`atlas-backup-snapshot-create` command. - Fixes a bug where login information wasn't stored at early exit while asking about project ID and org ID. -- Adds a command to open the config file in your proffered editor. +- Adds a command to open the config file in your preferred editor. - Adds a :ref:`backups-restores-watch` command. - Adds the :ref:`atlas-alerts-settings-enable` and :ref:`atlas-alerts-settings-disable` commands. From e32eef7ec4230eda714901d7c03238cb0d4b3d8b Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Mon, 17 Oct 2022 09:32:07 -0400 Subject: [PATCH 010/212] Fixing the build --- source/atlas-cli-changelog.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index edadf30f..1665db3e 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -29,18 +29,18 @@ Released 14 October 2022 {+atlas-cli+} v1.2.0 -------------------- -- Fixes a bug with the :ref:`atlas-customerDbRoles-list` command that +- Fixes a bug with the :ref:`atlas-customDbRoles-list` command that prevented printing the command's results. - Fixes an issue with the :ref:`atlas-privateEndpoints-azure-interfaces-describe` command where the output didn't display correctly. - Adds the :ref:`atlas-processes-describe` command. - Drops support for Debian 9. - Fixes a bug where inviting users issued an error. -- Improves help text for the :ref:`atlas-backup-snapshot-create` command. +- Improves help text for the :ref:`atlas-backups-snapshot-create` command. - Fixes a bug where login information wasn't stored at early exit while asking about project ID and org ID. - Adds a command to open the config file in your preferred editor. -- Adds a :ref:`backups-restores-watch` command. +- Adds a :ref:`atlas-backups-restores-watch` command. - Adds the :ref:`atlas-alerts-settings-enable` and :ref:`atlas-alerts-settings-disable` commands. From f430ed31e6c28888f86af4d8d63e50ccf4b448f6 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Mon, 17 Oct 2022 09:40:06 -0400 Subject: [PATCH 011/212] Fix the build --- source/atlas-cli-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index 1665db3e..d8f7bf49 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -36,7 +36,7 @@ Released 14 October 2022 - Adds the :ref:`atlas-processes-describe` command. - Drops support for Debian 9. - Fixes a bug where inviting users issued an error. -- Improves help text for the :ref:`atlas-backups-snapshot-create` command. +- Improves help text for the :ref:`atlas-backups-snapshots-create` command. - Fixes a bug where login information wasn't stored at early exit while asking about project ID and org ID. - Adds a command to open the config file in your preferred editor. From a3f6940503972b933143bd75c0542873037edc3f Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Mon, 17 Oct 2022 09:45:51 -0400 Subject: [PATCH 012/212] Edits --- source/atlas-cli-changelog.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index d8f7bf49..fb8aa019 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -19,16 +19,17 @@ Released 14 October 2022 -{+atlas-cli+} v1.2.1 --------------------- - - Fixes internal release tooling. - Makes ARM binaries available for installation with ``apt yum`` and ``dnf``. - Adds support for Debian 11. +.. _atlas-cli-1.2.0: + {+atlas-cli+} v1.2.0 -------------------- +Released 14 October 2022 + - Fixes a bug with the :ref:`atlas-customDbRoles-list` command that prevented printing the command's results. - Fixes an issue with the :ref:`atlas-privateEndpoints-azure-interfaces-describe` From 29c2f7072631360a47c95ad2a0723fd63529529e Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Mon, 17 Oct 2022 11:02:01 -0400 Subject: [PATCH 013/212] Copy review from Sarah --- source/atlas-cli-changelog.txt | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index fb8aa019..8ca64697 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -20,7 +20,8 @@ Released 14 October 2022 - Fixes internal release tooling. -- Makes ARM binaries available for installation with ``apt yum`` and ``dnf``. +- Makes ARM binaries available for installation with ``apt``, ``yum`` + and ``dnf``. - Adds support for Debian 11. .. _atlas-cli-1.2.0: @@ -34,16 +35,19 @@ Released 14 October 2022 prevented printing the command's results. - Fixes an issue with the :ref:`atlas-privateEndpoints-azure-interfaces-describe` command where the output didn't display correctly. -- Adds the :ref:`atlas-processes-describe` command. +- Adds the :ref:`atlas-processes-describe` command, which returns the details + for MongoDB process you specify. - Drops support for Debian 9. - Fixes a bug where inviting users issued an error. - Improves help text for the :ref:`atlas-backups-snapshots-create` command. - Fixes a bug where login information wasn't stored at early exit while asking about project ID and org ID. -- Adds a command to open the config file in your preferred editor. -- Adds a :ref:`atlas-backups-restores-watch` command. +- Adds the :ref:atlas-config-edit` command to open the config file in your + preferred editor. +- Adds a :ref:`atlas-backups-restores-watch` command, which watches for + a restore job to complete. - Adds the :ref:`atlas-alerts-settings-enable` and :ref:`atlas-alerts-settings-disable` - commands. + commands, which enable or disable the alert configuration you specify. .. _atlas-cli-1.1.7: From d9169aba1c7e072e69454180fbb4e74ae3f4672e Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Mon, 17 Oct 2022 11:09:17 -0400 Subject: [PATCH 014/212] Copy review from Sarah --- source/atlas-cli-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index 8ca64697..66b3c5a2 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -42,7 +42,7 @@ Released 14 October 2022 - Improves help text for the :ref:`atlas-backups-snapshots-create` command. - Fixes a bug where login information wasn't stored at early exit while asking about project ID and org ID. -- Adds the :ref:atlas-config-edit` command to open the config file in your +- Adds the :ref:`atlas-config-edit` command to open the config file in your preferred editor. - Adds a :ref:`atlas-backups-restores-watch` command, which watches for a restore job to complete. From ff0a75dd851605c692b5217f6ac4a3663df409b4 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Tue, 18 Oct 2022 21:58:52 -0400 Subject: [PATCH 015/212] (DOCSP-25907) Fix the Debian tabs --- source/index.txt | 4 ++-- source/install-atlas-cli.txt | 28 ++++++++++++++-------------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/source/index.txt b/source/index.txt index 4a34f685..ea2605ba 100644 --- a/source/index.txt +++ b/source/index.txt @@ -63,10 +63,10 @@ Get started quickly with two commands: #. Adds your IP address to your project's IP access list. #. Creates a MongoDB user for your |service| {+database-deployment+}. - #. Connect to your new {+database-deployment+} using the + #. Connects to your new {+database-deployment+} using the MongoDB Shell, {+mongosh+}. - To learn more, see the :doc:`atlas setup documentation `. + To learn more, see the :ref:`atlas-setup` command. .. image:: /images/setup.gif :alt: atlas setup command diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index 4964244a..fd19bbd9 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -16,8 +16,8 @@ Install the {+atlas-cli+} to quickly provision and manage |service| Install the {+atlas-cli+} ------------------------- -Select an installation method below and follow the steps to install the -{+atlas-cli+}. +Select one of the following installation methods and follow the steps to +install the {+atlas-cli+}. To check whether your operating system is compatible with the {+atlas-cli+}, see :ref:`compatibility-atlas-cli`. @@ -271,19 +271,19 @@ Follow These Steps .. tabs:: - .. tab:: Debian 10 (Buster) - :tabid: comm-deb-10 + .. tab:: Debian 11 (bullseye) + :tabid: comm-deb-11 .. code-block:: sh - echo "deb http://repo.mongodb.org/apt/debian buster/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb http://repo.mongodb.org/apt/debian/dists/bullseye/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list - .. tab:: Debian 9 (Stretch) - :tabid: comm-deb-9 + .. tab:: Debian 10 (buster) + :tabid: comm-deb-10 .. code-block:: sh - echo "deb http://repo.mongodb.org/apt/debian stretch/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb http://repo.mongodb.org/apt/debian/dists/buster/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: MongoDB Enterprise Edition :tabid: mdb-ent @@ -331,19 +331,19 @@ Follow These Steps .. tabs:: - .. tab:: Debian 10 (Buster) - :tabid: ent-deb-10 + .. tab:: Debian 11 (bullseye) + :tabid: ent-deb-11 .. code-block:: sh - echo "deb http://repo.mongodb.com/apt/debian buster/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb http://repo.mongodb.com/apt/dists/debian/bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list - .. tab:: Debian 9 (Stretch) - :tabid: ent-deb-9 + .. tab:: Debian 10 (bullseye) + :tabid: ent-deb-10 .. code-block:: sh - echo "deb http://repo.mongodb.com/apt/debian stretch/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb http://repo.mongodb.com/apt/dists/debian/buster/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. step:: Refresh the package database. From 1b6110a591eb1e48ac8a43287e0f17e941a9cd22 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Wed, 19 Oct 2022 21:06:05 -0400 Subject: [PATCH 016/212] Copy review and tech review, adjusted paths for Ubuntu and Debian, adding /dists --- source/install-atlas-cli.txt | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index fd19bbd9..149af2e7 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -244,21 +244,21 @@ Follow These Steps .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu/dists/jammy/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: Ubuntu 20.04 (Focal) :tabid: comm-focal .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu/dists/focal/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: Ubuntu 18.04 (Bionic) :tabid: comm-bionic .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu/dists/bionic/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: Debian :tabid: debian @@ -271,14 +271,14 @@ Follow These Steps .. tabs:: - .. tab:: Debian 11 (bullseye) + .. tab:: Debian 11 (Bullseye) :tabid: comm-deb-11 .. code-block:: sh echo "deb http://repo.mongodb.org/apt/debian/dists/bullseye/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list - .. tab:: Debian 10 (buster) + .. tab:: Debian 10 (Buster) :tabid: comm-deb-10 .. code-block:: sh @@ -306,21 +306,21 @@ Follow These Steps .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu jammy/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu/dists/jammy/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. tab:: Ubuntu 20.04 (Focal) :tabid: ent-focal .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu focal/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu/dists/focal/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. tab:: Ubuntu 18.04 (Bionic) :tabid: ent-bionic .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu bionic/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu/dists/bionic/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. tab:: Debian :tabid: debian @@ -331,19 +331,19 @@ Follow These Steps .. tabs:: - .. tab:: Debian 11 (bullseye) + .. tab:: Debian 11 (Bullseye) :tabid: ent-deb-11 .. code-block:: sh - echo "deb http://repo.mongodb.com/apt/dists/debian/bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb http://repo.mongodb.com/apt/dists/debian/dists/bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list - .. tab:: Debian 10 (bullseye) + .. tab:: Debian 10 (Buster) :tabid: ent-deb-10 .. code-block:: sh - echo "deb http://repo.mongodb.com/apt/dists/debian/buster/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb http://repo.mongodb.com/apt/debian/dists/buster/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. step:: Refresh the package database. From 5e291165ac6bd73a243d4c6ca3320277e546a7bb Mon Sep 17 00:00:00 2001 From: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> Date: Thu, 20 Oct 2022 13:47:01 -0400 Subject: [PATCH 017/212] (DOCSP-26031) Makes two small updates to quickstart tutorial (#73) --- source/atlas-cli-quickstart.txt | 7 ++++++- submodules/mongodb-atlas-cli | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/source/atlas-cli-quickstart.txt b/source/atlas-cli-quickstart.txt index 88e878bd..70fab64d 100644 --- a/source/atlas-cli-quickstart.txt +++ b/source/atlas-cli-quickstart.txt @@ -63,7 +63,7 @@ Click the tab to see the command for your preferred mode. - Cluster name: ``Quickstart-`` - Service provider: ``AWS`` - - Provider region: ``US_EAST-1`` + - Provider region: ``US_EAST_1`` - Cluster tier: ``M0`` - Disk size: ``0.5`` GB - Database Username: ``Quickstart-`` @@ -72,6 +72,11 @@ Click the tab to see the command for your preferred mode. - Load Sample Data: ``Yes`` - Open Shell: ``No`` + .. note:: + + The password is a random autogenerated value. ``abcdef12345`` + is an example value. + .. io-code-block:: .. input:: diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index 4b99a369..2ac7d5cf 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit 4b99a36973db3b4014101d8721eb30c24f069b56 +Subproject commit 2ac7d5cf94baa17b50e783a0f8a579695d9d0b4e From f29180e7f809564a8ae59f75acf24a8f30c52bde Mon Sep 17 00:00:00 2001 From: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> Date: Thu, 20 Oct 2022 13:48:05 -0400 Subject: [PATCH 018/212] Revert "(DOCSP-26031) Makes two small updates to quickstart tutorial (#73)" (#74) This reverts commit 5e291165ac6bd73a243d4c6ca3320277e546a7bb. --- source/atlas-cli-quickstart.txt | 7 +------ submodules/mongodb-atlas-cli | 2 +- 2 files changed, 2 insertions(+), 7 deletions(-) diff --git a/source/atlas-cli-quickstart.txt b/source/atlas-cli-quickstart.txt index 70fab64d..88e878bd 100644 --- a/source/atlas-cli-quickstart.txt +++ b/source/atlas-cli-quickstart.txt @@ -63,7 +63,7 @@ Click the tab to see the command for your preferred mode. - Cluster name: ``Quickstart-`` - Service provider: ``AWS`` - - Provider region: ``US_EAST_1`` + - Provider region: ``US_EAST-1`` - Cluster tier: ``M0`` - Disk size: ``0.5`` GB - Database Username: ``Quickstart-`` @@ -72,11 +72,6 @@ Click the tab to see the command for your preferred mode. - Load Sample Data: ``Yes`` - Open Shell: ``No`` - .. note:: - - The password is a random autogenerated value. ``abcdef12345`` - is an example value. - .. io-code-block:: .. input:: diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index 2ac7d5cf..4b99a369 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit 2ac7d5cf94baa17b50e783a0f8a579695d9d0b4e +Subproject commit 4b99a36973db3b4014101d8721eb30c24f069b56 From 550088080dbcc31a47eaeccbcf64800e294d14fd Mon Sep 17 00:00:00 2001 From: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> Date: Fri, 21 Oct 2022 07:55:02 -0400 Subject: [PATCH 019/212] (DOCSP-26031) Adds changes from MCLI quickstart edits (#76) --- source/atlas-cli-quickstart.txt | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/source/atlas-cli-quickstart.txt b/source/atlas-cli-quickstart.txt index 88e878bd..196f3b47 100644 --- a/source/atlas-cli-quickstart.txt +++ b/source/atlas-cli-quickstart.txt @@ -63,7 +63,7 @@ Click the tab to see the command for your preferred mode. - Cluster name: ``Quickstart-`` - Service provider: ``AWS`` - - Provider region: ``US_EAST-1`` + - Provider region: ``US_EAST_1`` - Cluster tier: ``M0`` - Disk size: ``0.5`` GB - Database Username: ``Quickstart-`` @@ -71,7 +71,12 @@ Click the tab to see the command for your preferred mode. - Allow connections from IP Address: ```` - Load Sample Data: ``Yes`` - Open Shell: ``No`` - + + .. note:: + + The password is a random autogenerated value. ``abcdef12345`` + is an example value. + .. io-code-block:: .. input:: From f58326d080ba104ea00dad80cc3564aaf4a88e12 Mon Sep 17 00:00:00 2001 From: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> Date: Thu, 27 Oct 2022 11:39:56 -0400 Subject: [PATCH 020/212] (DOCSP-26157) Adds link to cluster create command and config file (#80) * (DOCSP-26157) Adds link to cluster create command and config file * Includes changes from copy review --- source/atlas-cli-quickstart.txt | 5 +++++ submodules/mongodb-atlas-cli | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/source/atlas-cli-quickstart.txt b/source/atlas-cli-quickstart.txt index 196f3b47..a5343231 100644 --- a/source/atlas-cli-quickstart.txt +++ b/source/atlas-cli-quickstart.txt @@ -24,6 +24,11 @@ This tutorial demonstrates how to use the ``atlas quickstart`` command to: To perform all of these steps while also creating a new |service| account, see :ref:`atlas-cli-onboarding`. +To create a {+cluster+} using a configuration file, run the +:ref:`atlas-clusters-create` command with the ``--file`` option instead +of ``atlas quickstart``. To learn more about the configuration file +for an |service| {+cluster+}, see :ref:`atlas-cli-cluster-config-file`. + .. _atlas-cli-quick-start-reqs: Prerequisites diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index 4b99a369..2ac7d5cf 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit 4b99a36973db3b4014101d8721eb30c24f069b56 +Subproject commit 2ac7d5cf94baa17b50e783a0f8a579695d9d0b4e From f625cc0bf8fdaef36817cbe075ba7dd9c333bf2e Mon Sep 17 00:00:00 2001 From: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> Date: Thu, 17 Nov 2022 14:44:58 -0500 Subject: [PATCH 021/212] (DOCSP-26581) Adds release notes and updates version (#86) * (DOCSP-26581) Adds release notes and updates version * Sets submodule to v1.3.0 --- snooty.toml | 2 +- source/atlas-cli-changelog.txt | 18 ++++++++++++++++++ submodules/mongodb-atlas-cli | 2 +- 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/snooty.toml b/snooty.toml index 5c53abef..f27a441c 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,7 +25,7 @@ toc_landing_pages = [ aagent = "Automation Agent" atlas-cli = "Atlas CLI" atlas-cli-full = "MongoDB Atlas CLI" -atlas-cli-version = "1.2.1" +atlas-cli-version = "1.3.0" cloudgov = ":atlas:`MongoDB Atlas for Government `" cloudgov-short = "AtlasGov" cluster = "cluster" diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index 66b3c5a2..82b0c811 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -12,6 +12,24 @@ :depth: 1 :class: singlecol +.. _atlas-cli-1.3.0: + +{+atlas-cli+} 1.3.0 +------------------- + +Released 17 November 2022 + +- Adds new ``atlas clusters`` commands: + + - :ref:`atlas-clusters-advancedSettings-update` updates advanced + settings for your {+cluster+}. + + - :ref:`atlas-clusters-availableRegions-list` lists all + available regions where you can create {+clusters+}. + +- Enhances telemetry by detecting whether your operating system is + Debian, RPM, MSI, or Chocolatey. + .. _atlas-cli-1.2.1: {+atlas-cli+} 1.2.1 diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index 2ac7d5cf..9b51dd95 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit 2ac7d5cf94baa17b50e783a0f8a579695d9d0b4e +Subproject commit 9b51dd955e8b8a66340d1145ea00929b041ed561 From 1c2893053ff93d3a05769575a6305b0ae725638b Mon Sep 17 00:00:00 2001 From: Kanchana Sekhar Date: Tue, 13 Dec 2022 10:16:14 -0800 Subject: [PATCH 022/212] Release notes, redirects, source constant updates for 1.4.0 --- snooty.toml | 2 +- source/atlas-cli-changelog.txt | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index f27a441c..0a42036c 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,7 +25,7 @@ toc_landing_pages = [ aagent = "Automation Agent" atlas-cli = "Atlas CLI" atlas-cli-full = "MongoDB Atlas CLI" -atlas-cli-version = "1.3.0" +atlas-cli-version = "1.4.0" cloudgov = ":atlas:`MongoDB Atlas for Government `" cloudgov-short = "AtlasGov" cluster = "cluster" diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index 82b0c811..f7a33674 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -12,6 +12,23 @@ :depth: 1 :class: singlecol +.. _atlas-cli-1.4.0: + +{+atlas-cli+} 1.4.0 +------------------- + +Released 13 December 2022 + +- Fixes ``liveMigrations cutover`` command to take the ``orgId`` instead + of the ``projectId``. +- Adds options to the ``kubernetes config generate`` command for the + following: + + - Exporting |service| teams. + - Exporting private endpoints for serverless instances. + - Exporting resources from Atlas and convert them to the + :atlas:`AtlasOperator ` resources. + .. _atlas-cli-1.3.0: {+atlas-cli+} 1.3.0 From 4091e1a543e2a73b77c34e24b185aea70f3b69c2 Mon Sep 17 00:00:00 2001 From: Kanchana Sekhar Date: Tue, 13 Dec 2022 10:18:43 -0800 Subject: [PATCH 023/212] Set submodule to v1.4.0 --- submodules/mongodb-atlas-cli | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index 9b51dd95..a5eb069f 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit 9b51dd955e8b8a66340d1145ea00929b041ed561 +Subproject commit a5eb069f21c05e0cc3425f8d96219944b3b86cc2 From 2e4e8ab64a4e218449a3f2a11a339066eb4efe3f Mon Sep 17 00:00:00 2001 From: kanchana-mongodb <54281287+kanchana-mongodb@users.noreply.github.com> Date: Tue, 13 Dec 2022 10:32:21 -0800 Subject: [PATCH 024/212] Apply suggestions from code review Co-authored-by: Melissa Mahoney --- source/atlas-cli-changelog.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index f7a33674..ab2383de 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -17,11 +17,11 @@ {+atlas-cli+} 1.4.0 ------------------- -Released 13 December 2022 +Released 5 December 2022 -- Fixes ``liveMigrations cutover`` command to take the ``orgId`` instead +- Fixes the :ref:`atlas-liveMigrations-cutover` command to take the ``orgId`` instead of the ``projectId``. -- Adds options to the ``kubernetes config generate`` command for the +- Adds options to the :ref:`atlas-kubernetes-config-generate` command for the following: - Exporting |service| teams. From 4ab2e51f85d3f36b4976682bc8109febb1c05a35 Mon Sep 17 00:00:00 2001 From: Kanchana Sekhar Date: Tue, 13 Dec 2022 14:00:45 -0800 Subject: [PATCH 025/212] DOCSP-26855 updates for external review feedback --- source/atlas-cli-changelog.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index ab2383de..d0253283 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -19,14 +19,14 @@ Released 5 December 2022 -- Fixes the :ref:`atlas-liveMigrations-cutover` command to take the ``orgId`` instead - of the ``projectId``. +- Fixes the :ref:`atlas-liveMigrations-cutover` command to pass the + ``projectId`` instead of the ``orgId``. - Adds options to the :ref:`atlas-kubernetes-config-generate` command for the following: - Exporting |service| teams. - Exporting private endpoints for serverless instances. - - Exporting resources from Atlas and convert them to the + - Exporting resources from |service| and converting them to the :atlas:`AtlasOperator ` resources. .. _atlas-cli-1.3.0: From f6bdd90b882bcb4660e3198e6c0c17ba6f9abbdb Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 14 Dec 2022 11:43:01 -0500 Subject: [PATCH 026/212] DOCSP-27054 Edit AtlasCLI Ubuntu Install Links --- source/install-atlas-cli.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index 149af2e7..96360b8d 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -244,21 +244,21 @@ Follow These Steps .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu/dists/jammy/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: Ubuntu 20.04 (Focal) :tabid: comm-focal .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu/dists/focal/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: Ubuntu 18.04 (Bionic) :tabid: comm-bionic .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu/dists/bionic/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: Debian :tabid: debian @@ -306,21 +306,21 @@ Follow These Steps .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu/dists/jammy/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu jammy/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. tab:: Ubuntu 20.04 (Focal) :tabid: ent-focal .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu/dists/focal/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu focal/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. tab:: Ubuntu 18.04 (Bionic) :tabid: ent-bionic .. code-block:: sh - echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu/dists/bionic/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu bionic/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. tab:: Debian :tabid: debian From 105237401a31fcfd81ee2cdfd1c37dab28c64e3c Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Thu, 15 Dec 2022 10:19:49 -0500 Subject: [PATCH 027/212] fix debian versions --- source/install-atlas-cli.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index 96360b8d..6383012a 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -276,14 +276,14 @@ Follow These Steps .. code-block:: sh - echo "deb http://repo.mongodb.org/apt/debian/dists/bullseye/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb http://repo.mongodb.org/apt/debian bullseye/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: Debian 10 (Buster) :tabid: comm-deb-10 .. code-block:: sh - echo "deb http://repo.mongodb.org/apt/debian/dists/buster/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb http://repo.mongodb.org/apt/debian buster/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: MongoDB Enterprise Edition :tabid: mdb-ent @@ -336,14 +336,14 @@ Follow These Steps .. code-block:: sh - echo "deb http://repo.mongodb.com/apt/dists/debian/dists/bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb http://repo.mongodb.org/apt/debian bullseye/mongodb-org/6.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list .. tab:: Debian 10 (Buster) :tabid: ent-deb-10 .. code-block:: sh - echo "deb http://repo.mongodb.com/apt/debian/dists/buster/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb http://repo.mongodb.com/apt/debian buster/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. step:: Refresh the package database. From 8ff5a6557c2fbb575230f2109aa171d14734e96e Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Thu, 15 Dec 2022 10:20:26 -0500 Subject: [PATCH 028/212] insert constants for mdbversion on debian 11 --- source/install-atlas-cli.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index 6383012a..ae2b1633 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -336,7 +336,7 @@ Follow These Steps .. code-block:: sh - echo "deb http://repo.mongodb.org/apt/debian bullseye/mongodb-org/6.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list + echo "deb http://repo.mongodb.org/apt/debian bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list .. tab:: Debian 10 (Buster) :tabid: ent-deb-10 From a4fa3e311a99c9274bcb7427ce2a081846995ae5 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Thu, 15 Dec 2022 10:22:47 -0500 Subject: [PATCH 029/212] fix path --- source/install-atlas-cli.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index ae2b1633..f4dcd3b5 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -336,7 +336,7 @@ Follow These Steps .. code-block:: sh - echo "deb http://repo.mongodb.org/apt/debian bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list + echo "deb http://repo.mongodb.com/apt/debian bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list .. tab:: Debian 10 (Buster) :tabid: ent-deb-10 From bf4ec567c38c8b816f660ea6540ae26ba1a7da68 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Thu, 15 Dec 2022 10:23:54 -0500 Subject: [PATCH 030/212] fix enterprise path --- source/install-atlas-cli.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index f4dcd3b5..7f61cc61 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -336,7 +336,7 @@ Follow These Steps .. code-block:: sh - echo "deb http://repo.mongodb.com/apt/debian bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list + echo "deb http://repo.mongodb.com/apt/debian bullseye/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. tab:: Debian 10 (Buster) :tabid: ent-deb-10 From 02c21f137e672fe2b84d6d90270b9955192e63ae Mon Sep 17 00:00:00 2001 From: Evelyn Rabil Date: Thu, 22 Dec 2022 12:37:10 -0500 Subject: [PATCH 031/212] (DOCSP-26171) Adds example for geosharded cluster. --- source/cluster-config-file.txt | 11 ++- .../geosharded-cluster-config-file.json | 93 +++++++++++++++++++ 2 files changed, 102 insertions(+), 2 deletions(-) create mode 100644 source/includes/geosharded-cluster-config-file.json diff --git a/source/cluster-config-file.txt b/source/cluster-config-file.txt index 6c59f1a8..88b77e2c 100644 --- a/source/cluster-config-file.txt +++ b/source/cluster-config-file.txt @@ -168,11 +168,18 @@ following example file: .. _multi-cloud-example-cluster-config-file: -Multi-Cloud Example Cluster Configuration File +Example Multi-Cloud Cluster Configuration File ---------------------------------------------- To create a multi-cloud {+cluster+}, specify more than one service provider for your ``regionConfigs`` objects as shown in the following example file: -.. literalinclude:: /includes/json-cluster-config-file-multi.json \ No newline at end of file +.. literalinclude:: /includes/json-cluster-config-file-multi.json + +Example Geosharded Cluster Configuration File +--------------------------------------------- + +To create a :ref:`geosharded ` {+cluster+}, specify zones for your ``replicationSpecs`` objects as shown in the following example file: + +.. literalinclude:: /includes/geosharded-cluster-config-file.json \ No newline at end of file diff --git a/source/includes/geosharded-cluster-config-file.json b/source/includes/geosharded-cluster-config-file.json new file mode 100644 index 00000000..34b51334 --- /dev/null +++ b/source/includes/geosharded-cluster-config-file.json @@ -0,0 +1,93 @@ +{ + "backupEnabled": false, + "biConnector": { + "enabled": false, + "readPreference": "secondary" + }, + "clusterType": "GEOSHARDED", + "diskSizeGB": 100, + "encryptionAtRestProvider": "NONE", + "mongoDBMajorVersion": "5.0", + "name": "myCluster", + "paused": false, + "pitEnabled": false, + "stateName": "IDLE", + "replicationSpecs": [ + { + "numShards": 1, + "zoneName": "US-1", + "regionConfigs": [ + { + "analyticsSpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M30", + "nodeCount": 0 + }, + "electableSpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M30", + "nodeCount": 3 + }, + "readOnlySpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M30", + "nodeCount": 0 + }, + "autoScaling": { + "diskGB": { + "enabled": true + }, + "compute": { + "enabled": false, + "scaleDownEnabled": false + } + }, + "priority": 7, + "providerName": "AWS", + "regionName": "US_EAST_1" + } + ] + }, + { + "numShards": 1, + "zoneName": "US-2", + "regionConfigs": [ + { + "analyticsSpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M30", + "nodeCount": 0 + }, + "electableSpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M30", + "nodeCount": 3 + }, + "readOnlySpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M30", + "nodeCount": 0 + }, + "autoScaling": { + "diskGB": { + "enabled": true + }, + "compute": { + "enabled": false, + "scaleDownEnabled": false + } + }, + "priority": 7, + "providerName": "AWS", + "regionName": "US_EAST_2" + } + ] + } + ] + } \ No newline at end of file From 65e402b21f9d95007060ffc9210cf9a1c6d6a01f Mon Sep 17 00:00:00 2001 From: Evelyn Rabil Date: Thu, 22 Dec 2022 16:14:32 -0500 Subject: [PATCH 032/212] Adds required specs for geosharded clusters. --- source/cluster-config-file.txt | 41 +++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/source/cluster-config-file.txt b/source/cluster-config-file.txt index 88b77e2c..b458590e 100644 --- a/source/cluster-config-file.txt +++ b/source/cluster-config-file.txt @@ -150,10 +150,45 @@ Optional and Conditional {+Cluster+} Settings --------------------------------------------- Your {+cluster+} configuration file may contain additional optional or -conditional {+cluster+} settings. For a full list of available +conditional {+cluster+} settings. If you selected a ``clusterType`` of ``GEOSHARDED``, you must specify these {+cluster+} settings either +in the configuration file or as flags in the command: + +.. list-table:: + :header-rows: 1 + :widths: 20 10 70 + + * - Field + - Type + - Description + + * - ``replicationSpecs.`` + ``numShards`` + - string + - Positive integer that specifies the number of shards to deploy + in each specified zone. Provide this value if you set a + ``clusterType`` of ``SHARDED`` or ``GEOSHARDED``. Omit this + value if you selected a ``clusterType`` of ``REPLICASET``. + + This API resource accepts ``1`` through ``50``, inclusive. This + parameter defaults to ``1``. + + If you specify a ``numShards`` value of ``1`` and a + ``clusterType`` of ``SHARDED``, |service| deploys a single-shard + `sharded cluster `__. + + Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations. + + * - ``replicationSpecs.`` + ``zoneName`` + - string + - Name for the zone in a :ref:`Global Cluster `. + Provide this value if you set ``clusterType`` to ``GEOSHARDED``. + +For a full list of available settings, see the API documentation for -:atlas:`Create One Multi-Cloud Cluster from One Project -`. +:oas-atlas-op:`Create One Cluster ` and +:oas-atlas-op:`Create One Multi-Cloud Cluster from One Project +`. .. _example-cluster-config-file: From 733e6aad1e760dc0325a3d8295d34e8bf6742b1d Mon Sep 17 00:00:00 2001 From: Evelyn Rabil Date: Tue, 3 Jan 2023 09:28:21 -0700 Subject: [PATCH 033/212] Revises per copy review. --- source/cluster-config-file.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/cluster-config-file.txt b/source/cluster-config-file.txt index b458590e..4ff8f5eb 100644 --- a/source/cluster-config-file.txt +++ b/source/cluster-config-file.txt @@ -150,7 +150,7 @@ Optional and Conditional {+Cluster+} Settings --------------------------------------------- Your {+cluster+} configuration file may contain additional optional or -conditional {+cluster+} settings. If you selected a ``clusterType`` of ``GEOSHARDED``, you must specify these {+cluster+} settings either +conditional {+cluster+} settings. If you selected a ``clusterType`` of ``GEOSHARDED``, you must specify the following {+cluster+} settings either in the configuration file or as flags in the command: .. list-table:: @@ -174,7 +174,7 @@ in the configuration file or as flags in the command: If you specify a ``numShards`` value of ``1`` and a ``clusterType`` of ``SHARDED``, |service| deploys a single-shard - `sharded cluster `__. + :manual:`sharded cluster `. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations. From ecfd0c74fbc8e76abe24c216663c0d1712e9cfee Mon Sep 17 00:00:00 2001 From: David Hou Date: Thu, 9 Feb 2023 11:37:32 -0500 Subject: [PATCH 034/212] Release notes, redirects, source constant updates for 1.5.0 --- snooty.toml | 2 +- source/atlas-cli-changelog.txt | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 0a42036c..878e4483 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,7 +25,7 @@ toc_landing_pages = [ aagent = "Automation Agent" atlas-cli = "Atlas CLI" atlas-cli-full = "MongoDB Atlas CLI" -atlas-cli-version = "1.4.0" +atlas-cli-version = "1.5.0" cloudgov = ":atlas:`MongoDB Atlas for Government `" cloudgov-short = "AtlasGov" cluster = "cluster" diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index d0253283..3d6e8e41 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -12,6 +12,21 @@ :depth: 1 :class: singlecol +.. _atlas-cli-1.5.0: + +{+atlas-cli+} 1.5.0 +------------------- + +Released 9 February 2023 + +- Updates the :ref:`atlas-config-describe` command to no longer redact + public |api| keys. +- Updates the :ref:`atlas-customDbRoles-list` command to list + inherited roles. +- Deprecates the :ref:`atlas-integrations-create-NEW_RELIC>` command. +- Adds support for cluster termination protection. +- Improves help text and documentation for multiple commands. + .. _atlas-cli-1.4.0: {+atlas-cli+} 1.4.0 From 126bab4e7e7cf26bccdf411c9973ce2f9c7f681b Mon Sep 17 00:00:00 2001 From: David Hou Date: Thu, 9 Feb 2023 11:56:11 -0500 Subject: [PATCH 035/212] Set submodule to v1.5.0 --- source/atlas-cli-changelog.txt | 4 ++-- submodules/mongodb-atlas-cli | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index 3d6e8e41..08dc2ccb 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -21,8 +21,8 @@ Released 9 February 2023 - Updates the :ref:`atlas-config-describe` command to no longer redact public |api| keys. -- Updates the :ref:`atlas-customDbRoles-list` command to list - inherited roles. +- Updates the default output format for the :ref:`atlas-customDbRoles-list` + command to include inherited roles. - Deprecates the :ref:`atlas-integrations-create-NEW_RELIC>` command. - Adds support for cluster termination protection. - Improves help text and documentation for multiple commands. diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index a5eb069f..a3d64fc1 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit a5eb069f21c05e0cc3425f8d96219944b3b86cc2 +Subproject commit a3d64fc13b7ec5742f5b325f32eaf53a4cc0447a From 23ecc135892676e3b675ac0c594e73663022e304 Mon Sep 17 00:00:00 2001 From: David Hou Date: Thu, 9 Feb 2023 12:33:13 -0500 Subject: [PATCH 036/212] fix build error for release notes --- source/atlas-cli-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index 08dc2ccb..e0fd7f70 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -23,7 +23,7 @@ Released 9 February 2023 public |api| keys. - Updates the default output format for the :ref:`atlas-customDbRoles-list` command to include inherited roles. -- Deprecates the :ref:`atlas-integrations-create-NEW_RELIC>` command. +- Deprecates the :ref:`atlas-integrations-create-NEW_RELIC` command. - Adds support for cluster termination protection. - Improves help text and documentation for multiple commands. From 6d3be58867cae7cd788596252d0a66e034917228 Mon Sep 17 00:00:00 2001 From: David Hou Date: Thu, 9 Feb 2023 13:55:22 -0500 Subject: [PATCH 037/212] copy review --- source/atlas-cli-changelog.txt | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index e0fd7f70..761d85e4 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -23,8 +23,15 @@ Released 9 February 2023 public |api| keys. - Updates the default output format for the :ref:`atlas-customDbRoles-list` command to include inherited roles. -- Deprecates the :ref:`atlas-integrations-create-NEW_RELIC` command. -- Adds support for cluster termination protection. +- Deprecates the ``atlas-integrations-create-NEW_RELIC`` command. +- Adds support for cluster termination protection. + + - To enable cluster termination protection, run + :ref:`atlas-clusters-create` or :ref:`atlas-clusters-update` + with the ``--enableTerminationProtection`` option. + - To disable cluster termination protection, run :ref:`atlas-clusters-update` + with the ``--disableTerminationProtection`` option. + - Improves help text and documentation for multiple commands. .. _atlas-cli-1.4.0: From b8a5f1e39f509654dde099877c635588ee1b8822 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Tue, 14 Feb 2023 00:00:27 -0500 Subject: [PATCH 038/212] (DOCSP-26322) Added an IP access list restriction --- source/connect-atlas-cli.txt | 10 ++++++++++ submodules/mongodb-atlas-cli | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/source/connect-atlas-cli.txt b/source/connect-atlas-cli.txt index 07b132b1..c27731f9 100644 --- a/source/connect-atlas-cli.txt +++ b/source/connect-atlas-cli.txt @@ -96,6 +96,16 @@ Complete the Prerequisites - :ref:`Install the {+atlas-cli+} `. - Add your host's IP address to the :ref:`IP access list `. + + If you log into the {+atlas-cli+} with your Atlas user credentials, + and your organization's owners enable + :atlas:`IP access list for the Atlas UI for an organization + `, + then to run any commands in this organization, your IP address must + be included in the IP access list or CIDR ranges defined in that list. + To learn more, see :atlas:`Require IP Access List for the Atlas UI + `. + .. tab:: Programmatic Use :tabid: atlas-config-init diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index a3d64fc1..39507b21 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit a3d64fc13b7ec5742f5b325f32eaf53a4cc0447a +Subproject commit 39507b21e19734762cdedb19e9e7c7b7b5ee4c5a From 49efee12d33b43c6fd0a3ca85b6767699a5b30e7 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Tue, 14 Feb 2023 08:51:30 -0500 Subject: [PATCH 039/212] Copy review --- source/connect-atlas-cli.txt | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/source/connect-atlas-cli.txt b/source/connect-atlas-cli.txt index c27731f9..7ef486df 100644 --- a/source/connect-atlas-cli.txt +++ b/source/connect-atlas-cli.txt @@ -97,13 +97,11 @@ Complete the Prerequisites - :ref:`Install the {+atlas-cli+} `. - Add your host's IP address to the :ref:`IP access list `. - If you log into the {+atlas-cli+} with your Atlas user credentials, - and your organization's owners enable - :atlas:`IP access list for the Atlas UI for an organization + If you authenticate with your |service| user credentials + and your organization's owners enable :atlas:`IP access list for the Atlas UI for an organization `, - then to run any commands in this organization, your IP address must - be included in the IP access list or CIDR ranges defined in that list. - To learn more, see :atlas:`Require IP Access List for the Atlas UI + your IP address must be added to the IP access list to run commands + in this organization. To learn more, see :atlas:`Require IP Access List for the Atlas UI `. From 724376160631653ce76b64d199a801f4c009b0a2 Mon Sep 17 00:00:00 2001 From: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> Date: Thu, 16 Feb 2023 11:45:54 -0500 Subject: [PATCH 040/212] (DOCSP-28106) Release notes and source constant updates for v1.5.1 (#101) * (DOCSP-28106) Release notes and source constant updates for v1.5.1 * Sets submodule to atlascli/v1.5.1 --- snooty.toml | 2 +- source/atlas-cli-changelog.txt | 11 +++++++++++ submodules/mongodb-atlas-cli | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/snooty.toml b/snooty.toml index 878e4483..74783d6d 100644 --- a/snooty.toml +++ b/snooty.toml @@ -25,7 +25,7 @@ toc_landing_pages = [ aagent = "Automation Agent" atlas-cli = "Atlas CLI" atlas-cli-full = "MongoDB Atlas CLI" -atlas-cli-version = "1.5.0" +atlas-cli-version = "1.5.1" cloudgov = ":atlas:`MongoDB Atlas for Government `" cloudgov-short = "AtlasGov" cluster = "cluster" diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index 761d85e4..180abdde 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -12,6 +12,17 @@ :depth: 1 :class: singlecol +.. _atlas-cli-1.5.1: + +{+atlas-cli+} 1.5.1 +------------------- + +Released 16 February 2023 + +- Fixes a bug in the :ref:`atlas-kubernetes-config-generate` command + that could produce ``AtlasDatabaseUser`` resources with the same resource name for different users. +- Improves help text and documentation for multiple commands. + .. _atlas-cli-1.5.0: {+atlas-cli+} 1.5.0 diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index a3d64fc1..a6661aed 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit a3d64fc13b7ec5742f5b325f32eaf53a4cc0447a +Subproject commit a6661aede4821881111b51a9c5f0d921e7d000c6 From 32e662d8d372497ce006e6a041d8802aaa2c5e89 Mon Sep 17 00:00:00 2001 From: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> Date: Thu, 16 Feb 2023 11:51:26 -0500 Subject: [PATCH 041/212] (DOCSP-28106) Release notes and source constant updates for v1.5.1 (#101) (#102) * (DOCSP-28106) Release notes and source constant updates for v1.5.1 * Sets submodule to atlascli/v1.5.1 From 32d59a1a23a415e11a854810ee4aac6cc9f1fed0 Mon Sep 17 00:00:00 2001 From: "Julia.Malkin" Date: Tue, 21 Feb 2023 11:05:31 -0500 Subject: [PATCH 042/212] Adding newer submodules --- submodules/mongodb-atlas-cli | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli index 39507b21..a6661aed 160000 --- a/submodules/mongodb-atlas-cli +++ b/submodules/mongodb-atlas-cli @@ -1 +1 @@ -Subproject commit 39507b21e19734762cdedb19e9e7c7b7b5ee4c5a +Subproject commit a6661aede4821881111b51a9c5f0d921e7d000c6 From 13d2a953dea00ba6320c543ad889bc613bb0e924 Mon Sep 17 00:00:00 2001 From: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> Date: Mon, 6 Mar 2023 11:00:16 -0500 Subject: [PATCH 043/212] (DOCSP-28387)(DOCSP-28289) Adds troubleshooting page (#105) * (DOCSP-28064) Changes incorrect include file for programmatic steps * (DOCSP-28387)(DOCSP-28289) Adds troubleshooting page * Includes changes from copy and tech reviews --- source/index.txt | 1 + source/troubleshooting.txt | 124 +++++++++++++++++++++++++++++++++++++ 2 files changed, 125 insertions(+) create mode 100644 source/troubleshooting.txt diff --git a/source/index.txt b/source/index.txt index ea2605ba..0448512b 100644 --- a/source/index.txt +++ b/source/index.txt @@ -117,4 +117,5 @@ Learn the {+atlas-cli+} commands and optimize your workflow with advanced tutori /atlas-cli-tutorials Atlas CLI Commands /reference + /troubleshooting /atlas-cli-changelog \ No newline at end of file diff --git a/source/troubleshooting.txt b/source/troubleshooting.txt new file mode 100644 index 00000000..a4673395 --- /dev/null +++ b/source/troubleshooting.txt @@ -0,0 +1,124 @@ +:noprevnext: + +.. _atlas-cli-troubleshooting: + +=================== +Troubleshoot Errors +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Command Errors +-------------- + +Error: missing credentials +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Ensure that you either: + +- Run ``atlas config init`` and add your API keys to your + :ref:`profile ` or add your API keys to your + :ref:`environment variables `. If you created a + profile with a custom name or are using more than one profile, + specify the correct profile with the ``--profile`` flag. +- Run ``atlas auth login`` to authenticate using your |service| login + credentials and an authentication token. + +To learn more, see :ref:`connect-atlas-cli`. + +atlas: command not found +~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``atlas`` executable might be in a directory that isn't in your +$PATH. You can either add the directory to your $PATH, move the +executable to a directory which is in your $PATH, or run the executable +directly from its location. + +400 (request "TENANT_ATTRIBUTE_READ_ONLY") The attribute pitEnabled is read-only for tenant clusters and cannot be changed by the user. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This error might appear if you try to run :ref:`atlas-clusters-create` +with the ``--backup`` argument for a shared {+cluster+}. The +``--backup`` argument is unavailable for clusters smaller than ``M10``. + +401 (request "Unauthorized") You are not authorized for this resource. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The credentials you provided aren't valid for the project +specified in your {+atlas-cli+} command. Check your public and private +key strings for accuracy. + +If your credentials are stored in a :ref:`configuration file +`, make sure that the configuration file is in the +correct location. To learn more, see :ref:`config-toml-location`. If +the {+atlas-cli+} can't find your configuration file and you don't +store credentials in :ref:`environment variables `, +a ``401`` error will result. + +401 (request "Unauthorized") Current user is not authorized to perform this action. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The user account or API key that you used to +:ref:`connect to the {+atlas-cli+} ` +doesn't have permission to perform the requested action. User accounts +and API keys must have the appropriate :atlas:`user roles ` +to run {+atlas-cli+} commands. To assign or change a user's roles, see: + +- :atlas:`add-org-users` +- :atlas:`manage-project-access` +- :atlas:`API configuration ` + +401 (request "Unauthorized") The currently logged in user does not have the group creator role in organization . +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This error might appear when trying to create a new +:atlas:`project `. The user account or API +key that you use to authenticate must have the +``Organization Project Creator`` role at the +:atlas:`organization level ` in order +to create new projects. + +403 (request "Forbidden") IP address is not allowed to access this resource. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The user's IP address or API key that you use to authenticate is not on +the :atlas:`access list ` for the requested +project. Add your IP address or API key to the +:atlas:`access list ` to run commands. + +404 (request "Not Found") An invalid group ID was specified. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The project ID entered with the command does not exist. Check your +project ID by navigating to the :guilabel:`Settings` sub-section of the +:guilabel:`Project` section in the |service| left-side navigation. + +.. note:: + + ``group ID`` and ``project ID`` are synonymous in MongoDB cloud services. + +Alert Config Not Deleted +~~~~~~~~~~~~~~~~~~~~~~~~~ +This error might appear if the {+atlas-cli+} can't delete the alert +configuration specified by the ID. + +Configuration Errors +-------------------- + +Blank output when reading home directory +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This error might appear if the {+atlas-cli+} can't access your home +directory. + +HOMEDRIVE, HOMEPATH, or USERPROFILE are blank +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This error might appear if the {+atlas-cli+} can't access your home +directory. From 80b2d9c87efddb69a567895c2cb55b7c68d012f7 Mon Sep 17 00:00:00 2001 From: pierwill <19642016+pierwill@users.noreply.github.com> Date: Mon, 13 Mar 2023 10:15:39 -0500 Subject: [PATCH 044/212] DOCSP-25516 Add missing content on custom output (#103) Co-authored-by: sarahsimpers <82042374+sarahsimpers@users.noreply.github.com> --- source/configure-optional-settings.txt | 3 +- source/custom-output-cli.txt | 245 +++++++++++++++++++++++++ 2 files changed, 247 insertions(+), 1 deletion(-) create mode 100644 source/custom-output-cli.txt diff --git a/source/configure-optional-settings.txt b/source/configure-optional-settings.txt index d9779897..5639af3a 100644 --- a/source/configure-optional-settings.txt +++ b/source/configure-optional-settings.txt @@ -13,4 +13,5 @@ Configure Optional Settings .. toctree:: - /telemetry \ No newline at end of file + /telemetry + /custom-output-cli diff --git a/source/custom-output-cli.txt b/source/custom-output-cli.txt new file mode 100644 index 00000000..db1c3e5d --- /dev/null +++ b/source/custom-output-cli.txt @@ -0,0 +1,245 @@ +.. _go-template-output: + +================================== +Customize the {+atlas-cli+} Output +================================== + +.. default-domain:: mongodb + +You can customize the {+atlas-cli+} output fields and format using a Go +template or a JSON path, which makes it easier to automate processes based on the +output from the {+atlas-cli+}. + +Go templates +------------ + +You can specify a Go template within any {+atlas-cli+} command +or through a separate file. To learn more about +Go templates, see `Package template `__. +To learn the types and properties available for each response, see +`Atlas types `__. + +Syntax +~~~~~~ + +You can specify a template with the command using the ``--output`` or +``-o`` option: + +.. code-block:: shell + :copyable: false + + --output|-o go-template="{{