Referens: Azure Arc-konfigurationsinställningar för lokalt installerad gateway
GÄLLER FÖR: Utvecklare | Premium
Den här artikeln innehåller en referens för obligatoriska och valfria inställningar som används för att konfigurera Azure Arc-tillägget för EN API Management-gatewaycontainer med egen värd.
Viktigt!
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 och 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, västra 2, västra 3)
Konfigurations-API-integrering
Konfigurations-API:et används av den lokala gatewayen för att ansluta till Azure API Management för att hämta den senaste konfigurationen och skicka mått när det är aktiverat.
Här är en översikt över alla konfigurationsalternativ:
Name | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
gateway.configuration.uri |
Konfigurationsslutpunkt i Azure API Management för den lokalt installerade gatewayen. Hitta det här värdet i Azure-portalen under Gatewaydistribution>. | Ja | Ej tillämpligt |
gateway.auth.token |
Autentiseringsnyckel för att autentisera med till Azure API Management-tjänsten. Börjar vanligtvis med GatewayKey . |
Ja | Ej tillämpligt |
gateway.configuration.backup.enabled |
Om aktiverad lagras en säkerhetskopia av den senaste nedladdade konfigurationen på en lagringsvolym | false |
|
gateway.configuration.backup.persistentVolumeClaim.accessMode |
Åtkomstläge för PVC-podden (Persistent Volume Claim) | ReadWriteMany |
|
gateway.configuration.backup.persistentVolumeClaim.size |
Storleken på det beständiga volymanspråket (PVC) som ska skapas | 50Mi |
|
gateway.configuration.backup.persistentVolumeClaim.storageClassName |
Lagringsklassnamn som ska användas för det beständiga volymanspråket (PVC). När inget värde tilldelas (null ) används plattformsstandarden. Den angivna lagringsklassen bör ha stöd för ReadWriteMany åtkomstläge, läs mer om volymprovidrar som stöds och deras åtkomstlägen som stöds. |
null |
Identifiering och synkronisering mellan instanser
Name | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
service.instance.heartbeat.port |
UDP-port som används för instanser av en gatewaydistribution med egen värd för att skicka pulsslag till andra instanser. | Nej | 4291 |
service.instance.synchronization.port |
UDP-port som används för gatewayinstanser med egen värd för att synkronisera hastighetsbegränsning över flera instanser. | Nej | 4290 |
Mått
Name | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
telemetry.metrics.cloud |
Ange om mått ska genereras till Azure Monitor eller inte. | Nej | true |
telemetry.metrics.local |
Aktivera insamling av lokala mått via StatsD. Värdet är ett av följande alternativ: none , statsd . |
Nej | Ej tillämpligt |
telemetry.metrics.localStatsd.endpoint |
StatsD-slutpunkt. | Ja, om telemetry.metrics.local är inställt på statsd ; annars nej. |
Ej tillämpligt |
telemetry.metrics.localStatsd.sampling |
StatistikD-måttsamplingshastighet. Värdet måste vara mellan 0 och 1, till exempel 0,5. | Nej | Ej tillämpligt |
telemetry.metrics.localStatsd.tagFormat |
Taggningsformat för StatsD-exportör. Värdet är ett av följande alternativ: ibrato , dogStatsD , influxDB . |
Nej | Ej tillämpligt |
telemetry.metrics.opentelemetry.enabled |
Ange om mått ska genereras till en OpenTelemetry-insamlare på Kubernetes eller inte. | Nej | false |
telemetry.metrics.opentelemetry.collector.uri |
URI för OpenTelemetry-insamlaren att skicka mått till. | Ja, om observability.opentelemetry.enabled är inställt på true ; annars nej. |
Ej tillämpligt |
Loggar
Name | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
telemetry.logs.std |
Aktivera loggning till en standardström. Värdet är ett av följande alternativ: none , text , json . |
Nej | text |
telemetry.logs.local |
Aktivera lokal loggning. Värdet är ett av följande alternativ: none , auto , localsyslog , rfc5424 , , journal , json |
Nej | auto |
telemetry.logs.localConfig.localsyslog.endpoint |
Slutpunkt för lokala syslogs | Ja om telemetry.logs.local är inställt på localsyslog ; annars nej. |
Ej tillämpligt |
telemetry.logs.localConfig.localsyslog.facility |
Anger lokal syslog-anläggningskod, till exempel 7 . |
Nej | Ej tillämpligt |
telemetry.logs.localConfig.rfc5424.endpoint |
rfc5424-slutpunkt. | Ja om telemetry.logs.local är inställt på rfc5424 ; annars nej. |
Ej tillämpligt |
telemetry.logs.localConfig.rfc5424.facility |
Anläggningskod per rfc5424, till exempel 7 |
Nej | Ej tillämpligt |
telemetry.logs.localConfig.journal.endpoint |
Journalslutpunkt. | Ja om telemetry.logs.local är inställt på journal ; annars nej. |
Ej tillämpligt |
Trafikroutning
Name | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
service.type |
Typ av Kubernetes-tjänst som ska användas för att exponera gatewayen. (dokument) | Nej | ClusterIP |
service.http.port |
Port som ska användas för att exponera HTTP-trafik. | Nej | 8080 |
service.http.nodePort |
Port på noden som ska användas för att exponera HTTP-trafik. Detta kräver NodePort som tjänsttyp. |
Nej | Ej tillämpligt |
service.https.port |
Port som ska användas för att exponera HTTPS-trafik. | Nej | 8081 |
service.https.nodePort |
Port på noden som ska användas för att exponera HTTPS-trafik. Detta kräver NodePort som tjänsttyp. |
Nej | Ej tillämpligt |
service.annotations |
Anteckningar som ska läggas till i Kubernetes-tjänsten för gatewayen. | Nej | Ej tillämpligt |
ingress.annotations |
Anteckningar som ska läggas till i Kubernetes-ingressen för gatewayen. (experimentell) | Nej | Ej tillämpligt |
ingress.enabled |
Ange om Kubernetes Ingress ska användas eller inte. (experimentell) | Nej | false |
ingress.tls |
TLS-konfiguration för Kubernetes-ingress. (experimentell) | Nej | Ej tillämpligt |
ingress.hosts |
Konfiguration av värdar som ska användas för Kubernetes-ingress. (experimentell) | Nej | Ej tillämpligt |
Integreringar
Den lokalt installerade gatewayen integreras med olika andra tekniker. Det här avsnittet innehåller en översikt över de tillgängliga konfigurationsalternativ som du kan använda.
Dapr
Name | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
dapr.enabled |
Ange om Dapr-integrering ska användas eller inte. | Nej | false |
dapr.app.id |
Program-ID som ska användas för Dapr-integrering | Ingen | |
dapr.config |
Definierar vilken konfiguration CRD Dapr ska använda | tracing |
|
dapr.logging.level |
Nivå av log verbosity av Dapr sidecar | info |
|
dapr.logging.useJsonOutput |
Ange om loggning ska vara i JSON-format eller inte | true |
Azure Monitor
Name | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
monitoring.customResourceId |
Resurs-ID för Azure Log Analytics-arbetsytan som loggar ska skickas till. | Nej | Ej tillämpligt |
monitoring.ingestionKey |
Inmatningsnyckel för att autentisera med Azure Log Analytics-arbetsytan för att skicka loggar till. | Nej | Ej tillämpligt |
monitoring.workspaceId |
Arbetsyte-ID för Azure Log Analytics-arbetsytan som loggar ska skickas till. | Nej | Ej tillämpligt |
Schemaläggning av avbildning och arbetsbelastning
Kubernetes är en kraftfull orkestreringsplattform som ger mycket flexibilitet i vad som ska distribueras och hur det ska schemaläggas.
Det här avsnittet innehåller en översikt över de tillgängliga konfigurationsalternativ som du kan använda för att påverka den avbildning som används, hur den schemaläggs och konfigureras för självåterning.
Name | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
replicaCount |
Antal instanser av den lokala gateway som ska köras. | Nej | 3 |
image.repository |
Avbildning som ska köras. | Nej | mcr.microsoft.com/azure-api-management/gateway |
image.pullPolicy |
Princip som ska användas för att hämta containeravbildningar. | Nej | IfNotPresent |
image.tag |
Containeravbildningstagg som ska användas. | Nej | Appversionen av tillägget används |
imagePullSecrets |
Kubernetes-hemlighet som ska användas för autentisering med containerregistret när containeravbildningen hämtas. | Nej | Ej tillämpligt |
probes.readiness.httpGet.path |
URI-sökväg som ska användas för beredskapsavsökningar av containern | Nej | /status-0123456789abcdef |
probes.readiness.httpGet.port |
Port som ska användas för liveness-avsökningar av containern | Nej | http |
probes.liveness.httpGet.path |
URI-sökväg som ska användas för liveness-avsökningar av containern | Nej | /status-0123456789abcdef |
probes.liveness.httpGet.port |
Port som ska användas för liveness-avsökningar av containern | Nej | http |
highAvailability.enabled |
Ange om gatewayen ska vara schemalagd med hög tillgänglighet i klustret eller inte. | Nej | false |
highAvailability.disruption.maximumUnavailable |
Antal poddar som tillåts vara otillgängliga på grund av frivilliga avbrott. | Nej | 25% |
highAvailability.podTopologySpread.whenUnsatisfiable |
Ange hur poddar ska spridas över noder om kravet inte kan uppfyllas. Läs mer i Kubernetes-dokumenten | Nej | ScheduleAnyway |
resources |
Möjlighet att definiera processor-/minnesresurser som ska tilldelas till gatewayen | Nej | Ej tillämpligt |
nodeSelector |
Möjlighet att använda väljare för att identifiera den nod som gatewayen ska köras på. | Nej | Ej tillämpligt |
affinity |
Tillhörighet för poddschemaläggning (dokument) | Nej | Ej tillämpligt |
tolerations |
Toleranser för poddschemaläggning (dokument) | Nej | Ej tillämpligt |
Nästa steg
- Läs mer om vägledning för att köra den lokala gatewayen på Kubernetes i produktion
- Distribuera en gateway med egen värd till Docker
- Distribuera en lokalt installerad gateway till Kubernetes
- Distribuera en lokalt installerad gateway till Azure Arc-aktiverat Kubernetes-kluster
- Aktivera Dapr-stöd på en lokalt installerad gateway
- Läs mer om konfigurationsalternativ för den lokalt installerade gatewaycontaineravbildningen