UiPath Documentation
automation-suite
2022.4
false
Guide d'installation d'Automation Suite
Important :
Veuillez noter que ce contenu a été localisé en partie à l’aide de la traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Manuel : Expérience d'installation avancée

Cette page explique comment utiliser le fichier de configuration cluster_config.json d'Automation Suite.

Le fichier cluster_config.json définit les paramètres et préférences appliqués aux produits UiPath déployés via Automation Suite. Vous devez mettre à jour ce fichier si vous souhaitez modifier les valeurs par défaut et utiliser une configuration avancée pour votre cluster.

Pour modifier cluster_config.json, vous pouvez utiliser :

  • un éditeur de texte Linux, tel que vi ou GNU nano, directement sur la machine Linux via SSH (par exemple, commande : vi cluster_config.json) ;
  • votre éditeur de texte préféré, puis copier-coller le fichier sur la machine.

Le fichier cluster_config.json vous permet de configurer les produits UiPath que vous souhaitez déployer. Il existe deux types de services UiPath :

  • mandatory products: these are installed by default and do not have the enabled flag available on them;
  • optional products: these are not required to complete the install. However, be aware that products may have dependencies. Please see Product dependencies for more details on this.

Pour activer ou désactiver un service via le fichier cluster_config.json, utilisez true ou false pour l'indicateur enabled.

Exemple 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
  },
  "dataservice": {
    "enabled": true
  }
}
{
  "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
  },
  "dataservice": {
    "enabled": true
  }
}

Configuration générale​

Paramètres obligatoires Description

fqdn

Le nom de domaine de l'équilibreur de charge (mode de production multi-nœuds compatible haute disponibilité) ou de la machine (mode d'évaluation à nœud unique).

fixed_rke_address

Adresse fixe utilisée pour équilibrer la charge de l'enregistrement des nœuds et des requêtes de l'API kube. Il doit s'agir du nom de domaine complet si l'équilibreur de charge est configuré comme recommandé. Sinon, il doit s'agir du nom de domaine complet du 1er nœud de serveur. Référez-vous à Configurer l'équilibreur de charge.

Peut être l'IP/le FQDN du premier serveur rke2 de votre configuration.

multinode

Défini sur true lors du choix d'un profil de production multi-nœuds compatible haute disponibilité. La valeur de cet indicateur est définie automatiquement par l'assistant d'installation interactif. Il est utilisé à des fins internes uniquement et ne doit pas être modifié manuellement.

admin_username

Le nom d'utilisateur que vous souhaitez définir comme administrateur (par exemple : admin) pour l'organisation hôte.

admin_password

Mot de passe de l'administrateur hôte à définir.

rke_token

Utilisez un GUID nouvellement généré ici. Il s'agit d'une clé secrète pré-partagée, spécifique au cluster. Elle est nécessaire pour tous les nœuds rejoignant le cluster.

profile

Définit le profil de l'installation. Les profils disponibles sont :

  • default : profil d'évaluation à nœud unique.
  • ha : profil de production compatible haute disponibilité multi-nœuds.

La valeur de cet indicateur est définie automatiquement par l'assistant d'installation interactif. Elle est utilisée à des fins internes uniquement et ne doit pas être modifiée manuellement.

infra.docker_registry.username

Le nom d'utilisateur que vous souhaitez définir pour l'installation du registre docker.

infra.docker_registry.password

Le mot de passe que vous souhaitez définir pour l'installation du registre docker.

Paramètres facultatifsDescription
telemetry_optouttrue ou false : utilisé pour refuser le renvoi de la télémétrie à UiPath®. Il est défini sur false par défaut.

Si vous souhaitez le désactiver, définissez-le sur true.

Configuration du certificat​

Veuillez vous référer aux documents préalables pour obtenir le certificat :

Si aucun certificat n'est fourni au moment de l'installation, le programme d'installation crée un certificat auto-émis et le configure dans le cluster. La validité du certificat est de 90 jours.

Remarque :

Assurez-vous de spécifier le chemin absolu pour les fichiers de certificat. Exécutez pwd pour obtenir le chemin du répertoire où les fichiers sont placés et ajoutez le nom du fichier de certificat dans cluster_config.json.

Dans les installations en mode de production multi-nœuds compatible haute disponibilité, un certificat est requis uniquement sur le premier nœud.

ParamètreDescription
server_certificate.ca_cert_fileChemin d'accès absolu au certificat de l'Autorité de certification (CA). Cette autorité de certification est l'autorité qui signe le certificat TLS. Un bundle CA ne doit contenir que les certificats de chaîne utilisés pour signer le certificat TLS. La limite de la chaîne est de neuf certificats.

Si vous utilisez un certificat auto-signé, vous devez spécifier le chemin d'accès au rootCA.crt que vous avez créé précédemment. Laissez vide si vous souhaitez que le programme d'installation génère.
server_certificate.tls_cert_fileChemin absolu vers le certificat TLS (server.crt pour le certificat auto-signé créé lors des étapes précédentes). Laissez vide si vous souhaitez que le programme d'installation le génère.
server_certificate.tls_key_fileChemin d'accès absolu à la clé de certificat (server.key pour le certificat auto-signé créé lors des étapes précédentes). Laissez vide si vous souhaitez que le programme d'installation le génère.
identity_certificate.token_signing_cert_fileChemin absolu vers le certificat d'Identity Service utilisé pour signer les jetons (identity.pfx pour les jetons auto-signés créés lors des étapes précédentes). Laissez ce champ vide si vous souhaitez que le programme d'installation génère un certificat d'identité à l'aide du certificat du serveur.
identity_certificate.token_signing_cert_passMot de passe en texte brut défini lors de l'exportation.
additional_ca_certsChemin d'accès absolu au fichier contenant les certificats CA supplémentaires que tous les produits exécutés dans le cadre d'Automation Suite doivent approuver. Tous les certificats du fichier doivent être dans un format PEM valide.

Par exemple, vous devez fournir le fichier contenant le certificat de l'autorité de certification du serveur SQL si le certificat n'est pas émis par une autorité de certification publique.

Configuration de la base de données​

Workflow de création de base de données​

Le programme d'installation interactif crée automatiquement des bases de données à l'aide du workflow suivant :

  1. Le script d'installation interactif vérifie la valeur du paramètre sql.create_db dans le fichier cluster_config.json .
    • Si le paramètre sql.create_db est défini sur true, le programme d'installation génère automatiquement toutes les bases de données en votre nom. Dans ce cas, le programme d'installation utilise les noms de base de données par défaut et les modèles par défaut, et ignore tous les noms de base de données personnalisés que vous avez fournis.

    • Si sql.create_db est défini sur false, vous devez apporter vos propres bases de données. Dans ce cas, vous devez configurer manuellement vos bases de données. Notez que vous pouvez utiliser des noms de base de données personnalisés, à condition de suivre les conventions d'affectation de nom fournies. Cette étape est essentielle car nous utilisons le nom de la base de données conjointement avec le modèle de connexion pour former la chaîne de connexion de la base de données. Si vous ne suivez pas la convention d’affectation de noms recommandée, vous devez fournir vous-même les chaînes de connexion SQL.

      For details, see Bring your own databases.

  2. Le programme d'installation interactif génère les chaînes de connexion comme suit :
    • Si vous n’avez pas défini de chaîne de connexion pour votre service, le programme d’installation utilise le modèle de connexion pour générer toutes les chaînes de connexion de la base de données.
    • Si vous avez défini une chaîne de connexion pour votre service, le programme d’installation utilise la chaîne de connexion fournie pour votre base de données.

Créer automatiquement les bases de données nécessaires​

Si vous souhaitez que le programme d'installation crée les bases de données, veuillez remplir les champs suivants :

ParamètreDescription
sql.create_dbDéfinissez sur true pour permettre au programme d'installation de créer les bases de données. Notez que le programme d'installation utilise les noms de base de données par défaut et les modèles par défaut, et ignore tous les noms de base de données personnalisés que vous avez fournis.
sql.server_urlNom de domaine complet du serveur SQL, où vous souhaitez que le programme d’installation configure la base de données.
sql.portNuméro de port sur lequel une instance de base de données doit être hébergée dans le serveur SQL.
sql.usernameNom d'utilisateur / ID d'utilisateur pour se connecter au serveur SQL.
sql.passwordMot de passe du nom d'utilisateur fourni précédemment pour se connecter au serveur SQL.
Remarque :

Assurez-vous que l'utilisateur dispose du rôle dbcreator. Cela leur accorde l'autorisation de créer la base de données dans SQL Server. Sinon, l'installation échoue.

La connexion ODBC ne prend pas en charge les noms d'utilisateur contenant des caractères spéciaux. Pour les noms d'utilisateur de base de données pour AI Center et Document Understanding, utilisez uniquement des lettres majuscules et minuscules.

Fournissez votre propre base de données​

Si vous choisissez d’apporter vos propres bases de données dans le cadre d’une nouvelle installation Automation Suite, nous vous recommandons fortement de créer de nouvelles bases de données plutôt que d’utiliser les bases existantes. Cette précaution est nécessaire afin d’éviter tout conflit avec le fonctionnement d’Automation Suite qui pourrait être provoqué par la présence de métadonnées relatives à d’anciennes bases de données.

Si vous apportez votre propre base de données, vous devez fournir les chaînes de connexion SQL pour chaque base de données. Automation Suite prend en charge les formats de chaîne de connexion SQL suivants :

ParamètreDescriptionProduits
sql_connection_string_templateChaîne de connexion ADO.NET complète où le nom du catalogue est défini sur DB_NAME_PLACEHOLDER. Le programme d'installation remplacera cet espace réservé par les noms de base de données par défaut pour les services de la suite installée.Platform, Orchestrator, Test Manager, Automation Hub, Automation Ops, Insights, Task Mining, Data Service, Document Understanding
sql_connection_string_template_jdbcChaîne de connexion JDBC complète où le nom de la base de données est défini sur DB_NAME_PLACEHOLDER. Le programme d'installation remplacera cet espace réservé par les noms de base de données par défaut pour les services de la suite installée.AI Center
sql_connection_string_template_odbcChaîne de connexion ODBC complète où le nom de la base de données est défini sur DB_NAME_PLACEHOLDER. Le programme d'installation remplacera cet espace réservé par les noms de base de données par défaut pour les services de la suite installée.Document Understanding
Important :

Assurez-vous que le compte SQL spécifié dans les chaînes de connexion dispose des rôles db_securityadmin et db_owner pour toutes les bases de données Automation Suite. Si les restrictions de sécurité n'autorisent pas l'utilisation de db_owner, le compte SQL doit avoir les rôles et autorisations suivants sur toutes les bases de données :

  • db_ddladmin
  • db_datawriter
  • db_datareader
  • Autorisation EXECUTE sur le schéma dbo
Important :

Si vous définissez manuellement les chaînes de connexion dans le fichier de configuration, vous pouvez échapper les mots de passe SQL, JDBC ou ODBC comme suit :

  • pour SQL : ajoutez ' au début et à la fin du mot de passe, et doublez tout autre ' .
  • pour JDBC/ODBC : ajoutez { au début du mot de passe et } à la fin, et doublez tout autre } .
Remarque :

Par défaut, TrustServerCertificate est défini sur False, et vous devez fournir un certificat CA supplémentaire pour SQL Server. Ceci est requis si le certificat SQL Server est auto-signé ou signé par une autorité de certification interne.

See Certificate configuration for more details.

exemple sql_connection_string_template

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

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

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

Noms de bases de données par défaut et facultatifs pour les services 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",
  "dataservice": "AutomationSuite_DataService",
  "aicenter": "AutomationSuite_AICenter",
  "documentunderstanding": "AutomationSuite_DU_Datamanager",
}
{
  "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",
  "dataservice": "AutomationSuite_DataService",
  "aicenter": "AutomationSuite_AICenter",
  "documentunderstanding": "AutomationSuite_DU_Datamanager",
}
Remarque :

Si vous souhaitez remplacer la chaîne de connexion pour l'un des services ci-dessus, définissez le sql_connection_str pour ce service spécifique.

Vous devez toujours créer manuellement ces bases de données avant d'exécuter le programme d'installation.

Remplacer la chaîne de connexion par défaut pour Orchestrator et la plateforme

{
  "orchestrator": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomOrchDB;Persist Security Info=False;User Id=testadmin@sfdev1804627-c83f074b-sql.database.windows.net;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=testadmin@sfdev1804627-c83f074b-sql.database.windows.net;Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}
{
  "orchestrator": {
    "sql_connection_str": "Server=tcp:sfdev1804627-c83f074b-sql.database.windows.net,1433;Initial Catalog=CustomOrchDB;Persist Security Info=False;User Id=testadmin@sfdev1804627-c83f074b-sql.database.windows.net;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=testadmin@sfdev1804627-c83f074b-sql.database.windows.net;Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;"
  }
}

Pour remplacer les chaînes de connexion à la base de données pour d'autres produits, définissez le sql_connection_str dans les blocs de produits correspondants. La chaîne de connexion doit avoir un format pris en charge par le produit respectif.

Exemple de définition de la chaîne de connexion à la base de données pour AI Center

ParamètreDescription
aicenter.sql_connection_strChaîne de connexion AICenter JDBC (voir ci-dessous pour le format JDBC)
Remarque :

Veuillez vérifier que la chaîne de connexion JDBC a le même format que dans l'exemple ci-dessous.

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

Exemple de chaîne de connexion 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=testadmin@example.com;Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
  "cjkOcr":
  {
    "enabled": true
  }
}
"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=testadmin@example.com;Password=***;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;",
  "cjkOcr":
  {
    "enabled": true
  }
}
Remarque :

La chaîne de connexion SQL du Data Manager est facultative uniquement si vous souhaitez remplacer la valeur par défaut par la vôtre.

L'écriture manuscrite est toujours activée pour l'installation en ligne.

The default value for max_cpu_per-pod is 2, but you can adjust it according to your needs. For more information, check the Document Understanding configuration file.

Configuration spécifique à Orchestrator​

Orchestrator peut enregistrer les journaux des évènements du Robot sur un serveur Elasticsearch. Vous pouvez configurer cette fonctionnalité dans la section orchestrator.orchestrator_robot_logs_elastic. Si ce paramètre n'est pas configuré, les journaux des évènements du Robot seront enregistrés dans la base de données d'Orchestrator.

Le tableau suivant répertorie les champs orchestrator.orchestrator_robot_logs_elastic :

ParamètreDescription
elastic_uriL'adresse de l'instance Elasticsearch devant être utilisée. Elle doit être fournie sous la forme d'un URI. Si celle-ci est fournie, alors le nom d'utilisateur et le mot de passe sont également requis.
elastic_auth_usernameLe nom d'utilisateur Elasticsearch, utilisé pour l'authentification.
elastic_auth_passwordLe mot de passe Elasticsearch, utilisé pour l'authentification.

Exemple :

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

Configuration spécifique à Insights​

Si vous activez Insights, les utilisateurs peuvent inclure la configuration du serveur SMTP qui sera utilisée pour envoyer des e-mails/e-mails d'alerte programmés. S'ils ne sont pas fournis, les e-mails programmés et les e-mails d'alerte ne fonctionneront pas.

Les détails des champs insights.smtp_configuration :

ParamètreDescription
tls_versionLes valeurs valides sont TLSv1_2, TLSv1_1, SSLv23. Omettez complètement la clé si vous n'utilisez pas TLS.
from_emailAdresse à partir de laquelle les e-mails d'alerte/programmés seront envoyés.
hostNom d'hôte du serveur SMTP.
portLe port du serveur SMTP.
usernameNom d’utilisateur pour l’authentification du serveur SMTP.
passwordMot de passe pour l’authentification du serveur SMTP.

Exemple :

"insights": {
    "enabled": true,
    "smtp_configuration": {
      "tls_version": "TLSv1_2",
      "from_email": "test@test.com",
      "host": "smtp.sendgrid.com",
      "port": 587,
      "username": "login",
      "password": "password123"
    }
  }
"insights": {
    "enabled": true,
    "smtp_configuration": {
      "tls_version": "TLSv1_2",
      "from_email": "test@test.com",
      "host": "smtp.sendgrid.com",
      "port": 587,
      "username": "login",
      "password": "password123"
    }
  }

Configuration de la surveillance​

To provision enough resources for monitoring (see Using the monitoring stack), you should consider the number of vCPUs in the cluster and the amount of desired metric retention. See below for how to set the following monitoring resource configurations.

Le tableau suivant décrit les détails du champ de surveillance :

ParamètreDescription
prometheus_retentionEn jours.

Il s'agit du nombre de jours pendant lesquels les métriques seront conservées à des fins de visualisation dans Grafana et de requête manuelle via la console Prometheus.

La valeur par défaut est 7.
prometheus_storage_sizeEn Gio.

Quantité d'espace de stockage à réserver par réplica Prometheus.


Une bonne règle de base consiste à définir cette valeur sur :

0.65 * vCPU cores * (prometheus_retention / 7)

Exemple :

Si vous définissez prometheus_retention sur 14 jours et que votre cluster comporte 80 cœurs répartis sur 5 machines, cela devient :

0.65 * 80 * (14 / 7)

52 * (2)

104

La valeur par défaut est 45 et ne doit pas être inférieure.

If Prometheus starts to run out of storage space, an alert will be triggered with specific remediation instructions. See here.
prometheus_memory_limitEn Mio.

Quantité de mémoire à laquelle limiter chaque réplica Prometheus.

Une bonne règle de base consiste à définir cette valeur sur :

100 * vCPU cores * (prometheus_retention / 7)

Exemple :

Si vous avez défini prometheus_retention sur 14 jours et que votre cluster comporte 80 cœurs répartis sur 5 machines, cela devient :

100 * 80 * (14 / 7)

8000 * (2)

16000

La valeur par défaut est 3200 pour le mode d'évaluation à nœud unique et 6000 pour le mode de production multi-nœuds compatible haute disponibilité ; elle ne doit jamais être inférieure.

If Prometheus starts to run out of memory, an alert will be triggered with specific remediation instructions. See here.

Exemple :

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

Facultatif : configuration du serveur proxy​

Remarque :

Assurez-vous que vous répondez aux exigences du serveur proxy avant de configurer le serveur proxy lors de l'installation.

Lors de l'exécution de l'assistant d'installation interactif, vous devez le quitter et mettre à jour le cluster_config.json lors de l'étape de configuration avancée.

Vous devez ajouter les éléments suivants au fichier de configuration à l'aide de vim ou de votre éditeur préféré dans le fichier de configuration :

"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>,<k8s address range>,<private_subnet_ip>,<sql server host>,<Comma separated list of ips that should not go through proxy server>"
}
"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>,<k8s address range>,<private_subnet_ip>,<sql server host>,<Comma separated list of ips that should not go through proxy server>"
}
Paramètres obligatoires Description

enabled

Utilisez true ou false pour activer ou désactiver les paramètres de proxy.

http_proxy

Utilisé pour acheminer les requêtes sortantes HTTP à partir du cluster. Il doit s'agir du nom de domaine complet et du port du serveur proxy.

https_proxy

Utilisé pour acheminer les requêtes sortantes HTTPS à partir du cluster. Il doit s'agir du nom de domaine complet et du port du serveur proxy.

no_proxy

Liste d'hôtes, d'adresses IP ou de plages d'adresses IP au format CIDR séparée par des virgules et que vous ne souhaitez pas acheminer via le serveur proxy. Il doit s'agir d'une plage de sous-réseaux privés, d'un hôte de serveur sql, d'une adresse de serveur nommée, d'une adresse de serveur de métadonnées : *.<fqdn>,<fixed_rke_address>:9345,<fixed_rke2_address>:6443.

  • fqdn - le nom de domaine complet du cluster défini dans cluster_config.json
  • fixed_rke_address - le fixed_rke_address défini dans cluster_config.json
  • named server address - l'adresse IP de /etc/resolv.conf
  • private_subnet_ip : le réseau virtuel du cluster
  • sql server host - l'hôte du serveur sql
  • metadata server address - l'adresse IP 169.254.169.254 utilisée pour récupérer les métadonnées de la machine par les services cloud tels qu'Azure et AWS
  • k8s address range - les plages d'adresses IP utilisées par les nœuds Kubernetes, c'est-à-dire 10.0.0.0/8

Facultatif : Activation de la résilience aux échecs locaux dans un cluster en mode production multi-nœuds compatible haute disponibilité​

Pour activer la résilience aux défaillances zonales dans un cluster multi-nœuds, procédez comme suit :

  1. Assurez-vous que les nœuds sont répartis uniformément sur trois zones de disponibilité. Pour un serveur bare metal ou une machine virtuelle fournis par n'importe quel fournisseur à l'exception d'AWS, Azure ou GCP, les métadonnées de zone doivent être fournies via le fichier de configuration à /etc/default/k8s-node-labels sur chaque machine au format suivant.

    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
    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. Mettez à jour le fichier cluster_config.json lors de l'étape de configuration avancée.

Pour mettre à jour cluster_config.json à l'aide de l'assistant d'installation interactif, quittez l'étape de configuration avancée et ajoutez ce qui suit au fichier de configuration à l'aide de vim ou de votre éditeur préféré :

"zone_resilience": true
"zone_resilience": true
Paramètres obligatoiresDescription
zone_resilienceUtilisez true ou false pour activer ou désactiver la résilience aux défaillances de zone.
Important :

Si vous activez la résilience à l'échec zonal, la transmission des arguments --zone et --region est :

  • recommandée si vous enregistrez vos machines sur AWS, Azure ou GCP et que les services de métadonnées sont activés lorsque le programme d'installation renseigne les détails de la zone et de la région.
  • obligatoire si vous enregistrez vos machines sur AWS, Azure ou GCP et que les services de métadonnées sont désactivés, ou si vous optez pour un autre fournisseur de cloud.

Facultatif : Transmettre le fichier personnalisé resolv.conf​

Le cluster Kubernetes déployé par Automation Suite utilise les serveurs de noms configurés dans /etc/resolv.conf. Kubernetes ne fonctionne pas avec les résolveurs DNS locaux (127.0.0.1 ou 127.0.0.0/8) : si vous avez des serveurs de noms de ce type configurés dans le fichier /etc/resolv.conf, vous devez transmettre une référence de fichier avec les bonnes entrées de serveur de noms accessibles de n'importe où sur la VM dans le paramètre .infra.custom_dns_resolver dans cluster_config.json.

Pour plus de détails sur une limitation connue, consultez la documentation de Kubernetes.

Paramètres facultatifsDescription
.infra.custom_dns_resolverChemin d'accès au fichier avec les entrées correctes du serveur de noms accessibles depuis n'importe où sur la machine virtuelle. Ces entrées du serveur de noms ne doivent pas provenir de 127.0.0.0/8.

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance(opens in new window)

Vous souhaitez apprendre ? UiPath Academy(opens in new window)

Vous avez des questions ? UiPath Forum(opens in new window)

Rester à jour