Redact commands and args while logging Pod manifest #1200
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
Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com>
Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com>
pavannd1
reviewed
Jan 26, 2022
Co-authored-by: Pavan Navarathna <pavan@kasten.io>
julio-lopez
reviewed
Feb 3, 2022
|
|
||
| // SafeDumpPodObject redacts commands and args in Pod manifest to hide sensitive info, | ||
| // converts Pod object into string and returns it | ||
| func SafeDumpPodObject(pod *v1.Pod) string { |
There was a problem hiding this comment.
This function modifies pod. Either:
- it should be noted in the function documentation; or
- the function should create a deep copy.
This is not an issue in the current usage of this function. But, if the function were to be reused elsewhere, this is surprising behavior and it may actually introduce software defects (a.k.a bugs).
There was a problem hiding this comment.
That makes sense. Thanks a lot for letting me know. I will keep that in mind. Also, will fix this in the follow-up
10 tasks
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.
Change Overview
This PR adds a helper function that can be used to log pod object manifest safely by hiding the commands and args field values which can hold sensitive info.
Pull request type
Please check the type of change your PR introduces:
Test Plan