@@ -10,23 +10,25 @@ Online Archive Configuration File
10
10
:depth: 1
11
11
:class: singlecol
12
12
13
- You can use an Online Archive configuration file to specify the required
14
- settings for creating and updating an Online Archive. This archive stores
15
- data from one cluster within one project. To use this resource, the
16
- requesting API Key must have the Project Data Access Admin role .
13
+ You can use a configuration file to specify the required
14
+ settings for creating and updating an online archive using the
15
+ {+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` online archive
16
+ configuration files .
17
17
18
18
Use the following resources to:
19
19
20
- - Learn the required settings you can specify in the Online Archive
21
- configuration file.
20
+ - Learn the :ref:` required settings <required-oa-settings>` you
21
+ can specify in the online archive
22
22
23
23
- View and copy sample configuration files.
24
24
25
+ .. _required-oa-settings:
26
+
25
27
Required Online Archive Create and Update Settings
26
28
--------------------------------------------------
27
29
28
- |service| requires the following settings to create an Online Archive with
29
- the {+atlas-cli+}. You must specify these Online Archive settings either
30
+ |service| requires the following settings to create an online archive with
31
+ the {+atlas-cli+}. You must specify these online archive settings either
30
32
in the configuration file or as flags in the command:
31
33
32
34
.. list-table::
@@ -39,21 +41,20 @@ in the configuration file or as flags in the command:
39
41
40
42
* - ``groupId``
41
43
- string
42
- - Unique identifier for your project. Your group id is the same
43
- as your project id . For existing groups, your group/project id
44
+ - Unique identifier for your project. Your ``groupId`` is the same
45
+ as your ``projectId`` . For existing groups, your group/project id
44
46
remains the same. The resource and corresponding
45
47
endpoints use the term groups.
46
48
47
49
* - ``archiveID``
48
50
- string
49
51
- Unique 24-hexadecimal digit string that identifies
50
- the online archive to update. This param is required for updating an
51
- existing Online Archive.
52
+ the online archive to update.
52
53
53
54
* - ``clusterName``
54
55
- string
55
56
- Human-readable label that identifies the cluster that contains
56
- the collection for which you want to create one online archive.
57
+ the collection for which you want to create or update one online archive.
57
58
58
59
* - ``collName``
59
60
- string
@@ -73,19 +74,27 @@ For a full list of available settings, see the API documentation for
73
74
74
75
Example Online Archive Create Command
75
76
-------------------------------------
76
- After you create the file, run the command to create the Online Archive.
77
+ To create an online archive configuration, specify the ``--file`` option
78
+ and the path to the file. The following example creates an
79
+ online archive by using a configuration file named
80
+ ``online-archive-create-config.json``:
77
81
78
82
.. code-block::
79
83
80
- atlas clusters onlineArchive create --file online-archive-create.json --output json
84
+ atlas clusters onlineArchive create --file online-archive-create-config .json --output json
81
85
82
86
Example Online Archive Update Command
83
87
-------------------------------------
84
- After you create the file, run the command to update the Online Archive.
88
+ To update an online archive configuration, specify the ``--file`` option
89
+ and the path to the file. The following example updates an
90
+ online archive by using a configuration file named
91
+ ``online-archive-update-config.json``:
85
92
86
93
.. code-block::
87
94
88
- atlas clusters onlineArchive update --file online-archive-update.json --output json
95
+ atlas clusters onlineArchive update --file online-archive-update-config.json --output json
96
+
97
+ .. _example-oa-config-file:
89
98
90
99
Example Online Archive Create Configuration File
91
100
------------------------------------------------
0 commit comments