This is an automated email from the ASF dual-hosted git repository. nanda pushed a commit to branch ozone-0.4.1 in repository https://gitbox.apache.org/repos/asf/hadoop.git
commit 21402e2b30a3039f10c3deb2430ee5d24f31f1d5 Author: Márton Elek <e...@apache.org> AuthorDate: Thu Sep 19 14:42:33 2019 +0200 HDDS-2127. Detailed Tools doc not reachable Signed-off-by: Anu Engineer <aengin...@apache.org> (cherry picked from commit f260b5aa5b26d85504e95f877b53300fb0cd70af) --- hadoop-hdds/docs/content/recipe/_index.md | 2 +- hadoop-hdds/docs/content/tools/AuditParser.md | 2 +- hadoop-hdds/docs/content/tools/Freon.md | 62 ---------------------- hadoop-hdds/docs/content/tools/Genconf.md | 2 +- hadoop-hdds/docs/content/tools/SCMCLI.md | 2 +- hadoop-hdds/docs/content/tools/TestTools.md | 2 +- hadoop-hdds/docs/content/tools/Tools.md | 19 ------- .../content/{beyond/Tools.md => tools/_index.md} | 40 +++++++++----- 8 files changed, 33 insertions(+), 98 deletions(-) diff --git a/hadoop-hdds/docs/content/recipe/_index.md b/hadoop-hdds/docs/content/recipe/_index.md index beaab69..47053ab 100644 --- a/hadoop-hdds/docs/content/recipe/_index.md +++ b/hadoop-hdds/docs/content/recipe/_index.md @@ -2,7 +2,7 @@ title: Recipes date: "2017-10-10" menu: main -weight: 8 +weight: 9 --- <!--- diff --git a/hadoop-hdds/docs/content/tools/AuditParser.md b/hadoop-hdds/docs/content/tools/AuditParser.md index d79f44b..e4da208 100644 --- a/hadoop-hdds/docs/content/tools/AuditParser.md +++ b/hadoop-hdds/docs/content/tools/AuditParser.md @@ -1,7 +1,7 @@ --- title: "Audit Parser" date: 2018-12-17 - +summary: Audit Parser tool can be used for querying the ozone audit logs. --- <!--- Licensed to the Apache Software Foundation (ASF) under one or more diff --git a/hadoop-hdds/docs/content/tools/Freon.md b/hadoop-hdds/docs/content/tools/Freon.md deleted file mode 100644 index a306b9d..0000000 --- a/hadoop-hdds/docs/content/tools/Freon.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Freon -date: "2017-09-02T23:58:17-07:00" - ---- -<!--- - 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. ---> - -Overview --------- - -Freon is a load-generator for Ozone. This tool is used for testing the functionality of ozone. - -### Random keys - -In randomkeys mode, the data written into ozone cluster is randomly generated. -Each key will be of size 10 KB. - -The number of volumes/buckets/keys can be configured. The replication type and -factor (eg. replicate with ratis to 3 nodes) Also can be configured. - -For more information use - -`bin/ozone freon --help` - -### Example - -{{< highlight bash >}} -ozone freon randomkeys --numOfVolumes=10 --numOfBuckets 10 --numOfKeys 10 --replicationType=RATIS --factor=THREE -{{< /highlight >}} - -{{< highlight bash >}} -*************************************************** -Status: Success -Git Base Revision: 48aae081e5afacbb3240657556b26c29e61830c3 -Number of Volumes created: 10 -Number of Buckets created: 100 -Number of Keys added: 1000 -Ratis replication factor: THREE -Ratis replication type: RATIS -Average Time spent in volume creation: 00:00:00,035 -Average Time spent in bucket creation: 00:00:00,319 -Average Time spent in key creation: 00:00:03,659 -Average Time spent in key write: 00:00:10,894 -Total bytes written: 10240000 -Total Execution time: 00:00:16,898 -*********************** -{{< /highlight >}} diff --git a/hadoop-hdds/docs/content/tools/Genconf.md b/hadoop-hdds/docs/content/tools/Genconf.md index 146dfdc..35d5e3d 100644 --- a/hadoop-hdds/docs/content/tools/Genconf.md +++ b/hadoop-hdds/docs/content/tools/Genconf.md @@ -1,7 +1,7 @@ --- title: "Generate Configurations" date: 2018-12-18 - +summary: Tool to generate default configuration --- <!--- Licensed to the Apache Software Foundation (ASF) under one or more diff --git a/hadoop-hdds/docs/content/tools/SCMCLI.md b/hadoop-hdds/docs/content/tools/SCMCLI.md index 4fadda3..04950c2 100644 --- a/hadoop-hdds/docs/content/tools/SCMCLI.md +++ b/hadoop-hdds/docs/content/tools/SCMCLI.md @@ -1,7 +1,7 @@ --- title: "SCMCLI" date: 2017-08-10 - +summary: Admin tool for managing SCM --- <!--- Licensed to the Apache Software Foundation (ASF) under one or more diff --git a/hadoop-hdds/docs/content/tools/TestTools.md b/hadoop-hdds/docs/content/tools/TestTools.md index 6b1ac2c..a077f2e 100644 --- a/hadoop-hdds/docs/content/tools/TestTools.md +++ b/hadoop-hdds/docs/content/tools/TestTools.md @@ -1,6 +1,6 @@ --- title: "Testing tools" - +summary: Ozone contains multiple test tools for load generation, partitioning test or acceptance tests. --- <!--- Licensed to the Apache Software Foundation (ASF) under one or more diff --git a/hadoop-hdds/docs/content/tools/Tools.md b/hadoop-hdds/docs/content/tools/Tools.md deleted file mode 100644 index 7278fed..0000000 --- a/hadoop-hdds/docs/content/tools/Tools.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Testing tools" ---- -<!--- - 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. ---> \ No newline at end of file diff --git a/hadoop-hdds/docs/content/beyond/Tools.md b/hadoop-hdds/docs/content/tools/_index.md similarity index 85% rename from hadoop-hdds/docs/content/beyond/Tools.md rename to hadoop-hdds/docs/content/tools/_index.md index 7316089..d7c9270 100644 --- a/hadoop-hdds/docs/content/beyond/Tools.md +++ b/hadoop-hdds/docs/content/tools/_index.md @@ -2,8 +2,11 @@ title: "Tools" date: "2017-10-10" summary: Ozone supports a set of tools that are handy for developers.Here is a quick list of command line tools. -weight: 3 +menu: + main: + weight: 8 --- + <!--- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with @@ -25,25 +28,38 @@ Ozone has a set of command line tools that can be used to manage ozone. All these commands are invoked via the ```ozone``` script. -The commands supported by ozone are: +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 - * **fs** - Runs a command on ozone file system. - * **datanode** - Via daemon command, the HDDS data nodes can be started or - stopped. * **envvars** - Display computed Hadoop environment variables. - * **freon** - Runs the ozone load generator. - * **genesis** - Developer Only, Ozone micro-benchmark application. * **getconf** - Reads ozone config values from configuration. * **jmxget** - Get JMX exported values from NameNode or DataNode. - * **om** - Ozone Manager, via daemon command can be started or stopped. - * **sh** - Primary command line interface for ozone. - * **scm** - Storage Container Manager service, via daemon can be - stated or stopped. * **scmcli** - Developer only, Command Line Interface for the Storage Container Manager. - * **version** - Prints the version of Ozone and HDDS. * **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: \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org For additional commands, e-mail: common-commits-h...@hadoop.apache.org