Referens: Self-hosted gateway Azure Arc konfigurationsinställningar

GÄLLER FÖR: Utvecklare | Premie

Den här artikeln ger en referens för de nödvändiga och valfria inställningarna för att konfigurera Azure Arc-tillägget för API Managements självhostade gateway-container.

Important

API Management-gateway med egen värd i Azure Arc är för närvarande i förhandsversion. Under förhandsversionen är API Management-gatewaytillägget tillgängligt i följande regioner:

  • Asien (öst, sydöstra)
  • Australien (Centrala, Centrala 2, Östra och Sydöstra)
  • Brasilien (södra och sydöstra)
  • Kanada (centrala, östra)
  • Europa (nord, väst)
  • Frankrike (centrala och södra)
  • Tyskland (norra och västra centrala)
  • Indien (centrala, södra, västra, Jio centrala & Jio västra)
  • Japan (öst och väst)
  • Korea (centrala och södra)
  • Norge (öst och väst)
  • Sydafrika (nord- och väst)
  • Sverige (centrala)
  • Schweiz (nord och väst)
  • Förenade Arabemiraten (Förenade Arabemiraten – centrala och norra)
  • Storbritannien (Storbritannien -Södra)
  • USA (USA - centrala, centrala EUAP, östra, östra 2, östra 2 EUAP, norra centrala, södra centrala, västra centrala, västra, västra 2, västra 3)

Konfigurations-API-integration

Den självhostade gatewayen använder Configuration API för att ansluta till Azure API Management och få den senaste konfigurationen och skicka mätvärden, när den är aktiverad.

Här är en översikt över alla konfigurationsalternativ:

Name Description Obligatoriskt Default
gateway.configuration.uri Konfigurationsendpoint i Azure API Management för den självhostade gatewayen. Hitta detta värde i Azure-portalen under Gateways>Deployment. Yes N/A
gateway.auth.token Autentiseringsnyckel för att autentisera sig med Azure API Management-tjänsten. Börjar vanligtvis med GatewayKey. Yes N/A
gateway.configuration.backup.enabled Om den är aktiverad, lagrar den en säkerhetskopia av den senaste nedladdade konfigurationen på en lagringsvolym. No false
gateway.configuration.backup.persistentVolumeClaim.accessMode Åtkomstläge för Persistent Volume Claim (PVC)-podden. No ReadWriteMany
gateway.configuration.backup.persistentVolumeClaim.size Storleken på det bestående volymkravet (PVC) för att skapa. No 50Mi
gateway.configuration.backup.persistentVolumeClaim.storageClassName Lagringsklassnamn att använda för Persistent Volume Claim (PVC). När du inte tilldelar ett värde (null), använder plattformen standardvärdet. Den angivna lagringsklassen bör stödja ReadWriteMany åtkomstläge. Läs mer om de leverantörer av volym som stöds och deras stödda åtkomstsätt. No null

Upptäckt och synkronisering mellan instanser

Name Description Obligatoriskt Default
service.instance.heartbeat.port UDP-porten som instanser av en självhostad gateway-distribution använder för att skicka hjärtslag till andra instanser. No 4291
service.instance.synchronization.port UDP-port som självhostade gateway-instanser använder för att synkronisera hastighetsbegränsningar mellan flera instanser. No 4290

Metrics

Name Description Obligatoriskt Default
telemetry.metrics.cloud Indikering om man ska aktivera emitting metrics till Azure Monitor. No true
telemetry.metrics.local Aktivera lokal insamling av mätvärden via StatsD. Värde är ett av följande alternativ: none, statsd. No N/A
telemetry.metrics.localStatsd.endpoint StatsD-slutpunkt. Ja, om telemetry.metrics.local är satt till statsd; annars nej. N/A
telemetry.metrics.localStatsd.sampling StatsD-mätvärden samplingfrekvens. Värdet måste vara mellan 0 och 1, till exempel 0,5. No N/A
telemetry.metrics.localStatsd.tagFormat Taggningsformat för StatsD-exportör. Värde är ett av följande alternativ: librato, dogStatsD, influxDB. No N/A
telemetry.metrics.opentelemetry.enabled Indikation på om man ska aktivera emittering av mätvärden till en OpenTelemetrie-samlare på Kubernetes. No false
telemetry.metrics.opentelemetry.collector.uri URI för OpenTelemetrie-samlaren att skicka metrik till. Ja, om observability.opentelemetry.enabled är satt till true; annars nej. N/A

Logs

Name Description Obligatoriskt Default
telemetry.logs.std Aktivera loggning till en standardström. Värde är ett av följande alternativ: none, text, json. No text
telemetry.logs.local Aktivera lokal loggning. Värde är ett av följande alternativ: none, , autolocalsyslog, rfc5424, journal, ,json No auto
telemetry.logs.localConfig.localsyslog.endpoint Endpoint för lokala syslogs Ja om telemetry.logs.local är satt till localsyslog; annars nej. N/A
telemetry.logs.localConfig.localsyslog.facility Specificerar lokal syslog-facilitetskod, till exempel 7. No N/A
telemetry.logs.localConfig.rfc5424.endpoint RFC5424 Endpoint. Ja om telemetry.logs.local är satt till rfc5424; annars nej. N/A
telemetry.logs.localConfig.rfc5424.facility Anläggningskod enligt rfc5424, till exempel, 7 No N/A
telemetry.logs.localConfig.journal.endpoint Dagbokens slutpunkt. Ja om telemetry.logs.local är satt till journal; annars nej. N/A

Trafikroutning

Name Description Obligatoriskt Default
service.type Typ av Kubernetes-tjänst att använda för att exponera gatewayen. (Kubernetes-tjänstetyper) No ClusterIP
service.http.port Port att använda för att exponera HTTP-trafik. No 8080
service.http.nodePort Port på noden för att använda för att exponera HTTP-trafik. Denna inställning kräver NodePort som tjänstetyp. No N/A
service.https.port Port att använda för att exponera HTTPS-trafik. No 8081
service.https.nodePort Port på noden för att exponera HTTPS-trafik. Denna inställning kräver NodePort som tjänstetyp. No N/A
service.annotations Annotationer att lägga till i Kubernetes-tjänsten för gatewayen. No N/A
ingress.annotations Annotationer att lägga till i Kubernetes Ingress för gatewayen. (experimentellt stöd för Kubernetes Ingress) No N/A
ingress.enabled Indikation på om man ska använda Kubernetes Ingress eller inte. (experimentellt stöd för Kubernetes Ingress) No false
ingress.tls TLS-konfiguration för Kubernetes Ingress. (experimentellt stöd för Kubernetes Ingress) No N/A
ingress.hosts Konfiguration av värdar att använda för Kubernetes Ingress. (experimentellt stöd för Kubernetes Ingress) No N/A

Integrations

Den självhostade gatewayen integreras med olika andra teknologier. Detta avsnitt ger en översikt över de konfigurationsalternativ du kan använda.

Dapr

Name Description Obligatoriskt Default
dapr.enabled Indikerar om man ska använda Dapr-integration. No false
dapr.app.id Applikations-ID att använda för Dapr-integration. No None
dapr.config Definierar vilken konfiguration CRD Dapr ska använda. No tracing
dapr.logging.level Nivån av log-ordrikedom i Dapr sidecar. No info
dapr.logging.useJsonOutput Indikerar om loggningen sker i JSON-format. No true

Azure Monitor

Name Description Obligatoriskt Default
monitoring.customResourceId Resurs-ID för Azure Log Analytics-arbetsområdet att skicka loggar till. No N/A
monitoring.ingestionKey Ingestion key för att autentisera med Azure Log Analytics workspace för att skicka loggar till. No N/A
monitoring.workspaceId Workspace-ID för Azure Log Analytics-arbetsområdet att skicka loggar till. No N/A

Bild- och arbetsbelastningsschemaläggning

Kubernetes är en kraftfull orkestreringsplattform som ger stor flexibilitet i vad som ska distribueras och hur det ska schemalis.

Detta avsnitt ger en översikt över de tillgängliga konfigurationsalternativen du kan använda för att påverka bilden som används, hur den schemaläggs och konfigureras för att läka sig själv.

Name Description Obligatoriskt Default
replicaCount Antal instanser av den självhostade gatewayen att köra. No 3
image.repository Bild för att köra. No mcr.microsoft.com/azure-api-management/gateway
image.pullPolicy Policy att använda för att hämta containerbilder. No IfNotPresent
image.tag Container-bildtagg att använda. No Appversionen av tillägget används
imagePullSecrets Kubernetes-hemlighet att använda för autentisering med containerregistret när man hämtar containeravbilden. No N/A
probes.readiness.httpGet.path URI-väg att använda för beredskapsprober av containern No /status-0123456789abcdef
probes.readiness.httpGet.port Port att använda för livlighetssonder av containern No http
probes.liveness.httpGet.path URI-väg att använda för liveness-prober av containern No /status-0123456789abcdef
probes.liveness.httpGet.port Port att använda för livlighetssonder av containern No http
highAvailability.enabled Indikerar om gatewayen bör schemaläggas högt tillgänglig i klustret. No false
highAvailability.disruption.maximumUnavailable Antalet poddar som tillåts vara otillgängliga på grund av frivilliga störningar. No 25%
highAvailability.podTopologySpread.whenUnsatisfiable Indikera hur pods ska spridas över noder om kravet inte kan uppfyllas. Läs mer i Kubernetes-dokumenten No ScheduleAnyway
resources Möjlighet att definiera CPU-/minnesresurser att tilldela till gateway No N/A
nodeSelector Möjlighet att använda selectorer för att identifiera noden där gatewayen ska köras. No N/A
affinity Affinitet för pod scheduling (Kubernetes node affinity) No N/A
tolerations Toleranser för pod-schemaläggning (Kubernetes-föroreningar och toleranser) No N/A

Relaterat innehåll

  • Last updated on