Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
c2b8325
Update antora.yml
JakeSCahill May 22, 2025
8eda4f4
Update local-antora-playbook.yml
JakeSCahill May 22, 2025
84e590b
DOC-1229 Document feature: Package Operator CRDs with Operator Helm C…
JakeSCahill Jun 26, 2025
8d07bb6
Add docs for extraClusterConfig (#1187)
JakeSCahill Jul 2, 2025
bd6964b
Rename extraClusterConfig to extraClusterConfiguration (#1195)
JakeSCahill Jul 8, 2025
d7d9313
Fix field names
JakeSCahill Jul 9, 2025
1cb5336
DOC-1407 single source additions for Cloud (#1139)
micheleRP Jun 13, 2025
bc050db
DOC-1449 revert playbook (#1164)
micheleRP Jun 15, 2025
be67482
DOC-1494 Mark KC as community supported (#1211)
micheleRP Jul 17, 2025
25a1a70
Remove Kafka Connect info from Kubernetes docs (#1186)
JakeSCahill Jul 18, 2025
9ec6888
docs: remove ephemeral auth on Kafka API (#1210)
paulohtb6 Jul 18, 2025
22ea6c7
DOC-1378: Compaction robustness (#1153)
Feediver1 Jul 18, 2025
7b6e21f
[25.2] Serialized schema in Schema Registry API, support for confluen…
kbatuigas Jul 21, 2025
fad435c
docs: use attributes instead of page level props (#1220)
paulohtb6 Jul 25, 2025
6fb17a5
[25.2] KIP-554 support (#1240)
kbatuigas Jul 26, 2025
9c0bd41
[25.2] Iceberg - JSON Schema support (#1207)
kbatuigas Jul 26, 2025
30647cb
Console tab (#1239)
JakeSCahill Jul 28, 2025
b2654cc
Prepare Kubernetes docs for 25.2 release using 25.1 helm chart/operat…
JakeSCahill Jul 29, 2025
ca80cdc
[25.2] Iceberg - AWS Glue (#1208)
kbatuigas Jul 29, 2025
b834a18
Doc 1196: Document Feature - Schema Registry Authorization (#1224)
Feediver1 Jul 30, 2025
2d524e5
docs: rpk v25.2 (#1243)
paulohtb6 Jul 30, 2025
2bc22dd
docs: properties v25.2 (#1245)
paulohtb6 Jul 30, 2025
bc8ce01
docs: compaction props for whats new (#1255)
Feediver1 Jul 30, 2025
942633f
Prep beta (#1256)
paulohtb6 Jul 30, 2025
0260861
Fix issues in the build and apply Coderabbit suggestions
JakeSCahill Jul 31, 2025
b4995fa
Apply suggestions from code review
JakeSCahill Jul 31, 2025
c67075f
Add links to console migration
JakeSCahill Jul 31, 2025
7a87bc2
Fix single-sourcing errors in Cloud (#1258)
JakeSCahill Jul 31, 2025
b1d811c
Update modules/reference/pages/properties/cluster-properties.adoc
paulohtb6 Jul 31, 2025
c47d2c2
docs: add whats new props (#1261)
paulohtb6 Jul 31, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: ROOT
title: Self-Managed
version: 25.1
version: 25.2
start_page: home:index.adoc
nav:
- modules/ROOT/nav.adoc
Expand All @@ -17,11 +17,10 @@ asciidoc:
# Fallback versions
# We try to fetch the latest versions from GitHub at build time
# --

full-version: 25.1.1
latest-redpanda-tag: 'v25.1.1'
full-version: 25.2.1
latest-redpanda-tag: 'v25.2.1'
latest-console-tag: 'v2.8.5'
latest-release-commit: 'afe1a3f'
latest-release-commit: '68c64fd'
latest-operator-version: 'v2.3.8-24.3.6'
operator-beta-tag: 'v25.1.1-beta1'
helm-beta-tag: 'v25.1.1-beta1'
Expand Down
3 changes: 2 additions & 1 deletion local-antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site:
title: Redpanda Docs
start_page: 25.1@ROOT:get-started:intro-to-events.adoc
start_page: 25.2@ROOT:get-started:intro-to-events.adoc
url: http://localhost:5002
robots: disallow
keys:
Expand Down Expand Up @@ -43,6 +43,7 @@ antora:
- require: '@redpanda-data/docs-extensions-and-macros/extensions/add-global-attributes'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/validate-attributes'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/process-context-switcher'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/generate-index-data'
data:
sets:
Expand Down
10 changes: 6 additions & 4 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@
*** xref:deploy:deployment-option/self-hosted/kubernetes/k-production-workflow.adoc[Deployment Workflow]
*** xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc[Requirements and Recommendations]
*** xref:deploy:deployment-option/self-hosted/kubernetes/k-tune-workers.adoc[Tune Worker Nodes]
*** xref:deploy:deployment-option/self-hosted/kubernetes/k-25.1-beta.adoc[Try v25.1]
*** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc[Deploy Redpanda]
*** xref:deploy:deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc[Deploy Connectors]
*** xref:deploy:deployment-option/self-hosted/kubernetes/k-high-availability.adoc[High Availability]
Expand Down Expand Up @@ -171,17 +170,20 @@
*** xref:manage:whole-cluster-restore.adoc[Whole Cluster Restore]
** xref:manage:iceberg/index.adoc[Iceberg]
*** xref:manage:iceberg/about-iceberg-topics.adoc[About Iceberg Topics]
*** xref:manage:iceberg/choose-iceberg-mode.adoc[Choose Iceberg Mode]
*** xref:manage:iceberg/specify-iceberg-schema.adoc[Specify Iceberg Schema]
*** xref:manage:iceberg/use-iceberg-catalogs.adoc[Use Iceberg Catalogs]
*** xref:manage:iceberg/rest-catalog/index.adoc[Integrate with REST Catalogs]
**** xref:manage:iceberg/iceberg-topics-aws-glue.adoc[AWS Glue]
**** xref:manage:iceberg/iceberg-topics-databricks-unity.adoc[Databricks Unity Catalog]
**** xref:manage:iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc[Snowflake and Open Catalog]
*** xref:manage:iceberg/query-iceberg-topics.adoc[Query Iceberg Topics]
*** xref:manage:iceberg/iceberg-topics-databricks-unity.adoc[Query Iceberg Topics with Databricks Unity Catalog]
*** xref:manage:iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc[Query Iceberg Topics with Snowflake and Open Catalog]
** xref:manage:schema-reg/index.adoc[Schema Registry]
*** xref:manage:schema-reg/schema-reg-overview.adoc[Overview]
*** xref:manage:schema-reg/manage-schema-reg.adoc[]
**** xref:manage:schema-reg/schema-reg-api.adoc[API]
**** xref:console:ui/schema-reg.adoc[Redpanda Console]
**** xref:manage:kubernetes/k-schema-controller.adoc[Kubernetes]
*** xref:manage:schema-reg/schema-reg-authorization.adoc[Schema Registry Authorization]
*** 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]
Expand Down
5 changes: 5 additions & 0 deletions modules/console/pages/config/configure-console.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
= Configure Redpanda Console
:description: Redpanda Console configuration file with property descriptions.
:page-aliases: console:reference/config.adoc, reference:console/config.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/configure-console.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

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

Expand Down Expand Up @@ -46,6 +49,8 @@ KAFKA_BROKERS=redpanda-0:9092,redpanda-1:9092,redpanda-2:9092
NOTE: You cannot use environment variables to configure object arrays, such as the configuration
for Kafka Connect clusters. In this case, use a YAML file, and provide secrets using environment variables or command line arguments.

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

== Docker Compose example

If you are using Docker Compose, you can mount the configuration file and set the environment variable in your `docker-compose.yml` file:
Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/config/connect-to-redpanda.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Configure Redpanda Console to Connect to a Redpanda Cluster
: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.
: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" } ]

include::console:partial$operator-console-version-note.adoc[]

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:

Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/config/deserialization.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Configure Message Deserialization in Redpanda Console
:description: Configure Redpanda Console to use Schema Registry, Protobuf files, and other deserialization methods to ensure your data is correctly interpreted and displayed.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

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.

Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/config/enterprise-license.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Add a License Key to Redpanda Console
:description: Learn how to apply or update a license key to Redpanda Console.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/enterprise-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

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.

Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/config/http-path-rewrites.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
= HTTP Path Rewrites in Redpanda Console
:description: Learn how to configure Redpanda Console to work seamlessly with your URL path rewrites, particularly when hosted under a subpath.
:page-aliases: console:features/http-path-rewrites.adoc, manage:console/http-path-rewrites.adoc
: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" } ]

include::console:partial$operator-console-version-note.adoc[]

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:

Expand Down
5 changes: 5 additions & 0 deletions modules/console/pages/config/kafka-connect.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
= Connect Redpanda Console to Kafka Connect Clusters
:description: Connect one or more Kafka Connect clusters with Redpanda Console.
:page-aliases: console:features/kafka-connect.adoc, manage:console/kafka-connect.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/kafka-connect.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

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

include::console:partial$operator-console-version-note.adoc[]

Redpanda Console provides a user interface that lets you manage multiple Kafka Connect clusters.
You can inspect or patch connectors; restart, pause, and resume connector tasks; and delete connectors.
Expand Down
4 changes: 4 additions & 0 deletions modules/console/pages/config/security/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
: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.
: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
:page-categories: Security, Management, Redpanda Console
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authentication.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]


// ========================AUTOMATED TESTS===================================
// 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/.
Expand Down
5 changes: 5 additions & 0 deletions modules/console/pages/config/security/authorization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
: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.
: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
:page-categories: Security, Management, Redpanda Console
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authorization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

[NOTE]
====
Expand Down Expand Up @@ -158,6 +161,8 @@ Redpanda Console provides the following predefined roles:
| No limitations
|===

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

== Grant permissions through role bindings

When impersonation is disabled, Redpanda Console connects to Redpanda APIs using the service account defined in:
Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/config/security/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
:page-aliases: manage:security/console/index.adoc
:description: Security topics for Redpanda Console.
:page-layout: index
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]
3 changes: 3 additions & 0 deletions modules/console/pages/config/security/tls-termination.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
:description: To secure Redpanda Console using TLS, you can let Redpanda Console handle TLS termination or you can offload it to an upstream component, such as a reverse proxy or a Cloud HTTPS LoadBalancer.
:page-categories: Management, Security, Redpanda Console
:page-exclude-related-labs: true
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/tls-termination.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

To secure Redpanda Console using TLS (Transport Layer Security), you can either let Redpanda Console handle TLS termination or you can offload it to an upstream component, such as a reverse proxy or a cloud HTTPS load balancer. TLS termination refers to the process of decrypting incoming TLS-encrypted traffic. Choosing the right approach depends on various factors, such as your application's traffic load, the complexity of your infrastructure, security requirements, and resource availability:

Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/config/topic-documentation.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
= Enable Topic Documentation in Redpanda Console
:description: Embed your Kafka topic documentation into the Redpanda Console UI by linking a Git repository that contains the topic documentation files.
:page-aliases: console:features/topic-documentation.adoc, manage:console/topic-documentation.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/topic-documentation.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

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.

Expand Down
5 changes: 5 additions & 0 deletions modules/console/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
= 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
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

Redpanda Console is a web interface for managing and interacting with Redpanda clusters. Built to provide a seamless experience for developers working with streaming data, Redpanda Console simplifies tasks associated with managing data streams, offering a UI that helps you monitor, troubleshoot, and optimize your streaming workloads.

Expand Down Expand Up @@ -46,6 +49,8 @@ image::schema-reg.png[]

View and manage Kafka Connect clusters and connectors, simplifying the integration of external systems with your streaming data.

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

== Who should use Redpanda Console?

Redpanda Console is designed for:
Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/ui/add-license.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Manage Enterprise Edition Licenses through Redpanda Console
:description: Learn how to manage Enterprise Edition licenses in Redpanda Console.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/add-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

You can add or update an xref:get-started:licensing/overview.adoc#console[Enterprise Edition license] for both Redpanda and Redpanda Console directly through the Redpanda Console UI.

Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/ui/check-license.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Check License Status in Redpanda Console
:description: Learn how to check the status of your Redpanda Enterprise Edition license using the Redpanda Console. This topic includes steps to check license details and understand license warnings.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/check-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

You can check the expiration date of a license on the **Cluster Overview** page in Redpanda Console, under the **Licensing** section.

Expand Down
4 changes: 4 additions & 0 deletions modules/console/pages/ui/data-transforms.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
= Manage Data Transforms in {ui}
:description: Use {ui} to monitor the status and performance metrics of your transform functions. You can also view detailed logs and delete transform functions when they are no longer needed.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/data-transforms.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

// tag::single-source[]

{description}
Expand Down
4 changes: 4 additions & 0 deletions modules/console/pages/ui/edit-topic-configuration.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
= Edit Topic Configuration in {ui}
:page-aliases: manage:console/edit-topic-configuration.adoc
:description: Use {ui} to edit the configuration of existing topics in a cluster.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/edit-topic-configuration.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

// tag::single-source[]

{description}
Expand Down
3 changes: 3 additions & 0 deletions modules/console/pages/ui/generate-bundle.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Manage Debug Bundles in Redpanda Console
:description: Learn how to generate, download, and delete debug bundles in Redpanda Console for comprehensive cluster diagnostics.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/generate-bundle.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

[NOTE]
====
Expand Down
4 changes: 4 additions & 0 deletions modules/console/pages/ui/programmable-push-filters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
:page-aliases: console:features/programmable-push-filters.adoc, reference:console/programmable-push-filters.adoc
// Do not put page aliases in the single-sourced content
:description: Learn how to filter Kafka records using custom JavaScript code within {ui}.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/programmable-push-filters.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

// tag::single-source[]

You can use push-down filters in {ui} to search through large Kafka topics that may contain millions of records. Filters are JavaScript functions executed on the backend, evaluating each record individually. Your function must return a boolean:
Expand Down
5 changes: 5 additions & 0 deletions modules/console/pages/ui/record-deserialization.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
= View Deserialized Messages in {ui}
:page-aliases: console:features/record-deserialization.adoc, manage:console/protobuf.adoc, reference:console/record-deserialization.adoc
:description: Learn how {ui} deserializes messages.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/record-deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

// tag::single-source[]


In Redpanda, the messages exchanged between producers and consumers contain raw bytes. Schemas work as an agreed-upon format, like a contract, for producers and consumers to serialize and deserialize those messages. If a producer breaks this contract, consumers can fail.

{ui} automatically tries to deserialize incoming messages and displays them in human-readable format. It tests different deserialization strategies until it finds one with no errors. If no deserialization attempts are successful, {ui} renders the byte array in a hex viewer. Sometimes, the payload is displayed in hex bytes because it's encrypted or because it uses a serializer that {ui} cannot deserialize. When this happens, {ui} displays troubleshooting information. You can also download the raw bytes of the message to feed it directly to your client deserializer or share it with a support team.
Expand Down
4 changes: 4 additions & 0 deletions modules/console/pages/ui/schema-reg.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
:page-aliases: manage:schema-reg/schema-reg-ui.adoc
:page-categories: Management, Schema Registry
:description: Perform common Schema Registry management operations in the {ui}.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/schema-reg.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

// tag::single-source[]

In {ui}, the *Schema Registry* menu lists registered and verified schemas, including their serialization format and versions. Select an individual schema to see which topics it applies to.
Expand Down
Loading
Loading