DOC-470 Debug bundle in Redpanda Console

.github/workflows/test-docs.yml

@@ -36,6 +36,11 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           path: redpanda-docs
+      # Run tests on beta if the PR is targeting a branch that starts with 'v-WIP'
+      - name: Test WIP Branch Docs
+        if: startsWith(github.head_ref, 'v-WIP')
+        run: |
+          echo "BETA='true'" >> $GITHUB_ENV
       - name: Test docs
         if: ${{ github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch' }}
         uses: doc-detective/github-action@v1

antora.yml

@@ -18,10 +18,13 @@ asciidoc:
     # We try to fetch the latest from GitHub at build time
     # --
     full-version: 24.3.1
+    latest-redpanda-tag: 'v24.3.1'
+    latest-console-tag: 'v2.7.2'
     latest-release-commit: '72ba3d3'
     latest-operator-version: 'v2.2.0-24.2.2'
     latest-redpanda-helm-chart-version: 5.8.3
-    redpanda-beta-version: 24.3.1-rc1
+    redpanda-beta-version: '24.3.1-rc1'
+    redpanda-beta-tag: 'v24.3.1-rc1'
     # --
     supported-kubernetes-version: 1.21
     supported-helm-version: 3.10.0

modules/ROOT/nav.adoc

@@ -3,13 +3,17 @@
 ** xref:get-started:whats-new.adoc[]
 ** xref:get-started:intro-to-events.adoc[Introduction to Redpanda]
 ** xref:get-started:architecture.adoc[How Redpanda Works]
+** xref:console:index.adoc[Introduction to Redpanda Console]
 ** xref:get-started:install-beta.adoc[Install Beta]
-** xref:get-started:quick-start.adoc[Quickstart]
+** xref:get-started:quickstarts.adoc[Quickstarts]
+*** xref:get-started:quick-start.adoc[Redpanda Self-Managed]
+*** xref:console:quickstart.adoc[Redpanda Console]
 ** xref:get-started:licensing/index.adoc[Redpanda Licensing]
 *** xref:get-started:licensing/overview.adoc[Editions and Enterprise Features]
 *** xref:get-started:licensing/add-license-redpanda/index.adoc[Add an Enterprise License]
 **** xref:get-started:licensing/add-license-redpanda/linux.adoc[Linux]
 **** xref:get-started:licensing/add-license-redpanda/kubernetes.adoc[Kubernetes]
+**** xref:console:ui/add-license.adoc[Redpanda Console]
 *** xref:get-started:licensing/monitor-license-status.adoc[Monitor Enterprise Licenses]
 ** xref:get-started:rpk/index.adoc[Redpanda CLI]
 *** xref:get-started:intro-to-rpk.adoc[Introduction to rpk]
@@ -40,6 +44,7 @@
 *** xref:develop:data-transforms/deploy.adoc[Deploy]
 *** xref:develop:data-transforms/test.adoc[Test]
 *** xref:develop:data-transforms/monitor.adoc[Monitor]
+*** xref:console:ui/data-transforms.adoc[Manage in Redpanda Console]
 *** xref:develop:data-transforms/upgrade.adoc[Upgrade]
 *** xref:develop:data-transforms/versioning-compatibility.adoc[Versioning and Compatibility]
 *** xref:develop:data-transforms/labs.adoc[Examples]
@@ -129,9 +134,6 @@
 **** xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[Connectors]
 *** xref:manage:kubernetes/k-rolling-restart.adoc[Rolling Restart]
 *** xref:manage:kubernetes/k-resilience-testing.adoc[Resilience Testing]
-*** xref:manage:kubernetes/troubleshooting/index.adoc[Troubleshooting]
-**** xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[]
-**** xref:manage:kubernetes/troubleshooting/k-diagnostics-bundle.adoc[Diagnostics Bundle]
 ** xref:manage:cluster-maintenance/index.adoc[Cluster Maintenance]
 *** xref:manage:cluster-maintenance/cluster-property-configuration.adoc[]
 *** xref:manage:cluster-maintenance/node-property-configuration.adoc[]
@@ -146,7 +148,6 @@
 *** xref:manage:cluster-maintenance/manage-throughput.adoc[Manage Throughput]
 *** xref:manage:cluster-maintenance/compaction-settings.adoc[Compaction Settings]
 *** xref:manage:cluster-maintenance/configure-availability.adoc[Configure Availability]
-*** xref:manage:cluster-maintenance/cluster-diagnostics.adoc[Cluster Diagnostics]
 *** xref:manage:cluster-maintenance/partition-recovery.adoc[Forced Partition Recovery]
 *** xref:manage:cluster-maintenance/nodewise-partition-recovery.adoc[Node-wise Partition Recovery]
 ** xref:manage:security/index.adoc[Security]
@@ -169,9 +170,8 @@
 *** xref:manage:schema-reg/schema-reg-overview.adoc[]
 *** xref:manage:schema-reg/schema-reg-api.adoc[]
 *** xref:manage:schema-reg/schema-id-validation.adoc[]
+*** xref:console:ui/schema-reg.adoc[Manage in Redpanda Console]
 ** xref:manage:console/index.adoc[Redpanda Console]
-*** xref:console:index.adoc[Overview]
-*** xref:console:quickstart.adoc[Quickstart]
 *** xref:console:config/index.adoc[Configuration]
 **** xref:console:config/configure-console.adoc[Configure Console]
 **** xref:console:config/enterprise-license.adoc[Add an Enterprise License]
@@ -191,9 +191,6 @@
 **** xref:console:config/deserialization.adoc[Deserialization]
 **** xref:console:config/kafka-connect.adoc[Kafka Connect]
 **** xref:console:config/topic-documentation.adoc[Topic Documentation]
-*** xref:console:ui/add-license.adoc[Add an Enterprise License]
-*** xref:console:ui/schema-reg.adoc[Schema Registry]
-*** xref:console:ui/data-transforms.adoc[Data Transforms]
 *** xref:console:ui/programmable-push-filters.adoc[Filter Messages]
 *** xref:console:ui/record-deserialization.adoc[Deserialize Messages]
 *** xref:console:ui/edit-topic-configuration.adoc[Edit Topic Configuration]
@@ -204,6 +201,17 @@
 ** xref:manage:monitoring.adoc[]
 ** xref:manage:io-optimization.adoc[]
 ** xref:manage:raft-group-reconfiguration.adoc[Raft Group Reconfiguration]
+* xref:troubleshoot:index.adoc[Troubleshoot]
+** xref:troubleshoot:cluster-diagnostics/index.adoc[Cluster Diagnostics]
+*** xref:troubleshoot:cluster-diagnostics/diagnose-issues.adoc[Linux]
+*** xref:troubleshoot:cluster-diagnostics/k-diagnose-issues.adoc[Kubernetes]
+** xref:troubleshoot:debug-bundle/index.adoc[Generate Debug Bundle]
+*** xref:troubleshoot:debug-bundle/generate-debug-bundle.adoc[Linux]
+*** xref:troubleshoot:debug-bundle/k-generate-debug-bundle.adoc[Kubernetes]
+*** xref:console:ui/generate-bundle.adoc[Redpanda Console]
+** xref:troubleshoot:errors-solutions/index.adoc[Resolve Errors]
+*** xref:troubleshoot:errors-solutions/resolve-errors.adoc[Linux]
+*** xref:troubleshoot:errors-solutions/k-resolve-errors.adoc[Kubernetes]
 * xref:reference:index.adoc[Reference]
 ** xref:reference:properties/index.adoc[]
 *** xref:reference:properties/broker-properties.adoc[]

modules/console/pages/config/connect-to-redpanda.adoc

@@ -66,7 +66,7 @@ kafka:
 [[admin]]
 == Configure access to the Redpanda Admin API
 
-Configuring a connection to the Redpanda Admin API enables additional Redpanda-specific features in Redpanda Console, such as viewing the Redpanda version, managing data transforms, and SASL-SCRAM users.
+Configuring a connection to the Redpanda Admin API enables additional Redpanda-specific features in Redpanda Console, such as viewing the Redpanda version, managing data transforms and SASL-SCRAM users, and generating debug bundles.
 
 [,yaml]
 ----
@@ -85,6 +85,8 @@ redpanda:
       # insecureSkipTlsVerify: false
 ----
 
+NOTE: Make sure to include the URLs of _all_ brokers in the `redpanda.adminApi.urls` array.
+
 == Suggested reading
 
 - xref:console:config/deserialization.adoc[]

modules/console/pages/config/security/authorization.adoc

@@ -47,6 +47,9 @@ It does not include permission to create/remove ACLs or to create or remove a se
 
 The `admin` role grants all permissions that come with the `editor` role and additionally includes:
 
+* Access to the *Admin* page that includes:
+** Details about all users and ACLs
+** The ability to xref:console:ui/generate-bundle.adoc[generate debug bundles]
 * Managing all service account aspects (create/remove service accounts)
 * Managing all ACL aspects (create/remove ACLs)
 

modules/console/pages/index.adoc

@@ -1,4 +1,4 @@
-= Overview of Redpanda Console
+= Introduction to Redpanda Console
 :description: Learn about Redpanda Console: a web interface for managing and interacting with Redpanda clusters.
 :page-aliases: console:index/index.adoc, console:features/index.adoc, reference:console/index.adoc
 

modules/console/pages/quickstart.adoc

@@ -77,7 +77,7 @@ include::console:attachment$transactions-schema.json[]
 ```bash
 docker compose up -d --wait
 ```
-// (step {"action":"runShell", "command": "docker pull docker.redpanda.com/redpandadata/redpanda:v${REDPANDA_VERSION:?Set a Redpanda version} && docker pull docker.redpanda.com/redpandadata/console:v${REDPANDA_CONSOLE_VERSION:?Set a Redpanda Console version} && docker pull docker.redpanda.com/redpandadata/connect:latest", "workingDirectory": "../test-resources", "timeout": 100000, "exitCodes": [0,1]})
+// (step {"action":"runShell", "command": "docker pull docker.redpanda.com/redpandadata/${REDPANDA_DOCKER_REPO:-redpanda}:${REDPANDA_VERSION:-latest} && docker pull docker.redpanda.com/redpandadata/${CONSOLE_DOCKER_REPO:-console}:${REDPANDA_CONSOLE_VERSION:-latest} && docker pull docker.redpanda.com/redpandadata/connect:latest", "workingDirectory": "../test-resources", "timeout": 100000, "exitCodes": [0,1]})
 // (step {"action":"runShell", "command": "docker compose up -d --wait", "workingDirectory": "../test-resources", "timeout": 50000, "exitCodes": [0,1]})
 // (step {"action":"wait", "duration": 10000})
 +

modules/console/pages/ui/add-license.adoc

@@ -13,17 +13,9 @@ If Redpanda Console has enterprise features enabled and it cannot find a valid l
 
 TIP: You can also xref:console:config/enterprise-license.adoc[configure Redpanda Console to load the license key from its local configuration].
 
-== Check the license status in Redpanda Console
-
-You can check the expiration date of a license on the **Cluster Overview** page in Redpanda Console, under the **Licensing** section.
-
-If the license is due to expire within 30 days, a warning banner is displayed on all pages of Redpanda Console.
-
-See also: xref:get-started:licensing/monitor-license-status.adoc[].
-
-== Upload a new license
+== Upload a license
 
-When a new license is uploaded through Redpanda Console, it is replicated across the cluster and stored persistently in Redpanda's internal metadata, ensuring it is retained across restarts.
+When a license is uploaded through Redpanda Console, it is replicated across the cluster and stored persistently in Redpanda's internal metadata, ensuring it is retained across restarts.
 
 [CAUTION]
 ====
@@ -51,6 +43,14 @@ When a new license is uploaded, enterprise features in Redpanda Self-Managed are
 
 After restarting Redpanda Console, enterprise features such as RBAC are unlocked. However, to enable and use these features, you must configure them. See xref:console:config/index.adoc[].
 
+== Check the license status in Redpanda Console
+
+You can check the expiration date of a license on the **Cluster Overview** page in Redpanda Console, under the **Licensing** section.
+
+If the license is due to expire within 30 days, a warning banner is displayed on all pages of Redpanda Console.
+
+See also: xref:get-started:licensing/monitor-license-status.adoc[].
+
 == Next steps
 
 xref:get-started:licensing/monitor-license-status.adoc[].

modules/console/pages/ui/generate-bundle.adoc

@@ -0,0 +1,45 @@
+= Manage Debug Bundles in Redpanda Console
+:description: Learn how to generate, download, and delete debug bundles in Redpanda Console for comprehensive cluster diagnostics.
+
+{description}
+
+== Prerequisites
+
+- You must have an Enterprise Edition license. https://www.redpanda.com/contact[Request a license^] if you don't have one already.
++
+If Redpanda Console has enterprise features enabled and it cannot find a valid license either locally or in the connected Redpanda cluster, it shuts down.
+- Redpanda Console must be xref:console:config/connect-to-redpanda.adoc[connected to a Redpanda cluster] and xref:console:config/connect-to-redpanda.adoc#admin[configured to connect to the Redpanda Admin API].
+- Redpanda Console must be xref:console:config/security/authentication.adoc[configured with an authentication provider] and have at least one admin user.
+
+== Generate a debug bundle
+
+You can generate a debug bundle for all brokers in the cluster using Redpanda Console. After generating the bundle, download it onto your local computer for inspection.
+
+. Log in as an admin user.
+. Click *Admin* in the sidebar.
++
+This option is visible only when you are logged in as an admin user.
+. Go to *Debug bundle*.
+. Click *Generate new*.
+. Wait until the process is complete.
+. Click *debug-bundle.zip* to download the bundle on your local computer.
+. Unzip the file to inspect the contents.
+
+include::troubleshoot:partial$debug-bundle.adoc[tags=inspect]
+
+== Delete a debug bundle
+
+To generate a new debug bundle, you must delete the existing one.
+
+. Log in as an admin user.
+. Click *Admin* in the sidebar.
++
+This option is visible only when you are logged in as an admin user.
+. Go to *Debug bundle*.
+. Click the trash icon next to *debug-bundle.zip* to delete the bundle.
+
+== Next steps
+
+- xref:troubleshoot:cluster-diagnostics/index.adoc[]
+- xref:troubleshoot:errors-solutions/index.adoc[]
+

modules/console/test-resources/docker-compose.yml

@@ -33,7 +33,7 @@ services:
       # Tells Seastar (the framework Redpanda uses under the hood) to use 1 core on the system.
       - --smp 1
       - --default-log-level=info
-    image: docker.redpanda.com/redpandadata/redpanda:v${REDPANDA_VERSION:?Set a Redpanda version}
+    image: docker.redpanda.com/redpandadata/${REDPANDA_DOCKER_REPO:-redpanda}:${REDPANDA_VERSION:-latest}
     container_name: redpanda-0
     # Sets the username and password of the SCRAM superuser
     environment:
@@ -68,7 +68,7 @@ services:
       - --smp 1
       - --default-log-level=info
       - --seeds redpanda-0:33145
-    image: docker.redpanda.com/redpandadata/redpanda:v${REDPANDA_VERSION:?Set a Redpanda version}
+    image: docker.redpanda.com/redpandadata/${REDPANDA_DOCKER_REPO:-redpanda}:${REDPANDA_VERSION:-latest}
     container_name: redpanda-1
     environment:
       RP_BOOTSTRAP_USER: "superuser:secretpassword"
@@ -99,7 +99,7 @@ services:
       - --smp 1
       - --default-log-level=info
       - --seeds redpanda-0:33145
-    image: docker.redpanda.com/redpandadata/redpanda:v${REDPANDA_VERSION:?Set a Redpanda version}
+    image: docker.redpanda.com/redpandadata/${REDPANDA_DOCKER_REPO:-redpanda}:${REDPANDA_VERSION:?Set a Redpanda version}
     container_name: redpanda-2
     environment:
       RP_BOOTSTRAP_USER: "superuser:secretpassword"
@@ -120,7 +120,7 @@ services:
   ####################
   console:
     container_name: redpanda-console
-    image: docker.redpanda.com/redpandadata/console:v${REDPANDA_CONSOLE_VERSION:?Set a Redpanda Console version}
+    image: docker.redpanda.com/redpandadata/${CONSOLE_DOCKER_REPO:-console}:${REDPANDA_CONSOLE_VERSION:-latest}
     networks:
       - redpanda_network
     entrypoint: /bin/sh
@@ -235,7 +235,7 @@ services:
       - -X user=superuser
       - -X pass=secretpassword
       - -X registry.hosts=redpanda-0:8081
-    image: docker.redpanda.com/redpandadata/redpanda:v${REDPANDA_VERSION:?Set a Redpanda version}
+    image: docker.redpanda.com/redpandadata/${REDPANDA_DOCKER_REPO:-redpanda}:${REDPANDA_VERSION:-latest}
     # mount the local directory that contains your schema to the container.
     volumes:
       - ./transactions-schema.json:/etc/redpanda/transactions-schema.json

modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc

@@ -453,7 +453,7 @@ If you're using a private repository, always ensure your nodes have the necessar
 ----
 image:
   repository: docker.redpanda.com/redpandadata/redpanda
-  tag: "v{full-version}"
+  tag: "{latest-redpanda-tag}"
 imagePullSecrets: []
 ----
 

modules/deploy/partials/kubernetes/guides/troubleshoot.adoc

@@ -2,6 +2,6 @@
 
 Before troubleshooting your cluster, make sure that you have all the <<prerequisites,prerequisites>>.
 
-include::manage:kubernetes/troubleshooting/k-troubleshoot.adoc[tags=deployment,leveloffset=-1]
+include::troubleshoot:partial$errors-and-solutions.adoc[tags=deployment,leveloffset=-1]
 
 For more troubleshooting steps, see xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[Troubleshoot Redpanda in Kubernetes].

modules/get-started/attachments/single-broker

@@ -0,0 +1 @@
+../test-resources/single-broker

modules/get-started/attachments/three-brokers

@@ -0,0 +1 @@
+../test-resources/three-brokers

modules/get-started/pages/install-beta.adoc

@@ -2,7 +2,7 @@
 :description: Learn how to install the beta version.
 :publish-only-during-beta: true
 
-Redpanda beta versions provide users the opportunity to test and share feedback on new features before they're finalized in general availability. Beta versions, like `v{redpanda-beta-version}`, are published to `redpanda-unstable` as release candidate (RC) builds. RC builds are not recommended for production use.
+Redpanda beta versions provide users the opportunity to test and share feedback on new features before they're finalized in general availability. Beta versions, like `{redpanda-beta-tag}`, are published to `redpanda-unstable` as release candidate (RC) builds. RC builds are not recommended for production use.
 
 To install the beta version, select your environment.
 
@@ -16,7 +16,7 @@ Docker::
 +
 [source,bash,subs="attributes+"]
 ----
-docker pull docker.redpanda.com/redpandadata/redpanda-unstable:v{redpanda-beta-version}
+docker pull docker.redpanda.com/redpandadata/redpanda-unstable:{redpanda-beta-tag}
 ----
 
 . Create a Docker Compose file with the beta version:
@@ -59,7 +59,7 @@ services:
       - --mode dev-container
       # enable logs for debugging.
       - --default-log-level=debug
-    image: docker.redpanda.com/redpandadata/redpanda-unstable:v{redpanda-beta-version}
+    image: docker.redpanda.com/redpandadata/redpanda-unstable:{redpanda-beta-tag}
     container_name: redpanda-0
     volumes:
       - redpanda-0:/var/lib/redpanda/data
@@ -72,7 +72,7 @@ services:
       - 19644:9644
   console:
     container_name: redpanda-console
-    image: docker.redpanda.com/redpandadata/console:v{latest-console-version}
+    image: docker.redpanda.com/redpandadata/console:{latest-console-tag}
     networks:
       - redpanda_network
     entrypoint: /bin/sh
@@ -158,7 +158,7 @@ Install Redpanda with Helm from the RC build in https://hub.docker.com/r/redpand
 helm repo add redpanda https://charts.redpanda.com
 helm install redpanda redpanda/redpanda \
   --namespace <namespace> \
-  --create-namespace --set image.repository=docker.redpanda.com/redpandadata/redpanda-unstable --set image.tag=v{redpanda-beta-version}
+  --create-namespace --set image.repository=docker.redpanda.com/redpandadata/redpanda-unstable --set image.tag={redpanda-beta-tag}
 ----
 
 --