-
Notifications
You must be signed in to change notification settings - Fork 525
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
[Docs] Add sensitive fields reference to platform configuration #3152
Merged
TomerShor
merged 3 commits into
nuclio:development
from
TomerShor:doc-sensitive-data-maksing
Jan 31, 2024
Merged
[Docs] Add sensitive fields reference to platform configuration #3152
TomerShor
merged 3 commits into
nuclio:development
from
TomerShor:doc-sensitive-data-maksing
Jan 31, 2024
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
liranbg
reviewed
Jan 30, 2024
docs/tasks/configuring-a-platform.md
Outdated
Comment on lines
221
to
225
Sensitive fields are fields that contain sensitive information such as passwords, tokens, etc. | ||
When masking is enabled, these fields are encrypted in a secret, and are decrypted when the function is deployed. | ||
There are some config fields that are [masked by default](https://github.com/nuclio/nuclio/blob/development/pkg/platformconfig/types.go#L303-L340), and you can add custom sensitive fields to mask by specifying the regex to the path in the function configuration. | ||
The masked fields are replaced with references (`$ref`) in the function configuration. | ||
Example: |
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.
Suggested change
Sensitive fields are fields that contain sensitive information such as passwords, tokens, etc. | |
When masking is enabled, these fields are encrypted in a secret, and are decrypted when the function is deployed. | |
There are some config fields that are [masked by default](https://github.com/nuclio/nuclio/blob/development/pkg/platformconfig/types.go#L303-L340), and you can add custom sensitive fields to mask by specifying the regex to the path in the function configuration. | |
The masked fields are replaced with references (`$ref`) in the function configuration. | |
Example: | |
Nuclio resources (currently function configuration only) may contain sensitive information such as passwords, tokens, etc. | |
When masking sensitive fields feature is enabled, these fields gets obfuscated, their raw values stored aside (Kubernetes secret), and populated internally, for when it is needed (i.e function deployment) | |
There are some config fields that are [masked by default](https://github.com/nuclio/nuclio/blob/development/pkg/platformconfig/types.go#L303-L340), and you can add custom sensitive fields to mask by specifying the regex to the path in the function configuration. | |
The masked fields are replaced with references (`$ref`) in the function configuration. | |
Example: |
While writing this doc, I think it is clear we need to extend the capability for more nuclio resources (project, api gateway, etc)
rokatyy
approved these changes
Jan 31, 2024
jillnogold
reviewed
Jan 31, 2024
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.
Document how to enable and set up sensitive fields masking in the platform configuration.