bitnamicharts/flux
Bitnami Helm chart for Flux
100K+
Source Controller is a component of Flux. Flux is a tool for keeping Kubernetes clusters in sync with sources of configuration.
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.
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.
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.
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
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_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
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.
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 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.
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.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt 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 |
Name | Description | Value |
---|---|---|
kubeVersion | Override Kubernetes version | "" |
nameOverride | String to partially override common.names.name | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
namespaceOverride | String to fully override common.names.namespace | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
clusterDomain | Kubernetes cluster domain name | cluster.local |
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 deployment | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployment | ["infinity"] |
Name | Description | Value |
---|---|---|
kustomizeController.enabled | Enable Kustomize Controller | true |
kustomizeController.installCRDs | Flag to install Kustomize Controller CRDs | true |
kustomizeController.watchAllNamespaces | Watch for custom resources in all namespaces | true |
kustomizeController.image.registry | Kustomize Controller image registry | REGISTRY_NAME |
kustomizeController.image.repository | Kustomize Controller image repository | REPOSITORY_NAME/fluxcd-kustomize-controller |
kustomizeController.image.digest | Kustomize 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.pullPolicy | Kustomize Controller image pull policy | IfNotPresent |
kustomizeController.image.pullSecrets | Kustomize Controller image pull secrets | [] |
kustomizeController.image.debug | Enable Kustomize Controller image debug mode | false |
kustomizeController.replicaCount | Number of Kustomize Controller replicas to deploy | 1 |
kustomizeController.containerPorts.metrics | Kustomize Controller metrics container port | 8080 |
kustomizeController.containerPorts.health | Kustomize Controller health container port | 9440 |
kustomizeController.networkPolicy.enabled | Specifies whether a NetworkPolicy should be created | true |
kustomizeController.networkPolicy.allowExternal | Don't require server label for connections | true |
kustomizeController.networkPolicy.allowExternalEgress | Allow the pod to access any range of port and all destinations. | true |
kustomizeController.networkPolicy.kubeAPIServerPorts | List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security) | [] |
kustomizeController.networkPolicy.extraIngress | Add extra ingress rules to the NetworkPolicy | [] |
kustomizeController.networkPolicy.extraEgress | Add extra ingress rules to the NetworkPolicy | [] |
kustomizeController.networkPolicy.ingressNSMatchLabels | Labels to match to allow traffic from other namespaces | {} |
kustomizeController.networkPolicy.ingressNSPodMatchLabels | Pod labels to match to allow traffic from other namespaces | {} |
kustomizeController.livenessProbe.enabled | Enable livenessProbe on Kustomize Controller containers | true |
kustomizeController.livenessProbe.initialDelaySeconds | Initial delay seconds for livenessProbe | 5 |
kustomizeController.livenessProbe.periodSeconds | Period seconds for livenessProbe | 10 |
kustomizeController.livenessProbe.timeoutSeconds | Timeout seconds for livenessProbe | 5 |
kustomizeController.livenessProbe.failureThreshold | Failure threshold for livenessProbe | 5 |
kustomizeController.livenessProbe.successThreshold | Success threshold for livenessProbe | 1 |
kustomizeController.readinessProbe.enabled | Enable readinessProbe on Kustomize Controller containers | true |
kustomizeController.readinessProbe.initialDelaySeconds | Initial delay seconds for readinessProbe | 5 |
kustomizeController.readinessProbe.periodSeconds | Period seconds for readinessProbe | 10 |
kustomizeController.readinessProbe.timeoutSeconds | Timeout seconds for readinessProbe | 5 |
kustomizeController.readinessProbe.failureThreshold | Failure threshold for readinessProbe | 5 |
kustomizeController.readinessProbe.successThreshold | Success threshold for readinessProbe | 1 |
kustomizeController.startupProbe.enabled | Enable startupProbe on Kustomize Controller containers | false |
kustomizeController.startupProbe.initialDelaySeconds | Initial delay seconds for startupProbe | 5 |
kustomizeController.startupProbe.periodSeconds | Period 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