Session Manager

É possível configurar o Session Manager para fazer o gerenciamento de ambientes de execução a nivel empresarial. Essa funcionalidade é especialmente útil para empresas que possuem múltiplos Runners e desejam distribuir as tarefas de automação entre diferentes hosts, de maneira automática e eficiente.

Contexto

Uma empresa que possui 5 Runners no Orquestrador BotCity, pode fazer a distribuição deles de diversas formas.

Supondo que a empresa tenha duas máquinas remotas (host) para execução de suas automações, a distribuição pode ser feita da seguinte maneira:

• Primeiro Host: Remote-1
  • Runners Associados:
    • Runner-Desktop-1
    • Runner-BG-1
    • Runner-BG-2
• Segundo Host: Remote-2
  • Runners Associados:
    • Runner-Desktop-2
    • Runner-BG-3

Cada host possui um conjunto de Runners associados, os quais são responsáveis por executar as tarefas de automação, sendo apenas um Runner que controla tela por máquina e o restante Runners que executam processos em Background, para não interferir em manipulações em tela.

O Session Manager é o componente que gerencia a alocação dessas tarefas entre os Runners disponíveis nos hosts.

Session Manager

O Session Manager pode ser alocado em uma máquina dedicada ou em uma máquina de usuário. O importante é que essa máquina esteja disponível para fazer o monitoramento constante da fila de tarefas do Orquestrador BotCity, pois o gatilho de gerenciamento dos hosts é uma nova tarefa criada na fila.

A máquina também deve conseguir alcançar os hosts onde os Runners estão instalados via RDP, e ter comunicação liberada com o Orquestrador BotCity via HTTPS (Porta 443).

Sugestão de configuração de ambiente

Para um ambiente dedicado apenas a execução do Session Manager:

• SO: Linux
• RAM: 2GB

Atenção a possíveis adequações de requisitos referente a comunicação em rede ou outros recursos que deseja adicionar.

Configuração do Session Manager

A partir do contexto acima, vamos fazer a configuração do Session Manager para gerenciar os Runners associados aos hosts.

Passo 1: Download do Session Manager

O Session Manager faz parte do SDK da BotCity, e pode ser baixado diretamente do Orquestrador, selecionando o sistema operacional desejado. Esse exemplo seguirá o uso do sistema Windows, mas o processo é similar para outros sistemas operacionais.

Download

Para mais detalhes de como baixar e instalar o SDK, veja a documentação completa em Instalação do SDK BotCity.

Passo 2: Acesso ao Session Manager

Ao fazer a instalação, o Session Manager estará disponível entre as ferramentas do SDK BotCity.

No terminal, navegue até a pasta de instalação e utilize o comando para verificar a visibilidade do Session Manager:

dir

Você deve ver o executável do Session Manager listado, como session-manager.exe ou session-manager.

Passo 3: Configuração do Session Manager - Host

A configuração é feita por comandos no terminal, o primeiro a ser utilizado é para adicionar um host:

SessionManager host add

No contexto temos dois hosts, então vamos adicionar ambos, passando as seguintes informações:

• Primeiro Host:

  • Label for the host: Remote-1
  • Choose the protocol (rdp, ec2): rdp
  • Username: admin
  • Password: Pass123
  • Repeat for confirmation: Pass123
  • Hostname: 10.30.85.56
  • Width: 1600
  • Height: 900
  • Port [3389]: 3389

• Segundo Host:

  • Label for the host: Remote-2
  • Choose the protocol (rdp, ec2): rdp
  • Username: administrator
  • Password: 123pass
  • Repeat for confirmation: 123pass
  • Hostname: 172.24.70.36
  • Width: 1600
  • Height: 900
  • Port [3389]: 3389

Passo 4: Configuração do Session Manager - Runner

Com os hosts adicionados, o próximo passo é anexar os Runners a cada host. Para seguir conforme o contexto, vamos associar:

• Runner-Desktop-1, Runner-BG-1, Runner-BG-2 ao Remote-1
• Runner-Desktop-2, Runner-BG-3 ao Remote-2.

Para isso, utilizamos o comando:

SessionManager runner attach

Preenchendo as informações conforme o contexto:

• Runner-Desktop-1:
  • Host label: Remote-1
  • Runner label: Runner-Desktop-1
  • Path to SDK: C:\Users\admin\BotCity\Runner-Desktop-1
• Runner-BG-1:
  • Host label: Remote-1
  • Runner label: Runner-BG-1
  • Path to SDK: C:\Users\admin\BotCity\Runner-BG-1
• Runner-BG-2:
  • Host label: Remote-1
  • Runner label: Runner-BG-2
  • Path to SDK: C:\Users\admin\BotCity\Runner-BG-2
• Runner-Desktop-2:
  • Host label: Remote-2
  • Runner label: Runner-Desktop-2
  • Path to SDK: C:\Users\administrator\BotCity\Runner-Desktop-2
• Runner-BG-3:
  • Host label: Remote-2
  • Runner label: Runner-BG-3
  • Path to SDK: C:\Users\administrator\BotCity\Runner-BG-3

Passo 5: Verificação da Configuração

Para verificar se a configuração foi realizada corretamente, utilize o comando:

SessionManager list all

Esse comando lista todos os hosts e Runners associados, permitindo confirmar se tudo está conforme o esperado.

Passo 6: Iniciar o Session Manager

Com a configuração concluída, o próximo passo é iniciar o Session Manager para que ele comece a monitorar a fila de tarefas do Orquestrador BotCity e gerenciar os Runners.

Para iniciar o Session Manager, utilize o comando:

SessionManager run local

Acompanhe os logs sm_audit.log e sm_out.log na pasta log, no local de instalação do Session Manager, para verificar se tudo está funcionando corretamente.

Orquestrador BotCity

Assim que o Session Manager estiver executando, ele começará a monitorar a fila de tarefas do Orquestrador BotCity.

Para funcionar corretamente, é necessário que as Automações no Orquestrador estejam direcionadas para os Runners anexados aos hosts configurados no Session Manager.

Automações

Para fazer essa verificação, acesse o Orquestrador BotCity, navegue até a seção de Automações e selecione a automação desejada.

No campo Runners Vinculados deve estar selecionado um ou mais Runners anexados nas configurações do Session Manager.

Tarefas

Nesse momento, ao criar uma nova tarefa, o Session Manager automaticamente acessará um dos hosts configurados, iniciará o Runner anexado e executará a automação.

Ao finalizar, e não havendo mais tarefas em fila, o Session Manager desconectará do host, liberando-o para futuras execuções.

Documentação Completa

Veja a documentação completa do Session Manager, acessando outras funções e configurações em: Session Manager - BotCity Docs.