Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
S’APPLIQUE À : Développeur | Premium
Cet article fournit une référence pour les paramètres nécessaires et optionnels pour configurer l’extension Azure Arc pour le conteneur passerelle auto-hébergé de gestion d’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 et 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 API de configuration
La passerelle auto-hébergée utilise l’API de configuration pour se connecter à Gestion des API Azure afin d’obtenir les dernières configurations et envoyer les métriques, lorsqu’elle est activée.
Voici un aperçu de toutes les options de configuration :
| Nom | Description | Obligatoire | Par défaut |
|---|---|---|---|
gateway.configuration.uri |
Terminaison de configuration dans Gestion des API Azure pour la passerelle auto-hébergée. Trouvez cette valeur dans le portail Azure sous Déploiement des passerelles>. | Yes | N/A |
gateway.auth.token |
Clé d’authentification pour s’authentifier avec le service Gestion des API Azure. Elle commence généralement par GatewayKey. |
Yes | N/A |
gateway.configuration.backup.enabled |
Si activé, stocke une copie de sauvegarde de la dernière configuration téléchargée sur un volume de stockage. | Non | false |
gateway.configuration.backup.persistentVolumeClaim.accessMode |
Mode d’accès pour le pod de revendication de volume persistant (PVC). | Non | ReadWriteMany |
gateway.configuration.backup.persistentVolumeClaim.size |
Taille de la revendication de volume persistant (PVC) à créer. | Non | 50Mi |
gateway.configuration.backup.persistentVolumeClaim.storageClassName |
Nom de classe de stockage à utiliser pour la revendication de volume persistant (PVC). Lorsque vous n’attribuez pas de valeur (null), la plateforme utilise la valeur par défaut. La classe de stockage spécifiée doit prendre en charge ReadWriteMany le mode accès. En savoir plus sur les fournisseurs de volumes pris en charge et leurs modes d’accès pris en charge. |
Non | null |
Découverte et synchronisation entre instances
| Nom | Description | Obligatoire | Par défaut |
|---|---|---|---|
service.instance.heartbeat.port |
Portage UDP que les instances d’un déploiement de passerelle auto-hébergée utilisent pour envoyer des battements de cœur à d’autres instances. | Non | 4291 |
service.instance.synchronization.port |
Port UDP que les instances de passerelle auto-hébergées utilisent pour synchroniser la limitation de débit sur plusieurs instances. | Non | 4290 |
Metrics
| Nom | Description | Obligatoire | Par défaut |
|---|---|---|---|
telemetry.metrics.cloud |
Indiquez s’il faut activer les métriques d’émission sur Azure Monitor. | Non | true |
telemetry.metrics.local |
Activez la collecte locale de métriques via StatsD. La valeur est l’une des options suivantes : none, statsd. |
Non | N/A |
telemetry.metrics.localStatsd.endpoint |
Endpoint StatsD. | Oui, si telemetry.metrics.local est défini à statsd; sinon non. |
N/A |
telemetry.metrics.localStatsd.sampling |
Statistiques Metrics Taux d’échantillonnage. 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 : librato, dogStatsD, influxDB. |
Non | N/A |
telemetry.metrics.opentelemetry.enabled |
Indiquer s’il faut activer les métriques d’émission à un collecteur OpenTelemetry sur Kubernetes. | Non | false |
telemetry.metrics.opentelemetry.collector.uri |
URI du collecteur OpenTelemetry à qui envoyer des métriques. | Oui, si observability.opentelemetry.enabled est défini à true; sinon non. |
N/A |
Logs
| Nom | Description | Obligatoire | Par défaut |
|---|---|---|---|
telemetry.logs.std |
Activez la connexion d’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, rfc5424journal, ,json |
Non | auto |
telemetry.logs.localConfig.localsyslog.endpoint |
Endpoint pour les syslogs locaux | Oui, si telemetry.logs.local est défini à localsyslog; sinon non. |
N/A |
telemetry.logs.localConfig.localsyslog.facility |
Spécifie le code de facilité syslog local, par exemple, 7. |
Non | N/A |
telemetry.logs.localConfig.rfc5424.endpoint |
Terminaison RFC5424. | Oui, si telemetry.logs.local est défini à rfc5424; sinon non. |
N/A |
telemetry.logs.localConfig.rfc5424.facility |
Le code de l’installation selon le rfc5424, par exemple, 7 |
Non | N/A |
telemetry.logs.localConfig.journal.endpoint |
Point de terminaison du journal. | Oui, si telemetry.logs.local est défini à journal; sinon non. |
N/A |
Routage du trafic
| Nom | Description | Obligatoire | Par défaut |
|---|---|---|---|
service.type |
Type de service Kubernetes à utiliser pour exposer la passerelle. (Types de services Kubernetes) | Non | ClusterIP |
service.http.port |
Un port à utiliser pour exposer le trafic HTTP. | Non | 8080 |
service.http.nodePort |
Un port sur le nœud pour exposer le trafic HTTP. Ce paramètre nécessite NodePort comme type de service. |
Non | N/A |
service.https.port |
Un port à utiliser pour exposer le trafic HTTPS. | Non | 8081 |
service.https.nodePort |
Un port sur le nœud pour exposer le trafic HTTPS. Ce paramètre 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. (support expérimental Kubernetes Ingress) | Non | N/A |
ingress.enabled |
Indiquer s’il faut ou non utiliser Kubernetes Ingress. (support expérimental Kubernetes Ingress) | Non | false |
ingress.tls |
Configuration TLS pour Kubernetes Ingress. (support expérimental Kubernetes Ingress) | Non | N/A |
ingress.hosts |
Configuration des hôtes à utiliser pour Kubernetes Ingress. (support expérimental Kubernetes Ingress) | Non | N/A |
Integrations
La passerelle auto-hébergée s’intègre à diverses autres technologies. Cette section offre un aperçu des options de configuration que vous pouvez utiliser.
Dapr
| Nom | Description | Obligatoire | Par défaut |
|---|---|---|---|
dapr.enabled |
Indique s’il faut utiliser l’intégration Dapr. | Non | false |
dapr.app.id |
ID d’application à utiliser pour l’intégration Dapr. | Non | None |
dapr.config |
Définit quelle configuration CRD Dapr doit utiliser. | Non | tracing |
dapr.logging.level |
Niveau de verbosité du journal du sidecar Dapr. | Non | info |
dapr.logging.useJsonOutput |
Indique si la journalisation est au format JSON. | Non | true |
Moniteur de Azure
| Nom | Description | Obligatoire | Par défaut |
|---|---|---|---|
monitoring.customResourceId |
ID de ressource de l’espace de travail Azure Log Analytics pour envoyer les journaux. | Non | N/A |
monitoring.ingestionKey |
Clé d’ingestion pour s’authentifier avec l’espace de travail Azure Log Analytics pour envoyer les journaux. | Non | N/A |
monitoring.workspaceId |
ID de l’espace de travail de l’espace de travail Azure Log Analytics pour envoyer les journaux. | Non | N/A |
Planification des images et des charges de travail
Kubernetes est une plateforme d’orchestration puissante qui offre beaucoup de flexibilité quant à ce qui doit être déployé et à la manière dont il doit être planifié.
Cette section offre un aperçu des options de configuration disponibles que vous pouvez utiliser pour influencer l’image utilisée, comment elle est programmée et configurée pour s’auto-guérir.
| Nom | Description | Obligatoire | Par défaut |
|---|---|---|---|
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 |
Politique à utiliser pour extraire les images du conteneur. | Non | IfNotPresent |
image.tag |
Étiquette image conteneur à utiliser. | Non | La version de l’extension de l’application est utilisée |
imagePullSecrets |
Le secret Kubernetes à utiliser pour l’authentification avec le registre conteneur lors de l’extraction de l’image conteneur. | Non | N/A |
probes.readiness.httpGet.path |
Chemin URI pour utiliser les sondes de préparation du conteneur | Non | /status-0123456789abcdef |
probes.readiness.httpGet.port |
Port destiné à utiliser pour les sondes de vivacité du conteneur | Non | http |
probes.liveness.httpGet.path |
Chemin URI à utiliser pour les sondes de vivacité du conteneur | Non | /status-0123456789abcdef |
probes.liveness.httpGet.port |
Port destiné à utiliser pour les sondes de vivacité du conteneur | Non | http |
highAvailability.enabled |
Indiquer si la passerelle doit être programmée en haute disponibilité dans le cluster. | Non | false |
highAvailability.disruption.maximumUnavailable |
Nombre de pods autorisés à être indisponibles en raison de perturbations volontaires. | Non | 25% |
highAvailability.podTopologySpread.whenUnsatisfiable |
Indique comment les pods doivent être répartis sur les nœuds au cas où l’exigence ne pourrait pas être satisfaite. Pour en savoir plus, consultez la documentation de Kubernetes | Non | ScheduleAnyway |
resources |
Capacité à définir des ressources CPU/mémoire à attribuer à la passerelle | Non | N/A |
nodeSelector |
Capacité à utiliser des sélecteurs pour identifier le nœud sur lequel la passerelle doit fonctionner. | Non | N/A |
affinity |
Affinité pour la planification des pods (affinité des nœuds Kubernetes) | Non | N/A |
tolerations |
Tolérances pour la planification des pods (taints et tolérances de Kubernetes) | Non | N/A |
Contenu connexe
- Découvrez les conseils pour faire fonctionner la passerelle auto-hébergée sur Kubernetes en production
- Déploiement de passerelle auto-hébergée vers Docker
- Déploiement de passerelle auto-hébergée vers Kubernetes
- Déployer une passerelle auto-hébergée sur un cluster Kubernetes avec Azure Arc
- Activez la prise en charge de Dapr sur une passerelle auto-hébergée
- En savoir plus sur les options de configuration pour l’image du conteneur de passerelle auto-hébergée