Variables d’environnement dans Cloud Manager environment-variables
Les variables d’environnement standard peuvent être configurées et gérées via Cloud Manager. Ils sont fournis à l’environnement d’exécution et peuvent être utilisés dans des configurations OSGi.
Les variables d’environnement peuvent être des valeurs spécifiques à un environnement ou des secrets d’environnement, en fonction de ce qui est modifié.
À propos des variables d’environnement overview
Les variables d’environnement offrent de nombreux avantages aux utilisateurs d’AEM as a Cloud Service, notamment :
- Elles permettent au comportement de votre code et de votre application de varier en fonction du contexte et de l’environnement. Par exemple, elles peuvent être utilisées pour activer différentes configurations dans l’environnement de développement par rapport aux environnements de production ou d’évaluation, afin d’éviter des erreurs coûteuses.
- Elles ne doivent être configurées et paramétrées qu’une seule fois, et peuvent être mises à jour et supprimées si nécessaire.
- Leurs valeurs peuvent être mises à jour à tout moment et prennent effet immédiatement sans qu’il faille apporter de modifications au code ni procéder à des déploiements.
- Elles peuvent séparer le code de la configuration et supprimer la nécessité d’inclure des informations sensibles dans le contrôle de version.
- Elles améliorent la sécurité de l’application AEM as a Cloud Service puisqu’elles se trouvent en dehors du code.
Les cas d’utilisation standard des variables d’environnement incluent les suivants :
- La connexion de votre application AEM avec différents points d’entrée externes.
- L’utilisation d’une référence lors du stockage des mots de passe au lieu de le faire directement dans la base de code.
- Lorsque plusieurs environnements de développement existent dans un programme et que certaines configurations diffèrent d’un environnement à l’autre.
Ajouter une variable d’environnement add-variables
Si vous souhaitez ajouter plusieurs variables, Adobe vous recommande d’ajouter la première variable, puis d’utiliser
Pour ajouter, mettre à jour ou supprimer des variables d’environnement, vous devez être membre du rôle Responsable de déploiement.
Pour ajouter une variable d’environnement, procédez comme suit
-
Connectez-vous à Cloud Manager à l’adresse my.cloudmanager.adobe.com et sélectionnez l’organisation appropriée.
-
Dans la console Mes programmes, sélectionnez celui que vous souhaitez gérer.
-
Dans le menu latéral, cliquez sur Environnements.
-
Sur la page Environnements, sélectionnez une ligne du tableau contenant l’environnement pour lequel vous souhaitez ajouter une variable d’environnement.
-
Sur la page de détails de l’environnement, cliquez sur l’onglet Configuration.
-
Cliquez sur
Si vous ajoutez une variable d’environnement pour la première fois, cliquez sur Ajouter une configuration au centre de la page.
-
Dans la boîte de dialogue Configuration de l’environnement, saisissez les détails dans la première ligne du tableau.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 Champ Description Nom Nom unique de la variable de configuration. Il identifie la variable spécifique utilisée dans l’environnement. Il doit respecter les conventions de dénomination suivantes :
- Les variables ne peuvent contenir que des caractères alphanumériques et le trait de soulignement (
_). - Il existe une limite de 200 variables par environnement.
- Chaque nom doit comporter 100 caractères ou moins.
Valeur Valeur de la variable. Étape appliquée Sélectionnez le service auquel la variable s’applique. Sélectionnez Tous pour appliquer la variable à tous les services.
- Tous
- Auteur
- Publication
- Prévisualisation
Type Sélectionnez cette option si la variable est normale ou secrète. 
- Les variables ne peuvent contenir que des caractères alphanumériques et le trait de soulignement (
-
Cliquez sur
Ajoutez des variables supplémentaires si nécessaire.
-
Cliquez sur Enregistrer.
Une double flèche avec le statut Mise à jour en cours s’affiche dans le coin supérieur droit du tableau. Une double flèche s’affiche également à gauche de toutes les variables nouvellement ajoutées. Ces statuts indiquent que l’environnement est en cours de mise à jour avec la configuration. Une fois cette opération terminée, la nouvelle variable d’environnement est visible dans le tableau.
Mise à jour d’une variable d’environnement update-variables
Après avoir créé des variables d’environnement, vous pouvez les mettre à jour à l’aide de l’icône
Si vous souhaitez mettre à jour plusieurs variables, Adobe vous recommande d’utiliser la boîte de dialogue Configuration de l’environnement pour mettre à jour toutes les variables nécessaires en une seule fois avant de cliquer sur Enregistrer. De cette façon, vous pouvez les ajouter en une seule mise à jour de lʼenvironnement.
Pour mettre à jour une variable d’environnement, procédez comme suit
-
Connectez-vous à Cloud Manager à l’adresse my.cloudmanager.adobe.com et sélectionnez l’organisation appropriée.
-
Dans la console Mes programmes, sélectionnez celui que vous souhaitez gérer.
-
Dans le menu latéral, cliquez sur Environnements.
-
Sur la page Environnements, sélectionnez une ligne du tableau contenant l’environnement pour lequel vous souhaitez mettre à jour une variable.
-
Sur la page de détails de l’environnement, cliquez sur l’onglet Configuration.
-
Cliquez sur
-
Dans la boîte de dialogue Configuration de l’environnement, cliquez sur
-
Dans le menu déroulant, cliquez sur Modifier.
-
Mettez à jour la valeur de la variable d’environnement selon les besoins.
Lors de la modification d’un secret, la valeur peut uniquement être mise à jour, mais pas affichée.
-
Utilisez l’une des méthodes suivantes :
- Cliquez sur
- Cliquez sur
- Cliquez sur
-
Cliquez sur Enregistrer.
Une double flèche avec le statut Mise à jour en cours s’affiche dans le coin supérieur droit du tableau. Une double flèche s’affiche également à gauche de toutes les variables mises à jour. Ces statuts indiquent que l’environnement est en cours de mise à jour avec la configuration. Une fois l’opération terminée, la variable d’environnement mise à jour est visible dans le tableau.
Suppression d’une variable d’environnement delete-env-variable
- Connectez-vous à Cloud Manager à l’adresse my.cloudmanager.adobe.com et sélectionnez l’organisation appropriée.
- Dans la console Mes programmes, sélectionnez celui que vous souhaitez gérer.
- Dans le menu latéral, cliquez sur Environnements.
- Sur la page Environnements, sélectionnez une ligne du tableau contenant l’environnement pour lequel vous souhaitez mettre à jour une variable.
- Sur la page de détails de l’environnement, cliquez sur l’onglet Configuration.
- Cliquez sur
- Dans la boîte de dialogue Configuration de l’environnement, cliquez sur
- Dans le menu déroulant, cliquez sur Supprimer pour supprimer immédiatement la variable.
- Cliquez sur Enregistrer.
Utilisation des variables d’environnement using
Les variables d’environnement peuvent rendre vos configurations pom.xml plus sécurisées et flexibles. Par exemple, les mots de passe n’ont pas besoin d’être codés en dur et votre configuration peut s’adapter en fonction des valeurs des variables d’environnement.
Vous pouvez accéder aux variables d’environnement et aux secrets par le biais du code XML comme suit :
${env.VARIABLE_NAME}
Consultez Configuration d’un projet pour un exemple d’utilisation des deux types de variables dans un fichier pom.xml.
Consultez également la documentation officielle de Maven pour plus d’informations.
Disponibilité des variables d’environnement availability
Les variables d’environnement peuvent être utilisées à plusieurs endroits comme suit :
Seules les variables d’environnement normales peuvent être utilisées avec Dispatcher.
- Les secrets ne peuvent pas être utilisés.
- Les variables d’environnement ne peuvent pas être utilisées dans les directives
IfDefine. - Vous devez valider l’utilisation des variables d’environnement avec le Dispatcher localement avant le déploiement.