Skip to content

Commit ac7a9a9

Browse files
authored
HDDS-14199. [Docs] Explain how EC write pipelines are calculated (#9520)
1 parent 90994bb commit ac7a9a9

2 files changed

Lines changed: 36 additions & 1 deletion

File tree

hadoop-hdds/docs/content/feature/ErasureCoding.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,41 @@ When using ofs/o3fs, we can pass the EC Replication Config by setting the config
228228

229229
In the case bucket already has default EC Replication Config, there is no need of passing EC Replication Config while creating key.
230230

231+
#### Calculating EC Pipeline Limits
232+
233+
The target number of open EC pipelines SCM aims to maintain is calculated dynamically for each EC replication configuration (e.g., RS-6-3, RS-3-2). The calculation is based on the following two properties, with the final target being the greater of the two resulting values.
234+
235+
* `ozone.scm.ec.pipeline.minimum`
236+
* **Description**: The guaranteed minimum number of open pipelines to maintain for each EC configuration, regardless of other factors.
237+
* **Default Value**: `5`
238+
239+
* `ozone.scm.ec.pipeline.per.volume.factor`
240+
* **Description**: A factor used to calculate a target number of pipelines based on the total number of healthy volumes across all datanodes in the cluster.
241+
* **Default Value**: `1.0`
242+
243+
**Calculation Logic:**
244+
245+
SCM first calculates a volume-based target using the formula:
246+
`(<pipeline.per.volume.factor> * <total healthy volumes>) / <required nodes for EC config>`
247+
248+
The final target number of pipelines is then determined by:
249+
`max(<volume-based target>, <pipeline.minimum>)`
250+
251+
**Example:**
252+
253+
Consider a cluster with **200 total healthy volumes** across all datanodes and an EC policy of **RS-6-3** (which requires 9 nodes).
254+
* `ozone.scm.ec.pipeline.minimum` = **5** (default)
255+
* `ozone.scm.ec.pipeline.per.volume.factor` = **1.0** (default)
256+
257+
1. The volume-based target is: `(1.0 * 200) / 9 = 22`
258+
2. The final target is: `max(22, 5) = 22`
259+
260+
SCM will attempt to create and maintain approximately **22** open, RS-6-3 EC pipelines.
261+
262+
**Production Recommendation:**
263+
264+
The default values are a good starting point for most clusters. If you have a very high number of volumes and a write-heavy EC workload, you might consider slightly increasing the `pipeline.per.volume.factor`. Conversely, for read-heavy workloads, the default minimum of 5 pipelines is often sufficient.
265+
231266
### Enable Intel ISA-L
232267

233268
Intel Intelligent Storage Acceleration Library (ISA-L) is an open-source collection of optimized low-level functions used for

hadoop-hdds/docs/content/start/ProductionDeployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,5 +85,5 @@ A typical production Ozone cluster includes the following services:
8585
### Ozone Configuration
8686

8787
* **Monitoring**: Install Prometheus and Grafana for monitoring the Ozone cluster. For audit logs, consider using a log ingestion framework such as the ELK Stack (Elasticsearch, Logstash, and Kibana) with FileBeat, or other similar frameworks. Alternatively, you can use Apache Ranger to manage audit logs.
88-
* **Pipeline Limits**: Increase the number of allowed write pipelines to better suit your workload by adjusting `ozone.scm.datanode.pipeline.limit` and `ozone.scm.ec.pipeline.minimum`.
88+
* **Pipeline Limits**: Increase the number of allowed write pipelines to better suit your workload by adjusting `ozone.scm.datanode.pipeline.limit` (for Ratis) and `ozone.scm.ec.pipeline.minimum` (for EC).
8989
* **Heap Sizes**: Configure sufficient heap sizes for Ozone Manager (OM), Storage Container Manager (SCM), Recon, DataNode, S3 Gateway (S3G), and HttpFs services to ensure stability.

0 commit comments

Comments
 (0)