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: _benchmark/user-guide/install-and-configure/installing-benchmark.md
+15-4Lines changed: 15 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -138,21 +138,32 @@ docker run opensearchproject/opensearch-benchmark -h
138
138
```
139
139
{% include copy.html %}
140
140
141
-
142
141
### Establishing volume persistence in a Docker container
143
142
144
-
To make sure your benchmark data and logs persist after your Docker container stops, specify a Docker volume to mount to the image when you work with OpenSearch Benchmark.
143
+
To ensure that your benchmark data and logs persist after your Docker container stops, you must mount a local directory as a volume when running OpenSearch Benchmark in Docker.
145
144
146
145
Use the `-v` option to specify a local directory to mount and a directory in the container where the volume is attached.
147
146
148
-
The following example command creates a volume in a user's home directory, mounts the volume to the OpenSearch Benchmark containerat `/opensearch-benchmark/.benchmark`, and then runs a test benchmark using the geonames workload. Some client options are also specified:
147
+
The following example mounts a volume from the user's home directoryto the OpenSearch Benchmark container's default benchmark data path at `/opensearch-benchmark/.benchmark` and then runs a test benchmark using the `geonames` workload:
See [Configuring OpenSearch Benchmark]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/) to learn more about the files and subdirectories located in `/opensearch-benchmark/.benchmark`.
154
+
By default, the OpenSearch Benchmark container runs as the `benchmark` user with a home directory of `/opensearch-benchmark`, so `$HOME/.benchmark` resolves to `/opensearch-benchmark/.benchmark`.
155
+
{: .note}
156
+
157
+
#### Running OpenSearch Benchmark as the root user
158
+
159
+
If you run the container as the `root` user, then the effective home directory becomes `/root`, and the benchmark path becomes `/root/.benchmark`. In this case, specify the volume mount accordingly:
To learn more about the files and subdirectories located in `/opensearch-benchmark/.benchmark`, see [Configuring OpenSearch Benchmark]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/).
0 commit comments