Extensions and Macros Preview

This page is a preview of extensions and macros.

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 datePublished and dateModified
Available to Handlebars templates as page.attributes.git-created-date

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:

This link text is custom.

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-name and hover-text attributes, 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 link attribute, 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.

config_ref

test

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.1.9
{latest-redpanda-version}: 26.1.9
{redpanda-beta-version}: 25.3.15-rc4
{redpanda-beta-tag}: v25.3.15-rc4
{latest-release-commit}: 988a61b
{latest-console-version}: 3.7.3
{console-beta-version}: 3.0.0-beta.2
{console-beta-tag}: v3.0.0-beta.2
{latest-operator-version}: v26.1.4
{latest-redpanda-helm-chart-version}: 26.1.4

Attachments

By default, Antora does not replace attributes in attachment files. Download this test attachment to make sure that the correct elements were replaced:

Download attachment

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.

Download archive

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

Name	Connector Type	Support Level	Enterprise Licensed	Available in Cloud
`a2a_message`	Processor	Certified	Yes	Yes
`amqp_0_9`RabbitMQ AMQP	Input, Output	Certified	No	Yes
`amqp_1`RabbitMQ AMQP Apache Qpid	Input, Output	Community	No	No
`arc`	Output	Community	No	Yes
`archive`ZIP TAR GZIP	Processor	Certified	No	Yes
`avro`	Processor, Scanner	Community	No	Yes
`awk`	Processor	Community	No	No
`aws_bedrock_chat`Amazon AWS Bedrock Chat	Processor	Certified	No	Yes
`aws_bedrock_embeddings`Amazon AWS Bedrock Embeddings	Processor	Certified	No	Yes
`aws_cloudwatch`	Metric	Community	No	No
`aws_cloudwatch_logs`AWS CloudWatch Logs Amazon CloudWatch Logs	Input	Community	No	Yes
`aws_dynamodb`AWS DynamoDB Amazon DynamoDB DynamoDB	Cache, Output	Community	No	Yes
`aws_dynamodb_cdc`Amazon DynamoDB CDC	Input	Certified	Yes	Yes
`aws_dynamodb_partiql`Amazon AWS DynamoDB PartiQL	Processor	Certified	No	Yes
`aws_kinesis`AWS Kinesis Amazon Kinesis Kinesis	Input, Output	Certified	No	Yes
`aws_kinesis_firehose`AWS Kinesis Firehose Amazon Kinesis Firehose Kinesis Firehose	Output	Certified	No	Yes
`aws_lambda`AWS Lambda Amazon Lambda Lambda	Processor	Certified	No	Yes
`aws_s3`AWS S3 Amazon S3 S3 Simple Storage Service	Cache, Input, Output	Certified	No	Yes
`aws_sns`AWS SNS Amazon SNS SNS Simple Notification Service	Output	Community	No	Yes
`aws_sqs`AWS SQS Amazon SQS SQS Simple Queue Service	Input, Output	Certified	No	Yes
`azure_blob_storage`Azure Blob Storage Microsoft Azure Storage	Input, Output	Certified	No	Yes
`azure_cosmosdb`Microsoft Azure Azure	Input, Output, Processor	Certified	No	Yes
`azure_data_lake_gen2`Microsoft Azure Azure	Output	Certified	No	Yes
`azure_queue_storage`Azure Queue Storage Microsoft Azure Queue	Input, Output	Certified	No	Yes
`azure_table_storage`Azure Table Storage Microsoft Azure Table	Input, Output	Certified	No	Yes
`batched`	Input	Certified	No	Yes
`beanstalkd`	Input, Output	Community	No	No
`benchmark`	Processor	Certified	No	Yes
`bloblang`	Processor	Certified	No	Yes
`bounds_check`	Processor	Certified	No	Yes
`branch`	Processor	Certified	No	Yes
`broker`	Input, Output	Certified	No	Yes
`cache`	Output, Processor	Certified	No	Yes
`cached`	Processor	Certified	No	Yes
`cassandra`Apache Cassandra	Input, Output	Community	No	No
`catch`	Processor	Certified	No	Yes
`chunker`	Scanner	Certified	No	Yes
`cockroachdb_changefeed`	Input	Community	No	No
`cohere_chat`	Processor	Certified	No	Yes
`cohere_embeddings`	Processor	Certified	No	Yes
`cohere_rerank`	Processor	Certified	No	Yes
`command`	Processor	Certified	No	No
`compress`	Processor	Certified	No	Yes
`couchbase`	Cache, Output, Processor	Community	No	No
`crash`	Processor	Certified	No	No
`csv`Comma-Separated Values	Input, Scanner	Certified	No	Yes
`cyborgdb`	Output	Community	No	Yes
`cypher`	Output	Community	No	No
`decompress`	Processor, Scanner	Certified	No	Yes
`dedupe`	Processor	Certified	No	Yes
`discord`	Input, Output	Community	No	No
`drop`	Output	Certified	No	Yes
`drop_on`	Output	Certified	No	Yes
`dynamic`	Input, Output	Community	No	No
`elasticsearch_v8`	Output	Certified	No	Yes
`elasticsearch_v9`	Output	Community	No	No
`fallback`	Output	Certified	No	Yes
`ffi`Foreign Function Interface	Processor	Certified	No	No
`file`	Cache, Input, Output	Certified	No	No
`for_each`	Processor	Certified	No	Yes
`gateway`	Input	Certified	Yes	Yes
`gcp_bigquery`GCP BigQuery Google BigQuery BigQuery	Output	Certified	No	Yes
`gcp_bigquery_select`GCP BigQuery Google Cloud GCP	Input, Processor	Certified	No	Yes
`gcp_bigquery_write_api`GCP BigQuery	Output	Certified	Yes	Yes
`gcp_cloud_storage`GCP Cloud Storage Google Cloud Storage GCS	Cache, Input, Output	Certified	No	Yes
`gcp_cloudtrace`GCP Cloud Trace	Tracer	Certified	No	Yes
`gcp_pubsub`GCP PubSub Google Cloud Pub/Sub GCP Pub/Sub Google Pub/Sub	Input, Output	Certified	No	Yes
`gcp_spanner_cdc`Google Cloud GCP	Input	Certified	Yes	Yes
`gcp_vertex_ai_chat`GCP Vertex AI Google Cloud GCP	Processor	Certified	No	Yes
`gcp_vertex_ai_embeddings`Google Cloud GCP	Processor	Certified	No	Yes
`generate`	Input	Certified	No	Yes
`git`	Input	Certified	No	Yes
`google_drive_download`	Processor	Certified	Yes	Yes
`google_drive_list_labels`	Processor	Certified	Yes	Yes
`google_drive_search`	Processor	Certified	Yes	Yes
`grok`	Processor	Community	No	No
`group_by`	Processor	Certified	No	Yes
`group_by_value`	Processor	Certified	No	Yes
`hdfs`	Input, Output	Community	No	No
`http`	Processor	Certified	No	Yes
`http_client`HTTP REST API REST	Input, Output	Certified	No	Yes
`http_server`HTTP REST API REST Gateway	Input, Output	Certified	No	Yes
`iceberg`Apache Iceberg Apache Polaris AWS Glue Databricks Unity Catalog	Output	Certified	Yes	Yes
`influxdb`	Metric	Community	No	No
`inproc`	Input, Output	Certified	No	Yes
`insert_part`	Processor	Certified	No	Yes
`jaeger`	Tracer	Community	No	No
`javascript`	Processor	Certified	No	No
`jira`	Processor	Certified	No	Yes
`jmespath`	Processor	Certified	No	Yes
`jq`	Processor	Certified	No	Yes
`json_api`	Metric	Certified	No	No
`json_array`	Scanner	Community	No	Yes
`json_documents`	Scanner	Certified	No	Yes
`json_schema`JSON Schema	Processor	Certified	No	Yes
`kafka`Apache Kafka	Input, Output	Certified	No	Yes
`kafka_franz`Apache Kafka Kafka	Input, Output	Certified	No	Yes
`lines`	Scanner	Certified	No	Yes
`local`	Rate_limit	Certified	No	Yes
`log`	Processor	Certified	No	Yes
`logger`	Metric	Certified	No	No
`lru`	Cache	Community	No	Yes
`mapping`	Processor	Certified	No	Yes
`memcached`	Cache	Community	No	Yes
`memory`	Buffer, Cache	Certified	No	Yes
`metric`	Processor	Certified	No	Yes
`microsoft_sql_server_cdc`	Input	Certified	Yes	Yes
`mongodb`Mongo	Cache, Input, Output, Processor	Certified	No	Yes
`mongodb_cdc`MongoDB CDC	Input	Certified	Yes	Yes
`mqtt`	Input, Output	Certified	No	Yes
`msgpack`	Processor	Community	No	No
`multilevel`	Cache	Certified	No	Yes
`mutation`	Processor	Certified	No	Yes
`mysql_cdc`	Input	Certified	Yes	Yes
`nanomsg`	Input, Output	Community	No	No
`nats`NATS.io	Input, Output	Certified	No	Yes
`nats_jetstream`NATS JetStream NATS	Input, Output	Certified	No	Yes
`nats_kv`NATS KV	Cache, Input, Output, Processor	Certified	No	Yes
`nats_request_reply`NATS Request Reply	Processor	Certified	No	Yes
`nats_stream`NATS Stream NATS Streaming NATS	Input, Output	Community	No	No
`none`	Buffer, Metric, Tracer	Certified	No	Yes
`noop`	Cache, Processor	Certified	No	Yes
`nsq`	Input, Output	Community	No	No
`ockam_kafka`	Input, Output	Community	No	No
`ollama_chat`	Processor	Certified	No	No
`ollama_embeddings`	Processor	Certified	No	No
`ollama_moderation`	Processor	Certified	No	No
`open_telemetry_collector`OpenTelemetry	Metric, Tracer	Certified	Yes	Yes
`openai_chat_completion`	Processor	Certified	No	Yes
`openai_embeddings`	Processor	Certified	No	Yes
`openai_image_generation`	Processor	Certified	No	Yes
`openai_speech`	Processor	Certified	No	Yes
`openai_transcription`	Processor	Certified	No	Yes
`openai_translation`	Processor	Certified	No	Yes
`opensearch`	Output	Certified	No	Yes
`oracledb_cdc`Oracle CDC OracleDB CDC Oracle Database CDC	Input	Certified	Yes	Yes
`otlp_grpc`OpenTelemetry OTLP OTel gRPC	Input, Output	Certified	Yes	Yes
`otlp_http`OpenTelemetry OTLP OTel	Input, Output	Certified	Yes	Yes
`parallel`	Processor	Certified	No	Yes
`parquet`	Input, Processor	Certified: input Community: processor	No	No
`parquet_decode`	Processor	Certified	No	Yes
`parquet_encode`	Processor	Certified	No	Yes
`parse_log`	Processor	Community	No	Yes
`pg_stream`		Certified	Yes	Yes
`pinecone`	Output	Certified	No	Yes
`postgres_cdc`	Input	Certified	Yes	Yes
`processors`	Processor	Certified	No	Yes
`prometheus`	Metric	Certified	No	Yes
`protobuf`	Processor	Certified	No	No
`pulsar`Apache Pulsar	Input, Output	Community	No	No
`pusher`	Output	Community	No	No
`qdrant`	Output, Processor	Certified	No	Yes
`questdb`	Output	Certified	No	Yes
`rate_limit`	Processor	Certified	No	Yes
`re_match`	Scanner	Certified	No	Yes
`read_until`	Input	Certified	No	Yes
`redis`	Cache, Processor, Rate_limit	Certified	No	Yes
`redis_hash`Redis Hash Redis	Output	Certified	No	Yes
`redis_list`Redis List Redis Lists Redis	Input, Output	Certified	No	Yes
`redis_pubsub`Redis PubSub Redis Pub/Sub Redis	Input, Output	Certified	No	Yes
`redis_scan`Redis	Input	Certified	No	Yes
`redis_script`Redis Script	Processor	Certified	No	Yes
`redis_streams`Redis Streams Redis	Input, Output	Certified	No	Yes
`redpanda`	Cache, Input, Output, Tracer	Certified	No	Yes
`redpanda_common`	Input, Output	Certified	Yes	Yes
`redpanda_data_transform`	Processor	Certified	No	No
`redpanda_migrator`	Input, Output	Certified	No	Yes
`reject`	Output	Certified	No	Yes
`reject_errored`	Output	Certified	No	Yes
`resource`	Input, Output, Processor	Certified	No	Yes
`retry`	Output, Processor	Certified	No	Yes
`ristretto`	Cache	Community	No	Yes
`salesforce`	Input	Certified	Yes	Yes
`salesforce_cdc`Salesforce Salesforce CDC	Input	Certified	Yes	Yes
`salesforce_graphql`Salesforce Salesforce GraphQL	Input	Certified	Yes	Yes
`salesforce_sink`Salesforce Salesforce Sink	Output	Certified	Yes	Yes
`schema_registry`	Input, Output	Certified	No	Yes
`schema_registry_decode`	Processor	Certified	No	Yes
`schema_registry_encode`	Processor	Certified	No	Yes
`select_parts`	Processor	Certified	No	Yes
`sentry_capture`	Processor	Community	No	No
`sequence`	Input	Certified	No	Yes
`sftp`	Input, Output	Certified	No	Yes
`skip_bom`	Scanner	Certified	No	Yes
`slack`	Input	Certified	Yes	Yes
`slack_post`Slack Post	Output	Certified	Yes	Yes
`slack_reaction`Slack Reaction	Output	Certified	Yes	Yes
`slack_thread`Slack Thread	Processor	Certified	Yes	Yes
`slack_users`Slack Users	Input	Certified	Yes	Yes
`sleep`	Processor	Certified	No	Yes
`snowflake_put`Snowflake	Output	Certified	Yes	Yes
`snowflake_streaming`Snowflake Streaming	Output	Certified	Yes	Yes
`socket`	Input, Output	Certified	No	No
`socket_server`	Input	Certified	No	No
`spicedb_watch`	Input	Community	No	Yes
`split`	Processor	Certified	No	Yes
`splunk`	Input	Certified	Yes	Yes
`splunk_hec`Splunk	Output	Certified	Yes	Yes
`sql`	Cache, Output, Processor	Certified: cache Community: output, processor	No	Yes
`sql_driver_clickhouse`ClickHouse		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	Yes
`sql_driver_gocosmos`Azure Cosmos DB		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	No
`sql_driver_mssql`Microsoft SQL Server		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	No
`sql_driver_mysql`MYSQL		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	Yes
`sql_driver_oracle`Oracle		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	Yes
`sql_driver_postgres`PostgreSQL		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	Yes
`sql_driver_snowflake`Snowflake		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	No
`sql_driver_sqlite`SQLite		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	Yes
`sql_driver_trino`Trino		Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	No
`sql_insert`SQL PostgreSQL MySQL Microsoft SQL Server ClickHouse Trino	Output, Processor	Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	Yes
`sql_raw`SQL PostgreSQL MySQL Microsoft SQL Server ClickHouse Trino	Input, Output, Processor	Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	Yes
`sql_select`SQL PostgreSQL MySQL Microsoft SQL Server ClickHouse Trino	Input, Processor	Certified: MYSQL, Oracle, PostgreSQL, SQLite Community: ClickHouse, Azure Cosmos DB, Microsoft SQL Server, Snowflake, Trino	No	Yes
`sqlite`	Buffer	Community	No	No
`statsd`	Metric	Certified	No	No
`stdin`	Input	Certified	No	No
`stdout`	Output	Certified	No	No
`string_split`	Processor	Certified	No	Yes
`subprocess`	Input, Output, Processor	Community	No	No
`switch`	Output, Processor, Scanner	Certified	No	Yes
`sync_response`	Output, Processor	Certified	No	Yes
`system_window`	Buffer	Certified	No	Yes
`tar`	Scanner	Certified	No	Yes
`text_chunker`	Processor	Certified	No	Yes
`tigerbeetle_cdc`	Input	Certified	No	No
`timeplus`	Input, Output	Community	No	Yes
`to_the_end`	Scanner	Certified	No	Yes
`try`	Processor	Certified	No	Yes
`ttlru`	Cache	Community	No	Yes
`twitter_search`	Input	Community	No	No
`unarchive`ZIP TAR GZIP Archive	Processor	Certified	No	Yes
`wasm`	Processor	Community	No	No
`websocket`	Input, Output	Certified	No	No
`while`	Processor	Certified	No	Yes
`workflow`	Processor	Certified	No	Yes
`xml`	Processor	Community	No	Yes
`zmq4`	Input, Output	Community	No	No

a2a_message

Processor

Certified

Yes

amqp_0_9RabbitMQ AMQP

Input, Output