From e75c787422b3677d5be46fcde98cd50640b5c3ad Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Fri, 7 Aug 2026 15:03:48 +0100 Subject: [PATCH 1/4] feat: move the shared component to a folder on main and add the enterprise features registry The shared Antora component (glossary terms, valid categories, global attributes) moves from the shared branch to shared/ on main, added to the playbook as a second content source with start_path: shared. Registry entries, the prose that uses them, and table changes can now land atomically in one PR with normal CODEOWNERS review. shared/modules/ROOT/partials/enterprise-features.yml is the new canonical registry of enterprise features, seeded verbatim from the four tables in get-started:licensing/overview.adoc. The enterprise macro validates its targets against this registry and the enterprise_features block macro renders the licensing tables from it (docs-extensions-and-macros). --- .github/CODEOWNERS | 8 +- local-antora-playbook.yml | 5 +- shared/README.adoc | 46 ++ shared/antora.yml | 6 + .../ROOT/partials/enterprise-features.yml | 438 ++++++++++++++++++ .../ROOT/partials/global-attributes.yml | 32 ++ .../ROOT/partials/valid-categories.yml | 89 ++++ shared/modules/terms/partials/LA.adoc | 4 + .../modules/terms/partials/a2a-protocol.adoc | 6 + shared/modules/terms/partials/acl.adoc | 4 + shared/modules/terms/partials/admin-api.adoc | 10 + shared/modules/terms/partials/adp.adoc | 6 + .../terms/partials/advertised-listener.adoc | 4 + shared/modules/terms/partials/ai-agent.adoc | 6 + shared/modules/terms/partials/ai-gateway.adoc | 4 + shared/modules/terms/partials/ai-token.adoc | 6 + .../terms/partials/authentication.adoc | 4 + .../modules/terms/partials/authorization.adoc | 4 + shared/modules/terms/partials/az.adoc | 4 + .../modules/terms/partials/bearer-token.adoc | 4 + shared/modules/terms/partials/beta.adoc | 4 + shared/modules/terms/partials/broker.adoc | 8 + shared/modules/terms/partials/byoc.adoc | 4 + shared/modules/terms/partials/byovnet.adoc | 4 + shared/modules/terms/partials/byovpc.adoc | 4 + .../modules/terms/partials/cert-manager.adoc | 6 + shared/modules/terms/partials/client.adoc | 6 + .../modules/terms/partials/cloud-topic.adoc | 5 + shared/modules/terms/partials/cluster.adoc | 4 + shared/modules/terms/partials/community.adoc | 4 + shared/modules/terms/partials/compaction.adoc | 4 + shared/modules/terms/partials/connector.adoc | 4 + .../terms/partials/consumer-group.adoc | 4 + .../terms/partials/consumer-offset.adoc | 4 + shared/modules/terms/partials/consumer.adoc | 4 + .../terms/partials/context-window.adoc | 6 + .../modules/terms/partials/control-plane.adoc | 4 + .../terms/partials/controller-broker.adoc | 4 + .../terms/partials/controller-snapshot.adoc | 4 + shared/modules/terms/partials/data-plane.adoc | 4 + .../terms/partials/data-sovereignty.adoc | 6 + .../modules/terms/partials/data-stream.adoc | 4 + .../terms/partials/data-transforms.adoc | 4 + .../terms/partials/declarative-agent.adoc | 4 + shared/modules/terms/partials/dedicated.adoc | 4 + shared/modules/terms/partials/enterprise.adoc | 4 + shared/modules/terms/partials/event.adoc | 4 + .../terms/partials/frontier-model.adoc | 6 + shared/modules/terms/partials/gbac.adoc | 6 + shared/modules/terms/partials/helm.adoc | 4 + shared/modules/terms/partials/http-proxy.adoc | 4 + .../terms/partials/iceberg-catalog.adoc | 6 + .../modules/terms/partials/iceberg-mode.adoc | 4 + .../modules/terms/partials/iceberg-topic.adoc | 4 + .../terms/partials/iceberg-translation.adoc | 4 + shared/modules/terms/partials/idp.adoc | 6 + shared/modules/terms/partials/kafka-api.adoc | 4 + .../terms/partials/leader-pinning.adoc | 4 + shared/modules/terms/partials/learner.adoc | 6 + shared/modules/terms/partials/listener.adoc | 4 + shared/modules/terms/partials/llm.adoc | 6 + shared/modules/terms/partials/log.adoc | 8 + .../terms/partials/maintenance-mode.adoc | 4 + shared/modules/terms/partials/mcp-client.adoc | 6 + shared/modules/terms/partials/mcp-server.adoc | 6 + shared/modules/terms/partials/mcp-tool.adoc | 4 + shared/modules/terms/partials/mcp.adoc | 6 + shared/modules/terms/partials/message.adoc | 6 + shared/modules/terms/partials/node.adoc | 6 + .../modules/terms/partials/oauth-client.adoc | 4 + .../terms/partials/oauth-connection.adoc | 4 + .../terms/partials/oauth-provider.adoc | 4 + .../modules/terms/partials/observability.adoc | 6 + .../modules/terms/partials/offset-commit.adoc | 4 + shared/modules/terms/partials/offset.adoc | 4 + shared/modules/terms/partials/oidc.adoc | 6 + .../modules/terms/partials/opentelemetry.adoc | 6 + shared/modules/terms/partials/operator.adoc | 4 + shared/modules/terms/partials/otlp.adoc | 6 + shared/modules/terms/partials/oxla.adoc | 4 + shared/modules/terms/partials/pandaproxy.adoc | 4 + .../terms/partials/partition-leader.adoc | 4 + shared/modules/terms/partials/partition.adoc | 4 + shared/modules/terms/partials/pipeline.adoc | 4 + shared/modules/terms/partials/principal.adoc | 6 + shared/modules/terms/partials/processor.adoc | 6 + shared/modules/terms/partials/producer.adoc | 4 + shared/modules/terms/partials/prompt.adoc | 6 + .../terms/partials/rack-awareness.adoc | 4 + shared/modules/terms/partials/rack.adoc | 4 + shared/modules/terms/partials/raft.adoc | 5 + shared/modules/terms/partials/rbac.adoc | 4 + .../modules/terms/partials/rebalancing.adoc | 12 + shared/modules/terms/partials/record.adoc | 6 + .../terms/partials/redpanda-catalog.adoc | 4 + .../terms/partials/redpanda-cloud.adoc | 4 + .../partials/redpanda-connect-mcp-server.adoc | 4 + .../terms/partials/redpanda-connect.adoc | 4 + .../terms/partials/redpanda-console.adoc | 4 + .../modules/terms/partials/redpanda-sql.adoc | 6 + shared/modules/terms/partials/remote-mcp.adoc | 4 + shared/modules/terms/partials/replicas.adoc | 4 + .../terms/partials/resource-group.adoc | 4 + shared/modules/terms/partials/resource.adoc | 4 + shared/modules/terms/partials/retention.adoc | 4 + shared/modules/terms/partials/rf.adoc | 4 + .../terms/partials/rolling-upgrade.adoc | 4 + shared/modules/terms/partials/rpk.adoc | 4 + shared/modules/terms/partials/rrr.adoc | 4 + .../partials/schema-registry-context.adoc | 4 + .../terms/partials/schema-registry.adoc | 4 + shared/modules/terms/partials/schema.adoc | 4 + shared/modules/terms/partials/seastar.adoc | 5 + .../modules/terms/partials/seed-server.adoc | 4 + shared/modules/terms/partials/segment.adoc | 4 + .../modules/terms/partials/self-hosted.adoc | 6 + .../terms/partials/self-managed-agent.adoc | 4 + .../partials/self-managed-mcp-server.adoc | 4 + .../modules/terms/partials/serialization.adoc | 4 + shared/modules/terms/partials/serverless.adoc | 4 + .../terms/partials/service-account.adoc | 4 + .../terms/partials/shadow-cluster.adoc | 4 + .../modules/terms/partials/shadow-link.adoc | 4 + shared/modules/terms/partials/shard.adoc | 4 + .../terms/partials/sink-connector.adoc | 4 + .../terms/partials/source-connector.adoc | 4 + shared/modules/terms/partials/span.adoc | 6 + .../terms/partials/spending-event.adoc | 4 + shared/modules/terms/partials/subagent.adoc | 6 + shared/modules/terms/partials/subject.adoc | 4 + .../modules/terms/partials/system-prompt.adoc | 6 + .../terms/partials/thread-per-core.adoc | 4 + .../terms/partials/tiered-storage.adoc | 4 + .../modules/terms/partials/token-vault.adoc | 4 + .../terms/partials/tool-invocation.adoc | 6 + shared/modules/terms/partials/tool.adoc | 4 + .../terms/partials/topic-partition.adoc | 4 + shared/modules/terms/partials/topic.adoc | 4 + shared/modules/terms/partials/trace.adoc | 6 + shared/modules/terms/partials/transcript.adoc | 6 + .../modules/terms/partials/wire-format.adoc | 4 + 141 files changed, 1252 insertions(+), 3 deletions(-) create mode 100644 shared/README.adoc create mode 100644 shared/antora.yml create mode 100644 shared/modules/ROOT/partials/enterprise-features.yml create mode 100644 shared/modules/ROOT/partials/global-attributes.yml create mode 100644 shared/modules/ROOT/partials/valid-categories.yml create mode 100644 shared/modules/terms/partials/LA.adoc create mode 100644 shared/modules/terms/partials/a2a-protocol.adoc create mode 100644 shared/modules/terms/partials/acl.adoc create mode 100644 shared/modules/terms/partials/admin-api.adoc create mode 100644 shared/modules/terms/partials/adp.adoc create mode 100644 shared/modules/terms/partials/advertised-listener.adoc create mode 100644 shared/modules/terms/partials/ai-agent.adoc create mode 100644 shared/modules/terms/partials/ai-gateway.adoc create mode 100644 shared/modules/terms/partials/ai-token.adoc create mode 100644 shared/modules/terms/partials/authentication.adoc create mode 100644 shared/modules/terms/partials/authorization.adoc create mode 100644 shared/modules/terms/partials/az.adoc create mode 100644 shared/modules/terms/partials/bearer-token.adoc create mode 100644 shared/modules/terms/partials/beta.adoc create mode 100644 shared/modules/terms/partials/broker.adoc create mode 100644 shared/modules/terms/partials/byoc.adoc create mode 100644 shared/modules/terms/partials/byovnet.adoc create mode 100644 shared/modules/terms/partials/byovpc.adoc create mode 100644 shared/modules/terms/partials/cert-manager.adoc create mode 100644 shared/modules/terms/partials/client.adoc create mode 100644 shared/modules/terms/partials/cloud-topic.adoc create mode 100644 shared/modules/terms/partials/cluster.adoc create mode 100644 shared/modules/terms/partials/community.adoc create mode 100644 shared/modules/terms/partials/compaction.adoc create mode 100644 shared/modules/terms/partials/connector.adoc create mode 100644 shared/modules/terms/partials/consumer-group.adoc create mode 100644 shared/modules/terms/partials/consumer-offset.adoc create mode 100644 shared/modules/terms/partials/consumer.adoc create mode 100644 shared/modules/terms/partials/context-window.adoc create mode 100644 shared/modules/terms/partials/control-plane.adoc create mode 100644 shared/modules/terms/partials/controller-broker.adoc create mode 100644 shared/modules/terms/partials/controller-snapshot.adoc create mode 100644 shared/modules/terms/partials/data-plane.adoc create mode 100644 shared/modules/terms/partials/data-sovereignty.adoc create mode 100644 shared/modules/terms/partials/data-stream.adoc create mode 100644 shared/modules/terms/partials/data-transforms.adoc create mode 100644 shared/modules/terms/partials/declarative-agent.adoc create mode 100644 shared/modules/terms/partials/dedicated.adoc create mode 100644 shared/modules/terms/partials/enterprise.adoc create mode 100644 shared/modules/terms/partials/event.adoc create mode 100644 shared/modules/terms/partials/frontier-model.adoc create mode 100644 shared/modules/terms/partials/gbac.adoc create mode 100644 shared/modules/terms/partials/helm.adoc create mode 100644 shared/modules/terms/partials/http-proxy.adoc create mode 100644 shared/modules/terms/partials/iceberg-catalog.adoc create mode 100644 shared/modules/terms/partials/iceberg-mode.adoc create mode 100644 shared/modules/terms/partials/iceberg-topic.adoc create mode 100644 shared/modules/terms/partials/iceberg-translation.adoc create mode 100644 shared/modules/terms/partials/idp.adoc create mode 100644 shared/modules/terms/partials/kafka-api.adoc create mode 100644 shared/modules/terms/partials/leader-pinning.adoc create mode 100644 shared/modules/terms/partials/learner.adoc create mode 100644 shared/modules/terms/partials/listener.adoc create mode 100644 shared/modules/terms/partials/llm.adoc create mode 100644 shared/modules/terms/partials/log.adoc create mode 100644 shared/modules/terms/partials/maintenance-mode.adoc create mode 100644 shared/modules/terms/partials/mcp-client.adoc create mode 100644 shared/modules/terms/partials/mcp-server.adoc create mode 100644 shared/modules/terms/partials/mcp-tool.adoc create mode 100644 shared/modules/terms/partials/mcp.adoc create mode 100644 shared/modules/terms/partials/message.adoc create mode 100644 shared/modules/terms/partials/node.adoc create mode 100644 shared/modules/terms/partials/oauth-client.adoc create mode 100644 shared/modules/terms/partials/oauth-connection.adoc create mode 100644 shared/modules/terms/partials/oauth-provider.adoc create mode 100644 shared/modules/terms/partials/observability.adoc create mode 100644 shared/modules/terms/partials/offset-commit.adoc create mode 100644 shared/modules/terms/partials/offset.adoc create mode 100644 shared/modules/terms/partials/oidc.adoc create mode 100644 shared/modules/terms/partials/opentelemetry.adoc create mode 100644 shared/modules/terms/partials/operator.adoc create mode 100644 shared/modules/terms/partials/otlp.adoc create mode 100644 shared/modules/terms/partials/oxla.adoc create mode 100644 shared/modules/terms/partials/pandaproxy.adoc create mode 100644 shared/modules/terms/partials/partition-leader.adoc create mode 100644 shared/modules/terms/partials/partition.adoc create mode 100644 shared/modules/terms/partials/pipeline.adoc create mode 100644 shared/modules/terms/partials/principal.adoc create mode 100644 shared/modules/terms/partials/processor.adoc create mode 100644 shared/modules/terms/partials/producer.adoc create mode 100644 shared/modules/terms/partials/prompt.adoc create mode 100644 shared/modules/terms/partials/rack-awareness.adoc create mode 100644 shared/modules/terms/partials/rack.adoc create mode 100644 shared/modules/terms/partials/raft.adoc create mode 100644 shared/modules/terms/partials/rbac.adoc create mode 100644 shared/modules/terms/partials/rebalancing.adoc create mode 100644 shared/modules/terms/partials/record.adoc create mode 100644 shared/modules/terms/partials/redpanda-catalog.adoc create mode 100644 shared/modules/terms/partials/redpanda-cloud.adoc create mode 100644 shared/modules/terms/partials/redpanda-connect-mcp-server.adoc create mode 100644 shared/modules/terms/partials/redpanda-connect.adoc create mode 100644 shared/modules/terms/partials/redpanda-console.adoc create mode 100644 shared/modules/terms/partials/redpanda-sql.adoc create mode 100644 shared/modules/terms/partials/remote-mcp.adoc create mode 100644 shared/modules/terms/partials/replicas.adoc create mode 100644 shared/modules/terms/partials/resource-group.adoc create mode 100644 shared/modules/terms/partials/resource.adoc create mode 100644 shared/modules/terms/partials/retention.adoc create mode 100644 shared/modules/terms/partials/rf.adoc create mode 100644 shared/modules/terms/partials/rolling-upgrade.adoc create mode 100644 shared/modules/terms/partials/rpk.adoc create mode 100644 shared/modules/terms/partials/rrr.adoc create mode 100644 shared/modules/terms/partials/schema-registry-context.adoc create mode 100644 shared/modules/terms/partials/schema-registry.adoc create mode 100644 shared/modules/terms/partials/schema.adoc create mode 100644 shared/modules/terms/partials/seastar.adoc create mode 100644 shared/modules/terms/partials/seed-server.adoc create mode 100644 shared/modules/terms/partials/segment.adoc create mode 100644 shared/modules/terms/partials/self-hosted.adoc create mode 100644 shared/modules/terms/partials/self-managed-agent.adoc create mode 100644 shared/modules/terms/partials/self-managed-mcp-server.adoc create mode 100644 shared/modules/terms/partials/serialization.adoc create mode 100644 shared/modules/terms/partials/serverless.adoc create mode 100644 shared/modules/terms/partials/service-account.adoc create mode 100644 shared/modules/terms/partials/shadow-cluster.adoc create mode 100644 shared/modules/terms/partials/shadow-link.adoc create mode 100644 shared/modules/terms/partials/shard.adoc create mode 100644 shared/modules/terms/partials/sink-connector.adoc create mode 100644 shared/modules/terms/partials/source-connector.adoc create mode 100644 shared/modules/terms/partials/span.adoc create mode 100644 shared/modules/terms/partials/spending-event.adoc create mode 100644 shared/modules/terms/partials/subagent.adoc create mode 100644 shared/modules/terms/partials/subject.adoc create mode 100644 shared/modules/terms/partials/system-prompt.adoc create mode 100644 shared/modules/terms/partials/thread-per-core.adoc create mode 100644 shared/modules/terms/partials/tiered-storage.adoc create mode 100644 shared/modules/terms/partials/token-vault.adoc create mode 100644 shared/modules/terms/partials/tool-invocation.adoc create mode 100644 shared/modules/terms/partials/tool.adoc create mode 100644 shared/modules/terms/partials/topic-partition.adoc create mode 100644 shared/modules/terms/partials/topic.adoc create mode 100644 shared/modules/terms/partials/trace.adoc create mode 100644 shared/modules/terms/partials/transcript.adoc create mode 100644 shared/modules/terms/partials/wire-format.adoc diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4bde7b3e6d..0e07384f44 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,8 @@ -* @redpanda-data/documentation +* @redpanda-data/documentation # Auto-add marketing as reviewers in partner integration page -modules/get-started/pages/partner-integration.adoc @redpanda-data/documentation @larsenpanda @mikebroberg @dunithd \ No newline at end of file +modules/get-started/pages/partner-integration.adoc @redpanda-data/documentation @larsenpanda @mikebroberg @dunithd + +# The enterprise features registry defines which features may be documented as +# enterprise and under what names. Changes need docs-team review. +/shared/modules/ROOT/partials/enterprise-features.yml @redpanda-data/documentation \ No newline at end of file diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 447369e98f..d9b65f7a5e 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -15,8 +15,11 @@ content: sources: - url: . branches: HEAD + - url: . + branches: HEAD + start_path: shared - url: https://github.com/redpanda-data/docs - branches: [v/*, shared, site-search,'!v-end-of-life/*'] + branches: [v/*, site-search,'!v-end-of-life/*'] - url: https://github.com/redpanda-data/cloud-docs branches: main - url: https://github.com/redpanda-data/redpanda-labs diff --git a/shared/README.adoc b/shared/README.adoc new file mode 100644 index 0000000000..0996a46d83 --- /dev/null +++ b/shared/README.adoc @@ -0,0 +1,46 @@ += Shared Component +:url-docs: https://docs.redpanda.com +:url-org: https://github.com/redpanda-data +:url-ui: {url-org}/docs-ui +:url-extensions: {url-org}/docs-extensions-and-macros +:hide-uri-scheme: +:url-contributing: {url-org}/docs-site/blob/main/meta-docs/CONTRIBUTING.adoc +:url-netlify: https://netlify.com +:url-netlify-docs: https://docs.netlify.com +:url-antora-docs: https://docs.antora.org +:url-redoc: https://github.com/Redocly/redoc +:idprefix: +:idseparator: - +ifdef::env-github[] +:important-caption: :exclamation: +:note-caption: :paperclip: +endif::[] +:toc: +:toc-title: Contents + +toc::[] + +This directory is the `shared` Antora component: content that is intended to be shared across all component versions and doc sites. It lives on `main` in the `shared/` folder and is added to each playbook as a separate content source with `start_path: shared`. (It previously lived on the now-retired `shared` branch.) + +== Enterprise features registry + +The `ROOT/partials/enterprise-features.yml` file is the canonical registry of enterprise features: which features are enterprise, their approved external names, and pointers to the internal source of truth for each. The {url-extensions}[`enterprise` macro] validates its targets against this registry, and the `enterprise_features` block macro renders the licensing feature tables from it. To mark a feature as enterprise anywhere in the docs, add an entry here first. See the comment header in the file for the field reference and governance rules. + +== Global attributes + +The attributes in the `ROOT/partials/global-attributes.yml` file are merged into the `antora.yml` file of each component version by the {url-extensions}[global attributes extension]. These global attributes are required for all local builds as well as the production build. + +== Terms + +The pages in the `terms/partials/` directory are terms that can be referenced in any component version using the {url-extensions}[`glossterm` macro]. The content of these term pages are also added automatically to `reference:glossary.adoc` pages by the {url-extensions}[aggregate terms extension]. + +Each partial file in the `terms/partials/` directory is a term. Each file must include the following attributes: + +- `term-name`: The name of the term. +- `hover-text`: A short definition of the term to be used as hover-over text. + +If a page called `reference:glossary.adoc` exists in a component version, the contents of each term file gets merged into the glossary during the build. Terms are merged in alphabetical order, according to the filename. + +== Contributing + +To learn how to use the playbook and generate the docs site locally, see our link:{url-contributing}[contributing guide]. \ No newline at end of file diff --git a/shared/antora.yml b/shared/antora.yml new file mode 100644 index 0000000000..ee6262aaa3 --- /dev/null +++ b/shared/antora.yml @@ -0,0 +1,6 @@ +name: shared +version: ~ +asciidoc: + attributes: + page-hide-view-latest: true + page-exclude-from-dropdown-selector: true \ No newline at end of file diff --git a/shared/modules/ROOT/partials/enterprise-features.yml b/shared/modules/ROOT/partials/enterprise-features.yml new file mode 100644 index 0000000000..c198815a36 --- /dev/null +++ b/shared/modules/ROOT/partials/enterprise-features.yml @@ -0,0 +1,438 @@ +# Canonical registry of Redpanda enterprise features. +# +# This file is the single source of truth for WHICH features are enterprise and +# under WHAT external name they are documented. The enterprise: inline macro +# validates its targets against this registry, and the enterprise_features:: +# block macro renders the licensing feature tables from it. +# +# Field reference: +# name Canonical external (customer-facing) name. Unique, case-insensitive. +# scope redpanda | console | connect | operator | cloud +# xref Antora resource ID of the feature page (omit if none exists). +# url Absolute link used instead of xref when the target is not an Antora page. +# description AsciiDoc for the table's Description column. +# expiration AsciiDoc for the "Behavior Upon Expiration" (redpanda scope) or +# "Restrictions Without Valid License" column. +# aliases Accepted alternative spellings, including internal identifiers. +# Resolved to the canonical name. Old names stay here permanently. +# tooltip Optional tooltip override for the enterprise: macro. +# since Optional first Redpanda version with the feature. +# show-gating-property Render the gating property under the feature name in tables. +# feature-suffix Extra AsciiDoc rendered after the feature name in tables +# (for example, a resource-name annotation or a beta badge). +# source Internal ground-truth pointer. kind: core-enum (a +# license_required_feature enum value in +# src/v/features/enterprise_features.h), core-property (a +# config::enterprise<> property in src/v/config/configuration.h), +# connect-plugin (a plugin in connect internal/plugins/info.csv), or +# manual (value holds the justification). +# gating-property Cluster/node property that enables the feature; cross-checked +# against disable-enterprise-features.adoc. +# glossary-term Optional term-name of a related glossary entry in this component. +# notes Rationale when the internal-to-external mapping is not obvious. +# +# Governance: to mark a feature as enterprise in the docs, it MUST have an entry +# here. Adding an entry requires a source pointer and review by the CODEOWNERS. +# Multiple entries may share one source gate (for example, everything gated by +# cloud_storage). New license_required_feature enum values in core are flagged by +# `doc-tools validate enterprise-features` until an entry exists. +schema-version: 1 +features: + # ---------------------------------------------------------------- redpanda + - name: Audit Logging + scope: redpanda + xref: manage:audit-logging.adoc + description: | + Records detailed logs of cluster activities for compliance and monitoring. + expiration: | + Read access to the audit log topic is denied, but logging continues. + aliases: [audit_logging] + source: + kind: core-enum + value: audit_logging + gating-property: audit_enabled + + - name: Cloud Topics + scope: redpanda + xref: develop:manage-topics/cloud-topics.adoc + description: | + A Redpanda topic type that uses durable object storage as the primary backing store instead of local disk replication. + expiration: | + New Cloud Topics cannot be created. Existing Cloud Topics cannot be modified, including adding or modifying partitions. Major upgrades are blocked when in a violation state. + source: + kind: manual + value: License-enforced at Cloud Topics creation and modification; no dedicated license_required_feature enum value as of 26.2. + notes: Revisit when core adds a cloud_topics enum value. + + - name: Continuous Data Balancing + scope: redpanda + xref: manage:cluster-maintenance/continuous-data-balancing.adoc + description: | + Automatically balances partitions across a cluster to optimize resource use and performance. + + Continuous Data Balancing is enabled by default for all new clusters with valid licenses. + expiration: | + Continuous balancing is disabled, reverting to `node_add` setting that balances partitions only after a broker is added to the cluster. + aliases: [CDB, partition_auto_balancing_continuous] + source: + kind: core-enum + value: partition_auto_balancing_continuous + gating-property: partition_autobalancing_mode + + - name: Continuous Intra-Broker Partition Balancing + scope: redpanda + xref: manage:cluster-maintenance/cluster-balancing.adoc#intra-broker-partition-balancing + description: | + Balances partition replicas across CPU cores in an individual broker to optimize disk space usage. + + Continuous Intra-Broker Partition Balancing is enabled by default for all new clusters with a valid license. + expiration: | + Continuous Intra-Broker Partition Balancing is disabled. + aliases: [core_balancing_continuous] + show-gating-property: true + source: + kind: core-enum + value: core_balancing_continuous + gating-property: core_balancing_continuous + + - name: Fetch Read Coalescing + scope: redpanda + xref: manage:cluster-maintenance/fetch-read-coalescing.adoc + description: | + Shares one read result across concurrent fetches of the same data, reducing read CPU and fetch-response memory under high consumer fan-out. + expiration: | + It will switch off automatically, similar to the other balancing features. + source: + kind: manual + value: Gated by an enterprise-wrapped cluster property; no dedicated license_required_feature enum value as of 26.2. + notes: Confirm the exact config::enterprise<> property when the drift checker gains property-level resolution. + + - name: FIPS Compliance + scope: redpanda + xref: manage:security/fips-compliance.adoc + description: | + Enables compliance with FIPS security standards for cryptography. + expiration: | + No change. + aliases: [fips] + source: + kind: core-enum + value: fips + gating-property: fips_mode + + - name: Group-Based Access Control (GBAC) + scope: redpanda + xref: manage:security/authorization/gbac.adoc + description: | + Manages permissions using OIDC group memberships for ACLs and role assignments. + expiration: | + ACLs with `Group:` principals cannot be created. Existing group ACLs continue to be evaluated and can be deleted. + aliases: [GBAC, Group-Based Access Control] + source: + kind: core-enum + value: rbac + notes: Shares the rbac license gate in core (see acl_with_group in enterprise_feature_messages.h). Documented as a separate feature because customers configure it independently of roles. + + - name: Iceberg Topics + scope: redpanda + xref: manage:iceberg/topic-iceberg-integration.adoc + description: | + Enables Iceberg integration for Redpanda topics. + expiration: | + Topics cannot be created or modified with the `redpanda.iceberg.mode` property. + aliases: [datalake_iceberg] + source: + kind: core-enum + value: datalake_iceberg + gating-property: iceberg_enabled + + - name: Kerberos Authentication + scope: redpanda + xref: manage:security/authentication.adoc#kerberos + description: | + Provides secure Kerberos-based authentication. + expiration: | + No change. + aliases: [gssapi, Kerberos] + source: + kind: core-enum + value: gssapi + gating-property: sasl_mechanisms + notes: Triggered by GSSAPI in sasl_mechanisms. + + - name: Leader Pinning + scope: redpanda + xref: develop:produce-data/leader-pinning.adoc + description: | + Specifies the set of availability zones where the leaders of partitions of a given topic should be located. + expiration: | + Leader Pinning is disabled on all topics. + aliases: [leadership_pinning, Leadership Pinning] + source: + kind: core-enum + value: leadership_pinning + gating-property: default_leaders_preference + + - name: OAUTHBEARER/OIDC Authentication + scope: redpanda + xref: manage:security/authentication.adoc#oidc + description: | + Allows for OAUTHBEARER and OpenID Connect (OIDC) authentication. + expiration: | + No change. + aliases: [oidc, OIDC Authentication] + source: + kind: core-enum + value: oidc + gating-property: http_authentication + notes: Also triggered by OAUTHBEARER in sasl_mechanisms. + + - name: Remote Read Replicas + scope: redpanda + xref: manage:remote-read-replicas.adoc + description: | + Enables remote clusters to read data stored in object storage for disaster recovery. + expiration: | + Remote Read Replica topics cannot be created or modified. + aliases: [RRR] + source: + kind: core-enum + value: cloud_storage + notes: Enforced under the cloud_storage license gate together with Tiered Storage, Topic Recovery, and Whole Cluster Restore. + glossary-term: Remote Read Replica + + - name: Role-Based Access Control (RBAC) + scope: redpanda + xref: manage:security/authorization/rbac.adoc + description: | + Manages user roles and permissions within the cluster. + expiration: | + Roles and ACLs associated with roles cannot be created or modified. Role deletion is allowed. + aliases: [rbac, Role-Based Access Control] + source: + kind: core-enum + value: rbac + + - name: Schema Registry Authorization + scope: redpanda + xref: manage:schema-reg/schema-reg-authorization.adoc + description: | + Manages ACLs for Redpanda Schema Registry resources within the cluster. + expiration: | + You can no longer enable `schema_registry_enable_authorization`, nor can you create or modify schema ACLs. + source: + kind: core-property + value: schema_registry_enable_authorization + gating-property: schema_registry_enable_authorization + notes: Enterprise-wrapped property with no license_required_feature enum value. + + - name: Server-Side Schema ID Validation + scope: redpanda + xref: manage:schema-reg/schema-id-validation.adoc + description: | + Validates schema IDs server-side to ensure schema compatibility. With schema ID validation, records associated with unregistered schemas are detected and dropped by a broker rather than a consumer. + expiration: | + Topics with schema validation settings cannot be created or modified. + aliases: [schema_id_validation, Schema ID Validation] + source: + kind: core-enum + value: schema_id_validation + gating-property: enable_schema_id_validation + + - name: Shadowing + scope: redpanda + xref: deploy:redpanda/manual/disaster-recovery/shadowing/index.adoc + description: | + Provides enterprise-grade disaster recovery through asynchronous, offset-preserving replication between distinct Redpanda clusters for cross-region data protection. + expiration: | + New shadow links cannot be created. Existing shadow links continue operating and can be updated. + aliases: [shadow_linking, Shadow Linking] + source: + kind: core-enum + value: shadow_linking + gating-property: enable_shadow_linking + + - name: Topic Deletion Control + scope: redpanda + description: | + When set to `false`, prevents all users, including superusers, from deleting topics through the Kafka DeleteTopics API. This property provides a cluster-wide safety guard against accidental topic deletion. + expiration: | + Topic deletion reverts to enabled (`true`). + aliases: [topic_deletion_disabled] + show-gating-property: true + source: + kind: core-enum + value: topic_deletion_disabled + gating-property: delete_topic_enable + notes: No dedicated feature page; the table renders the name without a link. + + - name: Topic Recovery + scope: redpanda + xref: manage:topic-recovery.adoc + description: | + Allows restoring a single topic from Tiered Storage using remote recovery properties. + expiration: | + You cannot create topics with the `redpanda.remote.recovery=true` property or perform topic recovery operations. To proceed, add a valid license to the target cluster. Without a valid license, topic recovery is blocked. + source: + kind: core-enum + value: cloud_storage + notes: Enforced under the cloud_storage license gate together with Tiered Storage, Remote Read Replicas, and Whole Cluster Restore. + + - name: Tiered Storage + scope: redpanda + xref: manage:tiered-storage.adoc + description: | + Enables data storage in cloud object storage for long-term retention and retrieval. + expiration: | + Topics cannot be created or modified to enable Tiered Storage features. Additional partitions cannot be added to topics with Tiered Storage properties enabled. + aliases: [cloud_storage] + source: + kind: core-enum + value: cloud_storage + gating-property: cloud_storage_enabled + glossary-term: Tiered Storage + + - name: Whole Cluster Restore (WCR) + scope: redpanda + xref: manage:whole-cluster-restore.adoc + description: | + Enables the recovery of cluster data from a source cluster's snapshot. + expiration: | + If the license is expired, you cannot perform WCR. To proceed, add a valid license to the target cluster. If the source cluster has an expired license, the target cluster inherits the restriction until a valid license is applied. + aliases: [WCR, Whole Cluster Restore] + source: + kind: core-enum + value: cloud_storage + notes: Enforced under the cloud_storage license gate together with Tiered Storage, Remote Read Replicas, and Topic Recovery. + + # ----------------------------------------------------------------- console + - name: Authentication for Redpanda Console + scope: console + xref: console:config/security/authentication.adoc + description: | + Enables authentication for Redpanda Console, including secure login through OIDC and OAuth 2.0 SSO. + expiration: | + All pages are redirected to the license expiration landing page, and all other access is restricted. + source: + kind: manual + value: Enforced by the Console license service; Console has no machine-readable enterprise feature list. + + - name: Authorization (RBAC) for Redpanda Console + scope: console + xref: console:config/security/authorization.adoc + description: | + Manages user roles and permissions for accessing features within Redpanda and Redpanda Console. + expiration: | + All pages are redirected to the license expiration landing page, and all other access is restricted. + aliases: [Authorization (RBAC) for Redpanda] + source: + kind: manual + value: Enforced by the Console license service; Console has no machine-readable enterprise feature list. + + - name: Debug bundle generation + scope: console + xref: console:ui/generate-bundle.adoc + description: | + Enables generating and downloading debug bundles in Redpanda Console for comprehensive cluster diagnostics. + expiration: | + All pages are redirected to the license expiration landing page, and all other access is restricted. + source: + kind: manual + value: Enforced by the Console license service; Console has no machine-readable enterprise feature list. + + - name: Reassign Partitions + scope: console + description: | + Enables the ability to move partitions between brokers. + expiration: | + All pages are redirected to the license expiration landing page, and all other access is restricted. + source: + kind: manual + value: Enforced by the Console license service; Console has no machine-readable enterprise feature list. + notes: No dedicated feature page; the table renders the name without a link. + + # ----------------------------------------------------------------- connect + - name: Allow or deny lists + scope: connect + xref: connect:configuration:allow_and_deny_lists.adoc + description: | + Limit the Redpanda Connect components that users can run within data pipelines on a Redpanda Connect instance. + expiration: | + No change. + source: + kind: manual + value: Enforced by CheckRunningEnterprise call sites in connect; no central Go-level feature list. + + - name: Enterprise connectors + scope: connect + url: https://docs.redpanda.com/redpanda-connect/components/catalog/?support=enterprise + description: | + Additional inputs, outputs, and processors available only to enterprise customers. + expiration: | + All enterprise connectors are blocked. + source: + kind: manual + value: Aggregate entry; individual connectors are tracked by the support column in connect internal/plugins/info.csv. + + - name: FIPS compliance for Redpanda Connect + scope: connect + xref: connect:get-started:quickstarts/rpk.adoc#fips-compliance + description: | + Run Redpanda Connect using a FIPS-compliant version of `rpk`, the Redpanda command-line interface (CLI). + expiration: | + No change. + source: + kind: manual + value: Enforced through the FIPS-compliant rpk distribution. + notes: Renamed from the ambiguous "FIPS compliance" to avoid colliding with the Redpanda-scope FIPS Compliance entry. + + - name: Redpanda Connect configuration service + scope: connect + xref: connect:components:redpanda/about.adoc + description: | + A configuration block that you can use to send logs and status events to a topic on a Redpanda cluster. + expiration: | + No change. + source: + kind: manual + value: Enforced by CheckRunningEnterprise call sites in connect; no central Go-level feature list. + + - name: Secrets management + scope: connect + xref: connect:configuration:secrets.adoc#look-up-secrets-on-a-remote-system-at-runtime + description: | + Retrieve secrets values from a remote system, such as a secret management solution, without setting environment variables. + expiration: | + No change. + source: + kind: manual + value: Enforced by CheckRunningEnterprise call sites in connect; no central Go-level feature list. + + # ---------------------------------------------------------------- operator + - name: Stretch Clusters + scope: operator + xref: deploy:redpanda/kubernetes/k-stretch-clusters.adoc + description: | + A single logical Redpanda cluster distributed across multiple Kubernetes clusters for multi-region high availability, managed by the multicluster Redpanda Operator. + expiration: | + The multicluster operator requires a valid license to start, so stretch clusters cannot be deployed or managed without one. On a running stretch cluster, the operator continuously reports license state through the StretchCluster resource's `LicenseValid` status condition and `status.licenseStatus`, including the expiration date and any enterprise features in violation. When the license expires, the stretch cluster keeps running and its brokers' enterprise features follow the restrictions in <>. + aliases: [StretchCluster] + source: + kind: manual + value: License gate in operator cmd/multicluster (ReadLicense; "Operator requires enterprise license"). + notes: Feature name suffix "(StretchCluster resource)" is rendered from feature-suffix. + feature-suffix: (StretchCluster resource) + + - name: Redpanda Connect pipelines + scope: operator + xref: manage:kubernetes/k-connect-pipelines.adoc + description: | + Run Redpanda Connect pipelines declaratively through the operator's Connect controller. Requires a license that includes the Redpanda Connect product. + expiration: | + When the license is missing, expired, invalid, or does not include the Redpanda Connect product, the operator stops creating and updating pipeline workloads: new Pipeline resources report `License: False` in their status and are never deployed, and existing pipelines keep running with their last-applied configuration but no longer receive updates. Applying a valid license resumes reconciliation automatically, without recreating any Pipeline resources. + aliases: [Pipeline resource] + source: + kind: manual + value: License gate in operator internal/controller/pipeline (license does not allow enterprise features). + notes: Beta badge and "(Pipeline resource)" suffix are rendered from feature-suffix. + feature-suffix: (Pipeline resource) badge::[label=beta] diff --git a/shared/modules/ROOT/partials/global-attributes.yml b/shared/modules/ROOT/partials/global-attributes.yml new file mode 100644 index 0000000000..cb52795c25 --- /dev/null +++ b/shared/modules/ROOT/partials/global-attributes.yml @@ -0,0 +1,32 @@ +# Disable default hightlight.js so we can use Prism.js +source-highlighter: ~ +# Sync tab groups +tabs-sync-option: true +idprefix: '' +idseparator: '-' +# Next and previous links +page-pagination: true +table-stripes: even +# kbd macro +experimental: true +# Create tooltips for glossterm definitions +glossary-tooltip: 'data-tippy-content' +# Product names for single-sourced content +streaming-product-name: Redpanda Streaming +cloud-product-name: Redpanda Cloud +# Aliases for backwards compatibility (prefer explicit names above) +product-name: Redpanda Streaming +# Fallback version for Redpanda Console +latest-console-version: 2.7.1 +badge-gauge: 'image:https://img.shields.io/badge/Type-Gauge-brightgreen.svg[]' +badge-histogram: 'image:https://img.shields.io/badge/Type-Histogram-brightgreen.svg[]' +badge-counter: 'image:https://img.shields.io/badge/Type-Counter-brightgreen.svg[]' +badge-perf-iops: 'image:https://img.shields.io/badge/Performance-IOPS-yellow.svg[]' +badge-perf-storage: 'image:https://img.shields.io/badge/Performance-Storage-yellow.svg[]' +badge-deprecated: 'image:https://img.shields.io/badge/-Deprecated-red.svg[]' +badge-tech-preview: 'image:https://img.shields.io/badge/Technical%20Preview-Version%2023.2.x-red.svg[Technical Preview]' +badge-cloud-beta: 'image:https://img.shields.io/badge/Beta-red.svg[Beta]' +page-beta-text: 'This is a beta feature. Beta features are available for testing and feedback. They are not supported by Redpanda and should not be used in production environments.' +page-limited-availability-text: 'This feature has limited availability. Contact Redpanda Support for access.' +page-byoc-text: 'This feature is available only on BYOC clusters.' +page-cloud-only-text: 'This feature is available only on Redpanda Cloud.' diff --git a/shared/modules/ROOT/partials/valid-categories.yml b/shared/modules/ROOT/partials/valid-categories.yml new file mode 100644 index 0000000000..9b5ea1306a --- /dev/null +++ b/shared/modules/ROOT/partials/valid-categories.yml @@ -0,0 +1,89 @@ +page-valid-categories: + - category: 'rpk' + definition: 'Command-line tool for Redpanda administration and management. Includes topics related to configuring and using the rpk tool.' + + - category: 'Development' + definition: 'Building, testing, and maintaining applications and services that use Redpanda.' + subcategories: + - category: 'Clients' + definition: 'Using various client libraries to interact with Redpanda in different programming languages.' + - category: 'Stream Processing' + definition: 'Processing streaming data using Redpanda, including transformations, aggregations, and stateful processing.' + related: ['flink'] + - category: 'Data Transforms' + definition: 'Processing streaming data using Redpanda, including transformations, aggregations, and stateful processing.' + related: ['wasm'] + - category: 'Benchmarking' + definition: 'Measuring and evaluating the performance of Redpanda under various conditions and workloads. Benchmarking covers performance testing, throughput, and latency measurement, and optimizing configurations for maximum efficiency.' + + - category: 'Deployment' + definition: 'Deploying Redpanda in various environments such as Docker, Kubernetes, or Redpanda Cloud.' + subcategories: + - category: 'Iceberg' + definition: 'Covers the integration of Redpanda with Apache Iceberg for table formats, enabling advanced data lake use cases like schema evolution, partitioning, and ACID guarantees.' + - category: 'Tiered Storage' + definition: 'Topics and configurations related to Tiered Storage in Redpanda, enabling long-term data retention and seamless access using cloud or object storage solutions.' + - category: 'Integration' + definition: 'Integrating Redpanda with other systems and platforms, such as databases, message queues, or cloud services.' + - category: 'Architecture' + definition: 'Designing deployment architectures such as event-driven patterns and inter-service communication.' + - category: 'GitOps' + definition: 'Managing and automating the deployment and operation of software applications using Git as the source of truth. This category includes examples and best practices for deploying and managing Redpanda clusters and configurations using GitOps tools and methodologies.' + + - category: 'Management' + definition: 'Performing operational tasks such as scaling, upgrades, and backups.' + related: ['day2ops'] + subcategories: + - category: 'Security' + definition: 'Implementing security features such as SSL/TLS encryption, SASL authentication, and ACLs with Redpanda.' + - category: 'Networking' + definition: 'Configuring and managing network settings, protocols, and performance optimization for Redpanda. This includes internal communication between brokers, client connectivity, and integration with external systems.' + - category: 'Monitoring' + definition: 'Observing and analyzing operational metrics and logs. This category covers the tools, techniques, and best practices for effectively tracking the health, performance, and reliability of Redpanda clusters.' + related: ['grafana', 'prometheus'] + - category: 'Scaling' + definition: 'Strategies and best practices for scaling Redpanda clusters to handle increased workloads.' + + - category: 'Upgrades' + definition: 'Upgrading Redpanda software and systems.' + subcategories: + - category: 'Migration' + definition: 'Migrating from older versions of Redpanda.' + - category: 'Rollback' + definition: 'Procedures for rolling back Redpanda upgrades in case of issues.' + + - category: 'Kafka Compatibility' + definition: 'Highlighting Kafka API compatibility in Redpanda, showing how existing Kafka applications can work with Redpanda.' + subcategories: + - category: 'Kafka Migration' + definition: 'Migrating from Kafka to Redpanda.' + - category: 'Feature Comparison' + definition: 'Comparing features and capabilities between Kafka and Redpanda.' + + - category: 'Troubleshooting' + definition: 'Troubleshooting common issues and errors encountered while working with Redpanda.' + + - category: 'Redpanda Console' + definition: 'Covers the use, configuration, and features of the Redpanda Console, a web-based UI for managing and monitoring Redpanda clusters. This includes dashboard customization, security settings, user management, and integration with other services.' + + - category: 'High Availability' + definition: 'Exploring strategies, configurations, and practices for achieving high availability in Redpanda deployments. This includes redundancy, failover mechanisms, replication, and other techniques to ensure continuous operation and data durability.' + subcategories: + - category: 'Data Replication' + definition: 'Mechanisms and strategies for data replication across nodes and clusters, ensuring data integrity and availability even in the event of hardware or network issues.' + - category: 'Failover and Recovery' + definition: 'Procedures and tools for automatic failover and recovery in case of outages, including how to minimize downtime and data loss.' + - category: 'Disaster Recovery' + definition: 'Planning and implementing disaster recovery strategies, including backup and restore practices, to recover from significant system-wide failures.' + + - category: 'Schema Registry' + definition: 'Covers the setup, configuration, and usage of the Schema Registry with Redpanda to manage schema versions, compatibility, and serialization formats.' + + - category: 'Streaming' + definition: 'End-to-end design, optimization, and operation of real-time streaming systems built on Redpanda, including data ingestion patterns, throughput tuning, serialization formats, and end-to-end streaming architectures.' + + - category: 'Emergency Response' + definition: 'Operational practices, guidelines, and emergency procedures for responding to severe outages, data loss events, or infrastructure failures affecting Redpanda clusters, including incident handling and continuity planning.' + + - category: 'Agentic Data Plane' + definition: 'Building AI agents and applications using the Redpanda Agentic Data Plane, including the AI Gateway, MCP servers, and dynamic tool discovery.' diff --git a/shared/modules/terms/partials/LA.adoc b/shared/modules/terms/partials/LA.adoc new file mode 100644 index 0000000000..0f0b6fc515 --- /dev/null +++ b/shared/modules/terms/partials/LA.adoc @@ -0,0 +1,4 @@ +=== limited availability +:term-name: LA +:hover-text: Features in limited availability (LA) are production-ready and are covered by Redpanda Support for early adopters. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/a2a-protocol.adoc b/shared/modules/terms/partials/a2a-protocol.adoc new file mode 100644 index 0000000000..5d25f3912e --- /dev/null +++ b/shared/modules/terms/partials/a2a-protocol.adoc @@ -0,0 +1,6 @@ +=== Agent2Agent (A2A) protocol +:term-name: Agent2Agent (A2A) protocol +:hover-text: Communication protocol that enables AI agents to discover, coordinate with, and delegate tasks to other agents in a distributed system. +:category: Agentic Data Plane + +The A2A protocol allows agents to work together by sharing capabilities, coordinating workflows, and distributing complex tasks across multiple specialized agents. It provides standardized messaging, capability discovery, and task delegation mechanisms for multi-agent systems. diff --git a/shared/modules/terms/partials/acl.adoc b/shared/modules/terms/partials/acl.adoc new file mode 100644 index 0000000000..41db2922db --- /dev/null +++ b/shared/modules/terms/partials/acl.adoc @@ -0,0 +1,4 @@ +=== access control list (ACL) +:term-name: ACL +:hover-text: A security feature used to define and enforce granular permissions to resources, ensuring only authorized users or applications can perform specific operations. ACLs act on principals. +:category: Redpanda security diff --git a/shared/modules/terms/partials/admin-api.adoc b/shared/modules/terms/partials/admin-api.adoc new file mode 100644 index 0000000000..09f0955fc0 --- /dev/null +++ b/shared/modules/terms/partials/admin-api.adoc @@ -0,0 +1,10 @@ +=== Admin API +:term-name: Admin API +:hover-text: A REST API used to manage and monitor Redpanda Self-Managed clusters. It uses the default port 9644. +:category: Redpanda features + +ifndef::env-cloud[] +For more information about using this API with Self-Managed Redpanda, see link:/api/doc/admin[]. +endif::[] + +Note: The Redpanda Admin API is different from the https://kafka.apache.org/documentation/#adminapi[Kafka Admin API]. diff --git a/shared/modules/terms/partials/adp.adoc b/shared/modules/terms/partials/adp.adoc new file mode 100644 index 0000000000..9a2678fe13 --- /dev/null +++ b/shared/modules/terms/partials/adp.adoc @@ -0,0 +1,6 @@ +=== Agentic Data Plane +:term-name: Agentic Data Plane +:hover-text: Infrastructure layer that enables AI agents to discover, connect to, and interact with data sources and tools through standardized protocols. +:category: Agentic Data Plane + +The Agentic Data Plane provides the underlying infrastructure for AI agents to access streaming data, invoke tools, and coordinate operations across distributed systems using protocols like MCP and A2A. diff --git a/shared/modules/terms/partials/advertised-listener.adoc b/shared/modules/terms/partials/advertised-listener.adoc new file mode 100644 index 0000000000..a508857a1b --- /dev/null +++ b/shared/modules/terms/partials/advertised-listener.adoc @@ -0,0 +1,4 @@ +=== advertised listener +:term-name: advertised listener +:hover-text: The address a Redpanda broker broadcasts to producers, consumers, and other brokers. It specifies the hostname and port for connections to different listeners. Clients and other brokers use advertised listeners to connect to services such as the Admin API, Kafka API, and HTTP Proxy API. The advertised address might differ from the listener address in scenarios where brokers are behind a NAT, in a Docker container, or in Kubernetes. Advertised addresses ensure clients can reach the Redpanda brokers even in complex network setups. +:category: Redpanda security \ No newline at end of file diff --git a/shared/modules/terms/partials/ai-agent.adoc b/shared/modules/terms/partials/ai-agent.adoc new file mode 100644 index 0000000000..cc06428ac6 --- /dev/null +++ b/shared/modules/terms/partials/ai-agent.adoc @@ -0,0 +1,6 @@ +=== AI agent +:term-name: AI agent +:hover-text: A system built around a large language model (LLM) that interprets user intent, selects the right tools, and chains multiple steps into a workflow. +:category: Agentic Data Plane + +AI agents can understand natural language instructions, reason about tasks, invoke tools through MCP servers, and coordinate multiple operations to accomplish complex workflows. diff --git a/shared/modules/terms/partials/ai-gateway.adoc b/shared/modules/terms/partials/ai-gateway.adoc new file mode 100644 index 0000000000..35794ee6e3 --- /dev/null +++ b/shared/modules/terms/partials/ai-gateway.adoc @@ -0,0 +1,4 @@ +=== AI Gateway +:term-name: AI Gateway +:hover-text: A unified entry point for AI traffic that provides LLM routing, MCP tool aggregation, cost controls, and observability across multiple LLM providers. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/ai-token.adoc b/shared/modules/terms/partials/ai-token.adoc new file mode 100644 index 0000000000..36d96d4ed0 --- /dev/null +++ b/shared/modules/terms/partials/ai-token.adoc @@ -0,0 +1,6 @@ +=== AI token +:term-name: AI token +:hover-text: A credential used specifically for authenticating AI agents and authorizing their access to resources in agentic systems. +:category: Agentic Data Plane + +AI tokens are specialized authentication credentials for AI agents, distinct from bearer tokens used in traditional API authentication. They enable agents to authenticate with MCP servers and access data plane resources while maintaining audit trails of agent operations. diff --git a/shared/modules/terms/partials/authentication.adoc b/shared/modules/terms/partials/authentication.adoc new file mode 100644 index 0000000000..7908519986 --- /dev/null +++ b/shared/modules/terms/partials/authentication.adoc @@ -0,0 +1,4 @@ +=== authentication +:term-name: authentication +:hover-text: The process of verifying the identity of a principal, user, or service account. Also known as AuthN. +:category: Redpanda security diff --git a/shared/modules/terms/partials/authorization.adoc b/shared/modules/terms/partials/authorization.adoc new file mode 100644 index 0000000000..1811fe75eb --- /dev/null +++ b/shared/modules/terms/partials/authorization.adoc @@ -0,0 +1,4 @@ +=== authorization +:term-name: authorization +:hover-text: The process of specifying access rights to resources. Access rights are enforced through roles or access control lists (ACLs). Also known as AuthZ. +:category: Redpanda security diff --git a/shared/modules/terms/partials/az.adoc b/shared/modules/terms/partials/az.adoc new file mode 100644 index 0000000000..5191996f4d --- /dev/null +++ b/shared/modules/terms/partials/az.adoc @@ -0,0 +1,4 @@ +=== availability zone (AZ) +:term-name: availability zones +:hover-text: One or more data centers served by high-bandwidth links with low latency, typically within a close distance of one another. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/bearer-token.adoc b/shared/modules/terms/partials/bearer-token.adoc new file mode 100644 index 0000000000..e9d46501fc --- /dev/null +++ b/shared/modules/terms/partials/bearer-token.adoc @@ -0,0 +1,4 @@ +=== bearer token +:term-name: bearer token +:hover-text: An access token used for authentication and authorization in web applications and APIs. It holds user credentials, usually in the form of random strings of characters. +:category: Redpanda security diff --git a/shared/modules/terms/partials/beta.adoc b/shared/modules/terms/partials/beta.adoc new file mode 100644 index 0000000000..761dc7e9fb --- /dev/null +++ b/shared/modules/terms/partials/beta.adoc @@ -0,0 +1,4 @@ +=== beta +:term-name: beta +:hover-text: Features in beta are available for testing and feedback. They are not supported by Redpanda and should not be used in production environments. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/broker.adoc b/shared/modules/terms/partials/broker.adoc new file mode 100644 index 0000000000..59004b5098 --- /dev/null +++ b/shared/modules/terms/partials/broker.adoc @@ -0,0 +1,8 @@ +=== broker +:term-name: broker +:hover-text: An instance of Redpanda that stores and manages event streams. Multiple brokers join together to form a Redpanda cluster. +:category: Redpanda core + +Sometimes used interchangeably with node, but a node is typically a physical or virtual server. + +See also: node \ No newline at end of file diff --git a/shared/modules/terms/partials/byoc.adoc b/shared/modules/terms/partials/byoc.adoc new file mode 100644 index 0000000000..6946b2ac4e --- /dev/null +++ b/shared/modules/terms/partials/byoc.adoc @@ -0,0 +1,4 @@ +=== BYOC +:term-name: BYOC +:hover-text: Bring Your Own Cloud (BYOC) is a fully-managed Redpanda Cloud deployment where clusters run in your private cloud, so all data is contained in your own environment. Redpanda handles provisioning, operations, and maintenance. +:category: Redpanda Cloud diff --git a/shared/modules/terms/partials/byovnet.adoc b/shared/modules/terms/partials/byovnet.adoc new file mode 100644 index 0000000000..c18dc5d2c3 --- /dev/null +++ b/shared/modules/terms/partials/byovnet.adoc @@ -0,0 +1,4 @@ +=== BYOVNet +:term-name: BYOVNet +:hover-text: A Bring Your Own Virtual Network (BYOVNet) cluster allows you to deploy the Redpanda data plane into your existing Azure VNet to fully manage the networking lifecycle. Compared to standard BYOC, BYOVNet provides more security, but the configuration is more complex. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/byovpc.adoc b/shared/modules/terms/partials/byovpc.adoc new file mode 100644 index 0000000000..7016691359 --- /dev/null +++ b/shared/modules/terms/partials/byovpc.adoc @@ -0,0 +1,4 @@ +=== BYOVPC +:term-name: BYOVPC +:hover-text: A Bring Your Own Virtual Private Cloud (BYOVPC) cluster allows you to deploy the Redpanda data plane into your existing VPC on AWS or GCP to fully manage the networking lifecycle. Compared to standard BYOC, BYOVPC provides more security, but the configuration is more complex. +:category: Redpanda Cloud diff --git a/shared/modules/terms/partials/cert-manager.adoc b/shared/modules/terms/partials/cert-manager.adoc new file mode 100644 index 0000000000..ac5bfb8ec6 --- /dev/null +++ b/shared/modules/terms/partials/cert-manager.adoc @@ -0,0 +1,6 @@ +=== cert-manager +:term-name: cert-manager +:hover-text: A Kubernetes controller that simplifies the process of obtaining, renewing, and using certificates. +:link: https://cert-manager.io/docs/ +:category: Redpanda in Kubernetes + diff --git a/shared/modules/terms/partials/client.adoc b/shared/modules/terms/partials/client.adoc new file mode 100644 index 0000000000..dd79b40417 --- /dev/null +++ b/shared/modules/terms/partials/client.adoc @@ -0,0 +1,6 @@ +=== client +:term-name: client +:hover-text: A producer application that writes events to Redpanda, or a consumer application that reads events from Redpanda. +:category: Redpanda core + +This could also be a client library, like librdkafka or franz-go. \ No newline at end of file diff --git a/shared/modules/terms/partials/cloud-topic.adoc b/shared/modules/terms/partials/cloud-topic.adoc new file mode 100644 index 0000000000..edb0834b49 --- /dev/null +++ b/shared/modules/terms/partials/cloud-topic.adoc @@ -0,0 +1,5 @@ +=== Cloud Topic +:term-name: Cloud Topic +:hover-text: A Redpanda topic type, Cloud Topics use object storage (S3, GCS, or MinIO) as the primary data store (rather than replicating data across brokers). Unlike standard Redpanda topics, Cloud Topics allow users with flexible latency requirements to lower or eliminate costs associated with cross-AZ networking. +:category: Redpanda features + diff --git a/shared/modules/terms/partials/cluster.adoc b/shared/modules/terms/partials/cluster.adoc new file mode 100644 index 0000000000..ea824d7e95 --- /dev/null +++ b/shared/modules/terms/partials/cluster.adoc @@ -0,0 +1,4 @@ +=== cluster +:term-name: cluster +:hover-text: One or more brokers that work together to manage real-time data streaming, processing, and storage. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/community.adoc b/shared/modules/terms/partials/community.adoc new file mode 100644 index 0000000000..10fb9e9750 --- /dev/null +++ b/shared/modules/terms/partials/community.adoc @@ -0,0 +1,4 @@ +=== Redpanda Community Edition +:term-name: Redpanda Community Edition +:hover-text: Redpanda software that is available under the Redpanda Business Source License (BSL). These core features are free and source-available. +:category: Redpanda licenses \ No newline at end of file diff --git a/shared/modules/terms/partials/compaction.adoc b/shared/modules/terms/partials/compaction.adoc new file mode 100644 index 0000000000..fd36aa4f86 --- /dev/null +++ b/shared/modules/terms/partials/compaction.adoc @@ -0,0 +1,4 @@ +=== compaction +:term-name: compaction +:hover-text: Feature that retains the latest value for each key within a partition while discarding older values. +:category: Redpanda features diff --git a/shared/modules/terms/partials/connector.adoc b/shared/modules/terms/partials/connector.adoc new file mode 100644 index 0000000000..7d5d602202 --- /dev/null +++ b/shared/modules/terms/partials/connector.adoc @@ -0,0 +1,4 @@ +=== connector +:term-name: connector +:hover-text: Enables Redpanda to integrate with external systems, such as databases. +:category: Redpanda Cloud diff --git a/shared/modules/terms/partials/consumer-group.adoc b/shared/modules/terms/partials/consumer-group.adoc new file mode 100644 index 0000000000..720c1c5404 --- /dev/null +++ b/shared/modules/terms/partials/consumer-group.adoc @@ -0,0 +1,4 @@ +=== consumer group +:term-name: consumer group +:hover-text: A set of consumers that cooperate to read data for better scalability. As group members arrive and leave, partitions are re-assigned so each member receives a proportional share. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/consumer-offset.adoc b/shared/modules/terms/partials/consumer-offset.adoc new file mode 100644 index 0000000000..08afab7156 --- /dev/null +++ b/shared/modules/terms/partials/consumer-offset.adoc @@ -0,0 +1,4 @@ +=== consumer offset +:term-name: consumer offset +:hover-text: The position of a consumer in a specific topic partition, to track which records they have read. A consumer offset of 3 means it has read messages 0-2 and will next read message 3. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/consumer.adoc b/shared/modules/terms/partials/consumer.adoc new file mode 100644 index 0000000000..1542e16320 --- /dev/null +++ b/shared/modules/terms/partials/consumer.adoc @@ -0,0 +1,4 @@ +=== consumer +:term-name: consumer +:hover-text: A client application that subscribes to Redpanda topics to asynchronously read events. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/context-window.adoc b/shared/modules/terms/partials/context-window.adoc new file mode 100644 index 0000000000..bddcb4d354 --- /dev/null +++ b/shared/modules/terms/partials/context-window.adoc @@ -0,0 +1,6 @@ +=== context window +:term-name: context window +:hover-text: The maximum amount of text (measured in tokens) that an LLM can process in a single request. +:category: Agentic Data Plane + +The context window determines how much information an agent can consider at once, including the system prompt, conversation history, tool outputs, and retrieved documents. Larger context windows enable more sophisticated reasoning but may increase latency and cost. Common sizes range from 8K to 200K+ tokens. diff --git a/shared/modules/terms/partials/control-plane.adoc b/shared/modules/terms/partials/control-plane.adoc new file mode 100644 index 0000000000..6171e6aa8d --- /dev/null +++ b/shared/modules/terms/partials/control-plane.adoc @@ -0,0 +1,4 @@ +=== control plane +:term-name: control plane +:hover-text: This part of Redpanda Cloud enforces rules in the data plane, including cluster management, operations, and maintenance. +:category: Redpanda Cloud diff --git a/shared/modules/terms/partials/controller-broker.adoc b/shared/modules/terms/partials/controller-broker.adoc new file mode 100644 index 0000000000..95d996e60e --- /dev/null +++ b/shared/modules/terms/partials/controller-broker.adoc @@ -0,0 +1,4 @@ +=== controller broker +:term-name: controller broker +:hover-text: A broker that manages operational metadata for a Redpanda cluster and ensures replicas are distributed among brokers. At any given time, one active controller exists in a cluster. If the controller fails, another broker is automatically elected as the controller. +:category: Redpanda core diff --git a/shared/modules/terms/partials/controller-snapshot.adoc b/shared/modules/terms/partials/controller-snapshot.adoc new file mode 100644 index 0000000000..68bb2568f1 --- /dev/null +++ b/shared/modules/terms/partials/controller-snapshot.adoc @@ -0,0 +1,4 @@ +=== controller snapshot +:term-name: controller snapshot +:hover-text: Snapshot of the current cluster metadata state saved to disk, so broker startup is fast. +:category: Redpanda features \ No newline at end of file diff --git a/shared/modules/terms/partials/data-plane.adoc b/shared/modules/terms/partials/data-plane.adoc new file mode 100644 index 0000000000..c3b8afbfaa --- /dev/null +++ b/shared/modules/terms/partials/data-plane.adoc @@ -0,0 +1,4 @@ +=== data plane +:term-name: data plane +:hover-text: This part of Redpanda Cloud contains Redpanda clusters and other components, such as Redpanda Console, Redpanda Operator, and `rpk`. It is managed by an agent that receives cluster specifications from the control plane. Sometimes used interchangeably with clusters. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/data-sovereignty.adoc b/shared/modules/terms/partials/data-sovereignty.adoc new file mode 100644 index 0000000000..61e72d7964 --- /dev/null +++ b/shared/modules/terms/partials/data-sovereignty.adoc @@ -0,0 +1,6 @@ +=== data sovereignty +:term-name: data sovereignty +:hover-text: Containing all your data in your environment. +:category: Redpanda Cloud + +With BYOC, Redpanda handles provisioning, monitoring, and upgrades, but you manage your streaming data without Redpanda's control plane ever seeing it. Additionally, with BYOVPC, the Redpanda Cloud agent doesn't create any new resources or alter any settings in your account. \ No newline at end of file diff --git a/shared/modules/terms/partials/data-stream.adoc b/shared/modules/terms/partials/data-stream.adoc new file mode 100644 index 0000000000..92aa90aaf5 --- /dev/null +++ b/shared/modules/terms/partials/data-stream.adoc @@ -0,0 +1,4 @@ +=== data stream +:term-name: data stream +:hover-text: A continuous flow of events in real time that are produced and consumed by client applications. Redpanda is a data streaming platform. Also known as event stream. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/data-transforms.adoc b/shared/modules/terms/partials/data-transforms.adoc new file mode 100644 index 0000000000..c240f389ca --- /dev/null +++ b/shared/modules/terms/partials/data-transforms.adoc @@ -0,0 +1,4 @@ +=== data transforms +:term-name: data transforms +:hover-text: Framework to manipulate or enrich data written to Redpanda topics. You can develop custom data functions, which run asynchronously using a WebAssembly (Wasm) engine inside a Redpanda broker. +:category: Redpanda features diff --git a/shared/modules/terms/partials/declarative-agent.adoc b/shared/modules/terms/partials/declarative-agent.adoc new file mode 100644 index 0000000000..2404d90f48 --- /dev/null +++ b/shared/modules/terms/partials/declarative-agent.adoc @@ -0,0 +1,4 @@ +=== declarative agent +:term-name: declarative agent +:hover-text: An AI agent that runs in Redpanda's managed runtime, where you configure its behavior (LLM, system prompt, and attached tools) instead of writing agent code. Contrast with a self-managed agent, which you build and run in your own runtime. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/dedicated.adoc b/shared/modules/terms/partials/dedicated.adoc new file mode 100644 index 0000000000..7692cf22e1 --- /dev/null +++ b/shared/modules/terms/partials/dedicated.adoc @@ -0,0 +1,4 @@ +=== Dedicated Cloud +:term-name: Dedicated Cloud +:hover-text: A fully-managed Redpanda Cloud deployment option where you host your data in Redpanda's VPC, and Redpanda handles provisioning, operations, and maintenance. Dedicated clusters are single-tenant deployments that support private networking (for example, VPC peering to talk over private IPs) for better data isolation. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/enterprise.adoc b/shared/modules/terms/partials/enterprise.adoc new file mode 100644 index 0000000000..dd1bc6b625 --- /dev/null +++ b/shared/modules/terms/partials/enterprise.adoc @@ -0,0 +1,4 @@ +=== Redpanda Enterprise Edition +:term-name: Redpanda Enterprise Edition +:hover-text: Redpanda software that is available under the Redpanda Community License (RCL). It includes the free features licensed with the Redpanda Community Edition, as well enterprise features, such as Tiered Storage, Remote Read Replicas, and Continuous Data Balancing. +:category: Redpanda licenses \ No newline at end of file diff --git a/shared/modules/terms/partials/event.adoc b/shared/modules/terms/partials/event.adoc new file mode 100644 index 0000000000..a3e0f55339 --- /dev/null +++ b/shared/modules/terms/partials/event.adoc @@ -0,0 +1,4 @@ +=== event +:term-name: event +:hover-text: A record of something changing state at a specific time. Events can be generated by various sources, including sensors, applications, and devices. Producers write events to Redpanda, and consumers read events from Redpanda. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/frontier-model.adoc b/shared/modules/terms/partials/frontier-model.adoc new file mode 100644 index 0000000000..eca4536a76 --- /dev/null +++ b/shared/modules/terms/partials/frontier-model.adoc @@ -0,0 +1,6 @@ +=== frontier model +:term-name: frontier model +:hover-text: The most advanced and capable AI models available, representing the current state-of-the-art in language understanding and reasoning. +:category: Agentic Data Plane + +Frontier models are cutting-edge large language models with exceptional reasoning, planning, and problem-solving capabilities. Examples include GPT-4, Claude 3, and Gemini Ultra. These models are commonly used to power sophisticated AI agents that require advanced decision-making and tool orchestration. diff --git a/shared/modules/terms/partials/gbac.adoc b/shared/modules/terms/partials/gbac.adoc new file mode 100644 index 0000000000..a8d5161698 --- /dev/null +++ b/shared/modules/terms/partials/gbac.adoc @@ -0,0 +1,6 @@ +=== GBAC +:term-name: GBAC +:hover-text: Group-based access control lets you manage Redpanda permissions at scale by assigning them to OIDC groups instead of individual users. +:category: Redpanda security + +GBAC lets you manage Redpanda permissions at scale using the groups that already exist in your identity provider (IdP). You define access once for a group and your IdP controls who belongs to it. You can grant permissions to groups in two ways: create ACLs with `Group:` principals, or assign groups as members of RBAC roles. Both approaches can be used independently or together. diff --git a/shared/modules/terms/partials/helm.adoc b/shared/modules/terms/partials/helm.adoc new file mode 100644 index 0000000000..5200fb90dc --- /dev/null +++ b/shared/modules/terms/partials/helm.adoc @@ -0,0 +1,4 @@ +=== Redpanda Helm chart +:term-name: Helm chart +:hover-text: Generates and applies all the manifest files you need for deploying Redpanda in Kubernetes. +:category: Redpanda in Kubernetes diff --git a/shared/modules/terms/partials/http-proxy.adoc b/shared/modules/terms/partials/http-proxy.adoc new file mode 100644 index 0000000000..4bc000e971 --- /dev/null +++ b/shared/modules/terms/partials/http-proxy.adoc @@ -0,0 +1,4 @@ +=== HTTP Proxy +:term-name: HTTP Proxy +:hover-text: Redpanda HTTP Proxy (pandaproxy) allows access to your data through a REST API. It is built into the Redpanda binary and uses the default port 8082. +:category: Redpanda features diff --git a/shared/modules/terms/partials/iceberg-catalog.adoc b/shared/modules/terms/partials/iceberg-catalog.adoc new file mode 100644 index 0000000000..0105e42cea --- /dev/null +++ b/shared/modules/terms/partials/iceberg-catalog.adoc @@ -0,0 +1,6 @@ +=== Iceberg catalog +:term-name: Iceberg catalog +:hover-text: A metadata service that tracks Apache Iceberg tables and their schemas. Redpanda supports REST catalogs (such as AWS Glue, GCP BigLake, Snowflake Open Catalog, or Databricks Unity Catalog) and filesystem-based catalogs. +:category: Redpanda core + +Redpanda SQL connects to a REST catalog with `CREATE ICEBERG CATALOG` to query the Iceberg-committed history of a topic. diff --git a/shared/modules/terms/partials/iceberg-mode.adoc b/shared/modules/terms/partials/iceberg-mode.adoc new file mode 100644 index 0000000000..11f7a78e0a --- /dev/null +++ b/shared/modules/terms/partials/iceberg-mode.adoc @@ -0,0 +1,4 @@ +=== Iceberg mode +:term-name: Iceberg mode +:hover-text: The Redpanda topic property (`redpanda.iceberg.mode`) that controls whether and how the topic's records are translated into an Apache Iceberg table. +:category: Redpanda core diff --git a/shared/modules/terms/partials/iceberg-topic.adoc b/shared/modules/terms/partials/iceberg-topic.adoc new file mode 100644 index 0000000000..3ef63b8a38 --- /dev/null +++ b/shared/modules/terms/partials/iceberg-topic.adoc @@ -0,0 +1,4 @@ +=== Iceberg topic +:term-name: Iceberg topic +:hover-text: A Redpanda topic with Iceberg integration enabled, so its data is also stored as an Apache Iceberg table that downstream analytical systems can read directly. Also called an Iceberg-enabled topic. +:category: Redpanda core diff --git a/shared/modules/terms/partials/iceberg-translation.adoc b/shared/modules/terms/partials/iceberg-translation.adoc new file mode 100644 index 0000000000..1f6cf7e784 --- /dev/null +++ b/shared/modules/terms/partials/iceberg-translation.adoc @@ -0,0 +1,4 @@ +=== Iceberg translation +:term-name: Iceberg translation +:hover-text: The background process that converts records on an Iceberg topic into Apache Iceberg format and commits them to the configured Iceberg catalog. +:category: Redpanda core diff --git a/shared/modules/terms/partials/idp.adoc b/shared/modules/terms/partials/idp.adoc new file mode 100644 index 0000000000..e986bc8523 --- /dev/null +++ b/shared/modules/terms/partials/idp.adoc @@ -0,0 +1,6 @@ +=== identity provider (IdP) +:term-name: identity provider (IdP) +:hover-text: A service that creates, maintains, and manages identity information while providing authentication services to applications. +:category: Redpanda security + +Identity providers authenticate users and issue tokens that applications can use to verify identity and access permissions. Common IdPs include Okta, Auth0, Azure AD, and Google Identity Platform. diff --git a/shared/modules/terms/partials/kafka-api.adoc b/shared/modules/terms/partials/kafka-api.adoc new file mode 100644 index 0000000000..09ba42707f --- /dev/null +++ b/shared/modules/terms/partials/kafka-api.adoc @@ -0,0 +1,4 @@ +=== Kafka API +:term-name: Kafka API +:hover-text: Producers and consumers interact with Redpanda using the Kafka API. It uses the default port 9092. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/leader-pinning.adoc b/shared/modules/terms/partials/leader-pinning.adoc new file mode 100644 index 0000000000..922bdb5913 --- /dev/null +++ b/shared/modules/terms/partials/leader-pinning.adoc @@ -0,0 +1,4 @@ +=== Leader Pinning +:term-name: Leader Pinning +:hover-text: Feature that places a topic's partition leaders in a preferred location, such as a cloud availability zone, to reduce networking costs and latency for nearby clients. +:category: Redpanda features diff --git a/shared/modules/terms/partials/learner.adoc b/shared/modules/terms/partials/learner.adoc new file mode 100644 index 0000000000..b2f381c916 --- /dev/null +++ b/shared/modules/terms/partials/learner.adoc @@ -0,0 +1,6 @@ +=== learner +:term-name: learner +:hover-text: A broker that is a follower in a Raft group but is not part of quorum. +:category: Redpanda core + +In a Raft group, a broker can be in learner status. Learners are followers that cannot vote and so do not count towards quorum (the majority). They cannot be elected to leader nor can they trigger leader elections. Brokers can be promoted or demoted between learner and voter. New Raft group members start as learners. diff --git a/shared/modules/terms/partials/listener.adoc b/shared/modules/terms/partials/listener.adoc new file mode 100644 index 0000000000..28c078a8e2 --- /dev/null +++ b/shared/modules/terms/partials/listener.adoc @@ -0,0 +1,4 @@ +=== listener +:term-name: listener +:hover-text: Configuration on a broker that defines how it should accept client or inter-broker connections. Each listener is associated with a specific protocol, hostname, and port combination. The listener defines where the broker should listen for incoming connections. +:category: Redpanda core diff --git a/shared/modules/terms/partials/llm.adoc b/shared/modules/terms/partials/llm.adoc new file mode 100644 index 0000000000..1bdd0eb7b4 --- /dev/null +++ b/shared/modules/terms/partials/llm.adoc @@ -0,0 +1,6 @@ +=== large language model (LLM) +:term-name: large language model (LLM) +:hover-text: An AI model trained on vast amounts of text data that can understand and generate human-like text, reason about tasks, and follow instructions. +:category: Agentic Data Plane + +Large language models power AI agents by providing natural language understanding, reasoning capabilities, and the ability to plan and execute complex tasks. LLMs interpret user requests, decide which tools to invoke, and synthesize responses based on retrieved data. diff --git a/shared/modules/terms/partials/log.adoc b/shared/modules/terms/partials/log.adoc new file mode 100644 index 0000000000..d1694511a3 --- /dev/null +++ b/shared/modules/terms/partials/log.adoc @@ -0,0 +1,8 @@ +=== log +:term-name: log +:hover-text: An ordered, append-only, immutable sequence of records. +:category: Redpanda core + +The log is Redpanda's core storage abstraction for event streams. At the conceptual level, topics represent replayable logs. Physically, each partition is implemented as a log file on disk, divided into segments. Redpanda uses the Raft consensus algorithm to coordinate writing data to log files and replicate them across brokers for fault tolerance. + +See also: topic, partition, segment diff --git a/shared/modules/terms/partials/maintenance-mode.adoc b/shared/modules/terms/partials/maintenance-mode.adoc new file mode 100644 index 0000000000..59d80bd850 --- /dev/null +++ b/shared/modules/terms/partials/maintenance-mode.adoc @@ -0,0 +1,4 @@ +=== maintenance mode +:term-name: maintenance mode +:hover-text: A state where a Redpanda broker temporarily doesn't take any partition leaderships. It continues to store data as a follower. This is usually done for system maintenance or a rolling upgrade. +:category: Redpanda features diff --git a/shared/modules/terms/partials/mcp-client.adoc b/shared/modules/terms/partials/mcp-client.adoc new file mode 100644 index 0000000000..0a6c74aee2 --- /dev/null +++ b/shared/modules/terms/partials/mcp-client.adoc @@ -0,0 +1,6 @@ +=== MCP client +:term-name: MCP client +:hover-text: An AI application or agent that connects to MCP servers to discover and invoke tools. +:category: Agentic Data Plane + +MCP clients use the Model Context Protocol to communicate with MCP servers, discovering available tools, understanding their capabilities, and invoking them with appropriate parameters. The client handles authentication, request formatting, and response processing. diff --git a/shared/modules/terms/partials/mcp-server.adoc b/shared/modules/terms/partials/mcp-server.adoc new file mode 100644 index 0000000000..68a52f470a --- /dev/null +++ b/shared/modules/terms/partials/mcp-server.adoc @@ -0,0 +1,6 @@ +=== MCP server +:term-name: MCP server +:hover-text: A service that exposes tools and resources using the Model Context Protocol, allowing AI agents to discover and invoke them. +:category: Agentic Data Plane + +MCP servers act as bridges between AI agents and external systems, providing standardized interfaces for tool discovery, invocation, and resource access. diff --git a/shared/modules/terms/partials/mcp-tool.adoc b/shared/modules/terms/partials/mcp-tool.adoc new file mode 100644 index 0000000000..cdab2aac90 --- /dev/null +++ b/shared/modules/terms/partials/mcp-tool.adoc @@ -0,0 +1,4 @@ +=== MCP tool +:term-name: MCP tool +:hover-text: A function that an AI assistant can call to perform a specific task, such as fetching data from an API, querying a database, or processing streaming data. Each tool is defined using Redpanda Connect components and annotated with MCP metadata. +:category: Redpanda Connect diff --git a/shared/modules/terms/partials/mcp.adoc b/shared/modules/terms/partials/mcp.adoc new file mode 100644 index 0000000000..69a07239a4 --- /dev/null +++ b/shared/modules/terms/partials/mcp.adoc @@ -0,0 +1,6 @@ +=== Model Context Protocol (MCP) +:term-name: MCP +:hover-text: A standardized protocol that enables AI agents to connect with external data sources and tools in Redpanda. +:category: Agentic Data Plane + +MCP provides a consistent interface for AI applications to discover and interact with data sources, services, and computational tools through Redpanda infrastructure. diff --git a/shared/modules/terms/partials/message.adoc b/shared/modules/terms/partials/message.adoc new file mode 100644 index 0000000000..a45d8a3031 --- /dev/null +++ b/shared/modules/terms/partials/message.adoc @@ -0,0 +1,6 @@ +=== message +:term-name: message +:hover-text: One or more records representing individual events being transmitted. Redpanda transfers messages between producers and consumers. +:category: Redpanda core + +Sometimes used interchangeably with record. \ No newline at end of file diff --git a/shared/modules/terms/partials/node.adoc b/shared/modules/terms/partials/node.adoc new file mode 100644 index 0000000000..34cfda8845 --- /dev/null +++ b/shared/modules/terms/partials/node.adoc @@ -0,0 +1,6 @@ +=== node +:term-name: node +:hover-text: A machine, which could be a server, a virtual machine (instance), or a Docker container. Every node has its own disk. Partitions are stored locally on nodes. In Kubernetes, a Node is the machine that Redpanda runs on. Outside the context of Kubernetes, this term may be used interchangeably with broker, such as `node_id`. +:category: Redpanda core + +See also: broker diff --git a/shared/modules/terms/partials/oauth-client.adoc b/shared/modules/terms/partials/oauth-client.adoc new file mode 100644 index 0000000000..c87479dee9 --- /dev/null +++ b/shared/modules/terms/partials/oauth-client.adoc @@ -0,0 +1,4 @@ +=== OAuth client +:term-name: OAuth client +:hover-text: An ADP resource that governs inbound authentication: an external app (Claude Desktop, ChatGPT, Copilot Studio) authenticating to AI Gateway so the app's users can invoke MCP tools. Separate from an OAuth provider, which governs outbound authentication. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/oauth-connection.adoc b/shared/modules/terms/partials/oauth-connection.adoc new file mode 100644 index 0000000000..49247cc9f3 --- /dev/null +++ b/shared/modules/terms/partials/oauth-connection.adoc @@ -0,0 +1,4 @@ +=== OAuth connection +:term-name: OAuth connection +:hover-text: A stored authorization that links a user to a third-party provider, created when the user completes the OAuth consent flow. OAuth connections hold access and refresh tokens in the token vault for agents to use on the user's behalf. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/oauth-provider.adoc b/shared/modules/terms/partials/oauth-provider.adoc new file mode 100644 index 0000000000..e6e13e9591 --- /dev/null +++ b/shared/modules/terms/partials/oauth-provider.adoc @@ -0,0 +1,4 @@ +=== OAuth provider +:term-name: OAuth provider +:hover-text: An ADP resource that governs outbound authentication: AI Gateway authenticating to an upstream system (GitHub, Slack, Salesforce, and so on) on a user's behalf so MCP servers can call it. Separate from an OAuth client, which governs inbound authentication. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/observability.adoc b/shared/modules/terms/partials/observability.adoc new file mode 100644 index 0000000000..7f6fda852b --- /dev/null +++ b/shared/modules/terms/partials/observability.adoc @@ -0,0 +1,6 @@ +=== observability (o11y) +:term-name: observability (o11y) +:hover-text: The ability to understand a system's internal state by examining its external outputs, such as traces, metrics, and logs. +:category: Agentic Data Plane + +In Redpanda's agentic systems, observability enables debugging agent behavior, monitoring performance, analyzing execution flow, and identifying bottlenecks through transcripts captured in the `redpanda.otel_traces` topic. diff --git a/shared/modules/terms/partials/offset-commit.adoc b/shared/modules/terms/partials/offset-commit.adoc new file mode 100644 index 0000000000..1e29564728 --- /dev/null +++ b/shared/modules/terms/partials/offset-commit.adoc @@ -0,0 +1,4 @@ +=== offset commit +:term-name: offset commit +:hover-text: An acknowledgement that the event has been read. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/offset.adoc b/shared/modules/terms/partials/offset.adoc new file mode 100644 index 0000000000..f21b3c0c05 --- /dev/null +++ b/shared/modules/terms/partials/offset.adoc @@ -0,0 +1,4 @@ +=== offset +:term-name: offset +:hover-text: A unique integer assigned to each record to show its location in the partition. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/oidc.adoc b/shared/modules/terms/partials/oidc.adoc new file mode 100644 index 0000000000..e1cc467aec --- /dev/null +++ b/shared/modules/terms/partials/oidc.adoc @@ -0,0 +1,6 @@ +=== OpenID Connect (OIDC) +:term-name: OpenID Connect (OIDC) +:hover-text: Authentication layer built on OAuth 2.0 that allows clients to verify user identity and obtain basic profile information. +:category: Redpanda security + +OpenID Connect provides a standardized way for applications to authenticate users through identity providers. In Redpanda's agentic systems, OIDC enables secure authentication for AI agents and MCP servers accessing cloud resources. diff --git a/shared/modules/terms/partials/opentelemetry.adoc b/shared/modules/terms/partials/opentelemetry.adoc new file mode 100644 index 0000000000..6291040261 --- /dev/null +++ b/shared/modules/terms/partials/opentelemetry.adoc @@ -0,0 +1,6 @@ +=== OpenTelemetry +:term-name: OpenTelemetry +:hover-text: Open-source observability framework that provides standardized APIs, libraries, and tools for capturing and exporting telemetry data. +:category: Agentic Data Plane + +OpenTelemetry provides standardized APIs for capturing traces, metrics, and logs from applications. Redpanda agents and MCP servers automatically emit OpenTelemetry traces to the `redpanda.otel_traces` topic to provide complete observability into agentic system operations. diff --git a/shared/modules/terms/partials/operator.adoc b/shared/modules/terms/partials/operator.adoc new file mode 100644 index 0000000000..be27b6a075 --- /dev/null +++ b/shared/modules/terms/partials/operator.adoc @@ -0,0 +1,4 @@ +=== Redpanda Operator +:term-name: Redpanda Operator +:hover-text: Extends Kubernetes with custom resource definitions (CRDs), which allow Redpanda clusters to be treated as native Kubernetes resources. +:category: Redpanda in Kubernetes diff --git a/shared/modules/terms/partials/otlp.adoc b/shared/modules/terms/partials/otlp.adoc new file mode 100644 index 0000000000..39baca9884 --- /dev/null +++ b/shared/modules/terms/partials/otlp.adoc @@ -0,0 +1,6 @@ +=== OTLP (OpenTelemetry Protocol) +:term-name: OTLP +:hover-text: Standard protocol for encoding and transmitting telemetry data defined by the OpenTelemetry project. +:category: Agentic Data Plane + +OTLP is the OpenTelemetry Protocol specification for encoding and transmitting telemetry data. Redpanda stores spans in the `redpanda.otel_traces` topic using a Protobuf schema that closely follows the OTLP specification. diff --git a/shared/modules/terms/partials/oxla.adoc b/shared/modules/terms/partials/oxla.adoc new file mode 100644 index 0000000000..26dabc43f2 --- /dev/null +++ b/shared/modules/terms/partials/oxla.adoc @@ -0,0 +1,4 @@ +=== Oxla +:term-name: Oxla +:hover-text: The SQL engine technology that powers Redpanda SQL. "Oxla" may appear in version strings, error messages, and some API field names. +:category: Redpanda SQL diff --git a/shared/modules/terms/partials/pandaproxy.adoc b/shared/modules/terms/partials/pandaproxy.adoc new file mode 100644 index 0000000000..e7229e4257 --- /dev/null +++ b/shared/modules/terms/partials/pandaproxy.adoc @@ -0,0 +1,4 @@ +=== pandaproxy +:term-name: pandaproxy +:hover-text: Original name for the subsystem of Redpanda that allows access to your data through a REST API. This name still appears in the HTTP Proxy API and the Schema Registry API. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/partition-leader.adoc b/shared/modules/terms/partials/partition-leader.adoc new file mode 100644 index 0000000000..7563cd149f --- /dev/null +++ b/shared/modules/terms/partials/partition-leader.adoc @@ -0,0 +1,4 @@ +=== partition leader +:term-name: partition leader +:hover-text: Every Redpanda partition forms a Raft group with a single elected leader. This leader handles all writes, and it replicates data to followers to ensure that a majority of brokers store the data. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/partition.adoc b/shared/modules/terms/partials/partition.adoc new file mode 100644 index 0000000000..295dc9ada1 --- /dev/null +++ b/shared/modules/terms/partials/partition.adoc @@ -0,0 +1,4 @@ +=== partition +:term-name: partition +:hover-text: A subset of events in a topic, like a log file. It is an ordered, immutable sequence of records. Partitions allow you to distribute a stream, which lets producers write messages in parallel and consumers read messages in parallel. Partitions are made up of segment files on disk. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/pipeline.adoc b/shared/modules/terms/partials/pipeline.adoc new file mode 100644 index 0000000000..97c70cd330 --- /dev/null +++ b/shared/modules/terms/partials/pipeline.adoc @@ -0,0 +1,4 @@ +=== pipeline +:term-name: pipeline +:hover-text: A single configuration file running in Redpanda Connect with an input connector, an output connector, and optional processors in between. A pipeline typically streams data into Redpanda from an operational source (like PostgreSQL) or streams data out of Redpanda into an analytical system (like Snowflake). +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/principal.adoc b/shared/modules/terms/partials/principal.adoc new file mode 100644 index 0000000000..c617e603da --- /dev/null +++ b/shared/modules/terms/partials/principal.adoc @@ -0,0 +1,6 @@ +=== principal +:term-name: principal +:hover-text: An authenticated identity (user, service account, or group) that Redpanda evaluates when enforcing ACLs and role assignments. +:category: Redpanda security + +Redpanda supports `User:` and `Group:` principal types. Permissions are granted to principals through ACLs or RBAC role assignments. \ No newline at end of file diff --git a/shared/modules/terms/partials/processor.adoc b/shared/modules/terms/partials/processor.adoc new file mode 100644 index 0000000000..44bc40dcf6 --- /dev/null +++ b/shared/modules/terms/partials/processor.adoc @@ -0,0 +1,6 @@ +=== processor +:term-name: processor +:hover-text: A Redpanda Connect component that transforms data, validates inputs, or calls external APIs within a processing pipeline. +:category: Redpanda Connect + +Processors are stateless components in Redpanda Connect that operate on individual messages or batches. When used as MCP tools, processors handle data transformations, validate parameters, and invoke external services. Each processor executes independently per request with no state maintained between invocations. diff --git a/shared/modules/terms/partials/producer.adoc b/shared/modules/terms/partials/producer.adoc new file mode 100644 index 0000000000..986197bad5 --- /dev/null +++ b/shared/modules/terms/partials/producer.adoc @@ -0,0 +1,4 @@ +=== producer +:term-name: producer +:hover-text: A client application that writes events to Redpanda. Redpanda stores these events in sequence and organizes them into topics. +:category: Redpanda core diff --git a/shared/modules/terms/partials/prompt.adoc b/shared/modules/terms/partials/prompt.adoc new file mode 100644 index 0000000000..036df69892 --- /dev/null +++ b/shared/modules/terms/partials/prompt.adoc @@ -0,0 +1,6 @@ +=== prompt +:term-name: prompt +:hover-text: Natural language instructions or context provided to an LLM to guide its behavior and responses. +:category: Agentic Data Plane + +Prompts are the primary way to communicate with LLMs and AI agents. They can include instructions, examples, context, and questions that guide the model's reasoning and output. Effective prompt design is critical for agent performance and reliability. diff --git a/shared/modules/terms/partials/rack-awareness.adoc b/shared/modules/terms/partials/rack-awareness.adoc new file mode 100644 index 0000000000..cebc867436 --- /dev/null +++ b/shared/modules/terms/partials/rack-awareness.adoc @@ -0,0 +1,4 @@ +=== rack awareness +:term-name: rack awareness +:hover-text: Feature that lets you distribute replicas of the same partition across different racks to minimize data loss and improve fault tolerance in the event of a rack failure. +:category: Redpanda features diff --git a/shared/modules/terms/partials/rack.adoc b/shared/modules/terms/partials/rack.adoc new file mode 100644 index 0000000000..ac5f6f4df6 --- /dev/null +++ b/shared/modules/terms/partials/rack.adoc @@ -0,0 +1,4 @@ +=== rack +:term-name: rack +:hover-text: A failure zone that has one or more Redpanda brokers assigned to it. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/raft.adoc b/shared/modules/terms/partials/raft.adoc new file mode 100644 index 0000000000..fcae49c88e --- /dev/null +++ b/shared/modules/terms/partials/raft.adoc @@ -0,0 +1,5 @@ +=== Raft +:term-name: Raft +:hover-text: The consensus algorithm Redpanda uses to coordinate writing data to log files and replicating that data across brokers. +:link: https://raft.github.io/ +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/rbac.adoc b/shared/modules/terms/partials/rbac.adoc new file mode 100644 index 0000000000..e70e7baa3d --- /dev/null +++ b/shared/modules/terms/partials/rbac.adoc @@ -0,0 +1,4 @@ +=== RBAC +:term-name: RBAC +:hover-text: Role-based access control lets you assign users access to specific resources. +:category: Redpanda security \ No newline at end of file diff --git a/shared/modules/terms/partials/rebalancing.adoc b/shared/modules/terms/partials/rebalancing.adoc new file mode 100644 index 0000000000..4785946d9d --- /dev/null +++ b/shared/modules/terms/partials/rebalancing.adoc @@ -0,0 +1,12 @@ +=== rebalancing +:term-name: rebalancing +:hover-text: Process of moving partition replicas and transferring partition leadership for improved performance. +:category: Redpanda features + +Redpanda provides various topic-aware tools to balance clusters for best performance. + +- Leadership balancing changes where data is written to first, but it does not involve any data transfer. The partition leader regularly sends heartbeats to its followers. If a follower does not receive a heartbeat within a timeout, it triggers a new leader election. Redpanda also provides leadership balancing when brokers are added or decommissioned. +- Partition replica balancing moves partition replicas to alleviate disk pressure and to honor the configured replication factor across brokers and the additional redundancy across failure domains (such as racks). Redpanda provides partition replica rebalancing when brokers are added or decommissioned. +ifndef::env-cloud[] +- With an Enterprise license, you can additionally enable Continuous Data Balancing to continuously monitor broker and rack availability and disk usage. +endif::[] \ No newline at end of file diff --git a/shared/modules/terms/partials/record.adoc b/shared/modules/terms/partials/record.adoc new file mode 100644 index 0000000000..85e6138c50 --- /dev/null +++ b/shared/modules/terms/partials/record.adoc @@ -0,0 +1,6 @@ +=== record +:term-name: record +:hover-text: A self-contained data entity with a defined structure, representing a single event. +:category: Redpanda core + +Sometimes used interchangeably with message. \ No newline at end of file diff --git a/shared/modules/terms/partials/redpanda-catalog.adoc b/shared/modules/terms/partials/redpanda-catalog.adoc new file mode 100644 index 0000000000..660aa39f40 --- /dev/null +++ b/shared/modules/terms/partials/redpanda-catalog.adoc @@ -0,0 +1,4 @@ +=== Redpanda catalog +:term-name: Redpanda catalog +:hover-text: A catalog in Redpanda SQL that maps Redpanda topics to SQL tables. The default Redpanda catalog (`default_redpanda_catalog`) is provisioned automatically when Redpanda SQL is enabled. +:category: Redpanda SQL diff --git a/shared/modules/terms/partials/redpanda-cloud.adoc b/shared/modules/terms/partials/redpanda-cloud.adoc new file mode 100644 index 0000000000..b50cdee2e3 --- /dev/null +++ b/shared/modules/terms/partials/redpanda-cloud.adoc @@ -0,0 +1,4 @@ +=== Redpanda Cloud +:term-name: Redpanda Cloud +:hover-text: A fully-managed data streaming service deployed with Redpanda Console. It includes automated upgrades and patching, backup and recovery, data and partition balancing, and built-in connectors. Redpanda Cloud is available in Serverless, Dedicated, and Bring Your Own Cloud (BYOC) deployment options to suit different data sovereignty and infrastructure requirements. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/redpanda-connect-mcp-server.adoc b/shared/modules/terms/partials/redpanda-connect-mcp-server.adoc new file mode 100644 index 0000000000..b354cae20c --- /dev/null +++ b/shared/modules/terms/partials/redpanda-connect-mcp-server.adoc @@ -0,0 +1,4 @@ +=== Redpanda Connect MCP server +:term-name: Redpanda Connect MCP server +:hover-text: A process that exposes Redpanda Connect components to MCP clients. You write each tool's logic using Redpanda Connect configurations and annotate them with MCP metadata so clients can discover and invoke them. +:category: Redpanda Connect diff --git a/shared/modules/terms/partials/redpanda-connect.adoc b/shared/modules/terms/partials/redpanda-connect.adoc new file mode 100644 index 0000000000..5b696a8967 --- /dev/null +++ b/shared/modules/terms/partials/redpanda-connect.adoc @@ -0,0 +1,4 @@ +=== Redpanda Connect +:term-name: Redpanda Connect +:hover-text: A framework for building data streaming applications using declarative YAML configurations. Redpanda Connect provides components such as inputs, processors, outputs, and caches to define data flows and transformations. +:category: Redpanda Connect diff --git a/shared/modules/terms/partials/redpanda-console.adoc b/shared/modules/terms/partials/redpanda-console.adoc new file mode 100644 index 0000000000..48b277ad7a --- /dev/null +++ b/shared/modules/terms/partials/redpanda-console.adoc @@ -0,0 +1,4 @@ +=== Redpanda Console +:term-name: Redpanda Console +:hover-text: The web-based UI for managing and monitoring Redpanda clusters and streaming workloads. You can also set up and manage connectors in Redpanda Console. Redpanda Console is an integral part of Redpanda Cloud, but it also can be used as a standalone program as part of a Redpanda Self-Managed deployment. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/redpanda-sql.adoc b/shared/modules/terms/partials/redpanda-sql.adoc new file mode 100644 index 0000000000..92c72cc723 --- /dev/null +++ b/shared/modules/terms/partials/redpanda-sql.adoc @@ -0,0 +1,6 @@ +=== Redpanda SQL +:term-name: Redpanda SQL +:hover-text: A PostgreSQL-compatible SQL engine built into Redpanda Data Platform for querying streaming data in Redpanda topics. +:category: Redpanda SQL + +Redpanda SQL provides analytical SQL queries over Redpanda topic data without requiring ETL pipelines or a separate analytics system. It can also query the Iceberg-translated history of Iceberg-enabled topics alongside live records. diff --git a/shared/modules/terms/partials/remote-mcp.adoc b/shared/modules/terms/partials/remote-mcp.adoc new file mode 100644 index 0000000000..9d664a8e59 --- /dev/null +++ b/shared/modules/terms/partials/remote-mcp.adoc @@ -0,0 +1,4 @@ +=== Remote MCP +:term-name: Remote MCP +:hover-text: An MCP server hosted in your Redpanda Cloud cluster. It exposes custom tools that AI assistants can call to access your data and workflows. +:category: Redpanda Cloud diff --git a/shared/modules/terms/partials/replicas.adoc b/shared/modules/terms/partials/replicas.adoc new file mode 100644 index 0000000000..546fed8f19 --- /dev/null +++ b/shared/modules/terms/partials/replicas.adoc @@ -0,0 +1,4 @@ +=== replicas +:term-name: replicas +:hover-text: Copies of partitions that are distributed across different brokers, so if one broker goes down, there is a copy of the data. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/resource-group.adoc b/shared/modules/terms/partials/resource-group.adoc new file mode 100644 index 0000000000..499ee6f613 --- /dev/null +++ b/shared/modules/terms/partials/resource-group.adoc @@ -0,0 +1,4 @@ +=== resource group +:term-name: resource group +:hover-text: A container for Redpanda Cloud resources, including clusters and networks. You can rename your default resource group, and you can create more resource groups. For example, you may want different resource groups for production and testing. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/resource.adoc b/shared/modules/terms/partials/resource.adoc new file mode 100644 index 0000000000..ea010e9cc9 --- /dev/null +++ b/shared/modules/terms/partials/resource.adoc @@ -0,0 +1,4 @@ +=== resource +:term-name: resource +:hover-text: Read-only data that an MCP server exposes and agents can fetch by URI. Resources provide file contents, database rows, or API responses without performing side effects. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/retention.adoc b/shared/modules/terms/partials/retention.adoc new file mode 100644 index 0000000000..c2b7865000 --- /dev/null +++ b/shared/modules/terms/partials/retention.adoc @@ -0,0 +1,4 @@ +=== retention +:term-name: retention +:hover-text: The mechanism for determining how long Redpanda stores data on local disk or in object storage before purging it. +:category: Redpanda core diff --git a/shared/modules/terms/partials/rf.adoc b/shared/modules/terms/partials/rf.adoc new file mode 100644 index 0000000000..b19279e648 --- /dev/null +++ b/shared/modules/terms/partials/rf.adoc @@ -0,0 +1,4 @@ +=== replication factor +:term-name: replication factor +:hover-text: The number of partition copies in a cluster. This is set to 3 in Redpanda Cloud deployments and 1 (no replication) in Self-Managed deployments. A replication factor of at least 3 ensures that each partition has a copy of its data on at least one other broker. One replica acts as the leader, and the other replicas are followers. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/rolling-upgrade.adoc b/shared/modules/terms/partials/rolling-upgrade.adoc new file mode 100644 index 0000000000..5558b5f948 --- /dev/null +++ b/shared/modules/terms/partials/rolling-upgrade.adoc @@ -0,0 +1,4 @@ +=== rolling upgrade +:term-name: rolling upgrade +:hover-text: The process of upgrading each broker in a Redpanda cluster, one at a time, to minimize disruption and ensure continuous availability. +:category: Redpanda features diff --git a/shared/modules/terms/partials/rpk.adoc b/shared/modules/terms/partials/rpk.adoc new file mode 100644 index 0000000000..93d5682160 --- /dev/null +++ b/shared/modules/terms/partials/rpk.adoc @@ -0,0 +1,4 @@ +=== rpk +:term-name: rpk +:hover-text: Redpanda's command-line interface tool for managing Redpanda clusters. +:category: Redpanda features \ No newline at end of file diff --git a/shared/modules/terms/partials/rrr.adoc b/shared/modules/terms/partials/rrr.adoc new file mode 100644 index 0000000000..45e64eff3a --- /dev/null +++ b/shared/modules/terms/partials/rrr.adoc @@ -0,0 +1,4 @@ +=== Remote Read Replica +:term-name: Remote Read Replica +:hover-text: A read-only topic that mirrors a topic on a different cluster, using data from Tiered Storage. +:category: Redpanda features diff --git a/shared/modules/terms/partials/schema-registry-context.adoc b/shared/modules/terms/partials/schema-registry-context.adoc new file mode 100644 index 0000000000..8059d37543 --- /dev/null +++ b/shared/modules/terms/partials/schema-registry-context.adoc @@ -0,0 +1,4 @@ +=== Schema Registry context +:term-name: Schema Registry context +:hover-text: An independent namespace for subjects within a Schema Registry. Contexts let multiple groups of schemas coexist in one registry without naming conflicts. The default context is named ".". +:category: Redpanda features diff --git a/shared/modules/terms/partials/schema-registry.adoc b/shared/modules/terms/partials/schema-registry.adoc new file mode 100644 index 0000000000..5ce79fd100 --- /dev/null +++ b/shared/modules/terms/partials/schema-registry.adoc @@ -0,0 +1,4 @@ +=== Schema Registry +:term-name: Schema Registry +:hover-text: Redpanda Schema Registry (pandaproxy) is the interface for storing and managing event schemas. Producers and consumers register and retrieve schemas they use from the registry. It is built into the Redpanda binary and uses the default port 8081. +:category: Redpanda features diff --git a/shared/modules/terms/partials/schema.adoc b/shared/modules/terms/partials/schema.adoc new file mode 100644 index 0000000000..0fa7f22ec2 --- /dev/null +++ b/shared/modules/terms/partials/schema.adoc @@ -0,0 +1,4 @@ +=== schema +:term-name: schema +:hover-text: An external mechanism to describe the structure of data and its encoding. Schemas validate the structure and ensure that producers and consumers can connect with data in the same format. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/seastar.adoc b/shared/modules/terms/partials/seastar.adoc new file mode 100644 index 0000000000..80cccf414f --- /dev/null +++ b/shared/modules/terms/partials/seastar.adoc @@ -0,0 +1,5 @@ +=== Seastar +:term-name: Seastar +:hover-text: An open-source thread-per-core C++ framework, which binds all work to physical cores. Redpanda is built on Seastar. +:link: https://seastar.io/ +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/seed-server.adoc b/shared/modules/terms/partials/seed-server.adoc new file mode 100644 index 0000000000..5bf9d831f2 --- /dev/null +++ b/shared/modules/terms/partials/seed-server.adoc @@ -0,0 +1,4 @@ +=== seed server +:term-name: seed server +:hover-text: The initial set of brokers that a Redpanda broker contacts to join the cluster. Seed servers play a crucial role in cluster formation and recovery, acting as a point of reference for new or restarting brokers to understand the current topology of the cluster. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/segment.adoc b/shared/modules/terms/partials/segment.adoc new file mode 100644 index 0000000000..7bbb1d9080 --- /dev/null +++ b/shared/modules/terms/partials/segment.adoc @@ -0,0 +1,4 @@ +=== segment +:term-name: segment +:hover-text: Discrete part of a partition, used to break down a continuous stream into manageable chunks. You can set the maximum duration (`segment.ms`) or size (`segment.bytes`) for a segment to be open for writes. +:category: Redpanda core diff --git a/shared/modules/terms/partials/self-hosted.adoc b/shared/modules/terms/partials/self-hosted.adoc new file mode 100644 index 0000000000..929141fdd8 --- /dev/null +++ b/shared/modules/terms/partials/self-hosted.adoc @@ -0,0 +1,6 @@ +=== Self-Managed +:term-name: Self-Managed +:hover-text: Redpanda Self-Managed refers to the product offering that includes both the Enterprise Edition and the Community Edition of Redpanda. +:category: Redpanda licenses + +Sometimes used interchangeably with self-hosted. \ No newline at end of file diff --git a/shared/modules/terms/partials/self-managed-agent.adoc b/shared/modules/terms/partials/self-managed-agent.adoc new file mode 100644 index 0000000000..7bd7f8075a --- /dev/null +++ b/shared/modules/terms/partials/self-managed-agent.adoc @@ -0,0 +1,4 @@ +=== self-managed agent +:term-name: self-managed agent +:hover-text: An AI agent you build and run yourself, in your own runtime and framework, registered with Redpanda ADP as an identity. The AI Gateway becomes the agent's LLM and MCP endpoint, so ADP attributes spend, tokens, latency, and traces back to the agent. ADP does not host or run the agent. Contrast with a declarative agent, which runs in Redpanda's managed runtime. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/self-managed-mcp-server.adoc b/shared/modules/terms/partials/self-managed-mcp-server.adoc new file mode 100644 index 0000000000..8111d2da75 --- /dev/null +++ b/shared/modules/terms/partials/self-managed-mcp-server.adoc @@ -0,0 +1,4 @@ +=== self-managed MCP server +:term-name: self-managed MCP server +:hover-text: An MCP server you host and operate yourself, registered with Redpanda ADP so the AI Gateway can proxy tool calls to it. Contrast with a managed MCP server, which Redpanda hosts in-process for you. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/serialization.adoc b/shared/modules/terms/partials/serialization.adoc new file mode 100644 index 0000000000..83c0acf790 --- /dev/null +++ b/shared/modules/terms/partials/serialization.adoc @@ -0,0 +1,4 @@ +=== serialization +:term-name: serialization +:hover-text: The process of converting a record into a format that can be stored. Deserialization is the process of converting a record back to the original state. Redpanda Schema Registry supports Avro and Protobuf serialization formats. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/serverless.adoc b/shared/modules/terms/partials/serverless.adoc new file mode 100644 index 0000000000..dea99390ce --- /dev/null +++ b/shared/modules/terms/partials/serverless.adoc @@ -0,0 +1,4 @@ +=== Serverless +:term-name: Serverless +:hover-text: Serverless is the fastest and easiest way to start data streaming. You host your data in Redpanda's VPC, and Redpanda handles automatic scaling, provisioning, operations, and maintenance. +:category: Redpanda Cloud diff --git a/shared/modules/terms/partials/service-account.adoc b/shared/modules/terms/partials/service-account.adoc new file mode 100644 index 0000000000..4b0cba9232 --- /dev/null +++ b/shared/modules/terms/partials/service-account.adoc @@ -0,0 +1,4 @@ +=== service account +:term-name: service account +:hover-text: An identity independent of the user who created it that can be used to authenticate and perform operations. This is especially useful for authentication of machines. +:category: Redpanda security \ No newline at end of file diff --git a/shared/modules/terms/partials/shadow-cluster.adoc b/shared/modules/terms/partials/shadow-cluster.adoc new file mode 100644 index 0000000000..4476f1d672 --- /dev/null +++ b/shared/modules/terms/partials/shadow-cluster.adoc @@ -0,0 +1,4 @@ +=== shadow cluster +:term-name: shadow cluster +:hover-text: A read-only Redpanda cluster that continuously receives replicated data from a source cluster through a shadow link. During a disaster, you can fail over to the shadow cluster so it handles production traffic. +:category: Redpanda features diff --git a/shared/modules/terms/partials/shadow-link.adoc b/shared/modules/terms/partials/shadow-link.adoc new file mode 100644 index 0000000000..dee676abd3 --- /dev/null +++ b/shared/modules/terms/partials/shadow-link.adoc @@ -0,0 +1,4 @@ +=== shadow link +:term-name: shadow link +:hover-text: A persistent connection between two Redpanda clusters that continuously replicates topic data, metadata, consumer offsets, ACLs, and Schema Registry content from a source cluster to a shadow cluster for disaster recovery. +:category: Redpanda features diff --git a/shared/modules/terms/partials/shard.adoc b/shared/modules/terms/partials/shard.adoc new file mode 100644 index 0000000000..b68d4db411 --- /dev/null +++ b/shared/modules/terms/partials/shard.adoc @@ -0,0 +1,4 @@ +=== shard +:term-name: shard +:hover-text: A CPU core. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/sink-connector.adoc b/shared/modules/terms/partials/sink-connector.adoc new file mode 100644 index 0000000000..7d9427e9e9 --- /dev/null +++ b/shared/modules/terms/partials/sink-connector.adoc @@ -0,0 +1,4 @@ +=== sink connector +:term-name: sink connector +:hover-text: Exports data from a Redpanda cluster into a target system. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/source-connector.adoc b/shared/modules/terms/partials/source-connector.adoc new file mode 100644 index 0000000000..2f1067f856 --- /dev/null +++ b/shared/modules/terms/partials/source-connector.adoc @@ -0,0 +1,4 @@ +=== source connector +:term-name: source connector +:hover-text: Imports data from a source system into a Redpanda cluster. +:category: Redpanda Cloud \ No newline at end of file diff --git a/shared/modules/terms/partials/span.adoc b/shared/modules/terms/partials/span.adoc new file mode 100644 index 0000000000..d915eb1ec3 --- /dev/null +++ b/shared/modules/terms/partials/span.adoc @@ -0,0 +1,6 @@ +=== span +:term-name: span +:hover-text: A single unit of work within a trace representing one operation, such as a data processing operation or an external API call. +:category: Agentic Data Plane + +Spans are organized in the Redpanda UI as parent-child relationships that show how operations flow through the system. Each span captures details about a specific operation, including timing, status, and metadata. diff --git a/shared/modules/terms/partials/spending-event.adoc b/shared/modules/terms/partials/spending-event.adoc new file mode 100644 index 0000000000..50d7fdbe5d --- /dev/null +++ b/shared/modules/terms/partials/spending-event.adoc @@ -0,0 +1,4 @@ +=== spending event +:term-name: spending event +:hover-text: A record produced by the AI Gateway for every LLM call. Each event captures input, output, and cached token counts, the total cost in microcents, request count, and the provider, model, user, and organization context that the call ran under. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/subagent.adoc b/shared/modules/terms/partials/subagent.adoc new file mode 100644 index 0000000000..11e484fd67 --- /dev/null +++ b/shared/modules/terms/partials/subagent.adoc @@ -0,0 +1,6 @@ +=== subagent +:term-name: subagent +:hover-text: A specialized AI agent that handles specific tasks or domains as part of a larger multi-agent system. +:category: Agentic Data Plane + +Subagents are autonomous components within a multi-agent architecture that have focused expertise in particular domains or operations. They communicate with a parent agent or other subagents to accomplish complex workflows that require coordination across multiple specializations. diff --git a/shared/modules/terms/partials/subject.adoc b/shared/modules/terms/partials/subject.adoc new file mode 100644 index 0000000000..07c9bc0529 --- /dev/null +++ b/shared/modules/terms/partials/subject.adoc @@ -0,0 +1,4 @@ +=== subject +:term-name: subject +:hover-text: A logical grouping or category for schemas. When data formats are updated, a new version of the schema can be registered under the same subject, allowing for backward and forward compatibility. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/system-prompt.adoc b/shared/modules/terms/partials/system-prompt.adoc new file mode 100644 index 0000000000..737adbc931 --- /dev/null +++ b/shared/modules/terms/partials/system-prompt.adoc @@ -0,0 +1,6 @@ +=== system prompt +:term-name: system prompt +:hover-text: Initial instructions that define an agent's role, capabilities, and behavioral guidelines. +:category: Agentic Data Plane + +The system prompt is provided at the start of an agent session and establishes the agent's identity, available tools, operating constraints, and response style. It remains active throughout the conversation and shapes all subsequent agent behavior and decision-making. diff --git a/shared/modules/terms/partials/thread-per-core.adoc b/shared/modules/terms/partials/thread-per-core.adoc new file mode 100644 index 0000000000..ce0abfed44 --- /dev/null +++ b/shared/modules/terms/partials/thread-per-core.adoc @@ -0,0 +1,4 @@ +=== thread-per-core +:term-name: thread-per-core +:hover-text: Programming model that allows Redpanda to pin each of its application threads to a CPU core to avoid context switching and blocking. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/tiered-storage.adoc b/shared/modules/terms/partials/tiered-storage.adoc new file mode 100644 index 0000000000..6af93d6b07 --- /dev/null +++ b/shared/modules/terms/partials/tiered-storage.adoc @@ -0,0 +1,4 @@ +=== Tiered Storage +:term-name: Tiered Storage +:hover-text: Feature that lets you offload log segments to object storage in near real-time, providing long-term data retention and topic recovery. +:category: Redpanda features diff --git a/shared/modules/terms/partials/token-vault.adoc b/shared/modules/terms/partials/token-vault.adoc new file mode 100644 index 0000000000..0b6f4e12bd --- /dev/null +++ b/shared/modules/terms/partials/token-vault.adoc @@ -0,0 +1,4 @@ +=== token vault +:term-name: token vault +:hover-text: Encrypted per-user store for the OAuth access and refresh tokens used to access third-party providers. Redpanda injects a user's token at call time and refreshes it automatically; connections persist until the user revokes them. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/tool-invocation.adoc b/shared/modules/terms/partials/tool-invocation.adoc new file mode 100644 index 0000000000..bcf341bf26 --- /dev/null +++ b/shared/modules/terms/partials/tool-invocation.adoc @@ -0,0 +1,6 @@ +=== tool invocation +:term-name: tool invocation +:hover-text: The process of an AI agent executing an MCP tool to perform a specific operation. +:category: Agentic Data Plane + +Tool invocation occurs when an agent determines that it needs to use a tool, formats the request with appropriate parameters, sends it to the MCP server, and processes the response. Each invocation is captured in transcripts as spans for observability and debugging. diff --git a/shared/modules/terms/partials/tool.adoc b/shared/modules/terms/partials/tool.adoc new file mode 100644 index 0000000000..539efd330e --- /dev/null +++ b/shared/modules/terms/partials/tool.adoc @@ -0,0 +1,4 @@ +=== tool +:term-name: tool +:hover-text: A capability exposed by an MCP server that an AI agent can discover at runtime and invoke through structured JSON-RPC calls. Tools encapsulate operations such as querying a database, calling an API, or sending a message. +:category: Agentic Data Plane diff --git a/shared/modules/terms/partials/topic-partition.adoc b/shared/modules/terms/partials/topic-partition.adoc new file mode 100644 index 0000000000..d956ed1d63 --- /dev/null +++ b/shared/modules/terms/partials/topic-partition.adoc @@ -0,0 +1,4 @@ +=== topic partition +:term-name: topic partition +:hover-text: A topic may be partitioned through multiple brokers. A "topic partition" represents this logical separation in Redpanda, which is managed natively by Raft. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/topic.adoc b/shared/modules/terms/partials/topic.adoc new file mode 100644 index 0000000000..85a2941089 --- /dev/null +++ b/shared/modules/terms/partials/topic.adoc @@ -0,0 +1,4 @@ +=== topic +:term-name: topic +:hover-text: A logical stream of related events that are written to the same log. It can be divided into multiple partitions. A topic can have various clients writing events to it and reading events from it. +:category: Redpanda core \ No newline at end of file diff --git a/shared/modules/terms/partials/trace.adoc b/shared/modules/terms/partials/trace.adoc new file mode 100644 index 0000000000..648b29a11c --- /dev/null +++ b/shared/modules/terms/partials/trace.adoc @@ -0,0 +1,6 @@ +=== trace +:term-name: trace +:hover-text: The complete lifecycle of a request captured as a collection of spans, showing how operations relate to each other. +:category: Agentic Data Plane + +A trace represents the complete lifecycle of a request (for example, a tool invocation from start to finish). A trace contains one or more spans organized hierarchically, showing how operations relate to each other. diff --git a/shared/modules/terms/partials/transcript.adoc b/shared/modules/terms/partials/transcript.adoc new file mode 100644 index 0000000000..e8c426c00b --- /dev/null +++ b/shared/modules/terms/partials/transcript.adoc @@ -0,0 +1,6 @@ +=== transcript +:term-name: transcript +:hover-text: Complete observability record of agent or MCP server operations captured as OpenTelemetry traces and stored in the redpanda.otel_traces topic. +:category: Agentic Data Plane + +Transcripts capture tool invocations, agent reasoning steps, data processing operations, external API calls, error conditions, and performance metrics. They provide a complete record of how agentic systems operate, enabling debugging, auditing, and performance analysis. diff --git a/shared/modules/terms/partials/wire-format.adoc b/shared/modules/terms/partials/wire-format.adoc new file mode 100644 index 0000000000..9c4c62f147 --- /dev/null +++ b/shared/modules/terms/partials/wire-format.adoc @@ -0,0 +1,4 @@ +=== wire format +:term-name: wire format +:hover-text: A serialization format used by Schema Registry that prefixes each record with a magic byte and 4-byte schema ID, so consumers can identify and apply the correct schema. +:category: Redpanda core From b1cfd734e5f7e9c8fd41ba82fd98ad85c668de36 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Fri, 7 Aug 2026 15:22:57 +0100 Subject: [PATCH 2/4] fix: record cloud_storage_enable_remote_read as the Remote Read Replicas gating property Found by the doc-tools validate enterprise-features drift checker comparing the registry against disable-enterprise-features.adoc. --- shared/modules/ROOT/partials/enterprise-features.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/shared/modules/ROOT/partials/enterprise-features.yml b/shared/modules/ROOT/partials/enterprise-features.yml index c198815a36..504dab42d9 100644 --- a/shared/modules/ROOT/partials/enterprise-features.yml +++ b/shared/modules/ROOT/partials/enterprise-features.yml @@ -198,6 +198,7 @@ features: source: kind: core-enum value: cloud_storage + gating-property: cloud_storage_enable_remote_read notes: Enforced under the cloud_storage license gate together with Tiered Storage, Topic Recovery, and Whole Cluster Restore. glossary-term: Remote Read Replica From f62b0481f3e780ba3066e17292bc64030be4f03c Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Sat, 8 Aug 2026 06:51:13 +0100 Subject: [PATCH 3/4] feat: add Kubernetes and Cloud feature-page xrefs to the registry Some enterprise features have separate documentation for Kubernetes, Linux, and Redpanda Cloud. New optional xref-kubernetes and xref-cloud fields let the enterprise macro link to the environment-appropriate page based on the env-kubernetes and env-cloud page attributes, following the config_ref macro's environment-awareness pattern. The default xref stays the Linux / generic self-managed page. --- .../modules/ROOT/partials/enterprise-features.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/shared/modules/ROOT/partials/enterprise-features.yml b/shared/modules/ROOT/partials/enterprise-features.yml index 504dab42d9..e834c9f4d6 100644 --- a/shared/modules/ROOT/partials/enterprise-features.yml +++ b/shared/modules/ROOT/partials/enterprise-features.yml @@ -9,6 +9,11 @@ # name Canonical external (customer-facing) name. Unique, case-insensitive. # scope redpanda | console | connect | operator | cloud # xref Antora resource ID of the feature page (omit if none exists). +# This is the default (Linux / generic self-managed) page. +# xref-kubernetes Kubernetes-specific feature page, used by the enterprise: +# macro on pages with the env-kubernetes attribute. +# xref-cloud Redpanda Cloud feature page (cloud-data-platform component), +# used on pages with the env-cloud attribute. # url Absolute link used instead of xref when the target is not an Antora page. # description AsciiDoc for the table's Description column. # expiration AsciiDoc for the "Behavior Upon Expiration" (redpanda scope) or @@ -42,6 +47,8 @@ features: - name: Audit Logging scope: redpanda xref: manage:audit-logging.adoc + xref-kubernetes: manage:kubernetes/security/k-audit-logging.adoc + xref-cloud: cloud-data-platform:manage:audit-logging.adoc description: | Records detailed logs of cluster activities for compliance and monitoring. expiration: | @@ -190,6 +197,8 @@ features: - name: Remote Read Replicas scope: redpanda xref: manage:remote-read-replicas.adoc + xref-kubernetes: manage:kubernetes/tiered-storage/k-remote-read-replicas.adoc + xref-cloud: cloud-data-platform:get-started:cluster-types/byoc/remote-read-replicas.adoc description: | Enables remote clusters to read data stored in object storage for disaster recovery. expiration: | @@ -205,6 +214,7 @@ features: - name: Role-Based Access Control (RBAC) scope: redpanda xref: manage:security/authorization/rbac.adoc + xref-cloud: cloud-data-platform:security:authorization/rbac/rbac.adoc description: | Manages user roles and permissions within the cluster. expiration: | @@ -243,6 +253,7 @@ features: - name: Shadowing scope: redpanda xref: deploy:redpanda/manual/disaster-recovery/shadowing/index.adoc + xref-kubernetes: manage:kubernetes/shadowing/index.adoc description: | Provides enterprise-grade disaster recovery through asynchronous, offset-preserving replication between distinct Redpanda clusters for cross-region data protection. expiration: | @@ -270,6 +281,7 @@ features: - name: Topic Recovery scope: redpanda xref: manage:topic-recovery.adoc + xref-kubernetes: manage:kubernetes/tiered-storage/k-topic-recovery.adoc description: | Allows restoring a single topic from Tiered Storage using remote recovery properties. expiration: | @@ -282,6 +294,7 @@ features: - name: Tiered Storage scope: redpanda xref: manage:tiered-storage.adoc + xref-kubernetes: manage:kubernetes/tiered-storage/k-tiered-storage.adoc description: | Enables data storage in cloud object storage for long-term retention and retrieval. expiration: | @@ -296,6 +309,7 @@ features: - name: Whole Cluster Restore (WCR) scope: redpanda xref: manage:whole-cluster-restore.adoc + xref-kubernetes: manage:kubernetes/tiered-storage/k-whole-cluster-restore.adoc description: | Enables the recovery of cluster data from a source cluster's snapshot. expiration: | From c74550a7acb64a2051bfd38ee1ffb3ee357adbe5 Mon Sep 17 00:00:00 2001 From: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Date: Sat, 8 Aug 2026 07:34:24 +0100 Subject: [PATCH 4/4] Update CODEOWNERS --- .github/CODEOWNERS | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 0e07384f44..67491e07ff 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,8 +1,5 @@ * @redpanda-data/documentation -# Auto-add marketing as reviewers in partner integration page -modules/get-started/pages/partner-integration.adoc @redpanda-data/documentation @larsenpanda @mikebroberg @dunithd - # The enterprise features registry defines which features may be documented as # enterprise and under what names. Changes need docs-team review. -/shared/modules/ROOT/partials/enterprise-features.yml @redpanda-data/documentation \ No newline at end of file +/shared/modules/ROOT/partials/enterprise-features.yml @redpanda-data/documentation