mirror of
https://github.com/Luzifer/vault2env.git
synced 2024-09-19 17:13:00 +00:00
49 lines
2.4 KiB
Markdown
49 lines
2.4 KiB
Markdown
[](https://gobuilder.me/github.com/Luzifer/vault2env)
|
|
[](http://www.apache.org/licenses/LICENSE-2.0)
|
|
[](https://goreportcard.com/report/github.com/Luzifer/vault2env)
|
|
|
|
# Luzifer / vault2env
|
|
|
|
`vault2env` is a really small utility to transfer fields of a key in [Vault](https://www.vaultproject.io/) into the environment. It uses the [`app-role`](https://www.vaultproject.io/docs/auth/approle.html), [`app-id` authentication mechanism](https://www.vaultproject.io/docs/auth/app-id.html) or simple [token authentication](https://www.vaultproject.io/docs/auth/token.html) to identify itself with the Vault server, fetches all fields in the specified key and returns export directives for bash / zsh. That way you can do `eval` stuff and pull those fields into your ENV.
|
|
|
|
## Usage
|
|
|
|
In general this program can either output your ENV variables to use with `eval` or similar or it can run a program with populated environment.
|
|
|
|
```
|
|
# vault2env [secret path] [command]
|
|
<program is started, you see its output>
|
|
|
|
# vault2env --export [secret path]
|
|
export ...
|
|
```
|
|
|
|
### Using evironment variables
|
|
```bash
|
|
# export VAULT_ADDR="https://127.0.0.1:8200"
|
|
# export VAULT_APP_ID="29c8febe-49f5-4620-a177-20dff0fda2da"
|
|
# export VAULT_USER_ID="54d24f66-6ecb-4dcc-bdb7-0241a955f1df"
|
|
# vault2env secret/my/path/with/keys
|
|
export FIRST_KEY="firstvalue"
|
|
export SECOND_KEY="secondvalue"
|
|
# eval $(vault2env secret/my/path/with/keys)
|
|
# echo "${FIRST_KEY}"
|
|
firstvalue
|
|
```
|
|
|
|
### Using CLI parameters
|
|
|
|
The command does differ only with its parameters specified for the different authentication mechanisms:
|
|
|
|
- When using AppRole you need to specify `--vault-role-id` and optionally `--vault-secret-id` if you're using the `bind_secret_id` flag for your AppRole
|
|
- When using AppID specify `--vault-app-id` and `--vault-user-id`
|
|
- When using Token auth only specify `--vault-token`
|
|
|
|
```bash
|
|
# vault2env --vault-addr="..." --vault-app-id="..." --vault-user-id="..." secret/my/path/with/keys
|
|
export FIRST_KEY="firstvalue"
|
|
export SECOND_KEY="secondvalue"
|
|
```
|
|
|
|
Though it's possible to use CLI parameters I strongly recommend to stick to the ENV variant as it's possible under certain conditions to read CLI parameters on a shared system using for example `ps aux`.
|