Especifica anulaciones de configuración
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.
Antes de comenzar
Te recomendamos que revises las siguientes situaciones para determinar si deseas configurar tu clúster en función de ellas. Estas configuraciones son opcionales.
- Si planeas instalar Hybrid en varias regiones, lee Implementación multirregional antes de continuar.
- Apigee Hybrid proporciona contraseñas predeterminadas para los usuarios de Cassandra. Apigee recomienda cambiar las contraseñas de usuario predeterminadas. Consulta Cómo configurar TLS para Cassandra para obtener más detalles.
- Si deseas establecer la configuración de almacenamiento y montón para Cassandra, consulta Establece la configuración de almacenamiento y de montón.
- Como se describe en la Parte 1: Configuración del proyecto y de la organización -- Paso 1: Habilita las APIs, para situaciones de instalación de producción, configura el almacenamiento de disco de estado sólido (SSD) persistente para Cassandra. Apigee no admite el uso de SSD locales para Apigee Hybrid. Si deseas obtener detalles, consulta Agrega almacenamiento SSD para implementaciones de producción.
Configura el clúster
Por convención, las anulaciones de configuración se escriben en un archivo llamado overrides.yaml
, que se suele almacenar en el directorio $APIGEE_HELM_CHARTS_HOME
.
- Crea un archivo nuevo llamado
overrides.yaml
en el directorio$APIGEE_HELM_CHARTS_HOME
.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. Se proporciona una descripción detallada de cada propiedad.Asegúrate de que el archivo
overrides.yaml
tenga la siguiente estructura y sintaxis.Elige la pestaña del tipo de autenticación de cuenta de servicio que usas en tu instalación: Paso 4: Crea cuentas de servicio.
- Claves de cuentas de servicio en Secrets de Kubernetes: Secrets de Kubernetes
- Archivos de claves JSON de cuentas de servicio: Archivos JSON
- Claves de cuentas de servicio en Vault: Vault
- Federación de identidades para cargas de trabajo para GKE: WIF para GKE
- Federación de identidades para cargas de trabajo: WIF en otras plataformas
Para obtener una descripción general de las diferentes opciones de autenticación, consulta Métodos de autenticación de cuentas de servicio en Apigee Hybrid.
Selecciona la pestaña de instalación, producción, Producción o no producción (instalaciones de demostración, evaluación o prueba de concepto), No producción según tu elección en el Paso 4: Crear cuentas de servicio.
Para las instalaciones en entornos de producción, consulta los requisitos de almacenamiento de la base de datos de Cassandra en Configura Cassandra para la producción.
Secretos de Kubernetes
Producción
Plantilla
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 Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
SECRETEl nombre del secreto de Kubernetes que creaste para la clave de la cuenta de servicio en el paso 5: Configura la autenticación de la cuenta de servicio. Los nombres predeterminados de los secretos que se sugieren en esta guía son los siguientes:
Producción
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
No producción
apigee-non-prod-svc-account
Consulta los siguientes vínculos:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
SECRETEl nombre del secreto de Kubernetes que creaste para la clave de la cuenta de servicio en el paso 5: Configura la autenticación de la cuenta de servicio. Los nombres predeterminados de los secretos que se sugieren en esta guía son los siguientes:
Producción
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
No producción
apigee-non-prod-svc-account
Consulta los siguientes vínculos:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
No producción
Plantilla
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
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
SECRETEl nombre del secreto de Kubernetes que creaste para la clave de la cuenta de servicio en el paso 5: Configura la autenticación de la cuenta de servicio. Los nombres predeterminados de los secretos que se sugieren en esta guía son los siguientes:
Producción
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
No producción
apigee-non-prod-svc-account
Consulta los siguientes vínculos:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
SECRETEl nombre del secreto de Kubernetes que creaste para la clave de la cuenta de servicio en el paso 5: Configura la autenticación de la cuenta de servicio. Los nombres predeterminados de los secretos que se sugieren en esta guía son los siguientes:
Producción
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
No producción
apigee-non-prod-svc-account
Consulta los siguientes vínculos:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Archivos JSON
Producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
FILEPATHLa ruta y el nombre de archivo de los archivos JSON de la cuenta de servicio en el directorio del gráfico correspondiente. Proporciona los nombres con la ruta relativa al directorio del gráfico. Por ejemplo: - Si el archivo
my-project-apigee-synchronizer.json
reside en el directorio del gráficoapigee-env/
, solo debes proporcionar el nombre del archivo, por ejemplo:synchronizer: "FILE_NAME.json"
- Si el archivo reside en un directorio
apigee-env/service-accounts/
, debes especificar una ruta de acceso relativa:synchronizer: "service-accounts/FILE_NAME.json"
En entornos que no son de producción, se usa el nombre de la cuenta de servicio única,
PROJECT_ID-non-prod.json
de forma predeterminada.Para los entornos de producción, el nombre del archivo de claves de la cuenta de servicio que generaste con la herramienta
create-service-account
en Paso 4: Crear cuentas de servicio.Puedes ver los archivos de la cuenta de servicio en cada directorio del gráfico correspondiente.
Los nombres predeterminados de los directorios del gráfico correspondientes para las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico 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/
No producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes vínculos:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
FILEPATHLa ruta y el nombre de archivo de los archivos JSON de la cuenta de servicio en el directorio del gráfico correspondiente. Proporciona los nombres con la ruta relativa al directorio del gráfico. Por ejemplo: - Si el archivo
my-project-apigee-synchronizer.json
reside en el directorio del gráficoapigee-env/
, solo debes proporcionar el nombre del archivo, por ejemplo:synchronizer: "FILE_NAME.json"
- Si el archivo reside en un directorio
apigee-env/service-accounts/
, debes especificar una ruta de acceso relativa:synchronizer: "service-accounts/FILE_NAME.json"
En entornos que no son de producción, se usa el nombre de la cuenta de servicio única,
PROJECT_ID-non-prod.json
de forma predeterminada.Para los entornos de producción, el nombre del archivo de claves de la cuenta de servicio que generaste con la herramienta
create-service-account
en Paso 4: Crear cuentas de servicio.Puedes ver los archivos de la cuenta de servicio en cada directorio del gráfico correspondiente.
Los nombres predeterminados de los directorios del gráfico correspondientes para las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico 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/
No producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes vínculos:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
No producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
FILEPATHLa ruta y el nombre de archivo de los archivos JSON de la cuenta de servicio en el directorio del gráfico correspondiente. Proporciona los nombres con la ruta relativa al directorio del gráfico. Por ejemplo: - Si el archivo
my-project-apigee-synchronizer.json
reside en el directorio del gráficoapigee-env/
, solo debes proporcionar el nombre del archivo, por ejemplo:synchronizer: "FILE_NAME.json"
- Si el archivo reside en un directorio
apigee-env/service-accounts/
, debes especificar una ruta de acceso relativa:synchronizer: "service-accounts/FILE_NAME.json"
En entornos que no son de producción, se usa el nombre de la cuenta de servicio única,
PROJECT_ID-non-prod.json
de forma predeterminada.Para los entornos de producción, el nombre del archivo de claves de la cuenta de servicio que generaste con la herramienta
create-service-account
en Paso 4: Crear cuentas de servicio.Puedes ver los archivos de la cuenta de servicio en cada directorio del gráfico correspondiente.
Los nombres predeterminados de los directorios del gráfico correspondientes para las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico 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/
No producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes vínculos:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
FILEPATHLa ruta y el nombre de archivo de los archivos JSON de la cuenta de servicio en el directorio del gráfico correspondiente. Proporciona los nombres con la ruta relativa al directorio del gráfico. Por ejemplo: - Si el archivo
my-project-apigee-synchronizer.json
reside en el directorio del gráficoapigee-env/
, solo debes proporcionar el nombre del archivo, por ejemplo:synchronizer: "FILE_NAME.json"
- Si el archivo reside en un directorio
apigee-env/service-accounts/
, debes especificar una ruta de acceso relativa:synchronizer: "service-accounts/FILE_NAME.json"
En entornos que no son de producción, se usa el nombre de la cuenta de servicio única,
PROJECT_ID-non-prod.json
de forma predeterminada.Para los entornos de producción, el nombre del archivo de claves de la cuenta de servicio que generaste con la herramienta
create-service-account
en Paso 4: Crear cuentas de servicio.Puedes ver los archivos de la cuenta de servicio en cada directorio del gráfico correspondiente.
Los nombres predeterminados de los directorios del gráfico correspondientes para las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico 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/
No producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes vínculos:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Vault
Producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.No producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.WIF para GKE
Producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
EMAILLas direcciones de correo electrónico de la cuenta de servicio de las cuentas de servicio de Google (GSA) que debes proporcionar si usas Workload Identity Federation for GKE. Estas son las cuentas de servicio que creaste en Paso 4: Crear cuentas de servicio. Puedes encontrar las direcciones de correo electrónico de las cuentas de servicio con el siguiente comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Consulta los siguientes vínculos:
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
EMAILLas direcciones de correo electrónico de la cuenta de servicio de las cuentas de servicio de Google (GSA) que debes proporcionar si usas Workload Identity Federation for GKE. Estas son las cuentas de servicio que creaste en Paso 4: Crear cuentas de servicio. Puedes encontrar las direcciones de correo electrónico de las cuentas de servicio con el siguiente comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Consulta los siguientes vínculos:
No producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.NON_PROD_
SERVICE_ACCOUNT_
EMAILSon las direcciones de correo electrónico de la cuenta de servicio de la cuenta de servicio de Google (GSA) que no es de producción. Esta es la cuenta de servicio de apigee-non-prod
que creaste en el Paso 4: Crear cuentas de servicio.Si usas Workload Identity Federation for GKE en una instalación que no es de producción, especifica la dirección de correo electrónico de la cuenta de servicio para la propiedad
gcp.workloadIdentity.gsa
. No será necesario que agregues la propiedadgsa
para ningún componente individual.Puedes encontrar las direcciones de correo electrónico de las cuentas de servicio con el siguiente comando:
gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Consulta
gcp.workloadIdentity.gsa
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.NON_PROD_
SERVICE_ACCOUNT_
EMAILSon las direcciones de correo electrónico de la cuenta de servicio de la cuenta de servicio de Google (GSA) que no es de producción. Esta es la cuenta de servicio de apigee-non-prod
que creaste en el Paso 4: Crear cuentas de servicio.Si usas Workload Identity Federation for GKE en una instalación que no es de producción, especifica la dirección de correo electrónico de la cuenta de servicio para la propiedad
gcp.workloadIdentity.gsa
. No será necesario que agregues la propiedadgsa
para ningún componente individual.Puedes encontrar las direcciones de correo electrónico de las cuentas de servicio con el siguiente comando:
gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Consulta
gcp.workloadIdentity.gsa
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.WIF en otras plataformas
WIF: secretos
Producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
WORKLOAD_IDENTITY_
SECRETEs el nombre del secreto de Kubernetes que usaste para la configuración de credenciales de la cuenta de servicio en el paso 5: Configura la autenticación de la cuenta de servicio. Los nombres predeterminados de los secretos que se sugieren en esta guía son los siguientes:
Producción
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
No producción
non-prod-workload-identity-secret
Consulta los siguientes vínculos:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
WORKLOAD_IDENTITY_
SECRETEs el nombre del secreto de Kubernetes que usaste para la configuración de credenciales de la cuenta de servicio en el paso 5: Configura la autenticación de la cuenta de servicio. Los nombres predeterminados de los secretos que se sugieren en esta guía son los siguientes:
Producción
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
No producción
non-prod-workload-identity-secret
Consulta los siguientes vínculos:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
No producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
WORKLOAD_IDENTITY_
SECRETEs el nombre del secreto de Kubernetes que usaste para la configuración de credenciales de la cuenta de servicio en el paso 5: Configura la autenticación de la cuenta de servicio. Los nombres predeterminados de los secretos que se sugieren en esta guía son los siguientes:
Producción
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
No producción
non-prod-workload-identity-secret
Consulta los siguientes vínculos:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
WORKLOAD_IDENTITY_
SECRETEs el nombre del secreto de Kubernetes que usaste para la configuración de credenciales de la cuenta de servicio en el paso 5: Configura la autenticación de la cuenta de servicio. Los nombres predeterminados de los secretos que se sugieren en esta guía son los siguientes:
Producción
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
No producción
non-prod-workload-identity-secret
Consulta los siguientes vínculos:
-
envs[].serviceAccountSecretRefs.synchronizer
. -
envs[].serviceAccountSecretRefs.runtime
. -
envs[].serviceAccountSecretRefs.udca
. -
logger.serviceAccountRef
. -
connectAgent.serviceAccountRef
. -
mart.serviceAccountRef
. -
metrics.serviceAccountRef
. -
mintTaskScheduler.serviceAccountRef
. -
udca.serviceAccountRef
. -
watcher.serviceAccountRef
.
WIF: archivos
Producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHLa ruta y el nombre de archivo de los archivos de configuración de credenciales que creaste en el paso 5: Configura la autenticación de la cuenta de servicio. Proporciona los nombres con la ruta relativa al directorio del gráfico. Por ejemplo:
- Si el archivo
apigee-synchronizer-credential-configuration.json
reside en el directorio del gráficoapigee-env/
, solo debes proporcionar el nombre del archivo, por ejemplo:synchronizer: "FILE_NAME.json"
- Si el archivo reside en un directorio
apigee-env/service-accounts/
, debes especificar una ruta de acceso relativa:synchronizer: "service-accounts/FILE_NAME.json"
Los nombres predeterminados de los directorios del gráfico correspondientes para las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico 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/
No producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes vínculos:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHLa ruta y el nombre de archivo de los archivos de configuración de credenciales que creaste en el paso 5: Configura la autenticación de la cuenta de servicio. Proporciona los nombres con la ruta relativa al directorio del gráfico. Por ejemplo:
- Si el archivo
apigee-synchronizer-credential-configuration.json
reside en el directorio del gráficoapigee-env/
, solo debes proporcionar el nombre del archivo, por ejemplo:synchronizer: "FILE_NAME.json"
- Si el archivo reside en un directorio
apigee-env/service-accounts/
, debes especificar una ruta de acceso relativa:synchronizer: "service-accounts/FILE_NAME.json"
Los nombres predeterminados de los directorios del gráfico correspondientes para las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico 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/
No producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes vínculos:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
No producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHLa ruta y el nombre de archivo de los archivos de configuración de credenciales que creaste en el paso 5: Configura la autenticación de la cuenta de servicio. Proporciona los nombres con la ruta relativa al directorio del gráfico. Por ejemplo:
- Si el archivo
apigee-synchronizer-credential-configuration.json
reside en el directorio del gráficoapigee-env/
, solo debes proporcionar el nombre del archivo, por ejemplo:synchronizer: "FILE_NAME.json"
- Si el archivo reside en un directorio
apigee-env/service-accounts/
, debes especificar una ruta de acceso relativa:synchronizer: "service-accounts/FILE_NAME.json"
Los nombres predeterminados de los directorios del gráfico correspondientes para las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico 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/
No producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes vínculos:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHLa ruta y el nombre de archivo de los archivos de configuración de credenciales que creaste en el paso 5: Configura la autenticación de la cuenta de servicio. Proporciona los nombres con la ruta relativa al directorio del gráfico. Por ejemplo:
- Si el archivo
apigee-synchronizer-credential-configuration.json
reside en el directorio del gráficoapigee-env/
, solo debes proporcionar el nombre del archivo, por ejemplo:synchronizer: "FILE_NAME.json"
- Si el archivo reside en un directorio
apigee-env/service-accounts/
, debes especificar una ruta de acceso relativa:synchronizer: "service-accounts/FILE_NAME.json"
Los nombres predeterminados de los directorios del gráfico correspondientes para las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico 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/
No producción
Nombre del archivo de la cuenta de servicio Directorio del gráfico apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes vínculos:
-
envs[].serviceAccountPaths.synchronizer
. -
envs[].serviceAccountPaths.runtime
. -
envs[].serviceAccountPaths.udca
. -
logger.serviceAccountPath
. -
connectAgent.serviceAccountPath
. -
mart.serviceAccountPath
. -
metrics.serviceAccountPath
. -
mintTaskScheduler.serviceAccountPath
. -
udca.serviceAccountPath
. -
watcher.serviceAccountPath
.
WIF: Vault
Producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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 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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.No producción
Plantilla
Los valores en red, bold italics son los valores de propiedad que debes proporcionar. Puedes editar sus valores en esta página. Se describen en la siguiente tabla.
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.Ejemplo
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
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 UNIQUE_INSTANCE_
IDENTIFIERUna 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 el
instanceID
debe ser igual para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes para tus componentes de Apigee Hybrid.
El valor predeterminado es
apigee
.Consulta
namespace
.PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger
yapigee-metrics
envían sus datos. Este es el valor asignado a la variable de entornoPROJECT_ID
.Consulta
gcp.projectID
.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 2: Crea una organización). Corresponde al valor que asignaste anteriormente a la variable de entorno
ANALYTICS_REGION
.Consulta
gcp.region
.AUDIENCE Es el público permitido del proveedor de Workload Identity. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de credenciales. El valor del público es el mismo en cada archivo de configuración de credenciales.Por ejemplo, en el siguiente archivo
apigee-udca-credential-configuration.json
de muestra:{ "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" } } }
El valor del público se verá de la siguiente manera (sin saltos de línea):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"
Consulta
gcp.federatedWorkloadIdentity.audience
.CLUSTER_NAME El nombre de tu clúster de Kubernetes. Este es el valor asignado a la variable de entorno CLUSTER_NAME
.Consulta
k8sCluster.name
.CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que creaste el clúster en el Paso 1: Crea un clúster. Corresponde al valor que asignaste anteriormente a la variable de entorno
CLUSTER_LOCATION
.Consulta
k8sCluster.location
.ORG_NAME El ID de la organización híbrida de Apigee. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONEs obligatorio si usas la residencia de datos con la instalación de Apigee Hybrid. Esta es la ubicación donde se almacena el contenido principal del cliente, como los paquetes de proxy. Para obtener una lista, consulta Regiones del plano de control de la API de Apigee disponibles. Es el valor asignado a la variable de entorno CONTROL_PLANE_LOCATION
en el Paso 2: Crea una organización.Consulta
contractProvider
.ENVIRONMENT_NAME Usa el mismo nombre que usaste cuando creaste un entorno en la IU, como se explica en Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMEEl nombre del grupo de entornos al que se asignan tus entornos. Este es el grupo que creaste en la Configuración del proyecto y la organización - Paso 3: crea un grupo de entornos. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la puerta de enlace de entrada de Apigee para la implementación. Puede ser cualquier nombre que cumpla con los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula “.” o “-”.
- Comenzar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes vínculos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIngresa la ruta y el nombre de archivo de la clave de TLS autofirmada y los archivos de certificado que generaste antes en el Paso 6: Crea certificados TLS. Estos archivos deben estar ubicados en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes vínculos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional). Este es un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para configurar tu instalación híbrida, por ejemplo, si estableces el tipo de balanceador de cargas como interno o externo. Las anotaciones varían de una plataforma a otra. Consulta la documentación de tu plataforma para ver las anotaciones obligatorias y sugeridas.
Marca como comentario o borra esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.Resumen
El archivo de configuración le indica a Kubernetes cómo implementar los componentes híbridos en un clúster. A continuación, habilitarás el acceso al sincronizador para que el plano de ejecución y los de administración de Apigee puedan comunicarse.
Próximo paso
1 2 3 4 5 6 7 (NEXT) Step 8: Enable Control Plane access 9 10 11