Update the spread-minimizing token migration documentation #8411
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
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
duricanikolic
force-pushed
the
yuri/update-smt-documentation
branch
from
6337659
to
3090e1e
Compare
56quarters
approved these changes
Jun 18, 2024
docs/sources/mimir/configure/configure-spread-minimizing-tokens/index.md
Outdated
Show resolved
Hide resolved
tacole02
reviewed
Jun 18, 2024
| {{% /admonition %}} | ||
|
|
||
| {{% admonition type="note" %}}In order to prevent incorrect query results, [shuffle-sharding](https://grafana.com/docs/mimir/latest/configure/configure-shuffle-sharding/#ingesters-shuffle-sharding) on the [read path](https://grafana.com/docs/mimir/latest/configure/configure-shuffle-sharding/#ingesters-read-path) of your ingesters **must** be disabled before migrating ingesters to the spread-minimizing tokens. Shuffle-sharding on ingester's read path can be re-enabled at least `-querier.query-store-after` time after the last ingester zone was migrated to the spread-minimizing tokens. |
There was a problem hiding this comment.
Unbold "must". We use bold text only for UI elements, not for emphasis.
docs/sources/mimir/configure/configure-spread-minimizing-tokens/index.md
Show resolved
Hide resolved
| {{% admonition type="note" %}}In order to prevent incorrect query results, [shuffle-sharding](https://grafana.com/docs/mimir/latest/configure/configure-shuffle-sharding/#ingesters-shuffle-sharding) on the [read path](https://grafana.com/docs/mimir/latest/configure/configure-shuffle-sharding/#ingesters-read-path) of your ingesters **must** be disabled before migrating ingesters to the spread-minimizing tokens. Shuffle-sharding on ingester's read path can be re-enabled at least `-querier.query-store-after` time after the last ingester zone was migrated to the spread-minimizing tokens. | ||
| {{% /admonition %}} | ||
|
|
||
| If ingesters are configured with a non-empty value of `-ingester.ring.tokens-file-path`, the latter represents the file where ingesters store the tokens at shutdown and restore them at startup. Keep track of this value, because it will be needed in the last step. |
There was a problem hiding this comment.
Change to "Keep track of this value, because you need it in the last step". This change avoids using "will" and also moves away from passive voice.
There was a problem hiding this comment.
Thank you. I've applied your suggestions.
| If before the migration ingesters were configured to store their tokens under `-ingester.ring.tokens-file-path`, these files must be deleted once all ingester zones are migrated to the spread-minimizing tokens. | ||
|
|
||
| For example, assuming that an ingester pod `ingester-zone-a` from a namespace `mimir-prod` used to store its tokens in a file `/data/tokens`, the latter can be deleted by executing: | ||
|
|
There was a problem hiding this comment.
We might want to rephrase this step to avoid passive tense. For example:
If, before the migration, you configured ingesters to store their tokens under -ingester.ring.tokens-file-path, you must delete these files after migrating all ingester zones to spread-minimizing tokens.
For example, if an ingester pod called ingester-zone-a from a namespace called mimir-prod used to store its tokens in a file called /data/tokens, you can run the following command to delete the /data/tokens file:
…s/index.md Co-authored-by: Nick Pillitteri <56quarters@users.noreply.github.com>
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
grafanabot
pushed a commit
that referenced
this pull request
Jun 21, 2024
* Update the spread-minimizing token migration documentation Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com> * Update docs/sources/mimir/configure/configure-spread-minimizing-tokens/index.md Co-authored-by: Nick Pillitteri <56quarters@users.noreply.github.com> * Fixing review findings Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com> --------- Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com> Co-authored-by: Nick Pillitteri <56quarters@users.noreply.github.com> (cherry picked from commit 2ee427e)
dimitarvdimitrov
pushed a commit
that referenced
this pull request
Jun 21, 2024
…8473) * Update the spread-minimizing token migration documentation Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com> * Update docs/sources/mimir/configure/configure-spread-minimizing-tokens/index.md Co-authored-by: Nick Pillitteri <56quarters@users.noreply.github.com> * Fixing review findings Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com> --------- Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com> Co-authored-by: Nick Pillitteri <56quarters@users.noreply.github.com> (cherry picked from commit 2ee427e) Co-authored-by: Đurica Yuri Nikolić <durica.nikolic@grafana.com>
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.
What this PR does
This PR enriches the existing "Migrate ingesters to spread-minimizing tokens" documentation with some missing parts. In particular:
Which issue(s) this PR fixes or relates to
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.