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.

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 Descrição
axHashSalt

Introduzida na versão: 1.3.0

Valor padrão: o nome da sua organização

Opcional

O nome de um secret do Kubernetes que contém um valor de salt de hash usado para criptografar dados ofuscados dos usuários enviados à análise da Apigee. Se você não especificar um valor de salt, o nome da sua organização será usado por padrão. Crie o secret com o valor de salt como entrada. É possível usar o mesmo salt em vários clusters para garantir resultados de hash consistentes entre os clusters.

contractProvider Introduzida na versão: 1.0.0

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

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

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

Introduzida na versão: 1.0.0

Valor padrão: nenhum

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 Deprecated: Para a v1.2.0 ou posterior, use gcp.region.

Introduzida na versão: 1.0.0

Valor padrão: us-central1

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.

imagePullSecrets.name Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Nome do secret do Kubernetes configurado como tipo de registro do docker; usado para extrair imagens do repo privado.

instanceID Introduzida na versão: 1.3.0

Valor padrão: Nenhum

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.

k8sClusterName Deprecated: Para v1.2.0 e posterior, use k8sCluster.name e k8sCluster.region.

Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Nome do cluster do Kubernetes (K8S) em que seu projeto híbrido está sendo executado. Funciona com gcpProjectID (obsoleto) e gcpRegion (obsoleto) para identificar o projeto e determinar para onde apigee-logger e apigee-metrics enviam dados.

kmsEncryptionKey Introduzida na versão: 1.0.0

Valor padrão: defaults.org.kmsEncryptionKey

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: defaults.org.kmsEncryptionKey

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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.

namespace Introduzida na versão: 1.0.0

Valor padrão: apigee

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

org

Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: v120

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.

validateServiceAccounts Introduzida na versão: 1.0.0

Valor padrão: true

Permite a validação rigorosa das permissões da conta de serviço. Isso usa o método da API Cloud Resource Manager testIamPermissions para verificar se a conta de serviço fornecida tem as permissões necessárias. No caso de contas de serviço de uma organização da Apigee, a verificação do ID do projeto é aquela mapeada para a organização. Para Métricas e Logger, o projeto verificado é baseado na configuração gcpProjectID overrides.yaml.

Consulte também gcpProjectID

ao

Os operadores do Apigee (AO, na sigla em inglês) criam e atualizam recursos do Kubernetes e do Istio de baixo nível necessários para implantar e manter a configuração do ApigeeDeployment (AD). Por exemplo, o controlador executa o lançamento dos processadores de mensagens. Também valida a configuração do ApigeeDeployment antes de persistir no cluster do Kubernetes.

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

Propriedade Descrição
ao.image.pullPolicy Introduzida na versão: 1.2.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.2.0

Valor padrão: 1.3.6

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

ao.image.url Introduzida na versão: 1.2.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-operators

O local da imagem do Docker desse serviço.

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

Valor padrão: 250m

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

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

Valor padrão: 256Mi

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

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

Valor padrão: 250m

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

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

Valor padrão: 256Mi

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

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 Descrição
cassandra.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

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

Valor padrão: iloveapis123

Obrigatório

Senha para o administrador do Cassandra. O usuário administrador é usado para qualquer atividade administrativa realizada no cluster do Cassandra.

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

Valor padrão: iloveapis123

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 Introduzida na versão: 1.0.0

Valor padrão: iloveapis123

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 Introduzida na versão: 1.0.0

Valor padrão: iloveapis123

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 Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: 1.3.6

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

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

Valor padrão: gcr.io/apigee-release/hybrid/apigee-hybrid-cassandra-client

O local da imagem do Docker desse serviço.

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

Valor padrão: iloveapis123

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 Introduzida na versão: 1.4.0

Valor padrão: jmxuser

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 Introduzida na versão: 1.4.0

Valor padrão: iloveapis123

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 Introduzida na versão: 1.4.0

Valor padrão: apigee

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 Introduzida na versão: 1.3.3

Valor padrão: Nenhum

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:

cassandra.backup.cloudProvider Introduzida na versão: 1.0.0

Valor padrão: GCP

Obrigatório se o backup estiver ativado.

Provedor de nuvem para armazenamento de backup.

É possível definir o valor como GCP ou HYBRID. Defina o valor como GCP se quiser armazenar o backup no Google Cloud Storage e HYBRID se quiser armazenar o backup em um servidor remoto.

cassandra.backup.dbStorageBucket Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Obrigatório se o backup estiver ativado.

Bucket de armazenamento do Cloud para os dados de backup.

cassandra.backup.enabled Introduzida na versão: 1.0.0

Valor padrão: false

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.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: 1.3.6

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

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

Valor padrão: gcr.io/apigee-release/hybrid/apigee-cassandra-backup-utility

O local da imagem do Docker desse serviço.

cassandra.backup.schedule Introduzida na versão: 1.0.0

Valor padrão: 0 2 * * *

O agendamento do cron job.

Consulte Backup e recuperação do Cassandra.

cassandra.backup.serviceAccountPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Se o backup estiver ativado, é necessário backup.serviceAccountPath ou backup.serviceAccountRef.

Caminho para o arquivo de chave da conta de serviço do Google com o papel Storage Object Admin.

cassandra.backup.serviceAccountRef Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Se o backup estiver ativado, é necessário backup.serviceAccountPath ou backup.serviceAccountRef.

cassandra.clusterName Introduzida na versão: 1.0.0

Valor padrão: apigeecluster

Especifica o nome do cluster do Cassandra.

cassandra.datacenter Introduzida na versão: 1.0.0

Valor padrão: dc-1

Especifica o data center do nó do Cassandra.

cassandra.dnsPolicy Introduzida na versão: 1.1.1

Valor padrão: Nenhum

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

cassandra.externalSeedHost Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: 100M

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

cassandra.hostNetwork Introduzida na versão: 1.1.1

Valor padrão: false

Ativa o recurso hostNetwork do Kubernetes. A Apigee usa esse recurso em instalações multirregionais para se comunicar entre pods se o namespace da rede do pod não tiver conectividade entre clusters (os clusters estão em execução no "modo de rede ilha"), que é o caso padrão em instalações que não são do GKE, incluindo GKE On-Prem, GKE na AWS, Anthos em bare metal, AKS, EKS e 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 o GKE On-Prem, o GKE na AWS, o Anthos em bare metal, AKS e EKS e instalações do OpenShift. Consulte Implantação multirregional: pré-requisitos.

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

cassandra.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: 1.3.6

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

cassandra.image.url Introduzida na versão: 1.0.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-hybrid-cassandra

O local da imagem do Docker desse serviço.

cassandra.maxHeapSize Introduzida na versão: 1.0.0

Valor padrão: 512M

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

cassandra.multiRegionSeedHost Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: 9042

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

cassandra.rack Introduzida na versão: 1.0.0

Valor padrão: ra-1

Especifica o rack do nó do Cassandra.

cassandra.readinessProbe.failureThreshold Introduzida na versão: 1.0.0

Valor padrão: 2

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 Introduzida na versão: 1.0.0

Valor padrão: 0

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

cassandra.readinessProbe.periodSeconds Introduzida na versão: 1.0.0

Valor padrão: 10

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

cassandra.readinessProbe.successThreshold Introduzida na versão: 1.0.0

Valor padrão: 1

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 Introduzida na versão: 1.0.0

Valor padrão: 5

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

cassandra.replicaCount Introduzida na versão: 1.0.0

Valor padrão: 1

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 Introduzida na versão: 1.0.0

Valor padrão: 500m

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

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

Valor padrão: 1Gi

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

cassandra.restore.cloudProvider Introduzida na versão: 1.0.0

Valor padrão: GCP

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

Provedor de nuvem para armazenamento de backup.

cassandra.restore.dbStorageBucket Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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

Bucket do Cloud Storage para os dados de backup a serem restaurados.

cassandra.restore.enabled Introduzida na versão: 1.0.0

Valor padrão: false

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

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: 1.3.6

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

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

Valor padrão: gcr.io/apigee-release/hybrid/apigee-cassandra-backup-utility

O local da imagem do Docker desse serviço.

cassandra.restore.serviceAccountPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

Se a restauração for ativada, será necessário um das opções restore.serviceAccountPath ou restore.serviceAccountRef.

Caminho para o arquivo de chave da conta de serviço do Google com o papel Storage Object Admin.

cassandra.restore.serviceAccountRef Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Se a restauração for ativada, será necessário um das opções restore.serviceAccountPath ou restore.serviceAccountRef.

cassandra.restore.snapshotTimestamp Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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

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

cassandra.restore.user Introduzida na versão: 1.0.0

Valor padrão: conta de administrador

Nome de usuário do Cassandra usado para restauração de backup de esquema. Se não for especificado, o usuário administrador será usado.

cassandra.sslCertPath Introduzida na versão: 1.2.0

Valor padrão: Nenhum

O caminho no seu sistema para um arquivo de certificado TLS.

cassandra.sslKeyPath Introduzida na versão: 1.2.0

Valor padrão: Nenhum

O caminho no seu sistema para o arquivo de chave privada TLS.

cassandra.sslRootCAPath Introduzida na versão: 1.2.0

Valor padrão: Nenhum

A cadeia de certificados para a CA raiz (autoridade do certificado).

cassandra.storage.capacity Introduzida na versão: 1.0.0

Valor padrão: 50Gi

Obrigatório se storage.storageclass for especificado

Especifica o tamanho do disco necessário, em mebibytes.

cassandra.storage.storageclass Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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

cassandra.terminationGracePeriodSeconds Introduzida na versão: 1.0.0

Valor padrão: 300

O tempo 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.

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.

Confira o Apigee Connect.

A tabela a seguir descreve as propriedades do objeto connectAgent:

Propriedade Descrição
connectAgent.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

connectAgent.server Introduzida na versão: 1.2.0

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

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

connectAgent.logLevel Introduzida na versão: 1.2.0

Valor padrão: INFO

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 Introduzida na versão: 1.2.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.2.0

Valor padrão: 1.3.6

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

connectAgent.image.url Introduzida na versão: 1.2.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-connect-agent

O local da imagem do Docker desse serviço. Verifique o arquivo values.yaml do URL específico.

connectAgent.replicaCountMax Introduzida na versão: 1.2.0

Valor padrão: 5

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

connectAgent.replicaCountMin Introduzida na versão: 1.2.0

Valor padrão: 1

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

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

connectAgent.resources.requests.cpu Introduzida na versão: 1.0.0

Valor padrão: 100m

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

connectAgent.resources.requests.memory Introduzida na versão: 1.0.0

Valor padrão: 30Mi

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

connectAgent.targetCPUUtilizationPercentage Introduzida na versão: 1.2.0

Valor padrão: 75

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 Introduzida na versão: 1.2.0

Valor padrão: 600

O tempo 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.

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 Descrição
defaults.org.kmsEncryptionKey Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

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

defaults.org.kvmEncryptionKey Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

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

defaults.env.kmsEncryptionKey Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

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

defaults.env.kvmEncryptionKey Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

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

defaults.env.cacheEncryptionKey Introduzida na versão: 1.0.0

Valor padrão: aWxvdmVhcGlzMTIzNDU2Nw==

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

diagnostic

As configurações da ferramenta Coletor de diagnósticos.

Consulte Como usar o coletor de diagnósticos

A tabela a seguir descreve as propriedades do objeto diagnostic:

Propriedade Descrição
diagnostic.bucket Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório

O nome do bucket de armazenamento do Google Cloud em que os dados de diagnóstico serão depositados.

Consulte Como criar buckets de armazenamento.

diagnostic.container Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório

Isso especifica de qual tipo de pod você está capturando dados. Os valores podem ser um dos seguintes:

  • "apigee-cassandra" captura dados sobre o banco de dados do Cassandra. Os pods istio-cassandra são executados no namespace da Apigee.
  • "apigee-mart-server" captura dados sobre MART. Os pods apigee-mart-server são executados no namespace da Apigee.
  • O "apigee-runtime" captura dados sobre o processador de mensagens. Os pods do apigee-runtime são executados no namespace do Apigee.
  • "apigee-synchronizer" captura dados sobre o sincronizador. Os pods do sincronizador da Apigee são executados no namespace da Apigee.
  • "apigee-udca" captura dados sobre UDCA. Os pods apigee-udca são executados no namespace da apigee.
  • O "apigee-watcher" captura dados sobre o Watcher. Os pods apigee-watcher são executados no namespace da Apigee.
  • "istio-proxy" captura dados sobre o gateway de entrada do Istio. Os pods do istio-proxy são executados no namespace do sistema istio.
diagnostic.loggingDetails.logDuration Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório se a operação de coleta de diagnóstico for "LOGGING" (definida com operation: "LOGGING")

A duração em milissegundos dos dados de registro coletados. Um valor típico é 30000.

Consulte diagnostic.operation

diagnostic.loggingDetails.loggerNames[] Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório se a operação de coleta de diagnóstico for "LOGGING" (definida com operation: "LOGGING")

Especifica por nome os registradores que coletarão dados. Para a Apigee híbrida versão 1.6.0, o único valor compatível é ALL, o que significa todos os registradores. Exemplo:

diagnostic:
 loggingDetails:
   loggerNames:
   - ALL
diagnostic.loggingDetails.logLevel Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório se a operação de coleta de diagnóstico for "LOGGING" (definida com operation: "LOGGING")

Especifica a granularidade dos dados de geração de registros a serem coletados. No Apigee híbrido 1.6, somente FINE é compatível.

diagnostic.namespace Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório

O namespace do Kubernetes em que os pods de que você está coletando dados residem. O namespace precisa ser o correto para o contêiner que você especifica com diagnostic.container:

apigee para

  • apigee-runtime
  • apigee-synchronizer
  • apigee-udca
  • apigee-watcher
  • apigee-cassandra
  • apigee-mart-server

istio-system para

  • istio-proxy
diagnostic.operation Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório

Especifica se é necessário coletar todas as estatísticas ou apenas registros.

Os valores são:

diagnostic.podNames[] Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório

Os nomes dos pods do Kubernetes de que você está coletando dados. Exemplo:

diagnostic:
 podNames:
 - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
 - apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
diagnostic.serviceAccountPath Introduzida na versão: 1.6.0

Valor padrão: Nenhum

Obrigatório

O caminho para um arquivo de chave da conta de serviço (.json) para a conta de serviço com o papel de administrador do Storage (roles/storage.admin).

Veja estes tópicos:

diagnostic.tcpDumpDetails.maxMsgs Introduzida na versão: 1.6.0

Valor padrão: Nenhum

É obrigatório incluir diagnostic.tcpDumpDetails.maxMsgs ou diagnostic.tcpDumpDetails.timeoutInSeconds se você estiver usando diagnostic.tcpDumpDetails.

Define o número máximo de mensagens tcpDump a serem coletadas. A Apigee recomenda um valor máximo de até 1000.

diagnostic.tcpDumpDetails.timeoutInSeconds Introduzida na versão: 1.6.0

Valor padrão: Nenhum

É obrigatório incluir diagnostic.tcpDumpDetails.maxMsgs ou diagnostic.tcpDumpDetails.timeoutInSeconds se você estiver usando diagnostic.tcpDumpDetails.

Define o tempo de espera em segundos para que tcpDump retorne mensagens.

diagnostic.threadDumpDetails.delayInSeconds Introduzida na versão: 1.6.0

Valor padrão: Nenhum

É obrigatório usar diagnostic.threadDumpDetails.delayInSeconds e diagnostic.threadDumpDetails.iterations se você estiver usando diagnostic.threadDumpDetails.

O atraso em segundos entre a coleta de cada despejo de linhas de execução.

diagnostic.threadDumpDetails.iterations Introduzida na versão: 1.6.0

Valor padrão: Nenhum

É obrigatório usar diagnostic.threadDumpDetails.delayInSeconds e diagnostic.threadDumpDetails.iterations se você estiver usando diagnostic.threadDumpDetails.

O número de iterações de despejo de linhas de execução do jstack a serem coletadas.

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 Descrição
envs[].cacheEncryptionKey Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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

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

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

Valor padrão: Nenhum

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

É 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[].hostAliases[] Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Deprecated: a partir da versão híbrida 1.4, o plano do ambiente de execução recebe essas informações do plano de gerenciamento. Consulte Sobre ambientes e grupos de ambiente.

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

Valor padrão: Nenhum

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. 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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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

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

Valor padrão: Nenhum

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

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

Valor padrão: Nenhum

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

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

Valor padrão: Nenhum

Obrigatório

Nome do ambiente da Apigee a ser sincronizado.

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

Valor padrão: Nenhum

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

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

Valor padrão: Nenhum

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

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

Valor padrão: Nenhum

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 Introduzida na versão: 1.0

Valor padrão: Nenhum

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

envs[].serviceAccountPaths.udca Introduzida na versão: 1.0

Valor padrão: Nenhum

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

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

Valor padrão: Nenhum

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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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.

envs[].serviceAccountSecretRefs.udca Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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

envs[].sslCertPath Introduzida na versão: 1.2.0

Valor padrão: Nenhum

É necessário sslCertPath/sslKeyPath ou sslSecret.

O caminho no seu sistema para um arquivo de certificado TLS.

envs[].sslKeyPath Introduzida na versão: 1.2.0

Valor padrão: Nenhum

É necessário sslCertPath/sslKeyPath ou sslSecret.

O caminho no seu sistema para o arquivo de chave privada TLS.

envs[].sslSecret Introduzida na versão: 1.2.0

Valor padrão: Nenhum

É 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:

gcp

Identifica o ID do projeto do Google Cloud e a região para onde o apigee-logger e o apigee-metrics enviam dados.

A tabela a seguir descreve as propriedades do objeto gcp:

Propriedade Descrição
gcp.region Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Obrigatório

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

gcp.projectID Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Obrigatório

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

gcp.projectIDRuntime Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Identifica o projeto de cluster do ambiente de execução do Kubernetes.

A propriedade projectIDRuntime é opcional. Se não for usado, presumimos que o valor projectID é usado para o projeto do GCP da organização da Apigee e o projeto do cluster de K8S do ambiente de execução.

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 MART, Synchroner e UDCA passa pelo servidor proxy.

Consulte também: Logger, MART, Metrics, Synchronizer e UDCA.

A tabela a seguir descreve as propriedades do objeto httpProxy:

Propriedade Descrição
httpProxy.host Introduzida na versão: 1.1.1

Valor padrão: Nenhum

O nome do host do proxy HTTP.

httpProxy.port Introduzida na versão: 1.1.1

Valor padrão: Nenhum

A porta do proxy HTTP.

httpProxy.scheme Introduzida na versão: 1.1.1

Valor padrão: HTTPS

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

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 Descrição
k8sCluster.name Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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

k8sCluster.region Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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 Descrição
kubeRBACProxy.image.pullPolicy Introduzida na versão: 1.2.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.2.0

Valor padrão: v0.11.0

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

kubeRBACProxy.image.url Introduzida na versão: 1.2.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-kube-rbac-proxy

O local da imagem do Docker desse serviço.

Se você não quiser usar o Google Docker Hub, faça o download das imagens e use o endereço em que elas estão hospedadas internamente.

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 Descrição
logger.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

logger.enabled Introduzida na versão: 1.0.0

Valor padrão: false

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

logger.fluentd.buffer_chunk_limit Introduzida na versão: 1.0.0

Valor padrão: 512k

O tamanho máximo de um bloco de buffer permitido, em kilobytes. Os fragmentos que excederem o limite serão apagados para a fila de saída automaticamente.

logger.fluentd.buffer_queue_limit Introduzida na versão: 1.0.0

Valor padrão: 6

O tamanho máximo da fila de saída. O limite padrão é de 256 partes.

logger.fluentd.flush_interval Introduzida na versão: 1.0.0

Valor padrão: 5s

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

logger.fluentd.max_retry_wait Introduzida na versão: 1.0.0

Valor padrão: 30

O intervalo máximo entre novas tentativas de gravação, em segundos.

logger.fluentd.num_threads Introduzida na versão: 1.0.0

Valor padrão: 2

O número de linhas de execução usadas para liberar o buffer. O padrão é 1.

logger.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: 1.8.9

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

logger.image.url Introduzida na versão: 1.0.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-stackdriver-logging-agent

O local da imagem do Docker desse serviço.

logger.livenessProbe.failureThreshold Introduzida na versão: 1.0.0

Valor padrão: 3

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 Introduzida na versão: 1.0.0

Valor padrão: 0

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 Introduzida na versão: 1.0.0

Valor padrão: 60

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

logger.livenessProbe.successThreshold Introduzida na versão: 1.0.0

Valor padrão: 1

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 Introduzida na versão: 1.0.0

Valor padrão: 1

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

logger.nodeSelector.key Introduzida na versão: 1.0.0

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

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 Introduzida na versão: 1.0.0

Valor padrão: true

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.proxyURL Introduzida na versão: 1.0.0

Valor padrão: Nenhum

URL do servidor proxy do cliente.

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

Valor padrão: 500Mi

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

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

Valor padrão: 200m

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

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

Valor padrão: 100m

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

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

Valor padrão: 250Mi

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

logger.serviceAccountPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

É 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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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

logger.terminationGracePeriodSeconds Introduzida na versão: 1.0.0

Valor padrão: 30

O tempo 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.

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 Descrição
mart.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

mart.hostAlias Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: 1.3.6

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

mart.image.url Introduzida na versão: 1.0.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-mart-server

O local da imagem do Docker desse serviço. Verifique o arquivo values.yaml no URL específico. É possível modificar isso.

mart.initCheckCF.resources.requests.cpu Introduzida na versão: 1.0.0

Valor padrão: 10m

A quantidade de CPU alocada para a verificação de inicialização do processo do Cloud Foundry.

mart.livenessProbe.failureThreshold Introduzida na versão: 1.0.0

Valor padrão: 12

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 Introduzida na versão: 1.0.0

Valor padrão: 15

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 Introduzida na versão: 1.0.0

Valor padrão: 5

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

mart.livenessProbe.timeoutSeconds Introduzida na versão: 1.0.0

Valor padrão: 1

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

mart.metricsURL Introduzida na versão: 1.0.0

Valor padrão: /v1/server/metrics

mart.nodeSelector.key Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: 2

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 Introduzida na versão: 1.0.0

Valor padrão: 15

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

mart.readinessProbe.periodSeconds Introduzida na versão: 1.0.0

Valor padrão: 5

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

mart.readinessProbe.successThreshold Introduzida na versão: 1.0.0

Valor padrão: 1

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 Introduzida na versão: 1.0.0

Valor padrão: 1

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

mart.replicaCountMax Introduzida na versão: 1.0.0

Valor padrão: 5

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

mart.replicaCountMin Introduzida na versão: 1.0.0

Valor padrão: 1

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

mart.resources.requests.cpu Introduzida na versão: 1.0.0

Valor padrão: 500m

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

mart.resources.requests.memory Introduzida na versão: 1.0.0

Valor padrão: 512Mi

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

mart.serviceAccountPath Introduzida na versão: 1.1.1

Valor padrão: Nenhum

É 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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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

mart.sslCertPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

É necessário sslCertPath/sslKeyPath ou sslSecret.

Caminho do sistema de arquivos local para carregar e codificar o certificado SSL como um Secret.

mart.sslKeyPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

É necessário sslCertPath/sslKeyPath ou sslSecret.

Caminho do sistema de arquivos local para carregar e codificar a chave SSL para um secret.

mart.sslSecret Introduzida na versão: 1.2.0

Valor padrão: Nenhum

É 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 Introduzida na versão: 1.0.0

Valor padrão: 75

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 Introduzida na versão: 1.0.0

Valor padrão: 30

O tempo 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.

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 Descrição
metrics.aggregator.resources.requests.cpu Introduzida na versão: 1.4.0

Valor padrão: 500m

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

metrics.aggregator.resources.requests.memory Introduzida na versão: 1.4.0

Valor padrão: 512Mi

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 Introduzida na versão: 1.4.0

Valor padrão: 500m

O limite de CPU do recurso de agregador em um contêiner do Kubernetes, em millicores.

metrics.aggregator.resources.limits.memory Introduzida na versão: 1.4.0

Valor padrão: 3Gi

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

metrics.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

metrics.app.resources.requests.cpu Introduzida na versão: 1.4.0

Valor padrão: 500m

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

metrics.app.resources.requests.memory Introduzida na versão: 1.4.0

Valor padrão: 512Mi

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 Introduzida na versão: 1.4.0

Valor padrão: 500m

O limite de CPU do recurso do aap em um contêiner do Kubernetes, em millicores.

metrics.app.resources.limits.memory Introduzida na versão: 1.4.0

Valor padrão: 1Gi

O limite de memória para o recurso do app em um contêiner do Kubernetes, em gibibytes.

metrics.appStackdriverExporter.resources.requests.cpu Introduzida na versão: 1.7.0

Valor padrão: 128m

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

metrics.appStackdriverExporter.resources.requests.memory Introduzida na versão: 1.7.0

Valor padrão: 512Mi

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

metrics.appStackdriverExporter.resources.limits.cpu Introduzida na versão: 1.7.0

Valor padrão: 500m

O limite de CPU do recurso stackdriverExporter em um contêiner do Kubernetes, em millicores.

metrics.appStackdriverExporter.resources.limits.memory Introduzida na versão: 1.7.0

Valor padrão: 1Gi

O limite de memória para o recurso stackdriverExporter em um contêiner do Kubernetes, em gibibytes.

metrics.enabled Introduzida na versão: 1.0.0

Valor padrão: true

Ativa as métricas da Apigee. Defina como true para ativar métricas. Defina como false para desativar métricas.

metrics.nodeSelector.key Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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.args.storage_tsdb_retention Introduzida na versão: 1.0.0

Valor padrão: 48h

O tempo que o Prometheus espera antes de remover dados antigos do armazenamento local, em horas.

metrics.prometheus.containerPort Introduzida na versão: 1.0.0

Valor padrão: 9090

A porta para se conectar ao serviço de métricas do Prometheus.

metrics.prometheus.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: v2.9.2

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

metrics.prometheus.image.url Introduzida na versão: 1.0.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-prom-prometheus

O local da imagem do Docker desse serviço.

metrics.prometheus.livenessProbe.failureThreshold Introduzida na versão: 1.0.0

Valor padrão: 6

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 Introduzida na versão: 1.0.0

Valor padrão: 5

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

metrics.prometheus.livenessProbe.timeoutSeconds Introduzida na versão: 1.0.0

Valor padrão: 3

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

metrics.prometheus.readinessProbe.failureThreshold Introduzida na versão: 1.0.0

Valor padrão: 120

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 Introduzida na versão: 1.0.0

Valor padrão: 5

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

metrics.prometheus.readinessProbe.timeoutSeconds Introduzida na versão: 1.0.0

Valor padrão: 3

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

metrics.prometheus.sslCertPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.4.0

Valor padrão: 500m

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

metrics.proxy.resources.requests.memory Introduzida na versão: 1.4.0

Valor padrão: 512Mi

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 Introduzida na versão: 1.4.0

Valor padrão: 500m

O limite de CPU do recurso de proxy em um contêiner do Kubernetes, em millicores.

metrics.proxy.resources.limits.memory Introduzida na versão: 1.4.0

Valor padrão: 1Gi

O limite de memória do recurso de proxy em um contêiner Kubernetes em gibibytes.

metrics.proxyStackdriverExporter.resources.requests.cpu Introduzida na versão: 1.7.0

Valor padrão: 128m

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

metrics.proxyStackdriverExporter.resources.requests.memory Introduzida na versão: 1.7.0

Valor padrão: 512Mi

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 Introduzida na versão: 1.7.0

Valor padrão: 500m

O limite de CPU do recurso stackdriverExporter em um contêiner do Kubernetes, em millicores.

metrics.proxyStackdriverExporter.resources.limits.memory Introduzida na versão: 1.7.0

Valor padrão: 1Gi

O limite de memória para o recurso stackdriverExporter em um contêiner do Kubernetes, em gibibytes.

metrics.proxyURL Introduzida na versão: 1.0.0

Valor padrão: Nenhum

URL do proxy secundário do processo de métricas no cluster do Kubernetes.

metrics.sdSidecar.containerPort Introduzida na versão: 1.0.0

Valor padrão: 9091

A porta para se conectar ao serviço de métricas do Cloud Operations.

metrics.sdSidecar.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: 0.9.0

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

metrics.sdSidecar.image.url Introduzida na versão: 1.0.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-stackdriver-prometheus-sidecar

O local da imagem do Docker desse serviço.

metrics.serviceAccountPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

É 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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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

metrics.stackdriverExporter.resources.requests.cpu Introduzida na versão: 1.4.0

Deprecated: a partir da versão híbrida 1.7, metrics:stackdriverExporter foi substituído por metrics:appStackdriverExporter e metrics:proxyStackdriverExporter. Veja estes tópicos:

metrics.stackdriverExporter.resources.requests.memory Introduzida na versão: 1.4.0

Deprecated: a partir da versão híbrida 1.7, metrics:stackdriverExporter foi substituído por metrics:appStackdriverExporter e metrics:proxyStackdriverExporter. Veja estes tópicos:

metrics.stackdriverExporter.resources.limits.cpu Introduzida na versão: 1.4.0

Deprecated: a partir da versão híbrida 1.7, metrics:stackdriverExporter foi substituído por metrics:appStackdriverExporter e metrics:proxyStackdriverExporter. Veja estes tópicos:

metrics.stackdriverExporter.resources.limits.memory Introduzida na versão: 1.4.0

Deprecated: a partir da versão híbrida 1.7, metrics:stackdriverExporter foi substituído por metrics:appStackdriverExporter e metrics:proxyStackdriverExporter. Veja estes tópicos:

metrics.terminationGracePeriodSeconds Introduzida na versão: 1.0.0

Valor padrão: 300

O tempo 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.

nodeSelector

O objeto nodeSelector define o nó da instância da Apigee. Nos bastidores, quando apigeectl é executado, observe que a chave-valor de apigeeRuntime e apigeeData é mapeada para os componentes individuais do Istio e MART. É possível substituir isso por objetos individuais na propriedade mart:nodeSelector.

A tabela a seguir descreve as propriedades do objeto nodeSelector:

Propriedade Descrição
nodeSelector.apigeeData.key Introduzida na versão: 1.0.0

Valor padrão: cloud.google.com/gke-nodepool

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 Introduzida na versão: 1.0.0

Valor padrão: apigee-data

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 Introduzida na versão: 1.0.0

Valor padrão: cloud.google.com/gke-nodepool

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 Introduzida na versão: 1.0.0

Valor padrão: apigee-runtime

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 Introduzida na versão: 1.0.0

Valor padrão: falso

A propriedade requiredForScheduling assume como padrão false. Se esse valor for modificado como true, o Kubernetes não poderá encontrar nós com a chave/valor de rótulo configurada. Além disso, 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 Descrição
redis.auth.password Introduzida na versão: 1.6.0

Valor padrão: iloveapis123

Obrigatório

Senha do administrador do Redis. O usuário administrador é usado para qualquer atividade administrativa realizada no cluster do Redis.

redis.replicaCount Introduzida na versão: 1.6.0

Valor padrão: 2

O Redis é um armazenamento replicado. Essa propriedade especifica o número de nós do Redis empregado como um StatefulSet.

redis.resources.requests.cpu Introduzida na versão: 1.6.0

Valor padrão: 500m

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

runtime

A tabela a seguir descreve as propriedades do objeto runtime:

Propriedade Descrição
runtime.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

runtime.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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.image.tag Introduzida na versão: 1.0.0

Valor padrão: 1.3.6

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

runtime.image.url Introduzida na versão: 1.0.0

Valor padrão: URL para o recurso de imagem da instalação, por exemplo:gcr.io/apigee-release/hybrid/apigee-runtime

O local da imagem do Docker desse serviço.

runtime.livenessProbe.failureThreshold Introduzida na versão: 1.0.0

Valor padrão: 2

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 Introduzida na versão: 1.0.0

Valor padrão: 60

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 Introduzida na versão: 1.0.0

Valor padrão: 5

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

runtime.livenessProbe.timeoutSeconds Introduzida na versão: 1.0.0

Valor padrão: 1

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

runtime.nodeSelector.key Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: 2

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 Introduzida na versão: 1.0.0

Valor padrão: 60

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

runtime.readinessProbe.periodSeconds Introduzida na versão: 1.0.0

Valor padrão: 5

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

runtime.readinessProbe.successThreshold Introduzida na versão: 1.0.0

Valor padrão: 1

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 Introduzida na versão: 1.0.0

Valor padrão: 1

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

runtime.replicaCountMax Introduzida na versão: 1.0.0

Valor padrão: 4

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

runtime.replicaCountMin Introduzida na versão: 1.0.0

Valor padrão: 1

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

runtime.resources.requests.cpu Introduzida na versão: 1.0.0

Valor padrão: 500m

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

runtime.resources.requests.memory Introduzida na versão: 1.0.0

Valor padrão: 512Mi (confira a observação abaixo)

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 Introduzida na versão: 1.0.0

Valor padrão: ClusterIP

O tipo de serviço. Você pode definir isso como um serviço diferente de ClusterIP. Por exemplo, LoadBalancer.

runtime.targetCPUUtilizationPercentage Introduzida na versão: 1.0.0

Valor padrão: 75

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 Introduzida na versão: 1.0.0

Valor padrão: 180

O tempo 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.

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 Descrição
synchronizer.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

synchronizer.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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 Introduzida na versão: 1.0.0

Valor padrão: 1.3.6

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

synchronizer.image.url Introduzida na versão: 1.0.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-synchronizer

O local da imagem do Docker desse serviço.

synchronizer.livenessProbe.failureThreshold Introduzida na versão: 1.0.0

Valor padrão: 2

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 Introduzida na versão: 1.0.0

Valor padrão: 0

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 Introduzida na versão: 1.0.0

Valor padrão: 5

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

synchronizer.livenessProbe.timeoutSeconds Introduzida na versão: 1.0.0

Valor padrão: 1

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

synchronizer.nodeSelector.key Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.0.0

Valor padrão: 60

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 Introduzida na versão: 1.0.0

Valor padrão: 2

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 Introduzida na versão: 1.0.0

Valor padrão: 0

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

synchronizer.readinessProbe.periodSeconds Introduzida na versão: 1.0.0

Valor padrão: 5

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

synchronizer.readinessProbe.successThreshold Introduzida na versão: 1.0.0

Valor padrão: 1

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 Introduzida na versão: 1.0.0

Valor padrão: 1

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

synchronizer.replicaCount Introduzida na versão: 1.0.0

Valor padrão: 2

Número de réplicas para escalonamento automático.

synchronizer.replicaCountMax Introduzida na versão: 1.2.0

Valor padrão: 4

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

synchronizer.replicaCountMin Introduzida na versão: 1.2.0

Valor padrão: 1

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

synchronizer.resources.requests.cpu Introduzida na versão: 1.0.0

Valor padrão: 100m

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

synchronizer.resources.requests.memory Introduzida na versão: 1.0.0

Valor padrão: 1Gi

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

synchronizer.serviceAccountPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

É 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 Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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

synchronizer.targetCPUUtilizationPercentage Introduzida na versão: 1.0.0

Valor padrão: 75

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 Introduzida na versão: 1.0.0

Valor padrão: 30

O tempo 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.

udca

(Agente universal de coleta de dados) define o serviço que é executado no pod de coleta de dados no plano do ambiente de execução. Esse serviço extrai dados de status de análise e implantação e os envia para a plataforma de análise unificada (UAP, na sigla em inglês).

Para mais informações, consulte Coleta de dados de status de implantação e análise.

A tabela a seguir descreve as propriedades do objeto udca:

Propriedade Descrição
udca.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

udca.fluentd.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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.

udca.fluentd.image.tag Introduzida na versão: 1.0.0

Valor padrão: 1.8.9

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

udca.fluentd.image.url Introduzida na versão: 1.0.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-stackdriver-logging-agent

O local da imagem do Docker desse serviço.

udca.fluentd.resources.limits.memory Introduzida na versão: 1.0.0

Valor padrão: 500Mi

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

udca.fluentd.resources.requests.cpu Introduzida na versão: 1.0.0

Valor padrão: 500m

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

udca.fluentd.resources.requests.memory Introduzida na versão: 1.0.0

Valor padrão: 250Mi

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

udca.image.pullPolicy Introduzida na versão: 1.0.0

Valor padrão: IfNotPresent

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.

udca.image.tag Introduzida na versão: 1.0.0

Valor padrão: 1.3.6

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

udca.image.url Introduzida na versão: 1.0.0

Valor padrão: gcr.io/apigee-release/hybrid/apigee-udca

O local da imagem do Docker desse serviço.

udca.jvmXms Introduzida na versão: 1.0.0

Valor padrão: 256m

A quantidade de memória inicial do JVM do pod de coleta de dados.

udca.jvmXmx Introduzida na versão: 1.0.0

Valor padrão: 256m

A alocação máxima de memória para JVM do pod de coleta de dados.

udca.livenessProbe.failureThreshold Introduzida na versão: 1.0.0

Valor padrão: 2

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.

udca.livenessProbe.initialDelaySeconds Introduzida na versão: 1.0.0

Valor padrão: 0

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

udca.livenessProbe.periodSeconds Introduzida na versão: 1.0.0

Valor padrão: 5

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

udca.livenessProbe.timeoutSeconds Introduzida na versão: 1.0.0

Valor padrão: 1

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

udca.nodeSelector.key Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 udca.

Consulte Como configurar pools de nós dedicados.

udca.nodeSelector.value Introduzida na versão: 1.0.0

Valor padrão: Nenhum

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 udca.

Consulte Como configurar pools de nós dedicados.

udca.pollingIntervalInSec Introduzida na versão: 1.0.0

Valor padrão: 1

O tempo, em segundos, que a UDCA aguarda entre as operações de pesquisa. A UDCA pesquisa o diretório de dados no sistema de arquivos do pod de coleta de dados para detectar novos arquivos.

udca.replicaCountMax Introduzida na versão: 1.0.0

Valor padrão: 4

O número máximo de pods que o híbrido pode adicionar automaticamente para a implantação da UDCA. Como a UDCA é implementada como um ReplicaSet, os pods são réplicas.

udca.replicaCountMin Introduzida na versão: 1.0.0

Valor padrão: 1

O número mínimo de pods para implantação da UDCA. Como a UDCA é implementada como um ReplicaSet, os pods são réplicas.

Se o uso da CPU ultrapassar udca.targetCPUUtilizationPercentage, o híbrido aumentará gradualmente o número de pods, até udca.replicaCountMax.

udca.resources.requests.cpu Introduzida na versão: 1.0.0

Valor padrão: 250m

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

udca.revision Introduzida na versão: 1

Valor padrão: v1

Um valor estático preenchido em um rótulo para ativar implantações canário.

udca.serviceAccountPath Introduzida na versão: 1.0.0

Valor padrão: Nenhum

É 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 Agente do Apigee Analytics.

udca.serviceAccountRef Introduzida na versão: 1.2.0

Valor padrão: Nenhum

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

udca.targetCPUUtilizationPercentage Introduzida na versão: 1.0.0

Valor padrão: 75

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. O híbrido usa a combinação combinada de todos os contêineres no pod de coleta de dados (fluentd e UDCA) para calcular a utilização atual.

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

udca.terminationGracePeriodSeconds Introduzida na versão: 1.0.0

Valor padrão: 600

O tempo 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.

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 Descrição
virtualhosts[].additionalGateways Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Uma lista de gateways do Istio para rotear o tráfego.

virtualhosts[].name Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Obrigatório

O nome do host virtual.

virtualhosts[].hostAliases[] Introduzida na versão: 1.2.0

Valor padrão: Nenhum

Obrigatório

Deprecated: a partir da versão híbrida 1.4, o plano do ambiente de execução recebe essas informações do plano de gerenciamento. Consulte Sobre ambientes e grupos de ambiente.

virtualhosts[].maxTLSProtocolVersion Introduzida na versão: 1.3.0

Valor padrão: Nenhum

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 estar na forma de um número. Por exemplo:

virtualhosts:
  - name: default
    maxTLSProtocolVersion: "1.3"

Onde o número 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.TLSProtocol na documentação do Istio.

virtualhosts[].minTLSProtocolVersion Introduzida na versão: 1.3.0

Valor padrão: Nenhum

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 estar na forma de um número. Por exemplo:

virtualhosts:
  - name: default
    minTLSProtocolVersion: "1.2"

Onde o número 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.TLSProtocol na documentação do Istio.

virtualhosts[].selector Introduzida na versão: 1.2.0

Valor padrão: app: istio-ingressgateway

Obrigatório

Um par de valor-chave seletora de valor-chave para apontar para diferentes seletores de entrada.

virtualhosts[].sslCertPath Introduzida na versão: 1.2.0

Valor padrão: Nenhum

É necessário sslCertPath/sslKeyPath ou sslSecret.

O caminho no seu sistema para um arquivo de certificado TLS.

virtualhosts[].sslKeyPath Introduzida na versão: 1.2.0

Valor padrão: Nenhum

É necessário sslCertPath/sslKeyPath ou sslSecret.

O caminho no seu sistema para o arquivo de chave privada TLS.

virtualhosts[].sslSecret Introduzida na versão: 1.2.0

Valor padrão: Nenhum

É 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:

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 Descrição
watcher.annotations Introduzida na versão: 1.5.0

Valor padrão: Nenhum

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

watcher.replicaCountMax Introduzida na versão: 1.3.0

Valor padrão: 1

O número máximo de réplicas do inspetor. Deve ser mantido em 1 para evitar conflitos.

watcher.replicaCountMin Introduzida na versão: 1.3.0

Valor padrão: 1

O número mínimo de réplicas do inspetor.

watcher.serviceAccountPath Introduzida na versão: 1.3.0

Valor padrão: Nenhum

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 Introduzida na versão: 1.3.0

Valor padrão: Nenhum

É necessário escolher serviceAccountPath ou serviceAccountSecretRef.