DOC-1401 RPCN Secrets navigation change in UI #386
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 📝 WalkthroughWalkthrough
Sequence Diagram(s)sequenceDiagram
actor User
participant CloudUI as Cloud UI (Secrets Store)
participant API as Data Plane API
participant Pipeline as Data Pipeline Service
User->>CloudUI: Navigate to Secrets Store
User->>CloudUI: Create/Update/Delete Secret (ID, Value, Scopes)
CloudUI->>API: POST/PUT/DELETE /v1/secrets
API-->>CloudUI: Success/Failure
User->>CloudUI: Create/Edit Data Pipeline
CloudUI->>Pipeline: Configure connector with secret reference
Pipeline->>API: Retrieve secret by ID (scoped)
API-->>Pipeline: Secret value
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
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 comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🔭 Outside diff range comments (1)
modules/develop/pages/connect/configuration/resource-management.adoc (1)
179-193: Fix invalid curl example JSON and smart quotes; current sample won’t parse.
- The block attribute uses smart quotes: role=“no-placeholders”.
- The JSON payload is malformed (missing/extra commas) and includes stray backslashes from line continuations inside the JSON string.
Apply this diff to correct the block attribute and payload:
-[,bash,role=“no-placeholders”] +[source,bash,role="no-placeholders"] ---- curl -X PUT "https://<data-plane-api-url>/v1/redpanda-connect/pipelines/xxx..." \ -H 'accept: application/json'\ -H 'authorization: Bearer xxx...' \ -H "content-type: application/json" \ - -d '{"config_yaml":"input:\n generate:\n interval: 1s\n mapping: |\n root.id = uuid_v4()\n root. user.name = fake(\"name\")\n root.user.email = fake(\"email\")\n root.content = fake(\"paragraph\")\n\npipeline:\n processors:\n - mutation: |\n root.title = \"PRIVATE AND CONFIDENTIAL\"\n\noutput:\n kafka_franz:\n seed_brokers:\n - seed-j888.byoc.prd.cloud.redpanda.com:9092\n sasl:\n - mechanism: SCRAM-SHA-256\n password: password\n username: connect\n topic: processed-emails\n tls:\n enabled: true\n", \ - "description":"Email processor", \ - "display_name":"emailprocessor-pipeline", \ - "resources":{ \ - "memory_shares":"800M" \ - "cpu_shares":"200m", \ - } \ - }' + -d '{ + "config_yaml": "input:\n generate:\n interval: 1s\n mapping: |\n root.id = uuid_v4()\n root.user.name = fake(\"name\")\n root.user.email = fake(\"email\")\n root.content = fake(\"paragraph\")\n\npipeline:\n processors:\n - mutation: |\n root.title = \"PRIVATE AND CONFIDENTIAL\"\n\noutput:\n kafka_franz:\n seed_brokers:\n - seed-j888.byoc.prd.cloud.redpanda.com:9092\n sasl:\n mechanism: SCRAM-SHA-256\n password: password\n username: connect\n topic: processed-emails\n tls:\n enabled: true\n", + "description": "Email processor", + "display_name": "emailprocessor-pipeline", + "resources": { + "memory_shares": "800M", + "cpu_shares": "200m" + } + }' ----
🧹 Nitpick comments (5)
modules/develop/pages/connect/configuration/resource-management.adoc (1)
145-147: Minor grammar fix: add “in”.“are displayed milliCPU” → “are displayed in milliCPU”.
-* CPU resources (`cpu_shares`) are displayed milliCPU. For example, `1` compute unit is `100m` or 0.1 CPU. +* CPU resources (`cpu_shares`) are displayed in milliCPU. For example, `1` compute unit is `100m` or 0.1 CPU.modules/develop/pages/connect/configuration/secret-management.adoc (4)
21-23: Add a short visibility note for Secrets Store (helps users who don’t see it).. Log in to https://cloud.redpanda.com[Redpanda Cloud^]. -. Go to the **Secrets Store** page. +. Go to the **Secrets Store** page. ++ +[NOTE] +==== +If you don’t see the Secrets Store page, contact Redpanda Support to enable it for your organization. +====
24-27: Document ID naming constraints here to match API rules.Prevents UI/API mismatch later.
-. For **ID**, enter a name for the secret. You cannot rename the secret once it is created. +. For **ID**, enter a name for the secret. You cannot rename the secret once it is created. The ID must start with an uppercase letter and contain only uppercase letters, digits, or underscores.
55-57: Clarify Base64 requirement with a quick example.Adds a one-liner users can copy.
- `<secret-value>`: The Base64-encoded secret. - This scope: `"SCOPE_REDPANDA_CONNECT"`. + +For example, to Base64-encode a value: + +[source,bash] +---- +echo -n 'my-secret-value' | base64 +----
164-166: Clarify where the quick-add “Secret” button is located.Tiny tweak for discoverability in the UI.
-. Click the quick-add **Secret** button to add a new or existing secret to the pipeline. +. Click the quick-add **Secret** button (in the configuration editor toolbar) to add a new or existing secret to the pipeline.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
modules/develop/pages/connect/configuration/resource-management.adoc(1 hunks)modules/develop/pages/connect/configuration/secret-management.adoc(6 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 - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (1)
modules/develop/pages/connect/configuration/resource-management.adoc (1)
9-9: BYOVPC/BYOVNet support reflected — looks good.Change aligns with DOC-1401 goals and unified prerequisites.
paulohtb6
reviewed
Aug 11, 2025
paulohtb6
reviewed
Aug 11, 2025
|
|
||
| + | ||
| If you cannot see a **Secrets** tab, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^] | ||
| Secrets are stored in the secret management solution of your cloud provider and are retrieved when you run a pipeline configuration that references them. |
There was a problem hiding this comment.
should we try to tell them where? Or we're being purposefuly vague here because this is documenting a 3rd party product (style guide + high risk of going out-of-date)?
paulohtb6
reviewed
Aug 11, 2025
modules/develop/pages/connect/configuration/secret-management.adoc
Outdated
Show resolved
Hide resolved
paulohtb6
approved these changes
Aug 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Secret Management Documentation Improvements:
Resource Management Prerequisites:
Resolves https://redpandadata.atlassian.net/browse/DOC-1401
Review deadline:
Page previews
Manage Secrets
Checks