Immutable Fields API

[apelisse]

Enhancement Description

• One-line enhancement description (can be used as a release note): Ability to mark fields as immutable in APIs with automatic verification.
• Kubernetes Enhancement Proposal: (link to kubernetes/enhancements file, if none yet, link to PR): api-machinery: KEP for immutable fields #1265
• Primary contact (assignee): apelisse
• Responsible SIGs: sig-api-machinery
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y) N/A
  • Beta release target (x.y) 1.16
  • Stable release target (x.y) 1.18

[apelisse]

/sig api-machinery

[kacole2]

@apelisse is this going to go straight to Beta in 1.16?

/milestone v1.16
/stage beta

[kacole2]

@apelisse this is a reminder that Enhancement Freeze is tomorrow and this KEP #1099 needs to be merged by EOD. If not, it will be removed from the milestone. Thanks

[apelisse]

Thanks for the reminder Kendrick, work is actually going-on (apelisse#1) and mostly driven by @sttts
We'll try to mark it implementable before tomorrow!

[kacole2]

@apelisse @sttts

Enhancement Freeze has passed for 1.16. The KEP at #1099 was never merged and now this is being removed from the 1.16 milestone. If this would like to be re-added, please file an exception and it will require approval from the release lead.

/milestone clear

[apelisse]

Thanks Kendrick, we've decided to take our time and do it well! We're planning to do it for the next release

[palnabarun]

Hey there @apelisse , 1.17 Enhancements shadow here. I wanted to check in and see if you think this Enhancement will be graduating to alpha/beta in 1.17?

The current release schedule is:

• Monday, September 23 - Release Cycle Begins
• Tuesday, October 15, EOD PST - Enhancements Freeze
• Thursday, November 14, EOD PST - Code Freeze
• Tuesday, November 19 - Docs must be completed and reviewed
• Monday, December 9 - Kubernetes 1.17.0 Released

If you do, I'll add it to the 1.17 tracking sheet (https://bit.ly/k8s117-enhancement-tracking). Once coding begins please list all relevant k/k PRs in this issue so they can be tracked properly. 👍

Thanks!

[sttts]

Yes, please add it to the tracking sheet. We are on it.

[palnabarun]

Awesome. 🎉

Just FYI, for the enhancement to be accepted into the release:

1. KEP PR must be merged
2. KEP should be in an implementable state
3. KEP should have test plans and graduation criteria.

/milestone v1.17

[palnabarun]

Hi @sttts @apelisse , just a friendly reminder. We are just 5 days away from the Enhancements Freeze.

I see that the KEP PR is still not merged and is in the provisional state.

For the KEP to be considered for 1.17,

1. KEP PR must be merged
2. KEP should be in an implementable state
3. KEP should have test plans and graduation criteria.

[palnabarun]

@sttts @apelisse -- Unfortunately the deadline for the 1.17 Enhancement freeze has passed and the KEP is still not merged and in the provisional state. For now, this is being removed from the milestone and 1.17 tracking sheet. If there is a need to get this in, please file an enhancement exception.

[palnabarun]

/milestone clear

[palnabarun]

@stts @apelisse Since, the exception request filed here was accepted, I'm adding back the enhancement to the tracking sheet.

[palnabarun]

/milestone v1.17

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[sttts]

/remove-lifecycle stale

[kikisdeliveryservice]

Hi @apelisse

Enhancements Lead here. Any plans for this in 1.20?

Thanks!
Kirsten

[apelisse]

Hopefully next release

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[apelisse]

This is on my backlog, and I believe we can have a new discussion around this since we changed the null semantics.
/remove-lifecycle stale

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

[apelisse]

/lifecycle frozen

[fejta-bot]

Enhancement issues opened in kubernetes/enhancements should never be marked as frozen.
Enhancement Owners can ensure that enhancements stay fresh by consistently updating their states across release cycles.

/remove-lifecycle frozen

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

[apelisse]

/lifecycle frozen

[sftim]

It'd be lovely to account for immutability in the API reference docs (and the code that generates them).

Example: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/ doesn't mention that some fields, such as name and namespace (if set) aren't mutable.

FWIW, https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names also doesn't mention this.