[doc][flexible-ipam] Update document for Multiple-VLAN support #3507

gran-vmv · 2022-03-23T02:21:22Z

codecov-commenter · 2022-03-23T02:48:54Z

Codecov Report

Merging #3507 (1f5b322) into main (2acd70b) will decrease coverage by 27.18%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             main    #3507       +/-   ##
===========================================
- Coverage   65.44%   38.25%   -27.19%     
===========================================
  Files         277      114      -163     
  Lines       27500    15208    -12292     
===========================================
- Hits        17996     5818    -12178     
- Misses       7585     8909     +1324     
+ Partials     1919      481     -1438

Flag	Coverage Δ
integration-tests	`38.25% <ø> (?)`
kind-e2e-tests	`?`
unit-tests	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
pkg/apiserver/handlers/webhook/mutation_labels.go
...g/agent/apiserver/handlers/featuregates/handler.go
pkg/ipfix/ipfix_intermediate.go
...g/agent/apiserver/handlers/addressgroup/handler.go
...agent/flowexporter/connections/deny_connections.go
multicluster/cmd/multicluster-controller/main.go
pkg/agent/apiserver/apiserver.go
pkg/agent/openflow/meters_linux.go
...kg/agent/controller/networkpolicy/audit_logging.go
pkg/controller/traceflow/controller.go
... and 381 more

annakhm · 2022-03-24T18:12:47Z

docs/antrea-ipam.md

+subnets.
+All traffic to a Pod in different VLAN will be sent to the gateway of "underlay" network.
+Inter-Node traffic will be sent to the "underlay" network from the source Node, and
+forwarded to the destination Node by the "underlay" network.


I think quotes are not needed with underlay as those are not used in other places (like below)

Thanks, removed quotes.

annakhm · 2022-03-24T18:16:42Z

docs/antrea-ipam.md

+All traffic to a local Pod in same VLAN will be sent to the Pod's OVS port directly,
+after the destination MAC is rewritten to the Pod's MAC address. This includes
+`AntreaIPAM` Pods and regular `Subnet per Node` IPAM Pods, even they are not in the same
+subnets.


suggestion: even when they are not in the same subnet

Thanks. Fixed.

tnqn · 2022-03-25T15:41:03Z

docs/antrea-ipam.md

+after the destination MAC is rewritten to the Pod's MAC address. This includes
+`AntreaIPAM` Pods and regular `Subnet per Node` IPAM Pods, even when they are not in the
+same subnet.
+All traffic to a Pod in different VLAN will be sent to the gateway of underlay network.


Do you want to start a new paragraph for it? If yes, an empty line is needed before it to indicate a new paragraph in markdown. So do the following two cases.

No, this is to make the raw text clear, not to start a new paragraph.

I would say it is even confusing. If you want not a new paragraph for readers, why start a new in "raw text"?

@jianjuns Already changed to one line according your suggestion.
If we start a new line for every sentence, we don't need to correct the layout for the whole paragraph when we add/remove some words before this sentence in this paragraph. Thus why I used this method, but I'm OK to remove the newline for every sentence.

Many IDE/editor can wrap lines automatically. A line for a sentence doesn't look tidy and makes "paragraph" meaningless, and it's not a convention in practice in any project I know.

OK, got it.

jianjuns · 2022-03-25T15:47:44Z

docs/antrea-ipam.md

-Inter-Node traffic will be sent to the Node network from the source Node, and forwarded
-to the destination Node by the Node network.
+Traffic from `AntreaIPAM` Pods without VLAN, regular `Subnet per Node` IPAM Pods, and K8s
+Nodes are recognized as VLAN 0 (untagged).


Fixed. Thanks.

jianjuns · 2022-03-25T15:48:19Z

docs/antrea-ipam.md

+Traffic from `AntreaIPAM` Pods without VLAN, regular `Subnet per Node` IPAM Pods, and K8s
+Nodes are recognized as VLAN 0 (untagged).
+
+All traffic to a local Pod in same VLAN will be sent to the Pod's OVS port directly,


All traffic -> Traffic

same VLAN -> the Pod's VLAN

jianjuns · 2022-03-25T15:53:06Z

docs/antrea-ipam.md

+Nodes are recognized as VLAN 0 (untagged).
+
+All traffic to a local Pod in same VLAN will be sent to the Pod's OVS port directly,
+after the destination MAC is rewritten to the Pod's MAC address. This includes


Do we always override destination MAC, or only for cross-subnet case? If the latter, probably remove this sentence. If you want can add it to the last sentence:

This includes AntreaIPAM Pods and regular Subnet per Node IPAM Pods. If the source and destination are not in the same subnet, the packets' destination MAC will be overridden to the destination Pod's MAC".
same subnet.

Yes. DstMAC will be rewritten always for same vlan

jianjuns · 2022-03-25T15:54:50Z

docs/antrea-ipam.md

+after the destination MAC is rewritten to the Pod's MAC address. This includes
+`AntreaIPAM` Pods and regular `Subnet per Node` IPAM Pods, even when they are not in the
+same subnet.
+All traffic to a Pod in different VLAN will be sent to the gateway of underlay network.


All traffic -> Traffic

We do not explicitly send the traffic to gateway, so maybe:

will be sent to the underlay network, where the underlay router will route the traffic to the destination VLAN.

jianjuns · 2022-03-25T15:55:23Z

docs/antrea-ipam.md

+`AntreaIPAM` Pods and regular `Subnet per Node` IPAM Pods, even when they are not in the
+same subnet.
+All traffic to a Pod in different VLAN will be sent to the gateway of underlay network.
+Inter-Node traffic will be sent to the underlay network from the source Node, and


I feel this sentence is not necessary. But up to you.

OK. Removed this.

jianjuns · 2022-03-25T15:56:55Z

docs/antrea-ipam.md

-pools for IPv4 and IPv6 respectively will be supported.
+The IPs in the `IPPools` without VLAN must be in the same "underlay" subnet as the Node
+IP, because inter-Node traffic of AntreaIPAM Pods is forwarded by the Node network.
+The IPs in the `IPPools` with VLAN must not overlap with other network subnets, and the


We can remove "The IPs in the"

jianjuns · 2022-03-25T15:57:30Z

docs/antrea-ipam.md

+The IPs in the `IPPools` without VLAN must be in the same "underlay" subnet as the Node
+IP, because inter-Node traffic of AntreaIPAM Pods is forwarded by the Node network.
+The IPs in the `IPPools` with VLAN must not overlap with other network subnets, and the
+gateway of underlay network should provide the network connectivity for these VLANs.


Maybe say "the underlay network router" to be more generic.

jianjuns · 2022-03-25T15:58:42Z

docs/antrea-ipam.md

+IP, because inter-Node traffic of AntreaIPAM Pods is forwarded by the Node network.
+The IPs in the `IPPools` with VLAN must not overlap with other network subnets, and the
+gateway of underlay network should provide the network connectivity for these VLANs.
+Only a single IP pool can be included in the Namespace annotation.


Suggest to keep lines aligned at 80th column, rather than creating a new line for each sentence.

jianjuns · 2022-03-26T18:54:58Z

docs/antrea-ipam.md

-inter-Node traffic of AntreaIPAM Pods is forwarded by the Node network. Only a single IP
-pool can be included in the Namespace annotation. In the future, annotation of up to two
-pools for IPv4 and IPv6 respectively will be supported.
+The IPs in the `IPPools` without VLAN must be in the same "underlay" subnet as the Node


Nit - we can remove "" around "underlay" now, as underlay is talked a lot in this doc.

Thanks. Fixed.

Signed-off-by: gran <gran@vmware.com>

tnqn · 2022-03-28T01:58:40Z

/skip-all

gran-vmv added this to the Antrea v1.6 release milestone Mar 23, 2022

gran-vmv requested review from salv-orlando, antoninbas, tnqn, annakhm, jianjuns and hongliangl March 23, 2022 02:21

gran-vmv self-assigned this Mar 23, 2022

gran-vmv force-pushed the ipam-vlan-doc branch from ec3ca2a to cda4145 Compare March 23, 2022 02:23

annakhm reviewed Mar 24, 2022

View reviewed changes

gran-vmv force-pushed the ipam-vlan-doc branch from cda4145 to cbe4d28 Compare March 25, 2022 00:38

annakhm previously approved these changes Mar 25, 2022

View reviewed changes

tnqn reviewed Mar 25, 2022

View reviewed changes

jianjuns reviewed Mar 25, 2022

View reviewed changes

gran-vmv dismissed annakhm’s stale review via 1c7b487 March 26, 2022 01:21

gran-vmv force-pushed the ipam-vlan-doc branch from cbe4d28 to 1c7b487 Compare March 26, 2022 01:22

jianjuns previously approved these changes Mar 26, 2022

View reviewed changes

[flexible-ipam] Update document for Multiple-VLAN support

1f5b322

Signed-off-by: gran <gran@vmware.com>

gran-vmv dismissed jianjuns’s stale review via 1f5b322 March 28, 2022 01:56

gran-vmv force-pushed the ipam-vlan-doc branch from 1c7b487 to 1f5b322 Compare March 28, 2022 01:56

tnqn approved these changes Mar 28, 2022

View reviewed changes

tnqn merged commit 2698306 into antrea-io:main Mar 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[doc][flexible-ipam] Update document for Multiple-VLAN support #3507

[doc][flexible-ipam] Update document for Multiple-VLAN support #3507

gran-vmv commented Mar 23, 2022

codecov-commenter commented Mar 23, 2022 •

edited

annakhm Mar 24, 2022

gran-vmv Mar 25, 2022

annakhm Mar 24, 2022

gran-vmv Mar 25, 2022

tnqn Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 26, 2022

gran-vmv Mar 26, 2022 •

edited

tnqn Mar 26, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 25, 2022

gran-vmv Mar 26, 2022

jianjuns Mar 26, 2022

gran-vmv Mar 28, 2022

tnqn commented Mar 28, 2022

[doc][flexible-ipam] Update document for Multiple-VLAN support #3507

[doc][flexible-ipam] Update document for Multiple-VLAN support #3507

Conversation

gran-vmv commented Mar 23, 2022

codecov-commenter commented Mar 23, 2022 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gran-vmv Mar 26, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tnqn commented Mar 28, 2022

codecov-commenter commented Mar 23, 2022 •

edited

gran-vmv Mar 26, 2022 •

edited