Skip to content

Add OLM plugin with debug command and Jira integration #54

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 29, 2025
Merged

Add OLM plugin with debug command and Jira integration #54

merged 1 commit into from
Oct 29, 2025
+354 −0

Conversation

@jianzhangbjz
Copy link
Contributor

What this PR does / why we need it:

This commit introduces a new OLM plugin that provides debugging capabilities
for Operator Lifecycle Manager issues. The /olm:debug command analyzes
must-gather logs, correlates errors with source code, and searches for known
bugs in Jira's OCPBUGS project.

Key features:

  • Supports both OLMv0 and OLMv1 architectures
  • Automatically detects OCP version from must-gather logs
  • Clones appropriate repositories and checks out matching branches
  • Queries Jira for known bugs in OCPBUGS project (OLM component)
  • Generates comprehensive analysis reports with code references

Files added:

  • plugins/olm/.claude-plugin/plugin.json
  • plugins/olm/commands/debug.md
  • plugins/olm/README.md
  • Updated .claude-plugin/marketplace.json

Which issue(s) this PR fixes:

Fixes
This PR introduces a new OLM plugin that provides automated debugging capabilities for Operator Lifecycle Manager (OLM) issues in OpenShift clusters. The plugin
includes a /olm:debug command that combines must-gather log analysis, source code correlation, and Jira bug searching to streamline OLM troubleshooting.

Motivation

Debugging OLM issues currently requires manual correlation between:

  • Must-gather logs from customer clusters
  • OLM source code across multiple repositories
  • Known bugs in Jira (OCPBUGS project)

This process is time-consuming and error-prone. This plugin automates these steps, significantly reducing debugging time and improving accuracy.

The /olm:debug command accepts three parameters:
/olm:debug [olm-version]

  • issue-description: Brief description of the OLM issue
  • must-gather-path: Path to must-gather log directory
  • olm-version: Optional, either olmv0 (default) or olmv1

Automated Analysis Workflow

  1. OCP Version Detection: Automatically extracts OpenShift version from must-gather logs
  2. Repository Management:
    • OLMv0: Clones openshift/operator-framework-olm
    • OLMv1: Clones openshift/operator-framework-operator-controller and openshift/cluster-olm-operator
    • Checks out branches matching OCP version (e.g., release-4.14)
  3. Log Analysis: Extracts and analyzes OLM-related logs, errors, and stack traces
  4. Jira Integration:
    • Queries OCPBUGS project for OLM component bugs
    • Matches errors with known bugs using intelligent pattern matching
    • Categorizes matches by confidence (High/Medium/Low)
  5. Code Correlation: Maps errors to source code locations
  6. Report Generation: Creates comprehensive analysis with actionable recommendations

Special notes for your reviewer:

Checklist:

  • Subject and description added to both, commit and PR.
  • Relevant issues have been referenced.
  • This change includes docs.

@openshift-ci openshift-ci bot requested review from bentito and enxebre October 24, 2025 10:41
@stbenjam
Copy link
Member

Testing the linter

@stbenjam stbenjam closed this Oct 27, 2025
@stbenjam stbenjam reopened this Oct 27, 2025
@jianzhangbjz
Copy link
Contributor Author

Hi @stbenjam , seems like it's pending for testing, anything else I need to do? Thanks!

@stbenjam
Copy link
Member

/test images

@stbenjam
Copy link
Member

/lgtm

@openshift-ci openshift-ci bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 29, 2025
stbenjam
stbenjam reviewed Oct 29, 2025
View reviewed changes
.claude-plugin/marketplace.json
{
"name": "olm",
"source": "./plugins/olm",
"description": "OLM (Operator Lifecycle Manager) debugging and analysis tools"
Copy link
Member

Choose a reason for hiding this comment

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

Should this highlight the version being used, in light of #76?

Copy link
Member

Choose a reason for hiding this comment

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

And is there a way to combine them in the same plugin and let claude detect what's available instead of having the user have to know?

Copy link

Choose a reason for hiding this comment

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

Since both are available on-cluster from OCP4.18+ and we intend for them to co-exist for some time, it's going to be increasingly important to avoid a default and explicitly require a user to select which stack they want to interact with, via a flag, parameter, or saved state.

@stbenjam
Copy link
Member

/lgtm cancel

A question now that there's 2 proposed OLM plugins for different versions

@openshift-ci openshift-ci bot removed lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Oct 29, 2025
@stbenjam stbenjam mentioned this pull request Oct 29, 2025
Open
@grokspawn grokspawn mentioned this pull request Oct 29, 2025
Draft
5 tasks
@stbenjam
Copy link
Member

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 29, 2025
@openshift-ci
Copy link

openshift-ci bot commented Oct 29, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jianzhangbjz, stbenjam

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

The pull request process is described 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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 29, 2025
@stbenjam
Copy link
Member

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 29, 2025
@stbenjam stbenjam closed this Oct 29, 2025
@stbenjam stbenjam reopened this Oct 29, 2025
@stbenjam
Copy link
Member

Hm, I am not sure why Lint isn't complaining about the missing readme update... :-\

/hold cancel

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 29, 2025
@stbenjam
Copy link
Member

Ah there we go, github was just slow. make update needs to be run now to get the README updated

@openshift-merge-bot openshift-merge-bot bot merged commit 454f1e0 into openshift-eng:main Oct 29, 2025
4 of 5 checks passed
@stbenjam stbenjam mentioned this pull request Oct 29, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stbenjam stbenjam stbenjam left review comments

@bentito bentito Awaiting requested review from bentito

@enxebre enxebre Awaiting requested review from enxebre

+1 more reviewer

@grokspawn grokspawn grokspawn left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@stbenjam stbenjam

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.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jianzhangbjz @stbenjam @grokspawn