Extensions and Macros Preview
This page is a preview of extensions and macros.
|
Markdown output: View this page as Markdown Several macros on this page carry meaning in HTML attributes or CSS that a Markdown conversion cannot keep, so check both renderings when you change one. In particular, The Markdown is generated by the |
Git Dates Extension Test
The add-git-dates extension extracts accurate file creation and modification dates from Git history and makes them available to templates.
The extension automatically adds these dates by querying git log:
-
File created: 2023-07-06 (from first commit)
-
Last modified: 2025-08-08 (from most recent commit)
These dates are:
-
Exported to Markdown frontmatter (
git-created-date,git-modified-date) -
Used in structured data (JSON-LD) for
datePublishedanddateModified -
Available to Handlebars templates as
page.attributes.git-created-date
Enterprise macro
The enterprise macro marks a feature as an enterprise feature in prose. The feature name renders as a styled term (enterprise-feature class) with a tooltip explaining the license requirement, linking to the feature’s page or the licensing page. Targets are validated against the enterprise features registry (enterprise-features.yml in the shared component).
Both the badge and the tooltip are HTML-only: the badge comes from the CSS class and the explanation from a title attribute, so a Markdown conversion keeps neither. In the Markdown output each term below reads <name> (enterprise) with its link preserved, which gives readers and agents an explicit licensing signal.
This page sets :enterprise-licensing-page: streaming:get-started:licensing/overview.adoc because the default target (get-started:licensing/overview.adoc) is only resolvable from inside the docs component itself.
|
Marking forms
Default, no registry xref, linking to the licensing page: Continuous Data Balancing in a sentence.
Registry-supplied feature link (the Tiered Storage entry carries an xref): Tiered Storage in a sentence.
Per-use xref, overriding the registry (here, the Kubernetes variant of the feature page): Tiered Storage in a sentence.
Display text override (canonical name stays in the tooltip): audit logging in a sentence.
Tooltip override: Iceberg Topics in a sentence.
Text and tooltip together: audit logs in a sentence.
Registry resolution
Aliases and case-insensitive spellings canonicalize to the registry name, and the registry supplies the feature link.
From the alias cloud_storage (an internal core name, renders the canonical external name): Tiered Storage in a sentence.
From a lowercase spelling: Tiered Storage in a sentence.
An unknown feature name renders as written but logs a build warning with did-you-mean suggestions (set enterprise-validate to error to fail the build instead): Warp Drive in a sentence.
Environment-specific feature links
Registry entries can carry xref-kubernetes and xref-cloud for features with separate Kubernetes, Linux, and Cloud documentation. Resolution follows the page’s env-kubernetes/env-cloud attributes, so it applies page-wide: see the Kubernetes environment test page, where the same Tiered Storage call links to the Kubernetes feature page instead.
Generated feature tables
The enterprise_features block macro renders the licensing feature table for one scope from the same registry.
Default titles and headings, with a block anchor that survives generation (see the crossref below):
| Feature | Description | Behavior Upon Expiration |
|---|---|---|
Records detailed logs of cluster activities for compliance and monitoring. |
Read access to the audit log topic is denied, but logging continues. |
|
Automatically balances partitions across a cluster to optimize resource use and performance. |
Continuous balancing is disabled, reverting to |
|
Enables Iceberg integration for Redpanda topics. |
Topics cannot be created or modified with the |
|
Preview Beta Feature (beta) |
Fixture for the beta release status. Available to readers, still changing. |
The feature is disabled. |
Enables data storage in cloud object storage for long-term retention and retrieval. |
Topics cannot be created or modified to enable Tiered Storage features. |
|
Topic Deletion Control
( |
Prevents all users, including superusers, from deleting topics through the Kafka DeleteTopics API. |
Topic deletion reverts to enabled ( |
The operator scope demonstrates the feature-suffix field (a resource-name annotation) and the beta: true field, which renders the beta badge after the feature link. The badge is emitted as a passthrough rather than a badge: macro call, so it renders even though a playbook may not register that macro, and it degrades to the text (beta) in Markdown:
| Feature | Description | Restrictions Without Valid License |
|---|---|---|
Stretch Clusters (StretchCluster resource) (beta) |
A single logical Redpanda cluster distributed across multiple Kubernetes clusters. |
The multicluster operator requires a valid license to start. |
Custom title and heading overrides:
| Feature | Description | What stops working |
|---|---|---|
Additional inputs, outputs, and processors available only to enterprise customers. |
All enterprise connectors are blocked. |
The block anchor re-emitted above keeps crossrefs working: jump to the Redpanda table.
Property references (prop macro)
The prop macro marks a configuration property so the docs UI can decorate it with a hover tooltip. Targets are validated against the published property JSON (an attachment in the streaming component’s reference module). Marking is opt-in: plain backticked words never get tooltips, so ambiguous names like admin in Helm or feature contexts stay undecorated unless a writer marks them deliberately.
Marking only
A cluster property: cloud_storage_enabled in a sentence.
A broker property: fips_mode in a sentence.
A dotted topic property: redpanda.iceberg.mode in a sentence.
An ambiguous name, marked deliberately (this is the opt-in fix in action, plain admin elsewhere stays untouched): admin in a sentence.
Linked, page discovered dynamically
The target page is discovered by indexing which reference page documents each property. This preview component publishes no property pages, so links resolve cross-component into the streaming component:
A cluster property: iceberg_enabled in a sentence.
A broker property: empty_seed_starts_cluster in a sentence.
A topic property: retention.ms in a sentence.
Overrides
Display text: write caching in a sentence.
Display text and a link together: segment size in a sentence.
An explicit page override skips discovery entirely. The xref stays component-relative, so it only resolves in components that publish the page and can’t be demonstrated live from this preview component:
prop:cloud_storage_cache_size[link=true,page=properties/object-storage-properties]
Kubernetes Helm paths
With helm-path=auto, the property renders as its Helm values path on pages with the env-kubernetes attribute, and as the plain name elsewhere. On this page (no env-kubernetes), it stays plain: cloud_storage_enabled in a sentence. See the same call on the Kubernetes environment test page.
Terms
Terms must be defined in the terms module of the shared component (shared/modules/terms/partials).
Each partial file in this module 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 your component version, the contents of each term file gets merged into glossary during the build. Terms are merged in alphabetical order, according to the filename. The aggregate-terms extension is responsible for merging the content of each file into the glossary.
To reference a term in a doc topic, use the following syntax:
glossterm:<term-name>[]
Replace <term-name> with the value of the term-name attribute in a term file.
To add custom link text for a term, which can be useful for displaying plurals or context-specific variations of the term without changing the term reference, use this syntax:
glossterm:<term-name>[,<custom-link-text>]
Here, replace <custom-link-text> with your text that will appear as the link. For example:
The hover-text attribute is read from the term file and used to add hover text to the term.
The rules for whether a link to the glossary entry is added to the term, depend on what content is available on the term page:
-
If you include only a title and the required
term-nameandhover-textattributes, a link to the glossary entry is added to the term.For example: hover-only term
-
If you include other Asciidoc content in the term page, such as headings, images, or paragraphs, a link to the glossary entry is added to the term so that users can read the full definition.
For example: test term
-
If you include an external URL in the
linkattribute, a link to that URL is added to the term.For example: external term
Local development
For local development, you can test what your hover text will look like by adding the description to the macro like so:
glossterm:term[This description is located in the Asciidoc source of this page]
This term is defined inline on this page. Inline terms do not include an internal link to the glossary page.
helm_ref
For default values and documentation for configuration options, see the values.yaml file.
Latest versions
The version fetcher extension gets the latest version of Redpanda and Redpanda Console and assigns them to the following attributes:
-
{full-version}: 26.2.2 -
{latest-redpanda-version}: 26.2.2 -
{redpanda-beta-version}: {redpanda-beta-version} -
{redpanda-beta-tag}: {redpanda-beta-tag} -
{latest-release-commit}: fd30e45 -
{latest-console-version}: 3.10.0 -
{console-beta-version}: 3.0.0-beta.2 -
{console-beta-tag}: v3.0.0-beta.2 -
{latest-operator-version}: v26.2.2 -
{latest-redpanda-helm-chart-version}: 26.2.2
Attachments
By default, Antora does not replace attributes in attachment files. Download this test attachment to make sure that the correct elements were replaced:
The archive attachments extension is configured to archive all YAML files for the preview component. Test the extension by downloading this archive. It should contain the test.yaml file and include all replacements made by the replace-attributes-in-attachments extension.
Bloblang samples
{"hello.yaml":{"filename":"hello.yaml","title":"Hello world","input":"{\n \"message\": \"hello world\"\n}\n","mapping":"root.message = this.message.uppercase()\n"}}
End-of-life attributes
This section provides a test for the compute-end-of-life extension as an example of what it generates.
The preview component is configured with a release date of 2024-04-01, and the extension is configured like so:
- require: './extensions/compute-end-of-life'
data:
eol_settings:
- component: 'preview'
supported_months: 12
warning_weeks: 8
eol_doc: https://support.redpanda.com/hc/en-us/articles/20617574366743-Redpanda-Supported-Versions
upgrade_doc: ROOT:upgrade:index.adoc
The extension then generates the following data for the UI to use to build and display a notification banner for EoL versions:
-
{page-is-nearing-eol}: false -
{page-is-past-eol}: true -
{page-eol-date}: April 1, 2025 -
{page-eol-doc}: https://support.redpanda.com/hc/en-us/articles/20617574366743-Redpanda-Supported-Versions -
{page-upgrade-doc}: ROOT:upgrade:index.adoc
Code highlights
function helloWorld() {
console.log("Hello, World!") <sample>;
console.log("This is a sample.");
console.log("With multiple lines.");
console.log("Highlighted using Prism.");
}
Connector table with all data
| Name | Connector Type | Support Level | Enterprise Licensed | Available in Cloud |
|---|---|---|---|---|
|
Certified |
Yes |
|||
|
|
Certified |
No |
||
|
|
Community |
No |
No |
|
|
Community |
No |
|||
|
|
Certified |
No |
||
|
Community |
No |
|||
|
Community |
No |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
Community |
No |
No |
||
|
|
Community |
No |
||
|
|
Community |
No |
||
|
|
Certified |
Yes |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Community |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
|
Community |
No |
No |
|
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
No |
||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
No |
||
|
|
Certified |
No |
||
|
Community |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
|
Certified |
No |
No |
|
|
Certified |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
Yes |
|||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
Yes |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
Yes |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
Yes |
|||
|
Certified |
Yes |
|||
|
Certified |
Yes |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
Yes |
||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
No |
||
|
|
Certified |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
No |
||
|
Community |
No |
|||
|
Certified |
No |
|||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
No |
||
|
Community |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
Yes |
|||
|
|
Certified |
No |
||
|
|
Certified |
Yes |
||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
Yes |
|||
|
Community |
No |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Community |
No |
No |
|
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Community |
No |
No |
||
|
Certified |
No |
No |
||
|
Certified |
No |
No |
||
|
Certified |
No |
No |
||
|
|
Certified |
Yes |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
|
Certified |
Yes |
||
|
|
Certified |
Yes |
||
|
|
Certified |
Yes |
||
|
Certified |
No |
|||
|
Certified: input Community: processor |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
|||
|
Certified |
Yes |
Yes |
||
|
Certified |
No |
|||
|
Certified |
Yes |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
No |
||
|
|
Community |
No |
No |
|
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
|
Certified |
No |
||
|
Certified |
No |
|||
|
Certified |
Yes |
|||
|
Certified |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
|||
|
Certified |
Yes |
|||
|
|
Certified |
Yes |
||
|
|
Certified |
Yes |
||
|
|
Certified |
Yes |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
Yes |
|||
|
|
Certified |
Yes |
||
|
|
Certified |
Yes |
||
|
|
Certified |
Yes |
||
|
|
Certified |
Yes |
||
|
Certified |
No |
|||
|
|
Certified |
Yes |
||
|
|
Certified |
Yes |
||
|
Certified |
No |
No |
||
|
Certified |
No |
No |
||
|
Community |
No |
|||
|
Certified |
No |
|||
|
Certified |
Yes |
|||
|
|
Certified |
Yes |
||
|
Certified: cache Community: output, processor |
No |
|||
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
Yes |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
No |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
No |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
Yes |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
Yes |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
Yes |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
No |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
Yes |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
No |
|
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
||
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
||
|
|
Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino |
No |
||
|
Community |
No |
No |
||
|
Certified |
No |
No |
||
|
Certified |
No |
No |
||
|
Certified |
No |
No |
||
|
Certified |
No |
|||
|
Community |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
No |
||
|
Community |
No |
|||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
|||
|
Community |
No |
|||
|
Community |
No |
No |
||
|
|
Certified |
No |
||
|
Community |
No |
No |
||
|
Certified |
No |
No |
||
|
Certified |
No |
|||
|
Certified |
No |
|||
|
Community |
No |
|||
|
Community |
No |
No |