Containers¶

Using BotCity's available images you can quickly have access to BotCity CLI and BotCity Runner for your project.

Using BotCity's available images you can 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 headless Python development you can pick the appropriate image for your project depending on your runtime browser.

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 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 BotCity Runner.
• 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!

For more information about the configuration, please visit the Dev. Environment page.

Usage¶

As mentioned above, this image contains 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.

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

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'

BotCity CLI¶

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

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

For more information about the BotCLI tool, please refer to the BotCity CLI documentation.

BotCity Runner¶

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

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

For more information about the BotCity Runner tool, please refer to the BotCity Runner documentation.

Examples¶

Here are some practical examples using the container images above.

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> is the command prefix we described on the beginning of this section
• public.ecr.aws/botcity/botcity-base:latest is the image name where botcity-base is the name and latest is the tag
• BotCLI is the command name
• machine new is the command action
• -machineId DOCKER_01 is the parameter 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> is the command prefix we described on 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 and /code is the path inside the container
• botcity/botcity-base:latest is the image name where botcity-base is the name and latest is the tag
• BotCLI is the command name
• bot deploy is the command action
• -version 1.0 -botId BotPython -file /code/BotPython-1.0.tar.gz -python are the parameter 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> is the command prefix we described on the beginning of this section
• public.ecr.aws/botcity/botcity-python-web-firefox:latest is the image name where botcity-python-web-firefox is the name and latest is the tag
• BotRunner is the command name

No additional parameters are required for a standard BotCity Runner execution.

Customizing the Images¶

If you need to customize the images, you can create your own Dockerfile and use one of the images above as the base.

As an example, if you need to add additional packages to the botcity-python-desktop image, you can create a Dockerfile like the following:

FROM 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:latest .

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

For more information about Dockerfiles and how to use them, please visit the Docker documentation.

Troubleshooting¶