@@ -78,11 +78,11 @@ The tool requires the following environment variables to be set (as GitLab CI se
| `VAULT_BASE_AUTH_APPROLE_PATH`| The base [AppRole authentication](https://www.vaultproject.io/api-docs/auth/approle) API path | `/auth/approle` |
| `VAULT_BASE_AUTH_JWT_PATH` | The base [JWT/OIDC authentication](https://www.vaultproject.io/api-docs/auth/jwt) API path | `/auth/jwt` |
| `VAULT_BASE_KV_SECRETS_PATH` | The base [Key/Value secrets](https://www.vaultproject.io/api-docs/secret/kv/kv-v1) API path | `/secret` |
| `VAULT_ROLE_ID` | The [AppRole](https://www.vaultproject.io/docs/auth/approle) RoleID | _none_ (required to use the [AppRole](https://www.vaultproject.io/docs/auth/approle) Auth Method) |
| `VAULT_SECRET_ID` | The [AppRole](https://www.vaultproject.io/docs/auth/approle) SecretID | _none_ (required to use the [AppRole](https://www.vaultproject.io/docs/auth/approle) Auth Method) |
| `VAULT_TOKEN` | The token to use | _none_ (required to use the [Token](https://www.vaultproject.io/docs/auth/token) Auth Method) |
| `VAULT_JWT_TOKEN` | The signed [JSON Web Token](https://en.wikipedia.org/wiki/JSON_Web_Token) to login | `$CI_JOB_JWT` |
| `VAULT_JWT_ROLE` | Name of the role against which the login is being attempted | `default_role` (used with the [JWT/OIDC](https://www.vaultproject.io/docs/auth/jwt) Auth Method) |
| `VAULT_ROLE_ID` | The [AppRole](https://www.vaultproject.io/docs/auth/approle) RoleID <br/>_Required for the [AppRole](https://www.vaultproject.io/docs/auth/approle) Auth Method_ | _none_ |
| `VAULT_SECRET_ID` | The [AppRole](https://www.vaultproject.io/docs/auth/approle) SecretID <br/>_Required for the [AppRole](https://www.vaultproject.io/docs/auth/approle) Auth Method_ | _none_ |
| `VAULT_TOKEN` | The authentication token <br/>_Required for the [Token](https://www.vaultproject.io/docs/auth/token) Auth Method_ | _none_ |
| `VAULT_JWT_TOKEN` | The signed [JSON Web Token](https://en.wikipedia.org/wiki/JSON_Web_Token) to login <br/>_Required for the [JWT/OIDC](https://www.vaultproject.io/docs/auth/jwt) Auth Method_| `$CI_JOB_JWT` |
| `VAULT_JWT_ROLE` | Name of the role against which the login is being attempted <br/>_Required for the [JWT/OIDC](https://www.vaultproject.io/docs/auth/jwt) Auth Method_ | `default_role` |
If no authentication parameter is set, the image will emit an error log at startup.
@@ -123,24 +123,38 @@ Depending on what is available in your docker image, you may request the service
You might want to test/debug whether you have the right secret ID, role ID, secret path, secret key or so.
Simply run the Docker image with:
You may either use a remote Vault server, or run one locally using the
[Vault Docker image](https://hub.docker.com/_/vault) in dev mode on port 8200, specifying the root token value: