Especificar anulaciones de configuración
El instalador de Apigee hybrid usa valores predeterminados para muchos ajustes. Sin embargo, hay algunos ajustes que no tienen valores predeterminados. Debe proporcionar valores para estos ajustes, tal como se explica a continuación.
Antes de empezar
Te recomendamos que revises los siguientes casos para determinar si quieres configurar tu clúster para ellos. Estas configuraciones son opcionales.
- Si tienes previsto instalar una configuración híbrida en varias regiones, consulta Despliegue multirregional antes de continuar.
- Apigee hybrid proporciona contraseñas predeterminadas para los usuarios de Cassandra. Apigee recomienda cambiar las contraseñas de usuario predeterminadas. Para obtener más información, consulta el artículo sobre cómo configurar TLS para Cassandra.
- Si quieres configurar los ajustes de almacenamiento y de montículo de Cassandra, consulta Configurar los ajustes de almacenamiento y de montículo.
- Tal como se describe en la parte 1: Configuración de proyectos y organizaciones > Paso 1: Habilitar APIs, en los casos de instalación en producción, configura el almacenamiento en unidades de estado sólido (SSD) persistentes para Cassandra. Apigee no admite el uso de SSDs locales en Apigee Hybrid. Para obtener más información, consulta Añadir almacenamiento SSD para implementaciones de producción.
Configurar el clúster
Por convención, las anulaciones de configuración se escriben en un archivo llamado overrides.yaml
que suele almacenarse en el directorio $APIGEE_HELM_CHARTS_HOME
.
- Crea un archivo llamado
overrides.yaml
en el directorio$APIGEE_HELM_CHARTS_HOME
.El archivo
overrides.yaml
proporciona la configuración de tu instalación única de Apigee hybrid. El archivo de anulaciones de este paso proporciona una configuración básica para una instalación de tiempo de ejecución híbrida con un tamaño reducido, adecuada para tu primera instalación. - En
overrides.yaml
, añade los valores de propiedad obligatorios que se muestran a continuación. A continuación, se ofrece 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 correspondiente al tipo de autenticación de cuenta de servicio que estés usando en tu instalación: Paso 4: Crea cuentas de servicio.
- Claves de cuentas de servicio en secretos de Kubernetes: secretos de Kubernetes
- Archivos de clave JSON de cuenta de servicio: archivos JSON
- Claves de cuenta de servicio en Vault: Vault
- Workload Identity Federation para GKE: WIF para GKE
- Federación de identidades de cargas de trabajo: WIF en otras plataformas
Para obtener un resumen 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 tu instalación, Producción o Fuera de la fase de producción (instalaciones de demostración, evaluación o prueba de concepto), según lo que hayas elegido en el paso 4: Crea cuentas de servicio.
En el caso de las instalaciones en entornos de producción, consulta los requisitos de almacenamiento de la base de datos Cassandra en Configurar Cassandra para el entorno de producción.
Secretos de Kubernetes
Producción
Template
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 de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
En la siguiente tabla se describe cada uno de los valores de propiedad que debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
SECRETEl nombre del secreto de Kubernetes que has usado 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 artículos:
-
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
SECRETEl nombre del secreto de Kubernetes que has usado 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 artículos:
-
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
Template
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 de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
En la siguiente tabla se describe cada uno de los valores de propiedad que debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
SECRETEl nombre del secreto de Kubernetes que has usado 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 artículos:
-
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
SECRETEl nombre del secreto de Kubernetes que has usado 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 artículos:
-
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
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
FILEPATHLa ruta y el nombre de archivo de las cuentas de servicio de los archivos JSON en el directorio de gráficos correspondiente. Proporcione los nombres con la ruta relativa al directorio del gráfico. directory. Por ejemplo: - Si el archivo
my-project-apigee-synchronizer.json
se encuentra en el directorio del gráficoapigee-env/
, solo tienes que proporcionar el nombre del archivo, como este:synchronizer: "FILE_NAME.json"
- Si el archivo se encuentra en un directorio
apigee-env/service-accounts/
, debes especificar una ruta relativa:synchronizer: "service-accounts/FILE_NAME.json"
En los entornos que no son de producción, el nombre de la cuenta de servicio única es
PROJECT_ID-non-prod.json
de forma predeterminada.En los entornos de producción, el nombre del archivo de clave de cuenta de servicio que has generado con la herramienta
create-service-account
en el paso 4: Crea cuentas de servicio.Puedes ver los archivos de la cuenta de servicio en cada directorio de gráficos correspondiente.
Los nombres predeterminados de los directorios de gráficos correspondientes a las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio de gráficos 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 de gráficos PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes artículos:
-
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
FILEPATHLa ruta y el nombre de archivo de las cuentas de servicio de los archivos JSON en el directorio de gráficos correspondiente. Proporcione los nombres con la ruta relativa al directorio del gráfico. directory. Por ejemplo: - Si el archivo
my-project-apigee-synchronizer.json
se encuentra en el directorio del gráficoapigee-env/
, solo tienes que proporcionar el nombre del archivo, como este:synchronizer: "FILE_NAME.json"
- Si el archivo se encuentra en un directorio
apigee-env/service-accounts/
, debes especificar una ruta relativa:synchronizer: "service-accounts/FILE_NAME.json"
En los entornos que no son de producción, el nombre de la cuenta de servicio única es
PROJECT_ID-non-prod.json
de forma predeterminada.En los entornos de producción, el nombre del archivo de clave de cuenta de servicio que has generado con la herramienta
create-service-account
en el paso 4: Crea cuentas de servicio.Puedes ver los archivos de la cuenta de servicio en cada directorio de gráficos correspondiente.
Los nombres predeterminados de los directorios de gráficos correspondientes a las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio de gráficos 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 de gráficos PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes artículos:
-
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
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
FILEPATHLa ruta y el nombre de archivo de las cuentas de servicio de los archivos JSON en el directorio de gráficos correspondiente. Proporcione los nombres con la ruta relativa al directorio del gráfico. directory. Por ejemplo: - Si el archivo
my-project-apigee-synchronizer.json
se encuentra en el directorio del gráficoapigee-env/
, solo tienes que proporcionar el nombre del archivo, como este:synchronizer: "FILE_NAME.json"
- Si el archivo se encuentra en un directorio
apigee-env/service-accounts/
, debes especificar una ruta relativa:synchronizer: "service-accounts/FILE_NAME.json"
En los entornos que no son de producción, el nombre de la cuenta de servicio única es
PROJECT_ID-non-prod.json
de forma predeterminada.En los entornos de producción, el nombre del archivo de clave de cuenta de servicio que has generado con la herramienta
create-service-account
en el paso 4: Crea cuentas de servicio.Puedes ver los archivos de la cuenta de servicio en cada directorio de gráficos correspondiente.
Los nombres predeterminados de los directorios de gráficos correspondientes a las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio de gráficos 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 de gráficos PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes artículos:
-
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
FILEPATHLa ruta y el nombre de archivo de las cuentas de servicio de los archivos JSON en el directorio de gráficos correspondiente. Proporcione los nombres con la ruta relativa al directorio del gráfico. directory. Por ejemplo: - Si el archivo
my-project-apigee-synchronizer.json
se encuentra en el directorio del gráficoapigee-env/
, solo tienes que proporcionar el nombre del archivo, como este:synchronizer: "FILE_NAME.json"
- Si el archivo se encuentra en un directorio
apigee-env/service-accounts/
, debes especificar una ruta relativa:synchronizer: "service-accounts/FILE_NAME.json"
En los entornos que no son de producción, el nombre de la cuenta de servicio única es
PROJECT_ID-non-prod.json
de forma predeterminada.En los entornos de producción, el nombre del archivo de clave de cuenta de servicio que has generado con la herramienta
create-service-account
en el paso 4: Crea cuentas de servicio.Puedes ver los archivos de la cuenta de servicio en cada directorio de gráficos correspondiente.
Los nombres predeterminados de los directorios de gráficos correspondientes a las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio de gráficos 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 de gráficos PROJECT_ID-non-prod.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes artículos:
-
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
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina 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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.No producción
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina 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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.WIF para GKE
Producción
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
EMAILLas direcciones de correo de las cuentas de servicio de Google (GSAs) que debes proporcionar si utilizas Workload Identity Federation para GKE. Estas son las cuentas de servicio que has creado en el paso 4: Crea cuentas de servicio. Puedes encontrar las direcciones de correo de las cuentas de servicio con el siguiente comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Consulta los siguientes artículos:
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
SERVICE_ACCOUNT_
EMAILLas direcciones de correo de las cuentas de servicio de Google (GSAs) que debes proporcionar si utilizas Workload Identity Federation para GKE. Estas son las cuentas de servicio que has creado en el paso 4: Crea cuentas de servicio. Puedes encontrar las direcciones de correo de las cuentas de servicio con el siguiente comando: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"
Consulta los siguientes artículos:
No producción
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.NON_PROD_
SERVICE_ACCOUNT_
EMAILDirecciones de correo de la cuenta de servicio de Google (GSA) que no es de producción. Esta es la cuenta de servicio apigee-non-prod
que has creado en el paso 4: Crea cuentas de servicio.Si utilizas Workload Identity Federation para GKE en una instalación que no es de producción, especifica la dirección de correo de la cuenta de servicio en la propiedad
gcp.workloadIdentity.gsa
. No tendrá que añadir la propiedadgsa
a ningún componente.Puedes encontrar las direcciones de correo 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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina 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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.NON_PROD_
SERVICE_ACCOUNT_
EMAILDirecciones de correo de la cuenta de servicio de Google (GSA) que no es de producción. Esta es la cuenta de servicio apigee-non-prod
que has creado en el paso 4: Crea cuentas de servicio.Si utilizas Workload Identity Federation para GKE en una instalación que no es de producción, especifica la dirección de correo de la cuenta de servicio en la propiedad
gcp.workloadIdentity.gsa
. No tendrá que añadir la propiedadgsa
a ningún componente.Puedes encontrar las direcciones de correo 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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.WIF en otras plataformas
WIF: secrets
Producción
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
WORKLOAD_IDENTITY_
SECRETNombre del secreto de Kubernetes que has usado para configurar las 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 artículos:
-
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
WORKLOAD_IDENTITY_
SECRETNombre del secreto de Kubernetes que has usado para configurar las 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 artículos:
-
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
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
WORKLOAD_IDENTITY_
SECRETNombre del secreto de Kubernetes que has usado para configurar las 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 artículos:
-
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
WORKLOAD_IDENTITY_
SECRETNombre del secreto de Kubernetes que has usado para configurar las 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 artículos:
-
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
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHLa ruta y el nombre de archivo de las cuentas de los archivos de configuración de credenciales que has creado en el paso 5: Configura la autenticación de la cuenta de servicio. Proporcione los nombres con la ruta relativa al directorio del gráfico. directory. Por ejemplo:
- Si el archivo
apigee-synchronizer-credential-configuration.json
se encuentra en el directorio del gráficoapigee-env/
, solo tienes que proporcionar el nombre del archivo, como este:synchronizer: "FILE_NAME.json"
- Si el archivo se encuentra en un directorio
apigee-env/service-accounts/
, debes especificar una ruta relativa:synchronizer: "service-accounts/FILE_NAME.json"
Los nombres predeterminados de los directorios de gráficos correspondientes a las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio de gráficos 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 de gráficos apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes artículos:
-
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHLa ruta y el nombre de archivo de las cuentas de los archivos de configuración de credenciales que has creado en el paso 5: Configura la autenticación de la cuenta de servicio. Proporcione los nombres con la ruta relativa al directorio del gráfico. directory. Por ejemplo:
- Si el archivo
apigee-synchronizer-credential-configuration.json
se encuentra en el directorio del gráficoapigee-env/
, solo tienes que proporcionar el nombre del archivo, como este:synchronizer: "FILE_NAME.json"
- Si el archivo se encuentra en un directorio
apigee-env/service-accounts/
, debes especificar una ruta relativa:synchronizer: "service-accounts/FILE_NAME.json"
Los nombres predeterminados de los directorios de gráficos correspondientes a las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio de gráficos 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 de gráficos apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes artículos:
-
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
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHLa ruta y el nombre de archivo de las cuentas de los archivos de configuración de credenciales que has creado en el paso 5: Configura la autenticación de la cuenta de servicio. Proporcione los nombres con la ruta relativa al directorio del gráfico. directory. Por ejemplo:
- Si el archivo
apigee-synchronizer-credential-configuration.json
se encuentra en el directorio del gráficoapigee-env/
, solo tienes que proporcionar el nombre del archivo, como este:synchronizer: "FILE_NAME.json"
- Si el archivo se encuentra en un directorio
apigee-env/service-accounts/
, debes especificar una ruta relativa:synchronizer: "service-accounts/FILE_NAME.json"
Los nombres predeterminados de los directorios de gráficos correspondientes a las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio de gráficos 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 de gráficos apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes artículos:
-
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHLa ruta y el nombre de archivo de las cuentas de los archivos de configuración de credenciales que has creado en el paso 5: Configura la autenticación de la cuenta de servicio. Proporcione los nombres con la ruta relativa al directorio del gráfico. directory. Por ejemplo:
- Si el archivo
apigee-synchronizer-credential-configuration.json
se encuentra en el directorio del gráficoapigee-env/
, solo tienes que proporcionar el nombre del archivo, como este:synchronizer: "FILE_NAME.json"
- Si el archivo se encuentra en un directorio
apigee-env/service-accounts/
, debes especificar una ruta relativa:synchronizer: "service-accounts/FILE_NAME.json"
Los nombres predeterminados de los directorios de gráficos correspondientes a las cuentas de servicio son los siguientes:
Producción
Nombre del archivo de la cuenta de servicio Directorio de gráficos 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 de gráficos apigee-non-prod-credential-configuration.json
apigee-datastore/
apigee-org/
apigee-telemetry/
Consulta los siguientes artículos:
-
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
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina 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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.No producción
Template
Los valores de red, bold italics son valores de propiedad que debe proporcionar. Puedes editar sus valores en esta página. Se describen en la tabla de abajo.
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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina 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 debe proporcionar en el archivo de anulaciones. Para obtener más información, consulta la referencia de la propiedad de configuración.
Variable Descripción UNIQUE_INSTANCE_
IDENTIFIERUna cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
Puedes crear varias organizaciones en el mismo clúster, pero el
instanceID
debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.Consulta
instanceID
.APIGEE_NAMESPACE El espacio de nombres de Kubernetes de 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, debes asignar a este valor la misma región en la que se ejecuta el clúster. En el resto de las plataformas, selecciona la región de analíticas más cercana a tu clúster que admita analíticas (consulta la tabla del paso 2 de la parte 1: crea una organización). Este es el valor que has asignado a la variable de entorno
ANALYTICS_REGION
anteriormente.Consulta
gcp.region
.AUDIENCE Audiencia permitida del proveedor de identidades de carga de trabajo. Para encontrar el valor, busca el término audience:
en cualquiera de los archivos de configuración de las credenciales. El valor de la audiencia 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 de audiencia será similar al siguiente (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 Nombre del clúster de Kubernetes. Se trata del 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. Este es el valor que has asignado a la variable de entorno
CLUSTER_LOCATION
anteriormente.Consulta
k8sCluster.location
.ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME
.Consulta
org
.CONTROL_PLANE_
LOCATIONObligatorio si usas la residencia de datos con tu instalación híbrida de Apigee. Es la ubicación en la que se almacena el contenido principal del cliente, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee. 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 interfaz de usuario, tal como se explica en el Paso 3: Crea un grupo de entornos de la sección Configuración de proyectos y organizaciones. Consulta
envs[].name
.ENVIRONMENT_GROUP_
NAMENombre del grupo de entornos al que están asignados tus entornos. Este es el grupo que has creado en Configuración del proyecto y de la organización - Paso 3: Crea un grupo de entorno. Este es el valor asignado a la variable de entorno ENV_GROUP
.Consulta
virtualhosts[].name
.INGRESS_NAME El nombre de la pasarela de entrada de Apigee de tu implementación. Puede ser cualquier nombre que cumpla los siguientes requisitos: - Tener una longitud máxima de 17 caracteres
- Contener solo caracteres alfanuméricos en minúscula, guiones ("-") o puntos (".").
- Empezar con un carácter alfanumérico
- Terminar con un carácter alfanumérico
Consulta los siguientes artículos:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEIntroduce la ruta y el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 6: Crea certificados TLS. Estos archivos deben estar en el directorio APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs
. Por ejemplo:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
Consulta los siguientes artículos:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(Opcional) Se trata de un par clave-valor que proporciona anotaciones para tu servicio de entrada predeterminado. Tu plataforma en la nube usa anotaciones para ayudarte a configurar tu instalación híbrida. Por ejemplo, puedes definir el tipo de balanceador de carga 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.
Comenta o elimina esta sección si no la usas.
Consulta
ingressGateways[].svcAnnotations
.Resumen
El archivo de configuración indica a Kubernetes cómo desplegar los componentes híbridos en un clúster. A continuación, habilitarás el acceso del sincronizador para que los planos de gestión y de tiempo de ejecución de Apigee puedan comunicarse.
Paso siguiente
1 2 3 4 5 6 7 Paso 8(SIGUIENTE): Habilita el acceso al plano de control 9 10 11