Konfigurieren von VMware Spring Cloud Gateway

Dieser Artikel gilt für: ❎ Basic/Standard ✅ Enterprise

In diesem Artikel erfahren Sie, wie Sie VMware Spring Cloud Gateway für VMware Tanzu mit dem Azure Spring Apps Enterprise-Plan konfigurieren.

VMware Spring Cloud Gateway ist eine kommerzielle VMware Tanzu-Komponente, die auf dem Spring Cloud Gateway-Open-Source-Projekt basiert. VMware Spring Cloud Gateway für Tanzu erleichtert die Berücksichtigung übergreifender Aspekte durch API-Entwicklungsteams, z. B. einmaliges Anmelden (SSO), Zugriffssteuerung, Ratenbegrenzung, Resilienz und Sicherheit. Sie können die API-Bereitstellung beschleunigen, indem Sie moderne cloudeigene Muster der Programmiersprache in Ihrer Wahl für die API-Entwicklung verwenden.

Eine VMware Spring Cloud Gateway-Instanz leitet Datenverkehr anhand von Regeln weiter. Sowohl das horizontale Hoch-/Herunterskalieren als auch das zentrale Hoch-/Herunterskalieren werden unterstützt, um einer dynamischen Datenverkehrslast gerecht zu werden.

VMware Spring Cloud Gateway umfasst die folgenden Funktionen:

• Dynamische Routingkonfiguration, unabhängig von einzelnen Anwendungen, die Sie ohne erneute Kompilierung anwenden und ändern können
• Kommerzielle API-Routenfilter für den Transport von autorisierten JWT-Ansprüchen (JSON Web Token) an Anwendungsdienste
• Clientzertifikatautorisierung
• Ratenbegrenzungsansätze
• Konfiguration des Trennschalters
• Unterstützung für den Zugriff auf Anwendungsdienste über HTTP-Standardauthentifizierungsanmeldeinformationen

Für die Integration in das API-Portal für VMware Tanzu generiert VMware Spring Cloud Gateway automatisch eine OpenAPI-Dokumentation der Version 3, nachdem einer Routenkonfiguration etwas hinzugefügt oder darin etwas geändert wurde. Weitere Informationen finden Sie unter Verwenden des API-Portals für VMware Tanzu.

Voraussetzungen

• Eine bereits bereitgestellte Azure Spring Apps Enterprise-Plandienstinstanz mit aktiviertem VMware Spring Cloud Gateway-Feature. Weitere Informationen finden Sie unter Schnellstart: Erstellen und Bereitstellen von Anwendungen in Azure Spring Apps mit dem Enterprise Plan.
• Azure CLI-Version 2.0.67 oder höher Verwenden Sie den folgenden Befehl, um die Azure Spring Apps-Erweiterung zu installieren: az extension add --name spring.

Aktivieren oder Deaktivieren von VMware Spring Cloud Gateway

Sie können VMware Spring Cloud Gateway nach der Erstellung der Dienstinstanz mithilfe des Azure-Portals oder der Azure CLI aktivieren und deaktivieren. Bevor Sie VMware Spring Cloud Gateway deaktivieren, müssen Sie die Zuweisung des zugehörigen Endpunkts aufheben und alle Routenkonfigurationen entfernen.

az spring gateway create \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

az spring gateway delete \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name>

Neustart von VMware Spring Cloud Gateway

Nachdem Sie die Neustartaktion abgeschlossen haben, werden VMware Spring Cloud Gateway-Instanzen auf rollierender Basis neu gestartet.

az spring gateway restart \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

Zuweisen eines öffentlichen Endpunkts zu VMware Spring Cloud Gateway

In diesem Abschnitt wird beschrieben, wie Sie VMware Spring Cloud Gateway einen öffentlichen Endpunkt zuweisen und dessen Eigenschaften konfigurieren.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --assign-endpoint true

Konfigurieren von VMware Spring Cloud Gateway-Metadaten

VMware Spring Cloud Gateway-Metadaten generieren automatisch eine Dokumentation für OpenAPI-Version 3. Sie können VMware Spring Cloud Gateway-Metadaten konfigurieren, sodass Routengruppen im API-Portal für VMware Tanzu angezeigt werden. Weitere Informationen finden Sie unter Verwenden des API-Portals für VMware Tanzu.

In der folgenden Tabelle werden die verfügbaren Metadatenoptionen beschrieben:

Sie können das Azure-Portal oder die Azure CLI zum Bearbeiten der Metadateneigenschaften verwenden.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --api-description "<api-description>" \
    --api-title "<api-title>" \
    --api-version "v0.1" \
    --server-url "<gateway-endpoint-URL>" \
    --allowed-origins "*"

Einmaliges Anmelden konfigurieren

VMware Spring Cloud Gateway unterstützt die Authentifizierung und Autorisierung über einmaliges Anmelden (SSO) mit einem OpenID-Identitätsanbieter. Der Anbieter unterstützt das OpenID Connect Discovery-Protokoll. In der folgenden Tabelle werden die SSO-Eigenschaften beschrieben:

Informationen zum Einrichten von SSO mit Microsoft Entra ID finden Sie unter Einrichten des einmaligen Anmeldens mit Microsoft Entra ID für Spring Cloud Gateway und API-Portal.

Zum Bearbeiten von SSO-Eigenschaften können Sie das Azure-Portal oder die Azure CLI verwenden.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --client-id <client-id> \
    --client-secret <client-secret> \
    --issuer-uri <issuer-uri> \
    --scope <scope>

VMware Spring Cloud Gateway unterstützt nur Autorisierungsserver, die das OpenID Connect Discovery-Protokoll unterstützen. Stellen Sie außerdem sicher, dass Sie den externen Autorisierungsserver so konfigurieren, dass Umleitungen zurück an das Gateway zugelassen werden. Ziehen Sie die Dokumentation Ihres Autorisierungsservers zu Rate, und fügen Sie https://<gateway-external-url>/login/oauth2/code/sso der Liste der zulässigen Umleitungs-URIs hinzu.

Wenn Sie die falsche SSO-Eigenschaft konfigurieren, z. B. das falsche Kennwort, sollten Sie die gesamte SSO-Eigenschaft entfernen und dann die richtige Konfiguration hinzufügen.

Denken Sie nach der Konfiguration von SSO daran, ssoEnabled: true für die VMware Spring Cloud Gateway-Routen festzulegen.

Konfigurieren der SSO-Abmeldung

VMware Spring Cloud Gateway-Dienstinstanzen stellen einen Standard-API-Endpunkt zum Abmelden bei der aktuellen SSO-Sitzung bereit. Der Pfad zu diesem Endpunkt lautet /scg-logout. Die Abmeldung führt zu einem der folgenden Ergebnisse, je nachdem, wie der Abmeldeendpunkt aufgerufen wird:

• Abmeldung bei der Sitzung und Weiterleitung zur Abmeldung beim Identitätsanbieter (IdP)
• Abmeldung bei der Dienstinstanzsitzung

Abmeldung bei IdP- und SSO-Sitzung

Wenn Sie eine GET-Anforderung an den /scg-logout-Endpunkt senden, sendet der Endpunkt eine 302-Umleitungsantwort an die IdP-Abmelde-URL. Um den Endpunkt dazu zu bringen, den Benutzer oder die Benutzerin zu einem Pfad in der Gatewaydienstinstanz zurückzuleiten, fügen Sie der GET-Anforderung mit dem /scg-logout-Endpunkt einen Umleitungsparameter hinzu. Sie können beispielsweise ${server-url}/scg-logout?redirect=/home verwenden.

Bei dem Wert des Umleitungsparameters muss es sich um einen gültigen Pfad in der VMware Spring Cloud Gateway-Dienstinstanz handeln. Eine Umleitung zu einer externen URL ist nicht zulässig.

Die folgenden Schritte beschreiben ein Beispiel für die Implementierung der Funktion in Ihren Microservices:

1. Rufen Sie eine Routenkonfiguration ab, um die Abmeldeanforderung an Ihre Anwendung weiterzuleiten. Ein Beispiel finden Sie in der Routenkonfiguration im Repository animal-rescue auf GitHub.

2. Fügen Sie der Anwendung die gewünschte Abmeldelogik hinzu. Am Ende benötigen Sie eine GET-Anforderung an den /scg-logout-Endpunkt des Gateways, wie im return-Wert für die getActionButton-Methode im Repository animal-rescue gezeigt.

Abmelden nur von der SSO-Sitzung

Wenn Sie die GET-Anforderung unter Verwendung von XMLHttpRequestan den /scg-logout-Endpunkt senden, könnte die 302-Umleitung verschluckt und nicht im Antworthandler behandelt werden. In diesem Fall würde der Benutzer oder die Benutzerin nur von der SSO-Sitzung in der VMware Spring Cloud Gateway-Dienstinstanz abgemeldet. Der Benutzer oder die Benutzerin würde weiterhin über eine gültige IdP-Sitzung verfügen. Wenn der Benutzer oder die Benutzerin erneut versucht, sich anzumelden, wird er bzw. sie in der Regel automatisch vom IdP als authentifiziert an das Gateway zurückgesendet.

Sie müssen eine Routenkonfiguration haben, um die Abmeldeanforderung an Ihre Anwendung weiterleiten zu können, wie im folgenden Beispiel gezeigt. Mit diesem Code wird eine SSO-Sitzung nur für die Gatewayabmeldung erstellt.

const req = new XMLHttpRequest();
req.open("GET", "/scg-logout);
req.send();

Konfigurieren der Ressourcenfreigabe zwischen verschiedenen Ursprüngen

Die ressourcenübergreifende Ressourcenfreigabe (Cross-Origin Resource Sharing, CORS) ermöglicht es, dass eingeschränkte Ressourcen auf einer Webseite von einer anderen Domäne außerhalb der Domäne, von der aus die erste Ressource bereitgestellt wurde, angefordert werden können. In der folgenden Tabelle werden die verfügbaren CORS-Konfigurationsoptionen beschrieben.

Vergewissern Sie sich, dass Sie über die richtige CORS-Konfiguration verfügen, wenn eine Integration in das API-Portal gewünscht ist. Weitere Informationen finden Sie im Abschnitt Zuweisen eines öffentlichen Endpunkts zu VMware Spring Cloud Gateway.

Verwenden der Dienstskalierung

Sie können die Ressourcenzuordnung für VMware Spring Cloud Gateway-Instanzen anpassen, einschließlich vCPU, Arbeitsspeicher und Instanzenanzahl.

Um Hochverfügbarkeit zu gewährleisten, wird die Verwendung eines einzelnen Replikats nicht empfohlen.

In der folgenden Tabelle wird die Standardressourcennutzung beschrieben.

Konfigurieren von TLS zwischen Gateway und Anwendungen

Um die Sicherheit zu erhöhen und sensible Informationen vor dem Abfangen durch Unbefugte zu schützen, können Sie Transport Layer Security (TLS) zwischen VMware Spring Cloud Gateway und Ihren Anwendungen aktivieren.

Bevor Sie TLS konfigurieren können, müssen Sie über eine TLS-fähige Anwendung und ein TLS-Zertifikat verfügen. Um ein TLS-Zertifikat vorzubereiten, generieren Sie ein Zertifikat von einer vertrauenswürdigen Zertifizierungsstelle (ZS). Das Zertifikat verifiziert die Identität des Servers und stellt eine sichere Verbindung her.

Nachdem Sie eine TLS-fähige Anwendung haben, die in Azure Spring Apps ausgeführt wird, laden Sie das Zertifikat in Azure Spring Apps hoch. Weitere Informationen finden Sie im Abschnitt Importieren eines Zertifikats von Verwendung von TLS/SSL-Zertifikaten in Ihrer Anwendung in Azure Spring Apps.

Nachdem das Zertifikat in Azure Spring Apps aktualisiert wurde, können Sie das TLS-Zertifikat für das Gateway konfigurieren und die Zertifikatüberprüfung aktivieren. Sie können das Zertifikat im Azure-Portal oder mithilfe der Azure CLI konfigurieren.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --enable-cert-verify <value> \
    --certificate-names <certificate-name-in-Azure-Spring-Apps>

Vorbereiten der Routenkonfiguration

Sie müssen das Protokoll in der Routenkonfiguration als HTTPS angeben. Das folgende JSON-Objekt weist VMware Spring Cloud Gateway an, das HTTPS-Protokoll für den gesamten Datenverkehr zwischen dem Gateway und der App zu verwenden.

1. Erstellen Sie eine Datei namens test-tls-route.json mit dem folgenden Inhalt:

   {
       "routes": [
         {
           "title": "Test TLS app",
           "predicates": [
             "Path=/path/to/your/app",
             "Method=GET"
           ]
         }
        ],
       "uri": "https://<app-custom-domain-name>"
   }
   

2. Verwenden Sie den folgenden Befehl, um die Regel auf die Anwendung anzuwenden:

   az spring gateway route-config create \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --name test-tls-app \
       --routes-file test-tls-route.json
   

Sie können jetzt testen, ob die Anwendung mit dem Endpunkt des Gateways TLS-fähig ist. Weitere Informationen finden Sie im Abschnitt Konfigurieren von Routen von Verwenden von Spring Cloud Gateway.

Rotieren von Zertifikaten

Da Zertifikate ablaufen, müssen Sie Zertifikate in VMware Spring Cloud Gateway mithilfe der folgenden Schritte rotieren:

1. Generieren Sie neue Zertifikate von einer vertrauenswürdigen Zertifizierungsstelle.
2. Importieren Sie die Zertifikate in Azure Spring Apps. Weitere Informationen finden Sie im Abschnitt Importieren eines Zertifikats von Verwendung von TLS/SSL-Zertifikaten in Ihrer Anwendung in Azure Spring Apps.
3. Synchronisieren Sie die Zertifikate mithilfe des Azure-Portals oder der Azure CLI.

VMware Spring Cloud Gateway wird neu gestartet, um sicherzustellen, dass das Gateway das neue Zertifikat für alle Verbindungen verwendet.

az spring gateway restart \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name>

Einstellungen für die Autoskalierung festlegen

Sie können Autoskalierungsmodi für VMware Spring Cloud Gateway festlegen.

az monitor autoscale create \
    --resource-group <resource-group-name> \
    --name <autoscale-setting-name> \
    --resource /subscriptions/<subscription-id>/resourcegroups/<resource-group-name>/providers/Microsoft.AppPlatform/Spring/<service-instance-name>/gateways/default \
    --min-count 1 \
    --max-count 5 \
    --count 1

az monitor autoscale rule create \
    --resource-group <resource-group-name> \
    --autoscale-name <autoscale-setting-name> \
    --scale out 1 \
    --cooldown 1 \
    --condition "GatewayHttpServerRequestsSecondsCount > 100 avg 1m"

Weitere Informationen zu den verfügbaren Metriken finden Sie im Abschnitt Benutzermetrikoptionen unter Metriken für Azure Spring Apps.

Konfigurieren des Antwortcaches

Die Konfiguration des Antwortcaches bietet eine Möglichkeit, einen HTTP-Antwortcache zu definieren, der global oder auf Routenebene angewendet werden kann.

Globales Aktivieren des Antwortcaches

Nachdem Sie den Antwortcache global aktiviert haben, wird dieser automatisch für alle anwendbaren Routen aktiviert.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name>
    --enable-response-cache \
    --response-cache-scope Instance \
    --response-cache-size {Examples are 1GB, 100MB, 100KB} \
    --response-cache-ttl {Examples are 1h, 30m, 50s}

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --enable-response-cache false

Aktivieren des Antwortcaches auf Routenebene

Um den Antwortcache für jede Route zu aktivieren, verwenden Sie den LocalResponseCache-Filter. Das folgende Beispiel zeigt, wie Sie den LocalResponseCache-Filter in der Routingregelkonfiguration verwenden:

{
   "filters": [
      "<other-app-level-filter-of-route>",
   ],
   "routes": [
      {
        "predicates": [
            "Path=/api/**",
            "Method=GET"
         ],
         "filters": [
            "<other-filter-of-route>",
            "LocalResponseCache=3m, 1MB"
         ],
      }
   ]
}

Weitere Informationen finden Sie im Abschnitt LocalResponseCache unter Verwendung von VMware Spring Cloud Gateway-Routenfiltern mit dem Azure Spring Apps Enterprise-Plan und LocalResponseCache in der VMware-Dokumentation.

Anstatt size und timeToLive für jeden LocalResponseCache-Filter einzeln zu konfigurieren, können Sie diese Parameter auf Spring Cloud Gateway-Ebene festlegen. Mit dieser Option können Sie den LocalResponseCache-Filter verwenden, ohne diese Werte anfangs anzugeben, und gleichzeitig die Flexibilität behalten, sie später außer Kraft zu setzen.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --enable-response-cache \
    --response-cache-scope Route \
    --response-cache-size {Examples are 1GB, 100MB, 100KB} \
    --response-cache-ttl {Examples are 1h, 30m, 50s}

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --enable-response-cache false

Das folgende Beispiel zeigt, wie Sie den LocalResponseCache-Filter verwenden, wenn size und timeToLive auf der Spring Cloud Gateway-Ebene festgelegt werden:

{
   "filters": [
      "<other-app-level-filter-of-route>",
   ],
   "routes": [
      {
        "predicates": [
            "Path=/api/path1/**",
            "Method=GET"
         ],
         "filters": [
            "<other-filter-of-route>",
            "LocalResponseCache"
         ],
      },
      {
        "predicates": [
            "Path=/api/path2/**",
            "Method=GET"
         ],
         "filters": [
            "<other-filter-of-route>",
            "LocalResponseCache=3m, 1MB"
         ],
      }
   ]
}

Konfigurieren von Umgebungsvariablen

Der Azure Spring Apps-Dienst verwaltet und optimiert VMware Spring Cloud Gateway. Mit Ausnahme der Anwendungsfälle, in denen die Überwachung der Anwendungsleistung (Application Performance Monitoring, APM) und der Protokolliergrad konfiguriert werden, müssen Sie VMware Spring Cloud Gateway normalerweise nicht mit Umgebungsvariablen konfigurieren.

Wenn Sie über Anforderungen verfügen, die von anderen in diesem Artikel beschriebenen Konfigurationen nicht erfüllt werden können, können Sie versuchen, die in der Liste der allgemeinen Anwendungseigenschaften aufgeführten Umgebungsvariablen zu konfigurieren. Stellen Sie sicher, dass Sie Ihre Konfiguration in Ihrer Testumgebung überprüfen, bevor Sie sie in Ihrer Produktionsumgebung anwenden.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --properties <key=value> \
    --secrets <key=value>

Nachdem Sie Umgebungsvariablen aktualisiert haben, wird VMware Spring Cloud Gateway neu gestartet.

Konfigurieren der Überwachung der Anwendungsleistung

Um VMware Spring Cloud Gateway zu überwachen, können Sie die APM konfigurieren. In der folgenden Tabelle sind die fünf von VMware Spring Cloud Gateway bereitgestellten Typen von APM-Java-Agents zusammen mit den jeweils erforderlichen Umgebungsvariablen aufgeführt.

Informationen zu weiteren unterstützten Umgebungsvariablen finden Sie in den folgenden Quellen:

• Application Insights-Übersicht
• Dynatrace-Umgebungsvariablen
• New Relic-Umgebungsvariablen
• AppDynamics-Umgebungsvariablen
• Elastic-Umgebungsvariablen

Konfigurieren der APM-Integration auf Dienstinstanzebene (empfohlen)

Um die APM-Überwachung in Ihrer VMware Spring Cloud Gateway-Instanz zu aktivieren, können Sie eine APM-Konfiguration auf Dienstinstanzebene erstellen und an Spring Cloud Gateway binden. Auf diese Weise können Sie die APM nur einmal konfigurieren und dieselbe APM an Spring Cloud Gateway sowie an Ihre Apps binden.

Verwalten der APM in VMware Spring Cloud Gateway (veraltet)

Sie können das Azure-Portal oder die Azure CLI verwenden, um die APM in VMware Spring Cloud Gateway einzurichten. Sie können auch die Typen von APM-Java-Agents angeben, die verwendet werden sollen, und die entsprechenden unterstützten APM-Umgebungsvariablen.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --apm-types <APM-type> \
    --properties <key=value> \
    --secrets <key=value>

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --apm-types ApplicationInsights \
    --properties APPLICATIONINSIGHTS_CONNECTION_STRING=<your-Application-Insights-connection-string> APPLICATIONINSIGHTS_SAMPLE_RATE=10

Konfigurieren von Protokollstufen

Sie können die Protokolliergrade von VMware Spring Cloud Gateway wie folgt konfigurieren, um mehr Details zu erhalten oder die Protokollierung zu reduzieren:

• Sie können die Protokollgrade auf TRACE, DEBUG, INFO, WARN, ERROR oder OFF festlegen. Der Standardprotokolliergrad für VMware Spring Cloud Gateway lautet INFO.
• Sie können die Protokollierung deaktivieren, indem Sie die Protokolliergrade auf OFF festlegen.
• Wenn der Protokolliergrad auf WARN, ERROR oder OFF festgelegt ist, müssen Sie ihn möglicherweise in INFO ändern, wenn Sie Support vom Azure Spring Apps-Team anfordern. Diese Änderung bewirkt einen Neustart von VMware Spring Cloud Gateway.
• Wenn der Protokolliergrad auf TRACE oder DEBUG festgelegt ist, kann sich dies auf die Leistung von VMware Spring Cloud Gateway auswirken. Versuchen Sie, diese Einstellungen in Ihrer Produktionsumgebung zu vermeiden.
• Sie können Protokolliergrade für die root-Protokollierung oder bestimmte Protokollierungen wie io.pivotal.spring.cloud.gateway festlegen.

Die folgenden Protokollierungen können wertvolle Informationen zur Problembehandlung auf den Ebenen TRACE und DEBUG enthalten:

Zum Abrufen von Umgebungsvariablenschlüsseln fügen Sie das Präfix logging.level. hinzu, und legen Sie dann den Protokolliergrad fest, indem Sie die Umgebung logging.level.{loggerName}={logLevel}konfigurieren. In den folgenden Beispielen werden die Schritte für das Azure-Portal und die Azure CLI gezeigt.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --properties \
      logging.level.root=INFO \
      logging.level.io.pivotal.spring.cloud.gateway=DEBUG \
      logging.level.org.springframework.cloud.gateway=DEBUG \
      logging.level.org.springframework.boot.autoconfigure.web=TRACE \
      logging.level.org.springframework.security.web=ERROR

Update der Add-On-Konfiguration

Mit dem Add-On-Konfigurationsfeature können Sie bestimmte Eigenschaften von VMware Spring Cloud Gateway mithilfe einer JSON-Formatzeichenfolge anpassen. Das Feature ist nützlich, wenn Sie Eigenschaften, die nicht über die REST-API verfügbar gemacht werden, konfigurieren müssen.

Die Add-On-Konfiguration ist ein JSON-Objekt mit Schlüssel-Wert-Paaren, die die gewünschte Konfiguration darstellen. Das folgende Beispiel zeigt die Struktur des JSON-Formats:

{
    "<addon-key-name>": {
        "<addon-key-name>": "<addon-value>"
        ...
    },
    "<addon-key-name>": "<addon-value>",
    ...
}

Die folgende Liste enthält die unterstützten Add-On-Konfigurationen für die Add-On-Schlüsselnamen und Werttypen. Diese Liste kann sich ändern, wenn die VMware Spring Cloud Gateway-Version aktualisiert wird.

• SSO-Konfiguration:

  • Schlüsselname: sso

  • Werttyp: Objekt

  • Eigenschaften:

    • RolesAttributeName (Zeichenfolge): Gibt den Namen des Attributs an, das die Rollen enthält, die der SSO-Sitzung zugeordnet sind.
    • InactiveSessionExpirationInMinutes (Integer): Gibt die Ablaufzeit für inaktive SSO-Sitzungen in Minuten an. Ein Wert 0 bedeutet, dass die Sitzung nie abläuft.

  • Beispiel:

    {
        "sso": {
            "rolesAttributeName": "roles",
            "inactiveSessionExpirationInMinutes": 1
        }
    }
    

• Metadatenkonfiguration:

  • Schlüsselname: api

  • Werttyp: Objekt

  • Eigenschaften

    • groupId (Zeichenfolge): Ein eindeutiger Bezeichner für die Gruppe der APIs, die in der VMware Spring Cloud Gateway-Instanz verfügbar sind. Der Wert darf nur Kleinbuchstaben und Zahlen enthalten.

  • Beispiel:

    {
        "api": {
            "groupId": "id1"
        }
    }
    

• Podkonfiguration

  • Schlüsselname: PodOverrides, der verwendet wird, um Außerkraftsetzungen für die Standardpodkonfiguration anzugeben.

  • Werttyp: Objekt

  • Eigenschaften

    • Containers: Dieses Array enthält die Konfiguration für einzelne Container innerhalb des Pods. Derzeit wird nur der Container gateway unterstützt.
      • Name: Gibt den Namen des Containers an. Der Container sollte gateway benannt werden.
      • Lifecycle: PreStop ist ein Lebenszyklushook, der ausgeführt wird, wenn das Beenden des Containers bevorsteht. Mit diesem Hook können Sie alle erforderlichen Bereinigungen durchführen, bevor der Container beendet wird.
    • TerminationGracePeriodSeconds: Gibt die Zeit an, die Kubernetes wartet, bis ein Pod ordnungsgemäß beendet wird, bevor das Beenden erzwungen wird.

  • Beispiel:

    {
        "PodOverrides": {
            "Containers": [
                {
                    "Name": "gateway",
                    "Lifecycle": {
                        "PreStop": {
                            "Exec": {
                                "Command": [
                                    "/bin/sh",
                                    "-c",
                                    "sleep 20"
                                ]
                            }
                        }
                    }
                }
            ],
            "TerminationGracePeriodSeconds": 120
        }
    }
    

    Wenn ein Pod, der diesen Container enthält, beendet wird, führt der PreStop-Hook den Befehl /bin/sh -c 'sleep 20' aus, wodurch der Container für 20 Sekunden in den Ruhezustand versetzt wird. Durch diese Pause hat der Container Zeit, um laufende Tasks abzuschließen oder zu bereinigen, bevor er tatsächlich beendet wird.

    Die Einstellung TerminationGracePeriodSeconds gewährt insgesamt 120 Sekunden, damit der Pod ordnungsgemäß beendet wird, einschließlich der Zeit, die von Lebenszyklushooks wie PreStop benötigt wird.

Führen Sie die folgenden Schritte aus, um die Add-On-Konfiguration zu aktualisieren.

Nächste Schritte

• Verwenden des Spring Cloud-Gateways