| |
| |
| <!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"> |
| |
| </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/hadoop-ozone">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="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/ha.html">High Availability</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> |
| |
| </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> |
| |
| </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="active"> |
| |
| <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/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-10 col-sm-offset-2 col-md-10 col-md-offset-2 main"> |
| <div class="col-md-9"> |
| |
| |
| |
| <div class="pull-right"> |
| |
| |
| |
| |
| |
| <a href="./zh/tools.html"><span class="label label-success">中文</span></a> |
| |
| |
| </div> |
| |
| <h1>Tools</h1> |
| </div> |
| |
| <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 has a set of command line tools that can be used to manage ozone.</p> |
| <p>All these commands are invoked via the <code>ozone</code> script.</p> |
| <p>Daemon commands:</p> |
| <ul> |
| <li><strong>scm</strong> - Storage Container Manager service, via daemon can be started |
| or stopped.</li> |
| <li><strong>om</strong> - Ozone Manager, via daemon command can be started or stopped.</li> |
| <li><strong>datanode</strong> - Via daemon command, the HDDS data nodes can be started or |
| stopped.</li> |
| <li><strong>s3g</strong> - Start the S3 compatible REST gateway</li> |
| <li><strong>recon</strong> - The Web UI service of Ozone can be started with this command.</li> |
| </ul> |
| <p>Client commands:</p> |
| <ul> |
| <li><strong>sh</strong> - Primary command line interface for ozone to manage volumes/buckets/keys.</li> |
| <li><strong>fs</strong> - Runs a command on ozone file system (similar to <code>hdfs dfs</code>)</li> |
| <li><strong>version</strong> - Prints the version of Ozone and HDDS.</li> |
| </ul> |
| <p>Admin commands:</p> |
| <ul> |
| <li><strong>admin</strong> - Collects admin and developer related commands related to the |
| ozone components.</li> |
| <li><strong>insight</strong> - Generic tool to display filtered log, metrics or configs to help debuging. See <a href="./feature/observability.html">the observability</a> page for more information.</li> |
| <li><strong>classpath</strong> - Prints the class path needed to get the hadoop jar and the |
| required libraries.</li> |
| <li><strong>dtutil</strong> - Operations related to delegation tokens</li> |
| <li><strong>envvars</strong> - Display computed Hadoop environment variables.</li> |
| <li><strong>getconf</strong> - Reads ozone config values from configuration.</li> |
| <li><strong>jmxget</strong> - Get JMX exported values from NameNode or DataNode.</li> |
| <li><strong>genconf</strong> - Generate minimally required ozone configs and output to |
| ozone-site.xml.</li> |
| </ul> |
| <p>Test tools:</p> |
| <ul> |
| <li><strong>freon</strong> - Runs the ozone load generator.</li> |
| <li><strong>genesis</strong> - Developer Only, Ozone micro-benchmark application.</li> |
| </ul> |
| <p>For more information see the following subpages:</p> |
| |
| |
| |
| |
| |
| |
| |
| <div class="row"> |
| |
| <div class="col-sm-6"> |
| <div class="card"> |
| <div class="card-body"> |
| <h2 class="card-title"> |
| |
| Ozone Admin |
| </h2> |
| <p class="card-text">Ozone Admin command can be used for all the admin related tasks.</p> |
| <a href="./tools/admin.html" |
| class=" btn btn-primary btn-lg">Ozone Admin</a> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="col-sm-6"> |
| <div class="card"> |
| <div class="card-body"> |
| <h2 class="card-title"> |
| |
| Generate Configurations |
| </h2> |
| <p class="card-text">Tool to generate default configuration</p> |
| <a href="./tools/genconf.html" |
| class=" btn btn-primary btn-lg">Generate Configurations</a> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| <div class="row"> |
| |
| <div class="col-sm-6"> |
| <div class="card"> |
| <div class="card-body"> |
| <h2 class="card-title"> |
| |
| Audit Parser |
| </h2> |
| <p class="card-text">Audit Parser tool can be used for querying the ozone audit logs.</p> |
| <a href="./tools/auditparser.html" |
| class=" btn btn-primary btn-lg">Audit Parser</a> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div class="col-sm-6"> |
| <div class="card"> |
| <div class="card-body"> |
| <h2 class="card-title"> |
| |
| Testing tools |
| </h2> |
| <p class="card-text">Ozone contains multiple test tools for load generation, partitioning test or acceptance tests.</p> |
| <a href="./tools/testtools.html" |
| class=" btn btn-primary btn-lg">Testing tools</a> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="push"></div> |
| </div> |
| |
| |
| |
| <footer class="footer"> |
| <div class="container"> |
| <span class="small text-muted"> |
| Version: 1.1.0, Last Modified: August 7, 2020 <a class="hide-child link primary-color" href="https://github.com/apache/ozone/commit/5ce6f0eab381389fd04c3130531b3ec626acbc65">5ce6f0eab</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> |
