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.

Sign up for GitHub

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

Jump to bottom

maint: Add warning about cli flags #1293

Merged
merged 3 commits into from
Aug 22, 2024
Merged

maint: Add warning about cli flags #1293

merged 3 commits into from
Aug 22, 2024

Conversation

TylerHelmuth
Copy link
Contributor

Which problem is this PR solving?

  • Refinery has a couple CLI flags that, if used, could expose credetials. This PR adds warnings against such behavior.

Short description of the changes

  • Update the --help output to warn against using some flags
  • Update config docs to warn against using the command line flag option for some configuration fields.

@TylerHelmuth TylerHelmuth requested a review from a team as a code owner August 20, 2024 22:29
VinozzZ
VinozzZ reviewed Aug 21, 2024
View reviewed changes
config/metadata/configMeta.yaml Outdated
@@ -757,7 +757,7 @@ groups:
envvar: REFINERY_OTEL_METRICS_API_KEY, HONEYCOMB_API_KEY
commandline: otel-metrics-api-key
firstversion: v2.0
summary: is the API key used to send Honeycomb metrics via OpenTelemetry.
summary: is the API key used to send Honeycomb metrics via OpenTelemetry. Setting this value via a command line flag may expose credentials - it is recommended to use the env var or configuration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can specify through configuration files instead of just configuration?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

@TylerHelmuth TylerHelmuth added type: maintenance The necessary chores to keep the dust off. type: documentation version: no bump A PR with maintenance or doc changes that aren't included in a release. type: configuration Changes the configuration (and therefore requires regeneration and updating of docs). and removed type: configuration Changes the configuration (and therefore requires regeneration and updating of docs). labels Aug 22, 2024
@TylerHelmuth TylerHelmuth merged commit c87cc15 into main Aug 22, 2024
5 checks passed
@TylerHelmuth TylerHelmuth deleted the tyler.add-cli-warnings branch August 22, 2024 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@VinozzZ VinozzZ VinozzZ approved these changes

Assignees
No one assigned
Labels
type: documentation type: maintenance The necessary chores to keep the dust off. version: no bump A PR with maintenance or doc changes that aren't included in a release.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@TylerHelmuth @VinozzZ