Skip to content

CLOUDP-112245: Add missing docs #1011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions docs/atlascli/command/atlas-clusters-create.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ atlas clusters create
:depth: 1
:class: singlecol

Create a MongoDB cluster for your project.
Create one cluster in the specified project.

You can create MongoDB clusters using this command.
The quickest way to get started is to specify a name for your cluster and cloud provider and region to deploy.
This will create a 3 member replica set with the latest available MongoDB server version available.
Some of the cluster configuration options are available via flags, but for full control of your deployment you can provide a config file.
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.

Syntax
------
Expand All @@ -40,7 +38,7 @@ Arguments
* - clusterName
- 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 hyphen.
- Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphens.

Options
-------
Expand Down Expand Up @@ -132,16 +130,16 @@ Examples
.. code-block::


Deploy a 3 member replica set in AWS:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 4.2 --diskSizeGB 10
Deploy a three-member replica set in AWS:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10

Deploy a 3 member replica set in AZURE:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 4.2 --diskSizeGB 10
Deploy a three-member replica set in AZURE:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10

Deploy a 3 member replica set in GCP:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 4.2 --diskSizeGB 10
Deploy a three-member replica set in GCP:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10

Deploy a cluster from a config file:
$ mongocli atlas cluster create --projectId <projectId> --file <path/to/cluster.json>
Deploy a cluster or a multi-cloud cluster from a JSON configuration file:
$ mongocli atlas cluster create --projectId <projectId> --file <path/to/file.json>


2 changes: 1 addition & 1 deletion docs/atlascli/command/atlas-clusters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Related Commands
----------------

* :ref:`atlas-clusters-connectionStrings` - Manage MongoDB cluster connection string.
* :ref:`atlas-clusters-create` - Create a MongoDB cluster for your project.
* :ref:`atlas-clusters-create` - Create one cluster in the specified project.
* :ref:`atlas-clusters-delete` - Delete a cluster from your project.
* :ref:`atlas-clusters-describe` - Describe a cluster.
* :ref:`atlas-clusters-indexes` - Manage cluster rolling indexes for your project.
Expand Down
72 changes: 72 additions & 0 deletions docs/atlascli/command/atlas-config-init.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
.. _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::

atlas config init [options]

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
- Profile to use from your configuration file.

Examples
--------

.. code-block::


To configure the tool to work with Atlas
$ atlas config init

To configure the tool to work with Atlas for Government
$ atlas config init --gov


2 changes: 1 addition & 1 deletion docs/atlascli/command/atlas-config-set.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ atlas config set
Configure specific properties of a profile.

Configure specific properties of the profile.
Available properties include: [project_id org_id service public_api_key private_api_key output ops_manager_url base_url ops_manager_ca_certificate ops_manager_skip_verify mongosh_path skip_update_check].
Available properties include: [project_id org_id service public_api_key private_api_key output ops_manager_url base_url ops_manager_ca_certificate ops_manager_skip_verify mongosh_path skip_update_check access_token refresh_token].

Syntax
------
Expand Down
38 changes: 5 additions & 33 deletions docs/atlascli/command/atlas-config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,15 @@ atlas config
:depth: 1
:class: singlecol

Configure a profile to store access settings for your MongoDB deployment.
Manage your profile to store access settings for your MongoDB deployment.

Configure settings in a user profile.
All settings are optional. You can specify settings individually by running:
$ mongocli config set --help
$ atlas config set --help

You can also use environment variables (MCLI_*) when running the tool.
You can also use environment variables (MONGODB_ATLAS_*) when running the tool.
To find out more, see the documentation: https://docs.mongodb.com/mongocli/stable/configure/environment-variables/.

Syntax
------

.. code-block::

atlas config [options]

Options
-------

Expand All @@ -43,10 +36,6 @@ Options
-
- false
- help for config
* - --service
- string
- false
- Type of MongoDB service. Valid values are cloud, cloudgov, cloud-manager, or ops-manager. This value defaults to "cloud".

Inherited Options
-----------------
Expand All @@ -64,30 +53,12 @@ Inherited Options
- false
- Profile to use from your configuration file.

Examples
--------

.. code-block::


To configure the tool to work with Atlas
$ mongocli config

To configure the tool to work with Atlas for Government
$ mongocli config --service cloudgov

To configure the tool to work with Cloud Manager
$ mongocli config --service cloud-manager

To configure the tool to work with Ops Manager
$ mongocli config --service ops-manager


Related Commands
----------------

* :ref:`atlas-config-delete` - Delete a profile.
* :ref:`atlas-config-describe` - Return a specific profile.
* :ref:`atlas-config-init` - Configure a profile to store access settings for your MongoDB deployment.
* :ref:`atlas-config-list` - List available profiles.
* :ref:`atlas-config-rename` - Rename a profile.
* :ref:`atlas-config-set` - Configure specific properties of a profile.
Expand All @@ -98,6 +69,7 @@ Related Commands

delete </command/atlas-config-delete>
describe </command/atlas-config-describe>
init </command/atlas-config-init>
list </command/atlas-config-list>
rename </command/atlas-config-rename>
set </command/atlas-config-set>
Expand Down
2 changes: 1 addition & 1 deletion docs/atlascli/command/atlas.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Related Commands
* :ref:`atlas-cloudProviders` - Manage unified IAM role access in Atlas.
* :ref:`atlas-clusters` - Manage clusters for your project.
* :ref:`atlas-completion` - Generate the autocompletion script for the specified shell
* :ref:`atlas-config` - Configure a profile to store access settings for your MongoDB deployment.
* :ref:`atlas-config` - Manage your profile to store access settings for your MongoDB deployment.
* :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-dataLakes` - Manage Atlas Data Lakes for your project.
Expand Down
26 changes: 12 additions & 14 deletions docs/mongocli/command/mongocli-atlas-clusters-create.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ mongocli atlas clusters create
:depth: 1
:class: singlecol

Create a MongoDB cluster for your project.
Create one cluster in the specified project.

You can create MongoDB clusters using this command.
The quickest way to get started is to specify a name for your cluster and cloud provider and region to deploy.
This will create a 3 member replica set with the latest available MongoDB server version available.
Some of the cluster configuration options are available via flags, but for full control of your deployment you can provide a config file.
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.

Syntax
------
Expand All @@ -40,7 +38,7 @@ Arguments
* - clusterName
- 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 hyphen.
- Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphens.

Options
-------
Expand Down Expand Up @@ -132,16 +130,16 @@ Examples
.. code-block::


Deploy a 3 member replica set in AWS:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 4.2 --diskSizeGB 10
Deploy a three-member replica set in AWS:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10

Deploy a 3 member replica set in AZURE:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 4.2 --diskSizeGB 10
Deploy a three-member replica set in AZURE:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10

Deploy a 3 member replica set in GCP:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 4.2 --diskSizeGB 10
Deploy a three-member replica set in GCP:
$ mongocli atlas cluster create <clusterName> --projectId <projectId> --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10

Deploy a cluster from a config file:
$ mongocli atlas cluster create --projectId <projectId> --file <path/to/cluster.json>
Deploy a cluster or a multi-cloud cluster from a JSON configuration file:
$ mongocli atlas cluster create --projectId <projectId> --file <path/to/file.json>


2 changes: 1 addition & 1 deletion docs/mongocli/command/mongocli-atlas-clusters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Related Commands
----------------

* :ref:`mongocli-atlas-clusters-connectionStrings` - Manage MongoDB cluster connection string.
* :ref:`mongocli-atlas-clusters-create` - Create a MongoDB cluster for your project.
* :ref:`mongocli-atlas-clusters-create` - Create one cluster in the specified project.
* :ref:`mongocli-atlas-clusters-delete` - Delete a cluster from your project.
* :ref:`mongocli-atlas-clusters-describe` - Describe a cluster.
* :ref:`mongocli-atlas-clusters-indexes` - Manage cluster rolling indexes for your project.
Expand Down
2 changes: 1 addition & 1 deletion docs/mongocli/command/mongocli-config-set.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ mongocli config set
Configure specific properties of a profile.

Configure specific properties of the profile.
Available properties include: [project_id org_id service public_api_key private_api_key output ops_manager_url base_url ops_manager_ca_certificate ops_manager_skip_verify mongosh_path skip_update_check].
Available properties include: [project_id org_id service public_api_key private_api_key output ops_manager_url base_url ops_manager_ca_certificate ops_manager_skip_verify mongosh_path skip_update_check access_token refresh_token].

Syntax
------
Expand Down