翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

キュー環境で環境変数を設定する

多くのアプリケーションとフレームワークでは、環境変数を使用して機能設定、ログ記録レベル、表示設定を制御します。Open Job Description (OpenJD) 環境を使用して、スコープ内のすべてのタスクコマンドが継承する環境変数を設定できます。

環境変数スコープ

AWS Deadline Cloud は、キューにアタッチしたキュー環境から環境変数を適用します。ジョブテンプレート内で、OpenJD 環境を使用してジョブレベルとステップレベルで環境変数を定義することもできます。より狭いスコープで定義された変数は、より広いスコープから同じ名前の変数を上書きします。

キュー環境で変数を設定する

キュー環境の環境変数は、固定値のvariablesマップを使用するか、動的値のonEnterアクションscriptで を使用して設定できます。

次のキュー環境テンプレートは、variablesマップを使用してQT_QPA_PLATFORM変数を に設定しoffscreen、Qt Framework を使用するアプリケーションがインタラクティブディスプレイなしでワーカーホストで実行できるようにします。

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

仮想環境の変更PATHやアクティブ化などの動的な値の場合は、stdout openjd_env: VAR=valueの形式で行を出力するスクリプトを使用します。openjd_env: プレフィックスは必須です。プレフィックスなしで echo、export、またはその他のシェルメカニズムを使用しても、ジョブやタスクに変数は伝達されません。

次のキュー環境テンプレートは、スクリプトを使用して QT_QPA_PLATFORM変数を設定します。

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"

キュー環境にアタッチするには、Deadline Cloud コンソールまたは を使用します AWS CLI。詳細については、 AWS Deadline Cloud ユーザーガイドの「キュー環境の作成」を参照してください。次の AWS CLI コマンドは、テンプレートファイルからキュー環境を作成します。

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

conda 仮想環境の作成やアクティブ化などのより複雑な例については、GitHub の Deadline Cloud キュー環境のサンプルを参照してください。

ジョブテンプレートでの変数の設定

ジョブテンプレートで、 jobEnvironmentsまたは stepEnvironmentsエントリにvariablesマップを追加します。各エントリはキーと値のペアで、キーは変数名、値は変数値です。

次のジョブテンプレートは、 QT_QPA_PLATFORM環境変数を に設定しoffscreen、Qt Framework を使用するアプリケーションがインタラクティブディスプレイなしでワーカーホストで実行できるようにします。

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

1 つの環境定義で複数の変数を設定できます。

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

{{Param.ParameterName}} 構文を使用して、変数値のジョブパラメータを参照できます。

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

特定のステップのジョブレベルの変数を上書きするには、同じ変数名でstepEnvironmentsエントリを定義します。次の例ではJOB_PROJECT_ID、ジョブレベルで 値を で定義しproject-12、ステップレベルで 値を で上書きしますstep-project-12。ステップのタスクは、ステップレベルの値を使用します。

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

試す: 環境変数サンプルの実行

Deadline Cloud サンプルリポジトリには、環境変数の設定と表示を示すジョブバンドルが含まれています。サンプルジョブテンプレートは、ジョブレベルとステップレベルの両方で変数を定義し、マージされた結果を出力するタスクを実行します。サンプルを実行し、結果を検査するには、次の手順に従います。

前提条件

サンプルの実行

セッションアクションとその定義の比較

ログビューには 3 つのセッションアクションが表示されます。テキストエディタでファイル job_env_vars/template.yaml を開き、各アクションをジョブテンプレートの定義と比較します。