[DOC] The path to get .benchmarks folder changed in the latest release of OSB and docs is not longer valid

[navneet1v]

What do you want to do?

• [X] Request a change to existing documentation
• [ ] Add new documentation
• [ ] Report a technical problem with the documentation
• [ ] Other

Tell us about your request. Provide a summary of the request. The command here tells how to map .benchmarks folder while running OSB with docker. But the path has been changed. The new command that should be used is:

Present in Documentation

docker run -v $HOME/benchmarks:/opensearch-benchmark/.benchmark opensearchproject/opensearch-benchmark execute-test --target-hosts https://198.51.100.25:9200 --pipeline benchmark-only --workload geonames --client-options basic_auth_user:admin,basic_auth_password:admin,verify_certs:false --test-mode

Working

docker run -v $HOME/benchmarks:/root/.benchmark opensearchproject/opensearch-benchmark execute-test --target-hosts https://198.51.100.25:9200 --pipeline benchmark-only --workload geonames --client-options basic_auth_user:admin,basic_auth_password:admin,verify_certs:false --test-mode

OSB version

Latest download from docker hub via: opensearchproject/opensearch-benchmark

What other resources are available? Provide links to related issues, POCs, steps for testing, etc. NA

[navneet1v]

cc: @rishabh6788

[Naarcha-AWS]

@IanHoang: Is this accurate? If so, I can send a PR through to update it.

[IanHoang]

@navneet1v I tested out the latest docker image for OSB (1.9.0) and /opensearch-benchmark/.benchmark is still a valid path:

hoangia@80a9971b1103 ~ % docker run --entrypoint bash -it opensearchproject/opensearch-benchmark:latest -c /bin/bash
benchmark@95fe55242805:~$ cd ~
benchmark@95fe55242805:~$ pwd
/opensearch-benchmark
benchmark@95fe55242805:~$ cd .benchmark
benchmark@95fe55242805:~/.benchmark$ pwd
/opensearch-benchmark/.benchmark

Also, the Dockerfile still includes opensearch-benchmark as the entry directory: https://github.com/opensearch-project/opensearch-benchmark/blob/main/docker/Dockerfile#L30-L31

Could you provide the error you're receiving?

[rishabh6788]

@navneet1v Can you please make sure you are not changing the user to root while running OSB container? AFAIK the default path of benchmark config is always $HOME/.benchmark.

[navneet1v]

@rishabh6788 Yes I am using root as the user. Because if I don't use that I have to change permissions for all the folders. Could this be the reason why /root us getting used?

[rishabh6788]

@rishabh6788 Yes I am using root as the user. Because if I don't use that I have to change permissions for all the folders. Could this be the reason why /root us getting used?

Yes.

[navneet1v]

Make sense. Can we document this in the docs. This will be helpful for future confusions.