You're viewing version 2.17 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Configuration and system settings

For an overview of creating an OpenSearch cluster and examples of configuration settings, see Creating a cluster. To learn more about static and dynamic settings, see Configuring OpenSearch.

OpenSearch supports the following system settings:

• cluster.name (Static, string): The cluster name.

• node.name (Static, string): A descriptive name for the node.

• node.roles (Static, list): Defines one or more roles for an OpenSearch node. Valid values are cluster_manager, data, ingest, search, ml, remote_cluster_client, and coordinating_only.

• path.data (Static, string): A path to the directory where your data is stored. Separate multiple locations with commas.

• path.logs (Static, string): A path to log files.

• bootstrap.memory_lock (Static, Boolean): Locks the memory at startup. We recommend setting the heap size to about half the memory available on the system and that the owner of the process is allowed to use this limit. OpenSearch doesn’t perform well when the system is swapping the memory.