Paso 6: Configura el entorno de ejecución híbrido

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.

Por convención, las anulaciones de configuración se escriben en un archivo llamado overrides.yaml en el directorio $HYBRID_FILES/overrides.

  1. Crea un archivo llamado overrides.yaml en el directorio $HYBRID_FILES/overrides. Por ejemplo: 
    vi $HYBRID_FILES/overrides/overrides.yaml

    El archivo overrides.yaml proporciona la configuración de tu instalación única de Apigee hybrid. El archivo de anulaciones de este paso proporciona una configuración básica para una instalación de tiempo de ejecución híbrida con un tamaño reducido, adecuada para tu primera instalación.

  2. En overrides.yaml, añade los valores de propiedad obligatorios que se muestran a continuación. A continuación, también se incluye una descripción detallada de cada propiedad:

    No producción

    Asegúrate de que el archivo overrides.yaml tenga la siguiente estructura y sintaxis. Los valores de red, bold italics son valores de propiedad que debe proporcionar. Se describen en la tabla de abajo.

    Hay diferencias entre las distintas plataformas en cuanto a la región del proyecto de Google Cloud y la región del clúster de Kubernetes. Elige la plataforma en la que vas a instalar Apigee Hybrid.

    gcp:
  region: ANALYTICS_REGION
  projectID: GCP_PROJECT_ID

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Must be the closest Google Cloud region to your cluster.
org: ORG_NAME

instanceID: "UNIQUE_INSTANCE_IDENTIFIER"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and multi-region installations
    # with connectivity between pods in different clusters, for example GKE installations.
    # Set to true  for multi-region installations with no communication between
    # pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,
    # AKS, EKS, and OpenShift installations.
    # See Multi-region deployment: Prerequisites

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: ./certs/CERT_NAME.pem
  sslKeyPath: ./certs/KEY_NAME.key

ao:
  args:
  # This configuration is introduced in hybrid v1.8
    disableIstioConfigInAPIServer: true

# This configuration is introduced in hybrid v1.8
ingressGateways:
- name: INGRESS_NAME # maximum 17 characters.
  replicaCountMin: 2
  replicaCountMax: 10
  # You do not need to set Annotations or LoadBalancerIP if you are creating your own Kubernetes
  # service for ingress deployment. In prod, it's recommended to create your own Kubernetes service.
  # See: Expose Apigee ingress gateway.
  svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383.
    SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE
  svcLoadBalancerIP: SVC_LOAD_BALANCER_IP  # optional

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    synchronizer: NON_PROD_SERVICE_ACCOUNT_FILEPATH
      # For example: "./service-accounts/GCP_PROJECT_ID-apigee-non-prod.json"
    udca: NON_PROD_SERVICE_ACCOUNT_FILEPATH
    runtime: NON_PROD_SERVICE_ACCOUNT_FILEPATH

mart:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

connectAgent:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

metrics:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

udca:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

watcher:
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

logger:
  enabled: false
        # Set to false to disable logger for GKE installations.
        # Set to true for all platforms other than GKE.
        # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

    Producción

    Asegúrate de que el archivo overrides.yaml tenga la siguiente estructura y sintaxis. Los valores de red, bold italics son valores de propiedad que debe proporcionar. Se describen en la tabla de abajo.

    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.

    Hay diferencias entre las distintas plataformas en cuanto a la región del proyecto de Google Cloud y la región del clúster de Kubernetes. Elige la plataforma en la que vas a instalar Apigee Hybrid. 

    gcp:
  region: ANALYTICS_REGION
  projectID: GCP_PROJECT_ID

k8sCluster:
  name: CLUSTER_NAME
  region: CLUSTER_LOCATION # Must be the closest Google Cloud region to your cluster.
org: ORG_NAME

instanceID: "UNIQUE_INSTANCE_IDENTIFIER"

cassandra:
  hostNetwork: false
    # Set to false for single region installations and multi-region installations
    # with connectivity between pods in different clusters, for example GKE installations.
    # Set to true  for multi-region installations with no communication between
    # pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,
    # AKS, EKS, and OpenShift installations.
    # See Multi-region deployment: Prerequisites
  storage:
    capacity: 500Gi
  resources:
    requests:
      cpu: 7
      memory: 15Gi
  maxHeapSize: 8192M
  heapNewSize: 1200M
    # Minimum storage requirements for a production environment.
    # See Configure Cassandra for production.

virtualhosts:
- name: ENVIRONMENT_GROUP_NAME
  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME
  sslCertPath: ./certs/CERT_NAME.pem
  sslKeyPath: ./certs/KEY_NAME.key

ao:
  args:
  # This configuration is introduced in hybrid v1.8
    disableIstioConfigInAPIServer: true

# This configuration is introduced in hybrid v1.8
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

envs:
- name: ENVIRONMENT_NAME
  serviceAccountPaths:
    synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_FILEPATH
      # For example: "./service-accounts/GCP_PROJECT_ID-apigee-synchronizer.json"
    udca: UDCA_SERVICE_ACCOUNT_FILEPATH
      # For example: "./service-accounts/GCP_PROJECT_ID-apigee-udca.json"
    runtime: RUNTIME_SERVICE_ACCOUNT_FILEPATH
      # For example: "./service-accounts/GCP_PROJECT_ID-apigee-runtime.json"

mart:
  serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
        # For example: "./service-accounts/GCP_PROJECT_ID-apigee-mart.json"

connectAgent:
  serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
        # Use the same service account for mart and connectAgent

metrics:
  serviceAccountPath: METRICS_SERVICE_ACCOUNT_FILEPATH
        # For example: "./service-accounts/GCP_PROJECT_ID-apigee-metrics.json"

udca:
  serviceAccountPath: UDCA_SERVICE_ACCOUNT_FILEPATH
        # For example: "./service-accounts/GCP_PROJECT_ID-apigee-udca.json"

watcher:
  serviceAccountPath: WATCHER_SERVICE_ACCOUNT_FILEPATH
        # For example: "./service-accounts/GCP_PROJECT_ID-apigee-watcher.json"

logger:
  enabled: false
        # Set to false to disable logger for GKE installations.
        # Set to true for all platforms other than GKE.
        # See apigee-logger in Service accounts and roles used by hybrid components.
  serviceAccountPath: LOGGER_SERVICE_ACCOUNT_FILEPATH
        # For example: "./service-accounts/GCP_PROJECT_ID-apigee-logger.json"

    Ejemplo

    En el siguiente ejemplo se muestra un archivo de anulaciones completado con valores de propiedad de ejemplo añadidos:

    gcp:
  region: us-central1
  projectID: hybrid-example

k8sCluster:
  name: apigee-hybrid
  region: us-central1

org: hybrid-example

instanceID: "my_hybrid_example"

cassandra:
  hostNetwork: false

virtualhosts:
- name: example-env-group
  selector:
    app: apigee-ingressgateway
    ingress_name: my-ingress-1
  sslCertPath: ./certs/keystore.pem
  sslKeyPath: ./certs/keystore.key

ao:
  args:
    disableIstioConfigInAPIServer: true

ingressGateways:
- name: my-ingress-1
  replicaCountMin: 2
  replicaCountMax: 10

envs:
- name: test
  serviceAccountPaths:
    synchronizer: ./service-accounts/my-hybrid-project-apigee-non-prod.json
      # for production environments, my-hybrid-project-apigee-synchronizer.json
    udca: ./service-accounts/my-hybrid-project-apigee-non-prod.json
      # for production environments, my-hybrid-project-apigee-udca.json
    runtime: ./service-accounts/my-hybrid-project-apigee-non-prod.json
      # for production environments, my-hybrid-project-apigee-runtime.json

mart:
  serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
    # for production environments, my-hybrid-project-apigee-mart.json

connectAgent:
  serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
    # for production environments, example-hybrid-apigee-mart.json

metrics:
  serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
    # for production environments, my-hybrid-project-apigee-metrics.json

udca:
  serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
    # for production environments, my-hybrid-project-apigee-udca.json

watcher:
  serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
    # for production environments, my-hybrid-project-apigee-watcher.json

logger:
  enabled: false # Set to "false" for GKE. Set to "true" for all other Kubernetes platforms.
  serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
    # for production environments, LOGGER_SERVICE_ACCOUNT_NAME.json
  3. Cuando hayas terminado, guarda el archivo.

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
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.
GCP_PROJECT_ID Identifica el proyecto de Google Cloud en el que apigee-logger y apigee-metrics envían sus datos. Este es el valor asignado a la variable de entorno PROJECT_ID.
CLUSTER_NAME Nombre del clúster de Kubernetes. Se trata del valor asignado a la variable de entorno CLUSTER_NAME.
CLUSTER_LOCATION La región en la que se ejecuta el clúster. Esta es la región en la que 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.
ORG_NAME ID de tu organización de Apigee Hybrid. Este es el valor asignado a la variable de entorno ORG_NAME.
UNIQUE_INSTANCE_IDENTIFIER

Una cadena única para identificar esta instancia. Puede ser cualquier combinación de letras y números de hasta 63 caracteres.

Puedes crear varias organizaciones en el mismo clúster, pero el instanceID debe ser el mismo para todas las organizaciones del mismo clúster de Kubernetes.
ENVIRONMENT_GROUP_NAME Nombre 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.
CERT_NAME
KEY_NAME		 Introduce el nombre de los archivos de clave y certificado TLS autofirmados que has generado anteriormente en el paso 5: Crea certificados TLS. Estos archivos deben estar en el directorio base_directory/hybrid-files/certs. Por ejemplo: 
sslCertPath: ./certs/keystore.pem
sslKeyPath: ./certs/keystore.key
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 ingressGateways[].name en la referencia de la propiedad de configuración.

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 las 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.
SVC_LOAD_BALANCER_IP (Opcional) En las plataformas que admiten la especificación de la dirección IP del balanceador de carga, este se creará con esa dirección IP. En las plataformas que no te permiten especificar la IP del balanceador de carga, esta propiedad se ignora.
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.
*_SERVICE_ACCOUNT_FILEPATH La ruta y el nombre de archivo de las cuentas de servicio JSON en tu directorio service-accounts/. Los nombres deben incluir la ruta al archivo de la cuenta de servicio. Puede ser una ruta completa o una ruta relativa a tu directorio hybrid-files/. Si incluye una ruta relativa, debe llamar a apigeectl, el comando para aplicar esta configuración, desde su directorio hybrid-files/.

En los entornos que no son de producción, el nombre de la cuenta de servicio única es GCP_PROJECT_ID-non-prod.json de forma predeterminada.

En los entornos de producción, el nombre del archivo de clave de la cuenta de servicio que has generado con la herramienta create-service-account en Configuración del tiempo de ejecución híbrido - Paso 4: Crea credenciales y cuentas de servicio.

Puedes ver la lista de archivos de cuentas de servicio en tu directorio service-accounts/.

Los nombres predeterminados de las cuentas de servicio del entorno de producción son los siguientes:

  • Cassandra: GCP_PROJECT_ID-apigee-cassandra.json
  • Registro: GCP_PROJECT_ID-apigee-logger.json
  • MART: GCP_PROJECT_ID-apigee-mart.json
  • Conectar agente: GCP_PROJECT_ID-apigee-mart.json
  • Métricas: GCP_PROJECT_ID-apigee-metrics.json
  • Tiempo de ejecución de Apigee: GCP_PROJECT_ID-
  • Sincronizador: GCP_PROJECT_ID-apigee-synchronizer.json
  • UDCA: GCP_PROJECT_ID-apigee-udca.json
  • Watcher: GCP_PROJECT_ID-apigee-watcher.json
.

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.

1 2 3 4 5 6 Paso 7: Habilita el acceso al sincronizador 8 9 10