El instalador híbrido de Apigee usa los valores predeterminados para muchos parámetros de configuración. Sin embargo, hay algunos parámetros de configuración que no tienen valores predeterminados. Debes proporcionar valores para estos parámetros de configuración, 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 nuevo llamado overrides.yaml en tu editor de texto favorito. Por ejemplo:
vi overrides.yaml
El overrides.yaml proporciona la configuración para tu instalación única de Apigee Hybrid. El archivo de anulación en este paso proporciona una configuración básica para una instalación de entorno de ejecución híbrido de tamaño reducido, adecuado para tu primera instalación.
En overrides.yaml, agrega los valores de propiedad necesarios, que se muestran a continuación. También se proporciona una descripción detallada de cada propiedad:
Sintaxis
Asegúrate de que el archivo overrides.yaml tenga la siguiente estructura y sintaxis.
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Se describen en la siguiente tabla.
Existen diferencias entre las diferentes plataformas para la región del proyecto de Google Cloud y la región del clúster de Kubernetes. Elige la plataforma en la que instalarás Apigee Hybrid.
gcp:
region: analytics-region
projectID: gcp-project-id
k8sCluster:
name: cluster-name
region: analytics-region # Must be the closest Google Cloud region to your cluster
org: org-name
instanceID: "unique-instance-identifier"
cassandra:
hostNetwork: false #Set this to `true` for GKE On-prem installations.
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 # set to "false" for GKE.
serviceAccountPath: ./service-accounts/logger-service-account-name.json
Ejemplo
En el ejemplo siguiente, se muestra un archivo de anulación completo con valores de propiedad de ejemplo agregados:
gcp:
region: us-central1
projectID: hybrid-example
k8sCluster:
name: apigee-hybrid
region: us-central1
org: hybrid-example
instanceID: "my_hybrid_example"
cassandra:
hostNetwork: false # Set this to:
# false for GKE installations.
# true for GKE On-prem GKE on AWS, Anthos on bare metal,
# AKS, EKS, and OpenShift installations.
virtualhosts:
- name: example-env-group
sslCertPath: ./certs/keystore.pem
sslKeyPath: ./certs/keystore.key
envs:
- name: test
serviceAccountPaths:
synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json
udca: ./service-accounts/hybrid-project-apigee-udca.json
mart:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json
connectAgent:
serviceAccountPath: ./service-accounts/example-hybrid-apigee-mart.json
metrics:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json
watcher:
serviceAccountPath: ./service-accounts/hybrid-project-apigee-watcher.json
logger:
enabled: true # set to "false" for GKE.
serviceAccountPath: ./service-accounts/logger-service-account-name.json
Cuando termines, guarda el archivo.
En la siguiente tabla, se describe cada uno de los valores de propiedad que debes proporcionar en el archivo de anulación. Para obtener más información, consulta Referencia de la propiedad de configuración.
Variable
Descripción
analytics-region
En GKE, debe establecer este valor en la misma región donde se ejecuta el clúster. En todas las demás plataformas, selecciona la región de estadísticas más cercana a tu clúster, que admite Analytics (consulta la tabla en la Parte 1: Paso 4, crea una organización.
Corresponde al valor que asignaste anteriormente a la variable de entorno ANALYTICS_REGION.
gcp-project-id
Identifica el proyecto de Google Cloud en el que apigee-logger y apigee-metrics envían sus datos. Este es el valor asignado a la variable de entorno PROJECT_ID.
cluster-name
El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME.
org-name
El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME.
unique-instance-identifier
Una string ú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 instanceId debe ser la misma para todas las organizaciones del mismo clúster de Kubernetes.
Ingresa el nombre de la clave de TLS y los archivos de certificado autofirmados que generaste en el Paso 3: Instala apigeectl.
Estos archivos deben estar ubicados en el directorio base_directory/hybrid-files/certs. Por ejemplo:
El nombre del archivo de claves de la cuenta de servicio apigee-udca que generaste con la herramienta create-service-account.
mart-service-account-name
El nombre del archivo de claves de la cuenta de servicio apigee-mart que generaste con la herramienta create-service-account.
metrics-service-account-name
El nombre del archivo de claves de la cuenta de servicio apigee-metrics que generaste con la herramienta create-service-account.
watcher-service-account-name
El nombre del archivo de claves de la cuenta de servicio apigee-watcher que generaste con la herramienta create-service-account.
logger-service-account-name
El nombre del archivo de claves de la cuenta de servicio apigee-logger que generaste con la herramienta create-service-account.
Resumen
El archivo de configuración le indica a Kubernetes cómo implementar los componentes híbridos en un clúster. A continuación, aplicarás esta configuración a tu clúster.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (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 create an \u003ccode\u003eoverrides.yaml\u003c/code\u003e file in the \u003ccode\u003ehybrid-base-directory/hybrid-files/overrides/\u003c/code\u003e directory and populate it with the required property values for your specific Apigee hybrid setup, such as \u003ccode\u003egcp\u003c/code\u003e, \u003ccode\u003ek8sCluster\u003c/code\u003e, \u003ccode\u003eorg\u003c/code\u003e, and various service account paths.\u003c/p\u003e\n"],["\u003cp\u003eThe configuration file requires specific property values including the Google Cloud project region, Kubernetes cluster details, organization ID, a unique instance identifier, and environment group names, as well as the names of the previously generated TLS key and certificate files.\u003c/p\u003e\n"],["\u003cp\u003eThe document describes the necessary service account key files, such as \u003ccode\u003eapigee-synchronizer\u003c/code\u003e, \u003ccode\u003eapigee-udca\u003c/code\u003e, \u003ccode\u003eapigee-mart\u003c/code\u003e, \u003ccode\u003eapigee-metrics\u003c/code\u003e, \u003ccode\u003eapigee-watcher\u003c/code\u003e, and \u003ccode\u003eapigee-logger\u003c/code\u003e, which must be created, and then their paths must be specified in the overrides file.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoverrides.yaml\u003c/code\u003e file configures Kubernetes on how to deploy hybrid components to a cluster, and afterwards this configuration can be applied to your cluster.\u003c/p\u003e\n"]]],[],null,["# Step 6: Configure the hybrid runtime\n\n| You are currently viewing version 1.4 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: analytics-region # 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 #Set this to `true` for GKE On-prem installations.\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 # set to \"false\" for GKE.\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: false # Set this to:\n # false for GKE installations.\n # true for GKE On-prem GKE on AWS, Anthos on bare metal,\n # AKS, EKS, and OpenShift installations.\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 # set to \"false\" for GKE.\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.4/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.4/2-1-install-create-cluster) [2](/apigee/docs/hybrid/v1.4/2-2-install-cert-manager) [3](/apigee/docs/hybrid/v1.4/2-3-install-asm) [4](/apigee/docs/hybrid/v1.4/2-4-install-apigeectl) [5](/apigee/docs/hybrid/v1.4/2-5-install-service-accounts) [6](/apigee/docs/hybrid/v1.4/2-6-install-configure-cluster) [(NEXT) Step 7: Install the hybrid runtime](/apigee/docs/hybrid/v1.4/2-7-install-hybrid-runtime)\n\n\u003cbr /\u003e"]]
