-
Notifications
You must be signed in to change notification settings - Fork 485
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update the "vault" plugin document. #1665
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @hiyosi.
I believe that this clarifies the requirements using the TOKEN auth method. Can we document about the other methods also?
@@ -23,6 +23,16 @@ The plugin supports **Client Certificate**, **Token** and **AppRole** authentica | |||
- **Token** method authenticates to Vault using the token in a HTTP Request header. | |||
- **AppRole** method authenticates to Vault using a RoleID and SecretID that are issued from Vault. | |||
|
|||
The plugin must have at least the following permissions(Vault Policy). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is somehow confusing for me. Instead of referring to the "plugin permissions", I would rather refer to the capabilities required in the policy. Which is actually pointed below.
We may say something along the lines of
The configured token needs to be attached to a policy that has at least the following capabilities: ...
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @hiyosi!
Thank you for review! |
@hiyosi can you update the branch so we can merge this? Thanks! |
Signed-off-by: Tomoya Usami <tousami@zlab.co.jp>
@amartinezfayo just updated the branch 😀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @hiyosi!
Signed-off-by: Tomoya Usami <tousami@zlab.co.jp> Signed-off-by: Agustín Martínez Fayó <amartinezfayo@gmail.com>
Signed-off-by: Tomoya Usami <tousami@zlab.co.jp>
Signed-off-by: Tomoya Usami <tousami@zlab.co.jp>
Pull Request check list
Affected functionality
The UpstreamAuthority
vault
document.Description of change
Update the UpstreamAuthority
vault
plugin document.Which issue this PR fixes
#1611 (comment)
and related to #1664