3 minute read
Environment variables are used to setup and customize your system to your needs. The United Manufacturing Hub has a lot of different microservices you can enable or disable via environment variables. Additionally those microservices have settings you can set with those environment variables.
This webpage shows you how to change them and what variables are accessible.
The environment variables are specified in a .yaml file. You can either directly change them in the file or use our Management SaaS tool to generate the file according to your needs. The latter option eliminates the risk of invalid .yaml files.
Path | Description | Type | Possible values | Example value | Example value 2 |
---|---|---|---|---|---|
_000_commonConfig/datasources/sensorconnect/enabled | Enables or disables sensorconnect microservice. | bool | true, false | true | |
_000_commonConfig/datasources/sensorconnect/iprange | The IP range to search for ifm gateways. | string | All subnets in CIDR notation | 172.16.0.0/24 | |
_000_commonConfig/serialNumber | Usually the hostname. This will be used for the creation of the MQTT/Kafka topic. ia/raw/TRANSMITTERID/… | string | all | 2021-0156 | development |
sensorconnect/storageRequest | ToDo | string | 1Gi | ||
sensorconnect/ioddfilepath | A persistent path, to save downloaded IODD files at | string | All valid paths | /tmp/iodd | |
sensorconnect/lowerPollingTime | The fastest time to read values from connected sensors in milliseconds | int | all | 100 | |
sensorconnect/upperPollingTime | The slowest time to read values from connected sensors in milliseconds. To disable this feature, set this variable to the same value as lowerPollingTime | int | all | 100 | |
sensorconnect/pollingSpeedStepUpMs | The time to add to the actual tick rate in case of a failure (incremental) | int | all | 10 | |
sensorconnect/pollingSpeedStepDownMs | The time to subtract from actual tick rate in case of a failure (incremental) | int | all | 10 | |
sensorconnect/sensorInitialPollingTimeMs | The tick speed, that sensor connect will start from. Set a bit higher than LOWER_POLLING_TIME_MS to allow sensors to recover from faults easier | int | all | 100 | |
sensorconnect/maxSensorErrorCount | After this numbers on errors, the sensor will be removed until the next device scan | int | all | 50 | |
sensorconnect/deviceFinderTimeSec | Seconds between scanning for new devices | int | all | 10 | |
sensorconnect/deviceFinderTimeoutSec | Timeout per device for scan response | int | all | 10 | |
sensorconnect/additionalSleepTimePerActivePortMs | This adds a sleep per active port on an IO-Link master | float | all | 0.0 | |
sensorconnect/allowSubTwentyMs | Allows query times below 20MS. DO NOT activate this, if you are unsure, that your devices survive this load. | bool | 0, 1 | 0 | |
sensorconnect/additionalSlowDownMap | A json map of additional slowdowns per device. Identificates can be Serialnumber, Productcode or URL | int | all | [] | json[{"serialnumber":"000200610104","slowdown_ms":-10},{"url":"http://192.168.0.13","slowdown_ms":20},{"productcode":"AL13500","slowdown_ms":20.01}] |
sensorconnect/debug | Set to 1 to enable debug output | bool | 0, 1 | 0 | |
sensorconnect/resources/requests/cpu | CPU usage sensorconnect is guaranteed to get in milliCPU | string | 2m | ||
sensorconnect/resources/requests/memory | Memory usage sensorconnect is guaranteed to get in MiB | string | 200Mi | ||
sensorconnect/resources/limits/cpu | CPU usage sensorconnect can get maximally in milliCPU. Sensorconnect will be throttled to stay below the limit. | string | 5m | ||
sensorconnect/resources/limits/memory | Memory usage sensorconnect can get maximally in MiB. If the container goes past the memory limit, it will be terminated by kubernetes. | string | 500Mi |