Main configuration
The main configuration options of esthesis EDGE consist of the following parameters:
Global configuration
NAME | DESCRIPTION |
---|---|
--set global.imagePullSecrets | The name of the secret to use when pulling the esthesis EDGE image from the registry. |
--set global.storageClass | The storage class to use when creating persistent volumes. |
ESTHESIS_REGISTRY --set global.esthesisRegistry | The URL of the esthesis registry to use when pulling images. |
--set global.timezone | The timezone to use when running the esthesis EDGE service. |
General configuration
NAME | DESCRIPTION |
---|---|
QUARKUS_DATASOURCE_USERNAME --set quarkus.datasource.username | The username to connect with to the MariaDB database. Default: esthesis-edge |
QUARKUS_DATASOURCE_PASSWORD --set quarkus.datasource.password | The password to connect with to the MariaDB database. Default: esthesis-edge |
QUARKUS_DATASOURCE_JDBC_URL --set quarkus.datasource.jdbc.url | The JDBC URL of the MariaDB database to use. Default: jdbc:mariadb://localhost:4306/esthesis-edge |
QUARKUS_DATASOURCE_DB_NAME --set mariadb.auth.database | The name of the database to use in the MariaDB database. Default: esthesis-edge |
QUARKUS_REST_CLIENT_ESTHESIS_AGENT_SERVICE_CLIENT_URL --set quarkus.restClient.esthesisAgentServiceClient.url | The URL of the esthesis Agent Service. Default: http://localhost:59070 |
ESTHESIS_EDGE_ADMIN_SECRET --set esthesis.edge.admin.secret | A secret token to use when calling the admin API. Default: ca820829-328f-41e0-9207-ef42372f94c3 |
ESTHESIS_EDGE_SYNC_CRON --set esthesis.edge.sync.cron | A Quartz-type cron expression, specifying the frequency in which esthesis EDGE tries to syncronise queued data to InfluxDB and esthesis CORE. Default: 0 0 * * * ? |
ESTHESIS_EDGE_PURGE_CRON --set esthesis.edge.purge.cron | A Quartz-type cron expression, specifying the frequency in which data purge is initiated. Default: 0 0 0 * * ? |
ESTHESIS_EDGE_PURGE_SUCCESSFUL_MINUTES --set esthesis.edge.purge.successfulMinutes | The number of minutes after which successfully synced data is purged. Default: 60 |
ESTHESIS_EDGE_PURGE_QUEUED_MINUTES --set esthesis.edge.queuedMinutes | The number of minutes after which queued data is purged. Default: 10080 (1 week) |
Service and Ingress configuration
NAME | DESCRIPTION |
---|---|
ESTHESIS_EDGE_SERVICE_PORT --set esthesis.edge.service.port | The port on which the esthesis EDGE service is exposed. Default: 80 |
ESTHESIS_EDGE_INFLUX_DB_SERVICE_PORT | The port on which InfluxDB service is exposed. Default: 8086 |
--set esthesis.edge.service.type | The type of the service to use when exposing the esthesis EDGE service. Default: ClusterIP |
--set esthesis.edge.ingress.enabled | Whether to create an Ingress resource for the esthesis EDGE service or not. Default: false |
--set esthesis.edge.ingress.certManagerClusterIssuer | The name of the ClusterIssuer to use when creating the Ingress resource. |
--set esthesis.edge.ingress.certManagerIssuer | The name of the Issuer to use when creating the Ingress resource. |
--set esthesis.edge.ingress.className | The class name of the Ingress resource to use when creating the Ingress resource. |
--set esthesis.edge.ingress.hostname | The host name to use when creating the Ingress resource. |
InfluxDB configuration (local data sync)
NAME | DESCRIPTION |
---|---|
ESTHESIS_EDGE_LOCAL_ENABLED --set esthesis.edge.local.enabled | Whether syncronising data to the InfluxDB database is enabled or not. Default: false |
ESTHESIS_EDGE_LOCAL_INFLUX_DB_URL --set esthesis.edge.local.influxDb.url | The URL of the InfluxDB database to use. Default: http://localhost:9086 |
ESTHESIS_EDGE_LOCAL_INFLUX_DB_TOKEN --set esthesis.edge.local.influxDb.token | The token to use when connecting to the InfluxDB database. Default: esthesis-edge |
ESTHESIS_EDGE_LOCAL_INFLUX_DB_BUCKET --set esthesis.edge.local.influxDb.bucket | The bucket to use when connecting to the InfluxDB database. Default: edge |
ESTHESIS_EDGE_LOCAL_INFLUX_DB_ORG --set esthesis.edge.local.influxDb.org | The organisation to use when connecting to the InfluxDB database. Default: esthesis |
ESTHESIS_EDGE_LOCAL_INFLUXD_DB_USERNAME | The username to use when connecting to the InfluxDB database. Default: esthesis-system |
ESTHESIS_EDGE_LOCAL_INFLUXD_DB_PASSWORD | The password to use when connecting to the InfluxDB database. Default: esthesis-system |
esthesis CORE configuration (core data sync)
NAME | DESCRIPTION |
---|---|
ESTHESIS_EDGE_CORE_PUSH_ENABLED --set esthesis.edge.core.push.enabled | Whether syncronising data to the esthesis CORE is enabled or not. Default: false |
ESTHESIS_EDGE_CORE_PUSH_URL --set esthesis.edge.core.push.url | The URL of the MQTT server used by esthesis CORE to use. Default: ssl://mosquitto.esthesis:8883 |
ESTHESIS_EDGE_CORE_PUSH_TOPIC_TELEMETRY --set esthesis.edge.core.push.topicTelemetry | The topic to use when pushing telemetry data to esthesis CORE. Default: esthesis/telemetry |
ESTHESIS_EDGE_CORE_PUSH_TOPIC_PING --set esthesis.edge.core.push.topicPing | The topic to use when pushing ping data to esthesis CORE. Default: esthesis/ping |
ESTHESIS_EDGE_CORE_REGISTRATION_ENABLED --set esthesis.edge.core.registration.enabled | Whether new esthesis EDGE devices are registered as devices in esthesis CORE or not. Default: false |
ESTHESIS_EDGE_CORE_REGISTRATION_CRON --set esthesis.edge.core.registration.cron | A Quartz-type cron expression, specifying the frequency in which esthesis EDGE tries to register new devices to esthesis CORE. Default: 0 0 * * * ? |
ESTHESIS_EDGE_CORE_REGISTRATION_SECRET --set esthesis.edge.core.registration.secret | The secret token to use when registering new devices in esthesis CORE. |
ESTHESIS_EDGE_CORE_TAGS --set esthesis.edge.core.registration.tags | The tags used to identify the device in esthesis CORE. Default: edge |
ESTHESIS_EDGE_CORE_KEY_ALGORITHM --set esthesis.edge.core.keyAlgorithm | The algorithm used to generate the device keys by esthesis CORE. Default: RSA |
ESTHESIS_EDGE_CORE_CERT --set esthesis.edge.core.cert | esthesis CORE certificate in Base64 format. Needed when connecting to MQTT via ssl://. |