Compartilhar via

Referência: definições da configuração do Azure Arc do gateway auto-hospedado

  • Artigo

APLICA-SE A: Desenvolvedor | Premium

Este artigo fornece uma referência para as configurações obrigatórias e opcionais usadas para configurar a extensão do Azure Arc para o contêiner de gateway auto-hospedado do Gerenciamento de API.

Importante

Atualmente, o gateway auto-hospedado do Gerenciamento de API no Azure Arc está em versão prévia. Durante a versão prévia, a extensão de gateway do Gerenciamento de API está disponível nas seguintes regiões:

  • Ásia (Leste, Sudeste)
  • Austrália (Central, Central 2, Leste e Sudeste)
  • Brasil (Sul e Sudeste)
  • Canadá (Central, Leste)
  • Europa (Norte, Oeste)
  • França (Centro & Sul)
  • Alemanha (Norte e Centro-Oeste)
  • Índia (Central, Sul, Oeste, Jio central & Jio Oeste)
  • Japão (Leste e Oeste)
  • Coreia (Central & Sul)
  • Noruega (Leste e Oeste)
  • África do Sul (Norte e Oeste)
  • Suécia (Central)
  • Suíça (Norte e Oeste)
  • Emirados Árabes Unidos (Emirados Árabes Unidos - Central & Norte)
  • Reino Unido (UK – Sul)
  • Estados Unidos (EUA – Central, EUA Central, Leste, Leste 2, Leste 2 EUAP, Centro-Norte, Centro-Sul, Centro-Oeste, Oeste, Oeste 2, Oeste 3)

Integração da API de configuração

A API de Configuração é usada pelo gateway auto-hospedado para se conectar ao Gerenciamento de API do Azure para obter a configuração mais recente e enviar métricas, quando habilitada.

Aqui está uma visão geral de todas as opções de configuração:

Nome Descrição Obrigatório Padrão
gateway.configuration.uri Ponto de extremidade de configuração no Gerenciamento de API do Azure para o gateway auto-hospedado. Encontre este valor no portal do Azure em Gateways>Implantação. Sim N/D
gateway.auth.token Chave de autenticação para autenticação no serviço de Gerenciamento de API do Azure. Normalmente, começa com GatewayKey. Sim N/D
gateway.configuration.backup.enabled Se habilitado, armazenará uma cópia do backup da última configuração baixada em um volume de armazenamento false
gateway.configuration.backup.persistentVolumeClaim.accessMode Modo de acesso para o pod de Declaração do Volume Persistente (PVC) ReadWriteMany
gateway.configuration.backup.persistentVolumeClaim.size Tamanho da Declaração do Volume Persistente (PVC) a ser criado 50Mi
gateway.configuration.backup.persistentVolumeClaim.storageClassName Nome da classe de armazenamento a ser usada para a Declaração do Volume Persistente (PVC). Quando nenhum valor for atribuído (null), será usado o padrão da plataforma. A classe de armazenamento especificada deve ter suporte para o modo de acesso ReadWriteMany; saiba mais sobre os provedores de volume com suporte e seus modos de acesso suportados. null

Detecção entre instâncias e sincronização

Nome Descrição Obrigatório Padrão
service.instance.heartbeat.port Porta UDP usada para instâncias de uma implantação de gateway auto-hospedada para enviar pulsações para outras instâncias. Não 4291
service.instance.synchronization.port Porta UDP usada para instâncias de gateway auto-hospedadas para sincronizar a limitação de taxa em várias instâncias. Não 4290

Métricas

Nome Descrição Obrigatório Padrão
telemetry.metrics.cloud Indica se você deve ou não habilitar a emissão de métricas para o Azure Monitor. No true
telemetry.metrics.local Habilite a coleta de métricas locais por meio do StatsD. O valor é uma das seguintes opções: none, statsd. No N/D
telemetry.metrics.localStatsd.endpoint Ponto de extremidade StatsD. Sim, se telemetry.metrics.local estiver definido como statsd; caso contrário, não. N/D
telemetry.metrics.localStatsd.sampling Taxa de amostragem de métricas do StatsD. O valor deve estar entre 0 e 1, por exemplo, 0,5. Não N/D
telemetry.metrics.localStatsd.tagFormat Formato de marcaçãode exportador do StatsD. O valor é uma das seguintes opções: ibrato, dogStatsD, influxDB. Não N/D
telemetry.metrics.opentelemetry.enabled Indicação se deve ou não habilitar a emissão de métricas para um coletor OpenTelemetry no Kubernetes. No false
telemetry.metrics.opentelemetry.collector.uri URI do coletor OpenTelemetry para enviar métricas. Sim, se observability.opentelemetry.enabled estiver definido como true; caso contrário, não. N/D

Logs

Nome Descrição Obrigatório Padrão
telemetry.logs.std Habilite o registro em log em um fluxo padrão. O valor é uma das seguintes opções: none, text, json. Não text
telemetry.logs.local Habilite o registro em log local. O valor é uma das seguintes opções: none, auto, localsyslog, rfc5424, journal, json No auto
telemetry.logs.localConfig.localsyslog.endpoint Ponto de extremidade para syslogs locais Sim, se telemetry.logs.local estiver definido como localsyslog; caso contrário, não. N/D
telemetry.logs.localConfig.localsyslog.facility Especifica o código da instalação local do syslog , por exemplo, 7. Não N/D
telemetry.logs.localConfig.rfc5424.endpoint ponto de extremidade rfc5424. Sim, se telemetry.logs.local estiver definido como rfc5424; caso contrário, não. N/D
telemetry.logs.localConfig.rfc5424.facility Código de instalação por rfc5424, por exemplo, 7 Não N/D
telemetry.logs.localConfig.journal.endpoint Ponto de extremidade do diário. Sim, se telemetry.logs.local estiver definido como journal; caso contrário, não. N/D

Roteamento de tráfego

Nome Descrição Obrigatório Padrão
service.type Tipo de serviço do Kubernetes que será usado para expor o gateway. Porta (documentação) Não ClusterIP
service.http.port Porta a ser usada para expor o tráfego HTTP. Não 8080
service.http.nodePort Porta no nó a ser usada para expor o tráfego HTTP. Isso requer NodePort como tipo de serviço. Não N/D
service.https.port Porta a ser usada para expor o tráfego HTTPS. Não 8081
service.https.nodePort Porta no nó a ser usada para expor o tráfego HTTPS. Isso requer NodePort como tipo de serviço. Não N/D
service.annotations Anotações a serem adicionadas ao serviço de Kubernetes para o gateway. Não N/D
ingress.annotations Anotações a serem adicionadas à Entrada do Kubernetes para o gateway. (experimental) Não N/D
ingress.enabled Indicação se a Entrada do Kubernetes deve ou não ser usada. (experimental) Não false
ingress.tls Configuração de TLS para a Entrada do Kubernetes. (experimental) Não N/D
ingress.hosts Configuração dos hosts a serem usados na Entrada do Kubernetes. (experimental) Não N/D

Integrações

O gateway auto-hospedado se integra a várias outras tecnologias. Esta seção fornece uma visão geral das opções de configuração disponíveis que podem ser usadas.

Dapr

Nome Descrição Obrigatório Padrão
dapr.enabled Indicação se a integração do Dapr deve ou não ser usada. Não false
dapr.app.id ID do aplicativo a ser usado para integração com o Dapr Nenhum
dapr.config Define qual configuração o Dapr de CRD deve usar tracing
dapr.logging.level Nível de detalhamento do registro do sidecar do Dapr info
dapr.logging.useJsonOutput Indicação se o registro em log deve ou não estar no formato JSON true

Azure Monitor

Nome Descrição Obrigatório Padrão
monitoring.customResourceId ID do recurso do workspace do Azure Log Analytics para o qual enviar os logs. Não N/D
monitoring.ingestionKey Chave de ingestão para autenticar com o workspace do Log Analytics do Azure para enviar logs. Não N/D
monitoring.workspaceId ID do workspace do Azure Log Analytics para o qual enviar os logs. Não N/D

Imagem & agendamento de carga de trabalho

O Kubernetes é uma poderosa plataforma de orquestração que oferece muita flexibilidade no que deve ser implantado e como deve ser agendado.

Esta seção fornece uma visão geral das opções de configuração disponíveis que podem ser usadas para influenciar a imagem usada, como ela é agendada e configurada para autorrecuperação.

Nome Descrição Obrigatório Padrão
replicaCount Número de instâncias do gateway auto-hospedado a serem executadas. Não 3
image.repository Imagem a ser executada. Não mcr.microsoft.com/azure-api-management/gateway
image.pullPolicy Política a ser usada para pull das imagens do contêiner. Não IfNotPresent
image.tag Marca da imagem do contêiner que deve ser usada. Não A versão do aplicativo da extensão está sendo usada
imagePullSecrets Segredo do Kubernetes a ser usado para autenticação com o registro de contêiner ao efetuar pull da imagem do contêiner. Não N/D
probes.readiness.httpGet.path Caminho do URI a ser usado para investigações de preparação do contêiner Não /status-0123456789abcdef
probes.readiness.httpGet.port Porta a ser usada para investigações de atividades do contêiner Não http
probes.liveness.httpGet.path Caminho do URI a ser usado para investigações de atividade do contêiner Não /status-0123456789abcdef
probes.liveness.httpGet.port Porta a ser usada para investigações de atividades do contêiner Não http
highAvailability.enabled Indicação se o gateway deve ou não ser agendado altamente disponível no cluster. Não false
highAvailability.disruption.maximumUnavailable Quantidade de pods que podem ficar indisponíveis devido a interrupções voluntárias. Não 25%
highAvailability.podTopologySpread.whenUnsatisfiable Indicação de como os pods devem ser distribuídos entre os nós, caso os requisitos não possam ser atendidos. Saiba mais na documentação do Kubernetes Não ScheduleAnyway
resources Capacidade de definir recursos de CPU/Memória a serem atribuídos ao gateway Não N/D
nodeSelector Capacidade de usar seletores para identificar o nó no qual o gateway deve ser executado. Não N/D
affinity Afinidade com o agendamento de pods (documentação) Não N/D
tolerations Tolerâncias para o agendamento de pods (documentação) Não N/D

Próximas etapas