Introducing our new CEO Don Johnson - Read More

bitnamicharts/multus-cni

Verified Publisher

By VMware

Updated 1 day ago

Bitnami Helm chart for Multus CNI

Helm
Image
Networking
0

100K+

Bitnami package for Multus CNI

Multus is a CNI plugin for Kubernetes clusters. Written in Go, features adding multiple network interfaces to pods.

Overview of Multus CNI

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

helm install my-release oci://registry-1.docker.io/bitnamicharts/multus-cni

Looking to use Multus CNI in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

Introduction

This chart bootstraps a Multus CNI deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.0+
  • PV provisioner support in the underlying infrastructure
  • ReadWriteMany volumes for deployment scaling

Installing the Chart

To install the chart with the release name my-release:

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/multus-cni

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

The command deploys Multus CNI on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Configuration and installation details

Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Host configuration

Once installed, the helm chart will modify configuration files in the host nodes of the Kubernetes cluster. Ensure that the cluster allows root and privileged deployments.

Once the multus-cni configuration is installed, check the upstream Kubernetes documentation on how to modify the network settings of the cluster.

Important: Double check that the host CNI binary and configuration directories are properly configured, or the deployment will fail. This is done using the hostCNINetDir and hostCNIBinDir values.

Image

The image parameter allows specifying which image will be pulled for the chart.

Private registry

If you configure the image value to one in a private registry, you will need to specify an image pull secret.

  1. Manually create image pull secret(s) in the namespace. See this YAML example reference. Consult your image registry's documentation about getting the appropriate secret.

  2. Note that the imagePullSecrets configuration value cannot currently be passed to helm using the --set parameter, so you must supply these using a values.yaml file, such as:

    imagePullSecrets:
      - name: SECRET_NAME
    
  3. Install the chart

Setting Pod's affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod's affinity in the kubernetes documentation.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Backup and restore

To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.

Parameters

Global parameters
NameDescriptionValue
global.imageRegistryGlobal Docker image registry""
global.imagePullSecretsGlobal Docker registry secret names as an array[]
global.defaultStorageClassGlobal default StorageClass for Persistent Volume(s)""
global.storageClassDEPRECATED: use global.defaultStorageClass instead""
global.security.allowInsecureImagesAllows skipping image verificationfalse
global.compatibility.openshift.adaptSecurityContextAdapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation)auto
Common parameters
NameDescriptionValue
kubeVersionForce target Kubernetes version (using Helm capabilities if not set)""
nameOverrideString to partially override multus-cni.fullname template (will maintain the release name)""
fullnameOverrideString to fully override multus-cni.fullname template""
namespaceOverrideString to fully override common.names.namespace""
commonAnnotationsCommon annotations to add to all Multus CNI resources (sub-charts are not considered). Evaluated as a template{}
commonLabelsCommon labels to add to all Multus CNI resources (sub-charts are not considered). Evaluated as a template{}
extraDeployArray of extra objects to deploy with the release (evaluated as a template).[]
diagnosticMode.enabledEnable diagnostic mode (all probes will be disabled and the command will be overridden)false
diagnosticMode.commandCommand to override all containers in the deployment["sleep"]
diagnosticMode.argsArgs to override all containers in the deployment["infinity"]
Multus CNI parameters
NameDescriptionValue
image.registryMultus CNI image registryREGISTRY_NAME
image.repositoryMultus CNI Image nameREPOSITORY_NAME/multus-cni
image.digestMultus CNI image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag""
image.pullPolicyMultus CNI image pull policyIfNotPresent
image.pullSecretsSpecify docker-registry secret names as an array[]
image.debugSpecify if debug logs should be enabledfalse
CNIVersionCNI version0.3.0
hostCNIBinDirCNI binary dir in the host machine to mount/opt/cni/bin
hostCNINetDirCNI net.d dir in the host machine to mount/etc/cni/net.d
CNIMountPathPath inside the container to mount the CNI dirs/bitnami/multus-cni/host
commandOverride default container command (useful when using custom images)[]
argsOverride default container args (useful when using custom images)[]
updateStrategy.typeUpdate strategy - only really applicable for deployments with RWO PVs attachedRollingUpdate
priorityClassNameMultus CNI pods' priorityClassName""
schedulerNameName of the k8s scheduler (other than default)""
topologySpreadConstraintsTopology Spread Constraints for pod assignment[]
automountServiceAccountTokenMount Service Account token in podtrue
hostAliasesAdd deployment host aliases[]
extraEnvVarsExtra environment variables[]
extraEnvVarsCMConfigMap containing extra env vars""
extraEnvVarsSecretSecret containing extra env vars (in case of sensitive data)""
extraVolumesArray of extra volumes to be added to the deployment (evaluated as template). Requires setting extraVolumeMounts[]
extraVolumeMountsArray of extra volume mounts to be added to the container (evaluated as template). Normally used with extraVolumes.[]
initContainersAdd additional init containers to the pod (evaluated as a template)[]
sidecarsAttach additional containers to the pod (evaluated as a template)[]
tolerationsTolerations for pod assignment[]
networkPolicy.enabledSpecifies whether a NetworkPolicy should be createdtrue
networkPolicy.kubeAPIServerPortsList of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)[]
networkPolicy.allowExternalDon't require server label for connectionstrue
networkPolicy.allowExternalEgressAllow the pod to access any range of port and all destinations.true
networkPolicy.extraIngressAdd extra ingress rules to the NetworkPolicy[]
networkPolicy.extraEgressAdd extra ingress rules to the NetworkPolicy[]
networkPolicy.ingressNSMatchLabelsLabels to match to allow traffic from other namespaces{}
networkPolicy.ingressNSPodMatchLabelsPod labels to match to allow traffic from other namespaces{}
podAffinityPresetPod affinity preset. Ignored if affinity is set. Allowed values: soft or hard""
podAntiAffinityPresetPod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hardsoft
nodeAffinityPreset.typeNode affinity preset type. Ignored if affinity is set. Allowed values: soft or hard""
nodeAffinityPreset.keyNode label key to match Ignored if affinity is set.""
nodeAffinityPreset.valuesNode label values to match. Ignored if affinity is set.[]
affinityAffinity for pod assignment{}
nodeSelectorNode labels for pod assignment. Evaluated as a template.{}
resourcesPresetSet container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).nano
resourcesSet container requests and limits for different resources like CPU or memory (essential for production workloads)

Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/multus-cni/README.md

Docker Pull Command

docker pull bitnamicharts/multus-cni
Bitnami