- Erste Schritte
- Anforderungen
- Best Practices
- Installation
- Wird aktualisiert
- Identity Server
- Fehlerbehebung bei Startfehlern
Installationsanleitung für den Orchestrator
Orchestrator-Skripte
Publish-Orchestrator.ps1
verwendet werden können.
Parameter |
Beschreibung |
---|---|
|
Obligatorisch. Gibt den Typ des Szenarios an, das Sie starten möchten. Die folgenden Optionen sind verfügbar:
|
|
Obligatorisch. Die ID des Azure-Dienstprinzipals. Bitte beachten Sie, dass dem verwendeten Dienstprinzipal die Rolle Mitwirkender für den App-Dienst im Abonnementbereich zugewiesen werden muss. |
|
Obligatorisch. Das Azure-Tokenkennwort für die Dienstprinzipal-ID. |
|
Obligatorisch. Die Azure-Abonnement-ID für den App Service, der Orchestrator hostet. |
|
Obligatorisch. Die Azure-Mandanten-ID. |
|
Obligatorisch. Der Name der Azure-Ressourcengruppe, die den Orchestrator-App-Dienst enthält. |
|
Obligatorisch. Der Name des Azure App Service für Orchestrator. |
|
Obligatorisch. Geben Sie den vollständigen Pfad zum Archiv
UiPath.Orchestrator.Web.zip an.
|
|
Optional. Geben Sie den vollständigen Pfad des Archivs
UiPathActivities.zip an, das ab v2018.4.4 standardmäßig in UiPathOrchestrator.zip enthalten ist. Auf diese Weise können Sie den lokalen Aktivitätsfeed in Azure zur Installationszeit installieren. Bitte beachten Sie, dass dieser Parameter nur mit dem Repository-Typ Legacy verwendet werden kann. Andernfalls muss er manuell eingerichtet werden.
|
|
Optional. Dieser Parameter aktiviert das Modul „Testautomatisierung“ für Testdatenwarteschlangen, Testausführung und Terminplanung. Sie können diese Funktion basierend auf einem der folgenden Szenarien aktivieren: Mit einer Orchestrator-Neuinstallation starten Konfigurieren Sie die folgenden Einstellungen für Ihren App-Dienst, bevor Sie das Skript
Publish-Orchestrator.ps1 mit dem Parameter -testAutomationFeatureEnabled ausführen:
Markieren Sie diese Einstellungen als
Deployment slot setting , insbesondere, wenn Sie Hotswap-Slots verwenden.
Aktivieren der Testautomatisierung nach der Orchestrator-Installation Wenn Sie Orchestrator bereits bereitgestellt haben, ohne das Modul „Testautomatisierung“ zu aktivieren, führen Sie das Skript
Publish-Orchestrator.ps1 mit den gleichen Parametern wie bei einem Upgrade aus, und fügen Sie den Parameter -testAutomationFeatureEnabled hinzu.
Upgrade von Orchestrator Wenn Sie Ihre Orchestrator-Instanz upgraden, fügen Sie den Parameter
-testAutomationFeatureEnabled zum Skript Publish-Orchestrator.ps1 hinzu, bevor Sie es ausführen.
Weitere Informationen zum Upgraden des Orchestrators finden Sie unter Publish-Orchestrator.ps1 – Aktualisierung. |
|
Optional. Mit diesem Parameter wird das Modul für die Aktualisierung des Servers aktiviert. Sie können diese Funktion in einem der folgenden Szenarien aktivieren: Starten Sie mit einer Neuinstallation des Orchestrators erneut Konfigurieren Sie die folgenden Einstellungen für Ihren App-Dienst, bevor Sie das Skript
Publish-Orchestrator.ps1 mit dem Parameter -updateServerFeatureEnabled ausführen:
Aktivieren Sie die „Aktualisierung des Servers“ nach der Orchestrator-Installation Wenn Sie den Orchestrator bereits bereitgestellt haben, ohne das Modul zur Aktualisierung des Servers zu aktivieren, führen Sie das Skript
Publish-Orchestrator.ps1 mit den gleichen Parametern wie bei einem Upgrade aus, und fügen Sie den Parameter -updateServerFeatureEnabled hinzu.
Upgrade von Orchestrator Wenn Sie Ihre Orchestrator-Instanz upgraden, fügen Sie den Parameter
-updateServerFeatureEnabled zum Skript Publish-Orchestrator.ps1 hinzu, bevor Sie es ausführen.
Weitere Informationen zum Upgraden des Orchestrators finden Sie unter Publish-Orchestrator.ps1 – Aktualisierung. |
|
Optional. Dies sollte nur verwendet werden, wenn Sie Elasticsearch für die Protokollierung verwenden möchten. Geben Sie die Elasticsearch-URL als Wert an, z. B.
"http://elasticserver:9200" . Wenn Ihre Orchestrator-Instanz eine Authentifizierung erfordert, geben Sie die Parameter ElasticSearchUsername , ElasticSearchPassword , elasticSearchDiagnosticsUsername und elasticSearchDiagnosticsPassword an.
|
|
Optional. Dieser Parameter ermöglicht Ihnen, Robot-Protokolle nur zu dem konfigurierten Elasticsearch-Server zu senden. Geben Sie die URL von Elasticsearch als Wert an wie zum Beispiel
"http://elasticserver:9200" . Bitte beachten Sie, dass dieser Wert nur in Verbindung mit dem Parameter -robotsElasticSearchUrl verwendet werden kann. Wenn Sie diesen Parameter nicht angeben, werden Robot-Protokolle sowohl zu der konfigurierten SQL-Datenbank als auch zu Elasticsearch gesendet.
|
|
Optional. Dieser Parameter ermöglicht Ihnen, den Benutzernamen für Ihre Elasticsearch-Instanz anzugeben, wenn deren Authentifizierung aktiviert ist. |
|
Optional. Dieser Parameter ermöglicht Ihnen, das Passwort für Ihre Elasticsearch-Instanz anzugeben, wenn deren Authentifizierung aktiviert ist. |
|
Optional. Dieser Parameter ermöglicht Ihnen, den Benutzernamen für Ihre Elasticsearch-Instanz anzugeben, wenn deren Authentifizierung aktiviert ist. Dieser Parameter ist zusammen mit
elasticSearchDiagnosticsPassword "Password" für interne Orchestrator-Protokolle erforderlich.
|
|
Optional. Dieser Parameter ermöglicht Ihnen, das Passwort für Ihre Elasticsearch-Instanz anzugeben, wenn deren Authentifizierung aktiviert ist. Dieser Parameter ist zusammen mit
elasticSearchDiagnosticsUsername "Username" für interne Orchestrator-Protokolle erforderlich.
|
|
Optional. Verwenden Sie Redis als eine Datenbank zum Verteilen von Meldungen von und zu all den Maschinen, die über Ihren Lastausgleich verbunden sind. Wenn
-redisConnectionString angegeben ist, wird die Option automatisch auf true festgelegt, andernfalls wird sie auf false festgelegt.
|
|
Optional. Kann nur verwendet werden, wenn
loadBalancerUseRedis auf true festgelegt ist. Eine Verbindungszeichenfolge, die Ihnen ermöglicht, Ihren Redis-Server einzurichten, der die URL des Servers, das Kennwort und den mit Redis verwendeten Port enthält. Überdies besteht die Möglichkeit, mit SSL verschlüsselte Verbindungen zwischen den Orchestrator-Knoten und dem Redis-Dienst zu aktivieren. Weitere Informationen finden Sie hier.
Beispiele:
|
|
Optional. Hilft Ihnen bei der Aktivierung des Azure SignalR Service und erleichtert die Herstellung einer direkten Kommunikation zwischen Ihrer Roboterflotte und dem SignalR Service – der Orchestrator vermittelt diese nicht mehr. Bitte beachten Sie, dass bei Aktivierung dieser Option Roboter mit einer niedrigeren Version als 2019.2 für die Kommunikation mit Orchestrator nur das Heartbeat-Protokoll verwenden, d. h. dass ein von Orchestrator gegebener Befehl nur alle 30 Sekunden von einem Roboter aufgenommen wird. Beispiel:
-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;" |
|
Optional. Definiert das Ziel, in dem Ausführungsmedien und Pakete gespeichert werden sollen. Es kann mit den folgenden Zielen ausgefüllt werden:
Wenn Sie den Parameter
UiPath.Orchestrator.dll.config Storage.Type im Abschnitt Konfiguration von Azure App Service überschrieben haben, müssen Sie diesen Wert beim Aktualisieren als Skriptparameter an Publish-Orchestrator.ps1 übergeben.
|
|
Optional. Gibt den tatsächlichen Speicherort an, an dem die Ausführungsmedien und -pakete abgelegt werden sollen. Besonderheiten:
Weitere Informationen zu diesen Bereitstellungstypen finden Sie hier. Wenn Sie den Parameter
UiPath.Orchestrator.dll.config Storage.Location im Abschnitt Konfiguration von Azure App Service überschrieben haben, müssen Sie diesen Wert beim Aktualisieren als Skriptparameter an Publish-Orchestrator.ps1 übergeben.
|
|
Optional. Kann nur in Upgrade-Szenarien verwendet werden. Wenn angegeben, stellt das Skript Orchestrator im angegebenen App-Service-Slot anstelle des Produktions-Slots bereit. Zusätzlich wird ein Swap-Slot mit dem Produktions-Slot ohne Ausfallzeit ausgeführt. Voraussetzungen:
|
|
Optional. Kann nur verwendet werden, wenn sich der Bereitstellungs-Slot des App Service für Orchestrator von dem durch Azure festgelegten Standard-Produktionsslot von App-Service unterscheidet. |
|
Optional. Schlüsselwertpaare von Anwendungseinstellungen, die nach der Bereitstellung per Push in den Abschnitt der Azure App-Dienstkonfiguration übertragen werden. Beachten Sie, dass dies nur für Einstellungen aus dem Abschnitt App-Einstellungen der Datei UiPath.Orchestrator.dll.config gilt. Sie können diesen Parameter verwenden, um bestimmte Einstellungen zu ändern, die nicht über das
Publish-Orchestrator.ps1 -Skript verfügbar gemacht werden. Für den Rest verwenden Sie bitte ihren dedizierten Parameter bei der Bereitstellung des Skripts.
Bitte beachten Sie, dass vorhandene Einstellungen mit neuen Einstellungen zusammengeführt werden. |
|
Optional. Wenn vorhanden, wird die Anwendung vor der Bereitstellung angehalten und nach Abschluss der Bereitstellung gestartet. |
|
Optional. Wenn vorhanden, wird die Bereitstellung ohne Benutzerbestätigung fortgesetzt. |
|
Optional. Ein String, der eine durch Kommas getrennte Liste von Bucket-Anbietern enthält, die Sie aktivieren möchten. Wenn nicht genauer angegeben, wird standardmäßig
Orchestrator,Amazon,Azure,Minio eingestellt. Sie haben auch die Möglichkeit, den FileSystem-Anbieter zu aktivieren, indem Sie ihn dieser Liste hinzufügen.
Achtung: Wenn Sie den FileSystem-Anbieter verwenden und auf 20.10.7 oder höher aktualisieren, müssen Sie einen Wert übergeben, der
FileSystem für diesen Parameter enthält. Andernfalls ist dieser Anbieter deaktiviert und Sie können diese Buckets nicht mehr verwenden.
|
|
Nur obligatorisch, wenn FileSystem als Bucket-Anbieter ausgewählt wird. Die Liste der Speicherorte, an denen Sie die Erstellung von Buckets für den FileSystem-Anbieter zulassen möchten. Wenn Sie den FileSystem-Anbieter aktivieren, müssen Sie für diesen Parameter auch einen Wert übergeben. Werte sind eine Liste von UNC-Pfaden, die durch einen senkrechten Strich
| getrennt sind (z. B. \\mysharedstorage\mybyckets\|\\myotherserver\myotherbuckets ).
|
-azureUSGovernmentLogin | Optional. Dieser Parameter wird nur für Bereitstellungen der US-Regierung verwendet. |
UiPath.Orchestrator.dll.config
-Parameterwerte werden beim Durchführen einer Aktualisierung automatisch migriert und beibehalten. Um sie zu ändern, geben Sie beim Aufrufen des Skripts Publish-Orchestrator.ps1
neue Werte an.
-NuGet.Packages.ApiKey
-NuGet.Activities.ApiKey
-NuGet.Packages.Path
-NuGet.Activities.Path
-machineKey/@decryption
-machineKey/@decryptionKey
-machineKey/@validationKey
-EncryptionKey
-NuGet.Repository.Type
-Storage.Type
-Storage.Location
-LoadBalancer.Redis.ConnectionString
-LoadBalancer.UseRedis
-Scalability.AzureSignalR.ConnectionString
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@uri
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@username
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@password
-nlog/rules/logger/@name=Robot.*/@writeTo
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@uri
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@username
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@password
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@index
-nlog/rules/logger/@name=*/@writeTo
-NuGet.Packages.ApiKey
-NuGet.Activities.ApiKey
-NuGet.Packages.Path
-NuGet.Activities.Path
-machineKey/@decryption
-machineKey/@decryptionKey
-machineKey/@validationKey
-EncryptionKey
-NuGet.Repository.Type
-Storage.Type
-Storage.Location
-LoadBalancer.Redis.ConnectionString
-LoadBalancer.UseRedis
-Scalability.AzureSignalR.ConnectionString
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@uri
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@username
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@password
-nlog/rules/logger/@name=Robot.*/@writeTo
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@uri
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@username
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@password
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@index
-nlog/rules/logger/@name=*/@writeTo
-unattended
und protokolliert ihre Schritte auf -verbose
-Ebene.
.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-verbose
.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-verbose
-unattended
und protokolliert ihre Schritte auf -verbose
-Ebene.
.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-redisConnectionString "docs123.redis.cache.windows.net:6380,passwprd=******,ssl=True" `
-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=*****;Version=1.0;" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-verbose
.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-redisConnectionString "docs123.redis.cache.windows.net:6380,passwprd=******,ssl=True" `
-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=*****;Version=1.0;" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-verbose
-unattended
und protokolliert ihre Schritte auf -verbose
-Ebene.
Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-verbose
Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-verbose
Webhooks.Enabled
und Telemetry.Enabled
in false
geändert wird. Die Prozedur erfolgt -unattended
und protokolliert ihre Schritte auf -verbose
-Ebene.
Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-appSettings @{"Webhooks.Enabled"="false"; "Telemetry.Enabled"="false"} `
-verbose
Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-appSettings @{"Webhooks.Enabled"="false"; "Telemetry.Enabled"="false"} `
-verbose