Skip to content

Commit aa418ce

Browse files
committed
docs(design): address CodeRabbit review (typo + code-fence language tags)
CodeRabbit round 1 on PR #637: - s3_raft_blob_offload.md:358 typo "elegibility" → "eligibility" (single character). - Add `text` language identifier to the six previously-bare fenced code blocks (the §1 worst-case formula in admission_control, the §3.3 client/admission flow diagram in admission_control, the §3.5 metrics block in admission_control, the §1 Raft-log flow in blob_offload, the §3.1 keyspace block in blob_offload, and the §3.2 PUT pipeline diagram in blob_offload). Markdownlint flags bare fences; tagging them enables both linting compliance and consistent syntax highlighting in the rendered docs. No code changes; design docs only.
1 parent 1fb39ba commit aa418ce

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/design/2026_04_25_proposed_s3_admission_control.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ with `MaxSizePerMsg`, the **aggregate** in-flight memory bound is
2222
governed by client concurrency, which the server cannot currently
2323
limit:
2424

25-
```
25+
```text
2626
leader-side worst-case = concurrent_PUTs × pending_entries_per_PUT × entry_size
2727
≈ concurrent_PUTs × MaxInflight × 4 MiB
2828
```
@@ -105,7 +105,7 @@ Recommended: **both, at different scales**.
105105
fails with 503 mid-stream. Dispatch latency stays bounded by the
106106
semaphore size rather than by client behaviour.
107107

108-
```
108+
```text
109109
client ─[Content-Length]─► (A) reserve full body bytes
110110
111111
@@ -323,7 +323,7 @@ materialise by default.
323323

324324
### 3.5 Metrics
325325

326-
```
326+
```text
327327
elastickv_s3_put_admission_inflight_bytes gauge
328328
elastickv_s3_put_admission_rejections_total counter (labels:
329329
stage = "prereserve" | "perbatch",

docs/design/2026_04_25_proposed_s3_raft_blob_offload.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
Today every byte of an S3 object travels through the Raft log:
2222

23-
```
23+
```text
2424
HTTP PUT body ─► s3ChunkSize (1 MiB) chunks
2525
─► s3ChunkBatchOps × 1 MiB Raft entry
2626
─► Raft log entry (Pebble WAL on every node)
@@ -102,7 +102,7 @@ themselves*.
102102

103103
### 3.1 New keyspace
104104

105-
```
105+
```text
106106
!s3|chunkref|<bucket>|<gen>|<objectKey>|<uploadID>|<partNo>|<chunkNo>
107107
→ ChunkRef{
108108
ContentSHA256 [32]byte
@@ -128,7 +128,7 @@ Two separate keyspaces:
128128

129129
### 3.2 PUT path
130130

131-
```
131+
```text
132132
client ─► HTTP PUT body
133133
─► chunk loop (s3ChunkSize):
134134
1. compute SHA-256 of chunk
@@ -355,7 +355,7 @@ sweeper needs to know not just *that* the RC reached zero but
355355
would drive it to zero, the *same* txn additionally writes
356356
`!s3|chunkblob-gc-queue|<commitTS-nanos>|<SHA>` → empty. The
357357
commitTS-prefixed key is the time signal: the queue is
358-
naturally sorted by elegibility-start time, and any node can
358+
naturally sorted by eligibility-start time, and any node can
359359
determine the grace-period boundary by scanning the queue with
360360
`endKey = !s3|chunkblob-gc-queue|<now-gracePeriod>|`. If a
361361
subsequent txn re-references the same SHA before the sweeper

0 commit comments

Comments
 (0)