変数サービス間参照

サービス間参照

参照を使うと、あるサービスやアドオンが、認証情報をコピー＆ペーストせずに別のサービスやアドオンの値を読み取れます。シークレットを1か所にまとめて保持でき、自動的にローテーションされます。

構文

${{<name>.<KEY>}}
  • <name> — 対象のサービスまたはアドオン名（ダッシュボードに表示され、lizard add -n で使われるもの）。
  • <KEY> — 対象のマージ済み環境内のキー。

値を受け付ける場所ならどこでも使えます。最も一般的なのはシークレットです:

lizard secrets set DATABASE_URL='${{postgres.DATABASE_URL}}' --service api

解決の仕組み

  • 参照は、対象のマージ済み環境に対してデプロイ時に解決されます。
  • ID で保存されるため、あとで対象の名前を変更しても参照は壊れません。
  • 存在しない対象またはキーへの参照は、空文字列に解決されます。デプロイは失敗しません。
  • エラーになるのは循環参照だけです。

存在しないキーは黙って空になるため、参照を設定したあとは、コンシューマーが実際に値を受け取ったかを必ず確認してください:

lizard ssh --service api -- env | grep DATABASE_URL

参照が期待どおりに反映されない場合は、トラブルシューティング → シークレットまたは参照が表示されない を参照してください。

よくあるパターン

1つのアドオンを複数のサービスに接続する — ローテーションがどこにでも伝播するよう、各コンシューマー側でバインドします:

lizard secrets set REDIS_URL='${{redis.REDIS_URL}}' --service api
lizard secrets set REDIS_URL='${{redis.REDIS_URL}}' --service worker

別のサービスの値を参照する — たとえば、計算された URL やトークンを共有する場合:

lizard secrets set UPSTREAM_URL='${{api.LIZARD_PUBLIC_DOMAIN}}' --service web

同じ種類の2つ目のアドオンを参照する — その自動生成された名前を使います:

lizard secrets set CACHE_URL='${{redis-winter-otter.REDIS_URL}}' --service api

なぜ --global を使わないのですか？

共有 DSN をプロジェクト（--global）スコープに置くと、必要のないものも含めてすべてのサービスに公開されます。参照を使えば、単一の信頼できる情報源としてのローテーションという利点はそのままに、各シークレットを実際に利用するサービスだけにスコープできます。シークレットのスコープ を参照してください。

関連項目

変数とシークレットシークレットまたは参照が表示されません