For the complete documentation index, see llms.txt. Component-specific: ROOT-full.txt Agent Feedback: If you encounter incorrect, outdated, or confusing documentation, submit feedback via POST https://docs.redpanda.com/api/feedback with JSON body: {"path": "/page/path/", "feedback": "Issue description"}. Only submit when you have specific, actionable feedback.

New! Redpanda Agentic Data Plane is here: a governed, high-performance foundation for AI agents. Learn more
Redpanda logo Self-Managed
Cloud Self-Managed Connect Labs
or

What do you think of this page?

Let us know more:

Let us contact you about your feedback:

Please complete the “I'm not a robot” checkbox before submitting.

Version 26.1 keyboard_arrow_down
25.3 25.2 25.1 (end of life) 24.3 (end of life) 24.2 (end of life) 24.1 (end of life) 23.3 (end of life)
    • Overview
    • Get Started
      • What’s New
        • Redpanda
        • Operator
        • Helm Charts
      • Introduction to Redpanda
      • How Redpanda Works
      • Introduction to Redpanda Console
      • Quickstarts
        • Redpanda Self-Managed
        • Redpanda CLI Quickstart
        • Docker Compose Labs
      • Redpanda Licensing
        • Editions and Enterprise Features
        • Add License to Redpanda
          • Linux
          • Kubernetes
          • Use Redpanda Console
        • Add License to Redpanda Console
        • Check Status
          • Use rpk
          • Use Redpanda Operator
          • Use Redpanda Console
          • Use Metrics
        • Disable Enterprise Features
      • Redpanda CLI
        • Introduction to rpk
        • Install or Update rpk
        • rpk Profiles
        • Specify Broker Addresses for rpk
        • Specify Admin API Addresses for rpk
      • Partner Integrations
    • Develop
      • Kafka Compatibility
      • Benchmark Redpanda
      • Use Redpanda with the HTTP Proxy API
      • Topics
        • Manage Topics
        • Manage Cloud Topics
          • Configure Producers for Cloud Topics
      • Edit Topic Configuration
      • Produce Data
        • Configure Producers
        • Idempotent Producers
        • Configure Leader Pinning
      • Consume Data
        • Consumer Offsets
        • Follower Fetching
        • Filter Messages
        • Deserialize Messages
        • Paginate Messages in Redpanda Console
      • Data Transforms
        • Overview
        • Get Started
          • Linux
          • Kubernetes
        • Build
        • Configure
        • Deploy
        • Test
        • Monitor
        • Manage in Redpanda Console
        • Upgrade
        • Versioning and Compatibility
        • Examples
      • Transactions
    • Deploy
      • Redpanda
        • Kubernetes
          • Overview
          • Get Started
            • Azure AKS
            • Amazon EKS
            • Google GKE
            • Local (kind and minikube)
          • Deployment Workflow
          • Requirements and Recommendations
          • Tune Worker Nodes
          • Deploy Redpanda
          • Production Readiness Checklist
          • High Availability
        • Linux
          • Hardware and Software Requirements
          • Deployment Options
            • Deploy for Development
            • Deploy for Production: Automated
            • Deploy for Production: Manual
            • Production Readiness Checklist
          • Sizing Use Cases
          • Sizing Guidelines
          • System Tuning
      • Redpanda Console
        • Kubernetes
          • Requirements
          • Deploy on Kubernetes
        • Linux
          • Requirements
          • Deploy on Linux
      • Redpanda Connect
      • Kafka Connect
        • Deploy on Kubernetes
        • Deploy on Docker
    • Manage
      • Kubernetes
        • Customize the Helm Chart
        • Cluster Properties
        • Manage Topics
        • Cloud Topics
        • Manage Kafka Connect
        • Storage
          • Volume Types
          • Configure Storage
            • PersistentVolume
            • hostPath
            • emptyDir
          • Expand PersistentVolumes
          • Delete PersistentVolumes
        • Tiered Storage
          • Use Tiered Storage
          • Fast Commission and Decommission Brokers in Kubernetes
          • Remote Read Replicas
          • Topic Recovery
          • Whole Cluster Restore
        • Networking and Connectivity
          • Overview
          • Connect to Redpanda
          • Configure Listeners
          • External Access
            • Use a NodePort Service
            • Use LoadBalancer Services
            • Use Custom Services
        • Security
          • TLS Encryption
            • Use cert-manager
            • Use Secrets
          • Authentication and Authorization
            • Enable Authentication
            • Manage Users and ACLs (Operator)
            • Manage Roles and ACLs (Operator)
            • Manage Groups and ACLs (Operator)
            • Manage Schema Registry ACLs (Operator)
          • Audit Logging
        • Rack Awareness
        • Remote Read Replicas
        • Shadowing
          • Configure Shadowing
          • Monitor
          • Failover Runbook
        • Manage Pod Resources
        • Scale
        • Cluster Maintenance
          • Node Pools
          • Enable the PVCUnbinder
          • Decommission Brokers
          • Recovery Mode
          • Rolling Restart
        • Monitor
          • Redpanda
          • Kafka Connect
        • Resilience Testing
      • Cluster Maintenance
        • Configure Cluster Properties
        • Configure Broker Properties
        • Configure Topic Properties
        • Cluster Balancing
        • Continuous Data Balancing
        • Decommission Brokers
        • Maintenance Mode
        • Rolling Restart
        • Audit Logging
          • Sample Audit Log Messages
        • Manage Disk Space
        • About Client Throughput Quotas
        • Manage Throughput
        • Compaction Settings
        • Configure Client Connections
        • Forced Partition Recovery
        • Node-wise Partition Recovery
      • Security
        • Authentication
        • Authorization
          • Role-Based Access Control (RBAC)
          • Group-Based Access Control (GBAC)
          • Access Control Lists (ACLs)
        • FIPS Compliance
        • Configure Kafka TLS Encryption
        • Configure Listeners
        • IAM Roles
      • Tiered Storage
        • Use Tiered Storage
        • Fast Commission and Decommission Brokers
        • Mountable Topics
      • Iceberg
        • About Iceberg Topics
        • Specify Iceberg Schema
        • Use Iceberg Catalogs
        • Integrate with REST Catalogs
          • AWS Glue
          • Databricks Unity Catalog
          • GCP BigLake
          • Snowflake and Open Catalog
        • Query Iceberg Topics
        • Migrate to Iceberg Topics
        • Tune Iceberg Performance
        • Troubleshoot Iceberg Topics
      • Schema Registry
        • Overview
        • Use Schema Registry
          • API
          • Kubernetes
        • Schema Registry Authorization
        • Schema Registry Contexts
        • Server-Side Schema ID Validation
        • Manage in Redpanda Console
      • High Availability
      • Disaster Recovery
        • Shadowing
          • Overview
          • Configure Shadowing
          • Monitor Shadowing
          • Failover
          • Failover Runbook
        • Whole Cluster Restore
        • Topic Recovery
      • Remote Read Replicas
      • Recovery Mode
      • Rack Awareness
      • Raft Group Reconfiguration
      • Optimize I/O
      • Redpanda Console
        • Configure Redpanda Console
        • Add an Enterprise License
        • Connect to Redpanda
        • Security
          • Authentication
          • Authorization
          • TLS Termination
        • HTTP Path Rewrites
        • Deserialization
        • Topic Documentation
        • Telemetry
        • Kafka Connect
      • Use the Admin API
      • Monitor Redpanda
    • Upgrade
      • Upgrade Redpanda in Linux
      • Upgrade Redpanda in Kubernetes
      • Upgrade the Redpanda Operator
      • Kubernetes Compatibility
      • Migrate Node Pools
      • Migrate Node Pools Manually
      • Deprecated Features
      • Iceberg Schema Changes in v25.3
    • Migrate
      • Migrate to Redpanda Console v3.0.x
      • Migrate Data to Redpanda with MirrorMaker 2
      • Migrate from the Redpanda Helm chart
      • Migrate from Strimzi to Redpanda Operator
    • Troubleshoot
      • Cluster Diagnostics
        • Linux
        • Kubernetes
      • Debug Bundles
        • Overview
        • Configure
          • Linux
          • Kubernetes
        • Generate
          • Linux
          • Kubernetes
          • Redpanda Console
        • Inspect
      • Resolve Errors
        • Linux
        • Kubernetes
    • Reference
      • Properties
        • Broker Configuration Properties
        • Cluster Configuration Properties
        • Object Storage Properties
        • Topic Configuration Properties
      • Release Notes
        • Redpanda
        • Redpanda Console
        • Redpanda Helm Chart
        • Redpanda Operator
      • API Reference
        • HTTP Proxy API
        • Schema Registry API
        • Admin API
        • Admin API (ConnectRPC)
      • Data Transforms SDKs
        • Golang
        • Rust
        • JavaScript
          • Data Transforms API
          • Schema Registry API
      • Kubernetes
        • Kubernetes Helm Chart Specifications
          • Redpanda
          • Redpanda Operator
          • Redpanda Console
          • Kafka Connect
          • Redpanda Connect
        • Kubernetes Custom Resource Definitions
          • cluster.redpanda.com/v1alpha2
      • Monitoring Metrics
        • Public Metrics
        • Internal Metrics
      • rpk Commands
        • rpk
        • rpk -X
        • rpk cluster
          • rpk cluster config
            • rpk cluster config edit
            • rpk cluster config export
            • rpk cluster config force-reset
            • rpk cluster config get
            • rpk cluster config import
            • rpk cluster config list
            • rpk cluster config lint
            • rpk cluster config set
            • rpk cluster config status
          • rpk cluster connections
            • rpk cluster connections list
          • rpk cluster health
          • rpk cluster license
            • rpk cluster license info
            • rpk cluster license set
          • rpk cluster logdirs
            • rpk cluster logdirs describe
          • rpk cluster maintenance
            • rpk cluster maintenance disable
            • rpk cluster maintenance enable
            • rpk cluster maintenance status
          • rpk cluster info
          • rpk cluster partitions
            • rpk cluster partitions balance
            • rpk cluster partitions disable
            • rpk cluster partitions enable
            • rpk cluster partitions list
            • rpk cluster partitions balancer-status
            • rpk cluster partitions move
              • rpk cluster partitions move-cancel
              • rpk cluster partitions move-status
            • rpk cluster partitions transfer-leadership
            • rpk cluster partitions unsafe-recover
          • rpk cluster quotas
            • rpk cluster quotas alter
            • rpk cluster quotas describe
            • rpk cluster quotas import
          • rpk cluster self-test
            • rpk cluster self-test start
            • rpk cluster self-test status
            • rpk cluster self-test stop
          • rpk cluster storage
            • rpk cluster storage mount/unmount
              • rpk cluster storage cancel mount
              • rpk cluster storage list mount
              • rpk cluster storage list-mountable
              • rpk cluster storage mount
              • rpk cluster storage status mount
              • rpk cluster storage unmount
            • rpk cluster storage restore
            • rpk cluster storage restore start
            • rpk cluster storage restore status
          • rpk cluster txn
            • rpk cluster txn describe
            • rpk cluster txn describe-producers
            • rpk cluster txn list
        • rpk connect
          • rpk connect blobl server
          • rpk connect create
          • rpk connect echo
          • rpk connect install
          • rpk connect lint
          • rpk connect list
          • rpk connect run
          • rpk connect streams
          • rpk connect studio pull
          • rpk connect studio sync-schema
          • rpk connect template lint
          • rpk connect test
          • rpk connect uninstall
          • rpk connect upgrade
        • rpk container
          • rpk container
          • rpk container purge
          • rpk container start
          • rpk container status
          • rpk container stop
        • rpk debug
          • rpk debug bundle
          • rpk debug remote-bundle cancel
          • rpk debug remote-bundle download
          • rpk debug remote-bundle start
          • rpk debug remote-bundle status
          • rpk debug remote-bundle
        • rpk generate
          • rpk generate app
          • rpk generate grafana-dashboard
          • rpk generate license
          • rpk generate prometheus-config
          • rpk generate shell-completion
        • rpk group
          • rpk group delete
          • rpk group offset-delete
          • rpk group describe
          • rpk group list
          • rpk group seek
        • rpk help
        • rpk iotune
        • rpk plugin
          • rpk plugin list
          • rpk plugin uninstall
          • rpk plugin install
        • rpk profile
          • rpk profile clear
          • rpk profile create
          • rpk profile current
          • rpk profile delete
          • rpk profile edit
          • rpk profile edit-globals
          • rpk profile list
          • rpk profile print
          • rpk profile print-globals
          • rpk profile prompt
          • rpk profile rename-to
          • rpk profile set
          • rpk profile set-globals
          • rpk profile use
        • rpk registry
          • rpk registry compatibility-level
            • rpk registry compatibility-level get
            • rpk registry compatibility-level set
          • rpk registry context
            • rpk registry context delete
            • rpk registry context list
          • rpk registry mode
            • rpk registry mode get
            • rpk registry mode reset
            • rpk registry mode set
          • rpk registry schema
            • rpk registry schema check-compatibility
            • rpk registry schema create
            • rpk registry schema delete
            • rpk registry schema get
            • rpk registry schema list
            • rpk registry schema references
          • rpk registry subject
            • rpk registry subject delete
            • rpk registry subject list
        • rpk redpanda
          • rpk redpanda admin
            • rpk redpanda admin brokers
              • rpk redpanda admin brokers decommission
              • rpk redpanda admin brokers decommission-status
              • rpk redpanda admin brokers list
              • rpk redpanda admin brokers recommission
            • rpk redpanda admin config
              • rpk redpanda admin config log-level set
              • rpk redpanda admin config log-level
              • rpk redpanda admin config print
            • rpk redpanda config print
            • rpk redpanda admin partitions
              • rpk redpanda admin partitions
              • rpk redpanda admin partitions list
          • rpk redpanda check
          • rpk redpanda config
            • rpk redpanda config bootstrap
            • rpk redpanda config init
            • rpk redpanda config set
          • rpk redpanda mode
          • rpk redpanda start
          • rpk redpanda stop
          • rpk redpanda tune
            • rpk redpanda tune
            • rpk redpanda tune help
            • rpk redpanda tune list
        • rpk security
          • rpk security acl
            • rpk security acl create
            • rpk security acl delete
            • rpk security acl list
          • rpk security role
            • rpk security role assign
            • rpk security role create
            • rpk security role delete
            • rpk security role describe
            • rpk security role list
            • rpk security role unassign
          • rpk security user
            • rpk security user create
            • rpk security user delete
            • rpk security user update
            • rpk security user list
        • rpk shadow
          • rpk shadow config generate
          • rpk shadow create
          • rpk shadow delete
          • rpk shadow describe
          • rpk shadow failover
          • rpk shadow list
          • rpk shadow status
          • rpk shadow update
        • rpk topic
          • rpk topic add-partitions
          • rpk topic alter-config
          • rpk topic analyze
          • rpk topic consume
          • rpk topic create
          • rpk topic delete
          • rpk topic describe
          • rpk topic describe-storage
          • rpk topic list
          • rpk topic produce
          • rpk topic trim-prefix
        • rpk transform
          • rpk transform build
          • rpk transform delete
          • rpk transform deploy
          • rpk transform init
          • rpk transform list
          • rpk transform logs
          • rpk transform pause
          • rpk transform resume
        • rpk version
      • Glossary
Collapse navigation tree

Collapse

Was this helpful?
🎉 Thanks for your feedback!
  • Docs
  • Self-Managed
  • Develop