Skip to content

Commit a8de9e5

Browse files
doc: Document the environment variables OPENSEARCH_HOME and OPENSEARCH_PATH_CONF
1 parent beba6c2 commit a8de9e5

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

docs/modules/opensearch/pages/usage-guide/configuration-environment-overrides.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ nodes:
131131
default:
132132
config: {}
133133
envOverrides:
134-
OPENSEARCH_PATH_CONF: /etc/opensearch
134+
OPENSEARCH_HOME: /usr/share/opensearch
135135
----
136136

137137
or per role:
@@ -140,12 +140,21 @@ or per role:
140140
----
141141
nodes:
142142
envOverrides:
143-
OPENSEARCH_PATH_CONF: /etc/opensearch
143+
OPENSEARCH_HOME: /usr/share/opensearch
144144
roleGroups:
145145
default:
146146
config: {}
147147
----
148148

149+
The environment variables `OPENSEARCH_HOME` and `OPENSEARCH_PATH_CONF` are worth mentioning.
150+
`OPENSEARCH_HOME` contains the path in the image where OpenSearch is installed.
151+
`OPENSEARCH_PATH_CONF` contains the path with the OpenSearch configuration files.
152+
They are usually set in the image.
153+
In the Stackable image, `OPENSEARCH_HOME` is set to `/stackable/opensearch` and `OPENSEARCH_PATH_CONF` to `$\{OPENSEARCH_HOME}/config`.
154+
The operator must also know the values of these environment variables to mount volumes to the correct paths.
155+
Since the operator cannot read the values from the image, it assumes the ones from the Stackable image.
156+
If you use a custom image with different paths, you can override one or both of these environment variables as shown in the example above.
157+
149158
== CLI parameters
150159

151160
CLI parameters can be set with `cliOverrides` per role group:

0 commit comments

Comments
 (0)