1
0
mirror of https://github.com/k8snetworkplumbingwg/multus-cni.git synced 2025-05-09 16:57:40 +00:00
A CNI meta-plugin for multi-homed pods in Kubernetes
Go to file
Doug Smith f6298a3a29
Merge pull request from s1061123/dev/use-ghcr
Change github action to use ghcr.io
2021-03-12 14:51:45 -05:00
.github Change github action to use ghcr.io 2021-03-13 04:38:21 +09:00
cmd Bump libcni version 2021-03-11 04:50:21 +09:00
deployments Change github action to use ghcr.io 2021-03-13 04:38:21 +09:00
docs Provide the option to not to log via STDERR 2021-03-10 17:13:12 +09:00
e2e Add e2e tests for default-route annotation 2020-09-14 12:56:12 +09:00
examples Fix link to an example pod with SRIOV network 2021-03-11 16:48:04 +02:00
hack Restructured multus to use Go standard project layout. 2020-12-16 22:38:10 +09:00
images Provide the option to not to log via STDERR 2021-03-10 17:13:12 +09:00
pkg Bump libcni version 2021-03-11 04:50:21 +09:00
vendor Bump libcni version 2021-03-11 04:50:21 +09:00
.gitignore Update e2e 2020-09-04 02:20:35 +09:00
.goreleaser.yml Update github actions CI pipeline including lint error fix 2021-02-23 20:01:34 +09:00
.travis.yml Restructured multus to use Go standard project layout. 2020-12-16 22:38:10 +09:00
CODE_OF_CONDUCT.md Adds code of conduct 2020-06-05 09:18:10 +09:00
CONTRIBUTING.md Update CONTRIBUTING.md 2017-09-26 13:53:10 +01:00
go.mod Bump libcni version 2021-03-11 04:50:21 +09:00
go.sum Bump libcni version 2021-03-11 04:50:21 +09:00
LICENSE Initial commit 2016-12-13 14:48:12 +00:00
README.md Fix invite to NPWG slack 2021-03-02 04:39:51 +09:00

Multus-CNI

multus-cni Logo

BuildTestGo Report CardCoverage Status

Multus CNI enables attaching multiple network interfaces to pods in Kubernetes.

How it works

Multus CNI is a container network interface (CNI) plugin for Kubernetes that enables attaching multiple network interfaces to pods. Typically, in Kubernetes each pod only has one network interface (apart from a loopback) -- with Multus you can create a multi-homed pod that has multiple interfaces. This is accomplished by Multus acting as a "meta-plugin", a CNI plugin that can call multiple other CNI plugins.

Multus CNI follows the Kubernetes Network Custom Resource Definition De-facto Standard to provide a standardized method by which to specify the configurations for additional network interfaces. This standard is put forward by the Kubernetes Network Plumbing Working Group.

Multus is one of the projects in the Baremetal Container Experience kit

Multi-Homed pod

Here's an illustration of the network interfaces attached to a pod, as provisioned by Multus CNI. The diagram shows the pod with three interfaces: eth0, net0 and net1. eth0 connects kubernetes cluster network to connect with kubernetes server/services (e.g. kubernetes api-server, kubelet and so on). net0 and net1 are additional network attachments and connect to other networks by using other CNI plugins (e.g. vlan/vxlan/ptp).

multus-pod-image

Quickstart Installation Guide

The quickstart installation method for Multus requires that you have first installed a Kubernetes CNI plugin to serve as your pod-to-pod network, which we refer to as your "default network" (a network interface that every pod will be creatd with). Each network attachment created by Multus will be in addition to this default network interface. For more detail on installing a default network CNI plugins, refer to our quick-start guide.

Clone this GitHub repository, we'll apply a daemonset which installs Multus using to kubectl from this repo. From the root directory of the clone, apply the daemonset YAML file:

$ cat ./images/multus-daemonset.yml | kubectl apply -f -

This will configure your systems to be ready to use Multus CNI, but, to get started with adding additional interfaces to your pods, refer to our complete quick-start guide

Additional installation Options

  • Install via daemonset using the quick-start guide, above.
  • Download binaries from release page
  • By Docker image from Docker Hub
  • Or, roll-your-own and build from source

Comprehensive Documentation

Contact Us

For any questions about Multus CNI, feel free to ask a question in #general in the NPWG Slack, or open up a GitHub issue. Request an invite to NPWG slack here.