Microservices

• 1: Barcodereader
• 2: Cache
• 3: Data Bridge
• 4: Database
• 5: Factoryinsight
• 6: Grafana
• 7: Kafka Bridge
• 8: Kafka Broker
• 9: Kafka Console
• 10: Kafka to Postgresql
• 11: Kafka to Postgresql v2
• 12: MQTT Broker
• 13: MQTT Kafka Bridge
• 14: MQTT Simulator
• 15: MQTT to Postgresql
• 16: Node-RED
• 17: OPCUA Simulator
• 18: PackML Simulator
• 19: Sensorconnect
• 20: Tulip Connector

1 - Barcodereader

Kubernetes resources

• Deployment: united-manufacturing-hub-barcodereader
• Secret: united-manufacturing-hub-barcodereader-secrets

Configuration

Environment variables

2 - Cache

Kubernetes resources

• StatefulSet: united-manufacturing-hub-redis-master
• Service:
  • Internal ClusterIP:
    • Redis: united-manufacturing-hub-redis-master at port 6379
    • Headless: united-manufacturing-hub-redis-headless at port 6379
    • Metrics: united-manufacturing-hub-redis-metrics at port 6379
• ConfigMap:
  • Configuration: united-manufacturing-hub-redis-configuration
  • Health: united-manufacturing-hub-redis-health
  • Scripts: united-manufacturing-hub-redis-scripts
• Secret: redis-secret
• PersistentVolumeClaim: redis-data-united-manufacturing-hub-redis-master-0

Configuration

You shouldn’t need to configure the cache manually, as it’s configured automatically when the cluster is deployed. However, if you need to change the configuration, you can do it by editing the redis section of the Helm chart values file.

You can consult the Bitnami Redis chart for more information about the available configuration options.

Environment variables

3 - Data Bridge

Kubernetes resources

• Deployment: united-manufacturing-hub-databridge-0
• Secret: united-manufacturing-hub-databridge-mqtt-secrets

Configuration

You shouldn’t need to configure the environment variables directly, as they are set by the Helm chart. If you need to change them, you can do so by editing the values in the Helm chart.

Environment variables

4 - Database

Kubernetes resources

• StatefulSet: united-manufacturing-hub-timescaledb
• Service:
  • Internal ClusterIP for the replicas: united-manufacturing-hub-replica at port 5432
  • Internal ClusterIP for the config: united-manufacturing-hub-config at port 8008
  • External LoadBalancer: united-manufacturing-hub at port 5432
• ConfigMap:
  • Patroni: united-manufacturing-hub-timescaledb-patroni
  • Post init: timescale-post-init
  • Postgres BackRest: united-manufacturing-hub-timescaledb-pgbackrest
  • Scripts: united-manufacturing-hub-timescaledb-scripts
• Secret:
  • Certificate: united-manufacturing-hub-certificate
  • Patroni credentials: united-manufacturing-hub-credentials
  • Users passwords: timescale-post-init-pw
• PersistentVolumeClaim:
  • Data: storage-volume-united-manufacturing-hub-timescaledb-0
  • WAL-E: wal-volume-united-manufacturing-hub-timescaledb-0

Configuration

There is only one parameter that usually needs to be changed: the password used to connect to the database. To do so, set the value of the db_password key in the _000_commonConfig.datastorage section of the Helm chart values file.

Environment variables

5 - Factoryinsight

Kubernetes resources

• Deployment: united-manufacturing-hub-factoryinsight-deployment
• Service:
  • Internal ClusterIP: united-manufacturing-hub-factoryinsight-service at port 80
  • External : Access factoryinsight outside the cluster
• Secret: factoryinsight-secret

Configuration

You shouldn’t need to configure Factoryinsight manually, as it’s configured automatically when the cluster is deployed. However, if you need to change the configuration, you can do it by editing the factoryinsight section of the Helm chart values file.

Environment variables

API documentation

6 - Grafana

Kubernetes resources

• Deployment: united-manufacturing-hub-grafana
• Service:
  • External LoadBalancer: united-manufacturing-hub-grafana at port 8080
• ConfigMap: united-manufacturing-hub-grafana
• Secret: grafana-secret
• PersistentVolumeClaim: united-manufacturing-hub-grafana

Configuration

Grafana is configured through its user interface. The default credentials are found in the grafana-secret Secret.

The Grafana installation that is provided by the United Manufacturing Hub is shipped with a set of preinstalled plugins:

• ACE.SVG by Andrew Rodgers
• Button Panel by CloudSpout LLC
• Button Panel by UMH Systems Gmbh
• Discrete by Natel Energy
• Dynamic Text by Marcus Olsson
• FlowCharting by agent
• Pareto Chart by isaozler
• Pie Chart (old) by Grafana Labs
• Timepicker Buttons Panel by williamvenner
• UMH Datasource by UMH Systems Gmbh
• UMH Datasource v2 by UMH Systems Gmbh
• Untimely by factry
• Worldmap Panel by Grafana Labs

Environment variables

7 - Kafka Bridge

Kubernetes resources

• Deployment: united-manufacturing-hub-kafkabridge
• Secret:
  • Local broker: united-manufacturing-hub-kafkabridge-secrets-local
  • Remote broker: united-manufacturing-hub-kafkabridge-secrets-remote

Configuration

You can configure the kafka-bridge microservice by setting the following values in the _000_commonConfig.kafkaBridge section of the Helm chart values file.

  kafkaBridge:
    enabled: true
    remotebootstrapServer: ""
    topicmap:
      - bidirectional: false
        name: HighIntegrity
        send_direction: to_remote
        topic: ^ia\..+\..+\..+\.((addMaintenanceActivity)|(addOrder)|(addParentToChild)|(addProduct)|(addShift)|(count)|(deleteShiftByAssetIdAndBeginTimestamp)|(deleteShiftById)|(endOrder)|(modifyProducedPieces)|(modifyState)|(productTag)|(productTagString)|(recommendation)|(scrapCount)|(startOrder)|(state)|(uniqueProduct)|(scrapUniqueProduct))$
      - bidirectional: false
        name: HighThroughput
        send_direction: to_remote
        topic: ^ia\..+\..+\..+\.(processValue).*$

Topic Map schema

The topic map is a list of objects, each object represents a topic (or a set of topics) that should be forwarded. The following JSON schema describes the structure of the topic map:

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "array",
    "title": "Kafka Topic Map",
    "description": "This schema validates valid Kafka topic maps.",
    "default": [],
    "additionalItems": true,
    "items": {
        "$id": "#/items",
        "anyOf": [
            {
                "$id": "#/items/anyOf/0",
                "type": "object",
                "title": "Unidirectional Kafka Topic Map with send direction",
                "description": "This schema validates entries, that are unidirectional and have a send direction.",
                "default": {},
                "examples": [
                    {
                        "name": "HighIntegrity",
                        "topic": "^ia\\..+\\..+\\..+\\.(?!processValue).+$",
                        "bidirectional": false,
                        "send_direction": "to_remote"
                    }
                ],
                "required": [
                    "name",
                    "topic",
                    "bidirectional",
                    "send_direction"
                ],
                "properties": {
                    "name": {
                        "$id": "#/items/anyOf/0/properties/name",
                        "type": "string",
                        "title": "Entry Name",
                        "description": "Name of the map entry, only used for logging & tracing.",
                        "default": "",
                        "examples": [
                            "HighIntegrity"
                        ]
                    },
                    "topic": {
                        "$id": "#/items/anyOf/0/properties/topic",
                        "type": "string",
                        "title": "The topic to listen on",
                        "description": "The topic to listen on, this can be a regular expression.",
                        "default": "",
                        "examples": [
                            "^ia\\..+\\..+\\..+\\.(?!processValue).+$"
                        ]
                    },
                    "bidirectional": {
                        "$id": "#/items/anyOf/0/properties/bidirectional",
                        "type": "boolean",
                        "title": "Is the transfer bidirectional?",
                        "description": "When set to true, the bridge will consume and produce from both brokers",
                        "default": false,
                        "examples": [
                            false
                        ]
                    },
                    "send_direction": {
                        "$id": "#/items/anyOf/0/properties/send_direction",
                        "type": "string",
                        "title": "Send direction",
                        "description": "Can be either 'to_remote' or 'to_local'",
                        "default": "",
                        "examples": [
                            "to_remote",
                            "to_local"
                        ]
                    }
                },
                "additionalProperties": true
            },
            {
                "$id": "#/items/anyOf/1",
                "type": "object",
                "title": "Bi-directional Kafka Topic Map with send direction",
                "description": "This schema validates entries, that are bi-directional.",
                "default": {},
                "examples": [
                    {
                        "name": "HighIntegrity",
                        "topic": "^ia\\..+\\..+\\..+\\.(?!processValue).+$",
                        "bidirectional": true
                    }
                ],
                "required": [
                    "name",
                    "topic",
                    "bidirectional"
                ],
                "properties": {
                    "name": {
                        "$id": "#/items/anyOf/1/properties/name",
                        "type": "string",
                        "title": "Entry Name",
                        "description": "Name of the map entry, only used for logging & tracing.",
                        "default": "",
                        "examples": [
                            "HighIntegrity"
                        ]
                    },
                    "topic": {
                        "$id": "#/items/anyOf/1/properties/topic",
                        "type": "string",
                        "title": "The topic to listen on",
                        "description": "The topic to listen on, this can be a regular expression.",
                        "default": "",
                        "examples": [
                            "^ia\\..+\\..+\\..+\\.(?!processValue).+$"
                        ]
                    },
                    "bidirectional": {
                        "$id": "#/items/anyOf/1/properties/bidirectional",
                        "type": "boolean",
                        "title": "Is the transfer bidirectional?",
                        "description": "When set to true, the bridge will consume and produce from both brokers",
                        "default": false,
                        "examples": [
                            true
                        ]
                    }
                },
                "additionalProperties": true
            }
        ]
    },
    "examples": [
   {
      "name":"HighIntegrity",
      "topic":"^ia\\..+\\..+\\..+\\.(?!processValue).+$",
      "bidirectional":true
   },
   {
      "name":"HighThroughput",
      "topic":"^ia\\..+\\..+\\..+\\.(processValue).*$",
      "bidirectional":false,
      "send_direction":"to_remote"
   }
]
}

Environment variables

8 - Kafka Broker

Kubernetes resources

• StatefulSet: united-manufacturing-hub-kafka
• Service:
  • Internal ClusterIP (headless): united-manufacturing-hub-kafka
  • External NodePort: united-manufacturing-hub-kafka-external at port 9094 for the Kafka API listener, port 9644 for the Admin API listener, port 8083 for the HTTP Proxy listener, and port 8081 for the Schema Registry listener.
• ConfigMap: united-manufacturing-hub-kafka
• Secret: united-manufacturing-hub-kafka-sts-lifecycle
• PersistentVolumeClaim: datadir-united-manufacturing-hub-kafka-0

Configuration

You shouldn’t need to configure the Kafka broker manually, as it’s configured automatically when the cluster is deployed. However, if you need to change the configuration, you can do it by editing the redpanda section of the Helm chart values file.

Environment variables

9 - Kafka Console

Kubernetes resources

• Deployment: united-manufacturing-hub-console
• Service:
  • External LoadBalancer: united-manufacturing-hub-console at port 8090
• ConfigMap: united-manufacturing-hub-console
• Secret: united-manufacturing-hub-console

Configuration

Environment variables

10 - Kafka to Postgresql

Kubernetes resources

• Deployment: united-manufacturing-hub-kafkatopostgresql
• Secret: united-manufacturing-hub-kafkatopostgresql-certificates

Configuration

You shouldn’t need to configure kafka-to-postgresql manually, as it’s configured automatically when the cluster is deployed. However, if you need to change the configuration, you can do it by editing the kafkatopostgresql section of the Helm chart values file.

Environment variables

11 - Kafka to Postgresql v2

Kubernetes resources

• Deployment: united-manufacturing-hub-kafkatopostgresqlv2

Configuration

You shouldn’t need to configure kafka-to-postgresql-v2 manually, as it’s configured automatically when the cluster is deployed. However, if you need to change the configuration, you can do it by editing the kafkatopostgresqlv2 section of the Helm chart values file.

Environment variables

12 - MQTT Broker

Kubernetes resources

• StatefulSet: united-manufacturing-hub-hivemqce
• Service:
  • Internal ClusterIP:
    • HiveMQ local: united-manufacturing-hub-hivemq-local-service at port 1883 (MQTT) and 8883 (MQTT over TLS)
    • VerneMQ (for backwards compatibility): united-manufacturing-hub-vernemq at port 1883 (MQTT) and 8883 (MQTT over TLS)
    • VerneMQ local (for backwards compatibility): united-manufacturing-hub-vernemq-local-service at port 1883 (MQTT) and 8883 (MQTT over TLS)
  • External LoadBalancer: united-manufacturing-hub-mqtt at port 1883 (MQTT) and 8883 (MQTT over TLS)
• ConfigMap:
  • Configuration: united-manufacturing-hub-hivemqce-hive
  • Credentials: united-manufacturing-hub-hivemqce-extension
• Secret: united-manufacturing-hub-hivemqce-secret-keystore
• PersistentVolumeClaim:
  • Data: united-manufacturing-hub-hivemqce-claim-data
  • Extensions: united-manufacturing-hub-hivemqce-claim-extensions

Configuration

Most of the configuration is done through the XML files in the ConfigMaps. The default configuration should be sufficient for most use cases.

The HiveMQ installation of the United Manufacturing Hub comes with these extensions:

• RBAC file extension to manage the authentication and authorizations rules for the broker.
• Prometheus extension to expose metrics for a prometheus applications
• Heartbeat extension to allow for readiness checks

If you want to add more extensions, or to change the configuration, visit the HiveMQ documentation.

Environment variables

13 - MQTT Kafka Bridge

Kubernetes resources

• Deployment: united-manufacturing-hub-mqttkafkabridge
• Secret:
  • Kafka: united-manufacturing-hub-mqttkafkabridge-kafka-secrets
  • MQTT: united-manufacturing-hub-mqttkafkabridge-mqtt-secrets

Configuration

You shouldn’t need to configure mqtt-kafka-bridge manually, as it’s configured automatically when the cluster is deployed. However, if you need to change the configuration, you can do it by editing the mqttkafkabridge section of the Helm chart values file.

Environment variables

14 - MQTT Simulator

Kubernetes resources

• Deployment: united-manufacturing-hub-iotsensorsmqtt
• ConfigMap: united-manufacturing-hub-iotsensors-mqtt

Configuration

You can change the configuration of the microservice by updating the config.json file in the ConfigMap.

15 - MQTT to Postgresql

16 - Node-RED

Kubernetes resources

• StatefulSet: united-manufacturing-hub-nodered
• Service:
  • External LoadBalancer: united-manufacturing-hub-nodered-service at port 1880
• ConfigMap:
  • Configuration: united-manufacturing-hub-nodered-config
  • Flows: united-manufacturing-hub-nodered-flows
• Secret: united-manufacturing-hub-nodered-secrets
• PersistentVolumeClaim: united-manufacturing-hub-nodered-claim

Configuration

You can enable the nodered microservice and decide if you want to use the default flows in the _000_commonConfig.dataprocessing.nodered section of the Helm chart values.

All the other values are set by default and you can find them in the Danger Zone section of the Helm chart values.

Environment variables

17 - OPCUA Simulator

Kubernetes resources

• Deployment: united-manufacturing-hub-opcuasimulator-deployment
• Service:
  • External LoadBalancer: united-manufacturing-hub-opcuasimulator-service at port 46010
• ConfigMap: united-manufacturing-hub-opcuasimulator-config

Configuration

You can change the configuration of the microservice by updating the config.json file in the ConfigMap.

18 - PackML Simulator

Kubernetes resources

• Deployment: united-manufacturing-hub-packmlmqttsimulator

Configuration

You shouldn’t need to configure PackML Simulator manually, as it’s configured automatically when the cluster is deployed. However, if you need to change the configuration, you can do it by editing the packmlmqttsimulator section of the Helm chart values file.

Environment variables

19 - Sensorconnect

Kubernetes resources

• StatefulSet: united-manufacturing-hub-sensorconnect
• Secret:
  • Kafka: united-manufacturing-hub-sensorconnect-kafka-secrets
  • MQTT: united-manufacturing-hub-sensorconnect-mqtt-secrets
• PersistentVolumeClaim: united-manufacturing-hub-sensorconnect-claim

Configuration

You can configure the IP range to scan for gateways, and which message broker to use, by setting the values of the parameters in the _000_commonConfig.datasources.sensorconnect section of the Helm chart values file.

The default values of the other parameters are usually good for most use cases, but you can change them in the Danger Zone section of the Helm chart values file.

If you want to increase the polling speed of the sensors, you can do so by setting the sensorconnect.lowerPollingTime parameter to a lower value. This can cause the ifm IO-link master to become unresponsive, if its firmware is not up to date.

Environment variables

Slowdown map

The ADDITIONAL_SLOWDOWN_MAP environment variable allows you to slow down and speed up the polling time of specific sensors. It is a JSON array of values, with the following structure:

[
  {
    "serialnumber": "000200610104",
    "slowdown_ms": -10
  },
  {
    "url": "http://192.168.0.13",
    "slowdown_ms": 20
  },
  {
    "productcode": "AL13500",
    "slowdown_ms": 20.01
  }
]

20 - Tulip Connector

Kubernetes resources

• Deployment: united-manufacturing-hub-tulip-connector-deployment
• Service:
  • Internal ClusterIP: united-manufacturing-hub-tulip-connector-service at port 80
• Ingress: united-manufacturing-hub-tulip-connector-ingress

Configuration

You can enable the tulip-connector and set the domain for the ingress by editing the values in the _000_commonConfig.tulipconnector section of the Helm chart values file.

Environment variables

API documentation