Skip to content

NO-JIRA: Add initial Agent Guide#682

Open
dfajmon wants to merge 1 commit intoopenshift:mainfrom
dfajmon:add-agents-md
Open

NO-JIRA: Add initial Agent Guide#682
dfajmon wants to merge 1 commit intoopenshift:mainfrom
dfajmon:add-agents-md

Conversation

@dfajmon
Copy link
Contributor

@dfajmon dfajmon commented Mar 16, 2026

Add AGENTS.md, which contains instructions for coderabbit and other agentic AI.

@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 16, 2026
@openshift-ci-robot
Copy link
Contributor

@dfajmon: This pull request explicitly references no jira issue.

Details

In response to this:

Add AGENTS.md, which contains instructions for coderabbit and other agentic AI.

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.

@coderabbitai
Copy link

coderabbitai bot commented Mar 16, 2026

Walkthrough

A new documentation file AGENTS.md is added, providing comprehensive guidance on the cluster-storage-operator architecture, deployment modes, components, asset generation, development commands, and PR review procedures.

Changes

Cohort / File(s) Summary
Documentation
AGENTS.md
Adds comprehensive agent guide documentation covering CSO architecture, repository layout, deployment modes (Standalone, HyperShift), CSIOperatorConfig, asset generation, manifest topology, development commands, PR review criteria, and operator deployment procedures.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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

Tip

CodeRabbit can generate a title for your PR based on the changes with custom instructions.

Set the reviews.auto_title_instructions setting to generate a title for your PR based on the changes in the PR with custom instructions.

@openshift-ci openshift-ci bot requested review from gnufied and rhrmo March 16, 2026 09:57
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Mar 16, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dfajmon

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 Mar 16, 2026
Copy link

@coderabbitai coderabbitai bot left a comment

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 the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Around line 255-260: The doc currently instructs scaling down core operators
(oc scale --replicas=0 deploy/cluster-version-operator and
cluster-storage-operator) without any recovery steps; add a clear WARNING that
this is for non-production/dev clusters only and append explicit rollback
commands to restore those operators (oc scale --replicas=1
deploy/cluster-storage-operator and oc scale --replicas=1
deploy/cluster-version-operator) after testing, and ensure the restore sequence
and brief note about waiting for operator readiness (cluster-storage-operator,
cluster-version-operator) are included so the cluster isn't left degraded.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cac11555-514d-4fed-917e-e644ecc80998

📥 Commits

Reviewing files that changed from the base of the PR and between f7b0b15 and 5adeddc.

📒 Files selected for processing (1)
  • AGENTS.md

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Mar 16, 2026

@dfajmon: 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-azure-csi 5adeddc link true /test e2e-azure-csi
ci/prow/hypershift-aws-e2e-external 5adeddc link true /test hypershift-aws-e2e-external

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.

@jsafrane
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 16, 2026
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. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants