Referencia de la propiedad de configuración

En esta sección se enumeran todas las propiedades de configuración que puede usar para personalizar el plano de tiempo de ejecución de su implementación híbrida de Apigee.

Filtrar esta página

Para filtrar las propiedades que se muestran en esta página, seleccione Básico (las propiedades más habituales) o Avanzado (las propiedades que rara vez necesitan cambios):

Pantalla   propiedades de configuración en esta página.

Propiedades de nivel superior

En la siguiente tabla se describen las propiedades de nivel superior del archivo overrides.yaml. Estas son propiedades que no pertenecen a otro objeto y se aplican a nivel de organización o de entorno:

Propiedad Tipo Descripción
axHashSalt Avanzado

Introducido en la versión: 1.3.0

Valor predeterminado: iloveapis123

Optional

Nombre de un secreto de Kubernetes que contiene un salt usado al calcular hashes para ofuscar los datos de usuario antes de que se envíen a las analíticas de Apigee. Si no especificas ningún valor de salt, se usa iloveapis123 de forma predeterminada. Crea el secreto con el valor de la sal como entrada. Puedes usar la misma sal en varios clústeres para asegurarte de que los resultados del cifrado hash sean coherentes entre los clústeres.

Apigee usa SHA512 para cifrar con tecnología hash el valor original antes de enviar datos del plano de ejecución al plano de control.

Consulte Ofuscar datos de usuario para analíticas.
contractProvider Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: https://apigee.googleapis.com

Define la ruta de la API de todas las APIs de tu instalación.

Obligatorio si tu instalación híbrida usa residencia de datos en el siguiente formato: 

contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com

CONTROL_PLANE_LOCATION es la ubicación donde se almacenan los datos del plano de control, como los paquetes proxy. Para ver una lista, consulta Regiones disponibles del plano de control de la API de Apigee.

Por ejemplo:

contractProvider: https://us-apigee.googleapis.com
gcpProjectID Avanzado Deprecated: En la versión 1.2.0 y posteriores, usa gcp.projectID.

Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Obligatorio

ID de tu proyecto de Google Cloud. Funciona con k8sClusterName (obsoleto) y gcpRegion (obsoleto) para identificar el proyecto y determinar dónde envían sus datos apigee-logger y apigee-metrics.
gcpRegion Avanzado Deprecated: En la versión 1.2.0 y posteriores, usa gcp.region.

Introducido en la versión: 1.0.0

Valor predeterminado: us-central1

Obligatorio

La región o zona de Google Cloud más cercana a tu clúster de Kubernetes. Funciona con gcpProjectID (obsoleto) y k8sClusterName (obsoleto) para identificar el proyecto y determinar dónde envían sus datos apigee-logger y apigee-metrics.
hub Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: ninguno

URL de un repositorio de contenedores de imágenes privadas que se usa para extraer imágenes de todos los componentes de Apigee de un repositorio privado.

hub proporciona una ruta predeterminada para todos los componentes de Apigee hybrid. Si usas un repositorio privado, usa hub para definir la URL del repositorio de todos los componentes en lugar de usar la propiedad image.url individual para cada componente. Solo debe configurar URLs individuales si utiliza un repositorio independiente para un componente específico.

La ruta de la imagen de cada componente será el valor de hub más el nombre y la etiqueta de la imagen del componente.

Por ejemplo, si el valor de hub private-docker-host.example.com, los componentes individuales resolverán automáticamente la ruta de la imagen: 

hub: private-docker-host.example.com

como:

## an example of internal component vs 3rd party
containers:
- name: apigee-udca
  image: private-docker-host.example.com/apigee-udca:1.13.4
  imagePullPolicy: IfNotPresent

containers:
- name: apigee-ingressgateway
  image: private-docker-host.example.com/apigee-asm-ingress:1.18.7-asm.4-distroless
  imagePullPolicy: IfNotPresent

Los demás componentes seguirán un patrón similar.

Usa apigee-pull-push --list para ver la URL del repositorio actual de todos los componentes.

Consulta Usar un repositorio de imágenes privado con Apigee hybrid.

Puede anular la URL de la imagen de los componentes de forma individual con las siguientes propiedades:
imagePullSecrets.name Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Nombre del secreto de Kubernetes configurado como tipo docker-registry. Se usa para extraer imágenes de un repositorio privado.
instanceID Básico Introducido en la versión: 1.3.0

Valor predeterminado: ninguno

Obligatorio

Identificador único de esta instalación.

Una cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.
k8sClusterName Avanzado Deprecated: En la versión 1.2.0 y posteriores, usa k8sCluster.name y k8sCluster.region en su lugar.

Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Nombre del proclúster de Kubernetes (K8S) en el que se ejecuta tu proyecto híbrido. Funciona con gcpProjectID (obsoleto) y gcpRegion (obsoleto) para identificar el proyecto y determinar dónde envían sus datos apigee-logger y apigee-metrics.
kmsEncryptionKey Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: defaults.org.kmsEncryptionKey

Opcional. Usa solo uno de los campos kmsEncryptionKey, kmsEncryptionPath o kmsEncryptionSecret.

Ruta del sistema de archivos local de la clave de cifrado de los datos del KMS de Apigee.
kmsEncryptionPath Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Opcional. Usa solo uno de los campos kmsEncryptionKey, kmsEncryptionPath o kmsEncryptionSecret.

Ruta a un archivo que contiene una clave de cifrado codificada en base64. Consulta Cifrado de datos.
kmsEncryptionSecret.key Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Opcional. Usa solo uno de los campos kmsEncryptionKey, kmsEncryptionPath o kmsEncryptionSecret.

La clave de un secreto de Kubernetes que contiene una clave de cifrado codificada en base64. Consulta Cifrado de datos.
kmsEncryptionSecret.name Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Opcional. Usa solo uno de los campos kmsEncryptionKey, kmsEncryptionPath o kmsEncryptionSecret.

Nombre de un secreto de Kubernetes que contiene una clave de cifrado codificada en base64. Consulta Cifrado de datos.
kvmEncryptionKey Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: defaults.org.kmsEncryptionKey

Opcional. Usa solo uno de los siguientes campos: kvmEncryptionKey, kvmEncryptionPath o kvmEncryptionSecret.

Ruta del sistema de archivos local de la clave de encriptado de los datos de KVM de Apigee.
kvmEncryptionPath Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Opcional. Usa solo uno de los siguientes campos: kvmEncryptionKey, kvmEncryptionPath o kvmEncryptionSecret.

Ruta a un archivo que contiene una clave de cifrado codificada en base64. Consulta Cifrado de datos.
kvmEncryptionSecret.key Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Opcional. Usa solo uno de los siguientes campos: kvmEncryptionKey, kvmEncryptionPath o kvmEncryptionSecret.

La clave de un secreto de Kubernetes que contiene una clave de cifrado codificada en base64. Consulta Cifrado de datos.
kvmEncryptionSecret.name Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Opcional. Usa solo uno de los siguientes campos: kvmEncryptionKey, kvmEncryptionPath o kvmEncryptionSecret.

Nombre de un secreto de Kubernetes que contiene una clave de cifrado codificada en base64. Consulta Cifrado de datos.
multiOrgCluster Avanzado Introducido en la versión: 1.10.0

Valor predeterminado: false

En el caso de los clústeres de varias organizaciones, esta propiedad permite exportar las métricas de la organización al proyecto indicado en la propiedad gcp.projectID. Aplica este ajuste en el archivo de anulaciones de cada organización de un clúster de varias organizaciones. Para obtener más información, consulta Añadir varias organizaciones híbridas a un clúster.

namespace Básico Introducido en la versión: 1.0.0

Valor predeterminado: apigee

El espacio de nombres de tu clúster de Kubernetes en el que se instalarán los componentes de Apigee.
org Básico

Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Obligatorio

La organización habilitada para el modo híbrido que Apigee te proporcionó durante la instalación híbrida. Una organización es el contenedor de nivel superior de Apigee. Contiene todos tus proxies de API y recursos relacionados. Si el valor está vacío, debes actualizarlo con el nombre de tu organización una vez que la hayas creado.
orgScopedUDCA Avanzado Introducido en la versión: 1.8.0

Valor predeterminado: true

Habilita el servicio Universal Data Collection Agent (UDCA) a nivel de organización, que extrae analíticas, monetización y depuración (seguimiento) y lo envía a la plataforma de analíticas unificada (UAP), que reside en el plano de control.

UDCA con ámbito de organización usa una sola cuenta de servicio de Google para todos los entornos de Apigee. La cuenta de servicio debe tener el rol Agente de analíticas de Apigee (roles/apigee.analyticsAgent).

Especifica la ruta al archivo de clave de la cuenta de servicio con la propiedad udca.serviceAccountPath o proporciona la clave en un secreto de Kubernetes con la propiedad udca.serviceAccountRef en el archivo de configuración overrides.yaml.

Si prefiere usar un agente de UDCA independiente para cada entorno, defina orgScopedUDCA: false y los valores de envs[].serviceAccountPaths.udca y envs[].serviceAccountSecretRefs.udca.

Consulta también udca.

revision Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: "1134" (tu versión de Apigee Hybrid sin puntos. Por ejemplo, en la versión 1.12.0, el valor predeterminado es "1120".

Apigee hybrid admite actualizaciones continuas de Kubernetes, que permiten que las actualizaciones de despliegue se realicen sin tiempo de inactividad actualizando de forma incremental las instancias de Pod con otras nuevas.

Cuando se actualizan ciertas anulaciones de YAML que provocan un cambio en el PodTemplateSpec de Kubernetes subyacente, también se debe cambiar la propiedad de anulación revision en el override.yaml del cliente. Esto es necesario para que el controlador ApigeeDeployment (AD) de Kubernetes subyacente pueda llevar a cabo una actualización gradual segura de la versión anterior a la nueva. Puedes usar cualquier valor de texto en minúsculas, como blue, a o 1.0.0.

Cuando se cambia y se aplica la propiedad revision, se produce una actualización gradual de todos los componentes.

Para cambiar las propiedades de los siguientes objetos, es necesario actualizar revision:

Para obtener más información, consulta Actualizaciones continuas.
serviceAccountSecretProviderClass Avanzado Introducido en la versión: 1.12.0

Valor predeterminado: ninguno

Nombre de la clase de proveedor de secretos específica de la organización (SecretProviderClass) que se usa para almacenar claves de cuenta de servicio en Vault.

Consulta Almacenar claves de cuentas de servicio en HashiCorp Vault.

validateOrg Avanzado Introducido en la versión: 1.8.0

Valor predeterminado: true

Habilita la validación estricta del vínculo entre la organización de Apigee y el proyecto de Google Cloud, y comprueba si existen grupos de entornos.

Consulta también org.

validateServiceAccounts Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: true

Habilita la validación estricta de los permisos de la cuenta de servicio. Para ello, se usa el método testIamPermissions de la API Cloud Resource Manager, que verifica que la cuenta de servicio proporcionada tiene los permisos necesarios. En el caso de las cuentas de servicio de una organización de Apigee, la comprobación del ID de proyecto es la que se asigna a la organización. En el caso de las métricas y los registradores, el proyecto que se comprueba se basa en la configuración gcpProjectID overrides.yaml.

Consulta también gcpProjectID.

ao

Los operadores de Apigee (AO) crean y actualizan recursos de Kubernetes e Istio de bajo nivel que son necesarios para desplegar y mantener un componente. Por ejemplo, el controlador lleva a cabo la liberación de procesadores de mensajes.

En la siguiente tabla se describen las propiedades del objeto ao de apigee-operators:

Propiedad Tipo Descripción
ao.args.disableIstioConfigInAPIServer Avanzado Introducido en la versión: 1.8.0

Valor predeterminado: true

Impide que Apigee proporcione configuración a la malla de servicios de Cloud instalada por el cliente.

  • Definir como true para las instalaciones híbridas que usan la pasarela de entrada de Apigee.
  • false para instalaciones híbridas que usen Cloud Service Mesh (versiones 1.8 y anteriores de Apigee hybrid).
ao.args.disableManagedClusterRoles Avanzado Introducido en la versión: 1.10.0

Valor predeterminado: true

Cuando se usa true (el valor predeterminado), Apigee hybrid no gestiona Kubernetes ClusterRole y ClursterRoleBinding directamente. Si tienes un proceso que requiere gestionar estos recursos, debe llevarlo a cabo un usuario con los permisos correctos.

ao.image.pullPolicy Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: IfNotPresent

Determina cuándo kubelet extrae la imagen Docker del pod. Estos son algunos de los posibles valores:

  • IfNotPresent: no descargues una imagen nueva si ya existe.
  • Always: siempre extrae la imagen, independientemente de si ya existe.

Para obtener más información, consulta Actualizar imágenes.
ao.image.tag Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: 1.13.4

La etiqueta de versión de la imagen Docker de este servicio.
ao.image.url Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Ubicación de la imagen Docker de este servicio.

Usa apigee-pull-push --list para ver la URL del repositorio actual de este componente.
ao.resources.limits.cpu Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: 250m

Límite de CPU del recurso en un contenedor de Kubernetes, en milinúcleos.
ao.resources.limits.memory Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: 256Mi

Límite de memoria del recurso en un contenedor de Kubernetes, en mebibytes.
ao.resources.requests.cpu Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: 250m

La CPU necesaria para el funcionamiento normal del recurso en un contenedor de Kubernetes, en milinúcleos.
ao.resources.requests.memory Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: 256Mi

La memoria necesaria para el funcionamiento normal del recurso en un contenedor de Kubernetes, en mebibytes.
ao.tolerations.effect Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: ninguno

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

effect especifica el efecto que tendrá la coincidencia de una tolerancia con un taint. Los valores de effect pueden ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Para obtener más información, consulta Taints y tolerancias: conceptos.
ao.tolerations.key Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: ninguno

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

key identifica los pods a los que se puede aplicar la tolerancia.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
ao.tolerations.operator Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: "Equal"

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

operator especifica la operación que se usa para activar effect. Los valores de operator pueden ser:

  • Equal coincide con el valor definido en value.
  • Exists ignora el valor definido en value.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
ao.tolerations.tolerationSeconds Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: ninguno

Usada por la función Tolerancias e intolerancias de Kubernetes.

tolerationSeconds define en segundos cuánto tiempo permanece un pod enlazado a un nodo que falla o no responde.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
ao.tolerations.value Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: ninguno

Usada por la función Tolerancias e intolerancias de Kubernetes.

value es el valor que activa el effect cuando operator se define como Equal.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).

apigeeIngressGateway

Configura la pasarela de entrada de Apigee para Apigee Hybrid. Usa las propiedades apigeeIngressGateway para aplicar una configuración común a todas las instancias de la pasarela de entrada de Apigee.

Consulta ingressGateways para configurar instancias individuales de forma única.

Aplica cambios a las propiedades de apigeeIngressGateway con el gráfico apigee-org.

En la siguiente tabla se describen las propiedades del objeto apigeeIngressGateway:

Propiedad Tipo Descripción
apigeeIngressGateway.image.pullPolicy Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: IfNotPresent

Determina cuándo kubelet extrae la imagen Docker del pod. Estos son algunos de los posibles valores:

  • IfNotPresent: no descargues una imagen nueva si ya existe.
  • Always: siempre extrae la imagen, independientemente de si ya existe.

Para obtener más información, consulta Actualizar imágenes.
apigeeIngressGateway.image.tag Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: 1.18.7-asm.4-distroless

La etiqueta de versión de la imagen Docker de este servicio.
apigeeIngressGateway.image.url Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: ninguno

Ubicación de la imagen Docker de este servicio.

Usa apigee-pull-push --list para ver la URL del repositorio actual de este componente.
apigeeIngressGateway.nodeSelector.key Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: ninguno

Obligatorio

Clave de etiqueta del selector de nodos que se usa para orientar los nodos de Kubernetes dedicados a los servicios de la pasarela de entrada.

Consulta Configurar grupos de nodos dedicados.
apigeeIngressGateway.nodeSelector.value Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: ninguno

Valor de etiqueta de selector de nodos opcional que se usa para orientar los nodos de Kubernetes dedicados a los servicios de puerta de enlace de entrada y anular la configuración de nodeSelector.apigeeData.

Consulta nodeSelector.
apigeeIngressGateway.replicaCountMax Básico Introducido en la versión: 1.11.0

Valor predeterminado: 4

El número máximo de pods que puede añadir automáticamente el sistema híbrido para la puerta de enlace de entrada disponible para el autoescalado.
apigeeIngressGateway.replicaCountMin Básico Introducido en la versión: 1.11.0

Valor predeterminado: 2

El número mínimo de pods de la puerta de enlace de entrada disponibles para el autoescalado.
apigeeIngressGateway.targetCPUUtilizationPercentage Avanzado Introducido en la versión: 1.10.5, 1.11.2 y 1.12.1

Valor predeterminado: 75

Umbral de uso de CPU para escalar el número de pods del ReplicaSet, como porcentaje del total de recursos de CPU disponibles.

Cuando el uso de la CPU supera este valor, el modo híbrido aumentará gradualmente el número de pods del ReplicaSet hasta apigeeIngressGateway.replicaCountMax.

Para obtener más información sobre el escalado en Kubernetes, consulta el artículo sobre el autoescalado horizontal de pods en la documentación de Kubernetes.

apigeeIngressGateway.tolerations.effect Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: ninguno

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

effect especifica el efecto que tendrá la coincidencia de una tolerancia con un taint. Los valores de effect pueden ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Para obtener más información, consulta Taints y tolerancias: conceptos.
apigeeIngressGateway.tolerations.key Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: ninguno

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

key identifica los pods a los que se puede aplicar la tolerancia.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
apigeeIngressGateway.tolerations.operator Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: "Equal"

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

operator especifica la operación que se usa para activar effect. Los valores de operator pueden ser:

  • Equal coincide con el valor definido en value.
  • Exists ignora el valor definido en value.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
apigeeIngressGateway.tolerations.tolerationSeconds Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: ninguno

Usada por la función Tolerancias e intolerancias de Kubernetes.

tolerationSeconds define en segundos cuánto tiempo permanece un pod enlazado a un nodo que falla o no responde.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
apigeeIngressGateway.tolerations.value Avanzado Introducido en la versión: 1.11.0

Valor predeterminado: ninguno

Usada por la función Tolerancias e intolerancias de Kubernetes.

value es el valor que activa el effect cuando operator se define como Equal.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).

cassandra

Define el servicio híbrido que gestiona el repositorio de datos de tiempo de ejecución. Este repositorio almacena configuraciones de aplicaciones, contadores de cuota distribuidos, claves de API y tokens de OAuth para aplicaciones que se ejecutan en la pasarela.

Para obtener más información, consulta Configuración de StorageClass.

En la siguiente tabla se describen las propiedades del objeto cassandra:

Propiedad Tipo Descripción
cassandra.annotations Avanzado Introducido en la versión: 1.5.0

Valor predeterminado: ninguno

Mapa de clave-valor opcional que se usa para anotar pods. Para obtener más información, consulta Anotaciones personalizadas.
cassandra.auth.admin.password Básico Introducido en la versión: 1.0.0

Valor predeterminado: iloveapis123

Obligatorio

Contraseña del administrador de Cassandra. El usuario administrador se usa para cualquier actividad administrativa que se realice en el clúster de Cassandra, como crear y restaurar copias de seguridad.
cassandra.auth.ddl.password Básico Introducido en la versión: 1.0.0

Valor predeterminado: iloveapis123

Obligatorio

Contraseña del usuario del lenguaje de definición de datos (DDL) de Cassandra. Usada por MART para cualquiera de las tareas de definición de datos, como la creación, la actualización y la eliminación de espacios de claves.
cassandra.auth.default.password Básico Introducido en la versión: 1.0.0

Valor predeterminado: iloveapis123

Obligatorio

La contraseña del usuario predeterminado de Cassandra que se crea cuando se habilita la autenticación. Esta contraseña debe restablecerse al configurar la autenticación de Cassandra. Consulta Configurar TLS para Cassandra.
cassandra.auth.dml.password Básico Introducido en la versión: 1.0.0

Valor predeterminado: iloveapis123

Obligatorio

Contraseña del usuario del lenguaje de manipulación de datos (DML) de Cassandra. El usuario de DML lo usa la comunicación del cliente para leer y escribir datos en Cassandra.
cassandra.auth.image.pullPolicy Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: IfNotPresent

Determina cuándo kubelet extrae la imagen Docker del pod. Estos son algunos de los posibles valores:

  • IfNotPresent: no descargues una imagen nueva si ya existe.
  • Always: siempre extrae la imagen, independientemente de si ya existe.

Para obtener más información, consulta Actualizar imágenes.
cassandra.auth.image.tag Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 1.13.4

La etiqueta de versión de la imagen Docker de este servicio.
cassandra.auth.image.url Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Ubicación de la imagen Docker de este servicio.

Usa apigee-pull-push --list para ver la URL del repositorio actual de este componente.
cassandra.auth.jmx.password Básico Introducido en la versión: 1.4.0

Valor predeterminado: iloveapis123

Obligatorio

Contraseña del usuario de operaciones JMX de Cassandra. Se usa para autenticar y comunicarse con la interfaz JMX de Cassandra.
cassandra.auth.jmx.username Básico Introducido en la versión: 1.4.0

Valor predeterminado: jmxuser

Obligatorio

Nombre de usuario del usuario de operaciones JMX de Cassandra. Se usa para autenticar y comunicarse con la interfaz JMX de Cassandra.
cassandra.auth.jolokia.password Básico Introducido en la versión: 1.4.0

Valor predeterminado: iloveapis123

Obligatorio

Contraseña del usuario de operaciones JMX de Jolokia de Cassandra. Se usa para autenticar y comunicarse con la API JMX de Cassandra.
cassandra.auth.jolokia.username Básico Introducido en la versión: 1.4.0

Valor predeterminado: apigee

Obligatorio

Nombre de usuario del usuario de operaciones JMX de Jolokia de Cassandra. Se usa para autenticar y comunicarse con la API JMX de Cassandra.
cassandra.auth.secret Básico Introducido en la versión: 1.3.3

Valor predeterminado: ninguno

Nombre del archivo almacenado en un secreto de Kubernetes que contiene los usuarios y las contraseñas de Cassandra. Para crear el secreto, sigue estas instrucciones: Crea el secreto.

Consulta también:
cassandra.auth.secretProviderClass Avanzado Introducido en la versión: 1.10.3

Valor predeterminado: ninguno

Política de almacenamiento de secretos de Cassandra. Si se define, debe coincidir con SecretProviderClass que hace referencia al proveedor de secretos externo, como Hashicorp Vault. Si no se define, Apigee hybrid usa los nombres de usuario y las contraseñas almacenados en:

o el secreto de Kubernetes almacenado en:

Consulta Almacenar secretos de Cassandra en HashiCorp Vault para obtener instrucciones sobre cómo crear la política.
cassandra.backup.cloudProvider Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: GCP

El nombre de un proveedor de copias de seguridad. Valores admitidos: GCP, HYBRID y CSI. Asigna el valor:

  • GCP para almacenar archivos de copias de seguridad en Google Cloud Storage.
  • HYBRID para almacenar archivos de copia de seguridad en un servidor SSH remoto.
  • CSI (recomendado) para usar snapshots de volúmenes de CSI de Kubernetes para crear copias de seguridad. Para obtener información sobre la CSIcopia de seguridad y la restauración de plataformas en la nube como Google Cloud, AWS y Azure, consulta Copia de seguridad y restauración de CSI.
cassandra.backup.dbStorageBucket Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Obligatorio si la copia de seguridad está habilitada y cassandra.backup.cloudProvider tiene el valor GCP.

Nombre de un segmento de Google Cloud Storage que se usará para almacenar archivos de copia de seguridad. Consulta Crear segmentos si necesitas crear uno.
cassandra.backup.enabled Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: false

La copia de seguridad de los datos no está habilitada de forma predeterminada. Para habilitarlo, selecciona true.

Consulta Copia de seguridad y recuperación de Cassandra.
cassandra.backup.gsa Avanzado Introducido en la versión: 1.10.0

Valor predeterminado: ninguno

Solo Helm: dirección de correo de la cuenta de servicio de gestión de identidades y accesos de Google (IAM) apigee-cassandra que se asociará a la cuenta de servicio de Kubernetes de la copia de seguridad de Cassandra al habilitar Workload Identity en clústeres de GKE. Define este valor cuando hayas asignado true a gcp.workloadIdentity.enabled y true a cassandra.backup.enabled.

Las direcciones de correo de GSA suelen tener el siguiente formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Por ejemplo:

apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com

Consulta Habilitar Workload Identity Federation en GKE.
cassandra.backup.image.pullPolicy Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: IfNotPresent

Determina cuándo kubelet extrae la imagen Docker del pod. Estos son algunos de los posibles valores:

  • IfNotPresent: no descargues una imagen nueva si ya existe.
  • Always: siempre extrae la imagen, independientemente de si ya existe.

Para obtener más información, consulta Actualizar imágenes.
cassandra.backup.image.tag Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 1.13.4

La etiqueta de versión de la imagen Docker de este servicio.
cassandra.backup.image.url Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Ubicación de la imagen Docker de este servicio.

Usa apigee-pull-push --list para ver la URL del repositorio actual de este componente.
cassandra.backup.keyfile Avanzado Introducido en la versión: 1.3.0

Valor predeterminado: ninguno

Obligatorio si la copia de seguridad está habilitada y cassandra.backup.cloudProvider tiene el valor HYBRID.

Ruta del archivo de clave privada SSH en tu sistema de archivos local.
cassandra.backup.schedule Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 0 2 * * *

La programación de la tarea cron de la copia de seguridad.

Consulta Copia de seguridad y recuperación de Cassandra.
cassandra.backup.server Avanzado Introducido en la versión: 1.3.0

Valor predeterminado: ninguno

Obligatorio si la copia de seguridad está habilitada y cassandra.backup.cloudProvider tiene el valor HYBRID.

La dirección IP de tu servidor de copia de seguridad SSH remoto.
cassandra.backup.serviceAccountPath Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Ruta a un archivo de clave de cuenta de servicio de Google que tenga el rol Administrador de objetos de Storage (roles/storage.objectAdmin). Esta cuenta de servicio de Google se usará para subir archivos de copia de seguridad a un cassandra.backup.dbStorageBucket especificado.

Si la copia de seguridad está habilitada y cassandra.backup.cloudProvider está configurado como GCP, se debe cumplir uno de los siguientes requisitos para que Apigee Hybrid pueda acceder al segmento de Google Cloud Storage y subir archivos de copia de seguridad:

cassandra.backup.serviceAccountRef Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Nombre de un secreto de Kubernetes que almacena el contenido de un archivo de claves de cuenta de servicio de Google que tiene el rol Administrador de objetos de almacenamiento (roles/storage.objectAdmin). Esta cuenta de servicio de Google se usará para subir archivos de copia de seguridad a un cassandra.backup.dbStorageBucket especificado.

Si la copia de seguridad está habilitada y cassandra.backup.cloudProvider está configurado como GCP, se debe cumplir uno de los siguientes requisitos para que Apigee Hybrid pueda acceder al segmento de Google Cloud Storage y subir archivos de copia de seguridad:

cassandra.backup.storageDirectory Avanzado Introducido en la versión: 1.3.0

Valor predeterminado: ninguno

Obligatorio si la copia de seguridad está habilitada y cassandra.backup.cloudProvider tiene el valor HYBRID.

Puede ser una ruta absoluta o relativa al directorio principal del usuario apigee.

Nombre del directorio de copia de seguridad en el servidor SSH de copia de seguridad.
cassandra.clusterName Básico Introducido en la versión: 1.0.0

Valor predeterminado: apigeecluster

Especifica el nombre del clúster de Cassandra.
cassandra.datacenter Básico Introducido en la versión: 1.0.0

Valor predeterminado: dc-1

Especifica el centro de datos del nodo de Cassandra.
cassandra.dnsPolicy Básico Introducido en la versión: 1.1.1

Valor predeterminado: ninguno

Si asignas el valor true a hostNetwork, la política de DNS se establecerá en ClusterFirstWithHostNet automáticamente.

cassandra.externalSeedHost Básico Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Nombre de host o IP de un nodo de clúster de Cassandra. Si no se define, se usa el servicio local de Kubernetes.
cassandra.heapNewSize Básico Introducido en la versión: 1.0.0

Valor predeterminado: 100M

Cantidad de memoria del sistema JVM asignada a objetos más recientes, en megabytes.

cassandra.hostNetwork Básico Introducido en la versión: 1.1.1

Valor predeterminado: false

Habilita la función de Kubernetes hostNetwork. Apigee usa esta función en instalaciones multirregión para comunicarse entre pods si el espacio de nombres de la red de pods no tiene conectividad entre clústeres (los clústeres se ejecutan en "modo de red aislada"), que es el caso predeterminado en instalaciones que no son de GKE, como Google Distributed Cloud en VMware o bare metal, GKE en AWS, AKS, EKS y OpenShift.

Define cassandra.hostNetwork como false para instalaciones de una sola región y de varias regiones con conectividad entre pods de diferentes clústeres, como las instalaciones de GKE.

Define cassandra.hostNetwork como true para instalaciones multirregión sin comunicación entre pods de diferentes clústeres, como Google Distributed Cloud en VMware o bare metal, GKE en AWS, AKS, EKS e instalaciones de OpenShift. Consulta los requisitos previos para el despliegue multirregional.

Cuando true, política de DNS se establece automáticamente en ClusterFirstWithHostNet.
cassandra.image.pullPolicy Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: IfNotPresent

Determina cuándo kubelet extrae la imagen Docker del pod. Estos son algunos de los posibles valores:

  • IfNotPresent: no descargues una imagen nueva si ya existe.
  • Always: siempre extrae la imagen, independientemente de si ya existe.

Para obtener más información, consulta Actualizar imágenes.
cassandra.image.tag Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 1.13.4

La etiqueta de versión de la imagen Docker de este servicio.
cassandra.image.url Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Ubicación de la imagen Docker de este servicio.

Usa apigee-pull-push --list para ver la URL del repositorio actual de este componente.
cassandra.maxHeapSize Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 512M

El límite superior de la memoria del sistema JVM disponible para las operaciones de Cassandra, en megabytes.

cassandra.multiRegionSeedHost Básico Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Dirección IP de un clúster de Cassandra que se usa para ampliar un clúster a una nueva región. Consulta Configurar el host de inicialización multirregional.

cassandra.nodeSelector.key Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Obligatorio

Clave de etiqueta del selector de nodos que se usa para orientar los nodos de Kubernetes dedicados a los servicios de datos de cassandra.

Consulta Configurar grupos de nodos dedicados.
cassandra.nodeSelector.value Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Valor de etiqueta de selector de nodo opcional que se usa para orientar los nodos de Kubernetes dedicados a los servicios de datos cassandra y anular la configuración de nodeSelector.apigeeData.

Consulta nodeSelector.
cassandra.port Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 9042

Número de puerto usado para conectarse a Cassandra.
cassandra.rack Básico Introducido en la versión: 1.0.0

Valor predeterminado: ra-1

Especifica el rack del nodo de Cassandra.
cassandra.readinessProbe.failureThreshold Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 2

Número de veces que Kubernetes verificará que las sondas de disponibilidad han fallado antes de marcar el pod como no disponible. El valor mínimo es 1.
cassandra.readinessProbe.initialDelaySeconds Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 0

Número de segundos que deben transcurrir después de iniciar un contenedor para que se inicie una sonda de disponibilidad.
cassandra.readinessProbe.periodSeconds Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 10

Determina la frecuencia con la que se realiza una comprobación de disponibilidad (en segundos). El valor mínimo es 1.
cassandra.readinessProbe.successThreshold Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 1

Número mínimo de éxitos consecutivos necesarios para que una sonda de disponibilidad se considere correcta después de un fallo. El valor mínimo es 1.
cassandra.readinessProbe.timeoutSeconds Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 5

Número de segundos tras los cuales se agota el tiempo de espera de una prueba de actividad. El valor mínimo es 1.
cassandra.replicaCount Básico Introducido en la versión: 1.0.0

Valor predeterminado: 1

Cassandra es una base de datos replicada. Esta propiedad especifica el número de nodos de Cassandra empleados como StatefulSet.
cassandra.resources.requests.cpu Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 500m

La CPU necesaria para el funcionamiento normal del recurso en un contenedor de Kubernetes, en milinúcleos.
cassandra.resources.requests.memory Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 1Gi

La memoria necesaria para el funcionamiento normal del recurso en un contenedor de Kubernetes, en mebibytes.
cassandra.restore.cloudProvider Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: GCP

Nombre de un proveedor de restauración. Valores admitidos: GCP, HYBRID y CSI. Asigna el valor:

  • GCP para restaurar datos a partir de una copia de seguridad almacenada en Google Cloud Storage.
  • HYBRID para restaurar datos a partir de una copia de seguridad almacenada en un servidor SSH remoto.
  • CSI (opción recomendada) para usar las instantáneas de volumen de CSI de Kubernetes para la restauración. Para obtener información sobre la CSIcopia de seguridad y la restauración de plataformas en la nube como Google Cloud, AWS y Azure, consulta Copia de seguridad y restauración de CSI.
cassandra.restore.dbStorageBucket Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Obligatorio si la restauración está habilitada y cassandra.restore.cloudProvider tiene el valor GCP.

Nombre de un segmento de Google Cloud Storage que almacena archivos de copia de seguridad que se usarán para restaurar datos.
cassandra.restore.enabled Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: false

La restauración de datos no está habilitada de forma predeterminada. Para habilitarlo, selecciona true.

Consulta Copia de seguridad y recuperación de Cassandra.
cassandra.restore.gsa Avanzado Introducido en la versión: 1.10.0

Valor predeterminado: ninguno

Solo Helm: dirección de correo de la cuenta de servicio de apigee-cassandra Google IAM que se asociará a la cuenta de servicio de Kubernetes de restauración de Cassandra al habilitar Workload Identity en clústeres de GKE. Define este valor cuando hayas asignado true a gcp.workloadIdentity.enabled y true a cassandra.restore.enabled.

Las direcciones de correo de GSA suelen tener el siguiente formato:

GSA_NAME@PROJECT_ID.iam.gserviceaccount.com

Por ejemplo:

apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com

Consulta Habilitar Workload Identity Federation en GKE.
cassandra.restore.image.pullPolicy Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: IfNotPresent

Determina cuándo kubelet extrae la imagen Docker del pod. Estos son algunos de los posibles valores:

  • IfNotPresent: no descargues una imagen nueva si ya existe.
  • Always: siempre extrae la imagen, independientemente de si ya existe.

Para obtener más información, consulta Actualizar imágenes.
cassandra.restore.image.tag Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 1.13.4

La etiqueta de versión de la imagen Docker de este servicio.
cassandra.restore.image.url Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Ubicación de la imagen Docker de este servicio.

Usa apigee-pull-push --list para ver la URL del repositorio actual de este componente.
cassandra.restore.serviceAccountPath Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Ruta a un archivo de clave de cuenta de servicio de Google que tenga el rol Administrador de objetos de Storage (roles/storage.objectAdmin). Esta cuenta de servicio de Google se usará para descargar archivos de copia de seguridad de un cassandra.restore.dbStorageBucket especificado.

Si la restauración está habilitada y cassandra.restore.cloudProvider está configurado como GCP, se requiere una de las siguientes opciones para asegurarse de que Apigee Hybrid pueda acceder al segmento de Google Cloud Storage para descargar los archivos de copia de seguridad para la restauración:

cassandra.restore.serviceAccountRef Avanzado Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Nombre de un secreto de Kubernetes que almacena el contenido de un archivo de claves de cuenta de servicio de Google que tiene el rol Administrador de objetos de almacenamiento (roles/storage.objectAdmin). Esta cuenta de servicio de Google se usará para descargar archivos de copia de seguridad de un cassandra.restore.dbStorageBucket especificado.

Si la restauración está habilitada y cassandra.restore.cloudProvider está configurado como GCP, se requiere una de las siguientes opciones para asegurarse de que Apigee Hybrid pueda acceder al segmento de Google Cloud Storage para descargar los archivos de copia de seguridad para la restauración:

cassandra.restore.snapshotTimestamp Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Obligatorio si la restauración está habilitada.

Marca de tiempo de la copia de seguridad que se debe restaurar.
cassandra.sslCertPath Básico Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Ruta de tu sistema a un archivo de certificado TLS.
cassandra.sslKeyPath Básico Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

Ruta de tu sistema al archivo de clave privada TLS.
cassandra.sslRootCAPath Básico Introducido en la versión: 1.2.0

Valor predeterminado: ninguno

La cadena de certificados de la AC raíz (autoridad de certificación).
cassandra.storage.capacity Básico Introducido en la versión: 1.0.0

Valor predeterminado: 10Gi

Obligatorio si se especifica storage.storageclass

Especifica el tamaño de disco necesario en mebibytes (Mi) o gibibytes (Gi).
cassandra.storage.storageclass Básico Introducido en la versión: 1.0.0

Valor predeterminado: ninguno

Especifica la clase de almacenamiento local que se está usando.
cassandra.storage.storageSize Básico Introducido en la versión: 1.11.0

Valor predeterminado: 10Gi

Obligatorio si se especifica storage.storageclass

Especifica el tamaño de disco necesario en mebibytes (Mi) o gibibytes (Gi).
cassandra.terminationGracePeriodSeconds Avanzado Introducido en la versión: 1.0.0

Valor predeterminado: 300

Tiempo transcurrido entre una solicitud de eliminación de un pod y el momento en que se elimina, en segundos. Durante este periodo, se ejecutarán los hooks prestop y se cerrará correctamente cualquier proceso en ejecución.
cassandra.tolerations.effect Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: ninguno

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

effect especifica el efecto que tendrá la coincidencia de una tolerancia con un taint. Los valores de effect pueden ser:

  • NoExecute
  • NoSchedule
  • PreferNoSchedule

Para obtener más información, consulta Taints y tolerancias: conceptos.
cassandra.tolerations.key Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: ninguno

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

key identifica los pods a los que se puede aplicar la tolerancia.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
cassandra.tolerations.operator Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: "Equal"

Es necesario para usar la función Tolerancias e intolerancias de Kubernetes.

operator especifica la operación que se usa para activar effect. Los valores de operator pueden ser:

  • Equal coincide con el valor definido en value.
  • Exists ignora el valor definido en value.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
cassandra.tolerations.tolerationSeconds Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: ninguno

Usada por la función Tolerancias e intolerancias de Kubernetes.

tolerationSeconds define en segundos cuánto tiempo permanece un pod enlazado a un nodo que falla o no responde.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).
cassandra.tolerations.value Avanzado Introducido en la versión: 1.10.1

Valor predeterminado: ninguno

Usada por la función Tolerancias e intolerancias de Kubernetes.

value es el valor que activa el effect cuando operator se define como Equal.

Para obtener más información, consulta Taints and Tolerations: Concepts (Taints y tolerancias: conceptos).

certManager

Apigee usa cert-manager para validar los certificados.

En la siguiente tabla se describen las propiedades del objeto certManager:

Propiedad Tipo Descripción
certManager.namespace Avanzado Introducido en la versión: 1.9.0

Valor predeterminado: cert-manager

El espacio de nombres de cert-manager.

Consulta Ejecutar cert-manager en un espacio de nombres personalizado.

connectAgent

Apigee Connect permite que el plano de gestión de Apigee hybrid se conecte de forma segura al servicio MART del plano de entorno de ejecución sin que tengas que exponer el endpoint de MART en Internet.

En la siguiente tabla se describen las propiedades del objeto connectAgent:

Propiedad Tipo Descripción
connectAgent.annotations Avanzado Introducido en la versión: 1.5.0

Valor predeterminado: ninguno

Mapa de clave-valor opcional que se usa para anotar pods. Para obtener más información, consulta