Community
GitHub
The Kyverno source code and project artifacts are managed on GitHub in the Kyverno organization.
Slack Channel
Join the Kubernetes slack workspace at https://slack.k8s.io/ and then search for the #kyverno channel.
If you already have access to the Kubernetes slack workspace simply select sign in at https://slack.k8s.io/#kyverno.
Community Meetings
To attend our community meetings, join the Kyverno group. You will then be sent a meeting invite and will have access to the agenda and meeting notes (feel free to suggest topics!)
End Users Meeting
This is a monthly meeting for Kyverno community meeting for new feature demos and road map discussions:
- Monthly on the third Wednesday at 9:00 AM PST
- Agenda and meeting notes
Contributors Meeting
This is a weekly forum for Kyverno contributors and maintainers to discuss project delivery and implementation topics such as feature designs, fixes, code, and documentation:
- Weekly every Thursday at 9:00 AM PST
- Agenda and meeting notes
Get in touch
If you are unable to attend a community meeting, feel free to reach out anytime on the Kyverno slack channel in the Kubernetes workspace, or the Kyverno mailing list.
We love hearing from our community!
Contributing
Thanks for your interest in contributing! We welcome all types of contributions and encourage you to read our contribution guidelines for next steps.
The project contributors use GitHub discussions for all implementation and project internal topics and the GitHub Wiki for design documents, notes on the dev environment, project guidelines and best practices.
Join Kyverno Adopters
Kyverno is currently a CNCF sandbox project is growing fast. To qualify for the incubation level the CNCF requires production usage by multiple end users.
The goal of this adopters program is to gather real-world usage examples and help Kyverno achieve the incubating state criteria. We hope to achieve this by learning from the existing and new adopters of Kyverno who are willing to share their stories with CNCF. The adopters can remain private or choose to be listed in the public Adopters List.
To participate, kindly fill out this form (It will take 5 mins of your time).
Project Governance
This document highlights the role and responsibilities for the Kyverno community members. It also outlines the requirements for anyone who is looking to take on leadership roles in the Kyverno project.
In order to perform any actions on the Kyverno Github repositories, contributors should have certain access to GitHub, such as creating a pull request in a repository or changing an organization’s billing settings, a contributor must have sufficient access to the relevant account or resource.
Note: Please make sure to read and observe our Code of Conduct.
Project Roles
Contributors:
These are active contributors who have made multiple contributions to the project; by authoring PRs, commenting on issues and pull requests or or participating in community discussions on Slack or the mailing list.
Approver:
These are active contributors who have good experience and knowledge of the project. They are expected to proactively manage issues and pull requests without write access.
Maintainer:
They are approvers who have shown good technical judgement in feature design/development in the past. Has overall knowledge of the project and features in the project. Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings.
Admin:
These are persons who have full access to the project, including sensitive and destructive actions like managing security or deleting a repository. Can read, clone, and push to this repository. Can also manage issues, pull requests, and repository settings, including adding collaborators.
| Role | Responsibilities | Requirements | Defined by |
|---|---|---|---|
| Contributors | active contributor in the community. reviewer of PRs | made at least five contributions to the project & appointed by 2 approvers or maintainers. | CODEOWNERS, Github Org members. |
| Approver | assist maintainers Review & approve contributions | highly experienced and active reviewer + contributor to a subproject. | Maintainers & CODEOWNERS. |
| Maintainer | monitor project growth, set direction and priorities for a subproject | highly experienced and active reviewer + Kyverno Certification + Voted by Kyverno maintainers | Voted in by the Kyverno maintainers, CODEOWNERS & Repository owner. |
Contributors
Contributors are project members who are continuously active in the community. They can have issues and PRs assigned to them and remain active contributors to the community.
Checklist before becoming a Project Member
- Create pull requests for code changes.
- Respond to reviews from maintainers on pull requests.
- Attend community and project meetups..
- Register for mailing lists.
- Always tries to find ways to help.
- Actively contributing to 1 or more subprojects.
Responsibilities & Privileges
- Have an issue assigned to them.
- Authoring PRs.
- Open issues.
- Close issues they opened themselves Submit reviews on pull requests.
Approvers
Approvers are contributors who provide active review and feedback on the issues and PRs. While code review is focused on code quality and correctness, approval is focused on holistic acceptance of a contribution including backwards and forwards compatibility, adhering to API and flag conventions, subtle performance and correctness issues, interactions with other parts of the system. Approvers are encouraged to be active participants in project meetings, chat rooms, and other discussion forums.
Checklist before becoming an Approver
- Consistently monitors project activities such as issues created, new PR.
- Has been active on the project for over 2 months.
- Successfully reviewed project codebase for at least 1 month.
- Has an in-depth understanding of the project’s codebase.
- Sponsored by at least 2 maintainers.
Responsibilities & Privileges
- Understands the project goals and workflows defined by maintainers.
- Creates new issues according to the project requirements.
- Assign issues to contributors.
- Responds to new PRs and issues by asking clarifying questions.
- Organizes the backlog by applying labels, milestones, assignees, and projects.
- Is readily available to review and approve PRs, by making meaningful suggestions.
- Applies code of conduct to edit and delete any inappropriate comments on commits, pull requests, and issues.
Maintainers
Maintainers are the technical authority for a subproject. They MUST have demonstrated both good judgement and responsibility towards the health of that subproject. Maintainers MUST set technical direction and make or approve design decisions for their subproject - either directly or through delegation of these responsibilities.
Checklist before becoming a Project Maintainer:
- Proficient in GitHub, YAML, Markdown & Git.
- Exhibits strong attention to detail when reviewing commits and provides generous guidance and feedback.
- Helps others achieve their goals with open-source and community contributions.
- Understands the workflow of the Issues and Pull Requests.
- Makes consistent contributions to the Kyverno project.
- Consistently initiates and participates in Kyverno discussions.
- Has knowledge and interest that aligns with the overall project goals, specifications and design principles of the Kyverno project.
- Makes contributions that are considered notable.
- Creates at least 10 PRs.
- Creates at least 5 issues.
- Provides at least 10 comments or reviews.
- Demonstrates ability to help troubleshoot and resolve user issues.
- Has taken the Kyverno Certification, or demonstrated sound understanding of Kyverno.
Responsibilities & Privileges
The following responsibilities apply to the subproject for which one would be an owner.
- Tracks and ensures adequate health of the modules and subprojects they are in charge of.
- Ensures adequate test coverage to confidently release new features and fixes.
- Ensures that tests are passing reliably (i.e. not flaky) and are fixed when they fail Mentors and guides approvers, reviewers, and contributors.
- Actively participates in the processes for discussion and decision making in the project.
- Merges pull requests and helps prepare releases.
- Makes and approves technical design decisions for the subproject.
- Helps define milestones and releases.
- Decides on when PRs are merged to control the release scope.
- Works with other maintainers to maintain the project’s overall health and success holistically.
- Receives a Kyverno Maintainer Badge on Credly!
Mapping Project Roles to GitHub Roles
The roles used in this document are custom roles mapped according to the GitHub roles and responsibilities.
| Project Role | GitHub Role |
|---|---|
| Contributor | Triage |
| Approver | Write |
| Maintainer | Maintain |
| Administrator | Admin |