Customize your local installation

This page explains how to customize the values of the Helm chart without changing the defaults

  2 minute read  

Following the local deployment of the UMH stack you probably encountered the option to customize your deployment with a file called development.yaml.

The default installation deploys with the following services and respective configuration:

Data sources

  • BarcodeReader: disabled
  • CameraConnect: disabled
  • IOT sensors simulator: enabled
    • Resources:
      • Requests:
        • CPU: 10m
        • RAM: 20Mi
      • Limit:
        • CPU: 100m
        • RAM: 100Mi
  • SensorConnect: disabled

Data processing

  • NodeRED: enabled

Infrastructure

  • Kafka: enabled
    • Replicas: 1
    • Resources:
      • Requests:
        • CPU: 100m
        • RAM: 250Mi
      • Limit:
        • CPU: 1000m
        • RAM: 1Gi
  • Kafka-to-Postgresql: enabled
    • Replicas: 1
    • Resources:
      • Requests:
        • CPU: 50m
        • RAM: 50Mi
      • Limit:
        • CPU: 200m
        • RAM: 200Mi
  • VerneMQ (MQTT): enabled
    • Replicas: 1
    • Resources:
      • Requests:
        • CPU: 100m
        • RAM: 100Mi
      • Limit:
        • CPU: 500m
        • RAM: 500Mi

Data storage

  • FactoryInsight: enabled
    • Replicas: 2
    • Resources:
      • Requests:
        • CPU: 50m
        • RAM: 50Mi
      • Limit:
        • CPU: 200m
        • RAM: 200Mi
  • Grafana: enabled
    • Replicas: 1
  • Redis: enabled
    • Master:

      • extraFlags:

        - --maxmemory 200mb

      • Resources:

        • Requests:
          • CPU: 100m
          • RAM: 100Mi
        • Limit:
          • CPU: 200m
          • RAM: 200Mi
    • Sentinel:
      • Resources:
        • Requests:
          • CPU: 100m
          • RAM: 256Mi
    • Replica:
      • count: 1
      • Resources:
        • Requests:
          • CPU: 100m
          • RAM: 100Mi
        • Limit:
          • CPU: 200m
          • RAM: 200Mi
  • TimescaleDB: enabled

Data input

  • FactoryInput: disabled
  • GrafanaProxy: disabled

Blob Storage

  • Kafka-to-blob: disabled
  • MQTT-to-blob: disabled

Bridges

  • KafkaBridge: disabled
  • MQTTBridge: disabled

Others

  • KafkaStateDetector: disabled
  • Kowl: enabled

Minimum requirements

The default installation requires at least 1 CPU core and 4GB of RAM. For each additional service you want to enable, you might need to increase the CPU count or the amount of RAM.

If you decide to enable all the services in the stack you will need at least 4 CPU cores and 8GB of RAM.

Services configuation

Once you have deployed the UMH stack in you preferred way, you can customize the enabled services and their configuration simply by following these steps.

  1. Access the system where the stack is deployed. For example, in the case you chose to use a virtual machine, you can simply SSH into it.

  2. Navigate to the configs folder

    cd /home/rancher/configs

  3. Open the file united-manufacturing-hub-development.yaml with your preferred text editor

    nano united-manufacturing-hub-development.yaml

  4. Now just add the configuration that you want following this structure.

  5. When you are done save and close the file

  6. Upgrade the Helm Release

    helm upgrade -f united-manufacturing-hub-development.yaml united-manufacturing-hub united-manufacturing-hub/united-manufacturing-hub -n united-manufacturing-hub

Last modified February 17, 2023: update (#208) (ea731fc)