/k8s-enhancements

Feature tracking repo for Kubernetes releases

Apache License 2.0Apache-2.0

Feature Tracking and Backlog

Feature tracking repo for Kubernetes releases

This repo only contains issues. These issues are umbrellas for new features to be added to Kubernetes. A feature usually takes multiple releases to complete. And a feature can be tracked as backlog items before work begins. A feature may be filed once there is consensus in at least one Kubernetes SIG.

Is My Thing a Feature?

We are trying to figure out the exact shape of a feature. Until then here are a few rough heuristics.

A feature is anything that:

  • a blog post would be written about after its release (ex. minikube, StatefulSets, rkt container runtime)
  • requires multiple parties/SIGs/owners participating to complete (ex. GPU scheduling [API, Core, & Node], StatefulSets [Storage & API])
  • needs significant effort or changes Kubernetes in a significant way (ex. something that would take 10 person-weeks to implement, introduce or redesign a system component, or introduces API changes)
  • impacts the UX or operation of Kubernetes substantially such that engineers using Kubernetes will need retraining
  • users will notice and come to rely on

It is unlikely a feature if it is:

  • implemented using ThirdPartyResource and/or in https://github.com/kubernetes/contrib
  • fixing a flaky test
  • refactoring code
  • performance improvements, which are only visible to users as faster API operations, or faster control loops
  • adding error messages or events

If you are not sure, ask someone in the SIG where you initially circulated the idea. If they aren't sure jump into #kubernetes-pm on Slack or ping someone listed in OWNERS.

When to Create a New Feature Issue

Create an issue here once you:

  • have circulated your idea to see if there is interest
    • through Community Meetings, SIG meetings, SIG mailing lists, or an issue in github.com/kubernetes/kubernetes
  • (optionally) have done a prototype in your own fork
  • have identified people who agree to work on the feature
    • many features will take several releases to progress through Alpha, Beta, and Stable stages
    • you and your team should be prepared to work on the approx. 9mo - 1 year that it takes to progress to Stable status
  • are ready to be the project-manager for the feature

Why are Features Tracked

Once users adopt a feature, they expect to use it for an extended period of time. Therefore, we hold new features to a high standard of conceptual integrity and require consistency with other parts of the system, thorough testing, and complete documentation. As the project grows no single person can track whether all those requirements are met. The development of a feature often spans three stages: Alpha, Beta, and Stable; feature Tracking Issues provide a checklist that allows for different approvers for different aspects, and ensures that nothing is forgotten across the development lifetime of a feature.

When to Comment on a Feature Issue

Please comment on the feature issue to:

  • request a review or clarification on the process
  • update status of the feature effort
  • link to relevant issues in other repos

Please do not comment on the feature issue to:

  • discuss a detail of the design, code or docs. Use a linked-to-issue or PR for that