echonesis commented on code in PR #256: URL: https://github.com/apache/ozone-site/pull/256#discussion_r2702078850
########## docs/05-administrator-guide/03-operations/14-ozone-repair.md: ########## @@ -0,0 +1,276 @@ +# Ozone Repair + +Ozone Repair (`ozone repair`) is an advanced tool to repair Ozone. The nodes being repaired must be stopped before the tool is run. + +**Note:** All repair commands support a `--dry-run` option which allows a user to see what repair the command will be performing without actually making any changes to the cluster. +Use the `--force` flag to override the running service check in false-positive cases. Review Comment: We could use Admonitions. ```md :::note ``` ########## docs/05-administrator-guide/03-operations/14-ozone-repair.md: ########## @@ -0,0 +1,276 @@ +# Ozone Repair + +Ozone Repair (`ozone repair`) is an advanced tool to repair Ozone. The nodes being repaired must be stopped before the tool is run. + +**Note:** All repair commands support a `--dry-run` option which allows a user to see what repair the command will be performing without actually making any changes to the cluster. +Use the `--force` flag to override the running service check in false-positive cases. + +```bash +Usage: ozone repair [-hV] [--verbose] [-conf=<configurationPath>] + [-D=<String=String>]... [COMMAND] +Advanced tool to repair Ozone. The nodes being repaired must be stopped before +the tool is run. + -conf=<configurationPath> + + -D, --set=<String=String> + + -h, --help Show this help message and exit. + -V, --version Print version information and exit. + --verbose More verbose output. Show the stack trace of the errors. +Commands: + datanode Tools to repair Datanode + ldb Operational tool to repair ldb. + om Operational tool to repair OM. + scm Operational tool to repair SCM. +``` + +For more detailed usage see the output of --help for each of the subcommands. + +## ozone repair Datanode + +Operational tool to repair Datanode. + +### upgrade-container-schema + +Upgrade all schema V2 containers to schema V3 for a Datanode in offline mode. +Optionally takes `--volume` option to specify which volume needs the upgrade. + +## ozone repair ldb + +Operational tool to repair ldb. + +### compact + +Compact a column family in the DB to clean up tombstones while the service is offline. + +```bash +Usage: ozone repair ldb compact [-hV] [--dry-run] [--force] [--verbose] + --cf=<columnFamilyName> --db=<dbPath> +CLI to compact a column-family in the DB while the service is offline. +Note: If om.db is compacted with this tool then it will negatively impact the +Ozone Manager's efficient snapshot diff. + --cf, --column-family, --column_family=<columnFamilyName> + Column family name + --db=<dbPath> Database File Path +``` + +## ozone repair OM + +Operational tool to repair OM. + +### Subcommands under OM + +- FSO-tree + +- snapshot + +- update-transaction + +- quota + +- compact + +- skip-ratis-transaction Review Comment: We could remove the new lines. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
