Search Nodes Configuration File

On this page

Search Nodes Settings

Example Search Nodes Configuration File
Example Search Nodes Configuration Commands

To create or update search nodes for a cluster by using the Atlas CLI, you can use a .json configuration file to specify the required search nodes settings.

Search Nodes Settings

You can specify the following settings in the search nodes configuration file. For a full list of settings and descriptions, see the API specification.

Field	Type	Description
`specs`	Array of objects	Settings to configure search nodes for your cluster.
`specs.instanceSize`	string	Hardware specification for the search node instance sizes. This setting uses the following format: `<instance-size>_HIGHCPU_NVME` `<instance-size>_LOWCPU_NVME` For example, `S20_HIGHCPU_NVME`. To learn more, see Search Nodes Costs.
`specs.nodeCount`	integer	Number of search nodes in the cluster.

Example Search Nodes Configuration File

To create or update search nodes on your cluster, define the search nodes settings in your JSON file as shown in the following example file:

{
  "specs": [
    {
      "instanceSize": "S30_LOWCPU_NVME",
      "nodeCount": 2
    }
  ]
}

Example Search Nodes Configuration Commands

After you create the file, run the Atlas CLI command to create or update search nodes and specify the clusterName and file options.

Create Search Nodes

The following example creates search nodes for the cluster named myCluster using a JSON configuration file named search-nodes-config.json:

atlas clusters search nodes create --clusterName myCluster --file search-nodes-config.json

Update Search Nodes

The following example updates search nodes for the cluster named myCluster using a JSON configuration file named search-nodes-config.json:

atlas clusters search nodes update --clusterName myCluster --file search-nodes-config.json

Back

Atlas Search Index

Online Archive