actions/vault-action
5
0
Fork 0
mirror of https://github.com/hashicorp/vault-action.git synced 2025-11-07 07:06:56 +00:00
Code Activity Actions

docs: Clean up output a bit

Browse source
This commit is contained in:
Richard Simpson 2020-04-03 12:30:03 -05:00
parent 01bb0f9bc9
commit c80d0b130c
1 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -270,20 +270,23 @@ steps:
```
## Reference
| Option | Description | Default | Required |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| url | The URL for the vault endpoint | | true |
| secrets | A semicolon-separated list of secrets to retrieve. These will automatically be converted to environmental variable keys. See README for more details | | true |
| namespace | The Vault namespace from which to query secrets. Vault Enterprise only, unset by default | | false |
| path | The path of a non-default K/V engine | | false |
| kv-version | The version of the K/V engine to use. | 2 | false |
| method | The method to use to authenticate with Vault. | token | false |
| token | The Vault Token to be used to authenticate with Vault | | false |
| roleId | The Role Id for App Role authentication | | false |
| secretId | The Secret Id for App Role authentication | | false |
| githubToken | The Github Token to be used to authenticate with Vault | | false |
| extraHeaders | A string of newline separated extra headers to include on every request. | | false |
| exportEnv | Whether or not export secrets as environment variables. | true | false |
Here is all the inputs available through `with`:
| Input | Description | Default | Required |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| `url` | The URL for the vault endpoint | | No |
| `secrets` | A semicolon-separated list of secrets to retrieve. These will automatically be converted to environmental variable keys. See README for more details | | No |
| `namespace` | The Vault namespace from which to query secrets. Vault Enterprise only, unset by default | | No |
| `path` | The path of a non-default K/V engine | | No |
| `kv-version` | The version of the K/V engine to use. | `2` | No |
| `method` | The method to use to authenticate with Vault. | `token` | No |
| `token` | The Vault Token to be used to authenticate with Vault | | No |
| `roleId` | The Role Id for App Role authentication | | No |
| `secretId` | The Secret Id for App Role authentication | | No |
| `githubToken` | The Github Token to be used to authenticate with Vault | | No |
| `extraHeaders` | A string of newline separated extra headers to include on every request. | | No |
| `exportEnv` | Whether or not export secrets as environment variables. | `true` | No |
## Masking - Hidding Secrets from Logs