mirror of
https://github.com/hashicorp/vault-action.git
synced 2025-11-07 15:16:56 +00:00
docs: Clean up output a bit
This commit is contained in:
parent
01bb0f9bc9
commit
c80d0b130c
1 changed files with 17 additions and 14 deletions
31
README.md
31
README.md
|
|
@ -270,20 +270,23 @@ steps:
|
||||||
```
|
```
|
||||||
|
|
||||||
## Reference
|
## Reference
|
||||||
| Option | Description | Default | Required |
|
|
||||||
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
|
Here is all the inputs available through `with`:
|
||||||
| 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 |
|
| Input | Description | Default | Required |
|
||||||
| 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 |
|
| `url` | The URL for the vault endpoint | | No |
|
||||||
| kv-version | The version of the K/V engine to use. | 2 | false |
|
| `secrets` | A semicolon-separated list of secrets to retrieve. These will automatically be converted to environmental variable keys. See README for more details | | No |
|
||||||
| method | The method to use to authenticate with Vault. | token | false |
|
| `namespace` | The Vault namespace from which to query secrets. Vault Enterprise only, unset by default | | No |
|
||||||
| token | The Vault Token to be used to authenticate with Vault | | false |
|
| `path` | The path of a non-default K/V engine | | No |
|
||||||
| roleId | The Role Id for App Role authentication | | false |
|
| `kv-version` | The version of the K/V engine to use. | `2` | No |
|
||||||
| secretId | The Secret Id for App Role authentication | | false |
|
| `method` | The method to use to authenticate with Vault. | `token` | No |
|
||||||
| githubToken | The Github Token to be used to authenticate with Vault | | false |
|
| `token` | The Vault Token to be used to authenticate with Vault | | No |
|
||||||
| extraHeaders | A string of newline separated extra headers to include on every request. | | false |
|
| `roleId` | The Role Id for App Role authentication | | No |
|
||||||
| exportEnv | Whether or not export secrets as environment variables. | true | false |
|
| `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
|
## Masking - Hidding Secrets from Logs
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue