Skip to content

Rename "Insights Advisor" to "Red Hat Lightspeed Advisor" in API docs#2911

Open
Jakub007d wants to merge 1 commit into
openshift:masterfrom
Jakub007d:advisor-rename
Open

Rename "Insights Advisor" to "Red Hat Lightspeed Advisor" in API docs#2911
Jakub007d wants to merge 1 commit into
openshift:masterfrom
Jakub007d:advisor-rename

Conversation

@Jakub007d

Copy link
Copy Markdown

Rename all "Insights Advisor" references in API field descriptions to "Red Hat Lightspeed Advisor" across operator/v1, insights/v1, insights/v1alpha1, and insights/v1alpha2 types.
The generated swagger docs, CRD manifests, and OpenAPI specs were updated with make update.

Ref: https://redhat.atlassian.net/browse/HCCDOC-4522

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

@openshift-ci openshift-ci Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Hello @Jakub007d! 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Hi @Jakub007d. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This pull request updates documentation text in several HealthCheck type definitions and the generated CRD manifest. References to “Insights Advisor” were changed to “Red Hat Lightspeed Advisor” for the AdvisorURI/advisorURI field, and one state field description was reworded accordingly. Field names, types, JSON tags, validation markers, and behavior were unchanged.

Changes

  • Go type comments updated in insights/v1, insights/v1alpha1, insights/v1alpha2, and operator/v1
  • CRD schema description updated in payload-manifests/crds/0000_10_insights_01_datagathers.crd.yaml

Sequence Diagram(s)

Not applicable.

Estimated code review effort: Low

Related issues: None specified

Related PRs: None specified

Suggested labels: documentation, low-risk

Suggested reviewers: None specified

🚥 Pre-merge checks | ✅ 5 | ❌ 10

❌ Failed checks (10 inconclusive)

Check name Status Explanation Resolution
Stable And Deterministic Test Names ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Test Structure And Quality ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Microshift Test Compatibility ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Single Node Openshift (Sno) Test Compatibility ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Topology-Aware Scheduling Compatibility ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Ote Binary Stdout Contract ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Ipv6 And Disconnected Network Test Compatibility ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
No-Weak-Crypto ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Container-Privileges ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
No-Sensitive-Data-In-Logs ❓ Inconclusive Repository clone failed, so this custom check could not run with code access. Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately summarizes the API doc rename from Insights Advisor to Red Hat Lightspeed Advisor.
Description check ✅ Passed The description matches the changeset and accurately describes the documentation updates and generated outputs.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

Comment thread insights/v1/types_insights.go Outdated
Comment thread insights/v1alpha1/types_insights.go Outdated
Comment thread insights/v1/zz_generated.crd-manifests/0000_10_insights_01_datagathers.crd.yaml Outdated
Comment thread insights/v1alpha2/types_insights.go Outdated
Comment thread payload-manifests/crds/0000_10_insights_01_datagathers.crd.yaml Outdated

@michelle-purcell michelle-purcell left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@jakub - I reviewed the PR from the docs perspective for Red Hat style and grammar guidelines. Looks great. Just a few comments and suggestions. Thank you for your help with these updates 😄

@michelle-purcell

Copy link
Copy Markdown

/lgtm - my comments are non-critcal.

@Jakub007d Jakub007d marked this pull request as ready for review July 9, 2026 11:06
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 9, 2026
@openshift-ci openshift-ci Bot requested review from JoelSpeed and everettraven July 9, 2026 11:06
@JoelSpeed

Copy link
Copy Markdown
Contributor

I'm not necessarily familiar with what's happened on the rebrand here, is Insights Advisor always Lightspeed advisor UI now?

@michelle-purcell

Copy link
Copy Markdown

I'm not necessarily familiar with what's happened on the rebrand here, is Insights Advisor always Lightspeed advisor UI now?

Yes. It's the Red Hat Lightspeed Advisor UI (and it's Red Hat Lightspeed advisor service (lowercase a in this context)

@JoelSpeed

Copy link
Copy Markdown
Contributor

/lgtm
/verified by CI

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Jul 10, 2026
@openshift-ci-robot

Copy link
Copy Markdown

@JoelSpeed: This PR has been marked as verified by CI.

Details

In response to this:

/lgtm
/verified by CI

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.

@JoelSpeed

Copy link
Copy Markdown
Contributor

/ok-to-test

@openshift-ci openshift-ci Bot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Jul 10, 2026
@openshift-ci openshift-ci Bot added lgtm Indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 10, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Scheduling tests matching the pipeline_run_if_changed or not excluded by pipeline_skip_if_only_changed parameters:
/test e2e-aws-ovn
/test e2e-aws-ovn-hypershift
/test e2e-aws-ovn-hypershift-conformance
/test e2e-aws-ovn-techpreview
/test e2e-aws-serial-1of2
/test e2e-aws-serial-2of2
/test e2e-aws-serial-techpreview-1of2
/test e2e-aws-serial-techpreview-2of2
/test e2e-azure
/test e2e-gcp
/test e2e-upgrade
/test e2e-upgrade-out-of-change
/test minor-e2e-upgrade-minor

@openshift-ci

openshift-ci Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JoelSpeed, michelle-purcell

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

The pull request process is described here

Details 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 Jul 10, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

/retest-required

Remaining retests: 0 against base HEAD a3d85be and 2 for PR HEAD 212a921 in total

@openshift-ci

openshift-ci Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

@Jakub007d: 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-ovn 212a921 link true /test e2e-aws-ovn
ci/prow/e2e-aws-ovn-hypershift-conformance 212a921 link true /test e2e-aws-ovn-hypershift-conformance
ci/prow/e2e-azure 212a921 link true /test e2e-azure
ci/prow/e2e-aws-ovn-techpreview 212a921 link true /test e2e-aws-ovn-techpreview
ci/prow/verify 212a921 link true /test verify
ci/prow/e2e-aws-serial-techpreview-2of2 212a921 link true /test e2e-aws-serial-techpreview-2of2
ci/prow/e2e-gcp 212a921 link true /test e2e-gcp

Full PR test history. Your PR dashboard.

Details

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

Copy link
Copy Markdown
Contributor

/retest-required

Remaining retests: 0 against base HEAD fa22e69 and 1 for PR HEAD 212a921 in total

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

/retest-required

Remaining retests: 0 against base HEAD d8a1748 and 0 for PR HEAD 212a921 in total

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

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants