DOC-1478 update consumer group lag in Cloud #347
Conversation
✅ 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 📝 WalkthroughWalkthroughThe changes update the prerequisites section of the 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 (
|
![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
🧹 Nitpick comments (2)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (2)
12-13: Avoid hard-coding the Redpanda version; use an AsciiDoc attribute instead
Hard-coding25.1.2+will require a sweep across many docs on every release. Prefer something like{rp-version}+(or the existing project-wide attribute) to ensure the number auto-updates.-* *Redpanda version 25.1.2+*: To configure cluster properties, the cluster must be running Redpanda version 25.1.2 or later. +* *Redpanda version {rp-version}+*: To configure cluster properties, the cluster must be running Redpanda version {rp-version} or later.
14-16: Surface therpk cloud logincommand as a fenced code block for better readability
Inline code gets lost in long paragraphs. Presenting the command as a short snippet improves scanning and copy/paste.-To verify that you're running `rpk` in the correct cloud context, run `rpk cloud login` and select your cluster. +To verify that you're running `rpk` in the correct cloud context, run: + +[source,bash] +---- +rpk cloud login +---- +Then select your cluster.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/manage/pages/cluster-maintenance/config-cluster.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#334
File: modules/networking/partials/psc-api2.adoc:15-16
Timestamp: 2025-06-18T21:02:38.074Z
Learning: In the Redpanda Cloud documentation system, cross-reference anchors using the format `#patch-/v1/clusters/-cluster.id-` work correctly for referencing API endpoints, even with dashes instead of curly braces around parameter names.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#261
File: modules/get-started/pages/cluster-types/byoc/aws/create-byoc-cluster-aws.adoc:46-50
Timestamp: 2025-04-18T19:43:32.991Z
Learning: In the Redpanda documentation using AsciiDoc format, explanatory text that provides additional information about a step should not be formatted as a separate numbered step. Instead, it should appear as regular text with bullets (using ** syntax) for any sub-points.
modules/manage/pages/cluster-maintenance/config-cluster.adoc (2)
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
⏰ 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
kbatuigas
left a comment
kbatuigas
left a comment
There was a problem hiding this comment.
Just one comment, but no blockers.
| * *`rpk` version 25.1.2+ and cloud context*: To use `rpk` to configure cluster properties, you must be using `rpk` version 25.1.2 or later. To check your current version, see xref:manage:rpk/rpk-install.adoc[]. | ||
| + | ||
| To verify that you're running `rpk` in the correct cloud context, run `rpk cloud login` and select your cluster. |
There was a problem hiding this comment.
I'm not sure about "cloud context", it seems a little vague to me. The second paragraph indicates that it's something to do with rpk talking to the correct target cluster - I think if we explain it that way, it's more simple and direct than leaving it at "cloud context".
There was a problem hiding this comment.
instead of context, should this say something like "ensure you're logged into the control plane with rpk and you have the appropriate rpk profile configured for the target cluster?
There was a problem hiding this comment.
@hcoyote do you need to do this (log into control plane with rpk...) even in you plan to configure cluster properties only via the Cloud API (and not rpk); i.e., is this rpk prereq required even if you don't configure properties with rpk?
Description
This pull request updates the documentation in
config-cluster.adocto clarify prerequisites for configuring cluster properties. The changes emphasize version requirements and provide additional instructions for verifying therpkcloud context.Redpandaandrpkversion numbers. ([modules/manage/pages/cluster-maintenance/config-cluster.adocL12-R16](https://github.com/redpanda-data/cloud-docs/pull/347/files#diff-c8fbb49e2369d966902a69910a95b4e432a6931f6efaf898897f416acbd9cd8dL12-R16))rpkcloud context by runningrpk cloud loginand selecting the appropriate cluster. ([modules/manage/pages/cluster-maintenance/config-cluster.adocL12-R16](https://github.com/redpanda-data/cloud-docs/pull/347/files#diff-c8fbb49e2369d966902a69910a95b4e432a6931f6efaf898897f416acbd9cd8dL12-R16))Resolves https://redpandadata.atlassian.net/browse/DOC-1478
Review deadline:
Page previews
Configure Cluster Properties - Prerequisites
Checks