Sdílet prostřednictvím

Konfigurace brány VMware Spring Cloud

  • Článek

Poznámka:

Plány Basic, Standard a Enterprise budou od poloviny března 2025 vyřazeny ze 3letého období vyřazení. Doporučujeme přejít na Azure Container Apps. Další informace najdete v oznámení o vyřazení Azure Spring Apps.

Od 30. září 2024 bude od 30. září 2024 zastaralý plán s úplným vypnutím po šesti měsících. Doporučujeme přejít na Azure Container Apps. Další informace najdete v tématu Migrace spotřeby Azure Spring Apps Úrovně Standard a vyhrazeného plánu do Azure Container Apps.

Tento článek se vztahuje na: ❎ Basic/Standard ✅ Enterprise

V tomto článku se dozvíte, jak nakonfigurovat bránu VMware Spring Cloud pro VMware Tanzu s plánem Azure Spring Apps Enterprise.

Brána VMware Spring Cloud je komerční komponenta VMware Tanzu založená na opensourcovém projektu brány Spring Cloud. Brána VMware Spring Cloud pro Tanzu zpracovává průřezové otázky pro vývojové týmy rozhraní API, jako je jednotné přihlašování (SSO), řízení přístupu, omezování rychlosti, odolnost a zabezpečení. Doručování rozhraní API můžete urychlit pomocí moderních vzorů nativních pro cloud ve vašem výběru programovacího jazyka pro vývoj rozhraní API.

Instance brány VMware Spring Cloud směruje provoz podle pravidel. Podporuje horizontální navýšení nebo snížení kapacity, aby splňovalo dynamické zatížení provozu.

Brána VMware Spring Cloud zahrnuje následující funkce:

  • Konfigurace dynamického směrování nezávislá na jednotlivých aplikacích, které můžete použít a změnit bez rekompilování
  • Filtry tras komerčního rozhraní API pro přenos autorizovaných deklarací identity webového tokenu JSON (JWT) do aplikačních služeb
  • Autorizace klientského certifikátu
  • Přístupy k omezování rychlosti
  • Konfigurace jističe
  • Podpora přístupu k aplikačním službám prostřednictvím přihlašovacích údajů základního ověřování HTTP

Pokud se chcete integrovat s portálem API pro VMware Tanzu, brána VMware Spring Cloud automaticky vygeneruje dokumentaci OpenAPI verze 3 po přidání nebo změnách konfigurace směrování. Další informace najdete v tématu Použití portálu API pro VMware Tanzu.

Požadavky

Povolení nebo zakázání brány VMware Spring Cloud

Bránu VMware Spring Cloud můžete povolit nebo zakázat po vytvoření instance služby pomocí webu Azure Portal nebo Azure CLI. Před zakázání brány VMware Spring Cloud musíte zrušit přiřazení koncového bodu a odebrat všechny konfigurace tras.

Pomocí následujících kroků povolte nebo zakažte bránu VMware Spring Cloud pomocí webu Azure Portal:

  1. Přejděte k prostředku služby a pak vyberte Bránu Spring Cloud.
  2. Vyberte položku Spravovat.
  3. Zaškrtněte políčko Povolit bránu Spring Cloud nebo jeho zaškrtnutí zrušte a pak vyberte Uložit.

Stav brány Spring Cloud teď můžete zobrazit na stránce Brána Spring Cloud.

Snímek obrazovky webu Azure Portal se stránkou Brány Spring Cloud

Restartování brány VMware Spring Cloud

Po dokončení akce restartování se instance brány VMware Spring Cloud postupně restartují.

Pomocí následujících kroků restartujte bránu VMware Spring Cloud pomocí webu Azure Portal:

  1. Přejděte k prostředku služby a pak vyberte Bránu Spring Cloud.
  2. Vyberte Restartovat.
  3. Kliknutím na TLAČÍTKO OK potvrďte restartování.

Snímek obrazovky webu Azure Portal zobrazující stránku brány Spring Cloud s potvrzovací zprávou o restartování brány

Přiřazení veřejného koncového bodu ke službě VMware Spring Cloud Gateway

Tato část popisuje, jak přiřadit veřejný koncový bod bráně VMware Spring Cloud a nakonfigurovat její vlastnosti.

Pokud chcete přiřadit koncový bod na webu Azure Portal, postupujte následovně:

  1. Otevřete instanci Azure Spring Apps.
  2. V navigačním podokně vyberte Bránu Spring Cloud a pak vyberte Přehled.
  3. Nastavte možnost Přiřadit koncový bod na Hodnotu Ano.

Po několika minutách se v adrese URL zobrazí nakonfigurovaná adresa URL koncového bodu. Uložte adresu URL, abyste ji mohli použít později.

Snímek obrazovky webu Azure Portal zobrazující stránku přehledu brány Spring Cloud s přepínačem pro přiřazení koncového bodu

Konfigurace metadat brány VMware Spring Cloud

Metadata služby VMware Spring Cloud Gateway automaticky generují dokumentaci OpenAPI verze 3. Metadata brány VMware Spring Cloud můžete nakonfigurovat tak, aby zobrazovala skupiny tras na portálu API pro VMware Tanzu. Další informace najdete v tématu Použití portálu API pro VMware Tanzu.

Následující tabulka popisuje dostupné možnosti metadat:

Vlastnost Popis
title Název, který popisuje kontext rozhraní API dostupných v instanci brány VMware Spring Cloud. Výchozí hodnota je Spring Cloud Gateway for K8S.
description Podrobný popis rozhraní API dostupných v instanci brány VMware Spring Cloud. Výchozí hodnota je Generated OpenAPI 3 document that describes the API routes configured for '[Gateway instance name]' Spring Cloud Gateway instance deployed under '[namespace]' namespace.*.
documentation Umístění dokumentace k rozhraní API, která je k dispozici v instanci brány VMware Spring Cloud.
version Verze rozhraní API dostupná v této instanci brány VMware Spring Cloud. Výchozí hodnota je unspecified.
serverUrl Základní adresa URL pro přístup k rozhraním API v instanci brány VMware Spring Cloud. Tato vlastnost je povinná, pokud chcete integrovat s portálem api.

K úpravě vlastností metadat můžete použít Azure Portal nebo Azure CLI.

Pokud chcete upravit metadata na webu Azure Portal, postupujte následovně:

  1. Otevřete instanci Azure Spring Apps.
  2. V navigačním podokně vyberte Bránu Spring Cloud a pak vyberte Konfigurace.
  3. Zadejte hodnoty vlastností uvedených pro rozhraní API.
  4. Zvolte Uložit.

Snímek obrazovky webu Azure Portal znázorňující kartu konfigurace brány Spring Cloud se zvýrazněnou částí rozhraní API

Konfigurace jednotného přihlašování

Brána VMware Spring Cloud podporuje ověřování a autorizaci prostřednictvím jednotného přihlašování (SSO) s zprostředkovatelem identity OpenID. Zprostředkovatel podporuje protokol OpenID Connect Discovery. Následující tabulka popisuje vlastnosti jednotného přihlašování:

Vlastnost Povinný? Popis
issuerUri Ano Identifikátor URI, který se používá jako identifikátor vystavitele. Pokud issuerUri je https://example.comnapříklad , požadavek na konfiguraci zprostředkovatele OpenID je proveden na https://example.com/.well-known/openid-configuration. Očekává se, že výsledkem bude odpověď na konfiguraci zprostředkovatele OpenID.
clientId Ano ID klienta OpenID Connect od zprostředkovatele identity.
clientSecret Ano Tajný klíč klienta OpenID Connect od zprostředkovatele identity.
scope Ano Seznam oborů, které se mají zahrnout do tokenů identit JWT. Tento seznam by měl vycházet z rozsahů, které váš zprostředkovatel identity umožňuje.

Pokud chcete nastavit jednotné přihlašování s ID Microsoft Entra, přečtěte si téma Nastavení jednotného přihlašování pomocí ID Microsoft Entra pro bránu Spring Cloud a portál rozhraní API.

Vlastnosti jednotného přihlašování můžete upravit pomocí webu Azure Portal nebo Azure CLI.

Pokud chcete upravit vlastnosti jednotného přihlašování na webu Azure Portal, postupujte následovně:

  1. Otevřete instanci Azure Spring Apps.
  2. V navigačním podokně vyberte Bránu Spring Cloud a pak vyberte Konfigurace.
  3. Zadejte hodnoty vlastností uvedených pro jednotné přihlašování.
  4. Zvolte Uložit.

Snímek obrazovky webu Azure Portal zobrazující kartu konfigurace brány Spring Cloud se zvýrazněnou částí pro jednotné přihlašování

Brána VMware Spring Cloud podporuje pouze autorizační servery, které podporují protokol OpenID Connect Discovery. Nezapomeňte také nakonfigurovat externí autorizační server tak, aby umožňoval přesměrování zpět do brány. Projděte si dokumentaci k autorizačnímu serveru a přidejte https://<gateway-external-url>/login/oauth2/code/sso je do seznamu povolených identifikátorů URI přesměrování.

Pokud nakonfigurujete nesprávnou vlastnost jednotného přihlašování, například nesprávné heslo, měli byste odebrat celou vlastnost jednotného přihlašování a pak přidat správnou konfiguraci.

Po konfiguraci jednotného přihlašování nezapomeňte nastavit ssoEnabled: true trasy brány VMware Spring Cloud.

Konfigurace odhlášení jednotného přihlašování

Instance služby VMware Spring Cloud Gateway poskytují výchozí koncový bod rozhraní API pro odhlášení z aktuální relace jednotného přihlašování. Cesta k tomuto koncovému bodu je /scg-logout. Výsledkem odhlášení je jeden z následujících výsledků v závislosti na tom, jak voláte koncový bod odhlášení:

  • Odhlaste se z relace a přesměrujte na odhlášení zprostředkovatele identity (IdP).
  • Odhlaste se z relace instance služby.

Odhlaste se zprostředkovatele identity a relace jednotného přihlašování

Pokud odešlete GET požadavek do koncového /scg-logout bodu, koncový bod odešle 302 odpověď přesměrování na adresu URL odhlášení zprostředkovatele identity. Pokud chcete získat koncový bod pro vrácení uživatele do cesty v instanci služby brány, přidejte do GET požadavku parametr přesměrování s /scg-logout koncovým bodem. Můžete použít třeba ${server-url}/scg-logout?redirect=/home.

Hodnota parametru redirect musí být platná cesta k instanci služby VMware Spring Cloud Gateway. Nemůžete přesměrovat na externí adresu URL.

Následující kroky popisují příklad implementace funkce v mikroslužbách:

  1. Získejte konfiguraci trasy pro směrování žádosti o odhlášení do vaší aplikace. Příklad najdete v konfiguraci trasy v úložišti animal-rescue na GitHubu.

  2. Přidejte do aplikace libovolnou logiku odhlášení, kterou potřebujete. Na konci potřebujete GET požadavek na koncový bod brány /scg-logout , jak je znázorněno v return hodnotě getActionButton metody v úložišti pro záchranu zvířat.

Odhlaste se jenom z relace jednotného přihlašování

Pokud odešlete GET požadavek do koncového /scg-logout bodu pomocí XMLHttpRequest, 302 přesměrování může být spolknuto a nezpracováno v obslužné rutině odpovědi. V takovém případě by se uživatel odhlásil pouze z relace jednotného přihlašování v instanci služby brány VMware Spring Cloud. Uživatel bude mít stále platnou relaci zprostředkovatele identity. Pokud se uživatel obvykle pokusí znovu přihlásit, automaticky se odešle zpět do brány jako ověřený z zprostředkovatele identity.

Ke směrování žádosti o odhlášení do aplikace potřebujete konfiguraci trasy, jak je znázorněno v následujícím příkladu. Tento kód vytvoří relaci jednotného přihlašování jen pro bránu.

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

Konfigurace sdílení prostředků mezi zdroji

Sdílení prostředků mezi zdroji (CORS) umožňuje vyžádat omezené prostředky na webové stránce z jiné domény mimo doménu, ze které byl první prostředek obsluhován. Následující tabulka popisuje dostupné možnosti konfigurace CORS.

Vlastnost Popis
allowedOrigins Povolené zdroje pro provádění požadavků mezi weby
allowedOriginPatterns Povolené vzory původu pro vytváření požadavků mezi weby
allowedMethods Povolené metody HTTP na požadavcích mezi weby
allowedHeaders Povolené hlavičky v požadavcích mezi weby
maxAge Jak dlouho klienti v sekundách ukládají odpověď z předběžného požadavku do mezipaměti
allowCredentials Určuje, jestli se přihlašovací údaje uživatele podporují u požadavků mezi weby.
exposedHeaders Hlavičky odpovědi HTTP, které se zpřístupňují pro požadavky mezi weby

Pokud chcete integrovat s portálem API, ujistěte se, že máte správnou konfiguraci CORS. Další informace najdete v části Přiřazení veřejného koncového bodu ke službě VMware Spring Cloud Gateway .

Použití škálování služby

Přidělení prostředků pro instance brány VMware Spring Cloud můžete přizpůsobit, včetně počtu vCPU, paměti a instancí.

Pro zajištění vysoké dostupnosti nedoporučujeme používat jednu repliku.

Následující tabulka popisuje výchozí využití prostředků.

Název komponenty Počet instancí vCPU na instanci Paměť na instanci
Brána VMware Spring Cloud 2 1 jádro 2 GiB
Operátor brány VMware Spring Cloud 2 1 jádro 2 GiB

Konfigurace protokolu TLS mezi bránou a aplikacemi

Pokud chcete zvýšit zabezpečení a chránit citlivé informace před zachycením neoprávněnými stranami, můžete povolit protokol TLS (Transport Layer Security) mezi bránou VMware Spring Cloud a vašimi aplikacemi.

Před konfigurací protokolu TLS musíte mít aplikaci s povoleným protokolem TLS a certifikát TLS. Pokud chcete připravit certifikát TLS, vygenerujte certifikát od důvěryhodné certifikační autority (CA). Certifikát ověří identitu serveru a vytvoří zabezpečené připojení.

Jakmile máte aplikaci s povoleným protokolem TLS spuštěnou v Azure Spring Apps, nahrajte certifikát do Azure Spring Apps. Další informace najdete v části Import certifikátu použití certifikátů TLS/SSL ve vaší aplikaci ve službě Azure Spring Apps.

Když je certifikát aktualizovaný na Azure Spring Apps, můžete nakonfigurovat certifikát TLS pro bránu a povolit ověření certifikátu. Certifikát můžete nakonfigurovat na webu Azure Portal nebo pomocí Azure CLI.

Pomocí následujících kroků nakonfigurujte certifikát na webu Azure Portal:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud.
  2. Na stránce Brány Spring Cloud vyberte Správa certifikátů.
  3. Vyberte Povolit ověření certifikátu.
  4. Vyberte certifikát TLS v certifikátech.
  5. Zvolte Uložit.

Aktualizace konfigurace může trvat několik minut. Po dokončení konfigurace byste měli dostat oznámení.

Příprava konfigurace trasy

Protokol musíte zadat jako HTTPS v konfiguraci trasy. Následující objekt JSON dává bráně VMware Spring Cloud pokyn, aby pro veškerý provoz mezi bránou a aplikací používal protokol HTTPS.

  1. Vytvořte soubor s názvem test-tls-route.json s následujícím obsahem:

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

  2. Pomocí následujícího příkazu použijte pravidlo pro aplikaci:

    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

Teď můžete otestovat, jestli je aplikace povolená pomocí koncového bodu brány. Další informace najdete v části Konfigurace tras brány Spring Cloud.

Rotace certifikátů

Jakmile vyprší platnost certifikátů, musíte certifikáty ve službě VMware Spring Cloud Gateway obměňovat pomocí následujících kroků:

  1. Vygenerujte nové certifikáty z důvěryhodné certifikační autority.
  2. Importujte certifikáty do Azure Spring Apps. Další informace najdete v části Import certifikátu použití certifikátů TLS/SSL ve vaší aplikaci ve službě Azure Spring Apps.
  3. Synchronizujte certifikáty pomocí webu Azure Portal nebo Azure CLI.

Brána Spring Cloud VMware se restartuje, aby se zajistilo, že brána používá nový certifikát pro všechna připojení.

K synchronizaci certifikátů použijte následující postup:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud.
  2. Na stránce Brána Spring Cloud vyberte Restartovat a potvrďte operaci.

Nastavení automatického škálování

Režimy automatického škálování můžete nastavit pro bránu VMware Spring Cloud.

Následující seznam obsahuje možnosti, které jsou k dispozici pro správu poptávky automatického škálování:

  • Možnost Ruční škálování udržuje pevný počet instancí. Kapacitu můžete škálovat na maximálně 10 instancí. Tato hodnota změní počet samostatných spuštěných instancí brány Spring Cloud.
  • Možnost Vlastní automatické škálování se škáluje podle libovolného plánu na základě libovolných metrik.

Na webu Azure Portal zvolte, jak chcete škálovat. Následující snímek obrazovky ukazuje možnost Vlastní automatické škálování a nastavení režimu:

Snímek obrazovky webu Azure Portal se stránkou nastavení automatického škálování se zvýrazněnou možností Vlastní automatické škálování

Další informace o dostupnýchmetrikch

Konfigurace mezipaměti odpovědí

Konfigurace mezipaměti odpovědí poskytuje způsob, jak definovat mezipaměť odpovědí HTTP, kterou můžete použít globálně nebo na úrovni trasy.

Globální povolení mezipaměti odpovědí

Po povolení globální mezipaměti odpovědí se mezipaměť odpovědí automaticky povolí pro všechny příslušné trasy.

Globální povolení mezipaměti odpovědí pomocí následujících kroků:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud.
  2. Na stránce Brána Spring Cloud vyberte Konfigurace.
  3. V části Mezipaměť odpovědí vyberte Povolit mezipaměť odpovědí a pak nastavte Obor na instanci.
  4. Nastavte velikost a čas pro mezipaměť odpovědí.
  5. Zvolte Uložit.

Pomocí následujících kroků zakažte mezipaměť odpovědí:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud.
  2. Na stránce Brána Spring Cloud vyberte Konfigurace.
  3. V části Mezipaměť odpovědí zrušte zaškrtnutí políčka Povolit mezipaměť odpovědí.
  4. Zvolte Uložit.

Povolení mezipaměti odpovědí na úrovni trasy

Pokud chcete povolit mezipaměť odpovědí pro libovolnou trasu LocalResponseCache , použijte filtr. Následující příklad ukazuje, jak použít LocalResponseCache filtr v konfiguraci pravidla směrování:

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

Další informace najdete v části LocalResponseCache v tématu Použití filtrů tras brány VMware Spring Cloud s plánem Azure Spring Apps Enterprise a LocalResponseCache v dokumentaci k VMware.

Místo konfigurace size a timeToLive jednotlivých LocalResponseCache filtrů můžete tyto parametry nastavit na úrovni brány Spring Cloud. Tato možnost umožňuje použít LocalResponseCache filtr bez počátečního zadání těchto hodnot a zároveň zachovat flexibilitu pro pozdější přepsání.

Pomocí následujících kroků povolte mezipaměť odpovědí na úrovni trasy a nastavte size a timeToLive:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud.
  2. Na stránce Brána Spring Cloud vyberte Konfigurace.
  3. V části Mezipaměť odpovědí vyberte Povolit mezipaměť odpovědí a pak nastavte Obor na trasu.
  4. Nastavte velikost a čas pro mezipaměť odpovědí.
  5. Zvolte Uložit.

Pomocí následujících kroků zakažte mezipaměť odpovědí na úrovni trasy, která vymaže size a timeToLive:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud.
  2. Na stránce Brána Spring Cloud vyberte Konfigurace.
  3. V části Mezipaměť odpovědí zrušte zaškrtnutí políčka Povolit mezipaměť odpovědí.
  4. Zvolte Uložit.

Následující příklad ukazuje, jak použít LocalResponseCache filtr, když size a timeToLive jsou nastaveny na úrovni brány Spring Cloud:

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

Konfigurace proměnných prostředí

Služba Azure Spring Apps spravuje a tunes brány VMware Spring Cloud. S výjimkou případů použití, které konfigurují monitorování výkonu aplikací (APM) a úroveň protokolu, obvykle nemusíte konfigurovat bránu VMware Spring Cloud s proměnnými prostředí.

Pokud máte požadavky, které nemůžete splnit jinými konfiguracemi popsanými v tomto článku, můžete zkusit nakonfigurovat proměnné prostředí zobrazené v seznamu společných vlastností aplikace. Před použitím konfigurace v produkčním prostředí nezapomeňte ověřit konfiguraci v testovacím prostředí.

Pokud chcete konfigurovat proměnné prostředí na webu Azure Portal, postupujte následovně:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud a pak vyberte Konfigurace.
  2. Vyplňte páry klíč/hodnota pro proměnné prostředí v částech Vlastnosti a Tajné kódy. Do části Tajné kódy můžete zahrnout proměnné s citlivými informacemi.
  3. Výběrem možnosti Uložit uložte změny.

Po aktualizaci proměnných prostředí se brána VMware Spring Cloud restartuje.

Konfigurace monitorování výkonu aplikací

Pokud chcete monitorovat bránu VMware Spring Cloud, můžete nakonfigurovat APM. Následující tabulka uvádí pět typů agentů APM Java, které poskytuje brána VMware Spring Cloud, spolu s jejich požadovanými proměnnými prostředí.

Agent Java Požadované proměnné prostředí
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
Elastický APM ELASTIC_APM_SERVICE_NAME
ELASTIC_APM_APPLICATION_PACKAGES
ELASTIC_APM_SERVER_URL

Další podporované proměnné prostředí najdete v následujících zdrojích:

Pokud chcete povolit monitorování APM ve vaší bráně VMware Spring Cloud, můžete vytvořit konfiguraci APM na úrovni instance služby a svázat ji s bránou Spring Cloud. Tímto způsobem můžete pohodlně nakonfigurovat APM pouze jednou a svázat stejné APM s bránou Spring Cloud a vašimi aplikacemi.

Pomocí následujících kroků nastavte APM pomocí webu Azure Portal:

  1. Nakonfigurujte APM na úrovni instance služby s názvem APM, typem a vlastnostmi. Další informace najdete v části Správa apM na úrovni instance služby (doporučeno) v tématu Konfigurace integrace APM a certifikátů ca.

    Snímek obrazovky webu Azure Portal se stránkou editoru APM pro Azure Spring Apps

  2. V navigačním podokně vyberte Bránu Spring Cloud a pak vyberte APM.

  3. V seznamu referenčních názvů APM zvolte název APM. Seznam obsahuje všechny názvy APM nakonfigurované v kroku 1.

  4. Výběrem možnosti Uložit svážete referenční názvy APM s bránou Spring Cloud. Brána se restartuje, aby se povolilo monitorování APM.

Správa APM v bráně Spring Cloud VMware (zastaralé)

K nastavení APM ve službě VMware Spring Cloud Gateway můžete použít Azure Portal nebo Azure CLI. Můžete také zadat typy agentů APM Java, které se mají použít, a odpovídající proměnné prostředí APM, které podporují.

Pomocí následujících kroků nastavte APM pomocí webu Azure Portal:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud a pak vyberte Konfigurace.
  2. Zvolte typ APM v seznamu APM a monitorujte bránu.
  3. V částech Vlastnosti a tajné kódy vyplňte páry klíč/hodnota proměnných prostředí APM. Proměnné s citlivými informacemi můžete vložit do tajných kódů.
  4. Výběrem možnosti Uložit uložte změny.

Aktualizace konfigurace může trvat několik minut. Po dokončení konfigurace byste měli dostat oznámení.

Poznámka:

Azure Spring Apps upgraduje agenta APM a nasazené aplikace se stejným tempem, aby se zachovala kompatibilita agentů mezi službou VMware Spring Cloud Gateway a Azure Spring Apps.

Azure Spring Apps ve výchozím nastavení vytiskne protokoly agenta APM Java do STDOUT. Tyto protokoly jsou součástí protokolů brány VMware Spring Cloud. V protokolech můžete zkontrolovat verzi agenta APM. Pokud chcete řešit potíže, můžete se na tyto protokoly v Log Analytics dotazovat.

Pokud chcete, aby agenti APM správně fungovali, zvyšte využití procesoru a paměti brány VMware Spring Cloud.

Konfigurace úrovní protokolu

Úrovně protokolů brány VMware Spring Cloud můžete nakonfigurovat následujícími způsoby, abyste získali další podrobnosti nebo omezili protokoly:

  • Úrovně protokolu můžete nastavit na TRACE, DEBUG, INFO, WARN, , ERRORnebo OFF. Výchozí úroveň protokolu pro bránu VMware Spring Cloud je INFO.
  • Protokoly můžete vypnout nastavením úrovní protokolu na OFF.
  • Pokud je úroveň protokolu nastavená na WARNhodnotu , ERRORnebo OFF, může být nutné ji INFO upravit při žádosti o podporu od týmu Azure Spring Apps. Tato změna způsobí restartování brány VMware Spring Cloud.
  • Pokud je úroveň protokolu nastavená TRACE na nebo DEBUG, může mít vliv na výkon brány VMware Spring Cloud. Zkuste se těmto nastavením vyhnout v produkčním prostředí.
  • Můžete nastavit úrovně protokolu pro root protokolovací nástroje nebo pro konkrétní protokolovací nástroje, jako je io.pivotal.spring.cloud.gateway.

Následující protokolovací nástroje můžou obsahovat cenné informace o řešení potíží na TRACE těchto úrovních DEBUG :

Dřevorubec Popis
io.pivotal.spring.cloud.gateway Filtry a predikáty, včetně vlastních rozšíření
org.springframework.cloud.gateway Brána rozhraní API
org.springframework.http.server.reactive Interakce serveru HTTP
org.springframework.web.reactive Neaktivní toky brány rozhraní API
org.springframework.boot.autoconfigure.web Automatická konfigurace brány rozhraní API
org.springframework.security.web Informace o ověřování a autorizaci
reactor.netty Reactor Netty

Pokud chcete získat klíče proměnných prostředí, přidejte předponu logging.level. a potom nastavte úroveň protokolu konfigurací prostředí logging.level.{loggerName}={logLevel}. Následující příklady ukazují kroky pro Azure Portal a Azure CLI.

Pokud chcete nakonfigurovat úrovně protokolů na webu Azure Portal, postupujte následovně:

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud a pak vyberte Konfigurace.
  2. V částech Vlastnosti a tajné kódy vyplňte páry klíč/hodnota proměnných prostředí úrovně protokolu. Pokud je úroveň protokolu v případě citlivých informací, můžete ji zahrnout pomocí části Tajné kódy .
  3. Výběrem možnosti Uložit uložte změny.

Snímek obrazovky webu Azure Portal znázorňující proměnné prostředí Spring Cloud Gateway pro konfiguraci úrovní protokolů

Aktualizace konfigurace doplňku

Funkce konfigurace doplňku umožňuje přizpůsobit určité vlastnosti brány VMware Spring Cloud pomocí řetězce formátu JSON. Tato funkce je užitečná, když potřebujete nakonfigurovat vlastnosti, které nejsou vystavené prostřednictvím rozhraní REST API.

Konfigurace doplňku je objekt JSON s páry klíč/hodnota, které představují požadovanou konfiguraci. Následující příklad ukazuje strukturu formátu JSON:

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

Následující seznam ukazuje podporované konfigurace doplňků pro názvy klíčů doplňku a typy hodnot. Tento seznam se může při upgradu verze brány VMware Spring Cloud změnit.

  • Konfigurace jednotného přihlašování:

    • Název klíče: sso

    • Typ hodnoty: Objekt

    • Vlastnosti:

      • RolesAttributeName (String): Určuje název atributu, který obsahuje role přidružené k relaci jednotného přihlašování.
      • InactiveSessionExpirationInMinutes (Celé číslo): Určuje dobu vypršení platnosti v minutách pro neaktivní relace jednotného přihlašování. Hodnota 0 znamená, že relace nikdy nevyprší.

    • Příklad:

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

  • Konfigurace metadat:

    • Název klíče: api

    • Typ hodnoty: Objekt

    • Vlastnosti

      • groupId (Řetězec): Jedinečný identifikátor pro skupinu rozhraní API, která jsou k dispozici v instanci brány VMware Spring Cloud. Hodnota může obsahovat pouze malá písmena a číslice.

    • Příklad:

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

  • Konfigurace podu

    • Název klíče: PodOverrides, který se používá k určení přepsání pro výchozí konfiguraci podu.

    • Typ hodnoty: Objekt

    • Vlastnosti

      • Containers: Toto pole obsahuje konfiguraci pro jednotlivé kontejnery v podu. Aktuálně se podporuje pouze kontejner s názvem gateway .
        • Name: Určuje název kontejneru. Kontejner by měl mít název gateway.
        • Lifecycle: PreStop je háček životního cyklu, který se spustí, když se kontejner chystá ukončit. Tento háček umožňuje provést jakékoli nezbytné vyčištění před zastavením kontejneru.
      • TerminationGracePeriodSeconds: Určuje dobu, po kterou Kubernetes čeká na ukončení podu před vynuceným ukončením.

    • Příklad:

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

      Když dojde k ukončení podu obsahujícího tento kontejner, PreStop spustí háček příkaz /bin/sh -c 'sleep 20', což způsobí, že kontejner bude spát po dobu 20 sekund. Toto pozastavení dává kontejneru čas na dokončení probíhajících úkolů nebo vyčištění před tím, než se skutečně zastaví.

      Nastavení TerminationGracePeriodSeconds poskytuje celkem 120 sekund, než se pod řádně ukončí, včetně času, který trvalo libovolným hákem životního cyklu, například PreStop.

Pomocí následujících kroků aktualizujte konfiguraci doplňku.

  1. V instanci Azure Spring Apps vyberte v navigačním podokně bránu Spring Cloud a pak vyberte Konfigurace.
  2. Zadejte hodnotu JSON pro konfigurace doplňků.
  3. Zvolte Uložit.

Další kroky