Enhancement tracking repository for OKD.
Inspired by the Kubernetes enhancement process.
This repository provides a rally point to discuss, debate, and reach consensus for how OKD enhancements are introduced. OKD combines Kubernetes container orchestration services with a broad set of ecosystem components in order to provide an enterprise ready Kubernetes distribution built for extension. OKD assembles innovation across a wide array of repositories and upstream communities. Given the breadth of the distribution, it is useful to have a centralized place to describe OKD enhancements via an actionable design proposal.
Enhancements may take multiple releases to ultimately complete and thus provide the basis of a community roadmap. Enhancements may be filed from anyone in the community, but require consensus from domain specific project maintainers in order to implement and accept into the release.
For an overview of the whole project, see the roadmap. For a quick-start, FAQ, and template references, see the guidelines.
A rough heuristic for an enhancement is anything that:
- impacts how a cluster is operated including addition or removal of significant capabilities
- impacts upgrade/downgrade
- needs significant effort to complete
- requires consensus/code across multiple domains/repositories
- proposes adding a new user-facing component
- has phases of maturity (Dev Preview, Tech Preview, GA)
- demands formal documentation to utilize
It is unlikely to require an enhancement if it:
- fixes a bug
- adds more testing
- internally refactors a code or component only visible to that components domain
- minimal impact to distribution as a whole
If you are not sure if the proposed work requires an enhancement, file an issue and ask!
Create an enhancement here once you:
- have circulated your idea to see if there is interest
- (optionally) have done a prototype in your own fork
- have identified people who agree to work on and maintain the enhancement
- many enhancements will take several releases to complete
As the project evolves, its important that the OKD community understands how we build, test, and document our work. Individually it is hard to understand how all parts of the system interact, but as a community we can lean on each other to build the right design and approach before getting too deep into an implementation.
Please comment on the enhancement issue to:
- request a review or clarification on the process
- update status of the enhancement effort
- link to relevant issues in other repos
Please do not comment on the enhancement issue to:
- discuss a detail of the design, code or docs. Use a linked-to-issue or design PR for that
The following labels may be applied to enhancements to help categorize them:
priority/important-soonindicates that the enhancement is related to a top level release priority. These will be highlighted in the this-week newsletters.
Pull requests to this repository should be short-lived and merged as soon as there is consensus. Therefore, the normal life-cycle timeouts are shorter than for most of our code repositories.
Pull requests being actively discussed will stay open
indefinitely. Inactive pull requests will automatically have the
life-cycle/stale label applied after 28 days. Removing the
life-cycle label will reset the clock. After 7 days, stale pull
requests are updated to life-cycle/rotten. After another 7 days,
rotten pull requests are closed.
Ideally pull requests with enhancement proposals will be merged before significant coding work begins, since this avoids having to rework the implementation if the design changes as well as arguing in favor of accepting a design simply because it is already implemented.
From time to time the template for enhancement proposals is modified as we refine our processes. When that happens, open pull requests may start failing the linter job that ensures that all documents include the required sections.
If you are working on an enhancement and the linter job fails because of changes to the template (not other issues with the markdown formatting), handle it based on the maturity of the enhancement PR:
- If the only reason to update your PR is to make the linter job accept it after a template change and there are no substantive content changes needed for approval, override the job to allow the PR to merge.
- If your enhancement is still a draft, and consensus hasn't been reached, modify the PR so the new enhancement matches the updated template.
- If you are updating an existing (merged) document, go ahead and override the job.