Étape 6 : Configurer l'environnement d'exécution hybride

Spécifier des remplacements de configuration

Le programme d'installation d'Apigee hybrid utilise les valeurs par défaut pour de nombreux paramètres. Toutefois, certains paramètres n'ont pas de valeurs par défaut. Vous devez fournir des valeurs pour ces paramètres, comme expliqué ci-dessous.

  1. Assurez-vous d'être dans le répertoire hybrid-base-directory/hybrid-files/overrides/.
    cd hybrid-base-directory/hybrid-files/overrides
  2. Créez un fichier nommé overrides.yaml dans votre éditeur de texte préféré. Exemple :
    vi overrides.yaml

    Le fichier overrides.yaml fournit la configuration pour votre installation Apigee hybrid unique. Le fichier de remplacement utilisé à cette étape fournit une configuration de base pour une installation d'exécution Apigee hybrid peu encombrante, adaptée pour une première installation.

  3. Dans overrides.yaml, ajoutez les valeurs de propriété requises, indiquées ci-dessous. Vous trouverez ci-dessous une description détaillée de chaque propriété :

    Syntaxe

    Assurez-vous que le fichier overrides.yaml possède la structure et la syntaxe suivantes. Les valeurs de red, bold italics sont des valeurs de propriété que vous devez fournir. Elles sont décrites dans le tableau ci-dessous.

    Il existe des différences entre les différentes plates-formes pour la région du projet Google Cloud et la région du cluster Kubernetes. Choisissez la plate-forme sur laquelle vous installez Apigee hybrid.

    gcp:
      region: analytics-region
      projectID: gcp-project-id
    
    k8sCluster:
      name: cluster-name
      region: analytics-region # Must be the closest Google Cloud region to your cluster
    org: org-name
    
    instanceID: "unique-instance-identifier"
    
    cassandra:
      hostNetwork: false #Set this to `true` for GKE On-prem installations.
    
    virtualhosts:
      - name: environment-group-name
        sslCertPath: ./certs/cert-name.pem
        sslKeyPath: ./certs/key-name.key
    
    envs:
      - name: environment-name
        serviceAccountPaths:
          synchronizer: ./service-accounts/synchronizer-service-account-name.json
          udca: ./service-accounts/udca-service-account-name.json
    
    mart:
      serviceAccountPath: ./service-accounts/mart-service-account-name.json
    
    connectAgent:
      serviceAccountPath: ./service-accounts/mart-service-account-name.json
      # Same account used for mart and connectAgent
    
    metrics:
      serviceAccountPath: ./service-accounts/metrics-service-account-name.json
    
    watcher:
      serviceAccountPath: ./service-accounts/watcher-service-account-name.json
    
    logger:
      enabled: true # set to "false" for GKE.
      serviceAccountPath: ./service-accounts/logger-service-account-name.json
    

    Exemple

    L'exemple suivant montre un fichier de remplacement terminé avec des exemples de valeurs de propriété ajoutées :

    gcp:
      region: us-central1
      projectID: hybrid-example
    
    k8sCluster:
      name: apigee-hybrid
      region: us-central1
    
    org: hybrid-example
    
    instanceID: "my_hybrid_example"
    
    cassandra:
      hostNetwork: false # Set this to:
                         #   false for GKE installations.
                         #   true for GKE On-prem GKE on AWS, Anthos on bare metal,
                         #            AKS, EKS, and OpenShift installations.
    
    virtualhosts:
      - name: example-env-group
        sslCertPath: ./certs/keystore.pem
        sslKeyPath: ./certs/keystore.key
    
    envs:
      - name: test
        serviceAccountPaths:
          synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json
          udca: ./service-accounts/hybrid-project-apigee-udca.json
    
    mart:
      serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json
    
    connectAgent:
      serviceAccountPath: ./service-accounts/example-hybrid-apigee-mart.json
    
    metrics:
      serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json
    
    watcher:
      serviceAccountPath: ./service-accounts/hybrid-project-apigee-watcher.json
    
    logger:
      enabled: true # set to "false" for GKE.
      serviceAccountPath: ./service-accounts/logger-service-account-name.json
    
    
  4. Lorsque vous avez terminé, enregistrez le fichier.

Le tableau suivant décrit chacune des valeurs de propriété que vous devez fournir dans le fichier de remplacement. Pour en savoir plus, consultez la documentation de référence sur les propriétés de configuration.

Variable Description
analytics-region Dans GKE, vous devez définir cette valeur sur la même région que celle où le cluster est exécuté. Sur toutes les autres plates-formes, sélectionnez la région d'analyse la plus proche de votre cluster compatible avec Analytics (consultez le tableau de la Partie 1, Étape 4 : Créer une organisation).

Il s'agit de la valeur que vous avez précédemment attribuée à la variable d'environnement ANALYTICS_REGION.

gcp-project-id Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. Il s'agit de la valeur attribuée à la variable d'environnement PROJECT_ID.
cluster-name Le nom de votre cluster Kubernetes. Il s'agit de la valeur attribuée à la variable d'environnement CLUSTER_NAME.
org-name ID de votre organisation Apigee hybrid. Il s'agit de la valeur attribuée à la variable d'environnement ORG_NAME.
unique-instance-identifier

Une chaîne unique pour identifier cette instance. Vous pouvez utiliser n'importe quelle combinaison de lettres et de chiffres (jusqu'à 63 caractères).

Vous pouvez créer plusieurs organisations dans le même cluster, mais instanceId doit être identique pour toutes les organisations dans le même cluster Kubernetes.
environment-group-name Nom du groupe d'environnements auquel vos environnements sont attribués. Il s'agit du groupe que vous avez créé lors de la configuration du projet et de l'organisation - Étape 6 : Créer un groupe d'environnements. Il s'agit de la valeur attribuée à la variable d'environnement ENV_GROUP.
cert-name
key-name
Saisissez le nom de la clé et des fichiers de certificat TLS autosignés que vous avez générés précédemment à l'étape 3 : Installer apigeectl. Ces fichiers doivent se trouver dans le répertoire base_directory/hybrid-files/certs. Exemple :

sslCertPath: ./certs/keystore.pem
sslKeyPath: ./certs/keystore.key
environment-name Utilisez le même nom que celui que vous avez utilisé lors de la création d'un environnement dans l'interface utilisateur, comme expliqué à l'étape 6 "Créer un groupe d'environnements" de la configuration du projet et de l'organisation.
synchronizer-service-account-name Le nom du fichier de clé de compte de service apigee-synchronizer que vous avez généré avec l'outil create-service-account dans Configuration de l'environnement d'exécution hybride - Étape 6 : Créer des comptes de service et des identifiants. Vous pouvez consulter la liste des fichiers de compte de service dans votre répertoire service-accounts/. Exemple :

ls ../service-accounts/
udca-service-account-name Nom du fichier de clé du compte de service apigee-udca, généré à l'aide de l'outil create-service-account.
mart-service-account-name Nom du fichier de clé du compte de service apigee-mart, généré à l'aide de l'outil create-service-account.
metrics-service-account-name Nom du fichier de clé du compte de service apigee-metrics, généré à l'aide de l'outil create-service-account.
watcher-service-account-name Nom du fichier de clé du compte de service apigee-watcher, généré à l'aide de l'outil create-service-account.
logger-service-account-name Nom du fichier de clé du compte de service apigee-logger, généré à l'aide de l'outil create-service-account.

Résumé

Le fichier de configuration indique à Kubernetes comment déployer les composants hybrides sur un cluster. Vous allez ensuite appliquer cette configuration à votre cluster.

1 2 3 4 5 6 (SUIVANT) Étape 7 : Installer l'environnement d'exécution hybride