Справочник. Параметры конфигурации локального шлюза Azure Arc
ОБЛАСТЬ ПРИМЕНЕНИЯ: Разработчик | Премиум
В этой статье приведена ссылка на обязательные и необязательные параметры, которые используются для настройки расширения Azure Arc для Управление API локальном контейнере шлюза.
Внимание
Локальный шлюз Управления API в Azure Arc в настоящее время находится на этапе предварительной версии. Во время предварительной версии расширение шлюза Управление API доступно в следующих регионах:
- Азия (восточная, юго-восточная часть)
- Австралия (центральная, центральная 2, восточная и юго-восточная часть)
- Бразилия (южная и юго-восточная часть)
- Канада (Центральная, Восточная)
- Европа (Север, Запад)
- Франция (центральная и южная часть)
- Германия (северная и западная центральная часть)
- Индия (Центральная, Южная, Западная, Jio central и Jio West)
- Япония (восточная и западная часть)
- Корея (центральная и южная часть)
- Норвегия (восточная и западная часть)
- Южная Африка (северная и западная часть)
- Швеция (Центральная)
- Швейцария (северная и западная часть)
- Объединенные Арабские Эмираты (ОАЭ - Центральная и Северная)
- Соединенное Королевство (Великобритания -Юг)
- США (США — центральная, центральная часть ЕСАП, восточная часть 2, восточная часть 2 EUAP, северная центральная часть, центральная часть, западная часть, западная часть 2, западная часть 3)
Интеграция API конфигурации
API конфигурации используется локальным шлюзом для подключения к Azure Управление API для получения последней конфигурации и отправки метрик при включении.
Ниже приведен обзор всех параметров конфигурации:
Имя | Описание | Обязательное поле | По умолчанию. |
---|---|---|---|
gateway.configuration.uri |
Конечная точка конфигурации в Управлении API Azure для локального шлюза. Найдите это значение на портале Azure в разделе Шлюзы>Развертывание. | Да | Н/П |
gateway.auth.token |
Ключ проверки подлинности для проверки подлинности в службе Управление API Azure. Обычно начинается с GatewayKey . |
Да | Н/П |
gateway.configuration.backup.enabled |
Если включена копия резервной копии последней скачаемой конфигурации на томе хранилища | false |
|
gateway.configuration.backup.persistentVolumeClaim.accessMode |
Режим доступа для модуля pod "Постоянное утверждение тома" (ПВХ) | ReadWriteMany |
|
gateway.configuration.backup.persistentVolumeClaim.size |
Размер создаваемого утверждения постоянного тома (ПВХ) | 50Mi |
|
gateway.configuration.backup.persistentVolumeClaim.storageClassName |
служба хранилища имя класса, используемое для утверждения постоянного тома (ПВХ). Если значение не назначено (null ), используется значение по умолчанию платформы. Указанный класс хранилища должен поддерживать ReadWriteMany режим доступа, узнать больше о поддерживаемых поставщиках томов и поддерживаемых режимах доступа. |
null |
Обнаружение и синхронизация между экземплярами
Имя | Описание | Обязательное поле | По умолчанию. |
---|---|---|---|
service.instance.heartbeat.port |
Порт UDP, используемый для экземпляров локального развертывания шлюза для отправки пульса другим экземплярам. | No | 4291 |
service.instance.synchronization.port |
Порт UDP, используемый для экземпляров локального шлюза для синхронизации ограничения скорости между несколькими экземплярами. | No | 4290 |
Метрики
Имя | Описание | Обязательное поле | По умолчанию. |
---|---|---|---|
telemetry.metrics.cloud |
Указывает, следует ли включать отправку метрик в Azure Monitor. | No | true |
telemetry.metrics.local |
Включите локальный сбор метрик с помощью StatsD. Значение является одним из следующих параметров: none , statsd . |
No | Н/П |
telemetry.metrics.localStatsd.endpoint |
Конечная точка StatsD. | Да, если для telemetry.metrics.local задано значение statsd ; в противном случае — нет. |
Н/П |
telemetry.metrics.localStatsd.sampling |
Частота выборки метрик StatsD. Значение должно входит в диапазон 0–1 (по умолчанию: 0,5). | No | Н/П |
telemetry.metrics.localStatsd.tagFormat |
Формат тегирования экспортера StatsD. Значение является одним из следующих параметров: ibrato , dogStatsD , influxDB . |
No | Н/П |
telemetry.metrics.opentelemetry.enabled |
Указывает, следует ли включать отправку метрик в сборщик OpenTelemetry в Kubernetes. | No | false |
telemetry.metrics.opentelemetry.collector.uri |
URI сборщика OpenTelemetry для отправки метрик. | Да, если для observability.opentelemetry.enabled задано значение true ; в противном случае — нет. |
Н/П |
Журналы
Имя | Описание | Обязательное поле | По умолчанию. |
---|---|---|---|
telemetry.logs.std |
Включите запись журнала в стандартный поток. Значение является одним из следующих параметров: none , text , json . |
No | text |
telemetry.logs.local |
Включите локальное ведение журнала. Значение является одним из следующих параметров: none , auto , localsyslog , rfc5424 journal json |
No | auto |
telemetry.logs.localConfig.localsyslog.endpoint |
Конечная точка для локальных системных журналов | Да, если для telemetry.logs.local задано значение localsyslog ; в противном случае — нет. |
Н/П |
telemetry.logs.localConfig.localsyslog.facility |
Указывает код объекта локального системного журнала, например7 . |
No | Н/П |
telemetry.logs.localConfig.rfc5424.endpoint |
Конечная точка rfc5424. | Да, если для telemetry.logs.local задано значение rfc5424 ; в противном случае — нет. |
Н/П |
telemetry.logs.localConfig.rfc5424.facility |
Код объекта для rfc5424, например 7 |
No | Н/П |
telemetry.logs.localConfig.journal.endpoint |
Конечная точка журнала. | Да, если для telemetry.logs.local задано значение journal ; в противном случае — нет. |
Н/П |
Маршрутизация трафика
Имя | Описание | Обязательное поле | По умолчанию. |
---|---|---|---|
service.type |
Тип службы Kubernetes, используемой для предоставления доступа к шлюзу. (документы) | No | ClusterIP |
service.http.port |
Порт, используемый для предоставления трафика HTTP. | No | 8080 |
service.http.nodePort |
Порт на узле, используемый для предоставления трафика HTTP. Для этого требуется NodePort тип службы. |
No | Н/П |
service.https.port |
Порт, используемый для предоставления трафика HTTPS. | No | 8081 |
service.https.nodePort |
Порт на узле, используемый для предоставления трафика HTTPS. Для этого требуется NodePort тип службы. |
No | Н/П |
service.annotations |
Заметки для добавления в службу Kubernetes для шлюза. | No | Н/П |
ingress.annotations |
Заметки для добавления в входящий трафик Kubernetes для шлюза. (экспериментальный) | No | Н/П |
ingress.enabled |
Указывает, следует ли использовать входящий трафик Kubernetes. (экспериментальный) | No | false |
ingress.tls |
Конфигурация TLS для входящего трафика Kubernetes. (экспериментальный) | No | Н/П |
ingress.hosts |
Настройка узлов, используемых для входящего трафика Kubernetes. (экспериментальный) | No | Н/П |
Интеграции
Локальный шлюз интегрируется с различными другими технологиями. В этом разделе представлен обзор доступных параметров конфигурации, которые можно использовать.
Dapr
Имя | Описание | Обязательное поле | По умолчанию. |
---|---|---|---|
dapr.enabled |
Указывает, следует ли использовать интеграцию Dapr. | No | false |
dapr.app.id |
Идентификатор приложения для интеграции Dapr | нет | |
dapr.config |
Определяет, какую конфигурацию CRD Dapr следует использовать | tracing |
|
dapr.logging.level |
Уровень детализации журнала бокового автомобиля Dapr | info |
|
dapr.logging.useJsonOutput |
Указание того, должен ли ведение журнала быть в формате JSON | true |
Azure Monitor
Имя | Описание | Обязательное поле | По умолчанию. |
---|---|---|---|
monitoring.customResourceId |
Идентификатор ресурса рабочей области Azure Log Analytics для отправки журналов. | No | Н/П |
monitoring.ingestionKey |
Ключ приема для проверки подлинности в рабочей области Azure Log Analytics для отправки журналов. | No | Н/П |
monitoring.workspaceId |
Идентификатор рабочей области Azure Log Analytics для отправки журналов. | No | Н/П |
Планирование образов и рабочих нагрузок
Kubernetes — это мощная платформа оркестрации, которая обеспечивает большую гибкость в развертывании и планировании.
В этом разделе представлен обзор доступных параметров конфигурации, которые можно использовать для влияния на используемый образ, способ планирования и настройки самостоятельного лечения.
Имя | Описание | Обязательное поле | По умолчанию. |
---|---|---|---|
replicaCount |
Количество экземпляров локального шлюза для запуска. | No | 3 |
image.repository |
Образ для запуска. | No | mcr.microsoft.com/azure-api-management/gateway |
image.pullPolicy |
Политика, используемая для извлечения образов контейнеров. | No | IfNotPresent |
image.tag |
Тег образа контейнера для использования. | No | Используется версия расширения приложения |
imagePullSecrets |
Секрет Kubernetes, используемый для проверки подлинности с помощью реестра контейнеров при извлечении образа контейнера. | No | Н/П |
probes.readiness.httpGet.path |
Путь URI для использования для проверки готовности контейнера | No | /status-0123456789abcdef |
probes.readiness.httpGet.port |
Порт, используемый для проб активности контейнера | No | http |
probes.liveness.httpGet.path |
Путь URI для использования для проб активности контейнера | No | /status-0123456789abcdef |
probes.liveness.httpGet.port |
Порт, используемый для проб активности контейнера | No | http |
highAvailability.enabled |
Указывает, следует ли запланировать высокодоступный шлюз в кластере. | No | false |
highAvailability.disruption.maximumUnavailable |
Количество модулей pod, которые могут быть недоступны из-за добровольных нарушений. | No | 25% |
highAvailability.podTopologySpread.whenUnsatisfiable |
Указание того, как модули pod должны распространяться по узлам в случае, если требование не может быть выполнено. Дополнительные сведения см. в документации Kubernetes | No | ScheduleAnyway |
resources |
Возможность определения ресурсов ЦП и памяти для назначения шлюзу | No | Н/П |
nodeSelector |
Возможность использовать селекторы для идентификации узла, на котором должен выполняться шлюз. | No | Н/П |
affinity |
Сходство для планирования pod (документация) | No | Н/П |
tolerations |
Поддержка для планирования модулей pod (документация) | No | Н/П |
Следующие шаги
- Дополнительные указания по запуску локального шлюза в Kubernetes в рабочей среде
- Развертывание локального шлюза в Docker
- Развертывание локального шлюза в Kubernetes
- Развертывание локального шлюза в кластере Kubernetes с поддержкой Azure Arc
- Включение поддержки Dapr в локальном шлюзе
- Дополнительные сведения о параметрах конфигурации для образа контейнера локального шлюза