Introducing our new CEO Don Johnson - Read More

bitnamicharts/flux

Verified Publisher

By VMware

Updated 1 day ago

Bitnami Helm chart for Flux

Helm
Image
Integration & Delivery
Monitoring & Observability
0

100K+

Bitnami package for Flux

Source Controller is a component of Flux. Flux is a tool for keeping Kubernetes clusters in sync with sources of configuration.

Overview of Flux

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

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

Introduction

This chart bootstraps a Flux 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+

Installing the Chart

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

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/flux

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 flux 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.

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.

Prometheus metrics

This chart can be integrated with Prometheus by setting *.metrics.enabled (under the helmController, imageAutomationController, imageReflectorController, kustomizeController, notificationController and sourceController sections) to true. This will expose Flux native Prometheus ports in the containers. Additionally, it will deploy several metrics services, which can be configured under the *.metrics.service section (under the helmController, imageAutomationController, imageReflectorController, kustomizeController, notificationController and sourceController sections). These metrics services will have the necessary annotations to be automatically scraped by Prometheus.

Prometheus requirements

It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.

Integration with Prometheus Operator

The chart can deploy ServiceMonitor objects for integration with Prometheus Operator installations. To do so, set the value *.metrics.serviceMonitor.enabled=true (under the helmController, imageAutomationController, imageReflectorController, kustomizeController, notificationController and sourceController sections). Ensure that the Prometheus Operator CustomResourceDefinitions are installed in the cluster or it will fail with the following error:

no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.

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
kubeVersionOverride Kubernetes version""
nameOverrideString to partially override common.names.name""
fullnameOverrideString to fully override common.names.fullname""
namespaceOverrideString to fully override common.names.namespace""
commonLabelsLabels to add to all deployed objects{}
commonAnnotationsAnnotations to add to all deployed objects{}
clusterDomainKubernetes cluster domain namecluster.local
extraDeployArray of extra objects to deploy with the release[]
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"]
Kustomize Controller Parameters
NameDescriptionValue
kustomizeController.enabledEnable Kustomize Controllertrue
kustomizeController.installCRDsFlag to install Kustomize Controller CRDstrue
kustomizeController.watchAllNamespacesWatch for custom resources in all namespacestrue
kustomizeController.image.registryKustomize Controller image registryREGISTRY_NAME
kustomizeController.image.repositoryKustomize Controller image repositoryREPOSITORY_NAME/fluxcd-kustomize-controller
kustomizeController.image.digestKustomize Controller image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended)""
kustomizeController.image.pullPolicyKustomize Controller image pull policyIfNotPresent
kustomizeController.image.pullSecretsKustomize Controller image pull secrets[]
kustomizeController.image.debugEnable Kustomize Controller image debug modefalse
kustomizeController.replicaCountNumber of Kustomize Controller replicas to deploy1
kustomizeController.containerPorts.metricsKustomize Controller metrics container port8080
kustomizeController.containerPorts.healthKustomize Controller health container port9440
kustomizeController.networkPolicy.enabledSpecifies whether a NetworkPolicy should be createdtrue
kustomizeController.networkPolicy.allowExternalDon't require server label for connectionstrue
kustomizeController.networkPolicy.allowExternalEgressAllow the pod to access any range of port and all destinations.true
kustomizeController.networkPolicy.kubeAPIServerPortsList of possible endpoints to kube-apiserver (limit to your cluster settings to increase security)[]
kustomizeController.networkPolicy.extraIngressAdd extra ingress rules to the NetworkPolicy[]
kustomizeController.networkPolicy.extraEgressAdd extra ingress rules to the NetworkPolicy[]
kustomizeController.networkPolicy.ingressNSMatchLabelsLabels to match to allow traffic from other namespaces{}
kustomizeController.networkPolicy.ingressNSPodMatchLabelsPod labels to match to allow traffic from other namespaces{}
kustomizeController.livenessProbe.enabledEnable livenessProbe on Kustomize Controller containerstrue
kustomizeController.livenessProbe.initialDelaySecondsInitial delay seconds for livenessProbe5
kustomizeController.livenessProbe.periodSecondsPeriod seconds for livenessProbe10
kustomizeController.livenessProbe.timeoutSecondsTimeout seconds for livenessProbe5
kustomizeController.livenessProbe.failureThresholdFailure threshold for livenessProbe5
kustomizeController.livenessProbe.successThresholdSuccess threshold for livenessProbe1
kustomizeController.readinessProbe.enabledEnable readinessProbe on Kustomize Controller containerstrue
kustomizeController.readinessProbe.initialDelaySecondsInitial delay seconds for readinessProbe5
kustomizeController.readinessProbe.periodSecondsPeriod seconds for readinessProbe10
kustomizeController.readinessProbe.timeoutSecondsTimeout seconds for readinessProbe5
kustomizeController.readinessProbe.failureThresholdFailure threshold for readinessProbe5
kustomizeController.readinessProbe.successThresholdSuccess threshold for readinessProbe1
kustomizeController.startupProbe.enabledEnable startupProbe on Kustomize Controller containersfalse
kustomizeController.startupProbe.initialDelaySecondsInitial delay seconds for startupProbe5
kustomizeController.startupProbe.periodSecondsPeriod seconds for startupProbe

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/flux/README.md

Docker Pull Command

docker pull bitnamicharts/flux
Bitnami