DOC-546 Document the new useFlux flag

.github/workflows/test-docs.yml

@@ -11,6 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       console: ${{ steps.filter.outputs.console }}
+      quickstart: ${{ steps.filter.outputs.quickstart }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -21,22 +22,39 @@ jobs:
           filters: |
             console:
               - 'modules/console/**'
+            quickstart:
+              - 'modules/get-started/pages/quick-start.adoc'
   run-tests:
     needs: setup
     permissions:
       contents: write
       pull-requests: write
       issues: write
+      id-token: write
     strategy:
       matrix:
         os: [ubuntu-latest]  # Only using Linux for now since macOS takes a long time
     runs-on: ${{ matrix.os }}
     steps:
+      - uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-region: ${{ vars.RP_AWS_CRED_REGION }}
+          role-to-assume: arn:aws:iam::${{ secrets.RP_AWS_CRED_ACCOUNT_ID }}:role/${{ vars.RP_AWS_CRED_BASE_ROLE_NAME }}${{ github.event.repository.name }}
+      - uses: aws-actions/aws-secretsmanager-get-secrets@v2
+        with:
+          secret-ids: |
+            ,sdlc/prod/github/actions_bot_token
+          parse-json-secrets: true
       - uses: actions/checkout@v4
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ env.ACTIONS_BOT_TOKEN }}
           path: redpanda-docs
-      - name: Test docs
+
+      - name: Set GitHub token
+        run: |
+          echo "REDPANDA_GITHUB_TOKEN=${{ env.ACTIONS_BOT_TOKEN }}" >> $GITHUB_ENV
+
+      - name: Run all tests
         if: ${{ github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch' }}
         uses: doc-detective/github-action@v1
         with:
@@ -46,11 +64,32 @@ jobs:
           # create a PR/issue only if the workflow wasn't already triggered by a PR
           create_pr_on_change: true
           create_issue_on_fail: true
+          token: ${{ env.ACTIONS_BOT_TOKEN }}
 
-      - name: Test Console docs
+      - name: Test Redpanda Console docs
         if: needs.setup.outputs.console == 'true'
         uses: doc-detective/github-action@v1
         with:
           input: ../modules/console
           working_directory: redpanda-docs/setup-tests
           exit_on_fail: true
+        env:
+          REDPANDA_GITHUB_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}
+
+      - name: Test Redpanda Self-Managed quickstart
+        if: needs.setup.outputs.quickstart == 'true'
+        uses: doc-detective/github-action@v1
+        with:
+          input: ../modules/get-started/pages/quick-start.adoc
+          working_directory: redpanda-docs/setup-tests
+          exit_on_fail: true
+        env:
+          REDPANDA_GITHUB_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}
+      - name: Upload debug artifacts
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: doc-detective-output
+          path: /home/runner/work/_temp/doc-detective-output.json
+        env:
+          REDPANDA_GITHUB_TOKEN: ${{ env.ACTIONS_BOT_TOKEN }}

antora.yml

@@ -1,6 +1,8 @@
 name: ROOT
 title: Self-Managed
-version: 24.2
+version: 24.3
+display_version: '24.3 Beta'
+prerelease: true
 start_page: home:index.adoc
 nav:
 - modules/ROOT/nav.adoc
@@ -15,11 +17,16 @@ asciidoc:
     # Fallback versions
     # We try to fetch the latest from GitHub at build time
     # --
-    full-version: 24.2.2
+    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.2.2-rc5
+    redpanda-beta-version: '24.3.1-rc2'
+    redpanda-beta-tag: 'v24.3.1-rc2'
+    console-beta-version: '2.8.0-beta.1'
+    console-beta-tag: 'v2.8.0-beta.1'
     # --
     supported-kubernetes-version: 1.21
     supported-helm-version: 3.10.0

local-antora-playbook.yml

@@ -15,7 +15,7 @@ content:
   - url: .
     branches: HEAD
   - url: https://github.com/redpanda-data/docs
-    branches: [v/*, api, shared, site-search,'!v-end-of-life/*']
+    branches: [main,v/*, api, shared, site-search,'!v-end-of-life/*']
   - url: https://github.com/redpanda-data/cloud-docs
     branches: main
   - url: https://github.com/redpanda-data/redpanda-labs

modules/ROOT/nav.adoc

@@ -3,9 +3,18 @@
 ** 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:licenses.adoc[Redpanda Licensing]
+** 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]
 *** xref:get-started:rpk-install.adoc[]
@@ -21,6 +30,7 @@
 ** xref:develop:produce-data/index.adoc[Produce Data]
 *** xref:develop:produce-data/configure-producers.adoc[]
 *** xref:develop:produce-data/idempotent-producers.adoc[Idempotent Producers]
+*** xref:develop:produce-data/leader-pinning.adoc[]
 ** xref:develop:consume-data/index.adoc[Consume Data]
 *** xref:develop:consume-data/consumer-offsets.adoc[Consumer Offsets]
 *** xref:develop:consume-data/follower-fetching.adoc[Follower Fetching]
@@ -34,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]
@@ -123,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[]
@@ -140,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]
@@ -155,18 +162,19 @@
 ** xref:manage:tiered-storage-linux/index.adoc[Tiered Storage]
 *** xref:manage:tiered-storage.adoc[]
 *** xref:manage:fast-commission-decommission.adoc[]
+*** xref:manage:mountable-topics.adoc[]
 *** xref:manage:remote-read-replicas.adoc[Remote Read Replicas]
 *** xref:manage:topic-recovery.adoc[Topic Recovery]
 *** xref:manage:whole-cluster-restore.adoc[Whole Cluster Restore]
 ** xref:manage:schema-reg/index.adoc[Schema Registry]
 *** 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]
 **** xref:console:config/connect-to-redpanda.adoc[Connect to Redpanda]
 **** xref:console:config/security/index.adoc[Security]
 ***** xref:console:config/security/authentication.adoc[Authentication]
@@ -183,8 +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/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]
@@ -195,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[]
@@ -271,9 +288,16 @@
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-status.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc[]
 **** xref:reference:rpk/rpk-cluster/rpk-cluster-storage.adoc[]
+***** rpk cluster storage mount/unmount
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-mount.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore.adoc[]
-****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc[]
-****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-status.adoc[]
+***** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc[]
+***** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-status.adoc[]
 **** xref:reference:rpk/rpk-cluster/rpk-cluster-txn.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-describe.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc[]

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

@@ -63,9 +63,10 @@ kafka:
       enableFast: true
 ----
 
+[[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]
 ----
@@ -84,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/enterprise-license.adoc

@@ -0,0 +1,72 @@
+= Add a License Key to Redpanda Console
+:description: Learn how to apply or update a license key to Redpanda Console.
+
+To enable xref:get-started:licensing/overview.adoc#console[enterprise features for Redpanda Console], you must have an Enterprise Edition license to load at startup. This guide explains how to configure Redpanda Console to load the license key from its local configuration.
+
+TIP: Redpanda Console can also load the license key from a connected Redpanda cluster. To add a license key to Redpanda, see xref:get-started:licensing/add-license-redpanda/index.adoc[].
+
+== Prerequisites
+
+You must have an Enterprise Edition license. If you don't have a license yet, https://www.redpanda.com/contact[request one^].
+
+If Redpanda Console has enterprise features enabled and cannot find a valid license locally or in the connected Redpanda cluster, it shuts down. See xref:get-started:licensing/overview.adoc[].
+
+== Add a new license to Redpanda Console
+
+To add a new license to Redpanda Console, you have two options:
+
+- <<file, Provide the path to the license file>>.
+- <<inline, Provide the license key contents directly>>.
+
+[[file]]
+=== Use a license file
+
+Specify the path to the license file in one of the following ways:
+
+- Set the `licenseFilepath` property in the `/etc/redpanda/redpanda-console-config.yaml` configuration file:
++
+```yaml
+licenseFilepath: <path-to-license-file>
+```
+- Set the `REDPANDA_LICENSE_FILEPATH` environment variable:
++
+```bash
+export REDPANDA_LICENSE_FILEPATH=<path-to-license-file>
+```
+
+[[inline]]
+=== Use the license key contents directly
+
+If you don't want to provide a path to the license file, you can use the contents of the license key directly in one of the following ways:
+
+- Set the `license` property in the `/etc/redpanda/redpanda-console-config.yaml` configuration file:
++
+```yaml
+license: <license-key-contents>
+```
+
+- Set the `REDPANDA_LICENSE` environment variable:
++
+```yaml
+export REDPANDA_LICENSE=<license-key-contents>
+```
+
+== Update an existing license
+
+To update an existing license:
+
+. Update your configuration file or environment variables with one of the following:
+
+- <<file, The path to your new license file>>
+- <<inline, The contents of your new license key>>
+
+. Restart Redpanda Console to make the changes take effect.
+
+== Next steps
+
+xref:get-started:licensing/monitor-license-status.adoc[].
+
+== Suggested reading
+
+- xref:get-started:licensing/index.adoc[]
+- xref:console:ui/add-license.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/config/topic-documentation.adoc

@@ -4,7 +4,7 @@
 
 You can embed your topic's documentation into the Redpanda Console user interface by providing access to a public or private Git repository that hosts your documentation files in Markdown format.
 
-//image::topic-documentation.png[]
+image::topic-documentation.png[]
 
 Redpanda Console clones the provided Git repository and stores all Markdown files it finds in memory.
 The *Documentation* tab in the frontend displays the content of the Markdown file that matches the name of the Kafka topic.

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