Referência da propriedade de configuração

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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:

Property 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, kmsEncryptionPath ou kmsEncryptionSecret.

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, kvmEncryptionPath ou kvmEncryptionSecret.

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:

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

authz

A tabela a seguir descreve as propriedades do objeto authz:

Property Descrição
authz.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.

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

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

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

O local da imagem do Docker desse serviço.

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

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

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

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

authz.readinessProbe.failureThreshold Introduzida na versão: Beta2

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.

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

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

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

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

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

Valor padrão: 50m

A quantidade de recursos de CPU a serem alocados para solicitações de autenticação.

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

Valor padrão: 128Mi

A quantidade de recursos de memória para alocar para solicitações de autenticação.

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:

Property 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: apigee

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: googgcr.io/apigee-releasele/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.

Veja o Apigee Connect.

A tabela a seguir descreve as propriedades do objeto connectAgent:

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

Valor padrão: false

Esta instalação usa o Apigee Connect em vez da entrada do Istio para milhares? Verdadeiro ou falso?

Veja o Apigee Connect.

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:

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

Property 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

Valor

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:

Property 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