Skip to content

WIP: [CCXDEV-15259]: promote InsightConfigAPI and OnDemandDataGather to v1 #2448

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
Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

WIP: [CCXDEV-15259]: promote InsightConfigAPI and OnDemandDataGather to v1 #2448

wants to merge 6 commits into from

Conversation

opokornyy
Copy link
Contributor

No description provided.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 12, 2025
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 12, 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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Aug 12, 2025
@openshift-ci openshift-ci bot requested review from deads2k and everettraven August 12, 2025 14:24
@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Aug 12, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: opokornyy
Once this PR has been reviewed and has the lgtm label, please assign deads2k for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@opokornyy
Copy link
Contributor Author

/retest

@opokornyy
Copy link
Contributor Author

/test verify-feature-promotion

@opokornyy opokornyy force-pushed the CCXDEV-15259-io-v1 branch 2 times, most recently from d7b46b0 to dce787e Compare August 15, 2025 09:48
@opokornyy opokornyy changed the title WIP: promote InsightConfigAPI and OnDemandDataGather to v1 WIP: [CCXDEV-15259]: promote InsightConfigAPI and OnDemandDataGather to v1 Aug 15, 2025
JoelSpeed
JoelSpeed reviewed Aug 18, 2025
View reviewed changes
@opokornyy opokornyy force-pushed the CCXDEV-15259-io-v1 branch 2 times, most recently from 382e32d to c47f3e9 Compare August 19, 2025 08:08
@opokornyy
feat(insights): add v1 version
c01c100 
Signed-off-by: Ondrej Pokorny <[email protected]>
@opokornyy
feat(config): add v1 version for insights config
3b94abc 
Signed-off-by: Ondrej Pokorny <[email protected]>
@opokornyy
fix: linter errors
abc890b 
Signed-off-by: Ondrej Pokorny <[email protected]>
@opokornyy
fix: integration tests
502bf0a 
Signed-off-by: Ondrej Pokorny <[email protected]>
everettraven
everettraven reviewed Aug 19, 2025
View reviewed changes
@opokornyy
fix: dataPolicy linter error
d29ee57 
Signed-off-by: Ondrej Pokorny <[email protected]>
opokornyy
opokornyy commented Sep 1, 2025
View reviewed changes
@opokornyy
fix: totalRisk and group fields
e34bacd 
Signed-off-by: Ondrej Pokorny <[email protected]>
@opokornyy
Copy link
Contributor Author

/retest

JoelSpeed
JoelSpeed reviewed Sep 2, 2025
View reviewed changes
config/v1/types_insights.go
// +kubebuilder:validation:MinProperties=1
type InsightsDataGatherSpec struct {
// gatherConfig is an optional spec attribute that includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.
// +optional
Copy link
Contributor

Choose a reason for hiding this comment

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

Have we considered making this required? It's currently the only spec option and it seems the only purpose of this object so far is to handle the gather config. With the MinProperties:=1, the object cannot exist without it presently?

Are we expecting any future expansion? Any feedback from folks about future features we will need to support alongside gatherConfig?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are no plans to expand the spec. The MinProperties:=1 is forcing the use of gatherConfig, so maybe we should change this to required. At the moment, it doesn’t really make sense to create this object without gatherConfig defined.

Copy link
Contributor

Choose a reason for hiding this comment

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

If you make gatherConfig required, then we don't need the MinProperties anymore

config/v1/types_insights.go
}

// +kubebuilder:validation:MinProperties=1
type InsightsDataGatherStatus struct{}
Copy link
Contributor

Choose a reason for hiding this comment

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

Still don't need any status?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, if I am not overlooking anything, we are just reading the Spec

config/v1/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.

Have any of the gatherers developed any additional configuration so far, that we might want to think about adding alongside the current fields in this struct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

At the moment this should be sufficient configuration.

@openshift-ci OpenShift CI
Copy link
Contributor

openshift-ci bot commented Sep 2, 2025

@opokornyy: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-aws-serial-techpreview-1of2 e34bacd link true /test e2e-aws-serial-techpreview-1of2
ci/prow/e2e-aws-ovn-hypershift e34bacd link true /test e2e-aws-ovn-hypershift
ci/prow/e2e-aws-ovn-techpreview e34bacd link true /test e2e-aws-ovn-techpreview
ci/prow/e2e-aws-serial-techpreview-2of2 e34bacd link true /test e2e-aws-serial-techpreview-2of2

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.

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

@deads2k deads2k Awaiting requested review from deads2k

2 more reviewers

@JoelSpeed JoelSpeed JoelSpeed left review comments

@everettraven everettraven everettraven left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. 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.
3 participants
@opokornyy @JoelSpeed @everettraven