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.
- Assurez-vous d'être dans le répertoire
hybrid-base-directory/hybrid-files
. - Copiez le fichier
overrides-small.yaml
du répertoire
dans votre répertoire$APIGEECTL_HOME
/examplesoverrides
:cp
$APIGEECTL_HOME
/examples/overrides-small.yaml ./overrides/overrides.yamlCet exemple de fichier fournit une configuration de base pour une installation d'exécution hybride à faible empreinte, une configuration adaptée à votre première installation.
cd
dans le répertoireoverrides
:- Ouvrez
overrides.yaml
et ajoutez les valeurs de propriété requises, comme indiqué ci-dessous. Une description détaillée de chaque propriété est également fournie ci-dessous :Syntaxe
La structure et la syntaxe du fichier
overrides.yaml
sont les 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.gcp: region: gcp-region projectID: gcp-project-id k8sCluster: name: cluster-name region: cluster-region org: org-name virtualhosts: - name: virtual-host-name hostAliases: - "host-alias-1" - "host-alias-2" - "host-alias-n" sslCertPath: ./certs/cert-name.pem sslKeyPath: ./certs/key-name.key routingRules: - paths: - /path-1 - /path-2 - /path-n env: environment-name envs: - name: environment-name # The same name of the env you created in the UI serviceAccountPaths: synchronizer: ./service-accounts/synchronizer-service-account-name.json udca: ./service-accounts/udca-service-account-name.json mart: hostAlias: mart-host-alias serviceAccountPath: ./service-accounts/mart-service-account-name.json sslCertPath: ./certs/mart-cert-name.pem sslKeyPath: ./certs/mart-key-name.key metrics: serviceAccountPath: ./service-accounts/metrics-service-account-name.json logger: enabled: false
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: my-gcp-project k8sCluster: name: apigee-hybrid region: us-central1 org: hybrid-org virtualhosts: - name: default hostAliases: - "*.acme.com" sslCertPath: ./certs/keystore.pem sslKeyPath: ./certs/keystore.key routingRules: # - paths: - env: my-environment envs: - name: test serviceAccountPaths: synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json udca: ./service-accounts/hybrid-project-apigee-udca.json mart: hostAlias: "mart.apigee-hybrid-docs.net" serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json sslCertPath: ./certs/fullchain.pem sslKeyPath: ./certs/privkey.key metrics: serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json logger: enabled: false
- Lorsque vous avez terminé, enregistrez le fichier.
cd overrides
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 |
---|---|
gcp-region | Identifie la région GCP dans laquelle apigee-logger et apigee-metrics transfèrent leurs données. |
gcp-project-id | Identifie le projet Google Cloud dans lequel apigee-logger et apigee-metrics envoient leurs données. |
cluster-name | Le nom de votre cluster Kubernetes. |
cluster-region | Région dans laquelle le cluster a été créé. |
org-name | Nom de votre organisation hybride Apigee |
virtual-host-name | Nom permettant d'identifier l'hôte virtuel. |
host-alias (1 - n) | (Obligatoire) Nom DNS qualifié pour l'environnement. Vous pouvez utiliser un caractère générique partiel, tel que |
cert-name key-name |
Saisissez le nom de la clé TLS autosignée et des fichiers de certificat que vous avez générés précédemment à l'étape Créer des identifiants TLS pour la passerelle d'exécution. Ces fichiers doivent se trouver dans le répertoire base_directory/hybrid-files/certs . Exemple :
sslCertPath: ./certs/keystore.pem sslKeyPath: ./certs/keystore.key |
path (1 - n) | Les règles de routage dirigent les appels d'API vers les chemins fournis vers l'environnement mentionné.
Les chemins d'accès path-1 à path-n sont les chemins d'accès de base vers les proxys d'API déployés dans l'environnement nommé dans environment-name. paths: est facultatif. Le chemin par défaut est /. Voir aussi Configurer les hôtes virtuels.
paths: n'est pas obligatoire pour le moment. Supprimez ou commentez paths: ainsi que toute entrée du chemin d'accès. |
environment-name (sous routingRules ) |
Il s'agit de l'API d'environnement vers lequel les appels seront acheminés. 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 5 : Ajouter un environnement à l'interface utilisateur hybride. |
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 5 : Ajouter un environnement à l'interface utilisateur hybride. |
synchronizer-service-account-name | Le nom du fichier de clé du compte de service de synchronisation que vous avez généré avec l'outil create-service-account . Exemple :
synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json |
udca-service-account-name | Le nom du fichier de clé de compte de service udca que vous avez généré avec l'outil create-service-account . Exemple :
udca: ./service-accounts/hybrid-project-apigee-udca.json |
mart-host-alias | Un nom DNS qualifié pour le point de terminaison du serveur MART. Ce nom doit correspondre au nom commun utilisé dans le certificat TLS autorisé requis pour cette configuration.
For example,
mart.mydomain.com
|
mart-service-account-name | Le nom du fichier de clé du compte de service MART généré à l'aide de l'outil create-service-account . |
mart-cert-name mart-key-name |
Saisissez le nom de la clé TLS et des fichiers de certificat autorisés que vous avez générés précédemment à l'étape Créer des identifiants TLS pour la passerelle MART.
Ces fichiers doivent se trouver dans le répertoire base_directory/hybrid-files/certs . Exemple :
sslCertPath: ./certs/fullchain.pem sslKeyPath: ./certs/privkey.key |
metrics-service-account-name | Le nom du fichier de clé du compte de service de métrique généré à l'aide de l'outil create-service-account . Exemple :
serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json |
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 (SUIVANT) Étape 4 : Installer un environnement d'exécution hybride