Informations de référence sur les variables CLI de l’environnement de déploiement Azure

Article
04/17/2024

Les environnements de déploiement Azure (ADE) définissent de nombreuses variables liées à votre environnement que vous pouvez référencer lors de la création d’images personnalisées. Vous pouvez utiliser les variables ci-dessous dans les scripts d’opération (deploy.sh ou delete.sh) afin de rendre vos images flexibles pour l’environnement avec lequel elles interagissent.

Pour les fichiers utilisés par ADE dans le conteneur, tous existent dans un ade sous-dossier hors du répertoire initial.

Voici la liste des variables d’environnement disponibles :

ADE_ERROR_LOG

Fait référence au fichier situé à l’emplacement /ade/temp/error.log. Le error.log fichier stocke toute sortie d’erreur standard qui remplit les détails d’erreur d’un environnement en raison d’un déploiement ou d’une suppression ayant échoué. Le fichier est utilisé avec ade execute, qui enregistre tout contenu de sortie standard et d’erreur standard dans un fichier journal géré par ADE. Lorsque vous utilisez la commande, redirigez la ade execute journalisation des erreurs standard vers cet emplacement de fichier à l’aide de la commande suivante :

ade execute --operation $ADE_OPERATION_NAME --command "{YOUR_COMMAND}" 2> >(tee -a $ADE_ERROR_LOG)

À l’aide de cette méthode, vous pouvez afficher l’erreur de déploiement ou de suppression dans le portail des développeurs. Cela conduit à des itérations de débogage plus rapides et plus réussies lors de la création de votre image personnalisée et à un diagnostic plus rapide de la cause racine de l’opération ayant échoué.

ADE_OUTPUTS

Fait référence au fichier situé à l’emplacement /ade/temp/output.json. Le output.json fichier stocke les sorties du déploiement d’un environnement dans le stockage persistant, afin qu’elle soit accessible à l’aide d’Azure CLI à une date ultérieure. Lors du stockage de la sortie dans une image personnalisée, vérifiez que la sortie est chargée dans le fichier spécifié, comme illustré dans l’exemple suivant :

echo "$deploymentOutput" > $ADE_OUTPUTS

ADE_STORAGE

Fait référence au répertoire situé à l’emplacement /ade/storage. Pendant le point d’entrée de l’image de base, ADE extrait un fichier spécialement nommé storage.zip à partir du conteneur de stockage de l’environnement et remplit ce répertoire, puis à l’achèvement de l’opération, recharge le répertoire en tant que fichier zip dans le conteneur de stockage. Si vous avez des fichiers que vous souhaitez référencer dans votre image personnalisée lors des redéploiements suivants, tels que les fichiers d’état, placez-les dans ce répertoire.

ADE_CLIENT_ID

Fait référence à l’ID d’objet de l’identité de service managé (MSI) du type d’environnement de projet de l’environnement. Cette variable peut être utilisée pour valider auprès d’Azure CLI pour les autorisations à utiliser dans le conteneur, telles que le déploiement de l’infrastructure.

ADE_TENANT_ID

Fait référence au GUID du locataire de l’environnement.

ADE_SUBSCRIPTION_ID

Fait référence au GUID d’abonnement de l’environnement.

ADE_TEMPLATE_FILE

Fait référence à l’emplacement où se trouve le fichier de modèle principal spécifié dans la propriété « templatePath » dans la définition d’environnement dans le conteneur. Ce chemin d’accès miroir le contrôle de code source de l’emplacement du catalogue, en fonction du niveau de chemin d’accès du fichier auquel vous avez connecté le catalogue. Le fichier se trouve à peu près à /ade/repository/{CATALOG_NAME}/{PATH_TO_TEMPLATE_FILE}. Cette méthode est principalement utilisée lors de l’étape de déploiement principale, car le fichier référencé pour baser le déploiement est désactivé.

Voici un exemple utilisant Azure CLI :

az deployment group create --subscription $ADE_SUBSCRIPTION_ID \
    --resource-group "$ADE_RESOURCE_GROUP_NAME" \
    --name "$deploymentName" \
    --no-prompt true --no-wait \
    --template-file "$ADE_TEMPLATE_FILE" \
    --parameters "$deploymentParameters" \
    --only-show-errors

Tous les autres fichiers, tels que la prise en charge des fichiers iaC ou des fichiers que vous souhaitez utiliser dans votre image personnalisée, sont stockés à leur emplacement relatif dans le fichier de modèle à l’intérieur du conteneur tel qu’ils se trouvent dans le catalogue. Par exemple, prenez le répertoire suivant :

├───SampleCatalog
   ├───EnvironmentDefinition1
      │   file1.bicep
      │   main.bicep
      │   environment.yaml
      │
      └───TestFolder
              test1.txt
              test2.txt

Dans ce cas, $ADE_TEMPLATE_FILE=/ade/repository/SampleCatalog/EnvironmentDefinition1/main.bicep. En outre, les fichiers tels que file1.bicep se trouvent dans le conteneur à l’emplacement /ade/repository/SampleCatalog/EnvironmentDefinition1/file1.bicep, et test2.txt se trouve à l’emplacement /ade/repository/SampleCatalog/EnvironmentDefinition1/TestFolder/test2.txt.

ADE_ENVIRONMENT_NAME

Nom de l’environnement donné au moment du déploiement.

ADE_ENVIRONMENT_LOCATION

Emplacement où l’environnement est déployé. Cet emplacement est la région du projet.

ADE_RESOURCE_GROUP_NAME

Nom du groupe de ressources créé par ADE pour déployer vos ressources.

ADE_ENVIRONMENT_TYPE

Nom du type d’environnement de projet utilisé pour déployer cet environnement.

ADE_OPERATION_PARAMETERS

Objet JSON des paramètres fournis pour déployer l’environnement. Voici un exemple de l’objet parameters :

{
    "location": "locationInput",
    "name": "nameInput",
    "sampleObject": {
        "sampleProperty": "sampleValue"
    },
    "sampleArray": [
        "sampleArrayValue1",
        "sampleArrayValue2"
    ]
}

ADE_OPERATION_NAME

Type d’opération en cours d’exécution sur l’environnement. Aujourd’hui, cette valeur est « deploy » ou « delete ».

ADE_HTTP__OPERATIONID

ID d’opération affecté à l’opération en cours d’exécution sur l’environnement. L’ID d’opération est utilisé comme validation pour utiliser l’interface CLI ADE et est l’identificateur principal dans la récupération des journaux d’activité à partir d’opérations passées.

ADE_HTTP__DEVCENTERID

ID Centre de développement de l’environnement. L’ID Centre de développement est également utilisé comme validation pour utiliser l’interface CLI ADE.

Partage via