From 6898684b527c7003a0ae9d82914e64d2d38fc071 Mon Sep 17 00:00:00 2001 From: Carlos Panato Date: Wed, 9 Feb 2022 11:12:56 +0100 Subject: [PATCH] update based on feedback round 2 Signed-off-by: Carlos Panato --- .../README.md | 206 +----------------- .../kep.yaml | 17 +- 2 files changed, 15 insertions(+), 208 deletions(-) diff --git a/keps/sig-release/2853-kubernetes-kubernetes-repository-branch-rename/README.md b/keps/sig-release/2853-kubernetes-kubernetes-repository-branch-rename/README.md index 3a4671c47c7..dda553f286d 100644 --- a/keps/sig-release/2853-kubernetes-kubernetes-repository-branch-rename/README.md +++ b/keps/sig-release/2853-kubernetes-kubernetes-repository-branch-rename/README.md @@ -83,19 +83,9 @@ tags, and then generate with `hack/update-toc.sh`. - [Goals](#goals) - [Non-Goals](#non-goals) - [Proposal](#proposal) - - [User Stories (Optional)](#user-stories-optional) - - [Story 1](#story-1) - - [Story 2](#story-2) - - [Notes/Constraints/Caveats (Optional)](#notesconstraintscaveats-optional) - [Risks and Mitigations](#risks-and-mitigations) -- [Design Details](#design-details) - [Survey Questions](#survey-questions) - - [Test Plan](#test-plan) - [Graduation Criteria](#graduation-criteria) - - [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy) - - [Version Skew Strategy](#version-skew-strategy) -- [Production Readiness Review Questionnaire](#production-readiness-review-questionnaire) - - [Feature Enablement and Rollback](#feature-enablement-and-rollback) - [Rollout, Upgrade and Rollback Planning](#rollout-upgrade-and-rollback-planning) - [Monitoring Requirements](#monitoring-requirements) - [Dependencies](#dependencies) @@ -238,54 +228,16 @@ References: - https://github.com/github/renaming -### User Stories (Optional) - - -As a contributor, I have to remember to use `master` when working with repositories that -haven't yet switched. -Switching k/k to `main` will reduce the burden slightly. - - -#### Story 1 - -#### Story 2 - -### Notes/Constraints/Caveats (Optional) - - - ### Risks and Mitigations - + - Send out a survey to collect feedback and desire timeframe for the change + - Notify the community (via email k-dev and social media) when we plan the schedule and when it is approaching the change -## Design Details - #### Survey Questions 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 2. Would a kubernetes/kubernetes branch rename affect your downstream workflow? If yes, how? 3. How much time would you need in advance before the migration happens? -### Test Plan - - -N/A - ### Graduation Criteria -### Upgrade / Downgrade Strategy - - - -### Version Skew Strategy - - - -## Production Readiness Review Questionnaire - - - -### Feature Enablement and Rollback - - - -###### How can this feature be enabled / disabled in a live cluster? - - - -- [ ] Feature gate (also fill in values in `kep.yaml`) - - Feature gate name: - - Components depending on the feature gate: -- [ ] Other - - Describe the mechanism: - - Will enabling / disabling the feature require downtime of the control - plane? - - Will enabling / disabling the feature require downtime or reprovisioning - of a node? (Do not assume `Dynamic Kubelet Config` feature is enabled). - ###### Does enabling the feature change any default behavior? +As soon we rename the branch we do not have plans to rollback, but instead we will fix any possible issue right away. ###### How can a rollout or rollback fail? Can it impact already running workloads? @@ -542,55 +396,6 @@ logs or events for this purpose. --> N/A -###### How can someone using this feature know that it is working for their instance? - - - -- [ ] Events - - Event Reason: -- [ ] API .status - - Condition name: - - Other field: -- [ ] Other (treat as last resort) - - Details: - -###### What are the reasonable SLOs (Service Level Objectives) for the enhancement? - - - -###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service? - - - -- [ ] Metrics - - Metric name: - - [Optional] Aggregation method: - - Components exposing the metric: -- [ ] Other (treat as last resort) - - Details: - ###### Are there any missing metrics that would be useful to have to improve observability of this feature?