Add cookbook on how to use Antrea with Multus #1223

antoninbas · 2020-09-09T23:29:08Z

We add documentation to show how Antrea can be used with Multus: Antrea
is used as the default CNI plugin and an "arbitrary" plugin (in our
case, macvlan) can be used to attach additional interfaces to designated
Pods. Nothing is required on the Antrea side to make it work, so this is
just to show how it can be used in practice.

Fixes #368

antrea-bot · 2020-09-09T23:29:21Z

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

/test-e2e: to trigger e2e tests.
/skip-e2e: to skip e2e tests.
/test-conformance: to trigger conformance tests.
/skip-conformance: to skip conformance tests.
/test-whole-conformance: to trigger all conformance tests on linux.
/skip-whole-conformance: to skip all conformance tests on linux.
/test-networkpolicy: to trigger networkpolicy tests.
/skip-networkpolicy: to skip networkpolicy tests.
/test-windows-conformance: to trigger windows conformance tests.
/skip-windows-conformance: to skip windows conformance tests.
/test-windows-networkpolicy: to trigger windows networkpolicy tests.
/skip-windows-networkpolicy: to skip windows networkpolicy tests.
/test-hw-offload: to trigger ovs hardware offload test.
/skip-hw-offload: to skip ovs hardware offload test.
/test-all: to trigger all tests (except whole conformance).
/skip-all: to skip all tests (except whole conformance).

codecov-commenter · 2020-09-09T23:32:31Z

Codecov Report

Merging #1223 into master will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1223      +/-   ##
==========================================
- Coverage   54.99%   54.96%   -0.04%     
==========================================
  Files         110      110              
  Lines       10573    10573              
==========================================
- Hits         5815     5811       -4     
- Misses       4185     4187       +2     
- Partials      573      575       +2

Flag	Coverage Δ
#integration-tests	`44.96% <ø> (ø)`
#unit-tests	`41.76% <ø> (-0.05%)`	⬇️

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

Impacted Files	Coverage Δ
pkg/apiserver/handlers/endpoint/handler.go	`58.82% <0.00%> (-11.77%)`	⬇️
pkg/apiserver/storage/ram/store.go	`77.44% <0.00%> (-1.51%)`	⬇️

jianjuns

Took a quick review. Overall looks good to me. Feel a little uncertain regarding to the DHCP daemon Docker image.

jianjuns · 2020-09-16T00:45:09Z

docs/cookbooks/multus/README.md

+All the required software will be deployed using YAML manifests, and the
+corresponding container images will be downloaded from public registries.
+
+macvlan requires the network to be able to handle "promiscuous mode", as the


I feel this description is not accurate, for promisc mode is configured on the NIC device, but not on the network, and if the underlay network supports MAC learning promisc mode NICs should work fine.
But I know some hypervisor networking requires promisc mode settings on the vSwitch port, and other documentation describes it the same way, so probably not a big deal.

And this requirement should be for macvlan bridge mode only?

I clarified by mentioning that this is for macvlan "bridge" mode.

Regarding your first comment, I don't think the following is too misleading:

macvlan requires the network to be able to handle "promiscuous mode"

A lot of pieces can be involved:

hypervisor

physical NIC

underlying network: won't work on public cloud (as you said it needs to support MAC learning)

Not disagree what you said.

jianjuns · 2020-09-16T00:47:48Z

docs/cookbooks/multus/README.md

+### Step 1: Deploying Antrea
+
+```bash
+kubectl apply -f https://github.com/vmware-tanzu/antrea/releases/download/v0.9.2/antrea.yml


Would you consider ToT of the master?

docs/cookbooks/multus/README.md

jianjuns · 2020-09-16T00:53:22Z

docs/cookbooks/multus/build/cni-dhcp-daemon/README.md

+
+```bash
+docker build -t antrea/cni-dhcp-daemon:latest .
+docker push antrea/cni-dhcp-daemon:latest


Not sure if it is too much for us to maintain a DHCP daemon image to demonstrate Multus.

I don't believe this will be a maintenance burden. I can always move the image to my personal Github / Dockerhub accounts, but I don't think this is a better solution. I couldn't find a good existing image anywhere either.

Ok. No strong opinion on this.

jianjuns

A few extra comments.

jianjuns · 2020-09-20T05:45:40Z

docs/cookbooks/multus/README.md

+ * when using VMware Fusion, enable "promiscuous mode" in the guest (Node) for
+   the appropriate interface (e.g. using `ifconfig`); this may prompt for your
+   password on the host unless you uncheck `Require authentication to enter
+   promiscuous mode` in the Network Preferences


Network Preferences -> Network Preferences?

Replaced with the actual menu names: Preferences ... > Network

jianjuns · 2020-09-20T05:49:38Z

docs/cookbooks/multus/README.md

+This manifest will create a DaemonSet that will run a bash script once on every
+Node. It will:
+ * Enable promiscuous mode on the parent interface using `ifconfig`; if using a
+   virtual network for the Nodes, this does not replace enabling promiscuous


I am not sure I understood this sentence. Would you consider rephrasing?

Hopefully it's clearer now, especially with the pointer to the Prerequisites section

docs/cookbooks/multus/test/Vagrantfile

jianjuns · 2020-09-20T05:58:36Z

docs/cookbooks/multus/assets/testbed-multus-macvlan.svg

@@ -0,0 +1,1931 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>


Do you think better to add "br-int" to the OVS bridge box?

Done, thanks for pointing this out, I don't know how I missed adding this the first time

We add documentation to show how Antrea can be used with Multus: Antrea is used as the default CNI plugin and an "arbitrary" plugin (in our case, macvlan) can be used to attach additional interfaces to designated Pods. Nothing is required on the Antrea side to make it work, so this is just to show how it can be used in practice. Fixes antrea-io#368

antoninbas · 2020-09-21T19:06:44Z

/skip-all

vmwclabot added the cla-not-required label Sep 9, 2020

antoninbas requested review from tnqn, abhiraut, jianjuns, McCodeman and salv-orlando September 9, 2020 23:29

antoninbas added the kind/documentation Categorizes issue or PR as related to a documentation. label Sep 10, 2020

antoninbas force-pushed the add-cookbook-for-antrea-with-multus branch 4 times, most recently from 500ed5c to fa00318 Compare September 14, 2020 21:25

jianjuns reviewed Sep 16, 2020

View reviewed changes

jianjuns reviewed Sep 20, 2020

View reviewed changes

antoninbas added 2 commits September 21, 2020 11:07

Address Jianjun's review comments

f2b3e97

antoninbas force-pushed the add-cookbook-for-antrea-with-multus branch from 3fa7a6f to e5d58ff Compare September 21, 2020 18:08

Address Jianjun's review comments

299985a

antoninbas force-pushed the add-cookbook-for-antrea-with-multus branch from e5d58ff to 299985a Compare September 21, 2020 18:10

jianjuns approved these changes Sep 21, 2020

View reviewed changes

antoninbas merged commit 0fc008f into antrea-io:master Sep 21, 2020

antoninbas deleted the add-cookbook-for-antrea-with-multus branch September 21, 2020 19:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cookbook on how to use Antrea with Multus #1223

Add cookbook on how to use Antrea with Multus #1223

antoninbas commented Sep 9, 2020

antrea-bot commented Sep 9, 2020

codecov-commenter commented Sep 9, 2020 •

edited

Loading

jianjuns left a comment

jianjuns Sep 16, 2020

jianjuns Sep 16, 2020

antoninbas Sep 16, 2020

jianjuns Sep 18, 2020

jianjuns Sep 16, 2020

antoninbas Sep 16, 2020

jianjuns Sep 16, 2020

antoninbas Sep 16, 2020

jianjuns Sep 18, 2020

jianjuns left a comment

jianjuns Sep 20, 2020

antoninbas Sep 21, 2020

jianjuns Sep 20, 2020

antoninbas Sep 21, 2020

jianjuns Sep 20, 2020

antoninbas Sep 21, 2020

antoninbas commented Sep 21, 2020

		@@ -0,0 +1,1931 @@
		<?xml version="1.0" encoding="UTF-8" standalone="no"?>

Add cookbook on how to use Antrea with Multus #1223

Add cookbook on how to use Antrea with Multus #1223

Conversation

antoninbas commented Sep 9, 2020

antrea-bot commented Sep 9, 2020

codecov-commenter commented Sep 9, 2020 • edited Loading

Codecov Report

jianjuns left a 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

jianjuns left a 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

antoninbas commented Sep 21, 2020

codecov-commenter commented Sep 9, 2020 •

edited

Loading