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

Kubernetes Feature Gate Information On Website Incorrect For ~6 Features #47996

Open
aaron-prindle opened this issue Sep 19, 2024 · 5 comments
Open
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@aaron-prindle
Copy link
Contributor

aaron-prindle commented Sep 19, 2024

This is a Bug Report

Problem:
In going through the a number of the kubernetes feature gates alpha, beta, and GA release dates in kubernetes/kubernetes pkg/features/kube_features.go as part of a PR review for kubernetes/kubernetes#126791 - I found some inaccuracies on the kube feature gate information that is currently hosted on the kubernetes website (and thus in this repo). In my analysis I looked at the pkg/features/kube_features.go file of the specified kubernetes release (eg: vX.Y.Z branch) and compared the feature status in that file to what is stated in the files in kubernetes/website content/en/docs/reference/command-line-tools-reference/feature-gates. Below is my list of discrepancies that I discovered:

Note: below kubernetes/website JSON is a custom struct and differs from the website syntax BUT the values/info is identical

- TBD if needed - Add AppArmorFields feature (missing on kubernetes/website)
- TBD if needed - Add DisableAllocatorDualWrite feature (missing on kubernetes/website)
- TBD if needed - Add ReloadKubeletServerCertificateFile feature (missing on kubernetes/website)
^ EDIT: See comment below, there are PRs for the above missing features in-flight. Below feature descrepencies are actual issues though and should be resolved:

  • Add missing GA entry for DisableCloudProviders
    {
    "name": "disable-cloud-providers",
    "started_alpha": "1.22",
    "alpha_default_value": false,
    "started_beta": "1.29",
    "beta_default_value": true
    // missing
    "started_GA": "1.31",
    "GA_default_value": true

    },

  • Update website to have DynamicResourceAllocation at alpha: v1.29
    {
    "name": "dynamic-resource-allocation",
    "started_alpha": "1.30", // should be 1.29
    "alpha_default_value": false
    },

  • Add missing alpha entry for NewVolumeManagerReconstruction
    {
    "name": "new-volume-manager-reconstruction",
    // missing
    "started_alpha": "1.25",
    "alpha_default_value": false,

    "started_beta": "1.27",
    "beta_default_value": false, // should be true
    "started_GA": "1.30",
    "GA_default_value": true
    },

  • Add missing beta entry for DisableCloudProviders
    {
    "name": "proc-mount-type",
    "started_alpha": "1.12",
    "alpha_default_value": false
    // missing
    "started_beta": "1.31",
    "beta_default_value": false

    },

  • Add missing alpha entry for TranslateStreamCloseWebsocketRequests
    {
    "name": "translate-stream-close-websocket-requests",
    // missing
    "started_alpha": "1.29",
    "alpha_default_value": false,

    "started_beta": "1.30",
    "beta_default_value": true
    },

  • Add missing beta entry for CSIMigrationPortworx
    {
    "name": "csi-migration-portworx",
    "started_alpha": "1.23",
    "alpha_default_value": false,
    "started_beta": "1.25",
    "beta_default_value": false
    // missing
    "started_beta": "1.31",
    "beta_default_value": true

    },

Proposed Solution:
Update the associated content/en/docs/reference/command-line-tools-reference/feature-gates/<feature> file for all of the features with discrepancies noted above.

Page to Update:
content/en/docs/reference/command-line-tools-reference/feature-gates/<feature>

@aaron-prindle aaron-prindle added the kind/bug Categorizes issue or PR as related to a bug. label Sep 19, 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 Sep 19, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@aaron-prindle aaron-prindle changed the title Kubernetes Feature Gate Information On Website Incorrect or Missing for ~10 features Kubernetes Feature Gate Information On Website Incorrect or Missing for ~9 features Sep 19, 2024
@aaron-prindle aaron-prindle changed the title Kubernetes Feature Gate Information On Website Incorrect or Missing for ~9 features Kubernetes Feature Gate Information On Website Incorrect or Missing For ~9 Features Sep 19, 2024
@mengjiao-liu
Copy link
Member

mengjiao-liu commented Sep 19, 2024

The reason for the inconsistency is that many updates have not yet been merged.

TBD if needed - Add AppArmorFields feature (missing on kubernetes/website)

TBD if needed - Add DisableAllocatorDualWrite feature (missing on kubernetes/website)

TBD if needed - Add ReloadKubeletServerCertificateFile feature (missing on kubernetes/website)

These have been submitted to:

Add missing Missing or in need of updating:

You can check below to see if the open PRs contain missing feature gates(Or search by the feature gate name):

@aaron-prindle
Copy link
Contributor Author

/cc @Jefftree

@aaron-prindle
Copy link
Contributor Author

@mengjiao-liu thanks for clarifying, I will update my description to note that those missing feature gates are not an issue // already in flight.

@aaron-prindle aaron-prindle changed the title Kubernetes Feature Gate Information On Website Incorrect or Missing For ~9 Features Kubernetes Feature Gate Information On Website Incorrect or Missing For ~6 Features Sep 19, 2024
@aaron-prindle aaron-prindle changed the title Kubernetes Feature Gate Information On Website Incorrect or Missing For ~6 Features Kubernetes Feature Gate Information On Website Incorrect For ~6 Features Sep 19, 2024
@sftim
Copy link
Contributor

sftim commented Sep 20, 2024

/language en

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Sep 20, 2024
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 needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

4 participants