Gérer les composants du plan d'exécution

Cet article explique comment configurer et gérer les composants du plan d'exécution Apigee hybrid.

À propos du fichier de remplacement

La première fois que vous installez l'environnement d'exécution hybride dans un cluster, vous devez créer un fichier de remplacement de configuration. Ce fichier vous permet de fournir les valeurs de propriété requises pour installer la version hybride, telles que le nom de votre projet Google, le nom de votre organisation, les détails de l'environnement, les fichiers de certificat, etc. Vous pouvez également remplacer certaines valeurs par défaut pour la plupart des composants hybrides dans le fichier de remplacement. Pour obtenir la liste complète des propriétés configurables, consultez la documentation de référence sur les propriétés de configuration.

Les étapes d'installation du système hybride décrivent le processus de création d'un fichier de remplacement et le processus d'application de votre configuration à un cluster. Si vous souhaitez modifier la configuration ultérieurement, modifiez le fichier de remplacement que vous avez créé, puis appliquez-le à nouveau. Consultez la section Modifier une configuration.

Modifier une configuration

Pour modifier la configuration d'un composant du plan d'exécution hybride, modifiez votre fichier de remplacement et appliquez les modifications avec apigeectl. Pour obtenir la liste complète des propriétés configurables, consultez la documentation de référence sur les propriétés de configuration.

Par exemple, pour activer le composant logger, mettez à jour le fichier de remplacement et appliquez-le à nouveau :

Ouvrez le fichier de remplacement. Veillez à utiliser le même fichier de remplacement que celui utilisé pour installer l'environnement d'exécution hybride dans le cluster.
Recherchez l'élément logger dans le fichier. Exemple :
```
...
logger:
  enabled: false
...
```
Remplacez la valeur de la propriété par true :
```
...
  logger:
  enabled: true
...
```
Utilisez apigeectl pour appliquer la modification au cluster :
```
$APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry
```
L'option --telemetry indique à apigeectl de ne mettre à jour que le composant de journalisation. Pour en savoir plus sur les paramètres de champ d'application, tels que --telemetry, consultez la section Champs d'application pour appliquer apigeectl.

Quelles propriétés de configuration pouvez-vous modifier ?

Vous trouverez la liste complète des propriétés configurables dans la documentation de référence sur les propriétés de configuration. La référence ne répertorie que les propriétés que vous pouvez modifier. Si vous essayez de modifier une propriété qui ne figure pas dans la référence, la modification est ignorée.

Comment utiliser la référence de configuration ?

La documentation de référence sur la propriété de configuration utilise la notation par points pour décrire les éléments de configuration. Le premier élément est le nom de l'élément de niveau supérieur suivi des propriétés et des propriétés enfants. Exemple :

authz.image.pullPolicy

Dans le fichier de remplacement, les propriétés sont au format YAML approprié. Dans l'exemple ci-dessus, l'élément authz de niveau supérieur est mis en retrait à gauche et les propriétés des sous-éléments sont mis en retrait juste en-dessous. Le code YAML requiert également le signe "deux-points" à la fin de chaque élément et sous-élément.

Par exemple, pour définir la propriété authz.image.pullPolicy sur Always, recherchez ce stanza YAML dans le fichier de remplacement et définissez-le comme suit :

authz:
  image:
    pullPolicy: Always

Autre exemple, la propriété cassandra.auth.admin.password (telle qu'elle est répertoriée dans la référence de la propriété Configuration) est utilisée pour définir le mot de passe administrateur Cassandra. Pour le modifier, localisez le code YAML suivant dans le fichier de remplacement et définissez-le comme suit :

cassandra:
  auth:
    admin:
      password: abc123

N'oubliez pas que la référence sur les propriétés de configuration décrit toutes les propriétés que vous pouvez définir dans des composants de plan d'exécution hybride. Suivez le modèle expliqué ci-dessus pour modifier ces éléments dans votre fichier de remplacement avant d'appliquer les modifications à votre cluster.

À propos de la configuration par défaut

Apigee conserve la configuration de ses composants par défaut dans le fichier $HYBRID_FILES/config/values.yaml. Ce fichier spécifie, si possible, des valeurs par défaut pour chaque composant hybride.

Vos fichiers de remplacement suivent la même structure YAML que values.yaml. Toutefois, un fichier de remplacement n'inclut qu'un sous-ensemble des propriétés de configuration trouvées dans values.yaml. N'oubliez pas que toutes les propriétés ne sont pas modifiables. Lorsque vous appliquez une configuration à un cluster, vos remplacements sont fusionnés avec les valeurs par défaut pour créer la configuration complète du cluster Kubernetes.

Si vous souhaitez modifier les valeurs par défaut d'un composant et que le composant ne se trouve pas déjà dans votre fichier de remplacement, vous pouvez copier son fichier YAML depuis values.yaml dans votre fichier de remplacement et le modifier à partir de ce dernier.

Ne modifiez jamais values.yaml directement. utilisez toujours un fichier de remplacement pour spécifier les propriétés de configuration.

Utiliser un exemple prédéfini de fichier de remplacement

Apigee fournit un ensemble d'exemples de fichiers de remplacement pour vous aider à configurer votre déploiement hybride. Il est recommandé de copier et de modifier le fichier de remplacement qui correspond le mieux à vos exigences d'installation.

Les exemples suivants sont inclus dans le répertoire $APIGEECTL_HOME/examples :

Exemples de fichiers de remplacement	Description
`overrides-small.yaml`	Cet exemple est idéal pour débuter et progresser rapidement. Il utilise l'empreinte minimale recommandée pour démarrer les composants d'exécution hybride. Cet exemple de configuration repose autant que possible sur les paramètres et les valeurs par défaut. Toutes les instances dupliquées minimales sont définies sur `1`.
`overrides-medium.yaml`	Cet exemple constitue un bon point de départ pour les environnements de test et de contrôle qualité. Des composants individuels se sont vus attribuer un niveau supérieur de ressources pour traiter le trafic supplémentaire. Cassandra utilise des disques SSD pour améliorer les performances. Dans cet environnement, il est recommandé aux utilisateurs d'installer des composants avec état et sans état sur des nœuds distincts. Consultez la section Configurer des nœuds dédiés.
`overrides-large.yaml`	Cet exemple constitue un bon point de départ pour les environnements hautes performances tels que la préproduction et la production. L'exemple comprend des propriétés permettant de définir des clés de chiffrement, des mots de passe, etc. Les composants individuels disposent d'au moins deux instances dupliquées.
`private-overrides.yaml`	Cet exemple montre comment utiliser des images à partir d'un dépôt d'images privé. Consultez la page Utiliser un dépôt d'images privé.

Annotations personnalisées

Les annotations sont des mappages clé-valeur permettant d'associer des métadonnées à des pods Kubernetes. Vous pouvez créer des annotations personnalisées pour les propriétés des composants hybrides suivantes, indiquées dans la documentation de référence sur les propriétés de configuration :

Pour ajouter une annotation de paire nom/valeur personnalisée, ouvrez votre fichier de remplacement et ajoutez un stanza annotations pour le composant correspondant, puis appliquez la modification avec apigeectl. Exemple :

runtime:
  annotations:
    businessunit: "bu1"

Utiliser des dry runs (tests à blanc) pour tester les modifications de configuration

Vous pouvez utiliser l'option --dry-run avec apigeectl pour tester votre fichier de configuration de remplacement sans l'appliquer réellement à votre cluster. Cette option est utile pour déboguer un problème d'installation, car elle indique exactement ce qui sera appliqué au cluster.

Dans Apigee hybrid, la syntaxe de l'option --dry-run dépend de la version de kubectl que vous exécutez. Vérifiez la version de kubectl à l'aide de la commande suivante :

kubectl version

kubectl version 1.17 ou antérieure :

$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true

kubectl version 1.18 et ultérieure :

  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client

Créer plusieurs fichiers de remplacement selon vos besoins

Vous pouvez créer plusieurs fichiers de remplacement, chacun répondant à une exigence spécifique. Par exemple, vous pouvez disposer d'un fichier de remplacement qui ajuste votre cluster pour la production, et d'un autre fichier pour la création d'un cluster pour les tests. Vous pouvez ensuite conserver ces fichiers dans votre système de gestion de code source.

Utilisez la commande apigeectl apply pour appliquer un fichier de remplacement au cluster. Exemple :

$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml

Supprimer des composants d'exécution

La commande apigeectl delete fournit des options qui vous permettent de supprimer tout ou partie des composants d'exécution hybride installés. Pour en savoir plus sur l'utilisation des commandes, consultez la page de la documentation de référence sur apigeectl. Consultez également la page Désinstaller l'environnement d'exécution hybride.

Supprimer un environnement

Pour supprimer complètement un environnement, vous devez le supprimer à la fois au niveau de l'environnement d'exécution (local) et au niveau de la gestion (cloud). Pour plus d'informations, consultez la page Supprimer des environnements.