Skip to content

Commit 39a1ebb

Browse files
kyuan-mongodbkyuan-mongodb
authored
Merge pull request mongodb#123 from kyuan-mongodb/DOCSP-28323
2 parents 2579303 + 1c8824a commit 39a1ebb

File tree

6 files changed

+282
-1
lines changed

6 files changed

+282
-1
lines changed

‎config/redirects

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ define: base https://www.mongodb.com/docs/atlas/cli
22
define: versions v1.0 master
33

44
raw: docs/atlas/cli/ -> ${base}/stable/
5+
raw: docs/atlas/cli/stable/cluster-config-file -> ${base}/stable/reference/json/cluster-config-file

‎source/includes/update-cloud-backup-schedule-config-file.json

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"autoExportEnabled": true,
3+
"copySettings": [
4+
{
5+
"cloudProvider": "AWS",
6+
"frequencies": [
7+
"HOURLY"
8+
],
9+
"regionName": "US_EAST_1",
10+
"replicationSpecId": "24a7bf81d1ea39035acf7b8e3",
11+
"shouldCopyOplogs": true
12+
}
13+
],
14+
"deleteCopiedBackups": [
15+
{
16+
"cloudProvider": "GCP",
17+
"regionName": "CENTRAL_US",
18+
"replicationSpecId": "49c1b72a1ad50263cfa2a3d8"
19+
}
20+
],
21+
"export": {
22+
"exportBucketId": "62c569f85b7a381c093cc539",
23+
"frequencyType": "monthly"
24+
},
25+
"policies": [
26+
{
27+
"id": "62da8faac84a2721e448d767",
28+
"policyItems": [
29+
{
30+
"frequencyInterval": 6,
31+
"frequencyType": "hourly",
32+
"retentionUnit": "days",
33+
"retentionValue": 7
34+
}
35+
]
36+
}
37+
],
38+
"referenceHourOfDay": 0,
39+
"referenceMinuteOfHour": 0,
40+
"restoreWindowDays": 0,
41+
"updateSnapshots": true,
42+
"useOrgAndGroupNamesInExportPrefix": true
43+
}

‎source/reference.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Reference
66
.. toctree::
77
:titlesonly:
88

9-
/cluster-config-file
9+
/reference/json

‎source/reference/json.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
======
3+
|json|
4+
======
5+
6+
.. toctree::
7+
:titlesonly:
8+
9+
/reference/json/cluster-config-file
10+
/reference/json/cloud-backup-schedule-config-file

‎source/reference/json/cloud-backup-schedule-config-file.txt

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
.. _atlas-cli-cloud-backup-schedule-config-file:
2+
3+
========================================
4+
Cloud Backup Schedule Configuration File
5+
========================================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can use a cloud backup schedule configuration file to specify the
14+
settings required when you `update a cloud backup schedule
15+
<https://www.mongodb.com/docs/atlas/cli/stable/command/atlas-backups-schedule-update/>`__
16+
using the {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` cloud
17+
backup schedule configuration files.
18+
19+
.. _cloud-backup-schedule-settings:
20+
21+
Cloud Backup Schedule Settings
22+
------------------------------
23+
24+
You can specify the following settings to update a cloud
25+
backup schedule either in the configuration file or as flags in the
26+
command:
27+
28+
.. list-table::
29+
:header-rows: 1
30+
:widths: 20 10 70
31+
32+
* - Field
33+
- Type
34+
- Description
35+
36+
* - ``autoExportEnabled``
37+
- boolean
38+
- Flag that indicates whether |service| automatically exports
39+
cloud backup snapshots to the |aws| bucket.
40+
41+
* - ``copySettings``
42+
- array
43+
- List that contains a document for each copy setting item in the
44+
desired backup policy.
45+
46+
* - | ``copySettings.``
47+
| ``cloudProvider``
48+
- string
49+
- Human-readable label that identifies the cloud provider that
50+
stores the snapshot copy.
51+
52+
* - | ``copySettings.``
53+
| ``frequencies``
54+
- array of strings
55+
- List that describes which types of snapshots to copy.
56+
57+
* - | ``copySettings.``
58+
| ``regionName``
59+
- string
60+
- Target Atlas region to copy snapshots belonging to ``replicationSpecId``
61+
to. Please supply the **Atlas Region** that corresponds to your
62+
:ref:`AWS <amazon-aws>`, :ref:`GCP <google-gcp>` or :ref:`Azure
63+
<microsoft-azure>` region.
64+
65+
* - | ``copySettings.``
66+
| ``replicationSpecId``
67+
- string
68+
- Unique 24-hexadecimal digit string that identifies the
69+
replication object for a zone in a cluster. For global clusters,
70+
there can be multiple zones to choose from. For sharded clusters
71+
and replica set clusters, there is only one zone in the cluster.
72+
To find ``thereplicationSpecId``, do a GET request to
73+
:oas-atlas-op:`Return One Cluster in One Project
74+
</getLegacyCluster>` and consult its ``replicationSpecs`` array.
75+
76+
* - | ``copySettings.``
77+
| ``shouldCopyOplogs``
78+
- boolean
79+
- Flag that indicates whether to copy the oplogs to the target
80+
region. You can use the oplogs to perform point-in-time restores.
81+
82+
* - ``deleteCopiedBackups``
83+
- array
84+
- List that contains a document for each copy setting item in the
85+
desired backup policy.
86+
87+
* - | ``deleteCopiedBackups.``
88+
| ``cloudProvider``
89+
- string
90+
- Human-readable label that identifies the cloud provider for the
91+
deleted copy setting whose backup copies you want to delete.
92+
93+
* - | ``deleteCopiedBackups.``
94+
| ``regionName``
95+
- string
96+
- Target Atlas region to copy snapshots belonging to ``replicationSpecId``
97+
to. Please supply the **Atlas Region** that corresponds to your
98+
:ref:`AWS <amazon-aws>`, :ref:`GCP <google-gcp>` or :ref:`Azure
99+
<microsoft-azure>` region.
100+
101+
* - | ``deleteCopiedBackups.``
102+
| ``replicationSpecId``
103+
- string
104+
- Unique 24-hexadecimal digit string that identifies the
105+
replication object for a zone in a cluster. For global clusters,
106+
there can be multiple zones to choose from. For sharded clusters
107+
and replica setclusters, there is only one zone in the cluster.
108+
To find ``thereplicationSpecId``, do a GET request to
109+
:oas-atlas-op:`Return One Cluster in One Project
110+
</getLegacyCluster>` and consult its ``replicationSpecs`` array.
111+
112+
* - ``export``
113+
- object
114+
- List that contains a document for each copy setting item in the
115+
desired backup policy.
116+
117+
* - | ``export.``
118+
| ``exportBucketId``
119+
- string
120+
- Unique 24-hexadecimal character string that identifies the |aws|
121+
Bucket.
122+
123+
* - | ``export.``
124+
| ``frequencyType``
125+
- string
126+
- Human-readable label that indicates the rate at which the export
127+
policy item occurs.
128+
129+
* - ``policies``
130+
- array
131+
- Rules set for this backup schedule.
132+
133+
* - | ``policies.``
134+
| ``id``
135+
- string
136+
- Unique 24-hexadecimal digit string that identifies this backup
137+
policy.
138+
139+
* - | ``policies.``
140+
| ``policyItems``
141+
- array
142+
- List that contains the specifications for one policy.
143+
144+
* - | ``policies.``
145+
| ``policyItems.``
146+
| ``frequencyInterval``
147+
- integer
148+
- Number that indicates the frequency interval for a set of
149+
snapshots. A value of ``1`` specifies the first instance of the
150+
corresponding ``frequencyType``.
151+
152+
- In a monthly policy item, ``1`` indicates that the monthly
153+
snapshot occurs on the first day of the month and ``40``
154+
indicates the last day of the month.
155+
156+
- In a weekly policy item, ``1`` indicates that the weekly
157+
snapshot occurs on Monday and ``7`` indicates Sunday.
158+
159+
- In an hourly policy item, you can set the frequency interval to
160+
``1``, ``2``, ``4``, ``6``, ``8``, or ``12``. For hourly policy
161+
items for NVMe clusters, |service| only accepts ``12`` as
162+
the frequency interval value.
163+
164+
* - | ``policies.``
165+
| ``policyItems.``
166+
| ``frequencyType``
167+
- string
168+
- Human-readable label that identifies the frequency type
169+
associated with the backup policy.
170+
171+
* - | ``policies.``
172+
| ``policyItems.``
173+
| ``retentionUnit``
174+
- string
175+
- Unit of time in which |service| measures snapshot retention.
176+
177+
* - | ``policies.``
178+
| ``policyItems.``
179+
| ``retentionValue``
180+
- integer
181+
- Duration in days, weeks, or months that |service| retains the
182+
snapshot. For less frequent policy items, |service| requires
183+
that you specify a value greater than or equal to the value
184+
specified for more frequent policy items.
185+
186+
For example: If the hourly policy item specifies a retention of two
187+
days, you must specify two days or greater for the retention of the
188+
weekly policy item.
189+
190+
* - ``referenceHourOfDay``
191+
- integer
192+
- Hour of day in Coordinated Universal Time (UTC) that represents
193+
when |service| takes the snapshot.
194+
195+
* - ``referenceMinuteOfHour``
196+
- integer
197+
- Minute of the ``referenceHourOfDay`` that represents when
198+
|service| takes the snapshot.
199+
200+
* - ``restoreWindowDays``
201+
- integer
202+
- Number of previous days that you can restore back to with
203+
continuous cloud backup accuracy. You must specify a positive,
204+
non-zero integer. This parameter applies to continuous cloud
205+
backups only.
206+
207+
* - ``updateSnapshots``
208+
- boolean
209+
- Flag that indicates whether to apply the retention changes in the
210+
updated backup policy to snapshots that |service| took
211+
previously.
212+
213+
* - ``useOrgAndGroupNamesInExportPrefix``
214+
- boolean
215+
- Flag that indicates whether to use organization and project names
216+
instead of organization and project UUIDs in the path to the
217+
metadata files that |service| uploads to your |aws| bucket.
218+
219+
.. _example-cloud-backup-schedule-config-file:
220+
221+
Example Cloud Backup Schedule Configuration File
222+
------------------------------------------------
223+
224+
To update a cloud backup schedule for a single cluster, specify the
225+
fields you want to update as shown in the following example file:
226+
227+
.. literalinclude:: /includes/update-cloud-backup-schedule-config-file.json

‎source/cluster-config-file.txt renamed to ‎source/reference/json/cluster-config-file.txt

File renamed without changes.

0 commit comments

Comments
 (0)