kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.5k stars 14.43k forks source link

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

Open aaron-prindle opened 1 month ago

aaron-prindle commented 1 month ago

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 https://github.com/kubernetes/kubernetes/pull/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:

EDIT: Additionally more discrepencies were discovered in the thread here: https://github.com/kubernetes/kubernetes/pull/127200#discussion_r1768862429

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

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>

k8s-ci-robot commented 1 month ago

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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
mengjiao-liu commented 1 month ago

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 commented 1 month ago

/cc @Jefftree

aaron-prindle commented 1 month ago

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

sftim commented 1 month ago

/language en

iheartNathan commented 1 month ago

@aaron-prindle / @sftim I'm interested in working on this.

Aaina26 commented 2 weeks ago

@iheartNathan Are you working on this?

iheartNathan commented 1 week ago

@aaron-prindle yes.

iheartNathan commented 1 week ago

/assign