Update Iceberg catalog doc for Cloud (single source) #1113
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe changes update the Antora playbook configuration to source documentation from a specific feature branch in the Sequence Diagram(s)sequenceDiagram
participant User
participant rpk CLI / Data Plane API
participant Secret Store
participant Cluster Configuration
User->>rpk CLI / Data Plane API: Create secret (Base64-encoded, scope: SCOPE_REDPANDA_CLUSTER)
rpk CLI / Data Plane API->>Secret Store: Store secret value
User->>rpk CLI / Control Plane API: Add secret reference to cluster config
rpk CLI / Control Plane API->>Cluster Configuration: Update with secret reference
Assessment against linked issues
Possibly related PRs
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
local-antora-playbook.yml(1 hunks)modules/manage/partials/iceberg/use-iceberg-catalogs.adoc(2 hunks)
🔇 Additional comments (3)
local-antora-playbook.yml (1)
20-20: Ensure the feature branch exists
You’ve updated thebranchesvalue tobranches: 'DOC-1216-Document-how-to-pass-in-secrets-when-configuring-iceberg'Please verify that this branch is present in the
redpanda-data/cloud-docsrepository and includes the intended cloud secret-management content before merging.modules/manage/partials/iceberg/use-iceberg-catalogs.adoc (2)
41-43: Add cloud-only “Store a secret” section
The newifdef::env-cloud[] ... endif::[]wrapper and “Store a secret for REST authentication” heading correctly scope these instructions to cloud deployments. This aligns with the existing pattern for environment-specific content.
176-179: Verify the Snowflake-hide conditional
You’ve wrapped the Snowflake tip in anifndef::env-cloud[] … endif::[]to hide it in cloud builds. This correctly prevents the tip from appearing in cloud docs—please confirm in a local preview that the section is suppressed whenenv-cloudis set.
kbatuigas
changed the title
| ifdef::env-cloud[] | ||
| === Store a secret for REST authentication | ||
|
|
||
| To store a secret that you can reference in your catalog authentication cluster properties, you must create the secret using `rpk` or the Data Plane API. Secrets are stored in the secret management solution of your cloud provider. Redpanda retrieves the secrets at runtime. |
There was a problem hiding this comment.
Need SME to confirm this description and behavior
alenkacz
left a comment
alenkacz
left a comment
There was a problem hiding this comment.
Left some comments, looks great though 👏
|
|
||
| To store a secret that you can reference in your catalog authentication cluster properties, you must create the secret using `rpk` or the Cloud API. Secrets are stored in the secret management solution of your cloud provider. Redpanda retrieves the secrets at runtime. | ||
|
|
||
| To learn more about `rpk` and the Cloud API, see xref:manage:rpk/intro-to-rpk.adoc[] and xref:manage:api/cloud-api-overview.adoc[]. |
There was a problem hiding this comment.
again this should probably talk about dataplane api, right?
There was a problem hiding this comment.
To get the data plane API url, users have to authenticate and then call the Control Plane API first. I'll change it to specifically say "you must create the secret using... the Data Plane API," but I think directing them to the overview doc to learn more about the API in general is still appropriate.
| - This scope: `"SCOPE_REDPANDA_CLUSTER"`. | ||
| + | ||
| The response returns the name of the secret and the scope `"SCOPE_REDPANDA_CLUSTER"`. |
Co-authored-by: Michele Cyran <[email protected]>
kbatuigas
force-pushed
the
DOC-1216-single-source
branch
from
c9b4c30 to
e7f6813
Compare
Description
This pull request introduces updates to the documentation for configuring Iceberg catalog integrations in Redpanda, with a focus on adding instructions for passing secrets in cloud environments. Key changes include updating branch references in the Antora playbook, adding detailed steps for secret management, and refining content visibility based on the environment.
Documentation Updates for Iceberg Catalog Integration:
Secret Management for Cloud Environments:
rpkand the Data Plane API to create secrets and update cluster configurations.Environment-Specific Visibility:
Antora Playbook Configuration:
cloud-docsRepository:cloud-docsrepository toDOC-1216-Document-how-to-pass-in-secrets-when-configuring-iceberg.Resolves https://redpandadata.atlassian.net/browse/
Review deadline: 9 May
Page previews
Self-managed > Use Iceberg Catalogs
Cloud > Use Iceberg Catalogs > Store a secret for REST catalog authentication
Checks