Esta página foi traduzida pela API Cloud Translation.

Passo 7: crie as substituições

Especifique substituições de configuração

O instalador híbrido do Apigee usa predefinições para muitas definições. No entanto, existem algumas definições que não têm predefinições. Tem de fornecer valores para estas definições, conforme explicado em seguida.

Antes de começar

Recomendamos que reveja os seguintes cenários para determinar se quer configurar o cluster para os mesmos. Estas configurações são opcionais.

Se planeia instalar o híbrido em várias regiões, leia o artigo Implementação em várias regiões antes de continuar.
O Apigee Hybrid fornece palavras-passe predefinidas para os utilizadores do Cassandra. O Apigee recomenda a alteração das palavras-passe de utilizador predefinidas. Consulte o artigo Configurar o TLS para o Cassandra para ver detalhes.
Se quiser configurar as definições de armazenamento e de memória dinâmica para o Cassandra, consulte o artigo Configure as definições de armazenamento e de memória dinâmica.
Conforme descrito na Parte 1: Configuração do projeto e da organização – Passo 1: Ativar APIs, Para cenários de instalação de produção, configure o armazenamento persistent solid state disk (SSD) para o Cassandra. O Apigee não suporta a utilização de SSDs locais para o Apigee Hybrid. Para ver detalhes, consulte o artigo Adicione armazenamento SSD para implementações de produção.

Configure o cluster

Por convenção, as substituições de configuração são escritas num ficheiro denominado overrides.yaml normalmente armazenado no diretório $APIGEE_HELM_CHARTS_HOME.

Nota: o ficheiro overrides.yaml é usado durante as atualizações, as expansões e sempre que precisar de alterar a configuração da instalação do tempo de execução híbrido. A Apigee recomenda que armazene este ficheiro num repositório de controlo de origem com controlo de versões.

Crie um novo ficheiro denominado overrides.yaml no diretório $APIGEE_HELM_CHARTS_HOME.
O overrides.yaml fornece a configuração para a sua instalação híbrida do Apigee exclusiva. O ficheiro de substituições neste passo oferece uma configuração básica para uma instalação de tempo de execução híbrida de pequena dimensão, adequada para a sua primeira instalação.

Em overrides.yaml, adicione os valores das propriedades obrigatórias, apresentados abaixo. Abaixo, encontra uma descrição detalhada de cada propriedade.

Certifique-se de que o ficheiro overrides.yaml tem a seguinte estrutura e sintaxe.

Escolha o separador para o tipo de autenticação de conta de serviço que está a usar na sua instalação: Passo 4: crie contas de serviço.

Chaves de contas de serviço em segredos do Kubernetes: segredos do Kubernetes
Ficheiros de chave JSON da conta de serviço: ficheiros JSON
Chaves de contas de serviço no Vault: Vault
Workload Identity Federation para o GKE: WIF para o GKE
Workload Identity Federation: WIF noutras plataformas

Para uma vista geral das diferentes opções de autenticação, consulte os métodos de autenticação de contas de serviço no Apigee hybrid.

Selecione o separador para a sua instalação, produção, Produção ou não produção (instalações de demonstração, avaliação ou prova de conceito), Não prod., consoante a sua escolha no Passo 4: crie contas de serviço.

Para instalações em ambientes de produção, consulte os requisitos de armazenamento da base de dados Cassandra em Configure o Cassandra para produção.

Segredos do Kubernetes

Produção

Modelo

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretRefs:
    synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-synchronizer-svc-account"
    runtime: RUNTIME_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-runtime-svc-account"
    udca: UDCA_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-udca-svc-account"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountRef: MART_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-mart-svc-account"

connectAgent:
  serviceAccountRef: MART_SERVICE_ACCOUNT_SECRET
    # Use the same secret for mart and connectAgent
    # For example: "apigee-mart-svc-account"

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountRef: LOGGER_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-logger-svc-account"

metrics:
  serviceAccountRef: METRICS_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-metrics-svc-account"

udca:
  serviceAccountRef: UDCA_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-udca-svc-account"

watcher:
  serviceAccountRef: WATCHER_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-watcher-svc-account"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountRef: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-mint-task-scheduler-svc-account"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ SECRET`	O nome do segredo do Kubernetes que criou para a chave da conta de serviço no passo 5: configure a autenticação da conta de serviço. Os nomes predefinidos dos segredos sugeridos neste guia são: Produção `apigee-cassandra-svc-account` `apigee-logger-svc-account` `apigee-mart-svc-account` `apigee-metrics-svc-account` `apigee-mint-task-scheduler-svc-account` `apigee-runtime-svc-account` `apigee-synchronizer-svc-account` `apigee-udca-svc-account` `apigee-watcher-svc-account` Não prod `apigee-non-prod-svc-account` Consulte: `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountSecretRefs:
    synchronizer: "apigee-synchronizer-svc-account"
    runtime: "apigee-runtime-svc-account"
    udca: "apigee-udca-svc-account"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountRef: "apigee-mart-svc-account"

connectAgent:
  serviceAccountRef: "apigee-mart-svc-account"

logger:
  enabled: true
  serviceAccountRef: "apigee-logger-svc-account"

metrics:
  serviceAccountRef: "apigee-metrics-svc-account"

udca:
  serviceAccountRef: "apigee-udca-svc-account"

watcher:
  serviceAccountRef: "apigee-watcher-svc-account"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountRef: apigee-mint-task-scheduler-svc-account

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ SECRET`	O nome do segredo do Kubernetes que criou para a chave da conta de serviço no passo 5: configure a autenticação da conta de serviço. Os nomes predefinidos dos segredos sugeridos neste guia são: Produção `apigee-cassandra-svc-account` `apigee-logger-svc-account` `apigee-mart-svc-account` `apigee-metrics-svc-account` `apigee-mint-task-scheduler-svc-account` `apigee-runtime-svc-account` `apigee-synchronizer-svc-account` `apigee-udca-svc-account` `apigee-watcher-svc-account` Não prod `apigee-non-prod-svc-account` Consulte: `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Não prod

Modelo

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretRefs:
    synchronizer: NON_PROD_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-non-prod-svc-account"
    runtime: NON_PROD_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-non-prod-svc-account"
    udca: NON_PROD_SERVICE_ACCOUNT_SECRET
      # For example: "apigee-non-prod-svc-account"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

connectAgent:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # Use the same secret for mart and connectAgent
    # For example: "apigee-non-prod-svc-account"

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

metrics:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

udca:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

watcher:
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET
    # For example: "apigee-non-prod-svc-account"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ SECRET`	O nome do segredo do Kubernetes que criou para a chave da conta de serviço no passo 5: configure a autenticação da conta de serviço. Os nomes predefinidos dos segredos sugeridos neste guia são: Produção `apigee-cassandra-svc-account` `apigee-logger-svc-account` `apigee-mart-svc-account` `apigee-metrics-svc-account` `apigee-mint-task-scheduler-svc-account` `apigee-runtime-svc-account` `apigee-synchronizer-svc-account` `apigee-udca-svc-account` `apigee-watcher-svc-account` Não prod `apigee-non-prod-svc-account` Consulte: `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountSecretRefs:
    synchronizer: "apigee-non-prod-svc-account"
    runtime: "apigee-non-prod-svc-account"
    udca: "apigee-non-prod-svc-account"

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountRef: "apigee-non-prod-svc-account"

connectAgent:
  serviceAccountRef: "apigee-non-prod-svc-account"

logger:
  enabled: true
  serviceAccountRef: "apigee-non-prod-svc-account"

metrics:
  serviceAccountRef: "apigee-non-prod-svc-account"

udca:
  serviceAccountRef: "apigee-non-prod-svc-account"

watcher:
  serviceAccountRef: "apigee-non-prod-svc-account"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountRef: apigee-non-prod-svc-account

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ SECRET`	O nome do segredo do Kubernetes que criou para a chave da conta de serviço no passo 5: configure a autenticação da conta de serviço. Os nomes predefinidos dos segredos sugeridos neste guia são: Produção `apigee-cassandra-svc-account` `apigee-logger-svc-account` `apigee-mart-svc-account` `apigee-metrics-svc-account` `apigee-mint-task-scheduler-svc-account` `apigee-runtime-svc-account` `apigee-synchronizer-svc-account` `apigee-udca-svc-account` `apigee-watcher-svc-account` Não prod `apigee-non-prod-svc-account` Consulte: `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Ficheiros JSON

Produção

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    # Provide the path relative to the apigee-env chart directory.
    synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-synchronizer.json"
    runtime: RUNTIME_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-runtime.json"
    udca: UDCA_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-udca.json"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountPath: LOGGER_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-F chart directory.
    # For example: "PROJECT_ID-apigee-logger.json"

mart:
  serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-mart.json"

connectAgent:
  serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
    # Use the same service account for mart and connectAgent
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-mart.json"

metrics:
  serviceAccountPath: METRICS_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-metrics.json"

udca:
  serviceAccountPath: UDCA_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-udca.json"

watcher:
  serviceAccountPath: WATCHER_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-watcher.json"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountPath: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-mint-task-scheduler.json"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável Descrição

UNIQUE_INSTANCE_ IDENTIFIER

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

Nota: pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões).

Pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes.

Consulte instanceID.

APIGEE_NAMESPACE

O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid.

O valor predefinido é apigee.

Consulte namespace.

PROJECT_ID

Identifica o projeto do Google Cloud onde o apigee-logger e o apigee-metrics enviam os respetivos dados. Este é o valor atribuído à variável de ambiente PROJECT_ID.

Consulte gcp.projectID.

ANALYTICS_REGION

No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização).

Este é o valor que atribuiu anteriormente à variável de ambiente ANALYTICS_REGION.

Consulte gcp.region.

CLUSTER_NAME

O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente CLUSTER_NAME.

Consulte k8sCluster.name.

CLUSTER_LOCATION

A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster.

Este é o valor que atribuiu anteriormente à variável de ambiente CLUSTER_LOCATION.

Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona us-central1-a, especifique us-central1 para o CLUSTER_LOCATION.

Consulte k8sCluster.location.

ORG_NAME

O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente ORG_NAME.

Consulte org.

CONTROL_PLANE_ LOCATION

Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente CONTROL_PLANE_LOCATION no passo 2: crie uma organização.

Consulte contractProvider.

ENVIRONMENT_NAME

Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes.

Consulte envs[].name.

ENVIRONMENT_GROUP_ NAME

O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente ENV_GROUP.

Consulte virtualhosts[].name.

INGRESS_NAME

O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos:

Ter um comprimento máximo de 17 carateres
Contêm apenas carateres alfanuméricos minúsculos, "-" ou "."
Começar com um caráter alfanumérico
Terminar com um caráter alfanumérico

Consulte:

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. Por exemplo:

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consulte:

SVC_ANNOTATIONS_ KEY: SVC_ANNOTATIONS_ VALUE

(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo.

As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas.

Nota: não precisa de definir svcAnnotations se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee.

Comente ou elimine esta secção se não a estiver a usar.

Consulte ingressGateways[].svcAnnotations.

<component>_ SERVICE_ACCOUNT_ FILEPATH

O caminho e o nome de ficheiro da conta dos ficheiros JSON da conta de serviço no diretório do gráfico correspondente. Indique os nomes com o caminho relativo ao diretório do gráfico. Por exemplo:

Se o ficheiro my-project-apigee-synchronizer.json residir no diretório de gráficos apigee-env/, só tem de indicar o nome do ficheiro, como:
```
synchronizer:  "FILE_NAME.json"
```
Se o ficheiro residir num diretório apigee-env/service-accounts/, especifica um caminho relativo:
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Para ambientes de não produção, o nome da conta de serviço única é PROJECT_ID-non-prod.json por predefinição.

Para ambientes de produção, o nome do ficheiro de chave da conta de serviço que gerou com a ferramenta create-service-account no passo 4: crie contas de serviço.

Pode ver os ficheiros da conta de serviço em cada diretório de gráficos correspondente.

Os nomes predefinidos dos diretórios de gráficos correspondentes para as contas de serviço são:

Produção

Nome do ficheiro da conta de serviço	Diretório de gráficos
`PROJECT_ID-apigee-cassandra.json`	`apigee-datastore/`
`PROJECT_ID-apigee-mart.json`	`apigee-org/`
`PROJECT_ID-apigee-metrics.json`	`apigee-telemetry/`
`PROJECT_ID-apigee-mint-task-scheduler.json`	`apigee-org/`
`PROJECT_ID-apigee-runtime.json`	`apigee-env/`
`PROJECT_ID-apigee-synchronizer.json`	`apigee-env/`
`PROJECT_ID-apigee-udca.json`	`apigee-org/`
`PROJECT_ID-apigee-watcher.json`	`apigee-org/`

Não prod

Nome do ficheiro da conta de serviço	Diretório de gráficos
`PROJECT_ID-non-prod.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Nota: ambos os produtos mart e connectAgent usam a conta de serviço apigee-mart.

Consulte:

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountPaths:
    synchronizer: "my-project-apigee-synchronizer.json"
    runtime: "my-project-apigee-runtime.json"
    udca: "my-project-apigee-udca.json"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: true
  serviceAccountPath: "my-project-apigee-logger.json"

mart:
  serviceAccountPath: "my-project-apigee-mart.json"

connectAgent:
  serviceAccountPath: "my-project-apigee-mart.json"

metrics:
  serviceAccountPath: "my-project-apigee-metrics.json"

udca:
  serviceAccountPath: "my-project-apigee-udca.json"

watcher:
  serviceAccountPath: "my-project-apigee-watcher.json"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: my-project-apigee-mint-task-scheduler.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável Descrição

UNIQUE_INSTANCE_ IDENTIFIER

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

Pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes.

Consulte instanceID.

APIGEE_NAMESPACE

O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid.

O valor predefinido é apigee.

Consulte namespace.

PROJECT_ID

Identifica o projeto do Google Cloud onde o apigee-logger e o apigee-metrics enviam os respetivos dados. Este é o valor atribuído à variável de ambiente PROJECT_ID.

Consulte gcp.projectID.

ANALYTICS_REGION

Este é o valor que atribuiu anteriormente à variável de ambiente ANALYTICS_REGION.

Consulte gcp.region.

CLUSTER_NAME

O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente CLUSTER_NAME.

Consulte k8sCluster.name.

CLUSTER_LOCATION

A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster.

Este é o valor que atribuiu anteriormente à variável de ambiente CLUSTER_LOCATION.

Consulte k8sCluster.location.

ORG_NAME

O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente ORG_NAME.

Consulte org.

CONTROL_PLANE_ LOCATION

Consulte contractProvider.

ENVIRONMENT_NAME

Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes.

Consulte envs[].name.

ENVIRONMENT_GROUP_ NAME

Consulte virtualhosts[].name.

INGRESS_NAME

O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos:

Ter um comprimento máximo de 17 carateres
Contêm apenas carateres alfanuméricos minúsculos, "-" ou "."
Começar com um caráter alfanumérico
Terminar com um caráter alfanumérico

Consulte:

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consulte:

SVC_ANNOTATIONS_ KEY: SVC_ANNOTATIONS_ VALUE

As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas.

Comente ou elimine esta secção se não a estiver a usar.

Consulte ingressGateways[].svcAnnotations.

<component>_ SERVICE_ACCOUNT_ FILEPATH

Se o ficheiro my-project-apigee-synchronizer.json residir no diretório de gráficos apigee-env/, só tem de indicar o nome do ficheiro, como:
```
synchronizer:  "FILE_NAME.json"
```
Se o ficheiro residir num diretório apigee-env/service-accounts/, especifica um caminho relativo:
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Para ambientes de não produção, o nome da conta de serviço única é PROJECT_ID-non-prod.json por predefinição.

Para ambientes de produção, o nome do ficheiro de chave da conta de serviço que gerou com a ferramenta create-service-account no passo 4: crie contas de serviço.

Pode ver os ficheiros da conta de serviço em cada diretório de gráficos correspondente.

Os nomes predefinidos dos diretórios de gráficos correspondentes para as contas de serviço são:

Produção

Nome do ficheiro da conta de serviço	Diretório de gráficos
`PROJECT_ID-apigee-cassandra.json`	`apigee-datastore/`
`PROJECT_ID-apigee-mart.json`	`apigee-org/`
`PROJECT_ID-apigee-metrics.json`	`apigee-telemetry/`
`PROJECT_ID-apigee-mint-task-scheduler.json`	`apigee-org/`
`PROJECT_ID-apigee-runtime.json`	`apigee-env/`
`PROJECT_ID-apigee-synchronizer.json`	`apigee-env/`
`PROJECT_ID-apigee-udca.json`	`apigee-org/`
`PROJECT_ID-apigee-watcher.json`	`apigee-org/`

Não prod

Nome do ficheiro da conta de serviço	Diretório de gráficos
`PROJECT_ID-non-prod.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Nota: ambos os produtos mart e connectAgent usam a conta de serviço apigee-mart.

Consulte:

Não prod

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    # Provide the path relative to the apigee-env chart directory.
    synchronizer: NON_PROD_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-non-prod.json"
    runtime: NON_PROD_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-non-prod.json"
    udca: NON_PROD_SERVICE_ACCOUNT_FILEPATH
      # For example: "PROJECT_ID-apigee-non-prod.json"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

connectAgent:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Use the same service account for mart and connectAgent
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-F chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

metrics:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

udca:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

watcher:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "PROJECT_ID-apigee-non-prod.json"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável Descrição

UNIQUE_INSTANCE_ IDENTIFIER

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

Pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes.

Consulte instanceID.

APIGEE_NAMESPACE

O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid.

O valor predefinido é apigee.

Consulte namespace.

PROJECT_ID

Identifica o projeto do Google Cloud onde o apigee-logger e o apigee-metrics enviam os respetivos dados. Este é o valor atribuído à variável de ambiente PROJECT_ID.

Consulte gcp.projectID.

ANALYTICS_REGION

Este é o valor que atribuiu anteriormente à variável de ambiente ANALYTICS_REGION.

Consulte gcp.region.

CLUSTER_NAME

O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente CLUSTER_NAME.

Consulte k8sCluster.name.

CLUSTER_LOCATION

A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster.

Este é o valor que atribuiu anteriormente à variável de ambiente CLUSTER_LOCATION.

Consulte k8sCluster.location.

ORG_NAME

O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente ORG_NAME.

Consulte org.

CONTROL_PLANE_ LOCATION

Consulte contractProvider.

ENVIRONMENT_NAME

Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes.

Consulte envs[].name.

ENVIRONMENT_GROUP_ NAME

Consulte virtualhosts[].name.

INGRESS_NAME

O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos:

Ter um comprimento máximo de 17 carateres
Contêm apenas carateres alfanuméricos minúsculos, "-" ou "."
Começar com um caráter alfanumérico
Terminar com um caráter alfanumérico

Consulte:

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consulte:

SVC_ANNOTATIONS_ KEY: SVC_ANNOTATIONS_ VALUE

As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas.

Comente ou elimine esta secção se não a estiver a usar.

Consulte ingressGateways[].svcAnnotations.

<component>_ SERVICE_ACCOUNT_ FILEPATH

Se o ficheiro my-project-apigee-synchronizer.json residir no diretório de gráficos apigee-env/, só tem de indicar o nome do ficheiro, como:
```
synchronizer:  "FILE_NAME.json"
```
Se o ficheiro residir num diretório apigee-env/service-accounts/, especifica um caminho relativo:
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Para ambientes de não produção, o nome da conta de serviço única é PROJECT_ID-non-prod.json por predefinição.

Para ambientes de produção, o nome do ficheiro de chave da conta de serviço que gerou com a ferramenta create-service-account no passo 4: crie contas de serviço.

Pode ver os ficheiros da conta de serviço em cada diretório de gráficos correspondente.

Os nomes predefinidos dos diretórios de gráficos correspondentes para as contas de serviço são:

Produção

Nome do ficheiro da conta de serviço	Diretório de gráficos
`PROJECT_ID-apigee-cassandra.json`	`apigee-datastore/`
`PROJECT_ID-apigee-mart.json`	`apigee-org/`
`PROJECT_ID-apigee-metrics.json`	`apigee-telemetry/`
`PROJECT_ID-apigee-mint-task-scheduler.json`	`apigee-org/`
`PROJECT_ID-apigee-runtime.json`	`apigee-env/`
`PROJECT_ID-apigee-synchronizer.json`	`apigee-env/`
`PROJECT_ID-apigee-udca.json`	`apigee-org/`
`PROJECT_ID-apigee-watcher.json`	`apigee-org/`

Não prod

Nome do ficheiro da conta de serviço	Diretório de gráficos
`PROJECT_ID-non-prod.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Nota: ambos os produtos mart e connectAgent usam a conta de serviço apigee-mart.

Consulte:

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountPaths:
    synchronizer: "hybrid-example-apigee-non-prod.json"
    runtime: "hybrid-example-apigee-non-prod.json"
    udca: "hybrid-example-apigee-non-prod.json"

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountPath: "my-project-apigee-non-prod.json"

connectAgent:
  serviceAccountPath: "my-project-apigee-non-prod.json"

logger:
  enabled: true
  serviceAccountPath: "my-project-apigee-non-prod.json"

metrics:
  serviceAccountPath: "my-project-apigee-non-prod.json"

udca:
  serviceAccountPath: "my-project-apigee-non-prod.json"

watcher:
  serviceAccountPath: "my-project-apigee-non-prod.json"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: my-project-apigee-non-prod.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável Descrição

UNIQUE_INSTANCE_ IDENTIFIER

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

Pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes.

Consulte instanceID.

APIGEE_NAMESPACE

O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid.

O valor predefinido é apigee.

Consulte namespace.

PROJECT_ID

Identifica o projeto do Google Cloud onde o apigee-logger e o apigee-metrics enviam os respetivos dados. Este é o valor atribuído à variável de ambiente PROJECT_ID.

Consulte gcp.projectID.

ANALYTICS_REGION

Este é o valor que atribuiu anteriormente à variável de ambiente ANALYTICS_REGION.

Consulte gcp.region.

CLUSTER_NAME

O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente CLUSTER_NAME.

Consulte k8sCluster.name.

CLUSTER_LOCATION

A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster.

Este é o valor que atribuiu anteriormente à variável de ambiente CLUSTER_LOCATION.

Consulte k8sCluster.location.

ORG_NAME

O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente ORG_NAME.

Consulte org.

CONTROL_PLANE_ LOCATION

Consulte contractProvider.

ENVIRONMENT_NAME

Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes.

Consulte envs[].name.

ENVIRONMENT_GROUP_ NAME

Consulte virtualhosts[].name.

INGRESS_NAME

O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos:

Ter um comprimento máximo de 17 carateres
Contêm apenas carateres alfanuméricos minúsculos, "-" ou "."
Começar com um caráter alfanumérico
Terminar com um caráter alfanumérico

Consulte:

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consulte:

SVC_ANNOTATIONS_ KEY: SVC_ANNOTATIONS_ VALUE

As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas.

Comente ou elimine esta secção se não a estiver a usar.

Consulte ingressGateways[].svcAnnotations.

<component>_ SERVICE_ACCOUNT_ FILEPATH

Se o ficheiro my-project-apigee-synchronizer.json residir no diretório de gráficos apigee-env/, só tem de indicar o nome do ficheiro, como:
```
synchronizer:  "FILE_NAME.json"
```
Se o ficheiro residir num diretório apigee-env/service-accounts/, especifica um caminho relativo:
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Para ambientes de não produção, o nome da conta de serviço única é PROJECT_ID-non-prod.json por predefinição.

Para ambientes de produção, o nome do ficheiro de chave da conta de serviço que gerou com a ferramenta create-service-account no passo 4: crie contas de serviço.

Pode ver os ficheiros da conta de serviço em cada diretório de gráficos correspondente.

Os nomes predefinidos dos diretórios de gráficos correspondentes para as contas de serviço são:

Produção

Nome do ficheiro da conta de serviço	Diretório de gráficos
`PROJECT_ID-apigee-cassandra.json`	`apigee-datastore/`
`PROJECT_ID-apigee-mart.json`	`apigee-org/`
`PROJECT_ID-apigee-metrics.json`	`apigee-telemetry/`
`PROJECT_ID-apigee-mint-task-scheduler.json`	`apigee-org/`
`PROJECT_ID-apigee-runtime.json`	`apigee-env/`
`PROJECT_ID-apigee-synchronizer.json`	`apigee-env/`
`PROJECT_ID-apigee-udca.json`	`apigee-org/`
`PROJECT_ID-apigee-watcher.json`	`apigee-org/`

Não prod

Nome do ficheiro da conta de serviço	Diretório de gráficos
`PROJECT_ID-non-prod.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Nota: ambos os produtos mart e connectAgent usam a conta de serviço apigee-mart.

Consulte:

Vault

Produção

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountSecretProviderClass: apigee-envsakeys-prod-env-spc

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: true

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

Não prod

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountSecretProviderClass: apigee-envsakeys-test-env-spc

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: true

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# for message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

WIF para o GKE

Produção

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: true

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  gsa:
    synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_EMAIL
      # For example: "apigee-synchronizer@PROJECT_ID.iam.gserviceaccount.com"
    runtime: RUNTIME_SERVICE_ACCOUNT_EMAIL
      # For example: "apigee-runtime@PROJECT_ID.iam.gserviceaccount.com"
    udca: UDCA_SERVICE_ACCOUNT_EMAIL
      # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.
  backup:
    enabled: true # Required to create the Cassandra Kubernetes service accounts
                  # for Workload Identity Federation for GKE
                  # See Cassandra backup overview.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  gsa: MART_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com"

connectAgent:
  gsa: MART_SERVICE_ACCOUNT_EMAIL
    # Use the same service account email for mart and connectAgent
    # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com"

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.
  gsa: LOGGER_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-logger@PROJECT_ID.iam.gserviceaccount.com"

metrics:
  gsa: METRICS_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-metrics@PROJECT_ID.iam.gserviceaccount.com"

udca:
  gsa: UDCA_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com"

watcher:
  gsa: WATCHER_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-watcher@PROJECT_ID.iam.gserviceaccount.com"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  gsa: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_EMAIL
    # For example: "apigee-mint-task-scheduler@PROJECT_ID.iam.gserviceaccount.com"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ EMAIL`	Os endereços de email das contas de serviço para as contas de serviço Google (GSAs) que tem de fornecer se estiver a usar a federação de identidades da carga de trabalho para o GKE. Estas são as contas de serviço que criou no Passo 4: crie contas de serviço. Pode encontrar os endereços de email das contas de serviço com o seguinte comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee" Consulte: `envs[].gsa.synchronizer`. `envs[].gsa.runtime`. `envs[].gsa.udca`. `logger.gsa`. `connectAgent.gsa`. `mart.gsa`. `metrics.gsa`. `mintTaskScheduler.gsa`. `udca.serviceAccountRef`. `watcher.gsa`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: true

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  gsa:
    synchronizer: "apigee-synchronizer@my-project.iam.gserviceaccount.com"
    runtime: "apigee-runtime@my-project.iam.gserviceaccount.com"
    udca: "apigee-udca@my-project.iam.gserviceaccount.com"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  gsa: "apigee-mart@my-project.iam.gserviceaccount.com"

connectAgent:
  gsa: "apigee-mart@my-project.iam.gserviceaccount.com"

logger:
  enabled: true
  gsa: "apigee-logger@my-project.iam.gserviceaccount.com"

metrics:
  gsa: "apigee-metrics@my-project.iam.gserviceaccount.com"

udca:
  gsa: "apigee-udca@my-project.iam.gserviceaccount.com"

watcher:
  gsa: "apigee-watcher@my-project.iam.gserviceaccount.com"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: my-project-apigee-mint-task-scheduler.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ SERVICE_ACCOUNT_ EMAIL`	Os endereços de email das contas de serviço para as contas de serviço Google (GSAs) que tem de fornecer se estiver a usar a federação de identidades da carga de trabalho para o GKE. Estas são as contas de serviço que criou no Passo 4: crie contas de serviço. Pode encontrar os endereços de email das contas de serviço com o seguinte comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee" Consulte: `envs[].gsa.synchronizer`. `envs[].gsa.runtime`. `envs[].gsa.udca`. `logger.gsa`. `connectAgent.gsa`. `mart.gsa`. `metrics.gsa`. `mintTaskScheduler.gsa`. `udca.serviceAccountRef`. `watcher.gsa`.

Não prod

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: true
    gsa: "NON_PROD_SERVICE_ACCOUNT_EMAIL"
    # For example: "apigee-non-prod@PROJECT_ID.iam.gserviceaccount.com"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: true
    # enabled by default
    # See apigee-logger in Service accounts and roles used by hybrid components.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`NON_PROD_ SERVICE_ACCOUNT_ EMAIL`	Os endereços de email da conta de serviço para a conta de serviço Google (GSA) de não produção. Esta é a conta de serviço `apigee-non-prod` que criou no Passo 4: crie contas de serviço. Se estiver a usar a Workload Identity Federation para o GKE numa instalação não de produção, especifique o endereço de email da conta de serviço para a propriedade `gcp.workloadIdentity.gsa`. Não precisa de adicionar a propriedade `gsa` para nenhum componente individual. Pode encontrar os endereços de email das contas de serviço com o seguinte comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee" Consulte `gcp.workloadIdentity.gsa`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: true
    gsa: "apigee-non-prod@my-project.iam.gserviceaccount.com"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: true

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`NON_PROD_ SERVICE_ACCOUNT_ EMAIL`	Os endereços de email da conta de serviço para a conta de serviço Google (GSA) de não produção. Esta é a conta de serviço `apigee-non-prod` que criou no Passo 4: crie contas de serviço. Se estiver a usar a Workload Identity Federation para o GKE numa instalação não de produção, especifique o endereço de email da conta de serviço para a propriedade `gcp.workloadIdentity.gsa`. Não precisa de adicionar a propriedade `gsa` para nenhum componente individual. Pode encontrar os endereços de email das contas de serviço com o seguinte comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee" Consulte `gcp.workloadIdentity.gsa`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

WIF noutras plataformas

WIF: secrets

Produção

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretRefs:
    synchronizer: SYNCHRONIZER_WORKLOAD_IDENTITY_SECRET
      # For example: "synchronizer-workload-identity-secret"
    runtime: RUNTIME_WORKLOAD_IDENTITY_SECRET
      # For example: "runtime-workload-identity-secret"
    udca: UDCA_WORKLOAD_IDENTITY_SECRET
      # For example: "udca-workload-identity-secret"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountPath: MART_WORKLOAD_IDENTITY_SECRET
    # For example: "mart-workload-identity-secret"

connectAgent:
  serviceAccountPath: MART_WORKLOAD_IDENTITY_SECRET
    # Use the same secret for mart and connectAgent
    # For example: "mart-workload-identity-secret"

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, create a
    # Kubernetes secret for apigee-logger by following the steps
    # under Kubernetes secrets in
    # Step 5: Set up service account authentication.
    # Provide a reference to the secret with the
    # logger.serviceAccountRef property.

metrics:
  serviceAccountPath: METRICS_WORKLOAD_IDENTITY_SECRET
    # For example: "metrics-workload-identity-secret"

udca:
  serviceAccountPath: UDCA_WORKLOAD_IDENTITY_SECRET
    # For example: "udca-workload-identity-secret"

watcher:
  serviceAccountPath: WATCHER_WORKLOAD_IDENTITY_SECRET
    # For example: "watcher-workload-identity-secret"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountRef: MINT_TASK_SCHEDULER_WORKLOAD_IDENTITY_SECRET
    # For example: "apigee-mint-task-scheduler-workload-identity-secret"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`AUDIENCE`	O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo `audience:` . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais. Por exemplo, no seguinte ficheiro `apigee-udca-credential-configuration.json` de amostra: { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha): "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Dica: pode eliminar os ficheiros de configuração das credenciais depois de copiar o valor do público-alvo. Consulte `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ WORKLOAD_IDENTITY_ SECRET`	O nome do segredo do Kubernetes que usou para a configuração das credenciais da conta de serviço no Passo 5: configure a autenticação da conta de serviço. Os nomes predefinidos dos segredos sugeridos neste guia são: Produção `cassandra-workload-identity-secret` `logger-workload-identity-secret` `mart-workload-identity-secret` `metrics-workload-identity-secret` `mint-task-scheduler-workload-identity-secret` `runtime-workload-identity-secret` `synchronizer-workload-identity-secret` `udca-workload-identity-secret` `watcher-workload-identity-secret` Não prod `non-prod-workload-identity-secret` Consulte: `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountSecretRefs:
    synchronizer: "synchronizer-workload-identity-secret"
    runtime: "runtime-workload-identity-secret"
    udca: "udca-workload-identity-secret"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountRef: "mart-workload-identity-secret"

connectAgent:
  serviceAccountRef: "mart-workload-identity-secret"

logger:
  enabled: false

metrics:
  serviceAccountRef: "metrics-workload-identity-secret"

udca:
  serviceAccountRef: "udca-workload-identity-secret"

watcher:
  serviceAccountRef: "watcher-workload-identity-secret"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountRef: "apigee-mint-task-scheduler-workload-identity-secret"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`AUDIENCE`	O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo `audience:` . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais. Por exemplo, no seguinte ficheiro `apigee-udca-credential-configuration.json` de amostra: { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha): "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Dica: pode eliminar os ficheiros de configuração das credenciais depois de copiar o valor do público-alvo. Consulte `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ WORKLOAD_IDENTITY_ SECRET`	O nome do segredo do Kubernetes que usou para a configuração das credenciais da conta de serviço no Passo 5: configure a autenticação da conta de serviço. Os nomes predefinidos dos segredos sugeridos neste guia são: Produção `cassandra-workload-identity-secret` `logger-workload-identity-secret` `mart-workload-identity-secret` `metrics-workload-identity-secret` `mint-task-scheduler-workload-identity-secret` `runtime-workload-identity-secret` `synchronizer-workload-identity-secret` `udca-workload-identity-secret` `watcher-workload-identity-secret` Não prod `non-prod-workload-identity-secret` Consulte: `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Não prod

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretRefs:
    synchronizer: NON_PROD_WORKLOAD_IDENTITY_SECRET
      # For example: "non-prod-workload-identity-secret"
    runtime: NON_PROD_WORKLOAD_IDENTITY_SECRET
      # For example: "non-prod-workload-identity-secret"
    udca: NON_PROD_WORKLOAD_IDENTITY_SECRET
      # For example: "non-prod-workload-identity-secret"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

connectAgent:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # Use the same secret for mart and connectAgent
    # For example: "non-prod-workload-identity-secret"

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, create a
    # Kubernetes secret for apigee-logger by following the steps
    # under Kubernetes secrets in
    # Step 5: Set up service account authentication.
    # Provide a reference to the secret with the
    # logger.serviceAccountRef property.

metrics:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

udca:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

watcher:
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET
    # For example: "non-prod-workload-identity-secret"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`AUDIENCE`	O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo `audience:` . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais. Por exemplo, no seguinte ficheiro `apigee-udca-credential-configuration.json` de amostra: { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha): "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Dica: pode eliminar os ficheiros de configuração das credenciais depois de copiar o valor do público-alvo. Consulte `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ WORKLOAD_IDENTITY_ SECRET`	O nome do segredo do Kubernetes que usou para a configuração das credenciais da conta de serviço no Passo 5: configure a autenticação da conta de serviço. Os nomes predefinidos dos segredos sugeridos neste guia são: Produção `cassandra-workload-identity-secret` `logger-workload-identity-secret` `mart-workload-identity-secret` `metrics-workload-identity-secret` `mint-task-scheduler-workload-identity-secret` `runtime-workload-identity-secret` `synchronizer-workload-identity-secret` `udca-workload-identity-secret` `watcher-workload-identity-secret` Não prod `non-prod-workload-identity-secret` Consulte: `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountSecretRefs:
    synchronizer: "non-prod-workload-identity-secret"
    runtime: "non-prod-workload-identity-secret"
    udca: "non-prod-workload-identity-secret"

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountRef: "non-prod-workload-identity-secret"

connectAgent:
  serviceAccountRef: "non-prod-workload-identity-secret"

logger:
  enabled: false

metrics:
  serviceAccountRef: "non-prod-workload-identity-secret"

udca:
  serviceAccountRef: "non-prod-workload-identity-secret"

watcher:
  serviceAccountRef: "non-prod-workload-identity-secret"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountRef: "non-prod-workload-identity-secret"

# for message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`AUDIENCE`	O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo `audience:` . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais. Por exemplo, no seguinte ficheiro `apigee-udca-credential-configuration.json` de amostra: { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha): "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Dica: pode eliminar os ficheiros de configuração das credenciais depois de copiar o valor do público-alvo. Consulte `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.
`<component>_ WORKLOAD_IDENTITY_ SECRET`	O nome do segredo do Kubernetes que usou para a configuração das credenciais da conta de serviço no Passo 5: configure a autenticação da conta de serviço. Os nomes predefinidos dos segredos sugeridos neste guia são: Produção `cassandra-workload-identity-secret` `logger-workload-identity-secret` `mart-workload-identity-secret` `metrics-workload-identity-secret` `mint-task-scheduler-workload-identity-secret` `runtime-workload-identity-secret` `synchronizer-workload-identity-secret` `udca-workload-identity-secret` `watcher-workload-identity-secret` Não prod `non-prod-workload-identity-secret` Consulte: `envs[].serviceAccountSecretRefs.synchronizer`. `envs[].serviceAccountSecretRefs.runtime`. `envs[].serviceAccountSecretRefs.udca`. `logger.serviceAccountRef`. `connectAgent.serviceAccountRef`. `mart.serviceAccountRef`. `metrics.serviceAccountRef`. `mintTaskScheduler.serviceAccountRef`. `udca.serviceAccountRef`. `watcher.serviceAccountRef`.

WIF: ficheiros

Produção

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    # Provide the path relative to the apigee-env chart directory.
    synchronizer: SYNCHRONIZER_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-synchronizer-credential-configuration.json"
    runtime: RUNTIME_SERVICE_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-runtime-credential-configuration.json"
    udca: UDCA_SERVICE_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-udca-credential-configuration.json"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE installations.
    # Set to true  for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift
    # installations. See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountPath: MART_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-mart-credential-configuration.json"

connectAgent:
  serviceAccountPath: MART_CREDENTIAL_CONFIGURATION_FILEPATH
    # Use the same service account for mart and connectAgent
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-mart-credential-configuration.json"

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, provide
    # the path to the apigee-logger service account key file with
    # the logger.serviceAccountPath property.

metrics:
  serviceAccountPath: METRICS_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-metrics-credential-configuration.json"

udca:
  serviceAccountPath: UDCA_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-udca-credential-configuration.json"

watcher:
  serviceAccountPath: WATCHER_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-watcher-credential-configuration.json"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountPath: MINT_TASK_SCHEDULER_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-mint-task-scheduler-credential-configuration.json"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável Descrição

UNIQUE_INSTANCE_ IDENTIFIER

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

Pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes.

Consulte instanceID.

APIGEE_NAMESPACE

O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid.

O valor predefinido é apigee.

Consulte namespace.

PROJECT_ID

Identifica o projeto do Google Cloud onde o apigee-logger e o apigee-metrics enviam os respetivos dados. Este é o valor atribuído à variável de ambiente PROJECT_ID.

Consulte gcp.projectID.

ANALYTICS_REGION

Este é o valor que atribuiu anteriormente à variável de ambiente ANALYTICS_REGION.

Consulte gcp.region.

AUDIENCE

O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo audience: . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais.

Por exemplo, no seguinte ficheiro apigee-udca-credential-configuration.json de amostra:

{
  "universe_domain": "googleapis.com",
  "type": "external_account:,"
  "audience": "AUDIENCE",
  "subject_token_type": "TOKEN_TYPE",
  "token_url": "TOKEN_URL",
  "service
  "impersonation_url": "IMPERSONATION_URL",
  "credential_source": {
    "file": "FILE_PATH",
    "format": {
      "type": "text"
    }
  }
}

O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha):

"//iam.googleapis.com/projects/123456789012/
locations/global/workloadIdentityPools/
POOL_ID/providers/WORKLOAD_PROVIDER_ID"

Consulte gcp.federatedWorkloadIdentity.audience.

CLUSTER_NAME

O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente CLUSTER_NAME.

Consulte k8sCluster.name.

CLUSTER_LOCATION

A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster.

Este é o valor que atribuiu anteriormente à variável de ambiente CLUSTER_LOCATION.

Consulte k8sCluster.location.

ORG_NAME

O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente ORG_NAME.

Consulte org.

CONTROL_PLANE_ LOCATION

Consulte contractProvider.

ENVIRONMENT_NAME

Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes.

Consulte envs[].name.

ENVIRONMENT_GROUP_ NAME

Consulte virtualhosts[].name.

INGRESS_NAME

O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos:

Ter um comprimento máximo de 17 carateres
Contêm apenas carateres alfanuméricos minúsculos, "-" ou "."
Começar com um caráter alfanumérico
Terminar com um caráter alfanumérico

Consulte:

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consulte:

SVC_ANNOTATIONS_ KEY: SVC_ANNOTATIONS_ VALUE

As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas.

Comente ou elimine esta secção se não a estiver a usar.

Consulte ingressGateways[].svcAnnotations.

<component>_ CREDENTIAL_ CONFIGURATION_ FILEPATH

O caminho e o nome de ficheiro da conta dos ficheiros de configuração de credenciais que criou no Passo 5: configure a autenticação da conta de serviço.

Indique os nomes com o caminho relativo ao diretório do gráfico. Por exemplo:

Se o ficheiro apigee-synchronizer-credential-configuration.json residir no diretório de gráficos apigee-env/, só tem de indicar o nome do ficheiro, como:
```
synchronizer:  "FILE_NAME.json"
```
Se o ficheiro residir num diretório apigee-env/service-accounts/, especifica um caminho relativo:
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Os nomes predefinidos dos diretórios de gráficos correspondentes para as contas de serviço são:

Produção

Nome do ficheiro da conta de serviço	Diretório de gráficos
`apigee-cassandra-credential-configuration.json`	`apigee-datastore/`
`apigee-logger-credential-configuration.json`	`apigee-telemetry/`
`apigee-mart-credential-configuration.json`	`apigee-org/`
`apigee-metrics-credential-configuration.json`	`apigee-telemetry/`
`apigee-mint-task-scheduler-credential-configuration.json`	`apigee-org/`
`apigee-runtime-credential-configuration.json`	`apigee-env/`
`apigee-synchronizer-credential-configuration.json`	`apigee-env/`
`apigee-udca-credential-configuration.json`	`apigee-org/`
`apigee-watcher-credential-configuration.json`	`apigee-org/`

Não prod

Nome do ficheiro da conta de serviço	Diretório de gráficos
`apigee-non-prod-credential-configuration.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Nota: ambos os produtos mart e connectAgent usam a conta de serviço apigee-mart.

Consulte:

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountPaths:
    synchronizer: "apigee-synchronizer-credential-configuration.json"
    runtime: "apigee-runtime-credential-configuration.json"
    udca: "apigee-udca-credential-configuration.json"

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountPath: "apigee-mart-credential-configuration.json"

connectAgent:
  serviceAccountPath: "apigee-mart-credential-configuration.json"

logger:
  enabled: false

metrics:
  serviceAccountPath: "apigee-metrics-credential-configuration.json"

udca:
  serviceAccountPath: "apigee-udca-credential-configuration.json"

watcher:
  serviceAccountPath: "apigee-watcher-credential-configuration.json"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: apigee-mint-task-scheduler-credential-configuration.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável Descrição

UNIQUE_INSTANCE_ IDENTIFIER

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

Pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes.

Consulte instanceID.

APIGEE_NAMESPACE

O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid.

O valor predefinido é apigee.

Consulte namespace.

PROJECT_ID

Identifica o projeto do Google Cloud onde o apigee-logger e o apigee-metrics enviam os respetivos dados. Este é o valor atribuído à variável de ambiente PROJECT_ID.

Consulte gcp.projectID.

ANALYTICS_REGION

Este é o valor que atribuiu anteriormente à variável de ambiente ANALYTICS_REGION.

Consulte gcp.region.

AUDIENCE

Por exemplo, no seguinte ficheiro apigee-udca-credential-configuration.json de amostra:

{
  "universe_domain": "googleapis.com",
  "type": "external_account:,"
  "audience": "AUDIENCE",
  "subject_token_type": "TOKEN_TYPE",
  "token_url": "TOKEN_URL",
  "service
  "impersonation_url": "IMPERSONATION_URL",
  "credential_source": {
    "file": "FILE_PATH",
    "format": {
      "type": "text"
    }
  }
}

O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha):

"//iam.googleapis.com/projects/123456789012/
locations/global/workloadIdentityPools/
POOL_ID/providers/WORKLOAD_PROVIDER_ID"

Consulte gcp.federatedWorkloadIdentity.audience.

CLUSTER_NAME

O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente CLUSTER_NAME.

Consulte k8sCluster.name.

CLUSTER_LOCATION

A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster.

Este é o valor que atribuiu anteriormente à variável de ambiente CLUSTER_LOCATION.

Consulte k8sCluster.location.

ORG_NAME

O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente ORG_NAME.

Consulte org.

CONTROL_PLANE_ LOCATION

Consulte contractProvider.

ENVIRONMENT_NAME

Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes.

Consulte envs[].name.

ENVIRONMENT_GROUP_ NAME

Consulte virtualhosts[].name.

INGRESS_NAME

O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos:

Ter um comprimento máximo de 17 carateres
Contêm apenas carateres alfanuméricos minúsculos, "-" ou "."
Começar com um caráter alfanumérico
Terminar com um caráter alfanumérico

Consulte:

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consulte:

SVC_ANNOTATIONS_ KEY: SVC_ANNOTATIONS_ VALUE

As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas.

Comente ou elimine esta secção se não a estiver a usar.

Consulte ingressGateways[].svcAnnotations.

<component>_ CREDENTIAL_ CONFIGURATION_ FILEPATH

O caminho e o nome de ficheiro da conta dos ficheiros de configuração de credenciais que criou no Passo 5: configure a autenticação da conta de serviço.

Indique os nomes com o caminho relativo ao diretório do gráfico. Por exemplo:

Se o ficheiro apigee-synchronizer-credential-configuration.json residir no diretório de gráficos apigee-env/, só tem de indicar o nome do ficheiro, como:
```
synchronizer:  "FILE_NAME.json"
```
Se o ficheiro residir num diretório apigee-env/service-accounts/, especifica um caminho relativo:
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Os nomes predefinidos dos diretórios de gráficos correspondentes para as contas de serviço são:

Produção

Nome do ficheiro da conta de serviço	Diretório de gráficos
`apigee-cassandra-credential-configuration.json`	`apigee-datastore/`
`apigee-logger-credential-configuration.json`	`apigee-telemetry/`
`apigee-mart-credential-configuration.json`	`apigee-org/`
`apigee-metrics-credential-configuration.json`	`apigee-telemetry/`
`apigee-mint-task-scheduler-credential-configuration.json`	`apigee-org/`
`apigee-runtime-credential-configuration.json`	`apigee-env/`
`apigee-synchronizer-credential-configuration.json`	`apigee-env/`
`apigee-udca-credential-configuration.json`	`apigee-org/`
`apigee-watcher-credential-configuration.json`	`apigee-org/`

Não prod

Nome do ficheiro da conta de serviço	Diretório de gráficos
`apigee-non-prod-credential-configuration.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Nota: ambos os produtos mart e connectAgent usam a conta de serviço apigee-mart.

Consulte:

Não prod

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    # Provide the path relative to the apigee-env chart directory.
    synchronizer: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-non-prod-credential-configuration.json"
    runtime: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-non-prod-credential-configuration.json"
    udca: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
      # For example: "apigee-non-prod-credential-configuration.json"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

mart:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

connectAgent:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Use the same service account for mart and connectAgent
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, provide
    # the path to the apigee-non-prod service account key file with
    # the logger.serviceAccountPath property.

metrics:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

udca:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

watcher:
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-telemetry chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

mintTaskScheduler: # Required for Monetization for Apigee hybrid
  serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH
    # Provide the path relative to the apigee-org chart directory.
    # For example: "apigee-non-prod-credential-configuration.json"

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável Descrição

UNIQUE_INSTANCE_ IDENTIFIER

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

Pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes.

Consulte instanceID.

APIGEE_NAMESPACE

O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid.

O valor predefinido é apigee.

Consulte namespace.

PROJECT_ID

Identifica o projeto do Google Cloud onde o apigee-logger e o apigee-metrics enviam os respetivos dados. Este é o valor atribuído à variável de ambiente PROJECT_ID.

Consulte gcp.projectID.

ANALYTICS_REGION

Este é o valor que atribuiu anteriormente à variável de ambiente ANALYTICS_REGION.

Consulte gcp.region.

AUDIENCE

Por exemplo, no seguinte ficheiro apigee-udca-credential-configuration.json de amostra:

{
  "universe_domain": "googleapis.com",
  "type": "external_account:,"
  "audience": "AUDIENCE",
  "subject_token_type": "TOKEN_TYPE",
  "token_url": "TOKEN_URL",
  "service
  "impersonation_url": "IMPERSONATION_URL",
  "credential_source": {
    "file": "FILE_PATH",
    "format": {
      "type": "text"
    }
  }
}

O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha):

"//iam.googleapis.com/projects/123456789012/
locations/global/workloadIdentityPools/
POOL_ID/providers/WORKLOAD_PROVIDER_ID"

Consulte gcp.federatedWorkloadIdentity.audience.

CLUSTER_NAME

O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente CLUSTER_NAME.

Consulte k8sCluster.name.

CLUSTER_LOCATION

A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster.

Este é o valor que atribuiu anteriormente à variável de ambiente CLUSTER_LOCATION.

Consulte k8sCluster.location.

ORG_NAME

O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente ORG_NAME.

Consulte org.

CONTROL_PLANE_ LOCATION

Consulte contractProvider.

ENVIRONMENT_NAME

Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes.

Consulte envs[].name.

ENVIRONMENT_GROUP_ NAME

Consulte virtualhosts[].name.

INGRESS_NAME

O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos:

Ter um comprimento máximo de 17 carateres
Contêm apenas carateres alfanuméricos minúsculos, "-" ou "."
Começar com um caráter alfanumérico
Terminar com um caráter alfanumérico

Consulte:

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consulte:

SVC_ANNOTATIONS_ KEY: SVC_ANNOTATIONS_ VALUE

As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas.

Comente ou elimine esta secção se não a estiver a usar.

Consulte ingressGateways[].svcAnnotations.

<component>_ CREDENTIAL_ CONFIGURATION_ FILEPATH

O caminho e o nome de ficheiro da conta dos ficheiros de configuração de credenciais que criou no Passo 5: configure a autenticação da conta de serviço.

Indique os nomes com o caminho relativo ao diretório do gráfico. Por exemplo:

Se o ficheiro apigee-synchronizer-credential-configuration.json residir no diretório de gráficos apigee-env/, só tem de indicar o nome do ficheiro, como:
```
synchronizer:  "FILE_NAME.json"
```
Se o ficheiro residir num diretório apigee-env/service-accounts/, especifica um caminho relativo:
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Os nomes predefinidos dos diretórios de gráficos correspondentes para as contas de serviço são:

Produção

Nome do ficheiro da conta de serviço	Diretório de gráficos
`apigee-cassandra-credential-configuration.json`	`apigee-datastore/`
`apigee-logger-credential-configuration.json`	`apigee-telemetry/`
`apigee-mart-credential-configuration.json`	`apigee-org/`
`apigee-metrics-credential-configuration.json`	`apigee-telemetry/`
`apigee-mint-task-scheduler-credential-configuration.json`	`apigee-org/`
`apigee-runtime-credential-configuration.json`	`apigee-env/`
`apigee-synchronizer-credential-configuration.json`	`apigee-env/`
`apigee-udca-credential-configuration.json`	`apigee-org/`
`apigee-watcher-credential-configuration.json`	`apigee-org/`

Não prod

Nome do ficheiro da conta de serviço	Diretório de gráficos
`apigee-non-prod-credential-configuration.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Nota: ambos os produtos mart e connectAgent usam a conta de serviço apigee-mart.

Consulte:

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountPaths:
    synchronizer: "apigee-non-prod-credential-configuration.json"
    runtime: "apigee-non-prod-credential-configuration.json<"
    udca: "apigee-non-prod-credential-configuration.json"

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

mart:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

connectAgent:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

logger:
  enabled: false

metrics:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

udca:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

watcher:
  serviceAccountPath: "apigee-non-prod-credential-configuration.json"

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

mintTaskScheduler:
  serviceAccountPath: apigee-non-prod-credential-configuration.json"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável Descrição

UNIQUE_INSTANCE_ IDENTIFIER

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

Pode criar várias organizações no mesmo cluster, mas o instanceID tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes.

Consulte instanceID.

APIGEE_NAMESPACE

O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid.

O valor predefinido é apigee.

Consulte namespace.

PROJECT_ID

Identifica o projeto do Google Cloud onde o apigee-logger e o apigee-metrics enviam os respetivos dados. Este é o valor atribuído à variável de ambiente PROJECT_ID.

Consulte gcp.projectID.

ANALYTICS_REGION

Este é o valor que atribuiu anteriormente à variável de ambiente ANALYTICS_REGION.

Consulte gcp.region.

AUDIENCE

Por exemplo, no seguinte ficheiro apigee-udca-credential-configuration.json de amostra:

{
  "universe_domain": "googleapis.com",
  "type": "external_account:,"
  "audience": "AUDIENCE",
  "subject_token_type": "TOKEN_TYPE",
  "token_url": "TOKEN_URL",
  "service
  "impersonation_url": "IMPERSONATION_URL",
  "credential_source": {
    "file": "FILE_PATH",
    "format": {
      "type": "text"
    }
  }
}

O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha):

"//iam.googleapis.com/projects/123456789012/
locations/global/workloadIdentityPools/
POOL_ID/providers/WORKLOAD_PROVIDER_ID"

Consulte gcp.federatedWorkloadIdentity.audience.

CLUSTER_NAME

O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente CLUSTER_NAME.

Consulte k8sCluster.name.

CLUSTER_LOCATION

A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster.

Este é o valor que atribuiu anteriormente à variável de ambiente CLUSTER_LOCATION.

Consulte k8sCluster.location.

ORG_NAME

O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente ORG_NAME.

Consulte org.

CONTROL_PLANE_ LOCATION

Consulte contractProvider.

ENVIRONMENT_NAME

Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes.

Consulte envs[].name.

ENVIRONMENT_GROUP_ NAME

Consulte virtualhosts[].name.

INGRESS_NAME

O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos:

Ter um comprimento máximo de 17 carateres
Contêm apenas carateres alfanuméricos minúsculos, "-" ou "."
Começar com um caráter alfanumérico
Terminar com um caráter alfanumérico

Consulte:

PATH_TO_CERT_FILE
PATH_TO_KEY_FILE

sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key

Consulte:

SVC_ANNOTATIONS_ KEY: SVC_ANNOTATIONS_ VALUE

As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas.

Comente ou elimine esta secção se não a estiver a usar.

Consulte ingressGateways[].svcAnnotations.

<component>_ CREDENTIAL_ CONFIGURATION_ FILEPATH

O caminho e o nome de ficheiro da conta dos ficheiros de configuração de credenciais que criou no Passo 5: configure a autenticação da conta de serviço.

Indique os nomes com o caminho relativo ao diretório do gráfico. Por exemplo:

Se o ficheiro apigee-synchronizer-credential-configuration.json residir no diretório de gráficos apigee-env/, só tem de indicar o nome do ficheiro, como:
```
synchronizer:  "FILE_NAME.json"
```
Se o ficheiro residir num diretório apigee-env/service-accounts/, especifica um caminho relativo:
```
synchronizer:  "service-accounts/FILE_NAME.json"
```

Os nomes predefinidos dos diretórios de gráficos correspondentes para as contas de serviço são:

Produção

Nome do ficheiro da conta de serviço	Diretório de gráficos
`apigee-cassandra-credential-configuration.json`	`apigee-datastore/`
`apigee-logger-credential-configuration.json`	`apigee-telemetry/`
`apigee-mart-credential-configuration.json`	`apigee-org/`
`apigee-metrics-credential-configuration.json`	`apigee-telemetry/`
`apigee-mint-task-scheduler-credential-configuration.json`	`apigee-org/`
`apigee-runtime-credential-configuration.json`	`apigee-env/`
`apigee-synchronizer-credential-configuration.json`	`apigee-env/`
`apigee-udca-credential-configuration.json`	`apigee-org/`
`apigee-watcher-credential-configuration.json`	`apigee-org/`

Não prod

Nome do ficheiro da conta de serviço	Diretório de gráficos
`apigee-non-prod-credential-configuration.json`	`apigee-datastore/` `apigee-org/` `apigee-telemetry/`

Nota: ambos os produtos mart e connectAgent usam a conta de serviço apigee-mart.

Consulte:

WIF: Vault

Produção

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 3
    # Use multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, add
    # a "logger" : "value" entry in the orgsakeys vault secret
    # using the contents of the apigee-logger key file for the
    # value. See Step 5: Set up service account authentication.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`AUDIENCE`	O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo `audience:` . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais. Por exemplo, no seguinte ficheiro `apigee-udca-credential-configuration.json` de amostra: { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha): "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Dica: pode eliminar os ficheiros de configuração das credenciais depois de copiar o valor do público-alvo. Consulte `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

enhanceProxyLimits: true

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

envs:
- name: prod-env
  serviceAccountSecretProviderClass: apigee-envsakeys-prod-env-spc

cassandra:
  hostNetwork: false
  replicaCount: 3
  storage:
    storageSize: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: false

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# For message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`AUDIENCE`	O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo `audience:` . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais. Por exemplo, no seguinte ficheiro `apigee-udca-credential-configuration.json` de amostra: { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha): "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Dica: pode eliminar os ficheiros de configuração das credenciais depois de copiar o valor do público-alvo. Consulte `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

Não prod

Modelo

Os valores em red, bold italics são valores de propriedades que tem de fornecer. Pode editar os respetivos valores nesta página. Estão descritos na tabela abaixo.

instanceID: UNIQUE_INSTANCE_IDENTIFIER
namespace: APIGEE_NAMESPACE # Usually "apigee"

gcp:
  projectID: PROJECT_ID
  region: ANALYTICS_REGION
  workloadIdentity:
    enabled: false # Must be set to false to use
      # Workload Identity Federation on other platforms.
  federatedWorkloadIdentity:
    enabled: true
    audience: "AUDIENCE"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster.

org: ORG_NAME

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

# Required for Enhanced per-environment proxy limits:
enhanceProxyLimits: true

# Required if using data residency with hybrid:
contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

envs:
- name: ENVIRONMENT_NAME
  serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc

cassandra:
  hostNetwork: false
    # Set to false for single region installations and  for multi-region
    # installations with connectivity between pods in different clusters,
    # like GKE.
    # Set to true for multi-region installations with no communication
    # between pods in different clusters, for example Google Distributed
    # Cloud on VMware or bare metal, GKE on AWS, AKS, EKS, and OpenShift.
    # See Multi-region deployment: Prerequisites
  replicaCount: 1
    # Use 1 for non-prod installations and multiples of 3 for production.
    # See Configure Cassandra for production for guidelines.

ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: PATH_TO_CERT_FILE
  sslKeyPath: PATH_TO_KEY_FILE

logger:
  enabled: false
    # apigee-logger does not support Workload Identity Federation.
    # See Known issue #341099433.
    # If you want to enable the apigee-logger component, add
    # a "logger" : "value" entry in the orgsakeys vault secret
    # using the contents of the apigee-non-prod key file for the
    # value. See Step 5: Set up service account authentication.

# Required if using Monetization for Apigee hybrid (v1.15.1 and later)
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1" # Must be 1.15.1 or higher.

# If using message payloads larger than 10MB.
# See configure large message payload support:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`AUDIENCE`	O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo `audience:` . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais. Por exemplo, no seguinte ficheiro `apigee-udca-credential-configuration.json` de amostra: { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha): "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Dica: pode eliminar os ficheiros de configuração das credenciais depois de copiar o valor do público-alvo. Consulte `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

Exemplo

instanceID: "my_hybrid_example"
namespace: "apigee"

gcp:
  projectID: my-project
  region: us-central1
  workloadIdentity:
    enabled: false
  federatedWorkloadIdentity:
    enabled: true
    audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider"
    credentialSourceFile: "/var/run/service-account/token"

k8sCluster:
  name: hybrid-env
  region: us-central1

org: my-project

serviceAccountSecretProviderClass: apigee-orgsakeys-spc

enhanceProxyLimits: true

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

envs:
- name: test
  serviceAccountSecretProviderClass: apigee-envsakeys-test-env-spc

cassandra:
  hostNetwork: false
  replicaCount: 1

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: certs/keystore.pem
  sslKeyPath: certs/keystore.key

logger:
  enabled: false

# Monetization for Apigee hybrid
runtime:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-runtime"
    tag: "1.15.1"

# for message payloads larger than 10MB:
runtime:
  cwcAppend:
    bin_setenv_max_mem: 4096m   # Increase max heap size to 4 gigs
  resources:
    requests:
      memory: 4Gi
    limits:
      memory: 6Gi

A tabela seguinte descreve cada um dos valores das propriedades que tem de indicar no ficheiro de substituições. Para mais informações, consulte a referência da propriedade de configuração.

Variável	Descrição
`UNIQUE_INSTANCE_ IDENTIFIER`	Uma string exclusiva para identificar esta instância. Pode ser qualquer combinação de letras e números até 63 carateres. Nota: pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Para instalações em várias regiões, cada região requer o seu próprio cluster (os clusters individuais não abrangem regiões). Pode criar várias organizações no mesmo cluster, mas o `instanceID` tem de ser o mesmo para todas as organizações no mesmo cluster do Kubernetes. Consulte `instanceID`.
`APIGEE_NAMESPACE`	O espaço de nomes do Kubernetes para os seus componentes do Apigee Hybrid. O valor predefinido é `apigee`. Consulte `namespace`.
`PROJECT_ID`	Identifica o projeto do Google Cloud onde o `apigee-logger` e o `apigee-metrics` enviam os respetivos dados. Este é o valor atribuído à variável de ambiente `PROJECT_ID`. Consulte `gcp.projectID`.
`ANALYTICS_REGION`	No GKE, tem de definir este valor para a mesma região onde o cluster está a ser executado. Em todas as outras plataformas, selecione a região de estatísticas mais próxima do seu cluster que tenha suporte do Analytics (consulte a tabela na Parte 1, Passo 2: crie uma organização). Este é o valor que atribuiu anteriormente à variável de ambiente `ANALYTICS_REGION`. Consulte `gcp.region`.
`AUDIENCE`	O público-alvo permitido do fornecedor de identidade de carga de trabalho. Pode encontrar o valor pesquisando qualquer um dos ficheiros de configuração de credenciais pelo termo `audience:` . O valor do público-alvo é o mesmo em cada ficheiro de configuração de credenciais. Por exemplo, no seguinte ficheiro `apigee-udca-credential-configuration.json` de amostra: { "universe_domain": "googleapis.com", "type": "external_account:," "audience": "`AUDIENCE`", "subject_token_type": "`TOKEN_TYPE`", "token_url": "`TOKEN_URL`", "service "impersonation_url": "`IMPERSONATION_URL`", "credential_source": { "file": "`FILE_PATH`", "format": { "type": "text" } } } O valor do público-alvo tem um aspeto semelhante ao seguinte (sem quebras de linha): "//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID" Dica: pode eliminar os ficheiros de configuração das credenciais depois de copiar o valor do público-alvo. Consulte `gcp.federatedWorkloadIdentity.audience`.
`CLUSTER_NAME`	O nome do cluster do Kubernetes. Este é o valor atribuído à variável de ambiente `CLUSTER_NAME`. Consulte `k8sCluster.name`.
`CLUSTER_LOCATION`	A região onde o cluster está a ser executado. Esta é a região onde criou o cluster no Passo 1: crie um cluster. Este é o valor que atribuiu anteriormente à variável de ambiente `CLUSTER_LOCATION`. Se estiver a trabalhar com clusters zonais, tem de especificar a região na qual o cluster foi criado. Por exemplo, se criou o cluster na zona `us-central1-a`, especifique `us-central1` para o `CLUSTER_LOCATION`. Consulte `k8sCluster.location`.
`ORG_NAME`	O ID da sua organização híbrida do Apigee. Este é o valor atribuído à variável de ambiente `ORG_NAME`. Consulte `org`.
`CONTROL_PLANE_ LOCATION`	Obrigatório se estiver a usar a residência de dados com a instalação híbrida do Apigee. Esta é a localização onde o conteúdo principal do cliente, como pacotes de proxy, é armazenado. Para ver uma lista, consulte o artigo Regiões do plano de controlo da API Apigee disponíveis. É o valor atribuído à variável de ambiente `CONTROL_PLANE_LOCATION` no passo 2: crie uma organização. Consulte `contractProvider`.
`ENVIRONMENT_NAME`	Use o mesmo nome que usou quando criou um ambiente na IU, conforme explicado em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Consulte `envs[].name`.
`ENVIRONMENT_GROUP_ NAME`	O nome do grupo de ambientes ao qual os seus ambientes estão atribuídos. Este é o grupo que criou em Configuração do projeto e da organização – Passo 3: crie um grupo de ambientes. Este é o valor atribuído à variável de ambiente `ENV_GROUP`. Nota: se quiser colocar instâncias de cluster em várias regiões, tem de ter cuidado com a forma como define os seus ambientes e anfitriões virtuais. Se tiver um ou mais ambientes anexados a um grupo de ambientes, tem de incluir essa mesma configuração do grupo de ambientes no ficheiro de substituições de cada instância do cluster. Consulte `virtualhosts[].name`.
`INGRESS_NAME`	O nome da gateway de entrada do Apigee para a sua implementação. Pode ser qualquer nome que cumpra os seguintes requisitos: Ter um comprimento máximo de 17 carateres Contêm apenas carateres alfanuméricos minúsculos, "-" ou "." Começar com um caráter alfanumérico Terminar com um caráter alfanumérico Consulte: `ingressGateways[].name`. `virtualhosts[].selector`
`PATH_TO_CERT_FILE` `PATH_TO_KEY_FILE`	Introduza o caminho e o nome do ficheiro da chave TLS autoassinada e dos ficheiros de certificado que gerou anteriormente no Passo 6: crie certificados TLS. Estes ficheiros têm de estar localizados no diretório `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs`. Por exemplo: sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key Consulte: `virtualhosts[].sslCertPath`. `virtualhosts[].sslKeyPath`
`SVC_ANNOTATIONS_ KEY`: `SVC_ANNOTATIONS_ VALUE`	(Opcional). Este é um par de chave-valor que fornece anotações para o seu serviço de entrada predefinido. A sua plataforma na nuvem usa anotações para ajudar a configurar a sua instalação híbrida, por exemplo, definindo o tipo de balanceador de carga como interno ou externo. As anotações variam de plataforma para plataforma. Consulte a documentação da plataforma para ver as anotações obrigatórias e sugeridas. Nota: não precisa de definir `svcAnnotations` se estiver a criar o seu próprio serviço Kubernetes para a implementação de entrada, conforme documentado no artigo Exponha o gateway de entrada do Apigee. Comente ou elimine esta secção se não a estiver a usar. Consulte `ingressGateways[].svcAnnotations`.

Resumo

O ficheiro de configuração indica ao Kubernetes como implementar os componentes híbridos num cluster. Em seguida, vai ativar o acesso do sincronizador para que os planos de gestão e de tempo de execução do Apigee possam comunicar.

Passo seguinte

1 2 3 4 5 6 7 (NEXT) Passo 8: ative o acesso ao plano de controlo 9 10 11

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

Especifique substituições de configuração

Antes de começar

Configure o cluster

Segredos do Kubernetes

Produção

Modelo

Produção

Não prod

Exemplo

Produção

Não prod

Não prod

Modelo

Produção

Não prod

Exemplo

Produção

Não prod

Ficheiros JSON

Produção

Modelo

Produção

Não prod

Exemplo

Produção

Não prod

Não prod

Modelo

Produção

Não prod

Exemplo

Produção

Não prod

Vault

Produção

Modelo

Exemplo

Não prod

Modelo

Exemplo

WIF para o GKE

Produção

Modelo

Exemplo

Não prod

Modelo

Exemplo

WIF noutras plataformas

WIF: secrets

Produção

Modelo

Produção

Não prod

Exemplo

Produção

Não prod

Não prod

Modelo

Produção

Não prod

Exemplo

Produção

Não prod

WIF: ficheiros

Produção

Modelo

Produção

Não prod

Exemplo

Produção

Não prod

Não prod

Modelo

Produção

Não prod

Exemplo

Produção

Não prod

WIF: Vault

Passo 7: crie as substituições