Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for secondary network IPAM #3634

Merged
merged 1 commit into from
Apr 14, 2022
Merged

Add documentation for secondary network IPAM #3634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions build/yamls/antrea-aks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2771,7 +2771,8 @@ data:
# Egress: true

# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode.
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable multicast traffic. This feature is supported only with noEncap mode.
Expand Down Expand Up @@ -2840,9 +2841,9 @@ data:
#trafficEncryptionMode: none

# Enable bridging mode of Pod network on Nodes, in which the Node's transport interface is connected
# to the OVS bridge, and cross-Node/VLAN traffic from AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network via the uplink, and
# forwarded/routed by the underlay network.
# to the OVS bridge, and cross-Node/VLAN traffic of AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network, and forwarded/routed by the
# underlay network.
# This option requires the `AntreaIPAM` feature gate to be enabled. At this moment, it supports only
# IPv4 and Linux Nodes, and can be enabled only when `ovsDatapathType` is `system`,
# `trafficEncapMode` is `noEncap`, and `noSNAT` is true.
Expand Down Expand Up @@ -3016,8 +3017,9 @@ data:
# Run Kubernetes NodeIPAMController with Antrea.
# NodeIPAM: false

# Enable flexible IPAM mode for Antrea. This mode allows to assign IP Ranges to Namespaces,
# Deployments and StatefulSets via IP Pool annotation.
# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable managing external IPs of Services of LoadBalancer type.
Expand Down Expand Up @@ -3074,7 +3076,7 @@ kind: ConfigMap
metadata:
labels:
app: antrea
name: antrea-config-82h2mk24gg
name: antrea-config-mkbgmf6ct6
namespace: kube-system
---
apiVersion: v1
Expand Down Expand Up @@ -3145,7 +3147,7 @@ spec:
fieldRef:
fieldPath: spec.serviceAccountName
- name: ANTREA_CONFIG_MAP_NAME
value: antrea-config-82h2mk24gg
value: antrea-config-mkbgmf6ct6
image: projects.registry.vmware.com/antrea/antrea-ubuntu:latest
imagePullPolicy: IfNotPresent
livenessProbe:
Expand Down Expand Up @@ -3196,7 +3198,7 @@ spec:
key: node-role.kubernetes.io/master
volumes:
- configMap:
name: antrea-config-82h2mk24gg
name: antrea-config-mkbgmf6ct6
name: antrea-config
- name: antrea-controller-tls
secret:
Expand Down Expand Up @@ -3435,7 +3437,7 @@ spec:
operator: Exists
volumes:
- configMap:
name: antrea-config-82h2mk24gg
name: antrea-config-mkbgmf6ct6
name: antrea-config
- hostPath:
path: /etc/cni/net.d
Expand Down
22 changes: 12 additions & 10 deletions build/yamls/antrea-eks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2771,7 +2771,8 @@ data:
# Egress: true

# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode.
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable multicast traffic. This feature is supported only with noEncap mode.
Expand Down Expand Up @@ -2840,9 +2841,9 @@ data:
#trafficEncryptionMode: none

# Enable bridging mode of Pod network on Nodes, in which the Node's transport interface is connected
# to the OVS bridge, and cross-Node/VLAN traffic from AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network via the uplink, and
# forwarded/routed by the underlay network.
# to the OVS bridge, and cross-Node/VLAN traffic of AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network, and forwarded/routed by the
# underlay network.
# This option requires the `AntreaIPAM` feature gate to be enabled. At this moment, it supports only
# IPv4 and Linux Nodes, and can be enabled only when `ovsDatapathType` is `system`,
# `trafficEncapMode` is `noEncap`, and `noSNAT` is true.
Expand Down Expand Up @@ -3016,8 +3017,9 @@ data:
# Run Kubernetes NodeIPAMController with Antrea.
# NodeIPAM: false

# Enable flexible IPAM mode for Antrea. This mode allows to assign IP Ranges to Namespaces,
# Deployments and StatefulSets via IP Pool annotation.
# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable managing external IPs of Services of LoadBalancer type.
Expand Down Expand Up @@ -3074,7 +3076,7 @@ kind: ConfigMap
metadata:
labels:
app: antrea
name: antrea-config-82h2mk24gg
name: antrea-config-mkbgmf6ct6
namespace: kube-system
---
apiVersion: v1
Expand Down Expand Up @@ -3145,7 +3147,7 @@ spec:
fieldRef:
fieldPath: spec.serviceAccountName
- name: ANTREA_CONFIG_MAP_NAME
value: antrea-config-82h2mk24gg
value: antrea-config-mkbgmf6ct6
image: projects.registry.vmware.com/antrea/antrea-ubuntu:latest
imagePullPolicy: IfNotPresent
livenessProbe:
Expand Down Expand Up @@ -3196,7 +3198,7 @@ spec:
key: node-role.kubernetes.io/master
volumes:
- configMap:
name: antrea-config-82h2mk24gg
name: antrea-config-mkbgmf6ct6
name: antrea-config
- name: antrea-controller-tls
secret:
Expand Down Expand Up @@ -3437,7 +3439,7 @@ spec:
operator: Exists
volumes:
- configMap:
name: antrea-config-82h2mk24gg
name: antrea-config-mkbgmf6ct6
name: antrea-config
- hostPath:
path: /etc/cni/net.d
Expand Down
22 changes: 12 additions & 10 deletions build/yamls/antrea-gke.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2771,7 +2771,8 @@ data:
# Egress: true

# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode.
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable multicast traffic. This feature is supported only with noEncap mode.
Expand Down Expand Up @@ -2840,9 +2841,9 @@ data:
#trafficEncryptionMode: none

# Enable bridging mode of Pod network on Nodes, in which the Node's transport interface is connected
# to the OVS bridge, and cross-Node/VLAN traffic from AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network via the uplink, and
# forwarded/routed by the underlay network.
# to the OVS bridge, and cross-Node/VLAN traffic of AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network, and forwarded/routed by the
# underlay network.
# This option requires the `AntreaIPAM` feature gate to be enabled. At this moment, it supports only
# IPv4 and Linux Nodes, and can be enabled only when `ovsDatapathType` is `system`,
# `trafficEncapMode` is `noEncap`, and `noSNAT` is true.
Expand Down Expand Up @@ -3016,8 +3017,9 @@ data:
# Run Kubernetes NodeIPAMController with Antrea.
# NodeIPAM: false

# Enable flexible IPAM mode for Antrea. This mode allows to assign IP Ranges to Namespaces,
# Deployments and StatefulSets via IP Pool annotation.
# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable managing external IPs of Services of LoadBalancer type.
Expand Down Expand Up @@ -3074,7 +3076,7 @@ kind: ConfigMap
metadata:
labels:
app: antrea
name: antrea-config-c9ck44454h
name: antrea-config-2c8t9465tc
namespace: kube-system
---
apiVersion: v1
Expand Down Expand Up @@ -3145,7 +3147,7 @@ spec:
fieldRef:
fieldPath: spec.serviceAccountName
- name: ANTREA_CONFIG_MAP_NAME
value: antrea-config-c9ck44454h
value: antrea-config-2c8t9465tc
image: projects.registry.vmware.com/antrea/antrea-ubuntu:latest
imagePullPolicy: IfNotPresent
livenessProbe:
Expand Down Expand Up @@ -3196,7 +3198,7 @@ spec:
key: node-role.kubernetes.io/master
volumes:
- configMap:
name: antrea-config-c9ck44454h
name: antrea-config-2c8t9465tc
name: antrea-config
- name: antrea-controller-tls
secret:
Expand Down Expand Up @@ -3438,7 +3440,7 @@ spec:
path: /home/kubernetes/bin
name: host-cni-bin
- configMap:
name: antrea-config-c9ck44454h
name: antrea-config-2c8t9465tc
name: antrea-config
- hostPath:
path: /etc/cni/net.d
Expand Down
22 changes: 12 additions & 10 deletions build/yamls/antrea-ipsec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2771,7 +2771,8 @@ data:
# Egress: true

# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode.
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable multicast traffic. This feature is supported only with noEncap mode.
Expand Down Expand Up @@ -2840,9 +2841,9 @@ data:
trafficEncryptionMode: ipsec

# Enable bridging mode of Pod network on Nodes, in which the Node's transport interface is connected
# to the OVS bridge, and cross-Node/VLAN traffic from AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network via the uplink, and
# forwarded/routed by the underlay network.
# to the OVS bridge, and cross-Node/VLAN traffic of AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network, and forwarded/routed by the
# underlay network.
# This option requires the `AntreaIPAM` feature gate to be enabled. At this moment, it supports only
# IPv4 and Linux Nodes, and can be enabled only when `ovsDatapathType` is `system`,
# `trafficEncapMode` is `noEncap`, and `noSNAT` is true.
Expand Down Expand Up @@ -3021,8 +3022,9 @@ data:
# Run Kubernetes NodeIPAMController with Antrea.
# NodeIPAM: false

# Enable flexible IPAM mode for Antrea. This mode allows to assign IP Ranges to Namespaces,
# Deployments and StatefulSets via IP Pool annotation.
# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable managing external IPs of Services of LoadBalancer type.
Expand Down Expand Up @@ -3079,7 +3081,7 @@ kind: ConfigMap
metadata:
labels:
app: antrea
name: antrea-config-tmhkc66d6c
name: antrea-config-29g6gtcctg
namespace: kube-system
---
apiVersion: v1
Expand Down Expand Up @@ -3159,7 +3161,7 @@ spec:
fieldRef:
fieldPath: spec.serviceAccountName
- name: ANTREA_CONFIG_MAP_NAME
value: antrea-config-tmhkc66d6c
value: antrea-config-29g6gtcctg
image: projects.registry.vmware.com/antrea/antrea-ubuntu:latest
imagePullPolicy: IfNotPresent
livenessProbe:
Expand Down Expand Up @@ -3210,7 +3212,7 @@ spec:
key: node-role.kubernetes.io/master
volumes:
- configMap:
name: antrea-config-tmhkc66d6c
name: antrea-config-29g6gtcctg
name: antrea-config
- name: antrea-controller-tls
secret:
Expand Down Expand Up @@ -3484,7 +3486,7 @@ spec:
operator: Exists
volumes:
- configMap:
name: antrea-config-tmhkc66d6c
name: antrea-config-29g6gtcctg
name: antrea-config
- hostPath:
path: /etc/cni/net.d
Expand Down
22 changes: 12 additions & 10 deletions build/yamls/antrea.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2771,7 +2771,8 @@ data:
# Egress: true

# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode.
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable multicast traffic. This feature is supported only with noEncap mode.
Expand Down Expand Up @@ -2840,9 +2841,9 @@ data:
#trafficEncryptionMode: none

# Enable bridging mode of Pod network on Nodes, in which the Node's transport interface is connected
# to the OVS bridge, and cross-Node/VLAN traffic from AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network via the uplink, and
# forwarded/routed by the underlay network.
# to the OVS bridge, and cross-Node/VLAN traffic of AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network, and forwarded/routed by the
# underlay network.
# This option requires the `AntreaIPAM` feature gate to be enabled. At this moment, it supports only
# IPv4 and Linux Nodes, and can be enabled only when `ovsDatapathType` is `system`,
# `trafficEncapMode` is `noEncap`, and `noSNAT` is true.
Expand Down Expand Up @@ -3021,8 +3022,9 @@ data:
# Run Kubernetes NodeIPAMController with Antrea.
# NodeIPAM: false

# Enable flexible IPAM mode for Antrea. This mode allows to assign IP Ranges to Namespaces,
# Deployments and StatefulSets via IP Pool annotation.
# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable managing external IPs of Services of LoadBalancer type.
Expand Down Expand Up @@ -3079,7 +3081,7 @@ kind: ConfigMap
metadata:
labels:
app: antrea
name: antrea-config-hkhbh5gf99
name: antrea-config-bb75mkktfg
namespace: kube-system
---
apiVersion: v1
Expand Down Expand Up @@ -3150,7 +3152,7 @@ spec:
fieldRef:
fieldPath: spec.serviceAccountName
- name: ANTREA_CONFIG_MAP_NAME
value: antrea-config-hkhbh5gf99
value: antrea-config-bb75mkktfg
image: projects.registry.vmware.com/antrea/antrea-ubuntu:latest
imagePullPolicy: IfNotPresent
livenessProbe:
Expand Down Expand Up @@ -3201,7 +3203,7 @@ spec:
key: node-role.kubernetes.io/master
volumes:
- configMap:
name: antrea-config-hkhbh5gf99
name: antrea-config-bb75mkktfg
name: antrea-config
- name: antrea-controller-tls
secret:
Expand Down Expand Up @@ -3440,7 +3442,7 @@ spec:
operator: Exists
volumes:
- configMap:
name: antrea-config-hkhbh5gf99
name: antrea-config-bb75mkktfg
name: antrea-config
- hostPath:
path: /etc/cni/net.d
Expand Down
9 changes: 5 additions & 4 deletions build/yamls/base/conf/antrea-agent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ featureGates:
# Egress: true

# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode.
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think that a new line for each case (bridgingMode and secondaryNetwork) is more clear?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel one paragraph is ok. I do not like short paragraphs.

# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable multicast traffic. This feature is supported only with noEncap mode.
Expand Down Expand Up @@ -101,9 +102,9 @@ featureGates:
#trafficEncryptionMode: none

# Enable bridging mode of Pod network on Nodes, in which the Node's transport interface is connected
# to the OVS bridge, and cross-Node/VLAN traffic from AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network via the uplink, and
# forwarded/routed by the underlay network.
# to the OVS bridge, and cross-Node/VLAN traffic of AntreaIPAM Pods (Pods whose IP addresses are
# allocated by AntreaIPAM from IPPools) is sent to the underlay network, and forwarded/routed by the
# underlay network.
# This option requires the `AntreaIPAM` feature gate to be enabled. At this moment, it supports only
# IPv4 and Linux Nodes, and can be enabled only when `ovsDatapathType` is `system`,
# `trafficEncapMode` is `noEncap`, and `noSNAT` is true.
Expand Down
5 changes: 3 additions & 2 deletions build/yamls/base/conf/antrea-controller.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ featureGates:
# Run Kubernetes NodeIPAMController with Antrea.
# NodeIPAM: false

# Enable flexible IPAM mode for Antrea. This mode allows to assign IP Ranges to Namespaces,
# Deployments and StatefulSets via IP Pool annotation.
# Enable AntreaIPAM, which can allocate IP addresses from IPPools. AntreaIPAM is required by the
# bridging mode and allocates IPs to Pods in bridging mode. It is also required to use Antrea for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

# IPAM when configuring secondary network interfaces with Multus.
# AntreaIPAM: false

# Enable managing external IPs of Services of LoadBalancer type.
Expand Down
Loading