Skip to content

Latest commit

 

History

History
 
 

metallb

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
templates
templates
 
 
.helmignore
.helmignore
 
 
Chart.lock
Chart.lock
 
 
Chart.yaml
Chart.yaml
 
 
README.md
README.md
 
 
values.yaml
values.yaml
 
 

README.md

MetalLB packaged by Bitnami

MetalLB is a load-balancer implementation for bare metal Kubernetes clusters, using standard routing protocols.

Overview of MetalLB

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/metallb

Introduction

Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.

This chart bootstraps a MetalLB Controller Controller Deployment and a MetalLB Speaker Daemonset 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.

Looking to use MetalLB in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

Prerequisites

  • Kubernetes 1.19
  • Helm 3.2.0
  • Virtual IPs for Layer 2 or Route Reflector for BGP setup.

Installing the Chart

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

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

These commands deploy metallb 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

Uninstalling the Chart

To uninstall/delete the my-release helm release:

helm uninstall my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

Global parameters

Name Description Value
global.imageRegistry Global Docker image registry ""
global.imagePullSecrets Global Docker registry secret names as an array []

Common parameters

Name Description Value
kubeVersion Force target Kubernetes version (using Helm capabilities if not set) ""
nameOverride String to partially override metallb.fullname include (will maintain the release name) ""
fullnameOverride String to fully override metallb.fullname template ""
commonLabels Add labels to all the deployed resources {}
commonAnnotations Add annotations to all the deployed resources {}
extraDeploy Array of extra objects to deploy with the release []
diagnosticMode.enabled Enable diagnostic mode (all probes will be disabled and the command will be overridden) false
diagnosticMode.command Command to override all containers in the the deployment(s)/statefulset(s) ["sleep"]
diagnosticMode.args Args to override all containers in the the deployment(s)/statefulset(s) ["infinity"]
installCRDs Flag to install metallb CRDs true

MetalLB parameters

Name Description Value
rbac.create Specifies whether to install and use RBAC rules true
psp.create Whether to create a PodSecurityPolicy. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later false
networkPolicy.enabled Enable NetworkPolicy false
networkPolicy.ingressNSMatchLabels Allow connections from other namespaces {}
networkPolicy.ingressNSPodMatchLabels For other namespaces match by pod labels and namespace labels {}
prometheusRule.enabled Prometheus Operator alertmanager alerts are created false

Controller parameters

Name Description Value
controller.image.registry MetalLB Controller image registry docker.io
controller.image.repository MetalLB Controller image repository bitnami/metallb-controller
controller.image.tag MetalLB Controller image tag (immutable tags are recommended) 0.13.11-debian-11-r0
controller.image.digest MetalLB Controller image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag ""
controller.image.pullPolicy MetalLB Controller image pull policy IfNotPresent
controller.image.pullSecrets Specify docker-registry secret names as an array []
controller.updateStrategy.type Metallb controller deployment strategy type. RollingUpdate
controller.hostAliases Deployment pod host aliases []
controller.rbac.create create specifies whether to install and use RBAC rules. true
controller.psp.create Whether to create a PodSecurityPolicy. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later true
controller.priorityClassName Metallb controller pods' priorityClassName ""
controller.schedulerName Name of the k8s scheduler (other than default) ""
controller.terminationGracePeriodSeconds In seconds, time the given to the Metallb controller pod needs to terminate gracefully 0
controller.topologySpreadConstraints Topology Spread Constraints for pod assignment []
controller.resources.limits The resources limits for the container {}
controller.resources.requests The requested resources for the container {}
controller.nodeSelector Node labels for controller pod assignment {}
controller.tolerations Tolerations for controller pod assignment []
controller.affinity Affinity for controller pod assignment {}
controller.podAnnotations Controller Pod annotations {}
controller.podLabels Controller Pod labels {}
controller.podAffinityPreset Controller Pod affinitypreset. Allowed values: soft, hard ""
controller.podAntiAffinityPreset Controller Pod anti affinitypreset. Allowed values: soft, hard soft
controller.nodeAffinityPreset.type Controller Pod Node affinity preset. Allowed values: soft, hard ""
controller.nodeAffinityPreset.key Controller Pod Node affinity label key to match ""
controller.nodeAffinityPreset.values Controller Pod Node affinity label values to match []
controller.podSecurityContext.enabled Enabled Metallb Controller pods' Security Context true
controller.podSecurityContext.fsGroup Set Metallb Controller pod's Security Context fsGroup 1001
controller.containerSecurityContext.enabled Enabled Metallb Controller containers' Security Context true
controller.containerSecurityContext.runAsUser Set Metallb Controller containers' Security Context runAsUser 1001
controller.containerSecurityContext.runAsNonRoot Set Metallb Controller container's Security Context runAsNonRoot true
controller.containerSecurityContext.allowPrivilegeEscalation Enables privilege Escalation context for the pod. false
controller.containerSecurityContext.readOnlyRootFilesystem Allows the pod to mount the RootFS as ReadOnly true
controller.containerSecurityContext.capabilities.drop Drop capabilities for the securityContext []
controller.command Override default container command (useful when using custom images) []
controller.args Override default container args (useful when using custom images) []
controller.lifecycleHooks for the Metallb Controller container(s) to automate configuration before or after startup {}
controller.extraEnvVars Extra environment variable to pass to the running container. []
controller.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Metallb controller nodes ""
controller.extraEnvVarsSecret Name of existing Secret containing extra env vars for Metallb controller nodes ""
controller.extraVolumes Optionally specify extra list of additional volumes for the Metallb controller pod(s) []
controller.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Metallb controller container(s) []
controller.sidecars Add additional sidecar containers to the Metallb Controller pod(s) []
controller.initContainers Add additional init containers to the Metallb Controller pod(s) []
controller.serviceAccount.create Specifies whether a ServiceAccount should be created true
controller.serviceAccount.name Name of the service account to use. If not set and create is true, a name is generated using the fullname template. ""
controller.serviceAccount.automountServiceAccountToken Automount service account token for the server service account true
controller.serviceAccount.annotations Annotations for service account. Evaluated as a template. Only used if create is true. {}
controller.revisionHistoryLimit Configure the revisionHistoryLimit of the Controller deployment 3
controller.containerPorts.metrics Configures the ports the MetalLB Controller listens on for metrics 7472
controller.livenessProbe.enabled Enable livenessProbe true
controller.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 10
controller.livenessProbe.periodSeconds Period seconds for livenessProbe 10
controller.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 1
controller.livenessProbe.failureThreshold Failure threshold for livenessProbe 3
controller.livenessProbe.successThreshold Success threshold for livenessProbe 1
controller.readinessProbe.enabled Enable readinessProbe true
controller.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 10
controller.readinessProbe.periodSeconds Period seconds for readinessProbe 10
controller.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 1
controller.readinessProbe.failureThreshold Failure threshold for readinessProbe 3
controller.readinessProbe.successThreshold Success threshold for readinessProbe 1
controller.startupProbe.enabled Enable startupProbe false
controller.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 10
controller.startupProbe.periodSeconds Period seconds for startupProbe 10
controller.startupProbe.timeoutSeconds Timeout seconds for startupProbe 1
controller.startupProbe.failureThreshold Failure threshold for startupProbe 3
controller.startupProbe.successThreshold Success threshold for startupProbe 1
controller.customStartupProbe Custom liveness probe for the Web component {}
controller.customLivenessProbe Custom liveness probe for the Web component {}
controller.customReadinessProbe Custom readiness probe for the Web component {}
controller.logLevel Sets the controller log level. Does not work if the args are overridden info

Metallb controller Prometheus metrics export

Name Description Value
controller.metrics.enabled Enable the export of Prometheus metrics false
controller.metrics.service.port Prometheus metrics service port 7472
controller.metrics.service.annotations Annotations for the Prometheus Exporter service service {}
controller.metrics.serviceMonitor.enabled Specify if a servicemonitor will be deployed for prometheus-operator false
controller.metrics.serviceMonitor.namespace Namespace which Prometheus is running in ""
controller.metrics.serviceMonitor.jobLabel Specify the jobLabel to use for the prometheus-operator app.kubernetes.io/name
controller.metrics.serviceMonitor.interval Scrape interval. If not set, the Prometheus default scrape interval is used ""
controller.metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended ""
controller.metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics []
controller.metrics.serviceMonitor.relabelings Specify general relabeling []
controller.metrics.serviceMonitor.selector ServiceMonitor selector labels {}
controller.metrics.serviceMonitor.labels Extra labels for the ServiceMonitor {}
controller.metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels false

Speaker parameters

Name Description Value
speaker.enabled Whether to enable BGP speakers or not true
speaker.image.registry MetalLB Speaker image registry docker.io
speaker.image.repository MetalLB Speaker image repository bitnami/metallb-speaker
speaker.image.tag MetalLB Speaker image tag (immutable tags are recommended) 0.13.11-debian-11-r0
speaker.image.digest MetalLB Speaker image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag ""
speaker.image.pullPolicy MetalLB Speaker image pull policy IfNotPresent
speaker.image.pullSecrets Specify docker-registry secret names as an array []
speaker.updateStrategy.type Speaker daemonset strategy type RollingUpdate
speaker.rbac.create create specifies whether to install and use RBAC rules. true
speaker.hostAliases Deployment pod host aliases []
speaker.psp.create Whether to create a PodSecurityPolicy. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later true
speaker.priorityClassName Speaker pods' priorityClassName ""
speaker.terminationGracePeriodSeconds In seconds, time the given to the Speaker pod needs to terminate gracefully 2
speaker.resources.limits The resources limits for the container {}
speaker.resources.requests The requested resources for the container {}
speaker.nodeSelector Node labels for speaker pod assignment {}
speaker.tolerations Tolerations for speaker pod assignment []
speaker.affinity Affinity for speaker pod assignment {}
speaker.nodeAffinityPreset.type Node affinity preset type. Ignored if speaker.affinity is set. Allowed values: soft or hard ""
speaker.nodeAffinityPreset.key Node label key to match. Ignored if speaker.affinity is set ""
speaker.nodeAffinityPreset.values Node label values to match. Ignored if speaker.affinity is set []
speaker.podAffinityPreset Pod affinity preset. Ignored if speaker.affinity is set. Allowed values: soft or hard ""
speaker.podAntiAffinityPreset Pod anti-affinity preset. Ignored if speaker.affinity is set. Allowed values: soft or hard soft
speaker.podAnnotations Speaker Pod annotations {}
speaker.podLabels Speaker Pod labels {}
speaker.podSecurityContext.enabled Enabled Speaker pods' Security Context true
speaker.podSecurityContext.fsGroup Set Speaker pod's Security Context fsGroup 0
speaker.containerSecurityContext.enabled Enabled Speaker containers' Security Context true
speaker.containerSecurityContext.runAsUser Set Speaker containers' Security Context runAsUser 0
speaker.containerSecurityContext.allowPrivilegeEscalation Enables privilege Escalation context for the pod. false
speaker.containerSecurityContext.readOnlyRootFilesystem Allows the pod to mount the RootFS as ReadOnly true
speaker.containerSecurityContext.capabilities.drop Drop capabilities for the securityContext []
speaker.containerSecurityContext.capabilities.add Add capabilities for the securityContext []
speaker.command Override default container command (useful when using custom images) []
speaker.args Override default container args (useful when using custom images) []
speaker.lifecycleHooks for the Speaker container(s) to automate configuration before or after startup {}
speaker.sidecars Add additional sidecar containers to the Speaker pod(s) []
speaker.initContainers Add additional init containers to the Speaker pod(s) []
speaker.serviceAccount.create Specifies whether a ServiceAccount should be created true
speaker.serviceAccount.name Name of the service account to use. If not set and create is true, a name is generated using the fullname template. ""
speaker.serviceAccount.automountServiceAccountToken Automount service account token for the server service account true
speaker.serviceAccount.annotations Annotations for service account. Evaluated as a template. Only used if create is true. {}
speaker.secretName References a Secret name for the member secret outside of the helm chart ""
speaker.secretKey References a Secret key the member secret outside of the helm chart ""
speaker.secretValue Custom value for speaker.secretKey ""
speaker.extraEnvVars Extra environment variable to pass to the running container. []
speaker.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Speaker nodes ""
speaker.extraEnvVarsSecret Name of existing Secret containing extra env vars for Speaker nodes ""
speaker.extraVolumes Optionally specify extra list of additional volumes for the Speaker pod(s) []
speaker.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Speaker container(s) []
speaker.containerPorts.metrics HTTP Metrics Endpoint 7472
speaker.livenessProbe.enabled Enable livenessProbe true
speaker.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 10
speaker.livenessProbe.periodSeconds Period seconds for livenessProbe 10
speaker.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 1
speaker.livenessProbe.failureThreshold Failure threshold for livenessProbe 3
speaker.livenessProbe.successThreshold Success threshold for livenessProbe 1
speaker.readinessProbe.enabled Enable readinessProbe true
speaker.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 10
speaker.readinessProbe.periodSeconds Period seconds for readinessProbe 10
speaker.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 1
speaker.readinessProbe.failureThreshold Failure threshold for readinessProbe 3
speaker.readinessProbe.successThreshold Success threshold for readinessProbe 1
speaker.startupProbe.enabled Enable startupProbe false
speaker.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 10
speaker.startupProbe.periodSeconds Period seconds for startupProbe 10
speaker.startupProbe.timeoutSeconds Timeout seconds for startupProbe 1
speaker.startupProbe.failureThreshold Failure threshold for startupProbe 3
speaker.startupProbe.successThreshold Success threshold for startupProbe 1
speaker.customStartupProbe Custom liveness probe for the Web component {}
speaker.customLivenessProbe Custom liveness probe for the Web component {}
speaker.customReadinessProbe Custom readiness probe for the Web component {}
speaker.logLevel Sets the speaker log level. Does not work if the args are overridden info

Speaker Prometheus metrics export

Name Description Value
speaker.metrics.enabled Enable the export of Prometheus metrics false
speaker.metrics.service.port Prometheus metrics service port 7472
speaker.metrics.service.annotations Annotations for the Prometheus Exporter service service {}
speaker.metrics.serviceMonitor.enabled Enable support for Prometheus Operator false
speaker.metrics.serviceMonitor.namespace Namespace which Prometheus is running in ""
speaker.metrics.serviceMonitor.jobLabel Job label for scrape target app.kubernetes.io/name
speaker.metrics.serviceMonitor.interval Scrape interval. If not set, the Prometheus default scrape interval is used ""
speaker.metrics.serviceMonitor.scrapeTimeout Timeout after which the scrape is ended ""
speaker.metrics.serviceMonitor.metricRelabelings Specify additional relabeling of metrics []
speaker.metrics.serviceMonitor.relabelings Specify general relabeling []
speaker.metrics.serviceMonitor.selector ServiceMonitor selector labels {}
speaker.metrics.serviceMonitor.labels Extra labels for the ServiceMonitor {}
speaker.metrics.serviceMonitor.honorLabels honorLabels chooses the metric's labels on collisions with target labels false 
helm install my-release \
  --set readinessProbe.successThreshold=5 \
    oci://registry-1.docker.io/bitnamicharts/metallb

The above command sets the readinessProbe.successThreshold to 5.

Configuration and installation details

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.

To configure MetalLB please look into the configuration section MetalLB Configuration.

Example IP addresses to assing to the LoadBalancer configuration

# The address-pools lists the IP addresses that MetalLB is
# allowed to allocate. You can have as many
# address pools as you want.
apiVersion: metallb.io/v1beta1
kind: IPAddressPool
metadata:
  # A name for the address pool. Services can request allocation
  # from a specific address pool using this name.
  name: first-pool
  namespace: metallb-system
spec:
  # A list of IP address ranges over which MetalLB has
  # authority. You can list multiple ranges in a single pool, they
  # will all share the same settings. Each range can be either a
  # CIDR prefix, or an explicit start-end range of IPs.
  addresses:
  - 192.168.10.0/24
  - 192.168.9.1-192.168.9.5
  - fc00:f853:0ccd:e799::/124

Troubleshooting

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

Upgrading

To 4.0.0

This major release includes the changes and features available in MetalLB from version 0.13.0. Those changes include the deprecation of configmaps for configuring the service and using CRDs instead. If you are upgrading from a previous version, you can follow the official documentation on how to migrate the configuration from a configMap to CRDs.

To 3.0.0

This major release renames several values in this chart and adds missing features, in order to be aligned with the rest of the assets in the Bitnami charts repository.

Affected values:

  • <controller/speaker>.prometheus has been renamed as <controller/speaker>.metrics.
  • To enable the Prometheus serviceMonitors, it is necessary to enable both <controller/speaker>.metrics.enabled and <controller/speaker>.metrics.serviceMonitor.enabled.
  • Added the values section <controller/speaker>.metrics.service.
  • <controller/speaker>.securityContext has been split as <controller/speaker>.podSecurityContext and <controller/speaker>.containerSecurityContext
  • controller.containerPort has been renamed as controller.containerPorts.
  • speaker.daemonset.hostPorts.metrics renamed as speaker.containerPorts.metrics
  • speaker.daemonset.terminationGracePeriodSeconds renamed as speaker.terminationGracePeriodSeconds

To 2.0.0

What changes were introduced in 2.0.0?

  • The .Values.prometheus section was moved into the components .Values.controller.prometheus and .Values.speaker.prometheus
  • The prometheus.prometheusRule which is used to toggle the deployment of the metallb alerts is moved under the root of the .Values.prometheusRule
  • A globel .Values.psp.create and .Values.rbac.create was introduced together with the option of toggeling for each component. (global option overwrites component options)
    • Values.controller.rbac.create and Values.controller.psp.create
    • Values.speaker.rbac.create and Values.speaker.psp.create

Considerations when upgrading to 2.0.0

  • Check if you used the prometheus section in you deployment.
  • If you do so, place the configuration you made into the sections controller.prometheus and speaker.prometheus.
  • prometheusRule should stay under the root of your values.

To 1.0.0

On November 13, 2020, Helm v2 support was formally finished, this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

What changes were introduced in 1.0.0?

  • Previous versions of this Helm Chart use apiVersion: v1 (installable by both Helm 2 and 3), this Helm Chart was updated to apiVersion: v2 (installable by Helm 3 only). Here you can find more information about the apiVersion field.
  • The different fields present in the Chart.yaml file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts

Considerations when upgrading to 1.0.0

  • If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues
  • If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore
  • If you installed the previous version with Helm v2 and wants to upgrade to this version with Helm v3, please refer to the official Helm documentation about migrating from Helm v2 to v3

Useful links

License

Copyright © 2023 VMware, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.