gered/vault-sidekick
Archived
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge pull request #35 from deed02392/patch-1

Browse source 
Update README.md
This commit is contained in:
Rohith Jayawardene 2017-05-03 21:37:17 +01:00 committed by GitHub
parent 03357aa59f 777362f79c
commit f0b715ce2a
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -35,7 +35,9 @@ Usage of bin/vault-sidekick:
**Building** **Building**
There is a Makefile in the base repository, so assuming you have make and go: # make There is a Makefile in the base repository, so assuming you have make and go:
`$ make`
**Example Usage** **Example Usage**
@ -57,7 +59,7 @@ spec:
mountPath: /etc/secrets mountPath: /etc/secrets
``` ```
The above say's The above equates to:
- Write all the secrets to the /etc/secrets directory - Write all the secrets to the /etc/secrets directory
- Retrieve a dynamic certificate pair for me, with the common name: 'commons.example.com' and renew the cert when it expires automatically - Retrieve a dynamic certificate pair for me, with the common name: 'commons.example.com' and renew the cert when it expires automatically
@ -67,7 +69,7 @@ The above say's
**Authentication** **Authentication**
A authentication file can be specified in either yaml of json format which contains a method field, indicating one of the authentication An authentication file can be specified in either yaml of json format which contains a method field, indicating one of the authentication
methods provided by vault i.e. userpass, token, github etc and then followed by the required arguments for that plugin. methods provided by vault i.e. userpass, token, github etc and then followed by the required arguments for that plugin.
If the required arguments for that plugin are not contained in the authentication file, fallbacks from environment variables are used. If the required arguments for that plugin are not contained in the authentication file, fallbacks from environment variables are used.