@@ -83,19 +83,9 @@ tags, and then generate with `hack/update-toc.sh`.
83
83
- [ Goals] ( #goals )
84
84
- [ Non-Goals] ( #non-goals )
85
85
- [ Proposal] ( #proposal )
86
- - [ User Stories (Optional)] ( #user-stories-optional )
87
- - [ Story 1] ( #story-1 )
88
- - [ Story 2] ( #story-2 )
89
- - [ Notes/Constraints/Caveats (Optional)] ( #notesconstraintscaveats-optional )
90
86
- [ Risks and Mitigations] ( #risks-and-mitigations )
91
- - [ Design Details] ( #design-details )
92
87
- [ Survey Questions] ( #survey-questions )
93
- - [ Test Plan] ( #test-plan )
94
88
- [ Graduation Criteria] ( #graduation-criteria )
95
- - [ Upgrade / Downgrade Strategy] ( #upgrade--downgrade-strategy )
96
- - [ Version Skew Strategy] ( #version-skew-strategy )
97
- - [ Production Readiness Review Questionnaire] ( #production-readiness-review-questionnaire )
98
- - [ Feature Enablement and Rollback] ( #feature-enablement-and-rollback )
99
89
- [ Rollout, Upgrade and Rollback Planning] ( #rollout-upgrade-and-rollback-planning )
100
90
- [ Monitoring Requirements] ( #monitoring-requirements )
101
91
- [ Dependencies] ( #dependencies )
@@ -238,54 +228,16 @@ References:
238
228
239
229
- https://github.com/github/renaming
240
230
241
- ### User Stories (Optional)
242
-
243
- <!--
244
- Detail the things that people will be able to do if this KEP is implemented.
245
- Include as much detail as possible so that people can understand the "how" of
246
- the system. The goal here is to make this feel real for users without getting
247
- bogged down.
248
- -->
249
- As a contributor, I have to remember to use ` master ` when working with repositories that
250
- haven't yet switched.
251
- Switching k/k to ` main ` will reduce the burden slightly.
252
-
253
-
254
- #### Story 1
255
-
256
- #### Story 2
257
-
258
- ### Notes/Constraints/Caveats (Optional)
259
-
260
- <!--
261
- What are the caveats to the proposal?
262
- What are some important details that didn't come across above?
263
- Go in to as much detail as necessary here.
264
- This might be a good place to talk about core concepts and how they relate.
265
- -->
266
-
267
231
### Risks and Mitigations
268
232
269
- <!--
270
- What are the risks of this proposal, and how do we mitigate? Think broadly.
271
- For example, consider both security and how this will impact the larger
272
- Kubernetes ecosystem.
233
+ - ** Risk:** The branch rename may break downstream consumers
273
234
274
- How will security be reviewed, and by whom?
235
+ ** Mitigations: **
275
236
276
- How will UX be reviewed, and by whom?
277
-
278
- Consider including folks who also work outside the SIG or subproject.
279
- -->
237
+ - Send out a survey to collect feedback and desire timeframe for the change
238
+ - Notify the community (via email k-dev and social media) when we plan the schedule and when it is approaching the change
280
239
281
- ## Design Details
282
240
283
- <!--
284
- This section should contain enough information that the specifics of your
285
- change are understandable. This may include API specs (though not always
286
- required) or even code snippets. If there's any ambiguity about HOW your
287
- proposal will be implemented, this is the place to discuss them.
288
- -->
289
241
#### Survey Questions
290
242
291
243
The survey we will send out to gether information from the downstream consumer will have the following questions:
@@ -294,27 +246,6 @@ The survey we will send out to gether information from the downstream consumer w
294
246
2 . Would a kubernetes/kubernetes branch rename affect your downstream workflow? If yes, how?
295
247
3 . How much time would you need in advance before the migration happens?
296
248
297
- ### Test Plan
298
-
299
- <!--
300
- **Note:** *Not required until targeted at a release.*
301
-
302
- Consider the following in developing a test plan for this enhancement:
303
- - Will there be e2e and integration tests, in addition to unit tests?
304
- - How will it be tested in isolation vs with other components?
305
-
306
- No need to outline all of the test cases, just the general strategy. Anything
307
- that would count as tricky in the implementation, and anything particularly
308
- challenging to test, should be called out.
309
-
310
- All code is expected to have adequate tests (eventually with coverage
311
- expectations). Please adhere to the [Kubernetes testing guidelines][testing-guidelines]
312
- when drafting this test plan.
313
-
314
- [testing-guidelines]: https://git.k8s.io/community/contributors/devel/sig-testing/testing.md
315
- -->
316
- N/A
317
-
318
249
### Graduation Criteria
319
250
320
251
<!--
@@ -377,81 +308,6 @@ in back-to-back releases.
377
308
- Deprecate the flag
378
309
-->
379
310
380
- ### Upgrade / Downgrade Strategy
381
-
382
- <!--
383
- If applicable, how will the component be upgraded and downgraded? Make sure
384
- this is in the test plan.
385
-
386
- Consider the following in developing an upgrade/downgrade strategy for this
387
- enhancement:
388
- - What changes (in invocations, configurations, API use, etc.) is an existing
389
- cluster required to make on upgrade, in order to maintain previous behavior?
390
- - What changes (in invocations, configurations, API use, etc.) is an existing
391
- cluster required to make on upgrade, in order to make use of the enhancement?
392
- -->
393
-
394
- ### Version Skew Strategy
395
-
396
- <!--
397
- If applicable, how will the component handle version skew with other
398
- components? What are the guarantees? Make sure this is in the test plan.
399
-
400
- Consider the following in developing a version skew strategy for this
401
- enhancement:
402
- - Does this enhancement involve coordinating behavior in the control plane and
403
- in the kubelet? How does an n-2 kubelet without this feature available behave
404
- when this feature is used?
405
- - Will any other components on the node change? For example, changes to CSI,
406
- CRI or CNI may require updating that component before the kubelet.
407
- -->
408
-
409
- ## Production Readiness Review Questionnaire
410
-
411
- <!--
412
-
413
- Production readiness reviews are intended to ensure that features merging into
414
- Kubernetes are observable, scalable and supportable; can be safely operated in
415
- production environments, and can be disabled or rolled back in the event they
416
- cause increased failures in production. See more in the PRR KEP at
417
- https://git.k8s.io/enhancements/keps/sig-architecture/1194-prod-readiness.
418
-
419
- The production readiness review questionnaire must be completed and approved
420
- for the KEP to move to `implementable` status and be included in the release.
421
-
422
- In some cases, the questions below should also have answers in `kep.yaml`. This
423
- is to enable automation to verify the presence of the review, and to reduce review
424
- burden and latency.
425
-
426
- The KEP must have a approver from the
427
- [`prod-readiness-approvers`](http://git.k8s.io/enhancements/OWNERS_ALIASES)
428
- team. Please reach out on the
429
- [#prod-readiness](https://kubernetes.slack.com/archives/CPNHUMN74) channel if
430
- you need any help or guidance.
431
- -->
432
-
433
- ### Feature Enablement and Rollback
434
-
435
- <!--
436
- This section must be completed when targeting alpha to a release.
437
- -->
438
-
439
- ###### How can this feature be enabled / disabled in a live cluster?
440
-
441
- <!--
442
- Pick one of these and delete the rest.
443
- -->
444
-
445
- - [ ] Feature gate (also fill in values in ` kep.yaml ` )
446
- - Feature gate name:
447
- - Components depending on the feature gate:
448
- - [ ] Other
449
- - Describe the mechanism:
450
- - Will enabling / disabling the feature require downtime of the control
451
- plane?
452
- - Will enabling / disabling the feature require downtime or reprovisioning
453
- of a node? (Do not assume ` Dynamic Kubelet Config ` feature is enabled).
454
-
455
311
###### Does enabling the feature change any default behavior?
456
312
457
313
<!--
@@ -485,9 +341,7 @@ conversion tests if API types are being modified.
485
341
486
342
### Rollout, Upgrade and Rollback Planning
487
343
488
- <!--
489
- This section must be completed when targeting beta to a release.
490
- -->
344
+ As soon we rename the branch we do not have plans to rollback, but instead we will fix any possible issue right away.
491
345
492
346
###### How can a rollout or rollback fail? Can it impact already running workloads?
493
347
@@ -542,55 +396,6 @@ logs or events for this purpose.
542
396
-->
543
397
N/A
544
398
545
- ###### How can someone using this feature know that it is working for their instance?
546
-
547
- <!--
548
- For instance, if this is a pod-related feature, it should be possible to determine if the feature is functioning properly
549
- for each individual pod.
550
- Pick one more of these and delete the rest.
551
- Please describe all items visible to end users below with sufficient detail so that they can verify correct enablement
552
- and operation of this feature.
553
- Recall that end users cannot usually observe component logs or access metrics.
554
- -->
555
-
556
- - [ ] Events
557
- - Event Reason:
558
- - [ ] API .status
559
- - Condition name:
560
- - Other field:
561
- - [ ] Other (treat as last resort)
562
- - Details:
563
-
564
- ###### What are the reasonable SLOs (Service Level Objectives) for the enhancement?
565
-
566
- <!--
567
- This is your opportunity to define what "normal" quality of service looks like
568
- for a feature.
569
-
570
- It's impossible to provide comprehensive guidance, but at the very
571
- high level (needs more precise definitions) those may be things like:
572
- - per-day percentage of API calls finishing with 5XX errors <= 1%
573
- - 99% percentile over day of absolute value from (job creation time minus expected
574
- job creation time) for cron job <= 10%
575
- - 99.9% of /health requests per day finish with 200 code
576
-
577
- These goals will help you determine what you need to measure (SLIs) in the next
578
- question.
579
- -->
580
-
581
- ###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
582
-
583
- <!--
584
- Pick one more of these and delete the rest.
585
- -->
586
-
587
- - [ ] Metrics
588
- - Metric name:
589
- - [ Optional] Aggregation method:
590
- - Components exposing the metric:
591
- - [ ] Other (treat as last resort)
592
- - Details:
593
-
594
399
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
595
400
596
401
<!--
@@ -739,6 +544,7 @@ For each of them, fill in the following information by copying the below templat
739
544
## Implementation History
740
545
741
546
- 2021-11-18 Initial Draft
547
+ - 2022-02-09 Updates based on review/feedback
742
548
743
549
<!--
744
550
Major milestones in the lifecycle of a KEP should be tracked in this section.
0 commit comments