Skip to content

Conversation

@YutaLin
Copy link

@YutaLin YutaLin commented Jan 4, 2026

What changes were proposed in this pull request?

Complete the page https://ozone-site-v2.staged.apache.org/docs/quick-start/reading-writing-data

What is the link to the Apache Jira?

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

How was this patch tested?

  • 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

CI Action Link: https://github.com/YutaLin/ozone-site/actions/runs/20686017288


```bash
# Create a bucket
ozone sh bucket create /vol1/bucket1
Copy link
Contributor

Choose a reason for hiding this comment

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

this command assumes /vol1 exists, which is deleted in the previous section.

echo "Hello Ozone via Shell" > test_shell.txt

# Upload a file (put source to destination)
ozone sh key put /vol1/bucket1/test_shell.txt test_shell.txt
Copy link
Contributor

Choose a reason for hiding this comment

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

this command assumes the bucket bucket1 exists, which is deleted in the previous section.

# For RATIS: use -r ONE or THREE
ozone sh key put -t RATIS -r THREE /vol1/bucket1/key1_ratis test_shell.txt
# For EC: use format CODEC-DATA-PARITY-CHUNKSIZE (e.g., rs-3-2-1024k, rs-6-3-1024k, rs-10-4-1024k)
ozone sh key put -t EC -r rs-3-2-1024k /vol1/bucket1/key1_ec test_shell.txt
Copy link
Contributor

Choose a reason for hiding this comment

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

this command requires at least 5 Datanodes. If a reader follows the quick start guide, she would start only 3 datanodes and the command would fail.

Suggest to ask the reader to start 5 datanodes in the docker compose: docker compose up -d --scale datanode=5


```bash
# Create volume and bucket (using filesystem semantics)
ozone fs -mkdir -p /vol1/bucket_ofs
Copy link
Contributor

Choose a reason for hiding this comment

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

these command would fail because fs.defaultFS is not ofs://om in the docker compose file.

Suggest to add "ofs://om/" prefix for the commands in this section. E.g.

ozone fs -mkdir -p ofs://om/vol1/bucket_ofs

@jojochuang
Copy link
Contributor

The rest are good though. I just wanted to make sure when first time user look at this page, she can immediately complete the steps without trouble.

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.

2 participants