Manual: experiência de instalação avançada

Esta página explica como usar o arquivo de configuração cluster_config.json do Automation Suite.

O arquivo cluster_config.json define parâmetros, configurações e preferências aplicadas a produtos da UiPath implantados via Automation Suite. Você precisa atualizar esse arquivo se quiser alterar padrões e usar qualquer configuração avançada para seu cluster.

Para editar cluster_config.json, você pode usar:

• um editor de texto do Linux, como vi ou GNU nano, diretamente na máquina Linux via SSH (por exemplo, comando: vi cluster_config.json);
• o editor de texto de sua preferência e, em seguida, copiar e colar o arquivo na máquina.

O arquivo cluster_config.json permite configurar os produtos da UiPath que você deseja implantar. Há dois tipos de produtos da UiPath:

• produtos obrigatórios: são instalados por padrão e não têm o sinalizador enabled disponível neles;
• produtos opcionais: não são obrigatórios para concluir a instalação. No entanto, esteja ciente de que os produtos podem ter dependências. Consulte Dependências de produtos para obter mais informações sobre isso.

Para habilitar ou desabilitar um produto pelo arquivo cluster_config.json, use true ou false para o sinalizador enabled.

Amostra Cluster_config.json

{
  "fqdn": "PLACEHOLDER",
  "fixed_rke_address": "PLACEHOLDER",
  "multinode": "false",
  "admin_username": "PLACEHOLDER",
  "admin_password": "PLACEHOLDER",
  "profile": "ha",
  "telemetry_optout": "true",
  "rke_token": "PLACEHOLDER",
  "server_certificate": {
    "ca_cert_file": "/absolute/path/to/rootCA.crt",
    "tls_cert_file": "/absolute/path/to/server.crt",
    "tls_key_file": "/absolute/path/to/server.key"
  },
  "infra": {
    "docker_registry": {
      "username": "PLACEHOLDER",
      "password": "PLACEHOLDER"
    },
    "custom_dns_resolver": "/path/to/custom-resolv.conf"
  },
  "identity_certificate": {
    "token_signing_cert_file": "/absolute/path/to/identity.pfx",
    "token_signing_cert_pass": ""
  },
  "sql": {
    "server_url": "PLACEHOLDER",
    "username": "PLACEHOLDER",
    "password": "PLACEHOLDER",
    "port": "PLACEHOLDER",
    "create_db": "PLACEHOLDER"
  },
  "sql_connection_string_template": "PLACEHOLDER",
  "sql_connection_string_template_jdbc": "PLACEHOLDER",
  "sql_connection_string_template_odbc": "PLACEHOLDER",
  "orchestrator": {
    "testautomation": {
      "enabled": true
    },
    "updateserver": {
      "enabled": true
    }
  },
  "aicenter": {
    "enabled": true,
    "sql_connection_str": "PLACEHOLDER"
  },
  "documentunderstanding": {
    "enabled": true,
    "datamanager": {
      "sql_connection_str": "PLACEHOLDER"
    },
    "handwriting": {
      "enabled": true,
      "max_cpu_per_pod": 2
    }
  },
  "insights": {
    "enabled": true
  },
  "test_manager": {
    "enabled": true
  },
  "automation_ops": {
    "enabled": true
  },
  "automation_hub": {
    "enabled": true
  },
  "apps": {
    "enabled": true
  },
  "action_center": {
    "enabled": true
  },
  "task_mining": {
    "enabled": true
  }
}

Configuração geral

Parâmetros obrigatórios	Description
fqdn	O nome de domínio do balanceador de carga (modo de produção pronto para alta disponibilidade de vários nós) ou da máquina (modo de avaliação de nó único).
fixed_rke_address	O endereço fixo usado para registro de nó de balanceamento de carga e solicitações de API do kube. Deve ser fqdn se o balanceador de carga estiver configurado como recomendado. Caso contrário, FQDN do 1º nó do servidor. Consulte Configuração do balanceador de carga. Pode ser o IP/FQDN do primeiro servidor rke2 na sua configuração.
multinode	Defina como true ao escolher um perfil de produção pronto para alta disponibilidade de vários nós. O valor desse sinalizador é definido automaticamente pelo assistente de instalação interativo. Ele é usado apenas para fins internos e não deve ser modificado manualmente.
admin_username	O nome de usuário que você deseja definir como administrador (como: admin ) para a organização do host.
admin_password	A senha de administrador do host a ser definida.
rke_token	Use um GUID recém-gerado aqui. Este é um segredo pré-compartilhado, específico do cluster. É necessário para todos os nós associados ao cluster.
profile	Define o perfil da instalação. Os perfis disponíveis são: default : perfil de avaliação de nó único. ha : perfil de produção pronto para alta disponibilidade de vários nós. O valor desse sinalizador é definido automaticamente pelo assistente de instalação interativo. Ele é usado apenas para propósitos internos e não deve ser modificado manualmente.
infra.docker_registry.username	O nome de usuário que você deseja definir para a instalação do registro do docker.
infra.docker_registry.password	A senha que você deseja definir para a instalação do registro do docker.

Parâmetros opcionais	Description
telemetry_optout	true ou false – usado para cancelar o envio de telemetria de volta ao UiPath®. Ele é definido como false por padrão. Se você deseja cancelar, defina como true.

Configuração de Certificados

Consulte os documentos de pré-requisitos para obter o certificado:

• Modo de avaliação de nó único: configuração dos certificados
• Produção pronta para alta disponibilidade de vários nós: configuração dos certificados

Se nenhum certificado for fornecido no momento da instalação, o instalador cria um certificado emitido automaticamente e configura o certificado no cluster. A validade do certificado é de 90 dias.

Observação:

Não se esqueça de especificar o caminho absoluto para arquivos de certificado. Execute pwd para obter o caminho do diretório no qual os arquivos foram colocados e anexe o nome do arquivo de certificado no cluster_config.json.

Nas instalações de produção prontas para alta disponibilidade de vários nós, é necessário um certificado apenas no primeiro nó.

Parâmetro	Description
server_certificate.ca_cert_file	Caminho absoluto para o certificado da Autoridade de Certificação (CA). Essa CA é a autoridade que assina o certificado TLS. Um pacote CA deve conter apenas os certificados da cadeia usados para assinar o certificado TLS. O limite da cadeia é de até nove certificados. Se você estiver usando um certificado autoassinado, precisará especificar o caminho para o rootCA.crt, que você criou anteriormente. Deixe em branco se deseja que o instalador gere.
server_certificate.tls_cert_file	O caminho absoluto para o certificado de TLS (server.crt para autoassinado, criado em etapas anteriores). Deixe em branco se você quiser que o instalador gere.
server_certificate.tls_key_file	O caminho absoluto para a chave de certificado (server.key para autoassinado, criado em etapas anteriores). Deixe em branco se você quiser que o instalador gere.
identity_certificate.token_signing_cert_file	O caminho absoluto para o certificado do Identity Service usado para assinar tokens (identity.pfx para autoassinados criados em etapas anteriores). Deixe em branco se você quiser que o instalador gere um certificado de identidade usando o certificado do servidor.
identity_certificate.token_signing_cert_pass	Senha de texto simples definida quando foi exportado.
additional_ca_certs	O caminho absoluto para o arquivo contendo certificados de CA adicionais que você deseja que seja confiável para todos os serviços que funcionam como parte do Automation Suite. Todos os certificados no arquivo devem ter um formato PEM válido. Por exemplo, você precisa fornecer o arquivo que contém o certificado de CA do SQL Server se o certificado não for emitido por uma autoridade de certificação pública.

Configuração do Banco de Dados

Cria automaticamente os bancos de dados necessários

Se desejar que o instalador crie os bancos de dados, preencha os seguintes campos:

Parâmetro	Description
sql.create_db	Defina como true.
sql.server_url	FQDN do SQL Server, onde você deseja que o instalador configure o banco de dados.
sql.port	Número da porta na qual uma instância de banco de dados deve ser hospedada no SQL Server.
sql.username	Nome de usuário/ID do usuário para se conectar ao SQL Server.
sql.password	Senha do nome de usuário fornecido anteriormente para se conectar ao SQL Server.

Observação:

Certifique-se de que o usuário tenha a função de dbcreator. Isso concede a ele permissão para criar o banco de dados no SQL Server. Caso contrário, a instalação falha.

A conexão ODBC não aceita nomes de usuário que contenham caracteres especiais. Para nomes de usuário de banco de dados do AI Center e do Document Understanding, use apenas letras maiúsculas e minúsculas.

Traga seu próprio banco de dados

Se você optar por trazer seus próprios bancos de dados para uma nova instalação do Automation Suite, recomendamos fortemente a configuração de novos bancos de dados em vez de usar os existentes. Essa precaução é necessária para evitar quaisquer conflitos com a operação do Automation Suite que possam ocorrer devido a metadados restantes de bancos de dados antigos.

Se você trouxer seu próprio banco de dados, também deverá fornecer as strings de conexão SQL para cada banco de dados. O Automation Suite oferece suporte aos seguintes formatos de string de conexão SQL:

Parâmetro	Description	Produtos
sql_connection_string_template	String de conexão completa do ADO.NET onde o nome do catálogo é definido como DB_NAME_PLACEHOLDER. O instalador substituirá esse espaço reservado pelos nomes de banco de dados padrão para os serviços do pacote instalado.	Platform, Orchestrator, Test Manager, Automation Hub, Automation Ops, Insights, Task Mining, Document Understanding
sql_connection_string_template_jdbc	String de conexão completa do JDBC onde o nome do banco de dados é definido como DB_NAME_PLACEHOLDER. O instalador substituirá esse espaço reservado pelos nomes de banco de dados padrão para os serviços do pacote instalado.	AI Center
sql_connection_string_template_odbc	String de conexão completa do ODBC onde o nome do banco de dados é definido como DB_NAME_PLACEHOLDER. O instalador substituirá esse espaço reservado pelos nomes de banco de dados padrão para os serviços do pacote instalado.	Document Understanding

Importante:

Se você definir manualmente as strings de conexão no arquivo de configuração, poderá usar o caractere de escape em senhas SQL, JDBC ou ODBC da seguinte maneira:

• para SQL: adicione ' no início e no fim da senha, e duplique qualquer outro '.
• para JDBC/ODBC: adicione { no início da senha e } no final, e duplique qualquer outro }

Observação:

Por padrão, TrustServerCertificate é definido como False, e você deve fornecer um certificado de CA adicional para o SQL Server. Isso é necessário se o certificado do SQL Server for autoassinado ou assinado por uma CA interna.

Consulte Configuração de certificados nesta página para obter mais detalhes.

Exemplo do sql_connection_string_template

Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net:1433;Initial Catalog=DB_NAME_PLACEHOLDER;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;

Exemplo do sql_connection_string_template_jdbc

jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net:1433;database=DB_NAME_PLACEHOLDER;user=testadmin;password=***;encrypt=true;trustServerCertificate=false;Connection Timeout=30;hostNameInCertificate=sfdev1804627-c83f074b-sql.database.windows.net"

Exemplo do sql_connection_string_template_odbc

SERVER=sfdev1804627-c83f074b-sql.database.windows.net,1433;DATABASE=DB_NAME_PLACEHOLDER;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=***;MultipleActiveResultSets=False;Encrypt=YES;TrustServerCertificate=NO;Connection Timeout=30;"

Nomes de banco de dados padrão e opcional para serviços do Automation Suite

{
  "orchestrator": "AutomationSuite_Orchestrator",
  "orchestrator_ta": "AutomationSuite_Orchestrator",
  "orchestrator_upd": "AutomationSuite_Platform",
  "platform": "AutomationSuite_Platform",
  "test_manager": "AutomationSuite_Test_Manager",
  "automation_ops": "AutomationSuite_Platform",
  "automation_hub": "AutomationSuite_Automation_Hub",
  "insights": "AutomationSuite_Insights",
  "task_mining": "AutomationSuite_Task_Mining",
  "aicenter": "AutomationSuite_AICenter",
  "documentunderstanding": "AutomationSuite_DU_Datamanager",
}

Observação:

Se você quiser substituir a string de conexão de algum dos serviços acima, defina sql_connection_str para esse serviço específico.

Você ainda precisa criar esses bancos de dados manualmente antes de executar o instalador.

Substituição da string de conexão padrão do Orchestrator e da plataforma

{
  "orchestrator": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomOrchDB;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  },
  "platform": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomIDDB;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}

Para substituir as strings de conexão do banco de dados para outros produtos, defina sql_connection_str nos blocos de produto correspondentes. A string de conexão deve ter um formato compatível com o respectivo produto.

Exemplo para definir a string de conexão do banco de dados para o AI Center

Parâmetro	Description
aicenter.sql_connection_str	String de conexão JDBC do AICenter (consulte abaixo o formato JDBC)

Observação: verifique se a string de conexão JDBC tem o formato do exemplo abaixo.

"aicenter": {
    "enabled": true,
    "sql_connection_str": "jdbc:sqlserver://sfdev1804627-c83f074b-sql.database.windows.net;database=aicenter;user=[e-mail];password=TFgID_9GsE7_P@srCQp0WemXX_euHQZJ"
}

Amostra de string de conexão do Document Understanding

"documentUnderstanding": {
  "datamanager": {
    "sql_connection_str": "SERVER=sql-server.database.windows.net;DATABASE=datamanager;DRIVER={ODBC Driver 17 for SQL Server};UID=testadmin;PWD=myPassword"
  },
  "sql_connection_str": "Server=tcp:database.example.com,1433;Initial Catalog=db;Persist Security Info=False;User Id=[e-mail];Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
  "cjkOcr": 
  {
    "enabled": true
  }
}

Observação: a string de conexão do SQL Data Manager é opcional apenas se você quiser substituir a string padrão por uma própria.

O manuscrito fica sempre habilitado para a instalação online.

O valor padrão de max_cpu_per-pod é 2, mas você pode ajustá-lo de acordo com suas necessidades. Para obter mais informações, confira o Arquivo de configuração do Document Understanding.

Importante:

Certifique-se de que a conta do SQL especificada nas strings de conexão tenha a função db_owner para todos os bancos de dados do Automation Suite. Se as restrições de segurança não permitem o uso de db_owner, a conta do SQL deve ter as seguintes funções e permissões em todos os bancos de dados:

• db_ddladmin
• db_datawriter
• db_datareader
• EXECUTEpermissão no esquema dbo

Configuração específica do Orchestrator

O Orchestrator pode salvar logs de robô em um servidor do Elasticsearch. Você pode configurar esta funcionalidade na seção orchestrator.orchestrator_robot_logs_elastic. Se não forem fornecidos, os logs de robô serão salvos no banco de dados do Orchestrator.

A tabela a seguir lista os campos orchestrator.orchestrator_robot_logs_elastic:

Parâmetro	Description
elastic_uri	O endereço da instância do Elasticsearch que deve ser usado. Ele deve ser fornecido na forma de um URI. Se fornecidos, o nome de usuário e senha também são necessários.
elastic_auth_username	O nome de usuário do Elasticsearch, usado para autenticação.
elastic_auth_password	A senha do Elasticsearch, usada para autenticação.

Exemplo:

"orchestrator": {
    "orchestrator_robot_logs_elastic": {
        "elastic_uri": "https://elastic.example.com:9200",
        "elastic_auth_username": "elastic-user",
        "elastic_auth_password": "elastic-password"
    }
}

Configuração específica do Insights

Se habilitar o Insights, os usuários podem incluir a configuração do servidor SMTP que será usada para enviar emails agendados/emails de alerta. Se não for fornecida, os emails agendados e os emails de alerta não funcionarão.

Os detalhes dos campos insights.smtp_configuration:

Parâmetro	Description
tls_version	Os valores válidos são TLSv1_2, TLSv1_1, SSLv23. Omita a chave completamente se não estiver usando TLS.
from_email	Endereço do qual os emails de alerta/agendados serão enviados.
host	Nome do host do servidor SMTP.
port	Porta do servidor SMTP.
username	Nome de usuário para a autenticação do servidor SMTP.
password	Senha para a autenticação do servidor SMTP.

Exemplo:

"insights": {
    "enabled": true,
    "smtp_configuration": {
      "tls_version": "TLSv1_2",
      "from_email": "[e-mail]",
      "host": "smtp.sendgrid.com",
      "port": 587,
      "username": "login",
      "password": "password123"
    }
  }

Configuração do monitoramento

Para provisionar recursos suficientes para o monitoramento (consulte Uso da pilha de monitoramento), você deve considerar a quantidade de vCPUs no cluster e a quantidade de retenção de métrica desejada. Confira abaixo como definir as seguintes configurações de recursos de monitoramento.

A tabela a seguir descreve os detalhes do campo de monitoramento:

Parâmetro	Description
prometheus_retention	Em dias. Esta é a quantidade de dias que as métricas serão mantidas para a finalidade de visualização no Grafana e consulta manual usando o console do Prometheus. O valor padrão é 7.
prometheus_storage_size	No GiB. Quantidade de espaço de armazenamento a ser reservado por réplica do Prometheus. Uma boa regra prática é definir esse valor como: 0.65 * vCPU cores * (prometheus_retention / 7) Exemplo: Se você definir prometheus_retention como 14 dias, e seu cluster tiver 80 núcleos distribuídos em 5 máquinas, isso se torna: 0.65 * 80 * (14 / 7) 52 * (2) 104 O valor padrão é 45 e não deve ser definido um valor inferior. Se o Prometheus começar a ficar sem espaço de armazenamento, um alerta será enviado com instruções de correção específicas. Confira aqui.
prometheus_memory_limit	Em MiB. Quantidade de memória a ser limitada para cada réplica do Prometheus. Uma boa regra prática é definir esse valor como: 100 * vCPU cores * (prometheus_retention / 7) Exemplo: Se você definir prometheus_retention como 14 dias, e seu cluster tiver 80 núcleos distribuídos em 5 máquinas, isso se torna: 100 * 80 * (14 / 7) 8000 * (2) 16000 O valor padrão é 3200 para o modo de avaliação de nó único, e 6000 para o modo de produção pronto para alta disponibilidade de vários nós, e não deve ser definido um valor inferior. Se o Prometheus começar a ficar sem memória, um alerta será enviado com instruções de correção específicas. Confira aqui.

Exemplo:

"monitoring": {
  "prometheus_retention": 14,
  "prometheus_memory_limit": 16000,
  "prometheus_storage_size": 104
}

Opcional: configuração do servidor proxy

Observação:

Confira se os requisitos do servidor proxy são atendidos antes de configurar o servidor proxy durante a instalação.

Para obter detalhes, consulte Etapa 2: adição da configuração de proxy a cada nó.

Ao executar o assistente do instalador interativo, você precisa fechá-lo e atualizar o cluster_config.json durante a etapa de configuração avançada.

Você precisa adicionar o seguinte ao arquivo de configuração usando o vim ou o editor de sua preferência no arquivo de configuração:

"proxy": {
  "enabled": "true",
  "http_proxy": "http://<PROXY-SERVER-IP>:<PROXY-PORT>",
  "https_proxy": "http://<PROXY-SERVER-IP>:<PROXY-PORT>",
  "no_proxy": "alm.<fqdn>,<fixed_rke_address>:9345,<fixed_rke_address>:6443,<named server address>,<metadata server address>,10.0.0.0/8,<private_subnet_ip>,<sql server host>,<Comma separated list of ips that should not got though proxy server>"
}

Parâmetros obrigatórios	Description
enabled	Use true ou false para habilitar ou desabilitar as configurações de proxy.
http_proxy	Usado para rotear solicitações de saída HTTP do cluster. Este deve ser o FQDN e a porta do servidor proxy.
https_proxy	Usado para rotear solicitações de saída HTTPS do cluster. Este deve ser o FQDN e a porta do servidor proxy.
no_proxy	Lista separada por vírgulas de hosts, endereços IP ou intervalos de IP no formato CIDR que você não deseja rotear por meio do servidor proxy. Este deve ser um intervalo de sub-rede privada, host do SQL Server, endereço do servidor nomeado, endereço do servidor de metadados: *.<fqdn>,<fixed_rke_address>:9345,<fixed_rke2_address>:6443. fqdn – o FQDN do cluster definido em cluster_config.json fixed_rke_address – o fixed_rke_address definido em cluster_config.json named server address – o endereço IP de /etc/resolv.conf private_subnet_ip – o VNet do cluster sql server host – o host do SQL Server metadata server address – o endereço IP 169.254.169.254 usado para buscar metadados de máquina por serviços de nuvem, como o Azure e o AWS

Opcional: habilitação da resiliência a falhas zonais em um cluster de produção pronto para alta disponibilidade de vários nós

Para habilitar a resiliência a falhas zonais em um cluster de vários nós, siga estas etapas:

1. Certifique-se de que os nós estejam distribuídos uniformemente em três zonas de disponibilidade. Para um servidor bare-metal ou VM fornecido por qualquer fornecedor, exceto AWS, Azure ou GCP, os metadados da zona devem ser fornecidos por meio do arquivo de configuração /etc/default/k8s-node-labels em cada máquina no formato a seguir.

   NODE_REGION_LABEL=<REGION_NAME>
   NODE_ZONE_LABEL=<ZONE_NAME>
   cat > /etc/default/k8s-node-labels <<EOF
   EXTRA_K8S_NODE_LABELS="topology.kubernetes.io/region=$NODE_REGION_LABEL,topology.kubernetes.io/zone=${NODE_ZONE_LABEL}"
   EOF

2. Atualize o arquivo cluster_config.json durante a etapa de configuração avançada.

Para atualizar o cluster_config.json usando o assistente de instalação interativo, feche na etapa de configuração avançada e adicione o seguinte ao arquivo de configuração usando o vim ou o editor de sua preferência:

"zone_resilience": true

Parâmetros obrigatórios	Description
zone_resilience	Use true ou false para habilitar ou desabilitar a resiliência à falha zonal.

Opcional: passar Resolv.conf personalizado

O cluster do Kubernetes que o Automation Suite implanta usa os servidores de nomes configurados em /etc/resolv.conf. O Kubernetes não funciona com resolvedores de DNS locais (127.0.0.1 ou 127.0.0.0/8), portanto, se você tiver esses servidores de nomes configurados no arquivo /etc/resolv.conf, é necessário passar uma referência de arquivo com as entradas de servidor de nomes corretas acessíveis a partir de qualquer lugar na VM no parâmetro .infra.custom_dns_resolver em cluster_config.json.

Para obter detalhes sobre uma limitação conhecida, consulte a Documentação do Kubernetes.

Parâmetro opcional	Description
.infra.custom_dns_resolver	Caminho para o arquivo com as entradas corretas do servidor de nomes que podem ser acessadas de qualquer lugar na VM. Essas entradas de servidor de nomes não devem ser de 127.0.0.0/8.