Streaming

Property Tooltips Test

Test page for Redpanda configuration property tooltips. Property tooltips are enabled by default on all pages. To disable on a specific page, use :page-disable-property-tooltips: true.

Hover over property names to see documentation tooltips!

Cluster Properties in Paragraphs

When configuring Redpanda, you may need to adjust log_segment_size for optimal storage performance. The default segment size works for most workloads, but large messages may benefit from larger segments.

To enable authentication, set enable_sasl to true. This requires clients to authenticate using SASL mechanisms.

Topic Properties in Lists

Topic-level configuration properties:

  • retention_bytes - Controls maximum partition size before deletion

  • This is a topic-scoped property that can override cluster defaults

Dotted Property Names (Topic-scoped)

These properties use dot notation and test the anchor slugification fix:

  • redpanda.storage.mode - Controls storage mode (local vs tiered)

  • redpanda.remote.read - Enables remote reads from object storage

The "View full documentation" link for redpanda.storage.mode should generate an anchor like #redpanda-storage-mode (dots replaced with hyphens), not #redpanda.storage.mode.

Enterprise and Self-Hosted Properties

Some properties are enterprise-only:

  • cloud_storage_enabled - Requires Enterprise license (self-hosted only)

Broker Properties

Per-broker settings like kafka_connections_max control resource limits.

Deprecated Properties

The property group_max_session_timeout_ms is deprecated but still shown with appropriate styling.

Properties in Code Blocks

redpanda:
  log_segment_size: 134217728
  enable_sasl: true

Non-Property Code

Regular code elements should NOT have tooltips:

  • this_is_not_a_property - No tooltip

  • some_random_function() - No tooltip

  • myVariable - No tooltip

Mixed Content

In a paragraph with both properties and regular text: Set enable_sasl to configure authentication, then use kubectl apply to deploy. Only enable_sasl should have a tooltip.