This page contains features available in the Community Edition or higher. Create a free account to access them. More details about the specific offerings of the Community Edition can be found in the Editions and Pricing page.

1. Installation

Install the United Manufacturing Hub together with all required tools on a Linux Operating System.

The United Manufacturing Hub (UMH) can be deployed on various external devices, including edge devices and virtual machines (VMs). For initial installations or for development purposes, it is recommended to use a VM.

Software Requirements

The UMH installation requires one of the following Operating System on your server:

  • Flatcar version current-2023 or higher (3510.3.1). It is recommended that you have full control over the operating system. To install Flatcar on your server, follow this guide.
  • Red Hat Enterprise Linux (RHEL) 9.0 and higher. Recommended when you can choose out of a small amount of potential Operating Systems.
  • Community Supported: Ubuntu 22.04.4 LTS. This approach is useful when you’re for example trying to install the UMH on a cloud instance like AWS EC2 and struggle to install Flatcar or RHEL there.

While UMH is optimized for RHEL and Flatcar, it can theoretically run on other Linux distributions. However, support is not guaranteed. For Windows, you could try running one of the above described Operating Systems in a VM (e.g., Hyper-V). If you experiment with other systems, we encourage sharing your experiences on our Discord channel.

Hardware Requirements

  • CPU: Minimum 4 cores
  • Memory: 16 GB RAM
  • Disk Space: 32 GB available
    • On Ubuntu, we recommend at least 64 GB, due to the larger size of Ubuntu itself.
  • CPU Instructions: SSE 4.2
    • This instruction was first introduced in 2008 (Intel) and 2011 (AMD), but some VM’s require special configuration to enable it.

Note: Systems at the edge of these requirements may experience longer installation times. Close other programs during installation for optimal performance.

Network Requirements

Before proceeding with the installation, ensure your system meets the necessary network requirements.

To learn about configuring firewall and network rules for your UMH instances, please refer to our dedicated Firewall Rules page.

Installation Steps

  1. Open the Management Console in the browser.

  2. When you are finished with the creation of your account, enter your information and click on SIGN IN.

    Sign in page
    Sign in page

  3. If you are not a member, continue with sign up. Register your information and click on SIGN UP.

    Sign up page
    Sign up page

  4. You should’ve been redirected to the Network View. Now click on the +Add Instance button at the top right corner.

  5. Go through the installation wizard by first clicking on Install the UMH and then on UMH Classic.

  6. Configure your instance with the necessary details. Naming your instance is mandatory, while setting its location is optional but beneficial for management. The location follows a hierarchical format based on the ISA95 model, allowing for increasing specificity. For example, if your instance monitors a packaging line located in Building B of a factory in Ehrenfeld, Cologne, you could name it ‘Packaging’ and set the location as follows: Enterprise: UMH; Site: Ehrenfeld; Area: Building B. The Management Console organizes instances in this structure, making it easy to oversee multiple instances. Additionally, it helps in verifying data accuracy; for instance, if the enterprise is mistakenly entered as ‘UHM’ instead of ‘UMH’, the console will highlight the error based on the mismatch in received data.

  7. Once you’re ready, create the installation command, and then Copy and paste it into your server’s terminal (via ssh).

    Installation command
    Installation command

  8. The installation script runs a lot of checking and setup. For example, it checks your operating system, installation of required tools, and internet connection. After the check phase, kubectl and Helm will be installed. The script shall show you what actions will happen to your system in the next step. If you want to proceed, type Y and press enter key.

    Installation checks
    Installation checks

  9. In this step, k3s will be installed. Then, it installs the UMH Helm Chart in Kubernetes. After that, the Management Companion will be installed into Kubernetes. Until everything is set up, it can take a while.

    Installation logs
    Installation logs

  10. After a successful installation, you should be able to see messages like in the picture below.

    Installation success message
    Installation success message

  11. Back to the Management Console, everything’s ready and you click on Let’s Go!.

  12. Now in the Network View, a single node representing your newly created UMH instance should be visible.

    Network View
    Network View

Do you need more technical background information?

Here are some links to get you started:

What’s next?

Once you installed UMH, you can continue with the next page to learn how to manage the system, for example, access to the microservices.