Contenedores¶

Al utilizar las imágenes de BotCity disponibles, puede obtener acceso rápido a BotCity CLI y BotCity Runner para su proyecto. También puedes configurar tu entorno de desarrollo en poco tiempo.

Imágenes disponibles¶

Actualmente, ofrecemos las siguientes imágenes:

La imagen botcity-base es una imagen base y contiene Java, así como BotCity Runner y CLI. Todas las demás imágenes se derivan de esta imagen y agregan características adicionales.

Espejos¶

Las imágenes de contenedor de BotCity están disponibles en los siguientes espejos:

Cuándo usar cada imagen¶

Si simplemente desea utilizar la CLI de BotCity, puede utilizar la imagen botcity-base.

Para ejecutar automatizaciones web en modo headless, puedes elegir la imagen adecuada para tu proyecto, según el navegador y el lenguaje de programación utilizado. Por ejemplo, botcity-python-web-firefox o botcity-java-web-chrome.

Para ejecutar automatizaciones de Python que requieren una aplicación desktop, puede elegir la imagen botcity-python-desktop.

Configuración¶

Para configurar tu entorno, puedes utilizar las siguientes variables de ambiente:

• SERVER: El prefijo del servidor. Por ejemplo: developers a developers.botcity.dev.
• LOGIN: La información de inicio de sesión de BotCity Maestro, disponible en Entorno de Desarrollo.
• KEY: La clave API de BotCity Maestro, disponible en Entorno de Desarrollo.
• WORKSPACE: La información del espacio de trabajo en BotCity Maestro, disponible en Entorno de Desarrollo.
• MACHINE_ID: El ID del BotCity Runner que se utilizará, disponible en la página Runners.
• IGNORE_SSL: (Opcional) Si se establece en true, omitirá la validación del certificado SSL. ¡Úselo con precaución!
• DEBUG_ENABLED: (Opcional) Si se establece en true, habilitará el modo de depuración y producirá registros más detallados. ¡Usa con precaución!

Uso¶

Las imágenes contienen las herramientas BotCity Runner y BotCity CLI del SDK de BotCity Studio.

Se puede ejecutar a través de los comandos BotCLI y BotRunner, y todos los parámetros se transmiten a las herramientas respectivas.

BotCity CLI¶

Para ejecutar la herramienta BotCLI, simplemente ejecuta el siguiente comando:

<configuración de Docker> <nombre de la imagen> BotCLI <parámetros aquí>

docker run --rm -ti -e WORKSPACE=TU_ESPACIO_DE_TRABAJO -e SERVER=TU_SERVIDOR -e LOGIN=TU_INICIO_DE_SESIÓN -e KEY=TU_CLAVE -e MACHINE_ID=TU_ID_DE_MÁQUINA

botcity/botcity-base:latest

machine status --mid "vm-01"

BotCity Runner¶

Para ejecutar la herramienta Runner, simplemente ejecuta el siguiente comando:

<configuración de Docker> <nombre de la imagen> BotRunner

Ejemplos¶

Aquí tienes algunos ejemplos prácticos utilizando las imágenes de contenedor anteriores.

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

Crear una máquina con BotCity CLI¶

En este ejemplo, utilizaremos BotCity CLI para crear una nueva máquina con el machineId como DOCKER_01 utilizando el espejo de AWS ECR.

<configuración de Docker> public.ecr.aws/botcity/botcity-base:latest BotCLI machine new -machineId DOCKER_01

La explicación del comando:

• <configuración de Docker> Se refiere al comando de configuración de variables de entorno que describimos al comienzo de esta sección.
• public.ecr.aws/botcity/botcity-base:latest es la imagen utilizada, donde:
  • botcity-base es el nombre.
  • :latest es la etiqueta.
• BotCLI es el nombre del comando.
• machine new es la acción del comando.
• -machineId DOCKER_01 son parámetros enviados al comando BotCLI machine new.

Implementar un bot con BotCity CLI¶

En este ejemplo, implementaremos una automatización de Python disponible en el archivo BotPython-1.0.tar.gz utilizando el espejo de Docker Hub.

Dado que necesitamos que BotCity CLI tenga acceso al archivo BotPython-1.0.tar.gz, deberemos compartir la carpeta con el contenedor.

<configuración de Docker> -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

La explicación del comando:

• <configuración de Docker> Se refiere al comando de configuración de variables de entorno que describimos al comienzo de esta sección.
• -v my_code_folder:/code es la carpeta con el archivo BotPython-1.0.tar.gz para compartir con el contenedor.
  • :/code es la ruta donde se guardará el archivo dentro del contenedor.
• botcity/botcity-base:latest es la imagen utilizada, donde:
  • botcity-base es el nombre.
  • :latest es la etiqueta.
• BotCLI es el nombre del comando.
• bot deploy es la acción del comando.
• -version 1.0 -botId BotPython -file /code/BotPython-1.0.tar.gz -python son los parámetros que se pasan al comando BotCLI bot deployment.

BotCity Runner para automatizaciones de Python sin interfaz gráfica con Firefox¶

En este ejemplo, utilizaremos BotCity Runner para ejecutar automatizaciones de Python que utilizan el navegador Firefox en modo sin interfaz gráfica utilizando el espejo de AWS ECR.

<configuración de Docker> public.ecr.aws/botcity/botcity-python-web-firefox:latest BotRunner

La explicación del comando:

• <configuración de Docker> Se refiere al comando para configurar las variables de entorno que describimos al comienzo de esta sección.
• public.ecr.aws/botcity/botcity-python-web-firefox:latest es la imagen utilizada, donde:
  • botcity-python-web-firefox es el nombre.
  • :latest es la etiqueta.
• BotRunner es el nombre del comando.

No se requieren parámetros adicionales para una ejecución estándar de BotCity Runner, pero puedes usar -single para personalizar la ejecución.

Creando un archivo compose¶

También puedes utilizar Docker Compose para administrar tus contenedores de forma más eficiente y organizada. Puede crear un archivo docker-compose.yml con la siguiente estructura:

version: "3.0"
services:
  docker-1:
    image: botcity/botcity-python-web-chrome
    command: BotRunner
    environment:
        SERVER: developers
        LOGIN: TU_INICIO_DE_SESIÓN
        KEY: TU_CLAVE
        MACHINE_ID: TU_ID_DE_MÁQUINA

Y luego puedes ejecutar el comando docker-compose up en la terminal para iniciar el contenedor.

  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: developers
            LOGIN: TU_INICIO_DE_SESIÓN
            KEY: TU_CLAVE
            MACHINE_ID: TU_ID_DE_MÁQUINA_1
      docker-2:
        image: botcity/botcity-python-web-chrome
        command: BotRunner
        environment:
            SERVER: developers
            LOGIN: TU_INICIO_DE_SESIÓN
            KEY: TU_CLAVE
            MACHINE_ID: TU_ID_DE_MÁQUINA_2

Personalización de las imágenes¶

Si necesitas personalizar las imágenes, puedes crear tu propio Dockerfile y utilizar una de las imágenes de BotCity como base, ya tienen todas las herramientas para utilizar los comandos BotCLI y BotRunner listas.

Luego, desde una imagen existente, puedes agregar los paquetes necesarios para tu proyecto.

Como ejemplo, utilizamos la imagen botcity-python-desktop como base y agregamos el paquete freerdp2-x11 como dependencia del proyecto.

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/*

Luego puedes construir la imagen utilizando el siguiente comando:

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

Y luego puedes utilizar la imagen my-botcity-python-desktop-rdp:latest en tu proyecto.

version: "3.0"
services:
  docker-1:
    image: my-botcity-python-desktop-rdp
    command: BotRunner
    environment:
        SERVER: developers
        LOGIN: TU_INICIO_DE_SESIÓN
        KEY: TU_CLAVE
        MACHINE_ID: TU_ID_DE_MÁQUINA

Solución de problemas¶