diff --git a/.github/prompts/eol-branch.prompt.md b/.github/prompts/eol-branch.prompt.md new file mode 100644 index 00000000..fe79b464 --- /dev/null +++ b/.github/prompts/eol-branch.prompt.md @@ -0,0 +1,54 @@ + + +You are an agent that will help sunset a version of our docs. The user will provide the version number (e.g. v1.20). Complete the following tasks: + +1. Open the `snooty.toml` file and make the following changes: + +- Add `eol = true` to line 3. +- Add the following code where other banners are located in the file. Don't forget the closing quotations. + +``` +[[banners]] + targets = ["*"] + variant = "info" + value = """\ + This version of the documentation is archived and no longer supported. View the `current documentation `__ to learn how to `upgrade your version of the Atlas CLI `__.\ + """ +``` + +2. Create a new file named `NoindexEntireSource.sh` that contains the following code: + +``` +#!/bin/sh +while getopts p: flag +do + case "${flag}" in + p) project=${OPTARG};; + esac +done +echo "Adding noindex to all files in $project..." +# Use find to recursively search for .txt files in the source directory and noindex them +find ~/"$project"/source -type f -name "*.txt" | while read -r file; do + sed -i '' "1s%^%.. meta::\n :robots: noindex, nosnippet \n\n%" "$file" +done +``` + +3. Run the following command in the terminal: `sh /NoindexEntireSource.sh -p docs-atlas-cli`, replacing `` with the path to `NoindexEntireSource.sh`. + +For example: `sh ~/Projects/NoindexEntireSource.sh -p Projects/docs-atlas-cli` + +This script should add the following code to the top of every file in the repo: + +``` +.. meta:: + :robots: noindex, nosnippet +``` + +4. Then, create a PR with these changes by performing the following actions: + +- Run `git status` +- Run `git add -- ':!submodules/mongodb-atlas-cli'`. This is to add all files to the commit except for the submodules files. +- Generate a short PR description like "Sunset v1.20" and run `gcmsg ""` in the terminal. +- Generate a descriptive PR title like "Sunset Atlas CLI v1.20" and Run `gh pr create --title "(): "`. Replace the placeholders with appropriate values. + +The user will finalize the PR via the terminal prompts. \ No newline at end of file diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md new file mode 100644 index 00000000..861117c7 --- /dev/null +++ b/.github/pull-request-template.md @@ -0,0 +1,19 @@ +<!-- Add a description of your PR here (optional) --> + +- [DOCSP-number](https://jira.mongodb.org/browse/) +- [STAGING](paste the link to staging here) + +- [LATEST BUILD LOG](paste the build here) + +### Self-Review Checklist + +- [ ] Check that the submodule pulled in the right changes (if applicable). +- [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. +- [ ] Add genre facets (tutorial or reference), as in this [example PR](https://github.com/10gen/cloud-docs/pull/5042). +- [ ] Add programmingLanguage (if necessary). +- [ ] Add meta keywords (if necessary). +- [ ] Resolve any new warnings or errors in the build. +- [ ] Proofread for spelling and grammatical errors. +- [ ] Check staging for rendering issues. +- [ ] Confirm links are working. + diff --git a/.gitignore b/.gitignore index 7da98d39..51c22d7c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .DS_Store .vscode/settings.json -settings.json \ No newline at end of file +settings.json +NoindexEntireSource.sh \ No newline at end of file diff --git a/.gitmodules b/.gitmodules index 300ac4c0..e69de29b 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +0,0 @@ -[submodule "submodules/mongodb-atlas-cli"] - path = submodules/mongodb-atlas-cli - url = https://github.com/mongodb/mongodb-atlas-cli.git diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index e69de29b..00000000 diff --git a/build.sh b/build.sh new file mode 100644 index 00000000..a5e15032 --- /dev/null +++ b/build.sh @@ -0,0 +1,7 @@ +# ensures that we always use the latest version of the script +if [ -f build-site.sh ]; then + rm build-site.sh +fi + +curl https://raw.githubusercontent.com/mongodb/docs-worker-pool/netlify-poc/scripts/build-site.sh -o build-site.sh +sh build-site.sh diff --git a/config/redirects b/config/redirects index 47c334b2..5f946552 100644 --- a/config/redirects +++ b/config/redirects @@ -1,4 +1,20 @@ define: base https://www.mongodb.com/docs/atlas/cli -define: versions v1.0 master - +define: versions v1.0 v1.1 v1.2 v1.3 v1.4 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11 v1.12 v1.13 v1.14 v1.15 v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 v1.22 v1.23 master +symlink: upcoming -> master +symlink: v1.24 -> master +symlink: stable -> v1.23 + raw: docs/atlas/cli/ -> ${base}/stable/ +raw: docs/atlas/cli/stable/cluster-config-file -> ${base}/stable/reference/json/cluster-config-file + +# DOCSP-28477 -- I looked in the docs content source and was unable to find where these malformed links were. so adding redirects to prevent future 404s + +raw: docs/atlas/cli/stablecommand/atlas-config-describe/ -> ${base}/stable/command/atlas-config-describe/ +raw: docs/atlas/cli/stablecommand/atlas-liveMigrations-create/ -> ${base}/stable/command/atlas-liveMigrations-create/ +raw: docs/atlas/cli/stablecommand/atlas-liveMigrations-link-create/ -> ${base}/stable/command/atlas-liveMigrations-link-create/ +raw: docs/atlas/cli/stablecommand/atlas-liveMigrations-validation-create/ -> ${base}/stable/command/atlas-liveMigrations-validation-create/ +raw: docs/atlas/cli/stablecommand/atlas-privateEndpoints-onlineArchive-aws-describe/ -> ${base}/stable/command/atlas-privateEndpoints-onlineArchive-aws-describe/ + +# Atlas CLI Version 1.6 and later + +[v1.6-*]: docs/atlas/cli/${version}/cluster-config-file -> ${base}/${version}/reference/json/cluster-config-file \ No newline at end of file diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 00000000..d0c89040 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,6 @@ +[[integrations]] +name = "snooty-cache-plugin" + +[build] +publish = "snooty/public" +command = ". ./build.sh" diff --git a/snooty.toml b/snooty.toml index c0859fec..71e3a04f 100644 --- a/snooty.toml +++ b/snooty.toml @@ -1,5 +1,6 @@ name = "atlas-cli" -title = "Atlas Command Line Interface" +title = "Atlas CLI" +eol = true intersphinx = [ "https://www.mongodb.com/docs/ops-manager/current/objects.inv", "https://www.mongodb.com/docs/manual/objects.inv", @@ -10,22 +11,29 @@ intersphinx = [ "https://www.mongodb.com/docs/ops-manager/current/objects.inv", toc_landing_pages = [ "/atlas-cli-changelog", "/atlas-cli-env-variables", + "/atlas-cli-automate", "/atlas-cli-profiles", "/atlas-cli-quickstart", "/atlas-cli-tutorials", + "/atlas-cli-local-cloud", "/command/atlas", "/compatibility", "/connect-atlas-cli", "/install-atlas-cli", "/migrate-to-atlas-cli", + "/reference/json", "/telemetry" ] [constants] aagent = "Automation Agent" +adf = "Atlas Data Federation" atlas-cli = "Atlas CLI" atlas-cli-full = "MongoDB Atlas CLI" -atlas-cli-version = "1.1.7" +atlas-cli-version = "1.23.0" +ak8so = "Atlas Kubernetes Operator" +atlas-sp = "Atlas Stream Processing" +avs = "Atlas Vector Search" cloudgov = ":atlas:`MongoDB Atlas for Government </government>`" cloudgov-short = "AtlasGov" cluster = "cluster" @@ -39,12 +47,16 @@ data-lake-store = "data store" database-deployment = "database deployment" database-deployments = "database deployments" default-profile = ":ref:`default profile <mcli-profiles>`" +df = "Data Federation" +FDI = "Federated Database Instance" +fdi = "federated database instance" mcli = "MongoDB CLI" mcli-long = "MongoDB Command Line Interface (``mongocli``)" mcli-version = "1.23.1" mdbagent = "MongoDB Agent" -mdbVersion = "6.0" +mdbVersion = "7.0" mongosh = ":binary:`~bin.mongosh`" +oidc = ":abbr:`OIDC (OpenID Connect)`" [substitutions] a-application = "an Ops Manager Application" @@ -106,17 +118,24 @@ utc = ":abbr:`UTC (Coordinated Universal Time)`" vpc = ":abbr:`VPC (Virtual Private Cloud)`" [[banners]] -targets = ["command/atlas-dataLakes*.txt"] +targets = ["command/atlas-dataLakePipelines*.txt"] +variant = "warning" +value = """\ + **Data Lake is deprecated.** \ + As of September 2024, Data Lake is deprecated and will reach end-of-life. It will be removed on September 30, 2025. If you use Data Lake, you should migrate to alternative solutions before the service is removed. To learn more, see :adl:`Migration Guide </data-lake-deprecation/>`\ + """ + +[[banners]] +targets = ["*"] variant = "info" value = """\ - ``atlas dataLakes`` commands control the functionality previously \ - named Data Lake, which is now called \ - `Data Federation <https://www.mongodb.com/docs/atlas/data-federation/>`__ \ - in the Atlas UI. The ``atlas dataLakes`` commands will \ - continue to work for Data Federation without interruption. \ - MongoDB's new \ - `Data Lake <https://www.mongodb.com/docs/datalake/>`__ \ - functionality doesn't include CLI commands. When we introduce a \ - new set of CLI commands for our new Data Lake functionality, we \ - will reach out to you to prevent any interruption of service.\ + This version of the documentation is archived and no longer supported. View the `current documentation <https://www.mongodb.com/docs/atlas/cli/current/>`__ to learn how to `upgrade your version of the Atlas CLI <https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli/>`__.\ """ + +[[banners]] +targets = ["command/atlas-deployments*.txt"] +variant = "warning" +value = """\ + **Public Preview.** \ + The ``atlas deployments`` command and subsequent related commands are available as a Public Preview. The feature and corresponding documentation may change at any time in the Public Preview stage. To ask questions and provide feedback, see the `Atlas CLI Local Development Community Forum <https://www.mongodb.com/community/forums/tag/local-dev-atlas-cli>`__.\ + """ \ No newline at end of file diff --git a/source/atlas-cli-automate.txt b/source/atlas-cli-automate.txt new file mode 100644 index 00000000..bc1e7579 --- /dev/null +++ b/source/atlas-cli-automate.txt @@ -0,0 +1,114 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-automate: + +========================================= +Automate Processes with the {+atlas-cli+} +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +To automate a process with the {+atlas-cli+} in a script, use +the following resources and best practices as guidance. + +To learn how to connect to the {+atlas-cli+} programmatically, see +the :guilabel:`Programmatic User` tabs on :ref:`connect-atlas-cli`. + +Resources for Automation with the {+atlas-cli+} +----------------------------------------------- + +.. list-table:: + :header-rows: 1 + :widths: 40 60 + + * - Resource + - Objective + + * - :ref:`atlas-cli-env-vars` + - Set environment variables that you can define once and use + across all of your scripts. + + * - :ref:`go-template-output` + - Use Go templates or |json| paths to customize the output from + the {+atlas-cli+}. You can include the anticipated custom output in your scripts. + +Best Practices for Automation with the {+atlas-cli+} +---------------------------------------------------- + +Follow these best practices when you automate processes with the +{+atlas-cli+}: + +Use |service| Private Keys +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When you create a script to automate processes, we recommend that you +use |service| :ref:`private keys <atlas-admin-api-access>` to access +|service|. {+atlas-cli+} login sessions last for twelve hours, +after which you must login again to access |service|. Use |service| +:ref:`private keys <atlas-admin-api-access>` for continued access to +|service|. + +Base Your Script on the Version of the {+atlas-cli+} that You Run +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When you create a script to automate processes, you should base the +script on the version of the {+atlas-cli+} that you currently run. +**Don't** build automatic upgrades for the {+atlas-cli+} into your +script because new {+atlas-cli+} releases could introduce breaking +changes, which could break your automated processes. + +Instead, check release notes for deprecated features and +breaking changes before you manually upgrade your version of the +{+atlas-cli+}. + +.. _atlas-cli-redirect-stderr: + +Redirect ``stderr`` +~~~~~~~~~~~~~~~~~~~ + +The {+atlas-cli+} prints error messages and command deprecation +warnings in the output for commands. These unanticipated error messages +and warnings can cause issues for your automated processes that +anticipate a specific output. To prevent issues, you can redirect +``stderr`` to an output file in your script. + +For example, the following command redirects the ``stderr`` output from +a script called ``myScript.sh`` to a text file called ``error.txt``: + +.. code-block:: + + myScript.sh 2> error.txt + +In the previous example, all error messages and deprecation warnings +are stored in ``error.txt`` and don't display in the output, so +they don't disrupt your automated processes. + +Command deprecation messages are similar to the following text: + +.. code-block:: + + Command "describe" is deprecated, Please use atlas privateEndpoints aws interfaces describe <atlasPrivateEndpointId> [--privateEndpointId privateEndpointID] [--projectId projected] + +Update Scripts Regularly +~~~~~~~~~~~~~~~~~~~~~~~~ + +You should regularly update your scripts to discontinue use of +deprecated commands because they will be removed in future releases. +You can learn which commands are deprecated from the +:ref:`atlas-cli-changelog`. If you +:ref:`set up a redirect file for stderr <atlas-cli-redirect-stderr>`, +you can also check that file for deprecation warnings. + +.. toctree:: + :titlesonly: + + Environment Variables </atlas-cli-env-variables> + Customize Output </custom-output-cli> + \ No newline at end of file diff --git a/source/atlas-cli-changelog.txt b/source/atlas-cli-changelog.txt index e5a634af..50c4b5b8 100644 --- a/source/atlas-cli-changelog.txt +++ b/source/atlas-cli-changelog.txt @@ -1,3 +1,8 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-changelog: + :noprevnext: ======================= @@ -12,6 +17,681 @@ :depth: 1 :class: singlecol +.. _atlas-cli-1.23.0: + +{+atlas-cli+} 1.23.0 +-------------------- + +Released 23 May 2024 + +- Adds support for Amazon Linux 2023. To learn more, see + :ref:`install-atlas-cli`. + +- Updates :ref:`atlas-deployments-list` to list |service| clusters in + case of local failures. + +- Adds support for ``srvShardOptimizedConnectionString`` to the + :ref:`atlas-clusters-connectionStrings-describe` command. + +- Stops publishing new versions on the ``server-4.4 Linux yum/apt`` + repositories. + +.. _atlas-cli-1.22.0: + +{+atlas-cli+} 1.22.0 +-------------------- + +Released 3 May 2024 + +- Fixes a bug in the :ref:`atlas-dbusers-create` command when + creating an {+oidc+} user. +- Adds the following commands to configure connected organizations + for federated authentication: + + - :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list` + - :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update` + - :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete` + - :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe` + +.. _atlas-cli-1.21.0: + +{+atlas-cli+} 1.21.0 +-------------------- + +Released 26 April 2024 + +- Adds commands that support {+oidc+} federated authentication, + including: + + - :ref:`atlas-federatedAuthentication-federationSettings-identityProvider` commands + - :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect` and :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect` commands + - :ref:`atlas-federatedAuthentication-federationSettings-describe` + +- Adds the ``oidcType`` flag for the :ref:`atlas-dbusers-create` + command. +- Adds the ``--tier`` flag for the + :ref:`atlas-streams-instances-create` command. + +.. _atlas-cli-1.20.0: + +{+atlas-cli+} 1.20.0 +-------------------- + +Released 11 April 2024 + +- Adds the :ref:`atlas-projects-update` command. +- Fixes an issue with the :ref:`atlas-kubernetes-config-generate` + command. + +.. _atlas-cli-1.19.0: + +{+atlas-cli+} 1.19.0 +-------------------- + +Released 3 April 2024 + +- Adds support for Podman 5.0.0 for local deployments. +- Fixes an issue with the ``--watch`` flag for the + :ref:`atlas-deployments-search-indexes-create` command. + +.. _atlas-cli-1.18.0: + +{+atlas-cli+} 1.18.0 +-------------------- + +Released 27 March 2024 + +- Fixes a bug in the :ref:`atlas-events-projects-list`, + :ref:`atlas-projects-list` and :ref:`atlas-events-organizations-list` + commands where an invalid ``minDate`` and ``maxDate`` silently failed + and didn't apply to the command. +- Fixes an issue where the {+atlas-cli+} didn't sign Windows binaries. +- Fixes an issue where the {+atlas-cli+} didn't apply the correct + default MongoDB version for {+cluster+} creation. +- Fixes a bug where the :ref:`atlas-customDbRoles-create` command fails + if you provide more than one privilege with the same action. +- Fixes an issue where exporting a {+cluster+} from |service| to {+ak8so+} + YAML didn't exclude read only fields for shared tenant deployments. + +.. _atlas-cli-1.17.0: + +{+atlas-cli+} 1.17.0 +-------------------- + +Released 14 March 2024 + +- Fixes an issue where :ref:`atlas-customDbRoles` commands didn't + handle collection names with dots (``.``) properly. +- Adds the ``--omitCount`` flag to all the list commands that support + pagination. +- Adds the ``--file`` flag to the :ref:`atlas-clusters-indexes-create` + command. + +.. _atlas-cli-1.16.0: + +{+atlas-cli+} 1.16.0 +-------------------- + +Released 07 March 2024 + +- Adds the ``--omitCount`` flag to the :ref:`atlas-events-projects-list` and :ref:`atlas-events-organizations-list` commands. +- Improves the Microsoft Windows binary build process. + +.. _atlas-cli-1.15.1: + +{+atlas-cli+} 1.15.1 +-------------------- + +Released 29 February 2024 + +- Fixes an issue where the :ref:`atlas-auth-login` command fails + to prompt for the default organization. + +.. _atlas-cli-1.15.0: + +{+atlas-cli+} 1.15.0 +-------------------- + +Released 22 February 2024 + +- Adds support for Atlas Search nodes management, including the + following commands: + + - :ref:`atlas-clusters-search-nodes-create` + - :ref:`atlas-clusters-search-nodes-list` + - :ref:`atlas-clusters-search-nodes-update` + - :ref:`atlas-clusters-search-nodes-delete` +- Adds the ``--tag`` flag to the :ref:`atlas-projects-create` command. +- Fixes a bug that prevented you from using the ``--file`` flag with + the :ref:`atlas-clusters-update` command. + +.. _atlas-cli-1.14.3: + +{+atlas-cli+} 1.14.3 +-------------------- + +Released 8 February 2024 + +- Adds support for :ref:`{+avs+} for Local Deployments + <atlas-cli-deploy-fts>`. +- Adds support to rename teams. +- :ref:`Signs the Linux binaries <verify-packages-linux>` with PGP. +- :ref:`Signs the Windows binaries <verify-packages-windows>` with + garasign. +- :ref:`Signs the Docker image <verify-packages-docker>` with Cosign. + +.. _atlas-cli-1.14.2: + +{+atlas-cli+} 1.14.2 +-------------------- + +Released 30 January 2024 + +- Improves the validation of invalid profile names. + +.. _atlas-cli-1.14.1: + +{+atlas-cli+} 1.14.1 +-------------------- + +Released 18 January 2024 + +- Fixes an issue that prevented upgrading from a lower to a higher + shared tier. +- Fixes the template for ``privateEndpoint`` commands. + +.. _atlas-cli-1.14.0: + +{+atlas-cli+} 1.14.0 +-------------------- + +Released 6 December 2023 + +- Adds :ref:`atlas-backups-compliancePolicy` + commands so that you can set up and manage a cloud backup compliance policy + for your project. To learn more, see :ref:`backup-compliance-policy`. +- Drops support for :atlas:`{+ak8so+} </atlas-operator>` 1.x. + +.. _atlas-cli-1.13.0: + +{+atlas-cli+} 1.13.0 +-------------------- + +Released 17 November 2023 + +- Adds the :ref:`atlas-alerts-settings-describe` command, which + describes alert configurations. +- Adds support for Debian 12, Debian 10 ARM, and Debian 11 ARM. +- Adds the ``--decompress`` option to decompress logs when you run the + :ref:`atlas-logs-download` command. +- Adds the ``type`` column to the output for the following commands: + + - :ref:`atlas-clusters-search-indexes-list` + - :ref:`atlas-clusters-search-indexes-describe` + - :ref:`atlas-deployments-search-indexes-list` + - :ref:`atlas-deployments-search-indexes-describe` +- Adds the ``--expireAfterDays`` option for the + :ref:`atlas-clusters-onlineArchives-create` and + :ref:`atlas-clusters-onlineArchives-update` commands. +- Improves the error message for the :ref:`atlas-deployments-list` + command if you aren't authenticated. +- Fixes a bug that prevented organization fetching, which prevented + some users from logging in. +- Fixes a bug where :ref:`atlas-logs-download` didn't respect the + ``--start`` and ``--end`` flags. +- Fixes a local deployment bug when you create an index from a file. +- Fixes a bug in the :ref:`atlas-config-init` command where the output + property didn't save properly. + +.. _atlas-cli-1.12.2: + +{+atlas-cli+} 1.12.2 +-------------------- + +Released 20 October 2023 + +- Adds an unsupported distro warning if you try to run local + deployment commands on an unsupported operating system. +- Adds `Podman <https://podman.io/>`__ as a recommended dependency for + the ``deb`` and ``rpm`` meta packages. +- Adds listing of :ref:`atlas` and local :ref:`atlas-deployments` to + the deployment interactive flow. +- Adds a spinner for the :ref:`atlas-deployments-start` and + :ref:`atlas-deployments-pause` commands. +- Adds more context to error messages for local deployments. +- Adds the :ref:`atlas-deployments-logs` command, which returns logs for + your local and cloud deployments. +- Fixes a bug that occurred when you provided only the private API key + or only the public API key. +- Fixes a bug in the :ref:`atlas-clusters-onlineArchives-create` command + where validation prevented you from using three fields in your partition. +- Fixes an issue where the + :ref:`atlas-performanceAdvisor-suggestedIndexes-list` command didn't + accept the ``--namespaces`` option. + +.. _atlas-cli-1.12.1: + +{+atlas-cli+} 1.12.1 +-------------------- + +Released 26 September 2023 + +- Updates the :atlas:`Atlas Search </atlas-search>` Docker + image for local deployments. + +.. _atlas-cli-1.12.0: + +{+atlas-cli+} 1.12.0 +-------------------- + +Released 22 September 2023 + +- Adds :ref:`atlas-deployments` commands so that you can work with + |service|, including using :atlas:`Atlas Search </atlas-search>` and + :atlas:`{+avs+} </atlas-search/field-types/knn-vector>`, throughout + the entire software development lifecycle from your local + environment to the cloud. To learn more, see + :ref:`atlas-cli-local-cloud`. + +- Adds :ref:`atlas-streams` commands to manage :atlas:`{+atlas-sp+} + </atlas-sp/overview>` instances and connection registries. + +- Drops support for Ubuntu 18.04. + +{+atlas-cli+} 1.11.0 +-------------------- + +Released 14 September 2023 + +- Fixes an issue that occurred when you created x509 certs for database + users. The command didn't output the certificate. If you depend on + the previously incorrect output, this update is a breaking change. + +- :ref:`atlas-alerts-settings` create and update commands perform + validation that helps you formulate all required arguments for each + alert type. + +- Fixes a bug where the :ref:`atlas-projects-list` command ignored the + ``--orgId`` flag. + +- Fixes an issue that occurred while running cloud provider access + commands. + +- Supports configuring alerts with a file. To learn more, + see :doc:`</reference/json/alert-config-file>`. + +.. _atlas-cli-1.10.0: + +{+atlas-cli+} 1.10.0 +-------------------- + +Released 26 July 2023 + +- Fixes issue with the + :ref:`atlas-performanceAdvisor-suggestedIndexes-list` command that + caused a JSON unmarshal error. +- Amends the description for the ``--apiKey`` option for the + :ref:`atlas-organizations-apiKeys-accessLists-create` command to make + it clearer that the option uses the API key ID, not the public + API key. + +.. _atlas-cli-1.9.2: + +{+atlas-cli+} 1.9.2 +------------------- + +Released 20 July 2023 + +- Fixes issue with the printed table format for the + :ref:`atlas-networking-containers-list` command. +- Removes support for MongoDB 4.2. +- Configures ``atlas quickstart`` command as an alias for the + :ref:`atlas-setup` command. +- Fixes the :ref:`atlas-backups-restores-watch` command output format. +- Fixes the :ref:`atlas-backups-restores-watch` command to work + correctly. + +.. _atlas-cli-1.9.1: + +{+atlas-cli+} 1.9.1 +------------------- + +Released 5 July 2023 + +.. important:: + + This is the last {+atlas-cli+} release to be available on the + MongoDB server 4.2 Linux repositories for Debian, Ubuntu and RHEL. + +- Adds the ability to set up Microsoft Teams alert notifications with + the :ref:`atlas-alerts-settings-create` command. +- Fixes the following issues: + + - An error when trying to create project API keys. + - Users were unable to remove cluster tags. + +.. _atlas-cli-1.9.0: + +{+atlas-cli+} 1.9.0 +------------------- + +Released 29 June 2023 + +- Adds the ability to autocomplete the process name in the performance + advisor with the :ref:`atlas-performanceAdvisor` command. +- Adds the following new commands to manage data federation: + + - :ref:`atlas-dataFederation` + - :ref:`atlas-dataFederation-privateEndpoints` + - :ref:`atlas-dataFederation-queryLimits` + +- Adds the ``--tag`` flag to the :ref:`atlas-setup` and + ``atlas quickstart`` commands. +- Updates a namespace to be optional for performance advisor operations. +- Fixes the :ref:`atlas-clusters-update` and :ref:`atlas-serverless-update` + commands ignoring the ``--tag`` flag. +- Deprecates ``atlas datalake`` and ``atlas privateEndpoints`` + commands in favor of ``atlas datafederation``. + +.. _atlas-cli-1.8.0: + +{+atlas-cli+} 1.8.0 +------------------- + +Released 18 June 2023 + +- Adds the ``LagTime`` and ``ReadyForCutOver`` fields to the + :ref:`atlas-liveMigrations-create`. + and :ref:`atlas-liveMigrations-describe` command output. +- Adds the ``--tag`` flag to the :ref:`atlas-serverless-create` + and :ref:`atlas-serverless-update` commands. +- Adds the ``--watch`` flag to the :ref:`atlas-clusters-create` and + :ref:`atlas-clusters-delete` commands. + +.. _atlas-cli-1.7.4: + +{+atlas-cli+} 1.7.4 +------------------- + +Released 15 June 2023 + +- Adds the ``--compact`` flag to compact the output of specific ``list`` + commands. This ensures backwards compatibility with {+atlas-cli+} + releases prior to 1.7.0. + + Use this flag with the ``--output json`` or ``--output json-format`` + flags to return an array that contains list items as output for the + following commands: + + - :ref:`atlas-teams-list` + - :ref:`atlas-dbusers-certs-list` + - :ref:`atlas-dbusers-list` + - :ref:`atlas-projects-apiKeys-list` + - :ref:`atlas-organizations-apiKeys-list` + - :ref:`atlas-projects-users-list` + - :ref:`atlas-processes-list` + - :ref:`atlas-alerts-settings-list` + +- Introduces custom handling for valid ISO-8601 timestamps. + +.. _atlas-cli-1.7.3: + +{+atlas-cli+} 1.7.3 +------------------- + +Released 9 June 2023 + +- Fixes an issue that caused the + :ref:`atlas-clusters-search-indexes-list` + command to incorrectly handle ``oneOf`` schema matching for analyzers. + +.. _atlas-cli-1.7.2: + +{+atlas-cli+} 1.7.2 +------------------- + +Released 7 June 2023 + +- Introduces a breaking change to the :ref:`atlas-alerts-settings-list` + command that modifies its ``--output json`` response structure. + + Use the nested ``.results`` object to access the previous response + structure. Use the following ``jq`` template to migrate affected + scripts: + + .. code-block:: sh + + jq '.' ...`` => ``jq '.results' ... + +- Fixes an issue that caused the :ref:`atlas-clusters-search-indexes-create` command to + incorrectly handle a multikey index. +- Fixes an issue with the :ref:`atlas-performanceAdvisor-slowQueryLogs` command where the + output didn't display correctly in tabular form. +- Adds the ``--tag`` flag to the commands :ref:`atlas-clusters-create`, + :ref:`atlas-clusters-update`, and :ref:`atlas-clusters-upgrade`. The ``--tag`` flag + lets you create and use :ref:`tags <configure-resource-tags>` to categorize your clusters. + +.. _atlas-cli-1.7.1: + +{+atlas-cli+} 1.7.1 +------------------- + +Released 31 May 2023 + +- Updates help text for ``update`` commands that include arrays to clarify that certain + flags replace data instead of append data. +- Fixes a bug in the :ref:`atlas-metrics-processes` command that caused an error when + using the ``--type`` filter. + +.. _atlas-cli-1.7.0: + +{+atlas-cli+} 1.7.0 +------------------- + +Released 25 May 2023 + +- Introduces a breaking change to the following commands + that modifies their ``--output json`` response structures: + + - :ref:`atlas-teams-list` + - :ref:`atlas-dbusers-certs-list` + - :ref:`atlas-dbusers-list` + - :ref:`atlas-projects-apiKeys-list` + - :ref:`atlas-organizations-apiKeys-list` + - :ref:`atlas-projects-users-list` + - :ref:`atlas-processes-list` + + Use the nested ``.results`` object to access the previous response + structure. Use the following ``jq`` template to migrate affected + scripts: + + .. code-block:: sh + + jq '.' ...`` => ``jq '.results' ... + +- Adds the :ref:`atlas-kubernetes-operator-install` command to install + the :atlas:`{+ak8so+} </atlas-operator>`. + +- Adds the following new commands to manage {+data-lake+} pipelines: + + - :ref:`atlas-dataLakePipelines-create` + - :ref:`atlas-dataLakePipelines-datasets-delete` + - :ref:`atlas-dataLakePipelines-delete` + - :ref:`atlas-dataLakePipelines-describe` + - :ref:`atlas-dataLakePipelines-list` + - :ref:`atlas-dataLakePipelines-pause` + - :ref:`atlas-dataLakePipelines-runs-describe` + - :ref:`atlas-dataLakePipelines-runs-list` + - :ref:`atlas-dataLakePipelines-runs-watch` + - :ref:`atlas-dataLakePipelines-start` + - :ref:`atlas-dataLakePipelines-trigger` + - :ref:`atlas-dataLakePipelines-update` + - :ref:`atlas-dataLakePipelines-watch` + +- Adds the following new commands to load and manage sample data: + + - :ref:`atlas-clusters-sampleData-load`, which replaces ``atlas + clusters loadSampleData`` + - :ref:`atlas-clusters-sampleData-describe` + - :ref:`atlas-clusters-sampleData-watch` + +- Fixes a bug where running :ref:`atlas-dbusers-update` indicated + success prematurely, which made it possible for the command + to show success when the API call later failed. +- Improves the error message for commands that are + unavailable for ``M0`` {+clusters+}. + +.. _atlas-cli-1.6.0: + +{+atlas-cli+} 1.6.0 +------------------- + +Released 30 March 2023 + +- Adds the following new commands: + + - :ref:`atlas-serverless-backups-snapshots-watch` + - :ref:`atlas-serverless-backups-snapshots-list` + - :ref:`atlas-serverless-backups-restores-watch` + - :ref:`atlas-serverless-backups-restores-create` + - :ref:`atlas-serverless-backups-restores-describe` + - :ref:`atlas-serverless-backups-restores-list` + - :ref:`atlas-serverless-update` + - :ref:`atlas-backups-exports-jobs-watch` + - :ref:`atlas-organizations-create` + +- Adds the following to commands: + + - ``file`` option for :ref:`atlas-backups-schedule-update` command. + - ``srvShardOptimizedConnectionString`` field to + ``privateEndpoints`` in + :ref:`atlas-clusters-connectionStrings-describe` command output. + - Option to auto-detect the requester's current IP for the + :ref:`atlas-organizations-apiKeys-accessLists-create` command. + +- Adds the ability to :ref:`create organizations + <atlas-organizations-create>`. +- Automatically completes the following: + + - Available regions or tiers during cluster creation or update. + - Available profiles. + +- Improves the following: + + - Autocomplete for output options. + - Release process for Chocolatey. + +- Fixes the following issues: + + - Couldn't properly set days for weekly backup when updating a backup + schedule. + - |json| path would not render as a valid |json|. + +.. _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 +------------------- + +Released 9 February 2023 + +- Updates the :ref:`atlas-config-describe` command to no longer redact + public |api| keys. +- Updates the default output format for the :ref:`atlas-customDbRoles-list` + command to include inherited roles. +- 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: + +{+atlas-cli+} 1.4.0 +------------------- + +Released 5 December 2022 + +- 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 |service| and converting them to the + :atlas:`AtlasOperator </atlas-operator/>` resources. + +.. _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 +------------------- + +Released 14 October 2022 + +- 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` + command where the output didn't display correctly. +- 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 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, which enable or disable the alert configuration you specify. + .. _atlas-cli-1.1.7: {+atlas-cli+} 1.1.7 @@ -131,7 +811,7 @@ Released 16 June 2022 with the {+atlas-cli+} <install-atlas-cli>` using a new meta-package for Linux package managers (``apt`` and ``yum``). - Automatically detects {+mongosh+} when you use the - :ref:`atlas-quickstart` command. + ``atlas quickstart`` command. .. _atlas-cli-1.1.3: @@ -140,7 +820,7 @@ Released 16 June 2022 Released 13 June 2022 -- Improves the :ref:`atlas-quickstart` command: +- Improves the ``atlas quickstart`` command: - Prompts you to log in if you aren't already logged in. - Clarifies an error message when no regions are found for a given cloud @@ -161,129 +841,3 @@ Released 13 June 2022 Released 06 June 2022 - Fixes login and setup display issues for Microsoft Windows users. - -.. _atlas-cli-1.1.1: - -{+atlas-cli+} 1.1.1 -------------------- - -Released 02 June 2022 - -Changes -~~~~~~~ - -- Adds :ref:`telemetry <telemetry>` data to track the choices you make at the following interactive prompts: - - - confirm (``yes/no``) - - default output format - - cloud provider region - - choose a default organization - - choose a default project - -- Updates the :ref:`atlas-setup` with minor bug fixes and design refinements. - -.. _atlas-cli-1.1.0: - -{+atlas-cli+} 1.1.0 -------------------- - -Released 20 May 2022 - -Changes -~~~~~~~ - -- Adds two new commands for :ref:`Atlas onboarding - <atlas-cli-onboarding>`: - - - :ref:`atlas-auth-register` registers your |service| account and - authenticates from the {+atlas-cli+}. - - :ref:`atlas-setup` registers your |service| account, - authenticates from the {+atlas-cli+}, and creates a free - {+cluster+}. - -- Adds :ref:`telemetry <telemetry>` to the {+atlas-cli+}. -- Adds the ``--currentIp`` flag to the :ref:`atlas-quickstart` and - :ref:`atlas-setup` commands. ``--currentIp`` indicates whether to use - the IP address of the host that is currently executing the command. - - -.. _atlas-cli-1.0.3: - -{+atlas-cli+} 1.0.3 -------------------- - -Released 28 April 2022 - -Changes -~~~~~~~ - -- Improves :ref:`atlas-quickstart` commands: - - - Clusters created using :ref:`atlas-quickstart` now start - with the cluster prefix and five digits. - - :ref:`atlas-quickstart` now displays a default cluster - option before starting interactive setup. - - {+atlas-cli+} automatically identifies the ``mongosh`` path for - :ref:`atlas-config` and :ref:`atlas-quickstart` commands. - -- Makes minor improvements to the {+atlas-cli+} documentation. - -- Adds an alias ``-`` as the standard output for the parameter - ``--out`` for the following command: - - - :ref:`atlas-logs-download` - -.. _atlas-cli-1.0.2: - -{+atlas-cli+} 1.0.2 -------------------- - -Released 31 March 2022 - -Changes -~~~~~~~ - -- Fixes a bug that caused the :doc:`atlas config list </command/atlas-config-list/>` - command to show a default profile when a default profile doesn't exist. -- Fixes an issue that prevented use of the - :doc:`completion </command/atlas-completion-bash/>` command without credentials. -- Adds improvements to the {+atlas-cli+} login experience, including a flag to - skip configuration when running :doc:`atlas auth login </command/atlas-auth-login/>`. -- Updates the error message the {+atlas-cli+} shows when credentials are missing. - -.. _atlas-cli-1.0.1: - -{+atlas-cli+} 1.0.1 -------------------- - -Released 16 March 2022 - -Changes -~~~~~~~ - -Fixes an issue with the alert for new releases. - -.. _atlas-cli-1.0.0: - -{+atlas-cli+} 1.0.0 -------------------- - -Released 15 March 2022 - -This is the Generally Available (GA) release of {+atlas-cli-full+}. - -Changes -~~~~~~~ - -Introduces the ability to use {+atlas-cli-full+} to manage |service-fullname|, -including managing: - -- Projects -- Clusters -- Backup -- Alerts -- Metrics and monitoring - -For a complete list of available commands, see :doc:`</command/atlas>`. - -To install this version, see :ref:`<install-atlas-cli>`. diff --git a/source/atlas-cli-commands.txt b/source/atlas-cli-commands.txt deleted file mode 100644 index 36e25a06..00000000 --- a/source/atlas-cli-commands.txt +++ /dev/null @@ -1,11 +0,0 @@ -.. _atlascli-commands: - -===================== -{+atlas-cli+} Commands -===================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol diff --git a/source/atlas-cli-create-cluster-from-config-file.txt b/source/atlas-cli-create-cluster-from-config-file.txt new file mode 100644 index 00000000..bc156d5c --- /dev/null +++ b/source/atlas-cli-create-cluster-from-config-file.txt @@ -0,0 +1,216 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-create-cluster-from-config-file: + +====================================================== +Create an |service| Cluster Using a Configuration File +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +This tutorial demonstrates how to use {+atlas-cli+} commands to create +a new |service| cluster from a configuration file. Specifically, it +demonstrates how to: + +1. Get the configuration settings of an :ref:`existing Atlas cluster + <atlas-clusters-create>` and save the settings to a + configuration file using the :ref:`atlas-clusters-describe` command. +#. Create an |service| {+cluster+} from the configuration file using the + :ref:`atlas-clusters-create` command. + +.. _atlas-cli-create-cluster-from-config-file-reqs: + +Prerequisites +------------- + +Before you begin, you must have the following: + +- :ref:`An Atlas cluster <atlas-clusters-create>` +- :ref:`Atlas CLI <install-atlas-cli>` +- :ref:`A profile <atlas-cli-profiles>` that contains the IDs of the + |service| organization and project from where you wish to retrieve + existing cluster settings and where you wish to create the new + {+cluster+}. + +.. _atlas-cli-create-cluster-from-config-file-procedure: + +Create an |service| Cluster From a Configuration File +----------------------------------------------------- + +You can use the procedures in this section to easily create a new +{+cluster+} by exporting settings from an existing {+cluster+} instead +of manually creating a configuration file yourself. + +Export Existing Cluster Configuration Settings to a File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. procedure:: + :style: normal + + .. step:: Connect to your |service| account for programmatic access if you haven't connected yet. + + To learn more, see :ref:`connect-atlas-cli`. + + .. step:: Run the following command to export the details of an existing cluster to a |json| configuration file named ``myCluster``. + + .. code-block:: shell + :copyable: true + + atlas clusters describe <cluster-name> --output json > myCluster.json + + Replace <cluster-name> in the preceding command with the name of + the existing {+cluster+} that you wish to clone. + +(Optional) Edit the Configuration File for the new Cluster +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. procedure:: + :style: normal + + .. step:: Open the |json| file in a text editor to view the configuration settings. + + .. example:: + + The following example uses the ``vi`` editor to view the + replica set settings for an ``M10`` cluster named + ``mySandbox`` in the ``myCluster.json`` file. + + .. io-code-block:: + :copyable: false + + .. input:: + :language: shell + + vi myCluster.json + + .. output:: + :language: json + :linenos: + + { + "backupEnabled": true, + "biConnector": { + "enabled": false, + "readPreference": "secondary" + }, + "clusterType": "REPLICASET", + "connectionStrings": { + "standard": "<connection-string>" + }, + "diskSizeGB": 10, + "encryptionAtRestProvider": "NONE", + "groupId": "<group-id>", + "id": "<64403dd1f2a6b45e71527d5a>", + "mongoDBMajorVersion": "6.0", + "mongoDBVersion": "6.0.5", + "name": "mySandbox", + "paused": false, + "pitEnabled": true, + "stateName": "IDLE", + "replicationSpecs": [ + { + "numShards": 1, + "id": "64403dbb0a052449df3d04ae", + "zoneName": "Zone 1", + "regionConfigs": [ + { + "analyticsAutoScaling": { + "diskGB": { + "enabled": true + }, + "compute": { + "enabled": true, + "scaleDownEnabled": true, + "minInstanceSize": "M10", + "maxInstanceSize": "M40" + } + }, + "analyticsSpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M10", + "nodeCount": 0 + }, + "electableSpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M10", + "nodeCount": 3 + }, + "readOnlySpecs": { + "diskIOPS": 3000, + "ebsVolumeType": "STANDARD", + "instanceSize": "M10", + "nodeCount": 0 + }, + "autoScaling": { + "diskGB": { + "enabled": true + }, + "compute": { + "enabled": true, + "scaleDownEnabled": true, + "minInstanceSize": "M10", + "maxInstanceSize": "M40" + } + }, + "priority": 7, + "providerName": "AWS", + "regionName": "US_EAST_1" + } + ] + } + ], + "createDate": "2023-04-19T19:15:29Z", + "rootCertType": "ISRGROOTX1", + "versionReleaseSystem": "LTS", + "terminationProtectionEnabled": false + } + + .. step:: (Optional) Make changes to the settings in the configuration file as needed. + + To learn more about the optional and required settings, see + :ref:`atlas-cli-cluster-config-file`. + + .. step:: Save and close the configuration file. + +Create a New Cluster Using the Configuration File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. procedure:: + :style: normal + + .. step:: Connect to your |service| account for programmatic access if you aren't already connected to your |service| account. + + To learn more, see :ref:`connect-atlas-cli`. + + .. step:: Run the following command to create an |service| cluster using the configuration file. + + .. code-block:: + :copyable: true + + atlas clusters create <new-cluster-name> -f myCluster.json + + Replace ``<new-cluster-name>`` in the preceding command with the + name of the new {+cluster+} you wish to create. + + .. step:: Run the following command to check the status of the {+cluster+}. + + .. code-block:: shell + :copyable: true + + atlas clusters watch <new-cluster-name> + + Replace <new-cluster-name> in the preceding command with the name + of the new {+cluster+}. + + This command checks the {+cluster+}\'s status periodically until + it reaches an ``IDLE`` state. Once the {+cluster+} reaches the + expected state, the command prints "Cluster available." diff --git a/source/atlas-cli-deploy-docker.txt b/source/atlas-cli-deploy-docker.txt new file mode 100644 index 00000000..7aa90ed8 --- /dev/null +++ b/source/atlas-cli-deploy-docker.txt @@ -0,0 +1,436 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-deploy-docker: + +=========================================== +Create a Local Atlas Deployment with Docker +=========================================== + +.. default-domain:: mongodb + +.. facet:: + :name: genre + :values: tutorial + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +This tutorial shows you how to create a local |service| deployment with +Docker. In this tutorial, we will deploy a single-node replica set with +Docker. + +.. important:: Public Preview + + Local deployments in Docker and Docker Compose + are available as a Public Preview. The feature and corresponding + documentation may change at any time in the Public Preview stage. To + ask questions and provide feedback, see the `{+atlas-cli+} + Local Development Community Forum <https://www.mongodb.com/community/forums/tag/local-dev-atlas-cli>`__. + +.. _atlas-cli-deploy-docker-setup: + +Create a Local Atlas Deployment with Docker +------------------------------------------- + +.. procedure:: + :style: normal + + .. step:: Install and start Docker. + + To learn more, see the `Docker documentation <https://docs.docker.com/desktop/install/mac-install/>`__. + + .. step:: Pull down the ``mongodb/mongodb-atlas-local`` Docker image. + + **Example:** + + .. code-block:: sh + + docker pull mongodb/mongodb-atlas-local:latest + + .. step:: Run the Docker image. + + **Example:** + + .. tabs:: + + .. tab:: No Authentication + :tabid: no-auth + + .. code-block:: sh + + docker run -p 27017:27017 mongodb/mongodb-atlas-local + + .. tab:: With Authentication + :tabid: with-auth + + .. code-block:: sh + + docker run -e MONGODB_INITDB_ROOT_USERNAME=user -e MONGODB_INITDB_ROOT_PASSWORD=pass -p 27017:27017 mongodb/mongodb-atlas-local + + The logs display as the Docker image runs. + + .. step:: Connect to the local |service| deployment. + + To connect to the local |service| deployment from the host (not + container), copy and paste the following command into a new + terminal, and replace the ``{connection_string}`` variable with + your connection string. + + .. note:: + + The following example uses {+mongosh+}, but you can use the + connection method that you prefer. + + .. code-block:: sh + + mongosh {connection_string} + + **Examples:** + + .. tabs:: + + .. tab:: No Authentication + :tabid: no-auth + + .. code-block:: sh + + mongosh "mongodb://localhost:27017/?directConnection=true" + + .. tab:: With Authentication + :tabid: with-auth + + .. code-block:: sh + + mongosh "mongodb://user:pass@localhost:27017/?directConnection=true" + +Create a Local Atlas Deployment with Docker Compose +--------------------------------------------------- + +Create a local |service| deployment with `Docker Compose +<https://docs.docker.com/compose/>`__. + +.. note:: + + If you have an existing Docker-Compose based Atlas implementation that you've + built with the official `MongoDB Docker Image <https://hub.docker.com/_/mongo>`__ + and that you'd like to convert to use the Atlas Local Dev image, + see :ref:`Convert to a Local Dev Implementation <convert-to-local-dev>` below. + +.. procedure:: + :style: normal + + .. step:: Install and start Docker. + + To learn more, see the `Docker documentation <https://docs.docker.com/desktop/install/mac-install/>`__. + + .. step:: Install Docker Compose. + + **Example:** + + .. code-block:: sh + + brew install docker-compose + + To learn more, see the `Docker Compose install documentation + <https://docs.docker.com/compose/install/>`__. + + .. step:: Create a ``docker-compose.yaml`` file. + + Create the ``docker-compose.yaml`` file in the same directory + that you run Docker Compose from. + + **Example:** + + .. code-block:: sh + :linenos: + + services: + mongodb: + image: mongodb/mongodb-atlas-local + environment: + - MONGODB_INITDB_ROOT_USERNAME=user + - MONGODB_INITDB_ROOT_PASSWORD=pass + ports: + - 27018:27017 + + .. step:: Run Docker Compose. + + The following command creates a local |service| deployment with + |fts| capabilities enabled. + + **Example:** + + .. code-block:: sh + + docker-compose up + + .. step:: Connect to the local |service| deployment. + + To connect to the local |service| deployment from the host (not + container), copy and paste the following command into a new + terminal, and replace the ``{connection_string}`` variable with + your connection string. + + .. note:: + + The following example uses {+mongosh+}, but you can use the + connection method that you prefer. + + .. code-block:: sh + + mongosh {connection_string} + + **Example:** + + .. code-block:: sh + + mongosh "mongodb://user:pass@localhost:27018/?directConnection=true" + + .. step:: (Optional) Stop the container. + + .. code-block:: sh + + docker compose down -v + +Persist Data Across Runs with Docker Compose +-------------------------------------------- + +You can persist data across multiple runs with `Docker Compose +<https://docs.docker.com/compose/>`__. Persisting data helps to ensure +that data isn't lost between runs. Data remains available across runs +of Docker Compose. + +.. procedure:: + :style: normal + + .. step:: Install and start Docker. + + To learn more, see the `Docker documentation <https://docs.docker.com/desktop/install/mac-install/>`__. + + .. step:: Install Docker Compose. + + **Example:** + + .. code-block:: sh + + brew install docker-compose + + To learn more, see the `Docker Compose install documentation + <https://docs.docker.com/compose/install/>`__. + + .. step:: Create a ``docker-compose.yaml`` file. + + Update the ``docker-compose.yaml`` file to mount the necessary + data directories as volumes. + + **Example:** + + .. code-block:: sh + :linenos: + + services: + mongodb: + hostname: mongodb + image: mongodb/mongodb-atlas-local + environment: + - MONGODB_INITDB_ROOT_USERNAME=user + - MONGODB_INITDB_ROOT_PASSWORD=pass + ports: + - 27019:27017 + volumes: + - data:/data/db + - config:/data/configdb + volumes: + data: + config: + + .. step:: Run Docker Compose. + + The following command creates a local |service| deployment with + |fts| capabilities enabled. + + **Example:** + + .. code-block:: sh + + docker-compose up + + You can also run Docker Compose in `detached mode <https://docs.docker.com/reference/cli/docker/compose/up/#options>`__. + + **Example:** + + .. code-block:: sh + + docker-compose up -d + + .. step:: Connect to the local |service| deployment. + + To connect to the local |service| deployment from the host (not + container), copy and paste the following command into a new + terminal, and replace the ``{connection_string}`` variable with + your connection string. + + .. note:: + + The following example uses {+mongosh+}, but you can use the + connection method that you prefer. + + .. code-block:: sh + + mongosh {connection_string} + + **Example:** + + .. code-block:: sh + + mongosh "mongodb://user:pass@localhost:27019/?directConnection=true" + +Generate a List of Dependencies +------------------------------- + +You can generate a list of the dependencies for the +``mongodb/mongodb-atlas-local`` Docker image. + +.. procedure:: + :style: normal + + .. step:: Install syft. + + **Example:** + + .. code-block:: sh + + brew install syft + + To learn more, see the :github:`syft README + </anchore/syft/blob/main/README.md>`. + + .. step:: Run syft. + + .. code-block:: sh + + syft mongodb/mongodb-atlas-local + +Verify the Image Signature +-------------------------- + +You can verify the signature of the ``mongodb/mongodb-atlas-local`` +Docker image. + +.. procedure:: + :style: normal + + .. step:: Install cosign. + + **Example:** + + .. code-block:: sh + + brew install cosign + + To learn more, see the `cosign Installation + <https://docs.sigstore.dev/system_config/installation/>`__. + + .. step:: Run the following commands. + + **Example:** + + .. code-block:: sh + + curl -O https://cosign.mongodb.com/mongodb-atlas-local.pem + + .. code-block:: sh + + COSIGN_REPOSITORY="docker.io/mongodb/signatures" cosign verify --private-infrastructure --key=./mongodb-atlas-local.pem "mongodb/mongodb-atlas-local"; + +Run the Image with GitHub Actions +--------------------------------- + +To run the ``mongodb/mongodb-atlas-local`` Docker image with +GitHub actions, create a workflow file. To learn more, see the +`GitHub Actions Quickstart +<https://docs.github.com/en/actions/quickstart>`__. + +**Example:** + +Create the following ``mongodb.yml`` file in the ``.github/workflows`` +directory: + +.. code-block:: yml + + on: + push: + branches: + - main + pull_request: + jobs: + run: + runs-on: ubuntu-latest + services: + mongodb: + image: mongodb/mongodb-atlas-local + ports: + - 27017:27017 + steps: + - name: install mongosh + run: | + curl --output mongosh.deb https://downloads.mongodb.com/compass/mongodb-mongosh_2.2.1_amd64.deb + sudo dpkg -i mongosh.deb + mongosh --version + - run: mongosh 'mongodb://localhost/?directConnection=true' --eval 'show dbs' + + +.. _convert-to-local-dev: + +Convert Official Image to a Local Atlas Deployment +-------------------------------------------------- + +If you have an existing |service| implementation running in Docker Compose that +you have built with the official `mongo <https://hub.docker.com/_/mongo>`__ Docker +image, you can refer to the following checklist to simplify converting it to +the `mongodb-atlas-local <https://hub.docker.com/r/mongodb/mongodb-atlas-local>`__ image. + +1. Remove any existing ``command`` from your ``docker-compose.yaml`` file. Because + the ``command`` in a Docker Compose definition overrides the ``ENTRYPOINT`` + defined in the ``mongodb-atlas-local`` image, you must remove any existing + ``command`` for the ``mongodb-atlas-local`` image to run as designed. + +2. There is no need to define a health check for the |service| deployment, as this + feature is built in to the ``mongodb-atlas-local`` image. + +Example Docker Compose Updates +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following examples illustrate the likely required changes to your Docker +Compose YAML file: + +.. code-block:: yaml + + services: + self_built_atlas_implementation: + image: mongo:8.0 + ports: + - 27017:27017 + command: ["./entrypoint.sh"] # You may have defined a health check for the database in the entrypoint script. + +.. code-block:: yaml + + services: + local_dev_atlas: + image: mongodb/mongodb-atlas-local:8.0 + hostname: local_dev_atlas + ports: + - 27017:27017 + environment: + - MONGODB_INITDB_ROOT_USERNAME=user + - MONGODB_INITDB_ROOT_PASSWORD=pass + volumes: + - data:/data/db + - config:/data/configdb + volumes: + - data: + - config: \ No newline at end of file diff --git a/source/atlas-cli-deploy-fts.txt b/source/atlas-cli-deploy-fts.txt new file mode 100644 index 00000000..5d804126 --- /dev/null +++ b/source/atlas-cli-deploy-fts.txt @@ -0,0 +1,536 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-deploy-fts: + +========================================= +Use Atlas Search with an Atlas Deployment +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +This tutorial shows you how to use the ``atlas deployments`` +command to create an |fts| index, run a query, and work with +{+avs+}. + +Complete the Prerequisites +-------------------------- + +.. include:: /includes/fact-deploy-tutorial-prereqs.rst + +- Create an |service| deployment. + + **Example:** + + .. code-block:: sh + + atlas deployments setup + + To learn more, see :ref:`atlas-cli-deploy-local`. + + .. include:: /includes/fact-avs-mdb-version.rst + +- Download and load the sample data. + + **Example:** + + a. Run the following command to download the sample data: + + .. code-block:: sh + + curl https://atlas-education.s3.amazonaws.com/sampledata.archive -o sampledata.archive + + #. Copy and paste the following command into your terminal and + replace ``{port-number}`` with the port for your + deployment: + + .. code-block:: sh + + mongorestore --archive=sampledata.archive --port={port-number} + +.. _atlas-cli-fts-index-query: + +Create an Atlas Search Index and Run a Query +-------------------------------------------- + +Use the ``atlas deployments`` command to work with |fts|. To learn +more, see :atlas:`Atlas Search </atlas-search>`. + +You can run this command in the following ways: + +- **Interactive Mode**: the command prompts you for the + |fts| settings. + + .. note:: + + **Interactive Mode** allows you to create a basic |fts| index with + default settings. + +- **Non-Interactive Mode (Flags)**: you run the command + with the specified options. The command does not prompt you to + provide further values. +- **Non-Interactive Mode (Configuration File)**: you run the command + with the specified settings in the configuration file. The command + does not prompt you to provide further values. + +Click one of the following tabs to see the command for your preferred +mode. + +.. tabs:: + + .. tab:: Interactive + :tabid: interactive + + .. procedure:: + :style: normal + + .. step:: Create an |fts| index. + + a. Run the following command: + + .. code-block:: sh + + atlas deployments search indexes create + + #. Specify the deployment and press :kbd:`Enter`.. + + #. Specify ``searchIndex`` as the name for the index + and press :kbd:`Enter`.. + + #. Specify the ``sample_mflix`` database and press + :kbd:`Enter`.. + + #. Specify the ``movies`` collection and press + :kbd:`Enter`.. + + .. step:: Connect to the deployment. + + a. Run the following command to connect to a deployment: + + .. code-block:: sh + + atlas deployments connect + + #. Specify the deployment to connect to and press + :kbd:`Enter`.. + + #. Specify ``mongosh`` and press :kbd:`Enter`.. + + .. step:: Switch to the ``sample_mflix`` database. + + .. code-block:: sh + + use sample_mflix + + .. step:: Run an example query. + + .. io-code-block:: + :copyable: true + + .. input:: + :language: sh + + db.movies.aggregate([ + { + $search: { + "index": "searchIndex", + "text": { + "query": "baseball", + "path": "plot" + } + } + }, + { + $limit: 5 + }, + { + $project: { + "_id": 0, + "title": 1, + "plot": 1 + } + } + ]) + + .. output:: + :language: sh + + [ + { + plot: 'A trio of guys try and make up for missed opportunities in childhood by forming a three-player baseball team to compete against standard children baseball squads.', + title: 'The Benchwarmers' + }, + { + plot: 'A young boy is bequeathed the ownership of a professional baseball team.', + title: 'Little Big League' + }, + { + plot: 'A trained chimpanzee plays third base for a minor-league baseball team.', + title: 'Ed' + }, + { + plot: 'The story of the life and career of the famed baseball player, Lou Gehrig.', + title: 'The Pride of the Yankees' + }, + { + plot: 'Babe Ruth becomes a baseball legend but is unheroic to those who know him.', + title: 'The Babe' + } + ] + + .. tab:: Non-Interactive (Flags) + :tabid: noninteractive-flags + + .. procedure:: + :style: normal + + .. step:: Create an |fts| index. + + Copy and paste the following command into your terminal + and replace ``{myRs}`` with your deployment: + + .. code-block:: sh + + atlas deployments search indexes create searchIndex --deploymentName {myRs} --db sample_mflix --collection movies + + .. step:: Connect to the deployment. + + a. Run the following command to connect to a deployment: + + .. code-block:: sh + + atlas deployments connect + + #. Specify the deployment to connect to and press + :kbd:`Enter`.. + + #. Specify ``mongosh`` and press :kbd:`Enter`.. + + .. step:: Switch to the ``sample_mflix`` database. + + .. code-block:: sh + + use sample_mflix + + .. step:: Run an example query. + + .. io-code-block:: + :copyable: true + + .. input:: + :language: sh + + db.movies.aggregate([ + { + $search: { + "index": "searchIndex", + "text": { + "query": "baseball", + "path": "plot" + } + } + }, + { + $limit: 5 + }, + { + $project: { + "_id": 0, + "title": 1, + "plot": 1 + } + } + ]) + + .. output:: + :language: sh + + [ + { + plot: 'A trio of guys try and make up for missed opportunities in childhood by forming a three-player baseball team to compete against standard children baseball squads.', + title: 'The Benchwarmers' + }, + { + plot: 'A young boy is bequeathed the ownership of a professional baseball team.', + title: 'Little Big League' + }, + { + plot: 'A trained chimpanzee plays third base for a minor-league baseball team.', + title: 'Ed' + }, + { + plot: 'The story of the life and career of the famed baseball player, Lou Gehrig.', + title: 'The Pride of the Yankees' + }, + { + plot: 'Babe Ruth becomes a baseball legend but is unheroic to those who know him.', + title: 'The Babe' + } + ] + + .. tab:: Non-Interactive (Configuration File) + :tabid: noninteractive-config-file + + .. procedure:: + :style: normal + + .. step:: Create an ``indexDef.json`` configuration file. + + .. code-block:: json + + { + "collectionName": "movies", + "database": "sample_mflix", + "mappings": { + "dynamic": true + }, + "name": "searchIndex" + } + + .. step:: Create an |fts| index. + + a. Run the following command: + + .. code-block:: sh + + atlas deployments search indexes create --file indexDef.json + + #. Specify the deployment and press :kbd:`Enter`.. + + .. step:: Connect to the deployment. + + a. Run the following command to connect to a deployment: + + .. code-block:: sh + + atlas deployments connect + + #. Specify the deployment to connect to and press + :kbd:`Enter`.. + + #. Specify ``mongosh`` and press :kbd:`Enter`.. + + .. step:: Switch to the ``sample_mflix`` database. + + .. code-block:: sh + + use sample_mflix + + .. step:: Run an example query. + + .. io-code-block:: + :copyable: true + + .. input:: + :language: sh + + db.movies.aggregate([ + { + $search: { + "index": "searchIndex", + "text": { + "query": "baseball", + "path": "plot" + } + } + }, + { + $limit: 5 + }, + { + $project: { + "_id": 0, + "title": 1, + "plot": 1 + } + } + ]) + + .. output:: + :language: sh + + [ + { + plot: 'A trio of guys try and make up for missed opportunities in childhood by forming a three-player baseball team to compete against standard children baseball squads.', + title: 'The Benchwarmers' + }, + { + plot: 'A young boy is bequeathed the ownership of a professional baseball team.', + title: 'Little Big League' + }, + { + plot: 'A trained chimpanzee plays third base for a minor-league baseball team.', + title: 'Ed' + }, + { + plot: 'The story of the life and career of the famed baseball player, Lou Gehrig.', + title: 'The Pride of the Yankees' + }, + { + plot: 'Babe Ruth becomes a baseball legend but is unheroic to those who know him.', + title: 'The Babe' + } + ] + +.. _atlas-cli-deploy-avs: + +Use {+avs+} with an Atlas Deployment +------------------------------------------------ + +Use the ``atlas deployments`` command to work with {+avs+}. To +learn more, see :atlas:`How to Index Vector Embeddings for Vector +Search </atlas-search/field-types/knn-vector>`. + +.. include:: /includes/fact-avs-mdb-version.rst + +.. procedure:: + :style: normal + + .. step:: Create an ``indexDef-vector.json`` configuration file. + + .. code-block:: json + + { + "name": "vectorSearchIndex", + "type": "vectorSearch", + "collectionName": "embedded_movies", + "database": "sample_mflix", + "fields": [ + { + "type": "vector", + "path": "plot_embedding", + "numDimensions": 1536, + "similarity": "euclidean" + } + ] + } + + .. step:: Create an |fts| index. + + a. Run the following command: + + .. code-block:: sh + + atlas deployments search indexes create --file indexDef-vector.json + + #. Specify the deployment and press :kbd:`Enter`.. + + .. step:: Connect to the deployment. + + a. Run the following command to connect to a deployment: + + .. code-block:: sh + + atlas deployments connect + + #. Specify the deployment to connect to and press + :kbd:`Enter`.. + + #. Specify ``mongosh`` and press :kbd:`Enter`.. + + .. step:: Switch to the ``sample_mflix`` database. + + .. code-block:: sh + + use sample_mflix + + .. step:: Run an example query. + + .. important:: + + Copying and pasting a ``queryVector`` field with many numbers + into your terminal might take a while depending on your machine. + + .. io-code-block:: + :copyable: true + + .. input:: + :language: sh + + db.embedded_movies.aggregate([ + { + "$vectorSearch": { + "index": "vectorSearchIndex", + "path": "plot_embedding", + "queryVector": [0.024552748,-0.015502235,-0.013485263,0.012069505,-0.0027216184,0.023427898,-0.011920818,-0.03865862,0.0058472776,-0.026013758,-0.009069907,0.010834756,0.0065680863,-0.03470225,0.025936183,0.011164454,0.029918408,-0.0045866705,0.0134723345,-0.020376582,-0.014519608,0.02301416,0.007589501,0.0038464677,0.0022254563,-0.0034812149,0.022677999,-0.009651725,0.011772131,0.0113842515,-0.004790307,-0.029633963,0.008022632,-0.016407287,-0.025535375,-0.02173416,-0.004622226,-0.01448082,0.0061737425,-0.009334957,0.004237579,0.009367281,-0.021475572,0.006141419,0.00014464658,0.0046254583,-0.019743046,-0.002291719,-0.0166788,0.020066278,0.0202085,-0.0015983852,-0.02229012,-0.0017195974,-0.020842036,0.0098391995,0.0041244477,0.0018327287,0.01335597,-0.012780616,-0.010162433,-0.0008165663,-0.013989506,-0.012955162,-0.018708702,-0.0038303062,-0.00789334,0.0051587922,0.0036331343,-0.0010270715,0.03190952,0.0055628326,0.012825869,0.00020707087,0.015256578,-0.02133335,-0.023958,-0.0058763684,0.012625465,0.020389512,0.018346682,-0.031831946,-0.008701421,0.032918006,0.012890516,0.0026521233,-0.015489305,0.03452124,-0.018631127,-0.00096404116,0.020156784,0.0146489,0.011106271,0.009897382,0.018450117,-0.011836777,-0.0072921272,0.036305483,-0.0044606095,-0.013265465,-0.019924056,0.017234761,-0.011694555,-0.0025454566,-0.030487297,-0.019678399,0.020893754,0.0038400032,0.037857,0.007938593,-0.03299558,-0.010744251,0.017170114,-0.045692157,-0.0065939445,-0.0070400056,0.005911924,0.019019006,-0.002708689,0.00074545515,0.029194366,0.0036492958,0.0063321264,-0.018488904,-0.0012064656,0.0022997998,-0.004011316,-0.011345464,-0.012612536,-0.027616993,-0.0066327327,-0.008565663,0.025729313,-0.0094771795,-0.025406081,0.03043558,-0.032581843,0.004004852,-0.021449715,0.0038561646,0.0073761675,0.019626683,-0.019316379,-0.009612937,0.013924859,0.018282035,0.006597177,0.0005672732,0.0037591949,-0.015450518,0.023854565,-0.03247841,0.014778194,-0.008358794,0.028677195,0.0019975773,-0.015295366,0.018049307,-0.040313568,-0.0056177825,0.007589501,0.021307493,0.0014505063,-0.013924859,0.0138343545,0.016213346,0.0040921243,-0.005029499,-0.010698998,0.00036343464,-0.002519598,0.032064673,-0.023583049,0.013252536,-0.0026198002,0.017493347,-0.01854062,0.037546698,-0.0129034445,-0.008875967,0.0037979828,0.0008064653,0.0027701033,0.013278395,-0.035865888,-0.011856171,-0.028185882,-0.0021963655,-0.0003739397,0.0054593985,-0.00042828318,-0.004583438,-0.0025955576,0.0019620217,-0.6855634,-0.011164454,0.017415771,-0.024940627,3.7828315E-05,0.016717589,0.021682441,0.009244452,-0.020880826,-0.004583438,0.0027652548,0.016989104,0.0015595972,0.0037850535,-0.022820221,-0.01354991,0.014131729,-0.033874776,0.014933346,-0.014571325,-0.015747892,0.031107904,0.0043733367,-0.014222234,-0.010162433,0.031599216,0.0147652645,0.0011773747,-0.013233142,0.027125679,-0.030694166,0.029582245,0.0031563663,0.015670316,0.04729539,0.00993617,-0.027616993,0.01912244,0.0068977834,0.030306287,-0.03576245,0.00077818247,0.014623042,0.0048387917,0.0025050526,-0.0053947517,0.006538995,-0.0013511122,0.0112291,0.018863853,0.0073826322,0.0127224345,0.006519601,-0.00945132,0.029168509,-0.0059959646,0.024591535,0.01168809,0.008895361,0.0028105073,-0.012334555,0.017118398,-0.0181786,0.008766068,-0.01243799,0.027487699,-0.002164042,0.022522846,0.016277993,-0.023117594,0.025574163,0.039434377,-0.0036492958,0.0011393948,0.009031119,-0.00557253,0.020622239,0.02022143,-0.0058860653,-0.0062674796,0.0033745482,-0.022923656,-0.03361619,-0.02707396,0.033693764,-0.026401637,0.0051135393,0.014442032,0.0028169719,-0.0015208093,-0.0069624297,0.0118820295,-0.0042505083,-0.0057987925,0.012884051,-0.0047547515,-0.008332936,0.02337618,0.018139813,-0.04251155,0.013181425,-0.007835158,0.015385871,-0.012075969,-0.015075568,0.0007878794,-0.028289316,-0.0026602042,0.026660224,-0.022755574,0.0067426316,-0.012088899,0.009457786,-0.009781018,-0.013705062,-0.022548705,0.031857803,0.0050618225,0.024604464,-0.017157186,0.01373092,0.017170114,0.0025955576,-0.0024371736,0.0155151645,0.0020783856,-0.014739406,-0.009625866,-0.027332548,0.008559199,-0.004793539,0.025069918,0.005265459,-0.009955564,-0.008972936,-0.010698998,0.017596781,-0.0067103086,0.036434777,-0.018101025,-0.022419412,0.015980618,0.010155967,-0.016989104,-0.005582227,-0.018463045,-0.013588698,-0.014390315,-0.0363572,-0.008404047,-0.008895361,-0.017338196,-0.008216572,-0.015799608,0.0019911127,0.007537784,0.01214708,-0.0014690921,-0.015036779,-0.005666267,0.031237196,0.0028816184,-0.005970106,-0.004719196,-0.022975372,-0.011675161,-0.0056501054,0.023789918,0.0046577817,-0.020984259,-0.016963245,-0.023970928,-0.020570522,0.023608908,0.0036880837,0.008436371,-0.010492129,0.006144651,-0.021449715,-0.009141018,-0.004803236,-0.004670711,0.003384245,0.009250917,0.004670711,-0.012237586,0.015553952,-2.7247497E-05,-0.0038917202,0.010000817,0.0020299007,0.038270738,0.02209618,-0.0042892965,0.00478061,-0.00046868724,0.020648098,0.003145053,0.004185862,0.013459405,0.015696174,-0.025936183,0.02691881,-0.018656984,0.011157989,-0.023906281,0.01104809,-0.022820221,0.017402843,0.001338991,0.006144651,-0.033874776,-0.008177784,-0.010246473,-0.007822229,0.009574149,0.015541023,0.013142637,-0.008410512,-0.002311113,-0.016963245,-0.021216987,-0.0019959612,0.0073373797,0.0025276789,-0.00039616192,-0.0053010145,-0.008061421,0.019096581,-0.016303852,-0.011694555,-0.016833954,-0.004929297,0.035478007,0.003006063,-0.03656407,-0.0011636373,-0.02377699,0.033848915,9.106068E-05,0.007537784,0.02430709,0.018980218,-0.027823862,-0.008035562,-0.018514762,0.017364055,0.010653746,-0.009761624,-0.00788041,-0.030280428,-0.0054529337,0.00024969716,0.023453757,0.005566065,-0.010485665,0.017402843,-0.003959599,0.025354363,0.0401067,0.00788041,-0.0025777798,0.00575354,0.0040501044,-0.0045252563,-0.004027478,0.0023692949,0.0010456574,-0.0066521266,-0.016277993,-0.012399202,-0.004176165,0.007705865,-0.009690513,0.018954359,0.0075119254,-0.016536579,0.0010828292,0.013873142,0.01948446,0.001221011,-0.020880826,0.024785474,0.0011434352,-0.023453757,-0.006070308,-0.020286078,-0.0018812136,-0.012050111,0.012528495,0.019187085,-0.0058957622,0.0031660632,0.011151524,0.0118820295,0.008423441,0.0181786,-0.011267887,0.0204283,0.009826271,-0.00807435,0.002707073,-0.013116778,-0.011539403,0.0068137427,0.00047393978,-0.016652944,-0.008753139,-0.0056371763,-0.010556776,-0.008520411,-0.008197178,-0.0041826298,-0.0046060644,-0.014907487,0.004929297,0.003471518,0.011073948,0.02560002,0.0053042467,-0.0048290947,-0.030125277,-0.014015364,0.0047547515,0.1075718,-0.0020767692,0.0059959646,0.012192333,0.0024129313,-0.010666675,-0.025238,-0.0052460646,0.009069907,0.014610113,0.025755173,-0.010349907,0.013265465,0.01446789,-0.004800004,0.015437588,-0.013233142,-0.015256578,-0.00881132,-0.0075830366,2.77778E-05,0.00014272738,0.029530529,-0.0007846471,-0.013485263,-0.025509516,-0.0047385897,0.019949915,-0.00992324,-0.0026602042,-0.007550713,-0.021591937,-0.004929297,0.015657386,0.0021365674,0.00742142,0.0122246565,0.008604451,0.031392347,-0.02581982,0.039667103,0.025522444,0.013808496,-0.01985941,0.024242444,0.007970915,0.00046949534,0.027720427,0.022548705,-0.013149101,0.06568086,0.009108694,0.01987234,-0.00303677,0.023350323,0.0066391975,0.0036525282,0.01819153,-0.005536974,0.0055434387,-0.008429905,-0.027875578,0.0030028308,-0.0058763684,0.015204861,-0.03247841,-0.02244527,0.011558797,-0.013860214,-0.009166876,-0.017325267,-0.045174986,-0.0156056695,-0.026233556,0.011274353,0.015243649,0.009619402,-0.020699814,-0.017027892,0.01594183,-5.6111156E-05,-0.022303049,0.014610113,0.0024872748,-0.0035684877,0.015049709,0.02004042,0.017351124,-0.013627485,0.013394758,0.009709907,0.023104666,0.007001218,-0.023996787,0.008358794,0.012179404,0.012534959,0.007001218,-0.020156784,0.013394758,0.023272745,-0.036072757,-0.017428702,-0.019962844,0.017907085,-0.021798806,-0.00945132,0.0068266722,-0.018669914,-0.021837594,0.006138187,-0.002755558,0.01929052,0.0030238407,-0.004425054,0.012172939,0.010492129,0.018113954,0.00732445,-0.017674359,0.0034650534,-0.012968091,0.018450117,0.015734963,-0.024151938,0.0027636385,0.009554755,-0.019911127,-0.0053301053,-0.008656168,-0.013065061,0.012644859,-0.0025341434,-0.007408491,-0.031444065,-0.0034585886,-0.0020622239,0.010776575,-0.008320007,-0.010194756,-0.005675964,0.0061640455,-0.015075568,-0.030694166,-0.004880812,-0.02040244,-0.0032694975,-0.020273147,-0.009250917,0.032918006,0.00010626271,0.0017066681,0.005407681,0.024229515,-0.007111117,-0.027513558,-0.02968568,-0.0033357602,0.013026273,0.002191517,0.030306287,-0.00073575816,0.0025777798,-0.010220614,-0.005045661,0.005666267,-0.0061769746,-0.018760419,-0.034236796,0.016277993,0.0037139424,0.02209618,-0.0026892952,-0.022820221,0.005019802,0.016368497,-0.00044080845,-0.021229915,-0.0018989914,-0.024436383,-0.005905459,-0.007970915,-0.008649704,0.025483657,0.011410111,-0.0075119254,0.028030729,5.5909135E-05,0.0010682837,-0.008048492,0.03436609,-0.004977782,-0.00039535385,-0.0017325267,-0.009535361,-0.009322028,0.01085415,-0.01521779,-0.022871938,0.003940205,0.013110314,-0.005349499,0.0065907123,0.0045414176,0.005915156,0.031625077,0.004942226,-0.030539015,0.0034779827,-0.021023048,-0.019885268,-0.031625077,-0.0029591944,-0.0145842545,-0.0016775772,-0.010285261,-0.024345879,0.017557994,-0.027487699,-0.02616891,-0.010336978,-0.007182228,0.020324865,0.028496185,0.0076800063,0.022018604,-0.027901437,-0.0016307083,0.017325267,0.0011620212,-0.0017212135,0.009056977,0.00724041,-0.01466183,0.0024355575,-0.0046286904,0.003115962,-0.034081645,-0.019355167,0.012127686,0.029892549,0.0118820295,-0.020337794,-0.004496165,0.0033486895,0.021811735,-0.020854967,-0.0020864664,-0.012696576,7.9697034E-05,-0.018915571,-0.009263846,0.010976979,0.013136173,-0.0008000006,0.004017781,0.0017292943,-0.019988703,-0.0029301033,0.00011676777,0.00097535434,0.041322052,-0.0104080895,-0.0018456581,0.00012444454,-0.00084525323,-0.007311521,0.013705062,0.0012169707,0.0307976,0.011242029,0.0074537434,-0.012955162,0.025923254,0.013627485,0.01020122,-0.002600406,-0.0032032349,-0.008837179,0.0016105063,0.0146489,0.014377385,-0.022367695,-0.013769708,-0.018579409,-0.0063385908,-0.014312739,-0.015825467,-0.004871115,-0.009884452,-0.008481623,-0.001002829,-0.009360815,0.01984648,0.010356372,0.009153947,0.0011442434,0.029427094,-0.031806085,0.004948691,0.00732445,-0.0044993977,-0.006538995,0.014442032,0.018708702,-0.025522444,0.0018472743,-0.00040686902,-0.019432742,-0.014222234,-0.0020573754,-0.0068913186,-0.0047385897,-0.032788713,-0.0042181853,0.0030626287,-0.004483236,-0.035891745,-0.02190224,0.018437186,0.00022747493,-0.0063418234,0.018889712,0.0002092931,0.0307976,-0.0030416185,0.014273951,0.013963647,-0.0023078807,-0.011080413,-0.006063843,0.012793546,-0.010401624,-0.009858594,0.00047798018,-0.014635972,-0.008798391,0.01559274,0.0028218206,-0.004105054,-0.0045769736,0.032349117,0.00881132,0.016989104,0.010155967,0.016096983,-1.900254E-05,-0.022703856,-0.019497389,-0.014222234,0.004337781,0.03193538,-0.009709907,-0.007873946,-0.028651336,-0.0006113136,-0.02134628,-0.0070981877,-0.008300613,0.020441229,0.026815375,0.011707484,-0.00010232331,0.002957578,-0.0040727304,0.01649779,-0.033280026,-5.7020246E-05,-0.00398869,0.012955162,0.0045478824,0.02338911,-0.039563667,-0.0072080866,0.008164855,0.015140214,-0.018113954,0.009160412,-0.034598816,-0.01912244,-0.032064673,-0.0065842476,-0.0107701095,-0.004483236,0.01290991,-0.009696977,-0.0006303035,-0.0016953549,0.0041018217,-0.009729301,0.001120001,0.013601627,0.011242029,0.02911679,-0.005734146,-0.0068589956,0.007052935,-0.0128129395,0.015502235,0.0036331343,0.009457786,0.01910951,0.013937789,-0.021514362,-0.014700618,-0.0012492939,0.0052525294,-0.02002749,0.0043701045,-0.009179805,0.0023191937,-0.019833552,-0.015864255,-0.015295366,-0.014416173,-0.0034909118,0.014054153,-0.022419412,0.027591133,0.012625465,-0.030099418,0.012366879,0.004205256,-0.006603642,-0.0031353561,-0.02359598,-0.010039604,-0.002807275,0.00603152,-0.007789905,-0.0025842446,0.008714351,0.00714344,-0.00432162,-0.030409722,0.026052546,0.24493273,-0.008882431,-0.009587078,0.014558395,-0.0035846494,0.011267887,0.031599216,0.0009317179,-0.015204861,-0.008423441,-0.031288914,0.010194756,0.0009713139,0.0027523255,-0.010647281,-0.036150333,-0.035555582,-0.0086367745,-0.022057392,-0.024022646,-0.004046872,-0.010336978,0.0026440425,-0.016627084,0.02023436,-0.009787482,-0.0051555596,0.006852531,0.02002749,0.014791123,0.01410587,-0.025483657,-0.005921621,0.0052816207,-0.0057018227,-0.01728648,0.011487686,0.0042602057,0.0034553562,0.019704258,0.010065462,0.01224405,-0.009250917,0.022846079,0.0014933345,0.030306287,-0.016394356,0.010873544,0.00063434395,0.018501833,-0.026841234,-0.014067082,0.027487699,0.029090934,-0.011720413,0.012993949,0.017739004,0.01002021,-0.023156382,-0.007537784,0.0010731322,0.019368097,-0.006151116,0.034004066,-0.025651738,0.021087693,-0.023466686,-0.0057890955,-0.0005288893,-0.0024824264,-0.009406068,-0.0069624297,0.0004985863,0.0005692934,-0.0034553562,-0.015243649,0.031263057,0.0004654549,0.014791123,0.0024468706,-0.023789918,0.013860214,-0.00454465,-0.01446789,-0.0023127291,-0.047941856,0.009929705,-0.008384653,-0.0202085,-0.007919198,0.014118799,-0.0010076776,0.011862636,-0.006529298,0.004670711,0.031418208,-0.016937388,0.021979816,-0.008106673,0.019523248,-0.019975774,-0.025470728,0.0073050563,0.0065648537,-0.024604464,0.013304253,0.008184249,0.005207277,0.014816982,0.00329374,0.0008759603,-0.019936986,-0.0054690954,0.0015313143,-0.0072145513,0.01114506,0.02691881,-0.006762026,-0.014597183,-0.009813341,-0.002092931,0.0004711115,-0.021397997,0.012470313,0.0036557605,-0.02412608,0.0009204048,-0.00016787893,0.013937789,-0.01782951,0.0061737425,-0.032581843,0.007492531,0.007899804,-0.0034165685,0.031211339,0.010168897,-0.02618184,-0.012011323,0.025005274,0.019070722,0.0068396013,0.0028185882,-0.00482263,0.0053721257,-0.019730117,-0.0021187896,0.008151926,-0.015114356,-0.0017325267,-0.029892549,-0.027798003,-0.00817132,0.002411315,0.0363572,-0.018514762,-0.057664692,-0.030358003,-0.0020638402,0.035219423,-0.030461438,0.0045252563,0.006833137,0.00034484876,0.00042343469,0.0054593985,-0.16590883,0.008080815,0.0055402066,-0.015036779,0.028832346,0.008927684,0.010414554,-0.008106673,-0.018346682,-0.00052242464,0.015825467,0.008223037,-0.040184274,0.01242506,0.0014294961,0.00853334,-0.01816567,0.02059638,0.026298203,0.008248895,0.0042408113,-0.006613339,0.0066521266,-0.02024729,0.024888908,0.027513558,0.018773349,-0.0114295045,-0.0032274774,-0.00472566,-0.0046092966,0.0012113141,0.009684049,-0.012948697,0.03576245,-0.015502235,-0.017014964,-0.0063127326,0.010227079,0.0066391975,0.013200819,0.0017632338,0.0040016193,-0.0027248508,-0.0026149517,0.027410123,-0.0031353561,-0.003006063,-0.0065616216,-0.0036428312,0.0061866716,-0.014985062,0.007938593,-0.010537382,0.0098391995,0.02893578,0.014312739,0.0121341515,0.003859397,-0.020441229,0.003195154,-0.021966886,0.005288085,0.027487699,-0.0021559612,-0.019238804,0.00048202058,0.016989104,-0.029194366,0.0046933373,-0.031392347,-0.007899804,0.015903043,-0.02393214,0.01095112,-0.022794362,-0.0005907075,0.0046739434,0.0026957598,-0.0066521266,-0.020505875,0.042951144,-0.026285274,0.00087838457,0.013420617,-0.007221016,-0.0032290935,-0.008863037,-0.010130109,0.010634352,0.012651323,-0.026285274,0.027306689,-0.020867895,0.016122842,0.026686082,0.005365661,0.00058545504,0.030487297,-0.010175361,0.0030626287,-0.020842036,-0.017234761,0.0029818206,0.025548303,0.0022270726,0.030280428,-0.002766871,0.02247113,-0.014597183,-0.003581417,0.0067232377,0.010964049,0.0008290916,-0.0070270766,0.005514348,0.014403244,-0.008223037,0.02709982,-0.020661026,0.044011347,0.009496573,-0.028185882,-0.013717991,0.0045187916,0.0074149556,-0.10503766,-0.0014642436,-0.01894143,0.008856573,-0.028496185,-0.0057050553,-0.013808496,-0.0029010125,0.01132607,0.009011724,0.018708702,-0.013026273,0.0071240463,-0.011985464,0.014739406,-0.0017923247,-0.02950467,-0.018656984,0.006852531,0.008003239,-0.004631923,-0.0018876783,-0.012728899,-0.023828706,-0.014829911,-0.0064711166,-0.02896164,0.006613339,0.013705062,0.014610113,0.009677583,-0.025677597,0.010996372,-0.023104666,-0.0007701016,0.014545467,-0.027151536,0.00882425,0.023906281,-0.04158064,0.0056468733,-0.018023448,0.008481623,-0.0017438398,-0.0075119254,0.017208902,-0.011823848,0.0015959609,0.007149905,-0.019730117,-0.026505072,-0.0075183897,-0.01168809,-0.0059862672,0.033228308,-0.007886875,0.018695774,0.005747075,-0.001696971,0.005178186,-0.0019490925,-0.019200016,-0.00993617,0.02466911,0.016277993,-0.01335597,-0.0066715204,0.020635169,0.032555986,-0.0012072737,-0.00945132,0.01984648,-0.0025567696,0.027616993,-0.028444467,0.0161487,-0.019264663,-0.014920416,0.01781658,-0.026466284,0.003044851,-0.031625077,0.023673555,-0.013071526,0.023182241,-0.018993147,0.021048905,-0.005317176,0.0027523255,-0.003610508,0.0049971757,0.0033648512,-0.0056080855,-0.020156784,-0.0066521266,0.011778595,-0.011545868,-0.028987499,0.00464162,-0.0028315175,-0.009141018,-0.0016727286,-0.05849217,0.01801052,0.02023436,-0.006477581,0.00074505113,-0.020066278,0.024087293,0.0017745469,0.007369703,-0.005979803,-0.0033551543,0.028237598,0.019316379,0.007841622,0.009425462,-0.030358003,-0.00487758,-0.0040501044,0.0011967686,-0.0014901023,-0.0047450545,0.005905459,0.012981021,0.020997189,-0.02060931,0.0026117193,-0.022587493,0.011675161,-1.9671734E-05,-0.009632331,0.006367682,-0.032555986,0.012121222,-0.0041535385,0.0018133348,-0.013317183,-0.009884452,0.020803249,0.018023448,0.044787105,-0.02262628,-0.017557994,0.0168986,-0.0020557593,-0.009490109,0.012211727,-0.0077446527,0.0035878818,0.037003666,-0.0059183887,0.026013758,0.011901423,-0.0023143452,-0.023531333,-0.008048492,-0.027953153,0.022393553,-0.01448082,-0.025949111,-0.020725673,0.008714351,0.009044047,0.0063095,0.025380222,0.022432342,-0.011823848,0.012793546,-0.008229502,-0.010181827,-0.020467088,-0.0015313143,-0.0035587908,0.0014012132,0.014752335,-0.008320007,0.015747892,-0.022018604,-0.009865059,-0.0052525294,0.043028723,-0.008863037,0.004800004,-0.04923479,0.015747892,0.009121624,0.023156382,-0.022005673,0.011358393,-0.0095224315,-0.0010602028,0.013330112,0.008307077,0.023350323,1.0486119E-05,0.0051587922,0.019471532,-0.008785462,-0.0012541424,0.022109108,0.0057987925,-0.010970514,-0.001597577,-0.0040436396,-0.030668307,-0.0050650546,0.004066266,-0.023958,-0.030461438,-0.0015983852,0.015903043,-0.0049195997,-0.010259402,-0.006677985,0.010168897,-0.011371322,0.0029107095,-0.0052913176,-0.029194366,-0.008313542,0.01634264,-0.0050230343,0.016433144,0.016019408,-0.0124961715,0.013058596,0.012211727,0.027487699,0.00394667,-0.0078028347,0.0008290916,0.011487686,-0.016730519,-0.028004872,0.008662634,0.0061737425,-0.00676849,-0.0060993987,0.0029737398,-0.031599216,0.04437337,0.019368097,0.0008937381,0.010686069,-0.023052948,0.021850523,0.008669098,0.02932366,-0.0156056695,-0.018230317,-0.0020412137,-0.02968568,0.030487297,0.012890516,-0.021204058,0.022160826,-0.029065074,0.009580614,0.004295761,-0.0051814183,0.023893353,0.0076218243,0.033383463,-0.0010052533,-0.023440827,-0.016096983,-0.01103516,-0.009199199,-0.0023434362,-0.004476771,0.0068202075,0.0057793986,-0.0224582,-0.0057082875,0.026660224,-0.0077640465,-0.0030125277,-0.008585057,0.0134723345,0.010511524,-0.0033195987,0.010033139,-0.014920416,0.010505059,0.0037268717,0.019342238,0.003461821,-0.015851326,-0.033900633], + "numCandidates": 150, + "limit": 10 + } + }, + { + "$project": { + "_id": 0, + "plot": 1, + "title": 1, + "score": { $meta: "vectorSearchScore" } + } + } + ]) + + .. output:: + :language: sh + + [ + { + plot: 'When two girls move to the country to be near their ailing mother, they have adventures with the wonderous forest spirits who live nearby.', + title: 'My Neighbor Totoro', + score: 0.9999986886978149 + }, + { + plot: "To escape a war, a girl flees to a remote farmhouse and becomes part of an expansive family's unusual, perhaps even supernatural lifestyle.", + title: 'Black Moon', + score: 0.8282386660575867 + }, + { + plot: 'A shape-shifting mountain man and a group of children team up to protect an enchanted forest from evil lumberjacks.', + title: 'Forest Warrior', + score: 0.8196926712989807 + }, + { + plot: 'A shape-shifting mountain man and a group of children team up to protect an enchanted forest from evil lumberjacks.', + title: 'Forest Warrior', + score: 0.8196901082992554 + }, + { + plot: 'An adventurous girl finds another world that is a strangely idealized version of her frustrating home, but it has sinister secrets.', + title: 'Coraline', + score: 0.815956711769104 + }, + { + plot: "Set in a medieval village that is haunted by a werewolf, a young girl falls for an orphaned woodcutter, much to her family's displeasure.", + title: 'Red Riding Hood', + score: 0.8112794160842896 + }, + { + plot: 'Their women having been enslaved by the local pack of lesbian vampires thanks to an ancient curse, the remaining menfolk of a rural town send two hapless young lads out onto the moors as a sacrifice.', + title: 'Vampire Killers', + score: 0.8102427124977112 + }, + { + plot: 'In a mythical land, a man and a young boy investigate a series of unusual occurrences.', + title: 'Tales from Earthsea', + score: 0.8100577592849731 + }, + { + plot: 'Because of the actions of her irresponsible parents, a young girl is left alone on a decrepit country estate and survives inside her fantastic imagination.', + title: 'Tideland', + score: 0.8080059885978699 + }, + { + plot: 'Two siblings discover a supernatural escape from a troubled home, but find their bond tested when reality threatens to tear their family apart.', + title: 'One and Two', + score: 0.8072565197944641 + } + ] + +Supported Actions +----------------- + +To learn all of the actions that ``atlas deployments`` supports, see +:ref:`atlas-deployments`. diff --git a/source/atlas-cli-deploy-local.txt b/source/atlas-cli-deploy-local.txt new file mode 100644 index 00000000..072d4985 --- /dev/null +++ b/source/atlas-cli-deploy-local.txt @@ -0,0 +1,425 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-deploy-local: + +=============================== +Create a Local Atlas Deployment +=============================== + +.. default-domain:: mongodb + +.. facet:: + :name: genre + :values: tutorial + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +This tutorial shows you how to use the ``atlas deployments`` command to +create a local |service| deployment. In this tutorial, we will deploy a +single-node replica set on your local computer. You can then manage +your deployment, and use |fts| and {+avs+}. + +You should use local deployments for testing and development only. + +.. include:: /includes/fact-atlas-deployments-preview.rst + +Supported OS for Local Atlas Deployments +---------------------------------------- + +.. list-table:: + :header-rows: 1 + + * - Operating System + - Operating System Version + - Architecture + - Minimum CPU Cores + - Minimum Free RAM (GB) + + * - MacOS + - 13.2 and later + - x86-64, ARM + - 2 + - 2 + + * - Red Hat Enterprise Linux / CentOS + - 8, 9 + - x86-64, ARM + - 2 + - 2 + +.. note:: + + Windows and Ubuntu are not fully supported for local |service| + deployments during the Public Preview stage. + +.. _atlas-cli-deploy-local-reqs: + +Complete the Prerequisites +-------------------------- + +.. include:: /includes/fact-deploy-tutorial-prereqs.rst + +.. _atlas-cli-deploy-local-setup: + +Create a Local Atlas Deployment +------------------------------- + +Use the ``atlas deployments`` command to create a local |service| +deployment. + +You can run this command in the following ways: + +- **Interactive Mode (Default)**: the command prompts you for the + deployment settings and provides default values. +- **Interactive Mode (Custom)**: the command prompts you for the + deployment settings and lets you provide custom values. +- **Non-Interactive Mode**: you run the command with the specified + options. The command does not prompt you to provide further values. + To learn all of the actions that ``atlas deployments`` supports, see + :ref:`atlas-deployments`. + +Click one of the following tabs to see the command for your preferred +mode. + +.. tabs:: + + .. tab:: Interactive (Default) + :tabid: interactive-default + + .. procedure:: + :style: normal + + .. step:: Run the ``atlas deployments`` command in interactive mode. + + .. code-block:: sh + + atlas deployments setup + + .. step:: Specify what to deploy. + + **Example:** + + Specify ``local - Local Database`` and press :kbd:`Enter`.. + + .. io-code-block:: + + .. input:: + :language: sh + + ? What would you like to deploy? [Use arrows to move, type to filter, ? for more help] + > local - Local Database + atlas - Atlas Database + + .. output:: + :language: sh + + [Default Settings] + Deployment Name local50 + MongoDB Version 7.0 + Port 27017 + + .. step:: Specify how to set up your local Atlas database. + + **Example:** + + Specify ``default - With default settings`` and press + :kbd:`Enter`.. + + .. io-code-block:: + + .. input:: + :language: sh + + ? How do you want to setup your local MongoDB database? [Use arrows to move, type to filter] + > default - With default settings + custom - With custom settings + cancel - Cancel set up + + .. output:: + :language: sh + + Creating your deployment local50 [this might take several minutes] + 1/4: Downloading and completing configuration... + 2/4: Starting your local environment... + 3/4: Downloading MongoDB binaries to your local environment... + 4/4: Creating your deployment local50... + Deployment created! + Connection string: mongodb://localhost:27017/?directConnection=true + + .. tab:: Interactive (Custom) + :tabid: interactive-custom + + .. procedure:: + :style: normal + + .. step:: Run the ``atlas deployments`` command in interactive mode. + + .. code-block:: sh + + atlas deployments setup + + .. step:: Specify what to deploy. + + Specify ``local - Local Database`` and press :kbd:`Enter`.. + + **Example:** + + .. io-code-block:: + + .. input:: + :language: sh + + ? What would you like to deploy? [Use arrows to move, type to filter, ? for more help] + > local - Local Database + atlas - Atlas Database + + .. output:: + :language: sh + + [Default Settings] + Deployment Name local50 + MongoDB Version 7.0 + Port 27017 + + .. step:: Specify how to set up your local Atlas database. + + **Example:** + + Specify ``custom - With custom settings`` and press + :kbd:`Enter`.. + + .. code-block:: sh + + ? How do you want to setup your local MongoDB database? [Use arrows to move, type to filter] + default - With default settings + > custom - With custom settings + cancel - Cancel set up + + .. step:: Specify a deployment name. + + **Example:** + + Specify ``myLocalRs`` and press :kbd:`Enter`.. + + .. code-block:: sh + + ? Deployment Name [This can't be changed later] (local3612) myLocalRs + + .. step:: Specify a MongoDB Version. + + **Example:** + + Specify ``7.0`` and press :kbd:`Enter`.. + + .. code-block:: sh + + ? MongoDB Version [Use arrows to move, type to filter] + > 7.0 + 6.0 + + .. step:: Specify a port. + + **Example:** + + Specify ``37018`` and press :kbd:`Enter`.. + + .. io-code-block:: + + .. input:: + :language: sh + + ? Specify a port (49469) 37018 + + .. output:: + :language: sh + + Creating your deployment myLocalRs + 1/2: Starting your local environment... + 2/2: Creating your deployment myLocalRs... + Deployment created! + Connection string: mongodb://localhost:37018/?directConnection=true + + .. tab:: Non-Interactive + :tabid: noninteractive + + .. procedure:: + :style: normal + + .. step:: Run the ``atlas deployments`` command with the options. + + **Example:** + + .. io-code-block:: + :copyable: true + + .. input:: + :language: sh + + atlas deployments setup myLocalRs1 --type local --force + + .. output:: + :language: sh + + [Default Settings] + Deployment Name myLocalRs1 + MongoDB Version 7.0 + Port 49684 + + Creating your deployment myLocalRs1 + 1/2: Starting your local environment... + 2/2: Creating your deployment myLocalRs1... + Deployment created! + Connection string: mongodb://localhost:49684/?directConnection=true + + connection skipped + +.. _atlas-cli-deploy-local-manage: + +Manage a Local Atlas Deployment +------------------------------- + +Use the ``atlas deployments`` command to manage a local |service| +deployment. You can use the following commands for both local and +cloud |service| deployments. You can use ``--type local`` or +``--type atlas`` to run the command for local or cloud +atlas deployments respectively. + +.. procedure:: + :style: normal + + .. step:: List the available deployments. + + **Example:** + + .. io-code-block:: + :copyable: true + + .. input:: + :language: sh + + atlas deployments list + + .. output:: + :language: sh + + NAME TYPE MDB VER STATE + local50 LOCAL 7.0.1 IDLE + local62 LOCAL 7.0.1 IDLE + myLocalRs LOCAL 7.0.1 IDLE + myLocalRs1 LOCAL 7.0.1 IDLE + + .. step:: Download and load the sample data. + + a. Run the following command to download the sample data: + + .. code-block:: sh + + curl https://atlas-education.s3.amazonaws.com/sampledata.archive -o sampledata.archive + + #. Copy and paste the following command into your terminal and + replace ``{port-number}`` with the port for your + deployment: + + .. code-block:: sh + + mongorestore --archive=sampledata.archive --port={port-number} + + .. step:: Connect to a deployment. + + a. Run the following command to connect to a deployment: + + .. code-block:: sh + + atlas deployments connect + + #. Specify the deployment to connect to and press :kbd:`Enter`.. + + #. Specify how you want to connect to the deployment and press + :kbd:`Enter`.. + + .. step:: Pause a deployment. + + a. Run the following command to pause a deployment: + + .. code-block:: sh + + atlas deployments pause + + #. Specify the deployment to pause and press :kbd:`Enter`.. + + .. step:: Start a deployment + + a. Run the following command to start a deployment: + + .. code-block:: sh + + atlas deployments start + + #. Specify the deployment to start and press :kbd:`Enter`.. + + .. step:: Return the logs for the deployment. + + a. Run the following command to return the logs for a deployment: + + .. code-block:: sh + + atlas deployments logs + + #. Specify the deployment to return logs for and press :kbd:`Enter`.. + + .. step:: Delete a deployment. + + a. Run the following command to delete a deployment: + + .. code-block:: sh + + atlas deployments delete + + #. Specify the deployment to delete and press :kbd:`Enter`.. + + #. Specify ``y`` and press :kbd:`Enter`. to confirm. + +.. _atlas-cli-deploy-local-fts: + +Use Atlas Search with a Local Atlas Deployment +---------------------------------------------- + +Use the ``atlas deployments search indexes create`` command to +create an |fts| search index. You can then run |fts| queries. To +learn more, see :atlas:`Atlas Search </atlas-search>`. + +You can run this command with local and cloud |service| +deployments. For detailed steps, see +:ref:`atlas-cli-fts-index-query`. + +.. _atlas-cli-deploy-local-avs: + +Use {+avs+} with a Local Atlas Deployment +----------------------------------------------------- + +Use the ``atlas deployments search indexes create`` command to work +with {+avs+}. To learn more, see +:atlas:`How to Index Vector Embeddings for Vector Search +</atlas-search/field-types/knn-vector>`. + +You can run this command with local and cloud |service| +deployments. For detailed steps, see :ref:`atlas-cli-deploy-avs`. + +.. include:: /includes/fact-avs-mdb-version.rst + +Supported Actions +----------------- + +To learn all of the actions that ``atlas deployments`` supports, see +:ref:`atlas-deployments`. + +Troubleshoot Errors +------------------- + +To learn more about troubleshooting local |service| deployment +issues, see :ref:`local-deploy-errors`. diff --git a/source/atlas-cli-docker.txt b/source/atlas-cli-docker.txt new file mode 100644 index 00000000..d7a90498 --- /dev/null +++ b/source/atlas-cli-docker.txt @@ -0,0 +1,70 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-docker: + +====================================== +Run {+atlas-cli+} Commands with Docker +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +This tutorial shows you how to run {+atlas-cli+} commands with Docker +in the following ways: + +- Run Docker in interactive mode +- Run Docker as a daemon (detached mode) + +To learn more about interactive mode and detached mode, see `docker run +<https://docs.docker.com/engine/reference/commandline/run/>`__. + + +For more information on our Atlas CLI docker image, see our +`Docker Hub repository <https://hub.docker.com/r/mongodb/atlas>`__. + +You can also create a local |service| deployment with Docker. To learn +more, see :ref:`atlas-cli-deploy-docker`. + +.. _atlas-cli-docker-reqs: + +Complete The Prerequisites +-------------------------- + +Before you begin, complete the following prerequisites: + +1. Install the `Docker engine + <https://docs.docker.com/engine/install/>`__ or + `Docker desktop <https://docs.docker.com/desktop/>`__. +2. :ref:`Pull the Docker image <atlas-cli-install-steps>` to install + the {+atlas-cli+} with Docker. +3. (Optional) To run in interactive mode with an environment file, + create an `environment file + <https://docs.docker.com/engine/reference/commandline/run/#env>`__ + that contains valid + :ref:`{+atlas-cli+} environment variables <atlas-cli-env-vars>`, + including API key environment variables that provide your API + keys. + +Follow These Steps +------------------ + +To run {+atlas-cli+} commands with Docker, select one of the following +options and follow the steps: + +.. tabs:: + + .. tab:: Run Docker in Interactive Mode + :tabid: interactive + + .. include:: /includes/steps-run-interactive-mode.rst + + .. tab:: Run Docker as a Daemon + :tabid: daemon + + .. include:: /includes/steps-run-as-daemon.rst \ No newline at end of file diff --git a/source/atlas-cli-env-variables.txt b/source/atlas-cli-env-variables.txt index 5afd1868..4afdea38 100644 --- a/source/atlas-cli-env-variables.txt +++ b/source/atlas-cli-env-variables.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _atlas-cli-env-vars: =================================== @@ -113,4 +116,48 @@ The {+atlas-cli+} supports the following environment variables: {+atlas-cli+}. Set to ``false`` to disable telemetry. You can also enable or disable telemetry with ``DO_NOT_TRACK``, - but you don't need to specify both. \ No newline at end of file + but you don't need to specify both. + + * - ``HTTP_PROXY`` + - The absolute |url| or the hostname and port in the + ``hostname[:port]`` format. + + The following examples show how to set up the environment + variable in different situations: + + - If your proxy configuration doesn't require authentication: + + .. code-block:: sh + :copyable: false + + HTTP_PROXY=<my.proxy.address> + + - If your proxy configuration requires authentication: + + .. code-block:: sh + :copyable: false + + HTTP_PROXY=<username>:<password>@<my.proxy.address> + + - If the scheme is ``socks5``: + + .. code-block:: sh + :copyable: false + + HTTP_PROXY=socks5://<my.proxy.address> + + * - ``HTTPS_PROXY`` + - The absolute |url|. If ``HTTP_PROXY`` is also set, this takes + precedence over ``HTTP_PROXY`` for all requests. + + The following example shows how to set up the environment + variable: + + .. code-block:: sh + :copyable: false + + HTTPS_PROXY=https://<my.proxy.address> + + * - ``NO_PROXY`` + - Indicates no proxy for the |url| because proxy isn't configured + for the |url|. diff --git a/source/atlas-cli-ephemeral-cluster.txt b/source/atlas-cli-ephemeral-cluster.txt new file mode 100644 index 00000000..f6c27af1 --- /dev/null +++ b/source/atlas-cli-ephemeral-cluster.txt @@ -0,0 +1,118 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-ephemeral-cluster: + +===================================================== +Test Automations with Ephemeral Projects and Clusters +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +This tutorial demonstrates how to quickly create and delete ephemeral +|service| projects and {+clusters+} using the {+atlas-cli+}. Ephemeral +projects and {+clusters+} provide temporary testing environments that +you isolate from your production projects and {+clusters+}. You can use +ephemeral projects and {+clusters+} to test your automation scripts +before using the scripts on production {+clusters+}. + +.. _atlas-cli-ephemeral-reqs: + +Prerequisites +------------- + +Before you begin, complete the following tasks: + +- Create an |service| user account. +- :ref:`Create <atlas-organizations-create>` an + :atlas:`Atlas organization </organizations-projects/>` and + note its organization ID. You can find the organization ID by running the :ref:`atlas-organizations-list` command. +- :ref:`install-atlas-cli`. +- :ref:`connect-atlas-cli`. + +Follow These Steps +------------------ + +.. procedure:: + :style: normal + + .. step:: Create the ephemeral project, {+cluster+}, and database user. + + a. Run the :ref:`atlas-users-describe` command to find your + |service| user ID. Replace <YOUR-EMAIL> with the email address + that is associated with your |service| user account. + + .. code-block:: + + atlas users describe --username <YOUR-EMAIL> + + b. Run the :ref:`atlas-projects-create` command to create the + ephemeral project. Replace <ORG-ID> with the organization ID + and replace <YOUR-USER-ID> with your |service| user ID that + you retrieved in the previous step. + + .. code-block:: + + atlas projects create myEphemeralProject --orgId <ORG-ID> --ownerId <YOUR-USER-ID> + + c. Retrieve the project ID for the ephemeral project you created + from the response. In the following example response, the + project ID is ``64933bde48add154124e343f``. + + .. code-block:: + + Project '64933bde48add154124e343f' created. + + Alternatively, you can use the :ref:`atlas-projects-list` + command to find the project ID. + + d. Run the :ref:`atlas-setup` command to create an ``M10`` + {+cluster+} and a database user. Replace <YOUR-PASSWORD> with a password for the database user and replace <PROJECT-ID> with + the project ID for the ephemeral project you created. + + .. code-block:: + + atlas setup --clusterName myEphemeralCluster --provider AWS --region US_EAST_1 --tier M10 --username myEphemeralUser --password <YOUR-PASSWORD> --currentIp --skipSampleData --projectId <PROJECT-ID> --force + + After |service| creates the {+cluster+}, the {+atlas-cli+} + provides the :manual:`connection string + </reference/connection-string/#connection-string-options>` and + connects to your {+cluster+} through {+mongosh+}. + + .. step:: Test your automations on the ephemeral project and {+cluster+}. + + .. step:: Delete the ephemeral project, {+cluster+}, and database user. + + a. Run the :ref:`atlas-clusters-delete` command to delete the + ephemeral {+cluster+} and its database users. Replace <PROJECT-ID> with the project ID for your ephemeral project. + + .. code-block:: + + atlas clusters delete myEphemeralCluster --projectId <PROJECT-ID> --force + + b. Run the :ref:`atlas-projects-delete` command to delete the + ephemeral project. Replace <PROJECT-ID> with the project ID + for your ephemeral project. + + .. code-block:: + + atlas projects delete <PROJECT-ID> --force + + .. note:: + + You can't delete the ephemeral project until the ephemeral + {+cluster+} finishes shutting down. If you get an error + stating ``CANNOT_CLOSE_GROUP_ACTIVE_ATLAS_CLUSTERS``, wait + five minutes, then run the ``atlas projects delete`` + command again. + + You can run the :ref:`atlas-projects-list` command to confirm + successful deletion of the ephemeral project and {+cluster+}. If + the ephemeral project is missing from the list, you successfully + deleted both the project and the {+cluster+}. \ No newline at end of file diff --git a/source/atlas-cli-getting-started.txt b/source/atlas-cli-getting-started.txt index 19d19bbd..c1116c6e 100644 --- a/source/atlas-cli-getting-started.txt +++ b/source/atlas-cli-getting-started.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _atlas-cli-onboarding: ========================== diff --git a/source/atlas-cli-local-cloud.txt b/source/atlas-cli-local-cloud.txt new file mode 100644 index 00000000..c6317cd9 --- /dev/null +++ b/source/atlas-cli-local-cloud.txt @@ -0,0 +1,114 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-local-cloud: + +========================================================= +Manage Local and Cloud Deployments from the {+atlas-cli+} +========================================================= + +.. default-domain:: mongodb + +.. facet:: + :name: genre + :values: reference + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Use the {+atlas-cli+} to work with |service|, including using |fts| +and {+avs+}, throughout the entire software development lifecycle from +your local environment to the cloud. + +.. include:: /includes/fact-atlas-deployments-preview.rst + +With the ``atlas deployments`` commands, you can perform the following +actions: + +- Create and manage local |service| deployments. Local |service| + deployments reside on your computer and provide a non-production + environment for development. +- Create and manage |service| cloud deployments. Cloud |service| + deployments reside in the cloud for non-production and production use. +- Manage |fts| and {+avs+} indexes for your local and cloud |service| + deployments. + +.. note:: + + For local |service| deployments, you can manage only deployments that + you created with the ``atlas deployments`` command. If you created a + local |service| deployment without using the {+atlas-cli+}, you can't + manage that deployment with the {+atlas-cli+}. + +You can use only ``atlas deployments`` {+atlas-cli+} commands with +local |service| deployments. You can use all {+atlas-cli+} +commands, including ``atlas deployments`` commands, with cloud +|service| deployments. + +Supported Actions +----------------- + +You can perform the following actions with the ``atlas deployments`` +command for local and cloud |service| deployments including, but not limited to: + +- :ref:`Set up a new Atlas deployment + <atlas-cli-deploy-local-setup>`. + +- :ref:`List Atlas deployments <atlas-cli-deploy-local-manage>`. + +- :ref:`Connect <atlas-cli-deploy-local-manage>` with {+mongosh+} or + :compass:`Compass </>`, or return the + connection string for an |service| deployment. + +- :ref:`Pause or start an Atlas deployment + <atlas-cli-deploy-local-manage>`. + +- :ref:`Delete an Atlas deployment <atlas-cli-deploy-local-manage>`. + +- :ref:`Create or manage Atlas Search indexes + <atlas-cli-deploy-fts>` to run a full-text search on an + |service| deployment. + +- :ref:`Create or manage {+avs+} indexes <atlas-cli-deploy-local-avs>` + to run a semantic search on an |service| deployment. + +To learn all of the actions that the ``atlas deployments`` command +supports, see :ref:`atlas-deployments`. + +Tutorials +--------- + +Use the following resources for step-by-step guidance to run ``atlas +deployments`` commands: + +.. list-table:: + :header-rows: 1 + :widths: 40 60 + + * - Tutorial + - Objective + + * - :ref:`atlas-cli-deploy-local` + - Use the ``atlas deployments`` command to create a local |service| + deployment. This tutorial deploys a single-node replica set on + your local computer. + + * - :ref:`atlas-cli-deploy-docker` + - Use the ``atlas deployments`` command to create a local |service| + deployment with Docker. + + * - :ref:`atlas-cli-deploy-fts` + - Use the ``atlas deployments search indexes create`` command to + manage |fts| indexes and work with {+avs+} locally and in the + cloud. + +.. toctree:: + :titlesonly: + + Create a Local Deployment </atlas-cli-deploy-local> + Deploy with Docker </atlas-cli-deploy-docker> + Use Atlas Search </atlas-cli-deploy-fts> + \ No newline at end of file diff --git a/source/atlas-cli-quickstart.txt b/source/atlas-cli-quickstart.txt index 88e878bd..4bf73462 100644 --- a/source/atlas-cli-quickstart.txt +++ b/source/atlas-cli-quickstart.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _atlas-cli-quick-start: ========================================= @@ -12,7 +15,7 @@ Create and Configure an |service| Cluster :depth: 1 :class: singlecol -This tutorial demonstrates how to use the ``atlas quickstart`` command to: +This tutorial demonstrates how to use the :ref:`atlas-setup` command to: 1. Create one cluster in your |service| project. #. Load :atlas:`sample data </sample-data/available-sample-datasets/>` @@ -24,6 +27,15 @@ 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 setup``. To learn more about the configuration file +for an |service| {+cluster+}, see :ref:`atlas-cli-cluster-config-file`. + +You can also use ``atlas setup`` to create an |service| account and +authenticate with |service|. To learn more, see +:ref:`atlas-cli-onboarding`. + .. _atlas-cli-quick-start-reqs: Prerequisites @@ -40,15 +52,15 @@ Before you begin, complete the following tasks: Configure an |service| Cluster ------------------------------ -Use the ``atlas quickstart`` command to create an ``M0`` +Use the ``atlas setup`` command to create an ``M0`` cluster in |service|. ``M0`` clusters have some operational :ref:`limitations <atlas-free-tier>`. You can run this command in the following ways: -- **Default settings mode**: the command creates a sample shared-tier cluster with the - default settings. -- **Interactive mode**: the command prompts you for the cluster settings - and provides default values. +- **Default settings mode**: the command creates a sample shared-tier + cluster with the default settings. +- **Interactive mode**: the command prompts you for the cluster + settings and provides default values. - **Noninteractive mode**: you run the command with the options. Click the tab to see the command for your preferred mode. @@ -61,90 +73,88 @@ Click the tab to see the command for your preferred mode. The command creates a sample shared-tier cluster with the following default settings: - - Cluster name: ``Quickstart-<number>`` + - Cluster name: ``Cluster<number>`` - Service provider: ``AWS`` - - Provider region: ``US_EAST-1`` + - Provider region: ``US_EAST_1`` - Cluster tier: ``M0`` - Disk size: ``0.5`` GB - - Database Username: ``Quickstart-<number>`` + - Database Username: ``Cluster<number>`` - Database User Password: ``abcdef12345`` - Allow connections from IP Address: ``<YourIPAddress>`` - Load Sample Data: ``Yes`` - Open Shell: ``No`` - + + .. note:: + + The password is a random autogenerated value. ``abcdef12345`` + is an example value. + .. io-code-block:: .. input:: :language: sh - atlas quickstart --default --force + atlas setup --force .. output:: :language: sh - We are deploying Quickstart-9876543... + We are deploying Cluster9876543... + + Please store your database authentication access details in a secure location + Database User Username: Cluster9876543 + Database User Password: abcdef12345 + Creating your cluster... [Its safe to 'Ctrl + C'] + Cluster created. + Your connection string: mongodb+srv://cluster9876543.example.mongodb.net Loading sample data into your cluster... [Its safe to 'Ctrl + C'] - Now you can connect to your Atlas cluster with: mongosh -u Quickstart-9876543 -p abcdef12345 mongodb+srv://quickstart-9876543.example.mongodb.net + Now you can connect to your Atlas cluster with: mongosh -u Cluster9876543 -p abcdef12345 mongodb+srv://cluster9876543.example.mongodb.net .. tab:: Interactive Mode :tabid: interactive The command prompts you for the cluster settings and provides - default options. Press :kbd:`Enter` when prompted to accept the - default settings. + default options. When prompted, press :kbd:`Y`, then press + :kbd:`Enter` to accept the default settings. .. io-code-block:: .. input:: :language: sh - atlas quickstart + atlas setup .. output:: :language: sh - You are creating a new Atlas cluster and enabling access to it. - Press [Enter] to use the default values. Enter [?] on any option to get help. - [Set up your Atlas cluster] - ? Cluster Name [This cant be changed later] Quickstart-9876543 - ? Cloud Provider AWS - ? Cloud Provider Region US_EAST_1 - ? Do you want to load sample data into Quickstart-9876543? Yes - - [Set up your database authentication access details] - ? Database User Username Quickstart-2345678 - ? Database User Password [Press Enter to use an auto-generated password 'abcdef12345'] abcdef12345 - - [Set up your database network access details] - ? Access List Entry [Press Enter to use your public IP address '192.0.2.0'] 192.0.2.0 - - [Connect to Quickstart-9876543] - ? Do you want to access Quickstart-9876543 with MongoDB Shell? Yes - - [Summary of changes] - Cluster Name: Quickstart-9876543 - Cluster Tier: M0 - Cloud Provider: AWS - Region: US_EAST_1 - Cluster Disk Size (GiB): 0.5 - Database Username: Quickstart-9876543 - Allow connections from (IP Address): 192.0.2.0 - Load sample data: Yes - Open shell: No - ? Do you want to create a new cluster Quickstart-9876543 with the following settings? Yes + [Default Settings] + Cluster Name: Cluster9876543 + Cloud Provider and Region: AWS - US_EAST_1 + Database User Username: Cluster9876543 + Load sample data: Yes + Allow connections from (IP Address): <your-IP> + ? Do you want to set up your first free database in Atlas with default settings (it's free forever)? Yes We are deploying Quickstart-9876543... + + Please store your database authentication access details in a secure location: + Database User Username: Cluster9876543 + Database User Password: abcdef12345 + Creating your cluster... [Its safe to 'Ctrl + C'] + Cluster created. + + Your connection string: mongodb+srv://cluster9876543.example.mongodb.net Loading sample data into your cluster... [Its safe to 'Ctrl + C'] - Now you can connect to your Atlas cluster with: mongosh -u Quickstart-9876543 -p abcdef12345 mongodb+srv://quickstart-9876543.example.mongodb.net + Now you can connect to your Atlas cluster with: mongosh -u Cluster9876543 -p abcdef12345 mongodb+srv://cluster9876543.example.mongodb.net .. tab:: Non-Interactive Mode @@ -166,38 +176,19 @@ Click the tab to see the command for your preferred mode. .. input:: :language: sh - atlas quickstart --clusterName getStarted --provider AWS --region US_EAST_1 --username testUser --password changeMe accessListIp 192.0.2.15 --skipSampleData + atlas setup --clusterName getStarted --provider AWS --region US_EAST_1 --username testUser --password changeMe --accessListIp 192.0.2.15 --skipSampleData --force .. output:: :language: sh - You are creating a new Atlas cluster and enabling access to it. - - Press [Enter] to use the default values. + We are deploying getStarted... - Enter [?] on any option to get help. + Please store your database authentication access details in a secure location: + Database User Username: testUser + Database User Password: changeMe - [Set up your database network access details] - ? Access List Entry [Press Enter to use your public IP address '192.0.2.15'] 192.0.2.15 - - [Connect to getStarted] - ? Do you want to access getStarted with MongoDB Shell? Yes - - [Summary of changes] - Cluster Name: getStarted - Cluster Tier: M0 - Cloud Provider: AWS - Region: US_EAST_1 - Cluster Disk Size (GiB): 0.5 - Database Username: testUser - Allow connections from (IP Address): 192.0.2.15 - Load sample data: No - Open shell: No - ? Do you want to create a new cluster getStarted with the following settings? Yes - We are deploying getStarted... Creating your cluster... [Its safe to 'Ctrl + C'] - Now you can connect to your |service| cluster with: mongosh -u testUser -p changeMe mongodb+srv://getStarted.example.mongodb.net .. _atlas-cli-quick-start-summary: diff --git a/source/atlas-cli-save-connection-settings.txt b/source/atlas-cli-save-connection-settings.txt index 821fec00..0f635f1e 100644 --- a/source/atlas-cli-save-connection-settings.txt +++ b/source/atlas-cli-save-connection-settings.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _atlas-cli-profiles: ======================== @@ -58,15 +61,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 <https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>`__. + 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: @@ -96,6 +106,21 @@ Complete the Prerequisites - Add your host's IP address to the :ref:`IP access list <access-list>`. - If you select ``atlas config init`` as your connection method, you must :ref:`Configure API keys <atlas-admin-api-access>`. +- If your {+atlas-cli+} installation is behind a + firewall and you want to use a proxy |url|, + set up the ``HTTP_PROXY`` or ``HTTPS_PROXY`` :ref:`environment + variable <atlas-cli-env-vars>`. + + .. important:: + + {+atlas-cli+} supports + ``http``, ``https``, and ``socks5`` schemes. You must specify + ``cloud.mongodb.com/`` as the main target URL + in the proxy service's access list. You must also specify the + username and password if your proxy configuration enables authentication. + + To learn more, see `Proxy server + <https://en.wikipedia.org/wiki/Proxy_server>`__. Follow These Steps ~~~~~~~~~~~~~~~~~~ @@ -118,6 +143,7 @@ Select a use case and follow the procedure to create a profile. exists, these commands update the default profile's values. .. procedure:: + :style: normal .. include:: /includes/steps-atlas-cli-auth-nonprog-default.rst @@ -129,6 +155,7 @@ Select a use case and follow the procedure to create a profile. Follow these steps to create a profile with a custom name. .. procedure:: + :style: normal .. step:: Run the authentication command. @@ -159,6 +186,7 @@ Select a use case and follow the procedure to create a profile. exists, these commands update the default profile's values. .. procedure:: + :style: normal .. include:: /includes/steps-atlas-cli-auth-prog-default.rst @@ -170,6 +198,7 @@ Select a use case and follow the procedure to create a profile. Follow these steps to create a profile with a custom name. .. procedure:: + :style: normal .. step:: Run the authentication command. @@ -181,7 +210,7 @@ Select a use case and follow the procedure to create a profile. atlas config init --profile myProfile - .. include:: /includes/steps-atlas-cli-add-profile-nonprogrammatic.rst + .. include:: /includes/steps-atlas-cli-add-profile-programmatic.rst .. _atlas-cli-profile-update: diff --git a/source/atlas-cli-tutorials.txt b/source/atlas-cli-tutorials.txt index 4124430f..6aa231d3 100644 --- a/source/atlas-cli-tutorials.txt +++ b/source/atlas-cli-tutorials.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _atlas-cli-tutorials: ======================================= @@ -18,8 +21,8 @@ Use the following tutorials to learn how to manage |service| using the To learn the {+atlas-cli+} basics, see :ref:`install-atlas-cli` and :ref:`connect-atlas-cli`. -You can also go straight to the :doc:`{+atlas-cli+} Commands -</command/atlas>`. +You can also go straight to the :ref:`{+atlas-cli+} Commands +<atlas>`. .. list-table:: :header-rows: 1 @@ -39,8 +42,26 @@ You can also go straight to the :doc:`{+atlas-cli+} Commands {+cluster+}. This tutorial requires an |service| account and an existing organization. + * - :ref:`atlas-cli-local-cloud` + - Find tutorials for the ``atlas deployments`` command, which lets + you create and manage local and cloud |service| deployments. + + .. include:: /includes/fact-atlas-deployments-preview.rst + + * - :ref:`atlas-cli-ephemeral-cluster` + - Create an ephemeral project and {+cluster+} to test automations. + + * - :ref:`atlas-cli-docker` + - Run {+atlas-cli+} commands with Docker. + + .. toctree:: :titlesonly: - /atlas-cli-getting-started - /atlas-cli-quickstart \ No newline at end of file + Get Started </atlas-cli-getting-started> + Create & Configure Clusters </atlas-cli-quickstart> + Cluster Configuration File </atlas-cli-create-cluster-from-config-file> + Local & Cloud Deployments </atlas-cli-local-cloud> + Test Automations </atlas-cli-ephemeral-cluster> + Run Commands with Docker </atlas-cli-docker> + \ No newline at end of file diff --git a/source/cluster-config-file.txt b/source/cluster-config-file.txt deleted file mode 100644 index 6c59f1a8..00000000 --- a/source/cluster-config-file.txt +++ /dev/null @@ -1,178 +0,0 @@ -.. _atlas-cli-cluster-config-file: - -============================== -{+Cluster+} Configuration File -============================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -You can use a {+cluster+} configuration file to specify the settings -required when you create or update a {+cluster+} using the -{+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` -{+cluster+} configuration files. - -Use the following resources to: - -- Learn the :ref:`required settings <required-cluster-settings>` you - can specify in the {+cluster+} configuration file. -- View and copy :ref:`sample configuration files - <example-cluster-config-file>`. - -.. _required-cluster-settings: - -Required {+Cluster+} Settings ------------------------------ - -|service| requires the following settings to create a {+cluster+} with -the {+atlas-cli+}. 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 - - * - ``clusterType`` - - string - - Human-readable label that indicates the type of {+cluster+} to - create. Values include: ``REPLICASET``, ``SHARDED``, or - ``GEOSHARDED``. - - * - ``name`` - - string - - Human-readable label that identifies the {+cluster+}. - - * - ``replicationSpecs`` - - array - - List that contains the configuration settings for your - {+cluster+} regions and the hardware provisioned in them. - - * - ``replicationSpecs.`` - ``regionConfigs`` - - array - - List that contains the hardware specifications for the nodes set - within the region that you specify. Each ``regionConfigs`` - object describes the region's priority in elections and the - number and type of MongoDB nodes that |service| deploys to the - region. - - Each ``regionConfigs`` object must have either an - ``analyticsSpecs`` object, ``electableSpecs`` object, or - ``readOnlySpecs`` object. - - - Shared {+clusters+} require only ``electableSpecs``. - - Dedicated {+clusters+} can specify any of these - specifications, but must have at least one ``electableSpecs`` - object within a ``replicationSpec``. - - Every hardware specification must use the same - ``instanceSize``. - - * - ``replicationSpecs.`` - ``regionConfigs.electableSpecs`` - - object - - Hardware specifications for electable nodes in the region. - Electable nodes can become the - :manual:`primary </core/replica-set-members/#std-label-replica-set-primary-member>` and can enable - local reads. - - * - ``replicationSpecs.`` - ``regionConfigs.`` - ``electableSpecs.instanceSize`` - - string - - Hardware specification for the instance sizes in this region. To - learn more, see :ref:`create-cluster-instance`. - - * - ``replicationSpecs`` - ``.regionConfigs.`` - ``electableSpecs.nodeCount`` - - number - - Number of electable nodes for |service| to deploy to the region. - Electable nodes can become the - :manual:`primary </core/replica-set-members/#std-label-replica-set-primary-member>` and can enable - local reads. - - The combined electableSpecs.nodeCount across all - replicationSpecs[n].regionConfigs[m] objects must total 3, 5, or - 7. - - * - ``replicationSpecs.`` - ``regionConfigs.priority`` - - Integer - - Precedence that is given to this region when a primary election - occurs. - - If your region has set ``electableSpecs.nodeCount`` to ``1`` or - higher, it must have a priority of exactly one (1) less than - another region in the ``replicationSpecs[n].regionConfigs[m]`` - array. The highest-priority region must have a priority of - ``7``. The lowest possible priority is ``1``. - - The priority ``7`` region identifies the preferred region of the - {+cluster+}. |service| places the - :manual:`primary </core/replica-set-members/#std-label-replica-set-primary-member>` node in the - preferred region. - - * - ``replicationSpecs.`` - ``regionConfigs.providerName`` - - string - - Human-readable label that identifies your cloud service - provider. Values include: ``AWS``, ``AZURE``, or ``GCP``. - - To create a multi-cloud {+cluster+}, specify more than one - service provider for your ``regionConfigs`` objects. To - learn more, see the :ref:`multi-cloud example configuration file - <multi-cloud-example-cluster-config-file>` - - * - ``replicationSpecs.`` - ``regionConfigs.regionName`` - - string - - Human-readable label that indicates the physical location of - your {+cluster+} nodes. The region you choose can affect network - latency for clients accessing your databases. - - For a complete list of region name values, refer to the the - cloud provider reference pages: - - - :atlas:`AWS </reference/amazon-aws/#amazon-aws>>` - - :atlas:`GCP </reference/google-gcp/#google-gcp>` - - :atlas:`Azure </reference/microsoft-azure/#microsoft-azure>` - -.. _optional-cluster-settings: - -Optional and Conditional {+Cluster+} Settings ---------------------------------------------- - -Your {+cluster+} configuration file may contain additional optional or -conditional {+cluster+} settings. For a full list of available -settings, see the API documentation for -:atlas:`Create One Multi-Cloud Cluster from One Project -</reference/api-resources-spec/#operation/createOneAdvancedClusterFromOneProject>`. - -.. _example-cluster-config-file: - -Example Cluster Configuration File ----------------------------------- - -To create a {+cluster+} using a single cloud provider, specify the same -service provider for your ``regionConfigs`` objects as shown in the -following example file: - -.. literalinclude:: /includes/json-cluster-config-file.json - -.. _multi-cloud-example-cluster-config-file: - -Multi-Cloud Example 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 diff --git a/source/command b/source/command deleted file mode 120000 index e7119cc0..00000000 --- a/source/command +++ /dev/null @@ -1 +0,0 @@ -../submodules/mongodb-atlas-cli/docs/atlascli/command \ No newline at end of file diff --git a/source/command/atlas-accessLists-create.txt b/source/command/atlas-accessLists-create.txt new file mode 100644 index 00000000..bb8c8e5c --- /dev/null +++ b/source/command/atlas-accessLists-create.txt @@ -0,0 +1,143 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-accessLists-create: + +======================== +atlas accessLists create +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an IP access list entry for your project. + +The access list can contain trusted IP addresses, AWS security group IDs, and entries in Classless Inter-Domain Routing (CIDR) notation. You can add only one access list entry at a time. You can create one access list per project. + +The command doesn't overwrite existing entries in the access list. Instead, it adds the new entries to the list of entries. + +To use this command, you must authenticate with a user account or an API key with the Read Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas accessLists create [entry] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - entry + - string + - false + - IP address, CIDR address, or AWS security group ID that you want to add to the access list. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --comment + - string + - false + - Optional description or comment for the entry. + * - --currentIp + - + - false + - Flag that adds the IP address from the host that is currently executing the command to the access list. Only applicable for type ipAddress entries. You don't need the entry argument when you use the currentIp option. + * - --deleteAfter + - string + - false + - ISO-8601-formatted UTC date after which Atlas removes the entry from the access list. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of access list entry. Valid values are cidrBlock, ipAddress, or awsSecurityGroup. This value defaults to "ipAddress". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Created a new IP access list. + + +Examples +-------- + +.. code-block:: + + # Create an IP access list entry using the current IP address: + atlas accessList create --currentIp + + +.. code-block:: + + # Create an access list entry for the IP address 192.0.2.15 in the project with ID 5e2211c17a3e5a48f5497de3: + atlas accessList create 192.0.2.15 --type ipAddress --projectId 5e2211c17a3e5a48f5497de3 --comment "IP address for app server 2" --output json + + +.. code-block:: + + # Create an access list entry in CIDR notation for 73.231.201.205/24 in the project with ID 5e2211c17a3e5a48f5497de3: + atlas accessList create 73.231.201.205/24 --type cidrBlock --projectId 5e2211c17a3e5a48f5497de3 --output json --comment "CIDR block for servers C - F" + + +.. code-block:: + + # Create an access list entry for the AWS security group sg-903004f8 in the project with ID 5e2211c17a3e5a48f5497de3: + atlas accessList create sg-903004f8 --type awsSecurityGroup + --projectId 5e2211c17a3e5a48f5497de3 --output json --comment "AWS Security Group" diff --git a/source/command/atlas-accessLists-delete.txt b/source/command/atlas-accessLists-delete.txt new file mode 100644 index 00000000..0bb3c419 --- /dev/null +++ b/source/command/atlas-accessLists-delete.txt @@ -0,0 +1,111 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-accessLists-delete: + +======================== +atlas accessLists delete +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified IP access list entry from your project. + +The command, when run without the force option, prompts you to confirm the operation. + +To use this command, you must authenticate with a user account or an API key with the Read Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas accessLists delete <entry> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - entry + - string + - true + - The IP address, CIDR address, or AWS security group ID that you want to remove from the access list. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project access list entry '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the IP address 192.0.2.0 from the access list for the project with the ID 5e2211c17a3e5a48f5497de3 after prompting for a confirmation: + atlas accessLists delete 192.0.2.0 --projectId 5e2211c17a3e5a48f5497de3 + +.. code-block:: + + # Remove the IP address 192.0.2.0 from the access list for the project with the ID 5e2211c17a3e5a48f5497de3 without requiring confirmation: + atlas accessLists delete 192.0.2.0 --projectId 5e2211c17a3e5a48f5497de3 --force diff --git a/source/command/atlas-accessLists-describe.txt b/source/command/atlas-accessLists-describe.txt new file mode 100644 index 00000000..f653596d --- /dev/null +++ b/source/command/atlas-accessLists-describe.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-accessLists-describe: + +========================== +atlas accessLists describe +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified IP access list entry. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas accessLists describe <entry> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - entry + - string + - true + - The IP address, CIDR address, or AWS security group ID of the access list entry to return. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the access list entry 192.0.2.0/24 in the project with ID 5e2211c17a3e5a48f5497de3: + atlas accessLists describe 192.0.2.0/24 --output json --projectId 5e1234c17a3e5a48f5497de3 diff --git a/source/command/atlas-accessLists-list.txt b/source/command/atlas-accessLists-list.txt new file mode 100644 index 00000000..a3e629e2 --- /dev/null +++ b/source/command/atlas-accessLists-list.txt @@ -0,0 +1,90 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-accessLists-list: + +====================== +atlas accessLists list +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all IP access list entries for your project. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas accessLists list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all access list entries for the project with ID 5e1234c17a3e5a48f5497de3: + atlas accessLists list --output json --projectId 5e1234c17a3e5a48f5497de3 diff --git a/source/command/atlas-accessLists.txt b/source/command/atlas-accessLists.txt new file mode 100644 index 00000000..c9c1a544 --- /dev/null +++ b/source/command/atlas-accessLists.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-accessLists: + +================= +atlas accessLists +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the list of IP addresses that can access your Atlas project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for accessLists + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-accessLists-create` - Create an IP access list entry for your project. +* :ref:`atlas-accessLists-delete` - Remove the specified IP access list entry from your project. +* :ref:`atlas-accessLists-describe` - Return the details for the specified IP access list entry. +* :ref:`atlas-accessLists-list` - Return all IP access list entries for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-accessLists-create> + delete </command/atlas-accessLists-delete> + describe </command/atlas-accessLists-describe> + list </command/atlas-accessLists-list> + diff --git a/source/command/atlas-accessLogs-list.txt b/source/command/atlas-accessLogs-list.txt new file mode 100644 index 00000000..ff21a1c0 --- /dev/null +++ b/source/command/atlas-accessLogs-list.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-accessLogs-list: + +===================== +atlas accessLogs list +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Retrieve the access logs of a cluster identified by the cluster's name or hostname. + +To use this command, you must authenticate with a user account or an API key with the Project Monitoring Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas accessLogs list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authResult + - string + - false + - Authentication attempts that Atlas should return. When set to success, Atlas filters the log to return only successful authentication attempts. When set to fail, Atlas filters the log to return only failed authentication attempts. + * - --clusterName + - string + - false + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --end + - string + - false + - Timestamp in the number of milliseconds that have elapsed, since the UNIX Epoch, for the last entry that Atlas returns from the database access logs. + * - -h, --help + - + - false + - help for list + * - --hostname + - string + - false + - The fully qualified domain name (FQDN) of the target node that should receive the authentication attempt. + * - --ip + - string + - false + - IP address that attempted to authenticate with the database. Atlas filters the returned logs to include documents with only this IP address. + * - --nLog + - int + - false + - Maximum number of log lines to return. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - string + - false + - Timestamp in the number of milliseconds that have elapsed, since the UNIX Epoch, for the first entry that Atlas returns from the database access logs. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all authentication requests made against the cluster named Cluster0 for the project with ID 618d48e05277a606ed2496fe: + atlas accesslogs list --output json --projectId 618d48e05277a606ed2496fe --clusterName Cluster0 diff --git a/source/command/atlas-accessLogs.txt b/source/command/atlas-accessLogs.txt new file mode 100644 index 00000000..5afdc413 --- /dev/null +++ b/source/command/atlas-accessLogs.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-accessLogs: + +================ +atlas accessLogs +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the access logs for a cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for accessLogs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-accessLogs-list` - Retrieve the access logs of a cluster identified by the cluster's name or hostname. + + +.. toctree:: + :titlesonly: + + list </command/atlas-accessLogs-list> + diff --git a/source/command/atlas-alerts-acknowledge.txt b/source/command/atlas-alerts-acknowledge.txt new file mode 100644 index 00000000..a7ae81b9 --- /dev/null +++ b/source/command/atlas-alerts-acknowledge.txt @@ -0,0 +1,116 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-acknowledge: + +======================== +atlas alerts acknowledge +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Acknowledges the specified alert for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts acknowledge <alertId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - alertId + - string + - true + - ID of the alert you want to acknowledge or unacknowledge. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --comment + - string + - false + - Optional description or comment for the entry. + * - -F, --forever + - + - false + - Option that acknowledges an alert 'forever'. You can't set both the forever option and the until option in the same command. + * - -h, --help + - + - false + - help for acknowledge + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --until + - string + - false + - ISO 8601-formatted time until which the alert is acknowledged. This command returns this value if a MongoDB user previously acknowledged the alert. After this date, the alert becomes unacknowledged. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Alert '<Id>' acknowledged until <AcknowledgedUntil> + + +Examples +-------- + +.. code-block:: + + # Acknowledge an alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3 until January 1 2028: + atlas alerts acknowledge 5d1113b25a115342acc2d1aa --until 2028-01-01T20:24:26Z --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-alerts-describe.txt b/source/command/atlas-alerts-describe.txt new file mode 100644 index 00000000..e9d0e15c --- /dev/null +++ b/source/command/atlas-alerts-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-describe: + +===================== +atlas alerts describe +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified alert for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts describe <alertId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - alertId + - string + - true + - Unique identifier of the alert you want to describe. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID TYPE METRIC STATUS + <Id> <EventTypeName> <MetricName> <Status> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas alerts describe 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-alerts-list.txt b/source/command/atlas-alerts-list.txt new file mode 100644 index 00000000..7c22705f --- /dev/null +++ b/source/command/atlas-alerts-list.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-list: + +================= +atlas alerts list +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all alerts for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --status + - string + - false + - State of the alert. Valid values include TRACKING, OPEN, CLOSED, and CANCELLED. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID TYPE STATUS + <Id> <EventTypeName> <Status> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all alerts for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas alerts list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-alerts-settings-create.txt b/source/command/atlas-alerts-settings-create.txt new file mode 100644 index 00000000..3035c069 --- /dev/null +++ b/source/command/atlas-alerts-settings-create.txt @@ -0,0 +1,212 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-create: + +============================ +atlas alerts settings create +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an alert configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts settings create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - false + - Datadog API Key, Opsgenie API Key, or VictorOps API key. Required if the notificationType is DATADOG, OPS_GENIE, or VICTOR_OPS, respectively. + * - --enabled + - + - false + - Flag that indicates whether to enable the alert configuration. + * - --event + - string + - false + - Type of event that triggered the alert. To learn which values the CLI accepts, see the Enum for eventTypeName in the Atlas Admin API spec: https://dochub.mongodb.org/core/atlas-event-names. + * - -f, --file + - string + - false + - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli. + * - -h, --help + - + - false + - help for create + * - --matcherFieldName + - string + - false + - Name of the field in the target object to match on. To learn the valid values, run atlas alerts settings fields type. + * - --matcherOperator + - string + - false + - Comparison operator to apply when checking the current metric against matcherValue. Valid values are CONTAINS, ENDS_WITH, EQUALS, NOT_CONTAINS, NOT_EQUALS, REGEX, STARTS_WITH. + * - --matcherValue + - string + - false + - Value to test with the specified operator. If matcherFieldName is set to TYPE_NAME, you can match on the following values: CONFIG, MONGOS, PRIMARY, SECONDARY, STANDALONE. + * - --metricMode + - string + - false + - Option that indicates whether Atlas computes the current metric value as an average. Valid value is AVERAGE. + * - --metricName + - string + - false + - Name of the metric against which this command checks the configured alert. To learn the valid values, see https://dochub.mongodb.org/core/alert-host-metrics-atlas. This option applies only if the event is set to OUTSIDE_METRIC_THRESHOLD. + * - --metricOperator + - string + - false + - Comparison operator to apply when checking the current metric value. Valid values are LESS_THAN and GREATER_THAN. + * - --metricThreshold + - float + - false + - Threshold value outside of which an alert will be triggered. + * - --metricUnits + - string + - false + - Units for the threshold value. Valid values are BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILLISECONDS, MINUTES, PETABYTES, RAW, SECONDS, TERABYTES. + * - --notificationChannelName + - string + - false + - Slack channel name. Required for the SLACK notifications type. + * - --notificationDelayMin + - int + - false + - Number of minutes to wait after an alert condition is detected before sending out the first notification. + * - --notificationEmailAddress + - string + - false + - Email address to which alert notifications are sent. + * - --notificationEmailEnabled + - + - false + - Flag that enables email notifications. Configurable for GROUP and USER notification types. + * - --notificationIntervalMin + - int + - false + - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. + * - --notificationMobileNumber + - string + - false + - Mobile number to which alert notifications are sent. + * - --notificationRegion + - string + - false + - Region that indicates which API URL to use. + * - --notificationRole + - strings + - false + - List that contains the one or more organization or project roles that receive the configured alert. + * - --notificationServiceKey + - string + - false + - PagerDuty service key. + * - --notificationSmsEnabled + - + - false + - Flag that enables text message notifications. + * - --notificationTeamId + - string + - false + - Unique identifier of a team. + * - --notificationToken + - string + - false + - Slack API token, or Bot token. + * - --notificationType + - string + - false + - Type of alert notification. Valid values are DATADOG, EMAIL, GROUP (Project), MICROSOFT_TEAMS, ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, TEAM, USER, VICTOR_OPS, or WEBHOOK. + * - --notificationUsername + - string + - false + - Name of the Atlas user to which to send notifications. + * - --notificationVictorOpsRoutingKey + - string + - false + - Routing key associated with your Splunk On-Call account. + * - --notificationWebhookSecret + - string + - false + - Authentication secret for a webhook-based alert. + * - --notificationWebhookUrl + - string + - false + - Target URL for a webhook-based alert or Microsoft Teams alert. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Alert configuration <Id> created. + + +Examples +-------- + +.. code-block:: + + # Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305: + atlas alerts settings create --event JOINED_GROUP --enabled \ + --notificationType USER --notificationEmailEnabled \ + --notificationIntervalMin 60 --notificationUsername john@example.com \ + --output json --projectId 5df90590f10fab5e33de2305 + +.. code-block:: + + # Create alert using json file containing alert configuration + atlas alerts settings create 5d1113b25a115342acc2d1aa --file alerts.json diff --git a/source/command/atlas-alerts-settings-delete.txt b/source/command/atlas-alerts-settings-delete.txt new file mode 100644 index 00000000..18c61ecf --- /dev/null +++ b/source/command/atlas-alerts-settings-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-delete: + +============================ +atlas alerts settings delete +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified alert configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts settings delete <alertConfigId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - alertConfigId + - string + - true + - Unique identifier of the alert configuration to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Alert config '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the alert configuration with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas alerts settings delete 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-alerts-settings-describe.txt b/source/command/atlas-alerts-settings-describe.txt new file mode 100644 index 00000000..d0af8d14 --- /dev/null +++ b/source/command/atlas-alerts-settings-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-describe: + +============================== +atlas alerts settings describe +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified alert settings for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts settings describe <alertConfigId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - alertConfigId + - string + - true + - Unique identifier of the alert settings you want to describe. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID TYPE ENABLED + <Id> <EventTypeName> <Enabled> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the alert settings with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas alerts settings describe 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-alerts-settings-disable.txt b/source/command/atlas-alerts-settings-disable.txt new file mode 100644 index 00000000..57a4a4f1 --- /dev/null +++ b/source/command/atlas-alerts-settings-disable.txt @@ -0,0 +1,95 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-disable: + +============================= +atlas alerts settings disable +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disables one alert configuration for the specified project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts settings disable <alertConfigId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - alertConfigId + - string + - true + - ID of the alert configuration you want to disable. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Alert configuration '<ID>' disabled + + diff --git a/source/command/atlas-alerts-settings-enable.txt b/source/command/atlas-alerts-settings-enable.txt new file mode 100644 index 00000000..0ea0d93e --- /dev/null +++ b/source/command/atlas-alerts-settings-enable.txt @@ -0,0 +1,102 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-enable: + +============================ +atlas alerts settings enable +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enables one alert configuration for the specified project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts settings enable <alertConfigId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - alertConfigId + - string + - true + - ID of the alert you want to enable. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Alert configuration '<Id>' enabled + + +Examples +-------- + +.. code-block:: + + # Enable the alert configuration with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas alerts settings enable 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-alerts-settings-fields-type.txt b/source/command/atlas-alerts-settings-fields-type.txt new file mode 100644 index 00000000..097b9e59 --- /dev/null +++ b/source/command/atlas-alerts-settings-fields-type.txt @@ -0,0 +1,74 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-fields-type: + +================================= +atlas alerts settings fields type +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts settings fields type [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for type + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of accepted field types for the matchersFieldName option: + atlas alerts settings fields type --output json diff --git a/source/command/atlas-alerts-settings-fields.txt b/source/command/atlas-alerts-settings-fields.txt new file mode 100644 index 00000000..fbc9c10a --- /dev/null +++ b/source/command/atlas-alerts-settings-fields.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-fields: + +============================ +atlas alerts settings fields +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manages alert configuration fields for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for fields + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-alerts-settings-fields-type` - Return all available field types that the matcherFieldName option accepts when you create or update an alert configuration. + + +.. toctree:: + :titlesonly: + + type </command/atlas-alerts-settings-fields-type> + diff --git a/source/command/atlas-alerts-settings-list.txt b/source/command/atlas-alerts-settings-list.txt new file mode 100644 index 00000000..3ce29fd6 --- /dev/null +++ b/source/command/atlas-alerts-settings-list.txt @@ -0,0 +1,90 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-list: + +========================== +atlas alerts settings list +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all alert configurations for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts settings list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all alert configurations for the project with the ID 5df90590f10fab5e33de2305: + atlas alerts settings list --projectId 5df90590f10fab5e33de2305 --output json diff --git a/source/command/atlas-alerts-settings-update.txt b/source/command/atlas-alerts-settings-update.txt new file mode 100644 index 00000000..b9f53796 --- /dev/null +++ b/source/command/atlas-alerts-settings-update.txt @@ -0,0 +1,232 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings-update: + +============================ +atlas alerts settings update +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the details of the specified alert configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts settings update <alertConfigId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - alertConfigId + - string + - true + - Unique identifier of the alert configuration you want to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - false + - Datadog API Key, Opsgenie API Key, or VictorOps API key. Required if the notificationType is DATADOG, OPS_GENIE, or VICTOR_OPS, respectively. + * - --enabled + - + - false + - Flag that indicates whether to enable the alert configuration. + * - --event + - string + - false + - Type of event that triggered the alert. To learn which values the CLI accepts, see the Enum for eventTypeName in the Atlas Admin API spec: https://dochub.mongodb.org/core/atlas-event-names. + * - -f, --file + - string + - false + - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli. + * - -h, --help + - + - false + - help for update + * - --matcherFieldName + - string + - false + - Name of the field in the target object to match on. To learn the valid values, run atlas alerts settings fields type. + * - --matcherOperator + - string + - false + - Comparison operator to apply when checking the current metric against matcherValue. Valid values are CONTAINS, ENDS_WITH, EQUALS, NOT_CONTAINS, NOT_EQUALS, REGEX, STARTS_WITH. + * - --matcherValue + - string + - false + - Value to test with the specified operator. If matcherFieldName is set to TYPE_NAME, you can match on the following values: CONFIG, MONGOS, PRIMARY, SECONDARY, STANDALONE. + * - --metricMode + - string + - false + - Option that indicates whether Atlas computes the current metric value as an average. Valid value is AVERAGE. + * - --metricName + - string + - false + - Name of the metric against which this command checks the configured alert. To learn the valid values, see https://dochub.mongodb.org/core/alert-host-metrics-atlas. This option applies only if the event is set to OUTSIDE_METRIC_THRESHOLD. + * - --metricOperator + - string + - false + - Comparison operator to apply when checking the current metric value. Valid values are LESS_THAN and GREATER_THAN. + * - --metricThreshold + - float + - false + - Threshold value outside of which an alert will be triggered. + * - --metricUnits + - string + - false + - Units for the threshold value. Valid values are BITS, BYTES, DAYS, GIGABITS, GIGABYTES, HOURS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILLISECONDS, MINUTES, PETABYTES, RAW, SECONDS, TERABYTES. + * - --notificationChannelName + - string + - false + - Slack channel name. Required for the SLACK notifications type. + * - --notificationDelayMin + - int + - false + - Number of minutes to wait after an alert condition is detected before sending out the first notification. + * - --notificationEmailAddress + - string + - false + - Email address to which alert notifications are sent. + * - --notificationEmailEnabled + - + - false + - Flag that enables email notifications. Configurable for GROUP and USER notification types. + * - --notificationIntervalMin + - int + - false + - Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. + * - --notificationMobileNumber + - string + - false + - Mobile number to which alert notifications are sent. + * - --notificationRegion + - string + - false + - Region that indicates which API URL to use. + * - --notificationRole + - strings + - false + - List that contains the one or more organization or project roles that receive the configured alert. + * - --notificationServiceKey + - string + - false + - PagerDuty service key. + * - --notificationSmsEnabled + - + - false + - Flag that enables text message notifications. + * - --notificationTeamId + - string + - false + - Unique identifier of a team. + * - --notificationToken + - string + - false + - Slack API token, or Bot token. + * - --notificationType + - string + - false + - Type of alert notification. Valid values are DATADOG, EMAIL, GROUP (Project), MICROSOFT_TEAMS, ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, TEAM, USER, VICTOR_OPS, or WEBHOOK. + * - --notificationUsername + - string + - false + - Name of the Atlas user to which to send notifications. + * - --notificationVictorOpsRoutingKey + - string + - false + - Routing key associated with your Splunk On-Call account. + * - --notificationWebhookSecret + - string + - false + - Authentication secret for a webhook-based alert. + * - --notificationWebhookUrl + - string + - false + - Target URL for a webhook-based alert or Microsoft Teams alert. + * - --notifierId + - string + - false + - System-generated unique identifier assigned to each notification method. This identifier is needed when updating third-party notifications without requiring explicit authentication credentials. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Alert configuration '<Id>' updated. + + +Examples +-------- + +.. code-block:: + + # Modify the alert configuration with the ID 5d1113b25a115342acc2d1aa so that it notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305: + atlas alerts settings update 5d1113b25a115342acc2d1aa --event JOINED_GROUP --enabled \ + --notificationType USER --notificationEmailEnabled \ + --notificationIntervalMin 60 --notificationUsername john@example.com \ + --output json --projectId 5df90590f10fab5e33de2305 + +.. code-block:: + + # Update alert using json file input containing alert configuration + atlas alerts settings update 5d1113b25a115342acc2d1aa --file alerts.json diff --git a/source/command/atlas-alerts-settings.txt b/source/command/atlas-alerts-settings.txt new file mode 100644 index 00000000..6e6e616f --- /dev/null +++ b/source/command/atlas-alerts-settings.txt @@ -0,0 +1,78 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-settings: + +===================== +atlas alerts settings +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manages alerts configuration for your project. + +Use this command to list, create, edit, delete, enable and disable alert configurations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for settings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-alerts-settings-create` - Create an alert configuration for your project. +* :ref:`atlas-alerts-settings-delete` - Remove the specified alert configuration for your project. +* :ref:`atlas-alerts-settings-describe` - Return the details for the specified alert settings for your project. +* :ref:`atlas-alerts-settings-disable` - Disables one alert configuration for the specified project. +* :ref:`atlas-alerts-settings-enable` - Enables one alert configuration for the specified project. +* :ref:`atlas-alerts-settings-fields` - Manages alert configuration fields for your project. +* :ref:`atlas-alerts-settings-list` - Returns all alert configurations for your project. +* :ref:`atlas-alerts-settings-update` - Modify the details of the specified alert configuration for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-alerts-settings-create> + delete </command/atlas-alerts-settings-delete> + describe </command/atlas-alerts-settings-describe> + disable </command/atlas-alerts-settings-disable> + enable </command/atlas-alerts-settings-enable> + fields </command/atlas-alerts-settings-fields> + list </command/atlas-alerts-settings-list> + update </command/atlas-alerts-settings-update> + diff --git a/source/command/atlas-alerts-unacknowledge.txt b/source/command/atlas-alerts-unacknowledge.txt new file mode 100644 index 00000000..bcb1e60f --- /dev/null +++ b/source/command/atlas-alerts-unacknowledge.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts-unacknowledge: + +========================== +atlas alerts unacknowledge +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Unacknowledge the specified alert for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas alerts unacknowledge <alertId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - alertId + - string + - true + - Unique ID of the alert you want to unacknowledge. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --comment + - string + - false + - Optional description or comment for the entry. + * - -h, --help + - + - false + - help for unacknowledge + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Alert '<Id>' unacknowledged + + +Examples +-------- + +.. code-block:: + + # Unacknowledge the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas alerts unacknowledge 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-alerts.txt b/source/command/atlas-alerts.txt new file mode 100644 index 00000000..9682680c --- /dev/null +++ b/source/command/atlas-alerts.txt @@ -0,0 +1,70 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-alerts: + +============ +atlas alerts +============ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage alerts for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for alerts + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-alerts-acknowledge` - Acknowledges the specified alert for your project. +* :ref:`atlas-alerts-describe` - Return the details for the specified alert for your project. +* :ref:`atlas-alerts-list` - Return all alerts for your project. +* :ref:`atlas-alerts-settings` - Manages alerts configuration for your project. +* :ref:`atlas-alerts-unacknowledge` - Unacknowledge the specified alert for your project. + + +.. toctree:: + :titlesonly: + + acknowledge </command/atlas-alerts-acknowledge> + describe </command/atlas-alerts-describe> + list </command/atlas-alerts-list> + settings </command/atlas-alerts-settings> + unacknowledge </command/atlas-alerts-unacknowledge> + diff --git a/source/command/atlas-auditing-describe.txt b/source/command/atlas-auditing-describe.txt new file mode 100644 index 00000000..588f3857 --- /dev/null +++ b/source/command/atlas-auditing-describe.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-auditing-describe: + +======================= +atlas auditing describe +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns the auditing configuration for the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas auditing describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + AUDIT AUTHORIZATION SUCCESS AUDIT FILTER CONFIGURATION TYPE ENABLED + <AuditAuthorizationSuccess> <AuditFilter> <ConfigurationType> <Enabled> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the default project: + atlas auditing describe --output json diff --git a/source/command/atlas-auditing.txt b/source/command/atlas-auditing.txt new file mode 100644 index 00000000..5fc135f7 --- /dev/null +++ b/source/command/atlas-auditing.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-auditing: + +============== +atlas auditing +============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns database auditing settings for MongoDB Cloud projects. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for auditing + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-auditing-describe` - Returns the auditing configuration for the specified project. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-auditing-describe> + diff --git a/source/command/atlas-auth-login.txt b/source/command/atlas-auth-login.txt new file mode 100644 index 00000000..55d663ce --- /dev/null +++ b/source/command/atlas-auth-login.txt @@ -0,0 +1,77 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-auth-login: + +================ +atlas auth login +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Authenticate with MongoDB Atlas. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas auth login [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --gov + - + - false + - Log in to Atlas for Government. + * - -h, --help + - + - false + - help for login + * - --noBrowser + - + - false + - Don't try to open a browser session. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Log in to your MongoDB Atlas account in interactive mode: + atlas auth login + diff --git a/source/command/atlas-auth-logout.txt b/source/command/atlas-auth-logout.txt new file mode 100644 index 00000000..6081c934 --- /dev/null +++ b/source/command/atlas-auth-logout.txt @@ -0,0 +1,73 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-auth-logout: + +================= +atlas auth logout +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Log out of the CLI. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas auth logout [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for logout + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # To log out from the CLI: + atlas auth logout + diff --git a/source/command/atlas-auth-register.txt b/source/command/atlas-auth-register.txt new file mode 100644 index 00000000..a64d3182 --- /dev/null +++ b/source/command/atlas-auth-register.txt @@ -0,0 +1,73 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-auth-register: + +=================== +atlas auth register +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Register with MongoDB Atlas. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas auth register [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for register + * - --noBrowser + - + - false + - Don't try to open a browser session. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # To start the interactive setup: + atlas auth register + diff --git a/source/command/atlas-auth-whoami.txt b/source/command/atlas-auth-whoami.txt new file mode 100644 index 00000000..c444df31 --- /dev/null +++ b/source/command/atlas-auth-whoami.txt @@ -0,0 +1,69 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-auth-whoami: + +================= +atlas auth whoami +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Verifies and displays information about your authentication state. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas auth whoami [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for whoami + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # See the logged account: + atlas auth whoami + diff --git a/source/command/atlas-auth.txt b/source/command/atlas-auth.txt new file mode 100644 index 00000000..f219582d --- /dev/null +++ b/source/command/atlas-auth.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-auth: + +========== +atlas auth +========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the CLI's authentication state. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for auth + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-auth-login` - Authenticate with MongoDB Atlas. +* :ref:`atlas-auth-logout` - Log out of the CLI. +* :ref:`atlas-auth-register` - Register with MongoDB Atlas. +* :ref:`atlas-auth-whoami` - Verifies and displays information about your authentication state. + + +.. toctree:: + :titlesonly: + + login </command/atlas-auth-login> + logout </command/atlas-auth-logout> + register </command/atlas-auth-register> + whoami </command/atlas-auth-whoami> + diff --git a/source/command/atlas-backups-compliancePolicy-copyProtection-disable.txt b/source/command/atlas-backups-compliancePolicy-copyProtection-disable.txt new file mode 100644 index 00000000..abe023f6 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-copyProtection-disable.txt @@ -0,0 +1,73 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-copyProtection-disable: + +===================================================== +atlas backups compliancePolicy copyProtection disable +===================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable copy protection of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy copyProtection disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-copyProtection-enable.txt b/source/command/atlas-backups-compliancePolicy-copyProtection-enable.txt new file mode 100644 index 00000000..7bf8cd07 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-copyProtection-enable.txt @@ -0,0 +1,73 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-copyProtection-enable: + +==================================================== +atlas backups compliancePolicy copyProtection enable +==================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable copy protection of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy copyProtection enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-copyProtection.txt b/source/command/atlas-backups-compliancePolicy-copyProtection.txt new file mode 100644 index 00000000..9d3399e9 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-copyProtection.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-copyProtection: + +============================================= +atlas backups compliancePolicy copyProtection +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage copy protection of the backup compliance policy for your project. Learn more: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#-optional--keep-all-snapshots-when-removing-additional-snapshot-regions. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for copyProtection + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy-copyProtection-disable` - Disable copy protection of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-copyProtection-enable` - Enable copy protection of the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + disable </command/atlas-backups-compliancePolicy-copyProtection-disable> + enable </command/atlas-backups-compliancePolicy-copyProtection-enable> + diff --git a/source/command/atlas-backups-compliancePolicy-describe.txt b/source/command/atlas-backups-compliancePolicy-describe.txt new file mode 100644 index 00000000..544afd2b --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-describe.txt @@ -0,0 +1,69 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-describe: + +======================================= +atlas backups compliancePolicy describe +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-enable.txt b/source/command/atlas-backups-compliancePolicy-enable.txt new file mode 100644 index 00000000..5ad998f2 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-enable.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-enable: + +===================================== +atlas backups compliancePolicy enable +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable Backup Compliance Policy without any configuration. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authorizedEmail + - string + - true + - Email address of a security or legal representative. + * - --authorizedUserFirstName + - string + - true + - First name of the user who is authorized to update the Backup Compliance Policy settings. + * - --authorizedUserLastName + - string + - true + - Last name of the user who is authorized to update the Backup Compliance Policy settings. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt b/source/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt new file mode 100644 index 00000000..3d81641f --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt @@ -0,0 +1,73 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-encryptionAtRest-disable: + +======================================================= +atlas backups compliancePolicy encryptionAtRest disable +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable encryption-at-rest for the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy encryptionAtRest disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt b/source/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt new file mode 100644 index 00000000..6f60c327 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt @@ -0,0 +1,73 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-encryptionAtRest-enable: + +====================================================== +atlas backups compliancePolicy encryptionAtRest enable +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable encryption-at-rest for the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy encryptionAtRest enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-encryptionAtRest.txt b/source/command/atlas-backups-compliancePolicy-encryptionAtRest.txt new file mode 100644 index 00000000..ba20c0d0 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-encryptionAtRest.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-encryptionAtRest: + +=============================================== +atlas backups compliancePolicy encryptionAtRest +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage encryption-at-rest for the backup compliance policy for your project. Encryption-at-rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for encryptionAtRest + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy-encryptionAtRest-disable` - Disable encryption-at-rest for the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-encryptionAtRest-enable` - Enable encryption-at-rest for the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + disable </command/atlas-backups-compliancePolicy-encryptionAtRest-disable> + enable </command/atlas-backups-compliancePolicy-encryptionAtRest-enable> + diff --git a/source/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt b/source/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt new file mode 100644 index 00000000..96201180 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt @@ -0,0 +1,77 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-pointInTimeRestores-enable: + +========================================================= +atlas backups compliancePolicy pointInTimeRestores enable +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable Point-in-Time restores of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy pointInTimeRestores enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --restoreWindowDays + - int + - true + - Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer. Applies to continuous cloud backups only. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt b/source/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt new file mode 100644 index 00000000..12eaf8bc --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-pointInTimeRestores: + +================================================== +atlas backups compliancePolicy pointInTimeRestores +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage whether the project uses Continuous Cloud Backups with a Backup Compliance Policy. Read more in the documentation: https://www.mongodb.com/docs/atlas/backup/cloud-backup/configure-backup-policy/#configure-the-restore-window. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for pointInTimeRestores + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy-pointInTimeRestores-enable` - Enable Point-in-Time restores of the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + enable </command/atlas-backups-compliancePolicy-pointInTimeRestores-enable> + diff --git a/source/command/atlas-backups-compliancePolicy-policies-describe.txt b/source/command/atlas-backups-compliancePolicy-policies-describe.txt new file mode 100644 index 00000000..319cf151 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies-describe.txt @@ -0,0 +1,69 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies-describe: + +================================================ +atlas backups compliancePolicy policies describe +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the individual policy items of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt b/source/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt new file mode 100644 index 00000000..3b652312 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt @@ -0,0 +1,88 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies-ondemand-create: + +======================================================= +atlas backups compliancePolicy policies ondemand create +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create the on-demand policy item of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies ondemand create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --retentionUnit + - string + - true + - Unit of time in which Atlas measures snapshot retention: 'days' 'weeks' 'months'. + * - --retentionValue + - int + - true + - Duration in days, weeks, or months that Atlas retains the snapshot. For less frequent policy items, Atlas requires that you specify a value greater than or equal to the value specified for more frequent policy items. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Create a backup compliance on-demand policy with a retention of two weeks: + atlas backups compliancepolicy policies ondemand create --retentionUnit weeks --retentionValue 2 diff --git a/source/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt b/source/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt new file mode 100644 index 00000000..4d0d3f0f --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt @@ -0,0 +1,69 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies-ondemand-describe: + +========================================================= +atlas backups compliancePolicy policies ondemand describe +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the on-demand policy item of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies ondemand describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt b/source/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt new file mode 100644 index 00000000..e290c0f7 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt @@ -0,0 +1,88 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies-ondemand-update: + +======================================================= +atlas backups compliancePolicy policies ondemand update +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update the on-demand policy of the backup compliance for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies ondemand update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --retentionUnit + - string + - true + - Unit of time in which Atlas measures snapshot retention: 'days' 'weeks' 'months'. + * - --retentionValue + - int + - true + - Duration in days, weeks, or months that Atlas retains the snapshot. For less frequent policy items, Atlas requires that you specify a value greater than or equal to the value specified for more frequent policy items. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Update a backup compliance on-demand policy and set it's retention to one week: + atlas backups compliancepolicy policies ondemand update --retentionUnit weeks --retentionValue 1 diff --git a/source/command/atlas-backups-compliancePolicy-policies-ondemand.txt b/source/command/atlas-backups-compliancePolicy-policies-ondemand.txt new file mode 100644 index 00000000..0f9feab9 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies-ondemand.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies-ondemand: + +================================================ +atlas backups compliancePolicy policies ondemand +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the on-demand policy item of the backup compliance policy for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for ondemand + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy-policies-ondemand-create` - Create the on-demand policy item of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-ondemand-describe` - Return the on-demand policy item of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-ondemand-update` - Update the on-demand policy of the backup compliance for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-backups-compliancePolicy-policies-ondemand-create> + describe </command/atlas-backups-compliancePolicy-policies-ondemand-describe> + update </command/atlas-backups-compliancePolicy-policies-ondemand-update> + diff --git a/source/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt b/source/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt new file mode 100644 index 00000000..6bd54742 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt @@ -0,0 +1,96 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies-scheduled-create: + +======================================================== +atlas backups compliancePolicy policies scheduled create +======================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a scheduled policy item for the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies scheduled create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --frequencyInterval + - int + - true + - Number that indicates the frequency interval for a set of snapshots. A value of 1 specifies the first instance of the corresponding frequencyType. In a monthly policy item, 1 indicates that the monthly snapshot occurs on the first day of the month and 40 indicates the last day of the month. In a weekly policy item, 1 indicates that the weekly snapshot occurs on Monday and 7 indicates Sunday. In an hourly policy item, you can set the frequency interval to 1, 2, 4, 6, 8, or 12. For hourly policy items for NVMe clusters, Atlas accepts only 12 as the frequency interval value. + * - --frequencyType + - string + - true + - Frequency type associated with the backup policy: 'daily', 'hourly', 'monthly', 'weekly'. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --retentionUnit + - string + - true + - Unit of time in which Atlas measures snapshot retention: 'days' 'weeks' 'months'. + * - --retentionValue + - int + - true + - Duration in days, weeks, or months that Atlas retains the snapshot. For less frequent policy items, Atlas requires that you specify a value greater than or equal to the value specified for more frequent policy items. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Create a backup compliance schedule policy with a weekly frequency, where the snapshot occurs on Monday and has a retention of two months: + atlas backups compliancepolicy policies scheduled create --frequencyType weekly --frequencyInterval 1 --retentionUnit months --retentionValue 2 diff --git a/source/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt b/source/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt new file mode 100644 index 00000000..690ac37f --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt @@ -0,0 +1,69 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies-scheduled-describe: + +========================================================== +atlas backups compliancePolicy policies scheduled describe +========================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the scheduled policy items of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies scheduled describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy-policies-scheduled.txt b/source/command/atlas-backups-compliancePolicy-policies-scheduled.txt new file mode 100644 index 00000000..4327bbee --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies-scheduled.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies-scheduled: + +================================================= +atlas backups compliancePolicy policies scheduled +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the scheduled policy items of the backup compliance policy for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for scheduled + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy-policies-scheduled-create` - Create a scheduled policy item for the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-scheduled-describe` - Return the scheduled policy items of the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-backups-compliancePolicy-policies-scheduled-create> + describe </command/atlas-backups-compliancePolicy-policies-scheduled-describe> + diff --git a/source/command/atlas-backups-compliancePolicy-policies.txt b/source/command/atlas-backups-compliancePolicy-policies.txt new file mode 100644 index 00000000..3be1e28a --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-policies.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-policies: + +======================================= +atlas backups compliancePolicy policies +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the individual policy items of the backup compliance policy for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for policies + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy-policies-describe` - Return the individual policy items of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-ondemand` - Manage the on-demand policy item of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-scheduled` - Manage the scheduled policy items of the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-backups-compliancePolicy-policies-describe> + ondemand </command/atlas-backups-compliancePolicy-policies-ondemand> + scheduled </command/atlas-backups-compliancePolicy-policies-scheduled> + diff --git a/source/command/atlas-backups-compliancePolicy-setup.txt b/source/command/atlas-backups-compliancePolicy-setup.txt new file mode 100644 index 00000000..df11775f --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy-setup.txt @@ -0,0 +1,81 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy-setup: + +==================================== +atlas backups compliancePolicy setup +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Setup the backup compliance policy for your project with a configuration file. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy setup [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - true + - Path to a JSON configuration file that defines backup compliance policy settings. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for setup + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-backups-compliancePolicy.txt b/source/command/atlas-backups-compliancePolicy.txt new file mode 100644 index 00000000..a39e2711 --- /dev/null +++ b/source/command/atlas-backups-compliancePolicy.txt @@ -0,0 +1,74 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-compliancePolicy: + +============================== +atlas backups compliancePolicy +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for compliancePolicy + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy-copyProtection` - Manage copy protection of the backup compliance policy for your project. Learn more: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#-optional--keep-all-snapshots-when-removing-additional-snapshot-regions. +* :ref:`atlas-backups-compliancePolicy-describe` - Return the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-enable` - Enable Backup Compliance Policy without any configuration. +* :ref:`atlas-backups-compliancePolicy-encryptionAtRest` - Manage encryption-at-rest for the backup compliance policy for your project. Encryption-at-rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. +* :ref:`atlas-backups-compliancePolicy-pointInTimeRestores` - Manage whether the project uses Continuous Cloud Backups with a Backup Compliance Policy. Read more in the documentation: https://www.mongodb.com/docs/atlas/backup/cloud-backup/configure-backup-policy/#configure-the-restore-window. +* :ref:`atlas-backups-compliancePolicy-policies` - Manage the individual policy items of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-setup` - Setup the backup compliance policy for your project with a configuration file. + + +.. toctree:: + :titlesonly: + + copyProtection </command/atlas-backups-compliancePolicy-copyProtection> + describe </command/atlas-backups-compliancePolicy-describe> + enable </command/atlas-backups-compliancePolicy-enable> + encryptionAtRest </command/atlas-backups-compliancePolicy-encryptionAtRest> + pointInTimeRestores </command/atlas-backups-compliancePolicy-pointInTimeRestores> + policies </command/atlas-backups-compliancePolicy-policies> + setup </command/atlas-backups-compliancePolicy-setup> + diff --git a/source/command/atlas-backups-exports-buckets-create.txt b/source/command/atlas-backups-exports-buckets-create.txt new file mode 100644 index 00000000..bf898fff --- /dev/null +++ b/source/command/atlas-backups-exports-buckets-create.txt @@ -0,0 +1,112 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-buckets-create: + +==================================== +atlas backups exports buckets create +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an export destination for Atlas backups using an existing AWS S3 bucket. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups exports buckets create <bucketName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - bucketName + - string + - true + - Name of the existing S3 bucket that the provided role ID is authorized to access. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --cloudProvider + - string + - true + - Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas supports only AWS. + * - -h, --help + - + - false + - help for create + * - --iamRoleId + - string + - true + - Unique identifier that Atlas assigns to the cloud provider access role for the bucket. To learn more about setting up and retrieving a cloud provider access role, see: https://dochub.mongodb.org/core/set-up-unified-aws-access. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Export destination created using '<BucketName>'. + + +Examples +-------- + +.. code-block:: + + # The following command creates an export destination for Atlas backups using the existing AWS S3 bucket named test-bucket: + atlas backup export buckets create test-bucket --cloudProvider AWS --iamRoleId 12345678f901a234dbdb00ca diff --git a/source/command/atlas-backups-exports-buckets-delete.txt b/source/command/atlas-backups-exports-buckets-delete.txt new file mode 100644 index 00000000..62c06c52 --- /dev/null +++ b/source/command/atlas-backups-exports-buckets-delete.txt @@ -0,0 +1,92 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-buckets-delete: + +==================================== +atlas backups exports buckets delete +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a snapshot export bucket. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups exports buckets delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --bucketId + - string + - true + - Unique identifier that Atlas assigns to the bucket. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Snapshot export bucket with id '<Name>' deleted. + + +Examples +-------- + +.. code-block:: + + # The following deletes the continuous backup export bucket specified by ID: + atlas backup exports buckets delete --bucketId dbdb00ca12345678f901a234 diff --git a/source/command/atlas-backups-exports-buckets-describe.txt b/source/command/atlas-backups-exports-buckets-describe.txt new file mode 100644 index 00000000..02f4d4e7 --- /dev/null +++ b/source/command/atlas-backups-exports-buckets-describe.txt @@ -0,0 +1,93 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-buckets-describe: + +====================================== +atlas backups exports buckets describe +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return one snapshot export bucket. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups exports buckets describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --bucketId + - string + - true + - Unique identifier that Atlas assigns to the bucket. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID BUCKET NAME CLOUD PROVIDER IAM ROLE ID + <Id> <BucketName> <CloudProvider> <IamRoleId> + + +Examples +-------- + +.. code-block:: + + # Return the details for the continuous backup export bucket with the ID dbdb00ca12345678f901a234: + atlas backup exports buckets describe dbdb00ca12345678f901a234 diff --git a/source/command/atlas-backups-exports-buckets-list.txt b/source/command/atlas-backups-exports-buckets-list.txt new file mode 100644 index 00000000..43acfd1a --- /dev/null +++ b/source/command/atlas-backups-exports-buckets-list.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-buckets-list: + +================================== +atlas backups exports buckets list +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List cloud backup restore buckets for your project and cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups exports buckets list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID BUCKET NAME CLOUD PROVIDER IAM ROLE ID + <Id> <BucketName> <CloudProvider> <IamRoleId> + + +Examples +-------- + +.. code-block:: + + # Return all continuous backup export buckets for your project: + atlas backup exports buckets list diff --git a/source/command/atlas-backups-exports-buckets.txt b/source/command/atlas-backups-exports-buckets.txt new file mode 100644 index 00000000..41f28f63 --- /dev/null +++ b/source/command/atlas-backups-exports-buckets.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-buckets: + +============================= +atlas backups exports buckets +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup export buckets for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for buckets + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-exports-buckets-create` - Create an export destination for Atlas backups using an existing AWS S3 bucket. +* :ref:`atlas-backups-exports-buckets-delete` - Delete a snapshot export bucket. +* :ref:`atlas-backups-exports-buckets-describe` - Return one snapshot export bucket. +* :ref:`atlas-backups-exports-buckets-list` - List cloud backup restore buckets for your project and cluster. + + +.. toctree:: + :titlesonly: + + create </command/atlas-backups-exports-buckets-create> + delete </command/atlas-backups-exports-buckets-delete> + describe </command/atlas-backups-exports-buckets-describe> + list </command/atlas-backups-exports-buckets-list> + diff --git a/source/command/atlas-backups-exports-jobs-create.txt b/source/command/atlas-backups-exports-jobs-create.txt new file mode 100644 index 00000000..d74f5d95 --- /dev/null +++ b/source/command/atlas-backups-exports-jobs-create.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-jobs-create: + +================================= +atlas backups exports jobs create +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Export one backup snapshot for an M10 or higher Atlas cluster to an existing AWS S3 bucket. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups exports jobs create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --bucketId + - string + - true + - Unique identifier that Atlas assigns to the bucket. + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --customData + - key=value + - false + - Custom data to include in the metadata file named .complete that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - true + - Unique identifier of the snapshot. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Export job '<Id>' created in a bucket with ID '<ExportBucketId>'. + + +Examples +-------- + +.. code-block:: + + # The following command exports one backup snapshot of the ExampleCluster cluster to an existing AWS S3 bucket: + atlas backup export jobs create --clusterName ExampleCluster --bucketId 62c569f85b7a381c093cc539 --snapshotId 62c808ceeb4e021d850dfe1b --customData name=test,info=test diff --git a/source/command/atlas-backups-exports-jobs-describe.txt b/source/command/atlas-backups-exports-jobs-describe.txt new file mode 100644 index 00000000..a4548667 --- /dev/null +++ b/source/command/atlas-backups-exports-jobs-describe.txt @@ -0,0 +1,99 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-jobs-describe: + +=================================== +atlas backups exports jobs describe +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return one cloud backup export job for your project, cluster and job. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups exports jobs describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --exportId + - string + - false + - Unique string that identifies the AWS S3 bucket to which you export your snapshots. + + Mutually exclusive with --bucketId. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID EXPORT BUCKET ID STATE SNAPSHOT ID + <Id> <ExportBucketId> <State> <SnapshotId> + + +Examples +-------- + +.. code-block:: + + # Return the details for the continuous backup export job with the ID 5df90590f10fab5e33de2305 for the cluster named Cluster0: + atlas backup exports jobs describe --clusterName Cluster0 --exportID 5df90590f10fab5e33de2305 diff --git a/source/command/atlas-backups-exports-jobs-list.txt b/source/command/atlas-backups-exports-jobs-list.txt new file mode 100644 index 00000000..f3613b3b --- /dev/null +++ b/source/command/atlas-backups-exports-jobs-list.txt @@ -0,0 +1,117 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-jobs-list: + +=============================== +atlas backups exports jobs list +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all cloud backup export jobs for your project and cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups exports jobs list <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster for which you want to retrieve restore jobs. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID EXPORT BUCKET ID STATE SNAPSHOT ID + <Id> <ExportBucketId> <State> <SnapshotId> + + +Examples +-------- + +.. code-block:: + + # Return all continuous backup export jobs for the cluster named Cluster0: + atlas backup exports jobs list Cluster0 diff --git a/source/command/atlas-backups-exports-jobs-watch.txt b/source/command/atlas-backups-exports-jobs-watch.txt new file mode 100644 index 00000000..66c041bb --- /dev/null +++ b/source/command/atlas-backups-exports-jobs-watch.txt @@ -0,0 +1,113 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-jobs-watch: + +================================ +atlas backups exports jobs watch +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch for the specified export job to complete. + +This command checks the export job's status periodically until it reaches a completed, cancelled or failed status. +Once the export reaches the expected status, the command prints "Export completed." +If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. +You can interrupt the command's polling at any time with CTRL-C. +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups exports jobs watch <exportJobId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - exportJobId + - string + - true + - Unique string that identifies the export job. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Export completed. + + +Examples +-------- + +.. code-block:: + + # Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the cluster named Cluster0 until it becomes available: + atlas backup restore watch 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/source/command/atlas-backups-exports-jobs.txt b/source/command/atlas-backups-exports-jobs.txt new file mode 100644 index 00000000..29b7b985 --- /dev/null +++ b/source/command/atlas-backups-exports-jobs.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports-jobs: + +========================== +atlas backups exports jobs +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup export jobs for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for jobs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-exports-jobs-create` - Export one backup snapshot for an M10 or higher Atlas cluster to an existing AWS S3 bucket. +* :ref:`atlas-backups-exports-jobs-describe` - Return one cloud backup export job for your project, cluster and job. +* :ref:`atlas-backups-exports-jobs-list` - Return all cloud backup export jobs for your project and cluster. +* :ref:`atlas-backups-exports-jobs-watch` - Watch for the specified export job to complete. + + +.. toctree:: + :titlesonly: + + create </command/atlas-backups-exports-jobs-create> + describe </command/atlas-backups-exports-jobs-describe> + list </command/atlas-backups-exports-jobs-list> + watch </command/atlas-backups-exports-jobs-watch> + diff --git a/source/command/atlas-backups-exports.txt b/source/command/atlas-backups-exports.txt new file mode 100644 index 00000000..80d38f11 --- /dev/null +++ b/source/command/atlas-backups-exports.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-exports: + +===================== +atlas backups exports +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup export jobs for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for exports + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-exports-buckets` - Manage cloud backup export buckets for your project. +* :ref:`atlas-backups-exports-jobs` - Manage cloud backup export jobs for your project. + + +.. toctree:: + :titlesonly: + + buckets </command/atlas-backups-exports-buckets> + jobs </command/atlas-backups-exports-jobs> + diff --git a/source/command/atlas-backups-restores-describe.txt b/source/command/atlas-backups-restores-describe.txt new file mode 100644 index 00000000..837c37e6 --- /dev/null +++ b/source/command/atlas-backups-restores-describe.txt @@ -0,0 +1,98 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-restores-describe: + +=============================== +atlas backups restores describe +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a cloud backup restore job. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups restores describe <restoreJobId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - restoreJobId + - string + - true + - ID of the restore job. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the details for the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the cluster named Cluster0: + atlas backup restore describe 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/source/command/atlas-backups-restores-list.txt b/source/command/atlas-backups-restores-list.txt new file mode 100644 index 00000000..5e625e6c --- /dev/null +++ b/source/command/atlas-backups-restores-list.txt @@ -0,0 +1,117 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-restores-list: + +=========================== +atlas backups restores list +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all cloud backup restore jobs for your project and cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups restores list <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster for which you want to retrieve restore jobs. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID SNAPSHOT CLUSTER TYPE EXPIRES AT + <Id> <SnapshotId> <TargetClusterName> <DeliveryType> <ExpiresAt> + + +Examples +-------- + +.. code-block:: + + # Return all continuous backup restore jobs for the cluster Cluster0: + atlas backup restore list Cluster0 diff --git a/source/command/atlas-backups-restores-start.txt b/source/command/atlas-backups-restores-start.txt new file mode 100644 index 00000000..0078b171 --- /dev/null +++ b/source/command/atlas-backups-restores-start.txt @@ -0,0 +1,157 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-restores-start: + +============================ +atlas backups restores start +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start a restore job for your project and cluster. + +If you create an automated or pointInTime restore job, Atlas removes all existing data on the target cluster prior to the restore. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups restores start <automated|download|pointInTime> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - automated|download|pointInTime + - string + - true + - Type of restore job to create. Valid values include: automated, download, pointInTime. To learn more about types of restore jobs, see https://www.mongodb.com/docs/atlas/backup-restore-cluster/. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for start + * - --oplogInc + - int + - false + - 32-bit incrementing ordinal that represents operations within a given second. When paired with oplogTs, they represent the point in time to which your data will be restored. + * - --oplogTs + - int + - false + - Oplog timestamp given as a timestamp in the number of seconds that have elapsed since the UNIX Epoch. When paired with oplogInc, they represent the point in time to which your data will be restored. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --pointInTimeUTCSeconds + - int + - false + - Timestamp in the number of seconds that have elapsed since the UNIX epoch that represents the point in time to which your data will be restored. This timestamp must be within the last 24 hours of the current time. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - false + - Unique identifier of the snapshot to restore. You must specify a snapshotId for automated restores. + * - --targetClusterName + - string + - false + - Name of the target cluster. For use only with automated restore jobs. You must specify a targetClusterName for automated restores. + * - --targetProjectId + - string + - false + - Unique identifier of the project that contains the destination cluster for the restore job. You must specify a targetProjectId for automated restores. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Restore job '<Id>' successfully started + + +Examples +-------- + +.. code-block:: + + # Create an automated restore: + atlas backup restore start automated \ + --clusterName myDemo \ + --snapshotId 5e7e00128f8ce03996a47179 \ + --targetClusterName myDemo2 \ + --targetProjectId 1a2345b67c8e9a12f3456de7 + + +.. code-block:: + + # Create a point-in-time restore: + atlas backup restore start pointInTime \ + --clusterName myDemo \ + --pointInTimeUTCSeconds 1588523147 \ + --targetClusterName myDemo2 \ + --targetProjectId 1a2345b67c8e9a12f3456de7 + + +.. code-block:: + + # Create a download restore: + atlas backup restore start download \ + --clusterName myDemo \ + --snapshotId 5e7e00128f8ce03996a47179 diff --git a/source/command/atlas-backups-restores-watch.txt b/source/command/atlas-backups-restores-watch.txt new file mode 100644 index 00000000..5930d1ab --- /dev/null +++ b/source/command/atlas-backups-restores-watch.txt @@ -0,0 +1,112 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-restores-watch: + +============================ +atlas backups restores watch +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch for a restore job to complete. + +This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. +Once the restore reaches the expected status, the command prints "Restore completed." +If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. +You can interrupt the command's polling at any time with CTRL-C. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups restores watch <restoreJobId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - restoreJobId + - string + - true + - ID of the restore job. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Restore completed. + + +Examples +-------- + +.. code-block:: + + # Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the restore source cluster named Cluster0 until it becomes available: + atlas backup restore watch 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/source/command/atlas-backups-restores.txt b/source/command/atlas-backups-restores.txt new file mode 100644 index 00000000..132c7175 --- /dev/null +++ b/source/command/atlas-backups-restores.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-restores: + +====================== +atlas backups restores +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup restore jobs for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for restores + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-restores-describe` - Describe a cloud backup restore job. +* :ref:`atlas-backups-restores-list` - Return all cloud backup restore jobs for your project and cluster. +* :ref:`atlas-backups-restores-start` - Start a restore job for your project and cluster. +* :ref:`atlas-backups-restores-watch` - Watch for a restore job to complete. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-backups-restores-describe> + list </command/atlas-backups-restores-list> + start </command/atlas-backups-restores-start> + watch </command/atlas-backups-restores-watch> + diff --git a/source/command/atlas-backups-schedule-delete.txt b/source/command/atlas-backups-schedule-delete.txt new file mode 100644 index 00000000..e10e85db --- /dev/null +++ b/source/command/atlas-backups-schedule-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-schedule-delete: + +============================= +atlas backups schedule delete +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete all backup schedules of a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups schedule delete <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Backup schedules of the cluster with name '<Name>' deleted. + + +Examples +-------- + +.. code-block:: + + # Remove all backup schedules for the cluster named Cluster0: + atlas backup schedule delete Cluster0 diff --git a/source/command/atlas-backups-schedule-describe.txt b/source/command/atlas-backups-schedule-describe.txt new file mode 100644 index 00000000..0c9e7351 --- /dev/null +++ b/source/command/atlas-backups-schedule-describe.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-schedule-describe: + +=============================== +atlas backups schedule describe +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a cloud backup schedule for the cluster you specify. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups schedule describe <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Human-readable label for the cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the cloud backup schedule for the cluster named Cluster0: + atlas backup schedule describe Cluster0 diff --git a/source/command/atlas-backups-schedule-update.txt b/source/command/atlas-backups-schedule-update.txt new file mode 100644 index 00000000..babdb4f3 --- /dev/null +++ b/source/command/atlas-backups-schedule-update.txt @@ -0,0 +1,178 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-schedule-update: + +============================= +atlas backups schedule update +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the backup schedule for the specified cluster for your project. + +The backup schedule defines when MongoDB takes scheduled snapshots and how long it stores those snapshots. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups schedule update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --autoExport + - + - false + - Flag that enables automatic export of cloud backup snapshots to the AWS bucket. + + Mutually exclusive with --noAutoExport, --file. + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --exportBucketId + - string + - false + - Unique identifier that Atlas assigns to the bucket. + + Mutually exclusive with --file. + * - --exportFrequencyType + - string + - false + - Frequency associated with the export policy. Value can be daily, weekly, or monthly. + + Mutually exclusive with --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines backup schedule settings. To learn about the cloud backup configuration file for the Atlas CLI, see https://dochub.mongodb.org/core/cloud-backup-config-file. + + Mutually exclusive with --exportBucketId, --exportFrequencyType, --referenceHourOfDay, --referenceMinuteOfHour, --restoreWindowDays, --autoExport, --noAutoExport, --updateSnapshots, --noUpdateSnapshots, --useOrgAndGroupNamesInExportPrefix, --noUseOrgAndGroupNamesInExportPrefix, --policy. + * - -h, --help + - + - false + - help for update + * - --noAutoExport + - + - false + - Flag that disables automatic export of cloud backup snapshots to the AWS bucket. + + Mutually exclusive with --autoExport, --file. + * - --noUpdateSnapshots + - + - false + - Flag that disables applying the retention changes in the updated backup policy to snapshots that Atlas took previously. + + Mutually exclusive with --updateSnapshots, --file. + * - --noUseOrgAndGroupNamesInExportPrefix + - + - false + - Flag that disables usage of organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots. + + Mutually exclusive with --useOrgAndGroupNamesInExportPrefix, --file. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --policy + - stringArray + - false + - Array containing a document for each backup policy item in the desired updated backup policy. You must specify it in a format: '--policy policyID,policyItemID,frequencyType,frequencyIntervalNumber,retentionUnit,retentionValue'. + + Mutually exclusive with --file. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --referenceHourOfDay + - int + - false + - Hour of the day to schedule snapshots using a 24-hour clock. Accepted values are between 0 and 23 inclusive. + + Mutually exclusive with --file. + * - --referenceMinuteOfHour + - int + - false + - Minute of the hour to schedule snapshots. Accepted values are between 0 and 59 inclusive. + + Mutually exclusive with --file. + * - --restoreWindowDays + - int + - false + - Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer. Applies to continuous cloud backups only. + + Mutually exclusive with --file. + * - --updateSnapshots + - + - false + - Flag that enables applying the retention changes in the updated backup policy to snapshots that Atlas took previously. + + Mutually exclusive with --noUpdateSnapshots, --file. + * - --useOrgAndGroupNamesInExportPrefix + - + - false + - Flag that enables usage of organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots. + + Mutually exclusive with --noUseOrgAndGroupNamesInExportPrefix, --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Snapshot backup policy for cluster '<ClusterName>' updated. + + +Examples +-------- + +.. code-block:: + + # Update a snapshot backup policy for a cluster named Cluster0 to back up snapshots every 6 hours and, retain for 7 days, and update retention of previously-taken snapshots: + atlas backup schedule update --clusterName Cluster0 --updateSnapshots --policy 62da8faac84a2721e448d767,62da8faac84a2721e448d768,hourly,6,days,7 + + +.. code-block:: + + # Update a snapshot backup policy for a cluster named Cluster0 to export snapshots monthly to an S3 bucket: + atlas backup schedule update --clusterName Cluster0 --exportBucketId 62c569f85b7a381c093cc539 --exportFrequencyType monthly diff --git a/source/command/atlas-backups-schedule.txt b/source/command/atlas-backups-schedule.txt new file mode 100644 index 00000000..769165a4 --- /dev/null +++ b/source/command/atlas-backups-schedule.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-schedule: + +====================== +atlas backups schedule +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a cloud backup schedule for the cluster you specify. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for schedule + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-schedule-delete` - Delete all backup schedules of a cluster. +* :ref:`atlas-backups-schedule-describe` - Describe a cloud backup schedule for the cluster you specify. +* :ref:`atlas-backups-schedule-update` - Modify the backup schedule for the specified cluster for your project. + + +.. toctree:: + :titlesonly: + + delete </command/atlas-backups-schedule-delete> + describe </command/atlas-backups-schedule-describe> + update </command/atlas-backups-schedule-update> + diff --git a/source/command/atlas-backups-snapshots-create.txt b/source/command/atlas-backups-snapshots-create.txt new file mode 100644 index 00000000..61b0bb5f --- /dev/null +++ b/source/command/atlas-backups-snapshots-create.txt @@ -0,0 +1,115 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-snapshots-create: + +============================== +atlas backups snapshots create +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a backup snapshot for your project and cluster. + +You can create on-demand backup snapshots for Atlas cluster tiers M10 and larger. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups snapshots create <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster whose snapshot you want to restore. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --desc + - string + - true + - Description of the on-demand snapshot. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --retention + - int + - false + - Number of days that Atlas should retain the on-demand snapshot. Must be at least 1. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Snapshot '<Id>' created. + + +Examples +-------- + +.. code-block:: + + # Create a backup snapshot for the cluster named myDemo that Atlas retains for 30 days: + atlas backups snapshots create myDemo --desc "test" --retention 30 diff --git a/source/command/atlas-backups-snapshots-delete.txt b/source/command/atlas-backups-snapshots-delete.txt new file mode 100644 index 00000000..925bbcd3 --- /dev/null +++ b/source/command/atlas-backups-snapshots-delete.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-snapshots-delete: + +============================== +atlas backups snapshots delete +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified backup snapshot. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups snapshots delete <snapshotId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - snapshotId + - string + - true + - Unique identifier of the snapshot you want to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Snapshot '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 for the cluster named myDemo: + atlas backups snapshots delete 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/source/command/atlas-backups-snapshots-describe.txt b/source/command/atlas-backups-snapshots-describe.txt new file mode 100644 index 00000000..22e1d19a --- /dev/null +++ b/source/command/atlas-backups-snapshots-describe.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-snapshots-describe: + +================================ +atlas backups snapshots describe +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified snapshot for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups snapshots describe <snapshotId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - snapshotId + - string + - true + - Unique identifier of the snapshot you want to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID SNAPSHOT TYPE TYPE DESCRIPTION EXPIRES AT + <Id> <SnapshotType> <Type> <Description> <ExpiresAt> + + +Examples +-------- + +.. code-block:: + + # Return the details for the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 for the cluster named myDemo: + atlas backups snapshots describe 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/source/command/atlas-backups-snapshots-list.txt b/source/command/atlas-backups-snapshots-list.txt new file mode 100644 index 00000000..970d715b --- /dev/null +++ b/source/command/atlas-backups-snapshots-list.txt @@ -0,0 +1,117 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-snapshots-list: + +============================ +atlas backups snapshots list +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all cloud backup snapshots for your project and cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups snapshots list <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster that contains the snapshots you want to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID TYPE STATUS CREATED AT EXPIRES AT + <Id> <SnapshotType> <Status> <CreatedAt> <ExpiresAt> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of snapshots for the cluster named myDemo + atlas backups snapshots list myDemo --output json diff --git a/source/command/atlas-backups-snapshots-watch.txt b/source/command/atlas-backups-snapshots-watch.txt new file mode 100644 index 00000000..2350c697 --- /dev/null +++ b/source/command/atlas-backups-snapshots-watch.txt @@ -0,0 +1,110 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-snapshots-watch: + +============================= +atlas backups snapshots watch +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified snapshot in your project until it becomes available. + +This command checks the snapshot's status periodically until it reaches a completed or failed status. +Once the snapshot reaches the expected status, the command prints "Snapshot changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups snapshots watch <snapshotId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - snapshotId + - string + - true + - Unique identifier of the snapshot you want to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Snapshot changes completed. + + +Examples +-------- + +.. code-block:: + + # Watch the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 in the cluster named myDemo until it becomes available: + atlas backups snapshots watch 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/source/command/atlas-backups-snapshots.txt b/source/command/atlas-backups-snapshots.txt new file mode 100644 index 00000000..2b939d00 --- /dev/null +++ b/source/command/atlas-backups-snapshots.txt @@ -0,0 +1,70 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups-snapshots: + +======================= +atlas backups snapshots +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup snapshots for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for snapshots + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-snapshots-create` - Create a backup snapshot for your project and cluster. +* :ref:`atlas-backups-snapshots-delete` - Remove the specified backup snapshot. +* :ref:`atlas-backups-snapshots-describe` - Return the details for the specified snapshot for your project. +* :ref:`atlas-backups-snapshots-list` - Return all cloud backup snapshots for your project and cluster. +* :ref:`atlas-backups-snapshots-watch` - Watch the specified snapshot in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + create </command/atlas-backups-snapshots-create> + delete </command/atlas-backups-snapshots-delete> + describe </command/atlas-backups-snapshots-describe> + list </command/atlas-backups-snapshots-list> + watch </command/atlas-backups-snapshots-watch> + diff --git a/source/command/atlas-backups.txt b/source/command/atlas-backups.txt new file mode 100644 index 00000000..4bb2ade6 --- /dev/null +++ b/source/command/atlas-backups.txt @@ -0,0 +1,70 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-backups: + +============= +atlas backups +============= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backups for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for backups + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-backups-compliancePolicy` - Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. +* :ref:`atlas-backups-exports` - Manage cloud backup export jobs for your project. +* :ref:`atlas-backups-restores` - Manage cloud backup restore jobs for your project. +* :ref:`atlas-backups-schedule` - Return a cloud backup schedule for the cluster you specify. +* :ref:`atlas-backups-snapshots` - Manage cloud backup snapshots for your project. + + +.. toctree:: + :titlesonly: + + compliancePolicy </command/atlas-backups-compliancePolicy> + exports </command/atlas-backups-exports> + restores </command/atlas-backups-restores> + schedule </command/atlas-backups-schedule> + snapshots </command/atlas-backups-snapshots> + diff --git a/source/command/atlas-cloudProviders-accessRoles-aws-authorize.txt b/source/command/atlas-cloudProviders-accessRoles-aws-authorize.txt new file mode 100644 index 00000000..36bc01cd --- /dev/null +++ b/source/command/atlas-cloudProviders-accessRoles-aws-authorize.txt @@ -0,0 +1,99 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cloudProviders-accessRoles-aws-authorize: + +============================================== +atlas cloudProviders accessRoles aws authorize +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Authorize an AWS IAM role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas cloudProviders accessRoles aws authorize <roleId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleId + - string + - true + - Unique ID of the role to authorize. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for authorize + * - --iamAssumedRoleArn + - string + - false + - Role ARN that Atlas assumes to access your AWS account. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + AWS IAM role '<RoleId> successfully authorized. + + diff --git a/source/command/atlas-cloudProviders-accessRoles-aws-create.txt b/source/command/atlas-cloudProviders-accessRoles-aws-create.txt new file mode 100644 index 00000000..5ca25a27 --- /dev/null +++ b/source/command/atlas-cloudProviders-accessRoles-aws-create.txt @@ -0,0 +1,83 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cloudProviders-accessRoles-aws-create: + +=========================================== +atlas cloudProviders accessRoles aws create +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an AWS IAM role. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas cloudProviders accessRoles aws create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + AWS IAM role '<RoleId>' successfully created. + Atlas AWS Account ARN: <AtlasAWSAccountArn> + Unique External ID: <AtlasAssumedRoleExternalId> + + diff --git a/source/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt b/source/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt new file mode 100644 index 00000000..46248b03 --- /dev/null +++ b/source/command/atlas-cloudProviders-accessRoles-aws-deauthorize.txt @@ -0,0 +1,97 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cloudProviders-accessRoles-aws-deauthorize: + +================================================ +atlas cloudProviders accessRoles aws deauthorize +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Deauthorize an AWS IAM role. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas cloudProviders accessRoles aws deauthorize <roleId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleId + - string + - true + - Unique ID of the role to authorize. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for deauthorize + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + AWS IAM role successfully deauthorized. + + diff --git a/source/command/atlas-cloudProviders-accessRoles-aws.txt b/source/command/atlas-cloudProviders-accessRoles-aws.txt new file mode 100644 index 00000000..b7e25cf2 --- /dev/null +++ b/source/command/atlas-cloudProviders-accessRoles-aws.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cloudProviders-accessRoles-aws: + +==================================== +atlas cloudProviders accessRoles aws +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage AWS IAM role access in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for aws + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-cloudProviders-accessRoles-aws-authorize` - Authorize an AWS IAM role. +* :ref:`atlas-cloudProviders-accessRoles-aws-create` - Create an AWS IAM role. +* :ref:`atlas-cloudProviders-accessRoles-aws-deauthorize` - Deauthorize an AWS IAM role. + + +.. toctree:: + :titlesonly: + + authorize </command/atlas-cloudProviders-accessRoles-aws-authorize> + create </command/atlas-cloudProviders-accessRoles-aws-create> + deauthorize </command/atlas-cloudProviders-accessRoles-aws-deauthorize> + diff --git a/source/command/atlas-cloudProviders-accessRoles-list.txt b/source/command/atlas-cloudProviders-accessRoles-list.txt new file mode 100644 index 00000000..a39bceb4 --- /dev/null +++ b/source/command/atlas-cloudProviders-accessRoles-list.txt @@ -0,0 +1,71 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cloudProviders-accessRoles-list: + +===================================== +atlas cloudProviders accessRoles list +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List AWS IAM role access in Atlas. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas cloudProviders accessRoles list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-cloudProviders-accessRoles.txt b/source/command/atlas-cloudProviders-accessRoles.txt new file mode 100644 index 00000000..30559112 --- /dev/null +++ b/source/command/atlas-cloudProviders-accessRoles.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cloudProviders-accessRoles: + +================================ +atlas cloudProviders accessRoles +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage AWS IAM role access in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for accessRoles + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-cloudProviders-accessRoles-aws` - Manage AWS IAM role access in Atlas. +* :ref:`atlas-cloudProviders-accessRoles-list` - List AWS IAM role access in Atlas. + + +.. toctree:: + :titlesonly: + + aws </command/atlas-cloudProviders-accessRoles-aws> + list </command/atlas-cloudProviders-accessRoles-list> + diff --git a/source/command/atlas-cloudProviders.txt b/source/command/atlas-cloudProviders.txt new file mode 100644 index 00000000..6fcd247f --- /dev/null +++ b/source/command/atlas-cloudProviders.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cloudProviders: + +==================== +atlas cloudProviders +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud provider access in Atlas using AWS IAM roles. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for cloudProviders + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-cloudProviders-accessRoles` - Manage AWS IAM role access in Atlas. + + +.. toctree:: + :titlesonly: + + accessRoles </command/atlas-cloudProviders-accessRoles> + diff --git a/source/command/atlas-clusters-advancedSettings-describe.txt b/source/command/atlas-clusters-advancedSettings-describe.txt new file mode 100644 index 00000000..8223782b --- /dev/null +++ b/source/command/atlas-clusters-advancedSettings-describe.txt @@ -0,0 +1,93 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-advancedSettings-describe: + +======================================== +atlas clusters advancedSettings describe +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Retrieve advanced configuration settings for one cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters advancedSettings describe <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster for which you want to retrieve configuration settings. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + atlas clusters advancedSettings describe Cluster0 diff --git a/source/command/atlas-clusters-advancedSettings-update.txt b/source/command/atlas-clusters-advancedSettings-update.txt new file mode 100644 index 00000000..c2ec6884 --- /dev/null +++ b/source/command/atlas-clusters-advancedSettings-update.txt @@ -0,0 +1,176 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-advancedSettings-update: + +====================================== +atlas clusters advancedSettings update +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update advanced configuration settings for one cluster. + +Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. +Atlas supports this command only for M10+ clusters. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters advancedSettings update <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableFailIndexKeyTooLong + - + - false + - Flag that disables writing documents that exceed 1024 bytes without indexing. + + Mutually exclusive with --enableFailIndexKeyTooLong. + * - --disableJavascript + - + - false + - Flag that disables the execution of operations that perform server-side executions of JavaScript. + + Mutually exclusive with --enableJavascript. + * - --disableTableScan + - + - false + - Flag that disables executing any query that requires a collection scan to return results. + + Mutually exclusive with --enableTableScan. + * - --enableFailIndexKeyTooLong + - + - false + - Flag that enables writing documents that exceed 1024 bytes without indexing. + + Mutually exclusive with --disableFailIndexKeyTooLong. + * - --enableJavascript + - + - false + - Flag that enables the execution of operations that perform server-side executions of JavaScript. + + Mutually exclusive with --disableJavascript. + * - --enableTableScan + - + - false + - Flag that enables executing any query that requires a collection scan to return results. + + Mutually exclusive with --disableTableScan. + * - -h, --help + - + - false + - help for update + * - --oplogMinRetentionHours + - float + - false + - Minimum retention window for cluster's oplog expressed in hours. + * - --oplogSizeMB + - int + - false + - Storage limit of cluster's oplog expressed in megabytes. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --readConcern + - string + - false + - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. + * - --sampleRefreshIntervalBIConnector + - int + - false + - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. This value defaults to -1. + * - --sampleSizeBIConnector + - int + - false + - Number of documents per database to sample when gathering schema information. This value defaults to -1. + * - --tlsProtocol + - string + - false + - Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. + * - --writeConcern + - string + - false + - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Updating advanced configuration settings of your cluster'. + + +Examples +-------- + +.. code-block:: + + # Update the minimum oplog size for a cluster: + atlas cluster advancedSettings update <clusterName> --projectId <projectId> --oplogSizeMB 1000 + + +.. code-block:: + + # Update the minimum TLS protocol version for a cluster: + atlas cluster advancedSettings update <clusterName> --projectId <projectId> --minimumEnabledTLSProtocol "TLS1_2" diff --git a/source/command/atlas-clusters-advancedSettings.txt b/source/command/atlas-clusters-advancedSettings.txt new file mode 100644 index 00000000..e156ba87 --- /dev/null +++ b/source/command/atlas-clusters-advancedSettings.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-advancedSettings: + +=============================== +atlas clusters advancedSettings +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage advanced configuration settings for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for advancedSettings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-advancedSettings-describe` - Retrieve advanced configuration settings for one cluster. +* :ref:`atlas-clusters-advancedSettings-update` - Update advanced configuration settings for one cluster. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-clusters-advancedSettings-describe> + update </command/atlas-clusters-advancedSettings-update> + diff --git a/source/command/atlas-clusters-availableRegions-list.txt b/source/command/atlas-clusters-availableRegions-list.txt new file mode 100644 index 00000000..bee97d76 --- /dev/null +++ b/source/command/atlas-clusters-availableRegions-list.txt @@ -0,0 +1,90 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-availableRegions-list: + +==================================== +atlas clusters availableRegions list +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List available regions that Atlas supports for new deployments. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters availableRegions list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # List available regions for a given cloud provider and tier: + atlas cluster availableRegions list --provider AWS --tier M50 + + +.. code-block:: + + # List available regions by tier for a given provider: + atlas cluster availableRegions list --provider GCP diff --git a/source/command/atlas-clusters-availableRegions.txt b/source/command/atlas-clusters-availableRegions.txt new file mode 100644 index 00000000..8e714bd0 --- /dev/null +++ b/source/command/atlas-clusters-availableRegions.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-availableRegions: + +=============================== +atlas clusters availableRegions +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage available regions for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for availableRegions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-availableRegions-list` - List available regions that Atlas supports for new deployments. + + +.. toctree:: + :titlesonly: + + list </command/atlas-clusters-availableRegions-list> + diff --git a/source/command/atlas-clusters-connectionStrings-describe.txt b/source/command/atlas-clusters-connectionStrings-describe.txt new file mode 100644 index 00000000..cf96538f --- /dev/null +++ b/source/command/atlas-clusters-connectionStrings-describe.txt @@ -0,0 +1,98 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-connectionStrings-describe: + +========================================= +atlas clusters connectionStrings describe +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the SRV connection string for the cluster you specify. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters connectionStrings describe <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the Atlas cluster for which you want to retrieve connection strings. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of connection string. If you specify 'private', this option retrieves the connection string for the network peering endpoint. If you specify 'privateEndpoint', this option retrieves the shard optimized connection strings for the private endpoints. This value defaults to "standard". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted connection strings for the cluster named myCluster: + atlas clusters connectionStrings describe myCluster --output json diff --git a/source/command/atlas-clusters-connectionStrings.txt b/source/command/atlas-clusters-connectionStrings.txt new file mode 100644 index 00000000..86fbb4b2 --- /dev/null +++ b/source/command/atlas-clusters-connectionStrings.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-connectionStrings: + +================================ +atlas clusters connectionStrings +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage MongoDB cluster connection string. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for connectionStrings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-connectionStrings-describe` - Return the SRV connection string for the cluster you specify. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-clusters-connectionStrings-describe> + diff --git a/source/command/atlas-clusters-create.txt b/source/command/atlas-clusters-create.txt new file mode 100644 index 00000000..cf9b29be --- /dev/null +++ b/source/command/atlas-clusters-create.txt @@ -0,0 +1,219 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-create: + +===================== +atlas clusters create +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a cluster for your project. + +To get started quickly, specify a name for your cluster, a cloud provider, and a region to deploy a three-member replica set with the latest MongoDB server version. +For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters create [name] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - false + - Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphens. You must specify the cluster name argument if you don't use the --file option. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --backup + - + - false + - Flag that enables Continuous Cloud Backup for your deployment. This option is unavailable for clusters smaller than M10. + * - --biConnector + - + - false + - Flag that enables BI Connector for Atlas on the deployment. + + Mutually exclusive with --file. + * - --diskSizeGB + - float + - false + - Capacity, in gigabytes, of the host's root volume. + + Mutually exclusive with --file. This value defaults to 2. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli. + + Mutually exclusive with --tier, --provider, --members, --region, --diskSizeGB, --mdbVersion, --biConnector, --type, --shards, --tag. + * - -h, --help + - + - false + - help for create + * - --mdbVersion + - string + - false + - Major MongoDB version of the cluster. + + Mutually exclusive with --file. This value defaults to "7.0". + * - -m, --members + - int + - false + - Number of members in the replica set. + + Mutually exclusive with --file. This value defaults to 3. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. You must specify the provider option if you don't use the --file option. + + Mutually exclusive with --file. + * - -r, --region + - string + - false + - Physical location of your MongoDB cluster. You must specify the region option if you don't use the --file option. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + + Mutually exclusive with --file. + * - -s, --shards + - int + - false + - Number of shards in the cluster. + + Mutually exclusive with --file. This value defaults to 1. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. + + Mutually exclusive with --file. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + + Mutually exclusive with --file. This value defaults to "M2". + * - --type + - string + - false + - Type of the cluster that you want to create. Valid values are REPLICASET or SHARDED. + + Mutually exclusive with --file. This value defaults to "REPLICASET". + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. + * - --watchTimeout + - uint + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Cluster '<Name>' is being created. + + +Examples +-------- + +.. code-block:: + + # Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 + + +.. code-block:: + + # Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3 and tag "env=dev": + atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 --tag env=dev + + +.. code-block:: + + # Deploy a three-member replica set named myRS in AWS for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 + + +.. code-block:: + + # Deploy a three-member replica set named myRS in AZURE for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 + + +.. code-block:: + + # Deploy a three-member replica set named myRS in GCP for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10 + + +.. code-block:: + + # Deploy a cluster or a multi-cloud cluster from a JSON configuration file named myfile.json for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster create --projectId <projectId> --file myfile.json diff --git a/source/command/atlas-clusters-delete.txt b/source/command/atlas-clusters-delete.txt new file mode 100644 index 00000000..84dc3379 --- /dev/null +++ b/source/command/atlas-clusters-delete.txt @@ -0,0 +1,121 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-delete: + +===================== +atlas clusters delete +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified cluster from your project. + +The command prompts you to confirm the operation when you run the command without the --force option. + +Deleting a cluster also deletes any backup snapshots for that cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters delete <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. + * - --watchTimeout + - uint + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Deleting cluster '<Name>' + +Examples +-------- + +.. code-block:: + + # Remove a cluster named myCluster after prompting for a confirmation: + atlas clusters delete myCluster + + +.. code-block:: + + # Remove a cluster named myCluster without requiring confirmation: + atlas clusters delete myCluster --force diff --git a/source/command/atlas-clusters-describe.txt b/source/command/atlas-clusters-describe.txt new file mode 100644 index 00000000..1e2f13fe --- /dev/null +++ b/source/command/atlas-clusters-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-describe: + +======================= +atlas clusters describe +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified cluster for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters describe <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME MDB VER STATE + <Id> <Name> <MongoDBVersion> <StateName> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the cluster named myCluster: + atlas clusters describe myCluster --output json diff --git a/source/command/atlas-clusters-failover.txt b/source/command/atlas-clusters-failover.txt new file mode 100644 index 00000000..d99aa53d --- /dev/null +++ b/source/command/atlas-clusters-failover.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-failover: + +======================= +atlas clusters failover +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Starts a failover test for the specified cluster in the specified project. + +Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters failover <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Human-readable label that identifies the cluster to start a failover test for. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for failover + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Failover test for '<Name>' started + + +Examples +-------- + +.. code-block:: + + # Test failover for a cluster named myCluster: + atlas clusters failover myCluster diff --git a/source/command/atlas-clusters-indexes-create.txt b/source/command/atlas-clusters-indexes-create.txt new file mode 100644 index 00000000..6aa3c6f2 --- /dev/null +++ b/source/command/atlas-clusters-indexes-create.txt @@ -0,0 +1,135 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-indexes-create: + +============================= +atlas clusters indexes create +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a rolling index for the specified cluster for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters indexes create [indexName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexName + - string + - false + - Name of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --collection + - string + - false + - Name of the collection. + + Mutually exclusive with --file. + * - --db + - string + - false + - Name of the database. + + Mutually exclusive with --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines index settings. + + Mutually exclusive with --db, --collection, --key. + * - -h, --help + - + - false + - help for create + * - --key + - strings + - false + - Field to be indexed and the type of index in the following format: field:type. + + Mutually exclusive with --file. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sparse + - + - false + - Flag that creates a sparse index. To learn more, see https://dochub.mongodb.org/core/index-sparse-manual. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Create an index named bedrooms_1 on the listings collection of the realestate database: + atlas clusters indexes create bedrooms_1 --clusterName Cluster0 --collection listings --db realestate --key bedrooms:1 + + +.. code-block:: + + # Create a compound index named property_room_bedrooms on the + listings collection of the realestate database: + atlas clusters indexes create property_room_bedrooms --clusterName Cluster0 --collection listings --db realestate --key property_type:1 --key room_type:1 --key bedrooms:1 + + +.. code-block:: + + # Create an index named my_index from a JSON configuration file named myfile.json: + atlas clusters indexes create my_index --clusterName Cluster0 --file file.json diff --git a/source/command/atlas-clusters-indexes.txt b/source/command/atlas-clusters-indexes.txt new file mode 100644 index 00000000..676c8381 --- /dev/null +++ b/source/command/atlas-clusters-indexes.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-indexes: + +====================== +atlas clusters indexes +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cluster rolling indexes for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for indexes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-indexes-create` - Create a rolling index for the specified cluster for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-clusters-indexes-create> + diff --git a/source/command/atlas-clusters-list.txt b/source/command/atlas-clusters-list.txt new file mode 100644 index 00000000..a1ef9418 --- /dev/null +++ b/source/command/atlas-clusters-list.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-list: + +=================== +atlas clusters list +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all clusters for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME MDB VER STATE + <Id> <Name> <MongoDBVersion> <StateName> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3: + atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-clusters-onlineArchives-create.txt b/source/command/atlas-clusters-onlineArchives-create.txt new file mode 100644 index 00000000..edf8ec4d --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives-create.txt @@ -0,0 +1,140 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives-create: + +==================================== +atlas clusters onlineArchives create +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an online archive for a collection in the specified cluster. + +You can create an online archive for an M10 or larger cluster. + +To learn more about online archives, see https://www.mongodb.com/docs/atlas/online-archive/manage-online-archive/. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --archiveAfter + - int + - false + - Number of days after which to archive cluster data. + + Mutually exclusive with --file. + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --collection + - string + - false + - Name of the collection. + + Mutually exclusive with --file. + * - --dateField + - string + - false + - Name of an already indexed date field from the documents. + + Mutually exclusive with --file. + * - --dateFormat + - string + - false + - Date format for the date field. Valid values are "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", or "EPOCH_NANOSECONDS". + + Mutually exclusive with --file. This value defaults to "ISODATE". + * - --db + - string + - false + - Name of the database. + + Mutually exclusive with --file. + * - --expireAfterDays + - int + - false + - Number of days used in the date criteria for nominating documents for deletion. + + Mutually exclusive with --file. + * - --file + - string + - false + - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config. + + Mutually exclusive with --db, --collection, --dateField, --dateFormat, --archiveAfter, --expireAfterDays, --partition. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --partition + - strings + - false + - Fields to use to partition data. You can specify up to two frequently queried fields separated by a comma. + + Mutually exclusive with --file. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster when the current date is greater than the value of released date plus 2 days: + atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --output json + + +.. code-block:: + + # Create an online archive for the sample_mflix.movies collection in a cluster named myTestCluster using a profile named egAtlasProfile when the current date is greater than the value of the released date plus 2 days. Data is partitioned based on the title field, year field, and released field from the documents in the collection: + atlas clusters onlineArchive create --clusterName myTestCluster --db sample_mflix --collection movies --dateField released --archiveAfter 2 --partition title,year --output json -P egAtlasProfile diff --git a/source/command/atlas-clusters-onlineArchives-delete.txt b/source/command/atlas-clusters-onlineArchives-delete.txt new file mode 100644 index 00000000..a0419560 --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives-delete.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives-delete: + +==================================== +atlas clusters onlineArchives delete +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified online archive from your cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives delete <archiveId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Archive '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove an online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: + atlas clusters onlineArchives delete 5f189832e26ec075e10c32d3 --clusterName myCluster diff --git a/source/command/atlas-clusters-onlineArchives-describe.txt b/source/command/atlas-clusters-onlineArchives-describe.txt new file mode 100644 index 00000000..0375b605 --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives-describe.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives-describe: + +====================================== +atlas clusters onlineArchives describe +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified online archive for your cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives describe <archiveId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID CLUSTER DATABASE COLLECTION STATE + <Id> <ClusterName> <DbName> <CollName> <State> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: + atlas clusters onlineArchives describe 5f189832e26ec075e10c32d3 --clusterName myCluster --output json diff --git a/source/command/atlas-clusters-onlineArchives-list.txt b/source/command/atlas-clusters-onlineArchives-list.txt new file mode 100644 index 00000000..ba40c65f --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives-list.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives-list: + +================================== +atlas clusters onlineArchives list +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all online archives for your cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID DATABASE COLLECTION STATE + <Id> <DbName> <CollName> <State> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of online archives for the cluster named myCluster: + atlas clusters onlineArchives list --clusterName myCluster --output json diff --git a/source/command/atlas-clusters-onlineArchives-pause.txt b/source/command/atlas-clusters-onlineArchives-pause.txt new file mode 100644 index 00000000..dfd1c567 --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives-pause.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives-pause: + +=================================== +atlas clusters onlineArchives pause +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Pause the specfied online archive for your cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives pause <archiveId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to pause. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for pause + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Online archive '<Id>' paused. + + +Examples +-------- + +.. code-block:: + + # Pause the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: + atlas clusters onlineArchives pause 5f189832e26ec075e10c32d3 --clusterName myCluster --output json diff --git a/source/command/atlas-clusters-onlineArchives-start.txt b/source/command/atlas-clusters-onlineArchives-start.txt new file mode 100644 index 00000000..cdd7142b --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives-start.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives-start: + +=================================== +atlas clusters onlineArchives start +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start a paused online archive from a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives start <archiveId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to start. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for start + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Online archive '<Id>' started. + + diff --git a/source/command/atlas-clusters-onlineArchives-update.txt b/source/command/atlas-clusters-onlineArchives-update.txt new file mode 100644 index 00000000..d96c97de --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives-update.txt @@ -0,0 +1,126 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives-update: + +==================================== +atlas clusters onlineArchives update +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the archiving rule for the specified online archive for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives update <archiveId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --archiveAfter + - int + - false + - Number of days after which to archive cluster data. + + Mutually exclusive with --file. + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --expireAfterDays + - int + - false + - Number of days used in the date criteria for nominating documents for deletion. + + Mutually exclusive with --file. + * - --file + - string + - false + - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config. + + Mutually exclusive with --archiveAfter, --expireAfterDays. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Online archive '<Id>' updated. + + +Examples +-------- + +.. code-block:: + + # Update the archiving rule to archive after 5 days for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: + atlas clusters onlineArchives update 5f189832e26ec075e10c32d3 --clusterName --archiveAfter 5 myCluster --output json diff --git a/source/command/atlas-clusters-onlineArchives-watch.txt b/source/command/atlas-clusters-onlineArchives-watch.txt new file mode 100644 index 00000000..afcce77f --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives-watch.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives-watch: + +=================================== +atlas clusters onlineArchives watch +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch for an archive to be available. + +This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. +Once the archive reaches the expected status, the command prints "Online archive available." +If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters onlineArchives watch <archiveId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - archiveId + - string + - true + - Unique identifier of the online archive to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - false + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Online archive available. + + +Examples +-------- + +.. code-block:: + + atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample diff --git a/source/command/atlas-clusters-onlineArchives.txt b/source/command/atlas-clusters-onlineArchives.txt new file mode 100644 index 00000000..5c7c8b74 --- /dev/null +++ b/source/command/atlas-clusters-onlineArchives.txt @@ -0,0 +1,76 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-onlineArchives: + +============================= +atlas clusters onlineArchives +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage online archives for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for onlineArchives + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-onlineArchives-create` - Create an online archive for a collection in the specified cluster. +* :ref:`atlas-clusters-onlineArchives-delete` - Remove the specified online archive from your cluster. +* :ref:`atlas-clusters-onlineArchives-describe` - Return the details for the specified online archive for your cluster. +* :ref:`atlas-clusters-onlineArchives-list` - Return all online archives for your cluster. +* :ref:`atlas-clusters-onlineArchives-pause` - Pause the specfied online archive for your cluster. +* :ref:`atlas-clusters-onlineArchives-start` - Start a paused online archive from a cluster. +* :ref:`atlas-clusters-onlineArchives-update` - Modify the archiving rule for the specified online archive for a cluster. +* :ref:`atlas-clusters-onlineArchives-watch` - Watch for an archive to be available. + + +.. toctree:: + :titlesonly: + + create </command/atlas-clusters-onlineArchives-create> + delete </command/atlas-clusters-onlineArchives-delete> + describe </command/atlas-clusters-onlineArchives-describe> + list </command/atlas-clusters-onlineArchives-list> + pause </command/atlas-clusters-onlineArchives-pause> + start </command/atlas-clusters-onlineArchives-start> + update </command/atlas-clusters-onlineArchives-update> + watch </command/atlas-clusters-onlineArchives-watch> + diff --git a/source/command/atlas-clusters-pause.txt b/source/command/atlas-clusters-pause.txt new file mode 100644 index 00000000..f330900a --- /dev/null +++ b/source/command/atlas-clusters-pause.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-pause: + +==================== +atlas clusters pause +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Pause the specified running MongoDB cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters pause <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to pause. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for pause + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Pausing cluster '<Name>'. + + +Examples +-------- + +.. code-block:: + + # Pause the cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas clusters pause myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-clusters-sampleData-describe.txt b/source/command/atlas-clusters-sampleData-describe.txt new file mode 100644 index 00000000..8c7c159d --- /dev/null +++ b/source/command/atlas-clusters-sampleData-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-sampleData-describe: + +================================== +atlas clusters sampleData describe +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified sample data load job. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters sampleData describe <id> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - id + - string + - true + - Unique identifier of the sample data job. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID CLUSTER NAME STATE + <Id> <ClusterName> <State> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the sample data load job: + atlas clusters sampleData describe 5e98249d937cfc52efdc2a9f --output json diff --git a/source/command/atlas-clusters-sampleData-load.txt b/source/command/atlas-clusters-sampleData-load.txt new file mode 100644 index 00000000..f34bf2c3 --- /dev/null +++ b/source/command/atlas-clusters-sampleData-load.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-sampleData-load: + +============================== +atlas clusters sampleData load +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Load sample data into the specified cluster for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters sampleData load <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster for which you want to load sample data. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for load + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Sample Data Job <Id> created. + + +Examples +-------- + +.. code-block:: + + # Load sample data into the cluster named myCluster: + atlas clusters sampleData load myCluster --output json diff --git a/source/command/atlas-clusters-sampleData-watch.txt b/source/command/atlas-clusters-sampleData-watch.txt new file mode 100644 index 00000000..b4593b2a --- /dev/null +++ b/source/command/atlas-clusters-sampleData-watch.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-sampleData-watch: + +=============================== +atlas clusters sampleData watch +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified sample data job in your cluster until it completes. + +This command checks the sample data job's status periodically until it reaches an COMPLETED state. +If you run the command in the terminal, it blocks the terminal session until the resource state changes to COMPLETED. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters sampleData watch <id> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - id + - string + - true + - Unique identifier of the sample data job. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Sample data available. + + +Examples +-------- + +.. code-block:: + + # Watch for the sample data job with ID 5e2211c17a3e5a48f5497de3 to complete: + atlas clusters sampledata watch 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-clusters-sampleData.txt b/source/command/atlas-clusters-sampleData.txt new file mode 100644 index 00000000..02e98f3d --- /dev/null +++ b/source/command/atlas-clusters-sampleData.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-sampleData: + +========================= +atlas clusters sampleData +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage sample data for your cluster. + +The sampleData command provides access to sample data to be loaded onto your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for sampleData + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-sampleData-describe` - Return the details for the specified sample data load job. +* :ref:`atlas-clusters-sampleData-load` - Load sample data into the specified cluster for your project. +* :ref:`atlas-clusters-sampleData-watch` - Watch the specified sample data job in your cluster until it completes. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-clusters-sampleData-describe> + load </command/atlas-clusters-sampleData-load> + watch </command/atlas-clusters-sampleData-watch> + diff --git a/source/command/atlas-clusters-search-indexes-create.txt b/source/command/atlas-clusters-search-indexes-create.txt new file mode 100644 index 00000000..499f6c50 --- /dev/null +++ b/source/command/atlas-clusters-search-indexes-create.txt @@ -0,0 +1,112 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-indexes-create: + +==================================== +atlas clusters search indexes create +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a search index for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes create [indexName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexName + - string + - false + - Name of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -f, --file + - string + - false + - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Index <Name> created. + + +Examples +-------- + +.. code-block:: + + # Create a search index for the cluster named myCluster using a JSON index configuration file named search-config.json: + atlas clusters search indexes create --clusterName myCluster --file search-config.json --output json diff --git a/source/command/atlas-clusters-search-indexes-delete.txt b/source/command/atlas-clusters-search-indexes-delete.txt new file mode 100644 index 00000000..566d1c08 --- /dev/null +++ b/source/command/atlas-clusters-search-indexes-delete.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-indexes-delete: + +==================================== +atlas clusters search indexes delete +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete the specified search index from the specified cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes delete <indexId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - true + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Index '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Delete the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster without requiring confirmation: + atlas clusters search indexes delete 5f2099cd683fc55fbb30bef6 --clusterName myCluster --force diff --git a/source/command/atlas-clusters-search-indexes-describe.txt b/source/command/atlas-clusters-search-indexes-describe.txt new file mode 100644 index 00000000..a883aede --- /dev/null +++ b/source/command/atlas-clusters-search-indexes-describe.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-indexes-describe: + +====================================== +atlas clusters search indexes describe +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the search index for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes describe <indexId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - true + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME DATABASE COLLECTION TYPE + <IndexID> <Name> <Database> <CollectionName> <Type> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the search index with the ID 5f1f40842f2ac35f49190c20 for the cluster named myCluster: + atlas clusters search indexes describe 5f1f40842f2ac35f49190c20 --clusterName myCluster --output json diff --git a/source/command/atlas-clusters-search-indexes-list.txt b/source/command/atlas-clusters-search-indexes-list.txt new file mode 100644 index 00000000..bb406a02 --- /dev/null +++ b/source/command/atlas-clusters-search-indexes-list.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-indexes-list: + +================================== +atlas clusters search indexes list +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List all Atlas Search indexes for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --collection + - string + - true + - Name of the collection. + * - --db + - string + - true + - Name of the database. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME DATABASE COLLECTION TYPE + <IndexID> <Name> <Database> <CollectionName> <Type> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted list of Atlas search indexes on the sample_mflix.movies database in the cluster named myCluster: + atlas clusters search indexes list --clusterName myCluster --db sample_mflix --collection movies --output json diff --git a/source/command/atlas-clusters-search-indexes-update.txt b/source/command/atlas-clusters-search-indexes-update.txt new file mode 100644 index 00000000..46d9055a --- /dev/null +++ b/source/command/atlas-clusters-search-indexes-update.txt @@ -0,0 +1,112 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-indexes-update: + +==================================== +atlas clusters search indexes update +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify a search index for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search indexes update <indexId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - true + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -f, --file + - string + - false + - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Index <Name> updated. + + +Examples +-------- + +.. code-block:: + + # Modify the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster: + atlas clusters search indexes update 5f2099cd683fc55fbb30bef6 --clusterName myCluster --output json diff --git a/source/command/atlas-clusters-search-indexes.txt b/source/command/atlas-clusters-search-indexes.txt new file mode 100644 index 00000000..45fea7cb --- /dev/null +++ b/source/command/atlas-clusters-search-indexes.txt @@ -0,0 +1,70 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-indexes: + +============================= +atlas clusters search indexes +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Search indexes for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for indexes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-search-indexes-create` - Create a search index for a cluster. +* :ref:`atlas-clusters-search-indexes-delete` - Delete the specified search index from the specified cluster. +* :ref:`atlas-clusters-search-indexes-describe` - Return the details for the search index for a cluster. +* :ref:`atlas-clusters-search-indexes-list` - List all Atlas Search indexes for a cluster. +* :ref:`atlas-clusters-search-indexes-update` - Modify a search index for a cluster. + + +.. toctree:: + :titlesonly: + + create </command/atlas-clusters-search-indexes-create> + delete </command/atlas-clusters-search-indexes-delete> + describe </command/atlas-clusters-search-indexes-describe> + list </command/atlas-clusters-search-indexes-list> + update </command/atlas-clusters-search-indexes-update> + diff --git a/source/command/atlas-clusters-search-nodes-create.txt b/source/command/atlas-clusters-search-nodes-create.txt new file mode 100644 index 00000000..426a70be --- /dev/null +++ b/source/command/atlas-clusters-search-nodes-create.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-nodes-create: + +================================== +atlas clusters search nodes create +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a search node for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search nodes create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -f, --file + - string + - true + - Name of the JSON index configuration file to use. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - uint + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Search nodes are being created. + + +Examples +-------- + +.. code-block:: + + # Create a search node for the cluster named myCluster using a JSON node spec configuration file named spec.json: + atlas clusters search nodes create --clusterName myCluster --file spec.json --output json diff --git a/source/command/atlas-clusters-search-nodes-delete.txt b/source/command/atlas-clusters-search-nodes-delete.txt new file mode 100644 index 00000000..031e1f72 --- /dev/null +++ b/source/command/atlas-clusters-search-nodes-delete.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-nodes-delete: + +================================== +atlas clusters search nodes delete +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a search node for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search nodes delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - uint + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Delete a search node for the cluster named myCluster: + atlas clusters search nodes delete --clusterName myCluster diff --git a/source/command/atlas-clusters-search-nodes-list.txt b/source/command/atlas-clusters-search-nodes-list.txt new file mode 100644 index 00000000..25dd99bc --- /dev/null +++ b/source/command/atlas-clusters-search-nodes-list.txt @@ -0,0 +1,93 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-nodes-list: + +================================ +atlas clusters search nodes list +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List all Atlas Search nodes for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search nodes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID STATE INSTANCE SIZE NODE COUNT{{ $id:=.Id>{{ $state:=.StateName > + {{$id> {{$state> <InstanceSize> <NodeCount> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted list of Atlas search nodes in the cluster named myCluster: + atlas clusters search nodes list --clusterName myCluster --output json diff --git a/source/command/atlas-clusters-search-nodes-update.txt b/source/command/atlas-clusters-search-nodes-update.txt new file mode 100644 index 00000000..578165f3 --- /dev/null +++ b/source/command/atlas-clusters-search-nodes-update.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-nodes-update: + +================================== +atlas clusters search nodes update +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update a search node for a cluster. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner or Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters search nodes update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -f, --file + - string + - true + - Name of the JSON index configuration file to use. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. + * - --watchTimeout + - uint + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Started updating search nodes. + + +Examples +-------- + +.. code-block:: + + # Update a search node for the cluster named myCluster using a JSON node spec configuration file named spec.json: + atlas clusters search nodes update --clusterName myCluster --file spec.json --output json diff --git a/source/command/atlas-clusters-search-nodes.txt b/source/command/atlas-clusters-search-nodes.txt new file mode 100644 index 00000000..88a02402 --- /dev/null +++ b/source/command/atlas-clusters-search-nodes.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search-nodes: + +=========================== +atlas clusters search nodes +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Search nodes for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for nodes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-search-nodes-create` - Create a search node for a cluster. +* :ref:`atlas-clusters-search-nodes-delete` - Delete a search node for a cluster. +* :ref:`atlas-clusters-search-nodes-list` - List all Atlas Search nodes for a cluster. +* :ref:`atlas-clusters-search-nodes-update` - Update a search node for a cluster. + + +.. toctree:: + :titlesonly: + + create </command/atlas-clusters-search-nodes-create> + delete </command/atlas-clusters-search-nodes-delete> + list </command/atlas-clusters-search-nodes-list> + update </command/atlas-clusters-search-nodes-update> + diff --git a/source/command/atlas-clusters-search.txt b/source/command/atlas-clusters-search.txt new file mode 100644 index 00000000..6e931c02 --- /dev/null +++ b/source/command/atlas-clusters-search.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-search: + +===================== +atlas clusters search +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Search for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for search + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-search-indexes` - Manage Atlas Search indexes for your cluster. +* :ref:`atlas-clusters-search-nodes` - Manage Atlas Search nodes for your cluster. + + +.. toctree:: + :titlesonly: + + indexes </command/atlas-clusters-search-indexes> + nodes </command/atlas-clusters-search-nodes> + diff --git a/source/command/atlas-clusters-start.txt b/source/command/atlas-clusters-start.txt new file mode 100644 index 00000000..6efbd326 --- /dev/null +++ b/source/command/atlas-clusters-start.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-start: + +==================== +atlas clusters start +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start the specified paused MongoDB cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters start <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to start. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for start + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Starting cluster '<Name>'. + + +Examples +-------- + +.. code-block:: + + # Start a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas clusters start myCluster --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-clusters-update.txt b/source/command/atlas-clusters-update.txt new file mode 100644 index 00000000..92d34245 --- /dev/null +++ b/source/command/atlas-clusters-update.txt @@ -0,0 +1,181 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-update: + +===================== +atlas clusters update +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the settings of the specified cluster. + +You can specify modifications in a JSON configuration file with the --file flag. + +You can't change the name of the cluster or downgrade the MongoDB version of your cluster. + +You can only update a replica set to a single-shard cluster; you cannot update a replica set to a multi-sharded cluster. To learn more, see https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster. + +To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. +Atlas supports this command only for M10+ clusters + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters update [clusterName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - false + - Name of the cluster to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableTerminationProtection + - + - false + - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. + + Mutually exclusive with --enableTerminationProtection, --file. + * - --diskSizeGB + - float + - false + - Capacity, in gigabytes, of the host's root volume. + + Mutually exclusive with --file. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + + Mutually exclusive with --disableTerminationProtection, --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli. + + Mutually exclusive with --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag. + * - -h, --help + - + - false + - help for update + * - --mdbVersion + - string + - false + - Major MongoDB version of the cluster. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. Passing this flag replaces preexisting data. + + Mutually exclusive with --file. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Updating cluster '<Name>'. + + +Examples +-------- + +.. code-block:: + + # Update the tier for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50 + + +.. code-block:: + + # Replace tags cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag key1=value1 + + +.. code-block:: + + # Remove all tags from cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tag = + + +.. code-block:: + + # Update the disk size for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --diskSizeGB 20 + + +.. code-block:: + + # Update the MongoDB version for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --mdbVersion 5.0 + + +.. code-block:: + + # Use a configuration file named cluster-config.json to update a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3: + atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --output json diff --git a/source/command/atlas-clusters-upgrade.txt b/source/command/atlas-clusters-upgrade.txt new file mode 100644 index 00000000..42ce7710 --- /dev/null +++ b/source/command/atlas-clusters-upgrade.txt @@ -0,0 +1,148 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-upgrade: + +====================== +atlas clusters upgrade +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Upgrade a shared cluster's tier, disk size, and/or MongoDB version. + +This command is unavailable for dedicated clusters. + +To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters upgrade [clusterName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - false + - Name of the cluster to upgrade. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableTerminationProtection + - + - false + - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. + + Mutually exclusive with --enableTerminationProtection, --file. + * - --diskSizeGB + - float + - false + - Capacity, in gigabytes, of the host's root volume. + + Mutually exclusive with --file. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + + Mutually exclusive with --disableTerminationProtection, --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli. + + Mutually exclusive with --tier, --diskSizeGB, --mdbVersion, --enableTerminationProtection, --disableTerminationProtection, --tag. + * - -h, --help + - + - false + - help for upgrade + * - --mdbVersion + - string + - false + - Major MongoDB version of the cluster. + + Mutually exclusive with --file. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. Passing this flag replaces preexisting data. + + Mutually exclusive with --file. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Upgrading cluster '<Name>'. + + +Examples +-------- + +.. code-block:: + + # Upgrade the tier, disk size, and MongoDB version for the shared cluster named myCluster in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas cluster upgrade myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50 --diskSizeGB 20 --mdbVersion 7.0 --tag env=dev diff --git a/source/command/atlas-clusters-watch.txt b/source/command/atlas-clusters-watch.txt new file mode 100644 index 00000000..a7208577 --- /dev/null +++ b/source/command/atlas-clusters-watch.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters-watch: + +==================== +atlas clusters watch +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified cluster in your project until it becomes available. + +This command checks the cluster's status periodically until it reaches an IDLE state. +Once the cluster reaches the expected state, the command prints "Cluster available." +If you run the command in the terminal, it blocks the terminal session until the resource state changes to IDLE. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas clusters watch <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Name of the cluster to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Cluster available. + + +Examples +-------- + +.. code-block:: + + # Watch for the cluster named myCluster to become available for the project with ID 5e2211c17a3e5a48f5497de3: + atlas clusters watch myCluster --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-clusters.txt b/source/command/atlas-clusters.txt new file mode 100644 index 00000000..eabbad29 --- /dev/null +++ b/source/command/atlas-clusters.txt @@ -0,0 +1,96 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-clusters: + +============== +atlas clusters +============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage clusters for your project. + +The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for clusters + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-clusters-advancedSettings` - Manage advanced configuration settings for your cluster. +* :ref:`atlas-clusters-availableRegions` - Manage available regions for your project. +* :ref:`atlas-clusters-connectionStrings` - Manage MongoDB cluster connection string. +* :ref:`atlas-clusters-create` - Create a cluster for your project. +* :ref:`atlas-clusters-delete` - Remove the specified cluster from your project. +* :ref:`atlas-clusters-describe` - Return the details for the specified cluster for your project. +* :ref:`atlas-clusters-failover` - Starts a failover test for the specified cluster in the specified project. +* :ref:`atlas-clusters-indexes` - Manage cluster rolling indexes for your project. +* :ref:`atlas-clusters-list` - Return all clusters for your project. +* :ref:`atlas-clusters-onlineArchives` - Manage online archives for your cluster. +* :ref:`atlas-clusters-pause` - Pause the specified running MongoDB cluster. +* :ref:`atlas-clusters-sampleData` - Manage sample data for your cluster. +* :ref:`atlas-clusters-search` - Manage Atlas Search for your cluster. +* :ref:`atlas-clusters-start` - Start the specified paused MongoDB cluster. +* :ref:`atlas-clusters-update` - Modify the settings of the specified cluster. +* :ref:`atlas-clusters-upgrade` - Upgrade a shared cluster's tier, disk size, and/or MongoDB version. +* :ref:`atlas-clusters-watch` - Watch the specified cluster in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + advancedSettings </command/atlas-clusters-advancedSettings> + availableRegions </command/atlas-clusters-availableRegions> + connectionStrings </command/atlas-clusters-connectionStrings> + create </command/atlas-clusters-create> + delete </command/atlas-clusters-delete> + describe </command/atlas-clusters-describe> + failover </command/atlas-clusters-failover> + indexes </command/atlas-clusters-indexes> + list </command/atlas-clusters-list> + onlineArchives </command/atlas-clusters-onlineArchives> + pause </command/atlas-clusters-pause> + sampleData </command/atlas-clusters-sampleData> + search </command/atlas-clusters-search> + start </command/atlas-clusters-start> + update </command/atlas-clusters-update> + upgrade </command/atlas-clusters-upgrade> + watch </command/atlas-clusters-watch> + diff --git a/source/command/atlas-completion-bash.txt b/source/command/atlas-completion-bash.txt new file mode 100644 index 00000000..4eca6e22 --- /dev/null +++ b/source/command/atlas-completion-bash.txt @@ -0,0 +1,79 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-completion-bash: + +===================== +atlas completion bash +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for bash + + +Generate the autocompletion script for the bash shell. +This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager. +To load completions in your current shell session: +$ source <(atlas completion bash) +To load completions for every new session, execute once: +Linux: +$ atlas completion bash > /etc/bash_completion.d/atlas +MacOS: +$ atlas completion bash > /usr/local/etc/bash_completion.d/atlas +You will need to start a new shell for this setup to take effect. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas completion bash + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for bash + * - --no-descriptions + - + - false + - disable completion descriptions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-completion-fish.txt b/source/command/atlas-completion-fish.txt new file mode 100644 index 00000000..d00465df --- /dev/null +++ b/source/command/atlas-completion-fish.txt @@ -0,0 +1,78 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-completion-fish: + +===================== +atlas completion fish +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for fish + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + + atlas completion fish | source + +To load completions for every new session, execute once: + + atlas completion fish > ~/.config/fish/completions/atlas.fish + +You will need to start a new shell for this setup to take effect. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas completion fish [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for fish + * - --no-descriptions + - + - false + - disable completion descriptions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-completion-powershell.txt b/source/command/atlas-completion-powershell.txt new file mode 100644 index 00000000..0de40ea4 --- /dev/null +++ b/source/command/atlas-completion-powershell.txt @@ -0,0 +1,75 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-completion-powershell: + +=========================== +atlas completion powershell +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for powershell + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: + + atlas completion powershell | Out-String | Invoke-Expression + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas completion powershell [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for powershell + * - --no-descriptions + - + - false + - disable completion descriptions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-completion-zsh.txt b/source/command/atlas-completion-zsh.txt new file mode 100644 index 00000000..2a7344f7 --- /dev/null +++ b/source/command/atlas-completion-zsh.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-completion-zsh: + +==================== +atlas completion zsh +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for zsh + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + + echo "autoload -U compinit; compinit" >> ~/.zshrc + +To load completions in your current shell session: + + source <(atlas completion zsh) + +To load completions for every new session, execute once: + +#### Linux: + + atlas completion zsh > "${fpath[1]}/_atlas" + +#### macOS: + + atlas completion zsh > $(brew --prefix)/share/zsh/site-functions/_atlas + +You will need to start a new shell for this setup to take effect. + + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas completion zsh [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for zsh + * - --no-descriptions + - + - false + - disable completion descriptions + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-completion.txt b/source/command/atlas-completion.txt new file mode 100644 index 00000000..9b8d62c8 --- /dev/null +++ b/source/command/atlas-completion.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-completion: + +================ +atlas completion +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate the autocompletion script for the specified shell + +Generate the autocompletion script for atlas for the specified shell. +See each sub-command's help for details on how to use the generated script. + + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for completion + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-completion-bash` - Generate the autocompletion script for bash +* :ref:`atlas-completion-fish` - Generate the autocompletion script for fish +* :ref:`atlas-completion-powershell` - Generate the autocompletion script for powershell +* :ref:`atlas-completion-zsh` - Generate the autocompletion script for zsh + + +.. toctree:: + :titlesonly: + + bash </command/atlas-completion-bash> + fish </command/atlas-completion-fish> + powershell </command/atlas-completion-powershell> + zsh </command/atlas-completion-zsh> + diff --git a/source/command/atlas-config-delete.txt b/source/command/atlas-config-delete.txt new file mode 100644 index 00000000..bc03f615 --- /dev/null +++ b/source/command/atlas-config-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-config-delete: + +=================== +atlas config delete +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a profile. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config delete <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the profile. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Profile '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Delete the default profile configuration: + atlas config delete default + + +.. code-block:: + + # Skip the confirmation question and delete the default profile configuration: + atlas config delete default --force diff --git a/source/command/atlas-config-describe.txt b/source/command/atlas-config-describe.txt new file mode 100644 index 00000000..39083ce1 --- /dev/null +++ b/source/command/atlas-config-describe.txt @@ -0,0 +1,81 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-config-describe: + +===================== +atlas config describe +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the profile you specify. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config describe <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Label that identifies the profile. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-config-edit.txt b/source/command/atlas-config-edit.txt new file mode 100644 index 00000000..046de4b7 --- /dev/null +++ b/source/command/atlas-config-edit.txt @@ -0,0 +1,76 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-config-edit: + +================= +atlas config edit +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Opens the config file with the default text editor. + +Uses the default editor to open the config file. You can use EDITOR or VISUAL envs to change the default. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config edit [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for edit + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # To open the config + atlas config edit + + +.. toctree:: + :titlesonly: + + diff --git a/source/command/atlas-config-init.txt b/source/command/atlas-config-init.txt new file mode 100644 index 00000000..dde7cc40 --- /dev/null +++ b/source/command/atlas-config-init.txt @@ -0,0 +1,78 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-config-init: + +================= +atlas config init +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configure a profile to store access settings for your MongoDB deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config init [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --gov + - + - false + - Create a default profile for atlas for gov + * - -h, --help + - + - false + - help for init + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # To configure the tool to work with Atlas: + atlas config init + + +.. code-block:: + + # To configure the tool to work with Atlas for Government: + atlas config init --gov diff --git a/source/command/atlas-config-list.txt b/source/command/atlas-config-list.txt new file mode 100644 index 00000000..449e7baf --- /dev/null +++ b/source/command/atlas-config-list.txt @@ -0,0 +1,73 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-config-list: + +================= +atlas config list +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a list of available profiles by name. + +If you did not specify a name for your profile, it displays as the default profile. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + atlas config ls diff --git a/source/command/atlas-config-rename.txt b/source/command/atlas-config-rename.txt new file mode 100644 index 00000000..6040493c --- /dev/null +++ b/source/command/atlas-config-rename.txt @@ -0,0 +1,88 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-config-rename: + +=================== +atlas config rename +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Rename a profile. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config rename <oldProfileName> <newProfileName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - oldProfileName + - string + - true + - Name of the profile to rename. + * - newProfileName + - string + - true + - New name of the profile. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for rename + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Rename a profile called myProfile to testProfile: + atlas config rename myProfile testProfile diff --git a/source/command/atlas-config-set.txt b/source/command/atlas-config-set.txt new file mode 100644 index 00000000..0140e514 --- /dev/null +++ b/source/command/atlas-config-set.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-config-set: + +================ +atlas config set +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configure specific properties of a profile. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas config set <propertyName> <value> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - propertyName + - string + - true + - Property to set in the profile. Valid values for Atlas CLI and MongoDB CLI are project_id, org_id, service, public_api_key, private_api_key, output, mongosh_path, skip_update_check, telemetry_enabled, access_token, and refresh_token. Additionally, values that are only valid for MongoDB CLI include ops_manager_url base_url, ops_manager_ca_certificate, and ops_manager_skip_verify. + * - value + - string + - true + - Value for the property to set in the profile. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for set + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + + Set the organization ID in the default profile to 5dd5aaef7a3e5a6c5bd12de4: + atlas config set org_id 5dd5aaef7a3e5a6c5bd12de4 diff --git a/source/command/atlas-config.txt b/source/command/atlas-config.txt new file mode 100644 index 00000000..2de3f746 --- /dev/null +++ b/source/command/atlas-config.txt @@ -0,0 +1,81 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-config: + +============ +atlas config +============ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configure and manage your user profiles. + +Configure settings in a user profile. +All settings are optional. You can specify settings individually by running: +$ atlas config set --help + +You can also use environment variables (MONGODB_ATLAS_*) when running the tool. +To find out more, see the documentation: https://dochub.mongodb.org/core/atlas-cli-env-variables. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for config + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-config-delete` - Delete a profile. +* :ref:`atlas-config-describe` - Return the profile you specify. +* :ref:`atlas-config-edit` - Opens the config file with the default text editor. +* :ref:`atlas-config-init` - Configure a profile to store access settings for your MongoDB deployment. +* :ref:`atlas-config-list` - Return a list of available profiles by name. +* :ref:`atlas-config-rename` - Rename a profile. +* :ref:`atlas-config-set` - Configure specific properties of a profile. + + +.. toctree:: + :titlesonly: + + delete </command/atlas-config-delete> + describe </command/atlas-config-describe> + edit </command/atlas-config-edit> + init </command/atlas-config-init> + list </command/atlas-config-list> + rename </command/atlas-config-rename> + set </command/atlas-config-set> + diff --git a/source/command/atlas-customDbRoles-create.txt b/source/command/atlas-customDbRoles-create.txt new file mode 100644 index 00000000..6ba9de11 --- /dev/null +++ b/source/command/atlas-customDbRoles-create.txt @@ -0,0 +1,130 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDbRoles-create: + +========================== +atlas customDbRoles create +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a custom database role for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles create <roleName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleName + - string + - true + - Name of the custom role to create. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - --inheritedRole + - strings + - false + - List of inherited roles and the database on which the role is granted. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --privilege + - strings + - false + - List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. For details on actions specific to clusters, databases, or collections, see https://dochub.mongodb.org/core/privilege-actions. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Custom database role '<RoleName>' successfully created. + + +Examples +-------- + +.. code-block:: + + # Create a custom database role + atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.collectionName + + +.. code-block:: + + # Create a custom database role on multiple collections + atlas customDbRoles create customRole --privilege FIND@databaseName,UPDATE@databaseName.firstCollectionName,UPDATE@databaseName.secondCollectionName + + +.. code-block:: + + # Create a customer database role with granted action on the cluster resource + atlas customDbRoles create customRole --privilege GET_CMD_LINE_OPTS + + +.. code-block:: + + # Use an inherited role + atlas customDbRoles create customRole --inheritedRole read@databaseName diff --git a/source/command/atlas-customDbRoles-delete.txt b/source/command/atlas-customDbRoles-delete.txt new file mode 100644 index 00000000..76c9267c --- /dev/null +++ b/source/command/atlas-customDbRoles-delete.txt @@ -0,0 +1,97 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDbRoles-delete: + +========================== +atlas customDbRoles delete +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified custom database role from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles delete <roleName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleName + - string + - true + - Name of the custom role to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Custom database role '<Name>' deleted + + diff --git a/source/command/atlas-customDbRoles-describe.txt b/source/command/atlas-customDbRoles-describe.txt new file mode 100644 index 00000000..39e655d9 --- /dev/null +++ b/source/command/atlas-customDbRoles-describe.txt @@ -0,0 +1,87 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDbRoles-describe: + +============================ +atlas customDbRoles describe +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a single custom database role for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles describe <roleName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleName + - string + - true + - Name of the custom role to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-customDbRoles-list.txt b/source/command/atlas-customDbRoles-list.txt new file mode 100644 index 00000000..e0469a9a --- /dev/null +++ b/source/command/atlas-customDbRoles-list.txt @@ -0,0 +1,71 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDbRoles-list: + +======================== +atlas customDbRoles list +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List custom database roles for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-customDbRoles-update.txt b/source/command/atlas-customDbRoles-update.txt new file mode 100644 index 00000000..2b503b2e --- /dev/null +++ b/source/command/atlas-customDbRoles-update.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDbRoles-update: + +========================== +atlas customDbRoles update +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update a custom database role for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDbRoles update <roleName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - roleName + - string + - true + - Name of the custom role to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --append + - + - false + - Input action and inheritedRoles to append to the existing role. + * - -h, --help + - + - false + - help for update + * - --inheritedRole + - strings + - false + - List of inherited roles and the database on which the role is granted. Passing this flag replaces preexisting data. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --privilege + - strings + - false + - List of actions per database and collection. If no database or collections are provided, cluster scope is assumed. For details on actions specific to clusters, databases, or collections, see https://dochub.mongodb.org/core/privilege-actions. Passing this flag replaces preexisting data. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Custom database role '<RoleName>' successfully updated. + + diff --git a/source/command/atlas-customDbRoles.txt b/source/command/atlas-customDbRoles.txt new file mode 100644 index 00000000..9aa9905a --- /dev/null +++ b/source/command/atlas-customDbRoles.txt @@ -0,0 +1,70 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDbRoles: + +=================== +atlas customDbRoles +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage custom database roles for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for customDbRoles + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-customDbRoles-create` - Create a custom database role for your project. +* :ref:`atlas-customDbRoles-delete` - Remove the specified custom database role from your project. +* :ref:`atlas-customDbRoles-describe` - Return a single custom database role for your project. +* :ref:`atlas-customDbRoles-list` - List custom database roles for your project. +* :ref:`atlas-customDbRoles-update` - Update a custom database role for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-customDbRoles-create> + delete </command/atlas-customDbRoles-delete> + describe </command/atlas-customDbRoles-describe> + list </command/atlas-customDbRoles-list> + update </command/atlas-customDbRoles-update> + diff --git a/source/command/atlas-customDns-aws-describe.txt b/source/command/atlas-customDns-aws-describe.txt new file mode 100644 index 00000000..977bf239 --- /dev/null +++ b/source/command/atlas-customDns-aws-describe.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDns-aws-describe: + +============================ +atlas customDns aws describe +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDns aws describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ENABLED + <Enabled> + + +Examples +-------- + +.. code-block:: + + # Return the details for the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: + atlas customDns aws describe --projectId 618d48e05277a606ed2496fe diff --git a/source/command/atlas-customDns-aws-disable.txt b/source/command/atlas-customDns-aws-disable.txt new file mode 100644 index 00000000..6fa0b5bb --- /dev/null +++ b/source/command/atlas-customDns-aws-disable.txt @@ -0,0 +1,88 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDns-aws-disable: + +=========================== +atlas customDns aws disable +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDns aws disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DNS configuration disabled. + + +Examples +-------- + +.. code-block:: + + # Disable the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: + atlas customDns aws disable --projectId 618d48e05277a606ed2496fe diff --git a/source/command/atlas-customDns-aws-enable.txt b/source/command/atlas-customDns-aws-enable.txt new file mode 100644 index 00000000..6665a935 --- /dev/null +++ b/source/command/atlas-customDns-aws-enable.txt @@ -0,0 +1,88 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDns-aws-enable: + +========================== +atlas customDns aws enable +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas customDns aws enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DNS configuration enabled. + + +Examples +-------- + +.. code-block:: + + # Enable the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: + atlas customDns aws enable --projectId 618d48e05277a606ed2496fe diff --git a/source/command/atlas-customDns-aws.txt b/source/command/atlas-customDns-aws.txt new file mode 100644 index 00000000..a501814d --- /dev/null +++ b/source/command/atlas-customDns-aws.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDns-aws: + +=================== +atlas customDns aws +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage DNS configuration of an Atlas project’s cluster deployed to AWS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for aws + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-customDns-aws-describe` - Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +* :ref:`atlas-customDns-aws-disable` - Disable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. +* :ref:`atlas-customDns-aws-enable` - Enable the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-customDns-aws-describe> + disable </command/atlas-customDns-aws-disable> + enable </command/atlas-customDns-aws-enable> + diff --git a/source/command/atlas-customDns.txt b/source/command/atlas-customDns.txt new file mode 100644 index 00000000..012ca2e8 --- /dev/null +++ b/source/command/atlas-customDns.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-customDns: + +=============== +atlas customDns +=============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage DNS configuration of Atlas project’s clusters deployed to AWS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for customDns + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-customDns-aws` - Manage DNS configuration of an Atlas project’s cluster deployed to AWS. + + +.. toctree:: + :titlesonly: + + aws </command/atlas-customDns-aws> + diff --git a/source/command/atlas-dataFederation-create.txt b/source/command/atlas-dataFederation-create.txt new file mode 100644 index 00000000..792e27b8 --- /dev/null +++ b/source/command/atlas-dataFederation-create.txt @@ -0,0 +1,128 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-create: + +=========================== +atlas dataFederation create +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a new Data Federation database. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation create <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --awsRoleId + - string + - false + - Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores. + + Mutually exclusive with --file. + * - --awsTestS3Bucket + - string + - false + - Name of an Amazon S3 data bucket that Atlas Data Federation uses to validate the provided role. + + Mutually exclusive with --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config. + + Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - false + - Name of the region to which Atlas Data Federation routes client connections for data processing. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Data federation <Name> created. + +Examples +-------- + +.. code-block:: + + # create data federation database: + atlas dataFederation create DataFederation1 --region us_east_1 --awsRoleId role --awsTestS3Bucket bucket + diff --git a/source/command/atlas-dataFederation-delete.txt b/source/command/atlas-dataFederation-delete.txt new file mode 100644 index 00000000..9a2cb9f4 --- /dev/null +++ b/source/command/atlas-dataFederation-delete.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-delete: + +=========================== +atlas dataFederation delete +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified data federation database from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation delete <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # deletes data federation 'DataFederation1': + atlas dataFederation delete DataFederation1 + diff --git a/source/command/atlas-dataFederation-describe.txt b/source/command/atlas-dataFederation-describe.txt new file mode 100644 index 00000000..ffebaed7 --- /dev/null +++ b/source/command/atlas-dataFederation-describe.txt @@ -0,0 +1,95 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-describe: + +============================= +atlas dataFederation describe +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified data federation database for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation describe <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # retrieves data federation 'DataFederation1': + atlas dataFederation describe DataFederation1 + diff --git a/source/command/atlas-dataFederation-list.txt b/source/command/atlas-dataFederation-list.txt new file mode 100644 index 00000000..3bb4237d --- /dev/null +++ b/source/command/atlas-dataFederation-list.txt @@ -0,0 +1,83 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-list: + +========================= +atlas dataFederation list +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all data federation databases for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of Federated Database Instances to return. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # list all data federation databases: + atlas dataFederation list + diff --git a/source/command/atlas-dataFederation-logs.txt b/source/command/atlas-dataFederation-logs.txt new file mode 100644 index 00000000..8b18227d --- /dev/null +++ b/source/command/atlas-dataFederation-logs.txt @@ -0,0 +1,107 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-logs: + +========================= +atlas dataFederation logs +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns logs of the specified data federation database for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation logs <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - int + - false + - Timestamp in UNIX epoch format when the logs end. + * - --force + - + - false + - Flag that indicates whether to overwrite the destination file. + * - -h, --help + - + - false + - help for logs + * - --out + - string + - true + - Output file name. This value defaults to the log name. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - int + - false + - Timestamp in UNIX epoch format when the logs start. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # download logs of data federation database 'DataFederation1': + atlas dataFederation logs DataFederation1 + diff --git a/source/command/atlas-dataFederation-privateEndpoints-create.txt b/source/command/atlas-dataFederation-privateEndpoints-create.txt new file mode 100644 index 00000000..5fedea2d --- /dev/null +++ b/source/command/atlas-dataFederation-privateEndpoints-create.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-privateEndpoints-create: + +============================================ +atlas dataFederation privateEndpoints create +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a new Data Federation private endpoint. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation privateEndpoints create <endpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointId + - string + - true + - Endpoint identifier of the data federation private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --comment + - string + - false + - Optional description or comment for the entry. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Data federation private endpoint {{(index .Results 0).EndpointId> created. + +Examples +-------- + +.. code-block:: + + # create data federation private endpoint: + atlas dataFederation privateEndpoints create 507f1f77bcf86cd799439011 --comment "comment" + diff --git a/source/command/atlas-dataFederation-privateEndpoints-delete.txt b/source/command/atlas-dataFederation-privateEndpoints-delete.txt new file mode 100644 index 00000000..ccfa222c --- /dev/null +++ b/source/command/atlas-dataFederation-privateEndpoints-delete.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-privateEndpoints-delete: + +============================================ +atlas dataFederation privateEndpoints delete +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified data federation private endpoint from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation privateEndpoints delete <endpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointId + - string + - true + - Endpoint identifier of the data federation private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # deletes data federation private endpoint '507f1f77bcf86cd799439011': + atlas dataFederation privateEndpoints delete 507f1f77bcf86cd799439011 + diff --git a/source/command/atlas-dataFederation-privateEndpoints-describe.txt b/source/command/atlas-dataFederation-privateEndpoints-describe.txt new file mode 100644 index 00000000..8a0f1744 --- /dev/null +++ b/source/command/atlas-dataFederation-privateEndpoints-describe.txt @@ -0,0 +1,95 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-privateEndpoints-describe: + +============================================== +atlas dataFederation privateEndpoints describe +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified data federation private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation privateEndpoints describe <endpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointId + - string + - true + - Endpoint identifier of the data federation private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # retrieves data federation private endpoint '507f1f77bcf86cd799439011': + atlas dataFederation privateEndpoints describe 507f1f77bcf86cd799439011 + diff --git a/source/command/atlas-dataFederation-privateEndpoints-list.txt b/source/command/atlas-dataFederation-privateEndpoints-list.txt new file mode 100644 index 00000000..f173c33f --- /dev/null +++ b/source/command/atlas-dataFederation-privateEndpoints-list.txt @@ -0,0 +1,79 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-privateEndpoints-list: + +========================================== +atlas dataFederation privateEndpoints list +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all data federation private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation privateEndpoints list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # list all data federation private endpoints: + atlas dataFederation privateEndpoints list + diff --git a/source/command/atlas-dataFederation-privateEndpoints.txt b/source/command/atlas-dataFederation-privateEndpoints.txt new file mode 100644 index 00000000..a7af41b8 --- /dev/null +++ b/source/command/atlas-dataFederation-privateEndpoints.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-privateEndpoints: + +===================================== +atlas dataFederation privateEndpoints +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Data federation private endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for privateEndpoints + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataFederation-privateEndpoints-create` - Creates a new Data Federation private endpoint. +* :ref:`atlas-dataFederation-privateEndpoints-delete` - Remove the specified data federation private endpoint from your project. +* :ref:`atlas-dataFederation-privateEndpoints-describe` - Return the details for the specified data federation private endpoint for your project. +* :ref:`atlas-dataFederation-privateEndpoints-list` - Returns all data federation private endpoints for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-dataFederation-privateEndpoints-create> + delete </command/atlas-dataFederation-privateEndpoints-delete> + describe </command/atlas-dataFederation-privateEndpoints-describe> + list </command/atlas-dataFederation-privateEndpoints-list> + diff --git a/source/command/atlas-dataFederation-queryLimits-create.txt b/source/command/atlas-dataFederation-queryLimits-create.txt new file mode 100644 index 00000000..6488cc3d --- /dev/null +++ b/source/command/atlas-dataFederation-queryLimits-create.txt @@ -0,0 +1,116 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-queryLimits-create: + +======================================= +atlas dataFederation queryLimits create +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a new Data Federation query limit. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation queryLimits create <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Identifier of the data federation query limit. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dataFederation + - string + - true + - Identifier of the Federated Database Instance. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --overrunPolicy + - string + - false + - Action to take when the usage limit is exceeded. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --value + - int + - true + - Value given to the query limit. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Data federation query limit <Name> created. + +Examples +-------- + +.. code-block:: + + # create data federation query limit: + atlas dataFederation queryLimit create bytesProcessed.query --value 1000 --dataFederation DataFederation1 + diff --git a/source/command/atlas-dataFederation-queryLimits-delete.txt b/source/command/atlas-dataFederation-queryLimits-delete.txt new file mode 100644 index 00000000..d736f36a --- /dev/null +++ b/source/command/atlas-dataFederation-queryLimits-delete.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-queryLimits-delete: + +======================================= +atlas dataFederation queryLimits delete +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified data federation query limit from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation queryLimits delete <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Identifier of the data federation query limit. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dataFederation + - string + - true + - Identifier of the Federated Database Instance. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # deletes data federation query limits "bytesProcessed.query" for 'DataFederation1': + atlas dataFederation queryLimits delete bytesProcessed.query --tenantName DataFederation1 + diff --git a/source/command/atlas-dataFederation-queryLimits-describe.txt b/source/command/atlas-dataFederation-queryLimits-describe.txt new file mode 100644 index 00000000..812696ff --- /dev/null +++ b/source/command/atlas-dataFederation-queryLimits-describe.txt @@ -0,0 +1,99 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-queryLimits-describe: + +========================================= +atlas dataFederation queryLimits describe +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified data federation query limit for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation queryLimits describe <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Identifier of the data federation query limit. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dataFederation + - string + - true + - Identifier of the Federated Database Instance. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # retrieves data federation query limits "bytesProcessed.query" for 'DataFederation1': + atlas dataFederation queryLimits describe bytesProcessed.query --tenantName DataFederation1 + diff --git a/source/command/atlas-dataFederation-queryLimits-list.txt b/source/command/atlas-dataFederation-queryLimits-list.txt new file mode 100644 index 00000000..4769f3ee --- /dev/null +++ b/source/command/atlas-dataFederation-queryLimits-list.txt @@ -0,0 +1,83 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-queryLimits-list: + +===================================== +atlas dataFederation queryLimits list +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all data federation query limits for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation queryLimits list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dataFederation + - string + - true + - Identifier of the Federated Database Instance. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # list all data federation query limits: + atlas dataFederation queryLimits list + diff --git a/source/command/atlas-dataFederation-queryLimits.txt b/source/command/atlas-dataFederation-queryLimits.txt new file mode 100644 index 00000000..a1048444 --- /dev/null +++ b/source/command/atlas-dataFederation-queryLimits.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-queryLimits: + +================================ +atlas dataFederation queryLimits +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Data federation query limits. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for queryLimits + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataFederation-queryLimits-create` - Creates a new Data Federation query limit. +* :ref:`atlas-dataFederation-queryLimits-delete` - Remove the specified data federation query limit from your project. +* :ref:`atlas-dataFederation-queryLimits-describe` - Return the details for the specified data federation query limit for your project. +* :ref:`atlas-dataFederation-queryLimits-list` - Returns all data federation query limits for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-dataFederation-queryLimits-create> + delete </command/atlas-dataFederation-queryLimits-delete> + describe </command/atlas-dataFederation-queryLimits-describe> + list </command/atlas-dataFederation-queryLimits-list> + diff --git a/source/command/atlas-dataFederation-update.txt b/source/command/atlas-dataFederation-update.txt new file mode 100644 index 00000000..05d0eaa1 --- /dev/null +++ b/source/command/atlas-dataFederation-update.txt @@ -0,0 +1,128 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation-update: + +=========================== +atlas dataFederation update +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the details of the specified data federation database for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataFederation update <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the data federation database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --awsRoleId + - string + - false + - Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores. + + Mutually exclusive with --file. + * - --awsTestS3Bucket + - string + - false + - Name of an Amazon S3 data bucket that Atlas Data Federation uses to validate the provided role. + + Mutually exclusive with --file. + * - -f, --file + - string + - false + - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config. + + Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - false + - Name of the region to which Atlas Data Federation routes client connections for data processing. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Pipeline <Name> updated. + +Examples +-------- + +.. code-block:: + + # update data lake pipeline: + atlas dataFederation update DataFederation1 + diff --git a/source/command/atlas-dataFederation.txt b/source/command/atlas-dataFederation.txt new file mode 100644 index 00000000..31da160d --- /dev/null +++ b/source/command/atlas-dataFederation.txt @@ -0,0 +1,76 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataFederation: + +==================== +atlas dataFederation +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Data federation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for dataFederation + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataFederation-create` - Creates a new Data Federation database. +* :ref:`atlas-dataFederation-delete` - Remove the specified data federation database from your project. +* :ref:`atlas-dataFederation-describe` - Return the details for the specified data federation database for your project. +* :ref:`atlas-dataFederation-list` - Returns all data federation databases for your project. +* :ref:`atlas-dataFederation-logs` - Returns logs of the specified data federation database for your project. +* :ref:`atlas-dataFederation-privateEndpoints` - Data federation private endpoints. +* :ref:`atlas-dataFederation-queryLimits` - Data federation query limits. +* :ref:`atlas-dataFederation-update` - Modify the details of the specified data federation database for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-dataFederation-create> + delete </command/atlas-dataFederation-delete> + describe </command/atlas-dataFederation-describe> + list </command/atlas-dataFederation-list> + logs </command/atlas-dataFederation-logs> + privateEndpoints </command/atlas-dataFederation-privateEndpoints> + queryLimits </command/atlas-dataFederation-queryLimits> + update </command/atlas-dataFederation-update> + diff --git a/source/command/atlas-dataLakePipelines-availableSchedules-list.txt b/source/command/atlas-dataLakePipelines-availableSchedules-list.txt new file mode 100644 index 00000000..f673f9cd --- /dev/null +++ b/source/command/atlas-dataLakePipelines-availableSchedules-list.txt @@ -0,0 +1,83 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-availableSchedules-list: + +=============================================== +atlas dataLakePipelines availableSchedules list +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all available schedules for the specified data lake pipeline. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines availableSchedules list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --pipeline + - string + - true + - Name of the Data lake pipeline. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # list available schedules for data lake pipeline called 'Pipeline1': + atlas dataLakePipelines availableSchedules list Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-availableSchedules.txt b/source/command/atlas-dataLakePipelines-availableSchedules.txt new file mode 100644 index 00000000..e72955ea --- /dev/null +++ b/source/command/atlas-dataLakePipelines-availableSchedules.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-availableSchedules: + +========================================== +atlas dataLakePipelines availableSchedules +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage available schedules for the specified data lake pipeline. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for availableSchedules + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataLakePipelines-availableSchedules-list` - Return all available schedules for the specified data lake pipeline. + + +.. toctree:: + :titlesonly: + + list </command/atlas-dataLakePipelines-availableSchedules-list> + diff --git a/source/command/atlas-dataLakePipelines-availableSnapshots-list.txt b/source/command/atlas-dataLakePipelines-availableSnapshots-list.txt new file mode 100644 index 00000000..0e7d0c56 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-availableSnapshots-list.txt @@ -0,0 +1,99 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-availableSnapshots-list: + +=============================================== +atlas dataLakePipelines availableSnapshots list +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all available backup snapshots for the specified data lake pipeline. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines availableSnapshots list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --completedAfter + - string + - false + - Date filter for when the backup snapshots were completed. You must use the YYYY-MM-DD format. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --pipeline + - string + - true + - Name of the Data lake pipeline. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # list available backup schedules for data lake pipeline called 'Pipeline1': + atlas dataLakePipelines availableSnapshots list Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-availableSnapshots.txt b/source/command/atlas-dataLakePipelines-availableSnapshots.txt new file mode 100644 index 00000000..a4c10049 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-availableSnapshots.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-availableSnapshots: + +========================================== +atlas dataLakePipelines availableSnapshots +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage available backup snapshots for data lake pipelines. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for availableSnapshots + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataLakePipelines-availableSnapshots-list` - Return all available backup snapshots for the specified data lake pipeline. + + +.. toctree:: + :titlesonly: + + list </command/atlas-dataLakePipelines-availableSnapshots-list> + diff --git a/source/command/atlas-dataLakePipelines-create.txt b/source/command/atlas-dataLakePipelines-create.txt new file mode 100644 index 00000000..c99ba01c --- /dev/null +++ b/source/command/atlas-dataLakePipelines-create.txt @@ -0,0 +1,160 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-create: + +============================== +atlas dataLakePipelines create +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a new Data Lake Pipeline. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines create <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - false + - Name of the JSON data lake pipeline configuration file to use. + + Mutually exclusive with --sinkType, --sinkMetadataProvider, --sinkMetadataRegion, --sinkPartitionField, --sourceType, --sourceClusterName, --sourceCollectionName, --sourceDatabaseName, --sourcePolicyItemId, --transform. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sinkMetadataProvider + - string + - false + - Target cloud provider for this data lake pipeline. + + Mutually exclusive with --file. + * - --sinkMetadataRegion + - string + - false + - Target cloud provider region for this data lake pipeline. + + Mutually exclusive with --file. + * - --sinkPartitionField + - strings + - false + - Ordered fields used to physically organize data in the destination. + + Mutually exclusive with --file. + * - --sinkType + - string + - false + - Type of ingestion destination for this data lake pipeline. + + Mutually exclusive with --file. + * - --sourceClusterName + - string + - false + - Human-readable label that identifies the source cluster. + + Mutually exclusive with --file. + * - --sourceCollectionName + - string + - false + - Human-readable label that identifies the source collection. + + Mutually exclusive with --file. + * - --sourceDatabaseName + - string + - false + - Human-readable label that identifies the source database. + + Mutually exclusive with --file. + * - --sourcePolicyItemId + - string + - false + - Human-readable label that identifies the policy item. + + Mutually exclusive with --file. + * - --sourceType + - string + - false + - Type of ingestion source for this data lake pipeline. + + Mutually exclusive with --file. + * - --transform + - strings + - false + - Fields to exclude for this data lake pipeline. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # create data lake pipeline: + atlas dataLakePipelines create Pipeline1 --sinkType CPS --sinkMetadataProvider AWS --sinkMetadataRegion us-east-1 --sinkPartitionField name:0,summary:1 --sourceType PERIODIC_CPS --sourceClusterName Cluster1 --sourceDatabaseName sample_airbnb --sourceCollectionName listingsAndReviews --sourcePolicyItemId 507f1f77bcf86cd799439011 --transform EXCLUDE:space,EXCLUDE:notes diff --git a/source/command/atlas-dataLakePipelines-datasets-delete.txt b/source/command/atlas-dataLakePipelines-datasets-delete.txt new file mode 100644 index 00000000..f360df31 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-datasets-delete.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-datasets-delete: + +======================================= +atlas dataLakePipelines datasets delete +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified data lake pipeline dataset from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines datasets delete <pipelineRunId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineRunId + - string + - true + - Unique identifier for the data lake pipeline run + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --pipeline + - string + - true + - Name of the Data lake pipeline. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # delete dataset '507f1f77bcf86cd799439011' for data lake pipeline called 'Pipeline1': + atlas dataLakePipelines datasets delete 507f1f77bcf86cd799439011 --pipeline Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-datasets.txt b/source/command/atlas-dataLakePipelines-datasets.txt new file mode 100644 index 00000000..0b3b91b3 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-datasets.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-datasets: + +================================ +atlas dataLakePipelines datasets +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage datasets for the specified data lake pipeline. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for datasets + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataLakePipelines-datasets-delete` - Remove the specified data lake pipeline dataset from your project. + + +.. toctree:: + :titlesonly: + + delete </command/atlas-dataLakePipelines-datasets-delete> + diff --git a/source/command/atlas-dataLakePipelines-delete.txt b/source/command/atlas-dataLakePipelines-delete.txt new file mode 100644 index 00000000..2eba1e0c --- /dev/null +++ b/source/command/atlas-dataLakePipelines-delete.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-delete: + +============================== +atlas dataLakePipelines delete +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified data lake pipeline from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines delete <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # deletes pipeline 'Pipeline1': + atlas dataLakePipelines delete Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-describe.txt b/source/command/atlas-dataLakePipelines-describe.txt new file mode 100644 index 00000000..b96b0ea9 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-describe.txt @@ -0,0 +1,95 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-describe: + +================================ +atlas dataLakePipelines describe +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified data lake pipeline for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines describe <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # retrieves pipeline 'Pipeline1': + atlas dataLakePipelines describe Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-list.txt b/source/command/atlas-dataLakePipelines-list.txt new file mode 100644 index 00000000..e0c60191 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-list.txt @@ -0,0 +1,78 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-list: + +============================ +atlas dataLakePipelines list +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all data lake pipelines for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # list all pipelines: + atlas dataLakePipelines list diff --git a/source/command/atlas-dataLakePipelines-pause.txt b/source/command/atlas-dataLakePipelines-pause.txt new file mode 100644 index 00000000..01811ce0 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-pause.txt @@ -0,0 +1,95 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-pause: + +============================= +atlas dataLakePipelines pause +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Pause the specified data lake pipeline for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines pause <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for pause + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # pause pipeline 'Pipeline1': + atlas dataLakePipelines pause Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-runs-describe.txt b/source/command/atlas-dataLakePipelines-runs-describe.txt new file mode 100644 index 00000000..e53d0832 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-runs-describe.txt @@ -0,0 +1,99 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-runs-describe: + +===================================== +atlas dataLakePipelines runs describe +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified data lake pipeline run for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines runs describe <pipelineRunId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineRunId + - string + - true + - Unique identifier for the data lake pipeline run + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --pipeline + - string + - true + - Name of the Data lake pipeline. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # retrieves pipeline run '507f1f77bcf86cd799439011': + atlas dataLakePipelines runs describe 507f1f77bcf86cd799439011 + diff --git a/source/command/atlas-dataLakePipelines-runs-list.txt b/source/command/atlas-dataLakePipelines-runs-list.txt new file mode 100644 index 00000000..87475234 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-runs-list.txt @@ -0,0 +1,83 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-runs-list: + +================================= +atlas dataLakePipelines runs list +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all data lake pipeline runs for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines runs list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --pipeline + - string + - true + - Name of the Data lake pipeline. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # list all pipeline runs: + atlas dataLakePipelines runs list + diff --git a/source/command/atlas-dataLakePipelines-runs-watch.txt b/source/command/atlas-dataLakePipelines-runs-watch.txt new file mode 100644 index 00000000..b6515418 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-runs-watch.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-runs-watch: + +================================== +atlas dataLakePipelines runs watch +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch for the specified data lake pipeline run to complete. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines runs watch <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --pipeline + - string + - true + - Name of the Data lake pipeline. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + data lake pipeline created + + +Examples +-------- + +.. code-block:: + + # watches the pipeline 'Pipeline1': + atlas dataLakePipelines watch Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-runs.txt b/source/command/atlas-dataLakePipelines-runs.txt new file mode 100644 index 00000000..dcd43bfb --- /dev/null +++ b/source/command/atlas-dataLakePipelines-runs.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-runs: + +============================ +atlas dataLakePipelines runs +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Data Lake pipelines runs. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for runs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataLakePipelines-runs-describe` - Return the details for the specified data lake pipeline run for your project. +* :ref:`atlas-dataLakePipelines-runs-list` - Returns all data lake pipeline runs for your project. +* :ref:`atlas-dataLakePipelines-runs-watch` - Watch for the specified data lake pipeline run to complete. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-dataLakePipelines-runs-describe> + list </command/atlas-dataLakePipelines-runs-list> + watch </command/atlas-dataLakePipelines-runs-watch> + diff --git a/source/command/atlas-dataLakePipelines-start.txt b/source/command/atlas-dataLakePipelines-start.txt new file mode 100644 index 00000000..cfcc4464 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-start.txt @@ -0,0 +1,95 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-start: + +============================= +atlas dataLakePipelines start +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start the specified data lake pipeline for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines start <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for start + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # start pipeline 'Pipeline1': + atlas dataLakePipelines start Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-trigger.txt b/source/command/atlas-dataLakePipelines-trigger.txt new file mode 100644 index 00000000..b9b56765 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-trigger.txt @@ -0,0 +1,99 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-trigger: + +=============================== +atlas dataLakePipelines trigger +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Trigger the specified data lake pipeline for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines trigger <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for trigger + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - true + - Unique identifier of the snapshot. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # trigger pipeline 'Pipeline1': + atlas dataLakePipelines trigger Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines-update.txt b/source/command/atlas-dataLakePipelines-update.txt new file mode 100644 index 00000000..d1462ee3 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-update.txt @@ -0,0 +1,154 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-update: + +============================== +atlas dataLakePipelines update +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the details of the specified data lake pipeline for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines update <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - false + - Name of the JSON data lake pipeline configuration file to use. + + Mutually exclusive with --sinkMetadataProvider, --sinkMetadataRegion, --sinkPartitionField, --sourceType, --sourceClusterName, --sourceCollectionName, --sourceDatabaseName, --sourcePolicyItemId, --transform. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sinkMetadataProvider + - string + - false + - Target cloud provider for this data lake pipeline. + + Mutually exclusive with --file. + * - --sinkMetadataRegion + - string + - false + - Target cloud provider region for this data lake pipeline. + + Mutually exclusive with --file. + * - --sinkPartitionField + - strings + - false + - Ordered fields used to physically organize data in the destination. Passing this flag replaces preexisting data. + + Mutually exclusive with --file. + * - --sourceClusterName + - string + - false + - Human-readable label that identifies the source cluster. + + Mutually exclusive with --file. + * - --sourceCollectionName + - string + - false + - Human-readable label that identifies the source collection. + + Mutually exclusive with --file. + * - --sourceDatabaseName + - string + - false + - Human-readable label that identifies the source database. + + Mutually exclusive with --file. + * - --sourcePolicyItemId + - string + - false + - Human-readable label that identifies the policy item. + + Mutually exclusive with --file. + * - --sourceType + - string + - false + - Type of ingestion source for this data lake pipeline. + + Mutually exclusive with --file. + * - --transform + - strings + - false + - Fields to exclude for this data lake pipeline. Passing this flag replaces preexisting data. + + Mutually exclusive with --file. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # update data lake pipeline: + atlas dataLakePipelines update Pipeline1 --sinkType CPS --sinkMetadataProvider AWS --sinkMetadataRegion us-east-1 --sinkPartitionField name:0,summary:1 --sourceType PERIODIC_CPS --sourceClusterName Cluster1 --sourceDatabaseName sample_airbnb --sourceCollectionName listingsAndReviews --sourcePolicyItemId 507f1f77bcf86cd799439011 --transform EXCLUDE:space,EXCLUDE:notes diff --git a/source/command/atlas-dataLakePipelines-watch.txt b/source/command/atlas-dataLakePipelines-watch.txt new file mode 100644 index 00000000..7d4f0a86 --- /dev/null +++ b/source/command/atlas-dataLakePipelines-watch.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines-watch: + +============================= +atlas dataLakePipelines watch +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch for the specified data lake pipeline to complete. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dataLakePipelines watch <pipelineName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - pipelineName + - string + - true + - Label that identifies the pipeline + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + data lake pipeline created + + +Examples +-------- + +.. code-block:: + + # watches the pipeline 'Pipeline1': + atlas dataLakePipelines watch Pipeline1 + diff --git a/source/command/atlas-dataLakePipelines.txt b/source/command/atlas-dataLakePipelines.txt new file mode 100644 index 00000000..b11af5b0 --- /dev/null +++ b/source/command/atlas-dataLakePipelines.txt @@ -0,0 +1,86 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dataLakePipelines: + +======================= +atlas dataLakePipelines +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Data Lake pipelines. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for dataLakePipelines + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dataLakePipelines-availableSchedules` - Manage available schedules for the specified data lake pipeline. +* :ref:`atlas-dataLakePipelines-availableSnapshots` - Manage available backup snapshots for data lake pipelines. +* :ref:`atlas-dataLakePipelines-create` - Creates a new Data Lake Pipeline. +* :ref:`atlas-dataLakePipelines-datasets` - Manage datasets for the specified data lake pipeline. +* :ref:`atlas-dataLakePipelines-delete` - Remove the specified data lake pipeline from your project. +* :ref:`atlas-dataLakePipelines-describe` - Return the details for the specified data lake pipeline for your project. +* :ref:`atlas-dataLakePipelines-list` - Returns all data lake pipelines for your project. +* :ref:`atlas-dataLakePipelines-pause` - Pause the specified data lake pipeline for your project. +* :ref:`atlas-dataLakePipelines-runs` - Data Lake pipelines runs. +* :ref:`atlas-dataLakePipelines-start` - Start the specified data lake pipeline for your project. +* :ref:`atlas-dataLakePipelines-trigger` - Trigger the specified data lake pipeline for your project. +* :ref:`atlas-dataLakePipelines-update` - Modify the details of the specified data lake pipeline for your project. +* :ref:`atlas-dataLakePipelines-watch` - Watch for the specified data lake pipeline to complete. + + +.. toctree:: + :titlesonly: + + availableSchedules </command/atlas-dataLakePipelines-availableSchedules> + availableSnapshots </command/atlas-dataLakePipelines-availableSnapshots> + create </command/atlas-dataLakePipelines-create> + datasets </command/atlas-dataLakePipelines-datasets> + delete </command/atlas-dataLakePipelines-delete> + describe </command/atlas-dataLakePipelines-describe> + list </command/atlas-dataLakePipelines-list> + pause </command/atlas-dataLakePipelines-pause> + runs </command/atlas-dataLakePipelines-runs> + start </command/atlas-dataLakePipelines-start> + trigger </command/atlas-dataLakePipelines-trigger> + update </command/atlas-dataLakePipelines-update> + watch </command/atlas-dataLakePipelines-watch> + diff --git a/source/command/atlas-dbusers-certs-create.txt b/source/command/atlas-dbusers-certs-create.txt new file mode 100644 index 00000000..52422d10 --- /dev/null +++ b/source/command/atlas-dbusers-certs-create.txt @@ -0,0 +1,96 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers-certs-create: + +========================== +atlas dbusers certs create +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new Atlas-managed X.509 certificate for the specified database user. + +The user you specify must authenticate using X.509 certificates. You can't use this command to create certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers certs create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - --monthsUntilExpiration + - int + - false + - Number of months until the X.509 certificate expires. This value defaults to 3. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --username + - string + - true + - Username of a database user. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + <> + + +Examples +-------- + +.. code-block:: + + # Create an Atlas-managed X.509 certificate that expires in 5 months for a MongoDB user named dbuser for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers certs create --username dbuser --monthsUntilExpiration 5 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-dbusers-certs-list.txt b/source/command/atlas-dbusers-certs-list.txt new file mode 100644 index 00000000..728b3891 --- /dev/null +++ b/source/command/atlas-dbusers-certs-list.txt @@ -0,0 +1,96 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers-certs-list: + +======================== +atlas dbusers certs list +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all Atlas-managed, unexpired X.509 certificates for the specified database user. + +You can't use this command to return certificates if you are managing your own Certificate Authority (CA) in self-managed X.509 mode. + +The user you specify must authenticate using X.509 certificates. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers certs list <username> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - username + - string + - true + - Username of the database user for whom you want to list Atlas-managed certificates. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all Atlas-managed X.509 certificates for a MongoDB user named dbuser for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers certs list dbuser --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-dbusers-certs.txt b/source/command/atlas-dbusers-certs.txt new file mode 100644 index 00000000..09bb1bef --- /dev/null +++ b/source/command/atlas-dbusers-certs.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers-certs: + +=================== +atlas dbusers certs +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas x509 certificates for your database users. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for certs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dbusers-certs-create` - Create a new Atlas-managed X.509 certificate for the specified database user. +* :ref:`atlas-dbusers-certs-list` - Return all Atlas-managed, unexpired X.509 certificates for the specified database user. + + +.. toctree:: + :titlesonly: + + create </command/atlas-dbusers-certs-create> + list </command/atlas-dbusers-certs-list> + diff --git a/source/command/atlas-dbusers-create.txt b/source/command/atlas-dbusers-create.txt new file mode 100644 index 00000000..8cf08c4b --- /dev/null +++ b/source/command/atlas-dbusers-create.txt @@ -0,0 +1,173 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers-create: + +==================== +atlas dbusers create +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a database user for your project. + +If you set --ldapType, --x509Type, --oidcType and --awsIAMType to NONE, Atlas authenticates this user through SCRAM-SHA. To learn more, see https://www.mongodb.com/docs/manual/core/security-scram/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers create [builtInRole]... [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - builtInRole + - string + - false + - Atlas built-in role that you want to assign to the user. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --awsIAMType + - string + - false + - AWS IAM method by which the provided username is authenticated. Valid values are NONE, USER, or ROLE. If you set this to USER or ROLE, the user authenticates with IAM credentials and doesn't need a password. + + Mutually exclusive with --ldapType, --x509Type, --oidcType. This value defaults to "NONE". + * - --deleteAfter + - string + - false + - Timestamp in ISO 8601 in UTC after which Atlas deletes the user. + * - -h, --help + - + - false + - help for create + * - --ldapType + - string + - false + - LDAP method by which the provided username is authenticated. Valid values are NONE, USER, or GROUP. If you set this to USER or GROUP, the user authenticates with LDAP. + + Mutually exclusive with --awsIAMType, --x509Type, --oidcType. This value defaults to "NONE". + * - --oidcType + - string + - false + - OIDC method by which the provided database user is authenticated. Valid values are NONE, USER, or IDP_GROUP. If you set this to USER or GROUP_ID, the user authenticates with OIDC. + + Mutually exclusive with --awsIAMType, --ldapType, --x509Type, --password. This value defaults to "NONE". + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - -p, --password + - string + - false + - Password for the database user. + + Mutually exclusive with --oidcType. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - false + - Comma-separated list that specifies the user's roles and the databases or collections on which the roles apply. + The roles format is roleName[@dbName[.collection]]. + roleName can either be a built-in role or a custom role. + dbName and collection are required only for built-in roles. + * - --scope + - strings + - false + - Array of clusters and Atlas Data Lakes that this user has access to. + * - -u, --username + - string + - true + - Username for authenticating to MongoDB. + * - --x509Type + - string + - false + - X.509 method for authenticating the specified username. Valid values include NONE, MANAGED, and CUSTOMER. If you set this to MANAGED the user authenticates with an Atlas-managed X.509 certificate. If you set this to CUSTOMER, the user authenticates with a self-managed X.509 certificate. + + Mutually exclusive with --awsIAMType, --ldapType, --oidcType. This value defaults to "NONE". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Database user '<Username>' successfully created. + + +Examples +-------- + +.. code-block:: + + # Create an Atlas database admin user named myAdmin for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers create atlasAdmin --username myAdmin --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + + # Create a database user named myUser with read/write access to any database for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers create readWriteAnyDatabase --username myUser --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + + # Create a database user named myUser with multiple roles for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers create --username myUser --role clusterMonitor,backup --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + + # Create a database user named myUser with multiple scopes for the project with ID 5e2211c17a3e5a48f5497de3: + atlas dbusers create --username myUser --role clusterMonitor --scope <REPLICA-SET ID>,<storeName> --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-dbusers-delete.txt b/source/command/atlas-dbusers-delete.txt new file mode 100644 index 00000000..12a551b7 --- /dev/null +++ b/source/command/atlas-dbusers-delete.txt @@ -0,0 +1,120 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers-delete: + +==================== +atlas dbusers delete +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified database user from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers delete <username> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - username + - string + - true + - Username to delete from the MongoDB database. The format of the username depends on the user's method of authentication. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authDB + - string + - false + - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. This value defaults to "admin". + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DB user '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Delete the SCRAM SHA-authenticating database user named dylan for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas dbusers delete dylan --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + + # Delete the AWS IAM-authenticating database user with the ARN arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs for the project with ID 5e2211c17a3e5a48f5497de3. Prepend $external with \ to escape the special-use character: + atlas dbusers delete arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs --authDB \$external --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + + # Delete the xLDAP-authenticating database user with the RFC 2253 Distinguished Name CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM for the project with ID 5e2211c17a3e5a48f5497de3. Prepend $external with \ to escape the special-use character: + atlas dbusers delete CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM --authDB \$external --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-dbusers-describe.txt b/source/command/atlas-dbusers-describe.txt new file mode 100644 index 00000000..8cc28e8e --- /dev/null +++ b/source/command/atlas-dbusers-describe.txt @@ -0,0 +1,121 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers-describe: + +====================== +atlas dbusers describe +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified database user for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers describe <username> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - username + - string + - true + - Username to retrieve from the MongoDB database. The format of the username depends on the user's method of authentication. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authDB + - string + - false + - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. This value defaults to "admin". + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + USERNAME DATABASE + <Username> <DatabaseName> + + +Examples +-------- + +.. code-block:: + + # Return the details for the SCRAM SHA-authenticating database user named myDbUser: + atlas dbuser describe myDbUser --authDB admin --output json + + +.. code-block:: + + # Return the details for the AWS IAM-authenticating database user with the ARN arn:aws:iam::772401394250:user/my-test-user. Prepend $external with \ to escape the special-use character: + atlas dbuser describe arn:aws:iam::772401394250:user/my-test-user --authDB \$external --output json + + +.. code-block:: + + # Return the details for the X.509-authenticating database user with the RFC 2253 Distinguished Name CN=ellen@example.com,OU=users,DC=example,DC=com. Prepend $external with \ to escape the special-use character: + atlas dbuser describe CN=ellen@example.com,OU=users,DC=example,DC=com --authDB \$external --output json diff --git a/source/command/atlas-dbusers-list.txt b/source/command/atlas-dbusers-list.txt new file mode 100644 index 00000000..31035ef2 --- /dev/null +++ b/source/command/atlas-dbusers-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers-list: + +================== +atlas dbusers list +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all database users for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all database users for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas dbusers list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-dbusers-update.txt b/source/command/atlas-dbusers-update.txt new file mode 100644 index 00000000..bf60c00d --- /dev/null +++ b/source/command/atlas-dbusers-update.txt @@ -0,0 +1,134 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers-update: + +==================== +atlas dbusers update +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the details of a database user in your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas dbusers update <username> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - username + - string + - true + - Username to update in the MongoDB database. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authDB + - string + - false + - Authentication database name. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - -p, --password + - string + - false + - Password for the database user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - false + - User's roles and the databases or collections on which the roles apply. Passing this flag replaces preexisting data. + * - --scope + - strings + - false + - Array of clusters and Atlas Data Lakes that this user has access to. Passing this flag replaces preexisting data. + * - -u, --username + - string + - false + - Username for authenticating to MongoDB. + * - --x509Type + - string + - false + - X.509 method for authenticating the specified username. Valid values include NONE, MANAGED, and CUSTOMER. If you set this to MANAGED the user authenticates with an Atlas-managed X.509 certificate. If you set this to CUSTOMER, the user authenticates with a self-managed X.509 certificate. This value defaults to "NONE". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Successfully updated database user '<Username>'. + + +Examples +-------- + +.. code-block:: + + # Update roles for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas dbuser update myUser --role readWriteAnyDatabase --projectId 5e2211c17a3e5a48f5497de3 + + +.. code-block:: + + # Update scopes for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas dbuser update myUser --scope resourceName:resourceType --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-dbusers.txt b/source/command/atlas-dbusers.txt new file mode 100644 index 00000000..41c9732f --- /dev/null +++ b/source/command/atlas-dbusers.txt @@ -0,0 +1,76 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-dbusers: + +============= +atlas dbusers +============= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage database users for your project. + +The dbusers command retrieves, creates and modifies the MongoDB database users in your project. +Each user has a set of roles that provide access to the project’s databases. +A user’s roles apply to all the clusters in the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for dbusers + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-dbusers-certs` - Manage Atlas x509 certificates for your database users. +* :ref:`atlas-dbusers-create` - Create a database user for your project. +* :ref:`atlas-dbusers-delete` - Remove the specified database user from your project. +* :ref:`atlas-dbusers-describe` - Return the details for the specified database user for your project. +* :ref:`atlas-dbusers-list` - Return all database users for your project. +* :ref:`atlas-dbusers-update` - Modify the details of a database user in your project. + + +.. toctree:: + :titlesonly: + + certs </command/atlas-dbusers-certs> + create </command/atlas-dbusers-create> + delete </command/atlas-dbusers-delete> + describe </command/atlas-dbusers-describe> + list </command/atlas-dbusers-list> + update </command/atlas-dbusers-update> + diff --git a/source/command/atlas-deployments-connect.txt b/source/command/atlas-deployments-connect.txt new file mode 100644 index 00000000..4c1069f9 --- /dev/null +++ b/source/command/atlas-deployments-connect.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-connect: + +========================= +atlas deployments connect +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments connect [deploymentName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - false + - Name of the deployment that you want to connect to. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --connectWith + - string + - false + - Method for connecting to the deployment. Valid values are mongosh, compass, and skip. + * - --connectionStringType + - string + - false + - Type of connection string. If you specify 'private', this option retrieves the connection string for the network peering endpoint. If you specify 'privateEndpoint', this option retrieves the shard optimized connection strings for the private endpoints. This value defaults to "standard". + * - -h, --help + - + - false + - help for connect + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-deployments-delete.txt b/source/command/atlas-deployments-delete.txt new file mode 100644 index 00000000..52a04987 --- /dev/null +++ b/source/command/atlas-deployments-delete.txt @@ -0,0 +1,133 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-delete: + +======================== +atlas deployments delete +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a deployment. + +The command prompts you to confirm the operation when you run the command without the --force option. + +Deleting an Atlas deployment also deletes any backup snapshots for that cluster. +Deleting a Local deployment also deletes any local data volumes. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments delete [deploymentName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - false + - Name of the deployment that you want to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. + * - --watchTimeout + - uint + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Deployment '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove an Atlas deployment named myDeployment after prompting for a confirmation: + atlas deployments delete myDeployment --type ATLAS + + +.. code-block:: + + # Remove an Atlas deployment named myDeployment without requiring confirmation: + atlas deployments delete myDeployment --type ATLAS --force + + +.. code-block:: + + # Remove an Local deployment named myDeployment without requiring confirmation: + atlas deployments delete myDeployment --type LOCAL --force diff --git a/source/command/atlas-deployments-list.txt b/source/command/atlas-deployments-list.txt new file mode 100644 index 00000000..dadc0655 --- /dev/null +++ b/source/command/atlas-deployments-list.txt @@ -0,0 +1,76 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-list: + +====================== +atlas deployments list +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all deployments. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + NAME TYPE MDB VER STATE + <Name> <Type> <MongoDBVersion> <StateName> + + diff --git a/source/command/atlas-deployments-logs.txt b/source/command/atlas-deployments-logs.txt new file mode 100644 index 00000000..be0a642b --- /dev/null +++ b/source/command/atlas-deployments-logs.txt @@ -0,0 +1,97 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-logs: + +====================== +atlas deployments logs +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get deployment logs. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments logs [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --deploymentName + - string + - false + - Name of the deployment. + * - --end + - int + - false + - UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp. + * - --force + - + - false + - Flag that indicates whether to overwrite the destination file. + * - -h, --help + - + - false + - help for logs + * - --hostname + - string + - false + - Name of the host that stores the log files that you want to download. + * - --name + - string + - false + - Name of the log file (e.g. mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz). + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - int + - false + - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-deployments-pause.txt b/source/command/atlas-deployments-pause.txt new file mode 100644 index 00000000..c5acd131 --- /dev/null +++ b/source/command/atlas-deployments-pause.txt @@ -0,0 +1,95 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-pause: + +======================= +atlas deployments pause +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Pause a deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments pause <deploymentName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - true + - Name of the deployment. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for pause + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Pausing deployment '<Name>'. + + diff --git a/source/command/atlas-deployments-search-indexes-create.txt b/source/command/atlas-deployments-search-indexes-create.txt new file mode 100644 index 00000000..361e4604 --- /dev/null +++ b/source/command/atlas-deployments-search-indexes-create.txt @@ -0,0 +1,127 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-search-indexes-create: + +======================================= +atlas deployments search indexes create +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a search index for the specified deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments search indexes create [indexName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexName + - string + - false + - Name of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --collection + - string + - false + - Name of the collection. + + Mutually exclusive with --file. + * - --db + - string + - false + - Name of the database. + + Mutually exclusive with --file. + * - --deploymentName + - string + - false + - Name of the deployment. + * - -f, --file + - string + - false + - Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs. + + Mutually exclusive with --db, --collection. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + * - -w, --watch + - + - false + - Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option. + * - --watchTimeout + - uint + - false + - Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-deployments-search-indexes-delete.txt b/source/command/atlas-deployments-search-indexes-delete.txt new file mode 100644 index 00000000..ecbfbb4c --- /dev/null +++ b/source/command/atlas-deployments-search-indexes-delete.txt @@ -0,0 +1,114 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-search-indexes-delete: + +======================================= +atlas deployments search indexes delete +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete the specified search index from the specified deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments search indexes delete <indexId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - true + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --deploymentName + - string + - false + - Name of the deployment. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Index '<Name>' deleted + diff --git a/source/command/atlas-deployments-search-indexes-describe.txt b/source/command/atlas-deployments-search-indexes-describe.txt new file mode 100644 index 00000000..ff0c9788 --- /dev/null +++ b/source/command/atlas-deployments-search-indexes-describe.txt @@ -0,0 +1,112 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-search-indexes-describe: + +========================================= +atlas deployments search indexes describe +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a search index for the specified deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments search indexes describe [indexId] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - indexId + - string + - false + - ID of the index. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --deploymentName + - string + - false + - Name of the deployment. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME DATABASE COLLECTION STATUS TYPE + <IndexID> <Name> <Database> <CollectionName> <Status> <Type> + + diff --git a/source/command/atlas-deployments-search-indexes-list.txt b/source/command/atlas-deployments-search-indexes-list.txt new file mode 100644 index 00000000..bf347b7a --- /dev/null +++ b/source/command/atlas-deployments-search-indexes-list.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-search-indexes-list: + +===================================== +atlas deployments search indexes list +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List all Atlas Search indexes for a deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments search indexes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --collection + - string + - false + - Name of the collection. + * - --db + - string + - false + - Name of the database. + * - --deploymentName + - string + - false + - Name of the deployment. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME DATABASE COLLECTION STATUS TYPE + <IndexID> <Name> <Database> <CollectionName> <Status> <Type> + + diff --git a/source/command/atlas-deployments-search-indexes.txt b/source/command/atlas-deployments-search-indexes.txt new file mode 100644 index 00000000..5f5fc600 --- /dev/null +++ b/source/command/atlas-deployments-search-indexes.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-search-indexes: + +================================ +atlas deployments search indexes +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud and local search indexes. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for indexes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-deployments-search-indexes-create` - Create a search index for the specified deployment. +* :ref:`atlas-deployments-search-indexes-delete` - Delete the specified search index from the specified deployment. +* :ref:`atlas-deployments-search-indexes-describe` - Describe a search index for the specified deployment. +* :ref:`atlas-deployments-search-indexes-list` - List all Atlas Search indexes for a deployment. + + +.. toctree:: + :titlesonly: + + create </command/atlas-deployments-search-indexes-create> + delete </command/atlas-deployments-search-indexes-delete> + describe </command/atlas-deployments-search-indexes-describe> + list </command/atlas-deployments-search-indexes-list> + diff --git a/source/command/atlas-deployments-search.txt b/source/command/atlas-deployments-search.txt new file mode 100644 index 00000000..26ba6473 --- /dev/null +++ b/source/command/atlas-deployments-search.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-search: + +======================== +atlas deployments search +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage search for cloud and local deployments. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for search + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-deployments-search-indexes` - Manage cloud and local search indexes. + + +.. toctree:: + :titlesonly: + + indexes </command/atlas-deployments-search-indexes> + diff --git a/source/command/atlas-deployments-setup.txt b/source/command/atlas-deployments-setup.txt new file mode 100644 index 00000000..410fbf29 --- /dev/null +++ b/source/command/atlas-deployments-setup.txt @@ -0,0 +1,153 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-setup: + +======================= +atlas deployments setup +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a local deployment. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments setup [deploymentName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - false + - Name of the deployment that you want to set up. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --accessListIp + - strings + - false + - IP address to grant access to the deployment. + + Mutually exclusive with --currentIp. + * - --bindIpAll + - + - false + - Flag that indicates whether the LOCAL deployment port binding should happen for all IPs or only for the localhost interface 127.0.0.1. + * - --connectWith + - string + - false + - Method for connecting to the deployment. Valid values are mongosh, compass, and skip. + * - --currentIp + - + - false + - Flag that adds the IP address from the host that is currently executing the command to the access list. + + Mutually exclusive with --accessListIp. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your deployment. You can't delete a deployment with termination protection enabled. + * - --force + - + - false + - Flag that indicates whether to skip the request for input and create a deployment with the default settings for any unspecified options. + * - -h, --help + - + - false + - help for setup + * - --mdbVersion + - string + - false + - Major MongoDB version of the deployment. + * - --password + - string + - false + - Password for the user. + * - --port + - int + - false + - Port that the MongoDB server listens to for client connections. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. + * - -r, --region + - string + - false + - Physical location of your MongoDB deployment. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + * - --skipMongosh + - + - false + - Flag that indicates whether to skip accessing your deployment with MongoDB Shell. + * - --skipSampleData + - + - false + - Flag that indicates whether to skip loading sample data into your MongoDB deployment. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the deployment. + * - --tier + - string + - false + - Tier for each data-bearing server in the deployment. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. This value defaults to "M0". + * - --type + - string + - false + - Type of deployment that you want to create. Valid values are ATLAS or LOCAL. + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-deployments-start.txt b/source/command/atlas-deployments-start.txt new file mode 100644 index 00000000..d16c67f3 --- /dev/null +++ b/source/command/atlas-deployments-start.txt @@ -0,0 +1,98 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments-start: + +======================= +atlas deployments start +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start a deployment. + +After you stop a machine, it goes into sleep mode, or restarts. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas deployments start <deploymentName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - deploymentName + - string + - true + - Name of the deployment. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for start + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - string + - false + - Type of deployment. Valid values are ATLAS or LOCAL. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Starting deployment '<Name>'. + + diff --git a/source/command/atlas-deployments.txt b/source/command/atlas-deployments.txt new file mode 100644 index 00000000..d871cbaf --- /dev/null +++ b/source/command/atlas-deployments.txt @@ -0,0 +1,76 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-deployments: + +================= +atlas deployments +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud and local deployments. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for deployments + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-deployments-connect` - Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first. +* :ref:`atlas-deployments-delete` - Delete a deployment. +* :ref:`atlas-deployments-list` - Return all deployments. +* :ref:`atlas-deployments-logs` - Get deployment logs. +* :ref:`atlas-deployments-pause` - Pause a deployment. +* :ref:`atlas-deployments-search` - Manage search for cloud and local deployments. +* :ref:`atlas-deployments-setup` - Create a local deployment. +* :ref:`atlas-deployments-start` - Start a deployment. + + +.. toctree:: + :titlesonly: + + connect </command/atlas-deployments-connect> + delete </command/atlas-deployments-delete> + list </command/atlas-deployments-list> + logs </command/atlas-deployments-logs> + pause </command/atlas-deployments-pause> + search </command/atlas-deployments-search> + setup </command/atlas-deployments-setup> + start </command/atlas-deployments-start> + diff --git a/source/command/atlas-events-organizations-list.txt b/source/command/atlas-events-organizations-list.txt new file mode 100644 index 00000000..23e9da20 --- /dev/null +++ b/source/command/atlas-events-organizations-list.txt @@ -0,0 +1,100 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-events-organizations-list: + +=============================== +atlas events organizations list +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all events for the specified organization. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas events organizations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --maxDate + - string + - false + - Maximum created date. This option returns events whose created date is less than or equal to the specified value. + * - --minDate + - string + - false + - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --type + - strings + - false + - Type of event that triggered the alert. To learn which values the CLI accepts, see the Enum for eventTypeName in the Atlas Admin API spec: https://dochub.mongodb.org/core/atlas-event-names. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of events for the organization with the ID 5dd5a6b6f10fab1d71a58495: + atlas events organizations list --orgId 5dd5a6b6f10fab1d71a58495 --output json diff --git a/source/command/atlas-events-organizations.txt b/source/command/atlas-events-organizations.txt new file mode 100644 index 00000000..f3e0437b --- /dev/null +++ b/source/command/atlas-events-organizations.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-events-organizations: + +========================== +atlas events organizations +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Organization operations. + +List organization events. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for organizations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-events-organizations-list` - Return all events for the specified organization. + + +.. toctree:: + :titlesonly: + + list </command/atlas-events-organizations-list> + diff --git a/source/command/atlas-events-projects-list.txt b/source/command/atlas-events-projects-list.txt new file mode 100644 index 00000000..3830628c --- /dev/null +++ b/source/command/atlas-events-projects-list.txt @@ -0,0 +1,100 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-events-projects-list: + +========================== +atlas events projects list +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all events for the specified project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas events projects list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --maxDate + - string + - false + - Maximum created date. This option returns events whose created date is less than or equal to the specified value. + * - --minDate + - string + - false + - Minimum created date. This option returns events whose created date is greater than or equal to the specified value. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --type + - strings + - false + - Type of event that triggered the alert. To learn which values the CLI accepts, see the Enum for eventTypeName in the Atlas Admin API spec: https://dochub.mongodb.org/core/atlas-event-names. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of events for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas events projects list --Id 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-events-projects.txt b/source/command/atlas-events-projects.txt new file mode 100644 index 00000000..7a4ac94f --- /dev/null +++ b/source/command/atlas-events-projects.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-events-projects: + +===================== +atlas events projects +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Project operations. + +List projects events. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for projects + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-events-projects-list` - Return all events for the specified project. + + +.. toctree:: + :titlesonly: + + list </command/atlas-events-projects-list> + diff --git a/source/command/atlas-events.txt b/source/command/atlas-events.txt new file mode 100644 index 00000000..11e890a5 --- /dev/null +++ b/source/command/atlas-events.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-events: + +============ +atlas events +============ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage events for your organization or project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for events + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-events-organizations` - Organization operations. +* :ref:`atlas-events-projects` - Project operations. + + +.. toctree:: + :titlesonly: + + organizations </command/atlas-events-organizations> + projects </command/atlas-events-projects> + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt new file mode 100644 index 00000000..56597411 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect: + +============================================================================ +atlas federatedAuthentication federationSettings connectedOrgConfigs connect +============================================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Connect an Identity Provider to an Organization. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs connect [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - -h, --help + - + - false + - help for connect + * - --identityProviderId + - string + - true + - Unique identifier of the identity provider. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --protocol + - string + - false + - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Connect the current profile org to identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgs connect --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + +.. code-block:: + + # Connect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgs connect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt new file mode 100644 index 00000000..770f6a25 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete.txt @@ -0,0 +1,90 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete: + +=========================================================================== +atlas federatedAuthentication federationSettings connectedOrgConfigs delete +=========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a connected org config Organization. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Delete a connected org config from the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgs delete --federationSettingsId 5d1113b25a115342acc2d1aa + +.. code-block:: + + # Delete a connected org config from the org with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgs connect --orgId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt new file mode 100644 index 00000000..3a88fa6d --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe.txt @@ -0,0 +1,86 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe: + +============================================================================= +atlas federatedAuthentication federationSettings connectedOrgConfigs describe +============================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a Connected Org Config. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - -h, --help + - + - false + - help for describe + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Describe a connected org config with the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgsConfig connect --federationSettingsId 5d1113b25a115342acc2d1aa + +.. code-block:: + + # Describe a connected org config with the org with ID 7d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgs connect --orgId 7d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt new file mode 100644 index 00000000..1f5c2a3a --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect.txt @@ -0,0 +1,103 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect: + +=============================================================================== +atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect +=============================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Connect an Identity Provider to an Organization. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs disconnect [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - -h, --help + - + - false + - help for disconnect + * - --identityProviderId + - string + - true + - Unique identifier of the identity provider. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --protocol + - string + - false + - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Org Configs disconnected. + +Examples +-------- + +.. code-block:: + + # Disconnect the current profile org from identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgs disconnect --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + +.. code-block:: + + # Connect the org with ID 7d1113b25a115342acc2d1aa to identity provider with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgs disconnect --orgId 7d1113b25a115342acc2d1aa --identityProviderId 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt new file mode 100644 index 00000000..64c5f7a0 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list: + +========================================================================= +atlas federatedAuthentication federationSettings connectedOrgConfigs list +========================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a Connected Org Config. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # List all connected org config with federationSettingsId 5d1113b25a115342acc2d1aa + atlas federatedAuthentication connectedOrgsConfig list --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt new file mode 100644 index 00000000..0a599f1f --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt @@ -0,0 +1,85 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update: + +=========================================================================== +atlas federatedAuthentication federationSettings connectedOrgConfigs update +=========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update One Org Config Connected to One Federation Setting. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings connectedOrgConfigs update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - --file + - string + - true + - Path to a JSON configuration file that defines connected orgs configurations. To learn more about connected org configuration file format, see the request body in https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig. + * - -h, --help + - + - false + - help for update + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Update the connected orgs config the current profile org and federationSettingsId 5d1113b25a115342acc2d1aa using the JSON configuration file config.json + atlas federatedAuthentication connectedOrgs update --federationSettingsId 5d1113b25a115342acc2d1aa --file config.json + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt new file mode 100644 index 00000000..243a4b0e --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-connectedOrgConfigs: + +==================================================================== +atlas federatedAuthentication federationSettings connectedOrgConfigs +==================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Federated Authentication Connected Orgs Config + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for connectedOrgConfigs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect` - Connect an Identity Provider to an Organization. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete` - Delete a connected org config Organization. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe` - Describe a Connected Org Config. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect` - Connect an Identity Provider to an Organization. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list` - Describe a Connected Org Config. +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update` - Update One Org Config Connected to One Federation Setting. + + +.. toctree:: + :titlesonly: + + connect </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-connect> + delete </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-delete> + describe </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-describe> + disconnect </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-disconnect> + list </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-list> + update </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update> + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-describe.txt b/source/command/atlas-federatedAuthentication-federationSettings-describe.txt new file mode 100644 index 00000000..34d864c9 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-describe.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-describe: + +========================================================= +atlas federatedAuthentication federationSettings describe +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the Federation Settings details for the specified organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID IDENTITY PROVIDER ID IDENTITY PROVIDER STATUS + <Id> <IdentityProviderId> <IdentityProviderStatus> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted Federation Settings details: + atlas federatedAuthentication federationSettings describe --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt new file mode 100644 index 00000000..5965b9c1 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc.txt @@ -0,0 +1,135 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc: + +============================================================================= +atlas federatedAuthentication federationSettings identityProvider create oidc +============================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an OIDC identity provider. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider create oidc [displayName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - displayName + - string + - false + - The Identity Provider display name. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --associatedDomain + - strings + - false + - List of domains associated with the Identity Provider. + * - --audience + - string + - true + - Identifier of the intended recipient of the token. + * - --authorizationType + - string + - true + - Type of authorization. Valid values are NONE, JWT, or SAML. + * - --clientId + - string + - false + - Client identifier that is assigned to an application by the Identity Provider. + * - --desc + - string + - true + - Description of the Identity Provider. + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - --groupsClaim + - string + - true + - Identifier of the claim which contains IdP Group IDs in the token. + * - -h, --help + - + - false + - help for oidc + * - --idpType + - string + - true + - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. + * - --issuerUri + - string + - true + - Unique string that identifies the issuer of the OIDC metadata/discovery document URL. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --requestedScope + - strings + - false + - Scopes that MongoDB applications will request from the authorization endpoint. + * - --userClaim + - string + - true + - Identifier of the claim which contains the user ID in the token. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Identity provider '<Id>' created. + + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt new file mode 100644 index 00000000..665fe02b --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-create.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider-create: + +======================================================================== +atlas federatedAuthentication federationSettings identityProvider create +======================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create Federated Authentication Identity Providers. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc` - Create an OIDC identity provider. + + +.. toctree:: + :titlesonly: + + oidc </command/atlas-federatedAuthentication-federationSettings-identityProvider-create-oidc> + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt new file mode 100644 index 00000000..205b0109 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-delete.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider-delete: + +======================================================================== +atlas federatedAuthentication federationSettings identityProvider delete +======================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified identity provider from your federation settings. + +To use this command, you must authenticate with a user account or an API key with the Org Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider delete <identityProviderId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - identityProviderId + - string + - true + - ID of the identityProvider. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Identity provider '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Delete the specified identity provider from your federation settings with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa. + atlas federatedAuthentication identityProvider delete 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt new file mode 100644 index 00000000..269d20be --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-describe.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider-describe: + +========================================================================== +atlas federatedAuthentication federationSettings identityProvider describe +========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe the specified identity provider from your federation settings. + +To use this command, you must authenticate with a user account or an API key with the Org Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider describe <identityProviderId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - identityProviderId + - string + - true + - ID of the identityProvider. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE + <Id> <DisplayName> <IssuerUri> <ClientId> <IdpType> + + +Examples +-------- + +.. code-block:: + + # Describe the specified identity provider from your federation settings with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa. + atlas federatedAuthentication identityProvider describe 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt new file mode 100644 index 00000000..1defefb5 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-list.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider-list: + +====================================================================== +atlas federatedAuthentication federationSettings identityProvider list +====================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List the identity providers from your federation settings. + +To use this command, you must authenticate with a user account or an API key with the Org Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - -h, --help + - + - false + - help for list + * - --idpType + - string + - false + - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. This value defaults to "WORKFORCE". + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --protocol + - string + - false + - Protocol used to authenticate the user. Valid value is OIDC or SAML. This value defaults to "OIDC". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE + <Id> <DisplayName> <IssuerUri> <ClientId> <IdpType> + + +Examples +-------- + +.. code-block:: + + # List the identity providers from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa and idpType WORKLOAD + atlas federatedAuthentication identityProvider list --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKLOAD + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt new file mode 100644 index 00000000..c0559075 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk.txt @@ -0,0 +1,95 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk: + +=========================================================================== +atlas federatedAuthentication federationSettings identityProvider revokeJwk +=========================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Revoke the JWK token from the specified identity provider from your federation settings. + +To use this command, you must authenticate with a user account or an API key with the Org Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider revokeJwk <identityProviderId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - identityProviderId + - string + - true + - ID of the identityProvider. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - -h, --help + - + - false + - help for revokeJwk + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Revoke the Jwk from the specified identity provider from your federation settings with ID 5d1113b25a115342acc2d1aa and federationSettingsId 5d1113b25a115342acc2d1aa. + atlas federatedAuthentication identityProvider revokeJwk 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt new file mode 100644 index 00000000..8160a75a --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc.txt @@ -0,0 +1,143 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc: + +============================================================================= +atlas federatedAuthentication federationSettings identityProvider update oidc +============================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update an OIDC identity provider. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas federatedAuthentication federationSettings identityProvider update oidc [identityProviderId] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - identityProviderId + - string + - false + - The Identity Provider ID. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --associatedDomain + - strings + - false + - List of domains associated with the Identity Provider. + * - --audience + - string + - false + - Identifier of the intended recipient of the token. + * - --authorizationType + - string + - false + - Type of authorization. Valid values are NONE, JWT, or SAML. + * - --clientId + - string + - false + - Client identifier that is assigned to an application by the Identity Provider. + * - --desc + - string + - false + - Description of the Identity Provider. + * - --federationSettingsId + - string + - true + - Unique identifier of the federation settings. + * - --groupsClaim + - string + - false + - Identifier of the claim which contains IdP Group IDs in the token. + * - -h, --help + - + - false + - help for oidc + * - --idpType + - string + - true + - Type of Identity Provider. Valid values are WORKFORCE or WORKLOAD. + * - --issuerUri + - string + - false + - Unique string that identifies the issuer of the OIDC metadata/discovery document URL. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --requestedScope + - strings + - false + - Scopes that MongoDB applications will request from the authorization endpoint. + * - --userClaim + - string + - false + - Identifier of the claim which contains the user ID in the token. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Identity provider '<Id>' updated. + + +Examples +-------- + +.. code-block:: + + # Update the audience for the specified identity provider from your federation settings with ID 5d1113b25a115342acc2d1aa, federationSettingsId 5d1113b25a115342acc2d1aa and IdpType WORKFORCE + atlas federatedAuthentication identityProvider update 5d1113b25a115342acc2d1aa --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKFORCE --audience newAudience + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt new file mode 100644 index 00000000..fcd5b783 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider-update.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider-update: + +======================================================================== +atlas federatedAuthentication federationSettings identityProvider update +======================================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update Federated Authentication Identity Providers. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for update + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc` - Update an OIDC identity provider. + + +.. toctree:: + :titlesonly: + + oidc </command/atlas-federatedAuthentication-federationSettings-identityProvider-update-oidc> + diff --git a/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt new file mode 100644 index 00000000..022c5150 --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings-identityProvider.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings-identityProvider: + +================================================================= +atlas federatedAuthentication federationSettings identityProvider +================================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Federated Authentication Identity Providers. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for identityProvider + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-create` - Create Federated Authentication Identity Providers. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-delete` - Remove the specified identity provider from your federation settings. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-describe` - Describe the specified identity provider from your federation settings. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-list` - List the identity providers from your federation settings. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk` - Revoke the JWK token from the specified identity provider from your federation settings. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider-update` - Update Federated Authentication Identity Providers. + + +.. toctree:: + :titlesonly: + + create </command/atlas-federatedAuthentication-federationSettings-identityProvider-create> + delete </command/atlas-federatedAuthentication-federationSettings-identityProvider-delete> + describe </command/atlas-federatedAuthentication-federationSettings-identityProvider-describe> + list </command/atlas-federatedAuthentication-federationSettings-identityProvider-list> + revokeJwk </command/atlas-federatedAuthentication-federationSettings-identityProvider-revokeJwk> + update </command/atlas-federatedAuthentication-federationSettings-identityProvider-update> + diff --git a/source/command/atlas-federatedAuthentication-federationSettings.txt b/source/command/atlas-federatedAuthentication-federationSettings.txt new file mode 100644 index 00000000..bcea6f4c --- /dev/null +++ b/source/command/atlas-federatedAuthentication-federationSettings.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication-federationSettings: + +================================================ +atlas federatedAuthentication federationSettings +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Federated Authentication Federation Settings + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for federationSettings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs` - Manage Atlas Federated Authentication Connected Orgs Config +* :ref:`atlas-federatedAuthentication-federationSettings-describe` - Return the Federation Settings details for the specified organization. +* :ref:`atlas-federatedAuthentication-federationSettings-identityProvider` - Manage Federated Authentication Identity Providers. + + +.. toctree:: + :titlesonly: + + connectedOrgConfigs </command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs> + describe </command/atlas-federatedAuthentication-federationSettings-describe> + identityProvider </command/atlas-federatedAuthentication-federationSettings-identityProvider> + diff --git a/source/command/atlas-federatedAuthentication.txt b/source/command/atlas-federatedAuthentication.txt new file mode 100644 index 00000000..500b1012 --- /dev/null +++ b/source/command/atlas-federatedAuthentication.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-federatedAuthentication: + +============================= +atlas federatedAuthentication +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Federated Authentication. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for federatedAuthentication + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-federatedAuthentication-federationSettings` - Manage Atlas Federated Authentication Federation Settings + + +.. toctree:: + :titlesonly: + + federationSettings </command/atlas-federatedAuthentication-federationSettings> + diff --git a/source/command/atlas-integrations-create-DATADOG.txt b/source/command/atlas-integrations-create-DATADOG.txt new file mode 100644 index 00000000..26debbc5 --- /dev/null +++ b/source/command/atlas-integrations-create-DATADOG.txt @@ -0,0 +1,102 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-create-DATADOG: + +================================= +atlas integrations create DATADOG +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update a Datadog integration for your project. + +The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Datadog. + +After you integrate with Datadog, you can send metric data about your project to your Datadog dashboard. To learn more about the metrics available to Datadog, see https://www.mongodb.com/docs/atlas/tutorial/datadog-integration/. + +Datadog integration is available only for M10+ clusters. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create DATADOG [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - true + - Datadog API key that allows Atlas to access your Datadog account. + * - -h, --help + - + - false + - help for DATADOG + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - false + - Code that indicates which regional URL MongoDB uses to access the Datadog API. Valid values are US, EU, US3, US5, and AP1. This value defaults to "US". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Datadog integration configured. + + +Examples +-------- + +.. code-block:: + + # Integrate Datadog with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create DATADOG --apiKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-integrations-create-OPS_GENIE.txt b/source/command/atlas-integrations-create-OPS_GENIE.txt new file mode 100644 index 00000000..6473949c --- /dev/null +++ b/source/command/atlas-integrations-create-OPS_GENIE.txt @@ -0,0 +1,98 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-create-OPS_GENIE: + +=================================== +atlas integrations create OPS_GENIE +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update an Opsgenie integration for your project. + +The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Opsgenie. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create OPS_GENIE [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - true + - Opsgenie API key that allows Atlas to access your Opsgenie account. + * - -h, --help + - + - false + - help for OPS_GENIE + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - false + - Code that indicates which regional URL MongoDB uses to access the third-party API. Valid values are US and EU. This value defaults to "US". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Ops Genie integration configured. + + +Examples +-------- + +.. code-block:: + + # Integrate Opsgenie with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create OPS_GENIE --apiKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-integrations-create-PAGER_DUTY.txt b/source/command/atlas-integrations-create-PAGER_DUTY.txt new file mode 100644 index 00000000..449fa4e7 --- /dev/null +++ b/source/command/atlas-integrations-create-PAGER_DUTY.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-create-PAGER_DUTY: + +==================================== +atlas integrations create PAGER_DUTY +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update a PagerDuty integration for your project. + +The requesting API key must have the Organization Owner or Project Owner role to configure an integration with PagerDuty. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create PAGER_DUTY [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for PAGER_DUTY + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --serviceKey + - string + - true + - Service key associated with your PagerDuty account. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Pager Duty integration configured. + + +Examples +-------- + +.. code-block:: + + # Integrate PagerDuty with Atlas for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create PAGER_DUTY --serviceKey a1a23bcdef45ghijk6789 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-integrations-create-VICTOR_OPS.txt b/source/command/atlas-integrations-create-VICTOR_OPS.txt new file mode 100644 index 00000000..b76f61e3 --- /dev/null +++ b/source/command/atlas-integrations-create-VICTOR_OPS.txt @@ -0,0 +1,100 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-create-VICTOR_OPS: + +==================================== +atlas integrations create VICTOR_OPS +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update a Splunk On-Call integration for your project. + +VictorOps is now Splunk On-Call. + +The requesting API key must have the Organization Owner or Project Owner role to configure an integration with Splunk On-Call. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create VICTOR_OPS [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - true + - Splunk On-Call API key that allows Atlas to access your Splunk On-Call account. + * - -h, --help + - + - false + - help for VICTOR_OPS + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --routingKey + - string + - true + - Routing key associated with your Splunk On-Call account. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Victor Ops integration configured. + + +Examples +-------- + +.. code-block:: + + # Integrate Splunk On-Call with Atlas using the routing key operations for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create VICTOR_OPS --apiKey a1a23bcdef45ghijk6789 --routingKey operations --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-integrations-create-WEBHOOK.txt b/source/command/atlas-integrations-create-WEBHOOK.txt new file mode 100644 index 00000000..34e2d9b9 --- /dev/null +++ b/source/command/atlas-integrations-create-WEBHOOK.txt @@ -0,0 +1,98 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-create-WEBHOOK: + +================================= +atlas integrations create WEBHOOK +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create or update a webhook integration for your project. + +The requesting API key must have the Organization Owner or Project Owner role to configure a webhook integration. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations create WEBHOOK [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for WEBHOOK + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --secret + - string + - true + - Secret that secures your webhook. + * - --url + - string + - true + - Endpoint web address to which Atlas sends notifications. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Webhook integration configured. + + +Examples +-------- + +.. code-block:: + + # Integrate a webhook with Atlas that uses the secret mySecret for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations create WEBHOOK --url http://9b4ac7aa.abc.io/payload --secret mySecret --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-integrations-create.txt b/source/command/atlas-integrations-create.txt new file mode 100644 index 00000000..52f11414 --- /dev/null +++ b/source/command/atlas-integrations-create.txt @@ -0,0 +1,70 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-create: + +========================= +atlas integrations create +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create operations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-integrations-create-DATADOG` - Create or update a Datadog integration for your project. +* :ref:`atlas-integrations-create-OPS_GENIE` - Create or update an Opsgenie integration for your project. +* :ref:`atlas-integrations-create-PAGER_DUTY` - Create or update a PagerDuty integration for your project. +* :ref:`atlas-integrations-create-VICTOR_OPS` - Create or update a Splunk On-Call integration for your project. +* :ref:`atlas-integrations-create-WEBHOOK` - Create or update a webhook integration for your project. + + +.. toctree:: + :titlesonly: + + DATADOG </command/atlas-integrations-create-DATADOG> + OPS_GENIE </command/atlas-integrations-create-OPS_GENIE> + PAGER_DUTY </command/atlas-integrations-create-PAGER_DUTY> + VICTOR_OPS </command/atlas-integrations-create-VICTOR_OPS> + WEBHOOK </command/atlas-integrations-create-WEBHOOK> + diff --git a/source/command/atlas-integrations-delete.txt b/source/command/atlas-integrations-delete.txt new file mode 100644 index 00000000..178ba591 --- /dev/null +++ b/source/command/atlas-integrations-delete.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-delete: + +========================= +atlas integrations delete +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified third-party integration from your project. + +Deleting an integration from a project removes that integration configuration only for that project. This does not affect any other project or organization's configured integrations. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations delete <integrationType> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - integrationType + - string + - true + - Human-readable label that identifies the service integration to delete. Valid values are PAGER_DUTY, MICROSOFT_TEAMS, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, WEBHOOK, PROMETHEUS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Integration '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the Datadog integration for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations delete DATADOG --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-integrations-describe.txt b/source/command/atlas-integrations-describe.txt new file mode 100644 index 00000000..59937a48 --- /dev/null +++ b/source/command/atlas-integrations-describe.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-describe: + +=========================== +atlas integrations describe +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified third-party integration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations describe <integrationType> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - integrationType + - string + - true + - Human-readable label that identifies the integrated service. Valid values are PAGER_DUTY, MICROSOFT_TEAMS, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, WEBHOOK, PROMETHEUS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the Datadog integration for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations describe DATADOG --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-integrations-list.txt b/source/command/atlas-integrations-list.txt new file mode 100644 index 00000000..94277347 --- /dev/null +++ b/source/command/atlas-integrations-list.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations-list: + +======================= +atlas integrations list +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all active third-party integrations for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas integrations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + TYPE + <Type> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of active third-party integrations for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas integrations list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-integrations.txt b/source/command/atlas-integrations.txt new file mode 100644 index 00000000..6de912fa --- /dev/null +++ b/source/command/atlas-integrations.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-integrations: + +================== +atlas integrations +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Configure third-party integrations for your Atlas project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for integrations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-integrations-create` - Create operations. +* :ref:`atlas-integrations-delete` - Remove the specified third-party integration from your project. +* :ref:`atlas-integrations-describe` - Return the details for the specified third-party integration for your project. +* :ref:`atlas-integrations-list` - Return all active third-party integrations for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-integrations-create> + delete </command/atlas-integrations-delete> + describe </command/atlas-integrations-describe> + list </command/atlas-integrations-list> + diff --git a/source/command/atlas-kubernetes-config-apply.txt b/source/command/atlas-kubernetes-config-apply.txt new file mode 100644 index 00000000..a1046af1 --- /dev/null +++ b/source/command/atlas-kubernetes-config-apply.txt @@ -0,0 +1,116 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-kubernetes-config-apply: + +============================= +atlas kubernetes config apply +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate and apply Kubernetes configuration resources for use with Atlas Kubernetes Operator. + +This command exports configurations for Atlas objects including projects, deployments, and users directly into Kubernetes, allowing you to manage these resources using the Atlas Kubernetes Operator. For more information, see https://www.mongodb.com/docs/atlas/atlas-operator/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas kubernetes config apply [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - strings + - false + - One or more comma separated cluster names to import + * - -h, --help + - + - false + - help for apply + * - --kubeContext + - string + - false + - Name of the kubeconfig context to use. + * - --kubeconfig + - string + - false + - Path to the kubeconfig file to use for CLI requests. + * - --operatorVersion + - string + - false + - Version of Atlas Kubernetes Operator to generate resources for. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --targetNamespace + - string + - false + - Namespaces to use for generated kubernetes entities + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Export and apply all supported resources of a specific project: + atlas kubernetes config apply --projectId=<projectId> + + +.. code-block:: + + # Export and apply all supported resources of a specific project and to a specific namespace: + atlas kubernetes config apply --projectId=<projectId> --targetNamespace=<namespace> + + +.. code-block:: + + # Export and apply all supported Project resource, and only the described Deployment resources of a specific project to a specific namespace: + atlas kubernetes config apply --projectId=<projectId> --clusterName=<cluster-name-1, cluster-name-2> --targetNamespace=<namespace> + + +.. code-block:: + + # Export and apply all supported resources of a specific project to a specific namespace restricting the version of the Atlas Kubernetes Operator: + atlas kubernetes config apply --projectId=<projectId> --targetNamespace=<namespace> --operatorVersion=1.5.1 diff --git a/source/command/atlas-kubernetes-config-generate.txt b/source/command/atlas-kubernetes-config-generate.txt new file mode 100644 index 00000000..5052c51d --- /dev/null +++ b/source/command/atlas-kubernetes-config-generate.txt @@ -0,0 +1,128 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-kubernetes-config-generate: + +================================ +atlas kubernetes config generate +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Generate Kubernetes configuration resources for use with Atlas Kubernetes Operator. + +This command exports configurations for Atlas objects including projects, deployments, and users in a Kubernetes-compatible format, allowing you to manage these resources using the Atlas Kubernetes Operator. For more information, see https://www.mongodb.com/docs/atlas/atlas-operator/ + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas kubernetes config generate [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - strings + - false + - One or more comma separated cluster names to import + * - --dataFederationName + - strings + - false + - One or more comma separated data federation names to import + * - -h, --help + - + - false + - help for generate + * - --includeSecrets + - + - false + - Flag that generates kubernetes secrets with data for projects, users, deployments entities. + * - --operatorVersion + - string + - false + - Version of Atlas Kubernetes Operator to generate resources for. This value defaults to "2.2.0". + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --targetNamespace + - string + - false + - Namespaces to use for generated kubernetes entities + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Export Project, DatabaseUsers, Deployments resources for a specific project without connection and integration secrets: + atlas kubernetes config generate --projectId=<projectId> + + +.. code-block:: + + # Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets: + atlas kubernetes config generate --projectId=<projectId> --includeSecrets + + +.. code-block:: + + # Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets to a specific namespace: + atlas kubernetes config generate --projectId=<projectId> --includeSecrets --targetNamespace=<namespace> + + +.. code-block:: + + # Export Project, DatabaseUsers, DataFederations and specific Deployment resources for a specific project including connection and integration secrets to a specific namespace: + atlas kubernetes config generate --projectId=<projectId> --clusterName=<cluster-name-1, cluster-name-2> --includeSecrets --targetNamespace=<namespace> + + +.. code-block:: + + # Export resources for a specific version of the Atlas Kubernetes Operator: + atlas kubernetes config generate --projectId=<projectId> --targetNamespace=<namespace> --operatorVersion=1.5.1 + + +.. code-block:: + + # Export Project, DatabaseUsers, Clusters and specific DataFederation resources for a specific project to a specific namespace: + atlas kubernetes config generate --projectId=<projectId> --dataFederationName=<data-federation-name-1, data-federation-name-2> --targetNamespace=<namespace> diff --git a/source/command/atlas-kubernetes-config.txt b/source/command/atlas-kubernetes-config.txt new file mode 100644 index 00000000..845ff331 --- /dev/null +++ b/source/command/atlas-kubernetes-config.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-kubernetes-config: + +======================= +atlas kubernetes config +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Kubernetes configuration resources. + +This command provides your Kubernetes configuration access to Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for config + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-kubernetes-config-apply` - Generate and apply Kubernetes configuration resources for use with Atlas Kubernetes Operator. +* :ref:`atlas-kubernetes-config-generate` - Generate Kubernetes configuration resources for use with Atlas Kubernetes Operator. + + +.. toctree:: + :titlesonly: + + apply </command/atlas-kubernetes-config-apply> + generate </command/atlas-kubernetes-config-generate> + diff --git a/source/command/atlas-kubernetes-operator-install.txt b/source/command/atlas-kubernetes-operator-install.txt new file mode 100644 index 00000000..45f24f41 --- /dev/null +++ b/source/command/atlas-kubernetes-operator-install.txt @@ -0,0 +1,159 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-kubernetes-operator-install: + +================================= +atlas kubernetes operator install +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Install Atlas Kubernetes Operator to a cluster. + +This command installs a supported version of Atlas Kubernetes Operator to an existing cluster, and optionally imports Atlas resources that are managed by the operator. + +This command creates an API key for the Operator and adds it to Kubernetes as a secret, which the Operator then uses to make Atlas Admin API calls. +The key is scoped to the project when you specify the --projectName option and to the organization when you omit the --projectName option. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas kubernetes operator install [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --atlasGov + - + - false + - Flag that indicates whether to configure Atlas for Government as a target of the operator. + * - -h, --help + - + - false + - help for install + * - --import + - + - false + - Flag that indicates whether to import existing Atlas resources into the cluster for the operator to manage. + * - --kubeContext + - string + - false + - Name of the kubeconfig context to use. + * - --kubeconfig + - string + - false + - Path to the kubeconfig file to use for CLI requests. + * - --operatorVersion + - string + - false + - Version of the operator to install. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - --projectName + - string + - false + - Name of the project to create or use with the installed operator. + * - --resourceDeletionProtection + - + - false + - Toggle atlas operator deletion protection for resources like Projects, Deployments, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true. + * - --subresourceDeletionProtection + - + - false + - Toggle atlas operator deletion protection for subresources like Alerts, Integrations, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true. + * - --targetNamespace + - string + - false + - Namespace where to install the operator. + * - --watchNamespace + - strings + - false + - List that contains namespaces that the operator will listen to. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Install latest version of the operator into the default namespace: + atlas kubernetes operator install + + +.. code-block:: + + # Install the latest version of the operator targeting Atlas for Government instead of regular commercial Atlas: + atlas kubernetes operator install --atlasGov + + +.. code-block:: + + # Install a specific version of the operator: + atlas kubernetes operator install --operatorVersion=1.7.0 + + +.. code-block:: + + # Install a specific version of the operator to a namespace and watch only this namespace and a second one: + atlas kubernetes operator install --operatorVersion=1.7.0 --targetNamespace=<namespace> --watchNamespace=<namespace>,<secondNamespace> + + +.. code-block:: + + # Install and import all objects from an organization: + atlas kubernetes operator install --targetNamespace=<namespace> --orgID <orgID> --import + + +.. code-block:: + + # Install and import objects from a specific project: + atlas kubernetes operator install --targetNamespace=<namespace> --orgID <orgID> --projectName <project> --import + + +.. code-block:: + + # Install the operator and disable deletion protection: + atlas kubernetes operator install --resourceDeletionProtection=false + + +.. code-block:: + + # Install the operator and disable deletion protection for sub-resources (Atlas project integrations, private endpoints, etc.): + atlas kubernetes operator install --subresourceDeletionProtection=false diff --git a/source/command/atlas-kubernetes-operator.txt b/source/command/atlas-kubernetes-operator.txt new file mode 100644 index 00000000..e78af610 --- /dev/null +++ b/source/command/atlas-kubernetes-operator.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-kubernetes-operator: + +========================= +atlas kubernetes operator +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Kubernetes Operator. + +This command manages the Atlas Kubernetes Operator. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for operator + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-kubernetes-operator-install` - Install Atlas Kubernetes Operator to a cluster. + + +.. toctree:: + :titlesonly: + + install </command/atlas-kubernetes-operator-install> + diff --git a/source/command/atlas-kubernetes.txt b/source/command/atlas-kubernetes.txt new file mode 100644 index 00000000..e79c7707 --- /dev/null +++ b/source/command/atlas-kubernetes.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-kubernetes: + +================ +atlas kubernetes +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Kubernetes resources. + +This command provides access to Kubernetes features within Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for kubernetes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-kubernetes-config` - Manage Kubernetes configuration resources. +* :ref:`atlas-kubernetes-operator` - Manage Atlas Kubernetes Operator. + + +.. toctree:: + :titlesonly: + + config </command/atlas-kubernetes-config> + operator </command/atlas-kubernetes-operator> + diff --git a/source/command/atlas-liveMigrations-create.txt b/source/command/atlas-liveMigrations-create.txt new file mode 100644 index 00000000..2d9ed80d --- /dev/null +++ b/source/command/atlas-liveMigrations-create.txt @@ -0,0 +1,129 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-create: + +=========================== +atlas liveMigrations create +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new push live migration. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Human-readable label that identifies the Atlas destination cluster. + * - --drop + - + - false + - Flag that indicates whether this process should drop existing collections from the destination (Atlas) cluster given in --destinationClusterName before starting the migration of data from the source cluster. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for create + * - --migrationHost + - strings + - true + - List of hosts running the MongoDB Agent that can transfer your MongoDB data from the source (Cloud Manager or Ops Manager) to destination (Atlas) deployments. Each live migration process uses its own dedicated migration host. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sourceCACertificatePath + - string + - false + - Path to the CA certificate that signed TLS certificates use to authenticate to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceSSL is not passed. + * - --sourceClusterName + - string + - true + - Human-readable label that identifies the source Cloud Manager or Ops Manager cluster. + * - --sourceManagedAuthentication + - + - false + - Flag that indicates whether MongoDB Automation manages authentication to the source Cloud Manager or Ops Manager cluster. If you set this to true, don't provide values for --sourceUsername and --sourcePassword. + + Mutually exclusive with --sourceUsername. + * - -p, --sourcePassword + - string + - false + - Password that authenticates the username to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is passed. + * - --sourceProjectId + - string + - true + - Unique 24-hexadecimal digit string that identifies the source project. + * - --sourceSsl + - + - false + - Flag that indicates whether data source has TLS enabled. + * - -u, --sourceUsername + - string + - false + - Human-readable label that identifies the SCRAM-SHA user that connects to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is set. + + Mutually exclusive with --sourceManagedAuthentication. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID LAGTIME READY FOR CUTOVER STATUS + <Id> <LagTimeSeconds> <ReadyForCutover> <Status> + diff --git a/source/command/atlas-liveMigrations-cutover.txt b/source/command/atlas-liveMigrations-cutover.txt new file mode 100644 index 00000000..291256ae --- /dev/null +++ b/source/command/atlas-liveMigrations-cutover.txt @@ -0,0 +1,85 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-cutover: + +============================ +atlas liveMigrations cutover +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations cutover [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for cutover + * - --liveMigrationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the live migration job. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Cutover process successfully started. + + diff --git a/source/command/atlas-liveMigrations-describe.txt b/source/command/atlas-liveMigrations-describe.txt new file mode 100644 index 00000000..51f5f68d --- /dev/null +++ b/source/command/atlas-liveMigrations-describe.txt @@ -0,0 +1,65 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-describe: + +============================= +atlas liveMigrations describe +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a push live migration job. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --liveMigrationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the live migration job. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + diff --git a/source/command/atlas-liveMigrations-link-create.txt b/source/command/atlas-liveMigrations-link-create.txt new file mode 100644 index 00000000..1760ae5a --- /dev/null +++ b/source/command/atlas-liveMigrations-link-create.txt @@ -0,0 +1,85 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-link-create: + +================================ +atlas liveMigrations link create +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new link-token for a push live migration. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations link create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --accessListIp + - strings + - false + - IP address access list entries that are associated with the link-token. + * - -h, --help + - + - false + - help for create + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Link-token '<LinkToken>' successfully created. + + diff --git a/source/command/atlas-liveMigrations-link-delete.txt b/source/command/atlas-liveMigrations-link-delete.txt new file mode 100644 index 00000000..afdb9a27 --- /dev/null +++ b/source/command/atlas-liveMigrations-link-delete.txt @@ -0,0 +1,79 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-link-delete: + +================================ +atlas liveMigrations link delete +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete one link-token. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations link delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Link-token <Name> successfully deleted + + diff --git a/source/command/atlas-liveMigrations-link.txt b/source/command/atlas-liveMigrations-link.txt new file mode 100644 index 00000000..d1061f44 --- /dev/null +++ b/source/command/atlas-liveMigrations-link.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-link: + +========================= +atlas liveMigrations link +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the link-token for your organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for link + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-liveMigrations-link-create` - Create a new link-token for a push live migration. +* :ref:`atlas-liveMigrations-link-delete` - Delete one link-token. + + +.. toctree:: + :titlesonly: + + create </command/atlas-liveMigrations-link-create> + delete </command/atlas-liveMigrations-link-delete> + diff --git a/source/command/atlas-liveMigrations-validation-create.txt b/source/command/atlas-liveMigrations-validation-create.txt new file mode 100644 index 00000000..ebe3a6c3 --- /dev/null +++ b/source/command/atlas-liveMigrations-validation-create.txt @@ -0,0 +1,129 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-validation-create: + +====================================== +atlas liveMigrations validation create +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new validation request for a push live migration. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations validation create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Human-readable label that identifies the Atlas destination cluster. + * - --drop + - + - false + - Flag that indicates whether this process should drop existing collections from the destination (Atlas) cluster given in --destinationClusterName before starting the migration of data from the source cluster. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for create + * - --migrationHost + - strings + - true + - List of hosts running the MongoDB Agent that can transfer your MongoDB data from the source (Cloud Manager or Ops Manager) to destination (Atlas) deployments. Each live migration process uses its own dedicated migration host. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sourceCACertificatePath + - string + - false + - Path to the CA certificate that signed TLS certificates use to authenticate to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceSSL is not passed. + * - --sourceClusterName + - string + - true + - Human-readable label that identifies the source Cloud Manager or Ops Manager cluster. + * - --sourceManagedAuthentication + - + - false + - Flag that indicates whether MongoDB Automation manages authentication to the source Cloud Manager or Ops Manager cluster. If you set this to true, don't provide values for --sourceUsername and --sourcePassword. + + Mutually exclusive with --sourceUsername. + * - -p, --sourcePassword + - string + - false + - Password that authenticates the username to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is passed. + * - --sourceProjectId + - string + - true + - Unique 24-hexadecimal digit string that identifies the source project. + * - --sourceSsl + - + - false + - Flag that indicates whether data source has TLS enabled. + * - -u, --sourceUsername + - string + - false + - Human-readable label that identifies the SCRAM-SHA user that connects to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is set. + + Mutually exclusive with --sourceManagedAuthentication. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID PROJECT ID SOURCE PROJECT ID STATUS + <Id> <GroupId> <SourceGroupId> <Status> + diff --git a/source/command/atlas-liveMigrations-validation-describe.txt b/source/command/atlas-liveMigrations-validation-describe.txt new file mode 100644 index 00000000..176c312f --- /dev/null +++ b/source/command/atlas-liveMigrations-validation-describe.txt @@ -0,0 +1,83 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-validation-describe: + +======================================== +atlas liveMigrations validation describe +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return one validation job. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations validation describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --validationId + - string + - false + - Unique 24-hexadecimal digit string that identifies the validation job. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID PROJECT ID SOURCE PROJECT ID STATUS + <Id> <GroupId> <SourceGroupId> <Status> + diff --git a/source/command/atlas-liveMigrations-validation.txt b/source/command/atlas-liveMigrations-validation.txt new file mode 100644 index 00000000..61a0417b --- /dev/null +++ b/source/command/atlas-liveMigrations-validation.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations-validation: + +=============================== +atlas liveMigrations validation +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage a Live Migration validation job for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for validation + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-liveMigrations-validation-create` - Create a new validation request for a push live migration. +* :ref:`atlas-liveMigrations-validation-describe` - Return one validation job. + + +.. toctree:: + :titlesonly: + + create </command/atlas-liveMigrations-validation-create> + describe </command/atlas-liveMigrations-validation-describe> + diff --git a/source/command/atlas-liveMigrations.txt b/source/command/atlas-liveMigrations.txt new file mode 100644 index 00000000..9f0eeb6c --- /dev/null +++ b/source/command/atlas-liveMigrations.txt @@ -0,0 +1,70 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-liveMigrations: + +==================== +atlas liveMigrations +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage a Live Migration to Atlas for your organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for liveMigrations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-liveMigrations-create` - Create a new push live migration. +* :ref:`atlas-liveMigrations-cutover` - Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. +* :ref:`atlas-liveMigrations-describe` - Return a push live migration job. +* :ref:`atlas-liveMigrations-link` - Manage the link-token for your organization. +* :ref:`atlas-liveMigrations-validation` - Manage a Live Migration validation job for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-liveMigrations-create> + cutover </command/atlas-liveMigrations-cutover> + describe </command/atlas-liveMigrations-describe> + link </command/atlas-liveMigrations-link> + validation </command/atlas-liveMigrations-validation> + diff --git a/source/command/atlas-logs-download.txt b/source/command/atlas-logs-download.txt new file mode 100644 index 00000000..6b38d573 --- /dev/null +++ b/source/command/atlas-logs-download.txt @@ -0,0 +1,128 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-logs-download: + +=================== +atlas logs download +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Download a compressed file that contains the MongoDB logs for the specified host. + +This command downloads a file with a .gz extension. + +To find the hostnames for an Atlas project, use the process list command. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas logs download <hostname> <mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname + - string + - true + - Label that identifies the host that stores the log files that you want to download. + * - mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz + - string + - true + - Log file that you want to return. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -d, --decompress + - + - false + - Flag that indicates whether to decompress the log files. + * - --end + - int + - false + - UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp. + * - --force + - + - false + - Flag that indicates whether to overwrite the destination file. + * - -h, --help + - + - false + - help for download + * - --out + - string + - false + - Output file name. This value defaults to the log name. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - int + - false + - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Download of <Name> completed. + + +Examples +-------- + +.. code-block:: + + # Download the mongodb log file from the host atlas-123abc-shard-00-00.111xx.mongodb.net for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas logs download atlas-123abc-shard-00-00.111xx.mongodb.net mongodb.gz --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-logs.txt b/source/command/atlas-logs.txt new file mode 100644 index 00000000..5a420445 --- /dev/null +++ b/source/command/atlas-logs.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-logs: + +========== +atlas logs +========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Download host logs for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for logs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-logs-download` - Download a compressed file that contains the MongoDB logs for the specified host. + + +.. toctree:: + :titlesonly: + + download </command/atlas-logs-download> + diff --git a/source/command/atlas-maintenanceWindows-clear.txt b/source/command/atlas-maintenanceWindows-clear.txt new file mode 100644 index 00000000..1a2da675 --- /dev/null +++ b/source/command/atlas-maintenanceWindows-clear.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-maintenanceWindows-clear: + +============================== +atlas maintenanceWindows clear +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Clear the current maintenance window setting for your project. + +To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas maintenanceWindows clear [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for clear + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Maintenance window removed. + + +Examples +-------- + +.. code-block:: + + # Clear the current maintenance window for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas maintenanceWindows clear --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-maintenanceWindows-defer.txt b/source/command/atlas-maintenanceWindows-defer.txt new file mode 100644 index 00000000..5bf289c7 --- /dev/null +++ b/source/command/atlas-maintenanceWindows-defer.txt @@ -0,0 +1,90 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-maintenanceWindows-defer: + +============================== +atlas maintenanceWindows defer +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Defer scheduled maintenance for your project for one week. + +To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas maintenanceWindows defer [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for defer + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Maintenance window deferred. + + +Examples +-------- + +.. code-block:: + + # Defer scheduled maintenance for one week for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas maintenanceWindows defer --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-maintenanceWindows-describe.txt b/source/command/atlas-maintenanceWindows-describe.txt new file mode 100644 index 00000000..e2a9a18f --- /dev/null +++ b/source/command/atlas-maintenanceWindows-describe.txt @@ -0,0 +1,91 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-maintenanceWindows-describe: + +================================= +atlas maintenanceWindows describe +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the maintenance window details for your project. + +To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas maintenanceWindows describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DAY OF THE WEEK HOUR OF DAY START ASAP + <DayOfWeek> <HourOfDay> <StartASAP> + + +Examples +-------- + +.. code-block:: + + # Return the maintenance window for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas maintenanceWindows describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-maintenanceWindows-update.txt b/source/command/atlas-maintenanceWindows-update.txt new file mode 100644 index 00000000..cbd72da8 --- /dev/null +++ b/source/command/atlas-maintenanceWindows-update.txt @@ -0,0 +1,102 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-maintenanceWindows-update: + +=============================== +atlas maintenanceWindows update +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the maintenance window for your project. + +To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas maintenanceWindows update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --dayOfWeek + - int + - false + - Day of the week that you want the maintenance window to start, as a 1-based integer. Use 1 for Sunday, 2 for Monday, 3 for Tuesday, 4 for Wednesday, 5 for Thursday, 6 for Friday, or 7 for Saturday. + * - -h, --help + - + - false + - help for update + * - --hourOfDay + - int + - false + - Hour of the day that you want the maintenance window to start according to a 24-hour clock. Use 0 for midnight and 12 for noon. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --startASAP + - + - false + - Flag that starts maintenance immediately upon receiving this request. This flag resets to false after Atlas completes maintenance. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Maintenance window updated. + + +Examples +-------- + +.. code-block:: + + # Update the maintenance window to midnight on Saturdays for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas maintenanceWindows update --dayOfWeek 7 --hourOfDay 0 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-maintenanceWindows.txt b/source/command/atlas-maintenanceWindows.txt new file mode 100644 index 00000000..15598f6d --- /dev/null +++ b/source/command/atlas-maintenanceWindows.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-maintenanceWindows: + +======================== +atlas maintenanceWindows +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas maintenance windows. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for maintenanceWindows + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-maintenanceWindows-clear` - Clear the current maintenance window setting for your project. +* :ref:`atlas-maintenanceWindows-defer` - Defer scheduled maintenance for your project for one week. +* :ref:`atlas-maintenanceWindows-describe` - Return the maintenance window details for your project. +* :ref:`atlas-maintenanceWindows-update` - Modify the maintenance window for your project. + + +.. toctree:: + :titlesonly: + + clear </command/atlas-maintenanceWindows-clear> + defer </command/atlas-maintenanceWindows-defer> + describe </command/atlas-maintenanceWindows-describe> + update </command/atlas-maintenanceWindows-update> + diff --git a/source/command/atlas-metrics-databases-describe.txt b/source/command/atlas-metrics-databases-describe.txt new file mode 100644 index 00000000..38e809af --- /dev/null +++ b/source/command/atlas-metrics-databases-describe.txt @@ -0,0 +1,133 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-metrics-databases-describe: + +================================ +atlas metrics databases describe +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the measurements of a database on the specified host. + +To return the hostname and port needed for this command, run +atlas process list + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics databases describe <hostname:port> <databaseName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + * - databaseName + - string + - true + - Label that identifies the database from which you want to retrieve metrics. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - string + - false + - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --granularity + - string + - true + - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. + * - -h, --help + - + - false + - help for describe + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --period + - string + - false + - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. + + Mutually exclusive with --start, --end. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - string + - false + - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --type + - strings + - false + - Measurements to return. This option returns all measurements by default. Valid values include DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted database metrics from the last 36 hours with 5-minute granularity for the database named testDB in the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics databases describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 testDB --granularity PT1M --period P1DT12H --output json diff --git a/source/command/atlas-metrics-databases-list.txt b/source/command/atlas-metrics-databases-list.txt new file mode 100644 index 00000000..e2984796 --- /dev/null +++ b/source/command/atlas-metrics-databases-list.txt @@ -0,0 +1,120 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-metrics-databases-list: + +============================ +atlas metrics databases list +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all databases running on the specified host for your project. + +To return the hostname and port needed for this command, run +atlas processes list + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics databases list <hostname:port> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + DATABASE NAME + <DatabaseName> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of available databases for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics databases list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/source/command/atlas-metrics-databases.txt b/source/command/atlas-metrics-databases.txt new file mode 100644 index 00000000..d789341a --- /dev/null +++ b/source/command/atlas-metrics-databases.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-metrics-databases: + +======================= +atlas metrics databases +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List available databases or database metrics for a given host. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for databases + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-metrics-databases-describe` - Return the measurements of a database on the specified host. +* :ref:`atlas-metrics-databases-list` - Return all databases running on the specified host for your project. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-metrics-databases-describe> + list </command/atlas-metrics-databases-list> + diff --git a/source/command/atlas-metrics-disks-describe.txt b/source/command/atlas-metrics-disks-describe.txt new file mode 100644 index 00000000..a599cccb --- /dev/null +++ b/source/command/atlas-metrics-disks-describe.txt @@ -0,0 +1,135 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-metrics-disks-describe: + +============================ +atlas metrics disks describe +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the measurements of a disk or partition on the specified host. + +To return the hostname and port needed for this command, run +atlas processes list + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics disks describe <hostname:port> <diskName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + * - diskName + - string + - true + - Label that identifies the disk or partition from which you want to retrieve metrics. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - string + - false + - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --granularity + - string + - true + - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. + * - -h, --help + - + - false + - help for describe + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --period + - string + - false + - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. + + Mutually exclusive with --start, --end. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - string + - false + - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --type + - strings + - false + - Measurements to return. This option returns all measurements by default. Valid values include DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted disk metrics from the last 36 hours with 5-minute granularity for the database named testDB in the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics disks describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 testDB --granularity PT1M --period P1DT12H --output json diff --git a/source/command/atlas-metrics-disks-list.txt b/source/command/atlas-metrics-disks-list.txt new file mode 100644 index 00000000..2a156d3b --- /dev/null +++ b/source/command/atlas-metrics-disks-list.txt @@ -0,0 +1,120 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-metrics-disks-list: + +======================== +atlas metrics disks list +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all disks or disk partitions on the specified host for your project. + +To return the hostname and port needed for this command, run: +$ atlas processes list + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics disks list <hostname:port> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + PARTITION NAME + <PartitionName> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of disks and partitions for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics disks list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/source/command/atlas-metrics-disks.txt b/source/command/atlas-metrics-disks.txt new file mode 100644 index 00000000..99a776c7 --- /dev/null +++ b/source/command/atlas-metrics-disks.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-metrics-disks: + +=================== +atlas metrics disks +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List available disks or disk metrics for a given host. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disks + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-metrics-disks-describe` - Return the measurements of a disk or partition on the specified host. +* :ref:`atlas-metrics-disks-list` - Return all disks or disk partitions on the specified host for your project. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-metrics-disks-describe> + list </command/atlas-metrics-disks-list> + diff --git a/source/command/atlas-metrics-processes.txt b/source/command/atlas-metrics-processes.txt new file mode 100644 index 00000000..6351b2e3 --- /dev/null +++ b/source/command/atlas-metrics-processes.txt @@ -0,0 +1,131 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-metrics-processes: + +======================= +atlas metrics processes +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the process measurements for the specified host. + +To return the hostname and port needed for this command, run +atlas processes list + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas metrics processes <hostname:port> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - string + - false + - ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --granularity + - string + - true + - ISO 8601-formatted duration that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D. When you specify granularity, you must specify either period or start and end. + * - -h, --help + - + - false + - help for processes + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --period + - string + - false + - ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and the start or end parameter in the same request. + + Mutually exclusive with --start, --end. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - string + - false + - ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request. + + Mutually exclusive with --period. + * - --type + - strings + - false + - Measurements to return. This option returns all measurements by default. To learn which values the CLI accepts, see the Items Enum for m in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Monitoring-and-Logs/operation/getHostMeasurements/. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted process metrics for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas metrics processes atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/source/command/atlas-metrics.txt b/source/command/atlas-metrics.txt new file mode 100644 index 00000000..e7ce8fa1 --- /dev/null +++ b/source/command/atlas-metrics.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-metrics: + +============= +atlas metrics +============= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get metrics on the MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for metrics + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-metrics-databases` - List available databases or database metrics for a given host. +* :ref:`atlas-metrics-disks` - List available disks or disk metrics for a given host. +* :ref:`atlas-metrics-processes` - Return the process measurements for the specified host. + + +.. toctree:: + :titlesonly: + + databases </command/atlas-metrics-databases> + disks </command/atlas-metrics-disks> + processes </command/atlas-metrics-processes> + diff --git a/source/command/atlas-networking-containers-delete.txt b/source/command/atlas-networking-containers-delete.txt new file mode 100644 index 00000000..facf31f4 --- /dev/null +++ b/source/command/atlas-networking-containers-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-containers-delete: + +================================== +atlas networking containers delete +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking containers delete <containerId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - containerId + - string + - true + - Unique 24-hexadecimal digit string that identifies the network container that you want to remove. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Network peering container '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the network peering container with the ID 5e44103f8d614b2f0b6530d8 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking containers delete 5e44103f8d614b2f0b6530d8 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-networking-containers-list.txt b/source/command/atlas-networking-containers-list.txt new file mode 100644 index 00000000..a955f9cd --- /dev/null +++ b/source/command/atlas-networking-containers-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-containers-list: + +================================ +atlas networking containers list +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all network peering containers for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking containers list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of network peering containers in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking containers list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-networking-containers.txt b/source/command/atlas-networking-containers.txt new file mode 100644 index 00000000..34194b1e --- /dev/null +++ b/source/command/atlas-networking-containers.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-containers: + +=========================== +atlas networking containers +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Network Peering containers. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for containers + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-networking-containers-delete` - Remove the specified network peering container from your project before creating any clusters. Don't run this command if you have clusters in your project. +* :ref:`atlas-networking-containers-list` - Return all network peering containers for your project. + + +.. toctree:: + :titlesonly: + + delete </command/atlas-networking-containers-delete> + list </command/atlas-networking-containers-list> + diff --git a/source/command/atlas-networking-peering-create-aws.txt b/source/command/atlas-networking-peering-create-aws.txt new file mode 100644 index 00000000..30cafc40 --- /dev/null +++ b/source/command/atlas-networking-peering-create-aws.txt @@ -0,0 +1,112 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-peering-create-aws: + +=================================== +atlas networking peering create aws +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a network peering connection between the Atlas VPC and your AWS VPC. + +The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. + +To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering create aws [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --accountId + - string + - true + - Unique twelve-digit AWS account ID that owns the peer VPC. + * - --atlasCidrBlock + - string + - false + - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. + * - -h, --help + - + - false + - help for aws + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region where the VPC that you peered with the Atlas VPC resides. + * - --routeTableCidrBlock + - string + - true + - Peer VPC CIDR block or subnet. + * - --vpcId + - string + - true + - Unique identifier of the peer VPC. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Network peering connection '<Id>' created. + + +Examples +-------- + +.. code-block:: + + # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your AWS VPC in CIDR block 10.0.0.0/24 for AWS account number 854333054055: + atlas networking peering create aws --accountId 854333054055 --atlasCidrBlock 192.168.0.0/24 --region us-east-1 --routeTableCidrBlock 10.0.0.0/24 --vpcId vpc-078ac381aa90e1e63 diff --git a/source/command/atlas-networking-peering-create-azure.txt b/source/command/atlas-networking-peering-create-azure.txt new file mode 100644 index 00000000..d3241589 --- /dev/null +++ b/source/command/atlas-networking-peering-create-azure.txt @@ -0,0 +1,118 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-peering-create-azure: + +===================================== +atlas networking peering create azure +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a network peering connection between the Atlas VPC and your Azure VNet. + +Before you create an Azure network peering connection, complete the prerequisites listed here: https://www.mongodb.com/docs/atlas/reference/api/vpc-create-peering-connection/#prerequisites. + +The network peering create command checks if a VNet exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VNet and your VPC. If an Atlas VPC does not exist, this command creates one and creates a connection between it and your VNet. + +To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering create azure [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --atlasCidrBlock + - string + - false + - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. + * - --directoryId + - string + - true + - Unique identifier for an Azure AD directory. + * - -h, --help + - + - false + - help for azure + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region where the VPC that you peered with the Atlas VPC resides. + * - --resourceGroup + - string + - true + - Name of your Azure resource group. + * - --subscriptionId + - string + - true + - Unique identifier of the Azure subscription in which the VNet resides. + * - --vnet + - string + - true + - Name of your Azure VNet. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Network peering connection '<Id>' created. + + +Examples +-------- + +.. code-block:: + + # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your Azure VNet named atlascli-test in in US_EAST_2: + atlas networking peering create azure --atlasCidrBlock 192.168.0.0/24 --directoryId 56657fdb-ca45-40dc-fr56-77fd8b6d2b37 --subscriptionId 345654f3-77cf-4084-9e06-8943a079ed75 --resourceGroup atlascli-test --region US_EAST_2 --vnet atlascli-test diff --git a/source/command/atlas-networking-peering-create-gcp.txt b/source/command/atlas-networking-peering-create-gcp.txt new file mode 100644 index 00000000..9dd977c4 --- /dev/null +++ b/source/command/atlas-networking-peering-create-gcp.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-peering-create-gcp: + +=================================== +atlas networking peering create gcp +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a network peering connection between the Atlas VPC and your Google Cloud VPC. + +The network peering create command checks if a VPC exists in the region you specify for your Atlas project. If one exists, this command creates the peering connection between that VPC and your VPC. If an Atlas VPC doesn't exist, this command creates one and creates a connection between it and your VPC. + +To learn more about network peering connections, see https://www.mongodb.com/docs/atlas/security-vpc-peering/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering create gcp [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --atlasCidrBlock + - string + - true + - CIDR block that Atlas uses for all network peering connections created in the project. This option is required only if you do not already have an Atlas VPC. To learn more, see the Atlas UI tab at https://dochub.mongodb.org/core/peering-connection-atlas. + * - --gcpProjectId + - string + - false + - Unique identifier of the GCP project in which the network peer resides. + * - -h, --help + - + - false + - help for gcp + * - --network + - string + - false + - Unique identifier of the Network Peering connection in the Atlas project. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - strings + - false + - List of Atlas regions where the container resides. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Network peering connection '<Id>' created. + + +Examples +-------- + +.. code-block:: + + # Create a network peering connection between the Atlas VPC in CIDR block 192.168.0.0/24 and your GCP VPC with the GCP project ID grandiose-branch-256701 in the network named cli-test: + atlas networking peering create gcp --atlasCidrBlock 192.168.0.0/24 --gcpProjectId grandiose-branch-256701 --network cli-test --output json diff --git a/source/command/atlas-networking-peering-create.txt b/source/command/atlas-networking-peering-create.txt new file mode 100644 index 00000000..449a3ff7 --- /dev/null +++ b/source/command/atlas-networking-peering-create.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-peering-create: + +=============================== +atlas networking peering create +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a connection with AWS, Azure and Google Cloud. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-networking-peering-create-aws` - Create a network peering connection between the Atlas VPC and your AWS VPC. +* :ref:`atlas-networking-peering-create-azure` - Create a network peering connection between the Atlas VPC and your Azure VNet. +* :ref:`atlas-networking-peering-create-gcp` - Create a network peering connection between the Atlas VPC and your Google Cloud VPC. + + +.. toctree:: + :titlesonly: + + aws </command/atlas-networking-peering-create-aws> + azure </command/atlas-networking-peering-create-azure> + gcp </command/atlas-networking-peering-create-gcp> + diff --git a/source/command/atlas-networking-peering-delete.txt b/source/command/atlas-networking-peering-delete.txt new file mode 100644 index 00000000..38ced61a --- /dev/null +++ b/source/command/atlas-networking-peering-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-peering-delete: + +=============================== +atlas networking peering delete +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified peering connection from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering delete <peerId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - peerId + - string + - true + - Unique ID of the network peering connection that you want to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Peering connection '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the network peering connection with the ID 5f60c5bd0948295c093565ba in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking peering delete 5f60c5bd0948295c093565ba --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-networking-peering-list.txt b/source/command/atlas-networking-peering-list.txt new file mode 100644 index 00000000..0b5a437b --- /dev/null +++ b/source/command/atlas-networking-peering-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-peering-list: + +============================= +atlas networking peering list +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for all network peering connections for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. This value defaults to "AWS". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for all network peering connections in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking peering list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-networking-peering-watch.txt b/source/command/atlas-networking-peering-watch.txt new file mode 100644 index 00000000..c8c3bd5f --- /dev/null +++ b/source/command/atlas-networking-peering-watch.txt @@ -0,0 +1,110 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-peering-watch: + +============================== +atlas networking peering watch +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified peering connection in your project until it becomes available. + +This command checks the peering connection's status periodically until it becomes available. +Once it reaches the expected state, the command prints "Network peering changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource is available. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas networking peering watch <peerId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - peerId + - string + - true + - Unique ID of the network peering connection that you want to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Network peering changes completed. + + +Examples +-------- + +.. code-block:: + + Watch for the network peering connection with the ID 5f621dc701240c5b7c3a888e to become available in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas networking peering watch 5f621dc701240c5b7c3a888e --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-networking-peering.txt b/source/command/atlas-networking-peering.txt new file mode 100644 index 00000000..342ab3f1 --- /dev/null +++ b/source/command/atlas-networking-peering.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking-peering: + +======================== +atlas networking peering +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Network Peering connections. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for peering + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-networking-peering-create` - Create a connection with AWS, Azure and Google Cloud. +* :ref:`atlas-networking-peering-delete` - Remove the specified peering connection from your project. +* :ref:`atlas-networking-peering-list` - Return the details for all network peering connections for your project. +* :ref:`atlas-networking-peering-watch` - Watch the specified peering connection in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + create </command/atlas-networking-peering-create> + delete </command/atlas-networking-peering-delete> + list </command/atlas-networking-peering-list> + watch </command/atlas-networking-peering-watch> + diff --git a/source/command/atlas-networking.txt b/source/command/atlas-networking.txt new file mode 100644 index 00000000..7157f6a9 --- /dev/null +++ b/source/command/atlas-networking.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-networking: + +================ +atlas networking +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage or configure network peering for your Atlas project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for networking + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-networking-containers` - Manage Network Peering containers. +* :ref:`atlas-networking-peering` - Manage Network Peering connections. + + +.. toctree:: + :titlesonly: + + containers </command/atlas-networking-containers> + peering </command/atlas-networking-peering> + diff --git a/source/command/atlas-organizations-apiKeys-accessLists-create.txt b/source/command/atlas-organizations-apiKeys-accessLists-create.txt new file mode 100644 index 00000000..5452aa59 --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-accessLists-create.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-accessLists-create: + +============================================== +atlas organizations apiKeys accessLists create +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an IP access list entry for your API Key. + +To view possible values for the apiKey option, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Read Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys accessLists create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - true + - Unique 24-digit ID that identifies your API key. + * - --cidr + - strings + - false + - Access list entry in CIDR notation to be added for your API key. To add more than one entry, you can specify each entry with a separate cidr flag or specify all the entries as a comma-separated list using one cidr flag. You can't set both cidr and ip in the same command. + * - --currentIp + - + - false + - Flag that adds the IP address from the host that is currently executing the command to the access list. Only applicable for type ipAddress entries. You don't need the entry argument when you use the currentIp option. + * - -h, --help + - + - false + - help for create + * - --ip + - strings + - false + - IP address to add to the access list for your API key. To add more than one IP address, specify each address with a separate ip flag or specify all addresses as a comma-separated list using one ip flag. You can't set both ip and cidr in the same command. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Created new access list entry(s). + + +Examples +-------- + +.. code-block:: + + # Create access list entries for two IP addresses for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys accessLists create --apiKey 5f24084d8dbffa3ad3f21234 --cidr 192.0.2.0/24,198.51.100.0/24 --orgId 5a1b39eec902201990f12345 --output json diff --git a/source/command/atlas-organizations-apiKeys-accessLists-delete.txt b/source/command/atlas-organizations-apiKeys-accessLists-delete.txt new file mode 100644 index 00000000..42ca8da6 --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-accessLists-delete.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-accessLists-delete: + +============================================== +atlas organizations apiKeys accessLists delete +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified IP access list entry from your API Key. + +To use this command, you must authenticate with a user account or an API key with the Read Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys accessLists delete <entry> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - entry + - string + - true + - IP or CIDR address that you want to remove from the access list. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKey + - string + - false + - Unique 24-digit ID that identifies your API key. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Access list entry '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the IP address 192.0.2.0 from the access list for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys accessLists delete 192.0.2.0 --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 diff --git a/source/command/atlas-organizations-apiKeys-accessLists-list.txt b/source/command/atlas-organizations-apiKeys-accessLists-list.txt new file mode 100644 index 00000000..f591b106 --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-accessLists-list.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-accessLists-list: + +============================================ +atlas organizations apiKeys accessLists list +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all IP access list entries for your API Key. + +To view possible values for the apiKeyID argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys accessLists list <apiKeyID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - apiKeyID + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of access list entries for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys accessLists list --apiKey 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 --output json diff --git a/source/command/atlas-organizations-apiKeys-accessLists.txt b/source/command/atlas-organizations-apiKeys-accessLists.txt new file mode 100644 index 00000000..cf1f7777 --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-accessLists.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-accessLists: + +======================================= +atlas organizations apiKeys accessLists +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the IP access list for your API Key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for accessLists + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-apiKeys-accessLists-create` - Create an IP access list entry for your API Key. +* :ref:`atlas-organizations-apiKeys-accessLists-delete` - Remove the specified IP access list entry from your API Key. +* :ref:`atlas-organizations-apiKeys-accessLists-list` - Return all IP access list entries for your API Key. + + +.. toctree:: + :titlesonly: + + create </command/atlas-organizations-apiKeys-accessLists-create> + delete </command/atlas-organizations-apiKeys-accessLists-delete> + list </command/atlas-organizations-apiKeys-accessLists-list> + diff --git a/source/command/atlas-organizations-apiKeys-assign.txt b/source/command/atlas-organizations-apiKeys-assign.txt new file mode 100644 index 00000000..07e10fde --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-assign.txt @@ -0,0 +1,116 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-assign: + +================================== +atlas organizations apiKeys assign +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the roles or description for the specified organization API key. + +When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. + +To view possible values for the apiKeyId argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys assign <apiKeyId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - apiKeyId + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --desc + - string + - false + - Description of the API key. + * - -h, --help + - + - false + - help for assign + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --role + - strings + - false + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '<Id>' successfully updated. + + +Examples +-------- + +.. code-block:: + + # Modify the role and description for the API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json diff --git a/source/command/atlas-organizations-apiKeys-create.txt b/source/command/atlas-organizations-apiKeys-create.txt new file mode 100644 index 00000000..e8e15e34 --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-create.txt @@ -0,0 +1,100 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-create: + +================================== +atlas organizations apiKeys create +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an API Key for your organization. + +MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --desc + - string + - true + - Description of the API key. + * - -h, --help + - + - false + - help for create + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --role + - strings + - true + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '<Id>' created. + Public API Key <PublicKey> + Private API Key <PrivateKey> + + +Examples +-------- + +.. code-block:: + + # Create an organization API key with organization owner access in the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json diff --git a/source/command/atlas-organizations-apiKeys-delete.txt b/source/command/atlas-organizations-apiKeys-delete.txt new file mode 100644 index 00000000..4cc8598d --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-delete.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-delete: + +================================== +atlas organizations apiKeys delete +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified API key for your organization. + +To view possible values for the ID argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys delete <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the organization's API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 diff --git a/source/command/atlas-organizations-apiKeys-describe.txt b/source/command/atlas-organizations-apiKeys-describe.txt new file mode 100644 index 00000000..62be87a8 --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-describe.txt @@ -0,0 +1,107 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-describe: + +==================================== +atlas organizations apiKeys describe +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified API key for your organization. + +To view possible values for the ID argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys describe <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID DESCRIPTION PUBLIC KEY PRIVATE KEY + <Id> <Desc> <PublicKey> <PrivateKey> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json diff --git a/source/command/atlas-organizations-apiKeys-list.txt b/source/command/atlas-organizations-apiKeys-list.txt new file mode 100644 index 00000000..0d203720 --- /dev/null +++ b/source/command/atlas-organizations-apiKeys-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys-list: + +================================ +atlas organizations apiKeys list +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all API keys for your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations apiKeys list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of organization API keys for the organization with the ID 5a1b39eec902201990f12345: + atlas organizations apiKeys list --orgId 5a1b39eec902201990f12345 --output json diff --git a/source/command/atlas-organizations-apiKeys.txt b/source/command/atlas-organizations-apiKeys.txt new file mode 100644 index 00000000..d218a969 --- /dev/null +++ b/source/command/atlas-organizations-apiKeys.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-apiKeys: + +=========================== +atlas organizations apiKeys +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Organization API Keys operations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for apiKeys + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-apiKeys-accessLists` - Manage the IP access list for your API Key. +* :ref:`atlas-organizations-apiKeys-assign` - Modify the roles or description for the specified organization API key. +* :ref:`atlas-organizations-apiKeys-create` - Create an API Key for your organization. +* :ref:`atlas-organizations-apiKeys-delete` - Remove the specified API key for your organization. +* :ref:`atlas-organizations-apiKeys-describe` - Return the details for the specified API key for your organization. +* :ref:`atlas-organizations-apiKeys-list` - Return all API keys for your organization. + + +.. toctree:: + :titlesonly: + + accessLists </command/atlas-organizations-apiKeys-accessLists> + assign </command/atlas-organizations-apiKeys-assign> + create </command/atlas-organizations-apiKeys-create> + delete </command/atlas-organizations-apiKeys-delete> + describe </command/atlas-organizations-apiKeys-describe> + list </command/atlas-organizations-apiKeys-list> + diff --git a/source/command/atlas-organizations-create.txt b/source/command/atlas-organizations-create.txt new file mode 100644 index 00000000..9eabe3dd --- /dev/null +++ b/source/command/atlas-organizations-create.txt @@ -0,0 +1,102 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-create: + +========================== +atlas organizations create +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an organization. + +When authenticating using API keys, the organization to which the API keys belong must have cross-organization billing enabled. The resulting org will be linked to the paying org. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations create <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Label that identifies the organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --apiKeyDescription + - string + - false + - Description of the API key.Required when creating organizations authenticated with API Keys. + * - --apiKeyRole + - strings + - false + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/.Required when creating organizations authenticated with API Keys. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --ownerId + - string + - false + - Unique 24-digit string that identifies the Atlas user to be granted the Org Owner role on the specified organization. Required if using API keys. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Create an Atlas organization with the name myOrg: + atlas organizations create myOrg --output json diff --git a/source/command/atlas-organizations-delete.txt b/source/command/atlas-organizations-delete.txt new file mode 100644 index 00000000..b233c070 --- /dev/null +++ b/source/command/atlas-organizations-delete.txt @@ -0,0 +1,102 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-delete: + +========================== +atlas organizations delete +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified organization. + +Organizations with active projects can't be removed. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations delete <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Organization '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the organization with the ID 5e2211c17a3e5a48f5497de3: + atlas organizations delete 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-organizations-describe.txt b/source/command/atlas-organizations-describe.txt new file mode 100644 index 00000000..83afeabb --- /dev/null +++ b/source/command/atlas-organizations-describe.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-describe: + +============================ +atlas organizations describe +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified organizations. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations describe <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + <Id> <Name> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the organization with the ID 5e2211c17a3e5a48f5497de3: + atlas organizations describe 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-organizations-invitations-delete.txt b/source/command/atlas-organizations-invitations-delete.txt new file mode 100644 index 00000000..d84cf369 --- /dev/null +++ b/source/command/atlas-organizations-invitations-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-invitations-delete: + +====================================== +atlas organizations invitations delete +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified pending invitation to your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations delete <invitationId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - true + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Invitation '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the pending invitation with the ID 5dd56c847a3e5a1f363d424d from the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations delete 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc diff --git a/source/command/atlas-organizations-invitations-describe.txt b/source/command/atlas-organizations-invitations-describe.txt new file mode 100644 index 00000000..925ae04f --- /dev/null +++ b/source/command/atlas-organizations-invitations-describe.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-invitations-describe: + +======================================== +atlas organizations invitations describe +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified pending invitation to your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations describe <invitationId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - true + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details of the pending invitation with the ID 5dd56c847a3e5a1f363d424d for the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations describe 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --output json diff --git a/source/command/atlas-organizations-invitations-invite.txt b/source/command/atlas-organizations-invitations-invite.txt new file mode 100644 index 00000000..d12c2eba --- /dev/null +++ b/source/command/atlas-organizations-invitations-invite.txt @@ -0,0 +1,112 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-invitations-invite: + +====================================== +atlas organizations invitations invite +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invite the specified MongoDB user to your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations invite <email> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - email + - string + - true + - Email address that belongs to the user that you want to invite to the organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for invite + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --role + - strings + - true + - User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. + * - --teamId + - strings + - false + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User '<Username>' invited. + + +Examples +-------- + +.. code-block:: + + # Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: + atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json diff --git a/source/command/atlas-organizations-invitations-list.txt b/source/command/atlas-organizations-invitations-list.txt new file mode 100644 index 00000000..a95c4547 --- /dev/null +++ b/source/command/atlas-organizations-invitations-list.txt @@ -0,0 +1,82 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-invitations-list: + +==================================== +atlas organizations invitations list +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all pending invitations to your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --email + - string + - false + - Email address for the user. + * - -h, --help + - + - false + - help for list + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of pending invitations to the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations list --orgId 5f71e5255afec75a3d0f96dc --output json diff --git a/source/command/atlas-organizations-invitations-update.txt b/source/command/atlas-organizations-invitations-update.txt new file mode 100644 index 00000000..50a5d9a7 --- /dev/null +++ b/source/command/atlas-organizations-invitations-update.txt @@ -0,0 +1,120 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-invitations-update: + +====================================== +atlas organizations invitations update +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modifies the details of the specified pending invitation to your organization. + +You can use either the invitation ID or the user's email address to specify the invitation. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations invitations update [invitationId] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - false + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --email + - string + - false + - Email address for the user. + * - -h, --help + - + - false + - help for update + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --role + - strings + - true + - User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Invitation <Id> updated. + + +Examples +-------- + +.. code-block:: + + # Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations update 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json + + +.. code-block:: + + # Modify the invitation for the user with the email address user@example.com to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: + atlas organizations invitations update --email user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json diff --git a/source/command/atlas-organizations-invitations.txt b/source/command/atlas-organizations-invitations.txt new file mode 100644 index 00000000..414026f9 --- /dev/null +++ b/source/command/atlas-organizations-invitations.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-invitations: + +=============================== +atlas organizations invitations +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invitation operations. + +Create, list and manage your MongoDB organization invites. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for invitations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-invitations-delete` - Remove the specified pending invitation to your organization. +* :ref:`atlas-organizations-invitations-describe` - Return the details for the specified pending invitation to your organization. +* :ref:`atlas-organizations-invitations-invite` - Invite the specified MongoDB user to your organization. +* :ref:`atlas-organizations-invitations-list` - Return all pending invitations to your organization. +* :ref:`atlas-organizations-invitations-update` - Modifies the details of the specified pending invitation to your organization. + + +.. toctree:: + :titlesonly: + + delete </command/atlas-organizations-invitations-delete> + describe </command/atlas-organizations-invitations-describe> + invite </command/atlas-organizations-invitations-invite> + list </command/atlas-organizations-invitations-list> + update </command/atlas-organizations-invitations-update> + diff --git a/source/command/atlas-organizations-list.txt b/source/command/atlas-organizations-list.txt new file mode 100644 index 00000000..656e23b1 --- /dev/null +++ b/source/command/atlas-organizations-list.txt @@ -0,0 +1,111 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-list: + +======================== +atlas organizations list +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all organizations. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --includeDeleted + - + - false + - Flag that indictaes whether to include deleted organizations in the list. This option applies only to Ops Manager organizations. You can't return deleted Atlas or Cloud Manager organizations. + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --name + - string + - false + - Organization name to perform a case-insensitive search for. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + <Id> <Name> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all organizations: + atlas organizations list --output json + + +.. code-block:: + + # Return a JSON-formatted list that includes the organizations named org1 and Org1, but doesn't return org123: + atlas organizations list --name org1 --output json diff --git a/source/command/atlas-organizations-users-list.txt b/source/command/atlas-organizations-users-list.txt new file mode 100644 index 00000000..be1f6c45 --- /dev/null +++ b/source/command/atlas-organizations-users-list.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-users-list: + +============================== +atlas organizations users list +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all users for an organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas organizations users list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID FIRST NAME LAST NAME USERNAME + <Id> <FirstName> <LastName> <Username> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all users for the organization with the ID 5e2211c17a3e5a48f5497de3: + atlas organizations users list --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-organizations-users.txt b/source/command/atlas-organizations-users.txt new file mode 100644 index 00000000..2aff8c75 --- /dev/null +++ b/source/command/atlas-organizations-users.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations-users: + +========================= +atlas organizations users +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas users. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for users + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-users-list` - Return all users for an organization. + + +.. toctree:: + :titlesonly: + + list </command/atlas-organizations-users-list> + diff --git a/source/command/atlas-organizations.txt b/source/command/atlas-organizations.txt new file mode 100644 index 00000000..5ce4d73f --- /dev/null +++ b/source/command/atlas-organizations.txt @@ -0,0 +1,76 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-organizations: + +=================== +atlas organizations +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas organizations. + +Create, list and manage your MongoDB organizations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for organizations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-organizations-apiKeys` - Organization API Keys operations. +* :ref:`atlas-organizations-create` - Create an organization. +* :ref:`atlas-organizations-delete` - Remove the specified organization. +* :ref:`atlas-organizations-describe` - Return the details for the specified organizations. +* :ref:`atlas-organizations-invitations` - Invitation operations. +* :ref:`atlas-organizations-list` - Return all organizations. +* :ref:`atlas-organizations-users` - Manage your Atlas users. + + +.. toctree:: + :titlesonly: + + apiKeys </command/atlas-organizations-apiKeys> + create </command/atlas-organizations-create> + delete </command/atlas-organizations-delete> + describe </command/atlas-organizations-describe> + invitations </command/atlas-organizations-invitations> + list </command/atlas-organizations-list> + users </command/atlas-organizations-users> + diff --git a/source/command/atlas-performanceAdvisor-namespaces-list.txt b/source/command/atlas-performanceAdvisor-namespaces-list.txt new file mode 100644 index 00000000..c2857c57 --- /dev/null +++ b/source/command/atlas-performanceAdvisor-namespaces-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-namespaces-list: + +======================================== +atlas performanceAdvisor namespaces list +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return up to 20 namespaces for collections experiencing slow queries on the specified host. + +Namespaces appear in the following format: {database}.{collection}. + +If you don't set the duration option or the since option, this command returns data from the last 24 hours. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor namespaces list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --duration + - int + - false + - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --processName + - string + - true + - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --since + - int + - false + - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of namespaces for collections with slow queries for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas performanceAdvisor namespaces list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-performanceAdvisor-namespaces.txt b/source/command/atlas-performanceAdvisor-namespaces.txt new file mode 100644 index 00000000..b5dfa4fb --- /dev/null +++ b/source/command/atlas-performanceAdvisor-namespaces.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-namespaces: + +=================================== +atlas performanceAdvisor namespaces +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Retrieve namespaces for collections experiencing slow queries + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for namespaces + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-namespaces-list` - Return up to 20 namespaces for collections experiencing slow queries on the specified host. + + +.. toctree:: + :titlesonly: + + list </command/atlas-performanceAdvisor-namespaces-list> + diff --git a/source/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt b/source/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt new file mode 100644 index 00000000..949b8e93 --- /dev/null +++ b/source/command/atlas-performanceAdvisor-slowOperationThreshold-disable.txt @@ -0,0 +1,79 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-slowOperationThreshold-disable: + +======================================================= +atlas performanceAdvisor slowOperationThreshold disable +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable the application-managed slow operation threshold for your project. + +The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When disabled, the application considers any operation that takes longer than 100 milliseconds to be slow. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor slowOperationThreshold disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas management of the slow operation disabled + + diff --git a/source/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt b/source/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt new file mode 100644 index 00000000..885400aa --- /dev/null +++ b/source/command/atlas-performanceAdvisor-slowOperationThreshold-enable.txt @@ -0,0 +1,79 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-slowOperationThreshold-enable: + +====================================================== +atlas performanceAdvisor slowOperationThreshold enable +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable the application-managed slow operation threshold for your project. + +The slow operation threshold determines which operations are flagged by the Performance Advisor and Query Profiler. When enabled, the application uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. Application-managed slow operation threshold is enabled by default for dedicated clusters (M10+). + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor slowOperationThreshold enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas management of the slow operation enabled + + diff --git a/source/command/atlas-performanceAdvisor-slowOperationThreshold.txt b/source/command/atlas-performanceAdvisor-slowOperationThreshold.txt new file mode 100644 index 00000000..4aba9cb0 --- /dev/null +++ b/source/command/atlas-performanceAdvisor-slowOperationThreshold.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-slowOperationThreshold: + +=============================================== +atlas performanceAdvisor slowOperationThreshold +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable or disable management of the slow operation threshold for your cluster. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for slowOperationThreshold + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-slowOperationThreshold-disable` - Disable the application-managed slow operation threshold for your project. +* :ref:`atlas-performanceAdvisor-slowOperationThreshold-enable` - Enable the application-managed slow operation threshold for your project. + + +.. toctree:: + :titlesonly: + + disable </command/atlas-performanceAdvisor-slowOperationThreshold-disable> + enable </command/atlas-performanceAdvisor-slowOperationThreshold-enable> + diff --git a/source/command/atlas-performanceAdvisor-slowQueryLogs-list.txt b/source/command/atlas-performanceAdvisor-slowQueryLogs-list.txt new file mode 100644 index 00000000..fe211b1c --- /dev/null +++ b/source/command/atlas-performanceAdvisor-slowQueryLogs-list.txt @@ -0,0 +1,102 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-slowQueryLogs-list: + +=========================================== +atlas performanceAdvisor slowQueryLogs list +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return log lines for slow queries that the Performance Advisor and Query Profiler identified. + +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. The threshold for slow queries varies based on the average time of operations on your cluster to provide recommendations pertinent to your workload. + +If you don't set the duration option or the since option, this command returns data from the last 24 hours. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor slowQueryLogs list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --duration + - int + - false + - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. + * - -h, --help + - + - false + - help for list + * - --nLog + - int + - false + - Maximum number of log lines to return, up to a maximum of 20000. This value defaults to 20000. + * - --namespaces + - strings + - false + - Namespaces from which to retrieve suggested slow query logs formatted as <database>.<collection>. Omit this parameter to return results for all namespaces. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --processName + - string + - true + - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --since + - int + - false + - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of log lines for collections with slow queries for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas performanceAdvisor slowQueryLogs list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-performanceAdvisor-slowQueryLogs.txt b/source/command/atlas-performanceAdvisor-slowQueryLogs.txt new file mode 100644 index 00000000..2a9642e2 --- /dev/null +++ b/source/command/atlas-performanceAdvisor-slowQueryLogs.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-slowQueryLogs: + +====================================== +atlas performanceAdvisor slowQueryLogs +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get log lines for slow queries for a specified host + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for slowQueryLogs + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-slowQueryLogs-list` - Return log lines for slow queries that the Performance Advisor and Query Profiler identified. + + +.. toctree:: + :titlesonly: + + list </command/atlas-performanceAdvisor-slowQueryLogs-list> + diff --git a/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt b/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt new file mode 100644 index 00000000..f5d9e6d2 --- /dev/null +++ b/source/command/atlas-performanceAdvisor-suggestedIndexes-list.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-suggestedIndexes-list: + +============================================== +atlas performanceAdvisor suggestedIndexes list +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the suggested indexes for collections experiencing slow queries. + +The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas performanceAdvisor suggestedIndexes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --duration + - int + - false + - Length of time in milliseconds for which you want to return results. If you specify the since option, the duration starts at the date and time specified. If you don't set the since option, this command returns data from the duration before the current time. + * - -h, --help + - + - false + - help for list + * - --nExamples + - int + - false + - Maximum number of example queries to provide that a suggested index will improve. + * - --nIndexes + - int + - false + - Maximum number of indexes to suggest. + * - --namespaces + - strings + - false + - Namespaces from which to retrieve suggested indexes. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --processName + - string + - true + - Unique identifier for the host of a MongoDB process in the following format: {hostname}:{port}. You can obtain a list of possible values from the 'id' field when you run the 'atlas processes list' command. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --since + - int + - false + - Date and time from which the query retrieves the suggested indexes. Specify this value as the number of seconds that have elapsed since the UNIX epoch. If you don't set the duration option, this command returns data from the since value to the current time. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of suggested indexes for the atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 host in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas performanceAdvisor suggestedIndexes list --processName atlas-111ggi-shard-00-00.111xx.mongodb.net:27017 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-performanceAdvisor-suggestedIndexes.txt b/source/command/atlas-performanceAdvisor-suggestedIndexes.txt new file mode 100644 index 00000000..3317256a --- /dev/null +++ b/source/command/atlas-performanceAdvisor-suggestedIndexes.txt @@ -0,0 +1,62 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor-suggestedIndexes: + +========================================= +atlas performanceAdvisor suggestedIndexes +========================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get suggested indexes for collections experiencing slow queries + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for suggestedIndexes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-suggestedIndexes-list` - Return the suggested indexes for collections experiencing slow queries. + + +.. toctree:: + :titlesonly: + + list </command/atlas-performanceAdvisor-suggestedIndexes-list> + diff --git a/source/command/atlas-performanceAdvisor.txt b/source/command/atlas-performanceAdvisor.txt new file mode 100644 index 00000000..3b78147d --- /dev/null +++ b/source/command/atlas-performanceAdvisor.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-performanceAdvisor: + +======================== +atlas performanceAdvisor +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Learn more about slow queries and get suggestions to improve database performance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for performanceAdvisor + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-performanceAdvisor-namespaces` - Retrieve namespaces for collections experiencing slow queries +* :ref:`atlas-performanceAdvisor-slowOperationThreshold` - Enable or disable management of the slow operation threshold for your cluster. +* :ref:`atlas-performanceAdvisor-slowQueryLogs` - Get log lines for slow queries for a specified host +* :ref:`atlas-performanceAdvisor-suggestedIndexes` - Get suggested indexes for collections experiencing slow queries + + +.. toctree:: + :titlesonly: + + namespaces </command/atlas-performanceAdvisor-namespaces> + slowOperationThreshold </command/atlas-performanceAdvisor-slowOperationThreshold> + slowQueryLogs </command/atlas-performanceAdvisor-slowQueryLogs> + suggestedIndexes </command/atlas-performanceAdvisor-suggestedIndexes> + diff --git a/source/command/atlas-privateEndpoints-aws-create.txt b/source/command/atlas-privateEndpoints-aws-create.txt new file mode 100644 index 00000000..bda762d5 --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-create.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-create: + +================================= +atlas privateEndpoints aws create +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new AWS private endpoint for your project. + +To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '<Id>' created. + + +Examples +-------- + +.. code-block:: + + # Create a private endpoint connection for AWS in the us-east-1 region for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws create --region us-east-1 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-aws-delete.txt b/source/command/atlas-privateEndpoints-aws-delete.txt new file mode 100644 index 00000000..8749c249 --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-delete: + +================================= +atlas privateEndpoints aws delete +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified AWS private endpoint from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws delete <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws delete 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-privateEndpoints-aws-describe.txt b/source/command/atlas-privateEndpoints-aws-describe.txt new file mode 100644 index 00000000..4726a909 --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-describe: + +=================================== +atlas privateEndpoints aws describe +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified AWS private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws describe <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID ENDPOINT SERVICE STATUS ERROR + <Id> <EndpointServiceName> <Status> <ErrorMessage> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the AWS private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-aws-interfaces-create.txt b/source/command/atlas-privateEndpoints-aws-interfaces-create.txt new file mode 100644 index 00000000..9194a20e --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-interfaces-create.txt @@ -0,0 +1,110 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-interfaces-create: + +============================================ +atlas privateEndpoints aws interfaces create +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new interface for the specified AWS private endpoint. + +To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws interfaces create <endpointServiceId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --privateEndpointId + - string + - true + - Unique 22-character alphanumeric string that identifies the AWS PrivateLink connection in AWS. You can find this value on the AWS VPC Dashboard under Endpoints > VPC ID. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '<InterfaceEndpointId>' created. + + +Examples +-------- + +.. code-block:: + + # Create a new interface for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas and the ID vpce-00713b5e644e830a3 in AWS for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws interfaces create 5f4fc14da2b47835a58c63a2 --privateEndpointId vpce-00713b5e644e830a3 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-aws-interfaces-delete.txt b/source/command/atlas-privateEndpoints-aws-interfaces-delete.txt new file mode 100644 index 00000000..b15f8c70 --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-interfaces-delete.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-interfaces-delete: + +============================================ +atlas privateEndpoints aws interfaces delete +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified AWS private endpoint interface and related service from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws interfaces delete <interfaceEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - interfaceEndpointId + - string + - true + - Unique string that identifies the AWS private endpoint interface in AWS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - false + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the AWS private endpoint interface with the ID vpce-00713b5e644e830a3 in AWS from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws interfaces delete vpce-00713b5e644e830a3 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-privateEndpoints-aws-interfaces-describe.txt b/source/command/atlas-privateEndpoints-aws-interfaces-describe.txt new file mode 100644 index 00000000..27e060c8 --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-interfaces-describe.txt @@ -0,0 +1,111 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-interfaces-describe: + +============================================== +atlas privateEndpoints aws interfaces describe +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified AWS private endpoint interface for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws interfaces describe <interfaceEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - interfaceEndpointId + - string + - true + - Unique string that identifies the AWS private endpoint interface in AWS. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID STATUS ERROR + <InterfaceEndpointId> <ConnectionStatus> <ErrorMessage> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details of the AWS private endpoint interface with the ID + vpce-00713b5e644e830a3 in AWS for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: + atlas privateEndpoints aws interfaces describe + vpce-00713b5e644e830a3 --endpointServiceId 5f4fc14da2b47835a58c63a2 diff --git a/source/command/atlas-privateEndpoints-aws-interfaces.txt b/source/command/atlas-privateEndpoints-aws-interfaces.txt new file mode 100644 index 00000000..a4bd01f1 --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-interfaces.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-interfaces: + +===================================== +atlas privateEndpoints aws interfaces +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas AWS private endpoint interfaces. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for interfaces + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-aws-interfaces-create` - Create a new interface for the specified AWS private endpoint. +* :ref:`atlas-privateEndpoints-aws-interfaces-delete` - Remove the specified AWS private endpoint interface and related service from your project. +* :ref:`atlas-privateEndpoints-aws-interfaces-describe` - Return the details for the specified AWS private endpoint interface for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-privateEndpoints-aws-interfaces-create> + delete </command/atlas-privateEndpoints-aws-interfaces-delete> + describe </command/atlas-privateEndpoints-aws-interfaces-describe> + diff --git a/source/command/atlas-privateEndpoints-aws-list.txt b/source/command/atlas-privateEndpoints-aws-list.txt new file mode 100644 index 00000000..5388ada1 --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-list.txt @@ -0,0 +1,78 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-list: + +=============================== +atlas privateEndpoints aws list +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all AWS private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all AWS private endpoints for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-aws-watch.txt b/source/command/atlas-privateEndpoints-aws-watch.txt new file mode 100644 index 00000000..bda830fc --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws-watch.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws-watch: + +================================ +atlas privateEndpoints aws watch +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified AWS private endpoint in your project until it becomes available. + +This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. +Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints aws watch <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Private endpoint changes completed. + + +Examples +-------- + +.. code-block:: + + # Watch for the AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 to become available in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints aws watch 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-privateEndpoints-aws.txt b/source/command/atlas-privateEndpoints-aws.txt new file mode 100644 index 00000000..c0939da7 --- /dev/null +++ b/source/command/atlas-privateEndpoints-aws.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-aws: + +========================== +atlas privateEndpoints aws +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage AWS Private Endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for aws + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-aws-create` - Create a new AWS private endpoint for your project. +* :ref:`atlas-privateEndpoints-aws-delete` - Remove the specified AWS private endpoint from your project. +* :ref:`atlas-privateEndpoints-aws-describe` - Return the details for the specified AWS private endpoints for your project. +* :ref:`atlas-privateEndpoints-aws-interfaces` - Manage Atlas AWS private endpoint interfaces. +* :ref:`atlas-privateEndpoints-aws-list` - Return all AWS private endpoints for your project. +* :ref:`atlas-privateEndpoints-aws-watch` - Watch the specified AWS private endpoint in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + create </command/atlas-privateEndpoints-aws-create> + delete </command/atlas-privateEndpoints-aws-delete> + describe </command/atlas-privateEndpoints-aws-describe> + interfaces </command/atlas-privateEndpoints-aws-interfaces> + list </command/atlas-privateEndpoints-aws-list> + watch </command/atlas-privateEndpoints-aws-watch> + diff --git a/source/command/atlas-privateEndpoints-azure-create.txt b/source/command/atlas-privateEndpoints-azure-create.txt new file mode 100644 index 00000000..ff3f0fad --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-create.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-create: + +=================================== +atlas privateEndpoints azure create +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new Azure private endpoint for your project. + +To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '<Id>' created. + + +Examples +-------- + +.. code-block:: + + # Create a private endpoint connection for Azure in the eastus region for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure create --region eastus --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-azure-delete.txt b/source/command/atlas-privateEndpoints-azure-delete.txt new file mode 100644 index 00000000..f57bd835 --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-delete: + +=================================== +atlas privateEndpoints azure delete +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified Azure private endpoint from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure delete <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure delete 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-privateEndpoints-azure-describe.txt b/source/command/atlas-privateEndpoints-azure-describe.txt new file mode 100644 index 00000000..8cfb0d41 --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-describe: + +===================================== +atlas privateEndpoints azure describe +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified Azure private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure describe <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID ENDPOINT SERVICE STATUS ERROR + <Id> <PrivateLinkServiceName> <Status> <ErrorMessage> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the Azure private endpoint connection with the ID 5f4fc81c1f03a835c2728ff7 for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure describe 5f4fc81c1f03a835c2728ff7 --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-azure-interfaces-create.txt b/source/command/atlas-privateEndpoints-azure-interfaces-create.txt new file mode 100644 index 00000000..2c6ade67 --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-interfaces-create.txt @@ -0,0 +1,115 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-interfaces-create: + +============================================== +atlas privateEndpoints azure interfaces create +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new interface for the specified Azure private endpoint. + +To learn more about how to set up private endpoints with the Atlas CLI, see the tutorial on the Atlas CLI tab here: https://www.mongodb.com/docs/atlas/security-cluster-private-endpoint/. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure interfaces create <endpointServiceId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --privateEndpointId + - string + - true + - Unique string that identifies the Azure private endpoint in Azure. The Properties page for your private endpoint on your Azure dashboard displays this property in the Resource ID field. + * - --privateEndpointIpAddress + - string + - true + - Private IP address of the private endpoint network interface you created in your Azure VNet. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '<PrivateEndpointResourceId>' created. + + +Examples +-------- + +.. code-block:: + + # Create a new interface for an Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas and the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/test-endpoint in Azure for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure interfaces create 5f4fc14da2b47835a58c63a2 --privateEndpointId /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/test-endpoint --projectId 5e2211c17a3e5a48f5497de3 --privateEndpointIpAddress 192.0.2.5 + --output json diff --git a/source/command/atlas-privateEndpoints-azure-interfaces-delete.txt b/source/command/atlas-privateEndpoints-azure-interfaces-delete.txt new file mode 100644 index 00000000..f4cb41f4 --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-interfaces-delete.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-interfaces-delete: + +============================================== +atlas privateEndpoints azure interfaces delete +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified Azure private endpoint interface and related service from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure interfaces delete <privateEndpointResourceId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointResourceId + - string + - true + - Unique string that identifies the Azure private endpoint interface in Azure. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - false + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the Azure private endpoint interface with the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test in Azure from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure interfaces delete /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt b/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt new file mode 100644 index 00000000..4f127320 --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-interfaces-describe.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-interfaces-describe: + +================================================ +atlas privateEndpoints azure interfaces describe +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified Azure private endpoint interface for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure interfaces describe <privateEndpointResourceId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointResourceId + - string + - true + - Unique string that identifies the Azure private endpoint interface in Azure. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID IP ADDRESS STATUS ERROR + <PrivateEndpointResourceId> <PrivateEndpointIPAddress> <Status> <ErrorMessage> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details of the Azure private endpoint interface with the ID /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test in Azure for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: + atlas privateEndpoints azure interfaces describe /subscriptions/4e133d35-e734-4385-a565-c0945567ae346/resourceGroups/rg_95847a959b876e255dbb9b33_dfragd7w/providers/Microsoft.Network/privateEndpoints/cli-test --endpointServiceId 5f4fc14da2b47835a58c63a2 diff --git a/source/command/atlas-privateEndpoints-azure-interfaces.txt b/source/command/atlas-privateEndpoints-azure-interfaces.txt new file mode 100644 index 00000000..bf9dff70 --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-interfaces.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-interfaces: + +======================================= +atlas privateEndpoints azure interfaces +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Azure private endpoint interfaces. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for interfaces + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-azure-interfaces-create` - Create a new interface for the specified Azure private endpoint. +* :ref:`atlas-privateEndpoints-azure-interfaces-delete` - Remove the specified Azure private endpoint interface and related service from your project. +* :ref:`atlas-privateEndpoints-azure-interfaces-describe` - Return the details for the specified Azure private endpoint interface for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-privateEndpoints-azure-interfaces-create> + delete </command/atlas-privateEndpoints-azure-interfaces-delete> + describe </command/atlas-privateEndpoints-azure-interfaces-describe> + diff --git a/source/command/atlas-privateEndpoints-azure-list.txt b/source/command/atlas-privateEndpoints-azure-list.txt new file mode 100644 index 00000000..455d1b3d --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-list.txt @@ -0,0 +1,78 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-list: + +================================= +atlas privateEndpoints azure list +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all Azure private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all Azure private endpoints for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-azure-watch.txt b/source/command/atlas-privateEndpoints-azure-watch.txt new file mode 100644 index 00000000..de3c7726 --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure-watch.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure-watch: + +================================== +atlas privateEndpoints azure watch +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified Azure private endpoint in your project until it becomes available. + +This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. +Once the endpoint reaches the expected state, the command prints "Private endpoint changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints azure watch <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Private endpoint changes completed. + + +Examples +-------- + +.. code-block:: + + # Watch for the Azure private endpoint with the ID 5f4fc14da2b47835a58c63a2 to become available in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints azure watch 5f4fc14da2b47835a58c63a2 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-privateEndpoints-azure.txt b/source/command/atlas-privateEndpoints-azure.txt new file mode 100644 index 00000000..147eaf2d --- /dev/null +++ b/source/command/atlas-privateEndpoints-azure.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-azure: + +============================ +atlas privateEndpoints azure +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Azure Private Endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for azure + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-azure-create` - Create a new Azure private endpoint for your project. +* :ref:`atlas-privateEndpoints-azure-delete` - Remove the specified Azure private endpoint from your project. +* :ref:`atlas-privateEndpoints-azure-describe` - Return the details for the specified Azure private endpoint for your project. +* :ref:`atlas-privateEndpoints-azure-interfaces` - Manage Atlas Azure private endpoint interfaces. +* :ref:`atlas-privateEndpoints-azure-list` - Return all Azure private endpoints for your project. +* :ref:`atlas-privateEndpoints-azure-watch` - Watch the specified Azure private endpoint in your project until it becomes available. + + +.. toctree:: + :titlesonly: + + create </command/atlas-privateEndpoints-azure-create> + delete </command/atlas-privateEndpoints-azure-delete> + describe </command/atlas-privateEndpoints-azure-describe> + interfaces </command/atlas-privateEndpoints-azure-interfaces> + list </command/atlas-privateEndpoints-azure-list> + watch </command/atlas-privateEndpoints-azure-watch> + diff --git a/source/command/atlas-privateEndpoints-gcp-create.txt b/source/command/atlas-privateEndpoints-gcp-create.txt new file mode 100644 index 00000000..dbe3ee17 --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-create.txt @@ -0,0 +1,91 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-create: + +================================= +atlas privateEndpoints gcp create +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new GCP private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --region + - string + - true + - Cloud provider region in which you want to create the private endpoint connection. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '<Id>' created. + + +Examples +-------- + +.. code-block:: + + atlas privateEndpoints gcp create --region CENTRAL_US diff --git a/source/command/atlas-privateEndpoints-gcp-delete.txt b/source/command/atlas-privateEndpoints-gcp-delete.txt new file mode 100644 index 00000000..c9c6494f --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-delete.txt @@ -0,0 +1,103 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-delete: + +================================= +atlas privateEndpoints gcp delete +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a GCP private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp delete <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 22-character alphanumeric string that identifies the private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Private endpoint '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + atlas privateEndpoint gcp delete vpce-abcdefg0123456789 --force diff --git a/source/command/atlas-privateEndpoints-gcp-describe.txt b/source/command/atlas-privateEndpoints-gcp-describe.txt new file mode 100644 index 00000000..73002c58 --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-describe.txt @@ -0,0 +1,93 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-describe: + +=================================== +atlas privateEndpoints gcp describe +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a specific GCP private endpoint for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp describe <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 22-character alphanumeric string that identifies the private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + atlas privateEndpoint gcp describe vpce-abcdefg0123456789 diff --git a/source/command/atlas-privateEndpoints-gcp-interfaces-create.txt b/source/command/atlas-privateEndpoints-gcp-interfaces-create.txt new file mode 100644 index 00000000..7f287bab --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-interfaces-create.txt @@ -0,0 +1,118 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-interfaces-create: + +============================================ +atlas privateEndpoints gcp interfaces create +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a GCP private endpoint interface. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp interfaces create <endpointGroupId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - endpointGroupId + - string + - true + - Unique identifier for the endpoint group. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpoint + - strings + - false + - List of GCP endpoints in the group separated by commas, such as: endpointName1@ipAddress1,...,endpointNameN@ipAddressN + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - --gcpProjectId + - string + - true + - Unique identifier of the GCP project in which the network peer resides. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '<EndpointGroupName>' created. + + +Examples +-------- + +.. code-block:: + + atlas privateEndpoints gcp interfaces create endpoint-1 \ + --endpointServiceId 61eaca605af86411903de1dd \ + --gcpProjectId mcli-private-endpoints \ + --endpoint endpoint-0@10.142.0.2,endpoint-1@10.142.0.3,endpoint-2@10.142.0.4,endpoint-3@10.142.0.5,endpoint-4@10.142.0.6,endpoint-5@10.142.0.7 diff --git a/source/command/atlas-privateEndpoints-gcp-interfaces-delete.txt b/source/command/atlas-privateEndpoints-gcp-interfaces-delete.txt new file mode 100644 index 00000000..b8d3e219 --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-interfaces-delete.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-interfaces-delete: + +============================================ +atlas privateEndpoints gcp interfaces delete +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete a specific GCP private endpoint interface for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp interfaces delete <id> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - id + - string + - true + - Unique identifier for the endpoint group. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Interface endpoint '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + atlas privateEndpoints gcp interfaces delete endpoint-1 \ + --endpointServiceId 61eaca605af86411903de1dd diff --git a/source/command/atlas-privateEndpoints-gcp-interfaces-describe.txt b/source/command/atlas-privateEndpoints-gcp-interfaces-describe.txt new file mode 100644 index 00000000..9d5ab54e --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-interfaces-describe.txt @@ -0,0 +1,109 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-interfaces-describe: + +============================================== +atlas privateEndpoints gcp interfaces describe +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return a specific GCP private endpoint interface for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp interfaces describe <id> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - id + - string + - true + - Unique identifier of the private endpoint you want to retrieve. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --endpointServiceId + - string + - true + - Unique 24-character alphanumeric string that identifies the private endpoint in Atlas. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ENDPOINT STATUS DELETE REQUESTED + <EndpointGroupName> <Status> <DeleteRequested> + + +Examples +-------- + +.. code-block:: + + atlas privateEndpoints gcp interfaces describe endpoint-1 \ + --endpointServiceId 61eaca605af86411903de1dd diff --git a/source/command/atlas-privateEndpoints-gcp-interfaces.txt b/source/command/atlas-privateEndpoints-gcp-interfaces.txt new file mode 100644 index 00000000..2b0dba9b --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-interfaces.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-interfaces: + +===================================== +atlas privateEndpoints gcp interfaces +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas GCP private endpoint interfaces. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for interfaces + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-gcp-interfaces-create` - Create a GCP private endpoint interface. +* :ref:`atlas-privateEndpoints-gcp-interfaces-delete` - Delete a specific GCP private endpoint interface for your project. +* :ref:`atlas-privateEndpoints-gcp-interfaces-describe` - Return a specific GCP private endpoint interface for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-privateEndpoints-gcp-interfaces-create> + delete </command/atlas-privateEndpoints-gcp-interfaces-delete> + describe </command/atlas-privateEndpoints-gcp-interfaces-describe> + diff --git a/source/command/atlas-privateEndpoints-gcp-list.txt b/source/command/atlas-privateEndpoints-gcp-list.txt new file mode 100644 index 00000000..eb1f6463 --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-list.txt @@ -0,0 +1,77 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-list: + +=============================== +atlas privateEndpoints gcp list +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List GCP private endpoints for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + atlas privateEndpoint gcp ls diff --git a/source/command/atlas-privateEndpoints-gcp-watch.txt b/source/command/atlas-privateEndpoints-gcp-watch.txt new file mode 100644 index 00000000..891a1d05 --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp-watch.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp-watch: + +================================ +atlas privateEndpoints gcp watch +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified GCP private endpoint to detect changes in the endpoint's state. + +This command checks the endpoint's state periodically until the endpoint reaches an AVAILABLE or FAILED state. +Once the endpoint reaches the expected state, the command prints "GCP Private endpoint changes completed." +If you run the command in the terminal, it blocks the terminal session until the resource becomes available or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints gcp watch <privateEndpointId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - privateEndpointId + - string + - true + - Unique 22-character alphanumeric string that identifies the private endpoint. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + GCP Private endpoint changes completed. + + +Examples +-------- + +.. code-block:: + + atlas privateEndpoint gcp watch vpce-abcdefg0123456789 diff --git a/source/command/atlas-privateEndpoints-gcp.txt b/source/command/atlas-privateEndpoints-gcp.txt new file mode 100644 index 00000000..5ae508c7 --- /dev/null +++ b/source/command/atlas-privateEndpoints-gcp.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-gcp: + +========================== +atlas privateEndpoints gcp +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage GCP private endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for gcp + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-gcp-create` - Create a new GCP private endpoint for your project. +* :ref:`atlas-privateEndpoints-gcp-delete` - Delete a GCP private endpoint for your project. +* :ref:`atlas-privateEndpoints-gcp-describe` - Return a specific GCP private endpoint for your project. +* :ref:`atlas-privateEndpoints-gcp-interfaces` - Manage Atlas GCP private endpoint interfaces. +* :ref:`atlas-privateEndpoints-gcp-list` - List GCP private endpoints for your project. +* :ref:`atlas-privateEndpoints-gcp-watch` - Watch the specified GCP private endpoint to detect changes in the endpoint's state. + + +.. toctree:: + :titlesonly: + + create </command/atlas-privateEndpoints-gcp-create> + delete </command/atlas-privateEndpoints-gcp-delete> + describe </command/atlas-privateEndpoints-gcp-describe> + interfaces </command/atlas-privateEndpoints-gcp-interfaces> + list </command/atlas-privateEndpoints-gcp-list> + watch </command/atlas-privateEndpoints-gcp-watch> + diff --git a/source/command/atlas-privateEndpoints-regionalModes-describe.txt b/source/command/atlas-privateEndpoints-regionalModes-describe.txt new file mode 100644 index 00000000..c5238763 --- /dev/null +++ b/source/command/atlas-privateEndpoints-regionalModes-describe.txt @@ -0,0 +1,91 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-regionalModes-describe: + +============================================= +atlas privateEndpoints regionalModes describe +============================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the regionalized private endpoint setting for your project. + +Use this command to check whether you can create multiple private resources per region. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints regionalModes describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ENABLED + <Enabled> + + +Examples +-------- + +.. code-block:: + + # Return the regionalized private endpoint setting for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints regionalModes describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-regionalModes-disable.txt b/source/command/atlas-privateEndpoints-regionalModes-disable.txt new file mode 100644 index 00000000..8bbd4004 --- /dev/null +++ b/source/command/atlas-privateEndpoints-regionalModes-disable.txt @@ -0,0 +1,90 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-regionalModes-disable: + +============================================ +atlas privateEndpoints regionalModes disable +============================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable the regionalized private endpoint setting for your project. + +This disables the ability to create multiple private resources per region in all cloud service providers for this project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints regionalModes disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Regionalized private endpoint setting disabled. + + +Examples +-------- + +.. code-block:: + + # Disable the regionalied private endpoint setting in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints regionalModes disable --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-regionalModes-enable.txt b/source/command/atlas-privateEndpoints-regionalModes-enable.txt new file mode 100644 index 00000000..7d29ed76 --- /dev/null +++ b/source/command/atlas-privateEndpoints-regionalModes-enable.txt @@ -0,0 +1,90 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-regionalModes-enable: + +=========================================== +atlas privateEndpoints regionalModes enable +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable the regionalized private endpoint setting for your project. + +This enables the ability to create multiple private resources per region in all cloud service providers for this project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas privateEndpoints regionalModes enable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for enable + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Regionalized private endpoint setting enabled. + + +Examples +-------- + +.. code-block:: + + # Enable the regionalied private endpoint setting in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas privateEndpoints regionalModes enable --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-privateEndpoints-regionalModes.txt b/source/command/atlas-privateEndpoints-regionalModes.txt new file mode 100644 index 00000000..4ee10300 --- /dev/null +++ b/source/command/atlas-privateEndpoints-regionalModes.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints-regionalModes: + +==================================== +atlas privateEndpoints regionalModes +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage regionalized private endpoint setting for your Atlas project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for regionalModes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-regionalModes-describe` - Return the regionalized private endpoint setting for your project. +* :ref:`atlas-privateEndpoints-regionalModes-disable` - Disable the regionalized private endpoint setting for your project. +* :ref:`atlas-privateEndpoints-regionalModes-enable` - Enable the regionalized private endpoint setting for your project. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-privateEndpoints-regionalModes-describe> + disable </command/atlas-privateEndpoints-regionalModes-disable> + enable </command/atlas-privateEndpoints-regionalModes-enable> + diff --git a/source/command/atlas-privateEndpoints.txt b/source/command/atlas-privateEndpoints.txt new file mode 100644 index 00000000..f4859ef7 --- /dev/null +++ b/source/command/atlas-privateEndpoints.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-privateEndpoints: + +====================== +atlas privateEndpoints +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas private endpoints. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for privateEndpoints + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-privateEndpoints-aws` - Manage AWS Private Endpoints. +* :ref:`atlas-privateEndpoints-azure` - Manage Azure Private Endpoints. +* :ref:`atlas-privateEndpoints-gcp` - Manage GCP private endpoints. +* :ref:`atlas-privateEndpoints-regionalModes` - Manage regionalized private endpoint setting for your Atlas project. + + +.. toctree:: + :titlesonly: + + aws </command/atlas-privateEndpoints-aws> + azure </command/atlas-privateEndpoints-azure> + gcp </command/atlas-privateEndpoints-gcp> + regionalModes </command/atlas-privateEndpoints-regionalModes> + diff --git a/source/command/atlas-processes-describe.txt b/source/command/atlas-processes-describe.txt new file mode 100644 index 00000000..353ed45e --- /dev/null +++ b/source/command/atlas-processes-describe.txt @@ -0,0 +1,103 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-processes-describe: + +======================== +atlas processes describe +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified MongoDB process for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas processes describe <hostname:port> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - hostname:port + - string + - true + - Hostname and port number of the instance running the Atlas MongoDB process. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID REPLICA SET NAME SHARD NAME VERSION + <Id> <ReplicaSetName> <ShardName> <Version> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the MongoDB process with hostname and port atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 + atlas process describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json diff --git a/source/command/atlas-processes-list.txt b/source/command/atlas-processes-list.txt new file mode 100644 index 00000000..e83ad80d --- /dev/null +++ b/source/command/atlas-processes-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-processes-list: + +==================== +atlas processes list +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all MongoDB processes for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas processes list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all MongoDB processes in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas processes list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-processes.txt b/source/command/atlas-processes.txt new file mode 100644 index 00000000..24f3500a --- /dev/null +++ b/source/command/atlas-processes.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-processes: + +=============== +atlas processes +=============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage MongoDB processes for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for processes + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-processes-describe` - Return the details for the specified MongoDB process for your project. +* :ref:`atlas-processes-list` - Return all MongoDB processes for your project. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-processes-describe> + list </command/atlas-processes-list> + diff --git a/source/command/atlas-projects-apiKeys-assign.txt b/source/command/atlas-projects-apiKeys-assign.txt new file mode 100644 index 00000000..223743d2 --- /dev/null +++ b/source/command/atlas-projects-apiKeys-assign.txt @@ -0,0 +1,110 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-apiKeys-assign: + +============================= +atlas projects apiKeys assign +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Assign the specified organization API key to your project and modify the API key's roles for the project. + +When you modify the roles for an organization API key with this command, the values you specify overwrite the existing roles assigned to the API key. + +To view possible values for the ID argument, run atlas organizations apiKeys list. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects apiKeys assign <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for assign + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key successfully assigned. + + +Examples +-------- + +.. code-block:: + + # Assign an organization API key with the ID 5f46ae53d58b421fe3edc115 and grant the GROUP_DATA_ACCESS_READ_WRITE role for the project with ID 5e2211c17a3e5a48f5497de3: + atlas projects apiKeys assign 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_DATA_ACCESS_READ_WRITE --output json diff --git a/source/command/atlas-projects-apiKeys-create.txt b/source/command/atlas-projects-apiKeys-create.txt new file mode 100644 index 00000000..3d130dc8 --- /dev/null +++ b/source/command/atlas-projects-apiKeys-create.txt @@ -0,0 +1,100 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-apiKeys-create: + +============================= +atlas projects apiKeys create +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an organization API key and assign it to your project. + +MongoDB returns the private API key only once. After you run this command, immediately copy, save, and secure both the public and private API keys. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects apiKeys create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --desc + - string + - true + - Description of the API key. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '<Id>' created. + Public API Key <PublicKey> + Private API Key <PrivateKey> + + +Examples +-------- + +.. code-block:: + + # Create an organization API key with the ORG_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3: + atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role ORG_OWNER --output json diff --git a/source/command/atlas-projects-apiKeys-delete.txt b/source/command/atlas-projects-apiKeys-delete.txt new file mode 100644 index 00000000..e6215595 --- /dev/null +++ b/source/command/atlas-projects-apiKeys-delete.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-apiKeys-delete: + +============================= +atlas projects apiKeys delete +============================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified organization API key from your project. + +The API key still exists at the organization level. To reassign the organization API key to a project, run the atlas projects apiKeys assign command. + +To view possible values for the ID argument, run atlas organizations apiKeys list. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects apiKeys delete <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies your API key. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + API Key '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3: + atlas projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 diff --git a/source/command/atlas-projects-apiKeys-list.txt b/source/command/atlas-projects-apiKeys-list.txt new file mode 100644 index 00000000..f47f2882 --- /dev/null +++ b/source/command/atlas-projects-apiKeys-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-apiKeys-list: + +=========================== +atlas projects apiKeys list +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all organization API keys assigned to your project. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects apiKeys list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of organization API keys assigned to the project with ID 5e2211c17a3e5a48f5497de3: + atlas projects apiKeys list --projectId 5e1234c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-projects-apiKeys.txt b/source/command/atlas-projects-apiKeys.txt new file mode 100644 index 00000000..9f9f8366 --- /dev/null +++ b/source/command/atlas-projects-apiKeys.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-apiKeys: + +====================== +atlas projects apiKeys +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage API Keys for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for apiKeys + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-apiKeys-assign` - Assign the specified organization API key to your project and modify the API key's roles for the project. +* :ref:`atlas-projects-apiKeys-create` - Create an organization API key and assign it to your project. +* :ref:`atlas-projects-apiKeys-delete` - Remove the specified organization API key from your project. +* :ref:`atlas-projects-apiKeys-list` - Return all organization API keys assigned to your project. + + +.. toctree:: + :titlesonly: + + assign </command/atlas-projects-apiKeys-assign> + create </command/atlas-projects-apiKeys-create> + delete </command/atlas-projects-apiKeys-delete> + list </command/atlas-projects-apiKeys-list> + diff --git a/source/command/atlas-projects-create.txt b/source/command/atlas-projects-create.txt new file mode 100644 index 00000000..0b79f50a --- /dev/null +++ b/source/command/atlas-projects-create.txt @@ -0,0 +1,122 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-create: + +===================== +atlas projects create +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a project in your organization. + +Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects create <projectName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - projectName + - string + - true + - Label that identifies the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --govCloudRegionsOnly + - + - false + - Flag that designates that the project uses only the AWS GovCloud region. Use this option only for Atlas for Government projects. If unspecified, the project uses only the AWS Standard region for AWS deployments. You can't deploy clusters across AWS GovCloud and AWS Standard regions in the same project. + * - -h, --help + - + - false + - help for create + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --ownerId + - string + - false + - Unique 24-digit string that identifies the Atlas user to be granted the Project Owner role on the specified project. If unspecified, this value defaults to the user ID of the oldest Organization Owner. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. + * - --withoutDefaultAlertSettings + - + - false + - Flag that creates the new project without the default alert settings enabled. This flag defaults to false. This option is useful if you create projects programmatically and want to create your own alerts instead of using the default alert settings. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project '<Id>' created. + + +Examples +-------- + +.. code-block:: + + # Create a project in the organization with the ID 5e2211c17a3e5a48f5497de3 using default alert settings: + atlas projects create my-project --orgId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-projects-delete.txt b/source/command/atlas-projects-delete.txt new file mode 100644 index 00000000..35189040 --- /dev/null +++ b/source/command/atlas-projects-delete.txt @@ -0,0 +1,100 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-delete: + +===================== +atlas projects delete +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects delete <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects delete 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-projects-describe.txt b/source/command/atlas-projects-describe.txt new file mode 100644 index 00000000..266cfbc5 --- /dev/null +++ b/source/command/atlas-projects-describe.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-describe: + +======================= +atlas projects describe +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects describe <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + <Id> <Name> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects describe 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-projects-invitations-delete.txt b/source/command/atlas-projects-invitations-delete.txt new file mode 100644 index 00000000..80b1bd2a --- /dev/null +++ b/source/command/atlas-projects-invitations-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-invitations-delete: + +================================= +atlas projects invitations delete +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified pending invitation to your project. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects invitations delete <invitationId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - true + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Invitation '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the pending invitation with the ID 5dd56c847a3e5a1f363d424d from the project with the ID 5f71e5255afec75a3d0f96dc: + atlas projects invitations delete 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc diff --git a/source/command/atlas-projects-invitations-describe.txt b/source/command/atlas-projects-invitations-describe.txt new file mode 100644 index 00000000..6e2415d0 --- /dev/null +++ b/source/command/atlas-projects-invitations-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-invitations-describe: + +=================================== +atlas projects invitations describe +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified pending invitation to your project. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects invitations describe <invitationId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - true + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID USERNAME CREATED AT EXPIRES AT + <Id> <Username> <CreatedAt> <ExpiresAt> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details of the pending invitation with the ID 5dd56c847a3e5a1f363d424d for the project with the ID 5f71e5255afec75a3d0f96dc: + atlas projects invitations describe 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --output json diff --git a/source/command/atlas-projects-invitations-invite.txt b/source/command/atlas-projects-invitations-invite.txt new file mode 100644 index 00000000..63d048a7 --- /dev/null +++ b/source/command/atlas-projects-invitations-invite.txt @@ -0,0 +1,112 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-invitations-invite: + +================================= +atlas projects invitations invite +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invite the specified MongoDB user to your project. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects invitations invite <email> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - email + - string + - true + - Email address that belongs to the user that you want to invite to the project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for invite + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - User's roles for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. + * - --teamId + - strings + - false + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User '<Username>' invited. + + +Examples +-------- + +.. code-block:: + + # Invite the MongoDB user with the email user@example.com to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: + atlas projects invitations invite user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json diff --git a/source/command/atlas-projects-invitations-list.txt b/source/command/atlas-projects-invitations-list.txt new file mode 100644 index 00000000..d3830e92 --- /dev/null +++ b/source/command/atlas-projects-invitations-list.txt @@ -0,0 +1,82 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-invitations-list: + +=============================== +atlas projects invitations list +=============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all pending invitations to your project. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects invitations list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --email + - string + - false + - Email address for the user. + * - -h, --help + - + - false + - help for list + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of pending invitations to the project with the ID 5f71e5255afec75a3d0f96dc: + atlas projects invitations list --projectId 5f71e5255afec75a3d0f96dc --output json diff --git a/source/command/atlas-projects-invitations-update.txt b/source/command/atlas-projects-invitations-update.txt new file mode 100644 index 00000000..a7ecbd00 --- /dev/null +++ b/source/command/atlas-projects-invitations-update.txt @@ -0,0 +1,120 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-invitations-update: + +================================= +atlas projects invitations update +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modifies the details of the specified pending invitation to your project. + +You can use either the invitation ID or the user's email address to specify the invitation. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects invitations update [invitationId] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - invitationId + - string + - false + - Unique 24-digit string that identifies the invitation. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --email + - string + - false + - Email address for the user. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - User's roles for the associated organization. Valid values include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Invitation <Id> updated. + + +Examples +-------- + +.. code-block:: + + # Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant GROUP_READ_ONLY access the project with the ID 5f71e5255afec75a3d0f96dc: + atlas projects invitations update 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json + + +.. code-block:: + + # Modify the invitation for the user with the email address user@example.com to grant GROUP_READ_ONLY access the project with the ID 5f71e5255afec75a3d0f96dc: + atlas projects invitations update --email user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json diff --git a/source/command/atlas-projects-invitations.txt b/source/command/atlas-projects-invitations.txt new file mode 100644 index 00000000..64ed9652 --- /dev/null +++ b/source/command/atlas-projects-invitations.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-invitations: + +========================== +atlas projects invitations +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Invitation operations. + +Create, list and manage your MongoDB project invites. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for invitations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-invitations-delete` - Remove the specified pending invitation to your project. +* :ref:`atlas-projects-invitations-describe` - Return the details for the specified pending invitation to your project. +* :ref:`atlas-projects-invitations-invite` - Invite the specified MongoDB user to your project. +* :ref:`atlas-projects-invitations-list` - Return all pending invitations to your project. +* :ref:`atlas-projects-invitations-update` - Modifies the details of the specified pending invitation to your project. + + +.. toctree:: + :titlesonly: + + delete </command/atlas-projects-invitations-delete> + describe </command/atlas-projects-invitations-describe> + invite </command/atlas-projects-invitations-invite> + list </command/atlas-projects-invitations-list> + update </command/atlas-projects-invitations-update> + diff --git a/source/command/atlas-projects-list.txt b/source/command/atlas-projects-list.txt new file mode 100644 index 00000000..de7112f9 --- /dev/null +++ b/source/command/atlas-projects-list.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-list: + +=================== +atlas projects list +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all projects. + +To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + <Id> <Name> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all projects: + atlas projects list --output json diff --git a/source/command/atlas-projects-settings-describe.txt b/source/command/atlas-projects-settings-describe.txt new file mode 100644 index 00000000..f633ebc2 --- /dev/null +++ b/source/command/atlas-projects-settings-describe.txt @@ -0,0 +1,87 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-settings-describe: + +================================ +atlas projects settings describe +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Retrieve details for settings to the specified project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects settings describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + COLLECT DATABASE SPECIFICS STATISTICS ENABLED DATA EXPLORER ENABLED PERFORMANCE ADVISOR ENABLED REALTIME PERFORMANCE PANEL ENABLED SCHEMA ADVISOR ENABLED + <IsCollectDatabaseSpecificsStatisticsEnabled> <IsDataExplorerEnabled> <IsPerformanceAdvisorEnabled> <IsRealtimePerformancePanelEnabled> <IsSchemaAdvisorEnabled> + + +Examples +-------- + +.. code-block:: + + # This example uses the profile named "myprofile" for accessing Atlas. + atlas projects settings describe -P myprofile --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-projects-settings-update.txt b/source/command/atlas-projects-settings-update.txt new file mode 100644 index 00000000..447587b4 --- /dev/null +++ b/source/command/atlas-projects-settings-update.txt @@ -0,0 +1,146 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-settings-update: + +============================== +atlas projects settings update +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates settings for a project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects settings update [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableCollectDatabaseSpecificsStatistics + - + - false + - Flag that disables the Collect Database Specific Statistics project setting. + + Mutually exclusive with --enableCollectDatabaseSpecificsStatistics. + * - --disableDataExplorer + - + - false + - Flag that disables the Data Explorer project setting. + + Mutually exclusive with --enableDataExplorer. + * - --disablePerformanceAdvisor + - + - false + - Flag that disables the Performance Advisor project setting. + + Mutually exclusive with --enablePerformanceAdvisor. + * - --disableRealtimePerformancePanel + - + - false + - Flag that disables the Real Time Performance Panel project setting. + + Mutually exclusive with --enableRealtimePerformancePanel. + * - --disableSchemaAdvisor + - + - false + - Flag that disables the Schema Advisor project setting. + + Mutually exclusive with --enableSchemaAdvisor. + * - --enableCollectDatabaseSpecificsStatistics + - + - false + - Flag that enables the Collect Database Specific Statistics project setting. + + Mutually exclusive with --disableCollectDatabaseSpecificsStatistics. + * - --enableDataExplorer + - + - false + - Flag that enables the Data Explorer project setting. + + Mutually exclusive with --disableDataExplorer. + * - --enablePerformanceAdvisor + - + - false + - Flag that enables the Performance Advisor project setting. + + Mutually exclusive with --disablePerformanceAdvisor. + * - --enableRealtimePerformancePanel + - + - false + - Flag that enables the Real Time Performance Panel project setting. + + Mutually exclusive with --disableRealtimePerformancePanel. + * - --enableSchemaAdvisor + - + - false + - Flag that enables the Schema Advisor project setting. + + Mutually exclusive with --disableSchemaAdvisor. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project settings updated. + + +Examples +-------- + +.. code-block:: + + # This example uses the profile named "myprofile" for accessing Atlas. + atlas projects settings update --disableCollectDatabaseSpecificsStatistics -P myprofile --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-projects-settings.txt b/source/command/atlas-projects-settings.txt new file mode 100644 index 00000000..20b9cfb7 --- /dev/null +++ b/source/command/atlas-projects-settings.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-settings: + +======================= +atlas projects settings +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Settings operations. + +Manage your project settings. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for settings + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-settings-describe` - Retrieve details for settings to the specified project. +* :ref:`atlas-projects-settings-update` - Updates settings for a project. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-projects-settings-describe> + update </command/atlas-projects-settings-update> + diff --git a/source/command/atlas-projects-teams-add.txt b/source/command/atlas-projects-teams-add.txt new file mode 100644 index 00000000..e4b55739 --- /dev/null +++ b/source/command/atlas-projects-teams-add.txt @@ -0,0 +1,110 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-teams-add: + +======================== +atlas projects teams add +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Add the specified team to your project. + +All members of the team share the same project access. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects teams add <teamId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for add + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team added to the project. + + +Examples +-------- + +.. code-block:: + + # Add the team with the ID 5dd58c647a3e5a6c5bce46c7 to the project with the ID 5e2211c17a3e5a48f5497de3 with GROUP_READ_ONLY project access: + atlas projects teams add 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 --role GROUP_READ_ONLY diff --git a/source/command/atlas-projects-teams-delete.txt b/source/command/atlas-projects-teams-delete.txt new file mode 100644 index 00000000..a47cc351 --- /dev/null +++ b/source/command/atlas-projects-teams-delete.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-teams-delete: + +=========================== +atlas projects teams delete +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified team from your project. + +After you remove a team from your project, the team still exists in the organization in which it was created. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects teams delete <teamId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the team with the ID 5dd58c647a3e5a6c5bce46c7 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects teams delete 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-projects-teams-list.txt b/source/command/atlas-projects-teams-list.txt new file mode 100644 index 00000000..bbcf621b --- /dev/null +++ b/source/command/atlas-projects-teams-list.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-teams-list: + +========================= +atlas projects teams list +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all teams for a project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects teams list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID + <TeamId> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all teams for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects teams list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-projects-teams-update.txt b/source/command/atlas-projects-teams-update.txt new file mode 100644 index 00000000..dcce9eb2 --- /dev/null +++ b/source/command/atlas-projects-teams-update.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-teams-update: + +=========================== +atlas projects teams update +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the roles for the specified team for your project. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects teams update <teamId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --role + - strings + - true + - User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team's roles updated. + + +Examples +-------- + +.. code-block:: + + # Modify the roles for the team with the ID 5dd56c847a3e5a1f363d424d to grant GROUP_READ_ONLY access to the project with the ID 5f71e5255afec75a3d0f96dc: + atlas projects teams update 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json diff --git a/source/command/atlas-projects-teams.txt b/source/command/atlas-projects-teams.txt new file mode 100644 index 00000000..d8336591 --- /dev/null +++ b/source/command/atlas-projects-teams.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-teams: + +==================== +atlas projects teams +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas teams. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for teams + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-teams-add` - Add the specified team to your project. +* :ref:`atlas-projects-teams-delete` - Remove the specified team from your project. +* :ref:`atlas-projects-teams-list` - Return all teams for a project. +* :ref:`atlas-projects-teams-update` - Modify the roles for the specified team for your project. + + +.. toctree:: + :titlesonly: + + add </command/atlas-projects-teams-add> + delete </command/atlas-projects-teams-delete> + list </command/atlas-projects-teams-list> + update </command/atlas-projects-teams-update> + diff --git a/source/command/atlas-projects-update.txt b/source/command/atlas-projects-update.txt new file mode 100644 index 00000000..54f5c22c --- /dev/null +++ b/source/command/atlas-projects-update.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-update: + +===================== +atlas projects update +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update a project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects update <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - ID of the project you want to update. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - true + - Path to the JSON configuration file that defines project configuration settings. To learn more about project configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/project-config-file. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Project '<Id>' updated. + + +Examples +-------- + +.. code-block:: + + # Update a project with the ID 5e2211c17a3e5a48f5497de3 using the JSON file named myProject.json: + atlas projects update 5f4007f327a3bd7b6f4103c5 --file myProject.json --output json diff --git a/source/command/atlas-projects-users-delete.txt b/source/command/atlas-projects-users-delete.txt new file mode 100644 index 00000000..a633403a --- /dev/null +++ b/source/command/atlas-projects-users-delete.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-users-delete: + +=========================== +atlas projects users delete +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified user from your project. + +After you remove a user from your project, the user still exists in the organization in which it was created. + +To use this command, you must authenticate with a user account or an API key with the Project User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects users delete <ID> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - ID + - string + - true + - Unique 24-digit string that identifies the user. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User '<Name>' deleted from the project + + +Examples +-------- + +.. code-block:: + + # Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects users delete 5dd58c647a3e5a6c5bce46c7 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-projects-users-list.txt b/source/command/atlas-projects-users-list.txt new file mode 100644 index 00000000..afb5231c --- /dev/null +++ b/source/command/atlas-projects-users-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-users-list: + +========================= +atlas projects users list +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all users for a project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas projects users list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all users for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas projects users list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-projects-users.txt b/source/command/atlas-projects-users.txt new file mode 100644 index 00000000..96da48c0 --- /dev/null +++ b/source/command/atlas-projects-users.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects-users: + +==================== +atlas projects users +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage users for a project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for users + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-users-delete` - Remove the specified user from your project. +* :ref:`atlas-projects-users-list` - Return all users for a project. + + +.. toctree:: + :titlesonly: + + delete </command/atlas-projects-users-delete> + list </command/atlas-projects-users-list> + diff --git a/source/command/atlas-projects.txt b/source/command/atlas-projects.txt new file mode 100644 index 00000000..10fdcdb8 --- /dev/null +++ b/source/command/atlas-projects.txt @@ -0,0 +1,82 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-projects: + +============== +atlas projects +============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas projects. + +Create, list and manage your MongoDB projects. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for projects + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-projects-apiKeys` - Manage API Keys for your project. +* :ref:`atlas-projects-create` - Create a project in your organization. +* :ref:`atlas-projects-delete` - Remove the specified project. +* :ref:`atlas-projects-describe` - Return the details for the specified project. +* :ref:`atlas-projects-invitations` - Invitation operations. +* :ref:`atlas-projects-list` - Return all projects. +* :ref:`atlas-projects-settings` - Settings operations. +* :ref:`atlas-projects-teams` - Manage your Atlas teams. +* :ref:`atlas-projects-update` - Update a project. +* :ref:`atlas-projects-users` - Manage users for a project. + + +.. toctree:: + :titlesonly: + + apiKeys </command/atlas-projects-apiKeys> + create </command/atlas-projects-create> + delete </command/atlas-projects-delete> + describe </command/atlas-projects-describe> + invitations </command/atlas-projects-invitations> + list </command/atlas-projects-list> + settings </command/atlas-projects-settings> + teams </command/atlas-projects-teams> + update </command/atlas-projects-update> + users </command/atlas-projects-users> + diff --git a/source/command/atlas-security-customerCerts-create.txt b/source/command/atlas-security-customerCerts-create.txt new file mode 100644 index 00000000..4f8d30f0 --- /dev/null +++ b/source/command/atlas-security-customerCerts-create.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-customerCerts-create: + +=================================== +atlas security customerCerts create +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Saves a customer-managed X.509 configuration for your project. + +Saving a customer-managed X.509 configuration triggers a rolling restart. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security customerCerts create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --casFile + - string + - true + - Path to a PEM file containing one or more CAs for database user authentication. + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Certificate successfully created. + + +Examples +-------- + +.. code-block:: + + # Save the file named ca.pem stored in the files directory to the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security customerCerts create --casFile files/ca.pem --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-security-customerCerts-describe.txt b/source/command/atlas-security-customerCerts-describe.txt new file mode 100644 index 00000000..ec9736ee --- /dev/null +++ b/source/command/atlas-security-customerCerts-describe.txt @@ -0,0 +1,78 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-customerCerts-describe: + +===================================== +atlas security customerCerts describe +===================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the current customer-managed X.509 configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security customerCerts describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the customer-managed X.509 configuration in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security customerCerts describe --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-security-customerCerts-disable.txt b/source/command/atlas-security-customerCerts-disable.txt new file mode 100644 index 00000000..adcd8543 --- /dev/null +++ b/source/command/atlas-security-customerCerts-disable.txt @@ -0,0 +1,86 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-customerCerts-disable: + +==================================== +atlas security customerCerts disable +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. + +Disabling customer-managed X.509 triggers a rolling restart. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security customerCerts disable [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for disable + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + X.509 configuration for project <Name> was deleted. + + +Examples +-------- + +.. code-block:: + + # Disable the customer-managed X.509 configuration in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security customerCerts disable --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-security-customerCerts.txt b/source/command/atlas-security-customerCerts.txt new file mode 100644 index 00000000..0ed00e3f --- /dev/null +++ b/source/command/atlas-security-customerCerts.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-customerCerts: + +============================ +atlas security customerCerts +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage customer x509 certificates for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for customerCerts + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-security-customerCerts-create` - Saves a customer-managed X.509 configuration for your project. +* :ref:`atlas-security-customerCerts-describe` - Return the details for the current customer-managed X.509 configuration for your project. +* :ref:`atlas-security-customerCerts-disable` - Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, and disable self-managed X.509. + + +.. toctree:: + :titlesonly: + + create </command/atlas-security-customerCerts-create> + describe </command/atlas-security-customerCerts-describe> + disable </command/atlas-security-customerCerts-disable> + diff --git a/source/command/atlas-security-ldap-delete.txt b/source/command/atlas-security-ldap-delete.txt new file mode 100644 index 00000000..462db797 --- /dev/null +++ b/source/command/atlas-security-ldap-delete.txt @@ -0,0 +1,88 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-ldap-delete: + +========================== +atlas security ldap delete +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the current LDAP configuration captured in the userToDNMapping document from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap delete [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + LDAP configuration userToDNMapping deleted from project'<Name>' + + +Examples +-------- + +.. code-block:: + + # Remove the current LDAP configuration in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security ldap delete --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-security-ldap-get.txt b/source/command/atlas-security-ldap-get.txt new file mode 100644 index 00000000..297dc028 --- /dev/null +++ b/source/command/atlas-security-ldap-get.txt @@ -0,0 +1,89 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-ldap-get: + +======================= +atlas security ldap get +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the current LDAP configuration details for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap get [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for get + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + HOSTNAME PORT AUTHENTICATION AUTHORIZATION + <Ldap.Hostname> <Ldap.Port> <Ldap.AuthenticationEnabled> <Ldap.AuthorizationEnabled> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details of the current LDAP configuration in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security ldap get --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-security-ldap-save.txt b/source/command/atlas-security-ldap-save.txt new file mode 100644 index 00000000..63967a25 --- /dev/null +++ b/source/command/atlas-security-ldap-save.txt @@ -0,0 +1,140 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-ldap-save: + +======================== +atlas security ldap save +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Save an LDAP configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap save [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authenticationEnabled + - + - false + - Flag that indicates whether to enable LDAP user authentication. + * - --authorizationEnabled + - + - false + - Flag that indicates whether to enable LDAP user authorization. + * - --authzQueryTemplate + - string + - false + - RFC 4515-formatted or RFC 4516-formatted LDAP query template that Atlas executes to obtain the LDAP authorization groups to which the authenticated user belongs. Use the {USER} placeholder in the URL to substitute the username. The query is relative to the host specified with the hostname. + * - --bindPassword + - string + - false + - Password used to authenticate the bindUsername. + * - --bindUsername + - string + - true + - User distinguished name (DN) that Atlas uses to connect to the LDAP server. You must format LDAP distinguished names according to RFC 2253. + * - --caCertificate + - string + - false + - Certificate Authority (CA) used to verify the identity of the LDAP server. To delete an assigned value, pass an empty string. + * - -h, --help + - + - false + - help for save + * - --hostname + - string + - true + - Hostname or IP address of the LDAP server. + * - --mappingLdapQuery + - string + - false + - RFC 4515-formatted or RFC 4516-formatted LDAP query template that inserts the LDAP name that the regex matches into an LDAP query URI. + + Mutually exclusive with --mappingSubstitution, --mappingSubstitution. + * - --mappingMatch + - string + - false + - ECMAScript-formatted regular expression (regex) to match against a provided username. + * - --mappingSubstitution + - string + - false + - LDAP distinguished name (DN) template that converts the LDAP username that matches the regex specified in the match option into an LDAP DN. + + Mutually exclusive with --mappingLdapQuery, --mappingLdapQuery. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --port + - int + - false + - Port that the LDAP server listens to for client connections. This value defaults to 636. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + HOSTNAME PORT AUTHENTICATION AUTHORIZATION + <Ldap.Hostname> <Ldap.Port> <Ldap.AuthenticationEnabled> <Ldap.AuthorizationEnabled> + + +Examples +-------- + +.. code-block:: + + # Save an LDAP server configuration to authenticate and authorize MongoDB users for the host atlas-ldaps-01.ldap.myteam.com: + atlas security ldap save --authenticationEnabled --authorizationEnabled + --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername + "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" + --bindPassword changeMe diff --git a/source/command/atlas-security-ldap-verify-status-watch.txt b/source/command/atlas-security-ldap-verify-status-watch.txt new file mode 100644 index 00000000..34d9fae0 --- /dev/null +++ b/source/command/atlas-security-ldap-verify-status-watch.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-ldap-verify-status-watch: + +======================================= +atlas security ldap verify status watch +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch for an LDAP configuration request to complete. + +This command checks the LDAP configuration's status periodically until it reaches a SUCCESS or FAILED status. +Once the LDAP configuration reaches the expected status, the command prints "LDAP Configuration request completed." +If you run the command in the terminal, it blocks the terminal session until the resource status succeeds or fails. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap verify status watch <requestId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - requestId + - string + - true + - ID of the request to verify an LDAP configuration. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + LDAP Configuration request completed. + + +Examples +-------- + +.. code-block:: + + atlas security ldap status watch requestIdSample diff --git a/source/command/atlas-security-ldap-verify-status.txt b/source/command/atlas-security-ldap-verify-status.txt new file mode 100644 index 00000000..02a5a294 --- /dev/null +++ b/source/command/atlas-security-ldap-verify-status.txt @@ -0,0 +1,103 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-ldap-verify-status: + +================================= +atlas security ldap verify status +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Get the status of an LDAP configuration request. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap verify status <requestId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - requestId + - string + - true + - ID of the request to verify an LDAP configuration. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for status + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + REQUEST ID PROJECT ID STATUS + <RequestId> <GroupId> <Status> + + +Related Commands +---------------- + +* :ref:`atlas-security-ldap-verify-status-watch` - Watch for an LDAP configuration request to complete. + diff --git a/source/command/atlas-security-ldap-verify.txt b/source/command/atlas-security-ldap-verify.txt new file mode 100644 index 00000000..195b2370 --- /dev/null +++ b/source/command/atlas-security-ldap-verify.txt @@ -0,0 +1,119 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-ldap-verify: + +========================== +atlas security ldap verify +========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Request verification of an LDAP configuration for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas security ldap verify [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --authzQueryTemplate + - string + - false + - RFC 4515-formatted or RFC 4516-formatted LDAP query template that Atlas executes to obtain the LDAP authorization groups to which the authenticated user belongs. Use the {USER} placeholder in the URL to substitute the username. The query is relative to the host specified with the hostname. + * - --bindPassword + - string + - false + - Password used to authenticate the bindUsername. + * - --bindUsername + - string + - true + - User distinguished name (DN) that Atlas uses to connect to the LDAP server. You must format LDAP distinguished names according to RFC 2253. + * - --caCertificate + - string + - false + - Certificate Authority (CA) used to verify the identity of the LDAP server. To delete an assigned value, pass an empty string. + * - -h, --help + - + - false + - help for verify + * - --hostname + - string + - true + - Hostname or IP address of the LDAP server. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --port + - int + - false + - Port that the LDAP server listens to for client connections. This value defaults to 636. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + REQUEST ID PROJECT ID STATUS + <RequestId> <GroupId> <Status> + + +Examples +-------- + +.. code-block:: + + # Request the JSON-formatted verification of the LDAP configuration for the atlas-ldaps-01.ldap.myteam.com host in the project with the ID 5e2211c17a3e5a48f5497de3: + atlas security ldap verify --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" --bindPassword changeMe --projectId 5e2211c17a3e5a48f5497de3 --output json + +Related Commands +---------------- + +* :ref:`atlas-security-ldap-verify-status` - Get the status of an LDAP configuration request. + diff --git a/source/command/atlas-security-ldap.txt b/source/command/atlas-security-ldap.txt new file mode 100644 index 00000000..c7242082 --- /dev/null +++ b/source/command/atlas-security-ldap.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security-ldap: + +=================== +atlas security ldap +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +LDAP operations. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for ldap + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-security-ldap-delete` - Remove the current LDAP configuration captured in the userToDNMapping document from your project. +* :ref:`atlas-security-ldap-get` - Return the current LDAP configuration details for your project. +* :ref:`atlas-security-ldap-save` - Save an LDAP configuration for your project. +* :ref:`atlas-security-ldap-verify` - Request verification of an LDAP configuration for your project. + + +.. toctree:: + :titlesonly: + + delete </command/atlas-security-ldap-delete> + get </command/atlas-security-ldap-get> + save </command/atlas-security-ldap-save> + verify </command/atlas-security-ldap-verify> + diff --git a/source/command/atlas-security.txt b/source/command/atlas-security.txt new file mode 100644 index 00000000..7e5273b9 --- /dev/null +++ b/source/command/atlas-security.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-security: + +============== +atlas security +============== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage security configuration for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for security + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-security-customerCerts` - Manage customer x509 certificates for your project. +* :ref:`atlas-security-ldap` - LDAP operations. + + +.. toctree:: + :titlesonly: + + customerCerts </command/atlas-security-customerCerts> + ldap </command/atlas-security-ldap> + diff --git a/source/command/atlas-serverless-backups-restores-create.txt b/source/command/atlas-serverless-backups-restores-create.txt new file mode 100644 index 00000000..a1cd9d4d --- /dev/null +++ b/source/command/atlas-serverless-backups-restores-create.txt @@ -0,0 +1,138 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-restores-create: + +======================================== +atlas serverless backups restores create +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start a restore job for your serverless instance. + +If you create an automated or pointInTime restore job, Atlas removes all existing data on the target cluster prior to the restore. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. +Atlas supports this command only for M10+ clusters. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups restores create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --deliveryType + - string + - true + - Type of restore job to create. Valid values include: automated, download, pointInTime. To learn more about types of restore jobs, see https://dochub.mongodb.org/core/backup-restore-cluster-atlas. + * - -h, --help + - + - false + - help for create + * - --oplogInc + - int + - false + - 32-bit incrementing ordinal that represents operations within a given second. When paired with oplogTs, they represent the point in time to which your data will be restored. + * - --oplogTs + - int + - false + - Oplog timestamp given as a timestamp in the number of seconds that have elapsed since the UNIX Epoch. When paired with oplogInc, they represent the point in time to which your data will be restored. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --pointInTimeUTCSeconds + - int + - false + - Timestamp in the number of seconds that have elapsed since the UNIX epoch that represents the point in time to which your data will be restored. This timestamp must be within the last 24 hours of the current time. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - false + - Unique identifier of the snapshot. + * - --targetClusterName + - string + - false + - Name of the target cluster. For use only with automated restore jobs. You must specify a targetClusterName for automated restores. + * - --targetProjectId + - string + - false + - Unique identifier of the project that contains the destination cluster for the restore job. You must specify a targetProjectId for automated restores. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Create an automated restore: + atlas serverless backup restore create \ + --deliveryType automated \ + --clusterName myDemo \ + --snapshotId 5e7e00128f8ce03996a47179 \ + --targetClusterName myDemo2 \ + --targetProjectId 1a2345b67c8e9a12f3456de7 + + +.. code-block:: + + # Create a point-in-time restore: + atlas serverless backup restore create \ + --deliveryType pointInTime \ + --clusterName myDemo \ + --pointInTimeUTCSeconds 1588523147 \ + --targetClusterName myDemo2 \ + --targetProjectId 1a2345b67c8e9a12f3456de7 + + +.. code-block:: + + # Create a download restore: + atlas serverless backup restore create \ + --deliveryType download \ + --clusterName myDemo \ + --snapshotId 5e7e00128f8ce03996a47179 diff --git a/source/command/atlas-serverless-backups-restores-describe.txt b/source/command/atlas-serverless-backups-restores-describe.txt new file mode 100644 index 00000000..40ad0efd --- /dev/null +++ b/source/command/atlas-serverless-backups-restores-describe.txt @@ -0,0 +1,86 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-restores-describe: + +========================================== +atlas serverless backups restores describe +========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe a cloud backup restore job. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups restores describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --restoreJobId + - string + - true + - Unique identifier that identifies the Restore Job. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return the details for the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the serverless isntance named Cluster0: + atlas serverless backup restore describe --restoreJobId 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/source/command/atlas-serverless-backups-restores-list.txt b/source/command/atlas-serverless-backups-restores-list.txt new file mode 100644 index 00000000..8bf02110 --- /dev/null +++ b/source/command/atlas-serverless-backups-restores-list.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-restores-list: + +====================================== +atlas serverless backups restores list +====================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all cloud backup restore jobs for the specified serverless instance in your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups restores list <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Label that identifies the Atlas serverless instance for which you want to return restore jobs. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return all continuous backup restore jobs for the serverless instance Instance0: + atlas serverless backup restore list Instance0 diff --git a/source/command/atlas-serverless-backups-restores-watch.txt b/source/command/atlas-serverless-backups-restores-watch.txt new file mode 100644 index 00000000..53740b19 --- /dev/null +++ b/source/command/atlas-serverless-backups-restores-watch.txt @@ -0,0 +1,101 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-restores-watch: + +======================================= +atlas serverless backups restores watch +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified backup restore job until it completes. + +This command checks the restore job's status periodically until it reaches a completed, failed or canceled status. +Command finishes once one of the expected statuses are reached. +If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. +You can interrupt the command's polling at any time with CTRL-C. +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups restores watch [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --restoreJobId + - string + - true + - Unique identifier that identifies the Restore Job. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Restore completed. + + +Examples +-------- + +.. code-block:: + + # Watch the continuous backup restore job with the ID 507f1f77bcf86cd799439011 for the cluster named Cluster0 until it becomes available: + atlas serverless backup restore watch --restoreJobId 507f1f77bcf86cd799439011 --clusterName Cluster0 diff --git a/source/command/atlas-serverless-backups-restores.txt b/source/command/atlas-serverless-backups-restores.txt new file mode 100644 index 00000000..9d5fc5c5 --- /dev/null +++ b/source/command/atlas-serverless-backups-restores.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-restores: + +================================= +atlas serverless backups restores +================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup restore jobs for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for restores + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-serverless-backups-restores-create` - Start a restore job for your serverless instance. +* :ref:`atlas-serverless-backups-restores-describe` - Describe a cloud backup restore job. +* :ref:`atlas-serverless-backups-restores-list` - Return all cloud backup restore jobs for the specified serverless instance in your project. +* :ref:`atlas-serverless-backups-restores-watch` - Watch the specified backup restore job until it completes. + + +.. toctree:: + :titlesonly: + + create </command/atlas-serverless-backups-restores-create> + describe </command/atlas-serverless-backups-restores-describe> + list </command/atlas-serverless-backups-restores-list> + watch </command/atlas-serverless-backups-restores-watch> + diff --git a/source/command/atlas-serverless-backups-snapshots-describe.txt b/source/command/atlas-serverless-backups-snapshots-describe.txt new file mode 100644 index 00000000..f3931ce5 --- /dev/null +++ b/source/command/atlas-serverless-backups-snapshots-describe.txt @@ -0,0 +1,97 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-snapshots-describe: + +=========================================== +atlas serverless backups snapshots describe +=========================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified snapshot for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups snapshots describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - true + - Unique identifier of the snapshot. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID SNAPSHOT TYPE EXPIRES AT + <Id> <SnapshotType> <ExpiresAt> + + +Examples +-------- + +.. code-block:: + + # Return the details for the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 for the instance named myDemo: + atlas serverless backups snapshots describe --snapshotId 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/source/command/atlas-serverless-backups-snapshots-list.txt b/source/command/atlas-serverless-backups-snapshots-list.txt new file mode 100644 index 00000000..33df24e3 --- /dev/null +++ b/source/command/atlas-serverless-backups-snapshots-list.txt @@ -0,0 +1,106 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-snapshots-list: + +======================================= +atlas serverless backups snapshots list +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all cloud backup snapshots for the specified serverless instance in your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups snapshots list <clusterName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - clusterName + - string + - true + - Label that identifies the Atlas serverless instance that contains the snapshots you want to return. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of snapshots for the instance named myDemo + atlas serverless backups snapshots list myDemo --output json diff --git a/source/command/atlas-serverless-backups-snapshots-watch.txt b/source/command/atlas-serverless-backups-snapshots-watch.txt new file mode 100644 index 00000000..f7198c6b --- /dev/null +++ b/source/command/atlas-serverless-backups-snapshots-watch.txt @@ -0,0 +1,97 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-snapshots-watch: + +======================================== +atlas serverless backups snapshots watch +======================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Watch the specified snapshot in your project until it reaches a completed or failed status. + +This command checks the snapshot's status periodically until it reaches a completed or failed status. +Command finishes once one of the expected statuses are reached. +If you run the command in the terminal, it blocks the terminal session until the resource status completes or fails. +You can interrupt the command's polling at any time with CTRL-C. +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless backups snapshots watch [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --snapshotId + - string + - true + - Unique identifier of the snapshot. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Snapshot changes completed. + + +Examples +-------- + +.. code-block:: + + # Watch the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 in the cluster named myDemo until it becomes available: + atlas backups snapshots watch 5f4007f327a3bd7b6f4103c5 --clusterName myDemo diff --git a/source/command/atlas-serverless-backups-snapshots.txt b/source/command/atlas-serverless-backups-snapshots.txt new file mode 100644 index 00000000..e981ce93 --- /dev/null +++ b/source/command/atlas-serverless-backups-snapshots.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups-snapshots: + +================================== +atlas serverless backups snapshots +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup snapshots for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for snapshots + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-serverless-backups-snapshots-describe` - Return the details for the specified snapshot for your project. +* :ref:`atlas-serverless-backups-snapshots-list` - Return all cloud backup snapshots for the specified serverless instance in your project. +* :ref:`atlas-serverless-backups-snapshots-watch` - Watch the specified snapshot in your project until it reaches a completed or failed status. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-serverless-backups-snapshots-describe> + list </command/atlas-serverless-backups-snapshots-list> + watch </command/atlas-serverless-backups-snapshots-watch> + diff --git a/source/command/atlas-serverless-backups.txt b/source/command/atlas-serverless-backups.txt new file mode 100644 index 00000000..971eec9e --- /dev/null +++ b/source/command/atlas-serverless-backups.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-backups: + +======================== +atlas serverless backups +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backups for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for backups + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-serverless-backups-restores` - Manage cloud backup restore jobs for your project. +* :ref:`atlas-serverless-backups-snapshots` - Manage cloud backup snapshots for your project. + + +.. toctree:: + :titlesonly: + + restores </command/atlas-serverless-backups-restores> + snapshots </command/atlas-serverless-backups-snapshots> + diff --git a/source/command/atlas-serverless-create.txt b/source/command/atlas-serverless-create.txt new file mode 100644 index 00000000..b0b93f7f --- /dev/null +++ b/source/command/atlas-serverless-create.txt @@ -0,0 +1,116 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-create: + +======================= +atlas serverless create +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates one serverless instance in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless create <instanceName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Human-readable label that identifies your serverless instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - true + - Cloud service provider that applies to the provisioned serverless instance. + * - --region + - string + - true + - Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Serverless instance <Name> created. + + +Examples +-------- + +.. code-block:: + + # Deploy a serverlessIntance named myInstance for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas serverless create myInstance --provider AWS --region US_EAST_1 --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-serverless-delete.txt b/source/command/atlas-serverless-delete.txt new file mode 100644 index 00000000..350e68e4 --- /dev/null +++ b/source/command/atlas-serverless-delete.txt @@ -0,0 +1,97 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-delete: + +======================= +atlas serverless delete +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove a serverless instance from your project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless delete <instanceName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Name of the instance to delete. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Serverless instance '<Name>' deleted + + diff --git a/source/command/atlas-serverless-describe.txt b/source/command/atlas-serverless-describe.txt new file mode 100644 index 00000000..77253c43 --- /dev/null +++ b/source/command/atlas-serverless-describe.txt @@ -0,0 +1,98 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-describe: + +========================= +atlas serverless describe +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return one serverless instance in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless describe <instanceName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Human-readable label that identifies your serverless instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME MDB VER STATE + <Id> <Name> <MongoDBVersion> <StateName> + + diff --git a/source/command/atlas-serverless-list.txt b/source/command/atlas-serverless-list.txt new file mode 100644 index 00000000..e4d43c99 --- /dev/null +++ b/source/command/atlas-serverless-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-list: + +===================== +atlas serverless list +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all serverless instances in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME MDB VER STATE + <Id> <Name> <MongoDBVersion> <StateName> + + diff --git a/source/command/atlas-serverless-update.txt b/source/command/atlas-serverless-update.txt new file mode 100644 index 00000000..07593d21 --- /dev/null +++ b/source/command/atlas-serverless-update.txt @@ -0,0 +1,125 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-update: + +======================= +atlas serverless update +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates one serverless instance in the specified project. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless update <instanceName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Human-readable label that identifies your serverless instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --disableServerlessContinuousBackup + - + - false + - Disables Serverless Continuous Backup for your serverless instance. If disabled the serverless instance uses Basic Backup. + + Mutually exclusive with --enableServerlessContinuousBackup. + * - --disableTerminationProtection + - + - false + - Disables termination protection for your cluster. You can delete a cluster with termination protection disabled. + + Mutually exclusive with --enableTerminationProtection. + * - --enableServerlessContinuousBackup + - + - false + - Flag that enables Serverless Continuous Backup for your serverless instance. If enabled, the serverless instance does not use Basic Backup. + + Mutually exclusive with --disableServerlessContinuousBackup. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + + Mutually exclusive with --disableTerminationProtection. + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. Passing this flag replaces preexisting data. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Serverless instance <Name> updated. + + diff --git a/source/command/atlas-serverless-watch.txt b/source/command/atlas-serverless-watch.txt new file mode 100644 index 00000000..58219047 --- /dev/null +++ b/source/command/atlas-serverless-watch.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless-watch: + +====================== +atlas serverless watch +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Monitor the status of serverless instance. + +This command checks the serverless instance's state periodically until the instance reaches an IDLE state. +Once the instance reaches the expected state, the command prints "Instance available." +If you run the command in the terminal, it blocks the terminal session until the resource becomes idle. +You can interrupt the command's polling at any time with CTRL-C. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas serverless watch <instanceName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - instanceName + - string + - true + - Name of the instance to watch. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for watch + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + + Instance available. + + +Examples +-------- + +.. code-block:: + + atlas serverless watch instanceNameSample diff --git a/source/command/atlas-serverless.txt b/source/command/atlas-serverless.txt new file mode 100644 index 00000000..e768dfde --- /dev/null +++ b/source/command/atlas-serverless.txt @@ -0,0 +1,76 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-serverless: + +================ +atlas serverless +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage serverless instances for your project. + +The serverless command provides access to your serverless instance configurations. You can create, edit, and delete serverless instances. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for serverless + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-serverless-backups` - Manage cloud backups for your project. +* :ref:`atlas-serverless-create` - Creates one serverless instance in the specified project. +* :ref:`atlas-serverless-delete` - Remove a serverless instance from your project. +* :ref:`atlas-serverless-describe` - Return one serverless instance in the specified project. +* :ref:`atlas-serverless-list` - Return all serverless instances in the specified project. +* :ref:`atlas-serverless-update` - Updates one serverless instance in the specified project. +* :ref:`atlas-serverless-watch` - Monitor the status of serverless instance. + + +.. toctree:: + :titlesonly: + + backups </command/atlas-serverless-backups> + create </command/atlas-serverless-create> + delete </command/atlas-serverless-delete> + describe </command/atlas-serverless-describe> + list </command/atlas-serverless-list> + update </command/atlas-serverless-update> + watch </command/atlas-serverless-watch> + diff --git a/source/command/atlas-setup.txt b/source/command/atlas-setup.txt new file mode 100644 index 00000000..74839b20 --- /dev/null +++ b/source/command/atlas-setup.txt @@ -0,0 +1,138 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-setup: + +=========== +atlas setup +=========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Register, authenticate, create, and access an Atlas cluster. + +This command takes you through registration, login, default profile creation, creating your first free tier cluster and connecting to it using MongoDB Shell. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas setup [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --accessListIp + - strings + - false + - IP address to grant access to the deployment. + + Mutually exclusive with --currentIp. + * - --clusterName + - string + - false + - Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. + * - --currentIp + - + - false + - Flag that adds the IP address from the host that is currently executing the command to the access list. + + Mutually exclusive with --accessListIp. + * - --enableTerminationProtection + - + - false + - Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled. + * - --force + - + - false + - Flag that indicates whether to skip the request for input and create a cluster with the default settings for any unspecified options. + * - --gov + - + - false + - Register with Atlas for Government. + * - -h, --help + - + - false + - help for setup + * - --noBrowser + - + - false + - Don't try to open a browser session. + * - --password + - string + - false + - Password for the user. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - false + - Name of your cloud service provider. Valid values are AWS, AZURE, or GCP. + * - -r, --region + - string + - false + - Physical location of your MongoDB cluster. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas. + * - --skipMongosh + - + - false + - Flag that indicates whether to skip accessing your deployment with MongoDB Shell. + * - --skipSampleData + - + - false + - Flag that indicates whether to skip loading sample data into your MongoDB cluster. + * - --tag + - key=value + - false + - List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. + * - --tier + - string + - false + - Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. This value defaults to "M0". + * - --username + - string + - false + - Username for authenticating to MongoDB. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Override default cluster settings like name, provider, or database username by using the command options + atlas setup --clusterName Test --provider GCP --username dbuserTest diff --git a/source/command/atlas-streams-connections-create.txt b/source/command/atlas-streams-connections-create.txt new file mode 100644 index 00000000..674ba085 --- /dev/null +++ b/source/command/atlas-streams-connections-create.txt @@ -0,0 +1,119 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-connections-create: + +================================ +atlas streams connections create +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Creates a connection for an Atlas Stream Processing instance. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections create [connectionName] [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - connectionName + - string + - false + - Name of the connection + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - true + - Path to a JSON configuration file that defines an Atlas Stream Processing connection. + * - -h, --help + - + - false + - help for create + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Connection <Name> created. + + +Examples +-------- + +.. code-block:: + + # create a new connection for Atlas Stream Processing: + atlas streams connection create kafkaprod -i test01 -f kafkaConfig.json + + +.. code-block:: + + # create a new connection using the name from a cluster configuration file + atlas streams connection create -i test01 -f clusterConfig.json + diff --git a/source/command/atlas-streams-connections-delete.txt b/source/command/atlas-streams-connections-delete.txt new file mode 100644 index 00000000..8a76bcce --- /dev/null +++ b/source/command/atlas-streams-connections-delete.txt @@ -0,0 +1,117 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-connections-delete: + +================================ +atlas streams connections delete +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified Atlas Stream Processing connection from your project. + +The command prompts you to confirm the operation when you run the command without the --force option. + +Before deleting an Atlas Streams Processing connection, you must first stop all processes associated with it. To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections delete <connectionName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - connectionName + - string + - true + - Name of the connection + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas Stream Processing connection '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # deletes connection 'ExampleConnection' from instance 'ExampleInstance': + atlas streams connection delete ExampleConnection --instance ExampleInstance + + +.. code-block:: + + # deletes connection 'ExampleConnection' from instance 'ExampleInstance' without requiring confirmation: + atlas streams connection delete ExampleConnection --instance ExampleInstance --force + diff --git a/source/command/atlas-streams-connections-describe.txt b/source/command/atlas-streams-connections-describe.txt new file mode 100644 index 00000000..c0bf02fe --- /dev/null +++ b/source/command/atlas-streams-connections-describe.txt @@ -0,0 +1,99 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-connections-describe: + +================================== +atlas streams connections describe +================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified Atlas Stream Processing connection. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections describe <streamConnectionName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - streamConnectionName + - string + - true + - Name of the Atlas Stream Processing connection. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # retrieves stream connection 'ExampleConnection' in instance 'ExampleInstance': + atlas streams connection describe ExampleConnection --instance ExampleInstance + diff --git a/source/command/atlas-streams-connections-list.txt b/source/command/atlas-streams-connections-list.txt new file mode 100644 index 00000000..6a1e6951 --- /dev/null +++ b/source/command/atlas-streams-connections-list.txt @@ -0,0 +1,83 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-connections-list: + +============================== +atlas streams connections list +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # list all connections within ExampleInstance: + atlas streams connection list --instance ExampleInstance + diff --git a/source/command/atlas-streams-connections-update.txt b/source/command/atlas-streams-connections-update.txt new file mode 100644 index 00000000..640cfdea --- /dev/null +++ b/source/command/atlas-streams-connections-update.txt @@ -0,0 +1,113 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-connections-update: + +================================ +atlas streams connections update +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Modify the details of the specified connection within your Atlas Stream Processing instance. + +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams connections update <connectionName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - connectionName + - string + - true + - Name of the connection. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -f, --file + - string + - true + - Path to a JSON configuration file that defines an Atlas Stream Processing connection. + * - -h, --help + - + - false + - help for update + * - -i, --instance + - string + - true + - Name of your Atlas Stream Processing instance. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Connection <Name> updated. + + +Examples +-------- + +.. code-block:: + + # update an Atlas Stream Processing connection: + atlas streams connection update kafkaprod --instance test01 -f kafkaConfig.json + diff --git a/source/command/atlas-streams-connections.txt b/source/command/atlas-streams-connections.txt new file mode 100644 index 00000000..a2d44c39 --- /dev/null +++ b/source/command/atlas-streams-connections.txt @@ -0,0 +1,72 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-connections: + +========================= +atlas streams connections +========================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Stream Processing connections. + +Create, list, update and delete your Atlas Stream Processing connections + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for connections + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-streams-connections-create` - Creates a connection for an Atlas Stream Processing instance. +* :ref:`atlas-streams-connections-delete` - Remove the specified Atlas Stream Processing connection from your project. +* :ref:`atlas-streams-connections-describe` - Return the details for the specified Atlas Stream Processing connection. +* :ref:`atlas-streams-connections-list` - Returns all Atlas Stream Processing connections from your Atlas Stream Processing instance. +* :ref:`atlas-streams-connections-update` - Modify the details of the specified connection within your Atlas Stream Processing instance. + + +.. toctree:: + :titlesonly: + + create </command/atlas-streams-connections-create> + delete </command/atlas-streams-connections-delete> + describe </command/atlas-streams-connections-describe> + list </command/atlas-streams-connections-list> + update </command/atlas-streams-connections-update> + diff --git a/source/command/atlas-streams-instances-create.txt b/source/command/atlas-streams-instances-create.txt new file mode 100644 index 00000000..1ff6fc91 --- /dev/null +++ b/source/command/atlas-streams-instances-create.txt @@ -0,0 +1,116 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-instances-create: + +============================== +atlas streams instances create +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an Atlas Stream Processing instance for your project + +To get started quickly, specify a name, a cloud provider, and a region to configure an Atlas Stream Processing instance.To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances create <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the Atlas Stream Processing instance. After creation, you can't change the name of the instance. The name can contain ASCII letters, numbers, and hyphens. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - true + - Cloud service provider that applies to the provisioned Atlas Stream Processing instance. This value defaults to "AWS". + * - -r, --region + - string + - true + - Human-readable label that identifies the physical location of your Atlas Stream Processing instance. The region can affect network latency and performance if it is far from your source or sink. + * - --tier + - string + - false + - Tier for your Stream Instance. This value defaults to "SP30". + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas Streams Processor Instance '<Name>' successfully created. + + +Examples +-------- + +.. code-block:: + + # Deploy an Atlas Stream Processing instance called myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas streams instance create myProcessor --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region VIRGINIA_USA --tier SP30 diff --git a/source/command/atlas-streams-instances-delete.txt b/source/command/atlas-streams-instances-delete.txt new file mode 100644 index 00000000..393632cd --- /dev/null +++ b/source/command/atlas-streams-instances-delete.txt @@ -0,0 +1,113 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-instances-delete: + +============================== +atlas streams instances delete +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Delete an Atlas Stream Processing instance. + +The command prompts you to confirm the operation when you run the command without the --force option. + +Before deleting an Atlas Streams Processing instance, you must first stop all processes associated with it. +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances delete <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the Atlas Streams instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas Streams processor instance '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove an Atlas Stream Processing instance after prompting for a confirmation: + atlas streams instance delete myProcessorInstance + + +.. code-block:: + + # Remove an Atlas Stream Processing instance named myProcessorInstance without requiring confirmation: + atlas streams instance delete myProcessorInstance --force diff --git a/source/command/atlas-streams-instances-describe.txt b/source/command/atlas-streams-instances-describe.txt new file mode 100644 index 00000000..939cff1d --- /dev/null +++ b/source/command/atlas-streams-instances-describe.txt @@ -0,0 +1,110 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-instances-describe: + +================================ +atlas streams instances describe +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Describe an Atlas Stream Processing instance for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances describe <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the Atlas Streams processor instance. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME CLOUD REGION + <Id> <Name> <DataProcessRegion.CloudProvider> <DataProcessRegion.Region> + + +Examples +-------- + +.. code-block:: + + # Return an Atlas Stream Processing instance with a specific name: + atlas streams instance describe myProcessor + +.. code-block:: + + # Return a JSON-formatted Atlas Stream Processing instance with a specific name: + atlas streams instance describe myProcessor --output json diff --git a/source/command/atlas-streams-instances-download.txt b/source/command/atlas-streams-instances-download.txt new file mode 100644 index 00000000..158320ca --- /dev/null +++ b/source/command/atlas-streams-instances-download.txt @@ -0,0 +1,116 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-instances-download: + +================================ +atlas streams instances download +================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. + +This command downloads a file with a .gz extension. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances download <tenantName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - tenantName + - string + - true + - Label that identifies the tenant that stores the log files that you want to download. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --end + - int + - false + - UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp. + * - --force + - + - false + - Flag that indicates whether to overwrite the destination file. + * - -h, --help + - + - false + - help for download + * - --out + - string + - true + - Output file name. This value defaults to the log name. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --start + - int + - false + - UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Download of <Name> completed. + + +Examples +-------- + +.. code-block:: + + # Download the audit log file from the instance myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3: + atlas streams instance download myProcessor --projectId 5e2211c17a3e5a48f5497de3 diff --git a/source/command/atlas-streams-instances-list.txt b/source/command/atlas-streams-instances-list.txt new file mode 100644 index 00000000..88ad5a37 --- /dev/null +++ b/source/command/atlas-streams-instances-list.txt @@ -0,0 +1,97 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-instances-list: + +============================ +atlas streams instances list +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +List all the Atlas Stream Processing instances for your project. + +To use this command, you must authenticate with a user account or an API key with the Project Read Only role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME CLOUD REGION + <Id> <Name> <DataProcessRegion.CloudProvider> <DataProcessRegion.Region> + + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of all Atlas Stream Processing instances for the project with ID 5e2211c17a3e5a48f5497de3: + atlas streams instance list --projectId 5e2211c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-streams-instances-update.txt b/source/command/atlas-streams-instances-update.txt new file mode 100644 index 00000000..5a8afd26 --- /dev/null +++ b/source/command/atlas-streams-instances-update.txt @@ -0,0 +1,113 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-instances-update: + +============================== +atlas streams instances update +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Updates an Atlas Stream Processing instance for your project. + +Before updating an Atlas Streams Processing instance, you must first stop all processes associated with it. +To use this command, you must authenticate with a user account or an API key with the Project Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas streams instances update <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Name of the Atlas Stream Processing instance. After creation, you can't change the name of the instance. The name can contain ASCII letters, numbers, and hyphens. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for update + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --provider + - string + - true + - Cloud service provider that applies to the provisioned Atlas Stream Processing instance. This value defaults to "AWS". + * - -r, --region + - string + - true + - Human-readable label that identifies the physical location of your Atlas Stream Processing instance. The region can affect network latency and performance if it is far from your source or sink. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Atlas Streams Processor Instance '<Name>' successfully updated. + + +Examples +-------- + +.. code-block:: + + # Modify the Atlas Stream Processing instance configuration with the name MyInstance: + atlas streams instance update MyInstance --provider AWS --region VIRGINIA_USA diff --git a/source/command/atlas-streams-instances.txt b/source/command/atlas-streams-instances.txt new file mode 100644 index 00000000..343ea733 --- /dev/null +++ b/source/command/atlas-streams-instances.txt @@ -0,0 +1,74 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams-instances: + +======================= +atlas streams instances +======================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Atlas Stream Processing instances. + +Create, list, update and delete your Atlas Stream Processing instances. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for instances + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-streams-instances-create` - Create an Atlas Stream Processing instance for your project +* :ref:`atlas-streams-instances-delete` - Delete an Atlas Stream Processing instance. +* :ref:`atlas-streams-instances-describe` - Describe an Atlas Stream Processing instance for your project. +* :ref:`atlas-streams-instances-download` - Download a compressed file that contains the logs for the specified Atlas Stream Processing instance. +* :ref:`atlas-streams-instances-list` - List all the Atlas Stream Processing instances for your project. +* :ref:`atlas-streams-instances-update` - Updates an Atlas Stream Processing instance for your project. + + +.. toctree:: + :titlesonly: + + create </command/atlas-streams-instances-create> + delete </command/atlas-streams-instances-delete> + describe </command/atlas-streams-instances-describe> + download </command/atlas-streams-instances-download> + list </command/atlas-streams-instances-list> + update </command/atlas-streams-instances-update> + diff --git a/source/command/atlas-streams.txt b/source/command/atlas-streams.txt new file mode 100644 index 00000000..8524a486 --- /dev/null +++ b/source/command/atlas-streams.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-streams: + +============= +atlas streams +============= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas Stream Processing deployments. + +The streams command provides access to your Atlas Stream Processing configurations. You can create, edit, and delete streams, as well as change the connection registry. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for streams + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-streams-connections` - Manage Atlas Stream Processing connections. +* :ref:`atlas-streams-instances` - Manage Atlas Stream Processing instances. + + +.. toctree:: + :titlesonly: + + connections </command/atlas-streams-connections> + instances </command/atlas-streams-instances> + diff --git a/source/command/atlas-teams-create.txt b/source/command/atlas-teams-create.txt new file mode 100644 index 00000000..302d27a3 --- /dev/null +++ b/source/command/atlas-teams-create.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-create: + +================== +atlas teams create +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a team for your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams create <name> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - name + - string + - true + - Label that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for create + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --username + - strings + - true + - Comma-separated list that contains the valid usernames of the MongoDB users to add to the new team. A team must have at least one user. New users must accept the invitation to join an organization before you can add them to a team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team '<Name>' created. + + +Examples +-------- + +.. code-block:: + + # Create a team named myTeam in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams create myTeam --username user1@example.com,user2@example.com --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-teams-delete.txt b/source/command/atlas-teams-delete.txt new file mode 100644 index 00000000..011a87a0 --- /dev/null +++ b/source/command/atlas-teams-delete.txt @@ -0,0 +1,104 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-delete: + +================== +atlas teams delete +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified team from your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams delete <teamId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team '<Name>' deleted + + +Examples +-------- + +.. code-block:: + + # Remove the team with the ID 5e44445ef10fab20b49c0f31 from the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams delete 5e44445ef10fab20b49c0f31 --orgId 5e1234c17a3e5a48f5497de3 diff --git a/source/command/atlas-teams-describe.txt b/source/command/atlas-teams-describe.txt new file mode 100644 index 00000000..c18f9bf8 --- /dev/null +++ b/source/command/atlas-teams-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-describe: + +==================== +atlas teams describe +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified team for your organization. + +You can return the details for a team using the team's ID or the team's name. You must specify either the id option or the name option. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --id + - string + - false + - Unique 24-digit string that identifies the team. + * - --name + - string + - false + - Label that identifies the team. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID NAME + <Id> <Name> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the the team with the ID 5e44445ef10fab20b49c0f31 in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams describe --id 5e44445ef10fab20b49c0f31 --projectId 5e1234c17a3e5a48f5497de3 --output json + + +.. code-block:: + + # Return the JSON-formatted details for the the team with the name myTeam in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams describe --name myTeam --projectId 5e1234c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-teams-list.txt b/source/command/atlas-teams-list.txt new file mode 100644 index 00000000..e56434d5 --- /dev/null +++ b/source/command/atlas-teams-list.txt @@ -0,0 +1,94 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-list: + +================ +atlas teams list +================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all teams for your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --limit + - int + - false + - Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100. + * - --omitCount + - + - false + - Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response. + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --page + - int + - false + - Page number that specifies a page of results. This value defaults to 1. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of the teams for the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams list --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-teams-rename.txt b/source/command/atlas-teams-rename.txt new file mode 100644 index 00000000..76a9f922 --- /dev/null +++ b/source/command/atlas-teams-rename.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-rename: + +================== +atlas teams rename +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Rename a team in your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization Owner role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams rename <newName> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - newName + - string + - true + - New label that identifies the team. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for rename + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + Team '<Name>' updated. + + +Examples +-------- + +.. code-block:: + + # Rename a team in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams rename newName --teamId 5e1234c17a3e5a48f5497de3 --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-teams-users-add.txt b/source/command/atlas-teams-users-add.txt new file mode 100644 index 00000000..18b47384 --- /dev/null +++ b/source/command/atlas-teams-users-add.txt @@ -0,0 +1,110 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-users-add: + +===================== +atlas teams users add +===================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Add the specified MongoDB user to a team for your organization. + +Users must be current members of your organization before you can add them to a team. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams users add <userId>... [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - userId + - string + - true + - Unique 24-digit string that identifies the user. You can add more than one user at a time by specifying multiple user IDs separated by a space. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for add + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User(s) added to the team. + + +Examples +-------- + +.. code-block:: + + # Add the users with the IDs 5dd58c647a3e5a6c5bce46c7 and 5dd56c847a3e5a1f363d424d to the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams users add 5dd58c647a3e5a6c5bce46c7 5dd56c847a3e5a1f363d424d --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-teams-users-delete.txt b/source/command/atlas-teams-users-delete.txt new file mode 100644 index 00000000..a657a679 --- /dev/null +++ b/source/command/atlas-teams-users-delete.txt @@ -0,0 +1,108 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-users-delete: + +======================== +atlas teams users delete +======================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Remove the specified user from a team for your organization. + +To use this command, you must authenticate with a user account or an API key with the Organization User Admin role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams users delete <userId> [options] + +.. Code end marker, please don't delete this comment + +Arguments +--------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - userId + - string + - true + - Unique 24-digit string that identifies the user. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for delete + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - --teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + User '<Name>' deleted from the team + + +Examples +-------- + +.. code-block:: + + # Remove the user with the ID 5dd58c647a3e5a6c5bce46c7 from the team with the ID 5f6a5c6c713184005d72fe6e for the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams users delete 5dd58c647a3e5a6c5bce46c7 --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 diff --git a/source/command/atlas-teams-users-list.txt b/source/command/atlas-teams-users-list.txt new file mode 100644 index 00000000..dc0ade67 --- /dev/null +++ b/source/command/atlas-teams-users-list.txt @@ -0,0 +1,86 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-users-list: + +====================== +atlas teams users list +====================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return all users for a team. + +To use this command, you must authenticate with a user account or an API key with the Organization Member role. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas teams users list [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -c, --compact + - + - false + - Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option. + * - -h, --help + - + - false + - help for list + * - --orgId + - string + - false + - Organization ID to use. This option overrides the settings in the configuration file or environment variable. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --teamId + - string + - true + - Unique 24-digit string that identifies the team. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Return a JSON-formatted list of the users for the team with the ID 5f6a5c6c713184005d72fe6e in the organization with ID 5e2211c17a3e5a48f5497de3: + atlas teams users list --teamId 5f6a5c6c713184005d72fe6e --orgId 5e1234c17a3e5a48f5497de3 --output json diff --git a/source/command/atlas-teams-users.txt b/source/command/atlas-teams-users.txt new file mode 100644 index 00000000..524d78c6 --- /dev/null +++ b/source/command/atlas-teams-users.txt @@ -0,0 +1,68 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams-users: + +================= +atlas teams users +================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas users. + +Create, list and manage your users. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for users + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-teams-users-add` - Add the specified MongoDB user to a team for your organization. +* :ref:`atlas-teams-users-delete` - Remove the specified user from a team for your organization. +* :ref:`atlas-teams-users-list` - Return all users for a team. + + +.. toctree:: + :titlesonly: + + add </command/atlas-teams-users-add> + delete </command/atlas-teams-users-delete> + list </command/atlas-teams-users-list> + diff --git a/source/command/atlas-teams.txt b/source/command/atlas-teams.txt new file mode 100644 index 00000000..90dc7e1a --- /dev/null +++ b/source/command/atlas-teams.txt @@ -0,0 +1,74 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-teams: + +=========== +atlas teams +=========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas teams. + +Create, list and manage your Atlas teams. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for teams + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-teams-create` - Create a team for your organization. +* :ref:`atlas-teams-delete` - Remove the specified team from your organization. +* :ref:`atlas-teams-describe` - Return the details for the specified team for your organization. +* :ref:`atlas-teams-list` - Return all teams for your organization. +* :ref:`atlas-teams-rename` - Rename a team in your organization. +* :ref:`atlas-teams-users` - Manage your Atlas users. + + +.. toctree:: + :titlesonly: + + create </command/atlas-teams-create> + delete </command/atlas-teams-delete> + describe </command/atlas-teams-describe> + list </command/atlas-teams-list> + rename </command/atlas-teams-rename> + users </command/atlas-teams-users> + diff --git a/source/command/atlas-users-describe.txt b/source/command/atlas-users-describe.txt new file mode 100644 index 00000000..adb3bc86 --- /dev/null +++ b/source/command/atlas-users-describe.txt @@ -0,0 +1,105 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-users-describe: + +==================== +atlas users describe +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the details for the specified Atlas user. + +You can specify either the unique 24-digit ID that identifies the Atlas user or the username for the Atlas user. + +User accounts and API keys with any role can run this command. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas users describe [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for describe + * - --id + - string + - false + - Unique 24-digit identifier of the user. + + Mutually exclusive with --username. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --username + - string + - false + - Name that identifies the user. You must specify a valid email address. + + Mutually exclusive with --id. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + ID FIRST NAME LAST NAME USERNAME EMAIL + <Id> <FirstName> <LastName> <Username> <EmailAddress> + + +Examples +-------- + +.. code-block:: + + # Return the JSON-formatted details for the Atlas user with the ID 5dd56c847a3e5a1f363d424d: + atlas users describe --id 5dd56c847a3e5a1f363d424d --output json + + +.. code-block:: + + # Return the JSON-formatted details for the Atlas user with the username myUser: + atlas users describe --username myUser --output json diff --git a/source/command/atlas-users-invite.txt b/source/command/atlas-users-invite.txt new file mode 100644 index 00000000..74f52926 --- /dev/null +++ b/source/command/atlas-users-invite.txt @@ -0,0 +1,127 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-users-invite: + +================== +atlas users invite +================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. + +An Atlas user account grants access only to the the MongoDB Atlas application. To grant database access, create a database user with atlas dbusers create. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas users invite [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --country + - string + - true + - ISO 3166-1 alpha two-letter country code of the user's geographic location. The Atlas CLI requires this option. + * - --email + - string + - true + - Email address for the user. + * - --firstName + - string + - true + - First or given name for the user. + * - -h, --help + - + - false + - help for invite + * - --lastName + - string + - true + - Last name, family name, or surname for the user. + * - --mobile + - string + - false + - Mobile phone number for the user. + * - --orgRole + - strings + - false + - Unique 24-digit string that identifies the organization, colon, and the user's role for the organization. Specify this value as orgID:ROLE. Valid values for ROLE include ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, and ORG_READ_ONLY. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --password + - string + - false + - Password for the user. + * - --projectRole + - strings + - false + - Unique 24-digit string that identifies the project, colon, and the user's role for the project. Specify this value as projectID:ROLE. Valid values for ROLE include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY. + * - --username + - string + - true + - Name that identifies the user. You must specify a valid email address. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Output +------ + +If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values. + +.. code-block:: + + The user '<Username>' has been invited. + Invited users do not have access to the project until they accept the invitation. + + +Examples +-------- + +.. code-block:: + + # Create the Atlas user with the username user@example.com and invite them to the organization with the ID 5dd56c847a3e5a1f363d424d with ORG_OWNER access: + atlas users invite --email user@example.com --username user@example.com --orgRole 5dd56c847a3e5a1f363d424d:ORG_OWNER --firstName Example --lastName User --country US --output json + + +.. code-block:: + + # Create the Atlas user with the username user@example.com and invite them to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: + atlas users invite --email user@example.com --username user@example.com --projectRole 5f71e5255afec75a3d0f96dc:GROUP_READ_ONLY --firstName Example --lastName User --country US --output json diff --git a/source/command/atlas-users.txt b/source/command/atlas-users.txt new file mode 100644 index 00000000..f62f386f --- /dev/null +++ b/source/command/atlas-users.txt @@ -0,0 +1,66 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-users: + +=========== +atlas users +=========== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage your Atlas users. + +Create, list and manage your Atlas users. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for users + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Related Commands +---------------- + +* :ref:`atlas-users-describe` - Return the details for the specified Atlas user. +* :ref:`atlas-users-invite` - Create an Atlas user for your MongoDB Atlas application and invite the Atlas user to your organizations and projects. + + +.. toctree:: + :titlesonly: + + describe </command/atlas-users-describe> + invite </command/atlas-users-invite> + diff --git a/source/command/atlas.txt b/source/command/atlas.txt new file mode 100644 index 00000000..33483f49 --- /dev/null +++ b/source/command/atlas.txt @@ -0,0 +1,132 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas: + +===== +atlas +===== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +CLI tool to manage MongoDB Atlas. + +The Atlas CLI is a command line interface built specifically for MongoDB Atlas. You can manage your Atlas database deployments and Atlas Search from the terminal with short, intuitive commands. + +Use the --help flag with any command for more info on that command. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for atlas + * - -P, --profile + - string + - false + - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. + +Examples +-------- + +.. code-block:: + + # Display the help menu for the config command: + atlas config --help + +Related Commands +---------------- + +* :ref:`atlas-accessLists` - Manage the list of IP addresses that can access your Atlas project. +* :ref:`atlas-accessLogs` - Return the access logs for a cluster. +* :ref:`atlas-alerts` - Manage alerts for your project. +* :ref:`atlas-auditing` - Returns database auditing settings for MongoDB Cloud projects. +* :ref:`atlas-auth` - Manage the CLI's authentication state. +* :ref:`atlas-backups` - Manage cloud backups for your project. +* :ref:`atlas-cloudProviders` - Manage cloud provider access in Atlas using AWS IAM roles. +* :ref:`atlas-clusters` - Manage clusters for your project. +* :ref:`atlas-completion` - Generate the autocompletion script for the specified shell +* :ref:`atlas-config` - Configure and manage your user profiles. +* :ref:`atlas-customDbRoles` - Manage custom database roles for your project. +* :ref:`atlas-customDns` - Manage DNS configuration of Atlas project’s clusters deployed to AWS. +* :ref:`atlas-dataFederation` - Data federation. +* :ref:`atlas-dataLakePipelines` - Data Lake pipelines. +* :ref:`atlas-dbusers` - Manage database users for your project. +* :ref:`atlas-deployments` - Manage cloud and local deployments. +* :ref:`atlas-events` - Manage events for your organization or project. +* :ref:`atlas-federatedAuthentication` - Manage Atlas Federated Authentication. +* :ref:`atlas-integrations` - Configure third-party integrations for your Atlas project. +* :ref:`atlas-kubernetes` - Manage Kubernetes resources. +* :ref:`atlas-liveMigrations` - Manage a Live Migration to Atlas for your organization. +* :ref:`atlas-logs` - Download host logs for your project. +* :ref:`atlas-maintenanceWindows` - Manage Atlas maintenance windows. +* :ref:`atlas-metrics` - Get metrics on the MongoDB process. +* :ref:`atlas-networking` - Manage or configure network peering for your Atlas project. +* :ref:`atlas-organizations` - Manage your Atlas organizations. +* :ref:`atlas-performanceAdvisor` - Learn more about slow queries and get suggestions to improve database performance. +* :ref:`atlas-privateEndpoints` - Manage Atlas private endpoints. +* :ref:`atlas-processes` - Manage MongoDB processes for your project. +* :ref:`atlas-projects` - Manage your Atlas projects. +* :ref:`atlas-security` - Manage security configuration for your project. +* :ref:`atlas-serverless` - Manage serverless instances for your project. +* :ref:`atlas-setup` - Register, authenticate, create, and access an Atlas cluster. +* :ref:`atlas-streams` - Manage your Atlas Stream Processing deployments. +* :ref:`atlas-teams` - Manage your Atlas teams. +* :ref:`atlas-users` - Manage your Atlas users. + + +.. toctree:: + :titlesonly: + + accessLists </command/atlas-accessLists> + accessLogs </command/atlas-accessLogs> + alerts </command/atlas-alerts> + auditing </command/atlas-auditing> + auth </command/atlas-auth> + backups </command/atlas-backups> + cloudProviders </command/atlas-cloudProviders> + clusters </command/atlas-clusters> + completion </command/atlas-completion> + config </command/atlas-config> + customDbRoles </command/atlas-customDbRoles> + customDns </command/atlas-customDns> + dataFederation </command/atlas-dataFederation> + dataLakePipelines </command/atlas-dataLakePipelines> + dbusers </command/atlas-dbusers> + deployments </command/atlas-deployments> + events </command/atlas-events> + federatedAuthentication </command/atlas-federatedAuthentication> + integrations </command/atlas-integrations> + kubernetes </command/atlas-kubernetes> + liveMigrations </command/atlas-liveMigrations> + logs </command/atlas-logs> + maintenanceWindows </command/atlas-maintenanceWindows> + metrics </command/atlas-metrics> + networking </command/atlas-networking> + organizations </command/atlas-organizations> + performanceAdvisor </command/atlas-performanceAdvisor> + privateEndpoints </command/atlas-privateEndpoints> + processes </command/atlas-processes> + projects </command/atlas-projects> + security </command/atlas-security> + serverless </command/atlas-serverless> + setup </command/atlas-setup> + streams </command/atlas-streams> + teams </command/atlas-teams> + users </command/atlas-users> + diff --git a/source/compatibility.txt b/source/compatibility.txt index c94fcc4a..ebb86a18 100644 --- a/source/compatibility.txt +++ b/source/compatibility.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _compatibility-atlas-cli: =================== @@ -10,6 +13,10 @@ Check Compatibility :depth: 1 :class: singlecol +.. facet:: + :name: genre + :values: reference + The {+atlas-cli+} supports the following operating systems: @@ -20,13 +27,13 @@ systems: - Operating System Version - Architecture * - Amazon Linux - - 2 + - 2, 2023 - ``x86-64``, ``ARM`` * - Debian - - 9, 10 + - 10, 11, 12 - ``x86-64``, ``ARM`` * - MacOS - - 10.0 and later + - 12.0 and later - ``x86-64``, ``ARM`` * - Microsoft Windows - 10 @@ -41,5 +48,27 @@ systems: - 12, 15 - ``x86-64``, ``ARM`` * - Ubuntu - - 18.04, 20.04, 22.04 - - ``x86-64``, ``ARM`` \ No newline at end of file + - 20.04, 22.04 + - ``x86-64``, ``ARM`` + +MongoDB Service Versions +------------------------ + +The {+atlas-cli+} supports the following versions of |service| and +MongoDB server. + +.. list-table:: + :header-rows: 1 + :widths: 50 50 + + * - MongoDB Service + - MongoDB Service Version + + * - |service| + - Current + + * - MongoDB server + - Any `released and stable version + <https://www.mongodb.com/support-policy/lifecycles>`__ that has + not reached its End of Life date. The {+atlas-cli+} doesn't + support rapid release MongoDB versions. \ No newline at end of file diff --git a/source/configure-optional-settings.txt b/source/configure-optional-settings.txt deleted file mode 100644 index d9779897..00000000 --- a/source/configure-optional-settings.txt +++ /dev/null @@ -1,16 +0,0 @@ - -=========================== -Configure Optional Settings -=========================== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -.. toctree:: - - /telemetry \ No newline at end of file diff --git a/source/connect-atlas-cli.txt b/source/connect-atlas-cli.txt index 07b132b1..4b3711e6 100644 --- a/source/connect-atlas-cli.txt +++ b/source/connect-atlas-cli.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _connect-atlas-cli: =============================== @@ -96,6 +99,14 @@ Complete the Prerequisites - :ref:`Install the {+atlas-cli+} <install-atlas-cli>`. - Add your host's IP address to the :ref:`IP access list <access-list>`. + + 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 + </tutorial/manage-organizations/#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 + </tutorial/manage-organizations/#require-ip-access-list-for-the-atlas-ui>`. + .. tab:: Programmatic Use :tabid: atlas-config-init @@ -116,6 +127,7 @@ from the {+atlas-cli+}. :tabid: atlas-auth-login .. procedure:: + :style: normal .. include:: /includes/steps-atlas-cli-auth-nonprog-default.rst @@ -163,7 +175,7 @@ from the {+atlas-cli+}. .. step:: Issue commands using the ``--projectId`` and ``--orgId`` flags. - When you run :doc:`{+atlas-cli+} commands </command/atlas>` for + When you run :ref:`{+atlas-cli+} commands <atlas>` for the duration of your {+atlas-cli+} session, specify your Project ID and Org ID using the ``--projectId`` and ``--orgId`` flags. @@ -177,6 +189,7 @@ from the {+atlas-cli+}. :tabid: atlas-config-init .. procedure:: + :style: normal .. include:: /includes/steps-atlas-cli-auth-prog-default.rst @@ -196,7 +209,7 @@ from the {+atlas-cli+}. .. step:: Issue commands using the ``--projectId`` and ``--orgId`` flags. - When you run :doc:`{+atlas-cli+} commands </command/atlas>` for + When you run :ref:`{+atlas-cli+} commands <atlas>` for the duration of your {+atlas-cli+} session, specify your Project ID and Org ID using the ``--projectId`` and ``--orgId`` flags. @@ -212,7 +225,7 @@ Take the Next Steps ------------------- Start using the -:doc:`{+atlas-cli+} commands </command/atlas>`. +:ref:`{+atlas-cli+} commands <atlas>`. To save connection settings by modifying the default profile or create a different profile, see :ref:`<atlas-cli-profiles>`. @@ -220,9 +233,8 @@ different profile, see :ref:`<atlas-cli-profiles>`. .. toctree:: - /atlas-cli-save-connection-settings - /atlas-cli-env-variables - /migrate-to-atlas-cli + Save Connection Settings </atlas-cli-save-connection-settings> + Migrate to the Atlas CLI </migrate-to-atlas-cli> diff --git a/source/custom-output-cli.txt b/source/custom-output-cli.txt new file mode 100644 index 00000000..d16dfdf4 --- /dev/null +++ b/source/custom-output-cli.txt @@ -0,0 +1,248 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _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 <https://golang.org/pkg/text/template/>`__. +To learn the types and properties available for each response, see +`Atlas types <https://go.mongodb.org/atlas/mongodbatlas/>`__. + +Syntax +~~~~~~ + +You can specify a template with the command using the ``--output`` or +``-o`` option: + +.. code-block:: shell + :copyable: false + + --output|-o go-template="{{<template>}}" + +Alternatively, you can specify a template through a file using the ``--output`` or +``-o`` option: + +.. code-block:: shell + :copyable: false + + --output|-o go-template-file="<path-to-template-file>" + +Examples +~~~~~~~~ + +.. tabs:: + + .. tab:: Specify Template With the Command + :tabid: template-command + + Retrieve the Number of Projects + ``````````````````````````````` + + The following command uses a template to retrieve a count of + the number of projects in the specified organization: + + .. code-block:: shell + + atlas projects ls --orgId 5ab5cedf5g5h5i5j5kl12mn4 -o go-template="Count: {{.TotalCount}}" + + The preceding command returns the following output: + + .. code-block:: shell + :copyable: false + + Count: 2 + + .. _quick-start-atlas-retrieve-conection-string: + + Retrieve Your |service| Cluster Connection String + ````````````````````````````````````````````````` + + + The following :ref:`atlas-clusters-describe` command + uses the template to retrieve the connection string for an + |service| cluster named ``getStarted``. It uses the default + profile for accessing |service|. + + .. code-block:: sh + + atlas clusters describe getStarted -o go-template="Parse: {{.SrvAddress}}" + + The previous command returns a string similar to the following: + + .. code-block:: sh + :copyable: false + + Parse: mongodb+srv://getstarted.example.mongodb.net + + You can use the MongoDB Shell, {+mongosh+}, to connect to the + ``getStarted`` + cluster with the ``srvAddress`` and the :manual:`connection + string + </reference/connection-string/#connection-string-options>`. This + example uses the connection string returned by the previous command + for a user with the username ``User1``. + + .. code-block:: + + mongo "mongodb+srv://getstarted.example.mongodb.net" --username User1 --password ChangeThisPasswordToSomethingSecure + + .. tab:: Specify Template Through a File + :tabid: template-file + + For example, consider the following file named ``template.tmpl``: + + .. code-block:: shell + + Projects: {{range .Results}}{{.ID}} {{end}} + + The following command uses the ``template.tmpl`` file to retrieve + the IDs of the projects in the specified organization: + + .. code-block:: shell + + atlas projects ls --orgId 5ab5cedf5g5h5i5j5kl12mn4 -o go-template-file="template.tmpl" + + The preceding command returns the following output: + + .. code-block:: shell + :copyable: false + + Projects: 5e2211c17a3e5a48f5497de3 5f455b39749bea5fb575dccc + +.. _json-path-output-option: + +``json-path`` Output Type +------------------------- + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +The ``json-path`` output type limits the results of a command to the +fields you specify. + +Usage +~~~~~ + +When you add the ``--output`` option to a command, you can specify the +type ``json-path``. You must provide ``json-path`` with an expression +to evaluate against your results, which means you must be aware of the +``json`` fields returned by your command. + +Syntax +~~~~~~ + +.. code-block:: shell + :copyable: false + + <command> --output|-o json-path='$<expression>' + +``json-path`` expressions refer to the |json| element that an {+atlas-cli+} +command returns. The ``$`` character represents the root element, which +is usually an object or an array. + +For a list of valid characters and their functions, see `JSONPath expressions <https://goessner.net/articles/JsonPath/index.html#e2>`__. + +Examples +~~~~~~~~ + +Return the description of the first |api| key in a list +``````````````````````````````````````````````````````` + +In the following example, a user retrieves their |api| keys with +:ref:`atlas-organizations-apiKeys-list`. The ``json-path`` +expression limits the output to the ``desc`` field of the first key, +rather than returning the entire list of keys. + +.. code-block:: shell + :copyable: false + + atlas organizations apikeys list --output json-path='$[0].desc' + > owner_key + +Running the same command with ``--output json`` returns the full |json| +element from the |api|. It's important to understand the |json| +structure returned by a command in order to operate on it with +``json-path``. + +Using the the following full |json| output for reference, the +``--output json-path`` with the expression ``$[0].desc`` finds and +returns only the value ``"owner_key"``: + +.. code-block:: json + :copyable: false + :emphasize-lines: 1-2, 4 + + [ //``$`` represents the outer array. + { // ``[0]`` refers to the first element in the array (using a 0-based index). + "id": "60e736a95d585d2c9ccf2d19", + "desc": "owner_key", //``.desc`` refers to the ``desc`` field of that element. + "roles": [ + { + "orgId": "5d961a949ccf64b4e7f53bac", + "roleName": "ORG_OWNER" + } + ], + "privateKey": "********-****-****-c4e26334754f", + "publicKey": "xtfmtguk" + }, + { + "id": "d2c9ccf2d1960e736a95d585", + "desc": "member_key", + "roles": [ + { + "orgId": "5d961a949ccf64b4e7f53bac", + "roleName": "ORG_MEMBER" + } + ], + "privateKey": "********-****-****-c4e26334754f", + "publicKey": "vfgcttku" + }, + ] + +Return the description of a specific |api| key in a list +```````````````````````````````````````````````````````` + +In the following example, a user retrieves their |api| keys with +:ref:`atlas-organizations-apiKeys-list`. The ``json-path`` +expression limits the output to the ``desc`` field of the specific +|json| object with ``id`` ``d2c9ccf2d1960e736a95d585``. + +.. code-block:: shell + :copyable: false + + atlas organizations apikeys list --output json-path='$[? @.id=="d2c9ccf2d1960e736a95d585"].desc' + > member_key + +Return the status of a private endpoint +``````````````````````````````````````` + +In the following example, a user retrieves information for a +private endpoint with +:ref:`atlas-privateEndpoints-aws-describe`. The ``json-path`` +expression limits the output to the ``status`` field of the root +element. + +.. code-block:: shell + :copyable: false + + atlas privateendpoints aws describe 601a4044da900269480a2533 --output json-path='$.status' + > WAITING_FOR_USER diff --git a/source/facets.toml b/source/facets.toml new file mode 100644 index 00000000..359d4917 --- /dev/null +++ b/source/facets.toml @@ -0,0 +1,7 @@ +[[facets]] +category = "target_product" +value = "atlas" + +[[facets.sub_facets]] +category = "sub_product" +value = "atlas-cli" diff --git a/source/images/icons/card1.svg b/source/images/icons/card1.svg deleted file mode 100644 index 59345ff3..00000000 --- a/source/images/icons/card1.svg +++ /dev/null @@ -1,5 +0,0 @@ -<svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"> -<path d="M29.3333 27.5556H2.66666C2.17777 27.5556 1.77777 27.1556 1.77777 26.6667V5.33335C1.77777 4.84446 2.17777 4.44446 2.66666 4.44446H29.2889C29.7778 4.44446 30.1778 4.84446 30.1778 5.33335V26.6222C30.2222 27.1556 29.8222 27.5556 29.3333 27.5556Z" stroke="#001E2B" stroke-miterlimit="10" stroke-linejoin="round"/> -<path d="M30.2222 8.8889H1.77777V5.37779C1.77777 4.84446 2.17777 4.44446 2.7111 4.44446H29.2889C29.8222 4.44446 30.2222 4.84446 30.2222 5.37779V8.8889Z" fill="#00ED64" stroke="#001E2B" stroke-miterlimit="10" stroke-linecap="round" stroke-linejoin="round"/> -<path d="M19.0825 17.6935C18.7919 16.2198 17.5347 15.1111 16.0278 15.1111C14.8197 15.1111 13.7598 15.8436 13.2401 16.8888C13.1582 17.0533 12.9837 17.1533 12.8 17.1533C11.8154 17.0682 10.6667 17.9736 10.6667 19.1955C10.6667 20.4173 11.6218 21.3334 12.8 21.3334H19.7744C20.6354 21.3334 21.3334 20.684 21.3334 19.7911C21.3334 18.8982 20.6354 18.1744 19.7744 18.1744C19.462 18.1744 19.1429 17.9999 19.0825 17.6935Z" fill="#00ED64" stroke="#001E2B"/> -</svg> diff --git a/source/images/icons/card2.svg b/source/images/icons/card2.svg deleted file mode 100644 index 14520ac0..00000000 --- a/source/images/icons/card2.svg +++ /dev/null @@ -1,7 +0,0 @@ -<svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"> -<path d="M25.0614 23.1111H2.52892C2.11582 23.1111 1.77783 22.7803 1.77783 22.3761V4.73504C1.77783 4.33077 2.11582 4 2.52892 4H25.0239C25.437 4 25.775 4.33077 25.775 4.73504V22.3393C25.8125 22.7803 25.4745 23.1111 25.0614 23.1111Z" stroke="#001E2B" stroke-miterlimit="10" stroke-linejoin="round"/> -<path d="M25.7778 7.55556H1.77783V4.74667C1.77783 4.32 2.11533 4 2.56533 4H24.9903C25.4403 4 25.7778 4.32 25.7778 4.74667V7.55556Z" fill="#00ED64" stroke="#001E2B" stroke-miterlimit="10" stroke-linecap="round" stroke-linejoin="round"/> -<path d="M12.4445 17.7778H17.7779M7.11121 10.6667L10.5601 14.3682C10.7023 14.5274 10.7023 14.806 10.5601 14.9652L7.11121 18.6667" stroke="#001E2B" stroke-miterlimit="10" stroke-linejoin="round"/> -<path d="M29.4162 25.8049C27.1876 25.9379 25.0927 26.7361 23.3989 27.9335C23.2652 28.0222 23.0424 28.0222 22.9087 27.9335C21.1258 26.7361 19.0755 25.9823 16.8469 25.8049C16.4011 25.7605 16 25.4058 16 24.918V17.3347C16 16.8026 16.4457 16.4035 16.936 16.4478C19.12 16.6252 21.1703 17.3791 22.8641 18.5764C22.9978 18.6651 23.2207 18.6651 23.3544 18.5764C25.0481 17.3791 27.0984 16.6252 29.2824 16.4478C29.8173 16.4035 30.2185 16.8026 30.2185 17.3347V24.918C30.263 25.4058 29.9065 25.8049 29.4162 25.8049Z" fill="#00ED64" stroke="#001E2B" stroke-miterlimit="10"/> -<path d="M23.1112 18.6667V28" stroke="#001E2B" stroke-miterlimit="10"/> -</svg> diff --git a/source/images/icons/card3.svg b/source/images/icons/card3.svg deleted file mode 100644 index 0c413ca1..00000000 --- a/source/images/icons/card3.svg +++ /dev/null @@ -1,6 +0,0 @@ -<svg width="34" height="28" viewBox="0 0 34 28" fill="none" xmlns="http://www.w3.org/2000/svg"> -<path d="M28.401 15.75L32.364 17.9493C33.212 18.3313 33.212 19.5254 32.364 19.9075L17.9977 26.7851C17.3492 27.0716 16.6508 27.0716 16.0023 26.7851L1.63601 19.9075C0.787997 19.5254 0.787997 18.3313 1.63601 17.9493L6.09062 15.5" stroke="#001E2B" stroke-miterlimit="10"/> -<path d="M1.63601 16.4075C0.787997 16.0254 0.787997 14.8313 1.63601 14.4493L4.4576 13C4.49986 13.0864 4.54504 13.1714 4.59316 13.2549C5.43346 14.8725 7.1635 16 9.19011 16H26.0951C27.8745 16 29.3574 14.8235 29.8517 13.2549L32.364 14.4493C33.212 14.8313 33.212 16.0254 32.364 16.4075L17.9977 23.2851C17.3492 23.5716 16.6508 23.5716 16.0023 23.2851L1.63601 16.4075Z" fill="#00ED64" stroke="#001E2B" stroke-miterlimit="10"/> -<path d="M24.6336 8.05249C24.2691 4.09572 21.0208 1 17.0676 1C13.998 1 11.3209 2.91881 10.1186 5.61007C10.023 5.824 9.79969 5.95275 9.56598 5.93608C9.44508 5.92746 9.32304 5.92308 9.2 5.92308C6.8 5.71795 4 7.90064 4 10.8462C4 13.7917 6.32812 16 9.2 16H26.2C28.2987 16 30 14.4345 30 12.2821C30 10.1296 28.2987 8.38462 26.2 8.38462C25.9385 8.38462 25.6461 8.4501 25.3646 8.53786C25.0257 8.6435 24.6661 8.40596 24.6336 8.05249Z" stroke="#001E2B"/> -<path d="M29.0646 4.42026C28.7222 2.47583 27.0489 1 25.0364 1C23.4483 1 22.0553 1.94472 21.3744 3.29188C21.269 3.50021 21.0475 3.62684 20.814 3.62568L20.8 3.62564C19.5077 3.51624 18 4.68034 18 6.25128C18 7.82223 19.2536 9 20.8 9H29.9538C31.0839 9 32 8.16509 32 7.01709C32 5.8691 31.0839 4.93846 29.9538 4.93846C29.9157 4.93846 29.8763 4.94103 29.8361 4.9457C29.4842 4.98666 29.126 4.76914 29.0646 4.42026Z" fill="#00ED64" stroke="#001E2B"/> -</svg> diff --git a/source/includes/alert-configuration-config-file.json b/source/includes/alert-configuration-config-file.json new file mode 100644 index 00000000..b79a1142 --- /dev/null +++ b/source/includes/alert-configuration-config-file.json @@ -0,0 +1,26 @@ +{ + "enabled": true, + "eventTypeName": "NO_PRIMARY", + "matchers": [ + { + "fieldName": "REPLICA_SET_NAME", + "operator": "EQUALS", + "value": "event-replica-set" + } + ], + "notifications": [ + { + "datadogApiKey": "****************************a23c", + "datadogRegion": "US", + "delayMin": 0, + "intervalMin": 5, + "notifierId": "6462742adc47d365036da07c", + "typeName": "DATADOG" + } + ], + "threshold": { + "operator": "<", + "threshold": 0, + "units": "bits" + } +} diff --git a/source/includes/create-atlas-search-expanded-index-config-file.json b/source/includes/create-atlas-search-expanded-index-config-file.json new file mode 100644 index 00000000..a2228b47 --- /dev/null +++ b/source/includes/create-atlas-search-expanded-index-config-file.json @@ -0,0 +1,16 @@ +{ + "collectionName": "listingsAndReviews", + "database": "sample_airbnb", + "name": "myIndex", + "mappings": { + "dynamic": false, + "fields": { + "name": { + "type": "string" + }, + "property_type": { + "type": "string" + } + } + } + } \ No newline at end of file diff --git a/source/includes/create-atlas-search-index-config-file.json b/source/includes/create-atlas-search-index-config-file.json new file mode 100644 index 00000000..edd328e2 --- /dev/null +++ b/source/includes/create-atlas-search-index-config-file.json @@ -0,0 +1,8 @@ +{ + "collectionName": "listingsAndReviews", + "database": "sample_airbnb", + "name": "myIndex", + "mappings": { + "dynamic": true + } +} \ No newline at end of file diff --git a/source/includes/create-search-node-config-file.json b/source/includes/create-search-node-config-file.json new file mode 100644 index 00000000..a5a7d36e --- /dev/null +++ b/source/includes/create-search-node-config-file.json @@ -0,0 +1,9 @@ + +{ + "specs": [ + { + "instanceSize": "S30_LOWCPU_NVME", + "nodeCount": 2 + } + ] +} diff --git a/source/includes/data-federation-instance-config-file.json b/source/includes/data-federation-instance-config-file.json new file mode 100644 index 00000000..b81f5ef0 --- /dev/null +++ b/source/includes/data-federation-instance-config-file.json @@ -0,0 +1,70 @@ +{ + "cloudProviderConfig": { + "aws": { + "externalId": "2fe853d3-4b5b-4le0-9414-s3b6ab040ccb", + "iamAssumedRoleARN": "arn:aws:iam::123456789012:root", + "roleId": "MY_ROLE" + } + }, + "dataProcessRegion": { + "cloudProvider": "AWS", + "region": "SYDNEY_AUS" + }, + "groupId": "32y6e74b3g91947azb20e3b8", + "hostnames": [ + "federateddatabaseinstance5-0ywks.a.query.myhost.com:37017" + ], + "name": "FederatedDatabaseInstance0", + "state": "ACTIVE", + "storage": { + "databases": [ + { + "collections": [ + { + "dataSources": [ + { + "allowInsecure": false, + "collection": "my-collection", + "collectionRegex": "^list", + "database": "my-database", + "databaseRegex": ".*", + "defaultFormat": ".avro", + "path": "/foo/path", + "provenanceFieldName": "my-prov", + "storeName": "my-store", + "urls": [ + "https://atlas-data-lake.s3.amazonaws.com/json/sample_airbnb/listingsAndReviews.json","https://atlas-data-lake.s3.amazonaws.com/json/sample_weatherdata/data.json" + ] + } + ], + "name": "my-collection-mdb" + } + ], + "maxWildcardCollections": 100, + "name": "my-database-mdb", + "views": [ + { + "name": "my-view", + "pipeline": "[{"$group": {"_id": "$status","count": {"$sum": 1 }},"text": { "$push": "$text" }}},{ "$sort": {"count": 1 }}]", + "source": "my-source-collection" + } + ] + } + ], + "stores": [ + { + "name": "egAtlasStore", + "provider": "atlas", + "additionalStorageClasses": [ + "STANDARD" + ], + "bucket": "sample-data-atlas", + "delimiter": "/", + "includeTags": false, + "prefix": "/sample", + "public": false, + "region": "US_GOV_WEST_1" + } + ] + } + } \ No newline at end of file diff --git a/source/includes/fact-atlas-deployments-preview.rst b/source/includes/fact-atlas-deployments-preview.rst new file mode 100644 index 00000000..e20216a3 --- /dev/null +++ b/source/includes/fact-atlas-deployments-preview.rst @@ -0,0 +1,7 @@ +.. important:: Public Preview + + The ``atlas deployments`` command and subsequent related commands + are available as a Public Preview. The feature and corresponding + documentation may change at any time in the Public Preview stage. To + ask questions and provide feedback, see the `{+atlas-cli+} + Local Development Community Forum <https://www.mongodb.com/community/forums/tag/local-dev-atlas-cli>`__. diff --git a/source/includes/fact-avs-mdb-version.rst b/source/includes/fact-avs-mdb-version.rst new file mode 100644 index 00000000..fb544698 --- /dev/null +++ b/source/includes/fact-avs-mdb-version.rst @@ -0,0 +1,8 @@ +.. important:: + + To use the {+atlas-cli+} with {+avs+}, you must create an |service| + deployment with MongoDB 7.0.5 or later. If you created a local + |service| deployment with an earlier MongoDB version, you don't get + the latest MongoDB version automatically. You must delete the + earlier images and deployments. Then you must create a new |service| + deployment. diff --git a/source/includes/fact-deploy-tutorial-prereqs.rst b/source/includes/fact-deploy-tutorial-prereqs.rst new file mode 100644 index 00000000..bb3a0a58 --- /dev/null +++ b/source/includes/fact-deploy-tutorial-prereqs.rst @@ -0,0 +1,66 @@ +Before you begin, complete the following prerequisites: + +.. important:: + + For compatibility information for each prerequisite product, see the + related installation pages. + +- Install the :ref:`{+atlas-cli+} <install-atlas-cli>`. + + **Example (MacOS):** + + .. code-block:: sh + + brew install mongodb-atlas-cli + + To learn about the {+atlas-cli+} install instructions for other + operating systems, see :ref:`install-atlas-cli`. + +- Install :mongosh:`mongosh </install>` version 2.0 or later. + + **Example (MacOS):** + + .. code-block:: sh + + brew install mongosh + + To learn about the {+mongosh+} install instructions for other + operating systems, see :mongosh:`Install mongosh </install>`. + +- (Optional) Install :compass:`Compass </install>` version 1.39.4 or + later. + + **Example (MacOS):** + + .. code-block:: sh + + brew install mongodb-compass + + To learn about the Compass install instructions for other operating + systems, see :compass:`Download and Install Compass </install>`. + +- Install :dbtools:`MongoDB Database Tools + </installation/installation/>`. + + **Example (MacOS):** + + .. code-block:: sh + + brew tap mongodb/brew && brew install mongodb-database-tools + + To learn about the MongoDB Database Tools install instructions for + other operating systems, see :dbtools:`Installing the Database Tools + </installation/installation/>`. + +- Install `Podman <https://podman.io/>`__ version 4.4 and later. + + **Example (MacOS):** + + .. code-block:: sh + + brew install podman + + .. note:: + + Podman requires a network connection for pulling and caching + MongoDB images. 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 diff --git a/source/includes/online-archive-create.json b/source/includes/online-archive-create.json new file mode 100644 index 00000000..dd0a6dc9 --- /dev/null +++ b/source/includes/online-archive-create.json @@ -0,0 +1,28 @@ +{ + "name":"myCluster", + "groupId": "32y6e74b3g91947azb20e3b8", + "collName": "myCollection", + "collectionType": "TIMESERIES", + "criteria": { + "type": "DATE" + }, + "dataExpirationRule": { + "expireAfterDays": 7 + }, + "dataProcessRegion": { + "cloudProvider": "AWS", + "region": "US_EAST_1" + }, + "dbName": "myDB", + "partitionFields": [ + { + "fieldName": "exampleField", + "order": 0 + } + ], + + "paused": true, + "schedule": { + "type": "DEFAULT" + } + } \ No newline at end of file diff --git a/source/includes/online-archive-update.json b/source/includes/online-archive-update.json new file mode 100644 index 00000000..daa5ad84 --- /dev/null +++ b/source/includes/online-archive-update.json @@ -0,0 +1,15 @@ +{ + "name":"myCluster", + "groupId": "32y6e74b3g91947azb20e3b8", + "archiveId":"32y6e74b3g32y6e74b3gyb45", + "criteria": { + "type": "DATE" + }, + "dataExpirationRule": { + "expireAfterDays": 7 + }, + "paused": true, + "schedule": { + "type": "DEFAULT" + } + } \ No newline at end of file diff --git a/source/includes/steps-config-file-template-action-2.rst b/source/includes/steps-config-file-template-action-2.rst new file mode 100644 index 00000000..52a3cf57 --- /dev/null +++ b/source/includes/steps-config-file-template-action-2.rst @@ -0,0 +1,24 @@ +Follow these steps to |action 2| with a configuration file: + +.. procedure:: + :style: normal + + .. step:: Copy the sample request for |openapi-link 2|. + + a. Navigate to the |openapi-link 2| + section of the |service| Admin API specification. + b. Under :guilabel:`Request samples` on the right side, click + :guilabel:`Expand all`. + c. Click :guilabel:`Copy` to copy the sample request. + + .. step:: Create the configuration file. + + a. Paste the sample request into a text editor and change + the values to reflect your desired configuration. + b. Save the file with a ``.json`` extension. + + .. step:: Run the |atlas-cli command 2| command with + the ``--file`` option. + + Specify the path to the file you saved with the ``--file`` flag. + diff --git a/source/includes/steps-config-file-template-action-3.rst b/source/includes/steps-config-file-template-action-3.rst new file mode 100644 index 00000000..88b71ca6 --- /dev/null +++ b/source/includes/steps-config-file-template-action-3.rst @@ -0,0 +1,24 @@ +Follow these steps to |action 3| with a configuration file: + +.. procedure:: + :style: normal + + .. step:: Copy the sample request for |openapi-link 3|. + + a. Navigate to the |openapi-link 3| + section of the |service| Admin API specification. + b. Under :guilabel:`Request samples` on the right side, click + :guilabel:`Expand all`. + c. Click :guilabel:`Copy` to copy the sample request. + + .. step:: Create the configuration file. + + a. Paste the sample request into a text editor and change + the values to reflect your desired configuration. + b. Save the file with a ``.json`` extension. + + .. step:: Run the |atlas-cli command 3| command with + the ``--file`` option. + + Specify the path to the file you saved with the ``--file`` flag. + diff --git a/source/includes/steps-config-file-template.rst b/source/includes/steps-config-file-template.rst new file mode 100644 index 00000000..e4b98759 --- /dev/null +++ b/source/includes/steps-config-file-template.rst @@ -0,0 +1,24 @@ +Follow these steps to |action| with a configuration file: + +.. procedure:: + :style: normal + + .. step:: Copy the sample request for |openapi-link|. + + a. Navigate to the |openapi-link| + section of the |service| Admin API specification. + b. Under :guilabel:`Request samples` on the right side, click + :guilabel:`Expand all`. + c. Click :guilabel:`Copy` to copy the sample request. + + .. step:: Create the configuration file. + + a. Paste the sample request into a text editor and change + the values to reflect your desired configuration. + b. Save the file with a ``.json`` extension. + + .. step:: Run the |atlas-cli command| command with + the ``--file`` option. + + Specify the path to the file you saved with the ``--file`` flag. + diff --git a/source/includes/steps-run-as-daemon.rst b/source/includes/steps-run-as-daemon.rst new file mode 100644 index 00000000..407eef33 --- /dev/null +++ b/source/includes/steps-run-as-daemon.rst @@ -0,0 +1,41 @@ +.. procedure:: + :style: normal + + .. step:: Start the daemon. + + Run the following command to start the daemon: + + .. code-block:: + + docker run -d --name mongodb/atlas mongodb/atlas + + .. step:: Get a shell. + + Run the following command to get a shell with an environment file: + + .. code-block:: + + docker exec --env-file atlas.env --rm -it mongodb/atlas bash + + .. step:: Authenticate and run {+atlas-cli+} commands. + + .. note:: + + You must have access to the GitHub API in order to use the Atlas CLI in Docker. + + To authenticate and run commands, set up API keys in the `environment file + <https://docs.docker.com/engine/reference/commandline/run/#env>`__. + To learn more, see + :ref:`{+atlas-cli+} environment variables <atlas-cli-env-vars>`. + + After you set up API keys, you can run {+atlas-cli+} commands by + adding + ``docker exec --env-file ./atlas.env --rm mongodb/atlas`` before + each {+atlas-cli+} command. For example, to run the + :ref:`atlas --help <atlas>` command with an environment + file, run the following command, replacing ``atlas.env`` with the + name of the environment file: + + .. code-block:: + + docker exec --env-file ./atlas.env --rm mongodb/atlas atlas --help diff --git a/source/includes/steps-run-interactive-mode.rst b/source/includes/steps-run-interactive-mode.rst new file mode 100644 index 00000000..74d4e94a --- /dev/null +++ b/source/includes/steps-run-interactive-mode.rst @@ -0,0 +1,53 @@ +.. procedure:: + :style: normal + + .. step:: Get a shell. + + Run the command to get a shell in interactive mode. + + Without an Environment File + ~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + To get a shell without an environment file, run the + following command: + + .. code-block:: + + docker run --rm -it mongodb/atlas bash + + With an Environment File + ~~~~~~~~~~~~~~~~~~~~~~~~ + + To get a shell using an environment file, run the following + command, replacing ``atlas.env`` with the name of the environment + file: + + .. code-block:: + + docker run --env-file atlas.env --rm -it mongodb/atlas bash + + .. step:: Authenticate and run {+atlas-cli+} commands. + + .. note:: + + You must have access to the GitHub API in order to use the Atlas CLI in Docker. + + To authenticate and run commands, set up API keys in the `environment file + <https://docs.docker.com/engine/reference/commandline/run/#env>`__. + To learn more, see + :ref:`{+atlas-cli+} environment variables <atlas-cli-env-vars>`. + + To authenticate without an environment file, you can run + :ref:`atlas auth login <atlas-auth-login>` to authenticate: + + .. code-block:: + + atlas auth login + + After you authenticate, you can run Atlas CLI commands. For + example, you can run :ref:`atlas --help <atlas>` to learn about + available commands: + + .. code-block:: + + atlas --help diff --git a/source/includes/update-cloud-backup-schedule-config-file.json b/source/includes/update-cloud-backup-schedule-config-file.json new file mode 100644 index 00000000..32188f1c --- /dev/null +++ b/source/includes/update-cloud-backup-schedule-config-file.json @@ -0,0 +1,43 @@ +{ + "autoExportEnabled": true, + "copySettings": [ + { + "cloudProvider": "AWS", + "frequencies": [ + "HOURLY" + ], + "regionName": "US_EAST_1", + "replicationSpecId": "24a7bf81d1ea39035acf7b8e3", + "shouldCopyOplogs": true + } + ], + "deleteCopiedBackups": [ + { + "cloudProvider": "GCP", + "regionName": "CENTRAL_US", + "replicationSpecId": "49c1b72a1ad50263cfa2a3d8" + } + ], + "export": { + "exportBucketId": "62c569f85b7a381c093cc539", + "frequencyType": "monthly" + }, + "policies": [ + { + "id": "62da8faac84a2721e448d767", + "policyItems": [ + { + "frequencyInterval": 6, + "frequencyType": "hourly", + "retentionUnit": "days", + "retentionValue": 7 + } + ] + } + ], + "referenceHourOfDay": 0, + "referenceMinuteOfHour": 0, + "restoreWindowDays": 0, + "updateSnapshots": true, + "useOrgAndGroupNamesInExportPrefix": true +} diff --git a/source/index.txt b/source/index.txt index 4a34f685..e37b83db 100644 --- a/source/index.txt +++ b/source/index.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + :template: product-landing :hidefeedback: header :noprevnext: @@ -63,14 +66,31 @@ 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 </command/atlas-setup>`. + To learn more, see the :ref:`atlas-setup` command. .. image:: /images/setup.gif :alt: atlas setup command + .. tab:: Create an Atlas Deployment + :tabid: deploy + + .. procedure:: + + .. step:: Run ``atlas deployments setup`` + + To learn more, see :ref:`atlas-cli-local-cloud`. + + .. tab:: Create an Atlas Search Index + :tabid: search + + .. procedure:: + + .. step:: Run ``atlas deployments search indexes create`` + + To learn more, see :ref:`atlas-cli-deploy-fts`. .. kicker:: Related Products & Resources @@ -86,7 +106,7 @@ Learn the {+atlas-cli+} commands and optimize your workflow with advanced tutori .. card:: :cta: See All Commands :url: https://www.mongodb.com/docs/atlas/cli/stable/command/atlas/ - :icon: /images/icons/card1.svg + :icon: atlas_cli :icon-alt: AtlasCLI Commands Icon Discover new {+atlas-cli+} commands @@ -94,7 +114,7 @@ Learn the {+atlas-cli+} commands and optimize your workflow with advanced tutori .. card:: :cta: View All Tutorials :url: https://www.mongodb.com/docs/atlas/cli/stable/atlas-cli-tutorials/ - :icon: /images/icons/card2.svg + :icon: general_content_tutorial :icon-alt: Tutorials Icon Explore {+atlas-cli+} workflows with guided tutorials @@ -102,7 +122,7 @@ Learn the {+atlas-cli+} commands and optimize your workflow with advanced tutori .. card:: :cta: Read Release Notes :url: https://www.mongodb.com/docs/atlas/cli/stable/atlas-cli-changelog/ - :icon: /images/icons/card3.svg + :icon: atlas_product_family :icon-alt: Atlas Icon Learn what's new in the {+atlas-cli+} @@ -111,10 +131,12 @@ Learn the {+atlas-cli+} commands and optimize your workflow with advanced tutori :titlesonly: Overview </index> - /install-atlas-cli - /connect-atlas-cli - /configure-optional-settings - /atlas-cli-tutorials - Atlas CLI Commands </command/atlas> - /reference - /atlas-cli-changelog \ No newline at end of file + Install or Update </install-atlas-cli> + Connect </connect-atlas-cli> + Commands </command/atlas> + Automate </atlas-cli-automate> + Configure Telemetry </telemetry> + Manage Atlas </atlas-cli-tutorials> + Reference </reference> + Troubleshoot </troubleshooting> + Changelog </atlas-cli-changelog> \ No newline at end of file diff --git a/source/install-atlas-cli.txt b/source/install-atlas-cli.txt index 2f8d9671..0330adcb 100644 --- a/source/install-atlas-cli.txt +++ b/source/install-atlas-cli.txt @@ -1,9 +1,23 @@ +.. meta:: + :robots: noindex, nosnippet + .. _install-atlas-cli: =================================== Install or Update the {+atlas-cli+} =================================== +.. facet:: + :name: programming_language + :values: shell + +.. facet:: + :name: genre + :values: tutorial + +.. meta:: + :description: Install the Atlas CLI to quickly provision and manage Atlas database deployments from the terminal. + .. contents:: On this page :local: :backlinks: none @@ -13,11 +27,13 @@ Install or Update the {+atlas-cli+} Install the {+atlas-cli+} to quickly provision and manage |service| {+database-deployments+} from the terminal. +To verify packages before installation, see :ref:`verify-packages`. + 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`. @@ -46,15 +62,41 @@ To check whether your operating system is compatible with the Complete the Prerequisites ~~~~~~~~~~~~~~~~~~~~~~~~~~ - To install the {+atlas-cli+} using Apt, you must install ``gnupg``: + To install the {+atlas-cli+} using Apt, you must install ``gnupg`` and ``curl``: .. code-block:: sh - sudo apt-get install gnupg + sudo apt-get install gnupg curl + + .. 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 + <https://docs.chocolatey.org/en-us/choco/setup#requirements>`__ for installing Chocolatey. + #. Install Chocolatey using ``cmd.exe`` or ``PowerShell.exe``. To + learn more, see `Installing Chocolatey <https://docs.chocolatey.org/en-us/choco/setup#installing-chocolatey>`__. + + .. tab:: Docker + :tabid: docker + + Complete the Prerequisites + ~~~~~~~~~~~~~~~~~~~~~~~~~~ + + To install the {+atlas-cli+} using Docker, install the + `Docker engine <https://docs.docker.com/engine/install/>`__ or + `Docker desktop <https://docs.docker.com/desktop/>`__. .. tab:: Download Binary :tabid: download-binary +.. _atlas-cli-install-steps: + Follow These Steps ~~~~~~~~~~~~~~~~~~ @@ -65,6 +107,7 @@ Follow These Steps :tabid: Homebrew .. procedure:: + :style: normal .. step:: Install the {+atlas-cli+} and {+mongosh+}. @@ -87,6 +130,7 @@ Follow These Steps :tabid: yum .. procedure:: + :style: normal .. step:: Configure ``yum`` for your edition of MongoDB. @@ -115,8 +159,8 @@ Follow These Steps enabled=1 gpgkey=https://pgp.mongodb.com/server-{+mdbVersion+}.asc - .. tab:: Amazon Linux - :tabid: amazon + .. tab:: Amazon Linux 2 + :tabid: amazon2 .. code-block:: text :emphasize-lines: 1 @@ -128,6 +172,19 @@ Follow These Steps enabled=1 gpgkey=https://pgp.mongodb.com/server-{+mdbVersion+}.asc + .. tab:: Amazon Linux 2023 + :tabid: amazon2023 + + .. code-block:: text + :emphasize-lines: 1 + + [mongodb-org-{+mdbVersion+}] + name=MongoDB Repository + baseurl=https://repo.mongodb.org/yum/amazon/2023/mongodb-org/{+mdbVersion+}/x86_64/ + gpgcheck=1 + enabled=1 + gpgkey=https://pgp.mongodb.com/server-{+mdbVersion+}.asc + .. tab:: MongoDB Enterprise Edition :tabid: mdb-ent @@ -152,8 +209,8 @@ Follow These Steps enabled=1 gpgkey=https://pgp.mongodb.com/server-{+mdbVersion+}.asc - .. tab:: Amazon Linux - :tabid: amazon + .. tab:: Amazon Linux 2 + :tabid: amazon2 .. code-block:: text :emphasize-lines: 1 @@ -165,6 +222,19 @@ Follow These Steps enabled=1 gpgkey=https://pgp.mongodb.com/server-{+mdbVersion+}.asc + .. tab:: Amazon Linux 2023 + :tabid: amazon2023 + + .. code-block:: text + :emphasize-lines: 1 + + [mongodb-enterprise-{+mdbVersion+}] + name=MongoDB Enterprise Repository + baseurl=https://repo.mongodb.com/yum/amazon/2023/mongodb-enterprise/{+mdbVersion+}/$basearch/ + gpgcheck=1 + enabled=1 + gpgkey=https://pgp.mongodb.com/server-{+mdbVersion+}.asc + .. step:: Install the {+atlas-cli+} and {+mongosh+}. Invoke the following ``yum`` command to install both the @@ -188,6 +258,7 @@ Follow These Steps :tabid: apt .. procedure:: + :style: normal .. step:: Import the public key used by ``apt``. @@ -199,7 +270,9 @@ Follow These Steps .. code-block:: sh - wget -qO - https://pgp.mongodb.com/server-{+mdbVersion+}.asc | sudo apt-key add - + curl -fsSL https://pgp.mongodb.com/server-{+mdbVersion+}.asc | \ + sudo gpg -o /usr/share/keyrings/mongodb-server-{+mdbVersion+}.gpg \ + --dearmor A successful command returns an ``OK``. @@ -230,21 +303,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 signed-by=/usr/share/keyrings/mongodb-server-{+mdbVersion+}.gpg ] 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 focal/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-{+mdbVersion+}.gpg ] 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 bionic/mongodb-org/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list + echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-{+mdbVersion+}.gpg ] 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 @@ -257,19 +330,26 @@ Follow These Steps .. tabs:: - .. tab:: Debian 10 (Buster) - :tabid: comm-deb-10 + .. tab:: Debian 12 (Bookworm) + :tabid: comm-deb-12 .. 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 bookworm/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 11 (Bullseye) + :tabid: comm-deb-11 .. 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 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 buster/mongodb-org/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-org-{+mdbVersion+}.list .. tab:: MongoDB Enterprise Edition :tabid: mdb-ent @@ -292,21 +372,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 signed-by=/usr/share/keyrings/mongodb-server-{+mdbVersion+}.gpg ] 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 focal/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-{+mdbVersion+}.gpg ] 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 bionic/mongodb-enterprise/{+mdbVersion+} multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list + echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-{+mdbVersion+}.gpg ] 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 @@ -317,19 +397,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/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 (Buster) + :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/debian buster/mongodb-enterprise/{+mdbVersion+} main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list .. step:: Refresh the package database. @@ -358,10 +438,54 @@ Follow These Steps .. include:: /includes/steps-verify-atlas-cli.rst + .. tab:: Chocolatey + :tabid: chocolatey + + .. procedure:: + :style: normal + + .. 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:: Docker + :tabid: docker + + To pull the latest `{+atlas-cli+} Docker image + <https://hub.docker.com/repository/docker/mongodb/atlas/general>`__, run the following + command: + + .. code-block:: + + docker pull mongodb/atlas + + If you run ``docker pull mongodb/atlas`` without specifying + a version tag, Docker automatically pulls the latest version + of the Docker image (``mongodb/atlas:latest``). + + To pull a specific version of the Docker image, run the following + command, replacing ``<tag>`` with the version tag: + + .. code-block:: + + docker pull mongodb/atlas:<tag> + + To learn how to run {+atlas-cli+} commands with Docker after you + pull the Docker image, see :ref:`atlas-cli-docker`. + .. tab:: Download Binary :tabid: download-binary .. procedure:: + :style: normal .. step:: Install the {+atlas-cli+}. @@ -421,6 +545,7 @@ method you used to install the {+atlas-cli+}: ~~~~~~~~~~~~~~~~~~ .. procedure:: + :style: normal .. step:: Update the {+atlas-cli+}. @@ -449,6 +574,7 @@ method you used to install the {+atlas-cli+}: ~~~~~~~~~~~~~~~~~~ .. procedure:: + :style: normal .. step:: Update the {+atlas-cli+}. @@ -475,6 +601,7 @@ method you used to install the {+atlas-cli+}: ~~~~~~~~~~~~~~~~~~ .. procedure:: + :style: normal .. step:: Update the {+atlas-cli+}. @@ -495,6 +622,23 @@ method you used to install the {+atlas-cli+}: .. include:: /includes/steps-verify-update-atlas-cli.rst + .. tab:: Chocolatey + :tabid: chocolatey + + Follow These Steps + ~~~~~~~~~~~~~~~~~~ + + .. procedure:: + :style: normal + + .. 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 @@ -502,6 +646,7 @@ method you used to install the {+atlas-cli+}: ~~~~~~~~~~~~~~~~~~ .. procedure:: + :style: normal .. step:: Update the {+atlas-cli+}. @@ -522,9 +667,10 @@ Take the Next Steps ------------------- :ref:`<connect-atlas-cli>` to start using the -:doc:`{+atlas-cli+} commands </command/atlas>`. +:ref:`{+atlas-cli+} commands <atlas>`. .. toctree:: :titlesonly: - /compatibility + Check Compatibility </compatibility> + Verify Packages </verify-packages> diff --git a/source/migrate-to-atlas-cli.txt b/source/migrate-to-atlas-cli.txt index b5d8eba3..d25546af 100644 --- a/source/migrate-to-atlas-cli.txt +++ b/source/migrate-to-atlas-cli.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _migrate-to-atlas-cli: ============================ @@ -6,12 +9,23 @@ Migrate to the {+atlas-cli+} .. default-domain:: mongodb +.. facet:: + :name: genre + :values: tutorial + .. contents:: On this page :local: :backlinks: none :depth: 1 :class: singlecol +.. note:: + + ``mongocli atlas`` commands for MongoCLI are now deprecated. Follow + the steps on this page to migrate to the {+atlas-cli+} and run + :ref:`{+atlas-cli+} commands <atlas>` instead of + ``mongocli atlas`` commands. + If you have already configured {+mcli+}, you can migrate your settings to the {+atlas-cli+} easily. Migrating to the {+atlas-cli+} preserves existing {+mcli+} profiles and saved |api| keys. If you haven't already configured @@ -21,6 +35,7 @@ Complete the following steps to migrate from the {+mcli+} to the {+atlas-cli+}: .. procedure:: + :style: normal .. step:: Install the {+atlas-cli+}. @@ -35,7 +50,7 @@ following steps to migrate from the {+mcli+} to the {+atlas-cli+}: If you use any automation scripts that rely on ``mongocli.toml`` or use {+mcli+} |service| commands, update the scripts to point to the :ref:`new configuration file <config-toml-location>` and use - :doc:`{+atlas-cli+} commands </command/atlas>` instead. + :ref:`{+atlas-cli+} commands <atlas>` instead. .. note:: @@ -54,9 +69,9 @@ following steps to migrate from the {+mcli+} to the {+atlas-cli+}: You can authenticate using either ``atlas auth login`` or ``atlas config init``. To learn more, see :ref:`<connect-atlas-cli>`. - .. step:: Use the new :doc:`{+atlas-cli+} commands </command/atlas>`. + .. step:: Use the new :ref:`{+atlas-cli+} commands <atlas>`. - Use :doc:`{+atlas-cli+} commands </command/atlas>` (starting + Use :ref:`{+atlas-cli+} commands <atlas>` (starting with ``atlas``) wherever you previously used {+mcli+} |service| commands (starting with ``mongocli atlas``). You can use profiles that {+atlas-cli+} migrates diff --git a/source/reference.txt b/source/reference.txt index d3782d5d..ddc7521f 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + ========= Reference @@ -6,4 +9,4 @@ Reference .. toctree:: :titlesonly: - /cluster-config-file \ No newline at end of file + JSON Configuration Files </reference/json> diff --git a/source/reference/facets.toml b/source/reference/facets.toml new file mode 100644 index 00000000..6436e874 --- /dev/null +++ b/source/reference/facets.toml @@ -0,0 +1,3 @@ +[[facets]] +category = "genre" +value = "reference" diff --git a/source/reference/json.txt b/source/reference/json.txt new file mode 100644 index 00000000..d89a848c --- /dev/null +++ b/source/reference/json.txt @@ -0,0 +1,205 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _json-cluster-config: + +====== +|json| +====== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +If an {+atlas-cli+} command accepts the ``--file`` option, you can pass +a ``.json`` configuration file to define specific settings. For example, +you can pass a configuration file when using the {+atlas-cli+} to: + +- :ref:`Create <atlas-clusters-create>`, :ref:`update <atlas-clusters-update>`, + or :ref:`upgrade a cluster <atlas-clusters-upgrade>`. +- :ref:`Update a cloud backup schedule <atlas-backups-schedule-update>`. +- :ref:`Create <atlas-clusters-search-indexes-create>` or + :ref:`update an Atlas Search Index <atlas-clusters-search-indexes-update>`. +- :ref:`Create <atlas-clusters-search-nodes-create>` or + :ref:`update search nodes <atlas-clusters-search-nodes-update>`. +- :ref:`Create a {+df+} database <atlas-dataFederation-create>`. +- :ref:`Create <atlas-alerts-settings-create>` or + :ref:`update an alert configuration <atlas-alerts-settings-update>`. +- :ref:`Create a rolling index <atlas-clusters-indexes-create>` for a cluster. +- :ref:`Update a project <atlas-projects-update>` +- :ref:`Update connected organizations for federated authentication <atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update>`. + +Usage +----- + +To learn which settings are accepted by the {+atlas-cli+}, view the request +body schema and copy the request samples in the :ref:`Atlas Admin API Specification +<api-resources-spec>` for the endpoint that corresponds to the {+atlas-cli+} +command. The commands you can use include but are not limited to: + +.. list-table:: + :header-rows: 1 + :widths: 50 50 + + * - {+atlas-cli+} Command + - API Endpoint + + * - :ref:`atlas-clusters-create` + - :oas-atlas-op:`Create One Cluster </createLegacyCluster>` + + * - :ref:`atlas-clusters-update` + - :oas-atlas-op:`Update Configuration of One Cluster </updateClusterConfiguration>` + + * - :ref:`atlas-clusters-upgrade` + - :oas-atlas-op:`Upgrade One Shared-tier Cluster </upgradeSharedCluster>` + + * - :ref:`atlas-backups-schedule-update` + - :oas-atlas-op:`Update Cloud Backup Schedule for One Cluster </updateBackupSchedule>` + + * - :ref:`atlas-clusters-search-indexes-create` + - :oas-atlas-op:`Create One Atlas Search Index </createAtlasSearchIndex>` + + * - :ref:`atlas-clusters-search-indexes-update` + - :oas-atlas-op:`Update One Atlas Search Index </updateAtlasSearchIndex>` + + * - :ref:`atlas-clusters-search-nodes-create` + - :oas-atlas-op:`Create Search Nodes </createAtlasSearchDeployment>` + + * - :ref:`atlas-clusters-search-nodes-update` + - :oas-atlas-op:`Update Search Nodes </updateAtlasSearchDeployment>` + + * - :ref:`atlas-dataFederation-create` + - :oas-atlas-op:`Create One Federated Database Instance in One Project </createFederatedDatabase>` + + * - :ref:`atlas-alerts-settings-create` + - :oas-atlas-op:`Create One Alert Configuration in One Project </createAlertConfiguration>` + + * - :ref:`atlas-alerts-settings-update` + - :oas-atlas-op:`Update One Alert Configuration for One Project </updateAlertConfiguration>` + + * - :ref:`atlas-clusters-indexes-create` + - :oas-atlas-op:`Create One Rolling Index </createRollingIndex>` + + * - :ref:`atlas-projects-update` + - :oas-atlas-tag:`Update One Project </Projects/operation/updateProject>` + + * - :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update` + - :oas-atlas-tag:`Update One Org Config Connected to One Federation </Federated-Authentication/operation/updateConnectedOrgConfig>` + +When you run the command in your terminal, specify the ``--file`` option +and provide the path to the |json| configuration file that defines your +desired settings. + +Example +~~~~~~~ + +For example, consider the following configuration file +to enable backups and add a label: + +.. code-block:: sh + :caption: /example.json + + { + "backupEnabled" : true, + "labels": [ + { + "key": "<myKey>", + "value": "<myValue>" + } + ] + } + +The following command updates the ``myCluster`` deployment +based on the settings specified in the configuration file: + +.. code-block:: sh + + atlas clusters update myCluster --file example.json + +{+Cluster+} Configuration File +------------------------------ + +To learn more about {+cluster+} configuration files, see +:ref:`atlas-cli-cluster-config-file`. For sample files, +see: + +- :ref:`example-cluster-config-file` +- :ref:`multi-cloud-example-cluster-config-file` +- :ref:`geosharded-example-cluster-config-file` + + +Cloud Backup Schedule Configuration File +---------------------------------------- + +To learn more about cloud backup schedule configuration files, see +:ref:`atlas-cli-cloud-backup-schedule-config-file`. To learn the syntax +for a file, see :ref:`example-cloud-backup-schedule-config-file`. + +Atlas Search Index Configuration File +------------------------------------- + +To learn more about |fts| index configuration files, see +:ref:`atlas-cli-search-index-config-file`. To learn the syntax for a +file, see :ref:`example-search-index-config-file`. + +Search Nodes Configuration File +------------------------------- + +To learn more about search nodes configuration files, see +:ref:`atlas-cli-search-nodes-config-file`. To learn the syntax for a +file, see :ref:`example-search-nodes-config-file`. + +{+adf+} Configuration File +---------------------------------------- + +To learn more about {+adf+} configuration files, see +:ref:`atlas-cli-data-federation-config-file`. To learn the syntax for a +file, see :ref:`example-fdi-config-file`. + +Alert Configuration File +------------------------ + +To learn more about alert configuration files, see +:ref:`atlas-cli-alert-config-file`. To learn the syntax for a file, +see :ref:`example-alert-config-file`. + +Rolling Index Configuration File +-------------------------------- + +To learn more about rolling index configuration files, see +:ref:`atlas-cli-rolling-index-config-file`. For example files, see: + +- `Unique indexes <https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/e2e/atlas/data/create_2dspere_index.json>`__ +- `Sparse Index <https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/e2e/atlas/data/create_sparse_index.json>`__ +- `Partial indexes <https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/e2e/atlas/data/create_partial_index.json>`__ + +Project Configuration File +-------------------------- + +To learn more about project configuration files, see +:ref:`atlas-cli-project-config-file`. To learn the syntax for a file, +see :ref:`example-project-config-file`. + +Federated Authentication Configuration File +------------------------------------------- + +To learn more about federated authentication configuration files, see +:ref:`federated-auth-config-file`. To learn the syntax for a file, +see :ref:`example-connected-org-config-file`. + + +.. toctree:: + :titlesonly: + + Cluster </reference/json/cluster-config-file> + Cloud Backup Schedule </reference/json/cloud-backup-schedule-config-file> + Atlas Data Federation </reference/json/data-federation-config-file> + Atlas Search Index </reference/json/search-index-config-file> + Search Nodes </reference/json/search-nodes-config-file> + Online Archive </reference/json/file-options-online-archive> + Alert </reference/json/alert-config-file> + Rolling Index </reference/json/rolling-index-config-file> + Project </reference/json/project-config-file> + Federated Authentication </reference/json/connected-org-config-file> diff --git a/source/reference/json/alert-config-file.txt b/source/reference/json/alert-config-file.txt new file mode 100644 index 00000000..f1dbeea7 --- /dev/null +++ b/source/reference/json/alert-config-file.txt @@ -0,0 +1,61 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-alert-config-file: + +======================== +Alert Configuration File +======================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + + +.. This page differs from the main template because it documents +.. multiple commands For a one-command +.. template, use the template on cloud-backup-schedule-config-file.txt + +.. |atlas-cli command| replace:: :ref:`atlas-alerts-settings-create` +.. |configuration-file-name| replace:: alert configuration +.. |openapi-link| replace:: :oas-atlas-op:`Create One Alert Configuration in One Project </Alert-Configurations/operation/createAlertConfiguration>` +.. |action| replace:: create an alert configuration + +.. |atlas-cli command 2| replace:: :ref:`atlas-alerts-settings-update` +.. |openapi-link 2| replace:: :oas-atlas-tag:`Update One Alert Configuration for One Project </Alert-Configurations/operation/updateAlertConfiguration>` +.. |action 2| replace:: update an alert configuration + +You can use a |configuration-file-name| file to specify the +settings required when you |action| or |action 2| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _alert-config-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +When you |action 2| using a configuration file, you +can specify any settings that are listed in +|openapi-link 2| under :guilabel:`Request Body Schema`. + +.. _example-alert-config-file: + +Create a Configuration File +--------------------------- + +Create an Alert Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template.rst + +Update an Alert Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template-action-2.rst \ No newline at end of file diff --git a/source/reference/json/cloud-backup-schedule-config-file.txt b/source/reference/json/cloud-backup-schedule-config-file.txt new file mode 100644 index 00000000..80ee11ed --- /dev/null +++ b/source/reference/json/cloud-backup-schedule-config-file.txt @@ -0,0 +1,47 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-cloud-backup-schedule-config-file: + +======================================== +Cloud Backup Schedule Configuration File +======================================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. facet:: + :name: genre + :values: tutorial + +.. To create a configuration file doc, copy this template, change +.. the replacements below, and update the H1 title and refs. + +.. |atlas-cli command| replace:: :ref:`atlas-backups-schedule-update` +.. |configuration-file-name| replace:: cloud backup schedule configuration +.. |openapi-link| replace:: :oas-atlas-tag:`Update Cloud Backup Schedule for One Cluster </Cloud-Backups/operation/updateBackupSchedule>` +.. |action| replace:: update a cloud backup schedule + +You can use a |configuration-file-name| file to specify the +settings required when you |action| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _cloud-backup-schedule-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +.. _example-cloud-backup-schedule-config-file: + +Create a Configuration File +--------------------------- + +.. include:: /includes/steps-config-file-template.rst diff --git a/source/reference/json/cluster-config-file.txt b/source/reference/json/cluster-config-file.txt new file mode 100644 index 00000000..9b12055b --- /dev/null +++ b/source/reference/json/cluster-config-file.txt @@ -0,0 +1,73 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-cluster-config-file: + +============================== +{+Cluster+} Configuration File +============================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + + +.. |atlas-cli command| replace:: :ref:`atlas-clusters-create` +.. |configuration-file-name| replace:: cluster configuration +.. |openapi-link| replace:: :oas-atlas-tag:`Create One Cluster from One Project </Clusters/operation/createCluster>` +.. |action| replace:: create clusters + +.. |atlas-cli command 2| replace:: :ref:`atlas-clusters-update` +.. |openapi-link 2| replace:: :oas-atlas-tag:`Modify One Cluster from One Project </Clusters/operation/updateCluster>` +.. |action 2| replace:: update clusters + +.. |atlas-cli command 3| replace:: :ref:`atlas-clusters-upgrade` +.. |openapi-link 3| replace:: :oas-atlas-tag:`Upgrade One Shared-tier Cluster </Clusters/operation/upgradeSharedCluster>` +.. |action 3| replace:: upgrade clusters + +You can use a |configuration-file-name| file to specify the +settings required when you |action|, |action 2|, or |action 3| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _required-cluster-settings: +.. _optional-cluster-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +When you |action 2| using a configuration file, you +can specify any settings that are listed in +|openapi-link 2| under :guilabel:`Request Body Schema`. + +When you |action 3| using a configuration file, you +can specify any settings that are listed in +|openapi-link 3| under :guilabel:`Request Body Schema`. + +.. _example-cluster-config-file: +.. _multi-cloud-example-cluster-config-file: +.. _geosharded-example-cluster-config-file: + +Create a Configuration File +--------------------------- + +Create a Cluster +~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template.rst + +Update a Cluster +~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template-action-2.rst + +Upgrade a Cluster +~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template-action-3.rst \ No newline at end of file diff --git a/source/reference/json/connected-org-config-file.txt b/source/reference/json/connected-org-config-file.txt new file mode 100644 index 00000000..ee1120d1 --- /dev/null +++ b/source/reference/json/connected-org-config-file.txt @@ -0,0 +1,47 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _federated-auth-config-file: + +=========================================== +Federated Authentication Configuration File +=========================================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. facet:: + :name: genre + :values: tutorial + +.. To create a configuration file doc, copy this template, change +.. the replacements below, and update the H1 title and refs. + +.. |atlas-cli command| replace:: :ref:`atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update` +.. |configuration-file-name| replace:: federated authentication configuration +.. |openapi-link| replace:: :oas-atlas-tag:`Update One Org Config Connected to One Federation </Federated-Authentication/operation/updateConnectedOrgConfig>` +.. |action| replace:: update connected organizations for federated authentication + +You can use a |configuration-file-name| file to specify the +settings required when you |action| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _connected-org-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +.. _example-connected-org-config-file: + +Create a Configuration File +--------------------------- + +.. include:: /includes/steps-config-file-template.rst diff --git a/source/reference/json/data-federation-config-file.txt b/source/reference/json/data-federation-config-file.txt new file mode 100644 index 00000000..36c79678 --- /dev/null +++ b/source/reference/json/data-federation-config-file.txt @@ -0,0 +1,47 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-data-federation-config-file: + +======================================== +{+adf+} Configuration File +======================================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. facet:: + :name: genre + :values: tutorial + +.. To create a configuration file doc, copy this template, change +.. the replacements below, and update the H1 title and refs. + +.. |atlas-cli command| replace:: :ref:`atlas-dataFederation-create` +.. |configuration-file-name| replace:: data federation configuration +.. |openapi-link| replace:: :oas-atlas-tag:`Create One Federated Database Instance in One Project </Data-Federation/operation/createFederatedDatabase>` +.. |action| replace:: create a federated database instance + +You can use a |configuration-file-name| file to specify the +settings required when you |action| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _required-fdi-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +.. _example-fdi-config-file: + +Create a Configuration File +--------------------------- + +.. include:: /includes/steps-config-file-template.rst \ No newline at end of file diff --git a/source/reference/json/file-options-online-archive.txt b/source/reference/json/file-options-online-archive.txt new file mode 100644 index 00000000..df835a66 --- /dev/null +++ b/source/reference/json/file-options-online-archive.txt @@ -0,0 +1,60 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-file-options-online-archive-file: + +======================================== +Online Archive Configuration File +======================================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. This page differs from the main template because it documents +.. multiple commands For a one-command +.. template, use the template on cloud-backup-schedule-config-file.txt + +.. |atlas-cli command| replace:: :ref:`atlas-clusters-onlineArchives-create` +.. |configuration-file-name| replace:: online archive configuration +.. |openapi-link| replace:: :oas-atlas-tag:`Create One Online Archive </Online-Archive/operation/createOnlineArchive>` +.. |action| replace:: create online archives + +.. |atlas-cli command 2| replace:: :ref:`atlas-clusters-onlineArchives-update` +.. |openapi-link 2| replace:: :oas-atlas-tag:`Update One Online Archive </Online-Archive/operation/updateOnlineArchive>` +.. |action 2| replace:: update online archives + +You can use a |configuration-file-name| file to specify the +settings required when you |action| or |action 2| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _required-oa-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +When you |action 2| using a configuration file, you +can specify any settings that are listed in +|openapi-link 2| under :guilabel:`Request Body Schema`. + +.. _example-oa-config-file: + +Create a Configuration File +--------------------------- + +Create an Online Archive +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template.rst + +Update an Online Archive +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template-action-2.rst \ No newline at end of file diff --git a/source/reference/json/project-config-file.txt b/source/reference/json/project-config-file.txt new file mode 100644 index 00000000..e4d521f9 --- /dev/null +++ b/source/reference/json/project-config-file.txt @@ -0,0 +1,47 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-project-config-file: + +========================== +Project Configuration File +========================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. facet:: + :name: genre + :values: tutorial + +.. To create a configuration file doc, copy this template, change +.. the replacements below, and update the H1 title and refs. + +.. |atlas-cli command| replace:: :ref:`atlas-projects-update` +.. |configuration-file-name| replace:: project configuration +.. |openapi-link| replace:: :oas-atlas-tag:`Update One Project </Projects/operation/updateProject>` +.. |action| replace:: update a project + +You can use a |configuration-file-name| file to specify the +settings required when you |action| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _project-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +.. _example-project-config-file: + +Create a Configuration File +--------------------------- + +.. include:: /includes/steps-config-file-template.rst diff --git a/source/reference/json/rolling-index-config-file.txt b/source/reference/json/rolling-index-config-file.txt new file mode 100644 index 00000000..b255dca9 --- /dev/null +++ b/source/reference/json/rolling-index-config-file.txt @@ -0,0 +1,49 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-rolling-index-config-file: + +================================ +Rolling Index Configuration File +================================ + +.. facet:: + :name: genre + :values: tutorial + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. |atlas-cli command| replace:: :ref:`atlas-clusters-indexes-create` +.. |configuration-file-name| replace:: rolling index configuration +.. |openapi-link| replace:: :oas-atlas-op:`Create One Rolling Index </createRollingIndex>` +.. |action| replace:: create one rolling index + +You can use a |configuration-file-name| file to specify the +settings required when you |action| using the {+atlas-cli+}. The +{+atlas-cli+} accepts ``.json`` |configuration-file-name| files. + +.. _rolling-index-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +.. seealso:: Rolling Index File Examples + + - `Unique indexes <https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/e2e/atlas/data/create_2dspere_index.json>`__ + - `Sparse indexes <https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/e2e/atlas/data/create_sparse_index.json>`__ + - `Partial indexes <https://github.com/mongodb/mongodb-atlas-cli/blob/master/test/e2e/atlas/data/create_partial_index.json>`__ + +.. _example-rolling-index-config-file: + +Create a Configuration File +--------------------------- + +.. include:: /includes/steps-config-file-template.rst diff --git a/source/reference/json/search-index-config-file.txt b/source/reference/json/search-index-config-file.txt new file mode 100644 index 00000000..9324fa37 --- /dev/null +++ b/source/reference/json/search-index-config-file.txt @@ -0,0 +1,64 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-search-index-config-file: + +===================================== +Atlas Search Index Configuration File +===================================== + +.. facet:: + :name: genre + :values: tutorial + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. This page differs from the main template because it documents +.. multiple commands For a one-command +.. template, use the template on cloud-backup-schedule-config-file.txt + +.. |atlas-cli command| replace:: :ref:`atlas-clusters-search-indexes-create` +.. |configuration-file-name| replace:: search index configuration +.. |openapi-link| replace:: :oas-atlas-op:`Create One Atlas Search Index </createAtlasSearchIndex>` +.. |action| replace:: create an Atlas Search index + +.. |atlas-cli command 2| replace:: :ref:`atlas-clusters-search-indexes-update` +.. |openapi-link 2| replace:: :oas-atlas-tag:`Update One Atlas Search Index </Online-Archive/operation/updateAtlasSearchIndex>` +.. |action 2| replace:: update an Atlas Search index + +You can use a |configuration-file-name| file to specify the +settings required when you |action| or |action 2| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _search-index-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +When you |action 2| using a configuration file, you +can specify any settings that are listed in +|openapi-link 2| under :guilabel:`Request Body Schema`. + +.. _example-search-index-config-file: + +Create a Configuration File +--------------------------- + +Create an Atlas Search Index +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template.rst + +Update an Atlas Search Index +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template-action-2.rst diff --git a/source/reference/json/search-nodes-config-file.txt b/source/reference/json/search-nodes-config-file.txt new file mode 100644 index 00000000..9244e4a5 --- /dev/null +++ b/source/reference/json/search-nodes-config-file.txt @@ -0,0 +1,60 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _atlas-cli-search-nodes-config-file: + +=============================== +Search Nodes Configuration File +=============================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. This page differs from the main template because it documents +.. multiple commands For a one-command +.. template, use the template on cloud-backup-schedule-config-file.txt + +.. |atlas-cli command| replace:: :ref:`atlas-clusters-search-nodes-create` +.. |configuration-file-name| replace:: search nodes configuration +.. |openapi-link| replace:: :oas-atlas-tag:`Create Search Nodes </Atlas-Search/operation/createAtlasSearchDeployment>` +.. |action| replace:: create search nodes + +.. |atlas-cli command 2| replace:: :ref:`atlas-clusters-search-nodes-update` +.. |openapi-link 2| replace:: :oas-atlas-tag:`Update Search Nodes </Atlas-Search/operation/updateAtlasSearchDeployment>` +.. |action 2| replace:: update search nodes + +You can use a |configuration-file-name| file to specify the +settings required when you |action| or |action 2| +using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` +|configuration-file-name| files. + +.. _search-nodes-settings: + +Available Settings +------------------ + +When you |action| using a configuration file, you +can specify any settings that are listed in +|openapi-link| under :guilabel:`Request Body Schema`. + +When you |action 2| using a configuration file, you +can specify any settings that are listed in +|openapi-link 2| under :guilabel:`Request Body Schema`. + +.. _example-search-nodes-config-file: + +Create a Configuration File +--------------------------- + +Create a Search Node +~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template.rst + +Update a Search Node +~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/steps-config-file-template-action-2.rst diff --git a/source/telemetry.txt b/source/telemetry.txt index a9b82e68..19b96ee5 100644 --- a/source/telemetry.txt +++ b/source/telemetry.txt @@ -1,3 +1,6 @@ +.. meta:: + :robots: noindex, nosnippet + .. _telemetry: =================== @@ -20,6 +23,11 @@ identify improvements with the greatest impact. The installed the {+atlas-cli+} and {+mongosh+} together in the same package. +The following information also applies to local MongoDB deployments. To +learn more, see :ref:`atlas-cli-local-cloud`. + +.. include:: /includes/fact-atlas-deployments-preview.rst + Learn What the {+atlas-cli+} Tracks ----------------------------------- @@ -83,7 +91,6 @@ Learn What the {+atlas-cli+} Doesn't Track * - |api| key values or |service| login credentials. - ``private_api_key abcdefghi123456789`` - Disable Telemetry for the {+atlas-cli+} --------------------------------------- diff --git a/source/troubleshooting.txt b/source/troubleshooting.txt new file mode 100644 index 00000000..19e56735 --- /dev/null +++ b/source/troubleshooting.txt @@ -0,0 +1,323 @@ +.. meta:: + :robots: noindex, nosnippet + +:noprevnext: + +.. _atlas-cli-troubleshooting: + +=================== +Troubleshoot Errors +=================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. _local-deploy-errors: + +Troubleshoot Local Atlas Deployment Issues +------------------------------------------ + +Error: qemu exited unexpectedly with exit code -1, stderr: qemu-system-x86_64: Error: HV_DENIED +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The {+atlas-cli+} uses `Podman <https://podman.io/>`__ and `QEMU +<https://www.qemu.org/>`__. We have identified this issue on MacOS x86 +architectures. To resolve this issue, upgrade to the latest version of +QEMU and restart Podman. + +Error: exit status 127 +~~~~~~~~~~~~~~~~~~~~~~ + +This error might occur when you use the ``atlas deployments setup`` +command on Ubuntu Linux because of a `known issue +<https://bugs.launchpad.net/ubuntu/+source/libpod/+bug/2024394>`__ with +Podman. We don't support Ubuntu for local |service| deployments during +this Public Preview stage. + +MongoNetworkError: connect ECONNREFUSED +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This issue might occur after your machine goes into sleep mode or +restarts. When you try to connect to the local |service| deployment, +this error occurs. + +The {+atlas-cli+} uses `Podman <https://podman.io/>`__ and `QEMU +<https://www.qemu.org/>`__ to run dockerized instances of MongoDB. +Podman has a daemonless architecture. So, the local MongoDB instances +don't restart automatically. + +To fix this issue: + +1. List the available deployments. + + .. code-block:: sh + + atlas deployments list + +#. To resume the container, copy and paste the following command into + your terminal, and replace ``{deployment-name}`` with the name of + the deployment to start. + + .. code-block:: sh + + atlas deployments start {deployment-name} + +Issues on Windows +~~~~~~~~~~~~~~~~~ + +We don't support Windows for local |service| deployments during this +Public Preview stage. + +Local Machine Issues +~~~~~~~~~~~~~~~~~~~~ + +If the {+atlas-cli+} slows down to an unusable state after you create +multiple local |service| deployments and load data, you might have +reached the limits of your machine. + +Consider allocating more memory: + +1. Stop the Podman machine: + + .. code-block:: sh + + podman machine stop + +#. Allocate more memory based on your machine settings: + + .. code-block:: sh + + podman machine set --cpus 3 --memory 5120 + +#. Start the Podman machine: + + .. code-block:: sh + + podman machine start + +#. List the Podman containers. + + .. code-block:: sh + + podman ps --all + +#. To resume the container, copy and paste the following command into + your terminal and replace ``{container-name}`` with the name of the + container to start. + + .. code-block:: sh + + podman start {container-name} + +Podman Issues +~~~~~~~~~~~~~ + +The {+atlas-cli+} uses `Podman <https://podman.io/>`__ for +``atlas deployments`` commands. + +To install Podman, run the following command: + +.. code-block:: sh + + brew install podman + +To initialize a Podman machine, run the following command: + +.. code-block:: sh + + podman machine init + +To start a Podman machine, run the following command: + +.. code-block:: + + podman machine start + +If your local |service| deployment doesn't work, you might need to +clean up your Podman environment and start fresh: + +.. code-block:: + + podman kill --all && podman system prune --force && podman volume rm --all + +Failed to Install or Update the AtlasCLI Plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If the {+atlas-cli+} plugin fails to install or update, make sure that you have +access to the `GitHub API <https://docs.github.com/en/rest>`__, +as GitHub API access is required to install or update the {+atlas-cli+} plugin. + +Run Diagnostics +~~~~~~~~~~~~~~~ + +If you run into issues and with ``atlas deployments`` commands and need +support, run the following command to provide detailed diagnostics: + +.. code-block:: sh + + atlas deployments diagnostics <deploymentName> --output json > out.json + +Command Errors +-------------- + +Error: missing credentials +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Ensure that you either: + +- Run ``atlas config init`` and add your API keys to your + :ref:`profile <config-toml-location>` or add your API keys to your + :ref:`environment variables <atlas-cli-env-vars>`. 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 +<config-toml-location>`, 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 <atlas-cli-env-vars>`, +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+} <connect-atlas-cli>` +doesn't have permission to perform the requested action. User accounts +and API keys must have the appropriate :atlas:`user roles </reference/user-roles>` +to run {+atlas-cli+} commands. To assign or change a user's roles, see: + +- :atlas:`Manage Organization Users </access/manage-org-users/>` +- :atlas:`Manage Access to a Project </access/manage-project-access/>` +- :atlas:`API configuration </configure-api-access>` + +401 (request "Unauthorized") The currently logged in user does not have the group creator role in organization <org-id>. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This error might appear when trying to create a new +:atlas:`project </tutorial/manage-projects/>`. The user account or API +key that you use to authenticate must have the +``Organization Project Creator`` role at the +:atlas:`organization level </tutorial/manage-organizations/>` in order +to create new projects. + +403 (request "Forbidden") IP address <ip-address> is not allowed to access this resource. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The user's IP address that you use to authenticate is not on +the :atlas:`access list </configure-api-access>` for the requested +project. Add your IP address to the :atlas:`access list +</configure-api-access>` to run commands. + +To learn more, see the following pages: + +- For project access lists, see + :atlas:`Configure IP Access List Entries </security/ip-access-list/>`. + +- For API key access lists, see + :atlas:`Get Started with the Atlas Administration API + </configure-api-access>`. + +To add your IP address to an API key's access list: + +.. procedure:: + :style: normal + + .. step:: Go to the :guilabel:`Access Manager` page for your project. + + a. If it isn't already displayed, select the organization that + contains your desired project from the :icon-mms:`office` + :guilabel:`Organizations` menu in the navigation bar. + + #. Select your desired project from the list of projects in the + :guilabel:`Projects` page. + + #. Next to the :guilabel:`Projects` menu, expand the + :icon-fa5:`ellipsis-v` :guilabel:`Options` menu, then click + :guilabel:`Project Settings`. + + #. Click :guilabel:`Access Manager` in the navigation bar. + + .. step:: Go to the API key's access list. + + a. Click the :guilabel:`API Keys` tab. + + #. Click :icon-mms:`ellipsis` to the right of the |api| Key. + + #. Click :guilabel:`Edit Permissions` and click :guilabel:`Next`. + + .. step:: Add your IP address to the API key's access list. + + a. Do one of the following tasks in the + :guilabel:`API Access List` section: + + - Click :guilabel:`Add Access List Entry` and type an |ipaddr| + address. + + - If your current host for accessing |service| will also make + |api| requests with this |api| key, click + :guilabel:`Use Current IP Address` . + + #. Click :guilabel:`Save`. + +404 (request "Not Found") An invalid group ID <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. diff --git a/source/verify-packages.txt b/source/verify-packages.txt new file mode 100644 index 00000000..1968d9da --- /dev/null +++ b/source/verify-packages.txt @@ -0,0 +1,251 @@ +.. meta:: + :robots: noindex, nosnippet + +.. _verify-packages: + +============================================== +Verify the Integrity of {+atlas-cli+} Packages +============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +.. facet:: + :name: genre + :values: tutorial + +The {+atlas-cli+} release team digitally signs all software packages and +container images to certify that a particular package is valid and +unaltered. Before you install the {+atlas-cli+} packages for Linux, +Windows, or Docker, you should validate the +package using the provided PGP signature, SHA-256 checksum, or +`Cosign <https://github.com/sigstore/cosign>`__ information. + +.. _verify-packages-linux: + +Verify Linux Packages +--------------------- + +MongoDB signs each release branch with a different PGP key. The public +key files for the lastest {+atlas-cli+} release is available for +download from the `key server <https://pgp.mongodb.com/>`_. + +The following procedure verifies the {+atlas-cli+} package against its +PGP key. + +.. procedure:: + :style: normal + + .. step:: Download the {+atlas-cli+} installation file. + + Download the {+atlas-cli+} binaries from the + `MongoDB Download Center + <https://www.mongodb.com/try/download/atlascli>`__ + based on your Linux environment. Click :guilabel:`Copy link` and + use the URL in the following instructions. + + For example, to download the ``{+atlas-cli-version+}`` release + for Linux through the shell, run the following command: + + .. code-block:: + + curl -LO https://fastdl.mongodb.org/mongocli/mongodb-atlas-cli_{+atlas-cli-version+}_linux_x86_64.tar.gz + + .. step:: Download the public signature file. + + Run the following command to download the file: + + .. code-block:: + + curl -LO https://fastdl.mongodb.org/mongocli/mongodb-atlas-cli_{+atlas-cli-version+}_linux_x86_64.tar.gz.sig + + .. step:: Download and import the key file. + + Run the following command to download and import the key file: + + .. io-code-block:: + :copyable: true + + .. input:: + + curl -LO https://pgp.mongodb.com/atlas-cli.asc + gpg --import atlas-cli.asc + + .. output:: + + gpg: key <key-value-short>: public key "Atlas CLI Release Signing Key <packaging@mongodb.com>" imported + gpg: Total number processed: 1 + gpg: imported: 1 + + .. step:: Verify the {+atlas-cli+} installation file. + + Run the following command to verify the installation file: + + .. io-code-block:: + :copyable: true + + .. input:: + + gpg --verify mongodb-atlas-cli_{+atlas-cli-version+}_linux_x86_64.tar.gz.sig mongodb-atlas-cli_{+atlas-cli-version+}_linux_x86_64.tar.gz + + .. output:: + + gpg: Signature made Thu Mar 14 08:25:00 2024 EDT + gpg: using RSA key <key-value-long> + gpg: Good signature from "Atlas CLI Release Signing Key <packaging@mongodb.com>" [unknown] + + If the package is properly signed, but you don't currently trust + the signing key, ``gpg`` also returns the following message : + + .. code-block:: + + gpg: WARNING: This key is not certified with a trusted signature! + gpg: There is no indication that the signature belongs to the owner. + +.. _verify-packages-windows: + +Verify Windows Packages +----------------------- + +The following procedure verifies the {+atlas-cli+} package against its +SHA-256 key. + +.. procedure:: + :style: normal + + .. step:: Download the {+atlas-cli+} installation file. + + Download the {+atlas-cli+} ``.msi`` or ``.zip`` file from the + `MongoDB Download Center + <https://www.mongodb.com/try/download/atlascli>`__ or + `Github <https://github.com/mongodb/mongodb-atlas-cli/releases>`__. + + .. step:: Save the public signature. + + a. Download the ``checksums.txt`` file for the + release from `Github + <https://github.com/mongodb/mongodb-atlas-cli/releases>`__, + which contains the SHA-256 key for each file. For example, for + version {+atlas-cli-version+}, + download the `{+atlas-cli-version+} checksums.txt file + <https://github.com/mongodb/mongodb-atlas-cli/releases/download/atlascli%2Fv{+atlas-cli-version+}/checksums.txt>`__. + #. Open the ``checksums.txt`` file and copy the text listed to + the left of the package you downloaded. + For example, if you downloaded ``mongodb-atlas-cli_{+atlas-cli-version+}_windows_x86_64.zip``, + copy the text to the left of + ``mongodb-atlas-cli_{+atlas-cli-version+}_windows_x86_64.zip``. + This value is the SHA-256 key value. + #. Save the SHA-256 key value in a ``.txt`` file named ``atlas-cli-key`` + in your Downloads folder. + + .. step:: Compare the signature file to the {+atlas-cli+} installer hash. + + Run the Powershell command to verify the package based on the + file you downloaded. + + If you downloaded + ``mongodb-atlas-cli_{+atlas-cli-version+}_windows_x86_64.zip``, + run the following command: + + .. io-code-block:: + :copyable: true + + .. input:: + + $sigHash = (Get-Content $Env:HomePath\Downloads\atlas-cli-key.txt | Out-String).SubString(0,64).ToUpper(); ` + $fileHash = (Get-FileHash $Env:HomePath\Downloads\mongodb-atlas-cli_{+atlas-cli-version+}_windows_x86_64.zip).Hash.Trim(); ` + echo $sigHash; echo $fileHash; ` + $sigHash -eq $fileHash + + .. output:: + + <key-value-from-signature-file> + <key-value-from-downloaded-package> + True + + If you downloaded + ``mongodb-atlas-cli_{+atlas-cli-version+}_windows_x86_64.msi``, + run the following command: + + .. io-code-block:: + :copyable: true + + .. input:: + + $sigHash = (Get-Content $Env:HomePath\Downloads\atlas-cli-key.txt | Out-String).SubString(0,64).ToUpper(); ` + $fileHash = (Get-FileHash $Env:HomePath\Downloads\mongodb-atlas-cli_{+atlas-cli-version+}_windows_x86_64.msi).Hash.Trim(); ` + echo $sigHash; echo $fileHash; ` + $sigHash -eq $fileHash + + .. output:: + + <key-value-from-signature-file> + <key-value-from-downloaded-package> + True + + The command returns the key value from the signature file, the + key value from the downloaded package, and ``True`` if the two + values match. + + If the two values match, the {+atlas-cli+} binary is verified. + +.. _verify-packages-docker: + +Verify Docker Container Images +------------------------------ + +You can use `Cosign <https://github.com/sigstore/cosign>`__ to verify +MongoDB's signature for {+atlas-cli+} container images. + +To verify MongoDB's container signature, perform the following steps: + +.. procedure:: + :style: normal + + .. step:: Download and install Cosign. + + **Example: MacOS** + + .. code-block:: + + brew install cosign + + For full installation instructions, see `Cosign + <https://github.com/sigstore/cosign>`__. + + .. step:: Download the {+atlas-cli+} container image's public key + + .. code-block:: + + curl https://cosign.mongodb.com/atlas-cli.pem > atlas-cli.pem + + .. step:: Verify the signature. + + Run the following command to verify the signature by tag: + + .. io-code-block:: + :copyable: true + + .. input:: + + COSIGN_REPOSITORY=docker.io/mongodb/signatures cosign verify --private-infrastructure --key=./atlas-cli.pem docker.io/mongodb/atlas:latest + + .. output:: + + Verification for index.docker.io/mongodb/atlas:latest -- + The following checks were performed on each of these signatures: + - The cosign claims were validated + - The signatures were verified against the specified public key + + [{"critical":{"identity":{"docker-reference":"index.docker.io/mongodb/atlas"},"image":{"docker-manifest-digest":"sha256:<key-value>"},"type":"cosign container image signature"},"optional":null}] + + + + + + diff --git a/submodules/mongodb-atlas-cli b/submodules/mongodb-atlas-cli deleted file mode 160000 index 2ac7d5cf..00000000 --- a/submodules/mongodb-atlas-cli +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 2ac7d5cf94baa17b50e783a0f8a579695d9d0b4e