Skip to content

docs: add storage backend configuration reference tables#4173

Merged
rtyler merged 3 commits intodelta-io:mainfrom
immohamedadhil:docs/storage-backend-configuration
Feb 8, 2026
Merged

docs: add storage backend configuration reference tables#4173
rtyler merged 3 commits intodelta-io:mainfrom
immohamedadhil:docs/storage-backend-configuration

Conversation

@immohamedadhil
Copy link
Contributor

Closes #2748

Adds comprehensive storage_options configuration reference tables to each storage backend documentation page, making it easy for users
to discover all available configuration keys without having to dig through the Rust object_store crate docs.

Changes

Configuration Reference Tables Added

  • s3.md: Added configuration reference table (20+ S3 keys), Delta Lake specific options (locking, DynamoDB), and supported URL
    schemes
  • adls.md: Added configuration reference table (18 Azure keys) covering all authentication methods (account keys, service principal,
    SAS, managed identity) and URL schemes
  • gcs.md: Added configuration reference table (5 GCS keys), authentication methods section, and URL schemes
  • special_configuration.md: Added common client options table (17 keys) that work across all backends (HTTP timeouts, proxies,
    connection pooling, etc.)

S3-Compatible Services Documentation

  • s3-like.md: Added detailed configuration guides for 5 S3-compatible services:
    • Cloudflare R2 (with conditional put support)
    • MinIO (self-hosted, Docker-compatible)
    • Alibaba Cloud OSS (Asia-Pacific regions)
    • LocalStack (local testing/development)
    • Ceph/RADOS Gateway (enterprise storage)

Documentation Improvements

  • lakefs.md: Replaced TODO placeholder with working Python code example for cleaning up stale transaction branches

Notes

  • All configuration keys sourced from the object_store crate's config enums
  • Each section links to authoritative Rust documentation for complete reference
  • Existing content preserved - only added new sections
  • Follows MkDocs Material style with proper admonitions and code examples
  • Total: 342 lines of documentation added across 6 files

This contribution was created with assistance from Claude.

@codecov
Copy link

codecov bot commented Feb 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.62%. Comparing base (bbce1a1) to head (acf8588).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4173   +/-   ##
=======================================
  Coverage   76.62%   76.62%           
=======================================
  Files         166      166           
  Lines       47030    47030           
  Branches    47030    47030           
=======================================
  Hits        36036    36036           
  Misses       9252     9252           
  Partials     1742     1742           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Add comprehensive configuration reference tables for S3, Azure ADLS, GCS,
and S3-compatible storage backends. Each table lists all valid storage_options
keys, their environment variable equivalents, and descriptions sourced from
the object_store crate's config enums.

Changes:
- s3.md: Added configuration reference table (20+ keys), Delta Lake specific
  options, and supported URL schemes
- adls.md: Added Azure configuration reference with 18 auth/config options
- gcs.md: Added GCS configuration reference and authentication methods
- s3-like.md: Added detailed guides for 5 S3-compatible services (R2, MinIO,
  Alibaba OSS, LocalStack, Ceph) with service-specific examples
- lakefs.md: Replaced TODO placeholder with Python cleanup code example
- special_configuration.md: Added common client options table (17 keys) that
  work across all backends

All sections include links to authoritative object_store documentation for
complete reference.

Closes delta-io#2748

Signed-off-by: adhil-cloud <muhammadadhil45@gmail.com>
@immohamedadhil immohamedadhil force-pushed the docs/storage-backend-configuration branch from 6e91973 to 215b5b6 Compare February 7, 2026 18:42
@rtyler rtyler enabled auto-merge (rebase) February 8, 2026 20:21
@rtyler rtyler merged commit a0cf6b1 into delta-io:main Feb 8, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Provide documentation how to configure various storage backends

2 participants