Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Définir des variables d'environnement dans un environnement de file d'attente

De nombreuses applications et frameworks utilisent des variables d'environnement pour contrôler les paramètres des fonctionnalités, les niveaux de journalisation et la configuration de l'affichage. Vous pouvez utiliser les environnements Open Job Description (OpenJD) pour définir des variables d'environnement dont hérite chaque commande de tâche comprise dans son périmètre.

Portée de la variable d'environnement

AWS Deadline Cloud applique des variables d'environnement issues des environnements de files d'attente que vous associez à une file d'attente. Dans un modèle de tâche, vous pouvez également définir des variables d'environnement au niveau de la tâche et de l'étape à l'aide des environnements OpenJD. Les variables définies dans une portée plus étroite remplacent les variables portant le même nom dans une portée plus large.

Définition de variables dans un environnement de file d'attente

Vous pouvez définir des variables d'environnement dans un environnement de file d'attente à l'aide d'une variables carte pour les valeurs fixes ou à l'scriptaide d'une onEnter action pour les valeurs dynamiques.

Le modèle d'environnement de file d'attente suivant utilise une variables carte pour définir la QT_QPA_PLATFORM variable suroffscreen, ce qui permet aux applications utilisant le Qt Framework de s'exécuter sur des hôtes de travail sans affichage interactif.

specificationVersion: 'environment-2023-09'
environment:
  name: QtOffscreen
  variables:
    QT_QPA_PLATFORM: offscreen

Pour les valeurs dynamiques, telles que la modification PATH ou l'activation d'environnements virtuels, utilisez un script qui imprime les lignes openjd_env: VAR=value au format stdout. Le openjd_env: préfixe est obligatoire. L'utilisation de echoexport, ou d'autres mécanismes shell sans préfixe ne propage pas les variables aux jobs et aux tâches.

Le modèle d'environnement de file d'attente suivant définit la QT_QPA_PLATFORM variable à l'aide d'un script.

specificationVersion: 'environment-2023-09'
environment:
  name: QtOffscreen
  script:
    actions:
      onEnter:
        command: bash
        args:
        - "{{Env.File.Enter}}"
    embeddedFiles:
    - name: Enter
      type: TEXT
      data: |
        #!/bin/env bash
        set -euo pipefail
        echo "openjd_env: QT_QPA_PLATFORM=offscreen"

Pour associer un environnement de file d'attente à votre file d'attente, utilisez la console Deadline Cloud ou le AWS CLI. Pour plus d'informations, consultez la section Création d'un environnement de file d'attente dans le Guide de l'utilisateur de AWS Deadline Cloud. La AWS CLI commande suivante crée un environnement de file d'attente à partir d'un fichier modèle.

aws deadline create-queue-environment \
    --farm-id FARM_ID \
    --queue-id QUEUE_ID \
    --priority 1 \
    --template-type YAML \
    --template file://my-queue-env.yaml

Pour des exemples plus complexes, tels que la création et l'activation d'environnements virtuels Conda, consultez les exemples d'environnement de file d'attente Deadline Cloud sur GitHub.

Définition de variables dans un modèle de tâche

Dans un modèle de tâche, ajoutez une variables carte à une stepEnvironments entrée jobEnvironments ou. Chaque entrée est une paire clé-valeur où la clé est le nom de la variable et la valeur est la valeur de la variable.

Le modèle de tâche suivant définit la variable d'QT_QPA_PLATFORMenvironnement suroffscreen, ce qui permet aux applications utilisant le Qt Framework de s'exécuter sur des hôtes de travail sans affichage interactif.

specificationVersion: 'jobtemplate-2023-09'
name: MyJob
jobEnvironments:
- name: JobEnv
  variables:
    QT_QPA_PLATFORM: offscreen

Vous pouvez définir plusieurs variables dans une seule définition d'environnement.

jobEnvironments:
- name: JobEnv
  variables:
    JOB_VERBOSITY: MEDIUM
    JOB_PROJECT_ID: my-project-id
    JOB_ENDPOINT_URL: https://my-host-name/my/path
    QT_QPA_PLATFORM: offscreen

Vous pouvez référencer les paramètres de la tâche dans des valeurs variables à l'aide de la {{Param.ParameterName}} syntaxe.

jobEnvironments:
- name: JobEnv
  variables:
    JOB_EXAMPLE_PARAM: "{{Param.ExampleParam}}"

Pour remplacer une variable au niveau de la tâche pour une étape spécifique, définissez une stepEnvironments entrée portant le même nom de variable. L'exemple suivant définit JOB_PROJECT_ID au niveau de la tâche avec la valeurproject-12, puis remplace la valeur au niveau de l'étape parstep-project-12. Les tâches de l'étape utilisent la valeur au niveau de l'étape.

specificationVersion: 'jobtemplate-2023-09'
name: MyJob
jobEnvironments:
- name: JobEnv
  variables:
    JOB_PROJECT_ID: project-12
steps:
- name: MyStep
  stepEnvironments:
  - name: StepEnv
    variables:
      JOB_PROJECT_ID: step-project-12

Essayez-le : Exécution de l'exemple de variable d'environnement

Le référentiel d'exemples de Deadline Cloud comprend un ensemble de tâches qui explique la définition et la visualisation des variables d'environnement. L'exemple de modèle de tâche définit des variables au niveau de la tâche et de l'étape, puis exécute une tâche qui imprime le résultat fusionné. Suivez la procédure suivante pour analyser l'échantillon et inspecter les résultats.

Conditions préalables

Exécution de l'exemple

Comparaison des actions de session avec leurs définitions

La vue du journal montre trois actions de session. Ouvrez le fichier job_env_vars/template .yaml dans un éditeur de texte pour comparer chaque action avec sa définition dans le modèle de tâche.