Update beta target milestone, sync to match content with latest templ…

…ates
kubernetes · May 10, 2021 · 144dfa0 · 144dfa0
1 parent 423266b
commit 144dfa0
Show file tree

Hide file tree

Showing 4 changed files with 176 additions and 46 deletions.
diff --git a/keps/sig-node/1287-in-place-update-pod-resources/README.md b/keps/sig-node/1287-in-place-update-pod-resources/README.md
@@ -3,6 +3,7 @@
 ## Table of Contents
 
 <!-- toc -->
+- [Release Signoff Checklist](#release-signoff-checklist)
 - [Summary](#summary)
 - [Motivation](#motivation)
   - [Goals](#goals)
@@ -13,6 +14,8 @@
     - [Container Resize Policy](#container-resize-policy)
     - [Resize Status](#resize-status)
     - [CRI Changes](#cri-changes)
+  - [Risks and Mitigations](#risks-and-mitigations)
+- [Design Details](#design-details)
   - [Kubelet and API Server Interaction](#kubelet-and-api-server-interaction)
     - [Kubelet Restart Tolerance](#kubelet-restart-tolerance)
   - [Scheduler and API Server Interaction](#scheduler-and-api-server-interaction)
@@ -22,7 +25,6 @@
     - [Notes](#notes)
   - [Affected Components](#affected-components)
   - [Future Enhancements](#future-enhancements)
-  - [Risks and Mitigations](#risks-and-mitigations)
   - [Test Plan](#test-plan)
     - [Unit Tests](#unit-tests)
     - [Pod Resize E2E Tests](#pod-resize-e2e-tests)
@@ -43,8 +45,51 @@
   - [Scalability](#scalability)
   - [Troubleshooting](#troubleshooting)
 - [Implementation History](#implementation-history)
+- [Drawbacks](#drawbacks)
+- [Alternatives](#alternatives)
 <!-- /toc -->
 
+## Release Signoff Checklist
+
+<!--
+**ACTION REQUIRED:** In order to merge code into a release, there must be an
+issue in [kubernetes/enhancements] referencing this KEP and targeting a release
+milestone **before the [Enhancement Freeze](https://git.k8s.io/sig-release/releases)
+of the targeted release**.
+
+For enhancements that make changes to code or processes/procedures in core
+Kubernetes—i.e., [kubernetes/kubernetes], we require the following Release
+Signoff checklist to be completed.
+
+Check these off as they are completed for the Release Team to track. These
+checklist items _must_ be updated for the enhancement to be released.
+-->
+
+Items marked with (R) are required *prior to targeting to a milestone / release*.
+
+- [ ] (R) Enhancement issue in release milestone, which links to KEP dir in [kubernetes/enhancements] (not the initial KEP PR)
+- [ ] (R) KEP approvers have approved the KEP status as `implementable`
+- [ ] (R) Design details are appropriately documented
+- [ ] (R) Test plan is in place, giving consideration to SIG Architecture and SIG Testing input (including test refactors)
+  - [ ] e2e Tests for all Beta API Operations (endpoints)
+  - [ ] (R) Ensure GA e2e tests for meet requirements for [Conformance Tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md)
+  - [ ] (R) Minimum Two Week Window for GA e2e tests to prove flake free
+- [ ] (R) Graduation criteria is in place
+  - [ ] (R) [all GA Endpoints](https://github.com/kubernetes/community/pull/1806) must be hit by [Conformance Tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md)
+- [ ] (R) Production readiness review completed
+- [ ] (R) Production readiness review approved
+- [ ] "Implementation History" section is up-to-date for milestone
+- [ ] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
+- [ ] Supporting documentation—e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
+
+<!--
+**Note:** This checklist is iterative and should be reviewed and updated every time this enhancement is being considered for a milestone.
+-->
+
+[kubernetes.io]: https://kubernetes.io/
+[kubernetes/enhancements]: https://git.k8s.io/enhancements
+[kubernetes/kubernetes]: https://git.k8s.io/kubernetes
+[kubernetes/website]: https://git.k8s.io/website
 
 ## Summary
 
@@ -209,6 +254,25 @@ CPU and memory limit configurations from runtime.
 These CRI changes are a separate effort that does not affect the design
 proposed in this KEP.
 
+### Risks and Mitigations
+
+1. Backward compatibility: When Pod.Spec.Containers[i].Resources becomes
+   representative of desired state, and Pod's true resource allocations are
+   tracked in Pod.Status.ContainerStatuses[i].ResourcesAllocated, applications
+   that query PodSpec and rely on Resources in PodSpec to determine resource
+   allocations will see values that may not represent actual allocations. As a
+   mitigation, this change needs to be documented and highlighted in the
+   release notes, and in top-level Kubernetes documents.
+1. Resizing memory lower: Lowering cgroup memory limits may not work as pages
+   could be in use, and approaches such as setting limit near current usage may
+   be required. This issue needs further investigation.
+1. Older client versions: Previous versions of clients that are unaware of the
+   new ResourcesAllocated and ResizePolicy fields would set them to nil. To
+   keep compatibility, PodResourceAllocation admission controller mutates such
+   an update by copying non-nil values from the old Pod to current Pod.
+
+## Design Details
+
 ### Kubelet and API Server Interaction
 
 When a new Pod is created, Scheduler is responsible for selecting a suitable
@@ -489,23 +553,6 @@ Other components:
 1. Allow resource limits to be updated (VPA feature).
 1. Handle pod-scoped resources (https://github.com/kubernetes/enhancements/pull/1592)
 
-### Risks and Mitigations
-
-1. Backward compatibility: When Pod.Spec.Containers[i].Resources becomes
-   representative of desired state, and Pod's true resource allocations are
-   tracked in Pod.Status.ContainerStatuses[i].ResourcesAllocated, applications
-   that query PodSpec and rely on Resources in PodSpec to determine resource
-   allocations will see values that may not represent actual allocations. As a
-   mitigation, this change needs to be documented and highlighted in the
-   release notes, and in top-level Kubernetes documents.
-1. Resizing memory lower: Lowering cgroup memory limits may not work as pages
-   could be in use, and approaches such as setting limit near current usage may
-   be required. This issue needs further investigation.
-1. Older client versions: Previous versions of clients that are unaware of the
-   new ResourcesAllocated and ResizePolicy fields would set them to nil. To
-   keep compatibility, PodResourceAllocation admission controller mutates such
-   an update by copying non-nil values from the old Pod to current Pod.
-
 ### Test Plan
 
 #### Unit Tests
@@ -875,3 +922,22 @@ _This section must be completed when targeting beta graduation to a release._
 - 2020-11-06 - Updated with feedback from reviews
 - 2020-12-09 - Add "Deferred"
 - 2021-02-05 - Final consensus on resourcesAllocated[] and resize[]
+
+## Drawbacks
+
+<!--
+Why should this KEP _not_ be implemented?
+-->
+
+There are no drawbacks that we are aware of.
+
+## Alternatives
+
+<!--
+What other approaches did you consider, and why did you rule them out? These do
+not need to be as detailed as the proposal, but should include enough
+information to express the idea and why it was not acceptable.
+-->
+
+We considered having scheduler approve the resize. We also considered PodSpec as
+the location to checkpoint allocated resources.
diff --git a/keps/sig-node/1287-in-place-update-pod-resources/kep.yaml b/keps/sig-node/1287-in-place-update-pod-resources/kep.yaml
@@ -9,6 +9,8 @@ owning-sig: sig-node
 participating-sigs:
   - sig-autoscaling
   - sig-scheduling
+status: implementable
+creation-date: 2018-11-06
 reviewers:
   - "@bsalamat"
   - "@dashpole"
@@ -21,28 +23,25 @@ approvers:
   - "@derekwaynecarr"
   - "@ahg-g"
   - "@mwielgus"
-editor: TBD
-creation-date: 2018-11-06
-last-updated: 2021-02-05
-status: implementable
+prr-approvers:
+  - "@ehashman"
 see-also:
   - "/keps/sig-node/2273-kubelet-container-resources-cri-api-changes"
 replaces:
-superseded-by:
 
-# PRR
-prr-approvers:
-  - "@ehashman"
+stage: "alpha"
+
+latest-milestone: "v1.22"
+
+milestone:
+  alpha: "v1.22"
+  beta: "v1.24"
+  stable: "v1.26"
+
 feature-gates:
   - name: InPlacePodVerticalScaling
     components:
       - kube-apiserver
       - kube-scheduler
       - kubelet
 disable-supported: true
-milestone:
-  alpha: "v1.22"
-  beta: "v1.23"
-  stable: "v1.25"
-latest-milestone: "v1.22"
-stage: "alpha"
diff --git a/keps/sig-node/2273-kubelet-container-resources-cri-api-changes/README.md b/keps/sig-node/2273-kubelet-container-resources-cri-api-changes/README.md
@@ -3,11 +3,14 @@
 ## Table of Contents
 
 <!-- toc -->
+- [Release Signoff Checklist](#release-signoff-checklist)
 - [Summary](#summary)
 - [Motivation](#motivation)
   - [Goals](#goals)
   - [Non-Goals](#non-goals)
 - [Proposal](#proposal)
+  - [API Changes](#api-changes)
+  - [Risks and Mitigations](#risks-and-mitigations)
 - [Design Details](#design-details)
   - [Expected Behavior of CRI Runtime](#expected-behavior-of-cri-runtime)
   - [Test Plan](#test-plan)
@@ -25,8 +28,52 @@
   - [Scalability](#scalability)
   - [Troubleshooting](#troubleshooting)
 - [Implementation History](#implementation-history)
+- [Drawbacks](#drawbacks)
+- [Alternatives](#alternatives)
 <!-- /toc -->
 
+## Release Signoff Checklist
+
+<!--
+**ACTION REQUIRED:** In order to merge code into a release, there must be an
+issue in [kubernetes/enhancements] referencing this KEP and targeting a release
+milestone **before the [Enhancement Freeze](https://git.k8s.io/sig-release/releases)
+of the targeted release**.
+
+For enhancements that make changes to code or processes/procedures in core
+Kubernetes—i.e., [kubernetes/kubernetes], we require the following Release
+Signoff checklist to be completed.
+
+Check these off as they are completed for the Release Team to track. These
+checklist items _must_ be updated for the enhancement to be released.
+-->
+
+Items marked with (R) are required *prior to targeting to a milestone / release*.
+
+- [ ] (R) Enhancement issue in release milestone, which links to KEP dir in [kubernetes/enhancements] (not the initial KEP PR)
+- [ ] (R) KEP approvers have approved the KEP status as `implementable`
+- [ ] (R) Design details are appropriately documented
+- [ ] (R) Test plan is in place, giving consideration to SIG Architecture and SIG Testing input (including test refactors)
+  - [ ] e2e Tests for all Beta API Operations (endpoints)
+  - [ ] (R) Ensure GA e2e tests for meet requirements for [Conformance Tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md)
+  - [ ] (R) Minimum Two Week Window for GA e2e tests to prove flake free
+- [ ] (R) Graduation criteria is in place
+  - [ ] (R) [all GA Endpoints](https://github.com/kubernetes/community/pull/1806) must be hit by [Conformance Tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md)
+- [ ] (R) Production readiness review completed
+- [ ] (R) Production readiness review approved
+- [ ] "Implementation History" section is up-to-date for milestone
+- [ ] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
+- [ ] Supporting documentation—e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
+
+<!--
+**Note:** This checklist is iterative and should be reviewed and updated every time this enhancement is being considered for a milestone.
+-->
+
+[kubernetes.io]: https://kubernetes.io/
+[kubernetes/enhancements]: https://git.k8s.io/enhancements
+[kubernetes/kubernetes]: https://git.k8s.io/kubernetes
+[kubernetes/website]: https://git.k8s.io/website
+
 ## Summary
 
 This proposal aims to improve the Container Runtime Interface (CRI) APIs for
@@ -79,6 +126,8 @@ Another change in this proposal is to extend ContainerStatus CRI API such that
 Kubelet can query and discover the CPU and memory resources that are presently
 applied to a Container.
 
+### API Changes
+
 To accomplish aforementioned goals:
 
 * A new protobuf message object named *ContainerResources* that encapsulates
@@ -148,6 +197,10 @@ message UpdateContainerResourcesRequest {
 
 * Kubelet code is modified to leverage these changes.
 
+### Risks and Mitigations
+
+There are no risks that we are aware of as this KEP will be implemented simultaneously with In-place update KEP.
+
 ## Design Details
 
 Below diagram is an overview of Kubelet using UpdateContainerResources and
@@ -454,3 +507,16 @@ _This section must be completed when targeting beta graduation to a release._
 - 2019-10-25 - Initial KEP draft created
 - 2020-01-14 - Test plan and graduation criteria added
 
+## Drawbacks
+
+<!--
+Why should this KEP _not_ be implemented?
+-->
+
+## Alternatives
+
+<!--
+What other approaches did you consider, and why did you rule them out? These do
+not need to be as detailed as the proposal, but should include enough
+information to express the idea and why it was not acceptable.
+-->
diff --git a/keps/sig-node/2273-kubelet-container-resources-cri-api-changes/kep.yaml b/keps/sig-node/2273-kubelet-container-resources-cri-api-changes/kep.yaml
@@ -5,33 +5,32 @@ authors:
   - "@quinton-hoole"
 owning-sig: sig-node
 participating-sigs:
+status: implementable
+creation-date: 2019-10-25
 reviewers:
   - "@Random-Liu"
   - "@yujuhong"
   - "@PatrickLang"
 approvers:
   - "@dchen1107"
   - "@derekwaynecarr"
-editor: TBD
-creation-date: 2019-10-25
-last-updated: 2020-01-14
-status: implementable
+prr-approvers:
+  - "@ehashman"
 see-also:
   - "/keps/sig-node/1287-in-place-update-pod-resources"
 replaces:
-superseded-by:
 
-# PRR
-prr-approvers:
-  - "@ehashman"
+stage: "alpha"
+
+latest-milestone: "v1.22"
+
+milestone:
+  alpha: "v1.22"
+  beta: "v1.24"
+  stable: "v1.26"
+
 feature-gates:
   - name: InPlacePodVerticalScaling
     components:
       - kubelet
 disable-supported: true
-milestone:
-  alpha: "v1.22"
-  beta: "v1.23"
-  stable: "v1.25"
-stage: "alpha"
-latest-milestone: "v1.22"