Containers¶

Usando as imagens disponíveis do BotCity, você pode ter acesso rapidamente ao BotCity CLI e ao BotCity Runner para o seu projeto. Você também pode configurar seu ambiente de desenvolvimento em pouco tempo.

Imagens disponíveis¶

Atualmente, fornecemos as seguintes imagens:

botcity-base é uma imagem base e contém Java, bem como o Runner da BotCity e o CLI. Todas as outras imagens são derivadas desta imagem e adicionam recursos adicionais.

Espelhos¶

As imagens de contêiner da BotCity estão disponíveis nos seguintes espelhos:

Quando usar qual imagem¶

Se você pretende simplesmente usar o CLI da BotCity, poderá usar a imagem botcity-base.

Para a execução de automações Web em modo headless, você pode escolher a imagem apropriada para o seu projeto, dependendo do navegador e linguagem usados. Por exemplo, botcity-python-web-firefox ou botcity-java-web-chrome.

Para a execução de automações Python que requerem aplicativo desktop, você pode escolher a imagem botcity-python-desktop.

Configuração¶

Para configurar o ambiente, você pode utilizar as seguintes variáveis de ambiente:

• SERVER: O prefixo do servidor. Por exemplo: developers para developers.botcity.dev.
• LOGIN: A informação de login do BotCity Maestro, disponível na página Dev. Environment.
• KEY: A chave de API do BotCity Maestro, disponível na página Dev. Environment.
• WORKSPACE: A informação do workspace no BotCity Maestro, disponível na página Dev. Environment.
• MACHINE_ID: O ID do BotCity Runner a ser utilizado, disponível na página Runners.
• IGNORE_SSL: (Opcional) Se definido como true, ele ignorará a validação do certificado SSL. Use com cautela!
• DEBUG_ENABLED: (Opcional) Se definido como true, ele habilitará o modo de depuração e produzirá logs mais verbosos. Use com cautela!

Uso¶

As imagens contém as ferramentas BotCity Runner e BotCity CLI do BotCity Maestro SDK.

Eles podem ser lançados através dos comandos BotCLI eBotRunner e todos os parâmetros são encaminhados para as respectivas ferramentas.

BotCity CLI¶

Para iniciar a ferramenta BotCLI, basta executar o seguinte comando:

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

docker run --rm -ti -e WORKSPACE=SEU_WORKSPACE -e SERVER=SEU_SERVER -e LOGIN=SEU_LOGIN -e KEY=SUA_KEY -e MACHINE_ID=SUA_MACHINE_ID

botcity/botcity-base:latest

machine status --mid "vm-01"

BotCity Runner¶

Para iniciar a ferramenta Runner, basta executar o seguinte comando:

<docker config> <image name> BotRunner

Exemplos¶

Aqui estão alguns exemplos práticos usando as imagens de container da BotCity.

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

Criando uma máquina com o CLI da BotCity¶

Neste exemplo, usaremos a CLI da BotCity para criar uma nova máquina com o machineId como DOCKER_01 usando o espelho AWS ECR.

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

O comando explicado:

• <docker config> Referente ao comando de configuração das variáveis de ambiente que descrevemos no início desta seção.
• public.ecr.aws/botcity/botcity-base:latest é a imagem utilizada, onde:
  • botcity-base é o nome.
  • :latest é a tag.
• BotCLI é o nome do comando.
• machine new é a ação de comando.
• -machineId DOCKER_01 são parâmetros enviados ao comando BotCLI machine new.

Implantando um bot com o CLI do BotCity¶

Neste exemplo, implantaremos uma automação Python disponível no arquivo BotPython-1.0.tar.gz usando o espelho do Docker Hub.

Para que a CLI da BotCity tenha acesso ao arquivo BotPython-1.0.tar.gz, precisaremos compartilhar a pasta com o contêiner.

<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

O comando explicado:

• <docker config> Referente ao comando de configuração das variáveis de ambiente que descrevemos no início desta seção.
• -v my_code_folder:/code é a pasta com o arquivo BotPython-1.0.tar.gz para compartilhar com o contêiner
  • :/code é o caminho onde o arquivo será salvo dentro do contêiner.
• botcity/botcity-base:latest é a imagem utilizada, onde:
  • botcity-base é o nome.
  • :latest é a tag.
• BotCLI é o nome do comando.
• bot deploy é a ação de comando.
• -version 1.0 -botId BotPython -file /code/BotPython-1.0.tar.gz -python são os parâmetros enviados ao comando BotCLI bot deploy.

BotCity Runner para automações Python Headless com Firefox¶

Neste exemplo, usaremos o BotCity Runner para executar automações Python que usam o navegador Firefox no modo headless usando o espelho AWS ECR.

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

O comando explicado:

• <docker config> Referente ao comando de configuração das variáveis de ambiente que descrevemos no início desta seção.
• public.ecr.aws/botcity/botcity-python-web-firefox:latest é a imagem utilizada, onde:
  • botcity-python-web-firefox é o nome.
  • :latest é a tag.
• BotRunner é o nome do comando.

Não são necessários parâmetros adicionais para uma execução padrão do BotCity Runner, porém pode utilizar -single para personalizar a execução.

Criando um arquivo compose¶

Você também pode usar o Docker Compose para gerenciar seus contêineres de forma mais eficiente e organizada. Você pode criar um arquivo docker-compose.yml com a seguinte estrutura:

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

E então você pode executar o comando docker-compose up no terminal para iniciar o contêiner.

    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

Personalizando as imagens¶

Se você precisar personalizar as imagens, poderá criar seu próprio Dockerfile e usar uma das imagens da BotCity como base, pois elas já tem todas as ferramentas para o uso dos comandos BotCLI e BotRunner prontas.

Então, a partir de uma imagem existente, você pode adicionar pacotes necessários para o seu projeto.

Como exemplo, usamos a imagem botcity-python-desktop como base e adicionamos o pacote freerdp2-x11 como dependência do projeto.

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

Em seguida constrói-se a imagem usando o seguinte comando:

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

E então você pode usar a imagem my-botcity-python-desktop-rdp:latest em seu projeto.

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

Solução de problemas¶