unitedmanufacturinghub/factoryinput repository overview

⁠United Manufacturing Hub

The United Manufacturing Hub is an Open-Source Helm chart for Kubernetes⁠, which combines state-of -the-art IT / OT tools & technologies and brings them into the hands of the engineer.

⁠What can you do with it?

1. Extract data from the shopfloor via Node-RED⁠, sensorconnect⁠ and barcodereader⁠
2. Contextualize and standardize data using Node-RED⁠ and our pre-defined datamodel⁠ (which is compliant with multiple standards)
3. Exchange and store data using MQTT⁠, Kafka⁠ and TimescaleDB / PostgreSQL,
4. Visualize data using Grafana⁠ and factoryinsight⁠

⁠Get started

• Get started by installing the United Manufacturing Hub⁠
• Visit our learning platform⁠ learn all about common IT, OT and IIoT concepts such as the Unified Namespace⁠ and associated common open source tools such as Node-RED, Grafana and the United Manufacturing Hub.

⁠License

All source code is distributed under the APACHE LICENSE, VERSION 2.0. See LICENSE⁠ for more information. All other components (e.g. trademarks, images, logos, documentation, publications), especially those in the /docs folder, are property of the respective owner.

⁠About our current version 0.x.x.

Our current release, has been deployed and tested at a number of industrial sites worldwide and has proven to be stable in a variety of environments. While we have not yet reached a final version 1.0.0, this is typical for infrastructure projects that require extensive year-long testing and evaluation before a release. We are confident in the stability and reliability of our current release, which has been thoroughly tested over the past few years. As an open-source project, we welcome community involvement and feedback in the ongoing development and refinement of our software. We are committed to ensuring that our software is reliable and ready for deployment in industrial settings.

⁠Development

To get started with development, please refer to our development guide⁠.

You can run make help to get a list of all available make targets.

⁠Dependencies

• Go⁠ version v1.19+.
• Docker⁠ version v20.10.11+
• Helm⁠ version v3.11.2+
• kubectl⁠ version v1.26.1+
• K3d⁠ version v5.4.6+
• GNU Make
• GNU awk
• Python (to run some make targets)

You can download and install all the go dependencies by running:

make go-deps

⁠Build

To build and push all docker images, run:

make docker

⁠Run

To run the project on a local k3d cluster, run:

make cluster-install

⁠Test

To run go unit tests, run:

make go-test-unit

To run upgrade tests, run:

make kube-test-data-flow-job        # Run the data flow test Job in the current context
make helm-test-upgrade              # Spin up a new cluster, install the latest release and upgrade to the local version
make helm-test-upgrade-with-data    # Spin up a new cluster, install the latest release and upgrade to the local version, then run the data flow test

⁠Utilities

To display the help menu, run:

make help                     # Print the generic help menu
make <target> PRINT_HELP=y    # Print the help menu for a specific target

⁠Contact

UMH Systems GmbH⁠