Skip to content

HDDS-5966. [HTTPFSGW] Update module doc, and place it in Ozone project docs#4250

Merged
fapifta merged 3 commits intoapache:HDDS-5447-httpfsfrom
dombizita:HDDS-5966
Feb 27, 2023
Merged

HDDS-5966. [HTTPFSGW] Update module doc, and place it in Ozone project docs#4250
fapifta merged 3 commits intoapache:HDDS-5447-httpfsfrom
dombizita:HDDS-5966

Conversation

@dombizita
Copy link
Contributor

What changes were proposed in this pull request?

Added proper documentation for the HttpFS gateway.

What is the link to the Apache JIRA

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

How was this patch tested?

Not really needed, CI on my fork: https://github.com/dombizita/ozone/actions/runs/4105032540

Change-Id: I5526d6172f882674c7c283ad9344a7b0f837a654
@umamaheswararao
Copy link
Contributor

@DaveTeng0 @swamirishi

Copy link
Contributor

@DaveTeng0 DaveTeng0 left a comment

Choose a reason for hiding this comment

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

looks good to me~

Copy link
Contributor

@fapifta fapifta left a comment

Choose a reason for hiding this comment

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

Hi @dombizita thank you for working on the documentation piece for HttpFS, I have added some comments around wording. Probably I am not 100% right, it would be nice to get a native speaker to review as well though. :)


These are the WebHDFS REST API operations that are supported/unsupported in Ozone.

### File and Directory Operations
Copy link
Contributor

Choose a reason for hiding this comment

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

For the following tables I would like to suggest to use the following terms:

  • supported
  • not implemented in Ozone
  • not implemented in Ozone FileSystem API

For this to be meaningful, we should add the note about the internals I have suggested earlier.

Copy link
Contributor Author

@dombizita dombizita Feb 15, 2023

Choose a reason for hiding this comment

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

we should add the note about the internals I have suggested earlier.

I'm not sure I got this part, what note do you think of?

Change-Id: I06f42422255f6208858de569f474b4bf22b79532
@dombizita
Copy link
Contributor Author

thanks for the review @fapifta, I addressed them, I had only one question regarding your last comment.


## Introduction

Ozone HttpFS is forked from the HDFS HttpFS endpoint implementation ([HDDS-5448](https://issues.apache.org/jira/browse/HDDS-5448)). It is added as a separate role to Ozone, like S3G.
Copy link
Contributor

@smengcl smengcl Feb 22, 2023

Choose a reason for hiding this comment

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

Suggested change
Ozone HttpFS is forked from the HDFS HttpFS endpoint implementation ([HDDS-5448](https://issues.apache.org/jira/browse/HDDS-5448)). It is added as a separate role to Ozone, like S3G.
Ozone HttpFS is forked from the HDFS HttpFS endpoint implementation ([HDDS-5448](https://issues.apache.org/jira/browse/HDDS-5448)). Ozone HttpFS is intended to be added optionally as a role in an Ozone cluster, similar to [S3 Gateway]({{< ref "design/s3gateway.md" >}}).

Change-Id: I3bf0c4afd163d558e89926b4a5c217c6ed7f1766
@fapifta
Copy link
Contributor

fapifta commented Feb 27, 2023

Thank you @dombizita to address the comments, I have restarted the failed CI check, let's see, +1 to commit once it gets green ;)

@fapifta fapifta merged commit 8b2a3bd into apache:HDDS-5447-httpfs Feb 27, 2023
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