Referencia: valores de configuración de Azure Arc de la puerta de enlace autohospedada
SE APLICA A: Desarrollador | Premium
En este artículo se proporciona una referencia para los valores obligatorios y opcionales que se usan para configurar la extensión de Azure Arc para el contenedor de la puerta de enlace autohospedada de API Management.
Importante
La puerta de enlace autohospedada de API Management en Azure Arc está actualmente en versión preliminar. Durante la versión preliminar, la extensión de puerta de enlace de API Management está disponible en las siguientes regiones:
- Asia (Este, Sudeste)
- Australia (Centro, Centro 2, Este y Sudeste)
- Brasil (Sur y Sudeste)
- Canadá (Centro, Este)
- Europa (Norte, Oeste)
- Francia (Centro y Sur)
- Alemania (Norte y Centro-oeste)
- India (Centro, Sur, Oeste, Centro de Jio y Jio Oeste)
- Japón (Este y Oeste)
- Corea (Centro y Sur)
- Noruega (Este y Oeste)
- Sudáfrica (Norte y Oeste)
- Suecia (Centro)
- Suiza (Norte y Oeste)
- Emiratos Árabes Unidos (Emiratos Árabes Unidos - Centro y Norte)
- Reino Unido (RU-Sur)
- Estados Unidos (EE. UU. - Centro, Centro de EUAP, Este, Este 2, Este de EUAP 2, Centro-norte, Centro-sur, Centro-oeste, Oeste, Oeste 2, Oeste 3)
Integración de la API de configuración
La puerta de enlace autohospedada usa la API de configuración para conectarse a Azure API Management con la finalidad de obtener la configuración más reciente y enviar métricas, cuando esta opción está habilitada.
Esta es una introducción a todas las opciones de configuración:
| Nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
gateway.configuration.uri |
Punto de conexión de configuración de Azure API Management para la puerta de enlace autohospedada. Busque este valor en Azure Portal en Puertas de enlace>Implementación. | Sí | N/D |
gateway.auth.token |
Clave de autenticación para autenticarse en el servicio Azure API Management. Normalmente empieza por GatewayKey. |
Sí | N/D |
gateway.configuration.backup.enabled |
Si está habilitada, almacenará una copia de seguridad de la configuración descargada más reciente en un volumen de almacenamiento | false |
|
gateway.configuration.backup.persistentVolumeClaim.accessMode |
Modo de acceso para el pod de notificación de volumen persistente (PVC) | ReadWriteMany |
|
gateway.configuration.backup.persistentVolumeClaim.size |
Tamaño de la notificación de volumen persistente (PVC) que se va a crear | 50Mi |
|
gateway.configuration.backup.persistentVolumeClaim.storageClassName |
Nombre de clase de almacenamiento que se usará para la notificación de volumen persistente (PVC). Cuando no se asigne ningún valor (null), se usará el valor predeterminado de la plataforma. La clase de almacenamiento especificada debe admitir el modo de acceso ReadWriteMany. Obtenga más información sobre los proveedores de volúmenes admitidos y sus modos de acceso admitidos. |
null |
Detección y sincronización entre instancias
| Nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
service.instance.heartbeat.port |
Puerto UDP usado para instancias de una implementación de puerta de enlace autohospedada para enviar latidos a otras instancias. | No | 4291 |
service.instance.synchronization.port |
Puerto UDP usado para instancias de puerta de enlace autohospedada para sincronizar la limitación de velocidad entre varias instancias. | No | 4290 |
Métricas
| Nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
telemetry.metrics.cloud |
Indica si se va a habilitar la emisión de métricas para Azure Monitor o no. | No | true |
telemetry.metrics.local |
Habilite la recopilación de métricas locales mediante StatsD. El valor es una de las siguientes opciones: none, statsd. |
No | N/D |
telemetry.metrics.localStatsd.endpoint |
Punto de conexión de StatsD. | Sí, si telemetry.metrics.local se establece en statsd; en caso contrario, no. |
N/D |
telemetry.metrics.localStatsd.sampling |
Frecuencia de muestreo de las métricas de StatsD. El valor debe estar entre 0 y 1, por ejemplo, 0,5. | No | N/D |
telemetry.metrics.localStatsd.tagFormat |
Formato de etiquetado del exportador de StatsD. El valor es una de las siguientes opciones: ibrato, dogStatsD, influxDB. |
No | N/D |
telemetry.metrics.opentelemetry.enabled |
Indica si se va a habilitar la emisión de métricas para un recopilador de OpenTelemetry en Kubernetes o no. | No | false |
telemetry.metrics.opentelemetry.collector.uri |
URI del recopilador de OpenTelemetry al que se van a enviar las métricas. | Sí, si observability.opentelemetry.enabled se establece en true; en caso contrario, no. |
N/D |
Registros
| Nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
telemetry.logs.std |
Habilite el registro en un flujo estándar. El valor es una de las siguientes opciones: none, text, json. |
No | text |
telemetry.logs.local |
Habilite el registro local. El valor es una de las siguientes opciones: none, auto, localsyslog, rfc5424, journal, json |
No | auto |
telemetry.logs.localConfig.localsyslog.endpoint |
Punto de conexión para syslogs locales | Sí, si telemetry.logs.local se establece en localsyslog; en caso contrario, no. |
N/D |
telemetry.logs.localConfig.localsyslog.facility |
Especifica el código de componente de syslogs locales, por ejemplo: 7. |
No | N/D |
telemetry.logs.localConfig.rfc5424.endpoint |
rfc5424 endpoint. | Sí, si telemetry.logs.local se establece en rfc5424; en caso contrario, no. |
N/D |
telemetry.logs.localConfig.rfc5424.facility |
Código de componente por rfc5424; por ejemplo, 7 |
No | N/D |
telemetry.logs.localConfig.journal.endpoint |
Punto de conexión del diario. | Sí, si telemetry.logs.local se establece en journal; en caso contrario, no. |
N/D |
Enrutamiento del tráfico
| Nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
service.type |
Tipo de servicio de Kubernetes que se va a usar para exponer la puerta de enlace. (documentación) | No | ClusterIP |
service.http.port |
Puerto que se va a usar para exponer el tráfico HTTP. | No | 8080 |
service.http.nodePort |
Puerto en el nodo que se va a usar para exponer el tráfico HTTP. Esto requiere NodePort como tipo de servicio. |
No | N/D |
service.https.port |
Puerto que se va a usar para exponer el tráfico HTTPS. | No | 8081 |
service.https.nodePort |
Puerto en el nodo que se va a usar para exponer el tráfico HTTPS. Esto requiere NodePort como tipo de servicio. |
No | N/D |
service.annotations |
Anotaciones que se van a agregar al servicio Kubernetes para la puerta de enlace. | No | N/D |
ingress.annotations |
Anotaciones que se van a agregar a la entrada Kubernetes para la puerta de enlace. (experimental) | No | N/D |
ingress.enabled |
Indicación de si se debería usar o no la entrada de Kubernetes. (experimental) | No | false |
ingress.tls |
Configuración de TLS para la entrada de Kubernetes. (experimental) | No | N/D |
ingress.hosts |
Configuración de hosts que se van a usar para la entrada de Kubernetes. (experimental) | No | N/D |
Integraciones
La puerta de enlace autohospedada se integra con otras tecnologías. En esta sección se proporciona información general sobre las opciones de configuración disponibles que puede usar.
Dapr
| Nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
dapr.enabled |
Indicación de si se debe usar la integración de Dapr o no. | No | false |
dapr.app.id |
Identificador de aplicación que se va a usar para la integración de Dapr | None | |
dapr.config |
Define qué configuración debería usar Dapr de CRD | tracing |
|
dapr.logging.level |
Nivel de detalle del registro de sidecar de Dapr | info |
|
dapr.logging.useJsonOutput |
Indicación de si el registro debería estar en formato JSON | true |
Azure Monitor
| Nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
monitoring.customResourceId |
Identificador de recurso del área de trabajo de Azure Log Analytics a la que enviar registros. | No | N/D |
monitoring.ingestionKey |
Clave de ingesta para autenticarse con el área de trabajo de Azure Log Analytics a la que enviar registros. | No | N/D |
monitoring.workspaceId |
Identificador de área de trabajo del área de trabajo de Azure Log Analytics a la que enviar registros. | No | N/D |
Programación de imágenes y cargas de trabajo
Kubernetes es una plataforma de orquestación eficaz que proporciona mucha flexibilidad en lo que se debería implementar y cómo se debería programar.
En esta sección se proporciona información general sobre las opciones de configuración disponibles que puede usar para influir en la imagen que se usa y de cómo se programa y configura para la recuperación automática.
| Nombre | Descripción | Necesario | Valor predeterminado |
|---|---|---|---|
replicaCount |
Número de instancias de la puerta de enlace autohospedada que se va a ejecutar. | No | 3 |
image.repository |
Imagen que se va a ejecutar. | No | mcr.microsoft.com/azure-api-management/gateway |
image.pullPolicy |
Directiva que se va a usar para extraer imágenes de contenedor. | No | IfNotPresent |
image.tag |
Etiqueta de imagen del contenedor que se va a usar. | No | Se usa la versión de la aplicación de la extensión |
imagePullSecrets |
Secreto de Kubernetes que se va a usar para autenticarse con el registro de contenedor al extraer la imagen de contenedor. | No | N/D |
probes.readiness.httpGet.path |
Ruta de acceso del URI que se va a usar para los sondeos de preparación del contenedor | No | /status-0123456789abcdef |
probes.readiness.httpGet.port |
Puerto que se va a usar para sondeos de ejecución del contenedor | No | http |
probes.liveness.httpGet.path |
Ruta de acceso del URI que se va a usar para sondeos de ejecución del contenedor | No | /status-0123456789abcdef |
probes.liveness.httpGet.port |
Puerto que se va a usar para sondeos de ejecución del contenedor | No | http |
highAvailability.enabled |
Indicación de si la puerta de enlace debería estar programada con alta disponibilidad en el clúster. | No | false |
highAvailability.disruption.maximumUnavailable |
Cantidad de pods que pueden no estar disponibles debido a interrupciones voluntarias. | No | 25% |
highAvailability.podTopologySpread.whenUnsatisfiable |
Indicación de cómo se deben distribuir los pods entre nodos en caso de que no se pueda cumplir el requisito. Puede consultar más información en la documentación de Kubernetes | No | ScheduleAnyway |
resources |
Capacidad de definir recursos de CPU y memoria para asignar a la puerta de enlace | No | N/D |
nodeSelector |
Capacidad para usar selectores para identificar el nodo en el que se debería ejecutar la puerta de enlace. | No | N/D |
affinity |
Afinidad de la programación de pods (documentación) | No | N/D |
tolerations |
Tolerancias de la programación de pods (documentos) | No | N/D |
Pasos siguientes
- Obtenga más información sobre las instrucciones para ejecutar la puerta de enlace autohospedada en Kubernetes en producción.
- Implementación de una puerta de enlace autohospedada en Docker
- Implementación de una puerta de enlace autohospedada en Kubernetes
- Implementación de una puerta de enlace autohospedada en el clúster de Kubernetes habilitado para Azure Arc
- Habilitación de la compatibilidad con Dapr en la puerta de enlace autohospedada
- Más información sobre las opciones de configuración de la imagen de contenedor de puerta de enlace autohospedada