Skip to content

Commit

Permalink
clarify doc: featureGate setup for AntreaIPAM (#4665)
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Pan <Peter.Pan@daocloud.io>
  • Loading branch information
panpan0000 authored Mar 1, 2023
1 parent 26cecc6 commit dfbfa41
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions docs/antrea-ipam.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ changes in the Antrea deployment YAML:
Antrea supports flexible control over Pod IP addressing since version 1.4. Pod
IP addresses can be allocated from an `IPPool`. When a Pod's IP is allocated
from an IPPool, the traffic from the Pod to Pods on another Node or to external
network will be sent to the underlay network through the Node's transport
from an IPPool, the traffic from the Pod to Pods on another Node or from the Pod to
external network will be sent to the underlay network through the Node's transport
network interface, and will be forwarded/routed by the underlay network. We also
call this forwarding mode `bridging mode`.

Expand All @@ -88,8 +88,10 @@ IPPool annotation, or when the `AntreaIPAM` feature is disabled.

To enable flexible IPAM, you need to enable the `AntreaIPAM` feature gate for
both `antrea-controller` and `antrea-agent`, and set the `enableBridgingMode`
configuration parameter of `antrea-agent` to `true`. The needed changes in the
Antrea deployment YAML are:
configuration parameter of `antrea-agent` to `true`.

When Antrea is installed from YAML, the needed changes in the Antrea
ConfigMap `antrea-config` YAML are as below:

```yaml
antrea-controller.conf: |
Expand All @@ -104,8 +106,20 @@ Antrea deployment YAML are:
...
enableBridgingMode: true
...
trafficEncapMode: "noEncap"
...
noSNAT: true
...
```

Alternatively, you can use the following helm install/upgrade command to configure
the above options:

```bash
helm upgrade --install antrea antrea/antrea --namespace kube-system --set
enableBridgingMode=true,featureGates.AntreaIPAM=true,trafficEncapMode=noEncap,noSNAT=true
```

#### Create IPPool CR

The following example YAML manifest creates an IPPool CR.
Expand Down

0 comments on commit dfbfa41

Please sign in to comment.