旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。

参照形式

シークレットストアへの参照を記述するには、URL 構文を使用します。

{vault://<vault-backend|entity>/<secret-id id="sl-md0000000">[/<secret-key][/][?query][#version]}

プロトコル/スキーム

{vault://<vault-backend|entity>/<secret-id id="sl-md0000000">[/<secret-key]}
 ^^^^^

URL内のvaultはKongの識別子として使用されます。これを使用してVaultを参照します。

ホスト/パス

{vault://<vault-prefix id="sl-md0000000">/<secret-id id="sl-md0000000">[/<secret-key]}
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

URLのhostとpathは以下のように定義されています。

Vaultプレフィックス

Vaultのプレフィックスは、バックエンドの名前でも、作成したVaultエンティティの名前でもかまいません。

例

{vault://env/<secret-id id="sl-md0000000">[/<secret-key]}
         ^^^

またはVaultエンティティを使用

{vault://my-env-vault/<secret-id id="sl-md0000000">[/<secret-key]}
         ^^^^^^^^^^^^

シークレットID

secret-idは、Vaultに保存されているシークレットの識別子として使用されます。Vaultは string値（単一のシークレット）、またはシークレットobjectとしてのユーザーネームや パスワードなどの、複数の関連するシークレットのいずれかを返します。

秘密鍵

secret-keyは、 secret-idオブジェクト内のシークレットを識別するために使用されます。

秘密鍵が/で終わる場合、それは秘密鍵ではなくシークレットIDの一部とみなされます。 秘密鍵とシークレットIDの違いは、シークレットIDのみがVault APIに送信されることで、 秘密鍵は処理時にのみ使用されます

クエリ

クエリ引数は、Vault接頭辞のkey=value形式で構成オプションを示すために使用されます。

バージョン

{vault://<vault-backend|entity>/<secret-id id="sl-md0000000">[/<secret-key][/][?query][#version]}
                                                                     ^^^^^^^^

Vault URLのフラグメントとして指定されているバージョンは、Vaultバックエンドに保存されているシークレットのバージョン番号を識別します。バージョン管理をサポートするすべてのVaultバックエンドに適用されます。