Skip to content
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

Merged
merged 1 commit into from
Jun 20, 2020

Conversation

hiyosi
Copy link
Contributor

@hiyosi hiyosi commented Jun 18, 2020

Pull Request check list

  • Commit conforms to CONTRIBUTING.md?
  • Proper tests/regressions included?
  • Documentation updated?

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

Copy link
Member

@amartinezfayo amartinezfayo left a 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).
Copy link
Member

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?

amartinezfayo
amartinezfayo previously approved these changes Jun 19, 2020
Copy link
Member

@amartinezfayo amartinezfayo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @hiyosi!

@hiyosi
Copy link
Contributor Author

hiyosi commented Jun 19, 2020

Thank you for review!
I'll rebase the commits.

amartinezfayo
amartinezfayo previously approved these changes Jun 19, 2020
@amartinezfayo
Copy link
Member

@hiyosi can you update the branch so we can merge this? Thanks!

Signed-off-by: Tomoya Usami <tousami@zlab.co.jp>
@hiyosi
Copy link
Contributor Author

hiyosi commented Jun 20, 2020

@amartinezfayo just updated the branch 😀

Copy link
Member

@amartinezfayo amartinezfayo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @hiyosi!

@amartinezfayo amartinezfayo merged commit 62ff83b into spiffe:master Jun 20, 2020
amartinezfayo pushed a commit to amartinezfayo/spire that referenced this pull request Jun 22, 2020
Signed-off-by: Tomoya Usami <tousami@zlab.co.jp>
Signed-off-by: Agustín Martínez Fayó <amartinezfayo@gmail.com>
amartinezfayo pushed a commit to amartinezfayo/spire that referenced this pull request Jun 22, 2020
Signed-off-by: Tomoya Usami <tousami@zlab.co.jp>
amartinezfayo pushed a commit to amartinezfayo/spire that referenced this pull request Jun 23, 2020
Signed-off-by: Tomoya Usami <tousami@zlab.co.jp>
@hiyosi hiyosi deleted the fix_vault_doc branch July 8, 2020 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants