Fix installation docs after #1151 #1185
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
With the `2020-resolver` requirement removed in elastic#1151, installation in virtualenv will fail due older pip versions not using the new dependency resolver by default[1]. This commit updates the docs such that users always need to upgrade `pip`, either in a local or `virtualenv` environments prior to esrally installation. [1] https://discuss.python.org/t/announcement-pip-20-3-release/5948
dliappis
commented
Feb 15, 2021
| 1. Set up a new virtualenv environment in a directory with ``python3 -m venv .`` | ||
| 2. Activate the environment with ``source /path/to/virtualenv/dir/bin/activate`` | ||
| 3. Install Rally with ``python3 -m pip install esrally`` | ||
| 1. Set up a new virtualenv environment in a directory with ``python3 -m venv .venv`` |
There was a problem hiding this comment.
One thing to note here that is different to the --user case above is that even with e.g. python 3.8.7 with comes with pip 21.0.1, creating a venv brings pip 20.2.3. Starting with Python 3.9.0, there's a new flag --upgrade-deps that can do this in one go.
Hence, I think it's important to have the admonition in step 3.
danielmitterdorfer
approved these changes
Feb 15, 2021
| 2. Activate the environment with ``source /path/to/virtualenv/dir/bin/activate`` | ||
| 3. Install Rally with ``python3 -m pip install esrally`` | ||
| 1. Set up a new virtualenv environment in a directory with ``python3 -m venv .venv`` | ||
| 2. Activate the environment with ``source /path/to/virtualenv/.venv/bin/activate`` |
There was a problem hiding this comment.
I wonder whether we could simplify this path here assuming we are already in the current directory in the step above, i.e.
source .venv/bin/activate
There was a problem hiding this comment.
We could, I think we have it here because a few lines after we reference this step at a point where the user might not be in the same directory anymore:
Whenever you want to use Rally, run the activation script (step 2 above) first.
There was a problem hiding this comment.
Good point. Then let's be safe here.
dliappis
added a commit
that referenced
this pull request
Feb 15, 2021
With the `2020-resolver` requirement removed in #1151, installation in virtualenv will fail due older pip versions not using the new dependency resolver by default[1]. This commit updates the docs such that users always need to upgrade `pip`, either in a local or `virtualenv` environments prior to esrally installation. [1] https://discuss.python.org/t/announcement-pip-20-3-release/5948 Relates #1184
This was referenced Feb 15, 2021
dliappis
added a commit
to dliappis/rally
that referenced
this pull request
Feb 22, 2021
As a followup to elastic#1185 this commit adds a few IT tests to validate the Rally installation steps in the docs.
dliappis
added a commit
to dliappis/rally
that referenced
this pull request
Feb 22, 2021
As a followup to elastic#1185 this commit adds a few IT tests to validate the Rally installation steps in the docs.
dliappis
added a commit
to dliappis/rally
that referenced
this pull request
Feb 22, 2021
As a followup to elastic#1185 this commit adds a few IT tests to validate the Rally installation steps in the docs.
dliappis
added a commit
to dliappis/rally
that referenced
this pull request
Feb 22, 2021
As a followup to elastic#1185 this commit adds a few IT tests to validate the Rally installation steps in the docs. We also remove hardcoded Python versions from the installation section of docs instead relying on a checked-in variable to ease maintainance in the future.
dliappis
added a commit
that referenced
this pull request
Feb 23, 2021
As a followup to #1185 this commit adds a few IT tests to validate the Rally installation steps in the docs. We also remove hard coded Python versions from the installation section of docs instead relying on a checked-in variable to ease maintenance in the future. Finally we update the PY38/PY39 versions to the latest patch release (`3.8.8`, `3.9.2`)
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.
With the
2020-resolverrequirement removed in #1151, installation invirtualenv will fail due older pip versions not using the new
dependency resolver by default[1].
This commit updates the docs such that users always need to upgrade
pip, either in a local orvirtualenvenvironments prior to esrallyinstallation.
[1] https://discuss.python.org/t/announcement-pip-20-3-release/5948
Relates #1184