El instalador de Apigee hybrid usa valores predeterminados para muchos ajustes. Sin embargo, hay algunos ajustes que no tienen valores predeterminados. Debe proporcionar valores para estos ajustes, tal como se explica a continuación.
Asegúrate de que estás en el directorio hybrid-base-directory/hybrid-files/overrides/.
cd hybrid-base-directory/hybrid-files/overrides
Crea un archivo llamado overrides.yaml en tu editor de texto favorito. Por ejemplo:
vi overrides.yaml
El archivo overrides.yaml proporciona la configuración de tu instalación única de Apigee hybrid. El archivo de anulaciones de este paso proporciona una configuración básica para una instalación de tiempo de ejecución híbrido con un tamaño reducido, adecuada para tu primera instalación.
En overrides.yaml, añada los valores de propiedad obligatorios, que se muestran a continuación. A continuación, se incluye una descripción detallada de cada propiedad:
Sintaxis
Asegúrate de que el archivo overrides.yaml tenga la siguiente estructura y sintaxis.
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Se describen en la tabla de abajo.
Hay diferencias entre las distintas plataformas en cuanto a la región del proyecto de Google Cloud y la región del clúster de Kubernetes. Elige la plataforma en la que vas a instalar Apigee hybrid.
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-id-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
runtime: ./service-accounts/runtime-service-account-name.json
# for non-production environments, gcp-project-id-apigee-non-prod.json
# for production environments, gcp-project-id-apigee-runtime.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
# Use the same service account 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
udca:
serviceAccountPath: ./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
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: false
# Set to false to disable logger for GKE installations.
# Set to true for all platforms other than GKE.
# See apigee-logger in Service accounts and roles used by hybrid components.
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
Ejemplo
En el siguiente ejemplo se muestra un archivo de anulaciones completado con valores de propiedad de ejemplo:
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
runtime: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-runtime.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
udca:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-udca.json
watcher:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, hybrid-project-apigee-watcher.json
logger:
enabled: false # Set to "false" for GKE. Set to "true" for all other kubernetes platforms.
serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
# for production environments, logger-service-account-name.json
Cuando hayas terminado, guarda el archivo.
En la siguiente tabla se describen los valores de propiedad que debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable
Descripción
analytics-region
En GKE, debe definir este valor en la misma región en la que se ejecuta el clúster. En todas las demás plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 4 de la parte 1: crea una organización).
Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION anteriormente.
gcp-project-id
Identifica el proyecto de Google Cloud en el que apigee-logger y apigee-metrics insertan sus datos. Este es el valor asignado a la variable de entorno PROJECT_ID.
cluster-name
Nombre del clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME.
cluster-location
La región en la que se ejecuta el clúster. Esta es la región en la que has creado el clúster en el paso 1: Crea un clúster.
Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION anteriormente.
org-name
ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME.
unique-instance-identifier
Una cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el instanceId
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.
Introduce el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS.
Estos archivos deben estar en el directorio base_directory/hybrid-files/certs. Por ejemplo:
En los entornos que no son de producción, el nombre de la cuenta de servicio única es non-prod de forma predeterminada. En los entornos de producción, el nombre del archivo de clave de cuenta de servicio apigee-synchronizer que has generado con la herramienta create-service-account en Configuración del tiempo de ejecución híbrido - Paso 6: Crea credenciales y cuentas de servicio. Puedes ver la lista de archivos de la cuenta de servicio en tu directorio service-accounts/. Por ejemplo:
ls ../service-accounts/
udca-service-account-name
En los entornos que no son de producción, el nombre de la cuenta de servicio única es non-prod de forma predeterminada. En los entornos de producción, el nombre del archivo de clave de cuenta de servicio apigee-udca que has generado con la herramienta create-service-account.
runtime-service-account-name
En los entornos que no son de producción, el nombre de la cuenta de servicio única es non-prod de forma predeterminada. En entornos de producción, el nombre del archivo de clave de cuenta de servicio apigee-runtime que has generado con la herramienta create-service-account.
mart-service-account-name
En los entornos que no son de producción, el nombre de la cuenta de servicio única es non-prod de forma predeterminada. En los entornos de producción, el nombre del archivo de clave de cuenta de servicio apigee-mart que has generado con la herramienta create-service-account.
metrics-service-account-name
En los entornos que no son de producción, el nombre de la cuenta de servicio única es non-prod de forma predeterminada. En los entornos de producción, el nombre del archivo de clave de cuenta de servicio apigee-metrics que has generado con la herramienta create-service-account.
udca-service-account-name
En los entornos que no son de producción, el nombre de la cuenta de servicio única es non-prod de forma predeterminada. En los entornos de producción, el nombre del archivo de clave de cuenta de servicio apigee-udca que has generado con la herramienta create-service-account.
watcher-service-account-name
En los entornos que no son de producción, el nombre de la cuenta de servicio única es non-prod de forma predeterminada. En los entornos de producción, el nombre del archivo de clave de cuenta de servicio apigee-watcher que has generado con la herramienta create-service-account.
logger-service-account-name
En los entornos que no son de producción, el nombre de la cuenta de servicio única es non-prod de forma predeterminada. En los entornos de producción, el nombre del archivo de clave de cuenta de servicio apigee-logger que has generado con la herramienta create-service-account.
Resumen
El archivo de configuración indica a Kubernetes cómo desplegar los componentes híbridos en un clúster. A continuación, habilitarás el acceso del sincronizador para que los planos de gestión y de tiempo de ejecución de Apigee puedan comunicarse.
[[["Es fácil de entender","easyToUnderstand","thumb-up"],["Me ofreció una solución al problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Es difícil de entender","hardToUnderstand","thumb-down"],["La información o el código de muestra no son correctos","incorrectInformationOrSampleCode","thumb-down"],["Me faltan las muestras o la información que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 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 default settings as a base and adding the values that are unique to your installation.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file must be created in the \u003ccode\u003ehybrid-base-directory/hybrid-files/overrides/\u003c/code\u003e directory, and requires you to set property values for GCP region, project ID, Kubernetes cluster details, and organization information, along with unique identifiers.\u003c/p\u003e\n"],["\u003cp\u003eThe file should have the defined structure, and specific property values for items such as \u003ccode\u003egcp\u003c/code\u003e, \u003ccode\u003ek8sCluster\u003c/code\u003e, \u003ccode\u003eorg\u003c/code\u003e, \u003ccode\u003einstanceID\u003c/code\u003e, \u003ccode\u003ecassandra\u003c/code\u003e, \u003ccode\u003evirtualhosts\u003c/code\u003e, \u003ccode\u003eenvs\u003c/code\u003e, \u003ccode\u003emart\u003c/code\u003e, \u003ccode\u003econnectAgent\u003c/code\u003e, \u003ccode\u003emetrics\u003c/code\u003e, \u003ccode\u003eudca\u003c/code\u003e, \u003ccode\u003ewatcher\u003c/code\u003e, and \u003ccode\u003elogger\u003c/code\u003e must be provided.\u003c/p\u003e\n"],["\u003cp\u003eEach of these properties, such as the \u003ccode\u003eanalytics-region\u003c/code\u003e, \u003ccode\u003egcp-project-id\u003c/code\u003e, and \u003ccode\u003ecluster-name\u003c/code\u003e, corresponds to specific configurations for the Apigee hybrid environment and requires values that you assigned to specific environment variables during previous steps of the setup.\u003c/p\u003e\n"],["\u003cp\u003eThe document also explains that after creating the file and configuring it correctly, you must save it, which is a prerequisite to enabling synchronizer access, allowing the Apigee runtime and management planes to communicate.\u003c/p\u003e\n"]]],[],null,["# Step 7: Configure the hybrid runtime\n\n| You are currently viewing version 1.6 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-id-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 runtime: ./service-accounts/runtime-service-account-name.json\n # for non-production environments, gcp-project-id-apigee-non-prod.json\n # for production environments, gcp-project-id-apigee-runtime.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 # Use the same service account 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 udca:\n serviceAccountPath: ./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 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: false\n # Set to false to disable logger for GKE installations.\n # Set to true for all platforms other than GKE.\n # See apigee-logger in Service accounts and roles used by hybrid components.\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 runtime: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-runtime.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 udca:\n serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json\n # for production environments, hybrid-project-apigee-udca.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: false # Set to \"false\" for GKE. Set to \"true\" for all other kubernetes platforms.\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.6/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.6/install-create-cluster) [2](/apigee/docs/hybrid/v1.6/install-cert-manager) [3](/apigee/docs/hybrid/v1.6/install-asm) [4](/apigee/docs/hybrid/v1.6/install-apigeectl) [5](/apigee/docs/hybrid/v1.6/install-service-accounts) [6](/apigee/docs/hybrid/v1.6/install-create-tls-certificates) [7](/apigee/docs/hybrid/v1.6/install-configure-cluster) [(NEXT) Step 8: Enable Synchronizer access](/apigee/docs/hybrid/v1.6/install-enable-synchronizer-access) [9](/apigee/docs/hybrid/v1.6/install-hybrid-runtime)\n\n\u003cbr /\u003e"]]