docs: how to convert config to per tenant limit #5446
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
francoposa
force-pushed
the
francoposa/docs-how-to-convert-config-to-per-tenant-limit
branch
from
46f8e8d
to
efcfef7
Compare
56quarters
reviewed
Jul 7, 2023
|
|
||
| ## Deprecating the Existing Config Option | ||
|
|
||
| 1. Move the config option description JSON object from its previous location to the "limits" block of `cmd/mimir/config-descriptor.json`. |
There was a problem hiding this comment.
This file is automatically generated when make reference-help is run. It shouldn't be modified manually.
|
|
||
| 3. Expose the tenant-specific overrides for the new config option | ||
|
|
||
| First add the tenant-specific method and docstring to the _interface_ which uses the config option. |
There was a problem hiding this comment.
Using an interface like this is specific to the way limits are used in this particular area of the code. Can you note that this pattern of adding the setting to an interface may not apply in all cases?
|
|
||
| Similar helper functions may already exist for similar purposes: `SmallestPositiveNonZeroIntPerTenant`, `LargestPositiveNonZeroDurationPerTenant`, etc. | ||
|
|
||
| 5. Consume the overrides with the multiple tenant limits. |
There was a problem hiding this comment.
Using the limits from multiple tenants at once is specific to the read path. Can you note that here or mark this step as optional?
|
@56quarters I believe all feedback is addressed |
francoposa
force-pushed
the
francoposa/docs-how-to-convert-config-to-per-tenant-limit
branch
from
15d4dc5
to
fec4872
Compare
pracucci
approved these changes
Jul 18, 2023
pracucci
deleted the
francoposa/docs-how-to-convert-config-to-per-tenant-limit
branch
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
Adds a doc to
docs/internalabout how to migrate global config options to tenant-specific config.There are a ton of minor steps here particularly in regards to maintaining compatibility through the deprecation period for the old, global config option.
A playbook was suggested to make sure we didn't miss anything, as we will certainly need to do this again.
Which issue(s) this PR fixes or relates to
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]