VEP-1493: Vault Integration For Secrets Storage #1756
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
This VEP proposes integration with Hashicorp Vault for secrets storage. Signed-off-by: Dako Dakov <ddakov@vmware.com>
dakodakov
changed the title
for more information, see https://pre-commit.ci
mivanov1988
reviewed
Mar 21, 2023
specs/vep-1493-vault-integration/diagrams/high_level_design.puml
Outdated
Show resolved
Hide resolved
specs/vep-1493-vault-integration/diagrams/high_level_design.puml
Outdated
Show resolved
Hide resolved
specs/vep-1493-vault-integration/diagrams/high_level_design.puml
Outdated
Show resolved
Hide resolved
specs/vep-1493-vault-integration/diagrams/high_level_design.puml
Outdated
Show resolved
Hide resolved
ivakoleva
reviewed
Mar 21, 2023
Address review feedback. Clarify API/CLI changes. Signed-off-by: Dako Dakov <ddakov@vmware.com>
for more information, see https://pre-commit.ci
Update Component diagram. Signed-off-by: Dako Dakov <ddakov@vmware.com>
Update diagram picture. Signed-off-by: Dako Dakov <ddakov@vmware.com>
…com/vmware/versatile-data-kit into person/ddakov/vep-vault-integration
more updates on the component diagram. Signed-off-by: Dako Dakov <ddakov@vmware.com>
Add alternatives section of the VEP Signed-off-by: Dako Dakov <ddakov@vmware.com>
for more information, see https://pre-commit.ci
antoniivanov
approved these changes
Mar 23, 2023
There was a problem hiding this comment.
Looks good to me. I made some very small (formatting) comments.
My main 3 comments (and those can be addressed in separate PR):
- ) Would vdk secrets CLI be the same as vdk properties (with only difference not allowing values on command line) ? Right ?
- I'd like us to think (and hence describe) a bit about performance, availability and security.
-
Availability. If Vault is down or slow ,
As vault is external service I really recommend implementing read-through cache with fallback (read from storage and on error from cache) . Because during a job run we only will read secrets. And writes would be outside of data job run. That would help keep the SLA of job runs , so in case Vault is unavailable we will rely on the server cache to make sure we still get return the values. As values would tend to be changed fairly rarely - having even hours exipry time (before failing) would be enough . (Spring CacheManager should made this easy). Though the cache would need to be encrypted and should be able to disable it. -
Performance - the secrets will be loaded and cached at teh start of the SDK run job. (the same is currently for properties ), right?
- The SDK API changes are missing . We will add new interface ISecrets in job_input (https://github.com/vmware/versatile-data-kit/blob/main/projects/vdk-core/src/vdk/api/job_input.py) , and then we can re-use basically the whole properties builtin plugin - https://github.com/vmware/versatile-data-kit/tree/main/projects/vdk-core/src/vdk/internal/builtin_plugins/job_properties with difference possibly having SecretsRouter. That's teh direction my thoughts go but other options are ok.
Co-authored-by: Antoni Ivanov <aivanov@vmware.com>
Co-authored-by: Antoni Ivanov <aivanov@vmware.com>
Co-authored-by: Antoni Ivanov <aivanov@vmware.com>
Co-authored-by: Antoni Ivanov <aivanov@vmware.com>
Co-authored-by: Antoni Ivanov <aivanov@vmware.com>
Co-authored-by: Antoni Ivanov <aivanov@vmware.com>
Address review feedback. Clarify API/CLI changes. Signed-off-by: Dako Dakov <ddakov@vmware.com>
for more information, see https://pre-commit.ci
Clarify SDK changes. Signed-off-by: Dako Dakov <ddakov@vmware.com>
…com/vmware/versatile-data-kit into person/ddakov/vep-vault-integration
|
Address review feedback. Signed-off-by: Dako Dakov <ddakov@vmware.com>
for more information, see https://pre-commit.ci
dakodakov
changed the title
Fix typo. Signed-off-by: Dako Dakov <ddakov@vmware.com>
|
The final version looks great. |
mivanov1988
approved these changes
Mar 24, 2023
Add clarification about vault entries. Signed-off-by: Dako Dakov <ddakov@vmware.com>
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.
This VEP proposes integration with Hashicorp Vault for secrets storage.