Freigeben über

Referenz: Azure Arc-Konfigurationseinstellungen für selbstgehostetes Gateway

  • Artikel

GILT FÜR: Entwickler | Premium

Dieser Artikel enthält eine Referenz für erforderliche und optionale Einstellungen, die zum Konfigurieren der Azure Arc-Erweiterung des selbstgehosteten Gatewaycontainers von API Management verwendet werden.

Wichtig

Das selbstgehostete API Management-Gateway in Azure Arc befindet sich derzeit in der Vorschau. Während der Vorschau ist die API Management-Gatewayerweiterung in den folgenden Regionen verfügbar:

  • Asien (Osten, Südosten)
  • Australien (Central, Central 2, East & Southeast)
  • Brasilien (Süden und Südosten)
  • Kanada (Mitte, Osten)
  • Europa (Norden, Westen)
  • Frankreich (Zentral und Süd)
  • Deutschland (Nord- und West-Mittel)
  • Indien (Central, South, West, Jio central & Jio West)
  • Japan (Ost und Westen)
  • Korea (Zentral - Süd)
  • Norwegen (Ost und Westen)
  • Südafrika (Nord - Westen)
  • Schweden (Mitte)
  • Schweiz (Nord & West)
  • Vereinigte Arabische Emirate (VAE - Central & North)
  • Vereinigtes Königreich (Süden)
  • USA (Mitte, Mitte EUAP, Osten, Osten 2, Osten 2 EUAP, Norden-Mitte, Süden-Mitte, Westen-Mitte, Westen, Westen 2, Westen 3)

Integration der Konfigurations-API

Die Konfigurations-API wird vom selbstgehosteten Gateway verwendet, um eine Verbindung mit Azure API Management herzustellen, um die neueste Konfiguration abzurufen und Metriken zu senden, falls aktiviert.

Hier finden Sie eine Übersicht aller Konfigurationsoptionen:

Name BESCHREIBUNG Erforderlich Standard
gateway.configuration.uri Konfigurationsendpunkt in Azure API Management für das selbstgehostete Gateway. Suchen Sie diesen Wert im Azure-Portal unter Gateways>Deployment. Ja –
gateway.auth.token Authentifizierungsschlüssel für die Authentifizierung beim Azure API Management-Dienst. Dieser beginnt in der Regel mit GatewayKey. Ja –
gateway.configuration.backup.enabled Wenn aktiviert, wird eine Sicherungskopie der zuletzt heruntergeladenen Konfiguration auf einem Speichervolume gespeichert false
gateway.configuration.backup.persistentVolumeClaim.accessMode Zugriffsmodus für den Pod des Anspruchs auf ein persistentes Volume (Persistent Volume Claim, PVC) ReadWriteMany
gateway.configuration.backup.persistentVolumeClaim.size Größe des zu erstellenden Anspruchs auf ein persistentes Volume (PVC) 50Mi
gateway.configuration.backup.persistentVolumeClaim.storageClassName Speicherklassenname, der für den Anspruch auf ein persistentes Volume (PVC) verwendet werden soll. Wenn kein Wert zugewiesen wird (null), wird der Plattformstandard verwendet. Die angegebene Speicherklasse sollte den Zugriffsmodus ReadWriteMany unterstützen. Erfahren Sie mehr über unterstützte Volumeanbieter und ihre unterstützten Zugriffsmodi. null

Instanzübergreifende Erkennung und Synchronisierung

Name BESCHREIBUNG Erforderlich Standard
service.instance.heartbeat.port UDP-Port, der für Instanzen einer selbstgehosteten Gatewaybereitstellung verwendet wird, um Heartbeats an andere Instanzen zu senden. Nein 4.291
service.instance.synchronization.port UDP-Port, der für selbstgehostete Gatewayinstanzen verwendet wird, um die Ratenbegrenzung über mehrere Instanzen hinweg zu synchronisieren. Nein 4290

Metriken

Name BESCHREIBUNG Erforderlich Standard
telemetry.metrics.cloud Angabe, ob die Ausgabe von Metriken an Azure Monitor aktiviert werden soll oder nicht. No true
telemetry.metrics.local Aktivieren Sie die Erfassung lokaler Metriken über StatsD. Der Wert ist eine der folgenden Optionen: none, statsd. Nein –
telemetry.metrics.localStatsd.endpoint StatsD-Endpunkt. Ja, wenn telemetry.metrics.local auf statsd festgelegt ist; andernfalls nein. –
telemetry.metrics.localStatsd.sampling Abtastrate der StatsD-Metriken. Der Wert muss zwischen 0 und 1 liegen, z. B. 0,5. Nein –
telemetry.metrics.localStatsd.tagFormat Taggingformat der Exportfunktion von StatsD. Der Wert ist eine der folgenden Optionen: ibrato, dogStatsD, influxDB. Nein –
telemetry.metrics.opentelemetry.enabled Geben Sie an, ob Metriken an einen OpenTelemetrie-Sammler auf Kubernetes übergeben werden sollen. Nein false
telemetry.metrics.opentelemetry.collector.uri URI des OpenTelemetry-Collectors, an den Metriken gesendet werden sollen. Ja, wenn observability.opentelemetry.enabled auf true festgelegt ist; andernfalls nein. –

Protokolle

Name BESCHREIBUNG Erforderlich Standard
telemetry.logs.std Aktivieren Sie die Protokollierung in einem Standardstream. Der Wert ist eine der folgenden Optionen: none, text, json. Nein text
telemetry.logs.local Aktivieren Sie die lokale Protokollierung. Der Wert ist eine der folgenden Optionen: none, auto, localsyslog, rfc5424, journal, json. Nein auto
telemetry.logs.localConfig.localsyslog.endpoint Endpunkt für lokale Syslogs Ja, wenn telemetry.logs.local auf localsyslog festgelegt ist; andernfalls nein. –
telemetry.logs.localConfig.localsyslog.facility Gibt den Einrichtungscode des lokalen Syslogs an, z. B. 7. Nein –
telemetry.logs.localConfig.rfc5424.endpoint rfc5424-Endpunkt. Ja, wenn telemetry.logs.local auf rfc5424 festgelegt ist; andernfalls nein. –
telemetry.logs.localConfig.rfc5424.facility Einrichtungscode pro rfc5424, z.B. 7 Nein –
telemetry.logs.localConfig.journal.endpoint Journalendpunkt. Ja, wenn telemetry.logs.local auf journal festgelegt ist; andernfalls nein. –

Routing von Datenverkehr

Name BESCHREIBUNG Erforderlich Standard
service.type Typ des Kubernetes-Diensts, der dazu verwendet werden soll, das Gateway verfügbar zu machen. (Dokumentation) Nein ClusterIP
service.http.port Port, der dazu verwendet werden soll, HTTP-Datenverkehr verfügbar zu machen. Nein 8080
service.http.nodePort Port auf dem Knoten, der dazu verwendet werden soll, HTTP-Datenverkehr verfügbar zu machen. Dies erfordert NodePort als Diensttyp. Nein –
service.https.port Port, der dazu verwendet werden soll, HTTPS-Datenverkehr verfügbar zu machen. Nein 8081
service.https.nodePort Port auf dem Knoten, der dazu verwendet werden soll, HTTPS-Datenverkehr verfügbar zu machen. Dies erfordert NodePort als Diensttyp. Nein –
service.annotations Anmerkungen, die dem Kubernetes-Dienst für das Gateway hinzugefügt werden sollen. Nein –
ingress.annotations Anmerkungen, die dem Kubernetes-Eingang für das Gateway hinzugefügt werden sollen. (experimentell) Nein –
ingress.enabled Gibt an, ob der Kubernetes-Eingang verwendet werden soll. (experimentell) Nein false
ingress.tls TLS-Konfiguration für Kubernetes-Eingang. (experimentell) Nein –
ingress.hosts Konfiguration von Hosts, die für den Kubernetes-Eingang verwendet werden sollen. (experimentell) Nein –

Integrationen

Das selbstgehostete Gateway kann in verschiedene andere Technologien integriert werden. Dieser Abschnitt bietet eine Übersicht über die verfügbaren Konfigurationsoptionen, die Sie verwenden können.

Dapr

Name BESCHREIBUNG Erforderlich Standard
dapr.enabled Gibt an, ob die Dapr-Integration verwendet werden soll. Nein false
dapr.app.id Anwendungs-ID, die für die Dapr-Integration verwendet werden soll Keine
dapr.config Definiert, welche Konfigurations-CRD-Dapr verwendet werden soll tracing
dapr.logging.level Ebene der Protokollausführlichkeit des Dapr-Sidecars info
dapr.logging.useJsonOutput Gibt an, ob die Protokollierung im JSON-Format erfolgen soll true

Azure Monitor

Name BESCHREIBUNG Erforderlich Standard
monitoring.customResourceId Ressourcen-ID des Azure Log Analytics-Arbeitsbereichs, an den Protokolle gesendet werden sollen. Nein –
monitoring.ingestionKey Erfassungsschlüssel für die Authentifizierung beim Azure Log Analytics-Arbeitsbereich, an den Protokolle gesendet werden sollen. Nein –
monitoring.workspaceId Arbeitsbereichs-ID des Azure Log Analytics-Arbeitsbereichs, an den Protokolle gesendet werden sollen. Nein –

Planen von Image & Workload

Kubernetes ist eine leistungsstarke Orchestrierungsplattform, die viel Flexibilität bei der Bereitstellung und Planung bietet.

Dieser Abschnitt bietet eine Übersicht über die verfügbaren Konfigurationsoptionen, die Sie verwenden können, um das verwendete Image zu beeinflussen, und darüber, wie es geplant und für die Selbstheilung konfiguriert wird.

Name BESCHREIBUNG Erforderlich Standard
replicaCount Anzahl der Instanzen des auszuführenden selbstgehosteten Gateways. Nein 3
image.repository Auszuführendes Image. Nein mcr.microsoft.com/azure-api-management/gateway
image.pullPolicy Richtlinie, die zum Pullen von Containerimages verwendet werden soll. Nein IfNotPresent
image.tag Tag des Containerimages, das verwendet werden soll. Nein App-Version der Erweiterung wird verwendet
imagePullSecrets Kubernetes-Geheimnis, das beim Pullen des Containerimages für die Authentifizierung bei der Containerregistrierung verwendet werden soll. Nein –
probes.readiness.httpGet.path URI-Pfad, der für Bereitschaftstests des Containers verwendet werden soll Nein /status-0123456789abcdef
probes.readiness.httpGet.port Port, der für Livetests des Containers verwendet werden soll Nein http
probes.liveness.httpGet.path URI-Pfad, der für Livetests des Containers verwendet werden soll Nein /status-0123456789abcdef
probes.liveness.httpGet.port Port, der für Livetests des Containers verwendet werden soll Nein http
highAvailability.enabled Gibt an, ob das Gateway im Cluster hochverfügbar sein soll. Nein false
highAvailability.disruption.maximumUnavailable Anzahl der Pods, die aufgrund freiwilliger Unterbrechungen nicht verfügbar sein dürfen. Nein 25%
highAvailability.podTopologySpread.whenUnsatisfiable Gibt an, wie Pods auf Knoten verteilt werden sollen, falls die Anforderung nicht erfüllt werden kann. Weitere Informationen finden Sie in der Kubernetes-Dokumentation Nein ScheduleAnyway
resources Funktion zum Definieren von CPU-/Arbeitsspeicherressourcen, die dem Gateway zugewiesen werden sollen Nein –
nodeSelector Funktion zum Verwenden von Selektoren, um den Knoten zu identifizieren, auf dem das Gateway ausgeführt werden soll. Nein –
affinity Affinität zur Podplanung (Dokumentation) Nein –
tolerations Toleranzen für die Podplanung (Dokumentation) Nein –

Nächste Schritte