Skip to content

adding defaults to the configuration systems docs #10730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 2, 2025
+6 −6
Merged

adding defaults to the configuration systems docs #10730

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5be85ea
adding defaults to the configuration systems docs
AntonEliatra Aug 13, 2025
948f172
Update configuration-system.md
AntonEliatra Aug 18, 2025
5915d86
Apply suggestions from code review
natebower Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions _install-and-configure/configuring-opensearch/configuration-system.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ For an overview of creating an OpenSearch cluster and examples of configuration

OpenSearch supports the following system settings:

- `cluster.name` (Static, string): The cluster name.
- `cluster.name` (Static, string): The cluster name. Default is `opensearch`.

- `node.name` (Static, string): A descriptive name for the node.
- `node.name` (Static, string): A descriptive name for the node. Required.

- `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`.
- `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`. Default is `cluster_manager,data,ingest,remote_cluster_client`.

- `path.data` (Static, string): A path to the directory where your data is stored. Separate multiple locations with commas.
- `path.data` (Static, string): A path to the directory where your data is stored. Separate multiple locations with commas. Default is `$OPENSEARCH_HOME/data`.

- `path.logs` (Static, string): A path to log files.
- `path.logs` (Static, string): A path to log files. Default is `$OPENSEARCH_HOME/logs`.

- `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.
- `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 be allowed to use this limit. OpenSearch doesn't perform well when the system is swapping the memory. Default is `false`.
Loading