features

Documentation

Index

• Constants
• Variables
• func GetStatus(status bool) string
• func GetVersion(version string) string
• func SupportedOnExternalNode(feature featuregate.Feature) bool
• func SupportedOnWindows(feature featuregate.Feature) bool

Constants

const (

	// alpha: v0.8
	// beta: v1.0
	// Enable support for ClusterNetworkPolicy and AntreaNetworkPolicy CRDs.
	AntreaPolicy featuregate.Feature = "AntreaPolicy"

	// alpha: v0.13
	// beta: v1.11
	// GA: v1.14
	// Enable EndpointSlice support in AntreaProxy. If AntreaProxy is not enabled, this
	// flag will not take effect.
	EndpointSlice featuregate.Feature = "EndpointSlice"

	// alpha: v1.8
	// beta: v1.12
	// Enable TopologyAwareHints in AntreaProxy. If EndpointSlice is not enabled, this
	// flag will not take effect.
	TopologyAwareHints featuregate.Feature = "TopologyAwareHints"

	// alpha: v1.13
	// Enable support for cleaning up stale UDP Service conntrack connections in AntreaProxy.
	CleanupStaleUDPSvcConntrack featuregate.Feature = "CleanupStaleUDPSvcConntrack"

	// alpha: v0.8
	// beta: v0.11
	// GA: v1.14
	// Enable antrea proxy which provides ServiceLB for in-cluster services in antrea agent.
	// It should be enabled on Windows, otherwise NetworkPolicy will not take effect on
	// Service traffic.
	AntreaProxy featuregate.Feature = "AntreaProxy"

	// alpha: v0.8
	// beta: v0.11
	// Allows to trace path from a generated packet.
	Traceflow featuregate.Feature = "Traceflow"

	// alpha: v0.9
	// Flow exporter exports IPFIX flow records of Antrea flows seen in conntrack module.
	FlowExporter featuregate.Feature = "FlowExporter"

	// alpha: v0.10
	// beta: v1.2
	// Enable collecting and exposing NetworkPolicy statistics.
	NetworkPolicyStats featuregate.Feature = "NetworkPolicyStats"

	// alpha: v0.13
	// beta: v1.4
	// GA: v1.14
	// Expose Pod ports through NodePort
	NodePortLocal featuregate.Feature = "NodePortLocal"

	// alpha: v1.0
	// beta: v1.6
	// Enable controlling SNAT IPs of Pod egress traffic.
	Egress featuregate.Feature = "Egress"

	// alpha: v1.4
	// beta: v1.12
	// Run Kubernetes NodeIPAM with Antrea.
	NodeIPAM featuregate.Feature = "NodeIPAM"

	// alpha: v1.4
	// Enable AntreaIPAM, which is required by bridging mode Pods and secondary network IPAM.
	AntreaIPAM featuregate.Feature = "AntreaIPAM"

	// alpha: v1.5
	// beta: v1.12
	// Enable Multicast.
	Multicast featuregate.Feature = "Multicast"

	// alpha: v1.7
	// Enable Multicluster.
	Multicluster featuregate.Feature = "Multicluster"

	// alpha: v1.5
	// Enable Secondary interface feature for Antrea.
	SecondaryNetwork featuregate.Feature = "SecondaryNetwork"

	// alpha: v1.5
	// Enable controlling Services with ExternalIP.
	ServiceExternalIP featuregate.Feature = "ServiceExternalIP"

	// alpha: v1.7
	// Enable mirroring or redirecting the traffic Pods send or receive.
	TrafficControl featuregate.Feature = "TrafficControl"

	// alpha: v1.7
	// Enable certificate-based authentication for IPSec tunnel.
	IPsecCertAuth featuregate.Feature = "IPsecCertAuth"

	// alpha: v1.8
	// Enable running agent on an unmanaged VM/BM.
	ExternalNode featuregate.Feature = "ExternalNode"

	// alpha: v1.10
	// Enable collecting support bundle files with SupportBundleCollection CRD.
	SupportBundleCollection featuregate.Feature = "SupportBundleCollection"

	// alpha: v1.10
	// Enable users to protect their applications by specifying how they are allowed to communicate with others, taking
	// into account application context.
	L7NetworkPolicy featuregate.Feature = "L7NetworkPolicy"

	// alpha: v1.13
	// Allow users to specify the load balancer mode as DSR (Direct Server Return).
	LoadBalancerModeDSR featuregate.Feature = "LoadBalancerModeDSR"

	// alpha: v1.13
	// Enable the AdminNetworkPolicy APIs
	// https://github.com/kubernetes-sigs/network-policy-api
	AdminNetworkPolicy featuregate.Feature = "AdminNetworkPolicy"

	// alpha: v1.14
	// Enable Egress traffic shaping.
	EgressTrafficShaping featuregate.Feature = "EgressTrafficShaping"

	// alpha: v1.15
	// Allow users to allocate Egress IPs from a different subnet from the default Node subnet.
	EgressSeparateSubnet featuregate.Feature = "EgressSeparateSubnet"

	// alpha: v1.15
	// Allows users to apply ClusterNetworkPolicy to Kubernetes Nodes.
	NodeNetworkPolicy featuregate.Feature = "NodeNetworkPolicy"

	// alpha: v1.15
	// Enable layer 7 flow export on Pods and Namespaces
	L7FlowExporter featuregate.Feature = "L7FlowExporter"
)

Variables

var (
	// DefaultMutableFeatureGate is a mutable version of DefaultFeatureGate.
	DefaultMutableFeatureGate featuregate.MutableFeatureGate = featuregate.NewFeatureGate()

	// DefaultFeatureGate is a shared global FeatureGate.
	// The feature gate should be modified via DefaultMutableFeatureGate.
	DefaultFeatureGate featuregate.FeatureGate = DefaultMutableFeatureGate

	// DefaultAntreaFeatureGates consists of all known Antrea-specific feature keys.
	// To add a new feature, define a key for it above and add it here. The features will be
	// available throughout Antrea binaries.
	DefaultAntreaFeatureGates = map[featuregate.Feature]featuregate.FeatureSpec{
		AntreaPolicy:                {Default: true, PreRelease: featuregate.Beta},
		AntreaProxy:                 {Default: true, PreRelease: featuregate.GA},
		Egress:                      {Default: true, PreRelease: featuregate.Beta},
		EndpointSlice:               {Default: true, PreRelease: featuregate.GA},
		TopologyAwareHints:          {Default: true, PreRelease: featuregate.Beta},
		CleanupStaleUDPSvcConntrack: {Default: false, PreRelease: featuregate.Alpha},
		Traceflow:                   {Default: true, PreRelease: featuregate.Beta},
		AntreaIPAM:                  {Default: false, PreRelease: featuregate.Alpha},
		FlowExporter:                {Default: false, PreRelease: featuregate.Alpha},
		NetworkPolicyStats:          {Default: true, PreRelease: featuregate.Beta},
		NodePortLocal:               {Default: true, PreRelease: featuregate.GA},
		NodeIPAM:                    {Default: true, PreRelease: featuregate.Beta},
		Multicast:                   {Default: true, PreRelease: featuregate.Beta},
		Multicluster:                {Default: false, PreRelease: featuregate.Alpha},
		SecondaryNetwork:            {Default: false, PreRelease: featuregate.Alpha},
		ServiceExternalIP:           {Default: false, PreRelease: featuregate.Alpha},
		TrafficControl:              {Default: false, PreRelease: featuregate.Alpha},
		IPsecCertAuth:               {Default: false, PreRelease: featuregate.Alpha},
		ExternalNode:                {Default: false, PreRelease: featuregate.Alpha},
		SupportBundleCollection:     {Default: false, PreRelease: featuregate.Alpha},
		L7NetworkPolicy:             {Default: false, PreRelease: featuregate.Alpha},
		LoadBalancerModeDSR:         {Default: false, PreRelease: featuregate.Alpha},
		AdminNetworkPolicy:          {Default: false, PreRelease: featuregate.Alpha},
		EgressTrafficShaping:        {Default: false, PreRelease: featuregate.Alpha},
		EgressSeparateSubnet:        {Default: false, PreRelease: featuregate.Alpha},
		NodeNetworkPolicy:           {Default: false, PreRelease: featuregate.Alpha},
		L7FlowExporter:              {Default: false, PreRelease: featuregate.Alpha},
	}

	// AgentGates consists of all known feature gates for the Antrea Agent.
	// When adding a new feature gate that applies to the Antrea Agent, please also add it here.
	AgentGates = sets.New[featuregate.Feature](
		AntreaIPAM,
		AntreaPolicy,
		AntreaProxy,
		CleanupStaleUDPSvcConntrack,
		Egress,
		EndpointSlice,
		ExternalNode,
		FlowExporter,
		IPsecCertAuth,
		L7NetworkPolicy,
		LoadBalancerModeDSR,
		Multicast,
		Multicluster,
		NetworkPolicyStats,
		NodePortLocal,
		SecondaryNetwork,
		ServiceExternalIP,
		SupportBundleCollection,
		TopologyAwareHints,
		Traceflow,
		TrafficControl,
		EgressTrafficShaping,
		EgressSeparateSubnet,
		NodeNetworkPolicy,
		L7FlowExporter,
	)

	// ControllerGates consists of all known feature gates for the Antrea Controller.
	// When adding a new feature gate that applies to the Antrea Controller, please also add it here.
	ControllerGates = sets.New[featuregate.Feature](
		AdminNetworkPolicy,
		AntreaIPAM,
		AntreaPolicy,
		Egress,
		IPsecCertAuth,
		L7NetworkPolicy,
		Multicast,
		Multicluster,
		NetworkPolicyStats,
		NodeIPAM,
		ServiceExternalIP,
		SupportBundleCollection,
		Traceflow,
	)
)

Functions

func GetStatus

func GetStatus(status bool) string

func GetVersion

func GetVersion(version string) string

func SupportedOnExternalNode

func SupportedOnExternalNode(feature featuregate.Feature) bool

SupportedOnExternalNode checks whether a feature is supported on an external Node.

func SupportedOnWindows

func SupportedOnWindows(feature featuregate.Feature) bool

SupportedOnWindows checks whether a feature is supported on a Windows Node.