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.
Há diferenças entre as diferentes plataformas dependendo da região do projeto do Google Cloud e
a região do cluster do Kubernetes. Escolha a plataforma em que você está instalando o Apigee híbrido.
gcp:
region: analytics-region
projectID: gcp-project-id
k8sCluster:
name: cluster-name
region: cluster-location # Must be the closest Google Cloud region to your cluster.
org: org-name
instanceID: "unique-instance-identifier"
cassandra:
hostNetwork: false
# Set to false for single region installations and multi-region installations
# with connectivity between pods in different clusters, for example GKE installations.
# Set to true for multi-region installations with no communication between
# pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,
# AKS, EKS, and OpenShift installations.
# See Multi-region deployment: Prerequisites
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
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-apigee-synchronizer.json
udca: ./service-accounts/udca-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-udca.json
mart:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-mart.json
connectAgent:
serviceAccountPath: ./service-accounts/mart-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-mart.json
# Same account used for mart and connectAgent
metrics:
serviceAccountPath: ./service-accounts/metrics-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-metrics.json
watcher:
serviceAccountPath: ./service-accounts/watcher-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-watcher.json
logger:
enabled: true # set to "false" for GKE.
serviceAccountPath: ./service-accounts/logger-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-logger.json
Exemplo
No exemplo a seguir, mostramos um arquivo de modificações concluído com valores de propriedade de exemplo
adicionados:
gcp:
region: us-central1
projectID: hybrid-example
k8sCluster:
name: apigee-hybrid
region: us-central1
org: hybrid-example
instanceID: "my_hybrid_example"
cassandra:
hostNetwork: false
virtualhosts:
- name: example-env-group
sslCertPath: ./certs/keystore.pem
sslKeyPath: ./certs/keystore.key
envs:
- name: test
serviceAccountPaths:
synchronizer: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-synchronizer.json
udca: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-udca.json
mart:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-mart.json
connectAgent:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, example-hybrid-apigee-mart.json
metrics:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-metrics.json
watcher:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-watcher.json
logger:
enabled: true # set to "false" for GKE.
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, logger-service-account-name.json
Quando terminar, salve o arquivo.
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
No GKE, defina esse valor como a mesma região em que o cluster está em execução. Em todas as
outras plataformas, selecione a região de análise mais próxima ao seu cluster que seja compatível com o
Analytics. Consulte a tabela na
Parte 1, etapa 4: criar uma organização.
Este é o valor atribuído anteriormente à variável de ambiente
ANALYTICS_REGION.
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.
cluster-location
A região em que o cluster está em execução. Esta é a região em que você criou o
cluster na Etapa 1: criar um cluster.
Este é o valor atribuído anteriormente à variável de ambiente
CLUSTER_LOCATION.
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.
É possível criar várias organizações no mesmo cluster, mas o instanceId precisa ser o mesmo para todas as organizações que estiverem no mesmo cluster do Kubernetes
Digite o nome da chave TLS autoassinado e dos arquivos de certificado gerados anteriormente na
Etapa 6: criar certificados TLS.
Esses arquivos precisam estar localizados
no diretório base_directory/hybrid-files/certs. Por exemplo:
Em ambientes de não produção, o nome da conta de serviço única,
non-prod por padrão. Para ambientes de produção, o nome do arquivo de chave da
conta de serviço apigee-synchronizer que você gerou com
a ferramenta create-service-account na
Configuração de ambiente de execução híbrido -
Etapa 6: criar contas de serviço e credenciais. É possível ver a lista de arquivos da conta de serviço
no diretório service-accounts/. Por exemplo:
ls ../service-accounts/
udca-service-account-name
Em ambientes de não produção, o nome da conta de serviço única,
non-prod por padrão. Para ambientes de produção, o nome do arquivo de chave da conta
de serviço apigee-udca que você gerou com
a ferramenta create-service-account.
mart-service-account-name
Em ambientes de não produção, o nome da conta de serviço única,
non-prod por padrão. Para ambientes de produção, o nome do arquivo de
chave da conta de serviço apigee-mart que você gerou
com a ferramenta create-service-account.
metrics-service-account-name
Em ambientes de não produção, o nome da conta de serviço única,
non-prod por padrão. Para ambientes de produção, o nome do arquivo de chave da conta
de serviço apigee-metrics que você gerou com
a ferramenta create-service-account.
watcher-service-account-name
Em ambientes de não produção, o nome da conta de serviço única,
non-prod por padrão. Para ambientes de produção, o nome do arquivo de chave da conta
de serviço apigee-watcher que você gerou com
a ferramenta create-service-account.
logger-service-account-name
Em ambientes de não produção, o nome da conta de serviço única,
non-prod por padrão. Para ambientes de produção, o nome do arquivo de
chave da conta de serviço apigee-logger que você gerou
com a ferramenta create-service-account.
Resumo
O arquivo de configuração informa ao Kubernetes como implantar os componentes híbridos em
um cluster. Em seguida, ative o acesso do sincronizador para que os planos de ambiente de execução e gerenciamento
da Apigee possam se comunicar.
[[["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 document provides instructions for configuring the \u003ccode\u003eoverrides.yaml\u003c/code\u003e file, which is essential for customizing your unique Apigee hybrid installation, using a basic setup suitable for a first-time installation.\u003c/p\u003e\n"],["\u003cp\u003eYou must navigate to the \u003ccode\u003ehybrid-base-directory/hybrid-files/overrides\u003c/code\u003e directory and create an \u003ccode\u003eoverrides.yaml\u003c/code\u003e file to specify required properties like \u003ccode\u003egcp\u003c/code\u003e, \u003ccode\u003ek8sCluster\u003c/code\u003e, \u003ccode\u003eorg\u003c/code\u003e, and others to enable a functional Apigee hybrid environment.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file uses a specific syntax, including defining values for regions, project IDs, cluster names, organization names, and unique instance identifiers, along with service account paths and virtual host details, that must be specified.\u003c/p\u003e\n"],["\u003cp\u003eSpecific service account key files, generated by the create-service-account tool, must be referenced within the \u003ccode\u003eoverrides.yaml\u003c/code\u003e file for components such as synchronizer, udca, mart, metrics, watcher, and logger.\u003c/p\u003e\n"],["\u003cp\u003eThe document version (1.5) of the Apigee hybrid documentation you are viewing is end-of-life, and you should consider upgrading to a newer version for the most up-to-date information and support.\u003c/p\u003e\n"]]],[],null,["# Step 7: Configure the hybrid runtime\n\n| You are currently viewing version 1.5 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 There are differences between the different platforms for the Google Cloud project region and\n Kubernetes cluster region. Choose the platform where you are installing Apigee hybrid. \n\n ```\n gcp:\n region: analytics-region\n projectID: gcp-project-id\n\n k8sCluster:\n name: cluster-name\n region: cluster-location # Must be the closest Google Cloud region to your cluster.\n org: org-name\n\n instanceID: \"unique-instance-identifier\"\n \n cassandra:\n hostNetwork: false\n # Set to false for single region installations and multi-region installations\n # with connectivity between pods in different clusters, for example GKE installations.\n # Set to true for multi-region installations with no communication between\n # pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,\n # AKS, EKS, and OpenShift installations.\n # See Multi-region deployment: Prerequisites\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 # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-apigee-synchronizer.json\n udca: ./service-accounts/udca-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-udca.json\n\n mart:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/mart-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-mart.json\n # Same account used for mart and connectAgent\n\n metrics:\n serviceAccountPath: ./service-accounts/metrics-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-metrics.json\n\n watcher:\n serviceAccountPath: ./service-accounts/watcher-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-watcher.json\n\n logger:\n enabled: true # set to \"false\" for GKE.\n serviceAccountPath: ./service-accounts/logger-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-logger.json\n\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: false\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-non-prod.json\n # for production environments, hybrid-project-apigee-synchronizer.json\n udca: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-udca.json\n\n mart:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-mart.json\n\n connectAgent:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, example-hybrid-apigee-mart.json\n\n metrics:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-metrics.json\n\n watcher:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-watcher.json\n\n logger:\n enabled: true # set to \"false\" for GKE.\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, 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.5/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 enable synchronizer access so the Apigee runtime and management planes\nwill be able to communicate.\n[1](/apigee/docs/hybrid/v1.5/install-create-cluster) [2](/apigee/docs/hybrid/v1.5/install-cert-manager) [3](/apigee/docs/hybrid/v1.5/install-asm) [4](/apigee/docs/hybrid/v1.5/install-apigeectl) [5](/apigee/docs/hybrid/v1.5/install-service-accounts) [6](/apigee/docs/hybrid/v1.5/install-create-tls-certificates) [7](/apigee/docs/hybrid/v1.5/install-configure-cluster) [(NEXT) Step 8: Enable Synchronizer access](/apigee/docs/hybrid/v1.5/install-enable-synchronizer-access) [9](/apigee/docs/hybrid/v1.5/install-hybrid-runtime)\n\n\u003cbr /\u003e"]]
