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 server_jolokia_metrics_whitelist parameter #826

Merged
merged 1 commit into from
Apr 5, 2022

Conversation

alexjfisher
Copy link
Contributor

When set, allows listed clients access to the V2 (jolokia) metrics
endpoint.

See https://puppet.com/docs/puppet/7/server/metrics-api/v2/metrics_api.html

@alexjfisher
Copy link
Contributor Author

Should I also accept a special value that turns on unauthenticated access, instead of populating the allow section?

ie

Variant[Enum['NOAUTH'],Array[String[1]]]

Or maybe also accept true??

Variant[Boolean, Array[String[1]]]

Or maybe a whitelist is overly complicated and I should have gone for a simple boolean!

@alexjfisher
Copy link
Contributor Author

rebased. @ekohl Does this look ok?

Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

I'm OK with this. I haven't used the metrics myself so I'll trust you on the specifics. The defaults don't change anything so 👍

Do we want to drop the comment describing the default?

@@ -537,6 +537,10 @@
# invokes when on static_file_content requests.
# Defaults to undef
#
# $server_jolokia_metrics_whitelist:: The whitelist of clients that
# can query the jolokia /metrics/v2 endpoint
# Defaults to []
Copy link
Member

Choose a reason for hiding this comment

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

IMHO there's no need to document the default.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed and rebased.

When set, allows listed clients access to the V2 (jolokia) metrics
endpoint.

See https://puppet.com/docs/puppet/7/server/metrics-api/v2/metrics_api.html
@ekohl ekohl merged commit e5253a6 into theforeman:master Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants