Enclose secrets in single quotes #1340
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 PR updates documentation examples in four AsciiDoc files to wrap secret placeholders in single quotes. Changes occur in AWS Glue, Databricks Unity, Snowflake catalog pages, and a shared Iceberg catalogs partial. Lines like iceberg_rest_catalog_secret_key=${secrets.<...>} are revised to iceberg_rest_catalog_secret_key='${secrets.<...>}' in sample configurations and rpk cluster config set commands. No code or API changes are introduced; only doc snippets are modified. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Assessment against linked issues
Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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 project 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: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc (1)
152-161: Fix multiline command: missing trailing backslashes will break the rpk invocation.Lines for base_location, region, and access_key are missing trailing backslashes, causing the shell to start new commands mid-block. The new single-quoted secret is correct; just ensure the full block remains one command.
Apply this diff to restore proper line continuations:
rpk cluster config set \ iceberg_enabled=true \ iceberg_catalog_type=rest \ iceberg_rest_catalog_endpoint=https://glue.<glue-region>.amazonaws.com/iceberg \ iceberg_rest_catalog_authentication_mode=aws_sigv4 \ - iceberg_rest_catalog_base_location=s3://<bucket-name>/<warehouse-path> - iceberg_rest_catalog_aws_region=<glue-region> - iceberg_rest_catalog_aws_access_key=<glue-access-key> + iceberg_rest_catalog_base_location=s3://<bucket-name>/<warehouse-path> \ + iceberg_rest_catalog_aws_region=<glue-region> \ + iceberg_rest_catalog_aws_access_key=<glue-access-key> \ iceberg_rest_catalog_aws_secret_key='${secrets.<glue-secret-key-name>}'
🧹 Nitpick comments (2)
modules/manage/pages/iceberg/iceberg-topics-databricks-unity.adoc (1)
142-145: Secret is correctly single-quoted for Bash/zsh; consider a brief cross-OS note.On Windows cmd.exe, single quotes are literal characters; users there can omit quotes or use double quotes ("${secrets.<...>}"). Optional to add a short tip beneath the block to reduce copy/paste friction for Windows users.
modules/manage/partials/iceberg/use-iceberg-catalogs.adoc (1)
192-193: Good change; add a one-line rationale for readers.Consider adding a short sentence above the command: “Single quotes ensure the shell passes the literal ${secrets.} to rpk without expansion or word splitting.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc(1 hunks)modules/manage/pages/iceberg/iceberg-topics-databricks-unity.adoc(1 hunks)modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc(1 hunks)modules/manage/partials/iceberg/use-iceberg-catalogs.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc (1)
79-81: Quoting the secret prevents unwanted shell expansion — good call.Using single quotes around ${secrets.<...>} guarantees the literal is passed to rpk, which then resolves the secret on the server side. The surrounding multi-line command is syntactically correct (final argument without a trailing backslash).
Description
This PR modifies code examples that use a secret with
rpk cluster config setto update cluster properties. Single quotes are added around the secret to ensure that the shell doesn't try to interpret the secret as a variable, and the secret value gets passed into the cluster config correctly.Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks