Skip to content

HDDS-12727. Document high level architecture of S3 Gateway #8184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jojochuang
Copy link
Contributor

What changes were proposed in this pull request?

HDDS-12727. [Docs] High level architecture of Ozone S3 Gateway.

Please describe your PR in detail:

  • A high level description of Ozone S3 Gateway server.
  • This is largely generated by ChatGPT Deep Research. Though I proof-read it.

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-12727

How was this patch tested?

Doc only.

Change-Id: I455848c2d5d2ee65cdce7456814cb4e5e8247973
@jojochuang jojochuang requested a review from kerneltime March 28, 2025 22:05
@adoroszlai adoroszlai added the documentation Improvements or additions to documentation label Mar 29, 2025
@adoroszlai adoroszlai requested a review from errose28 March 29, 2025 06:13
@adoroszlai adoroszlai changed the title HDDS-12727. [Docs] High level architecture of Ozone S3 Gateway. HDDS-12727. Document high level architecture of S3 Gateway Apr 3, 2025
@adoroszlai
Copy link
Contributor

@kerneltime please review this

Comment on lines +49 to +52
Ozone separates metadata and data management:
- **Ozone Manager (OM):** Handles volumes, buckets, keys.
- **Storage Container Manager (SCM):** Manages DataNodes and allocates containers (storage units).
- **DataNodes:** Store the actual data chunks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is redundant on this page in the broader context.


### Mapping S3 to Ozone Concepts

In Ozone, data is organized into **volumes**, **buckets**, and **keys**. By default, the S3 Gateway uses a special volume named `/s3v` to store all S3 buckets.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not entirely accurate as the volume name can be changed. Also, bucket linking needs to be discussed.


This simplifies scaling and failure recovery.

### Authentication and Security
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section needs to touch kerberos.

@kerneltime
Copy link
Contributor

Please include the LLM footer “Generated-by: ” as per ASF guidelines in the git commit. https://www.apache.org/legal/generative-tooling.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants