Skip to content

docs: add deploy-test-workload example proposal#115

Open
onmete wants to merge 3 commits into
openshift:mainfrom
onmete:feat/quickstart-examples
Open

docs: add deploy-test-workload example proposal#115
onmete wants to merge 3 commits into
openshift:mainfrom
onmete:feat/quickstart-examples

Conversation

@onmete

@onmete onmete commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add deploy-test-workload.yaml example proposal that exercises the full analysis + execution lifecycle (deploys nginx Deployment + Service)
  • Keep original namespace-inventory.yaml for investigate-and-remediate scenarios
  • Update install.sh output and README.md to reference both examples

Test plan

  • oc apply -f deploy-test-workload.yaml runs analysis and proposes deploying nginx
  • After execution approval, deployment + service are created
  • namespace-inventory.yaml still works as before

Made with Cursor

Add a second example proposal (deploy-test-workload.yaml) that
exercises the full analysis + execution lifecycle by deploying an
nginx Deployment and Service. Update install.sh and README to
reference both examples.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 7e30b7ff-7593-4581-9e55-8a28858900ab

📥 Commits

Reviewing files that changed from the base of the PR and between eef671d and 5547375.

📒 Files selected for processing (1)
  • hack/quickstart/uninstall.sh
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • openshift/lightspeed-agentic-sandbox (manual)
🚧 Files skipped from review as they are similar to previous changes (1)
  • hack/quickstart/uninstall.sh

📝 Walkthrough

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated quickstart guide with expanded workflow instructions
    • Enhanced installation steps with detailed post-deployment guidance
    • Improved uninstall process to ensure complete resource cleanup
  • New Features

    • Added example proposal demonstrating namespace analysis and test workload deployment with automated approval workflow

Walkthrough

This PR adds a new example Proposal manifest for deploying a test workload and updates quickstart README/install to reference it, and adjusts the uninstall script to add a cluster-scoped deletion and renumber steps from 5 to 6.

Changes

Test Workload Proposal Example

Layer / File(s) Summary
deploy-test-workload Proposal manifest
hack/quickstart/examples/deploy-test-workload.yaml
New Proposal manifest defines namespace analysis and test workload deployment: analysis checks for existing hello-test Deployment; execution creates hello-test Deployment with nginx:latest (1 replica) and ClusterIP Service on port 80, then verifies the pod reaches Running state. Both analysis and execution use the default agent.
Documentation and quickstart updates
hack/quickstart/README.md, hack/quickstart/install.sh
README "Example Proposal" section updated to reference deploy-test-workload.yaml. install.sh post-install instructions expanded to include downloading/applying namespace-inventory.yaml and deploy-test-workload.yaml, investigating namespace workloads, applying remediation, and submitting the test workload proposal for analysis+execution.
Uninstall script adjustments
hack/quickstart/uninstall.sh
Uninstall flow renumbered from 5 to 6 steps: adds deletion of cluster-scoped agenticolsconfig, separates operator deletion and CRD deletion phases (CRD list now includes agenticolsconfigs.agentic.openshift.io), and updates all step counters and user messages.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a new deploy-test-workload example proposal file.
Description check ✅ Passed The description clearly relates to the changeset, detailing the new example proposal, retention of existing examples, and documentation updates.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

@openshift-ci openshift-ci Bot requested review from blublinsky and raptorsun June 12, 2026 12:17
@openshift-ci

openshift-ci Bot commented Jun 12, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

@coderabbitai coderabbitai Bot 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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
hack/quickstart/install.sh (1)

295-298: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Use the matching proposal name in the approval command.

ProposalApproval names track the proposal name, so this command won't approve the deploy-test-workload execution path. Update it to target the proposal you just applied.

🛠 Proposed fix
-  oc patch proposalapproval namespace-inventory -n ${NAMESPACE} \
+  oc patch proposalapproval deploy-test-workload -n ${NAMESPACE} \
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@hack/quickstart/install.sh` around lines 295 - 298, The oc patch command is
targeting the wrong ProposalApproval name ("namespace-inventory"); change the
ProposalApproval resource name to the actual proposal you applied (e.g.,
"deploy-test-workload") so the approval affects the intended execution
path—update the oc patch invocation that references proposalapproval and the
resource name to use deploy-test-workload (keeping the rest of the flags and
payload the same).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@hack/quickstart/install.sh`:
- Around line 295-298: The oc patch command is targeting the wrong
ProposalApproval name ("namespace-inventory"); change the ProposalApproval
resource name to the actual proposal you applied (e.g., "deploy-test-workload")
so the approval affects the intended execution path—update the oc patch
invocation that references proposalapproval and the resource name to use
deploy-test-workload (keeping the rest of the flags and payload the same).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: e5e1dff1-d665-46d3-a6a4-2e1042530061

📥 Commits

Reviewing files that changed from the base of the PR and between 9295b67 and 8e1bcee.

📒 Files selected for processing (3)
  • hack/quickstart/README.md
  • hack/quickstart/examples/deploy-test-workload.yaml
  • hack/quickstart/install.sh
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • openshift/lightspeed-agentic-sandbox (manual)

…anup

Add AgenticOLSConfig CR and CRD deletion, console plugin deregistration,
and fix the confirmation message formatting.

Co-authored-by: Cursor <cursoragent@cursor.com>

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@hack/quickstart/uninstall.sh`:
- Around line 57-67: The code logs "Plugin deregistered from Console" regardless
of whether the oc patch actually succeeded; change the flow in the block that
handles PLUGIN_NAME so the patch attempt (oc patch console.operator.openshift.io
cluster ...) is executed without unconditionally swallowing failures and its
exit status is checked, and only print the success message when the patch
command returns a zero status; if patch fails, log a failure/info message and
continue to run oc delete consoleplugin "${PLUGIN_NAME}" --ignore-not-found so
the CR is removed even if the cluster spec still contains a stale reference.
Ensure you reference the same commands/objects (oc patch,
console.operator.openshift.io cluster, PLUGIN_NAME, and oc delete consoleplugin)
so the change updates the conditional logging based on the patch command result.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 46cebd53-7da4-4862-b7e9-439ed911f426

📥 Commits

Reviewing files that changed from the base of the PR and between 8e1bcee and eef671d.

📒 Files selected for processing (1)
  • hack/quickstart/uninstall.sh
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • openshift/lightspeed-agentic-sandbox (manual)

Comment thread hack/quickstart/uninstall.sh Outdated
Use if/then/else instead of && { } || so the success message only
prints when the patch actually succeeds.

Co-authored-by: Cursor <cursoragent@cursor.com>
@onmete onmete force-pushed the feat/quickstart-examples branch from 4997361 to 5547375 Compare June 12, 2026 14:04
@openshift-ci

openshift-ci Bot commented Jun 12, 2026

Copy link
Copy Markdown

@onmete: all tests passed!

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant