Skip to content

DOC-13223: Added guardrails details to server docs #3808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 16, 2025
Merged

DOC-13223: Added guardrails details to server docs #3808

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4371c52
DOC-13223: Added guardrails details to server docs
TimLFletcher May 15, 2025
89b703d
Update sizing-general.adoc
TimLFletcher May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions modules/install/pages/sizing-general.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,40 @@ A reliable high-speed network for intra-cluster and inter-cluster communications
+
Most deployments can achieve optimal performance with 1 Gbps interconnects, but some may need 10 Gbps.


[#guardrails]
==== Couchbase Server Guardrails

For safe and reliable cluster operations, and to minimize the severity of cluster outages, clusters using Couchbase Server 7.6 or later have guardrails in place.
These guardrails proactively monitor for specific system thresholds.
When a cluster meets these thresholds, these guardrails automatically prevent the following cluster operations, which during these conditions can put the cluster at severe risk of outage and downtime:

* Bucket writes
* Bucket creation
* Collection creation
* Topology changes that involve rebalancing

Server-level enforcement thresholds are designed to ensure the optimal and reliable usage of available system resources by various workloads.
These thresholds are as follows:

[Attributes]
|===
|Cluster Metric |Threshold

|Data Service Resident Ratio (Couchstore)
|\<= 1%
Copy link
Collaborator

@osfameron osfameron May 16, 2025

Choose a reason for hiding this comment

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

I think this is fine, but I did wonder if it needs the backslash escape?
and whether <= is clear enough without explanation (but should be fine, is used elsewhere in docs-server in a text context, once, and I don't see any counter-indications in the style guide.


|Data Service Resident Ratio (Magma)
|\<= 0.1%

|Free Disk Space
|\<= 4%

|# of Buckets
Copy link
Contributor

@RichardSmedley RichardSmedley May 16, 2025

Choose a reason for hiding this comment

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

Is it better to spell out as "Number of Buckets",
as use of the octothorpe is not entirely universal beyond American English?
(Close to universal, but not as unambiguous as writing 'number')

Copy link
Contributor Author

@TimLFletcher TimLFletcher May 16, 2025

Choose a reason for hiding this comment

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

I think that's a fair suggestion. Changed.

|\<= 0.2 cores per bucket

|===

== Sizing Data Service Nodes

Data Service nodes handle data service operations, such as create/read/update/delete (CRUD).
Expand Down