Add Documentation for Python Support Guide #234
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
March 15, 2023 08:56
Signed-off-by: Ian Hoang <hoangia@amazon.com>
Signed-off-by: Ian Hoang <hoangia@amazon.com>
gkamat
reviewed
Mar 17, 2023
gkamat
reviewed
Mar 17, 2023
gkamat
reviewed
Mar 17, 2023
gkamat
reviewed
Mar 17, 2023
gkamat
reviewed
Mar 17, 2023
gkamat
reviewed
Mar 17, 2023
gkamat
reviewed
Mar 17, 2023
gkamat
reviewed
Mar 17, 2023
gkamat
reviewed
Mar 17, 2023
Signed-off-by: Ian Hoang <hoangia@amazon.com>
gkamat
approved these changes
Mar 20, 2023
| ``` | ||
| python3 ~/.local/bin/opensearch-benchmark execute_test --workload=geonames --pipeline=benchmark-only --target-host="<OPENSEARCH CLUSTER ENDPOINT>" --client-options="basic_auth_user:'<USERNAME>',basic_auth_password:'<PASSWORD>'" | ||
| ``` | ||
|
|
||
| ### Creating a Pull Request After Adding Changes and Testing Them Out | ||
| After adding python versions and testing them in environments, make a pull request on Github. Once that’s been merged, push a tag and get it approved by a maintainer. After this has been approved, Jenkins will publish to opensearch-benchmark’s Pypi account with the new version you updated it to. | ||
| After adding Python versions and testing them in environments, make a pull request on Github. Once that’s been merged, push a tag and get it approved by a maintainer. After this has been approved, Jenkins will publish to OpenSearch Benchmark’s Pypi account with the new version you updated it to. |
| For example: When I run which opensearch-benchmark on my Ubuntu environment, I get /home/ubuntu/.pyenv/shims/opensearch-benchmark. The path points to a shell script. Thus, I run the following to invoke a command: | ||
| Keep in mind the file path outputted differs for each operating system and might point to a shell script or a Python script. Depending on which it is, make sure you can invoke it with the proper prefix such as `bash` or `python3`. | ||
|
|
||
| - For example: When running `which opensearch-benchmark` on an Ubuntu environment, the commad line outputs `/home/ubuntu/.pyenv/shims/opensearch-benchmark`. On closer inspection, the path points to a shell script. Thus, to invoke OpenSearch Benchmark, pre-=append the OpenSearch Benchmark command with `bash` and the path outputted earlier: |
There was a problem hiding this comment.
Minor nit: "prepend" and "output earlier".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation on how to add and test support for additional major and minor Python versions.
Issues Resolved
N/A
Testing
No testing required as this is documentation related.
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.