diff options
| author | Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com> | 2022-08-02 05:23:44 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-02 05:23:44 -0700 |
| commit | 692d83075963fdabead7b2b5c4adebdbf89e125f (patch) | |
| tree | af9fac0e5a3c6055ae6076cd37ebfaf89deb1a88 | |
| parent | 896f0cea19b3754f3f1cf4e803698bbc66fddbd6 (diff) | |
| parent | 66d09b8a378b01a208f6902b962a0fa563d2cfda (diff) | |
Merge pull request #6693 from BenTheElder/add-generics-draft
Add generics policy for kubernetes
| -rw-r--r-- | sig-architecture/generics.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/sig-architecture/generics.md b/sig-architecture/generics.md new file mode 100644 index 00000000..059a65f2 --- /dev/null +++ b/sig-architecture/generics.md @@ -0,0 +1,38 @@ +# Background + +In general, Kubernetes has not restricted using new Go features, we've quickly +adopted new standard library types and methods and will continue to do so. + +Generally the latest stable go release is in use on the main development branch. +This includes all of the staging libraries (client-go etc.) that originate in the +main [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) repository. + +In Kubernetes v1.24 we shipped Go 1.18 (which adds support for generics) +rather late in the release cycle, so we temporarily prohibited using generics +in case we ran into other issues and needed to roll back to unblock the release. +Now that v1.24.0 is out, use of generics should be allowed. + +# Generics Policy + +Generics may be used in Kubernetes starting in v1.25, with the following restrictions +applying only until v1.24 is [out of support][version-support]: + +- Generics should **not** be used in Kubernetes libraries used across multiple Kubernetes +versions, that is the non "staged" libraries like: + - [k8s.io/utils](https://github.com/kubernetes/utils) + - [sigs.k8s.io/yaml](https://github.com/kubernetes-sigs/yaml) + - [k8s.io/klog](https://github.com/kubernetes/klog) + - etc. + +- Generics should be **avoided** when writing Kubernetes bug fixes that are likely to be backported, to streamline cherry-picking to older release branches. + +These restrictions should be considered lifted when v1.24 is out of support. + +## Recommendations for Reviewers + +- Consider if proposed generics pull requests improve maintainability and readability. + +- The current generics implementation is known to have some performance issues +depending on usage: consider requesting benchmarks before / after the changes. + +[version-support]: https://kubernetes.io/releases/patch-releases/#support-period |