Bitnami Stack for InfluxDB(TM)¶

InfluxDB(TM) is an open source time-series database. It is a core component of the TICK (Telegraf, InfluxDB(TM), Chronograf, Kapacitor) stack.

Overview of InfluxDB™

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

TL;DR¶

使用加速地址添加仓库:

helm repo add bitnami "https://helm-charts.itboon.top/bitnami" --force-update
helm update bitnami

helm install my-release bitnami/influxdb

Introduction¶

This chart bootstraps a influxdb 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.

Looking to use InfluxDB## Prerequisitestrade; in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

Prerequisites¶

• Kubernetes 1.19+
• Helm 3.2.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 bitnami/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.

Tip: List all releases using helm list

Uninstalling the Chart¶

To uninstall/delete the my-release statefulset:

helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release. Use the option --purge to delete all history too.

Parameters¶

Global parameters¶

Common parameters¶

InfluxDB™ parameters¶

InfluxDB Collectd™ parameters¶

Exposing parameters¶

Metrics parameters¶

Volume permissions parameters¶

InfluxDB™ backup parameters¶

RBAC Parameters¶

| Name | Description | Value | | serviceAccount.create | Specifies whether a ServiceAccount should be created | true | | serviceAccount.name | Name of the service account to use. If not set and create is true, a name is generated using the fullname template. | "" | | serviceAccount.automountServiceAccountToken | Automount service account token for the server service account | true | | serviceAccount.annotations | Annotations for service account. Evaluated as a template. Only used if create is 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 | | rbac.create | Create Role and RoleBinding (required for PSP to work) | false |

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install my-release \
  --set auth.admin.username=admin-user bitnami/influxdb

The above command sets the InfluxDB™ admin user to admin-user.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

helm install my-release -f values.yaml bitnami/influxdb

Tip: You can use the default values.yaml

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.

This chart installs a deployment with the following configuration:

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

Configure the way how to expose InfluxDB™¶

• Ingress: The ingress controller must be installed in the Kubernetes cluster. Set ingress.enabled=true to expose InfluxDB™ through Ingress.
• ClusterIP: Exposes the service on a cluster-internal IP. Choosing this value makes the service only reachable from within the cluster. Set influxdb.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 influxdb.service.type=NodePort to choose this service type.
• LoadBalancer: Exposes the service externally using a cloud provider's load balancer. Set influxdb.service.type=LoadBalancer to choose this service type.

Using custom configuration¶

This helm chart supports to customize the whole configuration file.

Add your custom configuration file to "files/conf" in your working directory. This file will be mounted as a configMap to the containers and it will be used for configuring InfluxDB™.

Alternatively, you can specify the InfluxDB™ configuration using the influxdb.configuration parameter.

In addition to these options, you can also set an external ConfigMap with all the configuration files. This is done by setting the influxdb.existingConfiguration parameter. Note that this will override the two previous options.

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™ image allows you to use your custom scripts to initialize a fresh instance. In order to execute the scripts, they must be located inside the chart folder files/docker-entrypoint-initdb.d so they can be consumed as a ConfigMap.

Alternatively, you can specify custom scripts using the influxdb.initdbScripts parameter.

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

The allowed extensions are .sh, and .txt.

Setting Pod's affinity¶

This chart allows you to set your custom affinity using the XXX.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 XXX.podAffinityPreset, XXX.podAntiAffinityPreset, or XXX.nodeAffinityPreset parameters.

Persistence¶

The data is 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 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 volumePermissions.securityContext.runAsUser to auto.

Troubleshooting¶

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

Upgrade¶

It's necessary to specify the existing passwords while performing an upgrade to ensure the secrets are not updated with invalid randomly generated passwords. Remember to specify the existing values of the auth.admin.password, user.pwd, auth.readUser.password and auth.writeUser.password parameters when upgrading the chart:

helm upgrade my-release bitnami/influxdb \
    --set auth.admin.password=[ADMIN_USER_PASSWORD] \
    --set auth.user.password=[USER_PASSWORD] \
    --set auth.readUser.password=[READ_USER_PASSWORD] \
    --set auth.writeUser.password=[WRITE_USER_PASSWORD]

Note: you need to substitute the placeholders [ADMIN_USER_PASSWORD], [USER_PASSWORD], [READ_USER_PASSWORD], and [WRITE_USER_PASSWORD] with the values obtained from instructions in the installation notes.

Upgrading¶

To 5.0.0¶

This major release completely removes support for InfluxDB Relay™ because the component is no longer maintained by the original developers. As a consequence, the "high-availability" architecture feature is no longer supported.

To update from the previous major, please follow this steps:

kubectl delete deployments.apps influxdb
helm upgrade influxdb bitnami/influxdb

To 4.0.0¶

This major release completely removes support for InfluxDB™ branch 1.x.x. You can use images for versions ~1.x.x taking into account the chart may need some modification to run with them.

If you were using InfluxDB™ +2.0 no issues are expected during upgrade.

To 3.0.0¶

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

Affected values:

• influxdb.service.port was deprecated, we recommend using influxdb.service.ports.http instead.
• influxdb.service.rpcPort was deprecated, we recommend using influxdb.service.ports.rpc instead.
• relay.service.port was deprecated, we recommend using relay.service.ports.http instead.
• relay.service.nodePort was renamed as relay.service.nodePorts.http.
• influxdb.securityContext split into influxdb.containerSecurityContext and influxdb.podSecurityContext.
• relay.securityContext split into relay.containerSecurityContext and relay.podSecurityContext.
• influxdb.updateStrategy and relay.updateStrategychanged from String type (previously default to 'rollingUpdate') to Object type, allowing users to configure other updateStrategy parameters, similar to other charts.

To 2.0.0¶

This version adds support to InfluxDB™ +2.0, since this version the chart is only verified to work with InfluxDB™ +2.0 bitnami images. However, you can use images for versions ~1.x.x taking into account the chart may need some modification to run with them.

Installing InfluxDB™ v1 in chart v2¶

helm install bitnami/influxdb --set image.tag=1.8.3-debian-10-r88

As a consecuece some breaking changes have been included in this version.

• Authentication values has been moved to auth.<property>....
• We keep auth.readUser and auth.writeUser user options in order to be compatible with InfluxDB™ v1. If you are using InfluxDB™ 2.0, please, use the CLI to create user and tokens through initDb scripts at influxdb.initdbScripts or the UI due to we are not able to automacally provide a token for them to be used. See more InfluxDB™ 2.0 auth
• InfluxDB™ 2.0 has removed database concept, now it is called Bucket so the property database has been also moved to auth.user.bucket.
• Removed support for files/docker-entrypoint-initdb.d/*.{sh,txt}, please use .influxdb.initdbScripts or .Values.influxdb.initdbScriptsCM instead.
• Removed support for files/conf/influxdb.conf, please use .influxdb.configuration or .influxdb.existingConfiguration instead.
• Removed support for files/conf/relay.toml, please use .Values.relay.configuration or .Values.relay.existingConfiguration instead.
• ingress.hosts parameter has been replaced by ingress.hostname and ingress.extraHosts that may give us a bit more flexibility.

Migrating form InfluxDB™ v1 to v2¶

Since this release could mean lot of concepts changes, we strongly recommend to not do it direcly using the chart upgrade. Please, read more info in their upgrade guide.

We actually recommend to backup all the data form a previous helm release, install new release using latest version of the chart and images and then restore data following their guides.

Upgrading the chart form 1.x.x to 2.x.x using InfluxDB™ v1 images¶

NOTE: Please, create a backup of your database before running any of those actions.

Having an already existing chart release called influxdb and deployed like

helm install influxdb bitnami/influxdb

Export secrets and required values to update¶

export INFLUXDB_ADMIN_PASSWORD=$(kubectl get secret --namespace default influxdb -o jsonpath="{.data.admin-user-password}" | base64 -d)

Upgrade the chart release¶

NOTE: Please remember to migrate all the values to its new path following the above notes, e.g: adminUser.pwd -> auth.admin.password.

helm upgrade influxdb bitnami/influxdb --set image.tag=1.8.3-debian-10-r99 \
  --set auth.admin.password=${INFLUXDB_ADMIN_PASSWORD}

To 1.1.0¶

This version introduces bitnami/common, a library chart as a dependency. More documentation about this new utility could be found here. Please, make sure that you have updated the chart dependencies before executing any upgrade.

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 this major version?¶

• 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 this version¶

• 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¶

• https://docs.bitnami.com/tutorials/resolve-helm2-helm3-post-migration-issues/
• https://helm.sh/docs/topics/v2_v3_migration/
• https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/

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.