Skip to content

Commit 58e1fa3

Browse files
committed
Update to latest template
1 parent 33c76cc commit 58e1fa3

File tree

1 file changed

+63
-17
lines changed

1 file changed

+63
-17
lines changed

keps/sig-cli/3805-ssa-default/README.md

Lines changed: 63 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
<!--
2-
31
# KEP-3805: Server-Side Apply default in Kubectl
42

53
<!-- toc -->
@@ -16,6 +14,10 @@
1614
- [Risks and Mitigations](#risks-and-mitigations)
1715
- [Design Details](#design-details)
1816
- [Test Plan](#test-plan)
17+
- [Prerequisite testing updates](#prerequisite-testing-updates)
18+
- [Unit tests](#unit-tests)
19+
- [Integration tests](#integration-tests)
20+
- [e2e tests](#e2e-tests)
1921
- [Graduation Criteria](#graduation-criteria)
2022
- [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
2123
- [Version Skew Strategy](#version-skew-strategy)
@@ -41,7 +43,7 @@ Items marked with (R) are required *prior to targeting to a milestone / release*
4143
- [ ] (R) Design details are appropriately documented
4244
- [ ] (R) Test plan is in place, giving consideration to SIG Architecture and SIG Testing input (including test refactors)
4345
- [ ] e2e Tests for all Beta API Operations (endpoints)
44-
- [ ] (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)
46+
- [ ] (R) Ensure GA e2e tests meet requirements for [Conformance Tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md)
4547
- [ ] (R) Minimum Two Week Window for GA e2e tests to prove flake free
4648
- [ ] (R) Graduation criteria is in place
4749
- [ ] (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)
@@ -164,37 +166,80 @@ proposal will be implemented, this is the place to discuss them.
164166

165167
### Test Plan
166168

169+
[x] I/we understand the owners of the involved components may require updates to
170+
existing tests to make this code solid enough prior to committing the changes necessary
171+
to implement this enhancement.
172+
173+
##### Prerequisite testing updates
174+
167175
<!--
168-
**Note:** *Not required until targeted at a release.*
176+
Based on reviewers feedback describe what additional tests need to be added prior
177+
implementing this enhancement to ensure the enhancements have also solid foundations.
178+
-->
179+
180+
##### Unit tests
181+
182+
<!--
183+
In principle every added code should have complete unit test coverage, so providing
184+
the exact set of tests will not bring additional value.
185+
However, if complete unit test coverage is not possible, explain the reason of it
186+
together with explanation why this is acceptable.
187+
-->
188+
189+
<!--
190+
Additionally, for Alpha try to enumerate the core package you will be touching
191+
to implement this enhancement and provide the current unit coverage for those
192+
in the form of:
193+
- <package>: <date> - <current test coverage>
194+
The data can be easily read from:
195+
https://testgrid.k8s.io/sig-testing-canaries#ci-kubernetes-coverage-unit
196+
197+
This can inform certain test coverage improvements that we want to do before
198+
extending the production code to implement this enhancement.
199+
-->
169200

170-
Consider the following in developing a test plan for this enhancement:
171-
- Will there be e2e and integration tests, in addition to unit tests?
172-
- How will it be tested in isolation vs with other components?
201+
- `<package>`: `<date>` - `<test coverage>`
173202

174-
No need to outline all of the test cases, just the general strategy. Anything
175-
that would count as tricky in the implementation, and anything particularly
176-
challenging to test, should be called out.
203+
##### Integration tests
177204

178-
All code is expected to have adequate tests (eventually with coverage
179-
expectations). Please adhere to the [Kubernetes testing guidelines][testing-guidelines]
180-
when drafting this test plan.
205+
<!--
206+
This question should be filled when targeting a release.
207+
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
181208
182-
[testing-guidelines]: https://git.k8s.io/community/contributors/devel/sig-testing/testing.md
209+
For Beta and GA, add links to added tests together with links to k8s-triage for those tests:
210+
https://storage.googleapis.com/k8s-triage/index.html
183211
-->
184212

213+
- <test>: <link to test coverage>
214+
215+
##### e2e tests
216+
217+
<!--
218+
This question should be filled when targeting a release.
219+
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
220+
221+
For Beta and GA, add links to added tests together with links to k8s-triage for those tests:
222+
https://storage.googleapis.com/k8s-triage/index.html
223+
224+
We expect no non-infra related flakes in the last month as a GA graduation criteria.
225+
-->
226+
227+
- <test>: <link to test coverage>
228+
185229
### Graduation Criteria
186230

187231
<!--
188232
**Note:** *Not required until targeted at a release.*
189233
190234
Define graduation milestones.
191235
192-
These may be defined in terms of API maturity, or as something else. The KEP
193-
should keep this high-level with a focus on what signals will be looked at to
194-
determine graduation.
236+
These may be defined in terms of API maturity, [feature gate] graduations, or as
237+
something else. The KEP should keep this high-level with a focus on what
238+
signals will be looked at to determine graduation.
195239
196240
Consider the following in developing the graduation criteria for this enhancement:
197241
- [Maturity levels (`alpha`, `beta`, `stable`)][maturity-levels]
242+
- [Feature gate][feature gate] lifecycle
198243
- [Deprecation policy][deprecation-policy]
199244
200245
Clearly define what graduation means by either linking to the [API doc
@@ -204,6 +249,7 @@ or by redefining what graduation means.
204249
In general we try to use the same stages (alpha, beta, GA), regardless of how the
205250
functionality is accessed.
206251
252+
[feature gate]: https://git.k8s.io/community/contributors/devel/sig-architecture/feature-gates.md
207253
[maturity-levels]: https://git.k8s.io/community/contributors/devel/sig-architecture/api_changes.md#alpha-beta-and-stable-versions
208254
[deprecation-policy]: https://kubernetes.io/docs/reference/using-api/deprecation-policy/
209255

0 commit comments

Comments
 (0)