How to Manage Containers in the IGEL UMS Web App

Managing a container through the IGEL UMS Web App consists of two main stages:

1. First, you upload the container configuration file and assign it to an IGEL OS device through a profile.

2. Then you need to create the container via the Device Configurator in the UMS Web App.

As soon as at least one container was created, you can view and manage the container from the Managed Containers tab.

Preparing the Container Configuration File

Prerequisites

• IMC uses a subset of the Compose specification as a configuration format for defining a single container. It expects that the configuration will only contain one service that will configure one container.

• The container configuration file must be available on the local machine from which the administrator accesses the UMS Web App.

services:
  ttyd:
    container_name: ttyd
    image: docker.io/library/alpine:latest
    command: [
      "sh",
      "-c",
      "apk add --no-cache ttyd && ttyd -W -p 7681 sh"
    ]
    # Simulate having the container in a NAT network, in rootless mode
    network_mode: private
    ports:
      - "7681:7681"

services:
  usb-app:
    image: docker.io/library/debian:stable
    devices:
      - "/dev/ttyUSB0:/dev/ttyUSB0"   # use your device node
    group_add:
      - keep-groups                   # carry host group access into the container - usually needed for full permissions to the device
    command: ["sh", "-c", "ls -l /dev/ttyUSB0 && sleep infinity"]

Uploading the Container Configuration File to the UMS Web App

1. In the UMS Web App, go to Configuration and click Files.

   

2. Click Create new directory and name it IMC.

3. Click Upload file and either drag & drop or browse through your files to upload the container configuration file to the IMC folder. Set the following configuration for the upload:

   • Classification: Undefined

   • Device file location: /services_rw/imc/config/

   • Owner: Root

   • Owner access rights:

     • Read

     • Write

   • Other access rights:

     • Read

       

       
       

4. Click Finish upload.

The container configuration file was uploaded to the UMS Web App.

Creating a Profile for the Container Configuration File

Profiles are used to transfer the container configuration file to the IGEL OS device. Follow the steps to create a profile and assign the container configuration file to it.

1. Open the UMS Web App, go to Configuration and click Profiles.

   

2. Click Create new profile .

3. Name the profile, e.g. IMC-configurations, and click Select Apps.

   

   
   

4. Select the IGEL OS Base System app and click Next.

   

   
   

5. Close the profile configuration window without making any further changes.

6. In the newly created profile, go to Contained Files and, in the Assign file search bar, enter the file name of the container configuration file. Once the entry with the same file name appears, select it.

   

   
   

7. In the confirmation dialog box that appears, click Yes.

The container configuration file has now been assigned to the profile.

Assigning the Container Profile to the IGEL OS Device

1. In the UMS Web App, go to Devices, select the device to which the container should be assigned to and click Assign object.

   

   
   

2. Assign the profile to the device and click Save and apply now.

   

The container configuration file is transferred to the target IGEL OS device when the profile settings are applied.

Creating the Container via the Device Configurator in the IGEL UMS Web App

1. In the UMS Web App, go to Devices, select the device to which the container should be assigned to and click Edit > Edit Configuration.

   

   
   

2. Go to Apps > IGEL Managed Containers > Containers and click Add item to create a new container.

   

   
   

3. Name the container instance.

   

   
   

4. Click Settings and enter the name of the container configuration file which has been assigned to the IGEL OS device and click Save and Close.

   

   
   

After the IGEL OS device applied the settings, the tab Managed Containers will appear on the device details page in the UMS Web App.

Managing Containers in the IGEL UMS Web App

When the target IGEL OS device received the container configuration file, restarted and at least one container was created, a new tab labeled Managed Containers is added.

Click the refresh button to display the most recent list of containers and to determine their current status.

The available possibilities of managing containers on IGEL OS devices are described below.

Starting Containers

To start running a container, click or .

Clicking for All Containers will start all containers assigned to the specific device.

Stopping Containers

To stop running a container, click or .

Clicking for All Containers will stop all containers assigned to the specific device.

Updating Container Images

To update a container image, click .