Skip to content
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.

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

DOC-470 Debug bundle in Redpanda Console #825

Merged
merged 33 commits into from
Nov 12, 2024
Merged

DOC-470 Debug bundle in Redpanda Console #825

merged 33 commits into from
Nov 12, 2024

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Oct 25, 2024

Description

This PR adds docs for the new feature to generate debug bundles in Redpanda Console. Additionally, it introduces a unified 'Troubleshoot' section that centralizes content on cluster diagnostics, error resolution, and debug bundle generation across environments.

Previously, the Cluster Diagnostics documentation covered self-tests but lacked information on Kubernetes. Similarly, only the Troubleshooting document for Kubernetes included error resolution content. This update consolidates all troubleshooting content (in troubleshoot/partials) to ensure both Linux and Kubernetes users have consistent access to diagnostics and error resolution guidance.

This single-source approach simplifies maintenance and provides users with cohesive troubleshooting instructions regardless of environment.

Fixes:

Relies on redpanda-data/seastar#152 and an RC4 release to work in Docker Desktop

Review deadline: 5 November

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@JakeSCahill JakeSCahill requested a review from a team as a code owner October 25, 2024 15:19
@JakeSCahill JakeSCahill changed the base branch from main to v-WIP/24.3 October 25, 2024 15:20
Copy link

netlify bot commented Oct 25, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit fbc89a2
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67331c5772c0f0000877fcc8
😎 Deploy Preview https://deploy-preview-825--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JakeSCahill JakeSCahill marked this pull request as draft October 25, 2024 15:25
@JakeSCahill JakeSCahill changed the title Doc 470 Doc 470 Debug bundle in Redpanda Console Oct 25, 2024
@JakeSCahill JakeSCahill marked this pull request as ready for review November 1, 2024 10:01
Copy link
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

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

Just a few suggestions, I don't think there are any blockers.

Also, not sure if you meant to include all the test files and artifacts in this PR, so I ignored them. (I'm also not sure if the test stuff should have gone in a PR by itself?)

modules/console/pages/ui/generate-bundle.adoc Outdated Show resolved Hide resolved
modules/troubleshoot/partials/cluster-diagnostics.adoc Outdated Show resolved Hide resolved
modules/troubleshoot/partials/cluster-diagnostics.adoc Outdated Show resolved Hide resolved
modules/troubleshoot/partials/cluster-diagnostics.adoc Outdated Show resolved Hide resolved
modules/troubleshoot/partials/errors-and-solutions.adoc Outdated Show resolved Hide resolved
modules/troubleshoot/partials/errors-and-solutions.adoc Outdated Show resolved Hide resolved
modules/troubleshoot/partials/errors-and-solutions.adoc Outdated Show resolved Hide resolved
@JakeSCahill
Copy link
Contributor Author

JakeSCahill commented Nov 6, 2024

Tests were failing because we were waiting for a beta build of Console.

@JakeSCahill JakeSCahill changed the title Doc 470 Debug bundle in Redpanda Console DOC-470 Debug bundle in Redpanda Console Nov 9, 2024
@JakeSCahill JakeSCahill merged commit 67c90f5 into v-WIP/24.3 Nov 12, 2024
7 checks passed
@JakeSCahill JakeSCahill deleted the DOC-470 branch November 12, 2024 09:25
kbatuigas added a commit that referenced this pull request Nov 13, 2024
Deflaimun pushed a commit that referenced this pull request Nov 19, 2024
Deflaimun pushed a commit that referenced this pull request Nov 19, 2024
Deflaimun pushed a commit that referenced this pull request Nov 19, 2024
Deflaimun pushed a commit that referenced this pull request Nov 21, 2024
Deflaimun added a commit that referenced this pull request Nov 21, 2024
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.

3 participants