Partage via

Référence : paramètres de configuration Azure Arc de la passerelle auto-hébergée

  • Article

S’APPLIQUE À : Développeur | Premium

Cet article sert de référence pour les paramètres obligatoires et facultatifs utilisés pour configurer l’extension Azure Arc pour un conteneur de passerelle auto-hébergée de Gestion des API.

Important

La passerelle Gestion des API auto-hébergée sur Azure Arc est actuellement en préversion. Pendant la préversion, l’extension de passerelle Gestion des API est disponible dans les régions suivantes :

  • Asie (Est, Sud-Est)
  • Australie (Centre, Centre 2, Est et Sud-Est)
  • Brésil (Sud et Sud-Est)
  • Canada (Centre, Est)
  • Europe (Nord, Ouest)
  • France (Centre et Sud)
  • Allemagne (Nord et Centre-Ouest)
  • Inde (Centre, Sud, Ouest, Jio Centre &Jio Ouest)
  • Japon (Est et Ouest)
  • Corée (Centre et Sud)
  • Norvège (Est et Ouest)
  • Afrique du Sud (Nord et Ouest)
  • Suède (Centre)
  • Suisse (Nord et Ouest)
  • Émirats arabes unis (Émirats arabes unis - Centre et Nord)
  • Royaume-Uni (Royaume-Uni -Sud)
  • États-Unis (USA - Centre, EUAP Centre, Est, Est 2, EUAP Est 2, Centre Nord, Centre Sud, Centre Ouest, Ouest, Ouest 2, Ouest 3)

Intégration de l’API de configuration

L’API de configuration est utilisée par la passerelle auto-hébergée pour se connecter à Azure API Management afin d’obtenir la dernière configuration et d’envoyer des métriques, quand il est activé.

Voici une vue d’ensemble de toutes les options de configuration :

Nom Description Obligatoire Default
gateway.configuration.uri Point de terminaison de configuration dans la Gestion des API Azure pour la passerelle auto-hébergée. Recherchez cette valeur dans le Portail Azure sous Déploiementde passerelles>. Oui N/A
gateway.auth.token Clé d’authentification pour s’authentifier auprès du service Gestion des API Azure. Elle commence généralement par GatewayKey. Oui N/A
gateway.configuration.backup.enabled En cas d’activation de cette option, stocke une copie de sauvegarde de la dernière configuration téléchargée sur un volume de stockage false
gateway.configuration.backup.persistentVolumeClaim.accessMode Mode d’accès pour le pod Revendication de volume persistant (PVC) ReadWriteMany
gateway.configuration.backup.persistentVolumeClaim.size Taille de la Revendication de volume persistant (PVC) à créer 50Mi
gateway.configuration.backup.persistentVolumeClaim.storageClassName Nom de la classe de stockage à utiliser pour la Revendication de volume persistant (PVC). Lorsqu’aucune valeur n’est affectée (null), la valeur par défaut de la plateforme est utilisée. La classe de stockage spécifiée doit prendre en charge le mode d’accès ReadWriteMany, en savoir plus sur les fournisseurs de volumes et leurs modes d’accès pris en charge. null

Découverte inter-instances et synchronisation

Nom Description Obligatoire Default
service.instance.heartbeat.port Port UDP utilisé pour les instances d’un déploiement de passerelle auto-hébergé pour envoyer des pulsations à d’autres instances. Non 4291
service.instance.synchronization.port Port UDP utilisé pour les instances de passerelle auto-hébergées pour synchroniser la limitation de débit entre plusieurs instances. Non 4290

Mesures

Nom Description Obligatoire Default
telemetry.metrics.cloud Indique si vous souhaitez activer ou non l’émission de métriques vers Azure Monitor. No true
telemetry.metrics.local Activez la collecte de métriques locales via StatsD. La valeur est l’une des options suivantes : none, statsd. Non N/A
telemetry.metrics.localStatsd.endpoint Point de terminaison StatsD. Oui, s’il telemetry.metrics.local est défini sur statsd ; sinon non. N/A
telemetry.metrics.localStatsd.sampling Taux d’échantillonnage des métriques StatsD. La valeur doit être comprise entre 0 et 1, par exemple, 0,5. Non N/A
telemetry.metrics.localStatsd.tagFormat Format d’étiquetage de l’exportateur StatsD. La valeur est l’une des options suivantes : ibrato, dogStatsD, influxDB. Non N/A
telemetry.metrics.opentelemetry.enabled Indique si vous souhaitez activer ou non l’émission de métriques à un collecteur OpenTelemetry sur Kubernetes. No false
telemetry.metrics.opentelemetry.collector.uri URI du collecteur OpenTelemetry vers laquelle envoyer des métriques. Oui, s’il observability.opentelemetry.enabled est défini sur true ; sinon non. N/A

Journaux d’activité

Nom Description Obligatoire Default
telemetry.logs.std Activez la journalisation dans un flux standard. La valeur est l’une des options suivantes : none, text, json. Non text
telemetry.logs.local Activez la journalisation locale. La valeur est l’une des options suivantes : none, auto, localsyslog,rfc5424,journal,json No auto
telemetry.logs.localConfig.localsyslog.endpoint Point de terminaison pour des syslogs locaux Oui, s’il telemetry.logs.local est défini sur localsyslog ; sinon non. N/A
telemetry.logs.localConfig.localsyslog.facility Specifies le code de facilité de syslog local, par exemple 7. Non N/A
telemetry.logs.localConfig.rfc5424.endpoint point de terminaison de rfc5424. Oui, s’il telemetry.logs.local est défini sur rfc5424 ; sinon non. N/A
telemetry.logs.localConfig.rfc5424.facility Code d’installation par rfc5424, par exemple, 7 Non N/A
telemetry.logs.localConfig.journal.endpoint Point de terminaison de journal. Oui, s’il telemetry.logs.local est défini sur journal ; sinon non. N/A

Routage du trafic

Nom Description Obligatoire Default
service.type Type de service Kubernetes à utiliser pour exposer la passerelle. (docs) Non ClusterIP
service.http.port Port à utiliser pour exposer un trafic HTTP. Non 8080
service.http.nodePort Port sur le nœud à utiliser pour exposer un trafic HTTP. Il nécessite NodePort comme type de service. Non N/A
service.https.port Port à utiliser pour exposer un trafic HTTPS. Non 8081
service.https.nodePort Port sur le nœud à utiliser pour exposer un trafic HTTP. Il nécessite NodePort comme type de service. Non N/A
service.annotations Annotations à ajouter au service Kubernetes pour la passerelle. Non N/A
ingress.annotations Annotations à ajouter à l’entrée Kubernetes pour la passerelle. (expérimental) Non N/A
ingress.enabled Indique si une entrée Kubernetes doit être utilisée. (expérimental) Non false
ingress.tls Configuration TLS pour une entrée Kubernetes. (expérimental) Non N/A
ingress.hosts Configuration des hôtes à utiliser pour une entrée Kubernetes. (expérimental) Non N/A

Intégrations

La passerelle auto-hébergée s’intègre à diverses autres technologies. Cette section fournit une vue d’ensemble des options de configuration disponibles que vous pouvez utiliser.

Dapr

Nom Description Obligatoire Default
dapr.enabled Indique si l’intégration Dapr doit être utilisée. Non false
dapr.app.id ID d’application à utiliser pour une intégration de Dapr None
dapr.config Définit le CRD de configuration que Dapr doit utiliser tracing
dapr.logging.level Niveau de verbosité du journal du side-car Dapr info
dapr.logging.useJsonOutput Indique si la journalisation doit être au format JSON true

Azure Monitor

Nom Description Obligatoire Default
monitoring.customResourceId ID de ressource de l’espace de travail Azure Log Analytics vers lequel envoyer des journaux d’activité. Non N/A
monitoring.ingestionKey Clé d’ingestion pour l’authentification auprès d’un espace de travail Azure Log Analytics vers lequel envoyer des journaux d’activité. Non N/A
monitoring.workspaceId ID d’espace de travail de l’espace de travail Azure Log Analytics vers lequel envoyer des journaux d’activité. Non N/A

Planification de l’image et de la charge de travail

Kubernetes est une plateforme d’orchestration puissante offrant une grande flexibilité dans ce qui doit être déployé et comment le planifier.

Cette section fournit une vue d’ensemble des options de configuration disponibles que vous pouvez utiliser pour influencer l’image utilisée, la façon de la planifier et de la configurer pour qu’elle se répare automatiquement.

Nom Description Obligatoire Default
replicaCount Nombre d’instances de la passerelle auto-hébergée à exécuter. Non 3
image.repository Image à exécuter. Non mcr.microsoft.com/azure-api-management/gateway
image.pullPolicy Stratégie à utiliser pour extraire des images conteneur. Non IfNotPresent
image.tag Étiquette d’image conteneur à utiliser. Non La version d’application de l’extension est utilisée
imagePullSecrets Secret Kubernetes à utiliser pour l’authentification auprès du registre de conteneurs lors de l’extraction de l’image conteneur. Non N/A
probes.readiness.httpGet.path Chemin d’URI à utiliser pour des sondes de préparation du conteneur Non /status-0123456789abcdef
probes.readiness.httpGet.port Port à utiliser pour des probes liveness du conteneur Non http
probes.liveness.httpGet.path Chemin d’URI à utiliser pour des sondes liveness du conteneur Non /status-0123456789abcdef
probes.liveness.httpGet.port Port à utiliser pour des probes liveness du conteneur Non http
highAvailability.enabled Indique si la passerelle doit être planifiée à haute disponibilité dans le cluster. Non false
highAvailability.disruption.maximumUnavailable Nombre de pods autorisés à être indisponibles en raison d’interruptions volontaires. Non 25%
highAvailability.podTopologySpread.whenUnsatisfiable Indication de la façon dont les pods doivent être répartis entre les nœuds au cas où l’exigence ne peut pas être satisfaite. En savoir plus sur la documentation Kubernetes Non ScheduleAnyway
resources Possibilité de définir des ressources processeur/mémoire à attribuer à la passerelle Non N/A
nodeSelector Possibilité d’utiliser des sélecteurs pour identifier le nœud sur lequel la passerelle doit s’exécuter. Non N/A
affinity Affinité pour la planification des pods (docs) Non N/A
tolerations Tolérances pour la planification des pods (docs) Non N/A

Étapes suivantes