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

[Docs] Add sensitive fields reference to platform configuration #3152

Merged
merged 3 commits into from
Jan 31, 2024

Conversation

TomerShor
Copy link
Contributor

Document how to enable and set up sensitive fields masking in the platform configuration.

@github-actions github-actions bot added the docs label Jan 30, 2024
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:
Copy link
Contributor

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)

@TomerShor TomerShor merged commit e3b129f into nuclio:development Jan 31, 2024
1 check passed
@TomerShor TomerShor deleted the doc-sensitive-data-maksing branch January 31, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants