環境変数を使用する

Workflow の環境変数は、デプロイ時に定義できます。たとえば、デプロイ先の環境に応じて動的に構成されるワークフローを作成できます。また、テンプレートとして再利用でき、個別に管理される環境変数に従って構成できるワークフローを作成することもできます。

環境変数は、実行時にワークフローからアクセスできる任意のキーと値の文字列ペアとして設定されます。Workflows バックエンドに保存され、ワークフロー実行のスコープが設定され、ワークフローの実行中に不変になります。

すべての環境変数はワークフローの関数のデプロイにバインドされています。デプロイを行うときにのみ、環境変数を設定または変更できます。環境変数を作成または変更するには、デプロイに成功する必要があります。なんらかの理由でデプロイに失敗すると、環境変数の変更は適用されません

Google Cloud CLI を使用して、ユーザー定義の環境変数を追加、更新、削除できます。

予約済みの名前

Workflows に定義された組み込み環境変数は予約されているため、設定はできません。

Workflow の環境変数を定義する場合は、以下を使用できません。

キー 説明
空白('' キーは空の文字列にできません。
GOOGLE_ キーの接頭辞として GOOGLE_ を使用することはできません。
WORKFLOWS_ キーの接頭辞として WORKFLOWS_ を使用することはできません。

環境変数を設定する

ワークフローのデプロイ時に、新しい変数を定義したり、既存の変数を置き換えたりできます。追加の変更を行うには、このドキュメントの環境変数を更新するをご覧ください。

コンソール

  1. Google Cloud コンソールで、[ワークフロー] ページに移動します。

    [ワークフロー] に移動

  2. [ワークフロー] ページで、 [作成] をクリックします。

  3. [ワークフローの作成] ページで、該当するフィールドに入力してワークフローの定義を構成します。

  4. [環境変数(オプション)] セクションで、[変数を追加] をクリックします。

  5. [名前 1] フィールドで、変数名を指定します。

  6. [値 1] フィールドで、変数の値を指定します。

  7. 別の変数を追加するには、[変数を追加] をクリックします。

  8. [次へ] をクリックします。

  9. ワークフローを定義してからデプロイするには [デプロイ] をクリックします。

gcloud

環境変数を設定するには、--set-env-vars フラグを使用します。

gcloud workflows deploy WORKFLOW_NAME \
    --set-env-vars KEY1=VALUE1

以下を置き換えます。

  • WORKFLOW_NAME: ワークフローの ID。
  • KEY1=VALUE1: 環境変数の名前とその値(例: MONTH=January)。

Terraform

ワークフローを作成するには、google_workflows_workflow リソースを使用して、サンプルに示すように main.tf ファイルを変更します。詳細については、Terraform を使用してワークフローを作成するをご覧ください。

user_env_vars 引数を使用して、環境変数をワークフロー リビジョンに関連付けます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

複数の環境変数を設定する

複数の環境変数を設定するには、カンマ区切りのリストを使用します。

gcloud workflows deploy