You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/opensearch/pages/usage-guide/configuration-environment-overrides.adoc
+23-3Lines changed: 23 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ The cluster definition also supports overriding configuration properties, enviro
4
4
either per role or per role group, where the more specific override (role group) has precedence over
5
5
the less specific one (role).
6
6
7
-
IMPORTANT: Overriding certain properties which are set by the operator (such as the `network.host`) can interfere with the operator and can lead to problems.
7
+
CAUTION: Overriding certain properties which are set by the operator (such as the `network.host`) can interfere with the operator and can lead to problems.
8
8
9
9
== Configuration Properties
10
10
@@ -36,7 +36,7 @@ nodes:
36
36
----
37
37
38
38
Property values must be strings when defined as key-value pairs.
39
-
To override properties using other types or nested structures, use a JSON merge patch by placing the properties under `jsonMergePatch`:
39
+
To override properties using other types or nested structures, use a JSON Merge Patch by placing the properties under `jsonMergePatch`:
40
40
41
41
[source,yaml]
42
42
----
@@ -50,6 +50,26 @@ nodes:
50
50
- CN=opensearch-admin-certificate
51
51
----
52
52
53
+
NOTE: A JSON Merge Patch is the recommended method for overriding configuration settings.
54
+
55
+
Use a JSON Patch when you need finer-grained control, e.g. to remove a setting.
56
+
Define a JSON Patch using the `jsonPatch` property, which accepts a list of operations:
NOTE: Replacing the entire configuration file is not recommended, as all properties normally managed by the operator must be explicitly provided to obtain a working OpenSearch cluster.
84
+
WARNING: Replacing the entire configuration file is not recommended, as all properties normally managed by the operator must be explicitly provided to obtain a working OpenSearch cluster.
65
85
66
86
For a list of configuration options, we refer to the
67
87
https://docs.opensearch.org/docs/latest/install-and-configure/configuring-opensearch/index/[Configuring OpenSearch{external-link-icon}^] section in the OpenSearch documentation.
0 commit comments