Skip to content

Add a section about operational readiness#556

Open
hammerhead wants to merge 1 commit intomainfrom
hammerhead/operational-readiness
Open

Add a section about operational readiness#556
hammerhead wants to merge 1 commit intomainfrom
hammerhead/operational-readiness

Conversation

@hammerhead
Copy link
Member

@hammerhead hammerhead commented Feb 24, 2026

About

This adds a section about aspects to watch our for before going live with CrateDB, or also regularly while already being live.

Preview

https://cratedb-guide--556.org.readthedocs.build/admin/going-into-production.html#operational-readiness

@coderabbitai
Copy link

coderabbitai bot commented Feb 24, 2026

Warning

Rate limit exceeded

@hammerhead has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 47 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b2def66 and 9541864.

📒 Files selected for processing (1)
  • docs/admin/going-into-production.md

Walkthrough

Adds an "Operational readiness" section to docs/admin/going-into-production.md with a production checklist (cluster health, lifecycle/maintenance, disaster planning/recovery, self-managed requirements, support readiness). Updates two "Unix-like" mentions and reference entries (removes two legacy refs, adds two new refs; anchors updated).

Changes

Cohort / File(s) Summary
Documentation Update
docs/admin/going-into-production.md
Added a new "Operational readiness" (prod-monitoring) checklist covering cluster health/metrics, capacity and lifecycle guidance, disaster planning & recovery, self-managed requirements (TLS, monitoring, snapshots), and support readiness. Reworded two "Unix-like" mentions, removed [path.data] and [raid 0] references, added [support terms] and [system table export], and updated reference anchors.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

cross linking, guidance

Poem

🐇 I hopped through docs with checklist in paw,
Tucking metrics and snapshots into the law,
TLS snug, recovery paths bright,
Support and health all set for the night,
Hop—production's ready; I take a bow.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically identifies the main change: adding a section about operational readiness, which aligns with the changeset that adds the prod-monitoring section with production checklist content.
Description check ✅ Passed The description is directly related to the changeset, explaining that it adds documentation about operational readiness aspects for CrateDB deployment and monitoring, which matches the additions in the documentation file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch hammerhead/operational-readiness

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]

This comment was marked as resolved.

@hammerhead hammerhead force-pushed the hammerhead/operational-readiness branch from d80b57a to 387f7c3 Compare February 24, 2026 16:34
coderabbitai[bot]

This comment was marked as outdated.

@hammerhead hammerhead force-pushed the hammerhead/operational-readiness branch 3 times, most recently from 207412b to b4db45c Compare February 24, 2026 16:54
@hammerhead hammerhead marked this pull request as ready for review February 24, 2026 16:55
coderabbitai[bot]

This comment was marked as resolved.

@hammerhead hammerhead force-pushed the hammerhead/operational-readiness branch from b4db45c to b9cda1a Compare February 24, 2026 17:00
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/admin/going-into-production.md (1)

412-415: Use active voice in the disk-usage bullet. Consider rephrasing to keep instructions direct (e.g., “If disk usage exceeds the low watermark threshold, CrateDB will no longer allocate new shards…”).

Based on learnings: “When reviewing documentation, use active voice instead of first-person or passive voice, and emit corresponding suggestions.”

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/admin/going-into-production.md` around lines 412 - 415, Rephrase the
"Disk usage" bullet to use active voice and a direct instruction: replace the
passive construction with something like "If disk usage exceeds the low
watermark threshold (cluster.routing.allocation.disk.watermark.low), CrateDB
will stop allocating new shards on affected nodes; monitor disk usage to ensure
seamless shard allocation." Edit the bullet under "Cluster health and capacity
management" (the "Disk usage" line referencing
cluster.routing.allocation.disk.watermark.low) to this active, imperative style
and keep the same reference link.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/admin/going-into-production.md`:
- Around line 412-415: Rephrase the "Disk usage" bullet to use active voice and
a direct instruction: replace the passive construction with something like "If
disk usage exceeds the low watermark threshold
(cluster.routing.allocation.disk.watermark.low), CrateDB will stop allocating
new shards on affected nodes; monitor disk usage to ensure seamless shard
allocation." Edit the bullet under "Cluster health and capacity management" (the
"Disk usage" line referencing cluster.routing.allocation.disk.watermark.low) to
this active, imperative style and keep the same reference link.

ℹ️ Review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4db45c and b9cda1a.

📒 Files selected for processing (1)
  • docs/admin/going-into-production.md

@hammerhead hammerhead force-pushed the hammerhead/operational-readiness branch from b9cda1a to 7919413 Compare February 25, 2026 07:03
coderabbitai[bot]

This comment was marked as outdated.

@hammerhead hammerhead force-pushed the hammerhead/operational-readiness branch from 7919413 to b2def66 Compare February 25, 2026 07:09
coderabbitai[bot]

This comment was marked as resolved.

@hammerhead hammerhead force-pushed the hammerhead/operational-readiness branch from b2def66 to 9541864 Compare February 25, 2026 07:16
@amotl amotl added the sanding-1200 Fine sanding. label Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sanding-1200 Fine sanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants