Skip to content

Commit

Permalink
[doc][flexible-ipam] Add IPAM behaviors section
Browse files Browse the repository at this point in the history
Co-authored-by: Lan <luola@vmware.com>
Signed-off-by: gran <gran@vmware.com>
  • Loading branch information
gran-vmv and luolanzone committed Oct 18, 2023
1 parent 652c721 commit 07898b9
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/antrea-ipam.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,34 @@ metadata:
A StatefulSet Pod's IP will be kept after Pod restarts, when the IP is allocated from the
annotated IPPool.

### IPAM behaviors

When `AntreaIPAM` is enabled, `antrea-controller` will watch IPPool CRs and StatefulSets
from K8s apiserver, and `antrea-agent` will register IPAM driver to CNI server.

#### On IPPool CR create/update event

`antrea-controller` will update IPPool counters, and periodically clean up stale IP addresses.

#### On StatefulSet create event

`antrea-controller` will check annotations and preallocate IPs from the IPPool.

#### On StatefulSet delete event

`antrea-controller` will clean up IP allocations under this StatefulSet.

#### On Pod create

`antrea-agent` will receive a CNI add request, it will check annotations and allocate an IP from
an IPPool. The IP is a pre-allocated StatefulSet IP, a specified IP or the next available IP in
the IPPool.

#### On Pod delete

`antrea-agent` will receive a CNI del request and release the IP allocation from the IPPool.
The pre-allocation status won't be changed.

### Data path behaviors

When `AntreaIPAM` is enabled, `antrea-agent` will connect the Node's network interface
Expand Down

0 comments on commit 07898b9

Please sign in to comment.