A VMware Spring Cloud Gateway konfigurálása

Feljegyzés

Az Azure Spring Apps az Azure Spring Cloud szolgáltatás új neve. Bár a szolgáltatásnak új neve van, bizonyos helyeken a régi nevet fogja látni egy darabig, miközben az eszközök, például képernyőképek, videók és diagramok frissítésével dolgozunk.

Ez a cikk a következőre vonatkozik:❌ Basic/Standard ✔️ Enterprise

Ez a cikk bemutatja, hogyan konfigurálhatja a VMware Tanzu-hoz készült VMware Spring Cloud Gatewayt az Azure Spring Apps Enterprise-csomaggal.

A VMware Spring Cloud Gateway egy kereskedelmi VMware Tanzu-összetevő, amely a nyílt forráskódú Spring Cloud Gateway-projekten alapul. A Tanzu-hoz készült VMware Spring Cloud Gateway kezeli az API-fejlesztői csapatok átfogó problémáit, például az egyszeri bejelentkezést (SSO), a hozzáférés-vezérlést, a sebességkorlátozást, a rugalmasságot és a biztonságot. Az API-teljesítés felgyorsítható a modern, natív felhőbeli mintákkal az API-fejlesztéshez választott programozási nyelvben.

A VMware Spring Cloud Gateway-példány szabályok szerint irányítja a forgalmat. Támogatja a horizontális fel- és leskálázást a dinamikus forgalmi terhelés kielégítése érdekében.

A VMware Spring Cloud Gateway a következő funkciókat tartalmazza:

• Dinamikus útválasztási konfiguráció, az egyes alkalmazásoktól függetlenül, amelyek újrafordítás nélkül alkalmazhatók és módosíthatók
• Kereskedelmi API-útvonalszűrők az engedélyezett JSON-webjogkivonatok (JWT) alkalmazásszolgáltatásokba való átviteléhez
• Ügyféltanúsítvány-engedélyezés
• Sebességkorlátozó megközelítések
• Megszakító konfigurálása
• Az alkalmazásszolgáltatások http-alapszintű hitelesítési hitelesítő adatokon keresztüli elérésének támogatása

A VMware Tanzu API Portallal való integrálásához a VMware Spring Cloud Gateway automatikusan létrehozza az OpenAPI 3- es verziójának dokumentációját az útvonalkonfiguráció kiegészítése vagy módosítása után. További információ: A VMware Tanzu API-portáljának használata.

Előfeltételek

• Egy már kiépített Azure Spring Apps Enterprise-csomagszolgáltatás-példány, amelyen engedélyezve van a VMware Spring Cloud Gateway. További információ : Rövid útmutató: Alkalmazások létrehozása és üzembe helyezése az Azure Spring Appsben a Nagyvállalati csomag használatával.
• Az Azure CLI 2.0.67-es vagy újabb verziója. Az Azure Spring Apps bővítmény telepítéséhez használja a következő parancsot: az extension add --name spring.

A VMware Spring Cloud Gateway engedélyezése vagy letiltása

A szolgáltatáspéldány létrehozása után engedélyezheti vagy letilthatja a VMware Spring Cloud Gatewayt az Azure Portal vagy az Azure CLI használatával. A VMware Spring Cloud Gateway letiltása előtt le kell kapcsolnia a végpontot, és el kell távolítania az összes útvonalkonfigurációt.

Azure Portal

A következő lépésekkel engedélyezheti vagy letilthatja a VMware Spring Cloud Gatewayt az Azure Portal használatával:

1. Nyissa meg a szolgáltatáserőforrást, majd válassza a Spring Cloud Gateway lehetőséget.
2. Válassza a Kezelés lehetőséget.
3. Jelölje be vagy törölje a jelet a Spring Cloud Gateway engedélyezése jelölőnégyzetből, majd válassza a Mentés lehetőséget.

Most már megtekintheti a Spring Cloud Gateway állapotát a Spring Cloud Gateway lapon.

Azure CLI

A VMware Spring Cloud Gateway engedélyezéséhez vagy letiltásához használja az alábbi Azure CLI-parancsokat:

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>

A VMware Spring Cloud Gateway újraindítása

Az újraindítási művelet befejezése után a VMware Spring Cloud Gateway-példányok gördülő alapon újraindulnak.

Azure Portal

A következő lépésekkel indítsa újra a VMware Spring Cloud Gatewayt az Azure Portal használatával:

1. Nyissa meg a szolgáltatáserőforrást, majd válassza a Spring Cloud Gateway lehetőséget.
2. Válassza az Újraindítás lehetőséget.
3. Az újraindítás megerősítéséhez kattintson az OK gombra .

Azure CLI

Az átjáró újraindításához használja a következő Azure CLI-parancsot:

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

Nyilvános végpont hozzárendelése a VMware Spring Cloud Gatewayhez

Ez a szakasz azt ismerteti, hogyan rendelhet nyilvános végpontot a VMware Spring Cloud Gatewayhez, és hogyan konfigurálhatja annak tulajdonságait.

Azure Portal

Ha végpontot szeretne hozzárendelni az Azure Portalhoz, kövesse az alábbi lépéseket:

1. Nyissa meg az Azure Spring Apps-példányt.
2. Válassza a Spring Cloud Gateway lehetőséget a navigációs panelen, majd válassza az Áttekintés lehetőséget.
3. Állítsa be a Végpont hozzárendelése igen értékre beállítását.

Néhány perc elteltével az URL-cím megjeleníti a konfigurált végpont URL-címét. Mentse az URL-címet későbbi használatra.

Azure CLI

A végpont hozzárendeléséhez használja a következő parancsot:

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

A VMware Spring Cloud Gateway metaadatainak konfigurálása

A VMware Spring Cloud Gateway metaadatai automatikusan generálják az OpenAPI 3- es verziójának dokumentációját. Konfigurálhatja a VMware Spring Cloud Gateway metaadatait az útvonalcsoportok megjelenítéséhez a VMware Tanzu API Portalján. További információ: A VMware Tanzu API-portáljának használata.

Az alábbi táblázat a rendelkezésre álló metaadat-beállításokat ismerteti:

Tulajdonság	Leírás
title	A VMware Spring Cloud Gateway-példányon elérhető API-k kontextusát leíró cím. Az alapértelmezett érték Spring Cloud Gateway for K8S.
description	A VMware Spring Cloud Gateway-példányon elérhető API-k részletes leírása. Az alapértelmezett érték a következő: Generated OpenAPI 3 document that describes the API routes configured for '[Gateway instance name]' Spring Cloud Gateway instance deployed under '[namespace]' namespace.*.
documentation	A VMware Spring Cloud Gateway-példányon elérhető API-dokumentáció helye.
version	A VMware Spring Cloud Gateway-példányon elérhető API-k verziója. Az alapértelmezett érték unspecified.
serverUrl	A VMware Spring Cloud Gateway-példány API-khoz való hozzáférésének alap URL-címe. Ez a tulajdonság kötelező, ha integrálni szeretne az API-portállal.

A metaadatok tulajdonságainak szerkesztéséhez használhatja az Azure Portalt vagy az Azure CLI-t.

Azure Portal

A metaadatok Azure Portalon való szerkesztéséhez kövesse az alábbi lépéseket:

1. Nyissa meg az Azure Spring Apps-példányt.
2. Válassza a Spring Cloud Gateway lehetőséget a navigációs panelen, majd válassza a Konfiguráció lehetőséget.
3. Adja meg az API-hoz felsorolt tulajdonságok értékeit.
4. Válassza a Mentés lehetőséget.

Azure CLI

A következő paranccsal konfigurálhatja a VMware Spring Cloud Gateway metaadat-tulajdonságait. A nyilvános végpont hozzárendelése a VMware Spring Cloud Gatewayhez szakasz befejezésekor kapott végponti URL-címre van szüksége.

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

Egyszeri bejelentkezés konfigurálása

A VMware Spring Cloud Gateway egyszeri bejelentkezéssel (SSO) támogatja a hitelesítést és az engedélyezést egy OpenID-identitásszolgáltatóval. A szolgáltató támogatja az OpenID Csatlakozás Discovery protokollt. Az alábbi táblázat az egyszeri bejelentkezés tulajdonságait ismerteti:

Tulajdonság	Kötelező?	Leírás
issuerUri	Igen	A kiállító azonosítójaként érvényes URI. Ha igen, issuerUrihttps://example.comakkor például egy OpenID-szolgáltató konfigurációs kérése lesz a következőre https://example.com/.well-known/openid-configuration: . Az eredmény várhatóan egy OpenID-szolgáltató konfigurációs válasza lesz.
clientId	Igen	Az OpenID Csatlakozás az identitásszolgáltató ügyfélazonosítóját.
clientSecret	Igen	Az OpenID Csatlakozás az identitásszolgáltató ügyféltitkát.
scope	Igen	A JWT-identitásjogkivonatokban szerepeltetni kívánt hatókörök listája. Ennek a listának azon hatókörökön kell alapulnia, amelyeket az identitásszolgáltató engedélyez.

Az egyszeri bejelentkezés Microsoft Entra-azonosítóval való beállításával kapcsolatban lásd : Egyszeri bejelentkezés beállítása a Microsoft Entra ID használatával a Spring Cloud Gatewayhez és az API Portalhoz.

Az SSO-tulajdonságok szerkesztéséhez használhatja az Azure Portalt vagy az Azure CLI-t.

Azure Portal

Az egyszeri bejelentkezés tulajdonságainak az Azure Portalon való szerkesztéséhez kövesse az alábbi lépéseket:

1. Nyissa meg az Azure Spring Apps-példányt.
2. Válassza a Spring Cloud Gateway lehetőséget a navigációs panelen, majd válassza a Konfiguráció lehetőséget.
3. Adja meg az egyszeri bejelentkezéshez felsorolt tulajdonságok értékeit.
4. Válassza a Mentés lehetőséget.

Azure CLI

A következő paranccsal konfigurálhatja a VMware Spring Cloud Gateway SSO-tulajdonságait:

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>

A VMware Spring Cloud Gateway csak az OpenID Csatlakozás Discovery protokollt támogató engedélyezési kiszolgálókat támogatja. Emellett konfigurálja a külső engedélyezési kiszolgálót is, hogy engedélyezze az átjáróra való átirányítást. Tekintse meg az engedélyezési kiszolgáló dokumentációját, és vegye fel https://<gateway-external-url>/login/oauth2/code/sso az engedélyezett átirányítási URI-k listájára.

Ha helytelen SSO-tulajdonságot konfigurál, például rossz jelszót, távolítsa el a teljes egyszeri bejelentkezés tulajdonságot, majd adja hozzá a megfelelő konfigurációt.

Az egyszeri bejelentkezés konfigurálása után ne felejtse el beállítani ssoEnabled: true a VMware Spring Cloud Gateway útvonalait.

SSO-kijelentkezés konfigurálása

A VMware Spring Cloud Gateway szolgáltatáspéldányai alapértelmezett API-végpontot biztosítanak az aktuális SSO-munkamenetből való kijelentkezéshez. A végpont elérési útja: /scg-logout. A kijelentkezés a következő eredmények egyikét eredményezi, attól függően, hogy hogyan hívja meg a kijelentkezési végpontot:

• Jelentkezzen ki a munkamenetből, és irányítsa át az identitásszolgáltató (IdP) kijelentkeztetésére.
• Jelentkezzen ki a szolgáltatáspéldány-munkamenetből.

Kijelentkezés az idP- és SSO-munkamenetből

Ha kérést GET küld a /scg-logout végpontnak, a végpont átirányítási 302 választ küld az IdP-kijelentkezés URL-címére. Ha le szeretné kérni a végpontot, hogy visszaadja a felhasználót az átjárószolgáltatás-példány egyik elérési útjának, adjon hozzá egy átirányítási paramétert a GET kéréshez a /scg-logout végponttal együtt. Használhatja például a következőt: ${server-url}/scg-logout?redirect=/home.

Az átirányítási paraméter értékének érvényes elérési útnak kell lennie a VMware Spring Cloud Gateway szolgáltatáspéldányon. Külső URL-címre nem irányítható át.

Az alábbi lépések egy példát mutatnak be a függvény mikroszolgáltatásokban való implementálására:

1. Szerezze be az útvonalkonfigurációt a kijelentkezés kérésének az alkalmazáshoz való átirányításához. Például tekintse meg az útvonalkonfigurációt a GitHub állatmentő adattárában.

2. Adja hozzá az alkalmazáshoz szükséges naplózási logikát. A végén szüksége lesz egy GET kérésre az átjáró végpontjához/scg-logout, ahogy az getActionButton az return állatmentő adattárban lévő metódus értékében is látható.

Kijelentkezés csak az egyszeri bejelentkezés munkamenetéből

Ha a kérést a GET/scg-logout végpontra küldi a használatával XMLHttpRequest, az 302 átirányítás lenyelhető, és nem kezelhető a válaszkezelőben. Ebben az esetben a felhasználó csak a VMware Spring Cloud Gateway szolgáltatáspéldány egyszeri bejelentkezéses munkamenetéből lesz kijelentkezve. A felhasználónak továbbra is érvényes idP-munkamenete lenne. Általában, ha a felhasználó újra megpróbál bejelentkezni, a rendszer automatikusan visszaküldi őket az átjárónak az idP által hitelesített módon.

A kijelentkezés kérésének az alkalmazáshoz való átirányításához útvonalkonfigurációval kell rendelkeznie, ahogyan az az alábbi példában látható. Ez a kód egy csak átjáróval rendelkező egyszeri bejelentkezéses munkamenetet hoz létre.

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

Forrásközi erőforrásmegosztás konfigurálása

A forrásközi erőforrás-megosztás (CORS) lehetővé teszi, hogy a weblapon korlátozott erőforrásokat kérhessenek egy másik tartománytól azon a tartományon kívülről, amelyből az első erőforrást kiszolgálták. Az alábbi táblázat az elérhető CORS-konfigurációs beállításokat ismerteti.

Tulajdonság	Leírás
allowedOrigins	Helyek közötti kérések igénylésének engedélyezése a forrásokkal
allowedOriginPatterns	Helyek közötti kérelmek készítéséhez engedélyezett forrásminták
allowedMethods	Engedélyezett HTTP-metódusok helyek közötti kérelmek esetén
allowedHeaders	Engedélyezett fejlécek helyek közötti kérelmekben
maxAge	Mennyi ideig, másodpercek alatt gyorsítótárazják az ügyfelek egy előzetes kérés válaszát?
allowCredentials	A felhasználói hitelesítő adatok támogatottak-e a helyek közötti kérelmekben
exposedHeaders	HTTP-válaszfejlécek a helyek közötti kérelmekhez való közzétételhez

Győződjön meg arról, hogy a megfelelő CORS-konfigurációval rendelkezik, ha integrálni szeretné az API-portált. További információ: Nyilvános végpont hozzárendelése a VMware Spring Cloud Gatewayhez szakasz.

Szolgáltatásskálázás használata

Testre szabhatja a VMware Spring Cloud Gateway-példányok erőforrás-lefoglalását, beleértve a vCPU-t, a memóriát és a példányok számát.

A magas rendelkezésre állás érdekében nem javasoljuk egyetlen replika használatát.

Az alábbi táblázat az alapértelmezett erőforrás-használatot ismerteti.

Összetevő neve	Példányok száma	vCPU példányonként	Memória példányonként
VMware Spring Cloud Gateway	2	1 mag	2 GiB
VMware Spring Cloud Gateway-operátor	2	1 mag	2 GiB

TLS konfigurálása az átjáró és az alkalmazások között

A biztonság növelése és a bizalmas információk jogosulatlan felek általi elfogása elleni védelme érdekében engedélyezheti a Transport Layer Security (TLS) szolgáltatást a VMware Spring Cloud Gateway és az alkalmazások között.

A TLS konfigurálása előtt TLS-kompatibilis alkalmazással és TLS-tanúsítvánnyal kell rendelkeznie. TLS-tanúsítvány előkészítéséhez hozzon létre egy tanúsítványt egy megbízható hitelesítésszolgáltatótól. A tanúsítvány ellenőrzi a kiszolgáló identitását, és biztonságos kapcsolatot hoz létre.

Miután egy TLS-kompatibilis alkalmazás fut az Azure Spring Appsben, töltse fel a tanúsítványt az Azure Spring Appsbe. További információkért tekintse meg a TLS/SSL-tanúsítványok használatának tanúsítványimportálásiszakaszát az alkalmazásban az Azure Spring Appsben.

Az Azure Spring Appsre frissített tanúsítványsal konfigurálhatja az átjáró TLS-tanúsítványát, és engedélyezheti a tanúsítvány-ellenőrzést. A tanúsítványt az Azure Portalon vagy az Azure CLI használatával konfigurálhatja.

Azure Portal

A tanúsítvány az Azure Portalon való konfigurálásához kövesse az alábbi lépéseket:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen.
2. A Spring Cloud Gateway lapon válassza a Tanúsítványkezelés lehetőséget.
3. Válassza a Tanúsítvány-ellenőrzés engedélyezése lehetőséget.
4. Válassza ki a TLS-tanúsítványt a tanúsítványokban.
5. Válassza a Mentés lehetőséget.

A konfiguráció frissítése eltarthat néhány percig. A konfiguráció befejezésekor értesítést kell kapnia.

Azure CLI

A következő paranccsal engedélyezheti vagy letilthatja a tanúsítvány-ellenőrzést az Azure CLI használatával. Cserélje le a <value> helyőrzőt true az ellenőrzés engedélyezésére vagy false letiltására.

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>

Az útvonalkonfiguráció előkészítése

Az útvonalkonfigurációban HTTPS-ként kell megadnia a protokollt. A következő JSON-objektum arra utasítja a VMware Spring Cloud Gatewayt, hogy használja a HTTPS protokollt az átjáró és az alkalmazás közötti összes forgalomhoz.

1. Hozzon létre egy test-tls-route.json nevű fájlt a következő tartalommal:

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

2. A következő paranccsal alkalmazza a szabályt az alkalmazásra:

   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
   

Most már tesztelheti, hogy az alkalmazás engedélyezve van-e a TLS-ben az átjáró végpontjával. További információ: A Spring Cloud Gateway használatának útvonalak konfigurálása szakasza.

Tanúsítványok váltása

A tanúsítványok lejáratakor a következő lépések végrehajtásával el kell forgatnia a tanúsítványokat a VMware Spring Cloud Gatewayben:

1. Hozzon létre új tanúsítványokat egy megbízható hitelesítésszolgáltatótól.
2. Importálja a tanúsítványokat az Azure Spring Appsbe. További információkért tekintse meg a TLS/SSL-tanúsítványok használatának tanúsítványimportálásiszakaszát az alkalmazásban az Azure Spring Appsben.
3. Szinkronizálja a tanúsítványokat az Azure Portal vagy az Azure CLI használatával.

A VMware Spring Cloud Gateway újraindul, hogy az átjáró az új tanúsítványt használja az összes kapcsolathoz.

Azure Portal

A tanúsítványok szinkronizálásához kövesse az alábbi lépéseket:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen.
2. A Spring Cloud Gateway lapon válassza az Újraindítás lehetőséget, majd erősítse meg a műveletet.

Azure CLI

A következő újraindítási paranccsal szinkronizálhat egy tanúsítványt a VMware Spring Cloud Gatewayhez:

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

Automatikus méretezési beállítások beállítása

Beállíthatja az automatikus méretezési módokat a VMware Spring Cloud Gatewayhez.

Azure Portal

Az alábbi lista az automatikus skálázási igénykezeléshez elérhető lehetőségeket mutatja be:

• A Manuális méretezés beállítás rögzített példányszámot tart fenn. A skálázás legfeljebb 10 példányra terjedhet ki. Ez az érték módosítja a Spring Cloud Gateway különálló futó példányainak számát.
• Az Egyéni automatikus skálázás beállítás bármilyen ütemezés szerint skálázható, bármilyen metrikák alapján.

Az Azure Portalon válassza ki a méretezés módját. Az alábbi képernyőképen az Egyéni automatikus skálázás beállítás és a mód beállításai láthatók:

Azure CLI

Automatikus méretezési beállítás létrehozásához használja az alábbi parancsot:

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

Automatikus méretezési szabály létrehozásához használja a következő parancsot:

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"

Az elérhető metrikákkal kapcsolatos további információkért tekintse meg az Azure Spring Apps metrikáinak Felhasználói metrikák beállítási szakaszát.

A válasz-gyorsítótár konfigurálása

A válaszgyorsítótár konfigurációja lehetővé teszi a globálisan vagy az útvonal szintjén alkalmazható HTTP-válaszgyorsítótár definiálásának módját.

A válaszgyorsítótár globális engedélyezése

Miután globálisan engedélyezte a válaszgyorsítótárat, a válaszgyorsítótár automatikusan engedélyezve lesz az összes alkalmazható útvonalon.

Azure Portal

A válasz-gyorsítótár globális engedélyezéséhez kövesse az alábbi lépéseket:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen.
2. A Spring Cloud Gateway lapon válassza a Konfiguráció lehetőséget.
3. A Válaszgyorsítótár szakaszban válassza a Válaszgyorsítótár engedélyezése lehetőséget, majd állítsa a hatókört példányra.
4. Állítsa be a válaszgyorsítótár méretét és élettartamát .
5. Válassza a Mentés lehetőséget.

A válaszgyorsítótár letiltásához kövesse az alábbi lépéseket:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen.
2. A Spring Cloud Gateway lapon válassza a Konfiguráció lehetőséget.
3. A Válaszgyorsítótár szakaszban törölje a válaszgyorsítótár engedélyezése lehetőséget.
4. Válassza a Mentés lehetőséget.

Azure CLI

A válaszgyorsítótár globális engedélyezéséhez használja a következő parancsot:

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}

A válaszgyorsítótár letiltásához használja a következő parancsot:

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

A válaszgyorsítótár engedélyezése az útvonal szintjén

A válaszgyorsítótár bármely útvonalhoz való engedélyezéséhez használja a szűrőt LocalResponseCache . Az alábbi példa bemutatja, hogyan használhatja a szűrőt az LocalResponseCache útválasztási szabály konfigurációjában:

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

További információ: A VMware Spring Cloud Gateway útvonalszűrőinekhasználata az Azure Spring Apps Enterprise-csomaggal és a LocalResponseCache szolgáltatással a VMware dokumentációjában.

Ahelyett, hogy egyenként konfigurálja size és timeToLive mindegyik LocalResponseCache szűrőre vonatkozóan, ezeket a paramétereket a Spring Cloud Gateway szintjén állíthatja be. Ezzel a beállítással anélkül használhatja a LocalResponseCache szűrőt, hogy eredetileg meg nem adja ezeket az értékeket, ugyanakkor megőrizheti a rugalmasságot a későbbi felülbírálásukhoz.

Azure Portal

Az alábbi lépésekkel engedélyezze a válasz-gyorsítótárat az útvonal szintjén, és állítsa be size a következőt timeToLive:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen.
2. A Spring Cloud Gateway lapon válassza a Konfiguráció lehetőséget.
3. A Válaszgyorsítótár szakaszban válassza a Válaszgyorsítótár engedélyezése lehetőséget, majd állítsa a hatókört útvonalra.
4. Állítsa be a válaszgyorsítótár méretét és élettartamát .
5. Válassza a Mentés lehetőséget.

Az alábbi lépésekkel tiltsa le a válaszgyorsítótárat az útvonal szintjén, amely törli size a következőt timeToLive:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen.
2. A Spring Cloud Gateway lapon válassza a Konfiguráció lehetőséget.
3. A Válaszgyorsítótár szakaszban törölje a válaszgyorsítótár engedélyezése lehetőséget.
4. Válassza a Mentés lehetőséget.

Azure CLI

Az alábbi paranccsal engedélyezze a válaszgyorsítótárat az útvonal szintjén, és állítsa be size a következőt timeToLive:

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}

A következő paranccsal tiltsa le a válaszgyorsítótárat az útvonal szintjén, amely törli size a következőt timeToLive:

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

Az alábbi példa bemutatja, hogyan használhatja a szűrőt, LocalResponseCache amikor size a timeToLive Spring Cloud Gateway szintjén van beállítva:

{
   "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"
         ],
      }
   ]
}

Környezeti változók konfigurálása

Az Azure Spring Apps szolgáltatás kezeli és hangolja a VMware Spring Cloud Gatewayt. Az alkalmazásteljesítmény-figyelést (APM) és a naplószintet konfiguráló használati esetek kivételével általában nem kell környezeti változókkal konfigurálnia a VMware Spring Cloud Gatewayt.

Ha olyan követelményekkel rendelkezik, amelyeket nem tud teljesíteni a cikkben ismertetett egyéb konfigurációk szerint, megpróbálhatja konfigurálni a Common application properties (Általános alkalmazástulajdonságok) listában látható környezeti változókat. Az éles környezetben való alkalmazás előtt győződjön meg arról, hogy a konfigurációt a tesztkörnyezetben szeretné ellenőrizni.

Azure Portal

A környezeti változók Azure Portalon való konfigurálásához kövesse az alábbi lépéseket:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen, majd válassza a Konfiguráció lehetőséget.
2. Töltse ki a környezeti változók kulcs-érték párjait a Tulajdonságok és titkos kódok szakaszban. A Titkos kulcsok szakaszban bizalmas információkat tartalmazó változókat is felvehet.
3. Válassza a Mentés lehetőséget a módosítások mentéséhez.

Azure CLI

Az alábbi paranccsal konfigurálhatja a környezeti változókat az Azure CLI használatával. A paraméterrel --secrets bizalmas információkat tartalmazó változókat is megadhat.

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

A környezeti változók frissítése után a VMware Spring Cloud Gateway újraindul.

Alkalmazásteljesítmény-figyelés konfigurálása

A VMware Spring Cloud Gateway monitorozásához konfigurálhatja az APM-et. Az alábbi táblázat a VMware Spring Cloud Gateway által biztosított öt APM Java-ügynöktípust és a szükséges környezeti változókat sorolja fel.

Java-ügynök	Szükséges környezeti változók
Application Insights	APPLICATIONINSIGHTS_CONNECTION_STRING
Dynatrace	DT_TENANT DT_TENANTTOKEN DT_CONNECTION_POINT
New Relic	NEW_RELIC_LICENSE_KEY NEW_RELIC_APP_NAME
AppDynamics	APPDYNAMICS_AGENT_APPLICATION_NAME APPDYNAMICS_AGENT_TIER_NAME APPDYNAMICS_AGENT_NODE_NAME APPDYNAMICS_AGENT_ACCOUNT_NAME APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY APPDYNAMICS_CONTROLLER_HOST_NAME APPDYNAMICS_CONTROLLER_SSL_ENABLED APPDYNAMICS_CONTROLLER_PORT
Rugalmas APM	ELASTIC_APM_SERVICE_NAME ELASTIC_APM_APPLICATION_PACKAGES ELASTIC_APM_SERVER_URL

Egyéb támogatott környezeti változókért tekintse meg a következő forrásokat:

• Alkalmazás Elemzések áttekintése
• Dynatrace környezeti változók
• Új Relic környezeti változók
• AppDynamics környezeti változók
• Rugalmas környezeti változók

Az APM-integráció konfigurálása a szolgáltatáspéldány szintjén (ajánlott)

Ha engedélyezni szeretné az APM-monitorozást a VMware Spring Cloud Gatewayben, létrehozhat egy APM-konfigurációt a szolgáltatáspéldány szintjén, és a Spring Cloud Gatewayhez kötheti. Ily módon kényelmesen konfigurálhatja az APM-et csak egyszer, és ugyanazt az APM-et a Spring Cloud Gatewayhez és az alkalmazásokhoz kötheti.

Azure Portal

Az APM azure portalon történő beállításához kövesse az alábbi lépéseket:

1. Konfigurálja az APM-t a szolgáltatáspéldány szintjén az APM nevével, típusával és tulajdonságaival. További információkért tekintse meg az APM-integráció és a hitelesítésszolgáltatói tanúsítványok konfigurálásának szolgáltatáspéldány-szintű (ajánlott) szakaszában található APM-eket.

   

2. Válassza a Spring Cloud Gateway lehetőséget a navigációs panelen, majd válassza az APM lehetőséget.

3. Válassza ki az APM nevét az APM-referencianevek listájában. A lista tartalmazza az 1. lépésben konfigurált összes APM-nevet.

4. Válassza a Mentés lehetőséget, ha az APM-referencianeveket a Spring Cloud Gatewayhez szeretné kötni. Az átjáró újraindul az APM monitorozásának engedélyezéséhez.

Azure CLI

Az alábbi lépésekkel állíthatja be az APM-t a Spring Cloud Gatewayben az Azure CLI használatával:

1. Konfigurálja az APM-t a szolgáltatáspéldány szintjén az APM nevével, típusával és tulajdonságaival. További információkért tekintse meg az APM-integráció és a hitelesítésszolgáltatói tanúsítványok konfigurálásának szolgáltatáspéldány-szintű (ajánlott) szakaszában található APM-eket.

2. Az átjáró APM-hivatkozásnevekkel való frissítéséhez használja a következő parancsot:

   az spring gateway update \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --apms <APM-reference-name>
   

   Az érték --apms az APM-referencianevek szóközzel elválasztott listája, amelyet az 1. lépésben hozott létre.

   Feljegyzés

   A Spring Cloud Gateway elavult az APM-típusok esetében. Az APM-referencianevek használatával konfigurálhatja az APM-et egy átjáróban.

APM kezelése a VMware Spring Cloud Gatewayben (elavult)

Az Azure Portal vagy az Azure CLI használatával beállíthatja az APM-et a VMware Spring Cloud Gatewayben. Megadhatja a használni kívánt APM Java-ügynökök típusait és az általuk támogatott APM-környezeti változókat is.

Azure Portal

Az APM azure portalon történő beállításához kövesse az alábbi lépéseket:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen, majd válassza a Konfiguráció lehetőséget.
2. Az átjáró figyeléséhez válassza az APM típust az APM listában.
3. Töltse ki az APM környezeti változóihoz tartozó kulcs-érték párokat a Tulajdonságok és titkos kódok szakaszban. Bizalmas információkat tartalmazó változókat is elhelyezhet a Titkos kódokban.
4. Válassza a Mentés lehetőséget a módosítások mentéséhez.

A konfiguráció frissítése eltarthat néhány percig. A konfiguráció befejezésekor értesítést kell kapnia.

Azure CLI

Az APM beállításához használja az alábbi parancsot az Azure CLI használatával:

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 engedélyezett értékek a következőkApplicationInsights: --apm-types , AppDynamics, Dynatrace, NewRelicés ElasticAPM. Az alábbi parancs példaként az Alkalmazás Elemzések használatát mutatja be:

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

A környezeti változókat is elhelyezheti a paraméterben ahelyett--properties, hogy a --secrets . Ez biztonságosabbá teszi a környezeti változót a hálózati átvitelben és az adattárolásban a háttérrendszerben.

Feljegyzés

Az Azure Spring Apps ugyanolyan ütemben frissíti az APM-ügynököt és az üzembe helyezett alkalmazásokat, hogy az ügynökök kompatibilitása megmaradjon a VMware Spring Cloud Gateway és az Azure Spring Apps között.

Alapértelmezés szerint az Azure Spring Apps kinyomtatja az APM Java-ügynök STDOUTnaplóit. Ezek a naplók a VMware Spring Cloud Gateway-naplók részét képezik. A naplókban használt APM-ügynök verzióját ellenőrizheti. Ezeket a naplókat a Log Analyticsben kérdezheti le a hibaelhárításhoz.

Az APM-ügynökök megfelelő működéséhez növelje a VMware Spring Cloud Gateway processzorát és memóriáját.

Naplószintek konfigurálása

A VMware Spring Cloud Gateway naplószintjeit a következő módokon konfigurálhatja további részletek lekéréséhez vagy a naplók csökkentéséhez:

• A naplószinteket a következőre TRACEállíthatja be: , DEBUG, INFO, WARN, ERRORvagy OFF. A VMware Spring Cloud Gateway alapértelmezett naplószintje a .INFO
• A naplók kikapcsolásához állítsa be a naplószinteket a következőre OFF: .
• Ha a naplószint WARNbeállítása , ERRORvagy OFF, akkor előfordulhat, hogy INFO módosítania kell, amikor támogatást kér az Azure Spring Apps csapatától. Ez a változás a VMware Spring Cloud Gateway újraindítását okozza.
• Ha a naplószint értéke TRACE vagy DEBUGértéke, az befolyásolhatja a VMware Spring Cloud Gateway teljesítményét. Próbálja elkerülni ezeket a beállításokat az éles környezetben.
• Beállíthat naplószinteket a root naplózóhoz vagy adott naplózókhoz, például io.pivotal.spring.cloud.gateway.

A következő naplózók értékes hibaelhárítási információkat tartalmazhatnak a szinteken és DEBUG szintekenTRACE:

Tuskózó	Leírás
io.pivotal.spring.cloud.gateway	Szűrők és predikátumok, beleértve az egyéni bővítményeket is
org.springframework.cloud.gateway	API-átjáró
org.springframework.http.server.reactive	HTTP-kiszolgáló interakciói
org.springframework.web.reactive	API-átjáró reaktív folyamatai
org.springframework.boot.autoconfigure.web	API-átjáró automatikus konfigurálása
org.springframework.security.web	Hitelesítési és engedélyezési információk
reactor.netty	Reactor Netty

Környezeti változókulcsok lekéréséhez adja hozzá az logging.level. előtagot, majd állítsa be a naplószintet a környezet logging.level.{loggerName}={logLevel}konfigurálásával. Az alábbi példák az Azure Portal és az Azure CLI lépéseit mutatják be.

Azure Portal

A naplószintek Azure Portalon való konfigurálásához kövesse az alábbi lépéseket:

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen, majd válassza a Konfiguráció lehetőséget.
2. Töltse ki a naplószintek környezeti változóinak kulcs-érték párjait a Tulajdonságok és titkos kódok szakaszban. Ha a naplószint bizalmas információ az ön esetében, a Titkos kulcsok szakasz használatával is felveheti.
3. Válassza a Mentés lehetőséget a módosítások mentéséhez.

Azure CLI

A környezeti változók megadására szolgáló általános PARANCSSOR-parancsért lásd a Környezeti változók konfigurálása szakaszt . Az alábbi példa bemutatja, hogyan konfigurálhatja a naplószinteket az Azure CLI használatával:

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

Ha a naplószint bizalmas információ az ön esetében, a paraméterrel is felveheti.--secrets

Bővítménykonfiguráció frissítése

A bővítménykonfigurációs funkció lehetővé teszi a VMware Spring Cloud Gateway bizonyos tulajdonságainak JSON formátumú sztring használatával történő testreszabását. Ez a funkció akkor hasznos, ha olyan tulajdonságokat kell konfigurálnia, amelyek nem jelennek meg a REST API-val.

A bővítménykonfiguráció egy olyan JSON-objektum, amelynek kulcs-érték párjai a kívánt konfigurációt képviselik. Az alábbi példa a JSON formátum szerkezetét mutatja be:

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

Az alábbi listában a bővítménykulcsok neveihez és értéktípusaihoz támogatott bővítménykonfigurációk láthatók. Ez a lista változhat a VMware Spring Cloud Gateway verziójának frissítése során.

• Egyszeri bejelentkezés konfigurálása:

  • Kulcs neve: sso

  • Érték típusa: Objektum

  • Tulajdonságok:

    • RolesAttributeName (Sztring): Az SSO-munkamenethez társított szerepköröket tartalmazó attribútum nevét adja meg.
    • InactiveSessionExpirationInMinutes (Egész szám): Az inaktív SSO-munkamenetek lejárati idejét adja meg percben. Az érték azt 0 jelenti, hogy a munkamenet soha nem jár le.

  • Példa:

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

• Metaadatok konfigurálása:

  • Kulcs neve: api

  • Érték típusa: Objektum

  • Tulajdonságok

    • groupId (Sztring): A VMware Spring Cloud Gateway-példányon elérhető API-k csoportjának egyedi azonosítója. Az érték csak kisbetűket és számokat tartalmazhat.

  • Példa:

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

A bővítménykonfiguráció frissítéséhez kövesse az alábbi lépéseket.

Azure Portal

1. Az Azure Spring Apps-példányban válassza a Spring Cloud Gatewayt a navigációs panelen, majd válassza a Konfiguráció lehetőséget.
2. Adja meg az Addon Configs JSON-értékét.
3. Válassza a Mentés lehetőséget.

Azure CLI

1. Készítse elő a JSON-fájlt a bővítménykonfigurációkhoz (<file-name-of-addon-configs-json>.json) a következő tartalommal:

   {
       "sso": {
           "rolesAttributeName": "roles",
           "inactiveSessionExpirationInMinutes": 1
       },
       "api": {
           "groupId": "id1"
       }
   }
   

2. A következő paranccsal frissítse a VMware Spring Cloud Gateway bővítménykonfigurációit:

   az spring gateway update \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --addon-configs-file <file-name-of-addon-configs-json>.json
   

Következő lépések

• A Spring Cloud Gateway használata