Skip to content

Commit f92ec9f

Browse files
Project import generated by Copybara. (#807)
GitOrigin-RevId: 97d3e3b7915c514e88be69ce1f1852ef2c503ccf Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com>
1 parent 3ea42e2 commit f92ec9f

23 files changed

+48
-1555
lines changed

source/command/atlas-backups-restores-start.txt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Start a restore job for your project and cluster.
1717
If you create an automated or pointInTime restore job, Atlas removes all existing data on the target cluster prior to the restore.
1818

1919
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
20-
Atlas supports this command only for M10+ clusters.
20+
Atlas supports this command only for Flex and M10+ clusters.
21+
Flex clusters support only automated restore jobs.
2122

2223
Syntax
2324
------
@@ -137,6 +138,17 @@ Examples
137138
--targetProjectId 1a2345b67c8e9a12f3456de7
138139

139140

141+
.. code-block::
142+
:copyable: false
143+
144+
# Create an automated restore for a Flex Cluster:
145+
atlas backup restore start automated \
146+
--clusterName myFlexSource \
147+
--snapshotId 5e7e00128f8ce03996a47179 \
148+
--targetClusterName myFlexCluster \
149+
--targetProjectId 1a2345b67c8e9a12f3456de7
150+
151+
140152
.. code-block::
141153
:copyable: false
142154

source/command/atlas-serverless-watch.txt renamed to source/command/atlas-backups-snapshots-download.txt

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _atlas-serverless-watch:
1+
.. _atlas-backups-snapshots-download:
22

3-
======================
4-
atlas serverless watch
5-
======================
3+
================================
4+
atlas backups snapshots download
5+
================================
66

77
.. default-domain:: mongodb
88

@@ -12,22 +12,19 @@ atlas serverless watch
1212
:depth: 1
1313
:class: singlecol
1414

15-
Monitor the status of serverless instance.
16-
17-
This command checks the serverless instance's state periodically until the instance reaches an IDLE state.
18-
Once the instance reaches the expected state, the command prints "Instance available."
19-
If you run the command in the terminal, it blocks the terminal session until the resource becomes idle.
20-
You can interrupt the command's polling at any time with CTRL-C.
15+
Download one snapshot for the specified flex cluster.
2116

17+
You can download a snapshot for an Atlas Flex cluster.
2218
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
19+
Atlas supports this command only for Flex clusters.
2320

2421
Syntax
2522
------
2623

2724
.. code-block::
2825
:caption: Command Syntax
2926

30-
atlas serverless watch <instanceName> [options]
27+
atlas backups snapshots download <snapshotId> [options]
3128

3229
.. Code end marker, please don't delete this comment
3330

@@ -42,10 +39,10 @@ Arguments
4239
- Type
4340
- Required
4441
- Description
45-
* - instanceName
42+
* - snapshotId
4643
- string
4744
- true
48-
- Name of the instance to watch.
45+
- Unique 24-hexadecimal digit string that identifies the snapshot to download.
4946

5047
Options
5148
-------
@@ -58,10 +55,18 @@ Options
5855
- Type
5956
- Required
6057
- Description
58+
* - --clusterName
59+
- string
60+
- true
61+
- Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api.
6162
* - -h, --help
6263
-
6364
- false
64-
- help for watch
65+
- help for download
66+
* - --out
67+
- string
68+
- false
69+
- Output file name. This value defaults to the Snapshot ID.
6570
* - --projectId
6671
- string
6772
- false
@@ -90,14 +95,6 @@ If the command succeeds, the CLI returns output similar to the following sample.
9095

9196
.. code-block::
9297

98+
Snapshot '<Name>' downloaded.
9399

94-
Instance available.
95-
96-
97-
Examples
98-
--------
99-
100-
.. code-block::
101-
:copyable: false
102100

103-
atlas serverless watch instanceNameSample

source/command/atlas-backups-snapshots.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Related Commands
5252
* :ref:`atlas-backups-snapshots-create` - Create a backup snapshot for your project and cluster.
5353
* :ref:`atlas-backups-snapshots-delete` - Remove the specified backup snapshot.
5454
* :ref:`atlas-backups-snapshots-describe` - Return the details for the specified snapshot for your project.
55+
* :ref:`atlas-backups-snapshots-download` - Download one snapshot for the specified flex cluster.
5556
* :ref:`atlas-backups-snapshots-list` - Return all cloud backup snapshots for your project and cluster.
5657
* :ref:`atlas-backups-snapshots-watch` - Watch the specified snapshot in your project until it becomes available.
5758

@@ -62,6 +63,7 @@ Related Commands
6263
create </command/atlas-backups-snapshots-create>
6364
delete </command/atlas-backups-snapshots-delete>
6465
describe </command/atlas-backups-snapshots-describe>
66+
download </command/atlas-backups-snapshots-download>
6567
list </command/atlas-backups-snapshots-list>
6668
watch </command/atlas-backups-snapshots-watch>
6769

source/command/atlas-clusters-create.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Options
135135
- false
136136
- Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas.
137137

138-
Mutually exclusive with --file. This value defaults to "M2".
138+
Mutually exclusive with --file. This value defaults to "FLEX".
139139
* - --type
140140
- string
141141
- false
@@ -187,6 +187,13 @@ Examples
187187
atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0
188188

189189

190+
.. code-block::
191+
:copyable: false
192+
193+
# Deploy a Flex cluster named myFlexCluster for the project with the ID 5e2211c17a3e5a48f5497de3 and tag "env=dev":
194+
atlas cluster create myFlexCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier FLEX --tag env=dev
195+
196+
190197
.. code-block::
191198
:copyable: false
192199

source/command/atlas-clusters-list.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ Options
6161
- string
6262
- false
6363
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
64+
* - --tier
65+
- string
66+
- false
67+
- Tier for each data-bearing server in the cluster. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas.
6468

6569
Inherited Options
6670
-----------------

source/command/atlas-kubernetes-config-generate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Options
6060
* - --operatorVersion
6161
- string
6262
- false
63-
- Version of Atlas Kubernetes Operator to generate resources for. This value defaults to "2.5.0".
63+
- Version of Atlas Kubernetes Operator to generate resources for. This value defaults to "2.6.0".
6464
* - --orgId
6565
- string
6666
- false

source/command/atlas-serverless-backups-restores-create.txt

Lines changed: 0 additions & 138 deletions
This file was deleted.

source/command/atlas-serverless-backups-restores-describe.txt

Lines changed: 0 additions & 84 deletions
This file was deleted.

0 commit comments

Comments
 (0)