Building and running the Amlen WebUI Docker image

Build and deploy the Amlen WebUI Docker image and then start the Amlen WebUI Docker container. You can then use the Amlen WebUI to administer one or more Eclipse Amlen messaging servers.

Ensure that you have access to a yum repository so that you can use the Dockerfile in the .tz file to build a Docker image.
  1. Build the Amlen WebUI Docker image.
    1. In the imawebui subdirectory, rename the EclipseAmlenWebUI-<build_info>.rpm file to imawebui.rpm by entering the following command:
      mv EclipseAmlenWebUI-<build_info>.rpm imawebui.rpm
    2. If you are not logged in as the root user, enter the following command:
      sudo sh
      Issuing this command enables you to run subsequent commands without having to specify sudo.
    3. If your host OS is Red Hat, you need to modify the Dockerfile.
      Change "FROM centos:latest" to "FROM rhel:latest".
    4. Build the Amlen WebUI Docker image by entering the following command:
      docker build --force-rm=true -t imawebui:5.0 .
      Ensure that you include the period at the end of the command.
    5. Confirm that the Amlen WebUI Docker image has been built successfully by entering the following command:
      docker images
      and look for output that is similar to the following line:
      imawebui     5.0    83b255b5a4b8    3 seconds ago
  2. Create a .tar file of the image so that you can deploy the Amlen WebUI on other hosts by entering the following command:
    docker save -o ./imawebui-5.0-dockerimage.tar imawebui:5.0
  3. Start the Amlen WebUI by entering the following command:
    docker run --cap-add SYS_ADMIN --net=host -P -it --name imawebui --env-file=imawebui-docker.env -m 2g -d imawebui:5.0
    This command creates and starts the Amlen WebUI Docker container.
    The following table shows the environment variables that are in the imawebui-docker.env file. You can set the environment variables and include them in the imawebui-docker.env file and include the file in the docker run command or you can specify them separately in the command by using the -e argument on the command.
    Table 1. Amlen WebUI container environment variables
    Environment variable name Required? Description
    WEBUI_CONTAINER_NAME Required Amlen WebUI Docker container name.
    WEBUI_MEMORY_SIZE Required Amount of memory, in GB, for use by the Amlen WebUI. The minimum value is 1 GB.
    WEBUI_PORT Optional Port number for the Amlen WebUI endpoint. The default is 9087.
    WEBUI_HOST Optional Host interface for the Amlen WebUI endpoint. The default is *
    Note:
    The default value for WEBUI_HOST is *, which means that all interfaces can access the Web UI. On systems with multiple interfaces, you might want to use a specific interface rather than allowing all interfaces to access the Web UI. For example, if a host is configured with the following interfaces:
    • 10.10.1.2
    • 10.2.1.10
    • 10.1.10.2
    you might want to specify WEBUI_HOST as 10.10.1.2 to limit Web UI access to that particular interface. If you use the default WEBUI_HOST value of *, then all three interfaces can access the Web UI.
  4. Verify that the Amlen WebUI container is running by entering the following command:
    docker ps
  5. If you are not logged in as the root user, enter the following command to exit from the sudo shell that you created at step 1.b:
    exit
After you start the Eclipse Amlen messaging server and Amlen WebUI Docker containers, you can log in to the Amlen WebUI and verify the installation by using a demonstration application. For more information about logging in to the Amlen WebUI, see Logging in to the Amlen WebUI. For more information about verifying the installation, see Verifying the installation of Eclipse Amlen.
Note: The Amlen WebUI can administer the messaging server only after the license has been accepted on the messaging server. Use the Eclipse Amlen REST API POST method to accept the license on the messaging server. For more information about accepting the license by using the Eclipse Amlen REST API POST method, see Configuring the licensed usage for Eclipse Amlen and accepting the license by using REST Administration APIs.