DOC-2277: Warn that BYOC GCP credential rotation needs Support#625
Conversation
Add a "Service account credential rotation" callout to the GCP IAM Policies and Create a BYOC Cluster on GCP pages, explaining that GCP service account credential rotation is not self-service and must be coordinated with Redpanda Support. The callout lives in a shared partial included by both pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughA new AsciiDoc partial file, Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Address review feedback on the disruption warning: add agent connectivity, specify tiered storage uploads, and replace "unrecoverable state" with cluster stuck and unable to complete future operations. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Feediver1
left a comment
There was a problem hiding this comment.
Check out Claude'a suggestions re other pages that may be impacted.
Feediver1
left a comment
There was a problem hiding this comment.
Final-pass review (docs-team-standards)
Overall: Clean, well-scoped, incident-driven doc-gap fix. SME-reviewed and approved, correct single-sourcing and heading levels. No critical issues — one cross-platform follow-up worth flagging.
What this PR does
Adds a Service account credential rotation warning to two BYOC GCP pages (GCP IAM Policies; Create a BYOC Cluster on GCP) via a single shared partial, telling customers that GCP service account credential rotation is not self-service and must be coordinated with Redpanda Support — closing the gap behind incident ZD-6896.
Jira alignment
DOC-2277 — fully addressed: the missing warning + safe "contact Support" path, on the two pages a GCP operator would look. (Couldn't fetch the ticket directly via MCP, but the content matches the PR's stated requirement. Internal CIAINFRA-3907 ref correctly omitted from public docs.)
Critical issues
None. Verified:
- Partial resolves —
security:partial$byoc-gcp-credential-rotation.adoccreated here; both consumers use correct full cross-module include syntax. - Heading levels correct — the partial's
== Service account credential rotationlands as a proper H2 sibling in both pages. - No single-source risk — these GCP pages and
iam-policies.adocare cloud-docs-native (env-gated, not single-sourced fromdocs), so a cloud-docs partial is consistent. - No nav change needed — content added to existing pages.
Suggestions
- Impact — AWS/Azure equivalents. Sibling pages exist (
cloud-iam-policies.adocAWS,cloud-iam-policies-azure.adoc, andcreate-byoc-cluster-aws/azure.adoc). If credential rotation is also Support-coordinated for BYOC on AWS/Azure (likely, given shared BYOC architecture), those pages have the same gap. Out of scope for DOC-2277 (GCP incident), but worth a follow-up ticket so the warning isn't GCP-only. - Minor — ordering. The how-to ("contact Support to rotate") precedes the WARNING. Conventionally the risk warning leads, then the safe path. Current order is a deliberate choice and reads fine; optional to flip.
Impact on other files
- AWS/Azure BYOC pages — see suggestion 1 (follow-up, not a blocker).
- No What's New entry needed (safety/clarity fix, not a feature). No broken xrefs.
CodeRabbit
No inline findings posted.
What works well
- Single shared partial keeps both pages in sync — the right pattern for identical warning text.
- SME review tightened the disruption list (agent connectivity, tiered storage uploads) and replaced "unrecoverable state" with the more accurate "stuck and unable to complete future operations."
- WARNING tone calibrated — "can disrupt… can leave the cluster stuck" frames risk without overstating.
- Internal ticket reference kept out of public docs.
🤖 Automated final-pass review via docs-team-standards pr-review.
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
|
Confirmed with Matteo that we'll merge this now and if/when we get confirmation about AWS & Azure, we'll update the doc for them similarly. |
What
Adds a Service account credential rotation callout to two BYOC GCP pages:
cloud-iam-policies-gcp.adoc) — new section at the bottom.create-byoc-cluster-gcp.adoc) — section before "Next steps".The callout text lives in a single shared partial (
security:partial$byoc-gcp-credential-rotation.adoc) included by both pages, so it stays in sync.Why
Customer incident ZD-6896: a BYOC GCP customer rotated their GCP service account credentials without coordinating with Redpanda Support. The agent lost connectivity, the cluster stuck in "Upgrading," tiered storage was disrupted, and recovery took 8 days of Engineering effort. The docs never warned that credential rotation is not self-service. This PR closes that gap.
Resolves DOC-2277.
Notes
[WARNING]admonition for the not-self-service / disruption risk, with the "contact Support" instructions as body text above it.Preview pages
🤖 Generated with Claude Code