diff --git a/keps/sig-ui/5008-kep-template/README.md b/keps/sig-ui/5008-kep-template/README.md new file mode 100644 index 00000000000..b8a81bba246 --- /dev/null +++ b/keps/sig-ui/5008-kep-template/README.md @@ -0,0 +1,940 @@ + +# KEP-5008: Introducing Kubernetes Desktop + + + + + + +- [Release Signoff Checklist](#release-signoff-checklist) +- [Summary](#summary) +- [Motivation](#motivation) + - [Background](#background) + - [Feature Highlights](#feature-highlights) + - [Goals](#goals) + - [Non-Goals](#non-goals) +- [Proposal](#proposal) + - [User Stories (Optional)](#user-stories-optional) + - [Story 1](#story-1) + - [Story 2](#story-2) + - [Story 3](#story-2) + - [Story 4](#story-2) + - [Story 5](#story-2) + - [Story 6](#story-2) + - [Notes/Constraints/Caveats (Optional)](#notesconstraintscaveats-optional) + - [Risks and Mitigations](#risks-and-mitigations) +- [Design Details](#design-details) + - [Test Plan](#test-plan) + - [Prerequisite testing updates](#prerequisite-testing-updates) + - [Unit tests](#unit-tests) + - [Integration tests](#integration-tests) + - [e2e tests](#e2e-tests) + - [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) + - [Scalability](#scalability) + - [Troubleshooting](#troubleshooting) +- [Implementation History](#implementation-history) +- [Drawbacks](#drawbacks) +- [Alternatives](#alternatives) +- [Infrastructure Needed (Optional)](#infrastructure-needed-optional) + + +## Release Signoff Checklist + + + +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 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 + + + +[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 graphical user interface experience in +Kubernetes by introducing a Kubernetes Desktop application and an improved +in-cluster web user interface, both based on the [Headlamp](https://headlamp.dev) +project. + +## Motivation + + + +The driving motivation behind this proposal is to provide both a great out of +the box experience for end users and a foundation for vendors and other +projects to integrate with and build upon. Essentially, we think Headlamps' +ability to be adapted and used across many scenarios allows it to serve as a +central hub for the CNCF community and projects. + +### Background + +Headlamp is a Kubernetes UI that can run as a Desktop application and an +in-cluster web interface. It is designed to be extended using its robust plugin +system. This allows vendors or projects to adapt it to their use case and for +the project to deliver builds for various use cases. + +Headlamp is currently available in two versions: +* Headlamp refers to the project and the default distribution of Headlamp which + ships with core Kubernetes UI functionality (see the next bullet point) plus + a set of plugins that the project thinks are generally useful for all users + in order to provide a rich and relevant Kubernetes user experience. +* Headlamp Base does not include any plugins. It only includes features that + the project deems universally desired in a Kubernetes UI. This is designed + for builders looking to have a solid base on which to extend the user + experience. They would generally create custom plugins to customize the user + experience, include any existing plugins they desire and then theme the UI to + fit their branding. + +Each version is available as a desktop experience and an in-cluster experience. +For the default build, the set of plugins differs between the in-cluster and +desktop installations as there are different user profiles for each environment. +For example, the plugin that allows managing plugins is not included in the +in-cluster environment as the cluster admin generally determines which plugins +to provide to the cluster users. + +### Feature highlights + +Headlamp has a number of features that we think are interesting for users and +developers/vendors. Some of those are: +* A robust plugin system for customization and integrations; +* Supports both desktop and in-cluster modes; +* Under very active development, with dedicated resources assigned to it + in addition to the active external contributors; +* Built on a very common technology stack (Typescript, React, Material UI, + Vite, Go) +* Multi-cluster support +* Graph view, displaying a relational map of a clusters +* Access and easy set up of community plugins + +### Goals + + + +With this proposal we aim to provide the Kubernetes project with the following. +* A tool to more easily onboard new and beginner-level users +* A UI that serves as a base for vendors to build upon +* A more modern UI developer environment +* A more feature-rich UI +* A desktop user experience +* An integration point for other CNCF and external projects, especially those + without a UI focus + +### Non-Goals + + + +This proposal does not propose to force people who are using the current +Dashboard to move to Headlamp. + +## Proposal + + + +The proposal is to ship the Headlamp experience as a new Kubernetes Desktop +and in-cluster UI. + +Effectively this entails moving the Headlamp project under the Kubernetes +GitHub organization and under the auspices of Kubernetes SIG UI. To be +specific, we would propose that the Headlamp project be moved to a repo under +the Kubernetes project; something to the effect of kubernetes/ui. + +The Headlamp branding would be phased out. + +### User Stories + + + +One of Headlamp's strengths is that it was designed to both deliver a great +end-user experience and be a platform for others to build upon and integrate +with. This is demonstrated by the wide range of user stories it enables and one +of the reasons we believe it can become a hub for the community. + +_**Note:** Using “Headlamp” in the following examples to avoid confusion._ + +#### Story 1 + +As an end user I want to get an overview of my cluster. I start the Headlamp +Desktop app which picks up my clusters from my kubeconfig and I’m now able to +explore my clusters. + +#### Story 2 + +As a new Kubernetes user I want to learn more about Kubernetes. I use the +Headlamp Desktop app to guide me in installing a local kubernetes cluster using +minikube. Once my local cluster is installed I’m presented with a tutorial +plugin which guides me through the various aspects of the UI and Kubernetes +concepts. + +_**Note:** We have the minikube installer plugin in POC but the tutorial plugin +is not something we currently have._ + +#### Story 3 + +As a cluster admin I was to provide a user interface for my users. I choose +which plugins I want to include for my users and deploy Headlamp to my cluster. +I have peace of mind knowing that Headlamp respects the RBAC rules that each +user has. + +#### Story 4 + +As a vendor I want to create a new Kubernetes user interface for my system. I +take Headlamp Base and build a set of plugins and take some of the existing +plugins to create my custom UI. I customize the UI with my company/product +branding and provide that to my users with or without them knowing it’s +Headlamp. If I desire, I can even allow my users to extend my customer UI using +the same way I did. + +#### Story 5 + +As a CNCF or external project, I want to provide my users with a graphical +experience but I don’t want to provide a full blown UI. I create a plugin that +can be as simple as adding a column to a table (ex. OpenCost plugin) or as +complex as creating a dedicated view with a sidebar entry and integrations +across the various resource types (ex. Flux plugin). Example: See the OpenCost +and Flux plugins. + +#### Story 6 + +As a CNCF or external project I have a dedicated UI but that UI is not +providing a full Kubernetes context. To provide my users with a Kubernetes +context I create a link from my project to the Headlamp instance running in the +cluster and create a plugin for Headlamp that provides the user in context +views or links to my projects resources. This allows the user to easily +navigate between the projects. (E.g. Backstage plugin) + +### Notes/Constraints/Caveats (Optional) + + + +### Risks and Mitigations + + + +## Design Details + + + +### Test Plan + + + +[ ] I/we understand the owners of the involved components may require updates to +existing tests to make this code solid enough prior to committing the changes necessary +to implement this enhancement. + +##### Prerequisite testing updates + + + +##### Unit tests + + + + + +- ``: `` - `` + +##### Integration tests + + + + + +- : + +##### e2e tests + + + +- : + +### 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? + +###### Does enabling the feature change any default behavior? + + + +###### Can the feature be disabled once it has been enabled (i.e. can we roll back the enablement)? + + + +###### What happens if we reenable the feature if it was previously rolled back? + +###### Are there any tests for feature enablement/disablement? + + + +### Rollout, Upgrade and Rollback Planning + + + +###### How can a rollout or rollback fail? Can it impact already running workloads? + + + +###### What specific metrics should inform a rollback? + + + +###### Were upgrade and rollback tested? Was the upgrade->downgrade->upgrade path tested? + + + +###### Is the rollout accompanied by any deprecations and/or removals of features, APIs, fields of API types, flags, etc.? + + + +### Monitoring Requirements + + + +###### How can an operator determine if the feature is in use by workloads? + + + +###### 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? + + + +### Dependencies + + + +###### Does this feature depend on any specific services running in the cluster? + + + +### Scalability + + + +###### Will enabling / using this feature result in any new API calls? + + + +###### Will enabling / using this feature result in introducing new API types? + + + +###### Will enabling / using this feature result in any new calls to the cloud provider? + + + +###### Will enabling / using this feature result in increasing size or count of the existing API objects? + + + +###### Will enabling / using this feature result in increasing time taken by any operations covered by existing SLIs/SLOs? + + + +###### Will enabling / using this feature result in non-negligible increase of resource usage (CPU, RAM, disk, IO, ...) in any components? + + + +###### Can enabling / using this feature result in resource exhaustion of some node resources (PIDs, sockets, inodes, etc.)? + + + +### Troubleshooting + + + +###### How does this feature react if the API server and/or etcd is unavailable? + +###### What are other known failure modes? + + + +###### What steps should be taken if SLOs are not being met to determine the problem? + +## Implementation History + + + +## Drawbacks + + + +## Alternatives + + + +## Infrastructure Needed (Optional) + + diff --git a/keps/sig-ui/5008-kep-template/kep.yaml b/keps/sig-ui/5008-kep-template/kep.yaml new file mode 100644 index 00000000000..024f4253ded --- /dev/null +++ b/keps/sig-ui/5008-kep-template/kep.yaml @@ -0,0 +1,37 @@ +title: Kubernetes Desktop +kep-number: 5008 +authors: + - "@joaquimrocha" +owning-sig: sig-ui +participating-sigs: +status: provisional +creation-date: 2024-12-19 +reviewers: + - TBD +approvers: + - TBD + +see-also: +replaces: + +# The target maturity stage in the current dev cycle for this KEP. +stage: alpha|beta|stable + +# The most recent milestone for which work toward delivery of this KEP has been +# done. This can be the current (upcoming) milestone, if it is being actively +# worked on. +latest-milestone: "v1.19" + +# The milestone at which this feature was, or is targeted to be, at each stage. +milestone: + alpha: "v1.19" + beta: "v1.20" + stable: "v1.22" + +# The following PRR answers are required at alpha release +# List the feature gate name and the components for which it must be enabled +feature-gates: +disable-supported: true + +# The following PRR answers are required at beta release +metrics: