Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent documentation about featuregate ComponentSLIs #48960

Open
T-Lakshmi opened this issue Dec 6, 2024 · 9 comments · May be fixed by #48964
Open

Inconsistent documentation about featuregate ComponentSLIs #48960

T-Lakshmi opened this issue Dec 6, 2024 · 9 comments · May be fixed by #48964
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@T-Lakshmi
Copy link
Contributor

This is a Bug Report
Problem:
ComponentSLIs feature-gate state mentioned as stable since V1.29 under Kubernetes Component SLI Metrics.
image

But under feature-gate list its still mentaion as Beta state.
image

Proposed Solution:
Update the docs with accurate information.

@T-Lakshmi T-Lakshmi added the kind/bug Categorizes issue or PR as related to a bug. label Dec 6, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Dec 6, 2024
@T-Lakshmi
Copy link
Contributor Author

/sig docs
/language en

@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. language/en Issues or PRs related to English language labels Dec 6, 2024
@T-Lakshmi
Copy link
Contributor Author

From the code comments its mentioned ComponentSLIs officially graduated to GA in v1.29 but the gate was not updated until v1.32.

https://github.com/kubernetes/kubernetes/blob/a27498ef42f27e7cddadb2c5b31bc80fed81d964/staging/src/k8s.io/component-base/metrics/features/kube_features.go#L35

ComponentSLIs: {
{Version: version.MustParse("1.26"), Default: false, PreRelease: featuregate.Alpha},
{Version: version.MustParse("1.27"), Default: true, PreRelease: featuregate.Beta},
// ComponentSLIs officially graduated to GA in v1.29 but the gate was not updated until v1.32.
// To support emulated versions, keep the gate until v1.35.
{Version: version.MustParse("1.32"), Default: true, PreRelease: featuregate.GA, LockToDefault: true},
},

@T-Lakshmi
Copy link
Contributor Author

https://github.com/kubernetes/kubernetes/blob/a27498ef42f27e7cddadb2c5b31bc80fed81d964/test/featuregates_linter/test_data/versioned_feature_list.yaml#L209

- name: ComponentSLIs
  versionedSpecs:
  - default: false
    lockToDefault: false
    preRelease: Alpha
    version: "1.26"
  - default: true
    lockToDefault: false
    preRelease: Beta
    version: "1.27"
  - default: true
    lockToDefault: true
    preRelease: GA
    version: "1.32"

@sftim
Copy link
Contributor

sftim commented Dec 6, 2024

We haven't released v1.32 yet

The docs look correct for v1.31 - which part is not right @T-Lakshmi ?

@sftim
Copy link
Contributor

sftim commented Dec 6, 2024

/priority awaiting-more-evidence

@k8s-ci-robot k8s-ci-robot added the priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. label Dec 6, 2024
@T-Lakshmi
Copy link
Contributor Author

@sftim,

The docs look correct for v1.31 - which part is not right @T-Lakshmi ?

ComponentSLIs feature-gate state mentioned as stable since V1.29 under Kubernetes Component SLI Metrics.

Is this true? is ComponentSLIs feature state stable for V1.31?

@sftim
Copy link
Contributor

sftim commented Dec 6, 2024

Ah that's the bit. Yes, it's not stable. The shortcode must be defined wrong.

/remove-priority awaiting-more-evidence
/triage accepted

@T-Lakshmi you are welcome to file a PR; if you don't plan to, please use /help to label this as help wanted.
Or (extra credit) add the information into the PR description to make this a good first issue.

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 6, 2024
@T-Lakshmi
Copy link
Contributor Author

@sftim,
Ok, i can file PR for this.

/assign

@T-Lakshmi
Copy link
Contributor Author

PR Raised: #48964

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants