- Getting Started
- Support for K8s Installers
- Deploying on Kind
- Deploying on Minikube
- Installing with Helm
- Antrea Network Policy
- Traffic Encryption (Ipsec / WireGuard)
- Securing Control Plane
- Security considerations
- OS-specific Known Issues
- OVS Pipeline
- Feature Gates
- Antrea Proxy
- Network Flow Visibility
- Traceflow Guide
- NoEncap and Hybrid Traffic Modes
- Egress Guide
- NodePortLocal Guide
- Antrea IPAM Guide
- Exposing Services of type LoadBalancer
- Traffic Control
- Antrea API Groups
- Antrea API Reference
This document defines the project governance for Antrea.
Antrea is committed to building an open, inclusive, productive and self-governing open source community focused on building a high-quality Kubernetes Network Plugin. The community is governed by this document which defines how all members should work together to achieve this goal.
Code of Conduct
The Antrea community abides by this code of conduct.
- Users: Members that engage with the Antrea community via any medium (Slack, GitHub, mailing lists, etc.).
- Contributors: Do regular contributions to the Antrea project (documentation, code reviews, responding to issues, participating in proposal discussions, contributing code, etc.).
- Maintainers: Responsible for the overall health and direction of the project. They are the final reviewers of PRs and responsible for Antrea releases.
Anyone can contribute to the project (e.g. open a PR) as long as they follow the guidelines in CONTRIBUTING.md.
Frequent contributors to the project can become members of the antrea-io Github
organization and receive write access to the repository. Write access is
required to trigger re-runs of workflows in
a member of the antrea-io Github organization does not come with additional
responsibilities for the contributor, but simplifies the contributing
process. To become a member, you may
and your membership needs to be approved by two maintainers: approval is
indicated by leaving a
+1 comment. If a contributor is not active for a
duration of 12 months (no contribution of any kind), they may be removed from
the antrea-io Github organization. In case of privilege abuse (members receive
write access to the organization), any maintainer can decide to disable write
access temporarily for the member. Within the next 2 weeks, the maintainer must
either restore the member’s privileges, or remove the member from the
organization. The latter requires approval from at least one other maintainer,
which must be obtained publicly either on Github or Slack.
The list of current maintainers can be found in MAINTAINERS.md.
While anyone can review a PR and is encouraged to do so, only maintainers are allowed to merge the PR. To maintain velocity, only one maintainer’s approval is required to merge a given PR. In case of a disagreement between maintainers, a vote should be called (on Github or Slack) and a simple majority is required in order for the PR to be merged.
New maintainers must be nominated from contributors by an existing maintainer and must be elected by a supermajority of the current maintainers. Likewise, maintainers can be removed by a supermajority of the maintainers or can resign by notifying the maintainers.
A supermajority is defined as two-thirds of members in the group.
Code of Conduct
The code of conduct is overseen by the Antrea project maintainers. Possible code of conduct violations should be emailed to the project maintainers at email@example.com.
If the possible violation is against one of the project maintainers that member will be recused from voting on the issue. Such issues must be escalated to the appropriate CNCF contact, and CNCF may choose to intervene.
All substantive changes in Governance require a supermajority vote of the maintainers.