ビルド環境変数を設定する（ソースデプロイ）

ビルド環境変数は、ソースコードから関数をデプロイするときに、Buildpack に構成情報を渡すことができる Key-Value ペアです。たとえば、ビルド時に、コンパイラ オプションのカスタマイズ、ビルド時の証明書の指定、パラメータの構成などを行いたい場合があります。

このページでは、ビルド時に使用可能なビルド環境変数を設定する方法について説明します。このページは、Cloud Run の関数をデプロイするプラットフォーム デベロッパーを対象としています。

始める前に

Cloud Build API を有効にします。

gcloud services enable cloudbuild.googleapis.com

必要なロール

ソースからデプロイするために必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。

Cloud Run に関連付けられている IAM ロールと権限のリストについては、Cloud Run IAM ロールと Cloud Run IAM 権限をご覧ください。Cloud Run サービスが Google Cloud APIs（Cloud クライアント ライブラリなど）と連携している場合は、サービス ID の構成ガイドをご覧ください。ロールの付与の詳細については、デプロイ権限とアクセスの管理をご覧ください。

ビルド環境変数を設定する

ビルド環境変数を設定すると、新しい変数を設定したり、既存のビルド変数を完全に置き換えることができます。

gcloud

ソースコードから関数をデプロイするときに、ビルド環境変数を設定できます。

gcloud beta run deploy SERVICE \
  --source . \
  --function FUNCTION_ENTRY_POINT \
  --set-build-env-vars KEY1=VALUE1,KEY2=VALUE2

次のように置き換えます。

  • SERVICE: Cloud Run 関数の名前。
  • FUNCTION_ENTRY_POINT: ソースコード内の関数のエントリ ポイント。
  • KEY1=VALUE1,KEY2=VALUE2: Buildpack に構成情報を渡す関数と一緒にデプロイされる変数名とその値のカンマ区切りリスト。

ビルド環境変数を更新する

既存の関数のビルド環境変数を更新できます。これは非破壊的なアプローチです。ビルド環境変数の変更または追加は行いますが、ビルド環境変数の削除は行いません。

gcloud

既存の関数のビルド環境変数を更新するには:

gcloud beta run deploy SERVICE \
  --source . \
  --function FUNCTION_ENTRY_POINT \
  --update-build-env-vars KEY1=VALUE1,KEY2=VALUE2

ビルド環境変数を削除する

既存の関数のビルド環境変数を削除できます。

gcloud

ビルド環境変数を削除するには、既存の関数で --remove-build-env-vars を使用します。

gcloud beta run deploy SERVICE \
  --source . \
  --function FUNCTION_ENTRY_POINT \
  --remove-build-env-vars KEY1=VALUE1,KEY2=VALUE2

また、既存の関数で --clear-build-env-vars を使用して、ビルド環境変数をクリアすることもできます。

gcloud beta run deploy SERVICE \
  --source . \
  --function FUNCTION_ENTRY_POINT \
  --clear-build-env-vars KEY1=VALUE1,KEY2=VALUE2

ビルド環境変数ファイル

既存の関数でビルド環境変数ファイルを使用できます。

gcloud

ファイルからビルド環境変数を設定するには:

gcloud beta run deploy SERVICE \
  --source . \
  --function FUNCTION_ENTRY_POINT \
  --build-env-vars-file FILE_NAME.yaml

FILE_NAME.yaml の内容を次のように変更します。

 KEY1: VALUE1
 KEY2: VALUE2