1
0
mirror of https://github.com/k8snetworkplumbingwg/multus-cni.git synced 2025-05-11 01:44:58 +00:00
A CNI meta-plugin for multi-homed pods in Kubernetes
Go to file
Tomofumi Hayashi 4eac660359 Introduce gopkg.in for go module
This change introduces gopkg.in to allow everyone to use multus
code as library. Currently multus-cni uses version 'v3', hence
it hits go modules limitation, as  describes.

This change fix  with gopkg.in.
2020-05-15 21:33:26 +09:00
.github Skip docker push action if REPOSITORY_PASS is not set 2020-04-21 21:54:44 +09:00
checkpoint Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
doc Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
e2e Add e2e test with kind in CI pipeline 2020-02-13 17:02:22 +09:00
examples changes sleep in docs to example that uses a trap INT 2019-06-10 21:35:15 +09:00
images Move pre-1.16 Kubernetes assets to a deprecated folder (to later remove) 2020-05-08 09:50:33 +09:00
k8sclient Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
kubeletclient Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
logging Unit tests and update to quickstart guide () 2019-08-05 15:04:35 -04:00
multus Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
netutils Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
testing Logging improvement (UID, net-attach-def) 2020-03-23 21:32:33 +09:00
types Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
vendor Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
.gitignore Removes duplicate NetworkAttachment CRD ref 2019-10-21 10:42:49 -04:00
.goreleaser.yml Fix goreleaser file for build-release error 2020-03-16 21:58:41 +09:00
.travis.yml Fix travis CI 2020-02-10 16:01:18 +09:00
build Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
CONTRIBUTING.md Update CONTRIBUTING.md 2017-09-26 13:53:10 +01:00
Dockerfile Updates Dockerfile to golang 1.13 (specifying version) 2020-04-20 21:44:17 +09:00
Dockerfile.arm64 Add Dockerfile for building image on arm64 2020-03-19 22:41:27 +09:00
Dockerfile.openshift [dockerfile] Use ENV GO111MODULE=off when building from openshift/origin-release:golang-1.10 2019-09-02 16:55:04 +09:00
Dockerfile.ppc64le Multi architecture image and CI job 2019-07-30 07:59:30 +09:00
go.mod Introduce gopkg.in for go module 2020-05-15 21:33:26 +09:00
go.sum Add error message in case of unexpected situation 2020-04-21 21:42:57 +09:00
LICENSE Initial commit 2016-12-13 14:48:12 +00:00
README.md Added coveralls badge () 2019-08-23 09:42:51 -04:00
test.sh Change .goreleaser.yml to support go module build 2019-06-24 16:50:30 +09:00

Multus-CNI

multus-cni Logo

Travis CIGo 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-you-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 Intel-Corp Slack, or open up a GitHub issue.