Riferimento: Impostazioni di configurazione di Azure Arc del gateway self-hosted
SI APPLICA A: Sviluppatore | Premium
Questo articolo fornisce informazioni di riferimento per le impostazioni obbligatorie e facoltative usate per configurare l'estensione Azure Arc per Gestione API contenitore gateway self-hosted.
Importante
Gestione API gateway self-hosted in Azure Arc è attualmente in anteprima. Durante l'anteprima, l'estensione del gateway Gestione API è disponibile nelle aree seguenti:
- Asia (est, sud-orientale)
- Australia (centrale, centrale 2, est e sud-orientale)
- Brasile (sud-orientale)
- Canada (centrale, orientale)
- Europa (nord, ovest)
- Francia (centrale e meridionale)
- Germania (centro-settentrionale)
- India (Centro, Sud, Ovest, Jio centrale e Jio West)
- Giappone (Est e Ovest)
- Corea (centrale e meridionale)
- Norvegia (Est e Ovest)
- Sudafrica (Nord e Ovest)
- Svezia (centrale)
- Svizzera (Nord e Ovest)
- Emirati Arabi Uniti (Emirati Arabi Uniti - Centro e Nord)
- Regno Unito (Regno Unito -Sud)
- Stati Uniti (Stati Uniti - Stati Uniti centrali, UEAP centrale, Est, Est 2, EUAP orientale 2, Centro-settentrionale, Centro-sud, Centro-occidentale, Ovest, 2 ovest 2, Ovest 3)
Integrazione dell'API di configurazione
L'API di configurazione viene usata dal gateway self-hosted per connettersi ad Azure Gestione API per ottenere la configurazione più recente e inviare le metriche, se abilitata.
Ecco una panoramica di tutte le opzioni di configurazione:
Nome | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
gateway.configuration.uri |
Endpoint di configurazione in Azure Gestione API per il gateway self-hosted. Trovare questo valore nella portale di Azure in Distribuzione gateway>. | Sì | N/D |
gateway.auth.token |
Chiave di autenticazione con cui eseguire l'autenticazione nel servizio azure Gestione API. In genere inizia con GatewayKey . |
Sì | N/D |
gateway.configuration.backup.enabled |
Se abilitato archivierà una copia di backup della configurazione scaricata più recente in un volume di archiviazione | false |
|
gateway.configuration.backup.persistentVolumeClaim.accessMode |
Modalità di accesso per il pod dell'attestazione di volume persistente (PVC) | ReadWriteMany |
|
gateway.configuration.backup.persistentVolumeClaim.size |
Dimensioni dell'attestazione di volume persistente (PVC) da creare | 50Mi |
|
gateway.configuration.backup.persistentVolumeClaim.storageClassName |
Archiviazione nome della classe da usare per l'attestazione di volume persistente (PVC). Quando non viene assegnato alcun valore (null ), verrà usato il valore predefinito della piattaforma. La classe di archiviazione specificata deve supportare ReadWriteMany la modalità di accesso, altre informazioni sui provider di volumi supportati e sulle modalità di accesso supportate. |
null |
Individuazione e sincronizzazione tra istanze
Nome | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
service.instance.heartbeat.port |
Porta UDP usata per le istanze di una distribuzione di gateway self-hosted per inviare heartbeat ad altre istanze. | No | 4291 |
service.instance.synchronization.port |
Porta UDP usata per le istanze del gateway self-hosted per sincronizzare la limitazione della frequenza tra più istanze. | No | 4290 |
Metriche
Nome | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
telemetry.metrics.cloud |
Indica se abilitare o meno la creazione di metriche in Monitoraggio di Azure. | No | true |
telemetry.metrics.local |
Abilitare la raccolta delle metriche locali tramite StatsD. Il valore è una delle opzioni seguenti: none , statsd . |
No | N/D |
telemetry.metrics.localStatsd.endpoint |
Endpoint StatsD. | Sì, se telemetry.metrics.local è impostato su statsd ; in caso contrario, no. |
N/D |
telemetry.metrics.localStatsd.sampling |
Frequenza di campionamento delle metriche StatsD. Il valore deve essere compreso tra 0 e 1, ad esempio 0,5. | No | N/D |
telemetry.metrics.localStatsd.tagFormat |
Formato di assegnazione di tag all'utilità di esportazione StatsD. Value è una delle opzioni seguenti: ibrato , dogStatsD , influxDB . |
No | N/D |
telemetry.metrics.opentelemetry.enabled |
Indica se abilitare o meno la creazione di metriche a un agente di raccolta OpenTelemetry in Kubernetes. | No | false |
telemetry.metrics.opentelemetry.collector.uri |
URI dell'agente di raccolta OpenTelemetry a cui inviare le metriche. | Sì, se observability.opentelemetry.enabled è impostato su true ; in caso contrario, no. |
N/D |
Registri
Nome | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
telemetry.logs.std |
Abilitare la registrazione in un flusso standard. Value è una delle opzioni seguenti: none , text , json . |
No | text |
telemetry.logs.local |
Abilitare la registrazione locale. Value è una delle opzioni seguenti: none , auto , localsyslog , rfc5424 , journal json |
No | auto |
telemetry.logs.localConfig.localsyslog.endpoint |
Endpoint per syslog locali | Sì se telemetry.logs.local è impostato su localsyslog ; in caso contrario, no. |
N/D |
telemetry.logs.localConfig.localsyslog.facility |
Specifica il codice della struttura syslog locale, 7 ad esempio . |
No | N/D |
telemetry.logs.localConfig.rfc5424.endpoint |
rfc5424 endpoint. | Sì se telemetry.logs.local è impostato su rfc5424 ; in caso contrario, no. |
N/D |
telemetry.logs.localConfig.rfc5424.facility |
Codice della struttura per rfc5424, ad esempio 7 |
No | N/D |
telemetry.logs.localConfig.journal.endpoint |
Endpoint journal. | Sì se telemetry.logs.local è impostato su journal ; in caso contrario, no. |
N/D |
instradamento del traffico
Nome | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
service.type |
Tipo di servizio Kubernetes da usare per esporre il gateway. (docs) | No | ClusterIP |
service.http.port |
Porta da usare per esporre il traffico HTTP. | No | 8080 |
service.http.nodePort |
Porta sul nodo da usare per esporre il traffico HTTP. Questo richiede NodePort come tipo di servizio. |
No | N/D |
service.https.port |
Porta da usare per esporre il traffico HTTPS. | No | 8081 |
service.https.nodePort |
Porta nel nodo da usare per esporre il traffico HTTPS. Questo richiede NodePort come tipo di servizio. |
No | N/D |
service.annotations |
Annotazioni da aggiungere al servizio Kubernetes per il gateway. | No | N/D |
ingress.annotations |
Annotazioni da aggiungere all'ingresso kubernetes per il gateway. (sperimentale) | No | N/D |
ingress.enabled |
Indica se usare o meno l'ingresso di Kubernetes. (sperimentale) | No | false |
ingress.tls |
Configurazione TLS per l'ingresso di Kubernetes. (sperimentale) | No | N/D |
ingress.hosts |
Configurazione degli host da usare per l'ingresso di Kubernetes. (sperimentale) | No | N/D |
Integrazioni
Il gateway self-hosted si integra con varie altre tecnologie. Questa sezione offre una panoramica delle opzioni di configurazione disponibili che è possibile usare.
Dapr
Nome | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
dapr.enabled |
Indica se usare o meno l'integrazione dapr. | No | false |
dapr.app.id |
ID applicazione da usare per l'integrazione di Dapr | None | |
dapr.config |
Definisce la configurazione dapr dapr CRD da usare | tracing |
|
dapr.logging.level |
Livello di dettaglio log di Dapr sidecar | info |
|
dapr.logging.useJsonOutput |
Indicazione se la registrazione deve essere in formato JSON | true |
Monitoraggio di Azure
Nome | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
monitoring.customResourceId |
ID risorsa dell'area di lavoro Log Analytics di Azure a cui inviare i log. | No | N/D |
monitoring.ingestionKey |
Chiave di inserimento a cui eseguire l'autenticazione con l'area di lavoro Log Analytics di Azure a cui inviare i log. | No | N/D |
monitoring.workspaceId |
ID area di lavoro dell'area di lavoro Log Analytics di Azure a cui inviare i log. | No | N/D |
Pianificazione di immagini e carichi di lavoro
Kubernetes è una potente piattaforma di orchestrazione che offre molta flessibilità in ciò che deve essere distribuito e come deve essere pianificato.
Questa sezione offre una panoramica delle opzioni di configurazione disponibili che è possibile usare per influenzare l'immagine usata, come viene pianificata e configurata per la riparazione automatica.
Nome | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
replicaCount |
Numero di istanze del gateway self-hosted da eseguire. | No | 3 |
image.repository |
Immagine da eseguire. | No | mcr.microsoft.com/azure-api-management/gateway |
image.pullPolicy |
Criteri da usare per il pull delle immagini del contenitore. | No | IfNotPresent |
image.tag |
Tag immagine contenitore da usare. | No | Viene usata la versione dell'estensione dell'app |
imagePullSecrets |
Segreto Kubernetes da usare per l'autenticazione con registro contenitori durante il pull dell'immagine del contenitore. | No | N/D |
probes.readiness.httpGet.path |
Percorso URI da usare per i probe di idoneità del contenitore | No | /status-0123456789abcdef |
probes.readiness.httpGet.port |
Porta da usare per i probe di attività del contenitore | No | http |
probes.liveness.httpGet.path |
Percorso URI da usare per i probe di attività del contenitore | No | /status-0123456789abcdef |
probes.liveness.httpGet.port |
Porta da usare per i probe di attività del contenitore | No | http |
highAvailability.enabled |
Indica se il gateway deve essere pianificato a disponibilità elevata nel cluster. | No | false |
highAvailability.disruption.maximumUnavailable |
Quantità di pod che possono non essere disponibili a causa di interruzioni volontarie. | No | 25% |
highAvailability.podTopologySpread.whenUnsatisfiable |
Indicazione del modo in cui i pod devono essere distribuiti tra i nodi nel caso in cui il requisito non possa essere soddisfatto. Altre informazioni sono disponibili nella documentazione di Kubernetes | No | ScheduleAnyway |
resources |
Capacità di definire le risorse CPU/memoria da assegnare al gateway | No | N/D |
nodeSelector |
Possibilità di usare selettori per identificare il nodo in cui deve essere eseguito il gateway. | No | N/D |
affinity |
Affinità per la pianificazione dei pod (documentazione) | No | N/D |
tolerations |
Tolerazioni per la pianificazione dei pod (documentazione) | No | N/D |
Passaggi successivi
- Altre informazioni sulle linee guida per l'esecuzione del gateway self-hosted in Kubernetes nell'ambiente di produzione
- Distribuire un gateway self-hosted in Docker
- Distribuire un gateway self-hosted in Kubernetes
- Distribuire un gateway self-hosted nel cluster Kubernetes abilitato per Azure Arc
- Abilitare il supporto dapr nel gateway self-hosted
- Altre informazioni sulle opzioni di configurazione per l'immagine del contenitore del gateway self-hosted