Alibaba Cloud DevOps:環境変数

環境変数のソース

環境変数の使用

変数を定義した後、${XXX} 構文を使用して、パイプライン内の任意の場所で変数を参照できます。システムは、以下の優先順位に従って変数を解決します。

• ステップの出力変数 > パイプライン ランタイムの入力変数 > パイプライン変数 > 共通変数グループの変数

• パイプラインに、同じ名前の変数を含む複数の共通変数グループを関連付けた場合、最後に関連付けられたグループの値が優先されます。

以降のセクションでは、コマンド実行、ホストデプロイメント、イメージビルド引数、設定ファイル、データの受け渡しといった、環境変数の一般的なユースケースの例を紹介します。

コマンドでの変数の使用

変数を使用して、設定ファイル内のパラメータを変更できます。たとえば、a.conf ファイル内の key パラメータの値を 123 から、abc という名前の環境変数の値に変更する場合などです。

シェルスクリプトのステップでは、 sed コマンドを使用してパラメーターの値を環境変数の値で置き換えます。

$ cat a.conf
key=123
$ sed -i "s/key=123/key=${abc}/g" a.conf
$ cat a.conf
key=abc_value

パイプラインの [変数とキャッシュ] で、変数 abc のデフォルト値を abc_value に設定します。

ホストデプロイメントにおける変数

${XXX} 構文を使用して、デプロイスクリプト内で環境変数を直接参照し、ホストデプロイのロジックをコントロールできます。パイプラインの実行後、ホストデプロイステップのログで、システムが変数の値を正しく渡したことを検証できます。

イメージビルド引数における変数

イメージビルド時にパイプラインの環境変数を引数として使用するには、次のように設定します。

1. イメージビルドのステップで、指定したコンテナ環境を使用します。ビルド引数にカスタム引数を追加し、${XXX} フォーマットを使用してその引数に環境変数を割り当てます。システムは --build-arg フラグを使用して、その引数をビルドコマンドに渡します。

イメージビルドステップの [Build Parameters] で、abc=${abc} のようなカスタム引数を追加します。この引数は、--build-arg として Docker ビルドコマンドに渡されます。

2. Dockerfile で、ARG argName で引数を参照します。

FROM <base-image>
ARG argName
RUN echo $argName

設定ファイルでの変数の使用

環境変数を使用して設定ファイル内のパラメーターを変更するには、次の手順に従ってください。たとえば、a.conf ファイル内の username パラメーターをパイプライン変数に置き換える場合：

1. a.conf ファイルで、行を username = ${abc} に変更します。

2. パイプラインの環境変数で、abc 変数のデフォルト値を my_name_is_hanmeimei に設定します。

3. パイプラインにジョブを追加します。 [Utilities] セクションから、[Replace EnvVar in File] ステップを追加します。 [Source File Path] フィールドに設定ファイルのパスを入力します。 [Target File Path] はオプションです。 ターゲットパスを指定すると新しいファイルが作成され、指定しない場合は元のファイルが変更されます。

この例では、ソースファイルパス は a.conf に、ターゲットファイルパス は b.conf に設定されています。

4. 結果を確認します。 このステップは、新しい b.conf ファイルで a.conf 内の username プレースホルダーを、変数の値 my_name_is_hanmeimei に置き換えます。 注：ステップは、同じジョブ内にある場合にのみワークスペースを共有します。

変数の受け渡し

パイプラインの設定ページで定義した環境変数は静的です。ただし、実行中のステップの出力から環境変数を生成し、後続のステップまたはジョブに渡す必要がある場合があります。これには、次の 2 つの方法があります：

• ジョブ内で変数を渡す： ステップ 1 で生成したカスタム環境変数を、ステップ 2 で使用します。

• ジョブ間で変数を渡す： ジョブ 1 で生成した環境変数を、ジョブ 2 で使用します。

重要：ビルド環境によって使用する構文が異なります。環境変数を設定するための構文は次のとおりです。デフォルト環境では echo 'USER_abc=123' > .env を使用します (変数名は USER_ で始まる必要があります)。指定されたコンテナ環境またはデフォルト VM 環境では echo "yaojia_Test=myParam" >> "$FLOW_ENV" を使用します。

ジョブ 1 では、[ステップの追加] > [ユーティリティ] > [変数の設定] に移動してステップを追加することで、環境変数をパイプラインレベルに昇格させることができます。

# ステップ 2 の実行ログ
echo $yaojia_Test
myParam
# [Success]

# ジョブ 2 の実行ログ
echo $yaojia_Test
myParam
# [成功]