DOC-1356 single source read-only properties in cloud

[micheleRP]

Description

This pull request tags cluster config properties for single sourcing them into Cloud docs (updated in redpanda-data/cloud-docs#295)

Resolves https://redpandadata.atlassian.net/browse/DOC-1356
Review deadline: Monday May 19

Page previews

Cluster Configuration Properties Reference in Cloud
Configure Cluster Properties in Cloud

Checks

• New feature
• Content gap
• Support Follow-up
• Small fix (typos, links, copyedits, etc)

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes add explicit documentation tags (// tag::...[] and // end::...[]) around several cluster configuration property blocks in the cluster-properties.adoc documentation file. These tags are placed before and after the definitions of specific properties, such as audit log partitions, cluster ID, log segment settings, authentication mechanisms, and others. The purpose of these tags is to enable modular referencing or extraction of these property descriptions within the documentation system. No modifications are made to the actual property descriptions, values, or semantics.

Assessment against linked issues

Objective	Addressed	Explanation
Set up single sourcing for the cluster config properties that will be visible read-only in Cloud (DOC-1356)	✅

Possibly related PRs

• DOC-1282 rpk cluster config for cloud wasm #1092: Both PRs modify documentation related to cluster configuration properties, with this PR adding documentation tags and the related PR enhancing instructions for enabling data transforms.

Suggested reviewers

• alenkacz
• asimms41

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	b36782d
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/682cb052638d0b0008ddd2f8
😎 Deploy Preview	https://deploy-preview-1128--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[JakeSCahill]

In the Cloud PR, you are trying to single-source these tags, but they don't exist in the doc:

• cloud_storage_azure_storage_account
• cloud_storage_azure_container

[micheleRP]

In the Cloud PR, you are trying to single-source these tags, but they don't exist in the doc:

• cloud_storage_azure_storage_account
• cloud_storage_azure_container

oh, right. I'll single source those from the object storage props page on Monday!

[alenkacz]

LGTM just one comment

[alenkacz]

We forgot to update the google sheet but cluster_id won't be exposed

[micheleRP]

thanks, I've removed it from Cloud docs