The Kubernetes project leverages multiple GitHub organizations to store and organize code. This guide contains the details on how to run those organizations for CNCF compliance and for the guidelines of the community.
Kubernetes managed organizations should be in the form of
For example, kubernetes-client where the
API clients are housed.
Prior to creating an organization please contact the steering committee for direction and approval.
Note: The CNCF, as part of the Linux Foundation, holds the trademark on the Kubernetes name. All GitHub organizations with Kubernetes in the name should be managed by the Kubernetes project or use a different name.
Due to licensing and CLA issues, prior to transferring software into a Kubernetes managed organization there is some due diligence that needs to occur. Please contact the steering committee and CNCF prior to moving any code in.
It is easier to start new code in a Kubernetes organization than it is to transfer in existing code.
Each organization should have the following teams:
foo-admins: granted admin access to the
foo-maintainers: granted write access to the
foo-reviewers: granted read access to the
foorepo; intended to be used as a notification mechanism for interested/active contributors for the
ownerprivileges to the org
NB: Not all organizations in use today currently follow this team guidance. We are looking to coalesce existing teams towards this model, and use this model for all orgs going forward. Notable discrepancies at the moment:
foo-reviewersteams are considered a historical subset of
kubernetes-sig-foo-pr-reviewsteams and are intended mostly as a fallback notification mechanism when requested reviewers are being unresponsive. Ideally OWNERS files can be used in lieu of these teams.
maintainers-footeams as used by the kubernetes-incubator org. This was a mistake that swapped the usual convention, and we would like to rename the team
Repositories have additional guidelines and requirements, such as the use of CLA checking on all contributions. For more details on those please see the Kubernetes Template Project, and the Repository Guidelines