docs(lfs): align gh-pages with PR #139 breaking changes#143
Merged
novatechflow merged 2 commits intoMay 17, 2026
Conversation
PR KafScale#139 (`fix/s3-bucket-takeover-cve` on main) introduced breaking changes to the LFS proxy. Documentation on gh-pages drifted; @novatechflow asked that gh-pages be updated alongside main so users don't follow stale guides. Changes to `_docs/lfs-proxy.md`: * Env var names: `LFS_*` → `KAFSCALE_LFS_PROXY_*` (the real names in cmd/proxy/lfs.go). * Replace `bucket: kafscale` example with `my-bucket` (the bucket name `kafscale-lfs` is permanently blocklisted at startup; using anything that looks like it invites future confusion). * Replace stale endpoint `POST /v1/topics/{topic}/records` with the real `POST /lfs/produce` (and pointer to the multipart upload endpoints). * New "Trust model and integrity verification" section documenting the buffer-then-verify download design, the required `integrity.sha256` AND `integrity.size` fields on stream mode, the `KAFSCALE_LFS_PROXY_ PRESIGN_ENABLED` opt-in for presign mode, and the new error codes (`integrity_failure`, `missing_integrity_size`, `payload_too_large`, `presign_disabled`). * Quick-start curl example switched to `/lfs/produce`. Changes to `_docs/lfs-helm.md`: * Same `bucket: kafscale` → `my-bucket` substitution with explanatory comment about the blocklist. Changes to `_docs/lfs-sdks.md`: * S3 bucket example: `kafscale` → `my-bucket`. * Resolve() example annotated to clarify the SDK populates the integrity claim from the envelope, and the proxy verifies before streaming. * Trust-model callout with link to the LFS Proxy doc. Companion to `KafScale#139`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
11 tasks
Collaborator
Author
|
Pushed follow-up commit 3ae607f to remove the remaining docs drift. What changed:
Verification:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Companion to KafScale/platform#139. Updates the three LFS docs on
gh-pagesso they reflect the breaking changes shipping in #139 — per @novatechflow's request to keepgh-pagesin sync withmain.What changed
_docs/lfs-proxy.mdLFS_*→KAFSCALE_LFS_PROXY_*(the actual names incmd/proxy/lfs.go). Bucket examplekafscale→my-bucket. EndpointPOST /v1/topics/{topic}/records→ realPOST /lfs/produce. New "Trust model and integrity verification" section documenting buffer-then-verify download, requiredintegrity.sha256+integrity.sizeon stream mode, presign opt-in (KAFSCALE_LFS_PROXY_PRESIGN_ENABLED), and all new error codes (integrity_failure,missing_integrity_size,payload_too_large,presign_disabled)._docs/lfs-helm.mdbucket: kafscale→my-bucket, with explanatory comment about thekafscale-lfsstartup blocklist._docs/lfs-sdks.mdkafscale→my-bucket.Resolve()example annotated: SDK populates integrity claim from envelope; proxy verifies bytes before streaming. Trust-model callout linking to the LFS Proxy doc.Test plan
bundle exec jekyll buildsucceeds (no broken internal links)integrity_failure,missing_integrity_size,payload_too_large,presign_disabled) appear in the rendered error table/lfs-proxy/#trust-model-and-integrity-verificationanchor resolves from the_docs/lfs-sdks.mdcalloutNotes
main, but matches the published OpenAPI in fix(security): block S3 bucket takeover via unsafe example defaults #139. If preferred we can hold this until fix(security): block S3 bucket takeover via unsafe example defaults #139 merges; just say.🤖 Generated with Claude Code