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.

Sign up for GitHub

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

KEP-1965: add GA criterias APIServerIdentity #4067

Closed
wants to merge 2 commits into from
Closed

KEP-1965: add GA criterias APIServerIdentity #4067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8337edd
KEP-1965: add GA criterias APIServerIdentity
andrewsykim Jun 8, 2023
272487b
KEP-1965: update KEP to reflect changes made for beta
andrewsykim Jun 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions keps/prod-readiness/sig-api-machinery/1965.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
kep-number: 1965
beta:
approver: "@deads2k" # and @wojtek-t
stable:
approver: "@deads2k" # and @wojtek-t
13 changes: 6 additions & 7 deletions keps/sig-api-machinery/1965-kube-apiserver-identity/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,18 +127,15 @@ post-start-hook and expired leases will be garbage collected by the `start-kube-
post-start-hook in kube-apiserver. The refresh rate, lease duration will be configurable through kube-apiserver
flags

The format of the lease will be `kube-apiserver-<hash-using-hostname>`. A hash based on the hostname is used for two reasons:
The format of the lease will be `apiserver-<hash-using-hostname>`. A hash based on the hostname is used for two reasons:
1. To ensure that a `kube-apiserver` that is restarting will attempt to obtain its previous lease, avoiding system churn when a kube-apiserver Lease is garbage collected.
2. Avoiding the need to truncate the lease name when using longer hostnames that exceed the 64 character limit for object names, which can lead to naming conflicts.

Each lease will have a `kubernetes.io/hostname` label with the actual hostname seen by kube-apiserver which cluster admins
can use to determine which kube-apiserver owns a Lease object. However, the holder identity of the
lease (`lease.spec.holderIdentity`) will be uniquely generated per start-up, which can be used as an indicator for
ownership churn of the lease. All kube-apiserver leases will also have a component label `k8s.io/component=kube-apiserver`.

In the future, we may consider providing a flag in `kube-apiserver` to override the lease name, but we don't anticipate
needing this today.

ownership churn of the lease. All leases will also have a `apiserver.kubernetes.io/identity` label, to uniquely distinguish
leases between kube-apiserver or extension apiservers.

### Test Plan

Expand Down Expand Up @@ -167,6 +164,8 @@ Proposed e2e tests:
- an e2e test that restarts a kube-apiserver and validates that a new Lease is created
with a newly generated ID and the old lease is garbage collected

See [apiserver_identity.go](https://github.com/kubernetes/kubernetes/blob/master/test/e2e/apimachinery/apiserver_identity.go) for currently implemented e2e tests.

### Graduation Criteria

Alpha should provide basic functionality covered with tests described above.
Expand All @@ -179,7 +178,7 @@ Alpha should provide basic functionality covered with tests described above.

#### Beta -> GA Graduation

==TODO==
- support for aggregated apiservers (with sufficient integration/e2e test coverage)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll need to document how to implement this in your aggregated API server. The docs should cover what's needed even if your implementation isn't in Go. It doesn't need to be in any great detail but I'm convinced we should make it feasible for an author to at least learn what they must implement themselves in order to conform.


**For non-optional features moving to GA, the graduation criteria must include
[conformance tests].**
Expand Down
5 changes: 3 additions & 2 deletions keps/sig-api-machinery/1965-kube-apiserver-identity/kep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,18 @@ see-also:
- "https://docs.google.com/document/d/1ed7miqlFY7-9lZxE7gzoyx_MFQCtFEDqtcKMpaAmHys/edit?usp=sharing"

# The target maturity stage in the current dev cycle for this KEP.
stage: beta
stage: stable

# The most recent milestone for which work toward delivery of this KEP has been
# done. This can be the current (upcoming) milestone, if it is being actively
# worked on.
latest-milestone: "v1.26"
latest-milestone: "v1.28"

# The milestone at which this feature was, or is targeted to be, at each stage.
milestone:
alpha: "v1.20"
beta: "v1.26"
stable: "v1.28"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this is not ready for stable - IIUC nothing actually uses this functionality, so we have no proof or experience that it actually works. GA graduation criteria should include at least one, ideally two plus usages of this feature (and those usages need to beta level).

The conversation around kubernetes/kubernetes#114314 (comment) happened so long ago that I have forgotten all the things that we need to fix.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this is not ready for stable - IIUC nothing actually uses this functionality, so we have no proof or experience that it actually works. GA graduation criteria should include at least one, ideally two plus usages of this feature (and those usages need to beta level).

I think it's reasonable to say this feature shouldn't GA until StorageVersion API is Beta, which is currently the primary use-case for it. I'll add this to the GA criteria.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For posterity: UVIP is using this but is still in alpha.


# The following PRR answers are required at alpha release
# List the feature gate name and the components for which it must be enabled
Expand Down