Antrea API

This document lists all the API resource versions currently or previously supported by Antrea, along with information related to their deprecation and removal when appropriate. It is kept up-to-date as we evolve the Antrea API.

Starting with the v1.0 release, we decided to group all the Custom Resource Definitions (CRDs) defined by Antrea in a single API group, crd.antrea.io, instead of grouping CRDs logically in different API groups based on their purposes. The rationale for this change was to avoid proliferation of API groups. As a result, all resources in the crd.antrea.io are versioned individually, while before the v1.0 release, we used to have a single version number for all the CRDs in a given group: when introducing a new version of the API group, we would “move” all CRDs from the earlier version to the new version together. This explains why the tables below are presented differently for crd.antrea.io and for other API groups.

For information about the Antrea API versioning policy, please refer to this document.

Currently-supported

CRDs in crd.antrea.io

These are the CRDs currently available in crd.antrea.io.

CRDCRD versionIntroduced inDeprecated in / Planned DeprecationPlanned Removal
AntreaAgentInfov1beta1v1.0.0N/AN/A
AntreaControllerInfov1beta1v1.0.0N/AN/A
ClusterGroupv1beta1v1.13.0N/AN/A
ClusterNetworkPolicyv1beta1v1.13.0N/AN/A
Egressv1beta1v1.13.0N/AN/A
ExternalEntityv1alpha2v1.0.0N/AN/A
ExternalIPPoolv1beta1v1.13.0N/AN/A
ExternalNodev1alpha1v1.8.0N/AN/A
IPPoolv1alpha2v1.4.0v2.0.0N/A
IPPoolv1beta1v2.0.0N/AN/A
Groupv1beta1v1.13.0N/AN/A
NetworkPolicyv1beta1v1.13.0N/AN/A
SupportBundleCollectionv1alpha1v1.10.0N/AN/A
Tierv1beta1v1.13.0N/AN/A
Traceflowv1beta1v1.13.0N/AN/A
TrafficControlv1alpha2v1.7.0N/AN/A

Other API groups

These are the API group versions which are currently available when using Antrea.

API groupAPI versionAPI Service?Introduced inDeprecated in / Planned DeprecationPlanned Removal
controlplane.antrea.iov1beta2Yesv1.0.0N/AN/A
stats.antrea.iov1alpha1Yesv1.0.0N/AN/A
system.antrea.iov1beta1Yesv1.0.0N/AN/A

Previously-supported

Previously-supported API groups

API groupAPI versionAPI Service?Introduced inDeprecated inRemoved in
core.antrea.tanzu.vmware.comv1alpha1Nov0.8.0v0.11.0v0.11.0
networking.antrea.tanzu.vmware.comv1beta1Yesv0.3.0v0.10.0v1.2.0
controlplane.antrea.tanzu.vmware.comv1beta1Yesv0.10.0v0.11.0v1.3.0
clusterinformation.antrea.tanzu.vmware.comv1beta1Nov0.3.0v1.0.0v1.6.0
core.antrea.tanzu.vmware.comv1alpha2Nov0.11.0v1.0.0v1.6.0
controlplane.antrea.tanzu.vmware.comv1beta2Yesv0.11.0v1.0.0v1.6.0
ops.antrea.tanzu.vmware.comv1alpha1Nov0.8.0v1.0.0v1.6.0
security.antrea.tanzu.vmware.comv1alpha1Nov0.8.0v1.0.0v1.6.0
stats.antrea.tanzu.vmware.comv1alpha1Yesv0.10.0v1.0.0v1.6.0
system.antrea.tanzu.vmware.comv1beta1Yesv0.5.0v1.0.0v1.6.0

Previously-supported CRDs

CRDCRD versionIntroduced inDeprecated inRemoved in
ClusterGroupv1alpha2v1.0.0v1.1.0v2.0.0
ClusterGroupv1alpha3v1.1.0v1.13.0v2.0.0
ClusterNetworkPolicyv1alpha1v1.0.0v1.13.0v2.0.0
Egressv1alpha2v1.0.0v1.13.0v2.0.0
ExternalEntityv1alpha1v0.10.0v0.11.0v2.0.0
ExternalIPPoolv1alpha2v1.2.0v1.13.0v2.0.0
Groupv1alpha3v1.8.0v1.13.0v2.0.0
NetworkPolicyv1alpha1v1.0.0v1.13.0v2.0.0
Tierv1alpha1v1.0.0v1.13.0v2.0.0
Traceflowv1alpha1v1.0.0v1.13.0v2.0.0