bitnamicharts/influxdb repository overview

⁠Bitnami Stack for InfluxDB™ Core

InfluxDB™ Core is an open source time-series database. It is a core component of the FDAP (Apache Flight, DataFusion, Arrow, and Parquet) stack.

Overview of InfluxDB™ InfluxDB™ Core⁠

InfluxDB™ is a trademark owned by InfluxData, which is not affiliated with, and does not endorse, this site.

⁠ TL;DR

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

⁠ Introduction

This chart bootstraps a influxdb⁠ deployment on a Kubernetes⁠ cluster using the Helm⁠ package manager.

⁠ Before you begin

• Kubernetes 1.23+
• Helm 3.8.0+
• PV provisioner support in the underlying infrastructure

⁠ Installing the Chart

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

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

These commands deploy influxdb on the Kubernetes cluster in the default configuration. The Parameters⁠ section lists the parameters that can be configured during installation.

⁠ Configuration and installation details

This section describes credentials, configuration, and other installation options.

⁠ Configure the way how to expose InfluxDB™ Core

This chart installs a deployment with the following configuration:

                ------------------
               |     Ingress      |
               |    Controller    |
                ------------------
                        |
                        | /query
                        | /write
                        \/
                 ----------------
                |  InfluxDB(TM)  |
                |      svc       |
                 ----------------
                        |
                        \/
                  --------------
                 | InfluxDB(TM) |
                 |    Server    |
                 |     Pod      |
                  --------------

• Gateway API HTTPRoute: Requires a Gateway API controller to be installed in the Kubernetes cluster. Set httpRoute.enabled=true to expose InfluxDB™ Core through HTTPRoute.
• Ingress: The ingress controller must be installed in the Kubernetes cluster. Set ingress.enabled=true to expose InfluxDB™ Core through Ingress.
• ClusterIP: Exposes the service on a cluster-internal IP. Choosing this value makes the service only reachable from within the cluster. Set service.type=ClusterIP to choose this service type.
• NodePort: Exposes the service on each Node's IP at a static port (the NodePort). You'll be able to contact the NodePort service, from outside the cluster, by requesting NodeIP:NodePort. Set service.type=NodePort to choose this service type.
• LoadBalancer: Exposes the service externally using a cloud provider's load balancer. Set service.type=LoadBalancer to choose this service type.

⁠ Configure the Object Store

InfluxDB™ Core supports different storage systems to store Parquet files (refer to upstream documentation⁠ for more information about the supported object stores) that we can divide into three categories:

• Memory: This is the default object store. It stores all data in memory and is not persistent. This is suitable for testing and development purposes.
• File: This object store stores data in files on the local filesystem.
• Cloud: This object store stores data in a cloud provider's object storage service (e.g., AWS S3, Google Cloud Storage, Azure Blob Storage).

This chart allows you to configure the object store using the objectStore parameter. If you're using a Cloud storage, there are additional parameters to configure such as the Cloud specific credentials or the bucket name.

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

⁠ Update credentials

This chart supports creating a random admin token at first boot (not supported when using memory as object store) by setting both the auth.enabled and createAdminTokenJob.enabled parameters to true. As an alternative, the chart also supports consuming credentials from an existing secret by setting the auth.existingSecret and auth.existingSecretAdminTokenKey parameters. However, please note that this is only supported if you have pre-populated data in your object store with an admin token already created.

Any further change in the credentials require manual intervention, please refer instructions below:

• Create an admin token following the upstream documentation⁠ if no admin token was created during the first boot.
• Regenerate the admin token following the upstream documentation⁠.

⁠ Securing traffic using TLS

This chart supports configuring TLS encryption for InfluxDB™ Core connections by setting tls.enabled parameter to true.

It is necessary to create a secret containing the TLS certificates and pass it to the chart via the tls.server.existingSecret parameter. The secret should contain a tls.server.crt and tls.server.key keys including the certificate and key files respectively.

You can manually create the required TLS certificates or relying on the chart auto-generation capabilities. The chart supports two different ways to auto-generate the required certificates:

• Using Helm capabilities. Enable this feature by setting tls.autoGenerated.enabled to true and tls.autoGenerated.engine to helm.
• Relying on CertManager (please note it's required to have CertManager installed in your K8s cluster). Enable this feature by setting tls.autoGenerated.enabled to true and tls.autoGenerated.engine to cert-manager. Please note it's supported to use an existing Issuer/ClusterIssuer for issuing the TLS certificates by setting the tls.autoGenerated.certManager.existingIssuer and tls.autoGenerated.certManager.existingIssuerKind parameters.

⁠ Prometheus metrics

This chart can be integrated with Prometheus by setting metrics.enabled to true. This will add the required annotations on InfluxDB™ Core service 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. 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.

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

⁠ Adding extra environment variables

In case you want to add extra environment variables, you can use the influxdb.extraEnvVars property.

extraEnvVars:
  - name: INFLUXDB_DATA_QUERY_LOG_ENABLED
    value: "true"

⁠ Initialize a fresh instance

The Bitnami InfluxDB™ Core⁠ image allows you to use your custom scripts to initialize a fresh instance (the allowed extension is .sh). In order to execute the scripts, you can specify custom scripts using the initdbScripts parameter.

In addition to this option, you can also set an external ConfigMap with all the initialization scripts. This is done by setting the initdbScriptsCM parameter. Note that this will override the two previous options. parameter.

⁠ Setting Pod's affinity

This chart allows you to set your custom affinity using the affinity parameter(s). 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⁠.

⁠ FIPS parameters

The FIPS parameters only have effect if you are using images from the Bitnami Secure Images catalog⁠.

For more information on this new support, please refer to the FIPS Compliance section⁠.

⁠ Persistence

When using file as object store, data can be persisted by default using PVC(s). You can disable the persistence setting the persistence.enabled parameter to false.

A default StorageClass is needed in the Kubernetes cluster to dynamically provision the volumes. Specify another StorageClass in the persistence.storageClass or set persistence.existingClaim if you have already existing persistent volumes to use.

⁠ Adjust permissions of persistent volume mountpoint

As the images run as non-root by default, it is necessary to adjust the ownership of the persistent volumes so that the containers can write data into it.

By default, the chart is configured to use Kubernetes Security Context to automatically change the ownership of the volume. However, this feature does not work in all Kubernetes distributions. As an alternative, this chart supports using an initContainer to change the ownership of the volume before mounting it in the final destination. You can enable this initContainer by setting defaultInitContainers.volumePermissions.enabled to true.

There are K8s distribution, such as OpenShift, where you can dynamically define the UID to run this initContainer. To do so, set the defaultInitContainers.volumePermissions.securityContext.runAsUser to auto.

⁠ Parameters

The following subsections list global, common, and component-specific parameters.

⁠ Global parameters

⁠ Common parameters

⁠ InfluxDB(TM) Core parameters

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://techdocs.broadcom.com/us/en/vmware-tanzu/bitnami-secure-images/bitnami-secure-images/services/bsi-app-doc/apps-charts-influxdb-index.html⁠