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

Add a note about --dry-run displaying secrets #12859

Merged
merged 1 commit into from Mar 11, 2024

Conversation

mattfarina
Copy link
Collaborator

What this PR does / why we need it: It adds a message to the install and upgrade help output about --dry-run and what it outputs. That includes secrets.

Special notes for your reviewer: N/A

If applicable:

  • this PR contains documentation
  • this PR contains unit tests
  • this PR has been tested for backwards compatibility

@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 10, 2024
Copy link
Contributor

@sabre1041 sabre1041 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small suggestion to refine the verbiage. If approved, please be sure to update the wording in both install.go and upgrade.go files

the '--debug' and '--dry-run' flags can be combined.
the --debug and --dry-run flags can be combined.

The --dry-run flag will output all generated chart manifests, including Secrets.
Copy link
Contributor

@sabre1041 sabre1041 Mar 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The --dry-run flag will output all generated chart manifests, including Secrets.
The --dry-run flag will output all generated chart manifests, including Secrets, which can contain sensitive values.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because these secrets are chart/template generated they may be plain text. This is before they are sent to Kubernetes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update Updated proposed changes

the --debug and --dry-run flags can be combined.

The --dry-run flag will output all generated chart manifests, including Secrets.
Please carefully consider the environment it is used in.
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
Please carefully consider the environment it is used in.
Please carefully consider how and when these arguments are used.

Signed-off-by: Matt Farina <matt.farina@suse.com>
@pull-request-size pull-request-size bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 11, 2024
@mattfarina mattfarina added this to the 3.14.2 milestone Mar 11, 2024
Copy link
Contributor

@sabre1041 sabre1041 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mattfarina mattfarina merged commit 106f7a8 into helm:main Mar 11, 2024
5 checks passed
@mattfarina mattfarina deleted the update-dry-run-messaging branch March 11, 2024 20:19
@mattfarina
Copy link
Collaborator Author

Note, this documentation is converted into mardown and placed on helm.sh.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants