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

CCXDEV-10455: update insightsDataGather to v1alpha2 with GathererConfig #2195

Merged
merged 1 commit into from
Mar 25, 2025
Merged

CCXDEV-10455: update insightsDataGather to v1alpha2 with GathererConfig #2195

merged 1 commit into from
Mar 25, 2025
+2,460 −1

Conversation

opokornyy
Copy link
Contributor

This PR introduces v1alpha2 for insightsDataGather, adding GathererConfig struct to enable/disable gatherers.

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Feb 6, 2025

Hello @opokornyy! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

@openshift-ci openshift-ci bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Feb 6, 2025
@openshift-ci openshift-ci bot requested review from JoelSpeed and knobunc February 6, 2025 13:35
@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch 3 times, most recently from c78f261 to 3986a7e Compare February 10, 2025 12:18
@opokornyy opokornyy changed the title feat: update insightsDataGather to v1alpha2 with GathererConfig CCXDEV-10455: update insightsDataGather to v1alpha2 with GathererConfig Feb 10, 2025
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 10, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Feb 10, 2025 •
edited by openshift-ci bot
Loading

@opokornyy: This pull request references CCXDEV-10455 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.19.0" version, but no target version was set.

In response to this:

This PR introduces v1alpha2 for insightsDataGather, adding GathererConfig struct to enable/disable gatherers.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch 5 times, most recently from be009b6 to 886b8ee Compare February 11, 2025 09:58
ncaak
ncaak approved these changes Feb 11, 2025
View reviewed changes
Copy link

@ncaak ncaak left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 11, 2025
JoelSpeed
JoelSpeed reviewed Feb 11, 2025
View reviewed changes
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Feb 14, 2025
@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from 98363ff to f06d4c2 Compare March 5, 2025 14:57
@openshift-ci openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 5, 2025
JoelSpeed
JoelSpeed reviewed Mar 5, 2025
View reviewed changes
config/v1alpha2/types_insights.go
}

// gathererConfig allows to configure specific gatherers
type GathererConfig struct {
Copy link
Contributor

Choose a reason for hiding this comment

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

This API has existed for some time now, did we reach any consensus on potential additions to the GathererConfig? Is there any feedback that individual gatherers might need some additional configuration here?

Copy link
Contributor

Choose a reason for hiding this comment

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

We don't have any additions at the moment. The main thing here is the ability to disable a specific gatherer.

@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from eca5670 to c72345d Compare March 6, 2025 09:47
@opokornyy
Copy link
Contributor Author

/cc @everettraven can you also have a look please?

@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from 370e87b to fac9dfd Compare March 18, 2025 10:11
everettraven
everettraven reviewed Mar 19, 2025
View reviewed changes
Copy link
Contributor

@everettraven everettraven left a comment

Choose a reason for hiding this comment

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

Aside from the open questions/threads I think this looks good. Tagging in @JoelSpeed to do a pass and get his thoughts on the open comments.

JoelSpeed
JoelSpeed reviewed Mar 19, 2025
View reviewed changes
config/v1alpha2/types_insights.go Outdated
// It may not exceed 2 items and must not contain duplicates.
// Valid values are ObfuscateNetworking and WorkloadNames.
// When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated.
// When set to WorkloadNames the data from Deployment Validation Operator is obfuscated.
Copy link
Contributor

Choose a reason for hiding this comment

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

For my own interest, what is the Deployment Validation Operator? And what data does it produce?

Also, probably want "the"

Suggested change
// When set to WorkloadNames the data from Deployment Validation Operator is obfuscated.
// When set to WorkloadNames the data from the Deployment Validation Operator is obfuscated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The Deployment Validation Operator runs Kube-linter against deployment manifests to check if they follow best practices and reports the results as Prometheus metrics, which are then processed with IO.

Copy link
Contributor

Choose a reason for hiding this comment

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

How obvious do you expect that to be to end users? I'm not sure I'd have known that, and I'm still not quite sure I'd know what this option does.

Is there a way we can work this that explains what the end user would see as a difference, without using the implementation detail in the description?

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, now it should be hopefully more user-friendly

everettraven
everettraven approved these changes Mar 20, 2025
View reviewed changes
Copy link
Contributor

@everettraven everettraven left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 20, 2025
@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from 265397e to 27fed23 Compare March 21, 2025 12:27
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Mar 21, 2025
@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from 27fed23 to 858cda7 Compare March 21, 2025 13:37
@JoelSpeed
Copy link
Contributor

LGTM once #2195 (comment) is sorted

@JoelSpeed
Copy link
Contributor

Could you please squash the commits, I don't think we need all the fixups in the history

@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from 1783599 to f3f5ffe Compare March 24, 2025 12:41
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 24, 2025
@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from f3f5ffe to 7ef147e Compare March 24, 2025 12:48
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 24, 2025
@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from 7ef147e to 0824b0a Compare March 24, 2025 12:52
@opokornyy
feat: update insightsDataGather to v1alpha2 with GathererConfig
4790b49 
This commit introduces v1alpha2 for insightsDataGather, adding
GathererConfig struct to enable/disable gatherers.

Signed-off-by: Ondrej Pokorny <[email protected]>
@opokornyy opokornyy force-pushed the CCX10455-gathererConfig branch from 0824b0a to 4790b49 Compare March 24, 2025 16:06
@JoelSpeed
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 24, 2025
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Mar 24, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: everettraven, JoelSpeed, ncaak, opokornyy

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 24, 2025
@opokornyy
Copy link
Contributor Author

/label acknowledge-critical-fixes-only

@openshift-ci openshift-ci bot added the acknowledge-critical-fixes-only Indicates if the issuer of the label is OK with the policy. label Mar 25, 2025
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Mar 25, 2025

@opokornyy: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@openshift-merge-bot openshift-merge-bot bot merged commit 21c5401 into openshift:master Mar 25, 2025
12 checks passed
@openshift-bot
Copy link

[ART PR BUILD NOTIFIER]

Distgit: ose-cluster-config-api
This PR has been included in build ose-cluster-config-api-container-v4.19.0-202503251208.p0.g21c5401.assembly.stream.el9.
All builds following this will include this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tremes tremes

@JoelSpeed JoelSpeed

@ncaak ncaak

@everettraven everettraven

@knobunc knobunc

Assignees

@JoelSpeed JoelSpeed

@everettraven everettraven

@ncaak ncaak

Labels
acknowledge-critical-fixes-only Indicates if the issuer of the label is OK with the policy. approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@opokornyy @openshift-ci-robot @JoelSpeed @openshift-bot @tremes @everettraven @ncaak @openshift-merge-robot