jojochuang commented on code in PR #293: URL: https://github.com/apache/ozone-site/pull/293#discussion_r2730856106
########## docs/05-administrator-guide/02-configuration/01-basic/03-directories/01-ozone-manager.md: ########## @@ -4,4 +4,70 @@ sidebar_label: Ozone Manager # Directory Configurations for Ozone Manager -**TODO:** File a subtask under [HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this page or section. +This section describes the directory-related configuration properties used by Ozone Manager (OM). + +```xml + <property> + <name>ozone.om.db.dirs</name> + <value/> + <tag>OZONE, OM, STORAGE, PERFORMANCE</tag> + <description> + Directory where the OzoneManager stores its metadata. This should + be specified as a single directory. If the directory does not + exist then the OM will attempt to create it. + + If undefined, then the OM will log a warning and fallback to + ozone.metadata.dirs. This fallback approach is not recommended for + production environments. + </description> + </property> + <property> + <name>ozone.om.db.dirs.permissions</name> + <value>750</value> + <description> + Permissions for the metadata directories for Ozone Manager. The + permissions have to be octal or symbolic. If the default permissions are not set + then the default value of 750 will be used. + </description> + </property> + +<property> + <name>ozone.om.ratis.storage.dir</name> + <value/> + <tag>OZONE, OM, STORAGE, MANAGEMENT, RATIS</tag> + <description>This directory is used for storing OM's Ratis metadata like + logs. If this is not set then default metadata dirs is used. A warning + will be logged if this not set. Ideally, this should be mapped to a + fast disk like an SSD. + If undefined, OM ratis storage dir will fallback to ozone.metadata.dirs. + This fallback approach is not recommended for production environments. + </description> +</property> + +<property> + <name>ozone.om.ratis.snapshot.dir</name> + <value/> + <tag>OZONE, OM, STORAGE, MANAGEMENT, RATIS</tag> + <description>This directory is used for storing OM's snapshot + related files like the ratisSnapshotIndex and DB checkpoint from leader + OM. + If undefined, OM snapshot dir will fallback to ozone.metadata.dirs. + This fallback approach is not recommended for production environments. + </description> +</property> + +<property> + <name>ozone.om.snapshot.diff.db.dir</name> + <value/> + <tag>OZONE, OM</tag> + <description> + Directory where the OzoneManager stores the snapshot diff related data. + This should be specified as a single directory. If the directory does not + exist then the OM will attempt to create it. + + If undefined, then the OM will log a warning and fallback to + ozone.metadata.dirs. This fallback approach is not recommended for + production environments. + </description> +</property> +``` Review Comment: Suggest to turn this into a table; added a column for sample value too. ```suggestion | Property Name | Description | Tags | Default/Example Value | Sample Value | |--------------------------------------|-----------------------------------------------------------------------------------------------------------|------------------------------------|--------------------------------------------------------------------------------|-----------------------------| | `ozone.om.db.dirs` | Directory where the OzoneManager stores its metadata. If not defined, falls back to `ozone.metadata.dirs`. | OZONE, OM, STORAGE, PERFORMANCE | Empty (creates directory if it doesn't exist) | `/var/data/ozone/om` | | `ozone.om.db.dirs.permissions` | Permissions for the metadata directories for Ozone Manager. Defaults to `750` if not defined. | | `750` | `750` | | `ozone.om.ratis.storage.dir` | Directory for storing OM's Ratis metadata like logs. Should use fast storage like SSD. | OZONE, OM, STORAGE, MANAGEMENT, RATIS | Falls back to `ozone.metadata.dirs` if undefined | `/var/data/ozone/ratis` | | `ozone.om.ratis.snapshot.dir` | Directory for storing OM's snapshot-related files like the `ratisSnapshotIndex` and DB checkpoint. | OZONE, OM, STORAGE, MANAGEMENT, RATIS | Falls back to `ozone.metadata.dirs` if undefined | `/var/data/ozone/snapshot` | | `ozone.om.snapshot.diff.db.dir` | Directory where OzoneManager stores snapshot diff-related data. | OZONE, OM | Falls back to `ozone.metadata.dirs` if undefined | `/var/data/ozone/diff` | ``` We really need to reduce the complexity. Having these many directories to configure makes it hard for beginners. -- 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]
