Dokumentacja: Ustawienia konfiguracji własnej bramy usługi Azure Arc

DOTYCZY: Developer | Premium

Ten artykuł zawiera informacje dotyczące wymaganych i opcjonalnych ustawień używanych do konfigurowania rozszerzenia usługi Azure Arc dla własnego kontenera bramy usługi API Management.

Ważne

Samoobsługowa brama usługi API Management w usłudze Azure Arc jest obecnie dostępna w wersji zapoznawczej. W wersji zapoznawczej rozszerzenie bramy usługi API Management jest dostępne w następujących regionach:

  • Azja (Wschód, Południowy Wschód)
  • Australia (Środkowa, Środkowa 2, Wschodnia i Południowo-Wschodnia)
  • Brazylia (Południowy i Południowy Wschód)
  • Kanada (Środkowa, Wschodnia)
  • Europa (Północ, Zachód)
  • Francja (Środkowa i Południowa)
  • Niemcy (północno-zachodnia)
  • Indie (Środkowe, Południowe, Zachodnie, Jio Central & Jio West)
  • Japonia (Wschód i Zachód)
  • Korea (Środkowa i Południowa)
  • Norwegia (Wschód i Zachód)
  • Republika Południowej Afryki (Północ i Zachód)
  • Szwecja (Środkowa)
  • Szwajcaria (Północ i Zachód)
  • Zjednoczone Emiraty Arabskie (ZJEDNOCZONE Emiraty Arabskie - Środkowe i Północne)
  • Zjednoczone Królestwo (Wielka Brytania -Południe)
  • Stany Zjednoczone (USA — Środkowe, Środkowe EUAP, Wschodnie, Wschodnie 2, Wschodnie 2 EUAP, Północno-środkowe, Południowo-środkowe, Zachodnio-środkowe, Zachodnie 2, Zachodnie 3)

Integracja interfejsu API konfiguracji

Interfejs API konfiguracji jest używany przez własną bramę do nawiązywania połączenia z usługą Azure API Management w celu uzyskania najnowszej konfiguracji i wysyłania metryk po włączeniu.

Oto omówienie wszystkich opcji konfiguracji:

Nazwa/nazwisko opis Wymagani Wartość domyślna
gateway.configuration.uri Punkt końcowy konfiguracji w usłudze Azure API Management dla własnej bramy. Znajdź tę wartość w witrynie Azure Portal w obszarze Wdrażanie bram>. Tak Nie dotyczy
gateway.auth.token Klucz uwierzytelniania do uwierzytelniania w usłudze Azure API Management. Zazwyczaj zaczyna się od GatewayKey. Tak Nie dotyczy
gateway.configuration.backup.enabled Jeśli ta opcja jest włączona, będzie przechowywać kopię zapasową najnowszej pobranej konfiguracji na woluminie magazynu false
gateway.configuration.backup.persistentVolumeClaim.accessMode Tryb dostępu dla zasobnika oświadczenia trwałego woluminu (PVC) ReadWriteMany
gateway.configuration.backup.persistentVolumeClaim.size Rozmiar oświadczenia trwałego woluminu (PVC) do utworzenia 50Mi
gateway.configuration.backup.persistentVolumeClaim.storageClassName Nazwa klasy magazynu do użycia dla oświadczenia trwałego woluminu (PVC). Jeśli żadna wartość nie zostanie przypisana (null), zostanie użyta wartość domyślna platformy. Określona klasa magazynu powinna obsługiwać ReadWriteMany tryb dostępu, dowiedz się więcej na temat obsługiwanych dostawców woluminów i obsługiwanych trybów dostępu. null

Odnajdywanie i synchronizacja między wystąpieniami

Nazwa/nazwisko opis Wymagani Wartość domyślna
service.instance.heartbeat.port Port UDP używany w przypadku wystąpień wdrożenia własnej bramy w celu wysyłania pulsów do innych wystąpień. Nie. 4291
service.instance.synchronization.port Port UDP używany na potrzeby wystąpień bramy self-hosted w celu synchronizacji ograniczania szybkości w wielu wystąpieniach. Nie. 4290

Metryki

Nazwa/nazwisko opis Wymagani Wartość domyślna
telemetry.metrics.cloud Wskazanie, czy włączyć emitowanie metryk do usługi Azure Monitor. Nie. true
telemetry.metrics.local Włącz zbieranie lokalnych metryk za pomocą funkcji StatsD. Wartość jest jedną z następujących opcji: none, statsd. Nie. Nie dotyczy
telemetry.metrics.localStatsd.endpoint Punkt końcowy StatsD. Tak, jeśli telemetry.metrics.local jest ustawiona na statsd; w przeciwnym razie nie. Nie dotyczy
telemetry.metrics.localStatsd.sampling Wskaźnik próbkowania metryk StatsD. Wartość musi należeć do zakresu od 0 do 1, na przykład 0,5. Nie. Nie dotyczy
telemetry.metrics.localStatsd.tagFormat Format tagowania eksportera StatsD. Wartość jest jedną z następujących opcji: ibrato, dogStatsD, influxDB. Nie. Nie dotyczy
telemetry.metrics.opentelemetry.enabled Wskazanie, czy włączyć emitowanie metryk do modułu zbierającego OpenTelemetry na platformie Kubernetes. Nie. false
telemetry.metrics.opentelemetry.collector.uri Identyfikator URI modułu zbierającego OpenTelemetry do wysyłania metryk. Tak, jeśli observability.opentelemetry.enabled jest ustawiona na true; w przeciwnym razie nie. Nie dotyczy

Dzienniki

Nazwa/nazwisko opis Wymagani Wartość domyślna
telemetry.logs.std Włącz rejestrowanie w standardowym strumieniu. Wartość jest jedną z następujących opcji: none, text, json. Nie. text
telemetry.logs.local Włącz rejestrowanie lokalne. Wartość jest jedną z następujących opcji: none, , autolocalsyslog, rfc5424, , , journaljson Nie. auto
telemetry.logs.localConfig.localsyslog.endpoint Punkt końcowy dla lokalnych dzienników systemu Tak, jeśli telemetry.logs.local jest ustawiona na localsyslog; w przeciwnym razie nie. Nie dotyczy
telemetry.logs.localConfig.localsyslog.facility Określa lokalny kod obiektu syslog, na przykład 7. Nie. Nie dotyczy
telemetry.logs.localConfig.rfc5424.endpoint punkt końcowy rfc5424. Tak, jeśli telemetry.logs.local jest ustawiona na rfc5424; w przeciwnym razie nie. Nie dotyczy
telemetry.logs.localConfig.rfc5424.facility Kod obiektu na rfc5424, na przykład 7 Nie. Nie dotyczy
telemetry.logs.localConfig.journal.endpoint Punkt końcowy dziennika. Tak, jeśli telemetry.logs.local jest ustawiona na journal; w przeciwnym razie nie. Nie dotyczy

Routing ruchu

Nazwa/nazwisko opis Wymagani Wartość domyślna
service.type Typ usługi Kubernetes, która ma być używana do uwidaczniania bramy. (docs) Nie. ClusterIP
service.http.port Port używany do uwidaczniania ruchu HTTP. Nie. 8080
service.http.nodePort Port w węźle, który ma być używany do uwidaczniania ruchu HTTP. NodePort Wymaga to typu usługi. Nie. Nie dotyczy
service.https.port Port używany do uwidaczniania ruchu HTTPS. Nie. 8081
service.https.nodePort Port w węźle, który ma być używany do uwidaczniania ruchu HTTPS. NodePort Wymaga to typu usługi. Nie. Nie dotyczy
service.annotations Adnotacje do dodania do usługi Kubernetes dla bramy. Nie. Nie dotyczy
ingress.annotations Adnotacje, które mają zostać dodane do ruchu przychodzącego Kubernetes dla bramy. (eksperymentalne) Nie. Nie dotyczy
ingress.enabled Określ, czy należy używać ruchu przychodzącego kubernetes. (eksperymentalne) Nie. false
ingress.tls Konfiguracja protokołu TLS dla ruchu przychodzącego Kubernetes. (eksperymentalne) Nie. Nie dotyczy
ingress.hosts Konfiguracja hostów do użycia dla ruchu przychodzącego Kubernetes. (eksperymentalne) Nie. Nie dotyczy

Integracje

Brama hostowana samodzielnie integruje się z różnymi innymi technologiami. Ta sekcja zawiera omówienie dostępnych opcji konfiguracji, których można użyć.

Dapr

Nazwa/nazwisko opis Wymagani Wartość domyślna
dapr.enabled Wskazanie, czy należy użyć integracji języka Dapr. Nie. false
dapr.app.id Identyfikator aplikacji do użycia na potrzeby integracji języka Dapr Brak
dapr.config Określa, której konfiguracji należy użyć języka DAPR konfiguracji tracing
dapr.logging.level Poziom szczegółowości dziennika przyczepki Dapr info
dapr.logging.useJsonOutput Wskazanie, czy rejestrowanie powinno mieć format JSON true

Azure Monitor

Nazwa/nazwisko opis Wymagani Wartość domyślna
monitoring.customResourceId Identyfikator zasobu obszaru roboczego usługi Azure Log Analytics do wysyłania dzienników. Nie. Nie dotyczy
monitoring.ingestionKey Klucz pozyskiwania do uwierzytelniania w obszarze roboczym usługi Azure Log Analytics w celu wysyłania dzienników do. Nie. Nie dotyczy
monitoring.workspaceId Identyfikator obszaru roboczego usługi Azure Log Analytics do wysyłania dzienników. Nie. Nie dotyczy

Planowanie obrazów i obciążeń

Platforma Kubernetes to zaawansowana platforma orkiestracji, która zapewnia dużą elastyczność w tym, co należy wdrożyć i jak ma być zaplanowana.

Ta sekcja zawiera omówienie dostępnych opcji konfiguracji, których można użyć, aby wpłynąć na używany obraz, sposób jego planowania i konfigurowania do samodzielnego uzdrowienia.

Nazwa/nazwisko opis Wymagani Wartość domyślna
replicaCount Liczba wystąpień bramy hostowanej samodzielnie do uruchomienia. Nie. 3
image.repository Obraz do uruchomienia. Nie. mcr.microsoft.com/azure-api-management/gateway
image.pullPolicy Zasady używane do ściągania obrazów kontenerów. Nie. IfNotPresent
image.tag Tag obrazu kontenera do użycia. Nie. Używana jest wersja rozszerzenia aplikacji
imagePullSecrets Wpis tajny kubernetes używany do uwierzytelniania w rejestrze kontenerów podczas ściągania obrazu kontenera. Nie. Nie dotyczy
probes.readiness.httpGet.path Ścieżka identyfikatora URI do użycia na potrzeby sond gotowości kontenera Nie. /status-0123456789abcdef
probes.readiness.httpGet.port Port do użycia na potrzeby sond liveness kontenera Nie. http
probes.liveness.httpGet.path Ścieżka identyfikatora URI do użycia na potrzeby sond żywo kontenera Nie. /status-0123456789abcdef
probes.liveness.httpGet.port Port do użycia na potrzeby sond liveness kontenera Nie. http
highAvailability.enabled Wskazuje, czy brama powinna być zaplanowana o wysokiej dostępności w klastrze. Nie. false
highAvailability.disruption.maximumUnavailable Ilość zasobników, które mogą być niedostępne z powodu dobrowolnych zakłóceń. Nie. 25%
highAvailability.podTopologySpread.whenUnsatisfiable Wskazanie, jak zasobniki powinny być rozłożone między węzłami w przypadku, gdy nie można spełnić wymagania. Dowiedz się więcej w dokumentacji platformy Kubernetes Nie. ScheduleAnyway
resources Możliwość definiowania zasobów procesora CPU/pamięci w celu przypisania do bramy Nie. Nie dotyczy
nodeSelector Możliwość używania selektorów do identyfikowania węzła, na którym powinna być uruchomiona brama. Nie. Nie dotyczy
affinity Koligacja na potrzeby planowania zasobników (docs) Nie. Nie dotyczy
tolerations Tolerancje dotyczące planowania zasobników (docs) Nie. Nie dotyczy

Następne kroki