Referência da propriedade de configuração

Nesta seção, estão listadas todas as propriedades de configuração que podem ser usadas para personalizar o plano do ambiente de execução da implantação do híbrido da Apigee.

Filtrar esta página

Para filtrar as propriedades exibidas nesta página, selecione Básico (propriedades mais comuns) ou Avançado (propriedades que raramente precisam de alterações):

Exibição   propriedades de configuração nesta página.

Propriedades de nível superior

A tabela a seguir descreve as propriedades de nível superior no arquivo overrides.yaml. Estas são propriedades que não pertencem a outro objeto e se aplicam no nível da organização ou do ambiente:

Propriedade Tipo Descrição
axHashSalt Avançado

Introduzida na versão: 1.3.0

Valor padrão: iloveapis123

Gráfico:apigee-org

Opcional

O nome de um secret do Kubernetes que contém um sal usado ao calcular hashes para ofuscar os dados do usuário antes de enviá-los às análises da Apigee. Se você não especificar um valor de sal, iloveapis123 será usado por padrão. Crie o secret com o valor de sal como entrada. É possível usar o mesmo sal em vários clusters para garantir resultados de hash consistentes entre eles.

A Apigee usa SHA512 a fim de gerar hash do valor original antes de enviar dados do plano do ambiente de execução para o plano de controle.

Consulte: Ofuscar dados do usuário para análise.

contractProvider Avançado Introduzida na versão: 1.0.0

Valor padrão: https://apigee.googleapis.com

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-redis, apigee-telemetry, apigee-virtualhost

Define o caminho da API para todas as APIs na instalação.

Obrigatório se a instalação híbrida estiver usando Residência de dados no seguinte formato:

contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

Em que CONTROL_PLANE_LOCATION é o local onde os dados do plano de controle, como pacotes de proxy, são armazenados. Para uma lista, consulte Regiões disponíveis do plano de controle da API Apigee.

Exemplo:

contractProvider: https://us-apigee.googleapis.com
customAutoscaling.enabled Básico Introduzida na versão: 1.14.0

Valor padrão: true

Gráfico:apigee-telemetry

Ativa o escalonamento automático com base em métricas da Apigee quando definido como true (o padrão). Defina como false para desativar o escalonamento automático personalizado.

Atualize o gráfico apigee-telemetry para aplicar mudanças a customAutoscaling.enabled.

enhanceProxyLimits Avançado Introduzida na versão: 1.14.0

Valor padrão: false

Gráfico:apigee-org, apigee-virtualhost

Obrigatório

enhanceProxyLimits é obrigatório para o recurso de limites de proxy aprimorados por ambiente da Apigee. Defina como enhanceProxyLimits: true se a organização híbrida tiver direito a limites de proxy otimizados por ambiente.

Veja estes tópicos:

A definição de enhanceProxyLimits: true é necessária para o encadeamento de proxy, de endpoint e de ServiceCallout. Confira mais informações em:

Aplique as mudanças em enhanceProxyLimits atualizando os gráficos apigee-org e apigee-virtualhost para cada grupo de ambientes.

gcpProjectID Avançado Deprecated: Para a v1.2.0 ou posterior, use gcp.projectID.

Introduzida na versão: 1.0.0

Valor padrão: nenhum

Gráfico:apigee-org, apigee-telemetry

Obrigatório

ID do seu projeto do Google Cloud. Funciona com k8sClusterName (obsoleto) e gcpRegion (obsoleto) para identificar o projeto e determinar para onde apigee-logger e apigee-metrics enviam dados.

gcpRegion Avançado Deprecated: Para a v1.2.0 ou posterior, use gcp.region.

Introduzida na versão: 1.0.0

Valor padrão: us-central1

Gráfico:apigee-org, apigee-telemetry

Obrigatório

A região ou zona mais próxima do Google Cloud do cluster do Kubernetes. Funciona com gcpProjectID (obsoleto) e k8sClusterName (obsoleto) para identificar o projeto e determinar para onde os apigee-logger e apigee-metrics enviam dados.

hub Avançado Introduzido na versão: 1.11.0

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-redis, apigee-telemetry, apigee-virtualhost

O URL de um repositório de contêineres de imagens particulares usado para extrair imagens de todos os componentes da Apigee de um repositório particular.

hub fornece um caminho padrão para todos os componentes da Apigee híbrida. Se você estiver usando um repositório particular, use hub para definir o URL do repositório para todos os componentes, em vez de usar a propriedade image.url individual para cada componente. Configure URLs individuais somente se você estiver usando um repositório separado para um componente específico.

O caminho da imagem para cada componente será o valor de hub mais o nome da imagem e a tag do componente.

Por exemplo, se o valor de hub for private-docker-host.example.com, os componentes individuais vão resolver automaticamente o caminho da imagem:

hub: private-docker-host.example.com

como:

containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.16.0
  imagePullPolicy: IfNotPresent

Os outros componentes vão seguir um padrão semelhante.

Use apigee-pull-push --list para ver o URL do repositório atual para todos os componentes.

Usar um repositório de imagens particular com a Apigee híbrida.

É possível substituir o URL da imagem por componentes individualmente com as seguintes propriedades:

imagePullSecrets[].name Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env, apigee-operator, apigee-org, apigee-redis

Nome do secret do Kubernetes configurado como tipo de registro do Docker; usado para extrair imagens de um repositório privado.

instanceID Básico Introduzida na versão: 1.3.0

Valor padrão: Nenhum

Gráfico:apigee-org

Obrigatório

Um identificador exclusivo da instalação.

Uma string exclusiva para identificar a instância. Pode ser qualquer combinação de letras e números, com até 63 caracteres.

kmsEncryptionKey Avançado Introduzida na versão: 1.0.0

Valor padrão: defaults.org.kmsEncryptionKey

Gráfico:apigee-org, apigee-env

Opcional. Use apenas um valor de kmsEncryptionKey, kmsEncryptionPath ou kmsEncryptionSecret.

Caminho do sistema de arquivos local para a chave de criptografia dos dados do Apigee KMS.

kmsEncryptionPath Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-env

Opcional. Use apenas um valor de kmsEncryptionKey, kmsEncryptionKey ou kmsEncryptionKey.

O caminho para um arquivo que contém uma chave de criptografia codificada em base64. Consulte Criptografia de dados.

kmsEncryptionSecret.key Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-env

Opcional. Use apenas um valor de kmsEncryptionKey, kmsEncryptionPath ou kmsEncryptionSecret.

A chave de uma chave secreta do Kubernetes contendo uma chave de criptografia codificada em Base64. Consulte Criptografia de dados.

kmsEncryptionSecret.name Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-env

Opcional. Use apenas um valor de kmsEncryptionKey, kmsEncryptionPath ou kmsEncryptionSecret.

O nome de um secret do Kubernetes contendo uma chave de criptografia codificada em Base64. Consulte Criptografia de dados.

kvmEncryptionKey Avançado Introduzida na versão: 1.0.0

Valor padrão: defaults.org.kmsEncryptionKey

Gráfico:apigee-org, apigee-env

Opcional. Use apenas um valor de kvmEncryptionKey, kvmEncryptionPath ou kvmEncryptionSecret.

Caminho do sistema de arquivos local para a chave de criptografia dos dados do Apigee KMS.

kvmEncryptionPath Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-env

Opcional. Use apenas um valor de kvmEncryptionKey, kvmEncryptionKey ou kvmEncryptionKey.

O caminho para um arquivo que contém uma chave de criptografia codificada em base64. Consulte Criptografia de dados.

kvmEncryptionSecret.key Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-env

Opcional. Use apenas um valor de kvmEncryptionKey, kvmEncryptionPath ou kvmEncryptionSecret.

A chave de uma chave secreta do Kubernetes contendo uma chave de criptografia codificada em Base64. Consulte Criptografia de dados.

kvmEncryptionSecret.name Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-env

Opcional. Use apenas um valor de kvmEncryptionKey, kvmEncryptionPath ou kvmEncryptionSecret.

O nome de um secret do Kubernetes contendo uma chave de criptografia codificada em Base64. Consulte Criptografia de dados.

multiOrgCluster Avançado Introduzida na versão: 1.10.0

Valor padrão: false

Gráfico:apigee-telemetry

Para clusters de várias organizações, essa propriedade permite que as métricas da organização sejam exportadas para o projeto listado na propriedade gcp.projectID. Aplique essa configuração ao arquivo de substituição para cada organização em um cluster de várias organizações. Para mais informações, consulte Como adicionar várias organizações híbridas a um cluster.

namespace Básico Introduzida na versão: 1.0.0

Valor padrão: apigee

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-redis, apigee-telemetry, apigee-virtualhost

O namespace do cluster do Kubernetes em que os componentes da Apigee serão instalados.

org Básico

Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env, apigee-operator, apigee-org, apigee-telemetry, apigee-virtualhost

Obrigatório

A organização com recurso híbrido que foi provisionada para você pela Apigee durante a instalação híbrida. Uma organização é o contêiner de nível superior no Apigee. Ela contém todos os proxies de API e recursos relacionados. Se o valor estiver vazio, será necessário atualizá-lo para limpar o nome da organização depois de criá-lo.

revision Avançado Introduzida na versão: 1.0.0

Valor padrão: "1160" (sua versão da Apigee híbrida sem pontos. Por exemplo, para a versão 1.12.0, o valor padrão é "1120".

Gráfico:apigee-operator

O híbrido da Apigee oferece suporte a atualizações graduais do Kubernetes, o que permite atualizações de implantação com tempo de inatividade zero por meio da atualização incremental de instâncias de pod com novas instâncias.

Ao atualizar determinadas modificações de YAML que resultam em alteração PodTemplateSpec do Kubernetes, a propriedade de modificação revision também precisa ser alterada no override.yaml do cliente. Isso é necessário para que o controlador subjacente ApigeeDeployment (AD) do Kubernetes faça uma atualização gradual e segura da versão anterior para a nova versão. É possível usar qualquer valor de texto em minúsculas, por exemplo: blue, a, 1.0.0

Quando a propriedade revision for alterada e aplicada, ocorrerá uma atualização contínua para todos os componentes

As alterações nas propriedades dos objetos a seguir exigem uma atualização de revision:

Para mais informações, consulte Atualizações graduais.

serviceAccountSecretProviderClass Avançado Introduzida na versão: 1.12.0

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-org, apigee-telemetry

O nome da classe do provedor de secrets específica da organização (SecretProviderClass) usada para armazenar as chaves de contas de serviço no Vault.

Consulte Como armazenar chaves de conta de serviço no Hashicorp Vault.

ao

Os operadores da Apigee (AO, na sigla em inglês) criam e atualizam recursos de baixo nível do Kubernetes e do Istio necessários para implantar e manter um componente. Por exemplo, o controlador executa o lançamento dos processadores de mensagens.

A tabela a seguir descreve as propriedades do objeto ao apigee-operators:

Propriedade Tipo Descrição
ao.args.disableIstioConfigInAPIServer Avançado Introduzida na versão: 1.8.0

Valor padrão: true

Gráfico:apigee-ingress-manager

Impede que a Apigee forneça configuração ao Cloud Service Mesh instalado pelo cliente.

  • Defina como true para instalações híbridas usando o gateway de entrada da Apigee.
  • Defina como false para instalações híbridas que usam o Cloud Service Mesh (versões híbridas 1.8 e anteriores da Apigee).
ao.args.disableManagedClusterRoles Avançado Introduzida na versão: 1.10.0

Valor padrão: true

Gráfico:apigee-operator

Quando true (padrão), a Apigee híbrida não gerencia o Kubernetes ClusterRole e ClursterRoleBinding diretamente. Se você tiver um processo que exija o gerenciamento desses recursos, ele precisará ser executado por um usuário com as permissões corretas.

ao.image.pullPolicy Avançado Introduzida na versão: 1.2.0

Valor padrão: IfNotPresent

Gráfico:apigee-operator, apigee-ingress-manager

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

ao.image.tag Avançado Introduzida na versão: 1.2.0

Valor padrão: 1.16.0

Gráfico:apigee-operator, apigee-ingress-manager

O rótulo da versão da imagem do Docker desse serviço.

ao.image.url Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-operator, apigee-ingress-manager

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

ao.resources.limits.cpu Avançado Introduzida na versão: 1.2.0

Valor padrão: 250m

Gráfico:apigee-operator, apigee-ingress-manager

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

ao.resources.limits.memory Avançado Introduzida na versão: 1.2.0

Valor padrão: 256Mi

Gráfico:apigee-operator, apigee-ingress-manager

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes.

ao.resources.requests.cpu Avançado Introduzida na versão: 1.2.0

Valor padrão: 250m

Gráfico:apigee-operator, apigee-ingress-manager

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

ao.resources.requests.memory Avançado Introduzida na versão: 1.2.0

Valor padrão: 256Mi

Gráfico:apigee-operator, apigee-ingress-manager

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes.

ao.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

ao.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

ao.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

ao.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-operator

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

ao.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-operator

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

apigeeIngressGateway

Configura o gateway de entrada da Apigee para a Apigee híbrida. Use as propriedades apigeeIngressGateway para aplicar a configuração comum a todas as instâncias do gateway de entrada da Apigee.

Consulte ingressGateways para configurar instâncias individuais de maneira exclusiva.

Aplique alterações às propriedades apigeeIngressGateway com o gráfico apigee-org.

A tabela a seguir descreve as propriedades do objeto apigeeIngressGateway:

Propriedade Tipo Descrição
apigeeIngressGateway.image.pullPolicy Avançado Introduzido na versão: 1.11.0

Valor padrão: IfNotPresent

Gráfico:apigee-org

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

apigeeIngressGateway.image.tag Avançado Introduzido na versão: 1.11.0

Valor padrão: 1.16.0

Gráfico:apigee-org

O rótulo da versão da imagem do Docker desse serviço.

apigeeIngressGateway.image.url Avançado Introduzido na versão: 1.11.0

Valor padrão: Nenhum

Gráfico:apigee-org

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

apigeeIngressGateway.nodeSelector.key Avançado Introduzido na versão: 1.11.0

Valor padrão: Nenhum

Gráfico:apigee-org

Obrigatório

Chave do identificador do seletor de nós usada para visar nós dedicados do Kubernetes para serviços de gateway de entrada.

Consulte Como configurar pools de nós dedicados.

apigeeIngressGateway.nodeSelector.value Avançado Introduzido na versão: 1.11.0

Valor padrão: Nenhum

Gráfico:apigee-org

Valor opcional do rótulo do seletor de nós usado a fim de segmentar nós dedicados do Kubernetes para serviços de gateway de entrada e substituir as configurações nodeSelector.apigeeData.

Consulte nodeSelector.

apigeeIngressGateway.replicaCountMax Básico Introduzido na versão: 1.11.0

Valor padrão: 4

Gráfico:apigee-org

O número máximo de pods que podem ser adicionados de forma automática ao gateway de entrada disponível para escalonamento automático.

apigeeIngressGateway.replicaCountMin Básico Introduzido na versão: 1.11.0

Valor padrão: 2

Gráfico:apigee-org

O número mínimo de pods para o gateway de entrada disponível para escalonamento automático.

apigeeIngressGateway.targetCPUUtilizationPercentage Avançado Introduzido na versão: 1.10.5, 1.11.2, 1.12.1

Valor padrão: 75

Gráfico:apigee-org

O limite de uso da CPU para escalonar o número de pods no ReplicaSet, como uma porcentagem do total de recursos de CPU disponíveis.

Quando o uso da CPU ultrapassar esse valor, o híbrido aumentará gradualmente o número de pods no ReplicaSet, até apigeeIngressGateway.replicaCountMax.

Para mais informações sobre escalonamento no Kubernetes, consulte Escalonamento automático horizontal de pods na documentação do Kubernetes.

apigeeIngressGateway.tolerations.effect Avançado Introduzido na versão: 1.11.0

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

apigeeIngressGateway.tolerations.key Avançado Introduzido na versão: 1.11.0

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

apigeeIngressGateway.tolerations.operator Avançado Introduzido na versão: 1.11.0

Valor padrão: "Equal"

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

apigeeIngressGateway.tolerations.tolerationSeconds Avançado Introduzido na versão: 1.11.0

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

apigeeIngressGateway.tolerations.value Avançado Introduzido na versão: 1.11.0

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

cassandra

Define o serviço híbrido que gerencia o repositório de dados de ambiente de execução. Esse repositório armazena configurações de aplicativos, contadores de cota distribuídos, chaves de API e tokens OAuth para aplicativos em execução no gateway.

Para mais informações, consulte a configuração StorageClass.

A tabela a seguir descreve as propriedades do objeto cassandra:

Propriedade Tipo Descrição
cassandra.annotations Avançado Introduzida na versão: 1.5.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Mapa opcional de chave-valor usado para anotar pods. Para mais informações, consulte Anotações personalizadas.

cassandra.auth.admin.password Básico Introduzida na versão: 1.0.0

Valor padrão: iloveapis123

Gráfico:apigee-datastore

Obrigatório

Senha para o administrador do Cassandra. O usuário administrador é usado para qualquer atividade administrativa realizada no cluster do Cassandra, como backup e restauração.

cassandra.auth.ddl.password Básico Introduzida na versão: 1.0.0

Valor padrão: iloveapis123

Gráfico:apigee-datastore

Obrigatório

Senha para o usuário da linguagem de definição de dados (DDL, na sigla em inglês) do Cassandra. Usado por MART para qualquer tarefa de definição de dados, como criação, atualização e exclusão de keyspace.

cassandra.auth.default.password Básico Introduzida na versão: 1.0.0

Valor padrão: iloveapis123

Gráfico:apigee-datastore

Obrigatório

A senha do usuário padrão do Cassandra criada quando o Authentication está ativado. Essa senha precisa ser redefinida ao configurar a autenticação do Cassandra. Consulte Como configurar o TLS para o Cassandra.

cassandra.auth.dml.password Básico Introduzida na versão: 1.0.0

Valor padrão: iloveapis123

Gráfico:apigee-datastore

Obrigatório

Senha para o usuário da linguagem de manipulação de dados (DML, na sigla em inglês) do Cassandra. O usuário DML é usado pela comunicação do cliente para ler e gravar dados no Cassandra.

cassandra.auth.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-datastore, apigee-org

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

cassandra.auth.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-datastore, apigee-org

O rótulo da versão da imagem do Docker desse serviço.

cassandra.auth.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-org

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

cassandra.auth.jmx.password Básico Introduzida na versão: 1.4.0

Valor padrão: iloveapis123

Gráfico:apigee-datastore

Obrigatório

Senha do usuário das operações do Cassandra JMX. Usado para autenticar e se comunicar com a interface do Cassandra JMX.

cassandra.auth.jmx.username Básico Introduzida na versão: 1.4.0

Valor padrão: jmxuser

Gráfico:apigee-datastore

Obrigatório

Senha do usuário das operações do Cassandra JMX. Usado para autenticar e se comunicar com a interface do Cassandra JMX.

cassandra.auth.jolokia.password Básico Introduzida na versão: 1.4.0

Valor padrão: iloveapis123

Gráfico:apigee-datastore

Obrigatório

Senha do usuário das operações do Cassandra Jolokia JMX. Usado para autenticar e se comunicar com a API Cassandra JMX.

cassandra.auth.jolokia.username Básico Introduzida na versão: 1.4.0

Valor padrão: apigee

Gráfico:apigee-datastore

Obrigatório

Senha do usuário das operações do Cassandra Jolokia JMX. Usado para autenticar e se comunicar com a API Cassandra JMX.

cassandra.auth.secret Básico Introduzida na versão: 1.3.3

Valor padrão: Nenhum

Gráfico:apigee-datastore

O nome do arquivo armazenado em um secret do Kubernetes que contém os usuários e as senhas do Cassandra. É possível criar a chave secreta usando as seguintes instruções: Criar a chave secreta.

Consulte também:

cassandra.auth.secretProviderClass Avançado Introduzida na versão: 1.10.3

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-operator

A política de armazenamento de secrets do Cassandra. Quando definida, ela precisa corresponder ao SecretProviderClass que faz referência ao provedor de secrets externos, como o Hashicorp Vault. Quando não definida, a Apigee híbrida usa os nomes de usuário e as senhas armazenados no seguinte:

ou o secret do Kubernetes armazenado em:

Consulte Como armazenar secrets do Cassandra no Hashicorp Vault para as instruções de criação da política.

cassandra.backup.cloudProvider Avançado Introduzida na versão: 1.0.0

Valor padrão: GCP

Gráfico:apigee-datastore

O nome de um provedor de backup. Valores aceitos: GCP, HYBRID e CSI. Definir o valor de como:

  • GCP para armazenar arquivos de backup no Google Cloud Storage.
  • HYBRID para armazenar arquivos de backup em um servidor SSH remoto.
  • CSI (recomendado) para usar os snapshots de volume da CSI do Kubernetes para backup. Para informações sobre backup e restauração de CSI para plataformas de nuvem, como Google Cloud, AWS e Azure, consulte Backup e restauração de CSI.
cassandra.backup.dbStorageBucket Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Obrigatório se o backup estiver ativado e cassandra.backup.cloudProvider estiver definido como GCP.

O nome de um bucket do Google Cloud Storage que será usado para armazenar os arquivos de backup. Consulte Como criar buckets. caso precise criar um.

cassandra.backup.enabled Avançado Introduzida na versão: 1.0.0

Valor padrão: false

Gráfico:apigee-datastore

O backup de dados não está ativado por padrão. Para ativar, defina como true.

Consulte Backup e recuperação do Cassandra.

cassandra.backup.gsa Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google (GSA) apigee-cassandra a ser associada à conta de serviço do Kubernetes de backup do Cassandra ao ativar a Identidade da carga de trabalho nos clusters do GKE. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true e cassandra.backup.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a federação de identidade da carga de trabalho no GKE.

cassandra.backup.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-datastore

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

cassandra.backup.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-datastore

O rótulo da versão da imagem do Docker desse serviço.

cassandra.backup.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

cassandra.backup.keyfile Avançado Introduzida na versão: 1.3.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Obrigatório se o backup estiver ativado e cassandra.backup.cloudProvider estiver definido como HYBRID.

O caminho no sistema de arquivos local para o arquivo de chave privada SSH.

cassandra.backup.schedule Avançado Introduzida na versão: 1.0.0

Valor padrão: 0 2 * * *

Gráfico:apigee-datastore

O agendamento do cron job de backup.

Consulte Backup e recuperação do Cassandra.

cassandra.backup.server Avançado Introduzida na versão: 1.3.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Obrigatório se o backup estiver ativado e cassandra.backup.cloudProvider estiver definido como HYBRID.

O endereço IP do servidor de backup SSH remoto.

cassandra.backup.serviceAccountPath Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Caminho para um arquivo de chave da conta de serviço do Google que tenha o papel de Administrador de objetos do Storage (roles/storage.objectAdmin). Essa conta de serviço do Google será usada para fazer upload de arquivos de backup para um cassandra.backup.dbStorageBucket especificado.

Se o backup estiver ativado e cassandra.backup.cloudProvider estiver definido como GCP, será necessário um dos itens a seguir para garantir que a Apigee híbrida possa acessar o bucket do Google Cloud Storage para fazer upload de arquivos de backup:

cassandra.backup.serviceAccountRef Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

O nome de um secret do Kubernetes que armazena o conteúdo de um arquivo de chave de uma conta de serviço do Google com o papel de Administrador de objetos do Storage (roles/storage.objectAdmin). Esta conta de serviço do Google será usada para fazer upload de arquivos de backup para um cassandra.backup.dbStorageBucket

Se o backup estiver ativado e cassandra.backup.cloudProvider estiver definido como GCP, será necessário um dos itens a seguir para garantir que a Apigee híbrida possa acessar o bucket do Google Cloud Storage para fazer upload de arquivos de backup:

cassandra.backup.storageDirectory Avançado Introduzida na versão: 1.3.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Obrigatório se o backup estiver ativado e cassandra.backup.cloudProvider estiver definido como HYBRID.

Pode ser um caminho absoluto ou relativo ao diretório inicial do usuário apigee.

O nome do diretório de backup no servidor SSH de backup.

cassandra.clusterName Básico Introduzida na versão: 1.0.0

Valor padrão: apigeecluster

Gráfico:apigee-datastore

Especifica o nome do cluster do Cassandra.

cassandra.datacenter Básico Introduzida na versão: 1.0.0

Valor padrão: dc-1

Gráfico:apigee-datastore

Especifica o data center do nó do Cassandra.

cassandra.dnsPolicy Básico Introduzida na versão: 1.1.1

Valor padrão: Nenhum

Gráfico:apigee-datastore

Quando você define hostNetwork como verdadeiro, a política de DNS é definida como ClusterFirstWithHostNet para você.

cassandra.externalSeedHost Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Nome do host ou IP de um nó do cluster do Cassandra. Se não for definido, o serviço local do Kubernetes será usado.

cassandra.heapNewSize Básico Introduzida na versão: 1.0.0

Valor padrão: 100M

Gráfico:apigee-datastore

A quantidade de memória do sistema JVM alocada para objetos mais recentes, em megabytes.

cassandra.hostNetwork Básico Introduzida na versão: 1.1.1

Valor padrão: false

Gráfico:apigee-datastore

Ativa o recurso hostNetwork do Kubernetes. A Apigee usa esse recurso em instalações multirregionais para se comunicar entre pods se o namespace de rede do pod não tiver conectividade entre clusters (os clusters estão sendo executados no "modo de rede de ilha"), que é o caso padrão em instalações que não são do GKE, incluindo o Google Distributed Cloud na VMware ou em bare metal, o GKE na AWS, o AKS, o EKS e o OpenShift.

Defina cassandra.hostNetwork como false para instalações de região única e multirregionais com conectividade entre pods em clusters diferentes, como instalações do GKE.

Defina cassandra.hostNetwork como true para instalações multirregionais sem comunicação entre pods em clusters diferentes, como Google Distributed Cloud no VMware ou bare metal, GKE em instalações da AWS, AKS, EKS e OpenShift. Consulte Implantação multirregional: pré-requisitos.

Quando true, a política de DNS é definida automaticamente como ClusterFirstWithHostNet.

cassandra.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-datastore

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

cassandra.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-datastore

O rótulo da versão da imagem do Docker desse serviço.

cassandra.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

cassandra.maxHeapSize Avançado Introduzida na versão: 1.0.0

Valor padrão: 512M

Gráfico:apigee-datastore

O limite máximo da memória do sistema JVM disponível para as operações do Cassandra em megabytes.

cassandra.multiRegionSeedHost Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Endereço IP de um cluster do Cassandra usado para expandir o cluster atual para uma nova região. Consulte Configurar o host de sugestão multirregional.

cassandra.nodeSelector.key Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Obrigatório

Chave de rótulo do seletor de nós usada para segmentar nós dedicados do Kubernetes para serviços de dados do cassandra.

Consulte Como configurar pools de nós dedicados.

cassandra.nodeSelector.value Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Valor do rótulo do seletor de nós opcional usado para segmentar nós dedicados do Kubernetes para serviços de dados cassandra e substituir as configurações de nodeSelector.apigeeData.

Consulte nodeSelector.

cassandra.port Avançado Introduzida na versão: 1.0.0

Valor padrão: 9042

Gráfico:apigee-datastore

Número da porta usado para se conectar ao cassandra.

cassandra.rack Básico Introduzida na versão: 1.0.0

Valor padrão: ra-1

Gráfico:apigee-datastore

Especifica o rack do nó do Cassandra.

cassandra.readinessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 2

Gráfico:apigee-datastore

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de preparo antes de marcar o pod como não pronto. O valor mínimo é 1.

cassandra.readinessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 0

Gráfico:apigee-datastore

O número de segundos após o início de um contêiner antes de uma sondagem de preparo.

cassandra.readinessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 10

Gráfico:apigee-datastore

Determina a frequência com uma sondagem de preparo será feita, em segundos. O valor mínimo é 1.

cassandra.readinessProbe.successThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-datastore

O número mínimo de sucessos consecutivos necessários para que uma sondagem de preparo seja considerada bem-sucedida após uma falha. O valor mínimo é 1.

cassandra.readinessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-datastore

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

cassandra.replicaCount Básico Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-datastore

O Cassandra é um banco de dados replicado. Essa propriedade especifica o número de nós do Cassandra empregado como um StatefulSet.

cassandra.resources.requests.cpu Avançado Introduzida na versão: 1.0.0

Valor padrão: 500m

Gráfico:apigee-datastore

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

cassandra.resources.requests.memory Avançado Introduzida na versão: 1.0.0

Valor padrão: 1Gi

Gráfico:apigee-datastore

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes.

cassandra.restore.cloudProvider Avançado Introduzida na versão: 1.0.0

Valor padrão: GCP

Gráfico:apigee-datastore

O nome de um provedor de restauração. Valores aceitos: GCP, HYBRID e CSI. Definir o valor de como:

  • GCP para restaurar dados de um backup armazenado no Google Cloud Storage.
  • HYBRID para restaurar dados de um backup armazenado em um servidor SSH remoto.
  • CSI (recomendado) para utilizar snapshots de volume da CSI do Kubernetes para restauração. Para informações sobre backup e restauração de CSI para plataformas de nuvem, como Google Cloud, AWS e Azure, consulte Backup e restauração de CSI.
cassandra.restore.dbStorageBucket Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Obrigatório se a restauração estiver ativada e o cassandra.restore.cloudProvider estiver definido como GCP.

O nome de um bucket do Google Cloud Storage que armazena arquivos de backup para serem usados na restauração de dados.

cassandra.restore.enabled Avançado Introduzida na versão: 1.0.0

Valor padrão: false

Gráfico:apigee-datastore, apigee-org

A restauração de dados não está ativada por padrão. Para ativar, defina como true.

Consulte Backup e recuperação do Cassandra.

cassandra.restore.gsa Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google (GSA) apigee-cassandra a ser associada à conta de serviço do Kubernetes de restauração do Cassandra ao ativar a Identidade da carga de trabalho nos clusters do GKE. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true e cassandra.restore.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a federação de identidade da carga de trabalho no GKE.

cassandra.restore.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-datastore

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

cassandra.restore.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-datastore

O rótulo da versão da imagem do Docker desse serviço.

cassandra.restore.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

cassandra.restore.serviceAccountPath Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Caminho para um arquivo de chave da conta de serviço do Google que tenha o papel de Administrador de objetos do Storage (roles/storage.objectAdmin). Essa conta de serviço do Google será usada para fazer o download de arquivos de backup de um cassandra.restore.dbStorageBucket especificado.

Se a restauração estiver ativada e cassandra.restore.cloudProvider estiver definido como GCP, uma das opções a seguir é necessária para garantir que a Apigee híbrida possa acessar o bucket do Google Cloud Storage para fazer o download dos arquivos de backup para restauração:

cassandra.restore.serviceAccountRef Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

O nome de um secret do Kubernetes que armazena o conteúdo de um arquivo de chave de uma conta de serviço do Google com o papel de Administrador de objetos do Storage (roles/storage.objectAdmin). Essa conta de serviço do Google será usada para fazer o download de arquivos de backup de um cassandra.restore.dbStorageBucket especificado.

Se a restauração estiver ativada e cassandra.restore.cloudProvider estiver definido como GCP, uma das opções a seguir é necessária para garantir que a Apigee híbrida possa acessar o bucket do Google Cloud Storage para fazer o download dos arquivos de backup para restauração:

cassandra.restore.snapshotTimestamp Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Obrigatório se a restauração estiver ativada.

Carimbo de data/hora do backup que precisa ser restaurado.

cassandra.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

cassandra.storage.capacity Básico Introduzida na versão: 1.0.0

Valor padrão: 10Gi

Gráfico:apigee-datastore

Obrigatório se storage.storageclass for especificado

Especifica o tamanho do disco necessário, em mebibytes (Mi) ou gibibytes (Gi).

cassandra.storage.storageclass Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-datastore

Especifica a classe de armazenamento local que está sendo usada.

cassandra.storage.storageSize Básico Introduzida na versão: 1.0.0

Valor padrão: 10Gi

Gráfico:apigee-datastore

Obrigatório se storage.storageclass for especificado

Especifica o tamanho do disco necessário, em mebibytes (Mi) ou gibibytes (Gi).

cassandra.terminationGracePeriodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 300

Gráfico:apigee-datastore

O tempo máximo entre uma solicitação de exclusão de pod e quando o pod é eliminado, em segundos. Durante esse período, todos os hooks de prestop serão executados, e qualquer processo em execução será encerrado sem problemas. O pod será encerrado quando todos os processos em execução forem concluídos ou ao final do período de carência, o que ocorrer primeiro. Se não houver processos em execução, o pod será encerrado imediatamente.

cassandra.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-datastore

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

cassandra.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-datastore

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

cassandra.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-datastore

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

cassandra.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-datastore

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

cassandra.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-datastore

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

certManager

A Apigee usa o cert-manager para a validação do certificado.

A tabela a seguir descreve as propriedades do objeto certManager:

Propriedade Tipo Descrição
certManager.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

certManager.namespace Avançado Introduzida na versão: 1.9.0

Valor padrão: cert-manager

Gráfico:apigee-operator

O namespace do cert-manager.

Consulte Como executar o cert-manager em um namespace personalizado.

connectAgent

O Apigee Connect permite que o plano de gerenciamento híbrido da Apigee se conecte com segurança ao serviço MART no plano do ambiente de execução sem exigir que você exponha o endpoint MART na Internet.

A tabela a seguir descreve as propriedades do objeto connectAgent:

Propriedade Tipo Descrição
connectAgent.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-org

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

connectAgent.annotations Avançado Introduzida na versão: 1.5.0

Valor padrão: Nenhum

Gráfico:apigee-org

Mapa opcional de chave-valor usado para anotar pods. Para mais informações, consulte Anotações personalizadas.

connectAgent.gsa Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-org

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google (GSA) que o connectAgent vai associar à conta de serviço correspondente do Kubernetes ao ativar a Identidade da carga de trabalho nos clusters do GKE usando gráficos do Helm. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-mart@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

connectAgent.logLevel Avançado Introduzida na versão: 1.2.0

Valor padrão: INFO

Gráfico:apigee-org

O nível de geração de relatórios de registro. Possíveis valores:

  • INFO: mensagens informativas além de alertas, erros e mensagens fatais. Mais útil para depuração.
  • WARNING: avisos não fatais, além de mensagens fatais e de erro.
  • ERROR: erros internos e erros que não são retornados ao usuário, além de mensagens fatais.
  • FATAL: eventos e erros irrecuperáveis que causam falha na Apigee.
connectAgent.image.pullPolicy Avançado Introduzida na versão: 1.2.0

Valor padrão: IfNotPresent

Gráfico:apigee-org

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

connectAgent.image.tag Avançado Introduzida na versão: 1.2.0

Valor padrão: 1.16.0

Gráfico:apigee-org

O rótulo da versão da imagem do Docker desse serviço.

connectAgent.image.url Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

connectAgent.replicaCountMax Básico Introduzida na versão: 1.2.0

Valor padrão: 5

Gráfico:apigee-org

Número máximo de réplicas disponíveis para escalonamento automático.

connectAgent.replicaCountMin Básico Introduzida na versão: 1.2.0

Valor padrão: 1

Gráfico:apigee-org

Número mínimo de réplicas disponíveis para escalonamento automático.

Em produção, é recomendável aumentar replicaCountMin para 1, a fim de ter um número maior de conexões com o plano de controle para garantir a confiabilidade e a escalabilidade.

connectAgent.resources.limits.cpu Avançado Introduzido na versão: 1.11.0

Valor padrão: 512m

Gráfico:apigee-org

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

connectAgent.resources.limits.memory Avançado Introduzido na versão: 1.11.0

Valor padrão: 512Mi

Gráfico:apigee-org

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes.

connectAgent.resources.requests.cpu Avançado Introduzido na versão: 1.11.0

Valor padrão: 100m

Gráfico:apigee-org

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

connectAgent.resources.requests.memory Avançado Introduzida na versão: 1.2.0

Valor padrão: 30Mi

Gráfico:apigee-org

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes.

connectAgent.server Avançado Introduzida na versão: 1.2.0

Valor padrão: apigeeconnect.googleapis.com:443

Gráfico:apigee-org

O local do servidor e da porta deste serviço.

connectAgent.serviceAccountPath Básico Introduzida na versão: 1.1.1

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Caminho para o arquivo de chave da conta de serviço do Google referente à conta de serviço apigee-mart.

Na maioria das instalações, o valor de connectAgent.serviceAccountPath precisa corresponder ao valor de mart.serviceAccountPath.

connectAgent.serviceAccountRef Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Uma referência de secret do Kubernetes a um arquivo de chave da conta de serviço do Google. Consulte Como armazenar chaves de conta de serviço em secrets do Kubernetes.

Na maioria das instalações, o valor de connectAgent.serviceAccountRef precisa corresponder ao valor de mart.serviceAccountRef.

connectAgent.targetCPUUtilizationPercentage Avançado Introduzida na versão: 1.2.0

Valor padrão: 75

Gráfico:apigee-org

Meta de uso da CPU para o agente de conexão da Apigee no pod O valor desse campo permite que a Apigee se conecte ao escalonamento automático quando a utilização da CPU atingir esse valor, até replicaCountMax.

connectAgent.terminationGracePeriodSeconds Avançado Introduzida na versão: 1.2.0

Valor padrão: 600

Gráfico:apigee-org

O tempo máximo entre uma solicitação de exclusão de pod e quando o pod é eliminado, em segundos. Durante esse período, todos os hooks de prestop serão executados, e qualquer processo em execução será encerrado sem problemas. O pod será encerrado quando todos os processos em execução forem concluídos ou ao final do período de carência, o que ocorrer primeiro. Se não houver processos em execução, o pod será encerrado imediatamente.

connectAgent.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

connectAgent.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

connectAgent.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

connectAgent.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

connectAgent.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

defaults

As chaves de criptografia padrão para a instalação híbrida da Apigee.

A tabela a seguir descreve as propriedades do objeto defaults:

Propriedade Tipo Descrição
defaults.org.kmsEncryptionKey Básico Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

Gráfico:apigee-env, apigee-org

Chave de criptografia padrão para a organização no KMS.

defaults.org.kvmEncryptionKey Básico Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

Gráfico:apigee-env, apigee-org

Chave de criptografia padrão para a organização no KVM.

defaults.env.kmsEncryptionKey Básico Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

Gráfico:apigee-env

Chave de criptografia padrão para o ambiente (ambiente) no KMS.

defaults.env.kvmEncryptionKey Básico Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

Gráfico:apigee-env

Chave de criptografia padrão para o ambiente (env) em KVM.

defaults.env.cacheEncryptionKey Básico Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

Gráfico:apigee-env

Chave de criptografia de cache padrão para o ambiente (env).

envs

Define uma matriz de ambientes em que é possível implantar os proxies de API. Cada ambiente fornece um contexto isolado ou sandbox para executar proxies de API.

Sua organização com recurso híbrido precisa ter pelo menos um ambiente.

Para mais informações, consulte Sobre ambientes.

A tabela a seguir descreve as propriedades do objeto envs:

Propriedade Tipo Descrição
envs[].cacheEncryptionKey Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

cacheEncryptionKeyÉ necessário incluir um destes campos: cacheEncryptionPath ou cacheEncryptionSecret.

Uma chave de criptografia codificada em Base64. Consulte Criptografia de dados.

envs[].cacheEncryptionPath Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

cacheEncryptionKeyÉ necessário incluir um destes campos: cacheEncryptionPath ou cacheEncryptionSecret.

O caminho para um arquivo que contém uma chave de criptografia codificada em base64. Consulte Criptografia de dados.

envs[].cacheEncryptionSecret.key Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

cacheEncryptionKeyÉ necessário incluir um destes campos: cacheEncryptionPath ou cacheEncryptionSecret.

A chave de uma chave secreta do Kubernetes contendo uma chave de criptografia codificada em Base64. Consulte Criptografia de dados.

envs[].cacheEncryptionSecret.name Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

É necessário incluir um destes campos: cacheEncryptionKey, cacheEncryptionPath ou cacheEncryptionSecret.

O nome de um secret do Kubernetes contendo uma chave de criptografia codificada em Base64. Consulte Criptografia de dados.

envs[].components.runtime.replicaCountMax Básico Introduzida na versão: 1.9.3

Valor padrão: 4

Gráfico:apigee-env

Número máximo de réplicas para escalonamento automático. Substitui runtime.replicaCountMax, se especificado.

envs[].components.runtime.replicaCountMin Básico Introduzida na versão: 1.9.3

Valor padrão: 1

Gráfico:apigee-env

Número mínimo de réplicas para escalonamento automático. Substitui runtime.replicaCountMin, se especificado.

envs[].components.runtime.resources.limits.memory Avançado Introduzida na versão: 1.15.0

Valor padrão: Nenhum

Gráfico:apigee-env

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes (Mi) ou gibibytes (Gi).

envs[].components.runtime.resources.requests.memory Avançado Introduzida na versão: 1.15.0

Valor padrão: Nenhum

Gráfico:apigee-env

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes (Mi) ou Gibibytes (Gi).

envs[].components.synchronizer.replicaCountMax Básico Introduzida na versão: 1.9.3

Valor padrão: 4

Gráfico:apigee-env

Número máximo de réplicas para escalonamento automático. Substitui synchronizer.replicaCountMax, se especificado.

envs[].components.synchronizer.replicaCountMin Básico Introduzida na versão: 1.9.3

Valor padrão: 1

Gráfico:apigee-env

Número mínimo de réplicas para escalonamento automático. Substitui synchronizer.replicaCountMin, se especificado.

envs[].gsa.runtime Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-env

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google relativa ao ambiente de execução a ser associada à conta de serviço correspondente do Kubernetes ao ativar a Identidade da carga de trabalho nos clusters do GKE usando gráficos do Helm.

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

envs[].gsa.synchronizer Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-env

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google relativa ao sincronizador a ser associada à conta de serviço correspondente do Kubernetes ao ativar a Identidade da carga de trabalho nos clusters do GKE usando gráficos do Helm.

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

envs[].httpProxy.host Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

Especifica o nome de host ou o endereço IP em que o proxy HTTP está em execução.

Liste as propriedades httpProxy na ordem scheme, host, port. Por exemplo:

envs:
  - name: test
    httpProxy:
      scheme: HTTP
      host: 10.12.0.47
      port: 3128
      ...

Confira também: Configurar proxy para proxies de API.

envs[].httpProxy.port Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

Especifica a porta na qual o proxy HTTP está em execução. Se esta propriedade for omitida, por padrão, ela usará a porta 80 para HTTP e a porta 443 para HTTPS.

envs[].httpProxy.scheme Básico Introduzida na versão: 1.2.0

Valor padrão: HTTPS

Gráfico:apigee-env

Especifica o tipo do proxy HTTP como HTTP ou HTTPS. Por padrão, ele usa HTTPS.

envs[].httpProxy.username Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

Se o proxy HTTP exigir autenticação básica, use essa propriedade para fornecer um nome de usuário.

envs[].httpProxy.password Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

Se o proxy HTTP exigir autenticação básica, use essa propriedade para fornecer uma senha.

envs[].managementCallsSkipProxy Avançado Introduzida na versão:1.15.1

Valor padrão: false

Gráfico:apigee-env

Se definido como true para proxy de encaminhamento no nível do ambiente, o rastreamento e a análise (que usam googleapis.com) vão ignorar o proxy de encaminhamento.

envs[].name Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

Obrigatório

Nome do ambiente da Apigee a ser sincronizado.

envs[].pollInterval Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

Intervalo usado para pesquisar alterações de organização e sincronização de ambiente, em segundos.

envs[].port Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

Número da porta TCP para o tráfego HTTPS.

envs[].securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-env

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

envs[].serviceAccountPaths.runtime Básico Introduzida na versão: 1.4.0

Valor padrão: Nenhum

Gráfico:apigee-env

Caminho para arquivar no sistema local em uma chave da conta de serviço do Google com o papel Agente do Cloud Trace, geralmente na conta de serviço apigee-runtime. Consulte Sobre contas de serviço para conferir os nomes padrão das contas de serviço e os papéis atribuídos.

envs[].serviceAccountPaths.synchronizer Básico Introduzida na versão: 1.0

Valor padrão: Nenhum

Gráfico:apigee-env

Caminho para arquivar no sistema local em uma chave da conta de serviço do Google com o papel Apigee Synchronizer Manager.

envs[].serviceAccountSecretProviderClass Avançado Introduzida na versão: 1.12.0

Valor padrão: Nenhum

Gráfico:apigee-env

O nome da classe do provedor de secrets específica do ambiente (SecretProviderClass) usada para armazenar as chaves de contas de serviço no Vault.

Consulte Como armazenar chaves de conta de serviço no Hashicorp Vault.

envs[].serviceAccountSecretRefs.runtime Básico Introduzida na versão: 1.4.0

Valor padrão: Nenhum

Gráfico:apigee-env

O nome de um secret do Kubernetes. Crie o secret usando uma chave de conta de serviço do Google com o papel Agente do Cloud Trace como entrada.

envs[].serviceAccountSecretRefs.synchronizer Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

O nome de um secret do Kubernetes. Crie o secret usando uma chave de conta de serviço do Google com o papel Apigee Synchronizer Manager como entrada.

gcp

Identifica o ID do projeto do Google Cloud (obrigatório para todas as instalações híbridas), as configurações de Identidade da carga de trabalho e de federação de identidade da carga de trabalho, além da região para onde o apigee-logger e o apigee-metrics enviam dados.

A tabela a seguir descreve as propriedades do objeto gcp:

Propriedade Tipo Descrição
gcp.federatedWorkloadIdentity.audience Básico Introduzida na versão: 1.12.0

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-org, apigee-telemetry

O público-alvo permitido do provedor de identidade da carga de trabalho em plataformas que não são do GKE.

Consulte Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

gcp.federatedWorkloadIdentity.credentialSourceFile Básico Introduzida na versão: 1.12.0

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-org, apigee-telemetry

O nome de arquivo e o caminho até o arquivo de origem da credencial usado pela federação de identidade da carga de trabalho para receber as credenciais das contas de serviço. Esse é o valor fornecido para credential-source-file ao configurar a federação de identidade da carga de trabalho com o comando create-cred-config.

Consulte Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

gcp.federatedWorkloadIdentity.enabled Básico Introduzida na versão: 1.12.0

Valor padrão: false

Gráfico:apigee-datastore, apigee-env, apigee-org, apigee-telemetry

Ativa a federação de identidade da carga de trabalho em plataformas que não são do GKE. Não pode ser definido como true quando gcp.workloadIdentity.enabled está definido como true no mesmo cluster.

Consulte Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

gcp.federatedWorkloadIdentity.tokenExpiration Básico Introduzida na versão: 1.12.0

Valor padrão: 3600

Gráfico:apigee-datastore, apigee-env, apigee-org, apigee-telemetry

A vida útil do token em segundos.

Consulte Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

gcp.projectID Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-operator, apigee-org, apigee-telemetry

Obrigatório

Identifica o projeto do Google Cloud em que apigee-logger e apigee-metrics enviam dados.

gcp.region Básico Introduzida na versão: 1.2.0

Valor padrão: us-central1

Gráfico:apigee-env, apigee-org

Obrigatório

Identifica a região do Google Cloud em que apigee-logger e apigee-metrics enviam os dados.

gcp.workloadIdentity.enabled Básico Introduzida na versão: 1.10.0

Valor padrão:false

Gráfico:apigee-datastore, apigee-env, apigee-operator, apigee-org, apigee-telemetry

Ativa o uso da federação de identidade da carga de trabalho para o GKE. Isso permite que as cargas de trabalho nos clusters do GKE representem contas de serviço do Identity and Access Management (IAM) para acessar os serviços do Google Cloud.

Não pode ser definido como true quando gcp.federatedWorkloadIdentity.enabled está definido como true no mesmo cluster.

Quando enabled é false, o padrão, a Apigee usa diferentes métodos de autenticação de conta de serviço, como arquivos de chaves de conta de serviço, secrets do Kubernetes, Vault ou federação de identidade da carga de trabalho em outras plataformas. Consulte Métodos de autenticação de contas de serviço na Apigee híbrida.

Quando workloadIdentityEnabled é true, a Apigee usa as contas de serviço do Kubernetes e as mapeia para as contas de serviço do IAM apropriadas com relação a cada componente. Especifique as contas de serviço do IAM a serem mapeadas para as contas de serviço do Kubernetes com o seguinte:

gcp.workloadIdentity.gsa Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-org, apigee-telemetry

O endereço de e-mail da conta de serviço do IAM do Google (GSA) para todos os componentes a ser associada à conta de serviço correspondente do Kubernetes ao ativar a Identidade da carga de trabalho em clusters do GKE usando gráficos do Helm. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true.

gcp.workloadIdentity.gsa se aplica a todos os componentes híbridos. Se você especificar um valor para gcp.workloadIdentity.gsa, não precisará fornecer uma GSA com relação aos componentes híbridos individuais. Se você fornecer uma GSA para um componente individual, a GSA desse componente substituirá gcp.workloadIdentity.gsa somente para ele.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-non-prod@my-hybrid-project.iam.gserviceaccount.com

Confira Enabling Workload Identity on GKE.

guardrails

Identifica a conta de serviço do Google (GSA) e o arquivo de chave usados pelo serviço Apigee Guardrails. O serviço de proteções da Apigee permite que o pod de proteções no gráfico apigee-operator verifique se as APIs necessárias estão ativadas no projeto para a instalação bem-sucedida da Apigee híbrida, conforme descrito em Diagnosticar problemas com proteções e Instalar e fazer upgrade do ambiente de execução híbrido.

A tabela a seguir descreve as propriedades do objeto guardrails:

Propriedade Tipo Descrição
guardrails.image.pullPolicy Avançado Introduzida na versão:1.16.0

Valor padrão: IfNotPresent

Gráfico:apigee-org

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

guardrails.image.tag Avançado Introduzida na versão:1.16.0

Valor padrão: 1.16.0

Gráfico:apigee-org

O rótulo da versão da imagem do Docker desse serviço.

guardrails.image.url Avançado Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-org

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

guardrails.gsa Avançado Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

O endereço de e-mail da conta de serviço do IAM do Google (GSA) apigee-guardrails a ser associada à conta de serviço correspondente do Kubernetes ao ativar Identidade da carga de trabalho nos clusters do GKE. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-guardrails@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

guardrails.serviceAccountPath Básico Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

A menos que você esteja usando a Identidade da carga de trabalho, é necessário escolher serviceAccountPath ou serviceAccountSecretRef.

Caminho para o arquivo de chave da conta de serviço do Google com o papel de Leitor de uso do serviço.

guardrails.serviceAccountRef Avançado Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

A menos que você esteja usando a Identidade da carga de trabalho, é necessário escolher serviceAccountPath ou serviceAccountSecretRef.

Uma referência de secret do Kubernetes a um arquivo de chave de conta de serviço do Google. Consulte Como armazenar chaves de conta de serviço em secrets do Kubernetes.

guardrails.tolerations.effect Avançado Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

guardrails.tolerations.key Avançado Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

guardrails.tolerations.operator Avançado Introduzida na versão:1.16.0

Valor padrão: "Equal"

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

guardrails.tolerations.tolerationSeconds Avançado Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

guardrails.tolerations.value Avançado Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

httpProxy

httpProxy fornece parâmetros de configuração para um servidor proxy HTTP. Quando configurada em overrides.yaml, toda a comunicação pela Internet para os componentes Apigee Connect, Logger, MART, Metrics, Synchronizer e UDCA passa pelo servidor proxy.

Consulte também: connectAgent, logger, mart, metrics, e synchronizer.

A tabela a seguir descreve as propriedades do objeto httpProxy:

Propriedade Tipo Descrição
httpProxy.host Básico Introduzida na versão: 1.1.1

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-telemetry, apigee-virtualhost

O nome do host do proxy HTTP.

httpProxy.password Básico Introduzida na versão: 1.1.1

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-telemetry, apigee-virtualhost

Se o proxy HTTP exigir autenticação básica, use essa propriedade para fornecer uma senha.

httpProxy.port Básico Introduzida na versão: 1.1.1

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-telemetry, apigee-virtualhost

A porta do proxy HTTP.

httpProxy.scheme Básico Introduzida na versão: 1.1.1

Valor padrão: HTTPS

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-telemetry, apigee-virtualhost

O esquema usado pelo proxy. Os valores podem ser HTTP ou HTTPS. Os valores precisam estar em maiúsculas.

httpProxy.useForRuntimeManagement Avançado Introduzida na versão:1.15.1

Valor padrão: Nenhum

Gráfico:apigee-org

Se useForRuntimeManagement for definido como true, o tráfego de depuração/rastreamento será encaminhado pelo tempo de execução usando esse proxy de encaminhamento. Você pode definir essa flag mesmo que o tempo de execução tenha uma configuração de proxy própria para o ambiente. Nesse caso, o tráfego de depuração/rastreamento do tempo de execução usará o proxy compartilhado no nível da organização, enquanto o tráfego de back-end continuará usando o proxy no nível do ambiente.

httpProxy.username Básico Introduzida na versão: 1.1.1

Valor padrão: Nenhum

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-telemetry, apigee-virtualhost

Se o proxy HTTP exigir autenticação básica, use essa propriedade para fornecer um nome de usuário.

ingressGateways

Configura cada instância individual do gateway de entrada da Apigee. Use essas propriedades para gerenciar instâncias individuais separadamente por ingressGateways[].name.

Consulte apigeeIngressGateway para aplicar uma configuração comum a todas as instâncias do gateway de entrada da Apigee.'

Aplique alterações às propriedades ingressGateways com o gráfico apigee-org.

A tabela a seguir descreve as propriedades do objeto ingressGateways:

Propriedade Tipo Descrição
ingressGateways[].securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-org

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

ingressGateways[].name Básico Introduzida na versão: 1.8.0

Valor padrão: Nenhum

Gráfico:apigee-org

Obrigatório

O nome do gateway de entrada. Outros serviços usarão esse nome para endereçar o tráfego ao gateway. O nome precisa cumprir os seguintes requisitos:

  • máximo de 17 caracteres;
  • conter apenas caracteres alfanuméricos minúsculos, "-" ou "."
  • começar com um caractere alfanumérico;
  • terminar com um caractere alfanumérico.

Para mais informações, consulte Nomes de subdomínios de DNS na documentação do Kubernetes.

ingressGateways[].resources.limits.cpu Avançado Introduzida na versão: 1.8.0

Valor padrão: 2000m

Gráfico:apigee-org

O limite de CPU para o recurso, em milicores.

ingressGateways[].resources.limits.memory Avançado Introduzida na versão: 1.8.0

Valor padrão: 1Gi

Gráfico:apigee-org

O limite de memória do recurso, em mebibytes.

ingressGateways[].resources.requests.cpu Avançado Introduzida na versão: 1.8.0

Valor padrão: 300m

Gráfico:apigee-org

A CPU necessária para a operação normal do recurso, em milicores.

ingressGateways[].resources.requests.memory Avançado Introduzida na versão: 1.8.0

Valor padrão: 128Mi

Gráfico:apigee-org

A memória necessária para a operação normal do recurso, em mebibytes.

ingressGateways[].replicaCountMax Básico Introduzida na versão: 1.8.0

Valor padrão: 10

Gráfico:apigee-org

O número máximo de pods que podem ser adicionados de forma automática ao gateway de entrada disponível para escalonamento automático.

ingressGateways[].replicaCountMin Básico Introduzida na versão: 1.8.0

Valor padrão: 2

Gráfico:apigee-org

O número mínimo de pods para o gateway de entrada disponível para escalonamento automático.

ingressGateways[].svcAnnotations Básico Introduzida na versão: 1.8.0

Valor padrão: Nenhum

Gráfico:apigee-org

Mapa opcional de chave-valor usado para anotar o gateway de entrada em plataformas compatíveis com anotações. Por exemplo:

ingressGateways:
  svcAnnotations:
    networking.gke.io/load-balancer-type: "Internal"
ingressGateways[].svcLoadBalancerIP Básico Introduzida na versão: 1.8.0

Valor padrão: Nenhum

Gráfico:apigee-org

Nas plataformas compatíveis com a especificação do endereço IP do balanceador de carga, o balanceador de carga será criado com esse endereço IP. Nas plataformas que não permitem especificar o endereço de IP do balanceador de carga, essa propriedade é ignorada.

ingressGateways[].svcType Básico Introduzida na versão: 1.8.1

Valor padrão: LoadBalancer

Gráfico:apigee-org

Usado para alterar o tipo de serviço k8s padrão para a implantação de entrada. Defina o valor como ClusterIP se quiser desativar a criação do balanceador de carga padrão. Valores possíveis:

  • ClusterIP
  • LoadBalancer
ingressGateways[].targetCPUUtilizationPercentage Avançado Introduzido na versão: 1.10.5, 1.11.2, 1.12.1

Valor padrão: 75

Gráfico:apigee-org

O limite de uso da CPU para escalonar o número de pods no ReplicaSet, como uma porcentagem do total de recursos de CPU disponíveis.

Quando o uso da CPU ultrapassar esse valor, o híbrido aumentará gradualmente o número de pods no ReplicaSet, até ingressGateways[].replicaCountMax.

Para mais informações sobre escalonamento no Kubernetes, consulte Escalonamento automático horizontal de pods na documentação do Kubernetes.

ingressGateways[].tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

ingressGateways[].tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

ingressGateways[].tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-operator

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

ingressGateways[].tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-operator

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

ingressGateways[].tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-operator

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

istiod

Configura a entrada da Apigee.

A tabela a seguir descreve as propriedades do objeto istiod:

Propriedade Tipo Descrição
istiod.accessLogFile Avançado Introduzida na versão: 1.8.0

Valor padrão: /dev/stdout

Gráfico:apigee-ingress-manager

O endereço do arquivo do registro de acesso de entrada, por exemplo, /dev/stdout.

Deixar esse valor indefinido desativa a geração de registros de acesso.

istiod.accessLogFormat Avançado Introduzida na versão: 1.8.0

Gráfico:apigee-ingress-manager

O formato do registro de acesso de entrada.

Deixar esse valor indefinido resulta no uso do formato de registro de acesso padrão do proxy.

Formato de registro de acesso padrão:

'{"start_time":"%START_TIME%","remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%","user_agent":"%REQ(USER-AGENT)%","host":"%REQ(:AUTHORITY)%","request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%","request_time":"%DURATION%","status":"%RESPONSE_CODE%","status_details":"%RESPONSE_CODE_DETAILS%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","upstream_address":"%UPSTREAM_HOST%","upstream_response_flags":"%RESPONSE_FLAGS%","upstream_response_time":"%RESPONSE_DURATION%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_cluster":"%UPSTREAM_CLUSTER%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%","request_method":"%REQ(:METHOD)%","request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","request_protocol":"%PROTOCOL%","tls_protocol":"%DOWNSTREAM_TLS_VERSION%","request_id":"%REQ(X-REQUEST-ID)%","sni_host":"%REQUESTED_SERVER_NAME%","apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}'

Consulte a seguir uma cópia do formato de registro de acesso padrão com quebras de linha adicionadas para facilitar a leitura.

'{"start_time":"%START_TIME%",
  "remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%",
  "user_agent":"%REQ(USER-AGENT)%",
  "host":"%REQ(:AUTHORITY)%",
  "request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%",
  "request_time":"%DURATION%",
  "status":"%RESPONSE_CODE%",
  "status_details":"%RESPONSE_CODE_DETAILS%",
  "bytes_received":"%BYTES_RECEIVED%",
  "bytes_sent":"%BYTES_SENT%",
  "upstream_address":"%UPSTREAM_HOST%",
  "upstream_response_flags":"%RESPONSE_FLAGS%",
  "upstream_response_time":"%RESPONSE_DURATION%",
  "upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%",
  "upstream_cluster":"%UPSTREAM_CLUSTER%",
  "x_forwarded_for":"%REQ(X-FORWARDED-FOR)%",
  "request_method":"%REQ(:METHOD)%",
  "request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%",
  "request_protocol":"%PROTOCOL%",
  "tls_protocol":"%DOWNSTREAM_TLS_VERSION%",
  "request_id":"%REQ(X-REQUEST-ID)%",
  "sni_host":"%REQUESTED_SERVER_NAME%",
  "apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}'
istiod.forwardClientCertDetails Avançado Introduzida na versão: 1.9.2

Valor padrão: SANITIZE_SET

Gráfico:apigee-ingress-manager

Determina como o proxy Envoy (para o gateway de entrada da Apigee) manipula o cabeçalho HTTP x-forwarded-client-cert (XFCC).

Os valores possíveis são:

  • SANITIZE_SET (padrão) Quando a conexão do cliente for mTLS, redefina o cabeçalho XFCC com as informações do certificado do cliente e envie-o para o próximo salto.
  • FORWARD_ONLY Quando a conexão do cliente for mTLS (TLS mútuo), encaminhe o cabeçalho XFCC apenas na solicitação.
  • APPEND_FORWARD Quando a conexão do cliente for mTLS, anexe as informações do certificado do cliente ao cabeçalho XFCC da solicitação e encaminhe-a.
  • SANITIZE Não encaminhe o cabeçalho XFCC.
  • ALWAYS_FORWARD_ONLY Sempre encaminhe o cabeçalho XFCC na solicitação, independentemente de a conexão do cliente ser mTLS.

Para mais informações sobre esses valores, consulte a documentação do Envoy sobre Enum extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ForwardClientCertDetails.

Se você alterar essa configuração depois de instalar o Hybrid, aplique-o com apigeectl init e reinicie os pods de gateway de entrada da Apigee.

istiod.healthCheckUserAgents Avançado Introduzida na versão: 1.12.0

Valores padrão:

- "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring)"
- "Edge Health Probe"

Gráfico:apigee-ingress-manager

Permite que balanceadores de carga que não são doGoogle Cloud verifiquem os endpoints de verificação de integridade do gateway de entrada (/healthz/ingress e /healthz) substituindo a lista de permissões de user-agent padrão no modo híbrido.

Para substituir os user agents padrão especificados, use a seguinte sintaxe, inserindo os user agents personalizados:

istiod:
  healthCheckUserAgents:
  - "CUSTOM_USER_AGENT_1"
  - "CUSTOM_USER_AGENT_2"

Para remover a exigência de user agent, use o seguinte:

istiod:
  healthCheckUserAgents: []

istiod.image.pullPolicy Avançado Introduzida na versão: 1.8.0

Valor padrão: IfNotPresent

Gráfico:apigee-ingress-manager

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

istiod.image.tag Avançado Introduzida na versão: 1.8.0

Valor padrão: 1.16.0

Gráfico:apigee-ingress-manager

O rótulo da versão da imagem do Docker desse serviço.

istiod.image.url Avançado Introduzida na versão: 1.8.0

Valor padrão: Nenhum

Gráfico:apigee-ingress-manager

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

istiod.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-ingress-manager

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

istiod.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-ingress-manager

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

istiod.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-ingress-manager

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

istiod.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-ingress-manager

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

istiod.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-ingress-manager

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

k8sCluster

Identifica o cluster do Kubernetes em que o ambiente de execução híbrido está instalado.

A tabela a seguir descreve as propriedades do objeto k8sCluster:

Propriedade Tipo Descrição
k8sCluster.name Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-telemetry

O nome do cluster do Kubernetes em que o ambiente de execução híbrido está instalado.

k8sCluster.region Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-telemetry

Identifica a região do Google Cloud em que seu cluster do Kubernetes foi criado.

kubeRBACProxy

Identifica onde a Apigee deve procurar controles de acesso baseados em papéis do Kubernetes.

A tabela a seguir descreve as propriedades do objeto kubeRBACProxy:

Propriedade Tipo Descrição
kubeRBACProxy.image.pullPolicy Avançado Introduzida na versão: 1.2.0

Valor padrão: IfNotPresent

Gráfico:apigee-operator, apigee-ingress-manager

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

kubeRBACProxy.image.tag Avançado Introduzida na versão: 1.2.0

Valor padrão: 1.16.0

Gráfico:apigee-operator, apigee-ingress-manager

O rótulo da versão da imagem do Docker desse serviço.

kubeRBACProxy.image.url Avançado Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-operator, apigee-ingress-manager

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

kubeRBACProxy.resources.limits.cpu Avançado Introduzido na versão: 1.11.0

Valor padrão: 500m

Gráfico:apigee-operator, apigee-ingress-manager

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

kubeRBACProxy.resources.limits.memory Avançado Introduzido na versão: 1.11.0

Valor padrão: 128Mi

Gráfico:apigee-operator, apigee-ingress-manager

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes.

kubeRBACProxy.resources.requests.cpu Avançado Introduzido na versão: 1.11.0

Valor padrão: 5m

Gráfico:apigee-operator, apigee-ingress-manager

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

kubeRBACProxy.resources.requests.memory Avançado Introduzido na versão: 1.11.0

Valor padrão: 64Mi

Gráfico:apigee-operator, apigee-ingress-manager

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes.

logger

Define o serviço que gerencia registros operacionais. Todos os serviços do híbrido da Apigee que são executados no cluster do Kubernetes geram essas informações.

Para mais informações, consulte Visão geral do Logging.

A tabela a seguir descreve as propriedades do objeto logger:

Propriedade Tipo Descrição
logger.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

logger.annotations Avançado Introduzida na versão: 1.5.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Mapa opcional de chave-valor usado para anotar pods. Para mais informações, consulte Anotações personalizadas.

logger.bufferChunkSize Avançado Introduzida na versão: 1.12.0

Valor padrão: 256k

Gráfico:apigee-telemetry

O tamanho inicial do buffer para ler arquivos de registro.

logger.bufferMaxSize Avançado Introduzida na versão: 1.12.0

Valor padrão: 104857600

Gráfico:apigee-telemetry

O limite do tamanho do buffer por arquivo monitorado. Os arquivos que excedem esse limite são removidos da lista de arquivos monitorados.

logger.bufferMemoryLimit Avançado Introduzida na versão: 1.12.0

Valor padrão: 150 MB

Gráfico:apigee-telemetry

O limite de memória que o logger pode consumir. Se o alcance for atingido, o registrador fará uma pausa momentânea na leitura de mais dados até que os dados existentes sejam transferidos para a memória.

logger.enabled Básico Introduzida na versão: 1.0.0

Valor padrão: false

Gráfico:apigee-telemetry

Ativa ou desativa a geração de registros no cluster. Para não GKE definido como true, para GKE em Google Cloud ou Google Distributed Cloud definido como false.

logger.envVars Básico Introduzida na versão: 1.8.5

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Permite incluir a variável de ambiente NO_PROXY do Fluent Bit, que especifica URLs para os quais o tráfego não é roteado por meio do proxy HTTP. A variável NO_PROXY precisa ser definida como uma string separada por vírgulas de nomes de host, no formato:

logger:
  ...
  envVars:
    NO_PROXY: '<comma-separated-values>'

por exemplo:

  envVars:
    NO_PROXY: 'kubernetes.default.svc,oauth2.googleapis.com,logging.googleapis.com'

Use envVars: NO_PROXY opcionalmente quando o proxy de encaminhamento de HTTP estiver ativado.

Consulte NO_PROXY na documentação do Fluent Bit.

logger.flushInterval Avançado Introduzida na versão: 1.12.0

Valor padrão: 1

Gráfico:apigee-telemetry

O intervalo a aguardar antes de invocar a próxima limpeza de buffer, em segundos.

logger.gsa Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google (GSA) apigee-logger a ser associada à conta de serviço correspondente do Kubernetes ao ativar a Identidade da carga de trabalho nos clusters do GKE usando gráficos do Helm. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-logger@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

logger.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-telemetry

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

logger.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-telemetry

O rótulo da versão da imagem do Docker desse serviço.

logger.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

logger.livenessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 3

Gráfico:apigee-telemetry

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de ativação antes de reiniciar o contêiner. O valor mínimo é 1.

logger.livenessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 0

Gráfico:apigee-telemetry

O número de segundos após o início de um contêiner antes que uma sondagem de ativação seja iniciada.

logger.livenessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 60

Gráfico:apigee-telemetry

Determina a frequência com que uma sondagem de atividade será feita, em segundos. O valor mínimo é 1.

logger.livenessProbe.successThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-telemetry

O número mínimo de sucessos consecutivos necessários para que uma sondagem de atividade seja considerada bem-sucedida após uma falha. O valor mínimo é 1.

logger.livenessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-telemetry

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

logger.nodeSelector.key Básico Introduzida na versão: 1.0.0

Valor padrão: apigee.com/apigee-logger-enabled

Gráfico:apigee-telemetry

Obrigatório

Chave de rótulo do seletor de nós usada para segmentar nós dedicados do Kubernetes para serviços do ambiente de execução logger.

Consulte Como configurar pools de nós dedicados.

logger.nodeSelector.value Básico Introduzida na versão: 1.0.0

Valor padrão: true

Gráfico:apigee-telemetry

Obrigatório

Valor do rótulo do seletor de nós usado para segmentar nós dedicados do Kubernetes para serviços do ambiente de execução logger.

Consulte Como configurar pools de nós dedicados.

logger.resources.limits.cpu Avançado Introduzida na versão: 1.0.0

Valor padrão: 200m

Gráfico:apigee-telemetry

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

logger.resources.limits.memory Avançado Introduzida na versão: 1.0.0

Valor padrão: 500Mi

Gráfico:apigee-telemetry

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes.

logger.resources.requests.cpu Avançado Introduzida na versão: 1.0.0

Valor padrão: 100m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

logger.resources.requests.memory Avançado Introduzida na versão: 1.0.0

Valor padrão: 250Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes.

logger.serviceAccountPath Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Caminho para o arquivo de chave da conta de serviço do Google com o papel de gravador de registros.

logger.serviceAccountRef Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Uma referência de secret do Kubernetes a um arquivo de chave da conta de serviço do Google. Consulte Como armazenar chaves de conta de serviço em secrets do Kubernetes.

logger.storageMaxChunks Avançado Introduzida na versão: 1.12.0

Valor padrão: 128

Gráfico:apigee-telemetry

O número máximo de blocos que podem estar ativos na memória. Os blocos que excederem o limite serão salvos no sistema de arquivos.

logger.terminationGracePeriodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 30

Gráfico:apigee-telemetry

O tempo máximo entre uma solicitação de exclusão de pod e quando o pod é eliminado, em segundos. Durante esse período, todos os hooks de prestop serão executados, e qualquer processo em execução será encerrado sem problemas. O pod será encerrado quando todos os processos em execução forem concluídos ou ao final do período de carência, o que ocorrer primeiro. Se não houver processos em execução, o pod será encerrado imediatamente.

logger.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

logger.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

logger.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-telemetry

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

logger.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

logger.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

mart

Define o serviço MART (API Management para dados do ambiente de execução, na sigla em inglês), que age como um provedor de API para APIs públicas da Apigee, para que você possa acessar e gerenciar entidades de dados de ambiente de execução, como KMS (Chaves de API e tokens OAuth), KVM, cota e produtos de API.

A tabela a seguir descreve as propriedades do objeto mart:

Propriedade Tipo Descrição
mart.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-org

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

mart.annotations Avançado Introduzida na versão: 1.5.0

Valor padrão: Nenhum

Gráfico:apigee-org

Mapa opcional de chave-valor usado para anotar pods. Para mais informações, consulte Anotações personalizadas.

mart.gsa Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-org

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google (GSA) apigee-mart a ser associada à conta de serviço correspondente do Kubernetes ao ativar a Identidade da carga de trabalho nos clusters do GKE usando gráficos do Helm. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-mart@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

mart.hostAlias Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-org

O alias de host que aponta para o objeto MART. É possível definir essa propriedade como * ou um nome de domínio totalmente qualificado.

mart.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-org, apigee-env

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

mart.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-org, apigee-env

O rótulo da versão da imagem do Docker desse serviço.

mart.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-org, apigee-env

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

mart.initCheckCF.resources.requests.cpu Avançado Introduzida na versão: 1.0.0

Valor padrão: 10m

Gráfico:apigee-org

A quantidade de CPU alocada para a verificação de inicialização do processo do Cloud Foundry.

mart.livenessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 12

Gráfico:apigee-org

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de ativação antes de reiniciar o contêiner. O valor mínimo é 1.

mart.livenessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 15

Gráfico:apigee-org

O número de segundos após o início de um contêiner antes que uma sondagem de ativação seja iniciada.

mart.livenessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-org

Determina a frequência com que uma sondagem de atividade será feita, em segundos. O valor mínimo é 1.

mart.livenessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-org

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

mart.metricsURL Básico Introduzida na versão: 1.0.0

Valor padrão: /v1/server/metrics

Gráfico:apigee-org

mart.nodeSelector.key Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-org

Chave de rótulo do seletor de nó opcional para segmentar nós do Kubernetes para serviços do ambiente de execução mart. Se você não especificar uma chave para mart.nodeselector, o ambiente de execução usará o nó especificado no objeto nodeSelector.

Consulte Como configurar pools de nós dedicados.

mart.nodeSelector.value Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-org

Valor do rótulo do seletor de nós opcional para segmentação de nós do Kubernetes para mart serviços do ambiente de execução. Consulte também o objeto nodeSelector.

Consulte Como configurar pools de nós dedicados.

mart.readinessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 2

Gráfico:apigee-org

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de preparo antes de marcar o pod como não pronto. O valor mínimo é 1.

mart.readinessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 15

Gráfico:apigee-org

O número de segundos após o início de um contêiner antes de uma sondagem de preparo.

mart.readinessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-org

Determina a frequência com uma sondagem de preparo será feita, em segundos. O valor mínimo é 1.

mart.readinessProbe.successThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-org

O número mínimo de sucessos consecutivos necessários para que uma sondagem de preparo seja considerada bem-sucedida após uma falha. O valor mínimo é 1.

mart.readinessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-org

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

mart.replicaCountMax Básico Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-org

Número máximo de réplicas disponíveis para escalonamento automático.

mart.replicaCountMin Básico Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-org

Número mínimo de réplicas disponíveis para escalonamento automático.

mart.resources.limits.cpu Avançado Introduzido na versão: 1.11.0

Valor padrão: 2000m

Gráfico:apigee-org

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

mart.resources.limits.memory Avançado Introduzido na versão: 1.11.0

Valor padrão: 5Gi

Gráfico:apigee-org

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes.

mart.resources.requests.cpu Avançado Introduzida na versão: 1.0.0

Valor padrão: 500m

Gráfico:apigee-org

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

mart.resources.requests.memory Avançado Introduzida na versão: 1.0.0

Valor padrão: 512Mi

Gráfico:apigee-org

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes.

mart.serviceAccountPath Básico Introduzida na versão: 1.1.1

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Caminho para o arquivo de chave da conta de serviço do Google sem papel.

mart.serviceAccountRef Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Uma referência de secret do Kubernetes a um arquivo de chave da conta de serviço do Google. Consulte Como armazenar chaves de conta de serviço em secrets do Kubernetes.

mart.sslCertPath Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário sslCertPath/sslKeyPath ou sslSecret.

Caminho do sistema de arquivos local para carregar e codificar o certificado SSL como um Secret.

mart.sslKeyPath Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário sslCertPath/sslKeyPath ou sslSecret.

Caminho do sistema de arquivos local para carregar e codificar a chave SSL para um secret.

mart.sslSecret Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário sslCertPath/sslKeyPath ou sslSecret.

O nome de um arquivo armazenado em um secret do Kubernetes que contém o certificado TLS e a chave privada. Você precisa criar o secret usando o certificado TLS e os dados da chave como entrada.

Consulte também:

mart.targetCPUUtilizationPercentage Avançado Introduzida na versão: 1.0.0

Valor padrão: 75

Gráfico:apigee-org

Meta de uso da CPU para o processo MART no pod. O valor desse campo permite que o MART seja escalonado automaticamente quando a utilização da CPU atingir esse valor, até replicaCountMax.

mart.terminationGracePeriodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 30

Gráfico:apigee-org

O tempo máximo entre uma solicitação de exclusão de pod e quando o pod é eliminado, em segundos. Durante esse período, todos os hooks de prestop serão executados, e qualquer processo em execução será encerrado sem problemas. O pod será encerrado quando todos os processos em execução forem concluídos ou ao final do período de carência, o que ocorrer primeiro. Se não houver processos em execução, o pod será encerrado imediatamente.

mart.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

mart.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

mart.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

mart.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

mart.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

metrics

Define o serviço que coleta métricas de operações. Use os dados das métricas para monitorar a integridade dos serviços híbridos, configurar alertas e assim por diante.

Para mais informações, consulte Visão geral da coleta de métricas.

A tabela a seguir descreve as propriedades do objeto metrics:

Propriedade Tipo Descrição
metrics.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

metrics.adapter.image.pullPolicy Avançado Introduzida na versão: 1.8.1

Valor padrão: IfNotPresent

Gráfico:apigee-telemetry

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

metrics.adapter.image.tag Avançado Introduzida na versão: 1.8.1

Valor padrão: 1.16.0

Gráfico:apigee-telemetry

O rótulo da versão da imagem do Docker desse serviço.

metrics.adapter.image.url Avançado Introduzida na versão: 1.8.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

metrics.adapter.resources.limits.cpu Avançado Introduzida na versão:1.14.1

Valor padrão: 500m

Gráfico:apigee-telemetry

O limite de CPU do recurso de adaptador em um contêiner do Kubernetes, em millicores.

metrics.adapter.resources.limits.memory Avançado Introduzida na versão:1.14.1

Valor padrão: 4Gi

Gráfico:apigee-telemetry

O limite de memória para o recurso de adaptador em um contêiner do Kubernetes, em gibibytes.

metrics.adapter.resources.requests.cpu Avançado Introduzida na versão:1.14.1

Valor padrão: 100m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do adaptador em um contêiner do Kubernetes, em millicores.

metrics.adapter.resources.requests.memory Avançado Introduzida na versão:1.14.1

Valor padrão: 128Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do adaptador em um contêiner do Kubernetes, em mebibytes.

metrics.aggregator.resources.requests.cpu Avançado Introduzida na versão: 1.4.0

Valor padrão: 500m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do agregador em um contêiner do Kubernetes, em millicores.

metrics.aggregator.resources.requests.memory Avançado Introduzida na versão: 1.4.0

Valor padrão: 512Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do agregador em um contêiner do Kubernetes, em mebibytes.

metrics.aggregator.resources.limits.cpu Avançado Introduzida na versão: 1.4.0

Valor padrão: 500m

Gráfico:apigee-telemetry

O limite de CPU do recurso de agregador em um contêiner do Kubernetes, em millicores.

metrics.aggregator.resources.limits.memory Avançado Introduzida na versão: 1.4.0

Valor padrão: 3Gi

Gráfico:apigee-telemetry

O limite de memória do recurso de agregador em um contêiner do Kubernetes, em gibibytes.

metrics.annotations Avançado Introduzida na versão: 1.5.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Mapa opcional de chave-valor usado para anotar pods. Para mais informações, consulte Anotações personalizadas.

metrics.app.resources.requests.cpu Avançado Introduzida na versão: 1.4.0

Valor padrão: 500m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do app em um contêiner do Kubernetes, em millicores.

metrics.app.resources.requests.memory Avançado Introduzida na versão: 1.4.0

Valor padrão: 512Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do app em um contêiner do Kubernetes, em mebibytes.

metrics.app.resources.limits.cpu Avançado Introduzida na versão: 1.4.0

Valor padrão: 500m

Gráfico:apigee-telemetry

O limite de CPU do recurso do aap em um contêiner do Kubernetes, em millicores.

metrics.app.resources.limits.memory Avançado Introduzida na versão: 1.4.0

Valor padrão: 1Gi

Gráfico:apigee-telemetry

O limite de memória para o recurso do app em um contêiner do Kubernetes, em gibibytes.

metrics.appStackdriverExporter.resources.limits.cpu Avançado Introduzida na versão: 1.7.0

Valor padrão: 500m

Gráfico:apigee-telemetry

O limite de CPU do recurso stackdriverExporter em um contêiner do Kubernetes, em millicores.

metrics.appStackdriverExporter.resources.limits.memory Avançado Introduzida na versão: 1.7.0

Valor padrão: 1Gi

Gráfico:apigee-telemetry

O limite de memória para o recurso stackdriverExporter em um contêiner do Kubernetes, em gibibytes.

metrics.appStackdriverExporter.resources.requests.cpu Avançado Introduzida na versão: 1.7.0

Valor padrão: 128m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do stackdriverExporter em um contêiner do Kubernetes, em millicores.

metrics.appStackdriverExporter.resources.requests.memory Avançado Introduzida na versão: 1.7.0

Valor padrão: 512Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do stackdriverExporter em um contêiner do Kubernetes, em mebibytes.

metrics.collector.envVars Básico Introduzida na versão: 1.13

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Permite transmitir e substituir variáveis de ambiente no OpenTelemetry. Por exemplo, é possível definir HTTP_PROXY, HTTPS_PROXY ou NO_PROXY para receber as solicitações passam pelo servidor proxy.

A variável HTTP_PROXY pode ser definida como uma string que contém o nome do host no formato:

metrics:
...
  envVars:
    HTTP_PROXY: '<host-name>'

por exemplo:

  envVars:
    HTTP_PROXY: 'http://1.1.1.1:80'

A variável HTTPS_PROXY pode ser definida como uma string que contém o nome do host no formato:

metrics:
...
  envVars:
    HTTPS_PROXY: '<host-name>'

por exemplo:

  envVars:
    HTTPS_PROXY: 'https://1.1.1.1:80'

A variável NO_PROXY precisa ser definida como uma string separada por vírgulas de nomes de host, no formato:

metrics:
...
envVars:
  NO_PROXY: '<comma-separated-values>'

por exemplo:

envVars:
  NO_PROXY: 'https://1.1.1.1:80, https://1.1.1.1:81'

Use envVars: HTTP_PROXY, envVars: HTTPS_PROXY ou envVars: NO_PROXY opcionalmente quando o proxy de encaminhamento de HTTP estiver ativado.

Consulte Compatibilidade com proxy na documentação do OpenTelemetry.

metrics.collector.imagePullPolicy Avançado Introduzida na versão: 1.12.0

Valor padrão: IfNotPresent

Gráfico:apigee-telemetry

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, acesse Usar um repositório de imagens particular com a Apigee híbrida .

metrics.collector.image.tag Básico Introduzida na versão: 1.12.0

Valor padrão: 1.16.0

Gráfico:apigee-telemetry

O rótulo da versão da imagem do Docker desse serviço.

metrics.collector.image.url Básico Introduzida na versão: 1.12.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

metrics.collector.resources.requests.cpu Avançado Introduzida na versão: 1.12.0

Valor padrão: 500m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do app em um contêiner do Kubernetes, em millicores.

metrics.collector.resources.requests.memory Avançado Introduzida na versão: 1.12.0

Valor padrão: 512Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do app em um contêiner do Kubernetes, em mebibytes.

metrics.collector.resources.limits.cpu Avançado Introduzida na versão: 1.12.0

Valor padrão: 500m

Gráfico:apigee-telemetry

O limite de CPU do recurso do aap em um contêiner do Kubernetes, em millicores.

metrics.collector.resources.limits.memory Avançado Introduzida na versão: 1.12.0

Valor padrão: 1Gi

Gráfico:apigee-telemetry

O limite de memória para o recurso do app em um contêiner do Kubernetes, em gibibytes.

metrics.collector.livenessProbe.failureThreshold Avançado Introduzida na versão: 1.12.0

Valor padrão: 5

Gráfico:apigee-telemetry

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de ativação antes de reiniciar o contêiner. O valor mínimo é 1.

metrics.collector.livenessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.12.0

Valor padrão: 30

Gráfico:apigee-telemetry

O número de segundos após o início de um contêiner antes que uma sondagem de ativação seja iniciada.

metrics.collector.livenessProbe.periodSeconds Avançado Introduzida na versão: 1.12.0

Valor padrão: 10

Gráfico:apigee-telemetry

Determina a frequência com que uma sondagem de atividade será feita, em segundos. O valor mínimo é 1.

metrics.collector.livenessProbe.successThreshold Avançado Introduzida na versão: 1.12.0

Valor padrão: 1

Gráfico:apigee-telemetry

O número mínimo de sucessos consecutivos necessários para que uma sondagem de atividade seja considerada bem-sucedida após uma falha. O valor mínimo é 1.

metrics.collector.livenessProbe.timeoutSeconds Avançado Introduzida na versão: 1.12.0

Valor padrão: 5

Gráfico:apigee-telemetry

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

metrics.collector.readinessProbe.failureThreshold Avançado Introduzida na versão: 1.12.0

Valor padrão: 3

Gráfico:apigee-telemetry

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de preparo antes de marcar o pod como não pronto. O valor mínimo é 1.

metrics.collector.readinessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.12.0

Valor padrão: 30

Gráfico:apigee-telemetry

O número de segundos após o início de um contêiner antes de uma sondagem de preparo.

metrics.collector.readinessProbe.periodSeconds Avançado Introduzida na versão: 1.12.0

Valor padrão: 10

Gráfico:apigee-telemetry

Determina a frequência com uma sondagem de preparo será feita, em segundos. O valor mínimo é 1.

metrics.collector.readinessProbe.successThreshold Avançado Introduzida na versão: 1.12.0

Valor padrão: 1

Gráfico:apigee-telemetry

O número mínimo de sucessos consecutivos necessários para que uma sondagem de preparo seja considerada bem-sucedida após uma falha. O valor mínimo é 1.

metrics.collector.readinessProbe.timeoutSeconds Avançado Introduzida na versão: 1.12.0

Valor padrão: 5

Gráfico:apigee-telemetry

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

metrics.disablePrometheusPipeline Básico Introduzida na versão: 1.12.0

Valor padrão: true

Gráfico:apigee-telemetry

As métricas dos recursos monitorados ProxyV2 e TargetV2 não são emitidas quando definidas como true. Em vez disso, use métricas para os recursos monitorados Proxy e Target.

metrics.enabled Básico Introduzida na versão: 1.0.0

Valor padrão: true

Gráfico:apigee-telemetry

Ativa as métricas da Apigee. Defina como true para ativar métricas. Defina como false para desativar métricas.

metrics.gsa Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google (GSA) apigee-metrics a ser associada à conta de serviço correspondente do Kubernetes ao ativar a Identidade da carga de trabalho nos clusters do GKE usando gráficos do Helm. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-metrics@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

metrics.nodeSelector.key Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Obrigatório

Chave de rótulo do seletor de nós usada para segmentar nós dedicados do Kubernetes para serviços do ambiente de execução metrics.

Consulte Como configurar pools de nós dedicados.

metrics.nodeSelector.value Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Obrigatório

Valor do rótulo do seletor de nós usado para segmentar nós dedicados do Kubernetes para serviços do ambiente de execução metrics.

Consulte Como configurar pools de nós dedicados.

metrics.prometheus.containerPort Avançado Introduzida na versão: 1.0.0

Valor padrão: 9090

Gráfico:apigee-telemetry

A porta para se conectar ao serviço de métricas do Prometheus.

metrics.prometheus.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-telemetry

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

metrics.prometheus.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-telemetry

O rótulo da versão da imagem do Docker desse serviço.

metrics.prometheus.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

metrics.prometheus.livenessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 6

Gráfico:apigee-telemetry

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de ativação antes de reiniciar o contêiner. O valor mínimo é 1.

metrics.prometheus.livenessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-telemetry

Determina a frequência com que uma sondagem de atividade será feita, em segundos. O valor mínimo é 1.

metrics.prometheus.livenessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 3

Gráfico:apigee-telemetry

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

metrics.prometheus.readinessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 120

Gráfico:apigee-telemetry

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de preparo antes de marcar o pod como não pronto. O valor mínimo é 1.

metrics.prometheus.readinessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-telemetry

Determina a frequência com uma sondagem de preparo será feita, em segundos. O valor mínimo é 1.

metrics.prometheus.readinessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 3

Gráfico:apigee-telemetry

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

metrics.prometheus.resources.limits.cpu Avançado Introduzida na versão:1.14.1

Valor padrão: 500m

Gráfico:apigee-telemetry

O limite de CPU do recurso do Prometheus em um contêiner do Kubernetes, em millicores.

metrics.prometheus.resources.limits.memory Avançado Introduzida na versão:1.14.1

Valor padrão: 4Gi

Gráfico:apigee-telemetry

O limite de memória para o recurso do Prometheus em um contêiner do Kubernetes, em gibibytes.

metrics.prometheus.resources.requests.cpu Avançado Introduzida na versão:1.14.1

Valor padrão: 128m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do Prometheus em um contêiner do Kubernetes, em millicores.

metrics.prometheus.resources.requests.memory Avançado Introduzida na versão:1.14.1

Valor padrão: 512Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do Prometheus em um contêiner do Kubernetes, em mebibytes.

metrics.prometheus.sslCertPath Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Obrigatório

Caminho para o certificado SSL para o processo de coleta de métricas do Prometheus. O Prometheus é uma ferramenta que a Apigee pode usar para coletar e processar métricas.

Veja estes tópicos:

metrics.prometheus.sslKeyPath Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Obrigatório

Caminho para a chave SSL do processo de coleta de métricas do Prometheus. O Prometheus é uma ferramenta que a Apigee pode usar para coletar e processar métricas.

Veja estes tópicos:

metrics.proxy.resources.requests.cpu Avançado Introduzida na versão: 1.4.0

Valor padrão: 500m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do proxy em um contêiner do Kubernetes, em millicores.

metrics.proxy.resources.requests.memory Avançado Introduzida na versão: 1.4.0

Valor padrão: 512Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do proxy em um contêiner do Kubernetes, em mebibytes.

metrics.proxy.resources.limits.cpu Avançado Introduzida na versão: 1.4.0

Valor padrão: 500m

Gráfico:apigee-telemetry

O limite de CPU do recurso de proxy em um contêiner do Kubernetes, em millicores.

metrics.proxy.resources.limits.memory Avançado Introduzida na versão: 1.4.0

Valor padrão: 1Gi

Gráfico:apigee-telemetry

O limite de memória do recurso de proxy em um contêiner Kubernetes em gibibytes.

metrics.proxyStackdriverExporter.resources.requests.cpu Avançado Introduzida na versão: 1.7.0

Valor padrão: 128m

Gráfico:apigee-telemetry

A CPU necessária para a operação normal do stackdriverExporter em um contêiner do Kubernetes, em millicores.

metrics.proxyStackdriverExporter.resources.requests.memory Avançado Introduzida na versão: 1.7.0

Valor padrão: 512Mi

Gráfico:apigee-telemetry

A memória necessária para a operação normal do stackdriverExporter em um contêiner do Kubernetes, em mebibytes.

metrics.proxyStackdriverExporter.resources.limits.cpu Avançado Introduzida na versão: 1.7.0

Valor padrão: 500m

Gráfico:apigee-telemetry

O limite de CPU do recurso stackdriverExporter em um contêiner do Kubernetes, em millicores.

metrics.proxyStackdriverExporter.resources.limits.memory Avançado Introduzida na versão: 1.7.0

Valor padrão: 1Gi

Gráfico:apigee-telemetry

O limite de memória para o recurso stackdriverExporter em um contêiner do Kubernetes, em gibibytes.

metrics.proxyURL Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

URL do proxy secundário do processo de métricas no cluster do Kubernetes.

metrics.sdSidecar.containerPort Avançado Introduzida na versão: 1.0.0

Valor padrão: 9091

Gráfico:apigee-telemetry

A porta para se conectar ao serviço de métricas do Cloud Monitoring.

metrics.sdSidecar.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-telemetry

Determina quando o Kubelet extrai a imagem do Docker desse serviço. Os valores possíveis incluem:

  • IfNotPresent: não extrair uma nova imagem se ela já existir
  • Always: sempre extrair a política, mesmo que ela já exista

    Para mais informações, consulte Como atualizar imagens.

metrics.sdSidecar.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-telemetry

O rótulo da versão da imagem do Docker desse serviço.

metrics.sdSidecar.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

metrics.serviceAccountPath Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Caminho para o arquivo de chave da conta de serviço do Google com o papel de gravador de métricas do Monitoring.

metrics.serviceAccountRef Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-telemetry

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Uma referência de secret do Kubernetes a um arquivo de chave da conta de serviço do Google. Consulte Como armazenar chaves de conta de serviço em secrets do Kubernetes.

metrics.stackdriverExporter.resources.requests.cpu Avançado Introduzida na versão: 1.4.0

Gráfico:apigee-telemetry

Deprecated: a partir da versão híbrida 1.8, metrics:stackdriverExporter foi substituído por metrics:appStackdriverExporter e metrics:proxyStackdriverExporter. Veja estes tópicos:

metrics.stackdriverExporter.resources.requests.memory Avançado Introduzida na versão: 1.4.0

Gráfico:apigee-telemetry

Deprecated: a partir da versão híbrida 1.8, metrics:stackdriverExporter foi substituído por metrics:appStackdriverExporter e metrics:proxyStackdriverExporter. Veja estes tópicos:

metrics.stackdriverExporter.resources.limits.cpu Avançado Introduzida na versão: 1.4.0

Gráfico:apigee-telemetry

Deprecated: a partir da versão híbrida 1.8, metrics:stackdriverExporter foi substituído por metrics:appStackdriverExporter e metrics:proxyStackdriverExporter. Veja estes tópicos:

metrics.stackdriverExporter.resources.limits.memory Avançado Introduzida na versão: 1.4.0

Gráfico:apigee-telemetry

Deprecated: a partir da versão híbrida 1.8, metrics:stackdriverExporter foi substituído por metrics:appStackdriverExporter e metrics:proxyStackdriverExporter. Veja estes tópicos:

metrics.terminationGracePeriodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 300

Gráfico:apigee-telemetry

O tempo máximo entre uma solicitação de exclusão de pod e quando o pod é eliminado, em segundos. Durante esse período, todos os hooks de prestop serão executados, e qualquer processo em execução será encerrado sem problemas. O pod será encerrado quando todos os processos em execução forem concluídos ou ao final do período de carência, o que ocorrer primeiro. Se não houver processos em execução, o pod será encerrado imediatamente.

metrics.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

metrics.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

metrics.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-telemetry

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

metrics.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

metrics.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-telemetry

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

mintTaskScheduler

mintTaskScheduler é o cron job para programar tarefas de monetização, como cálculo de taxa recorrente periodicamente.

A tabela a seguir descreve as propriedades do objeto mintTaskScheduler:

Propriedade Tipo Descrição
mintTaskScheduler.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-org

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

mintTaskScheduler.gsa Avançado Introduzida na versão:1.15.1

Valor padrão: Nenhum

Gráfico:apigee-org

O endereço de e-mail da conta de serviço do IAM do Google (GSA) apigee-mint-task-scheduler a ser associada à conta de serviço correspondente do Kubernetes ao ativar Identidade da carga de trabalho nos clusters do GKE usando gráficos do Helm. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-mint-task-scheduler@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

mintTaskScheduler.image.pullPolicy Avançado Introduzida na versão: 1.7.0

Valor padrão: IfNotPresent

Gráfico:apigee-org

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

mintTaskScheduler.image.tag Avançado Introduzida na versão: 1.7.0

Valor padrão: 1.16.0

Gráfico:apigee-org

O rótulo da versão da imagem do Docker desse serviço.

mintTaskScheduler.image.url Avançado Introduzida na versão: 1.7.0

Valor padrão: Nenhum

Gráfico:apigee-org

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

mintTaskScheduler.resources.limits.cpu Avançado Introduzido na versão: 1.1.0

Valor padrão: 2000m

Gráfico:apigee-org

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

mintTaskScheduler.resources.limits.memory Avançado Introduzido na versão: 1.1.0

Valor padrão: 4Gi

Gráfico:apigee-org

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes.

mintTaskScheduler.resources.requests.cpu Avançado Introduzida na versão: 1.7.0

Valor padrão: 500m

Gráfico:apigee-org

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

mintTaskScheduler.resources.requests.memory Avançado Introduzida na versão: 1.7.0

Valor padrão: 512Mi

Gráfico:apigee-org

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes.

mintTaskScheduler.serviceAccountPath Básico Introduzida na versão:1.15.1

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Caminho para o arquivo de chave da conta de serviço do Google.

mintTaskScheduler.serviceAccountRef Básico Introduzida na versão:1.15.1

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Uma referência de secret do Kubernetes a um arquivo de chave da conta de serviço do Google. Consulte Como armazenar chaves de conta de serviço em secrets do Kubernetes.

mintTaskScheduler.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

mintTaskScheduler.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

mintTaskScheduler.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

mintTaskScheduler.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

mintTaskScheduler.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

newDataPipeline

newDataPipeline determina se o híbrido da Apigee usa o pipeline de dados do Pub/Sub para que os componentes do ambiente de execução gravem dados diretamente no plano de controle.

A tabela a seguir descreve as propriedades do objeto newDataPipeline:

Propriedade Tipo Descrição
newDataPipeline.debugSession Avançado Introduzido na versão: 1.13.1

Valor padrão: true

Gráfico:apigee-env

Determina se o pipeline de dados do Pub/Sub está ativado.

newDataPipeline.analytics Avançado Introduzido na versão: 1.13.1

Valor padrão: true

Gráfico:apigee-env

Determina se a análise usa o pipeline de dados do Pub/Sub.

nodeSelector

O objeto nodeSelector define o nó da instância da Apigee. Nos bastidores, a Apigee híbrida cuida de mapear a chave/valor do rótulo apigeeRuntime e apigeeData para os componentes individuais do Istio e do MART quando você instala ou faz upgrade do apigee-org e apigee-ingress-manager. É possível substituir isso por objetos individuais na propriedade mart:nodeSelector.

A tabela a seguir descreve as propriedades do objeto nodeSelector:

Propriedade Tipo Descrição
nodeSelector.apigeeData.key Avançado Introduzida na versão: 1.0.0

Valor padrão: cloud.google.com/gke-nodepool

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-redis, apigee-telemetry, apigee-virtualhost

ApigeeData é o nó do banco de dados do Cassandra. Chave de rótulo do seletor de nós para segmentar nós do Kubernetes para trabalhar com dados de serviços da Apigee.

Consulte Configurar pools de nós dedicados.

nodeSelector.apigeeData.value Avançado Introduzida na versão: 1.0.0

Valor padrão: apigee-data

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-redis, apigee-telemetry, apigee-virtualhost

apigee-data é o nó do banco de dados do Cassandra. Valor do rótulo do seletor de nós para segmentar nós do Kubernetes para trabalhar com dados de serviços da Apigee.

Consulte Configurar pools de nós dedicados.

nodeSelector.apigeeRuntime.key Avançado Introduzida na versão: 1.0.0

Valor padrão: cloud.google.com/gke-nodepool

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-redis, apigee-telemetry, apigee-virtualhost

O ambiente de execução da Apigee é o nó do ambiente de execução do projeto. Chave de rótulo do seletor de nós para segmentar nós do Kubernetes para serviços do ambiente de execução da Apigee.

Consulte Configurar pools de nós dedicados.

nodeSelector.apigeeRuntime.value Avançado Introduzida na versão: 1.0.0

Valor padrão: apigee-runtime

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-redis, apigee-telemetry, apigee-virtualhost

apigee-runtime é o nó do ambiente de execução do projeto; Valor do rótulo do seletor de nós para segmentação de nós do Kubernetes para serviços do ambiente de execução da Apigee.

Consulte Configurar pools de nós dedicados.

nodeSelector.requiredForScheduling Avançado Introduzida na versão: 1.0.0

Valor padrão: verdadeiro

Gráfico:apigee-datastore, apigee-env, apigee-ingress-manager, apigee-operator, apigee-org, apigee-redis, apigee-telemetry, apigee-virtualhost

A propriedade requiredForScheduling assume como padrão true. Em caso de true, isso significa que, se o Kubernetes não conseguir encontrar nós com a chave/valor de rótulo configurados, os pods subjacentes não serão programados nos nós de trabalho da VM.

Para a produção, nodeSelector.requiredForScheduling precisa ser definido como verdadeiro.

Consulte Configurar pools de nós dedicados.

redis

A tabela a seguir descreve as propriedades do objeto redis:

Propriedade Tipo Descrição
redis.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-redis

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

redis.auth.password Básico Introduzida na versão: 1.6.0

Valor padrão: iloveapis123

Gráfico:apigee-redis

Obrigatório

Senha do administrador do Redis. O usuário administrador é usado para qualquer atividade administrativa realizada no cluster do Redis.

redis.auth.secret Básico Introduzida na versão: 1.9.1

Valor padrão: Nenhum

Gráfico:apigee-redis

O nome do arquivo armazenado em um secret do Kubernetes que contém a senha do administrador do Redis. O arquivo secret precisa conter a chave:

data:
    redis.auth.password: encoded_value

Consulte também:

redis.envoy.image.pullPolicy Avançado Introduzida na versão: 1.6.0

Valor padrão: IfNotPresent

Gráfico:apigee-redis

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

redis.envoy.image.tag Avançado Introduzida na versão: 1.6.0

Valor padrão: 1.16.0

Gráfico:apigee-redis

O rótulo da versão da imagem do Docker desse serviço.

redis.envoy.image.url Avançado Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Gráfico:apigee-redis

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

redis.image.pullPolicy Avançado Introduzida na versão: 1.6.0

Valor padrão: IfNotPresent

Gráfico:apigee-redis

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

redis.image.tag Avançado Introduzida na versão: 1.6.0

Valor padrão: 1.16.0

Gráfico:apigee-redis

O rótulo da versão da imagem do Docker desse serviço.

redis.image.url Avançado Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Gráfico:apigee-redis

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

redis.replicaCount Básico Introduzida na versão: 1.6.0

Valor padrão: 2

Gráfico:apigee-redis

O Redis é um armazenamento replicado. Essa propriedade especifica o número de nós do Redis empregado como um StatefulSet.

redis.resources.requests.cpu Avançado Introduzida na versão: 1.6.0

Valor padrão: 500m

Gráfico:apigee-redis

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

redis.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-redis

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

redis.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-redis

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

redis.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-redis

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

redis.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-redis

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

redis.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-redis

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

runtime

A tabela a seguir descreve as propriedades do objeto runtime:

Propriedade Tipo Descrição
runtime.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-env

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

runtime.annotations Avançado Introduzida na versão: 1.5.0

Valor padrão: Nenhum

Gráfico:apigee-env

Mapa opcional de chave-valor usado para anotar pods. Para mais informações, consulte Anotações personalizadas.

runtime.envVars Básico Introduzida na versão:1.13.1

Valor padrão: Nenhum

Gráfico:apigee-env

Permite fornecer variáveis de ambiente adicionais ao componente de tempo de execução em um par de chave-valor:

runtime:
  envVars:
    KEY_1: VALUE_N
    ... ...
    KEY_N: VALUE_N

por exemplo:

runtime:
  envVars:
    RUNTIME_ENV_VAR1: "value of runtime env-var 1"
    RUNTIME_ENV_VAR2: "value of runtime env-var 2"
runtime.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-env

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

runtime.hpaBehavior.scaleDown.percent.periodSeconds Avançado Introduzida na versão: 1.7.0

Valor padrão:60

Gráfico:apigee-env

O período em que a política deve ser válida ao reduzir verticalmente uma porcentagem de instâncias de execução.

runtime.hpaBehavior.scaleDown.percent.value Avançado Introduzida na versão: 1.7.0

Valor padrão:20

Gráfico:apigee-env

A quantidade de mudança permitida pela política ao reduzir uma porcentagem de instâncias de execução.

runtime.hpaBehavior.scaleDown.pods.periodSeconds Avançado Introduzida na versão: 1.7.0

Valor padrão:60

Gráfico:apigee-env

O período em que a política deve ser válida ao reduzir o número de instâncias de ambiente de execução.

runtime.hpaBehavior.scaleDown.pods.value Avançado Introduzida na versão: 1.7.0

Valor padrão:20

Gráfico:apigee-env

A quantidade de mudança permitida pela política ao reduzir o número de instâncias de execução.

runtime.hpaBehavior.scaleDown.selectPolicy Avançado Introduzida na versão: 1.7.0

Valor padrão:Min

Gráfico:apigee-env

A decisão que o autoescalador toma entre várias políticas de escalonamento automático. Definir o valor como Min permite a menor mudança no escalonamento vertical de instâncias de execução. Definir o valor como Max permite a maior mudança no escalonamento de instâncias de execução.

runtime.hpaBehavior.scaleDown.stabilizationWindowSeconds Avançado Introduzida na versão: 1.7.0

Valor padrão:120

Gráfico:apigee-env

O número de segundos em que as recomendações anteriores devem ser consideradas durante o escalonamento vertical para baixo.

runtime.hpaBehavior.scaleUp.percent.periodSeconds Avançado Introduzida na versão: 1.7.0

Valor padrão:60

Gráfico:apigee-env

O período em que a política deve ser válida ao aumentar uma porcentagem de instâncias de execução.

runtime.hpaBehavior.scaleUp.percent.value Avançado Introduzida na versão: 1.7.0

Valor padrão:20

Gráfico:apigee-env

O período em que a política deve ser válida ao aumentar uma porcentagem de instâncias de execução.

runtime.hpaBehavior.scaleUp.pods.periodSeconds Avançado Introduzida na versão: 1.7.0

Valor padrão:60

Gráfico:apigee-env

O período em que a política deve ser válida ao aumentar o número de instâncias de ambiente de execução.

runtime.hpaBehavior.scaleUp.pods.value Avançado Introduzida na versão: 1.7.0

Valor padrão: 4

Gráfico:apigee-env

A quantidade de mudança permitida pela política ao aumentar o número de instâncias de ambiente de execução.

runtime.hpaBehavior.scaleUp.selectPolicy Avançado Introduzida na versão: 1.7.0

Valor padrão:Max

Gráfico:apigee-env

A decisão que o autoescalador toma entre várias políticas de escalonamento automático. Definir o valor como Min permite a menor mudança no escalonamento vertical de instâncias de execução. Definir o valor como Máximo permite a maior mudança no escalonamento vertical de instâncias de execução.

runtime.hpaBehavior.scaleUp.stabilizationWindowSeconds Avançado Introduzida na versão: 1.7.0

Valor padrão:30

Gráfico:apigee-env

O número de segundos em que as recomendações anteriores devem ser consideradas ao aumentar as instâncias de ambiente de execução.

runtime.hpaMetrics.serverMainTaskWaitTime Avançado Introduzida na versão: 1.7.0

Valor padrão:400M

Gráfico:apigee-env

O tempo médio de espera desejado (em ms) da fila de processamento em instâncias de ambiente de execução para solicitações de proxy na camada http.

runtime.hpaMetrics.serverNioTaskWaitTime Avançado Introduzida na versão: 1.7.0

Valor padrão:400M

Gráfico:apigee-env

O tempo médio de espera desejado (em ms) da fila de processamento em instâncias de ambiente de execução para solicitações de proxy ao processar políticas.

runtime.hpaMetrics.targetCPUUtilizationPercentage Avançado Introduzida na versão: 1.7.0

Valor padrão:75

Gráfico:apigee-env

A porcentagem de utilização da CPU desejada em todas as instâncias de execução.

runtime.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-env

O rótulo da versão da imagem do Docker desse serviço.

runtime.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

runtime.livenessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 2

Gráfico:apigee-env

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de ativação antes de reiniciar o contêiner. O valor mínimo é 1.

runtime.livenessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 60

Gráfico:apigee-env

O número de segundos após o início de um contêiner antes que uma sondagem de ativação seja iniciada.

runtime.livenessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-env

Determina a frequência com que uma sondagem de atividade será feita, em segundos. O valor mínimo é 1.

runtime.livenessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-env

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

runtime.nodeSelector.key Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

Chave de rótulo do seletor de nós opcional para segmentar nós do Kubernetes para serviços runtime.

Consulte propriedade nodeSelector.

runtime.nodeSelector.value Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

Valor do rótulo do seletor de nós para segmentar nós do Kubernetes para serviços runtime.

Consulte Como configurar pools de nós dedicados.

runtime.readinessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 2

Gráfico:apigee-env

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de preparo antes de marcar o pod como não pronto. O valor mínimo é 1.

runtime.readinessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 60

Gráfico:apigee-env

O número de segundos após o início de um contêiner antes de uma sondagem de preparo.

runtime.readinessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-env

Determina a frequência com uma sondagem de preparo será feita, em segundos. O valor mínimo é 1.

runtime.readinessProbe.successThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-env

O número mínimo de sucessos consecutivos necessários para que uma sondagem de preparo seja considerada bem-sucedida após uma falha. O valor mínimo é 1.

runtime.readinessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-env

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

runtime.replicaCountMax Básico Introduzida na versão: 1.0.0

Valor padrão: 4

Gráfico:apigee-env

Número máximo de réplicas disponíveis para escalonamento automático.

Se você estiver usando os limites de proxy aprimorados por ambiente, isso será aplicado a todos os conjuntos de réplicas do ambiente. Cada conjunto de réplicas ainda vai passar por escalonamento automático de forma independente.

runtime.replicaCountMin Básico Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-env

Número mínimo de réplicas disponíveis para escalonamento automático.

Se você estiver usando os limites de proxy aprimorados por ambiente, isso será aplicado a todos os conjuntos de réplicas do ambiente. Cada conjunto de réplicas ainda vai passar por escalonamento automático de forma independente.

runtime.resources.limits.cpu Avançado Introduzido na versão: 1.11.0

Valor padrão: 4000m

Gráfico:apigee-env

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

runtime.resources.limits.memory Avançado Introduzido na versão: 1.11.0

Valor padrão: 6Gi

Gráfico:apigee-env

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes (Mi) ou gibibytes (Gi).

runtime.resources.requests.cpu Avançado Introduzida na versão: 1.0.0

Valor padrão: 500m

Gráfico:apigee-env

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

runtime.resources.requests.memory Avançado Introduzida na versão: 1.0.0

Valor padrão: 512Mi (confira a observação abaixo)

Gráfico:apigee-env

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em mebibytes (Mi) ou Gibibytes (Gi).

runtime.service.type Avançado Introduzida na versão: 1.0.0

Valor padrão: ClusterIP

Gráfico:apigee-env

O tipo de serviço. Você pode definir isso como um serviço diferente de ClusterIP. Por exemplo, LoadBalancer.

runtime.targetCPUUtilizationPercentage Avançado Introduzida na versão: 1.0.0

Valor padrão: 75

Gráfico:apigee-env

Meta de uso da CPU para o processo do ambiente de execução no pod. O valor desse campo permite que o ambiente de execução seja escalonado automaticamente quando a utilização da CPU atingir esse valor, até replicaCountMax.

runtime.terminationGracePeriodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 3600

Gráfico:apigee-env

O tempo máximo entre uma solicitação de exclusão de pod e quando o pod é eliminado, em segundos. Durante esse período, todos os hooks de prestop serão executados, e qualquer processo em execução será encerrado sem problemas. O pod será encerrado quando todos os processos em execução forem concluídos ou ao final do período de carência, o que ocorrer primeiro. Se não houver processos em execução, o pod será encerrado imediatamente.

runtime.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-env

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

runtime.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-env

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

runtime.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-env

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

runtime.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-env

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

runtime.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-env

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

securityContext

Define configurações de segurança para pods que podem ser aplicadas no nível global, de ambiente ou de componente.

Propriedade Tipo Descrição
securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-operator

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

synchronizer

Garanta que os processadores de mensagens sejam mantidos atualizados com os pacotes de proxy de API implantados mais recentes. Para fazer isso, o Synchronizer pesquisa o plano de gerenciamento. Quando um novo contrato é detectado, o Synchronizer o envia para o plano de ambiente de execução. Por padrão, o Sync sincroniza dados de configuração do ambiente no Cassandra.

Para saber mais, consulte Configurar o sincronizador.

A tabela a seguir descreve as propriedades do objeto synchronizer:

Propriedade Tipo Descrição
synchronizer.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-env

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

synchronizer.annotations Avançado Introduzida na versão: 1.5.0

Valor padrão: Nenhum

Gráfico:apigee-env

Mapa opcional de chave-valor usado para anotar pods. Para mais informações, consulte Anotações personalizadas.

synchronizer.image.pullPolicy Avançado Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

Gráfico:apigee-env

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

synchronizer.image.tag Avançado Introduzida na versão: 1.0.0

Valor padrão: 1.16.0

Gráfico:apigee-env

O rótulo da versão da imagem do Docker desse serviço.

synchronizer.image.url Avançado Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

synchronizer.livenessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 2

Gráfico:apigee-env

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de ativação antes de reiniciar o contêiner. O valor mínimo é 1.

synchronizer.livenessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 0

Gráfico:apigee-env

O número de segundos após o início de um contêiner antes que uma sondagem de ativação seja iniciada.

synchronizer.livenessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-env

Determina a frequência com que uma sondagem de atividade será feita, em segundos. O valor mínimo é 1.

synchronizer.livenessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-env

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

synchronizer.nodeSelector.key Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

Obrigatório

Chave de rótulo do seletor de nó opcional para segmentar nós do Kubernetes para serviços do ambiente de execução synchronizer.

Consulte nodeSelector.

synchronizer.nodeSelector.value Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

Valor do rótulo do seletor de nós opcional usado para segmentação de nós do Kubernetes para synchronizer serviços do ambiente de execução.

Consulte nodeSelector.

synchronizer.pollInterval Avançado Introduzida na versão: 1.0.0

Valor padrão: 60

Gráfico:apigee-env

O tempo que o Synchronizer aguarda entre as operações de pesquisa. O Synchronizer pesquisa os serviços do plano de controle do Apigee para detectar e receber novos contratos de ambiente de execução.

synchronizer.readinessProbe.failureThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 2

Gráfico:apigee-env

O número de vezes que o Kubernetes verificará se houve falha nas sondagens de preparo antes de marcar o pod como não pronto. O valor mínimo é 1.

synchronizer.readinessProbe.initialDelaySeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 0

Gráfico:apigee-env

O número de segundos após o início de um contêiner antes de uma sondagem de preparo.

synchronizer.readinessProbe.periodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 5

Gráfico:apigee-env

Determina a frequência com uma sondagem de preparo será feita, em segundos. O valor mínimo é 1.

synchronizer.readinessProbe.successThreshold Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-env

O número mínimo de sucessos consecutivos necessários para que uma sondagem de preparo seja considerada bem-sucedida após uma falha. O valor mínimo é 1.

synchronizer.readinessProbe.timeoutSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 1

Gráfico:apigee-env

O número de segundos após os quais uma sondagem de ativação expira. O valor mínimo é 1.

synchronizer.replicaCount Básico Introduzida na versão: 1.0.0

Gráfico:apigee-env

Deprecated: a partir da Apigee híbrida 1.2, gerencie a contagem de réplicas do sincronizador com: synchronizer.replicaCountMax e synchronizer.replicaCountMin

synchronizer.replicaCountMax Básico Introduzida na versão: 1.2.0

Valor padrão: 4

Gráfico:apigee-env

Número máximo de réplicas para escalonamento automático.

synchronizer.replicaCountMin Básico Introduzida na versão: 1.2.0

Valor padrão: 1

Gráfico:apigee-env

Número mínimo de réplicas para escalonamento automático.

synchronizer.resources.limits.cpu Avançado Introduzido na versão: 1.11.0

Valor padrão: 2000m

Gráfico:apigee-env

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

synchronizer.resources.limits.memory Avançado Introduzido na versão: 1.11.0

Valor padrão: 5Gi

Gráfico:apigee-env

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes.

synchronizer.resources.requests.cpu Avançado Introduzida na versão: 1.0.0

Valor padrão: 100m

Gráfico:apigee-env

A CPU necessária para a operação normal do recurso em um contêiner do Kubernetes, em milissegundos.

synchronizer.resources.requests.memory Avançado Introduzida na versão: 1.0.0

Valor padrão: 1Gi

Gráfico:apigee-env

A memória necessária para a operação normal do recurso em um contêiner do Kubernetes, em gigabytes.

synchronizer.serviceAccountPath Básico Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Gráfico:apigee-env

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Caminho para o arquivo de chave da conta de serviço do Google com o papel Apigee Synchron Manager.

synchronizer.serviceAccountRef Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-env

É necessário incluir um destes campos: serviceAccountPath ou serviceAccountRef.

Uma referência de secret do Kubernetes a um arquivo de chave da conta de serviço do Google. Consulte Como armazenar chaves de conta de serviço em secrets do Kubernetes.

synchronizer.serviceAccountSecret Básico Introduzida na versão:1.1.0

Valor padrão: Nenhum

Gráfico:apigee-env

O nome de um secret do Kubernetes. Crie o secret usando uma chave de conta de serviço do Google com o papel Apigee Synchronizer Manager como entrada.

synchronizer.targetCPUUtilizationPercentage Avançado Introduzida na versão: 1.0.0

Valor padrão: 75

Gráfico:apigee-env

Meta de uso da CPU para o processo do Synchronizer no pod. O valor desse campo permite que o Synchronizer faça o escalonamento automático quando a utilização da CPU atingir esse valor, até replicaCountMax.

synchronizer.terminationGracePeriodSeconds Avançado Introduzida na versão: 1.0.0

Valor padrão: 30

Gráfico:apigee-env

O tempo máximo entre uma solicitação de exclusão de pod e quando o pod é eliminado, em segundos. Durante esse período, todos os hooks de prestop serão executados, e qualquer processo em execução será encerrado sem problemas. O pod será encerrado quando todos os processos em execução forem concluídos ou ao final do período de carência, o que ocorrer primeiro. Se não houver processos em execução, o pod será encerrado imediatamente.

synchronizer.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-env

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

synchronizer.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-env

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

synchronizer.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-env

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

synchronizer.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-env

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

synchronizer.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-env

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.

virtualhosts

A propriedade virtualhosts é uma propriedade de configuração obrigatória. Os hosts virtuais permitem que a Apigee híbrida processe solicitações de API para um grupo de ambiente especificado.

Para mais informações, consulte Configurar hosts virtuais.

A tabela a seguir descreve as propriedades do objeto virtualhosts:

Propriedade Tipo Descrição
virtualhosts[].additionalGateways Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-virtualhost

Uma lista de gateways do Istio para rotear o tráfego.

virtualhosts[].cipherSuites[] Avançado Introduzida na versão: 1.9.2

Valor padrão: Nenhum

Gráfico:apigee-virtualhost

Essa propriedade configura as criptografias TLS usadas no gateway de entrada.

Os valores de virtualhosts.cipherSuites precisam estar no formato OpenSSL.

Confira abaixo uma lista das criptografias compatíveis no formato OpenSSL. Veja mais informações sobre as criptografias compatíveis na documentação do Boring FIPS build of Envoy (em inglês). Um valor em branco é padronizado para os pacotes de criptografia compatíveis com o build Boring do FIPS do Envoy.

TLS v1.3:

Ativado por padrão Outros conjuntos de algoritmos de criptografia
  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
Não é possível substituir os pacotes de criptografia do TLS 1.3.

TLS v1.2:

Ativado por padrão Outros conjuntos de algoritmos de criptografia
  • ECDHE-ECDSA-AES128-GCM-SHA256
  • ECDHE-RSA-AES128-GCM-SHA256
  • ECDHE-ECDSA-AES256-GCM-SHA384
  • ECDHE-RSA-AES256-GCM-SHA384
  • AES128-GCM-SHA256
  • AES128-SHA
  • AES256-GCM-SHA384
  • AES256-SHA
  • ECDHE-ECDSA-AES128-GCM-SHA256
  • ECDHE-ECDSA-AES128-SHA
  • ECDHE-ECDSA-AES256-GCM-SHA384
  • ECDHE-ECDSA-AES256-SHA
  • ECDHE-ECDSA-CHACHA20-POLY1305
  • ECDHE-RSA-AES128-GCM-SHA256
  • ECDHE-RSA-AES128-SHA
  • ECDHE-RSA-AES256-GCM-SHA384
  • ECDHE-RSA-AES256-SHA
  • ECDHE-RSA-CHACHA20-POLY1305

TLS v1.1:

Ativado por padrão Outros conjuntos de algoritmos de criptografia
O TLS v1.1 não está ativado por padrão.
  • ECDHE-ECDSA-AES128-GCM-SHA256
  • ECDHE-RSA-AES128-GCM-SHA256
  • ECDHE-ECDSA-AES256-GCM-SHA384
  • ECDHE-RSA-AES256-GCM-SHA384
  • ECDHE-ECDSA-CHACHA20-POLY1305
  • ECDHE-RSA-CHACHA20-POLY1305
  • ECDHE-ECDSA-AES128-SHA
  • ECDHE-ECDSA-AES256-SHA
  • ECDHE-RSA-AES256-SHA

Para ativar mais pacotes de criptografia, adicione-os à propriedade virtualhosts.cipherSuites com a versão do TLS em que você quer ativá-los na propriedade virtualhosts.minTLSProtocolVersion. Por exemplo, para ativar todos os pacotes de criptografia TLS v.1.2 aceitos, adicione o seguinte à sua configuração virtualhosts:

virtualhosts:
- name: ENV_GROUP_NAME
  minTLSProtocolVersion: "1.2"
  cipherSuites:
  - "AES128-GCM-SHA256"
  - "AES128-SHA"
  - "AES256-GCM-SHA384"
  - "AES256-SHA"
  - "ECDHE-ECDSA-AES128-GCM-SHA256"
  - "ECDHE-ECDSA-AES128-SHA"
  - "ECDHE-ECDSA-AES256-GCM-SHA384"
  - "ECDHE-ECDSA-AES256-SHA"
  - "ECDHE-ECDSA-CHACHA20-POLY1305"
  - "ECDHE-RSA-AES128-GCM-SHA256"
  - "ECDHE-RSA-AES128-SHA"
  - "ECDHE-RSA-AES256-GCM-SHA384"
  - "ECDHE-RSA-AES256-SHA"
  - "ECDHE-RSA-CHACHA20-POLY1305"
...

Se você quiser ativar versões mais antigas do TLS na implantação do gateway de entrada da Apigee, use as propriedades virtualhosts.minTLSProtocolVersion e virtualhosts.cipherSuites.

Por exemplo, para ativar a TLS v.1.1:

virtualhosts:
- name: ENV_GROUP_NAME
  minTLSProtocolVersion: "1.1"
  cipherSuites:
  - "ECDHE-ECDSA-AES128-GCM-SHA256"
  - "ECDHE-RSA-AES128-GCM-SHA256"
  - "ECDHE-ECDSA-AES256-GCM-SHA384"
  - "ECDHE-RSA-AES256-GCM-SHA384"
  - "ECDHE-ECDSA-CHACHA20-POLY1305"
  - "ECDHE-RSA-CHACHA20-POLY1305"
  - "ECDHE-ECDSA-AES128-SHA"
  - "ECDHE-RSA-AES128-SHA"
  - "ECDHE-ECDSA-AES256-SHA"
  - "ECDHE-RSA-AES256-SHA"
...
virtualhosts[].name Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-virtualhost

Obrigatório

O nome do host virtual.

virtualhosts[].maxTLSProtocolVersion Básico Introduzida na versão: 1.3.0

Valor padrão: Nenhum

Gráfico:apigee-virtualhost

A versão máxima do protocolo TLS que o Envoy pode selecionar. O Envoy usa automaticamente a versão ideal do protocolo TLS entre virtualhosts[].minTLSProtocolVersion e virtualhosts[].maxTLSProtocolVersion.

O valor precisa ser uma string que representa o número da versão do TLS. Exemplo:

virtualhosts:
- name: default
  maxTLSProtocolVersion: "1.3"

Onde a string representa o número da versão TLS no formato "#.#". No exemplo acima, "1.3" representa a versão TLS do Istio TLSV1_3.

Consulte também ServerTLSSettings na documentação do Istio.

virtualhosts[].minTLSProtocolVersion Básico Introduzida na versão: 1.3.0

Valor padrão: Nenhum

Gráfico:apigee-virtualhost

A versão mínima do protocolo TLS que o Envoy pode selecionar. O Envoy usa automaticamente a versão ideal do protocolo TLS entre virtualhosts[].minTLSProtocolVersion e virtualhosts[].maxTLSProtocolVersion.

O valor precisa ser uma string que representa o número da versão TLS. Exemplo:

virtualhosts:
- name: default
  minTLSProtocolVersion: "1.2"

Onde a string representa o número da versão TLS no formato "#.#". No exemplo acima, "1.2" representa a versão TLS do Istio TLSV1_2.

Consulte também ServerTLSSettings na documentação do Istio.

virtualhosts[].selector Básico Introduzida na versão: 1.2.0

Valor padrão: app: apigee-ingressgateway

Gráfico:apigee-virtualhost

Obrigatório

Um par de valor-chave seletora de valor-chave para apontar para diferentes seletores de entrada.

  • apigee-ingressgateway: para instalações híbridas da Apigee usando o gateway de entrada da Apigee.
  • istio-ingressgateway: para instalações híbridas da Apigee que usam o Cloud Service Mesh (versões híbridas 1.8 e anteriores da Apigee).

Se nenhum rótulo do seletor for fornecido, a configuração será fornecida para o gateway de entrada da Apigee.

virtualhosts[].sslCertPath Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-virtualhost

É necessário sslCertPath/sslKeyPath ou sslSecret.

O caminho no seu sistema para um arquivo de certificado TLS.

virtualhosts[].sslKeyPath Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-virtualhost

É necessário sslCertPath/sslKeyPath ou sslSecret.

O caminho no seu sistema para o arquivo de chave privada TLS.

virtualhosts[].sslSecret Básico Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Gráfico:apigee-virtualhost

É necessário sslCertPath/sslKeyPath ou sslSecret.

O nome se o arquivo armazenado em um secret do Kubernetes que contém os usuários e as senhas do Cassandra. É possível criar a chave secreta usando as seguintes instruções: Criar a chave secreta.

Consulte também:

watcher

A propriedade watcher é uma propriedade de configuração obrigatória. O inspetor é um processo que monitora alterações de configuração e aciona o aplicativo no plano do ambiente de execução.

A tabela a seguir descreve as propriedades do objeto watcher:

Propriedade Tipo Descrição
watcher.securityContext.seccompProfile.type Avançado

Introduzida na versão:1.16.0

Valor padrão: Nenhum

Gráfico:apigee-org

Especifica o tipo de perfil Seccomp a ser aplicado ao contexto de segurança do pod. Os valores permitidos são RuntimeDefault (para usar o perfil padrão do ambiente de execução do contêiner) ou Unconfined (para não aplicar restrições do Seccomp). Se não for especificado, nenhum perfil será aplicado pela Apigee.

Consulte Configurar perfis Seccomp para segurança de pods.

watcher.annotations Avançado Introduzida na versão: 1.5.0

Valor padrão: Nenhum

Gráfico:apigee-org

Mapa opcional de chave-valor usado para anotar pods. Para mais informações, consulte Anotações personalizadas.

watcher.args.enableIssueScanning Avançado Introduzida na versão: 1.10.0

Valor padrão: true

Gráfico:apigee-org

Ativa ou desativa a exibição automática de problemas. Quando true, o inspetor verifica automaticamente o plano de controle e o estado do servidor da API Kubernetes para determinar se há algum problema de configuração.

Defina como false para desativar a exibição automática de problemas. Para mais informações, consulte Solução de problemas automatizada.

watcher.args.enableLeaderElect Avançado Introduzida na versão: 1.13.0

Valor padrão: true

Gráfico:apigee-org

Quando true (o padrão) watcher.args.enableLeaderElect seleciona um único pod de observador para gerenciar e informar as informações de roteamento. Limitar isso a um único pod é necessário para evitar inatividade durante upgrades ou rollbacks. Durante esses eventos, várias versões do observador podem ser executadas simultaneamente. Cada instância do Watcher pode ter uma lógica de criação de rotas diferente, o que pode causar tempo de inatividade.watcher.replicaCountMax.

watcher.args.issueScanInterval Avançado Introduzida na versão: 1.10.0

Valor padrão: 60

Gráfico:apigee-org

O intervalo em segundos da frequência com que o inspetor analisa o plano do ambiente de execução para identificar problemas automatizados. Para mais informações, consulte Solução de problemas automatizada.

watcher.gsa Avançado Introduzida na versão: 1.10.0

Valor padrão: Nenhum

Gráfico:apigee-org

Somente Helm: o endereço de e-mail da conta de serviço do IAM do Google (GSA) apigee-watcher a ser associada à conta de serviço correspondente do Kubernetes ao ativar a Identidade da carga de trabalho nos clusters do GKE usando gráficos do Helm. Faça essa configuração quando for preciso definir gcp.workloadIdentity.enabled como true.

Os endereços de e-mail da GSA costumam ter o seguinte formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Exemplo:

apigee-watcher@my-hybrid-project.iam.gserviceaccount.com

Consulte Como ativar a Identidade da carga de trabalho no GKE ou Como ativar a federação de identidade da carga de trabalho no AKS e EKS.

watcher.image.pullPolicy Avançado Introduzida na versão: 1.4.0

Valor padrão: IfNotPresent

Gráfico:apigee-org

Determina quando o kubelet extrai a imagem do Docker do pod. Os valores possíveis incluem:

  • IfNotPresent: não extraia uma nova imagem se ela já existir.
  • Always: sempre extraia a imagem, independentemente de ela existir.

Para mais informações, consulte Como atualizar imagens.

watcher.image.tag Avançado Introduzida na versão: 1.4.0

Valor padrão: 1.16.0

Gráfico:apigee-org

O rótulo da versão da imagem do Docker desse serviço.

watcher.image.url Avançado Introduzida na versão: 1.4.0

Valor padrão: Nenhum

Gráfico:apigee-org

O local da imagem do Docker desse serviço.

Use apigee-pull-push --list para conferir o URL do repositório atual desse componente.

watcher.replicaCountMax Básico Introduzida na versão: 1.3.0

Valor padrão: 1

Gráfico:apigee-org

O número máximo de réplicas do inspetor. Deve ser mantido em 1 para evitar conflitos.

A Apigee híbrida usa um pod de observador por instalação. A seleção de líderes escolhe automaticamente um pod de observador. Outras réplicas de pod de observador serão forçadas a um estado instável. Consulte watcher.args.enableLeaderElect.

watcher.replicaCountMin Básico Introduzida na versão: 1.3.0

Valor padrão: 1

Gráfico:apigee-org

O número mínimo de réplicas do inspetor.

watcher.resources.limits.cpu Avançado Introduzido na versão: 1.11.0

Valor padrão: 1000m

Gráfico:apigee-org

O limite de CPU do recurso em um contêiner do Kubernetes, em milésimos.

watcher.resources.limits.memory Avançado Introduzido na versão: 1.11.0

Valor padrão: 2Gi

Gráfico:apigee-org

O limite de memória do recurso em um contêiner do Kubernetes, em mebibytes.

watcher.serviceAccountPath Básico Introduzida na versão: 1.3.0

Valor padrão: Nenhum

Gráfico:apigee-org

Obrigatório.

Caminho para o arquivo de chave da conta de serviço do Google com o papel de agente de ambiente de execução da Apigee.

watcher.serviceAccountRef Avançado Introduzida na versão: 1.3.0

Valor padrão: Nenhum

Gráfico:apigee-org

É necessário escolher serviceAccountPath ou serviceAccountSecretRef.

Uma referência de secret do Kubernetes a um arquivo de chave da conta de serviço do Google. Consulte Como armazenar chaves de conta de serviço em secrets do Kubernetes.

watcher.tolerations.effect Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

effect especifica o efeito que a correspondência de uma tolerância com um taint terá. Os valores para effect podem ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Consulte taints e tolerâncias: conceitos para mais detalhes.

watcher.tolerations.key Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

key identifica os pods em que a tolerância pode ser aplicada.

Consulte taints e tolerâncias: conceitos para mais detalhes.

watcher.tolerations.operator Avançado Introduzida na versão: 1.10.1

Valor padrão: "Equal"

Gráfico:apigee-org

Necessário para usar o recurso taints e tolerâncias do Kubernetes.

operator especifica a operação usada para acionar o effect. Os valores para operator podem ser:

  • Equal corresponde ao valor definido em value.
  • Exists ignora o valor definido em value.

Consulte taints e tolerâncias: conceitos para mais detalhes.

watcher.tolerations.tolerationSeconds Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

tolerationSeconds define, em segundos, por quanto tempo um pod permanece vinculado a um nó com falha ou sem resposta.

Consulte taints e tolerâncias: conceitos para mais detalhes.

watcher.tolerations.value Avançado Introduzida na versão: 1.10.1

Valor padrão: Nenhum

Gráfico:apigee-org

Usado pelo recurso taints e tolerâncias do Kubernetes.

value é o valor que aciona o effect quando operator está definido como Equal.

Consulte taints e tolerâncias: conceitos para mais detalhes.