Skip to content

Commit 2ca0df4

Browse files
davidhou17davidhou17
authored
(DOCSP-36734): Add JSON configuration page for Atlas Search Nodes (#274)
* Add search nodes JSON spec * copy review feedback * fix file names
1 parent 0850dc4 commit 2ca0df4

File tree

5 files changed

+123
-4
lines changed

5 files changed

+123
-4
lines changed

‎source/includes/create-search-node-config-file.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
{
3+
"specs": [
4+
{
5+
"instanceSize": "S30_LOWCPU_NVME",
6+
"nodeCount": 2
7+
}
8+
]
9+
}

‎source/reference/json.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ you can pass a configuration file when using the {+atlas-cli+} to:
1919
- :ref:`Update a cloud backup schedule <atlas-backups-schedule-update>`.
2020
- :ref:`Create <atlas-clusters-search-indexes-create>` or
2121
:ref:`update an Atlas Search Index <atlas-clusters-search-indexes-update>`.
22+
- :ref:`Create <atlas-clusters-search-nodes-create>` or
23+
:ref:`update search nodes <atlas-clusters-search-nodes-update>`.
2224
- :ref:`Create a {+df+} database <atlas-dataFederation-create>`.
2325
- :ref:`Create <atlas-alerts-settings-create>` or
2426
:ref:`update an alert configuration <atlas-alerts-settings-update>`.
@@ -56,6 +58,12 @@ command. The commands you can use include but are not limited to:
5658
* - :ref:`atlas-clusters-search-indexes-update`
5759
- :oas-atlas-op:`Update One Atlas Search Index </updateAtlasSearchIndex>`
5860

61+
* - :ref:`atlas-clusters-search-nodes-create`
62+
- :oas-atlas-op:`Create Search Nodes </createAtlasSearchDeployment>`
63+
64+
* - :ref:`atlas-clusters-search-nodes-update`
65+
- :oas-atlas-op:`Update Search Nodes </updateAtlasSearchDeployment>`
66+
5967
* - :ref:`atlas-dataFederation-create`
6068
- :oas-atlas-op:`Create One Federated Database Instance in One Project </createFederatedDatabase>`
6169

@@ -93,7 +101,7 @@ based on the settings specified in the configuration file:
93101

94102
.. code-block:: sh
95103

96-
atlas clusters update myCluster --file /example.json
104+
atlas clusters update myCluster --file example.json
97105

98106
{+Cluster+} Configuration File
99107
------------------------------
@@ -121,6 +129,13 @@ To learn more about |fts| index configuration files, see
121129
:ref:`atlas-cli-search-index-config-file`. For a sample file,
122130
see :ref:`example-search-index-config-file`.
123131

132+
Search Nodes Configuration File
133+
-------------------------------
134+
135+
To learn more about search nodes configuration files, see
136+
:ref:`atlas-cli-search-nodes-config-file`. For a sample file,
137+
see :ref:`example-search-nodes-config-file`.
138+
124139
{+adf+} Configuration File
125140
----------------------------------------
126141

@@ -142,5 +157,6 @@ see :ref:`example-alert-config-file`.
142157
Cloud Backup Schedule </reference/json/cloud-backup-schedule-config-file>
143158
Atlas Data Federation </reference/json/data-federation-config-file>
144159
Atlas Search Index </reference/json/search-index-config-file>
160+
Search Nodes </reference/json/search-nodes-config-file>
145161
Online Archive </reference/json/file-options-online-archive>
146162
Alert </reference/json/alert-config-file>

‎source/reference/json/search-index-config-file.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Example Atlas Search Index Create Command
105105

106106
.. code-block::
107107

108-
atlas clusters search indexes create --clusterName myCluster --file /search-config.json --output json
108+
atlas clusters search indexes create --clusterName myCluster --file search-config.json --output json
109109

110110
.. tab:: Local Deployment
111111
:tabid: local
@@ -118,4 +118,4 @@ Example Atlas Search Index Create Command
118118

119119
.. code-block::
120120

121-
atlas deployments search indexes create --deploymentName myLocalRs --file /search-config.json --output json
121+
atlas deployments search indexes create --deploymentName myLocalRs --file search-config.json --output json

‎source/reference/json/search-nodes-config-file.txt

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
.. _atlas-cli-search-nodes-config-file:
2+
3+
===============================
4+
Search Nodes Configuration File
5+
===============================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
To create or update :atlas:`search nodes
14+
</cluster-config/multi-cloud-distribution/#std-label-configure-search-nodes>`
15+
for a {+cluster+} by using the {+atlas-cli+}, you can use a ``.json``
16+
configuration file to specify the required search nodes settings.
17+
18+
.. _search-nodes-settings:
19+
20+
Search Nodes Settings
21+
---------------------
22+
23+
You can specify the following settings in the search nodes
24+
configuration file. For a full list of settings and
25+
descriptions, see the :oas-atlas-op:`API specification
26+
</createAtlasSearchDeployment>`.
27+
28+
.. list-table::
29+
:header-rows: 1
30+
:widths: 20 10 70
31+
32+
* - Field
33+
- Type
34+
- Description
35+
36+
* - ``specs``
37+
- Array of objects
38+
- Settings to configure search nodes for your {+cluster+}.
39+
40+
* - ``specs.instanceSize``
41+
- string
42+
- Hardware specification for the search node instance sizes.
43+
This setting uses the following format:
44+
45+
- ``<instance-size>_HIGHCPU_NVME``
46+
- ``<instance-size>_LOWCPU_NVME``
47+
48+
For example, ``S20_HIGHCPU_NVME``.
49+
To learn more, see :atlas:`Search Nodes Costs
50+
</billing/search-node>`.
51+
52+
* - ``specs.nodeCount``
53+
- integer
54+
- Number of search nodes in the {+cluster+}.
55+
56+
.. _example-search-nodes-config-file:
57+
58+
Example Search Nodes Configuration File
59+
---------------------------------------
60+
61+
To create or update search nodes on your {+cluster+},
62+
define the search nodes settings in your |json| file
63+
as shown in the following example file:
64+
65+
.. literalinclude:: /includes/create-search-node-config-file.json
66+
67+
Example Search Nodes Configuration Commands
68+
-------------------------------------------
69+
70+
After you create the file, run the {+atlas-cli+} command
71+
to create or update search nodes and specify
72+
the ``clusterName`` and ``file`` options.
73+
74+
Create Search Nodes
75+
~~~~~~~~~~~~~~~~~~~
76+
77+
The following example creates search nodes for the {+cluster+} named
78+
``myCluster`` using a JSON configuration file named
79+
``search-nodes-config.json``:
80+
81+
.. code-block::
82+
83+
atlas clusters search nodes create --clusterName myCluster --file search-nodes-config.json
84+
85+
Update Search Nodes
86+
~~~~~~~~~~~~~~~~~~~
87+
88+
The following example updates search nodes for the {+cluster+} named
89+
``myCluster`` using a JSON configuration file named
90+
``search-nodes-config.json``:
91+
92+
.. code-block::
93+
94+
atlas clusters search nodes update --clusterName myCluster --file search-nodes-config.json

‎submodules/mongodb-atlas-cli

Submodule mongodb-atlas-cli updated 2737 files

0 commit comments

Comments
 (0)