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

Configuration examples for OIDC/security and metrics #1384

Merged
merged 7 commits into from
Jan 22, 2025

Conversation

MikeEdgar
Copy link
Member

No description provided.

Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

Looks good, Mike. I made a few minor suggestions on descriptions as I read through. Feel free to ignore any. I think it might be useful to have a sentence to describe what we're looking at in each example yaml and and how to go about using it.

examples/console-config.yaml Outdated Show resolved Hide resolved
examples/console/console-openshift-metrics.yaml Outdated Show resolved Hide resolved
metricsSources:
# type=openshift-monitoring requires no other attributes, but truststore may be used if necessary
- name: my-ocp-prometheus
type: openshift-monitoring
Copy link
Contributor

Choose a reason for hiding this comment

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

will this always be openshift-monitoring?

Copy link
Member Author

Choose a reason for hiding this comment

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

For this example, yes. But, the type value is an enumeration. It could be one of openshift-monitoring, standalone, or embedded.

Copy link
Contributor

Choose a reason for hiding this comment

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

would they require additional attributes? Just thinking of what would be needed in the docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

The openshift-monitoring and embedded do not take any additional attributes. However, standalone requires a url and optionally takes authentication and a trustStore. The examples/console/console-standalone-prometheus.yaml includes them as well.

examples/console/console-openshift-metrics.yaml Outdated Show resolved Hide resolved
examples/console/console-openshift-metrics.yaml Outdated Show resolved Hide resolved
examples/console/console-standalone-prometheus.yaml Outdated Show resolved Hide resolved
examples/console/console-security-oidc.yaml Outdated Show resolved Hide resolved
examples/console/console-standalone-prometheus.yaml Outdated Show resolved Hide resolved
examples/console/console-standalone-prometheus.yaml Outdated Show resolved Hide resolved
examples/console/console-standalone-prometheus.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

Thanks Mike.
Summaries look great
Few minor suggestions

examples/console/console-openshift-metrics.yaml Outdated Show resolved Hide resolved
metricsSources:
# type=openshift-monitoring requires no other attributes, but truststore may be used if necessary
- name: my-ocp-prometheus
type: openshift-monitoring
Copy link
Contributor

Choose a reason for hiding this comment

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

would they require additional attributes? Just thinking of what would be needed in the docs.

examples/console/console-security-oidc.yaml Outdated Show resolved Hide resolved
# Using claims is only supported when OIDC security is enabled.
- claim: groups
include:
- team-a
Copy link
Contributor

Choose a reason for hiding this comment

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

Yep. Makes sense for me.

examples/console/console-standalone-prometheus.yaml Outdated Show resolved Hide resolved
@MikeEdgar MikeEdgar marked this pull request as ready for review January 21, 2025 20:23
@MikeEdgar MikeEdgar added this to the 0.6.2 milestone Jan 21, 2025
Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

Just one more thought, Mike.
Mention placeholder in description.

examples/console/console-security-oidc.yaml Show resolved Hide resolved
@MikeEdgar MikeEdgar merged commit 320644a into streamshub:main Jan 22, 2025
7 checks passed
@MikeEdgar MikeEdgar deleted the readme-examples branch January 22, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants