Skip to content

docs: document Object Store bucket behavior - #8534

Merged
sneub merged 1 commit into
mainfrom
docs/object-store-behavior
Oct 19, 2026
Merged

sneub merged 1 commit into
mainfrom
docs/object-store-behavior

Conversation

@sneub

@sneub sneub commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Adds storage/behavior (/docs/storage/behavior), a concept page on how hosted Object Store buckets behave, for people designing upload and deletion flows. Support had questions on this that the docs couldn't answer.

Covers

  • Regions: buckets are single-region and follow the project region (eu-west-3 stores in Frankfurt).
  • Strong consistency.
  • Conditional writes: If-None-Match: * on PutObject returns 412. Local dev buckets don't enforce it.
  • S3 compatibility: multipart list/abort supported; versioning and bucket policies not supported.
  • Access keys: one bucket each, no prefix permissions, revocation applies to new requests.
  • Deleting objects: no versioning, soft delete or snapshots; incomplete multipart uploads aren't cleaned up.
  • Deleting a bucket, and what we don't publish (physical erasure timing, backup retention).

Also adds the page to the Storage sidebar and links it from the Storage page.

Sources

  • pdp-control-plane: packages/object-store/src/tigris.ts (provisioning sends only the region; no soft-delete, snapshot or lifecycle options; bucket delete is forced), packages/interactors/src/region.ts (region map), docs/ObjectStore.md (no multipart cleanup).
  • Provider docs for conditional writes, consistency by location type, the S3 compatibility table, and access key deletion. The page doesn't name the provider.

pnpm lint:links passes.

Summary by CodeRabbit

  • Documentation
    • Added guidance on hosted bucket behavior, including region selection, strong consistency, conditional object writes and reads, and supported S3 operations.
    • Clarified limits around versioning and bucket policies, access-key revocation, object and bucket deletion, and incomplete multipart uploads.
    • Added a link to the new behavior guide from the Storage documentation.

Regions, consistency, conditional writes, S3 compatibility, key revocation,
and what deleting an object or bucket removes.
@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
blog Ready Ready Preview Oct 19, 2026 1:32pm UTC
docs Ready Ready Preview Oct 19, 2026 1:32pm UTC
eclipse Ready Ready Preview Oct 19, 2026 1:32pm UTC
site Ready Ready Preview Oct 19, 2026 1:32pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
handbook Skipped Skipped Oct 19, 2026 1:32pm UTC

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

🍈 Lychee Link Check Report

13 links: ✅ 1 OK | 🚫 0 errors | 🔀 1 redirects | 👻 12 excluded

✅ All links are working!


Full Statistics Table
Status Count
✅ Successful 1
🔀 Redirected 1
👻 Excluded 12
🚫 Errors 0
⛔ Unsupported 0
⏳ Timeouts 0
❓ Unknown 0

@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 30833832-2f9e-4eb8-80e7-9d10561ffd12
📥 Commits

Reviewing files that changed from the base of the PR and between 0dfc009 and 68b5a1f.

📒 Files selected for processing: 3
  • apps/docs/content/docs/storage/behavior.mdx
  • apps/docs/content/docs/storage/index.mdx
  • apps/docs/content/docs/storage/meta.json

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Walkthrough

The storage documentation adds a page describing bucket location, consistency, supported S3 operations, access-key behavior, and object and bucket deletion. The storage index links to the new page.

Changes

Bucket behavior documentation

Layer / File(s) Summary
Bucket location and consistency
apps/docs/content/docs/storage/behavior.mdx, apps/docs/content/docs/storage/index.mdx, apps/docs/content/docs/storage/meta.json
The new page documents bucket location rules, consistency guarantees, and conditional requests. The storage index links to the page, and the docs navigation includes it.
Supported operations and access keys
apps/docs/content/docs/storage/behavior.mdx
The page lists supported and unsupported S3 features and documents access-key scope and revocation behavior.
Object and bucket deletion
apps/docs/content/docs/storage/behavior.mdx
The page documents object deletion, incomplete multipart uploads, and bucket deletion. It also states that physical-erasure timing and internal-backup retention are not guaranteed.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 68b5a

No confirmed issue blocks merging. Hosted conditional-create behavior and the stated bucket location are worth validating before relying on those guarantees.

### Architecture Summary

Architecture risk: 🔵 Low · up to 68b5a

The change affects 1 system.

Changed systems: apps/docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — apps/docs (service) was modified; 3 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in apps/docs/content/docs/storage/behavior.mdx: Adds page metadata and an introduction describing the page’s scope and linking to bucket and key setup documentation.
  • observed — Modified behavior in apps/docs/content/docs/storage/behavior.mdx: Documents the project-region-to-bucket-location mapping, including the eu-west-3 Frankfurt mapping and us-east-1 default when a project has no region. States that buckets are not replicated or moved after creation.
  • observed — Modified behavior in apps/docs/content/docs/storage/behavior.mdx: Documents strong read-after-write and read-after-delete consistency. States that PutObject with If-None-Match: * fails with 412 and leaves an existing object unchanged, and that at most one concurrent conditional create for a key succeeds. Lists supported GetObject conditional headers and notes that the dev emulator does not enforce conditional headers.
  • observed — Modified behavior in apps/docs/content/docs/storage/behavior.mdx: Documents supported S3 operations, including multipart uploads and conditional requests, and identifies bucket versioning and bucket policies as unsupported. States that unsupported features require no runtime check.
Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: documenting Object Store bucket behavior.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@sneub
sneub merged commit aee6de2 into main Oct 19, 2026
28 checks passed
@sneub
sneub deleted the docs/object-store-behavior branch October 19, 2026 14:32

This branch was successfully deployed

4 active and 1 inactive deployments
Preview – docs — 68b5a1fd Deployed Oct 19, 2026 by vercel[bot]
Preview – blog — 68b5a1fd Deployed Oct 19, 2026 by vercel[bot]
Preview – site — 68b5a1fd Deployed Oct 19, 2026 by vercel[bot]
Preview – eclipse — 68b5a1fd Deployed Oct 19, 2026 by vercel[bot]
Preview – handbook — 68b5a1fd Deployed Oct 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant