Skip to content

HDDS-14505. [Website v2] [Docs] [User Guide] s3a#300

Merged
jojochuang merged 5 commits intoapache:HDDS-9225-website-v2from
rich7420:HDDS-14505
Feb 6, 2026
Merged

HDDS-14505. [Website v2] [Docs] [User Guide] s3a#300
jojochuang merged 5 commits intoapache:HDDS-9225-website-v2from
rich7420:HDDS-14505

Conversation

@rich7420
Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

Write about "s3a and Ozone"

What is the link to the Apache Jira?

HDDS-14505

How was this patch tested?

https://github.com/rich7420/ozone-site/actions/runs/21430617221

  • The CI checks on my fork are passing
  • I verified the rendered content using a local preview
  • I manually verified the steps provided in this change work as described

@ssulav ssulav self-requested a review January 30, 2026 06:51
- `core-site.xml` is configured as above
- An S3 bucket (for example `bucket1`) already exists (you can create it with `aws s3api --endpoint http://localhost:9878 create-bucket --bucket bucket1`)

S3A URLs use the form `s3a://<bucket>/<path>`. The bucket corresponds to an Ozone bucket under the `/s3v` volume or a bucket link.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The path is broken with the quoting


### Recommended settings for Ozone

Ozone S3 Gateway does not support ETags and object versioning in the same way as AWS S3. To avoid compatibility issues, set these options when using S3A with Ozone:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Etag support is added in S3 MPU. Do we still recommend below configs?

Copy link
Copy Markdown

@ashishkumar50 ashishkumar50 left a comment

Choose a reason for hiding this comment

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

@rich7420, Thanks for writing the doc.


```bash
# To local filesystem
hadoop fs -copyToLocal s3a://bucket1/path/local-file.txt /tmp/from-ozone.txt
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nit:
hadoop fs -copyToLocal s3a://bucket1/path/file.txt /tmp/from-ozone.txt

hadoop fs -copyToLocal s3a://bucket1/path/local-file.txt /tmp/from-ozone.txt

# Copy to HDFS
hadoop fs -cp s3a://bucket1/path/local-file.txt hdfs:///user/test/from-ozone.txt
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nit:
hadoop fs -cp s3a://bucket1/path/file.txt hdfs:///user/test/from-ozone.txt

@rich7420
Copy link
Copy Markdown
Contributor Author

rich7420 commented Feb 5, 2026

@ashishkumar50 thanks for the review!

@jojochuang
Copy link
Copy Markdown
Contributor

It looks good to me. Anything else you'd like to add? @ashishkumar50 @ssulav

Copy link
Copy Markdown

@ashishkumar50 ashishkumar50 left a comment

Choose a reason for hiding this comment

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

LGTM

@ssulav
Copy link
Copy Markdown
Contributor

ssulav commented Feb 6, 2026

LGTM

<value>us-east-1</value>
<description>
Logical region name required by the S3A client. Ozone does not enforce regions,
but this must be a valid-looking value.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

it would be nice to have a link to the spec for region name format.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It doesn't look like Ozone s3 gateway does any checks for region string.

<name>fs.s3a.path.style.access</name>
<value>true</value>
<description>
Ozone S3 Gateway defaults to path-style URLs (http://host:9878/bucket),
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

can ozone handle the style.access=false? if so what should be configured on ozone side?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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


### Recommended settings for Ozone

Ozone S3 Gateway adds ETag support for S3 Multipart Upload (MPU). Object versioning and some other S3 behaviors may still differ from AWS S3. To avoid compatibility issues with older clients or when not using MPU, you can set these options when using S3A with Ozone:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

it would be nice to describe the difference in Ozone's behavior comparing to AWS S3.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@jojochuang jojochuang merged commit ae2e230 into apache:HDDS-9225-website-v2 Feb 6, 2026
11 checks passed
@jojochuang
Copy link
Copy Markdown
Contributor

@yandrey321 I addressed your comments so I think this is good to merge.
Thanks @rich7420 for the PR and @ssulav @ashishkumar50 for reviews.

@rich7420
Copy link
Copy Markdown
Contributor Author

rich7420 commented Feb 7, 2026

thanks for the review!

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.

5 participants