Installieren und Konfigurieren des Dienstgeflechts

Wichtig:

Installationsberechtigungen sind nur relevant, wenn Sie dem Automation Suite-Installationsprogramm keine Administratorrechte zur Verfügung stellen können. Wenn Sie dem Installationsprogramm die erforderlichen Administratorrechte zur Verfügung stellen können, müssen Sie die Anweisungen in diesem Abschnitt nicht befolgen.

Die Automation Suite erfordert das Istio-Dienstgeflecht für Ingress und Netzwerk.

Red Hat stellt OpenShift Service Mesh bereit, das intern auf Istio basiert.

The service mesh installation and configuration is a multi-step process. Which of the steps you must perform depends on whether or not you can grant the Automation Suite installer admin privileges over your cluster. For details, see the following table:

Schritt	Administratorrechte	Keine Administratorrechte
Schritt 1: Installieren des Dienstgeflechts	Erforderlicher Schritt	Erforderlicher Schritt
Schritt 2: Konfigurieren von Istio und Installieren des Wasm-Plugins für das Routing	Schritt nicht erforderlich	Erforderlicher Schritt
Schritt 3: Konfigurieren von Istio für mehrere Installationen in einem einzelnen Cluster	Schritt nicht erforderlich	Erforderlicher Schritt

Schritt 1: Installieren des Dienstgeflechts

Note: Before selecting an installation procedure, review the OpenShift Service Mesh compatibility matrix to confirm which OSSM versions are supported for your Automation Suite on OpenShift version.

To install OpenShift Service Mesh, refer to the procedure that applies to the version you use:

• Installing OpenShift Service Mesh 2.x
• Installing OpenShift Service Mesh 3.x

Hinweis:

Die Automation Suite erfordert keine Anwendungen wie AIli und Jaeger. Sie können sie jedoch nach eigenem Ermessen verwenden.

UiPath® gibt keine Empfehlungen zur Konfiguration des Service Mesh-Operators für die Ausführung auf einem Knoten.

Installing OpenShift Service Mesh 2.x

To install OpenShift Service Mesh 2.x, follow the instructions in the OpenShift Service Mesh documentation.

Um die OpenShift Service Mesh-Steuerebene zu erstellen, befolgen Sie die Anweisungen in der Dokumentation zur OpenShift Service Mesh-Steuerebene. Stellen Sie sicher, dass Sie auch die folgenden Schritte ausführen:

1. Installieren Sie die neue Instanz der Dienstgeflecht-Steuerungsebene im Namespace <istio-system> .
2. Verwenden Sie den Modus ClusterWide für die Steuerungsebene des Dienstgeflechts. Informationen zum Modus MultiTenant finden Sie unter Punkt 3 auf dieser Seite. Der folgende Block muss im Abschnitt spec der Ressource ServiceMeshControlPlane vorhanden sein:

   gateways:
     enabled: true
     openshiftRoute:
       enabled: true
   mode: ClusterWide

   Informationen zum Deaktivieren der OpenShift-Route finden Sie unter Punkt 4 auf dieser Seite.
3. Sie können den Modus MultiTenant für die Steuerungsebene des Dienstgeflechts verwenden. In diesem Szenario müssen Sie explizit eine Dienstgeflechtsrolle erstellen, wie im folgenden Beispiel gezeigt:

   apiVersion: maistra.io/v1
   kind: ServiceMeshMemberRoll
   metadata:
     name: default
     namespace: <istio-system>
   spec:
     members:
       - <uipath>

4. Sie haben auch die Möglichkeit, die OpenShift-Route zu deaktivieren. Diese Auswahl bringt jedoch den zusätzlichen Aufwand mit sich, dass Sie manuell eine Route für den FQDN erstellen müssen. Informationen zur manuellen Routenerstellung finden Sie im folgenden Beispiel:

   kind: Route
   apiVersion: route.openshift.io/v1
   metadata:
     name: uipath-route
     namespace: <istio-system>
     labels:
       app: istio-ingressgateway
       app.kubernetes.io/part-of: istio
       app.kubernetes.io/instance: <istio-system>
       maistra.io/owner-name: basic
       release: istio
       app.kubernetes.io/version: 2.6.1-1-1
       app.kubernetes.io/component: istio-ingress
       maistra-version: 2.6.1
       istio: ingressgateway
       app.kubernetes.io/managed-by: maistra-istio-operator
       maistra.io/owner: <istio-system>
       istio.io/rev: basic
       app.kubernetes.io/name: istio-ingress
   spec:
     to:
       kind: Service
       name: istio-ingressgateway
     tls:
       termination: passthrough
       insecureEdgeTerminationPolicy: Redirect
     host: <fqdn>
     port:
       targetPort: https
     alternateBackends: []
   

   Warnung: Das Deaktivieren der OpenShift-Route führt bei der Ausführung der Voraussetzungsprüfungen zu dem folgenden Fehler:

    ❌ [ISTIO_SERVICEMESH_VALIDATION_URL_ACCESS] error accessing the url. unexpected status code: 503

Installieren einer bestimmten Version von OpenShift Service Mesh

Use a YAML file to install a specific version of OpenShift Service Mesh (OSSM). The following example file installs OSSM version 2.4.5:

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: servicemeshoperator
  namespace: openshift-operators
spec:
  channel: stable
  installPlanApproval: Manual
  name: servicemeshoperator
  source: redhat-operators
  sourceNamespace: openshift-marketplace
  startingCSV: servicemeshoperator.v2.4.5

Wenn Sie eine andere OSSM-Version installieren möchten, ersetzen Sie servicemeshoperator.v2.4.5 durch den richtigen Wert für Ihre Version in der YAML-Datei. Um beispielsweise die OSSM-Version 2.5.0 zu installieren, geben Sie servicemeshoperator.v2.5.0 ein.

Führen Sie den folgenden Befehl aus, um OSSM zu installieren:

oc apply -f <yaml>

Ersetzen Sie den Platzhalter <yaml> im Beispielbefehl durch den Namen Ihrer YAML-Datei.

Wichtig: Nach der Installation von OSSM müssen Sie die Installation manuell genehmigen.

Wechseln Sie in der OpenShift -Konsole zu Operatoren > Installierte Operatoren > Servicemeshopperator > 1 erfordert Genehmigung > Vorschau des Installationsplans > Genehmigen.

Installing OpenShift Service Mesh 3.x

Before you install OpenShift Service Mesh 3.x, make sure that:

• You have installed or upgraded to a supported Automation Suite version. For details, refer to the Compatibily matrix.
• You have OpenShift cluster administrator permissions.
• You can access the OpenShift web console.
• You have the domain name (FQDN) used for Automation Suite routing.
• You have the OpenShift CLI (oc) installed on your workstation.

The OpenShift Service Mesh 3.x installation process deploys the following components:

• Service Mesh Operator - Manages the lifecycle of the service mesh.
• Istio Control Plane - Provides the core data plane and control plane functionality.
• Istio CNI Plugin - Configures and enforces mesh networking rules.
• Ingress Gateway - Exposes Automation Suite applications to external traffic.
• Routes - Provide entry points for Automation Suite components and validation endpoints.

To install OpenShift Service Mesh 3.x, follow the instructions for installing the operator from OperatorHub by using the OpenShift web console. For details, refer to the OpenShift Service Mesh documentation.

Make sure that you also take the following steps:

1. Install Service Mesh Operator from OperatorHub by following the instructions provided in the OpenShift Service Mesh documentation.
2. Ensure that the ingress gateway includes the correct labels. The labels must match the values that you pass as the gateway selector in the input.json file. To verify the ingress gateway label, run:

   oc get pods -l istio=ingressgateway -n <istio-system>
   

3. Create the required routes by using a YAML file. The YAML file must define routes for the main Automation Suite endpoint, the apps endpoint, the insights endpoint, and the validation endpoint. For details, refer to the following examples:
   • Automation Suite endpoint:

     ---
     kind: Route
     apiVersion: route.openshift.io/v1
     metadata:
       name: uipath-route-https
       namespace: <istio-system>
     spec:
       host: <FQDN>
       to:
         kind: Service
         name: istio-ingressgateway # Istio Ingress gateway Service
       port:
         targetPort: https
       tls:
         termination: passthrough
         insecureEdgeTerminationPolicy: Redirect
     

   • Apps endpoint:

     ---
     kind: Route
     apiVersion: route.openshift.io/v1
     metadata:
       name: uipath-route-apps
       namespace: <istio-system>
     spec:
       host: apps.<FQDN>
       to:
         kind: Service
         name: istio-ingressgateway # Istio Ingress gateway Service
       port:
         targetPort: https
       tls:
         termination: passthrough
         insecureEdgeTerminationPolicy: Redirect
     

   • Insights endpoint:

     ---
     kind: Route
     apiVersion: route.openshift.io/v1
     metadata:
       name: uipath-route-insights
       namespace: <istio-system>
     spec:
       host: insights.<FQDN>
       to:
         kind: Service
         name: istio-ingressgateway # Istio Ingress gateway Service
       port:
         targetPort: https
       tls:
         termination: passthrough
         insecureEdgeTerminationPolicy: Redirect
     

   • validation endpoint:

     ---
     kind: Route
     apiVersion: route.openshift.io/v1
     metadata:
       name: istio-validation-route
       namespace: <istio-system>
     spec:
       host: istio-validation.<FQDN> # Istio Ingress gateway Service
       to:
         kind: Service
         name: istio-ingressgateway
       port:
         targetPort: http2
     

     This route is required for the PreReq Run.

     If missing, OpenShift may return the following error:

     ❌ [ISTIO_SERVICEMESH_VALIDATION_URL_ACCESS] error accessing the url. unexpected status code: 503

4. Apply the route definitions:

   oc apply -f routes.yaml
   

5. Verify that the routes were created successfully:

   oc get routes -n <istio-system>
   

   You should see the following routes:
   • uipath-route-https
   • uipath-route-apps
   • uipath-route-insights
   • istio-validation-route

Warning: The validation route is required. If the route is missing, the prerequisite checks fail with:

❌ [ISTIO_SERVICEMESH_VALIDATION_URL_ACCESS] error accessing the url. unexpected status code: 503

Bereitstellen der Istio-Konfiguration

Um die Istio-Konfiguration bereitzustellen, müssen Sie die folgenden Parameter in der input.json -Datei festlegen:

"ingress": {
  "gateway_selector": {
    "istio": "ingressgateway"
  },
  "ingress_gateway_secret": "istio-ingressgateway-certs",
  "namespace": "<istio-system>"
},

Weitere Informationen zu den Istio-Konfigurationsparametern finden Sie in der folgenden Tabelle:

Parameter	Wert
ingress.gateway_selector.istio	Standardwert: ingressgateway Note: This is the default label used internally by Automation Suite. However, your environment may use a different label for the Istio ingress gateway depending on how the cluster was configured. Wenn Sie den Wert geändert haben, verwenden Sie den folgenden Befehl, um den richtigen Wert abzurufen: oc -n <istio-system> get deploy istio-ingressgateway -o jsonpath="{.metadata.labels.istio}"; echo
ingress.ingress_gateway_secret	Der Name des geheimen Schlüssels, der die Zertifikatsdateien enthält. Der Standardwert ist istio-ingressgateway-certs.
ingress.namespace	Der Namespace, in dem Sie das Dienstgeflecht installiert haben.

Schritt 2: Konfigurieren von Istio und Installieren des Wasm-Plugins für das Routing

Überblick

Wichtig:

Dieser Schritt erfordert Administratorrechte für die Installation im Istio-Namespace.

Es gibt zwei Möglichkeiten, die Installation durchzuführen:

• Option A: Wenn Sie die Berechtigungen, die das Automation Suite-Installationsprogramm erfordert, nicht bereitstellen können, müssen Sie diesen Schritt vor der Installation der Automation Suite ausführen.

• Option B: Während der Installation der Automation Suite. Diese Methode erfordert, dass die Kubeconfig-Datei, die Sie während der Automation Suite-Installation verwenden, über die erforderlichen Berechtigungen verfügt. Informationen zum Überprüfen der Berechtigungen finden Sie im Abschnitt Erteilen von Installationsberechtigungen . Wenn Sie alle erforderlichen Berechtigungen erteilen können, überspringen Sie diesen Schritt.

Voraussetzungen

Bevor Sie Istio konfigurieren und das WASM-Plugin für das Routing installieren, müssen die folgenden Voraussetzungen erfüllt sein:

• Verwenden Sie eine Linux-, Windows- oder macOS-Maschine mit Zugriff auf den OpenShift Kubernetes API-Server.

• Installieren Sie den OpenShift-CLI-Client auf Ihrer Maschine. Weitere Informationen finden Sie unter OpenShift-CLI (OC).

• Installieren Sie Helm 3.14 oder höher auf der Maschine, von der Sie das WASM-Plugin installieren möchten, und authentifizieren Sie Helm bei Ihrer privaten Registrierung. Führen Sie die folgenden Schritte aus, um Helm zu installieren und zu authentifizieren:

  1. Laden Sie die Helm-Binärdateien herunter und installieren Sie sie auf Ihrer Maschine. Weitere Informationen finden Sie in der Helm-Dokumentation.

  2. Authentifizieren Sie Helm bei Ihrer Registrierung, indem Sie die Anweisungen in der Helm-Dokumentation befolgen. Alternativ können Sie den folgenden Befehl verwenden und die Beispielwerte durch Ihre tatsächliche Registrierungs-URL und Anmeldeinformationen ersetzen:

     helm registry login my.registry.io:443 --username "admin" --password "secret"

Konfiguration und Installation

Führen Sie die folgenden Schritte aus, um Istio zu konfigurieren und das WASM-Plugin für das Routing zu installieren:

1. Erstellen Sie ein imagepullsecret in dem Namespace, in dem Sie das Dienstgeflecht installiert haben. Um die imagepullsecret zu erstellen, verwenden Sie Ihren typischen Workflow oder führen Sie die folgenden Schritte aus:

   registry= <registry_url> #provide the registry where the UiPath images are hosted
   username= <user_name> #provide the username which will be used for the authentication
   password= <password> #provide the password which will be used for the authentication
   namespace= <namespace> #namespace where you want to create a secret
   
   oc create secret docker-registry uipathpullsecret --namespace=${namespace} \
     --docker-server=${registry} --docker-username=${username} \
     --docker-password=${password} --dry-run=client -o yaml \
     | oc apply -f -

2. Rufen Sie das Helm-Diagramm in ein lokales Verzeichnis ab, <uipath-istio-configure>:

   helm pull oci://<docker-registry>/helm/istio-configure --version <istio-configure-version> \
   --untar --untardir <uipath-istio-configure>

   Das folgende Beispiel zeigt den Befehl, nachdem Sie die Platzhalter durch tatsächliche Werte ersetzt haben:

   helm pull oci://registry.mycompany.com/helm/istio-configure --version 2024.10.0 \
   --untar --untardir uipath-istio-configure

3. Erstellen Sie eine Parameterwertdatei, die während der Helm-Installation von istio-configure angewendet wird. Verwenden Sie das folgende Beispiel als Vorlage für die Datei und ersetzen Sie die Platzhalter <fqdn>, <cluster_type>, <pullsecret>, <registry> und <uipath_namespace> durch entsprechende Werte:

   fqdn: <fqdn>    #the FQDN of the Automation Suite
   gateway:
     selector:
       istio: ingressgateway
   global:
     cluster_type: <cluster_type>    # REQUIRED. Example: eks, aks, openshift
     kubernetesDistribution: <cluster_type>  # REQUIRED. Example: eks, aks, openshift
     imagePullSecret:
       name: <pullsecret>    #name of pull secret which you had create earlier
   minProtocolVersion: TLSV1_2   #TLS versions
   uipath:
     registry: <registry>    #registry url without the protocol 
   uipathServiceNamespace: <uipath_namespace>   #namespace where the uipath application is deployed
   patchIstioService: false
   wasm:
     image:
       pullSecret: <pullsecret>    #name of pull secret which you had create earlier
       registry: oci://<registry>   #registry url without the protocol

4. Installieren Sie istio-configure im Istio-Namespace mithilfe von Helm. Ersetzen Sie im folgenden Befehl den Platzhalter <istio_namespace> durch den Namespace, in dem Istio installiert ist, und <path_to_the_values_yaml> durch den Speicherort der YAML-Datei, die die Parameterwerte enthält:

   helm upgrade --debug --install --wait custom-istio-configure \
     uipath-istio-configure/istio-configure --version 2024.10.0 \
     --namespace <istio_namespace> -f <path_to_the_values.yaml>

5. Wenn Sie eine Registrierung verwenden, die nicht von einer bekannten Stelle signiert ist, müssen Sie die Umgebungsvariable WASM_INSECURE_REGISTRIES zur istio-ingressgateway -Bereitstellung hinzufügen, damit Istio das Image abrufen kann, das das Wasm-Plugin verwendet. Führen Sie den folgenden Befehl aus, um die Umgebungsvariable hinzuzufügen:

   oc -n <istio-system> patch deployment istio-ingressgateway --type="json" --patch='[{"op":"add", "path": "/spec/template/spec/containers/0/env/-", "value": {"name": "WASM_INSECURE_REGISTRIES", "value": "customer-registry.com"}}]'

6. Fügen Sie istio-configure zum Abschnitt exclude_components in Ihrer input.json -Datei hinzu.
7. Erstellen Sie Zertifikatsgeheimnisse mithilfe des in ingress.ingress_gateway_secret angegebenen Namens im Namespace <istio-system> .

Hinweis:

Wenn Sie den FQDN nach der Installation ändern, müssen Sie Istio und das WASM-Plugin neu konfigurieren, es sei denn, das Installationsprogramm der Automation Suite verfügt über Administratorrechte. Zum Neukonfigurieren müssen Sie die folgenden Schritte ausführen:

1. Aktualisieren Sie die inSchritt 3 genannte Parameterwertedatei mit dem neuen FQDN.
2. Wiederholen Sie alle Schritte zum Konfigurieren von Istio und zum Installieren des WASM-Plugins für das Routing.

Schritt 3: Konfigurieren von Istio für mehrere Installationen in einem einzelnen Cluster

Um Istio für mehrere Automation Suite-Installationen in einem einzelnen OpenShift-Cluster zu konfigurieren, müssen Sie mehrere custom-istio-configure hinzufügen, die den FQDN und Ressourcen für verschiedene Automation Suite-Instanzen enthalten. Sie müssen die Helm-Werte ausfüllen, die Ihrer zweiten oder jeder nachfolgenden Installation entsprechen.

Für jede Installation müssen Sie unterschiedliche istio-configure -Werte erstellen:

 fqdn: <fqdn-for-second-installation>    #the FQDN of the Automation Suite
gateway:
  selector:
    istio: ingressgateway
global:
  cluster_type: <cluster_type>    # REQUIRED. Example: eks, aks, openshift
  imagePullSecret:
    name: <pullsecret>    #name of pull secret which you had create earlier
minProtocolVersion: TLSV1_2   #TLS versions
uipath:
  registry: <registry>    #registry url without the protocol 
uipathServiceNamespace: <second-installation-namespace>   #namespace where the uipath application is deployed
patchIstioService: false
wasm:
  image:
    pullSecret: <pullsecret>    #name of pull secret which you had create earlier
    registry: oci://<registry>   #registry url without the protocol

Sie müssen den Namen von custom-istio-configure in <namespace>-custom-istio-configure ändern. Dies muss auf dem replizierten Namespace installiert werden, in dem die zweite Installation durchgeführt wird.

 helm upgrade --debug --install --wait <namespace>-custom-istio-configure \
  uipath-istio-configure/istio-configure --version 2024.10.0 \
  --namespace <istio_namespace> -f <path_to_the_values.yaml>