Primeiros Passos¶

Conceitos Chave¶

Antes de mergulhar na configuração, é importante entender alguns conceitos-chave que serão referenciados abaixo:

host: Um host é um computador ou máquina virtual (localmente ou na nuvem) que terá sua sessão controlada.
protocol: O protocolo a ser utilizado para a conexão e comunicação com o host. Verifique a lista de protocolos suportados.

Protocolos Suportados¶

Atualmente, dois protocolos são suportados:

RDP
AWS EC2 + RDP

RDP - Área de Trabalho Remota¶

Para configurar um host com suporte para Área de Trabalho Remota, você precisará das seguintes informações:

Nome do Host ou Endereço IP para se comunicar com o host
Nome de usuário para iniciar a sessão
Senha para iniciar a sessão do usuário

AWS EC2 + RDP¶

Este protocolo permite não apenas estabelecer a conexão RDP com o host, mas também manipular o estado da instância EC2 da AWS, iniciando e parando-a com base na demanda da fila de tarefas do BotCity Orchestrator.

Para configurar um host com suporte para AWS EC2, você precisará das seguintes informações:

ID da Instância
Região AWS (Opcional) a região da AWS onde esta instância está localizada
ID da Chave de Acesso AWS (Opcional) a chave de acesso da API AWS
ID da Chave Secreta de Acesso AWS (Opcional) a chave secreta de acesso da AWS
Nome do Host ou Endereço IP para se comunicar com o host
Nome de usuário para iniciar a sessão
Senha para iniciar a sessão do usuário

Tip

O uso de um arquivo de credenciais da AWS também é suportado. Certifique-se de responder Sim durante o comando host add quando solicitado.

Se você usar o arquivo de credenciais, a Região, Chave de Acesso e Chave Secreta não serão solicitados.

Requisitos¶

Para executar o Session Manager corretamente, é obrigatório que:

Seu servidor Session Manager possa se comunicar com o BotCity Orchestrator via HTTPS (Porta 443)
Seu servidor Session Manager possa alcançar os hosts via rede para gerenciar as sessões
O usuário que executa o Session Manager esteja autorizado a estabelecer conexão RDP ou outra conexão necessária com os hosts

Instalação¶

O Session Manager faz parte do BotCity Studio SDK.

Para obter o Session Manager, prossiga com a instalação descrita no guia de introdução.

Instalando como Serviço do Windows

Você pode instalar o BotCity Session Manager como um Serviço do Windows seguindo as instruções abaixo:

Tip

Você precisará de um sistema operacional Windows com privilégios administrativos.

Passo 1: Criar o Serviço

Abra o Prompt de Comando como Administrador:
Pressione Win + X e selecione Prompt de Comando (Admin) ou Windows PowerShell (Admin).

Execute o seguinte comando para criar um novo serviço:

sc create SessionManagerService binPath="C:\caminho\para\seu\executável.exe"

Substitua C:\caminho\para\seu\SessionManager.exe pelo caminho completo para o seu arquivo .exe.
Nota: Certifique-se de que não há espaço entre binPath= e o caminho.

Passo 2: Configurar o Serviço para Iniciar Automaticamente

Execute o seguinte comando para definir o serviço para iniciar automaticamente na inicialização do sistema:
```
sc config SessionManagerService start=auto
```
Para iniciar o serviço imediatamente, use:
```
sc start SessionManagerService
```

Passo 3: Verificar o Serviço

Abra Serviços (pressione Win + R, digite services.msc e pressione Enter).
Localize SessionManagerService na lista de serviços para confirmar que ele aparece.
Verifique se o Tipo de inicialização do serviço está definido como Automático.
Reinicie o sistema para verificar se o serviço inicia automaticamente ao inicializar.

Passo 4: Teste e Solução de Problemas

Para verificar o status do serviço, você pode usar:
```
sc query SessionManagerService
```
Se o serviço não iniciar, verifique o log_sm.txt na pasta logs do BotCity Studio SDK.
Alternativamente, verifique o Visualizador de Eventos em Logs do Windows > Aplicativo.

Desinstalando o Serviço

Para remover o serviço, execute:

sc delete SessionManagerService

Esse comando exclui o serviço completamente.

Configuração¶

Tip

Você pode personalizar o local do banco de dados de configuração do Session Manager definindo o caminho completo para o arquivo smdb em seu conf/conf.bcf sob o parâmetro sessionManagerDBPath.

sessionManagerDBPath=/path/exemplo/BotCity/config_file.smdb

Toda a configuração do Session Manager é realizada via a interface de linha de comando (CLI) do Session Manager.

Para executar o Session Manager, você precisará pelo menos:

Adicionar um host
Anexar um Runner a um host registrado

Adicionando um Host¶

Tip

Antes de prosseguir, certifique-se de ter em mãos:

O IP ou nome do host para a conexão com o host.
O nome de usuário e senha que serão usados para abrir a sessão.
Qualquer outra informação pertinente requerida pelo protocolo a ser utilizado para a conexão de sessão.

Abra o terminal de comando de sua escolha e navegue até a pasta do BotCity Studio SDK onde o SessionManager está localizado.
Execute o comando para adicionar um novo host SessionManager host add.
Siga as instruções no prompt.

Anexando um Runner a um Host¶

Tip

Antes de prosseguir, certifique-se de ter em mãos:

O caminho completo no host onde o BotCity SDK para o Runner desejado está instalado.

Abra o terminal de comando de sua escolha e navegue até a pasta do BotCity Studio SDK onde o SessionManager está localizado.
Execute o comando para anexar um novo runner SessionManager runner attach.
Siga as instruções no prompt.

Liberando um Runner de um Host¶

Abra o terminal de comando de sua escolha e navegue até a pasta do BotCity Studio SDK onde o SessionManager está localizado.
Execute o comando para liberar um runner SessionManager runner release.
Siga as instruções no prompt.

Listando todos os Hosts e Runners Associados¶

Abra o terminal de comando de sua escolha e navegue até a pasta do BotCity Studio SDK onde o SessionManager está localizado.
Execute o comando para listar todos os hosts SessionManager list all.

Removendo um Host¶

Abra o terminal de comando de sua escolha e navegue até a pasta do BotCity Studio SDK onde o SessionManager está localizado.
Execute o comando para remover um host SessionManager host remove.
Siga as instruções no prompt.

Executando o Session Manager¶

Você pode executar o Session Manager clicando duas vezes no aplicativo SessionManager ou executando o seguinte comando para execução local:

SessionManager run local

Detalhes Técnicos¶

Como Funciona¶

O Session Manager monitora a fila de tarefas em tempo real, ativando recursos conforme a fila cresce e desativando-os quando a demanda diminui. Ele é otimizado para fornecer alocação de recursos em tempo hábil, reduzindo o tempo ocioso e garantindo a disponibilidade de recursos quando necessário.

Fluxo de Processos:

Monitoramento da Fila: O Session Manager monitora continuamente a fila de tarefas.
Ativação de Recursos: Quando há demanda de tarefas, os recursos são ativados para lidar com a carga.
Desativação de Recursos: À medida que a demanda deixa de existir, os recursos são liberados para otimizar a eficiência e reduzir os custos.

Solução de Problemas¶

Falha ao Iniciar o Serviço: Verifique o arquivo sm_out.log na pasta logs do BotCity Studio SDK. Alternativamente, verifique o Visualizador de Eventos em Logs do Windows > Aplicativo.
Problemas de Configuração: Certifique-se de que todas as configurações estejam definidas corretamente e correspondam às especificações do sistema.

Para mais assistência, entre em contato com nosso time de suporte.