mirror of
https://github.com/hashicorp/vault-action.git
synced 2025-11-07 15:16:56 +00:00
Add path parameter example (#511)
* x * Update README.md Co-authored-by: John-Michael Faircloth <fairclothjm@users.noreply.github.com> --------- Co-authored-by: John-Michael Faircloth <fairclothjm@users.noreply.github.com>
This commit is contained in:
parent
6853090cd9
commit
00bce0da9c
1 changed files with 15 additions and 0 deletions
15
README.md
15
README.md
|
|
@ -25,6 +25,7 @@ is not meant to modify Vault’s state.
|
||||||
- [Userpass](#userpass)
|
- [Userpass](#userpass)
|
||||||
- [Ldap](#ldap)
|
- [Ldap](#ldap)
|
||||||
- [Other Auth Methods](#other-auth-methods)
|
- [Other Auth Methods](#other-auth-methods)
|
||||||
|
- [Custom Path](#custom-path-name)
|
||||||
- [Key Syntax](#key-syntax)
|
- [Key Syntax](#key-syntax)
|
||||||
- [Simple Key](#simple-key)
|
- [Simple Key](#simple-key)
|
||||||
- [Set Output Variable Name](#set-output-variable-name)
|
- [Set Output Variable Name](#set-output-variable-name)
|
||||||
|
|
@ -300,6 +301,20 @@ with:
|
||||||
If any other method is specified and you provide an `authPayload`, the action will
|
If any other method is specified and you provide an `authPayload`, the action will
|
||||||
attempt to `POST` to `auth/${method}/login` with the provided payload and parse out the client token.
|
attempt to `POST` to `auth/${method}/login` with the provided payload and parse out the client token.
|
||||||
|
|
||||||
|
### Custom Path Name
|
||||||
|
|
||||||
|
Auth methods at custom path names can be configured using the [`path`](#path) parameter
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
with:
|
||||||
|
url: https://vault.mycompany.com:8200
|
||||||
|
caCertificate: ${{ secrets.VAULT_CA_CERT }}
|
||||||
|
path: my-custom-path
|
||||||
|
method: userpass
|
||||||
|
username: ${{ secrets.VAULT_USERNAME }}
|
||||||
|
password: ${{ secrets.VAULT_PASSWORD }}
|
||||||
|
```
|
||||||
|
|
||||||
## Key Syntax
|
## Key Syntax
|
||||||
|
|
||||||
The `secrets` parameter is a set of multiple secret requests separated by the `;` character.
|
The `secrets` parameter is a set of multiple secret requests separated by the `;` character.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue