Update KMS readme with vault quick start guide #6747
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #6747 +/- ##
==========================================
+ Coverage 52.25% 52.97% +0.71%
==========================================
Files 269 269
Lines 42176 42986 +810
==========================================
+ Hits 22039 22771 +732
+ Misses 18199 18194 -5
- Partials 1938 2021 +83
Continue to review full report at Codecov.
|
|
We don't need a separate vault quick start guide, we should simply add it in the same documentation in the prerequisite section. |
poornas
force-pushed
the
fixvaultdocs
branch
2 times, most recently
from
b0540bc
to
2272500
Compare
eco-minio
reviewed
Nov 1, 2018
docs/kms/README.md
Outdated
| vault auth enable approle # enable approle style auth | ||
| vault secrets enable transit # enable transit secrets engine | ||
| vault write -f transit/keys/my-minio-key #define a encryption key-ring for the transit path | ||
| vault policy write minio-policy ~/code/src/github.com/minio/vaultpolicy.hcl #define a policy for AppRole to access transit path |
There was a problem hiding this comment.
Should amend to a shorter path to the sample file (from the heredoc it implies pwd?)
docs/kms/README.md
Outdated
| vault secrets enable transit # enable transit secrets engine | ||
| vault write -f transit/keys/my-minio-key #define a encryption key-ring for the transit path | ||
| vault policy write minio-policy ~/code/src/github.com/minio/vaultpolicy.hcl #define a policy for AppRole to access transit path | ||
| vault write auth/approle/role/my-role token_num_uses=0 secret_id_num_uses=0 period=60s # period indicates it is renewable if tok renewed before the period is over |
There was a problem hiding this comment.
"...if token is renewed..."
ebozduman
previously requested changes
Nov 1, 2018
docs/kms/README.md
Outdated
| @@ -14,6 +14,43 @@ Vault as Key Management System requires following to be configured in Vault | |||
| - AppRole based authentication with read/update policy for transit backend. In particular, read and update policy | |||
| are required for the generate data key endpoint and decrypt key endpoint. | |||
|
|
|||
| Here is a sample quick start to configuring vault with a transit backend and Approle with correct policy | |||
There was a problem hiding this comment.
start to configuring vault => start for configuring vault
IMHO
|
@eco-minio && @ebozduman - updated PR. |
eco-minio
requested changes
Nov 2, 2018
poornas
force-pushed
the
fixvaultdocs
branch
2 times, most recently
from
9e12bd0
to
8ee6ff7
Compare
|
@ebozduman , addressed your feedback |
ebozduman
requested changes
Nov 3, 2018
docs/kms/README.md
Outdated
| are required for the generate data key endpoint and decrypt key endpoint. | ||
| - [transit](https://www.vaultproject.io/docs/secrets/transit/index.html) backend configured with a named encryption key-ring | ||
| - [AppRole](https://www.vaultproject.io/docs/auth/approle.html) based authentication with read/update policy for transit backend. In particular, read and update policy | ||
| are required for the Generate Data Key](https://www.vaultproject.io/api/secret/transit/index.html#generate-data-key) endpoint and [Decrypt Data](https://www.vaultproject.io/api/secret/transit/index.html#decrypt-data) endpoint. |
There was a problem hiding this comment.
Missing [ in ...for the Generate Data Key](...
Mint Automation
|
|
I noticed there is travis failure after giving my LGTM. |
|
@ebozduman , travis passed on restart |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding a quick start guide to configure Vault for use as KMS with minio server
Motivation and Context
Helps guide new users
Regression
NoHow Has This Been Tested?
Types of changes
Checklist:
mintPR # here: )