README
¶
Antrea
Overview
Antrea is a Kubernetes networking solution intended to be Kubernetes native. It operates at Layer3/4 to provide networking and security services for a Kubernetes cluster, leveraging Open vSwitch as the networking data plane.
Open vSwitch is a widely adopted high-performance programmable virtual switch; Antrea leverages it to implement Pod networking and security features. For instance, Open vSwitch enables Antrea to implement Kubernetes Network Policies in a very efficient manner.
Prerequisites
Antrea has been tested with Kubernetes clusters running version 1.16 or later.
NodeIPAMControllermust be enabled in the Kubernetes cluster.
When deploying a cluster with kubeadm the--pod-network-cidr <cidr>option must be specified.- Open vSwitch kernel module must be present on every Kubernetes node.
Getting Started
Getting started with Antrea is very simple, and takes only a few minutes. See how it's done in the Getting started document.
Contributing
The Antrea community welcomes new contributors. We are waiting for your PRs!
- Before contributing, please get familiar with our Code of Conduct.
- Check out the Antrea Contributor Guide for information about setting up your development environment and our contribution workflow.
- Learn about Antrea's Architecture and design. Your feedback is more than welcome!
- Check out Open Issues.
- Join our mailing lists to always stay up-to-date with Antrea development:
- projectantrea-announce for important project announcements.
- projectantrea for updates about Antrea or provide feedback.
- projectantrea-dev to participate in discussions on Antrea development.
Also check out @ProjectAntrea on Twitter!
Roadmap
Antrea is a very young project. There is a very exciting list of features and integrations that we would like to add. A most likely incomplete list can be found on our Roadmap page. Feel free to throw your ideas in!
License
Antrea is licensed under the Apache License, version 2.0
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
antrea-agent
Package main under directory cmd parses and validates user input, instantiates and initializes objects imported from pkg, and runs the process.
|
Package main under directory cmd parses and validates user input, instantiates and initializes objects imported from pkg, and runs the process. |
|
antrea-controller
Package main under directory cmd parses and validates user input, instantiates and initializes objects imported from pkg, and runs the process.
|
Package main under directory cmd parses and validates user input, instantiates and initializes objects imported from pkg, and runs the process. |
|
hack
|
|
|
netpol
Module
|
|
|
pkg
|
|
|
agent
Package agent contains the libraries that drive the antrea-agent binary.
|
Package agent contains the libraries that drive the antrea-agent binary. |
|
agent/cniserver/ipam/testing
Package testing is a generated GoMock package.
|
Package testing is a generated GoMock package. |
|
agent/openflow/testing
Package testing is a generated GoMock package.
|
Package testing is a generated GoMock package. |
|
apis
Package apis contains API definitions used to interface with the different Antrea components, along with files auto-generated from these API definitions.
|
Package apis contains API definitions used to interface with the different Antrea components, along with files auto-generated from these API definitions. |
|
apis/networkpolicy
Package networkpolicy contains the latest (or "internal") version of the Antrea NetworkPolicy API messages.
|
Package networkpolicy contains the latest (or "internal") version of the Antrea NetworkPolicy API messages. |
|
apis/networkpolicy/v1beta1
Package v1beta1 is the v1beta1 version of the Antrea NetworkPolicy API messages.
|
Package v1beta1 is the v1beta1 version of the Antrea NetworkPolicy API messages. |
|
apiserver
Package apiserver contains code to create kubernetes-like API server for antrea-controller.
|
Package apiserver contains code to create kubernetes-like API server for antrea-controller. |
|
apiserver/storage
Package storage contains storage interfaces and implementations for the apiserver.
|
Package storage contains storage interfaces and implementations for the apiserver. |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/antrea/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/antrea/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned/typed/networkpolicy/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/networkpolicy/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
cni
Package cni contains the libraries that drive the antrea-cni binary.
|
Package cni contains the libraries that drive the antrea-cni binary. |
|
controller
Package controller contains the libraries that drive the antrea-controller binary.
|
Package controller contains the libraries that drive the antrea-controller binary. |
|
controller/types
Package types contains common types in the antrea-controller.
|
Package types contains common types in the antrea-controller. |
|
k8s
Package k8s contains utilities for Antrea interactions with Kubernetes.
|
Package k8s contains utilities for Antrea interactions with Kubernetes. |
|
ovs
Package ovs contains ovsdb and openflow interfaces and implementations.
|
Package ovs contains ovsdb and openflow interfaces and implementations. |
|
ovs/openflow/testing
Package testing is a generated GoMock package.
|
Package testing is a generated GoMock package. |
|
ovs/ovsconfig/testing
Package testing is a generated GoMock package.
|
Package testing is a generated GoMock package. |
|
signals
Package signals contains utilities for dealing with signals.
|
Package signals contains utilities for dealing with signals. |
|
version
Package version provides information about the current semantic version for the Antrea project.
|
Package version provides information about the current semantic version for the Antrea project. |
|
plugins
|
|
|
octant
Module
|
|
|
test
|
|
|
integration
Package integration provides integration tests that require a running OVS or invoking external calls on the system.
|
Package integration provides integration tests that require a running OVS or invoking external calls on the system. |
Click to show internal directories.
Click to hide internal directories.