Skip to content

Conversation

@Lennonka
Copy link
Contributor

@Lennonka Lennonka commented Dec 9, 2025

What changes are you introducing?

Adding permission prerequisites to Lightspeed IoP procedures

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

SAT-40633

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

  • Expected in Foreman 3.18 (I guess)

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into: N/A

Summary by Sourcery

Document permission prerequisites for accessing Lightspeed IoP features and related Insights information.

Documentation:

  • Add permission prerequisites to the Lightspeed IoP vulnerability examination procedure documentation.
  • Update Insights-in-project access reference to describe required permissions for Lightspeed IoP usage.

@sourcery-ai
Copy link

sourcery-ai bot commented Dec 9, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documents required permissions and prerequisites for using Lightspeed IoP, updating existing vulnerability examination and Insights access procedures to explicitly call out Lightspeed IoP–related access requirements.

File-Level Changes

Change Details Files
Add explicit permission prerequisites to the procedure for examining system vulnerabilities when using Lightspeed IoP.
  • Update procedural steps to mention Lightspeed IoP–specific roles or permissions needed before following the vulnerability examination workflow
  • Clarify that users must ensure appropriate access in advance, likely via role-based permissions or organization/location context
  • Adjust supporting text so that failure cases or limitations are framed in terms of missing Lightspeed IoP permissions
guides/common/modules/proc_examining-vulnerability-of-systems.adoc
Extend the reference documentation for accessing information from Insights in projects to include Lightspeed IoP permission requirements.
  • Describe which permissions, roles, or entitlements are required to access Lightspeed IoP features within Insights-integrated workflows
  • Clarify how Lightspeed IoP access interacts with existing Insights or project-level permissions
  • Align terminology and expectations with the target Foreman 3.18 behavior for Lightspeed IoP
guides/common/modules/ref_access-to-information-from-insights-in-project.adoc

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@Lennonka Lennonka marked this pull request as draft December 9, 2025 17:56
@github-actions github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Dec 9, 2025
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `guides/common/modules/ref_access-to-information-from-insights-in-project.adoc:18` </location>
<code_context>
 If the host has recommendations listed, click on the number of recommendations.
 On the *{Insights}* tab, the vertical ellipsis next to the *Remediate* button provides a *Go To {Project} {Insights} page* link to information for the system, and a *View in {Insights}* link to host details on the console.
+
+Your {Project} account must have the `view_advisor` permission to view information from {Insights}.
</code_context>

<issue_to_address>
**suggestion (review_instructions):** This sentence is written as a product/permission statement rather than in a user-story style as requested.

To better align with the user-story style, consider rephrasing this to focus on what the user can do when they have this permission. For example, something along the lines of “As a user with the `view_advisor` permission, you can view information from {Insights} …” or similar wording that emphasizes the user’s goal and outcome rather than the permission as a product feature.

<details>
<summary>Review instructions:</summary>

**Path patterns:** `guides/common/*.adoc,guides/common/modules/*.adoc`

**Instructions:**
Documentation describes a user story rather than a product feature.

</details>
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Lennonka Lennonka added the Waiting for code Requires merge of related code in another repository before it can be merged label Dec 9, 2025
@github-actions
Copy link

github-actions bot commented Dec 9, 2025

Copy link

@qcjames53 qcjames53 left a comment

Choose a reason for hiding this comment

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

This looks good to me! Permissions match https://issues.redhat.com/browse/SAT-40632.

@Lennonka Lennonka added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Dec 18, 2025
@Lennonka
Copy link
Contributor Author

Lennonka commented Dec 18, 2025

Thank you for reviews, folks!

I'm gonna have to rebase this PR after #4524 will have been merged. It will look very differently, so I'm keeping the style ack open for now. :)

@Lennonka
Copy link
Contributor Author

Lennonka commented Jan 6, 2026

Rebased.

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

Labels

Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing tech review done No issues from the technical perspective Waiting for code Requires merge of related code in another repository before it can be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants