Treatment get

vault::get

Configuration

⬡ vault: vault::Vault

Parameters

↳ var name: string
↳ var plain_reveal: bool = false
↳ var transmission: string = "local"

Inputs

⇥ path: Block<string>

Outputs

↦ error: Block<string>
↦ failed: Block<void>
↦ secret: Block<Secret<string>>

Gives a secret stored at path in vault.

path is <path>#<field>, such as kv/data/app/db#password, read from the source of vault, for paths only known at runtime. The secret is named name, its policy is given by transmission (local, reference or value) and plain_reveal (whether the plain std/secret::reveal treatment may reveal it), as std/secret::|locate takes. It is read once to check it exists, and resolved again when revealed.

If the secret cannot be read, or the transmission is not valid, failed is emitted and error contains the reason.