Skip to content

Commit 480757a

Browse files
authored
Console tab (#1239)
1 parent 88e640f commit 480757a

File tree

67 files changed

+93
-47
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+93
-47
lines changed

antora.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ asciidoc:
1919
# Fallback versions
2020
# We try to fetch the latest versions from GitHub at build time
2121
# --
22-
2322
full-version: 25.1.1
2423
latest-redpanda-tag: 'v25.1.1'
2524
latest-console-tag: 'v2.8.5'

local-antora-playbook.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ antora:
4343
- require: '@redpanda-data/docs-extensions-and-macros/extensions/add-global-attributes'
4444
- require: '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
4545
- require: '@redpanda-data/docs-extensions-and-macros/extensions/validate-attributes'
46+
- require: '@redpanda-data/docs-extensions-and-macros/extensions/process-context-switcher'
4647
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-index-data'
4748
data:
4849
sets:

modules/console/pages/config/configure-console.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
= Configure Redpanda Console
22
:description: Redpanda Console configuration file with property descriptions.
33
:page-aliases: console:reference/config.adoc, reference:console/config.adoc
4+
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/configure-console.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
5+
6+
include::console:partial$operator-console-version-note.adoc[]
47

58
Redpanda Console loads configuration properties from three sources, in the following order of precedence:
69

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
= Configure Redpanda Console to Connect to a Redpanda Cluster
22
:description: This topic provides instructions on configuring Redpanda Console to connect to a Redpanda cluster. The configuration ensures that Redpanda Console can communicate with your Redpanda brokers.
3+
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/connect-to-redpanda.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
4+
5+
include::console:partial$operator-console-version-note.adoc[]
36

47
Redpanda Console connects to your Redpanda cluster using dedicated configuration blocks for the Kafka API, Schema Registry API, and Admin API. Each connection serves a different purpose:
58

modules/console/pages/config/deserialization.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
= Configure Message Deserialization in Redpanda Console
22
:description: Configure Redpanda Console to use Schema Registry, Protobuf files, and other deserialization methods to ensure your data is correctly interpreted and displayed.
3+
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
4+
5+
include::console:partial$operator-console-version-note.adoc[]
36

47
Redpanda Console provides tools for deserializing and inspecting messages in Kafka topics. This topic explains how to configure Redpanda Console to use Schema Registry, Protobuf files, and other deserialization methods to ensure your data is correctly interpreted and displayed.
58

modules/console/pages/config/enterprise-license.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
= Add a License Key to Redpanda Console
22
:description: Learn how to apply or update a license key to Redpanda Console.
3+
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/enterprise-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
4+
5+
include::console:partial$operator-console-version-note.adoc[]
36

47
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.
58

modules/console/pages/config/http-path-rewrites.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
= HTTP Path Rewrites in Redpanda Console
22
:description: Learn how to configure Redpanda Console to work seamlessly with your URL path rewrites, particularly when hosted under a subpath.
33
:page-aliases: console:features/http-path-rewrites.adoc, manage:console/http-path-rewrites.adoc
4+
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/http-path-rewrites.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
5+
6+
include::console:partial$operator-console-version-note.adoc[]
47

58
If you want to host Redpanda Console under a subpath rather than the root path, you need to configure HTTP path rewrites. This allows you to serve Redpanda Console under a subpath of your domain, such as `+https://my-company.com/redpanda/console+`, instead of directly from `+https://my-company.com+`. This type of configuration is often necessary when:
69

modules/console/pages/config/kafka-connect.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
= Connect Redpanda Console to Kafka Connect Clusters
22
:description: Connect one or more Kafka Connect clusters with Redpanda Console.
33
:page-aliases: console:features/kafka-connect.adoc, manage:console/kafka-connect.adoc
4+
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/kafka-connect.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
45

56
include::shared:partial$community-supported-kc.adoc[]
67

8+
include::console:partial$operator-console-version-note.adoc[]
9+
710
Redpanda Console provides a user interface that lets you manage multiple Kafka Connect clusters.
811
You can inspect or patch connectors; restart, pause, and resume connector tasks; and delete connectors.
912
Redpanda Console queries all configured Kafka Connect

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
:description: Authentication in Redpanda Console enables users to log in and optionally forward their credentials to the connected Redpanda cluster, ensuring all API requests are executed under the user's identity.
33
:page-aliases: console:single-sign-on/authentication.adoc, manage:security/console/authentication.adoc, console:config/security/plain.adoc, console:config/security/okta.adoc, console:config/security/generic-oidc.adoc, console:config/security/keycloak.adoc, console:config/security/github.adoc, console:config/security/google.adoc, console:config/security/azure-ad.adoc
44
:page-categories: Security, Management, Redpanda Console
5+
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authentication.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
6+
7+
include::console:partial$operator-console-version-note.adoc[]
8+
59

610
// ========================AUTOMATED TESTS===================================
711
// The comments in this file are used to run automated tests of the documented steps. Tests are run using GitHub Actions on each pull request that changes this file in the upstream repository. For more details about the testing tool we use, see https://doc-detective.com/.

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
:description: Redpanda Console supports role-based access control (RBAC) to restrict system access to authorized users. This page is intended for cluster administrators who manage Redpanda Console access and need to configure UI-based authorization.
33
:page-aliases: console:single-sign-on/authorization.adoc, manage:security/console/authorization.adoc, console:features/role-bindings.adoc, console:reference/role-bindings.adoc, reference:console/role-bindings.adoc
44
:page-categories: Security, Management, Redpanda Console
5+
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authorization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
6+
7+
include::console:partial$operator-console-version-note.adoc[]
58

69
[NOTE]
710
====

0 commit comments

Comments
 (0)