| |
| |
| <!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="Hadoop Ozone Documentation"> |
| |
| <title>Documentation for Apache Hadoop Ozone</title> |
| |
| |
| <link href="css/bootstrap.min.css" rel="stylesheet"> |
| |
| |
| <link href="css/ozonedoc.css" rel="stylesheet"> |
| |
| </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 class="navbar-brand hidden-xs" href="#">Apache Hadoop Ozone/HDDS documentation</a> |
| <a class="navbar-brand visible-xs-inline" href="#">Hadoop Ozone</a> |
| </div> |
| <div id="navbar" class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav navbar-right"> |
| <li><a href="https://github.com/apache/hadoop">Source</a></li> |
| <li><a href="https://hadoop.apache.org">Apache Hadoop</a></li> |
| <li><a href="https://apache.org">ASF</a></li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| |
| <div class="container-fluid"> |
| <div class="row"> |
| |
| <div class="col-sm-3 col-md-2 sidebar" id="sidebar"> |
| <img src="ozone-logo.png" style="max-width: 100%;"/> |
| <ul class="nav nav-sidebar"> |
| |
| |
| |
| <li class=""> |
| |
| <a href="index.html"> |
| |
| |
| |
| <span>Ozone Overview</span> |
| </a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="runningviadocker.html"> |
| |
| <span>Getting Started</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="./runningviadocker.html">Alpha Cluster</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./settings.html">Configuration</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./realcluster.html">Starting an Ozone Cluster</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./ozonefs.html">Ozone File System</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./runningwithhdfs.html">Running concurrently with HDFS</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./buildingsources.html">Building from Sources</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="commandshell.html"> |
| |
| <span>Client</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="./commandshell.html"> |
| |
| <span>Ozone CLI</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| <a href="./volumecommands.html">Volume Commands</a> |
| </li> |
| |
| <li class=""> |
| <a href="./bucketcommands.html">Bucket Commands</a> |
| </li> |
| |
| <li class=""> |
| <a href="./keycommands.html">Key Commands</a> |
| </li> |
| |
| </ul> |
| |
| </li> |
| |
| <li class="active"> |
| |
| <a href="./s3.html">S3</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./javaapi.html">Java API</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="dozone.html"> |
| |
| <span>Tools</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="./auditparser.html">Audit Parser</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./dozone.html">Dozone & Dev Tools</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./freon.html">Freon</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./genconf.html">Generate Configurations</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./scmcli.html">SCMCLI</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="prometheus.html"> |
| |
| <span>Recipes</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="./prometheus.html">Monitoring with Prometheus</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./sparkozonefsk8s.html">Spark in Kubernetes with OzoneFS</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="./concepts.html"> |
| |
| <span>Architecture</span> |
| </a> |
| <ul class="nav"> |
| |
| <li class=""> |
| |
| <a href="./hdds.html">Hadoop Distributed Data Store</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./ozonemanager.html">Ozone Manager</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./ozonesecurityarchitecture.html">Ozone Security Overview</a> |
| |
| </li> |
| |
| <li class=""> |
| |
| <a href="./setupsecureozone.html">Setup secure ozone cluster</a> |
| |
| </li> |
| |
| </ul> |
| </li> |
| |
| |
| <li class="visible-xs"><a href="#">References</a> |
| <ul class="nav"> |
| <li><a href="https://github.com/apache/hadoop"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Source</a></li> |
| <li><a href="https://hadoop.apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Apache Hadoop</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-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> |
| <h1>S3</h1> |
| <div class="col-md-9"> |
| |
| |
| <!--- |
| 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 provides S3 compatible REST interface to use the object store data with any S3 compatible tools.</p> |
| |
| <h2 id="getting-started">Getting started</h2> |
| |
| <p>S3 Gateway is a separated component which provides the S3 compatible. It should be started additional to the regular Ozone components.</p> |
| |
| <p>You can start a docker based cluster, including the S3 gateway from the release package.</p> |
| |
| <p>Go to the <code>compose/ozones3</code> directory, and start the server:</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</code></pre></div> |
| <p>You can access the S3 gateway at <code>http://localhost:9878</code></p> |
| |
| <h2 id="url-schema">URL Schema</h2> |
| |
| <p>Ozone S3 gateway supports both the virtual-host-style URL s3 bucket addresses (eg. <a href="http://bucketname.host:9878">http://bucketname.host:9878</a>) and the path-style addresses (eg. <a href="http://host:9878/bucketname">http://host:9878/bucketname</a>)</p> |
| |
| <p>By default it uses the path-style addressing. To use virtual host style URLs set your main domain name in your <code>ozone-site.xml</code>:</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-xml" data-lang="xml"><span style="color:#f92672"><property></span> |
| <span style="color:#f92672"><name></span>ozone.s3g.domain.name<span style="color:#f92672"></name></span> |
| <span style="color:#f92672"><value></span>s3g.internal<span style="color:#f92672"></value></span> |
| <span style="color:#f92672"></property></span></code></pre></div> |
| <h2 id="bucket-browser">Bucket browser</h2> |
| |
| <p>Buckets could be browsed from the browser by adding <code>?browser=true</code> to the bucket URL.</p> |
| |
| <p>For example the content of the ‘testbucket’ could be checked from the browser using the URL <a href="http://localhost:9878/testbucket?browser=true">http://localhost:9878/testbucket?browser=true</a></p> |
| |
| <h2 id="implemented-rest-endpoints">Implemented REST endpoints</h2> |
| |
| <p>Operations on S3Gateway service:</p> |
| |
| <table> |
| <thead> |
| <tr> |
| <th>Endpoint</th> |
| <th>Status</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| <tr> |
| <td>GET service</td> |
| <td>implemented</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <p>Operations on Bucket:</p> |
| |
| <table> |
| <thead> |
| <tr> |
| <th>Endpoint</th> |
| <th>Status</th> |
| <th>Notes</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| <tr> |
| <td>GET Bucket (List Objects) Version 2</td> |
| <td>implemented</td> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <td>HEAD Bucket</td> |
| <td>implemented</td> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <td>DELETE Bucket</td> |
| <td>implemented</td> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <td>PUT Bucket (Create bucket)</td> |
| <td>implemented</td> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <td>Delete Multiple Objects (POST)</td> |
| <td>implemented</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <p>Operation on Objects:</p> |
| |
| <table> |
| <thead> |
| <tr> |
| <th>Endpoint</th> |
| <th>Status</th> |
| <th>Notes</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| <tr> |
| <td>PUT Object</td> |
| <td>implemented</td> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <td>GET Object</td> |
| <td>implemented</td> |
| <td>Range headers are not supported</td> |
| </tr> |
| |
| <tr> |
| <td>Multipart Uplad</td> |
| <td>implemented</td> |
| <td>Except the listing of the current MultiPartUploads.</td> |
| </tr> |
| |
| <tr> |
| <td>DELETE Object</td> |
| <td>implemented</td> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <td>HEAD Object</td> |
| <td>implemented</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <h2 id="security">Security</h2> |
| |
| <p>If security is not enabled, you can <em>use</em> <strong>any</strong> AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY</p> |
| |
| <p>If security is enabled, you can get the key and the secret with the <code>ozone s3 getsecret</code> command (*kerberos based authentication is required).</p> |
| |
| <pre><code>/etc/security/keytabs/testuser.keytab testuser/scm@EXAMPLE.COM |
| ozone s3 getsecret |
| awsAccessKey=testuser/scm@EXAMPLE.COM |
| awsSecret=c261b6ecabf7d37d5f9ded654b1c724adac9bd9f13e247a235e567e8296d2999 |
| |
| </code></pre> |
| |
| <p>Now, you can use the key and the secret to access the S3 endpoint:</p> |
| |
| <pre><code>export AWS_ACCESS_KEY_ID=testuser/scm@EXAMPLE.COM |
| export AWS_SECRET_ACCESS_KEY=c261b6ecabf7d37d5f9ded654b1c724adac9bd9f13e247a235e567e8296d2999 |
| aws s3api --endpoint http://localhost:9878 create-bucket --bucket bucket1 |
| </code></pre> |
| |
| <h2 id="s3-bucket-name-mapping-to-ozone-buckets">S3 bucket name mapping to Ozone buckets</h2> |
| |
| <p><strong>Note</strong>: Ozone has a notion for ‘volumes’ which is missing from the S3 Rest endpoint. Under the hood S3 bucket names are mapped to Ozone ‘volume/bucket’ locations (depending on the given authentication information).</p> |
| |
| <p>To show the storage location of a S3 bucket, use the <code>ozone s3 path <bucketname></code> command.</p> |
| |
| <pre><code>aws s3api --endpoint-url http://localhost:9878 create-bucket --bucket=bucket1 |
| |
| ozone sh bucket path bucket1 |
| Volume name for S3Bucket is : s3thisisakey |
| Ozone FileSystem Uri is : o3fs://bucket1.s3thisisakey |
| </code></pre> |
| |
| <h2 id="clients">Clients</h2> |
| |
| <h3 id="aws-cli">AWS Cli</h3> |
| |
| <p><code>aws</code> CLI could be used with specifying the custom REST endpoint.</p> |
| |
| <pre><code>aws s3api --endpoint http://localhost:9878 create-bucket --bucket buckettest |
| </code></pre> |
| |
| <p>Or</p> |
| |
| <pre><code>aws s3 ls --endpoint http://localhost:9878 s3://buckettest |
| </code></pre> |
| |
| <h3 id="s3-fuse-driver-goofys">S3 Fuse driver (goofys)</h3> |
| |
| <p>Goofys is a S3 FUSE driver. It could be used to mount any Ozone bucket as posix file system:</p> |
| |
| <pre><code>goofys --endpoint http://localhost:9878 bucket1 /mount/bucket1 |
| </code></pre> |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| <script src="./js/jquery.min.js"></script> |
| <script src="./js/ozonedoc.js"></script> |
| <script src="./js/bootstrap.min.js"></script> |
| |
| |
| </body> |
| </html> |
