use-cases: add VPP directions #25

egernst · 2018-03-12T19:04:39Z

this PR creates a use-cases subdirectory and adds an initial use case,
booting a kata container which makes use of vpp vhost-user interface.

Going forward, will add similar documents for SRIOV support, vhost-user-scsi / SPDK, RDMA, QAT, etc.

This starts to address #22

Signed-off-by: Eric Ernst eric.ernst@intel.com

jodh-intel · 2018-03-13T09:19:57Z

use-cases/using-vpp-and-kata.md

+# Setup to run VPP
+
+The Data Plane Development Kit (DPDK) is a set of libraries and drivers for
+fast packet processing. The Vector Packet Processing (VPP) is a platform


s/The Vector Packet Processing/Vector Packet Processing/ ?

jodh-intel · 2018-03-13T09:20:49Z

use-cases/using-vpp-and-kata.md

+extensible framework which provides out-of-the-box production quality
+switch and router functionality. VPP is a high performance packet-processing
+stack which can run on commodity CPUs. Enabling VPP with DPDK support can
+yield significant performance improvements over a Linux\*-bridge providing a


s/Linux*-bridge/Linux* bridge/ ?

jodh-intel · 2018-03-13T09:22:04Z

use-cases/using-vpp-and-kata.md

+enable memory preallocation and huge page support:
+
+```
+sudo sed -i -e 's/^# *\(enable_hugepages\).*=.*$/\1 = true/g' /usr/share/defaults/kata-containers/configuration.toml


Can you add a $ prefix here?

You mentioned memory prealloc earlier, but havent enabled it in the config here. Is memory prealloc really required?

jodh-intel · 2018-03-13T09:22:39Z

use-cases/using-vpp-and-kata.md

+Follow  the [Kata Containers' setup instructions](https://github.com/kata-containers/documentation/wiki/Developer-Guide).
+
+In order to make use of vhost-user based interfaces, the container needs to be backed
+by huge pages.  After enabling huge-pages support on the host system, update the Kata configuration to


I think it would be clearer to state somewhere in this paragraph that "huge pages" are a kernel feature.

I think it will be useful to specify the kernel configuration that needs to be checked for huge pages as well. Along with the kernel configuration, it is also necessary to enable huge pages on the kernel command line as well iirc.
Will be useful to mention a check for that.

jodh-intel · 2018-03-13T09:23:09Z

use-cases/using-vpp-and-kata.md

+
+In order to make use of vhost-user based interfaces, the container needs to be backed
+by huge pages.  After enabling huge-pages support on the host system, update the Kata configuration to
+enable memory preallocation and huge page support:


How about changing this to:

and huge page support in the guest kernel:

jodh-intel · 2018-03-13T09:25:40Z

use-cases/using-vpp-and-kata.md

@@ -0,0 +1,76 @@
+# Setup to run VPP


Pet peeve - could you consider adding a table of contents here? That would make it much clearer which level each section is part of.

jodh-intel · 2018-03-13T09:26:55Z

use-cases/using-vpp-and-kata.md

+To create a network and connect Kata Containers easily to that network via
+Docker, install a VPP Docker plugin.
+
+To install the plugin, you can follow the [plugin installation instructions](https://github.com/clearcontainers/vpp).


Should we be linking to a Clear Containers repo here? Maybe we should consider creating a new repo under Kata for this?

I'm fine either way - it isn't clear or kata specific really, though.

jodh-intel · 2018-03-13T09:36:24Z

use-cases/using-vpp-and-kata.md

+$ sudo docker rm $(sudo docker ps --no-trunc -aq)
+$ sudo docker network rm vpp_net
+$ sudo service vpp stop
+$ sudo service vpp start


Why is the service being restarted?

But if it needs to be, why not sudo systemctl restart vpp?

you're right - not necessary.

jodh-intel · 2018-03-13T09:37:15Z

use-cases/using-vpp-and-kata.md

+use this branch's runtime:
+
+```
+$ sudo docker run --net=vpp_net --ip=192.168.1.2 --mac-address=CA:FE:CA:FE:01:02 -it debian bash -c "ip a; ip route; sleep 300"


Our informal "standard image" is busybox (as it's one of the smallest), and docker pull time will be minimised if you specify that.

amshinde · 2018-03-13T22:41:01Z

use-cases/using-vpp-and-kata.md

+Follow  the [Kata Containers' setup instructions](https://github.com/kata-containers/documentation/wiki/Developer-Guide).
+
+In order to make use of vhost-user based interfaces, the container needs to be backed
+by huge pages.  After enabling huge-pages support on the host system, update the Kata configuration to


I think it will be useful to specify the kernel configuration that needs to be checked for huge pages as well. Along with the kernel configuration, it is also necessary to enable huge pages on the kernel command line as well iirc.
Will be useful to mention a check for that.

amshinde · 2018-03-13T22:43:03Z

use-cases/using-vpp-and-kata.md

+enable memory preallocation and huge page support:
+
+```
+sudo sed -i -e 's/^# *\(enable_hugepages\).*=.*$/\1 = true/g' /usr/share/defaults/kata-containers/configuration.toml


You mentioned memory prealloc earlier, but havent enabled it in the config here. Is memory prealloc really required?

amshinde · 2018-03-13T22:53:56Z

use-cases/using-vpp-and-kata.md

+
+Follow the [VPP installation instructions](https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages).
+
+After a successful installation, your host system is ready to start


/is ready/should be ready/ ?

amshinde · 2018-03-13T22:54:23Z

use-cases/using-vpp-and-kata.md

+
+### Install the VPP Docker\* plugin
+
+To create a network and connect Kata Containers easily to that network via


/network/Docker network/?

amshinde · 2018-03-13T22:56:22Z

use-cases/using-vpp-and-kata.md

+```
+
+Test connectivity by launching two containers, assuming Docker is setup to
+use this branch's runtime:


Shouldnt you be getting rid of "assuming Docker is setup to use this branch's runtime"?

amshinde · 2018-04-12T22:35:37Z

@egernst Any update on this?

egernst · 2018-04-12T23:17:47Z

Shame on me. I'll work through these before tomorrow.

intelkevinputnam · 2018-07-23T19:21:46Z

@egernst @amshinde looks like this is still waiting for updates. If so, I'll hold off on grammar/wording review until those changes are completed.

jodh-intel · 2018-07-30T10:38:15Z

Hi @egernst - any chance you'll be able to update this PR this week?

jodh-intel · 2018-08-02T13:05:20Z

Hi @egernst - this has been open for 143 days. Please could you update "real soon now"... ? :)

@klynnrif - ptal.

klynnrif

Scrubbed for grammar, structure, and flow. A few suggestions. Thanks!

klynnrif · 2018-08-07T18:45:44Z

use-cases/using-vpp-and-kata.md

+
+The Data Plane Development Kit (DPDK) is a set of libraries and drivers for
+fast packet processing. The Vector Packet Processing (VPP) is a platform
+extensible framework which provides out-of-the-box production quality


sub out "which" for "that": extensible framework that provides out-of-the-box production quality

@egernst This needs to be addressed.

klynnrif · 2018-08-07T18:46:53Z

use-cases/using-vpp-and-kata.md

+fast packet processing. The Vector Packet Processing (VPP) is a platform
+extensible framework which provides out-of-the-box production quality
+switch and router functionality. VPP is a high performance packet-processing
+stack which can run on commodity CPUs. Enabling VPP with DPDK support can


sub out "which" for "that": stack that can run on commodity CPUs.

This as well.

klynnrif · 2018-08-07T18:48:46Z

use-cases/using-vpp-and-kata.md

+To create a network and connect Kata Containers easily to that network via
+Docker, install a VPP Docker plugin.
+
+To install the plugin, you can follow the [plugin installation instructions](https://github.com/clearcontainers/vpp).


Removing "you can":
To install the plugin, follow the plugin installation instructions.

klynnrif · 2018-08-07T18:49:35Z

use-cases/using-vpp-and-kata.md

+To install the plugin, you can follow the [plugin installation instructions](https://github.com/clearcontainers/vpp).
+
+This VPP plugin allows the creation of a VPP network. Every container added
+to this network will be connected via an L2 bridge-domain provided by VPP.


Suggested rewrite to stay active:
to this network is connected through an L2 bridge-domain provided by VPP.

klynnrif · 2018-08-07T18:50:17Z

use-cases/using-vpp-and-kata.md

+
+## Example: Launch two Kata Containers using VPP
+
+To use VPP, use Docker to create a network which will make use of VPP.


sub out "which" for "that" and rewrite to stay active:
To use VPP, use Docker to create a network that makes use of VPP.

egernst

believe it or not, tomorrow finally came; I made updates. take a look...

egernst · 2018-08-08T22:46:28Z

use-cases/using-vpp-and-kata.md

+# Setup to run VPP
+
+The Data Plane Development Kit (DPDK) is a set of libraries and drivers for
+fast packet processing. The Vector Packet Processing (VPP) is a platform


egernst · 2018-08-08T22:47:03Z

use-cases/using-vpp-and-kata.md

+
+The Data Plane Development Kit (DPDK) is a set of libraries and drivers for
+fast packet processing. The Vector Packet Processing (VPP) is a platform
+extensible framework which provides out-of-the-box production quality


egernst · 2018-08-08T22:47:07Z

use-cases/using-vpp-and-kata.md

+fast packet processing. The Vector Packet Processing (VPP) is a platform
+extensible framework which provides out-of-the-box production quality
+switch and router functionality. VPP is a high performance packet-processing
+stack which can run on commodity CPUs. Enabling VPP with DPDK support can


egernst · 2018-08-08T22:47:43Z

use-cases/using-vpp-and-kata.md

+extensible framework which provides out-of-the-box production quality
+switch and router functionality. VPP is a high performance packet-processing
+stack which can run on commodity CPUs. Enabling VPP with DPDK support can
+yield significant performance improvements over a Linux\*-bridge providing a


egernst · 2018-08-08T22:48:22Z

use-cases/using-vpp-and-kata.md

+
+In order to make use of vhost-user based interfaces, the container needs to be backed
+by huge pages.  After enabling huge-pages support on the host system, update the Kata configuration to
+enable memory preallocation and huge page support:


egernst · 2018-08-08T22:50:24Z

use-cases/using-vpp-and-kata.md

+To install the plugin, you can follow the [plugin installation instructions](https://github.com/clearcontainers/vpp).
+
+This VPP plugin allows the creation of a VPP network. Every container added
+to this network will be connected via an L2 bridge-domain provided by VPP.


egernst · 2018-08-08T22:52:57Z

use-cases/using-vpp-and-kata.md

+use this branch's runtime:
+
+```
+$ sudo docker run --net=vpp_net --ip=192.168.1.2 --mac-address=CA:FE:CA:FE:01:02 -it debian bash -c "ip a; ip route; sleep 300"


egernst · 2018-08-08T22:54:36Z

use-cases/using-vpp-and-kata.md

+```
+
+Test connectivity by launching two containers, assuming Docker is setup to
+use this branch's runtime:


egernst · 2018-08-08T22:55:03Z

use-cases/using-vpp-and-kata.md

+$ sudo docker rm $(sudo docker ps --no-trunc -aq)
+$ sudo docker network rm vpp_net
+$ sudo service vpp stop
+$ sudo service vpp start


you're right - not necessary.

egernst · 2018-08-08T22:56:08Z

use-cases/using-vpp-and-kata.md

+To create a network and connect Kata Containers easily to that network via
+Docker, install a VPP Docker plugin.
+
+To install the plugin, you can follow the [plugin installation instructions](https://github.com/clearcontainers/vpp).


I'm fine either way - it isn't clear or kata specific really, though.

egernst · 2018-08-09T14:42:00Z

@klynnrif @amshinde PTAL?

bergwolf · 2018-08-14T08:07:26Z

ping @klynnrif @amshinde @kata-containers/documentation

amshinde · 2018-08-15T06:29:27Z

@egernst Have you pushed your changes? I dont see the previous review comments addressed.

klynnrif · 2018-08-16T19:08:46Z

@egernst I don't see any changes from my first review comments - are they pushed? Thanks!

egernst · 2018-08-17T15:09:49Z

smh. git commit -a --amend!

Pushed.

egernst · 2018-08-17T21:22:22Z

@klynnrif @amshinde PTAL.

devimc

lgtm

klynnrif

lgtm - thanks!

amshinde · 2018-08-20T18:24:03Z

use-cases/using-vpp-and-kata.md

+```
+
+These commands setup two Kata Containers connected via a VPP L2 bridge
+domain. The first of the the VMs displays the networking details and then


/the the/the two/?

create a use-cases subdirectory and add an initial use case, booting a kata container which makes use of vpp vhost-user interface. Fixes: kata-containers#209 Signed-off-by: Eric Ernst <eric.ernst@intel.com>

Changed image-builder/image_builder.sh to automatically calculate the size of the root disk Fixes kata-containers#25. Signed-off-by: Harshal Patil <harshal.patil@in.ibm.com>

egernst added the review label Mar 12, 2018

jodh-intel reviewed Mar 13, 2018

View reviewed changes

amshinde reviewed Mar 13, 2018

View reviewed changes

klynnrif suggested changes Aug 7, 2018

View reviewed changes

egernst force-pushed the vpp-use-case-doc branch from 6b63590 to 89a1d23 Compare August 8, 2018 23:08

egernst commented Aug 8, 2018

View reviewed changes

egernst force-pushed the vpp-use-case-doc branch from 89a1d23 to dbd9677 Compare August 17, 2018 15:09

devimc approved these changes Aug 20, 2018

View reviewed changes

klynnrif approved these changes Aug 20, 2018

View reviewed changes

amshinde reviewed Aug 20, 2018

View reviewed changes

use-cases: add VPP directions

1f80ea8

create a use-cases subdirectory and add an initial use case, booting a kata container which makes use of vpp vhost-user interface. Fixes: kata-containers#209 Signed-off-by: Eric Ernst <eric.ernst@intel.com>

egernst force-pushed the vpp-use-case-doc branch from dbd9677 to 1f80ea8 Compare August 21, 2018 19:05

amshinde approved these changes Aug 21, 2018

View reviewed changes

amshinde merged commit b594fd3 into kata-containers:master Aug 21, 2018

egernst removed the review label Aug 21, 2018


		Follow the [VPP installation instructions](https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages).

		After a successful installation, your host system is ready to start


		### Install the VPP Docker\* plugin

		To create a network and connect Kata Containers easily to that network via


		## Example: Launch two Kata Containers using VPP

		To use VPP, use Docker to create a network which will make use of VPP.

use-cases: add VPP directions #25

use-cases: add VPP directions #25

Uh oh!

Conversation

egernst commented Mar 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amshinde commented Apr 12, 2018

Uh oh!

egernst commented Apr 12, 2018

Uh oh!

intelkevinputnam commented Jul 23, 2018

Uh oh!

jodh-intel commented Jul 30, 2018

Uh oh!

jodh-intel commented Aug 2, 2018

Uh oh!

klynnrif left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

egernst commented Mar 12, 2018 •

edited

Loading