Containers¶

Using BotCity's available images you can quickly have access to BotCity CLI and BotCity Runner for your project. You can also setup your development environment in no time.

Available Images¶

We currently provide the following images:

botcity-base image is a base image and contains Java as well as the BotCity Runner and CLI. All other images are derived from this image and add additional features.

Mirrors¶

BotCity container images are available in the following mirrors:

When to use which image¶

If you intend to simply use the BotCity CLI, you can use the botcity-base image.

For Web automations in headless mode, you can choose the appropriate image for your project depending on the browser and language used. For example, botcity-python-web-firefox or botcity-java-web-chrome.

For desktop applications that require a graphical interface, you can choose the botcity-python-desktop image.

Configuration¶

In order to use it you will need to provide the following environment variables:

• SERVER: The server prefix. E.g.: developers for developers.botcity.dev.
• LOGIN: The Orchestrator BotCity Maestro login information available at the Dev. Environment page.
• KEY: The BotCity Maestro key information available at the Dev. Environment page.
• WORKSPACE: The BotCity Maestro workspace information available at the Dev. Environment page.
• MACHINE_ID: The machine ID to be used by the Runners page.
• IGNORE_SSL: (Optional) If set to true, it will ignore SSL certificate validation. Use with caution!
• DEBUG_ENABLED: (Optional) If set to true, it will enable debug mode and produce more verbose logs. Use with caution!

Usage¶

The images contain the BotCity Runner and BotCity CLI tools from the BotCity Studio SDK.

They can be launched via the BotCLI and BotRunner commands and all parameters are forwarded to the respective tools.

BotCity CLI¶

To start the BotCLI tool, simply run the following command:

<docker config> <image name> BotCLI <parameters here>

docker run --rm -ti -e WORKSPACE=YOUR_WORKSPACE -e SERVER=YOUR_SERVER -e LOGIN=YOUR_LOGIN -e KEY=YOUR_KEY -e MACHINE_ID=YOUR_MACHINE_ID

botcity/botcity-base:latest

machine status --mid "vm-01"

BotCity Runner¶

To launch the Runner tool, simply run the following command:

<docker config> <image name> BotRunner

Examples¶

Here are some practical examples using BotCity container images.

docker run --rm -ti -e WORKSPACE=company -e SERVER=company -e LOGIN=company -e KEY=COM_123ABCBA321 -e MACHINE_ID=DOCKER_01

Creating a Machine with the BotCity CLI¶

In this example we will use the BotCity CLI to create a new machine with the machineId as DOCKER_01 using the AWS ECR mirror.

<docker config> public.ecr.aws/botcity/botcity-base:latest BotCLI machine new -machineId DOCKER_01

The command explained:

• <docker config> Refers to the command for configuring environment variables that we described at the beginning of this section.
• public.ecr.aws/botcity/botcity-base:latest is the image used, where:
  • botcity-base is the name.
  • :latest is the tag.
• BotCLI is the name of the command.
• machine new is the command action.
• -machineId DOCKER_01 are parameters sent to the BotCLI machine new command.

Deploying a Bot with the BotCity CLI¶

In this example we will deploy a Python automation available on the file BotPython-1.0.tar.gz using the Docker Hub mirror.

Since we need the BotCity CLI to have access to the BotPython-1.0.tar.gz file, we will need to share the folder with the container.

<docker config> -v my_code_folder:/code botcity/botcity-base:latest BotCLI bot deploy -version 1.0 -botId BotPython -file /code/BotPython-1.0.tar.gz -python

The command explained:

• <docker config> Refers to the command to configure the environment variables that we described at the beginning of this section.
• -v my_code_folder:/code is the folder with the BotPython-1.0.tar.gz file to share with the container.
  • :/code is the path where the file will be saved inside the container.
• botcity/botcity-base:latest is the image used, where:
  • botcity-base is the name.
  • :latest is the tag.
• BotCLI is the name of the command.
• bot deploy is the command action.
• -version 1.0 -botId BotPython -file /code/BotPython-1.0.tar.gz -python are the parameters sent to the BotCLI bot deploy command.

BotCity Runner for Headless Python Firefox Automations¶

In this example we will use the BotCity Runner to run Python automations that use Firefox browser in headless mode using the AWS ECR mirror.

<docker config> public.ecr.aws/botcity/botcity-python-web-firefox:latest BotRunner

The command explained:

• <docker config> Refers to the command for configuring environment variables that we described at the beginning of this section.
• public.ecr.aws/botcity/botcity-python-web-firefox:latest is the image used, where:
  • botcity-python-web-firefox is the name.
  • :latest is the tag.
• BotRunner is the name of the command.

No additional parameters are required for a standard BotCity Runner run, but you can use -single to customize the run.

Creating a Compose File¶

You can also use Docker Compose to manage your containers more efficiently and organized. You can create a docker-compose.yml file with the following structure:

version: "3.0"
services:
  docker-1:
    image: botcity/botcity-python-web-chrome
    command: BotRunner
    environment:
        SERVER: developers
        LOGIN: YOUR_LOGIN
        KEY: YOUR_KEY
        MACHINE_ID: YOUR_MACHINE_ID

And then you can run the docker-compose up command in the terminal to start the container.

version: "3.0"
services:
    docker-1:
    image: botcity/botcity-python-web-chrome
    command: BotRunner
    environment:
        SERVER: developers
        LOGIN: YOUR_LOGIN
        KEY: YOUR_KEY
        MACHINE_ID: YOUR_MACHINE_ID
    shm_size: '1gb'

    version: "3.0"
    services:
      docker-1:
        image: botcity/botcity-python-web-chrome
        command: BotRunner
        environment:
            SERVER: YOUR_SERVER
            LOGIN: YOUR_LOGIN
            KEY: YOUR_KEY
            MACHINE_ID: YOUR_MACHINE_ID_1
      docker-2:
        image: botcity/botcity-python-web-chrome
        command: BotRunner
        environment:
            SERVER: YOUR_SERVER
            LOGIN: YOUR_LOGIN
            KEY: YOUR_KEY
            MACHINE_ID: YOUR_MACHINE_ID_2

Customizing the Images¶

If you need to customize the images, you can create your own Dockerfile and use one of the BotCity images as the base, as they already have all the tools for using the BotCLI and BotRunner commands ready.

Then, from an existing image, you can add the necessary packages for your project.

As an example, we used the botcity-python-desktop image as the base and added the freerdp2-x11 package as a project dependency.

FROM botcity/botcity-python-desktop:latest

# Install System Dependencies
RUN apt-get update && \
     \
    apt-get -y install freerdp2-x11 \
    --no-install-recommends && \
    apt-get clean && \
    rm -rf /var/lib/apt/lists/*

Then you can build the image using the following command:

docker build -t my-botcity-python-desktop-rdp:latest .

And then you can use the my-botcity-python-desktop-rdp:latest image in your project.

version: "3.0"
services:
  docker-1:
    image: my-botcity-python-desktop-rdp
    command: BotRunner
    environment:
        SERVER: YOUR_SERVER
        LOGIN: YOUR
        KEY: YOUR_KEY
        MACHINE_ID: YOUR_MACHINE_ID

Troubleshooting¶