Skip to content

Commit 11d6e0f

Browse files
CLOUDP-112245: Add missing docs (#1011)
1 parent 405a4db commit 11d6e0f

9 files changed

+106
-66
lines changed

docs/atlascli/command/atlas-clusters-create.txt

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,10 @@ atlas clusters create
1212
:depth: 1
1313
:class: singlecol
1414

15-
Create a MongoDB cluster for your project.
15+
Create one cluster in the specified project.
1616

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

2220
Syntax
2321
------
@@ -40,7 +38,7 @@ Arguments
4038
* - clusterName
4139
- string
4240
- false
43-
- Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphen.
41+
- Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphens.
4442

4543
Options
4644
-------
@@ -132,16 +130,16 @@ Examples
132130
.. code-block::
133131

134132

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

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

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

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

147145

docs/atlascli/command/atlas-clusters.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Related Commands
5252
----------------
5353

5454
* :ref:`atlas-clusters-connectionStrings` - Manage MongoDB cluster connection string.
55-
* :ref:`atlas-clusters-create` - Create a MongoDB cluster for your project.
55+
* :ref:`atlas-clusters-create` - Create one cluster in the specified project.
5656
* :ref:`atlas-clusters-delete` - Delete a cluster from your project.
5757
* :ref:`atlas-clusters-describe` - Describe a cluster.
5858
* :ref:`atlas-clusters-indexes` - Manage cluster rolling indexes for your project.
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
.. _atlas-config-init:
2+
3+
=================
4+
atlas config init
5+
=================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Configure a profile to store access settings for your MongoDB deployment.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
22+
atlas config init [options]
23+
24+
Options
25+
-------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - --gov
36+
-
37+
- false
38+
- Create a default profile for atlas for gov
39+
* - -h, --help
40+
-
41+
- false
42+
- help for init
43+
44+
Inherited Options
45+
-----------------
46+
47+
.. list-table::
48+
:header-rows: 1
49+
:widths: 20 10 10 60
50+
51+
* - Name
52+
- Type
53+
- Required
54+
- Description
55+
* - -P, --profile
56+
- string
57+
- false
58+
- Profile to use from your configuration file.
59+
60+
Examples
61+
--------
62+
63+
.. code-block::
64+
65+
66+
To configure the tool to work with Atlas
67+
$ atlas config init
68+
69+
To configure the tool to work with Atlas for Government
70+
$ atlas config init --gov
71+
72+

docs/atlascli/command/atlas-config-set.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ atlas config set
1515
Configure specific properties of a profile.
1616

1717
Configure specific properties of the profile.
18-
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].
18+
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].
1919

2020
Syntax
2121
------

docs/atlascli/command/atlas-config.txt

Lines changed: 5 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,15 @@ atlas config
1212
:depth: 1
1313
:class: singlecol
1414

15-
Configure a profile to store access settings for your MongoDB deployment.
15+
Manage your profile to store access settings for your MongoDB deployment.
1616

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

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

24-
Syntax
25-
------
26-
27-
.. code-block::
28-
29-
atlas config [options]
30-
3124
Options
3225
-------
3326

@@ -43,10 +36,6 @@ Options
4336
-
4437
- false
4538
- help for config
46-
* - --service
47-
- string
48-
- false
49-
- Type of MongoDB service. Valid values are cloud, cloudgov, cloud-manager, or ops-manager. This value defaults to "cloud".
5039

5140
Inherited Options
5241
-----------------
@@ -64,30 +53,12 @@ Inherited Options
6453
- false
6554
- Profile to use from your configuration file.
6655

67-
Examples
68-
--------
69-
70-
.. code-block::
71-
72-
73-
To configure the tool to work with Atlas
74-
$ mongocli config
75-
76-
To configure the tool to work with Atlas for Government
77-
$ mongocli config --service cloudgov
78-
79-
To configure the tool to work with Cloud Manager
80-
$ mongocli config --service cloud-manager
81-
82-
To configure the tool to work with Ops Manager
83-
$ mongocli config --service ops-manager
84-
85-
8656
Related Commands
8757
----------------
8858

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

9970
delete </command/atlas-config-delete>
10071
describe </command/atlas-config-describe>
72+
init </command/atlas-config-init>
10173
list </command/atlas-config-list>
10274
rename </command/atlas-config-rename>
10375
set </command/atlas-config-set>

docs/atlascli/command/atlas.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Related Commands
5656
* :ref:`atlas-cloudProviders` - Manage unified IAM role access in Atlas.
5757
* :ref:`atlas-clusters` - Manage clusters for your project.
5858
* :ref:`atlas-completion` - Generate the autocompletion script for the specified shell
59-
* :ref:`atlas-config` - Configure a profile to store access settings for your MongoDB deployment.
59+
* :ref:`atlas-config` - Manage your profile to store access settings for your MongoDB deployment.
6060
* :ref:`atlas-customDbRoles` - Manage custom database roles for your project.
6161
* :ref:`atlas-customDns` - Manage DNS configuration of Atlas project’s clusters deployed to AWS.
6262
* :ref:`atlas-dataLakes` - Manage Atlas Data Lakes for your project.

docs/mongocli/command/mongocli-atlas-clusters-create.txt

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,10 @@ mongocli atlas clusters create
1212
:depth: 1
1313
:class: singlecol
1414

15-
Create a MongoDB cluster for your project.
15+
Create one cluster in the specified project.
1616

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

2220
Syntax
2321
------
@@ -40,7 +38,7 @@ Arguments
4038
* - clusterName
4139
- string
4240
- false
43-
- Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphen.
41+
- Name of the cluster. The cluster name cannot be changed after the cluster is created. Cluster name can contain ASCII letters, numbers, and hyphens.
4442

4543
Options
4644
-------
@@ -132,16 +130,16 @@ Examples
132130
.. code-block::
133131

134132

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

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

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

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

147145

docs/mongocli/command/mongocli-atlas-clusters.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Related Commands
5252
----------------
5353

5454
* :ref:`mongocli-atlas-clusters-connectionStrings` - Manage MongoDB cluster connection string.
55-
* :ref:`mongocli-atlas-clusters-create` - Create a MongoDB cluster for your project.
55+
* :ref:`mongocli-atlas-clusters-create` - Create one cluster in the specified project.
5656
* :ref:`mongocli-atlas-clusters-delete` - Delete a cluster from your project.
5757
* :ref:`mongocli-atlas-clusters-describe` - Describe a cluster.
5858
* :ref:`mongocli-atlas-clusters-indexes` - Manage cluster rolling indexes for your project.

docs/mongocli/command/mongocli-config-set.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ mongocli config set
1515
Configure specific properties of a profile.
1616

1717
Configure specific properties of the profile.
18-
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].
18+
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].
1919

2020
Syntax
2121
------

0 commit comments

Comments
 (0)