O instalador híbrido da Apigee usa padrões para muitas configurações. No entanto, existem algumas configurações
sem padrões. É preciso fornecer valores para essas configurações, conforme explicado a seguir.
Verifique se você está no diretório hybrid-base-directory/hybrid-files/overrides/.
cd hybrid-base-directory/hybrid-files/overrides
Crie um novo arquivo chamado overrides.yaml em seu editor de texto favorito. Por exemplo:
vi overrides.yaml
O overrides.yaml fornece a configuração para sua instalação híbrida exclusiva
da Apigee. O arquivo de modificações nesta etapa fornece uma configuração básica para uma instalação de tempo de execução híbrido
de pouco espaço, adequada para sua primeira instalação.
Em overrides.yaml, adicione os valores de propriedade obrigatórios, mostrados abaixo. Veja abaixo
uma descrição detalhada de cada propriedade:
Sintaxe
Verifique se o arquivo overrides.yaml tem a seguinte estrutura e sintaxe:
Os valores em red, bold italics são
valores de propriedade que você precisa fornecer. Eles estão descritos na tabela abaixo.
gcp:
region: analytics-region # Choose the closest Google Cloud region to your cluster.
projectID: gcp-project-id
k8sCluster:
name: cluster-name
region: analytics-region # Choose the closest Google Cloud region to your cluster.
org: org-name
instanceID: "unique-instance-identifier"
cassandra:
hostNetwork: true #Set this to `false` for platforms other than GKE On-prem.
virtualhosts:
- name: environment-group-name
sslCertPath: ./certs/cert-name.pem
sslKeyPath: ./certs/key-name.key
envs:
- name: environment-name
serviceAccountPaths:
synchronizer: ./service-accounts/synchronizer-service-account-name.json
udca: ./service-accounts/udca-service-account-name.json
mart:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
connectAgent:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# Same account used for mart and connectAgent
metrics:
serviceAccountPath: ./service-accounts/metrics-service-account-name.json
watcher:
serviceAccountPath: ./service-accounts/watcher-service-account-name.json
logger:
enabled: true
serviceAccountPath: ./service-accounts/logger-service-account-name.json
Exemplo
No exemplo a seguir, mostramos um arquivo de modificações concluído com valores de propriedade de exemplo
adicionados:
A tabela a seguir descreve cada um dos valores de propriedade que você precisa fornecer no
arquivo de modificações. Para mais informações, consulte
Referência da propriedade de configuração.
Variável
Descrição
analytics-region
Defina esse valor para a mesma região em que o cluster está em execução.
Este é o valor atribuído à variável de ambiente
ANALYTICS_REGION anteriormente
durante a criação do cluster
Oapigee-logger e oapigee-metrics envia os
dados para esta região.
gcp-project-id
Identifica o projeto do Google Cloud em que apigee-logger e apigee-metrics enviam os
dados. Esse é o valor atribuído à variável de ambiente PROJECT_ID.
cluster-name
O nome do cluster do Kubernetes. Esse é o valor atribuído à variável de ambiente
CLUSTER_NAME.
org-name
É o ID da sua organização da Apigee híbrida. Esse é o valor atribuído à
variável de ambiente ORG_NAME.
unique-instance-identifier
Uma string exclusiva para identificar a instância. Pode ser qualquer combinação de letras e
números, com até 63 caracteres.
Digite o nome da chave TLS autoassinada e dos arquivos de certificado gerados anteriormente na
Etapa 3: instalar o Apigeectl.
Esses arquivos precisam estar localizados
no diretório base_directory/hybrid-files/certs. Por exemplo:
O nome da conta de serviço mart (que tem o papel do Agente do
Apigee Connect atribuído a ele) criado por você
Etapa 3: instalar o apigeectl.
O Mart e o agente do Apigee Connect usam a mesma conta de serviço.
watcher-service-account-name
O nome do arquivo JSON da conta de serviço watcher que você gerou com a
ferramenta create-service-account. Por exemplo:
O arquivo de configuração informa ao Kubernetes como implantar os componentes híbridos em
um cluster. Em seguida, você aplicará essa configuração ao cluster.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-28 UTC."],[[["\u003cp\u003eThis documentation outlines the process of setting up configuration overrides for an Apigee hybrid installation, which allows users to customize their hybrid environment beyond default settings.\u003c/p\u003e\n"],["\u003cp\u003eUsers must create an \u003ccode\u003eoverrides.yaml\u003c/code\u003e file to specify unique configuration details, including GCP project ID, cluster name, organization ID, and service account paths.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file must follow a defined syntax, and certain properties such as \u003ccode\u003egcp-project-id\u003c/code\u003e, \u003ccode\u003ecluster-name\u003c/code\u003e, and \u003ccode\u003eorg-name\u003c/code\u003e are required to be filled out correctly, to ensure the hybrid components are deployed correctly.\u003c/p\u003e\n"],["\u003cp\u003eThe document provides an example \u003ccode\u003eoverrides.yaml\u003c/code\u003e file to showcase the structure and format of property value inputs required, which includes how to correctly input service account paths, regions, and certificate information.\u003c/p\u003e\n"],["\u003cp\u003eThe document describes each property value that can be inserted into the \u003ccode\u003eoverrides.yaml\u003c/code\u003e in a detailed table, for the configuration of the Apigee Hybrid setup, and provides additional notes on security considerations using Google Cloud VPC Service Controls.\u003c/p\u003e\n"]]],[],null,["# Step 4: Configure the cluster\n\n| You are currently viewing version 1.3 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nSpecify configuration overrides\n-------------------------------\n\n\nThe Apigee hybrid installer uses defaults for many settings; however, there are a few settings\nthat do not have defaults. You must provide values for these settings, as explained next.\n\n1. Be sure you are in the \u003cvar translate=\"no\"\u003ehybrid-base-directory\u003c/var\u003e`/hybrid-files/overrides/` directory. \n\n ```\n cd hybrid-base-directory/hybrid-files/overrides\n ```\n2. Create a new file named **\u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml`** in your favorite text editor. For example: \n\n ```\n vi overrides.yaml\n ```\n\n\n The \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml` provides the configuration for your unique Apigee hybrid\n installation. The overrides file in this step provides a basic configuration for a small-footprint\n hybrid runtime installation, suitable for your first installation.\n3. In \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml`, add the required property values, shown below. A detailed description of each property is also provided below: \n\n ### Syntax\n\n Make sure the \u003cvar translate=\"no\"\u003eoverrides\u003c/var\u003e`.yaml` file has the following structure and syntax.\n Values in \u003cvar translate=\"no\"\u003ered, bold italics\u003c/var\u003e are\n property values that you must provide. They are described in the [table below](#tablebelow). \n\n ```\n\n gcp:\n region: analytics-region # Choose the closest Google Cloud region to your cluster.\n projectID: gcp-project-id\n\n k8sCluster:\n name: cluster-name\n region: analytics-region # Choose the closest Google Cloud region to your cluster.\n\n org: org-name\n\n instanceID: \"unique-instance-identifier\"\n\n cassandra:\n hostNetwork: true #Set this to `false` for platforms other than GKE On-prem.\n\n virtualhosts:\n - name: environment-group-name\n sslCertPath: ./certs/cert-name.pem\n sslKeyPath: ./certs/key-name.key\n\n envs:\n - name: environment-name\n serviceAccountPaths:\n synchronizer: ./service-accounts/synchronizer-service-account-name.json\n udca: ./service-accounts/udca-service-account-name.json\n\n mart:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # Same account used for mart and connectAgent\n\n metrics:\n serviceAccountPath: ./service-accounts/metrics-service-account-name.json\n\n watcher:\n serviceAccountPath: ./service-accounts/watcher-service-account-name.json\n\n logger:\n enabled: true\n serviceAccountPath: ./service-accounts/logger-service-account-name.json\n ```\n\n ### Example\n\n The following example shows a completed overrides file with example property values\n added: \n\n ```\n gcp:\n region: us-central1\n projectID: hybrid-example\n\n k8sCluster:\n name: apigee-hybrid\n region: us-central1\n\n org: hybrid-example\n\n instanceID: \"my_hybrid_example\"\n\n cassandra:\n hostNetwork: true #Set this to `false` for platforms other than GKE-On Prem.\n\n virtualhosts:\n - name: example-env-group\n sslCertPath: ./certs/keystore.pem\n sslKeyPath: ./certs/keystore.key\n\n envs:\n - name: test\n serviceAccountPaths:\n synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json\n udca: ./service-accounts/hybrid-project-apigee-udca.json\n\n mart:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/example-hybrid-apigee-mart.json\n\n metrics:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json\n\n watcher:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-watcher.json\n\n logger:\n enabled: true\n serviceAccountPath: ./service-accounts/logger-service-account-name.json\n\n ```\n4. When you are finished, save the file.\n\n\nThe following table describes each of the property values that you must provide in the\noverrides file. For more information, see\n[Configuration property reference](/apigee/docs/hybrid/v1.3/config-prop-ref).\n\n| **Note:** If you want to create a security perimeter around your cluster and related Cloud services, you can configure one using Google Cloud [Virtual Private Cloud (VPC) Service\n| Controls](https://cloud.google.com/vpc-service-controls) with Apigee hybrid. See [Using\n| VPC Service Controls with Apigee and Apigee hybrid](/apigee/docs/api-platform/security/vpc-sc) for instructions.\n\nSummary\n-------\n\n\nThe configuration file tells Kubernetes how to deploy the hybrid components to\na cluster. Next, you will apply this configuration to your cluster.\n[1](/apigee/docs/hybrid/v1.3/install-create-cluster-anthos) [2](/apigee/docs/hybrid/v1.3/install-download-cert-manager-istio-anthos) [3](/apigee/docs/hybrid/v1.3/install-download-install-anthos) [4](/apigee/docs/hybrid/v1.3/install-copy-overrides-anthos) [(NEXT) Step 5: Install hybrid runtime](/apigee/docs/hybrid/v1.3/install-apply-hybrid-anthos)\n\n\u003cbr /\u003e"]]
