Orchestrator - Pré-requisitos para instalação

Servidor do Orchestrator

Sistema Operacional Windows Server - versão mínima necessária: 2012 R2. Verifique os Requisitos de Software para as outras versões compatíveis.
Windows PowerShell - versão mínima exigida: 5.1. Para baixar o Windows PowerShell versão 5.1, visite este link e instale o Windows Management Framework 5.1. Para obter ajuda adicional, consulte a documentação de instalação do Windows PowerShell 5.1.
.NET Framework - versão mínima necessária: 4.7.2 Para descobrir qual versão do .NET está instalada no seu computador, consulte Encontrar a Versão do .NET Instalada.
IIS - versão mínima necessária: 8. Isso faz parte da função Web Server (IIS) e é habilitada automaticamente pelo script do InstallRolesAndFeatures.ps1 fornecido, que pode ser encontrado aqui.
ASP.Net Core IIS Module - versão mínima 6.0.x, disponível aqui como parte do Pacote de Hospedagem. Para fazer isso, certifique-se de clicar em Pacote de Hospedagem, conforme exibido na seguinte imagem.

Observação: o módulo do Core é necessário e pode ser instalado sem qualquer tempo de execução usando o parâmetro OPT_NO_RUNTIME=1 da linha de comando.
Reescrita de URL - versão mínima necessária 2.1. Permite que o site redirecione as chamadas para https (https://servername), ao invés de http (http://servername). Baixe e instale a Reescrita de URL acessando este link.
Funções e Funcionalidades do Servidor. Nós fornecemos um script do PowerShell que adiciona automaticamente as funções e funcionalidades necessárias ao(s) servidor(es) de aplicativos. A lista de funções e funcionalidades é apresentada em Funções e Funcionalidades do Servidor. Observe que esse capítulo é apenas para fins informativos.
Extensão do Web-Deploy - versão mínima necessária: 3.6, versão de 64 bits. Observe que isso é necessário apenas para instalações de script do PowerShell, como a do Azure. Permite que você implemente um site. Baixe e instale a Extensão do Web Deploy 3.6 acessando esse link.
Web.Config - O <system.webServer>elemento em web.config não deve conter qualquer seção bloqueada. Se essas seções existem, você precisa desbloqueá-las manualmente no IIS.
O usuário do Pool de aplicativos precisa ter os seguintes direitos na Política de Computador local:
- Faça login como um processamento em lote.
A Autenticação Anônima deve estar habilitada.

Certificados web (certificado SSL)

O protocolo do HTTPS é obrigatório para todas as comunicações entre Robôs e Orchestrator em todos os navegadores em que o aplicativo da Web é acessado pelos usuários.

Os três seguintes tipos de certificados da Web podem ser usados.

Um certificado web emitido por uma autoridade de certificação confiável, como a GoDaddy, VeriSign, etc. O certificado web deve ser importado para certificados de servidor no IIS. Você precisa saber o nome da entidade "Emitido para", que deve ser fornecido quando solicitado pelo instalador do Windows.
Você é uma Autoridade de Certificação que pode emitir certificados confiáveis no domínio do Windows. Consulte Uso de um Certificado para o Protocolo HTTPS.
Um certificado autoassinado, que não é recomendado para Produção. O certificado não é confiável dentro do domínio. Por esse motivo, você precisa exportar sua chave pública e, então, importá-la em todas as máquinas do Robô. Consulte Usando um certificado para o protocolo HTTPS para obter mais informações.

O nome do certificado que você fornecer quando solicitado pelo instalador do Windows ou aquele mencionado na linha de comando usando -sslCertificate é o mesmo que aparece na coluna Emitido para em Certificados do Servidor no IIS.

Importante:

Por razões de segurança, o certificado usado pelo Identity Server precisa:

ter uma chave pública em 2048 bits,
ser signing-capable,
ter uma chave privada acessível pelo usuário do AppPool,
estar no seu período de validade (não expirado).

O local do certificado é definido no arquivo appsettings.Production.json de configuração do Identity Server, na seção Signing Credential.

Se um certificado autoassinado for usado, ele também deve ser colocado no armazenamento de certificado da Autoridade de Certificação da Raiz confiável (além do local Pessoal habitual).

O certificado é usado para assinar tokens de acesso do OpenID que são usados para a identificação de usuário por meio do navegador e para comunicação de serviço a serviço entre o Orchestrator e o Identity Server. Clique aqui para mais detalhes sobre o OpenID Connect.

SQL Server

O produto do SQL Server pode ser instalado na mesma máquina que o Servidor de Aplicativo (não recomendado para o ambiente de produção) ou fornecido como uma máquina separada. A máquina do SQL Server pode ser compartilhada com outros aplicativos. Ela não precisa ser dedicada ao Orchestrator. Clique aqui para obter pré-requisitos, restrições e recomendações sobre como implantar grupos de disponibilidade Always On e aqui para obter detalhes sobre Opções de Implantação Física.
Se você planeja conectar o Orchestrator ao banco de dados usando um usuário do SQL Server habilite o modo de Autenticação do Windows e SQL Server. Caso contrário, o "modo de Autenticação do Windows" é suficiente. Se o SQL Server já estiver instalado, selecione esta opção como exibido nas imagens abaixo:

Observação: o usuário do SQL Server deve ter acesso ao nível do servidor, o acesso ao nível de banco de dados não é suficiente para uma instalação bem-sucedida.
A sequência de colação deve ser a padrão - Latin1_General_CI_AS.
O SQL Server Management Studio é necessário para configurar o login do usuário de domínio que acessa o SQL Server. O pool de aplicativos é executado no servidor de aplicativos sob o nome do usuário do domínio.

Configuração do SQL Server

Antes de instalar o Orchestrator, é necessário configurar a instância do SQL Server que você deseja usar.

Observação: o banco de dados SQL Orchestrator tem que ser insensível a casos ("OrchDB" = "orchdb"). Se for criado durante o processo de instalação do Orchestrator, ele será definido automaticamente como tal. Se não, você deve configurá-lo manualmente para ignorar maiúsculas e minúsculas.

Requisitos:

o nome da máquina do SQL Server;
o nome da instância, se não for a instância padrão;
o valor da porta TCP, se não fora porta padrão - 1433;
a porta do SQL Server está aberta no firewall da máquina do SQL Server;
o Protocolo TCP no SQL Server Configuration Manager deve estar habilitado;
o serviço do SQL Server precisa receber informação em uma porta fixa, não em uma alocada dinamicamente.
o acesso público ao banco de dados mestre SQL é necessário para a conta de serviço que executa o Orchestrator. Isso é necessário tanto para a instalação quanto para atualizações futuras.

Selecione uma das seguintes opções por meio das quais o Orchestrator pode se conectar ao banco de dados do SQL Server.

Autenticação Integrada do Windows. Para esta opção, um novo login é necessário para o SQL Server como uma conta de serviço. A conta de serviço deve ser um usuário de domínio cuja senha nunca expira.

Para criar um novo login no SQL Server Management Studio:

a. No painel Explorador de Objetos, navegue até Segurança > Login.

b. Clique com o botão direito do mouse na pasta Logins e selecione Novo Login. A janela Login - Novo será exibida.

c. Selecione a opção Autenticação do Windows. A janela é atualizada de acordo.

d. No campo Nome de login, digite o domínio de usuário que você deseja usar como uma conta de serviço.

e. Na lista Idioma padrão, selecione inglês.

Importante: certifique-se de que o idioma padrão esteja definido como inglês. Se não estiver, o site não pode iniciar e o Visualizador de Eventos no computador no qual o Orchestrator está instalado exibe a seguinte mensagem de erro: "a conversão de um tipo de dados varchar em um tipo de dados datetime resultou em um valor fora do intervalo".

f. Clique em OK. Suas configurações são salvas.

Se a conta de serviço já tiver sido criada e adicionada à seção Segurança > Logins do SQL Server, verifique se o Idioma Padrão dessa conta SQL está definido como inglês. Se não estiver, faça os ajustes necessários.

2. Nome de usuário e senha do SQL Server. Neste caso, um usuário do SQL Server é necessário. Recomendamos não usar uma conta sa.

Para criar um novo usuário SQL no SQL Server Management Studio:

a. No painel Explorador de Objetos, navegue até Segurança > Login.

b. Clique com o botão direito do mouse na pasta Logins e selecione Novo Login. A janela Login - Novo será exibida.

c. Selecione a opção autenticação do SQL Server. A janela é atualizada de acordo.

d. Preencha os campos Nome de login, Senha e Confirmar senha corretamente.

e. Certifique-se de que as opções Aplicar expiração de senha e Usuário deve alterar a senha no próximo login não estejam selecionadas.

Importante: certifique-se de que o idioma padrão esteja definido como inglês. Se não estiver, o site não pode iniciar e o Visualizador de Eventos no computador no qual o Orchestrator está instalado exibe a seguinte mensagem de erro: "a conversão de um tipo de dados varchar em um tipo de dados datetime resultou em um valor fora do intervalo".

Se a conta do SQL Server já tiver sido criada e adicionada à seção Segurança > Logins do SQL Server, verifique se o Idioma Padrão está definido como inglês. Se não estiver, faça os ajustes necessários.

Independentemente do tipo de usuário (domínio ou SQL) que você deseja conectar ao SQL Server, observe que você precisa atribuí-lo a Função de Servidor dbcreator ANTES de instalar o Orchestrator, pois o banco de dados é criado durante este processo de instalação.

Se as restrições de segurança não permitem o uso da Função de Servidor dbcreator na conta de serviço, crie o banco de dados vazio no SQL Server.

O instalador do Windows se conecta ao SQL Server para verificar a existência do banco de dados.

Após criar o banco de dados, você precisa fornecer ao usuário que se conecta ao banco de dados SQL com a função de mapeamento de usuário db_owner, como na seguinte captura de tela.

Se as restrições de segurança não permitem que você use afunção de mapeamento de usuários db_owner com o login da UiPath, conceda o seguinte:

db_datareader
db_datawriter
db_ddladmin
EXECUTEpermissão em dboesquema

[block:image] { "images": [ { "image": [] } ] } [/block]

A EXECUTEpermissão deve ser concedida usando o GRANT EXECUTEcomando SQL, da seguinte maneira.

se a Autenticação Integrada do Windows for usada:
```
USE UiPath
GO
GRANT EXECUTE ON SCHEMA::dbo TO [domain\user]
GOUSE UiPath
GO
GRANT EXECUTE ON SCHEMA::dbo TO [domain\user]
GO
```

se a Autenticação do SQL Server for usada:

USE UiPath
GO
GRANT EXECUTE ON SCHEMA::dbo TO [sql_user]
GOUSE UiPath
GO
GRANT EXECUTE ON SCHEMA::dbo TO [sql_user]
GO

Complemento de alta disponibilidade

O suplemento de Alta Disponibilidade (HAA) para o Orchestrator é um banco de dados em memória que é usado para cache e é compartilhado entre os nós do Orchestrator, fornecendo uma sincronização quase instantânea.

Importante:

O HAA é obrigatório em um ambiente de cluster.

As implantações de vários nós do Orchestrator usam o RESP (Protocolo de Serialização do REdis) para a comunicação, e, assim, podem ser configuradas usando qualquer solução que contenha esse protocolo, porém o HAA é a única solução compatível com a UiPath.

As seguintes informações são armazenadas no HAA:

estado de sessão - definido automaticamente ao instalar o Orchestrator em vários nós
sessões de usuário do navegador
cache de pulsação do UiPath Robot
associações entre usuários e funções
associações entre usuários e unidades de organização
Informações da licença
Configurações

O Orchestrator usa HAA como um cache compartilhado todos os seus nós. O exemplo a seguir descreve como o cache é usado para coordenar os nós do Orchestrator:

Exemplo: um usuário inicia manualmente um trabalho de Robô em um nó do Orchestrator. Esse nó específico pode não saber para qual nó do Orchestrator o Robô está conectado. O nó de onde você iniciou o trabalho encaminha a solicitação a HAA, que, por sua vez, sincroniza a informação. O nó do Orchestrator com uma conexão estabelecida com o Robô em questão envia o comando inicial para ele. Os outros nós do Orchestrator que não estão conectados ao nosso Robô apenas ignoram o comando.

Também é possível habilitar as conexões criptografadas por SSL entre os nós do Orchestrator e o serviço do HAA por meio do LoadBalancer.Redis.ConnectionStringparâmetro em UiPath.Orchestrator.dll.config. Para obter mais informações, consulte essa página.

Balanceador de carga de rede

Um balanceador de carga de rede permite que você distribua a carga para vários nós e, assim, habilita um desempenho geral melhor da sua instância do Orchestrator. Além disso, se um dos nós falhar, o resto assume a carga, garantindo que você não tenha tempo de inatividade.

Importante: Um balanceador de carga em rede é obrigatório se você quiser implantar o Orchestrator em um cluster, tirando vantagem de um modelo de alta disponibilidade.

Recomendamos usar um balanceamento de carga F5 com um algoritmo preditivo, pois a carga é distribuída para nós que funcionam melhor e, portanto, oferece um desempenho geral melhor do Orchestrator. Para obter mais informações sobre algoritmos, consulte aqui.

Servidor Elasticsearch

O Elasticsearch é opcional e é usado para armazenar mensagens registradas pelos Robôs. Os logs podem ser enviados para o ElasticSearch e/ou para um banco de dados SQL local, permitindo que você tenha logs de não repudiação. Ao usar o ElasticSearch e o SQL, eles não afetam um ao outro se um deles encontrar um problema. Esses parâmetros podem ser alterados a partir do arquivo UiPath.Orchestrator.dll.config (C:\Program Files (x86)\UiPath\Orchestrator). Para obter mais informações, consulte Configuração de Registro em Log.

Se você escolher usar o ElasticSearch, observe que, embora seja um produto multiplataforma, que é executado no Windows, Linux ou Unix, ele requer Java. Você pode usar o OpenJDK ou o Oracle JRE. Uma matriz de compatibilidade é fornecida pelo Elasticsearch aqui.

Observação: perceba que a partir de 16 de abril de 2019, o modelo de licenciamento da Oracle foi alterado. As informações relativas às alterações estão disponíveis aqui.

Se os computadores estão em um domínio, você deve garantir que sejam adicionados na seção de Computadores do servidor de domínio, em Usuários e Computadores do Active Directory. Esta etapa é necessária porque o nome do computador é usado durante o processo de instalação. Por exemplo, http://computername.domain.nameou http://computernameé usado em vez de http://localhost.

Se não for possível, o nome do computador ou o endereço IP devem ser usados durante o processo de instalação.

Instalando o Elasticsearch

Baixe o Elasticsearch.
Clique duas vezes no instalador do Windows do Elasticsearch. O assistente do Elastisearch é exibido, no passo Locations.
Use os diretórios padrão para a instalação, dados, configuração e logs ou selecione locais personalizados para cada um.

Observação: se você tiver outro disco diferente daquele que estiver o Elasticsearch instalado, você pode configurar o Elasticsearch para armazenar dados no disco com mais espaço livre.
Clique em Avançar. A etapa de Serviço é exibida.
Certifique-se de que as seguintes opções estejam selecionadas:
- Instalar como um serviço
- Iniciar o serviço após a conclusão da instalação
- Iniciar o serviço quando o Windows inicia (Automático)
Clique em Avançar. A etapa de Configuração é exibida.
Configure as opções seguintes conforme desejar:
- Nome do Cluster - altere o valor para algo que reflita o propósito da instalação do Elasticsearch. Isso é importante se você tiver vários servidores com o Elasticsearch na sua intranet, para evitar autodiscovery.
- Nome do nó - um nome amigável para o seu nó.
- Funções - as opções padrão são recomendadas.
- Memória - as opções padrão são recomendadas.
- Host de rede - o endereço de hostname/IP do computador (você pode obter o nome da máquina em um prompt de comando executando o nome do host de comando).
- Porta HTTP - a porta padrão para o Elasticsearch é 9200
- Descoberta - habilite a caixa de seleção Este é o primeiro mestre em um novo cluster para o primeiro nó no cluster.
  
  Importante: se o Orchestrator for instalado em uma máquina diferente, lembre-se de abrir a porta 9200 no Firewall da máquina onde o Elasticsearch é instalado.
Clique em Avançar. A etapa de Plug-ins é exibida.
(Opcionalmente) Selecione os plug-ins adicionais para o Elasticsearch, como o X-Pack para a segurança.
Clique em Instalar. O ElasticSearch está instalado.

Reduzindo o Número de Fragmentação de Índice

Por padrão, os índices recém-criados do Elasticsearch têm cinco shards. No entanto, para um melhor desempenho, é recomendável reduzir esse número para dois. Para obter mais informações, consulte a documentação oficial do Elasticsearch.

Para fazer essa alteração, tudo o que você precisa é fazer uma solicitação de PUT para a sua URL de instância do Elasticsearch no formato elasticUrl/_template/uipath_logs, com o seguinte corpo:

{
    "template": "*",
    "order": 1,
    "settings": {
        "number_of_shards": 2
    }
}{
    "template": "*",
    "order": 1,
    "settings": {
        "number_of_shards": 2
    }
}

Para testar sua conexão do ElasticSearch, use qualquer navegador para abrir a seguinte URL: http://computername:9200/. Computername reflete o nome do computador no qual o Elasticsearch está instalado. O navegador deve pedir que você baixe um .jsonarquivo ou abra e exiba o arquivo como na imagem abaixo.

Kibana

O Kibana é usado em combinação com o Elasticsearch e ajuda você a criar exibições personalizadas com base nos logs que você envia para o Elasticsearch, no nosso caso, aqueles enviados pelos Robôs.

Instalar o Kibana

Observação: o Kibana não precisa de Java para ser executado. Se o Kibana estiver instalado em uma máquina diferente do Elasticsearch, você não precisará instalar o Java para que o Kibana funcione.

Baixe o Kibana.
Descompacte o pacote Kibana.
Observação: descompacte para C:\ ou D:\ . Você não precisa criar uma nova pasta chamada kibana-x.y.z-windows, porque os arquivos já estão colocados em uma pasta com esse nome.
Edite o arquivo de configuração do Kibana (C:\kibana-x.y.z-windows-x86\config\kibana.yml), da seguinte maneira:
Observação: primeiro abra arquivo com o Wordpad e salve-o para converter os caracteres LF (Feed de Linha) em caracteres CRLF (Feed de Linha de Retorno de Carriagem). Depois, abra o arquivo com o Notepad.
1. Descomentar a linha que contém server.port. O valor padrão é 5601. Ele não precisa ser alterado, a menos que você queira que o Kibana seja executado em uma porta diferente.
2. Descomentar a linha que contém server.host. Altere o valor para o nome do computador.
3. Descomentar a linha que contém elasticsearch.url. Altere o valor para o URL do Elasticsearch usando o nome do computador em que o Elasticsearch está instalado. Por exemplo, http://computername:9200.
  Observação: para o Kibana 6.6.0 ou posterior, essa linha foi substituída por elasticsearch.hosts.
  
  A captura de tela abaixo exibe um exemplo de um arquivo de configuração do Kibana no qual os nomes de computador do Kibana e do Elasticsearch são JLTSQL:
4. Salve o arquivo.
Baixe o arquivo setup-kibana-service.zip.
Copie os arquivos nssm.exe e setup_kibana.bat do setup-kibana-service.ziparquivo para C:\kibana-x.y.z-windows-x86\bin.
Abra o arquivo KIBANA_HOME para verificar se o Kibana está instalado de acordo com o local definido na variável setup_kibana.bat do arquivo BAT. Se você extraiu o Kibana para um local diferente, faça as alterações necessárias.
Abra o Prompt de Comando como um Administrador e altere a pasta para C:\kibana-x.y.z-windows-x86\bin.
Execute setup_kibana.batpara instalar o Kibana.
Teste se o Kibana responde digitando http://computername:5601em qualquer navegador da Web. computernamerepresenta o nome do computador no qual você instalou o Kibana.
Importante: abra a porta 5601 no Firewall da máquina em que o Kibana estiver instalado.
Adicione uma mensagem de teste no banco de dados do Elasticsearch usando o Kibana:
1. No Kibana, navegue para a aba Ferramentas de Desenvolver.
2. Envie uma solicitação de POST no formato exibido abaixo. Se nenhum erro for retornado, o índice do Elasticsearch chamado default-yyyy.mm será criado e a mensagem será adicionada.

Importante: cada vez que um novo tenant é adicionado, um padrão de índice correspondente deve ser criado no Kibana, a partir do nome do tenant. yyyy representa o ano em que a mensagem foi adicionada. mm representa o mês em que a mensagem foi adicionada. Leia Criando um Padrão de Índice para se Conectar ao Elasticsearch para aprender como criar um padrão de índice no Kibana.

Sincronização de Tempo

Lembre-se de que, independentemente do tipo de instalação que você escolher, para que as funcionalidades de agendamento funcionem corretamente, deve garantir que:

no modo agrupado, os relógios em todas as máquinas devem ser sincronizados em menos de um segundo;
os relógios para o banco de dados e as máquinas do Orchestrator também devem ser sincronizadas;
se o banco de dados SQL inserir um estado com falha, é recomendável reiniciar o servidor da Web do Orchestrator do IIS. Se você estiver em um ambiente NLB, reinicie todos os servidores da Web.

Guia de instalação do Orchestrator

Pré-requisitos para a instalação