Skip to content

Conversation

@jojochuang
Copy link
Contributor

What changes were proposed in this pull request?

Provide a one-liner summary of the changes in the PR Title field above.
It should be in the form of HDDS-1234. Short summary of the change.

Please describe your PR in detail:

  • Unlike httpsfs user doc https://ozone.apache.org/docs/edge/interface/httpfs.html we don't list the supported operation for Ofs.

    This patch adds a table in the 'Ofs (Hadoop compatible)' page for supported operations.

    The table has columns 'Operation', 'Description', 'Support' where 'Operation' is the exact operation name in the audit log, 'Description' is a few words of short description, and 'Support' is either Supported or Unsupported. Add footnotes for any caveats.

    Adds a table for HDFS-specific operations that are not part of the general Hadoop FileSystem API and are therefore not supported by Ofs.

  • Generated-by: Google Gemini 2.5 Pro + Gemini Cli.

│  Input Tokens         2,430,886  │
│  Output Tokens           11,652  │
│  Thoughts Tokens         22,566  │
│  ──────────────────────────────  │
│  Total Tokens         2,465,104  │
│                                  │
│  Total duration (API)    7m 26s  │

What is the link to the Apache JIRA

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

How was this patch tested?

Documentation only change.

Unlike httpsfs user doc https://ozone.apache.org/docs/edge/interface/httpfs.html we don't list the supported operation for Ofs.

This patch adds a table in the 'Ofs (Hadoop compatible)' page for supported operations.

The table has columns 'Operation', 'Description', 'Support' where 'Operation' is the exact operation name in the audit log, 'Description' is a few words of short description, and 'Support' is either Supported or Unsupported. Add footnotes for any caveats.

Change-Id: I6613f5f13f23394c30da83ce41e22b28f6d04732
Adds a table for HDFS-specific operations that are not part of the general Hadoop FileSystem API and are therefore not supported by Ofs.

Change-Id: Ibfc51daf614aa5cf0d56e1037b64856c4980c4e5
@jojochuang jojochuang added documentation Improvements or additions to documentation AI-gen labels Jul 8, 2025
The "Supported Operations" table in the OFS documentation was missing
several methods that are part of the public FileSystem API and are
implemented in `RootedOzoneFileSystem`.

This commit updates the table to include these methods, providing a more
complete and accurate reference for developers.

Change-Id: Iace6c9dd21bf6cae3701b0d5a620882c1976899e
Comment on lines 326 to 337
| `setXAttr` | Sets an extended attribute. | Unsupported |
| `getXAttr` | Gets an extended attribute. | Unsupported |
| `listXAttrs` | Lists extended attributes. | Unsupported |
| `removeXAttr` | Removes an extended attribute. | Unsupported |
| `setAcl` | Sets an ACL. | Unsupported |
| `getAclStatus` | Gets an ACL status. | Unsupported |
| `modifyAclEntries` | Modifies ACL entries. | Unsupported |
| `removeAclEntries` | Removes ACL entries. | Unsupported |
| `removeDefaultAcl` | Removes the default ACL. | Unsupported |
| `removeAcl` | Removes an ACL. | Unsupported |
| `truncate` | Truncates a file. | Unsupported |
| `concat` | Concatenates files. | Unsupported |
Copy link
Member

Choose a reason for hiding this comment

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

the above heading says

## Supported Operations

The following table lists the supported operations for Ofs.

But we mention unsupported methods as well in this table

Change-Id: I41bdbc9b347a474bb3abb6e80b73b5914f02ad87
@jojochuang jojochuang requested a review from ayushtkn July 9, 2025 23:55
@jojochuang
Copy link
Contributor Author

@ayushtkn let me know how you think about this revision. thx

Copy link
Member

@ayushtkn ayushtkn left a comment

Choose a reason for hiding this comment

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

Changes LGTM, just double check the highlight change

<value>org.apache.hadoop.fs.ozone.OzoneTrashPolicy</value>
</property>
{{< /highlight >}}
{{< highlight >}}
Copy link
Member

Choose a reason for hiding this comment

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

this seems accidental, it gives error

Error: error building site: assemble: "/Users/ayushsaxena/code/ozone/hadoop-hdds/docs/content/interface/Ofs.md:233:1": failed to extract shortcode: shortcode "highlight" must be closed or self-closed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks for catching it! fixed.

Change-Id: Ic095bbbc604d90a79235d321365f6ca4bd94af32
@jojochuang jojochuang merged commit 1ad1b2d into apache:master Jul 10, 2025
14 checks passed
@jojochuang
Copy link
Contributor Author

Merged. Thanks @ayushtkn

jojochuang added a commit to jojochuang/ozone that referenced this pull request Jul 31, 2025
Generated-by: Google Gemini 2.5 Pro, Gemini Cli
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-gen documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants