Docker Image: Universal Automation Center (UAC) Agent

  • Orginal documentation for the UAC Agent docker image can be found here.

  • We will start a detached container based on the UAC Agent image with a friendly name of My-UAG1.

    1. But first, we’ll need to be aware of some values which will be passed to the container by defining environment variables within the docker-compose.yml file:

      ENV Var Value Description

      UAGNETNAME

      DockerUAG1

      gives the agent a unique Agent ID within the UAC.

      UAGOMSSERVERS

      7878@v-serv2022-uac

      list of one or more OMS server addresses.

      UAGAGENTCLUSTERS

      DockerAgentCluster

      automatically add the agent into a predefined agent cluster.

      UAGTRANSIENT

      yes

      mark the agent as transient so that it is automatically deleted from the UAC when the container is deleted.

      UAGENABLESSL

      yes

      enable SSL.

    2. create a docker-compose.yml file with the following content

      version: '3'
services:
    UAG:
        image: 'stonebranch/universal-agent:latest'
        container_name: My-UAG1
        environment:
            - UAGNETNAME=DockerUAG1
            - UAGOMSSERVERS=7878@v-serv2022-uac
            - UAGAGENTCLUSTERS=DockerAgentCluster
            - UAGTRANSIENT=yes
            - UAGENABLESSL=yes

    3. Start the container via the docker-compose.yml file:

      This command must be executed within the directory containing the docker-compose.yml file
      Command
      docker compose up -d
      Results
      [+] Running 2/2
- Network "uac_default"    Created                                                                                                                                                               0.0s
- Container uac_My-UAG1_1  Started                                                                                                                                                               0.6s

    4. view the running container:

      This command must be executed within the directory containing the docker-compose.yml file
      Command
      docker compose ps
      Results
      NAME                SERVICE             STATUS              PORTS
uac_My-UAG1_1       My-UAG1             running             7878/tcp, 7887/tcp

    5. Now we can see the Agent in the UAC and it’s related Agent Cluster:

      2021 04 19 18 50 52

    6. This agent can now run tasks within this container.