Skip to content

Commit 318a83a

Browse files
committed
Update KEP 3157 to use the latest template
1 parent 281d88e commit 318a83a

File tree

1 file changed

+73
-11
lines changed
  • keps/sig-api-machinery/3157-watch-list

1 file changed

+73
-11
lines changed

keps/sig-api-machinery/3157-watch-list/README.md

Lines changed: 73 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,12 @@ tags, and then generate with `hack/update-toc.sh`.
9393
- [Required changes for a WATCH request with the RV set to the last observed value (RV > 0)](#required-changes-for-a-watch-request-with-the-rv-set-to-the-last-observed-value-rv--0)
9494
- [Provide a fix for the long-standing issue <a href="https://github.com/kubernetes/kubernetes/issues/59848">https://github.com/kubernetes/kubernetes/issues/59848</a>](#provide-a-fix-for-the-long-standing-issue-httpsgithubcomkuberneteskubernetesissues59848)
9595
- [Test Plan](#test-plan)
96+
- [Prerequisite testing updates](#prerequisite-testing-updates)
97+
- [Unit tests](#unit-tests)
98+
- [Integration tests](#integration-tests)
99+
- [e2e tests](#e2e-tests)
96100
- [Graduation Criteria](#graduation-criteria)
101+
- [Alpha](#alpha)
97102
- [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
98103
- [Version Skew Strategy](#version-skew-strategy)
99104
- [Production Readiness Review Questionnaire](#production-readiness-review-questionnaire)
@@ -575,19 +580,9 @@ Then on the server side we:
575580
4. otherwise, construct the final list and send back to a client.
576581

577582
### Test Plan
578-
- unit tests for new code added to the watch cache were implemented.
579-
- unit tests for new code added to the reflector were implemented.
580-
- integration tests asserting fallback mechanism for reflector were added.
581583
<!--
582584
**Note:** *Not required until targeted at a release.*
583-
584-
Consider the following in developing a test plan for this enhancement:
585-
- Will there be e2e and integration tests, in addition to unit tests?
586-
- How will it be tested in isolation vs with other components?
587-
588-
No need to outline all of the test cases, just the general strategy. Anything
589-
that would count as tricky in the implementation, and anything particularly
590-
challenging to test, should be called out.
585+
The goal is to ensure that we don't accept enhancements with inadequate testing.
591586
592587
All code is expected to have adequate tests (eventually with coverage
593588
expectations). Please adhere to the [Kubernetes testing guidelines][testing-guidelines]
@@ -596,6 +591,61 @@ when drafting this test plan.
596591
[testing-guidelines]: https://git.k8s.io/community/contributors/devel/sig-testing/testing.md
597592
-->
598593

594+
[X] I/we understand the owners of the involved components may require updates to
595+
existing tests to make this code solid enough prior to committing the changes necessary
596+
to implement this enhancement.
597+
598+
##### Prerequisite testing updates
599+
600+
<!--
601+
Based on reviewers feedback describe what additional tests need to be added prior
602+
implementing this enhancement to ensure the enhancements have also solid foundations.
603+
-->
604+
605+
##### Unit tests
606+
<!--
607+
In principle every added code should have complete unit test coverage, so providing
608+
the exact set of tests will not bring additional value.
609+
However, if complete unit test coverage is not possible, explain the reason of it
610+
together with explanation why this is acceptable.
611+
-->
612+
613+
<!--
614+
Additionally, for Alpha try to enumerate the core package you will be touching
615+
to implement this enhancement and provide the current unit coverage for those
616+
in the form of:
617+
- <package>: <date> - <current test coverage>
618+
The data can be easily read from:
619+
https://testgrid.k8s.io/sig-testing-canaries#ci-kubernetes-coverage-unit
620+
621+
This can inform certain test coverage improvements that we want to do before
622+
extending the production code to implement this enhancement.
623+
-->
624+
- k8s.io/apiserver/pkg/storage/cacher: 02/02/2023 - 74,7%
625+
- k8s.io/client-go/tools/cache/reflector: 02/02/2023 - 88,6%
626+
627+
##### Integration tests
628+
<!--
629+
This question should be filled when targeting a release.
630+
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
631+
632+
For Beta and GA, add links to added tests together with links to k8s-triage for those tests:
633+
https://storage.googleapis.com/k8s-triage/index.html
634+
-->
635+
- For alpha, tests asserting fallback mechanism for reflector will be added.
636+
637+
##### e2e tests
638+
<!--
639+
This question should be filled when targeting a release.
640+
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
641+
642+
For Beta and GA, add links to added tests together with links to k8s-triage for those tests:
643+
https://storage.googleapis.com/k8s-triage/index.html
644+
645+
We expect no non-infra related flakes in the last month as a GA graduation criteria.
646+
-->
647+
- For alpha, tests exercising this feature will be added.
648+
599649
### Graduation Criteria
600650

601651
#### Alpha
@@ -984,6 +1034,18 @@ This through this both in small and large cases, again with respect to the
9841034
[supported limits]: https://git.k8s.io/community//sig-scalability/configs-and-limits/thresholds.md
9851035
-->
9861036

1037+
###### Can enabling / using this feature result in resource exhaustion of some node resources (PIDs, sockets, inodes, etc.)?
1038+
<!--
1039+
Focus not just on happy cases, but primarily on more pathological cases
1040+
(e.g. probes taking a minute instead of milliseconds, failed pods consuming resources, etc.).
1041+
If any of the resources can be exhausted, how this is mitigated with the existing limits
1042+
(e.g. pods per node) or new limits added by this KEP?
1043+
1044+
Are there any tests that were run/should be run to understand performance characteristics better
1045+
and validate the declared limits?
1046+
-->
1047+
On the contrary. It will decrease the memory usage required for master nodes.
1048+
9871049
### Troubleshooting
9881050

9891051
<!--

0 commit comments

Comments
 (0)