From c80d0b130c7e994028ff648be474863e7d8b387d Mon Sep 17 00:00:00 2001 From: Richard Simpson Date: Fri, 3 Apr 2020 12:30:03 -0500 Subject: [PATCH] docs: Clean up output a bit --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index ee95e6c..c80bf50 100644 --- a/README.md +++ b/README.md @@ -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