Skip to content

Commit ddb9a55

Browse files
committed
fix(clustered): clarify compactor scaling guidance for CPU and memory
Addresses customer confusion where scaling CPU alone doesn't improve compactor performance. Compactor concurrency scales based on memory allocation, not CPU count, so both resources should be scaled together. Closes influxdata/DAR#514 add related links fix(clustered): correct anchor link in scale-cluster documentation Fix broken internal anchor link from #rrecommended-scaling-strategies-per-component to #recommended-scaling-strategies-per-component (removed extra 'r'). This was used to test the improved link-checker anchor validation functionality. fix(clustered): correct anchor link in scale-cluster documentation Fixes broken anchor link #rrecommended-scaling-strategies-per-component to the correct #recommended-scaling-strategies-per-component
1 parent b962b17 commit ddb9a55

File tree

2 files changed

+33
-3
lines changed

2 files changed

+33
-3
lines changed

TESTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,31 @@ link-checker check public/path/to/file.html
184184
link-checker config
185185
```
186186

187+
### Link Resolution Behavior
188+
189+
The link-checker automatically handles relative link resolution based on the input type:
190+
191+
**Local Files → Local Resolution**
192+
```bash
193+
# When checking local files, relative links resolve to the local filesystem
194+
link-checker check public/influxdb3/core/admin/scale-cluster/index.html
195+
# Relative link /influxdb3/clustered/tags/kubernetes/ becomes:
196+
# → /path/to/public/influxdb3/clustered/tags/kubernetes/index.html
197+
```
198+
199+
**URLs → Production Resolution**
200+
```bash
201+
# When checking URLs, relative links resolve to the production site
202+
link-checker check https://docs.influxdata.com/influxdb3/core/admin/scale-cluster/
203+
# Relative link /influxdb3/clustered/tags/kubernetes/ becomes:
204+
# → https://docs.influxdata.com/influxdb3/clustered/tags/kubernetes/
205+
```
206+
207+
**Why This Matters**
208+
- **Testing new content**: Tag pages generated locally will be found when testing local files
209+
- **Production validation**: Production URLs validate against the live site
210+
- **No false positives**: New content won't appear broken when testing locally before deployment
211+
187212
### Content Mapping Workflows
188213

189214
#### Scenario 1: Map and check InfluxDB 3 Core content

content/influxdb3/clustered/admin/scale-cluster.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ menu:
88
parent: Administer InfluxDB Clustered
99
name: Scale your cluster
1010
weight: 207
11-
influxdb3/clustered/tags: [scale]
11+
influxdb3/clustered/tags: [scale, performance, Kubernetes]
1212
related:
1313
- /influxdb3/clustered/reference/internals/storage-engine/
14+
- /influxdb3/clustered/write-data/best-practices/data-lifecycle/
15+
- /influxdb3/clustered/query-data/troubleshoot-and-optimize/optimize-queries/
1416
- https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits, Kubernetes resource requests and limits
1517
---
1618

@@ -559,11 +561,14 @@ concurrency demands or reaches the hardware limits of your underlying nodes.
559561

560562
### Compactor
561563

562-
- **Recommended**: Maintain **1 Compactor pod** and use [vertical scaling](#vertical-scaling) (especially
563-
increasing the available CPU) for the Compactor.
564+
- **Recommended**: Maintain **1 Compactor pod** and use [vertical scaling](#vertical-scaling) for the Compactor.
565+
Scale CPU and memory resources together, as compactor concurrency settings scale based on memory, not CPU count.
564566
- Because compaction is a compute-heavy process, horizontal scaling increases compaction throughput, but not as
565567
efficiently as vertical scaling.
566568

569+
> [!Important]
570+
> When scaling the Compactor, scale CPU and memory resources together.
571+
567572
### Garbage collector
568573

569574
The [Garbage collector](/influxdb3/clustered/reference/internals/storage-engine/#garbage-collector) is a lightweight process that typically doesn't require

0 commit comments

Comments
 (0)