Skip to content

NO-JIRA: how-to: troubleshoot bootstrap CVO#1369

Open
hongkailiu wants to merge 1 commit intoopenshift:mainfrom
hongkailiu:bootstrap-cvo
Open

NO-JIRA: how-to: troubleshoot bootstrap CVO#1369
hongkailiu wants to merge 1 commit intoopenshift:mainfrom
hongkailiu:bootstrap-cvo

Conversation

@hongkailiu
Copy link
Copy Markdown
Member

@hongkailiu hongkailiu commented Apr 8, 2026

Summary by CodeRabbit

  • Documentation
    • Added a troubleshooting guide for Cluster Version Operator issues when the operator runs on the bootstrap node.
    • Provides a step-by-step workflow for inspecting installer logs and diagnostic bundles to pinpoint deployment failures.
    • Includes example artifact locations and sample listings to help locate relevant logs and collected diagnostics for effective debugging.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Apr 8, 2026
@openshift-ci-robot
Copy link
Copy Markdown
Contributor

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

Details

In response to this:

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
Copy Markdown

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: bd17f6ec-d2da-45fc-9b98-0bc22dae8a42

📥 Commits

Reviewing files that changed from the base of the PR and between 1098bbc and 6223dac.

📒 Files selected for processing (2)
  • docs/dev/README.md
  • docs/dev/troubleshoot-bootstrap-cvo.md
✅ Files skipped from review due to trivial changes (2)
  • docs/dev/README.md
  • docs/dev/troubleshoot-bootstrap-cvo.md

Walkthrough

Adds a new troubleshooting guide for the Cluster Version Operator (CVO) running on the OpenShift bootstrap node and updates the dev README to link to that guide.

Changes

Cohort / File(s) Summary
Documentation
docs/dev/README.md, docs/dev/troubleshoot-bootstrap-cvo.md
Added troubleshoot-bootstrap-cvo.md describing how to locate bootstrap CVO pod manifests, contrast with post-install CVO deployment manifests, and a troubleshooting workflow focused on installer logs and generated log bundles; updated README to link the new guide.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 8, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hongkailiu

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 Apr 8, 2026
Copy link
Copy Markdown

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

🧹 Nitpick comments (1)
docs/dev/troubleshoot-bootstrap-cvo.md (1)

3-7: Clarify wording and avoid implying fixed artifact filenames.

Line 3 and Line 5 are hard to parse, and Line 6 can read as if those exact filenames must exist. Prefer concise phrasing and wildcard patterns.

Proposed edit
-In the OpenShift installation process, a CVO pod runs on the [bootstrap node](https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/installation_overview/ocp-installation-overview#installation-process-details). The pod's manifest is defined in [bootstrap-pod.yaml](../../bootstrap/bootstrap-pod.yaml) which is slightly differently from the one created for the [CVO deployment](../../install/0000_00_cluster-version-operator_30_deployment.yaml) running on a control plane after installation.
+During OpenShift installation, a CVO pod runs on the [bootstrap node](https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/installation_overview/ocp-installation-overview#installation-process-details). Its manifest is defined in [bootstrap-pod.yaml](../../bootstrap/bootstrap-pod.yaml), which differs slightly from the [post-install CVO deployment manifest](../../install/0000_00_cluster-version-operator_30_deployment.yaml) used on control-plane nodes.
 
-To troubleshoot issues from the CVO pod on the bootstrap node, it is useful digging into the installer log and log-bundle. See [OpenShift documentation](https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/validation_and_troubleshooting/installing-troubleshooting) for details about how they are collected.
-In CI jobs, they are usually collected by a step during installation, such as [ipi-install-install](https://steps.ci.openshift.org/reference/ipi-install-install). See `.openshift_install-1775655648.log` and `log-bundle-20260408134042.tar` in the following files: 
+To troubleshoot bootstrap-node CVO issues, inspect the installer log and log bundle. See the [OpenShift troubleshooting docs](https://docs.redhat.com/en/documentation/openshift_container_platform/4.21/html/validation_and_troubleshooting/installing-troubleshooting) for collection details.
+In CI jobs, these artifacts are usually collected by an installation step such as [ipi-install-install](https://steps.ci.openshift.org/reference/ipi-install-install). For example, look for files matching `.openshift_install-*.log` and `log-bundle-*.tar`:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/dev/troubleshoot-bootstrap-cvo.md` around lines 3 - 7, Rewrite the
paragraph to clarify wording and avoid implying specific artifact filenames:
rephrase the sentence referencing bootstrap-pod.yaml and the CVO deployment
manifest to be more concise and parallel (mention bootstrap-pod.yaml vs
0000_00_cluster-version-operator_30_deployment.yaml), change the sentence about
CI job collection (referencing ipi-install-install) to state that logs are
typically collected by a CI install step, and replace the exact filenames
(.openshift_install-1775655648.log and log-bundle-20260408134042.tar) with
example wildcard patterns such as .openshift_install-*.log and log-bundle-*.tar
to make it clear these are examples rather than required fixed names.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/dev/troubleshoot-bootstrap-cvo.md`:
- Around line 3-7: Rewrite the paragraph to clarify wording and avoid implying
specific artifact filenames: rephrase the sentence referencing
bootstrap-pod.yaml and the CVO deployment manifest to be more concise and
parallel (mention bootstrap-pod.yaml vs
0000_00_cluster-version-operator_30_deployment.yaml), change the sentence about
CI job collection (referencing ipi-install-install) to state that logs are
typically collected by a CI install step, and replace the exact filenames
(.openshift_install-1775655648.log and log-bundle-20260408134042.tar) with
example wildcard patterns such as .openshift_install-*.log and log-bundle-*.tar
to make it clear these are examples rather than required fixed names.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: e8924d81-2b18-4bf9-855c-b2c0f930d33b

📥 Commits

Reviewing files that changed from the base of the PR and between 26e3765 and 1098bbc.

📒 Files selected for processing (2)
  • docs/dev/README.md
  • docs/dev/troubleshoot-bootstrap-cvo.md

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 8, 2026

@hongkailiu: 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

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants