Manual: experiencia de instalación avanzada

En esta página se explica cómo utilizar el archivo de configuración cluster_config.json de Automation Suite.

El archivo cluster_config.json define los parámetros, la configuración y las preferencias que se aplican a los productos de UiPath implementados a través de Automation Suite. Debes actualizar este archivo si deseas cambiar los valores predeterminados y utilizar cualquier configuración avanzada para tu clúster.

Para editar cluster_config.json, puede utilizar:

• un editor de texto Linux, como vi o GNU nano, directamente en la máquina Linux a través de SSH (por ejemplo, comando: vi cluster_config.json);
• su editor de texto favorito y luego, copiar y pegar el archivo en la máquina.

El archivo cluster_config.json te permite configurar los productos de UiPath que deseas implementar. Hay dos tipos de productos de UiPath:

• productos obligatorios: se instalan de forma predeterminada y no tienen disponible la marca enabled;
• productos opcionales: no son necesarios para completar la instalación. Sin embargo, tenga en cuenta que los productos pueden tener dependencias. Consulte Dependencias del producto para obtener más detalles.

Para habilitar o deshabilitar un producto a través del archivo cluster_config.json, utiliza true o false para el marcador enabled.

Ejemplo de Clúster_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
  }
}

Configuración general

Parámetros obligatorios	Descripción
fqdn	El nombre de dominio del equilibrador de carga (modo de producción multinodo preparada para alta disponibilidad) o de la máquina (modo de evaluación de nodo único).
fixed_rke_address	Dirección fija que se utiliza para equilibrar la carga del registro del nodo y las solicitudes de la API de Kubernetes. Debe ser FQDN si el equilibrador de carga está configurado de la manera recomendada. De lo contrario, el FQDN del primer nodo de servidor. Consulta Configurar el equilibrador de carga. Puede ser la IP o el FQDN del primer servidor rke2 en su configuración.
multinode	Se establece como true cuando se elige un perfil de producción multinodo preparada para alta disponibilidad. El valor de este marcador lo establece automáticamente el asistente de instalación interactivo. Su uso es únicamente para fines internos y no debe modificarse manualmente.
admin_username	El nombre de usuario que desea establecer como administrador (por ejemplo, admin) para la organización del host.
admin_password	La clave de administrador del host que se establecerá.
rke_token	Utilice aquí un GUID recién generado. Este es un secreto previamente compartido y específico del clúster. Es necesario para todos los nodos que se unan al clúster.
profile	Establece el perfil de la instalación. Los perfiles disponibles son: default: perfil de evaluación de nodo único. ha: perfil de producción multinodo preparada para alta disponibilidad. El valor de este marcador lo establece automáticamente el asistente de instalación interactivo. Su uso es únicamente para fines internos y no debe modificarse manualmente.
infra.docker_registry.username	El nombre de usuario que desea establecer para la instalación del registro Docker.
infra.docker_registry.password	La contraseña que desea establecer para la instalación del registro Docker.

Parámetros opcionales	Descripción
telemetry_optout	true o false: se utiliza para cancelar el envío de telemetría a UiPath®. Está establecido en false de manera predeterminada. Si desea cancelarlo, establézcalo en true.

Configuración de certificados

Consulte los documentos de requisitos previos para obtener el certificado:

• Modo de evaluación de nodo único: configuración de los certificados
• Producción multinodo preparada para alta disponibilidad: configuración de los certificados

Si en el momento de la instalación no se proporciona ningún certificado, el instalador crea un certificado autoemitido y lo configura en el clúster. El certificado tiene una validez de 90 días.

Nota:

Asegúrese de especificar la ruta absoluta de los archivos de certificado. Ejecute pwd para obtener la ruta del directorio donde se encuentran los archivos y añada el nombre del archivo de certificado a cluster_config.json.

En las instalaciones de producción multinodo preparadas para alta disponibilidad, solo se requiere un certificado en el primer nodo.

Parámetro	Descripción
server_certificate.ca_cert_file	Ruta absoluta al certificado de la entidad de certificación (CA). Esta CA es la autoridad que firma el certificado TLS. Un paquete de CA debe contener solo los certificados en cadena utilizados para firmar el certificado TLS. El límite de la cadena es de hasta nueve certificados. Si utilizas un certificado autofirmado, debes especificar la ruta al rootCA.crt, que creaste previamente. Déjelo en blanco si desea que el instalador genere.
server_certificate.tls_cert_file	Ruta absoluta al certificado TLS (server.crtpara el certificado autofirmado que se creó en los pasos anteriores). Déjelo en blanco si desea que lo genere el instalador.
server_certificate.tls_key_file	Ruta absoluta a la clave de certificado (server.keypara el certificado autofirmado que se creó en los pasos anteriores). Déjelo en blanco si desea que lo genere el instalador.
identity_certificate.token_signing_cert_file	Ruta absoluta al certificado de Identity Service utilizado para firmar los tokens (identity.pfxpara los autofirmados creados en pasos anteriores). Déjelo en blanco si desea que el instalador genere un certificado de identidad utilizando el certificado del servidor.
identity_certificate.token_signing_cert_pass	Contraseña de texto sin formato establecida al exportarse.
additional_ca_certs	Ruta absoluta al archivo que contiene los certificados AC adicionales que desea que sean de confianza para todos los servicios que se ejecutan como parte de Automation Suite. Todos los certificados del archivo deben tener un formato PEM válido. Por ejemplo, debe proporcionar el archivo que contiene el certificado AC del servidor SQL si el certificado no ha sido emitido por una autoridad de certificación pública.

Configuración de la base de datos

Creación automática de las bases de datos necesarias

Si desea que el instalador cree las bases de datos, rellene los siguientes campos:

Parámetro	Descripción
sql.create_db	Establecida como true.
sql.server_url	FQDN del servidor SQL donde desea que el instalador configure la base de datos.
sql.port	Número de puerto en el que debe alojarse una instancia de base de datos en el servidor SQL.
sql.username	Nombre o ID de usuario con el que conectarse al servidor SQL.
sql.password	Contraseña del nombre de usuario proporcionado anteriormente con la que conectarse al servidor SQL.

Nota:

Asegúrese de que el usuario tiene el rol dbcreator. Esto le da permiso para crear la base de datos en el servidor SQL. De lo contrario, la instalación fallará.

La conexión ODBC no admite nombres de usuario que contengan caracteres especiales. Para los nombres de usuario de la base de datos de AI Center y Document Understanding, utilice únicamente mayúsculas y minúsculas.

Utilizar su propia base de datos

Si decides traer tus propias bases de datos para una nueva instalación de Automation Suite, recomendamos encarecidamente configurar nuevas bases de datos en lugar de utilizar las existentes. Esta precaución es necesaria para evitar cualquier conflicto con la operación de Automation Suite que pueda ocurrir debido a los metadatos sobrantes de las bases de datos antiguas.

Si aportas tu propia base de datos, también debes proporcionar las cadenas de conexión SQL para cada base de datos. Automation Suite admite los siguientes formatos de cadenas de conexión SQL.

Parámetro	Descripción	Productos
sql_connection_string_template	Cadena de conexión ADO.NET completa en la que el nombre del catálogo se establece como DB_NAME_PLACEHOLDER. El instalador sustituirá este marcador de posición por los nombres de base de datos predeterminados para los servicios de la suite instalada.	Plataforma, Orchestrator, Test Manager, Automation Hub, Automation Ops, Insights, Task Mining, Document
sql_connection_string_template_jdbc	Cadena de conexión JDBC completa en la que el nombre de base de datos se establece como DB_NAME_PLACEHOLDER. El instalador sustituirá este marcador de posición por los nombres de base de datos predeterminados para los servicios de la suite instalada.	AI Center
sql_connection_string_template_odbc	Cadena de conexión ODBC completa en la que el nombre de base de datos se establece como DB_NAME_PLACEHOLDER. El instalador sustituirá este marcador de posición por los nombres de base de datos predeterminados para los servicios de la suite instalada.	Document Understanding

Importante:

Si establece manualmente las cadenas de conexión en el archivo de configuración, puede escapar de las contraseñas SQL, JDBC u ODBC de la siguiente manera:

• para SQL: añade ' al principio y al final de la contraseña, y doble cualquier otra' .
• para JDBC/ODBC: añade { al principio y } al final de la contraseña, y duplicar cualquier otra }.

Nota:

De forma predeterminada, TrustServerCertificate está establecido en False, y debes proporcionar un certificado de CA adicional para SQL Server. Esto es necesario si el certificado del servidor SQL está autofirmado o firmado por una AC interna.

Consulta Configuración de certificados en esta página para obtener más detalles.

ejemplo: plantilla_cadena_conexión_sql

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;

ejemplo: plantilla_cadena_conexión_jdbc_sql

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"

ejemplo: plantilla_cadena_conexión_odjbc_sql

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;"

Nombres de base de datos predeterminados y opcionales para servicios de 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",
}

Nota:

Si desea anular la cadena de conexión para cualquiera de los servicios anteriores, establezca la sql_connection_str para ese servicio específico.

De todos modos, tiene que crear manualmente estas bases de datos antes de ejecutar el instalador.

Anular la cadena de conexión predeterminada para Orchestrator y la 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 anular las cadenas de conexión a la base de datos de otros productos, establezca la sql_connection_str en los bloques de producto correspondientes. La cadena de conexión debe tener un formato compatible con el respectivo producto.

Ejemplo de establecimiento de cadena de conexión a la base de datos para AI Center

Parámetro	Descripción
aicenter.sql_connection_str	Cadena de conexión JDBC de AI Center (consulte el formato JDBC más abajo)

Nota: comprueba que la cadena de conexión JDBC tiene el formato del siguiente ejemplo.

"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"
}

Cadena de conexión de ejemplo de 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
  }
}

Nota: la cadena de conexión SQL de Data Manager es opcional solamente si deseas sobrescribir la base de datos predeterminada con la tuya propia.

La escritura manual está siempre habilitada para la instalación en línea.

El valor predeterminado para max_cpu_per-pod es 2, pero puede ajustarlo según sus necesidades. Para obtener más información, consulta el archivo de configuración de Document Understanding.

Importante:

Asegúrese de que la cuenta SQL especificada en las cadenas de conexión tiene asignado el rol db_owner para todas las bases de datos de Automation Suite. Si las restricciones de seguridad no permiten el uso de db_owner, entonces la cuenta SQL debe tener los siguientes roles y permisos en todas las bases de datos:

• db_ddladmin
• db_datawriter
• db_datareader
• Permiso EXECUTE en el esquema dbo

Configuración específica de Orchestrator

Orchestrator puede guardar los registros del robot en un servidor Elasticsearch. Esta funcionalidad se puede configurar en la sección orchestrator.orchestrator_robot_logs_elastic. De no proporcionarse, los registros del robot se guardan en la base de datos de Orchestrator.

En la siguiente tabla se enumeran los campos de orchestrator.orchestrator_robot_logs_elastic:

Parámetro	Descripción
elastic_uri	La dirección de la instancia de Elasticsearch que debe utilizarse. Debe proporcionarse en forma de URI. Si se facilita, también se requieren el nombre de usuario y la contraseña.
elastic_auth_username	El nombre de usuario de Elasticsearch que se utiliza para la autenticación.
elastic_auth_password	La contraseña de Elasticsearch que se utiliza para la autenticación.

Ejemplo:

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

Configuración específica de Insights

Si se habilita Insights, los usuarios pueden incluir la configuración del servidor SMTP que se utilizará para enviar correos electrónicos programados o de alerta. Si no se proporciona, los correos electrónicos programados y los de alerta no funcionarán.

Detalles de los campos de insights.smtp_configuration:

Parámetro	Descripción
tls_version	Los valores válidos son TLSv1_2, TLSv1_1 y SSLv23. Omitir la clave si no utiliza TLS.
from_email	Dirección desde la que se enviarán los correos electrónicos de alerta o programados.
host	Nombre del host del servidor SMTP.
port	Puerto del servidor SMTP.
username	Nombre de usuario para la autenticación del servidor SMTP.
password	Contraseña para la autenticación del servidor SMTP.

Ejemplo:

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

Configuración de la supervisión

Para aprovisionar suficientes recursos para la supervisión (consulta Uso de la pila de supervisión), debes tener en cuenta el número de vCPU en el clúster y la cantidad de retención de métricas deseada.A continuación, se explica cómo establecer las siguientes configuraciones de recursos de supervisión.

En la siguiente tabla se describen los detalles de los campos de supervisión.

Parámetro	Descripción
prometheus_retention	Se indica en días. Se trata del número de días que se conservarán las métricas a efectos de visualización en Grafana y de consulta manual a través de la consola de Prometheus. El valor predeterminado es 7.
prometheus_storage_size	En GiB. Espacio de almacenamiento que se reservará por réplica de Prometheus. Una buena regla general es establecer este valor en: 0.65 * vCPU cores * (prometheus_retention / 7) Ejemplo: Si establece prometheus_retention en 14 días y su clúster tiene 80 núcleos repartidos en 5 máquinas, pasa a ser: 0.65 * 80 * (14 / 7) 52 * (2) 104 El valor predeterminado es 45 y no debe ser inferior. Si Prometheus empieza a quedarse sin espacio de almacenamiento, se activará una alerta con instrucciones específicas para solucionarlo. Consulta aquí.
prometheus_memory_limit	En MiB. Cantidad de memoria a la que limitar cada réplica de Prometheus. Una buena regla general es establecer este valor en: 100 * vCPU cores * (prometheus_retention / 7) Ejemplo: Si ha establecido prometheus_retention en 14 días y su clúster tiene 80 núcleos repartidos en 5 máquinas, pasa a ser: 100 * 80 * (14 / 7) 8000 * (2) 16000 El valor predeterminado para el modo de evaluación de nodo único es 3200 y para el modo de producción multinodo preparada para alta disponibilidad es 6000 y no debe establecerse un valor inferior. Si Prometheus empieza a quedarse sin memoria, se activará una alerta con instrucciones específicas para solucionarlo. Consulta aquí.

Ejemplo:

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

Opcional: configurar el servidor proxy

Nota:

Asegúrese de cumplir los requisitos del servidor proxy antes de configurarlo durante la instalación.

Para obtener más detalles, consulta el Paso 2: añadir la configuración del proxy a cada nodo.

Al ejecutar el asistente de instalación interactivo, es necesario salir de él y actualizar el cluster_config.json durante el paso de configuración avanzada.

Es necesario añadir lo siguiente al archivo de configuración utilizando vim o su editor favorito:

"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 obligatorios	Descripción
enabled	Utilice true o false para habilitar o deshabilitar los ajustes del proxy.
http_proxy	Se utiliza para redirigir las peticiones salientes HTTP del clúster. Debe ser el FQDN y el puerto del servidor proxy.
https_proxy	Se utiliza para redirigir las peticiones salientes HTTPS del clúster. Debe ser el FQDN y el puerto del servidor proxy.
no_proxy	Lista separada por comas de hosts, direcciones IP o rangos de IP en formato CIDR que no desea redirigir a través del servidor proxy. Debe ser un rango de subred privada, un host de servidor SQL, una dirección de servidor con nombre, una dirección de servidor de metadatos: *.<fqdn>,<fixed_rke_address>:9345,<fixed_rke2_address>:6443. fqdn: el FQDN del clúster definido en cluster_config.json fixed_rke_address: fixed_rke_address definido/a en cluster_config.json named server address: la dirección IP de /etc/resolv.conf private_subnet_ip: la VNet del clúster sql server host: host del servidor SQL metadata server address: la dirección IP 169.254.169.254 que utilizan los servicios en la nube, como Azure y AWS, para obtener metadatos de las máquinas.

Opcional: habilitación de la resistencia a fallos de zona en un clúster multinodo de producción preparada para alta disponibilidad

Para habilitar o deshabilitar la resistencia a los fallos de zona en un clúster multinodo, realice los siguientes pasos:

1. Asegúrese de que los nodos se repartan de forma uniforme en tres zonas de disponibilidad. Para un servidor vacío o una máquina virtual proporcionada por cualquier proveedor, excepto AWS, Azure o GCP, los metadatos de zona deben proporcionarse a través del archivo de configuración /etc/default/k8s-node-labels en cada máquina con el siguiente formato.

   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. Actualice el archivo cluster_config.json durante el paso de configuración avanzada.

Para actualizar cluster_config.json mediante el asistente de instalación interactivo, salga del paso de configuración avanzada y añada lo siguiente al archivo de configuración con ayuda de vim o su editor favorito:

"zone_resilience": true

Parámetros obligatorios	Descripción
zone_resilience	Utilice true o false para habilitar o deshabilitar la resistencia a los fallos de zona.

Opcional: pasar Resolv.conf personalizado

El clúster de Kubernetes que implementa Automation Suite utiliza los servidores de nombres configurados en /etc/resolv.conf. Kubernetes no funciona con solucionadores de DNS locales (127.0.0.1 o 127.0.0.0/8), por lo que, si tiene configurados dichos servidores de nombres en el archivo /etc/resolv.conf, debe proporcionar una referencia de archivo con las entradas correctas del servidor de nombres accesible desde cualquier lugar de la máquina virtual en el parámetro .infra.custom_dns_resolver en cluster_config.json.

Para obtener detalles sobre una limitación conocida, consulta la documentación de Kubernetes.

Parámetro opcional	Descripción
.infra.custom_dns_resolver	Ruta del archivo que contiene las entradas correctas del servidor de nombres al que se puede acceder desde cualquier parte de la máquina virtual. Estas entradas del servidor de nombres no deben ser de 127.0.0.0/8.