osp-influxdb

Overview

This module is used to store the Analytics data.

List of configuration files

Note

This module has no configurations files

Environment Variables

All modules env variables

Variable Name	Default Value	Usage
PROMETHEUS_PORT	9100	The internal port used for Openmetrics exposition.
DISPATCHER_HOST	modules_configuration-dispatcher_main	The hostname on which the modules can fetch the configuration.
DISPATCHER_PORT	10000	The port used by the module to listen for configuration request.
USE_LEGACY_RESTART	Not set	When this flag is enabled, the container will terminate itself whenever a restart is needed (for example, after a configuration change). This is the legacy restart (before version 2.1.0). Otherwise, the system will simply restart the process running inside the container.
CUSTOM_JVM_OPTIONS	Not set	Allow to inject JVM options. See Configuration changes for more information.
ALLOW_VERSION_MISMATCH	Not set	Allow to disable the version check when a new configuration is published to a module. By default, a module will not be restarted if its configuration does not match its version.

Dedicated variables

Variable name	Default value	Usage
DOCKER_INFLUXDB_INIT_USERNAME_FILE	‘/run/secrets/admin-user’	The username for the first account.
DOCKER_INFLUXDB_INIT_PASSWORD_FILE	‘/run/secrets/admin-pwd’	The password for the first account.
DOCKER_INFLUXDB_INIT_ORG	‘OnSphere’	The initial organization.
DOCKER_INFLUXDB_INIT_BUCKET	‘month’	The initial bucket name.
DOCKER_INFLUXDB_INIT_RETENTION	30d	The initial bucket retention.
DOCKER_INFLUXDB_INIT_ADMIN_TOKEN		The initial token.
DOCKER_INFLUXDB_INIT_MODE	‘setup’	The initialization mode.

Password

Following secrets need to be created before the first deployment:

• admin-user with the username for the admin user

• admin-pwd with the password for the admin user

Changing password

To change the user password, following steps are needed:

• Connect to the influx console.

• Use the command influx user password -n <username>.

• On docker, create a new secret with the new password.

• On the module.service of Influx, add or modify the environment variable DOCKER_INFLUXDB_INIT_PASSWORD_FILE with the new secret /run/secrets/<new-admin-pwd>.

• Push the configuration.

Healthcheck

The healthcheck is done with the command :

HEALTHCHECK --start-period=300s --timeout=15s --interval=15s CMD influx ping || exit 1

Persistent storage

The osp-influxdb plugin stores the history of the values and its configuration on:

• /var/lib/influxdb2 which is linked to the volume osp-influxdb-data-1.

• /etc/influxdb2 which is link to the volume osp-influxdb-config-1.

Note

See persistent storage section for more details