Identity Server-Skripte

Führen Sie das Skript Publish-IdentityServer.ps1 für die erste Bereitstellung oder Aktualisierungen des Identity Server aus

Veröffentlichen auf Identity Server

In der folgenden Tabelle sind alle Parameter beschrieben, die mit dem Skript Publish-IdentityServer.ps1 verwendet werden können.

Parameter	Beschreibung
-action	Mandatory. Indicates the type of scenario you want to start. Die folgenden Optionen sind verfügbar: Deploy – gibt an, dass es sich um eine Neuinstallation handelt. Update – Gibt an, dass Sie Ihre Identity Server-Instanz aktualisieren.
-azureAccountApplicationId	Mandatory. The Azure service principal ID. Please note that the used service principal needs to be assigned the Contributor role to the app service at the subscription scope.
-azureAccountPassword	Obligatorisch. Das Azure-Tokenkennwort für die Dienstprinzipal-ID.
-azureSubscriptionId	Obligatorisch. Die Azure-Abonnement-ID für den App Service, der Orchestrator hostet.
-azureAccountTenantId	Obligatorisch. Die Azure-Mandanten-ID.
-orchestratorUrl	Obligatorisch. Die URL der Orchestrator-Instanz.
-identityServerUrl	Obligatorisch. Die URL des Identity Servers. Important: The URL must contain the Identity Server address + the suffix /identity in lowercase. Beispiel: https://[identity_server]/identity.
-resourceCatalogUrl	Obligatorisch. Die URL des Ressourcenkatalogs.
-orchDetails	Dieser Parameter ist eine Hashtabelle, die die folgenden Werte enthält: resourceGroupName – Obligatorisch. Der Name der Azure-Ressourcengruppe, die den App-Dienst des Orchestrators enthält. appServiceName – Obligatorisch. Der Name des Azure App-Diensts des Orchestrators. targetSlot – Obligatorisch. Der von Azure festgelegte Ziel-App-Dienst-Slot.
-identityServerDetails	Dieser Parameter ist eine Hashtabelle, die die folgenden Werte enthält: resourceGroupName – Obligatorisch. Der Name der Azure-Ressourcengruppe, die den Identity Server App-Dienst enthält. appServiceName – Obligatorisch. Der Name des Azure App-Diensts des Identity Servers. targetSlot – Obligatorisch. Der von Azure festgelegte Ziel-App-Dienst-Slot.
-package	Obligatorisch. Geben Sie den vollständigen Pfad oder relativen Pfad des Archivs UiPath.IdentityServer.Web.zip an.
-cliPackage	Obligatorisch. Geben Sie den vollständigen Pfad oder relativen Pfad des Archivs UiPath.IdentityServer.Migrator.Cli.zip an.
-productionSlotName	Optional. Kann nur verwendet werden, wenn sich der Bereitstellungs-Slot des App Service für Identity Server von dem durch Azure festgelegten Standard-Produktionsslot von App-Service unterscheidet.
-stopApplicationBeforePublish	Optional. Wenn vorhanden, wird die Anwendung vor der Bereitstellung angehalten und nach Abschluss der Bereitstellung gestartet.
-unattended	Optional. Wenn vorhanden, wird die Bereitstellung ohne Benutzerbestätigung fortgesetzt.
-tmpDirectory	Optional: Ermöglicht das Festlegen eines Verzeichnisses, in dem benötigte Dateien heruntergeladen und entpackt werden.
-noAzureAuthentication	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the UseServicePrincipal parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.

Das Skript Publish-IdentityServer.ps1 wird für die anfängliche Bereitstellung oder Aktualisierung von Identity Server verwendet. Das Skript geht davon aus, dass die Web-App bereits die Datenbankverbindungszeichenfolge DefaultConnection konfiguriert hat.

.\Publish-IdentityServer.ps1 `
    -action Deploy `
    -orchestratorUrl "<orchestrator_address>" `
    -identityServerUrl "https://<identity_server_url>/identity" ` // must be in lowercase
    -resourceCatalogUrl "<resource_catalog_address>" `
    -orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>";  targetSlot = "Production" } `
    -identityServerDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" } `
    -azureSubscriptionId "<subscription_id>" `
    -azureAccountTenantId "<azure_tenant_id>" `
    -azureAccountApplicationId "<azure_application_id>" `
    -azureAccountPassword "<azure_account_password>" `
    -package "UiPath.IdentityServer.Web.zip" `
    -cliPackage "UiPath.IdentityServer.Migrator.Cli.zip" `
    -stopApplicationBeforePublish `
    -unattended

Wichtig:

Stellen Sie nach dem Ausführen des obigen Skripts sicher, dass Sie die unten aufgeführten zusätzlichen Schritte ausführen, um eine erfolgreiche Erstbereitstellung zu ermöglichen.

Führen Sie nach der Veröffentlichung von Identity Server die folgenden Schritte aus:

1. Wechseln Sie zum Azure-Portal.
2. Wählen Sie Ihren Identity Server-App-Service aus.
3. Wechseln Sie im Menü Zertifikate zu Eigene Zertifikate einbringen.
4. Laden Sie die .pfx-Zertifikatdatei eines privaten Schlüssels mit einem gültigen Kennwort hoch.

Hinweis:

Dieses Zertifikat wird zum Signieren der Zugriffstoken und der ID-Token verwendet.

5. Fügen Sie unter dem Konfigurationsmenü die folgenden Anwendungseinstellungen genau wie in der Spalte Anwendungseinstellungen geschrieben hinzu:

   Anwendungseinstellung	Wert	Beschreibung
   AppSettings__IdentityServerAddress	https://[identity_server]/identity	Die öffentliche URL von Identity Server. Wichtig: Die URL muss die Adresse von Identity Server sowie das Suffix enthalten /identity in Kleinbuchstaben.
   AppSettings__SigningCredentialSettings__StoreLocation__Location	CurrentUser	Dies muss auf CurrentUser verweisen.
   AppSettings__SigningCredentialSettings__StoreLocation__Name	XXXXXXXXXXXXXXXXXXXXXXXXXXXXX	Der Fingerabdruckwert Ihres Zertifikats, das Sie zuvor hochgeladen haben.
   AppSettings__SigningCredentialSettings__StoreLocation__NameType	Thumbprint	Enter Thumbprint als Typ des vorherigen Felds.
   AppSettings__LoadBalancerSettings__RedisConnectionString	XXXXXXXXXXXX:XXXX,password=XXXXXX	The connection string needed to set up your Redis server, which contains the URL of the server, the password, and the port. You can also enable SSL encrypted connections between the Orchestrator nodes and the Redis service.
   AppSettings__LoadBalancerSettings__SlidingExpirationTimeInSeconds	Anzahl der Sekunden	The sliding expiration time of an item inside the cache. This expiration time applies to both Redis Cache and InMemory Cache.
   AppSettings__RedisSettings__UseRedisStoreCache	true / false	Setzen Sie den Wert auf true to enable Redis caching of OAuth client data. This helps prevent performance issues when using Interactive Sign In to connect a large number of robots in a short amount of time. This cache uses the same Redis connection string specified in the AppSettings__LoadBalancerSettings Hinweis: Dies wird nicht empfohlen, wenn Sie die Funktion Externe Anwendungen verwenden, da diese Einstellung Clients zwischenspeichert und Aktualisierungen für externe Anwendungen nicht widergespiegelt werden.
   AppSettings__RedisSettings__UseRedisStoreClientCache	true / false	Set its value to true to enable Redis caching for first-party clients (UiPath applications) or third-party clients (external applications). If you have a large-scale deployment, it is recommended to enable this flag.
   App__Saml2ValidCertificateOnly	true / false	Für Orchestrator-Bereitstellungen über eine Azure Web-App muss dieser Parameter auf festgelegt werden false . This is because SAML2 requires certificates to be added to its trust store, but Azure web apps do not allow this action. Setting the value to false bedeutet, dass die Zertifikataktivierung umgangen wird.
   WEBSITE_LOAD_CERTIFICATES	XXXXXXXXXXXXXXXXXXXXXXXXXXXXX	Der Fingerabdruckwert Ihres Zertifikats, das Sie zuvor hochgeladen haben.
   WEBSITE_LOAD_USER_PROFILE	1	Das Benutzerprofil.
   -azureUSGovernmentLogin	Optional. Dieser Parameter wird nur für Bereitstellungen der US-Regierung verwendet.

   6.

   Speichern Sie die Änderungen.

   Weitere Informationen finden Sie in der Microsoft Azure-Dokumentation.

   Ersetzen des Zertifikats mit privatem Schlüssel

   Wenn Sie ein Zertifikat mit privatem Schlüssel durch ein neues ersetzen, stellen Sie sicher, dass Sie die folgenden Schritte ausführen:

   1. Ersetzen Sie die Werte der Parameter AppSettings__SigningCredentialSettings__StoreLocation__Name und WEBSITE_LOAD_CERTIFICATES durch den Fingerabdruck des neuen Zertifikats.
   2. Starten Sie den Identitäts-App-Dienst neu.
   3. Starten Sie den Orchestrator-App-Dienst neu.

   Migrieren zu Identity Server

   In der folgenden Tabelle sind alle Parameter beschrieben, die mit MigrateTo-IdentityServer.ps1 verwendet werden können.

   Parameter	Beschreibung
   -cliPackage	Mandatory . Geben Sie den vollständigen Pfad oder relativen Pfad des Archivs UiPath.IdentityServer.Migrator.Cli.zip an.
   -azureDetails	Dieser Parameter ist eine Hashtabelle, die die folgenden Werte enthält: azureAccountApplicationId - Mandatory. The Azure service principal ID. Please note that the used service principal needs to be assigned the Contributor role to the app service at the subscription scope. azureSubscriptionId – Obligatorisch. Die Azure-Abonnement-ID für den App-Dienst, der den Orchestrator hostet. azureAccountTenantId – Obligatorisch. Die Azure-Mandanten-ID. azureAccountPassword – Obligatorisch. Das Azure-Tokenkennwort für die Dienstprinzipal-ID.
   -orchDetails	Dieser Parameter ist eine Hashtabelle, die die folgenden Werte enthält: resourceGroupName – Obligatorisch. Der Name der Azure-Ressourcengruppe, die den App-Dienst des Orchestrators enthält. appServiceName – Obligatorisch. Der Name des Azure App-Diensts des Orchestrators. targetSlot – Obligatorisch. Der von Azure festgelegte Ziel-App-Dienst-Slot.
   -identityServerDetails	Dieser Parameter ist eine Hashtabelle, die die folgenden Werte enthält: resourceGroupName – Obligatorisch. Der Name der Azure-Ressourcengruppe, die den Identity Server App-Dienst enthält. appServiceName – Obligatorisch. Der Name des Azure App-Diensts des Identity Servers. targetSlot – Obligatorisch. Der von Azure festgelegte Ziel-App-Dienst-Slot.
   -identityServerUrl	Obligatorisch. Die öffentliche Adresse von Identity Server. Important: The URL must contain the address of Identity Server + the suffix /identity in lowercase. Beispiel: https://[identity_server]/identity.
   -orchestratorUrl	Obligatorisch. Die öffentliche Adresse von Orchestrator.
   -tmpDirectory	Optional: Ermöglicht das Festlegen eines Verzeichnisses, in dem benötigte Dateien heruntergeladen und entpackt werden.
   -hostAdminPassword	Mandatory only for fresh deployments, when-action is set to Deploy . Specify a custom password for the host administrator. Please note that passwords have to be least 8 characters long, and must have at least one lowercase character and at least one digit.
   -isHostPassOneTime	Optional. Enables you to enforce a password reset on the first login for the host administrator. If this parameter is omitted, the host admin password is not a one-time password.
   -defaultTenantAdminPassword	Mandatory only for fresh deployments, when-action is set to Deploy . Specify a custom password for the default tenant administrator. Please note that passwords have to be least 8 characters long, and must have at least one lowercase character and at least one digit.
   -isDefaultTenantPassOneTime	Optional. Enables you to enforce a password reset on the first login for the default tenant administrator. If this parameter is omitted, the tenant admin password is not a one-time password.
   -noAzureAuthentication	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the UseServicePrincipal parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.

   Das Skript MigrateTo-IdentityServer.ps1 wird verwendet, um Benutzerdaten vom Orchestrator zum Identity Server zu migrieren und die Konfigurationen für beide festzulegen. Es überträgt die Identifikationsautorität des Orchestrators auf den Identity Server und erstellt die Clientkonfiguration für den Orchestrator im Identity Server.

   Das Skript geht davon aus, dass Orchestrator und Identity Server bereits veröffentlicht wurden.

   .\MigrateTo-IdentityServer.ps1 `
       -cliPackage "UiPath.IdentityServer.Migrator.Cli.zip" `
       -azureDetails @{azureSubscriptionId = "<subscription_id>"; azureAccountTenantId = "<azure_tenant_id>"; azureAccountApplicationId = "<azure_application_id>"; azureAccountPassword = "<azure_account_password>" } `
       -orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>";  targetSlot = "Production" } `
       -identityServerDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" } `
       -identityServerUrl "https://<identity_server_url>/identity" ` // must be in lowercase
       -orchestratorUrl "https://<OrchestratorURL>" `
       -hostAdminPassword "12345qwert" `
       -defaultTenantAdminPassword "12345qwert"