Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Dockerfile and Docker README #250

Merged
merged 5 commits into from
Apr 3, 2023

Conversation

IanHoang
Copy link
Collaborator

@IanHoang IanHoang commented Apr 3, 2023

Description

Users on Dockerhub were having trouble running the command docker run opensearchproject/opensearch-benchmark in the README and Dockerhub repo's description. The commands exits with an exit status code of 0 because it doesn't run any entrypoint commands. This PR does the following:

  • Adds entrypoint commands to Dockerfile
  • Adds more information to the README to illuminate how to use the Docker image.
  • Adds the command that's been updated in the Dockerhub repository so that there's consistency between the README and the Dockerhub repository overview tab.

Issues Resolved

Testing

  • New functionality includes testing

Built image locally after updating Dockerfile and tested it with the following commands with Docker CLI. Tested on Docker Desktop to confirm consistency:

  • docker run --entrypoint bash <IMAGE> -c "opensearch-benchmark -h" --> overwrites entrypoint commands to use opensearch-benchmark help command
  • docker run <IMAGE> opensearch-benchmark -h --> runs it in simpler method
  • docker run -it <IMAGE> /bin/sh --> runs in interactive mode in terminal
  • Ran with Docker Desktop to run the image
  • Monitored container status on Docker desktop

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Ian Hoang added 5 commits April 3, 2023 09:54
…nt with Dockerhub official repo

Signed-off-by: Ian Hoang <hoangia@amazon.com>
Signed-off-by: Ian Hoang <hoangia@amazon.com>
Signed-off-by: Ian Hoang <hoangia@amazon.com>
Signed-off-by: Ian Hoang <hoangia@amazon.com>
Signed-off-by: Ian Hoang <hoangia@amazon.com>
@IanHoang IanHoang requested a review from gkamat as a code owner April 3, 2023 15:00
@IanHoang IanHoang merged commit e582da5 into opensearch-project:main Apr 3, 2023
@IanHoang IanHoang deleted the update_docker_readme branch April 3, 2023 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants