| |
| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| |
| <meta name="description" content="Apache Ozone Documentation"> |
| |
| <title>Documentation for Apache Ozone</title> |
| |
| |
| <link href="../css/bootstrap.min.css" rel="stylesheet"> |
| |
| |
| <link href="../css/ozonedoc.css" rel="stylesheet"> |
| |
| |
| |
| <link href="../swagger-resources/swagger-ui.css" rel="stylesheet"> |
| |
| |
| <script> |
| var _paq = window._paq = window._paq || []; |
| |
| |
| |
| _paq.push(['disableCookies']); |
| |
| |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="//analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '34']); |
| var d=document, g=d.createElement('script'), |
| s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| |
| |
| </head> |
| |
| |
| <body> |
| |
| |
| <nav class="navbar navbar-inverse navbar-fixed-top"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#sidebar" aria-expanded="false" aria-controls="navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a href="../index.html" class="navbar-left ozone-logo"> |
| <img src="../ozone-logo-small.png"/> |
| </a> |
| <a class="navbar-brand hidden-xs" href="../index.html"> |
| Apache Ozone/HDDS Documentation |
| </a> |
| <a class="navbar-brand visible-xs-inline" href="#">Apache Ozone</a> |
| </div> |
| <div id="navbar" class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav navbar-right"> |
| <li><a href="https://github.com/apache/ozone">Source</a></li> |
| <li><a href="https://ozone.apache.org">Apache Ozone</a></li> |
| <li><a href="https://apache.org">ASF</a></li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| |
| <div class="wrapper"> |
| <div class="container-fluid"> |
| <div class="row"> |
| |
| <div class="col-sm-2 col-md-2 sidebar" id="sidebar"> |
| <ul class="nav nav-sidebar"> |
| |
| |
| |
| <li class=""> |
| |
| <a href="../index.html"> |
| |
| |
| |
| <span>Overview</span> |
| </a> |
| </li> |
| |
| |
| |
| <li class=""> |
| |
| <a href="../start.html"> |
| |
| |
| |
| <span>Getting Started</span> |
| </a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../concept.html"> |
| |
| <span>Architecture</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="../concept/overview.html">Overview</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../concept/ozonemanager.html">Ozone Manager</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../concept/storagecontainermanager.html">Storage Container Manager</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../concept/containers.html">Containers</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../concept/datanodes.html">Datanodes</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../concept/recon.html">Recon</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../feature.html"> |
| |
| <span>Features</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="../feature/decommission.html">Decommissioning</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/om-ha.html">OM High Availability</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/erasurecoding.html">Ozone Erasure Coding</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/snapshot.html">Ozone Snapshot</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/scm-ha.html">SCM High Availability</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/streaming-write-pipeline.html">Streaming Write Pipeline</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/dn-merge-rocksdb.html">Merge Container RocksDB in DN</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/prefixfso.html">Prefix based File System Optimization</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/topology.html">Topology awareness</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/quota.html">Quota in Ozone</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/recon.html">Recon Server</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/observability.html">Observability</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/nonrolling-upgrade.html">Non-Rolling Upgrades and Downgrades</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/s3-multi-tenancy.html"> |
| |
| <span>S3 Multi-Tenancy</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| <a href="../feature/s3-multi-tenancy-setup.html">Setup</a> |
| </li> |
| |
| <li class=""> |
| <a href="../feature/s3-tenant-commands.html">Tenant commands</a> |
| </li> |
| |
| <li class=""> |
| <a href="../feature/s3-multi-tenancy-access-control.html">Access Control</a> |
| </li> |
| |
| </ul> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../feature/reconfigurability.html">Reconfigurability</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../interface.html"> |
| |
| <span>Client Interfaces</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="../interface/ofs.html">Ofs (Hadoop compatible)</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../interface/o3fs.html">O3fs (Hadoop compatible)</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../interface/s3.html">S3 Protocol</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../interface/cli.html">Command Line Interface</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../interface/reconapi.html">Recon API</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../interface/javaapi.html">Java API</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../interface/csi.html">CSI Protocol</a> |
| |
| </li> |
| |
| <li class="active"> |
| |
| <a href="../interface/httpfs.html">HttpFS Gateway</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../security.html"> |
| |
| <span>Security</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="../security/secureozone.html">Securing Ozone</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../security/securingtde.html">Transparent Data Encryption</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../security/gdpr.html">GDPR in Ozone</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../security/securingdatanodes.html">Securing Datanodes</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../security/securingozonehttp.html">Securing HTTP</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../security/securings3.html">Securing S3</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../security/securityacls.html">Ozone ACLs</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="../security/securitywithranger.html">Apache Ranger</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| |
| <a href="../tools.html"> |
| |
| |
| |
| <span>Tools</span> |
| </a> |
| </li> |
| |
| |
| |
| <li class=""> |
| |
| <a href="../recipe.html"> |
| |
| |
| |
| <span>Recipes</span> |
| </a> |
| </li> |
| |
| |
| <li><a href="../design.html"><span><b>Design docs</b></span></a></li> |
| <li class="visible-xs"><a href="#">References</a> |
| <ul class="nav"> |
| <li><a href="https://github.com/apache/ozone"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Source</a></li> |
| <li><a href="https://ozone.apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Apache Ozone</a></li> |
| <li><a href="https://apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> ASF</a></li> |
| </ul></li> |
| </ul> |
| |
| </div> |
| |
| <div class="col-sm-10 col-sm-offset-2 col-md-10 col-md-offset-2 main-content"> |
| |
| |
| |
| <div class="col-md-9"> |
| <nav aria-label="breadcrumb"> |
| <ol class="breadcrumb"> |
| <li class="breadcrumb-item"><a href="../index.html">Home</a></li> |
| <li class="breadcrumb-item" aria-current="page"><a href="../interface.html">Client Interfaces</a></li> |
| <li class="breadcrumb-item active" aria-current="page">HttpFS Gateway</li> |
| </ol> |
| </nav> |
| |
| |
| |
| <div class="pull-right"> |
| |
| |
| |
| </div> |
| |
| |
| <div class="col-md-9"> |
| <h1>HttpFS Gateway</h1> |
| |
| <!--- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <p>Ozone HttpFS can be used to integrate Ozone with other tools via REST API.</p> |
| <h2 id="introduction">Introduction</h2> |
| <p>Ozone HttpFS is forked from the HDFS HttpFS endpoint implementation (<a href="https://issues.apache.org/jira/browse/HDDS-5448">HDDS-5448</a>). Ozone HttpFS is intended to be added optionally as a role in an Ozone cluster, similar to <a href="../design/s3gateway.html">S3 Gateway</a>.</p> |
| <p>HttpFS is a service that provides a REST HTTP gateway supporting File System operations (read and write). It is interoperable with the <strong>webhdfs</strong> REST HTTP API.</p> |
| <p>HttpFS can be used to access data on an Ozone cluster behind of a firewall. For example, the HttpFS service acts as a gateway and is the only system that is allowed to cross the firewall into the cluster.</p> |
| <p>HttpFS can be used to access data in Ozone using HTTP utilities (such as curl and wget) and HTTP libraries Perl from other languages than Java.</p> |
| <p>The <strong>webhdfs</strong> client FileSystem implementation can be used to access HttpFS using the Ozone filesystem command line tool (<code>ozone fs</code>) as well as from Java applications using the Hadoop FileSystem Java API.</p> |
| <p>HttpFS has built-in security supporting Hadoop pseudo authentication and Kerberos SPNEGO and other pluggable authentication mechanisms. It also provides Hadoop proxy user support.</p> |
| <h2 id="getting-started">Getting started</h2> |
| <p>HttpFS service itself is a Jetty based web-application that uses the Hadoop FileSystem API to talk to the cluster, it is a separate service which provides access to Ozone via a REST APIs. It should be started in addition to other regular Ozone components.</p> |
| <p>To try it out, you can start a Docker Compose dev cluster that has an HttpFS gateway.</p> |
| <p>Extract the release tarball, go to the <code>compose/ozone</code> directory and start the cluster:</p> |
| <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">docker-compose up -d --scale datanode<span style="color:#f92672">=</span><span style="color:#ae81ff">3</span> |
| </code></pre></div><p>You can/should find now the HttpFS gateway in docker with the name <code>ozone_httpfs</code>. |
| HttpFS HTTP web-service API calls are HTTP REST calls that map to an Ozone file system operation. For example, using the <code>curl</code> Unix command.</p> |
| <p>E.g. in the docker cluster you can execute commands like these:</p> |
| <ul> |
| <li> |
| <p><code>curl -i -X PUT "http://httpfs:14000/webhdfs/v1/vol1?op=MKDIRS&user.name=hdfs"</code> creates a volume called <code>vol1</code>.</p> |
| </li> |
| <li> |
| <p><code>$ curl 'http://httpfs-host:14000/webhdfs/v1/user/foo/README.txt?op=OPEN&user.name=foo'</code> returns the content of the key <code>/user/foo/README.txt</code>.</p> |
| </li> |
| </ul> |
| <h2 id="supported-operations">Supported operations</h2> |
| <p>Here are the tables of WebHDFS REST APIs and their state of support in Ozone.</p> |
| <h3 id="file-and-directory-operations">File and Directory Operations</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>Operation</th> |
| <th>Support</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Create and Write to a File</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>Append to a File</td> |
| <td>not implemented in Ozone</td> |
| </tr> |
| <tr> |
| <td>Concat File(s)</td> |
| <td>not implemented in Ozone</td> |
| </tr> |
| <tr> |
| <td>Open and Read a File</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>Make a Directory</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>Create a Symbolic Link</td> |
| <td>not implemented in Ozone</td> |
| </tr> |
| <tr> |
| <td>Rename a File/Directory</td> |
| <td>supported (with limitations)</td> |
| </tr> |
| <tr> |
| <td>Delete a File/Directory</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>Truncate a File</td> |
| <td>not implemented in Ozone</td> |
| </tr> |
| <tr> |
| <td>Status of a File/Directory</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>List a Directory</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>List a File</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>Iteratively List a Directory</td> |
| <td>supported</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="other-file-system-operations">Other File System Operations</h3> |
| <table> |
| <thead> |
| <tr> |
| <th>Operation</th> |
| <th>Support</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>Get Content Summary of a Directory</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>Get Quota Usage of a Directory</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>Set Quota</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Set Quota By Storage Type</td> |
| <td>not implemented in Ozone</td> |
| </tr> |
| <tr> |
| <td>Get File Checksum</td> |
| <td>unsupported (to be fixed)</td> |
| </tr> |
| <tr> |
| <td>Get Home Directory</td> |
| <td>unsupported (to be fixed)</td> |
| </tr> |
| <tr> |
| <td>Get Trash Root</td> |
| <td>unsupported</td> |
| </tr> |
| <tr> |
| <td>Set Permission</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Set Owner</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Set Replication Factor</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Set Access or Modification Time</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Modify ACL Entries</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Remove ACL Entries</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Remove Default ACL</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Remove ACL</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Set ACL</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Get ACL Status</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| <tr> |
| <td>Check access</td> |
| <td>not implemented in Ozone FileSystem API</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="hadoop-user-and-developer-documentation-about-httpfs">Hadoop user and developer documentation about HttpFS</h2> |
| <ul> |
| <li> |
| <p><a href="https://hadoop.apache.org/docs/stable/hadoop-hdfs-httpfs/ServerSetup.html">HttpFS Server Setup</a></p> |
| </li> |
| <li> |
| <p><a href="https://hadoop.apache.org/docs/stable/hadoop-hdfs-httpfs/ServerSetup.html">Using HTTP Tools</a></p> |
| </li> |
| </ul> |
| |
| |
| |
| <a class="btn btn-success btn-lg" href="../interface/swaggerreconapi.html">Next >></a> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="push"></div> |
| </div> |
| |
| |
| |
| <footer class="footer"> |
| <div class="container"> |
| <span class="small text-muted"> |
| Version: 1.5.0-SNAPSHOT, Last Modified: February 27, 2024 <a class="hide-child link primary-color" href="https://github.com/apache/ozone/commit/7939faf7d6c904bf1e4ad32baa5d6d0c1de19003">7939faf</a> |
| </span> |
| </div> |
| </footer> |
| |
| |
| |
| <script src="../js/jquery-3.5.1.min.js"></script> |
| <script src="../js/ozonedoc.js"></script> |
| <script src="../js/bootstrap.min.js"></script> |
| |
| |
| </body> |
| |
| </html> |
