Manage environment variables in your InfluxDB Cluster
Use environment variables to define settings for individual components in your
InfluxDB cluster and adjust your cluster’s running configuration.
Define environment variables for each component in your AppInstance
resource.
InfluxDB Clustered components support various environment variables. While many of these variables have default settings, you can customize them by setting your own values.
Overriding default settings may affect overall cluster performance
InfluxDB Clustered components have complex interactions that can be affected when overriding default configuration settings. Changing these settings may impact overall cluster performance. Before making configuration changes using environment variables, consider consulting InfluxData Support to identify any potential unintended consequences.
AppInstance component schema
In your AppInstance
resource, configure individual component settings in the
spec.package.spec.components
property. This property supports the following
InfluxDB Clustered component keys:
ingester
querier
router
compactor
garbage-collector
apiVersion: kubecfg.dev/v1alpha1
kind: AppInstance
metadata:
name: influxdb
namespace: influxdb
spec:
package:
# ...
spec:
components:
ingester:
# Ingester settings ...
querier:
# Querier settings ...
router:
# Router settings. ...
compactor:
# Compactor settings ...
garbage-collector:
# Garbage collector settings ...
For more information about components in the InfluxDB v3 storage engine, see the InfluxDB v3 storage engine architecture.
Set environment variables for a component
Under the specific component property, use the
<component>.template.containers.iox.env
property to define environment variables.In the
env
property, structure each environment variable as a key-value pair. For example, to configure environment variables for the Garbage collector:apiVersion: kubecfg.dev/v1alpha1 kind: AppInstance metadata: name: influxdb namespace: influxdb spec: package: # ... spec: components: garbage-collector: template: containers: iox: env: INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF: '6h' INFLUXDB_IOX_GC_PARQUETFILE_CUTOFF: '6h'
Use
kubectl apply
to apply the configuration changes to your cluster and add or update environment variables in each component.kubectl apply \ --filename myinfluxdb.yml \ --namespace influxdb
Update environment variables instead of removing them
Most configuration settings that can be overridden by environment variables have
default values that are used if the environment variable is unset. Removing
environment variables from your AppInstance
resource configuration will not
remove those environment variables entirely; instead, they will revert to their
default settings. To revert to the default settings, simply unset the
environment variable or update the value in your AppInstance
resource to the
default value.
In the preceding example, the INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF
environment
variable is set to 6h
. If you remove INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF
from
the env
property, the cutoff reverts to its default setting of 30d
.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.