Tools

Ozone has a set of command line tools that can be used to manage ozone.

All these commands are invoked via the ozone script.

Daemon commands:

  • scm - Storage Container Manager service, via daemon can be started or stopped.
  • om - Ozone Manager, via daemon command can be started or stopped.
  • datanode - Via daemon command, the HDDS data nodes can be started or stopped.
  • s3g -

Client commands:

  • sh - Primary command line interface for ozone to manage volumes/buckets/keys.
  • fs - Runs a command on ozone file system (similar to hdfs dfs)
  • version - Prints the version of Ozone and HDDS.

Admin commands:

  • classpath - Prints the class path needed to get the hadoop jar and the required libraries.
  • dtutil - Operations related to delegation tokens
  • envvars - Display computed Hadoop environment variables.
  • getconf - Reads ozone config values from configuration.
  • jmxget - Get JMX exported values from NameNode or DataNode.
  • scmcli - Developer only, Command Line Interface for the Storage Container Manager.
  • genconf - Generate minimally required ozone configs and output to ozone-site.xml.

Test tools:

  • freon - Runs the ozone load generator.
  • genesis - Developer Only, Ozone micro-benchmark application.

For more information see the following subpages:

Generate Configurations

Genconf tool generates a template ozone-site.xml file at the specified path. This template file can be edited to replace with proper values. ozone genconf <path>

Generate Configurations

Audit Parser

Audit Parser tool can be used for querying the ozone audit logs. This tool creates a sqllite database at the specified path. If the database already exists, it will avoid creating a database. The database contains only one table called audit defined as: CREATE TABLE IF NOT EXISTS audit ( datetime text, level varchar(7), logger varchar(7), user text, ip text, op text, params text, result varchar(7), exception text, UNIQUE(datetime,level,logger,user,ip,op,params,result)) Usage: ozone auditparser <path to db file> [COMMAND] [PARAM]

Audit Parser

SCMCLI

SCM is the block service for Ozone. It is also the workhorse for ozone. But user process never talks to SCM. However, being able to read the state of SCM is useful. SCMCLI allows the developer to access SCM directly. Please note: Improper usage of this tool can destroy your cluster. Unless you know exactly what you are doing, Please do not use this tool. In other words, this is a developer only tool.

SCMCLI

Testing tools

Testing is one of the most important part during the development of a distributed system. We have the following type of test. This page includes our existing test tool which are part of the Ozone source base. Note: we have more tests (like TCP-DS, TCP-H tests via Spark or Hive) which are not included here because they use external tools only. Unit test As every almost every java project we have the good old unit tests inside each of our projects.

Testing tools