Document the v1.x guarantees #2360
Merged
Conversation
This file contains hidden or 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
khaines
reviewed
Mar 30, 2020
docs/configuration/v1-guarantees.md
Outdated
There was a problem hiding this comment.
Should we make a pass on these to ensure all are prefixed with "experimental"? I realize that is a breaking change in itself, but I do like the convention that everything non-prod ready is prefixed with something consistent and obvious.
Another option is to output a warning in logs on startup of experimental features, similar to what we do for deprecated flags.
At the very least using the log output method, we could leave these flags alone for now and only force new experimental features to adhere to the convention.
pracucci
approved these changes
Mar 30, 2020
There was a problem hiding this comment.
Good job @gouthamve. I left few comments, but overall LGTM.
Signed-off-by: Goutham Veeramachaneni <[email protected]>
gouthamve
force-pushed
the
v1-guarantees
branch
from
3193f98 to
a24fbfe
Compare
|
|
||
| # Flags, Config and minor version upgrades | ||
|
|
||
| Upgrading cortex from one minor version to the next should "just work"; that being said, we don't want to bump the major version every time we remove a flag, so we will will keep deprecated flags around for 2 minor release. There is a metric (`cortex_deprecated_flags_inuse_total`) you can alert on to find out if you're using a deprecated flag. |
There was a problem hiding this comment.
@gouthamve so we will will typo.
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.
Signed-off-by: Goutham Veeramachaneni [email protected]
What this PR does:
Which issue(s) this PR fixes:
Fixes #2247