Skip to content

CCXDEV-14850: align insights DataGather with config #2248

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

opokornyy
Copy link
Contributor

This PR should align the configuration options in DataGather with the InsightsDataGather

This commit introduces the v1alpha2 version of the
DataGather CRD for Insights.

Signed-off-by: Ondrej Pokorny <[email protected]>
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Mar 26, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 26, 2025

@opokornyy: This pull request references CCXDEV-14850 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 task to target the "4.19.0" version, but no target version was set.

In response to this:

This PR should align the configuration options in DataGather with the InsightsDataGather

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.

Copy link
Contributor

openshift-ci bot commented Mar 26, 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 Mar 26, 2025
Copy link
Contributor

openshift-ci bot commented Mar 26, 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 joelspeed 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 opokornyy force-pushed the CCXDEV-15040-insights-v1alpha2 branch from cce4ef9 to af4174b Compare March 27, 2025 07:12
This commit aligns the configuration options of the
DataGather CRD with those of InsightsDataGather,
making it easier to use both CRDs.

Signed-off-by: Ondrej Pokorny <[email protected]>
@opokornyy opokornyy force-pushed the CCXDEV-15040-insights-v1alpha2 branch from af4174b to 4bada1b Compare March 27, 2025 08:07
@opokornyy
Copy link
Contributor Author

/cc @ncaak @tremes

@openshift-ci openshift-ci bot requested review from ncaak and tremes March 27, 2025 10:54
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.

I believe most of this API I've seen before and looks good. I've left comments on stuff that seemed new to me

@opokornyy opokornyy force-pushed the CCXDEV-15040-insights-v1alpha2 branch 2 times, most recently from 4725f08 to 866a461 Compare April 4, 2025 07:33
@everettraven
Copy link
Contributor

Just leaving a general note that some of the changes I've requested are a deviation from the v1alpha1 API that I think would be inherently breaking (i.e removing fields, etc.). I'm still learning what this means for alpha level APIs that are only in TPNU clusters, but I suspect we would likely want to go back and bring the v1alpha1 APIs into alignment (or drop them?).

@JoelSpeed what is the correct approach to follow here?

@JoelSpeed
Copy link
Contributor

Since we aren't going to allow clusters to upgrade between v1alpha1 and v1alpha2, we don't need to make changes in the alpha 1 or care about conversion webhooks, so we can make breaking changes here

@opokornyy opokornyy force-pushed the CCXDEV-15040-insights-v1alpha2 branch 3 times, most recently from 811a9a2 to d548836 Compare April 10, 2025 13:19
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.

A couple more comments plus my still outstanding comment on the TotalRisk field.

Other than that, I think this looks good.

@JoelSpeed will need to make a pass on it prior to it being able to merge though

@opokornyy opokornyy force-pushed the CCXDEV-15040-insights-v1alpha2 branch from d548836 to 0fa9cfb Compare April 11, 2025 11:44
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.

A couple more comments. Other than these, I think it looks good.

tagging in @JoelSpeed for a review.

// When it has a status of False and a reason Failed, the upload failed. The accompanying message will include the specific error encountered.
//
// The DataRecorded condition is used to represent whether or not the archive was successfully recorded.
// When it has a status of True and a reason of AsExpected, the archive was recorded successfully.
Copy link
Contributor

Choose a reason for hiding this comment

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

Succeeded > AsExpected ? WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have updated the values, so you can check it

// The RemoteConfigurationAvailable condition is used to represent whether the remote configuration is available.
// When it has a status of Unknown and a reason of Unknown or RemoteConfigNotRequestedYet, the state of the remote configuration is unknown—typically at startup.
// When it has a status of True and a reason of AsExpected, the configuration is available.
// When it has a status of False and a reason of AsExpected, the configuration is not available.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is AsExpected the right reason here? Reads a little funky to me if both available and unavailable are an expected state

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to Succeeded and Invalid

// The RemoteConfigurationValid condition is used to represent whether the remote configuration is valid.
// When it has a status of Unknown and a reason of Unknown or NoValidationYet, the validity of the remote configuration is unknown—typically at startup.
// When it has a status of True and a reason of AsExpected, the configuration is valid.
// When it has a status of False and a reason of AsExpected, the configuration is invalid.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto re: AsExpected when status is False

@opokornyy opokornyy force-pushed the CCXDEV-15040-insights-v1alpha2 branch from 0fa9cfb to 882784e Compare April 23, 2025 12:11
@opokornyy opokornyy force-pushed the CCXDEV-15040-insights-v1alpha2 branch 2 times, most recently from 5a4f9e6 to bb217af Compare April 25, 2025 12:15
Signed-off-by: Ondrej Pokorny <[email protected]>
@opokornyy opokornyy force-pushed the CCXDEV-15040-insights-v1alpha2 branch from bb217af to 522fbdc Compare April 29, 2025 11:18
Copy link
Contributor

openshift-ci bot commented Apr 29, 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.

@opokornyy opokornyy requested a review from JoelSpeed April 30, 2025 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants