Skip to content

Commit fdfdfb0

Browse files
adding defaults to the configuration systems docs (#10730)
* adding defaults to the configuration systems docs Signed-off-by: Anton Rubin <[email protected]> * Update configuration-system.md Signed-off-by: AntonEliatra <[email protected]> * Apply suggestions from code review Signed-off-by: Nathan Bower <[email protected]> --------- Signed-off-by: Anton Rubin <[email protected]> Signed-off-by: AntonEliatra <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit dcfdc0f) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent ad677bd commit fdfdfb0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

_install-and-configure/configuring-opensearch/configuration-system.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ For an overview of creating an OpenSearch cluster and examples of configuration
1111

1212
OpenSearch supports the following system settings:
1313

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

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

18-
- `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`.
18+
- `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`.
1919

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

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

24-
- `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.
24+
- `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`.

0 commit comments

Comments
 (0)