Ozone Properties in Cloudera Runtime 7.1.0

Role groups:

Gateway

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Deploy Directory The directory where the client configs will be deployed /etc/ozone client_config_root_dir true
Gateway Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml For advanced use only, a string to be inserted into the client configuration for ozone-conf/ozone-site.xml. ozone-conf/ozone-site.xml_client_config_safety_valve false
Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml For advanced use only, a string to be inserted into the client configuration for ozone-conf/ssl-client.xml. ozone-conf/ssl-client.xml_client_config_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
Gateway Logging Threshold The minimum log level for Gateway logs INFO log_threshold false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false

Other

Display Name Description Related Name Default Value API Name Required
Alternatives Priority The priority level that the client configuration will have in the Alternatives system on the hosts. Higher priority levels will cause Alternatives to prefer this configuration over any others. 50 client_config_priority true

Security

Display Name Description Related Name Default Value API Name Required
Gateway TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Gateway might connect to. This is used when Gateway is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.client.truststore.location ssl_client_truststore_location false
Gateway TLS/SSL Client Trust Store Password The password for the Gateway TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.client.truststore.password ssl_client_truststore_password false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Deploy Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter. false role_config_suppression_client_config_root_dir true
Suppress Parameter Validation: Gateway Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml parameter. false role_config_suppression_ozone-conf/ozone-site.xml_client_config_safety_valve true
Suppress Parameter Validation: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml parameter. false role_config_suppression_ozone-conf/ssl-client.xml_client_config_safety_valve true
Suppress Parameter Validation: Gateway TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Gateway TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true

Ozone DataNode

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ozone DataNode Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties For advanced use only. A string to be inserted into ozone-conf/dn-audit-log4j2.properties for this role only. ozone-conf/dn-audit-log4j2.properties_role_safety_valve false
Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only. ozone-conf/ozone-site.xml_role_safety_valve false
Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only. ozone-conf/ssl-client.xml_role_safety_valve false
Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only. ozone-conf/ssl-server.xml_role_safety_valve false
Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. OZONE_DATANODE_role_env_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false

Logs

Display Name Description Related Name Default Value API Name Required
Ozone DataNode Log Directory The log directory for log files of the role Ozone DataNode. log.dir /var/log/hadoop-ozone log_dir false
Ozone DataNode Logging Threshold The minimum log level for Ozone DataNode logs INFO log_threshold false
Ozone DataNode Maximum Log File Backups The maximum number of rolled log files to keep for Ozone DataNode logs. Typically used by log4j or logback. 10 max_log_backup_index false
Ozone DataNode Max Log Size The maximum size, in megabytes, per log file for Ozone DataNode logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % ozone_datanode_fd_thresholds false
Ozone DataNode Host Health Test When computing the overall Ozone DataNode health, consider the host's health. true ozone_datanode_host_health_enabled false
Ozone DataNode Process Health Test Enables the health test that the Ozone DataNode's process state is consistent with the role configuration true ozone_datanode_scm_health_enabled false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Datanode Ratis Metadata Directory This directory is used for storing Datanode Ratis metadata. Ideally, this should be mapped to a fast disk like an SSD. dfs.container.ratis.datanode.storage.dir /var/lib/hadoop-ozone/datanode/ratis/data dfs.container.ratis.datanode.storage.dir true
Datanode Data Directory Determines where on the local filesystem HDDS data will be stored. hdds.datanode.dir /var/lib/hadoop-ozone/datanode/data hdds.datanode.dir true
Ozone Log Directory Directory where Ozone DataNode logs will be written to ozone.log.dir /var/log/hadoop-ozone ozone.log.dir false
Datanode Metadata Directory Determines where on the local filesystem datanode security certificates will be stored. ozone.metadata.dirs /var/lib/hadoop-ozone/datanode/ozone-metadata ozone.metadata.dirs true
Datanode ID Directory Ozone Datanode ID Directory ozone.scm.datanode.id.dir /var/lib/hadoop-ozone/datanode ozone.scm.datanode.id.dir true
Java Heap Size of DataNode Maximum size for the Java process heap memory. ozone_datanode_heap_size 4 GiB ozone_datanode_heap_size false

Performance

Display Name Description Related Name Default Value API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Ozone Datanode HTTP Web UI Port The base port that the Ozone Datanode web user interface listens on. The host name is combined with this port to form the 'hdds.datanode.http-address'. ozone.datanode.http-port 9882 ozone.datanode.http-port true
Ozone Datanode Port (TLS/SSL) The base port that the Ozone Datanode web user interface listens on when using HTTPS. The host name is combined with this port to form the 'hdds.datanode.https-address'. ozone.datanode.https-port 9883 ozone.datanode.https-port false

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value API Name Required
Ozone DataNode TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Ozone DataNode might connect to. This is used when Ozone DataNode is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.client.truststore.location ssl_client_truststore_location false
Ozone DataNode TLS/SSL Client Trust Store Password The password for the Ozone DataNode TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.client.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Ozone DataNode Encrypt communication between clients and Ozone DataNode using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ozone.ssl.enabled false ssl_enabled false
Ozone DataNode TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when Ozone DataNode is acting as a TLS/SSL server. ssl.server.keystore.keypassword ssl_server_keystore_keypassword false
Ozone DataNode TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Ozone DataNode is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.server.keystore.location ssl_server_keystore_location false
Ozone DataNode TLS/SSL Server JKS Keystore File Password The password for the Ozone DataNode JKS keystore file. ssl.server.keystore.password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Datanode Ratis Metadata Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Ratis Metadata Directory parameter. false role_config_suppression_dfs.container.ratis.datanode.storage.dir true
Suppress Parameter Validation: Datanode Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Data Directory parameter. false role_config_suppression_hdds.datanode.dir true
Suppress Parameter Validation: Ozone DataNode Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Ozone DataNode Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties parameter. false role_config_suppression_ozone-conf/dn-audit-log4j2.properties_role_safety_valve true
Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml parameter. false role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve true
Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml parameter. false role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve true
Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml parameter. false role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Datanode HTTP Web UI Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Datanode HTTP Web UI Port parameter. false role_config_suppression_ozone.datanode.http-port true
Suppress Parameter Validation: Ozone Datanode Port (TLS/SSL) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Datanode Port (TLS/SSL) parameter. false role_config_suppression_ozone.datanode.https-port true
Suppress Parameter Validation: Ozone Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Log Directory parameter. false role_config_suppression_ozone.log.dir true
Suppress Parameter Validation: Datanode Metadata Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Metadata Directory parameter. false role_config_suppression_ozone.metadata.dirs true
Suppress Parameter Validation: Datanode ID Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode ID Directory parameter. false role_config_suppression_ozone.scm.datanode.id.dir true
Suppress Parameter Validation: Java Heap Size of DataNode Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of DataNode parameter. false role_config_suppression_ozone_datanode_heap_size true
Suppress Parameter Validation: Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_ozone_datanode_role_env_safety_valve true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Ozone DataNode TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Ozone DataNode TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Ozone DataNode TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: Ozone DataNode TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Ozone DataNode TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_datanode_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_datanode_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_datanode_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_datanode_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_datanode_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_datanode_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_datanode_unexpected_exits true

Ozone Manager

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ozone Manager Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties For advanced use only. A string to be inserted into ozone-conf/om-audit-log4j2.properties for this role only. ozone-conf/om-audit-log4j2.properties_role_safety_valve false
Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only. ozone-conf/ozone-site.xml_role_safety_valve false
Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml For advanced use only. A string to be inserted into ozone-conf/ranger-ozone-audit.xml for this role only. ozone-conf/ranger-ozone-audit.xml_role_safety_valve false
Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-policymgr-ssl.xml For advanced use only. A string to be inserted into ozone-conf/ranger-ozone-policymgr-ssl.xml for this role only. ozone-conf/ranger-ozone-policymgr-ssl.xml_role_safety_valve false
Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml For advanced use only. A string to be inserted into ozone-conf/ranger-ozone-security.xml for this role only. ozone-conf/ranger-ozone-security.xml_role_safety_valve false
Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only. ozone-conf/ssl-client.xml_role_safety_valve false
Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only. ozone-conf/ssl-server.xml_role_safety_valve false
Ozone Manager Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. OZONE_MANAGER_role_env_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false

Logs

Display Name Description Related Name Default Value API Name Required
Ozone Manager Log Directory The log directory for log files of the role Ozone Manager. log.dir /var/log/hadoop-ozone log_dir false
Ozone Manager Logging Threshold The minimum log level for Ozone Manager logs INFO log_threshold false
Ozone Manager Maximum Log File Backups The maximum number of rolled log files to keep for Ozone Manager logs. Typically used by log4j or logback. 10 max_log_backup_index false
Ozone Manager Max Log Size The maximum size, in megabytes, per log file for Ozone Manager logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % ozone_manager_fd_thresholds false
Ozone Manager Host Health Test When computing the overall Ozone Manager health, consider the host's health. true ozone_manager_host_health_enabled false
Ozone Manager Process Health Test Enables the health test that the Ozone Manager's process state is consistent with the role configuration true ozone_manager_scm_health_enabled false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Java Heap Size of Ozone Manager Maximum size for the Java process heap memory. om_max_heap_size 4 GiB om_max_heap_size false
Ozone Log Directory Directory where Ozone Manager logs will be written to ozone.log.dir /var/log/hadoop-ozone ozone.log.dir false
Ozone Manager Metadata Directory Determines where on the local filesystem Ozone Manager security certificates will be stored. ozone.metadata.dirs /var/lib/hadoop-ozone/om/ozone-metadata ozone.metadata.dirs true
Ozone Manager Data Directory Directory where the OzoneManager stores its metadata. ozone.om.db.dirs /var/lib/hadoop-ozone/om/data ozone.om.db.dirs true
Ozone Manager HTTP Bind Hostname The actual address the OM web server will bind to. If this optional address is set, it overrides only the hostname portion of 'ozone.om.http-address'. ozone.om.http-bind-host 0.0.0.0 ozone.om.http-bind-host false
Secure Ozone Manager HTTPS Bind Hostname The actual address the OM web server will bind to using HTTPS. If this optional address is set, it overrides only the hostname portion of 'ozone.om.https-address'. ozone.om.https-bind-host 0.0.0.0 ozone.om.https-bind-host false
Ozone Manager Ratis Storage Directory This directory is used for storing Ozone Manager's Ratis metadata like logs. Ideally, this should be mapped to a fast disk like an SSD. ozone.om.ratis.storage.dir /var/lib/hadoop-ozone/om/ratis ozone.om.ratis.storage.dir true
Ranger Ozone Plugin Conf Path Staging directory for Ranger Ozone Plugin Configuration. This should generally not be changed. ranger_ozone_plugin_conf_path /etc/ranger/ozone-plugin ranger_ozone_plugin_conf_path true
Ranger Ozone Plugin Policy Cache Directory Path The directory where Ranger security policies are cached locally. ranger.plugin.ozone.policy.cache.dir /var/lib/ranger/ozone/policy-cache ranger_ozone_plugin_policy_cache_directory true
Ranger Ozone Plugin Audit Solr Spool Directory Path Spool directory for Ranger audits being written to Solr. xasecure.audit.destination.solr.batch.filespool.dir /var/log/hadoop-ozone/ranger-audit/solr/spool ranger_ozone_plugin_solr_audit_spool_directory true

Performance

Display Name Description Related Name Default Value API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Ozone Manager HTTP Web UI Port The base port that the Ozone Manager HTTP web user interface listens on. The host name of the Ozone Manager is combined with this port to form the 'ozone.om.http-address'. ozone.om.http-port 9874 ozone.om.http-port true
Secure Ozone Manager Web UI Port (TLS/SSL) The base port that the Ozone Manager HTTP web user interface listens on when using HTTPS. The host name of the Ozone Manager is combined with this port to form the 'ozone.om.https-address'. ozone.om.https-port 9875 ozone.om.https-port false
Ozone Manager Ratis port The base port that Ozone Manager's Ratis Server listens on if multiple Ozone Manager's are configured. ozone.om.ratis-port 9872 ozone.om.ratis-port false
Ozone Manager RPC port The base port that Ozone Manager listens on when serving RPCs. The host name of the Ozone Manager is combined with this port to form the 'ozone.om.address'. ozone.om.rpc-port 9862 ozone.om.rpc-port false

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value API Name Required
Ozone Manager TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Ozone Manager might connect to. This is used when Ozone Manager is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.client.truststore.location ssl_client_truststore_location false
Ozone Manager TLS/SSL Client Trust Store Password The password for the Ozone Manager TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.client.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Ozone Manager Encrypt communication between clients and Ozone Manager using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ozone.ssl.enabled false ssl_enabled false
Ozone Manager TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when Ozone Manager is acting as a TLS/SSL server. ssl.server.keystore.keypassword ssl_server_keystore_keypassword false
Ozone Manager TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Ozone Manager is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.server.keystore.location ssl_server_keystore_location false
Ozone Manager TLS/SSL Server JKS Keystore File Password The password for the Ozone Manager JKS keystore file. ssl.server.keystore.password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Ozone Manager Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Ozone Manager Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Java Heap Size of Ozone Manager Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Ozone Manager parameter. false role_config_suppression_om_max_heap_size true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties parameter. false role_config_suppression_ozone-conf/om-audit-log4j2.properties_role_safety_valve true
Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml parameter. false role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml parameter. false role_config_suppression_ozone-conf/ranger-ozone-audit.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-policymgr-ssl.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-policymgr-ssl.xml parameter. false role_config_suppression_ozone-conf/ranger-ozone-policymgr-ssl.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml parameter. false role_config_suppression_ozone-conf/ranger-ozone-security.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml parameter. false role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml parameter. false role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Log Directory parameter. false role_config_suppression_ozone.log.dir true
Suppress Parameter Validation: Ozone Manager Metadata Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Metadata Directory parameter. false role_config_suppression_ozone.metadata.dirs true
Suppress Parameter Validation: Ozone Manager Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Data Directory parameter. false role_config_suppression_ozone.om.db.dirs true
Suppress Parameter Validation: Ozone Manager HTTP Bind Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager HTTP Bind Hostname parameter. false role_config_suppression_ozone.om.http-bind-host true
Suppress Parameter Validation: Ozone Manager HTTP Web UI Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager HTTP Web UI Port parameter. false role_config_suppression_ozone.om.http-port true
Suppress Parameter Validation: Secure Ozone Manager HTTPS Bind Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone Manager HTTPS Bind Hostname parameter. false role_config_suppression_ozone.om.https-bind-host true
Suppress Parameter Validation: Secure Ozone Manager Web UI Port (TLS/SSL) Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone Manager Web UI Port (TLS/SSL) parameter. false role_config_suppression_ozone.om.https-port true
Suppress Parameter Validation: Ozone Manager Ratis port Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Ratis port parameter. false role_config_suppression_ozone.om.ratis-port true
Suppress Parameter Validation: Ozone Manager Ratis Storage Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Ratis Storage Directory parameter. false role_config_suppression_ozone.om.ratis.storage.dir true
Suppress Parameter Validation: Ozone Manager RPC port Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager RPC port parameter. false role_config_suppression_ozone.om.rpc-port true
Suppress Parameter Validation: Ozone Manager Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_ozone_manager_role_env_safety_valve true
Suppress Parameter Validation: Ranger Ozone Plugin Conf Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Ozone Plugin Conf Path parameter. false role_config_suppression_ranger_ozone_plugin_conf_path true
Suppress Parameter Validation: Ranger Ozone Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Ozone Plugin Policy Cache Directory Path parameter. false role_config_suppression_ranger_ozone_plugin_policy_cache_directory true
Suppress Parameter Validation: Ranger Ozone Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Ozone Plugin Audit Solr Spool Directory Path parameter. false role_config_suppression_ranger_ozone_plugin_solr_audit_spool_directory true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Ozone Manager TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Ozone Manager TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Ozone Manager TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: Ozone Manager TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Ozone Manager TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_manager_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_manager_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_manager_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_manager_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_manager_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_manager_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_manager_unexpected_exits true

Ozone Prometheus

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml For advanced use only. A string to be inserted into ozone-conf/ozone-prometheus.yml for this role only. ozone-conf/ozone-prometheus.yml_role_safety_valve false
Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. OZONE_PROMETHEUS_role_env_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % ozone_prometheus_fd_thresholds false
Ozone Prometheus Host Health Test When computing the overall Ozone Prometheus health, consider the host's health. true ozone_prometheus_host_health_enabled false
Ozone Prometheus Process Health Test Enables the health test that the Ozone Prometheus's process state is consistent with the role configuration true ozone_prometheus_scm_health_enabled false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Ozone Log Directory Directory where Prometheus logs will be written to ozone.log.dir /var/log/hadoop-ozone ozone.log.dir false
Prometheus Data Retention time. How long to retain samples in storage. Units Supported: y, w, d, h, m, s, ms. ozone.prometheus.data.retention.time 15d ozone.prometheus.data.retention.time false
Prometheus Data Directory Directory where the Prometheus Server stores its metadata. ozone.prometheus.db.dir /var/lib/hadoop-ozone/prometheus/data ozone.prometheus.db.dir true
Prometheus server extra flags. Extra command line flags that can be used while starting up the server. For example, '--query.timeout=2m --query.max-samples=5000' ozone.prometheus.extra.flags ozone.prometheus.extra.flags false
Prometheus server log level. Only log messages with the given severity or above. One of: [debug, info, warn, error] ozone.prometheus.log.level info ozone.prometheus.log.level false
Prometheus Binary Location Location of the unarchived Prometheus binary. prometheus.location prometheus.location true

Performance

Display Name Description Related Name Default Value API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Prometheus HTTP Port The base port that the prometheus web user interface listens on. ozone.prometheus.http-port 9090 ozone.prometheus.http-port true

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml parameter. false role_config_suppression_ozone-conf/ozone-prometheus.yml_role_safety_valve true
Suppress Parameter Validation: Ozone Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Log Directory parameter. false role_config_suppression_ozone.log.dir true
Suppress Parameter Validation: Prometheus Data Retention time. Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus Data Retention time. parameter. false role_config_suppression_ozone.prometheus.data.retention.time true
Suppress Parameter Validation: Prometheus Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus Data Directory parameter. false role_config_suppression_ozone.prometheus.db.dir true
Suppress Parameter Validation: Prometheus server extra flags. Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus server extra flags. parameter. false role_config_suppression_ozone.prometheus.extra.flags true
Suppress Parameter Validation: Prometheus HTTP Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus HTTP Port parameter. false role_config_suppression_ozone.prometheus.http-port true
Suppress Parameter Validation: Prometheus server log level. Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus server log level. parameter. false role_config_suppression_ozone.prometheus.log.level true
Suppress Parameter Validation: Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_ozone_prometheus_role_env_safety_valve true
Suppress Parameter Validation: Prometheus Binary Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus Binary Location parameter. false role_config_suppression_prometheus.location true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_prometheus_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_prometheus_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_prometheus_host_health true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_prometheus_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_prometheus_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_prometheus_unexpected_exits true

Ozone Recon

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ozone Recon Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only. ozone-conf/ozone-site.xml_role_safety_valve false
Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only. ozone-conf/ssl-client.xml_role_safety_valve false
Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only. ozone-conf/ssl-server.xml_role_safety_valve false
Ozone Recon Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. OZONE_RECON_role_env_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false

Logs

Display Name Description Related Name Default Value API Name Required
Ozone Recon Log Directory The log directory for log files of the role Ozone Recon. log.dir /var/log/hadoop-ozone log_dir false
Ozone Recon Logging Threshold The minimum log level for Ozone Recon logs INFO log_threshold false
Ozone Recon Maximum Log File Backups The maximum number of rolled log files to keep for Ozone Recon logs. Typically used by log4j or logback. 10 max_log_backup_index false
Ozone Recon Max Log Size The maximum size, in megabytes, per log file for Ozone Recon logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % ozone_recon_fd_thresholds false
Ozone Recon Host Health Test When computing the overall Ozone Recon health, consider the host's health. true ozone_recon_host_health_enabled false
Ozone Recon Process Health Test Enables the health test that the Ozone Recon's process state is consistent with the role configuration true ozone_recon_scm_health_enabled false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Ozone Log Directory Directory where Recon logs will be written to ozone.log.dir /var/log/hadoop-ozone ozone.log.dir false
Recon Metadata Directory Determines where on the local filesystem recon security certificates will be stored. ozone.metadata.dirs /var/lib/hadoop-ozone/recon/ozone-metadata ozone.metadata.dirs true
Recon Data Directory Directory where the Recon Server stores its metadata. ozone.recon.db.dir /var/lib/hadoop-ozone/recon/data ozone.recon.db.dir true
Recon HTTP Bind Hostname The actual address the Recon web server will bind to. If this optional address is set, it overrides only the hostname portion of 'ozone.recon.http-address'. ozone.recon.http-bind-host 0.0.0.0 ozone.recon.http-bind-host false
Secure Recon HTTPS Bind Hostname The actual address the Recon web server will bind to using HTTPS. If this optional address is set, it overrides only the hostname portion of 'ozone.recon.https-address'. ozone.recon.https-bind-host 0.0.0.0 ozone.recon.https-bind-host false
Recon OzoneManager Data Directory Directory where the Recon Server stores OzoneManager's metadata ozone.recon.om.db.dir /var/lib/hadoop-ozone/recon/om/data ozone.recon.om.db.dir true
Recon StorageContainerManager Data Directory Directory where the Recon Server stores StorageContainerManager's metadata ozone.recon.scm.db.dirs /var/lib/hadoop-ozone/recon/scm/data ozone.recon.scm.db.dirs true
Java Heap Size of Recon Maximum size for the Java process heap memory. ozone_recon_max_heap_size 1 GiB ozone_recon_max_heap_size false

Performance

Display Name Description Related Name Default Value API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Recon HTTP Web UI Port The base port that the Recon web user interface listens on. The host name of the Recon web user interface is combined with this port to form the 'ozone.recon.http-address'. ozone.recon.http-port 9888 ozone.recon.http-port true
Secure Recon Web UI Port (TLS/SSL) The base port that the Recon web user interface listens on when using HTTPS. The host name of the Recon web user interface is combined with this port to form the 'ozone.recon.https-address'. ozone.recon.https-port 9889 ozone.recon.https-port false
Recon RPC Port The base port that Recon listens on when serving RPCs. The host name of Recon is combined with this port to form the 'ozone.recon.address'. ozone.recon.rpc-port 9891 ozone.recon.rpc-port true

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value API Name Required
Ozone Recon TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Ozone Recon might connect to. This is used when Ozone Recon is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.client.truststore.location ssl_client_truststore_location false
Ozone Recon TLS/SSL Client Trust Store Password The password for the Ozone Recon TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.client.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Ozone Recon Encrypt communication between clients and Ozone Recon using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ozone.ssl.enabled false ssl_enabled false
Ozone Recon TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when Ozone Recon is acting as a TLS/SSL server. ssl.server.keystore.keypassword ssl_server_keystore_keypassword false
Ozone Recon TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Ozone Recon is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.server.keystore.location ssl_server_keystore_location false
Ozone Recon TLS/SSL Server JKS Keystore File Password The password for the Ozone Recon JKS keystore file. ssl.server.keystore.password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Ozone Recon Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Ozone Recon Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml parameter. false role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml parameter. false role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml parameter. false role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Log Directory parameter. false role_config_suppression_ozone.log.dir true
Suppress Parameter Validation: Recon Metadata Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon Metadata Directory parameter. false role_config_suppression_ozone.metadata.dirs true
Suppress Parameter Validation: Recon Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon Data Directory parameter. false role_config_suppression_ozone.recon.db.dir true
Suppress Parameter Validation: Recon HTTP Bind Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon HTTP Bind Hostname parameter. false role_config_suppression_ozone.recon.http-bind-host true
Suppress Parameter Validation: Recon HTTP Web UI Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon HTTP Web UI Port parameter. false role_config_suppression_ozone.recon.http-port true
Suppress Parameter Validation: Secure Recon HTTPS Bind Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Recon HTTPS Bind Hostname parameter. false role_config_suppression_ozone.recon.https-bind-host true
Suppress Parameter Validation: Secure Recon Web UI Port (TLS/SSL) Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Recon Web UI Port (TLS/SSL) parameter. false role_config_suppression_ozone.recon.https-port true
Suppress Parameter Validation: Recon OzoneManager Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon OzoneManager Data Directory parameter. false role_config_suppression_ozone.recon.om.db.dir true
Suppress Parameter Validation: Recon RPC Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon RPC Port parameter. false role_config_suppression_ozone.recon.rpc-port true
Suppress Parameter Validation: Recon StorageContainerManager Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon StorageContainerManager Data Directory parameter. false role_config_suppression_ozone.recon.scm.db.dirs true
Suppress Parameter Validation: Java Heap Size of Recon Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Recon parameter. false role_config_suppression_ozone_recon_max_heap_size true
Suppress Parameter Validation: Ozone Recon Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_ozone_recon_role_env_safety_valve true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Ozone Recon TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Ozone Recon TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Ozone Recon TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: Ozone Recon TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Ozone Recon TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_recon_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_recon_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_recon_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_recon_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_recon_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_recon_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_ozone_recon_unexpected_exits true

S3 Gateway

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
S3 Gateway Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only. ozone-conf/ozone-site.xml_role_safety_valve false
S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only. ozone-conf/ssl-client.xml_role_safety_valve false
S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only. ozone-conf/ssl-server.xml_role_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false
S3 Gateway Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. S3_GATEWAY_role_env_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
S3 Gateway Log Directory The log directory for log files of the role S3 Gateway. log.dir /var/log/hadoop-ozone log_dir false
S3 Gateway Logging Threshold The minimum log level for S3 Gateway logs INFO log_threshold false
S3 Gateway Maximum Log File Backups The maximum number of rolled log files to keep for S3 Gateway logs. Typically used by log4j or logback. 10 max_log_backup_index false
S3 Gateway Max Log Size The maximum size, in megabytes, per log file for S3 Gateway logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % s3_gateway_fd_thresholds false
S3 Gateway Host Health Test When computing the overall S3 Gateway health, consider the host's health. true s3_gateway_host_health_enabled false
S3 Gateway Process Health Test Enables the health test that the S3 Gateway's process state is consistent with the role configuration true s3_gateway_scm_health_enabled false
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Ozone S3 Gateway HTTP Bind Hostname The actual address the S3 Gateway web server will bind to. If this optional address is set, it overrides only the hostname portion of 'ozone.s3g.http-address'. ozone.s3g.http-bind-host 0.0.0.0 ozone.s3g.http-bind-host false
Secure Ozone S3 Gateway HTTPS Bind Hostname The actual address the S3 Gateway web server will bind to using HTTPS. If this optional address is set, it overrides only the hostname portion of 'ozone.s3g.https-address'. ozone.s3g.https-bind-host 0.0.0.0 ozone.s3g.https-bind-host false
Java Heap Size of S3 Gateway Maximum size for the Java process heap memory. ozone_S3_gateway_max_heap_size 1 GiB ozone_S3_gateway_max_heap_size false

Performance

Display Name Description Related Name Default Value API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Ozone S3 Gateway HTTP Web UI Port The base port that the S3 Gateway web user interface listens on. The host name of the S3 Gateway is combined with this port to form the 'ozone.s3g.http-address'. ozone.s3g.http-port 9878 ozone.s3g.http-port true
Secure Ozone S3 Gateway Web UI Port (TLS/SSL) The base port that the S3 Gateway web user interface listens on when using HTTPS. The host name of the S3 Gateway is combined with this port to form the 'ozone.s3g.https-address'. ozone.s3g.https-port 9879 ozone.s3g.https-port false

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value API Name Required
S3 Gateway TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that S3 Gateway might connect to. This is used when S3 Gateway is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.client.truststore.location ssl_client_truststore_location false
S3 Gateway TLS/SSL Client Trust Store Password The password for the S3 Gateway TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.client.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for S3 Gateway Encrypt communication between clients and S3 Gateway using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ozone.ssl.enabled false ssl_enabled false
S3 Gateway TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when S3 Gateway is acting as a TLS/SSL server. ssl.server.keystore.keypassword ssl_server_keystore_keypassword false
S3 Gateway TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when S3 Gateway is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.server.keystore.location ssl_server_keystore_location false
S3 Gateway TLS/SSL Server JKS Keystore File Password The password for the S3 Gateway JKS keystore file. ssl.server.keystore.password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: S3 Gateway Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: S3 Gateway Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml parameter. false role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve true
Suppress Parameter Validation: S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml parameter. false role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve true
Suppress Parameter Validation: S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml parameter. false role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve true
Suppress Parameter Validation: Ozone S3 Gateway HTTP Bind Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone S3 Gateway HTTP Bind Hostname parameter. false role_config_suppression_ozone.s3g.http-bind-host true
Suppress Parameter Validation: Ozone S3 Gateway HTTP Web UI Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone S3 Gateway HTTP Web UI Port parameter. false role_config_suppression_ozone.s3g.http-port true
Suppress Parameter Validation: Secure Ozone S3 Gateway HTTPS Bind Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone S3 Gateway HTTPS Bind Hostname parameter. false role_config_suppression_ozone.s3g.https-bind-host true
Suppress Parameter Validation: Secure Ozone S3 Gateway Web UI Port (TLS/SSL) Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone S3 Gateway Web UI Port (TLS/SSL) parameter. false role_config_suppression_ozone.s3g.https-port true
Suppress Parameter Validation: Java Heap Size of S3 Gateway Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of S3 Gateway parameter. false role_config_suppression_ozone_s3_gateway_max_heap_size true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: S3 Gateway Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_s3_gateway_role_env_safety_valve true
Suppress Parameter Validation: S3 Gateway TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: S3 Gateway TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: S3 Gateway TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: S3 Gateway TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: S3 Gateway TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_s3_gateway_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_s3_gateway_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_s3_gateway_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_s3_gateway_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_s3_gateway_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_s3_gateway_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_s3_gateway_unexpected_exits true

Service-Wide

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml For advanced use only, a string to be inserted into ozone-conf/ozone-site.xml. Applies to configurations of all roles in this service except client configuration. ozone-conf/ozone-site.xml_service_safety_valve false
Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml For advanced use only, a string to be inserted into ozone-conf/ssl-client.xml. Applies to configurations of all roles in this service except client configuration. ozone-conf/ssl-client.xml_service_safety_valve false
Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml For advanced use only, a string to be inserted into ozone-conf/ssl-server.xml. Applies to configurations of all roles in this service except client configuration. ozone-conf/ssl-server.xml_service_safety_valve false
Ozone Service Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration. OZONE_service_env_safety_valve false
System Group The group that this service's processes should run as. hdfs process_groupname true
System User The user that this service's processes should run as. hdfs process_username true

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Service Level Health Alerts When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Service Triggers The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] service_triggers true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. smon_derived_configs_safety_valve false

Other

Display Name Description Related Name Default Value API Name Required
HDFS Service Name of the HDFS service that this Ozone service instance depends on hdfs_service false
Enable Access Control Lists ACLs (Access Control Lists) enhance the existing Ozone permission model to support controlling file access for arbitrary combinations of users and groups instead of a single owner, single group, and all other users. When ACLs are disabled, the Ozone Manager rejects all attempts to set an ACL. ozone.acl.enabled false ozone.acl.enabled false
Ozone Replication Factor Default replication factor value for keys stored in Ozone. The actual number of replications can be specified when writing the key. The default is used if replication value is not specified. Supported values: 1 and 3. ozone.replication 3 ozone.replication true
Enable Kerberos Authentication Enables Kerberos authentication for Ozone. ozone.security.enabled false ozone.security.enabled false
Enable Kerberos Authentication for HTTP web consoles Enables Kerberos authentication for Ozone HTTP web consoles for all roles of this service using the SPNEGO protocol. Note: This is effective only if Kerberos is enabled for the Ozone service. ozone.security.http.kerberos.enabled false ozone.security.http.kerberos.enabled false
Ozone Service ID A logical name for this Ozone service. Note: No special characters. ozone.service.id ozone.service.id true
Ozone Java Options These arguments will be passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags would be passed here. ozone_java_opts java_args ozone_java_opts false
Ranger Ozone Plugin Hdfs Audit Directory The DFS path on which Ranger audits are written. ranger_ozone_plugin_hdfs_audit_directory $ranger_base_audit_url/ozone ranger_ozone_plugin_hdfs_audit_directory false
RANGER Service Name of the RANGER service that this Ozone service instance depends on ranger_service false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Configuration Validator: Deploy Directory Whether to suppress configuration warnings produced by the Deploy Directory configuration validator. false role_config_suppression_client_config_root_dir true
Suppress Configuration Validator: Datanode Ratis Metadata Directory Whether to suppress configuration warnings produced by the Datanode Ratis Metadata Directory configuration validator. false role_config_suppression_dfs.container.ratis.datanode.storage.dir true
Suppress Configuration Validator: Datanode Data Directory Whether to suppress configuration warnings produced by the Datanode Data Directory configuration validator. false role_config_suppression_hdds.datanode.dir true
Suppress Configuration Validator: Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_log4j_safety_valve true
Suppress Configuration Validator: Storage Container Manager Log Directory Whether to suppress configuration warnings produced by the Storage Container Manager Log Directory configuration validator. false role_config_suppression_log_dir true
Suppress Configuration Validator: Java Heap Size of Ozone Manager Whether to suppress configuration warnings produced by the Java Heap Size of Ozone Manager configuration validator. false role_config_suppression_om_max_heap_size true
Suppress Configuration Validator: Heap Dump Directory Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator. false role_config_suppression_oom_heap_dump_dir true
Suppress Configuration Validator: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties Whether to suppress configuration warnings produced by the Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties configuration validator. false role_config_suppression_ozone-conf/dn-audit-log4j2.properties_role_safety_valve true
Suppress Configuration Validator: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties Whether to suppress configuration warnings produced by the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties configuration validator. false role_config_suppression_ozone-conf/om-audit-log4j2.properties_role_safety_valve true
Suppress Configuration Validator: Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml Whether to suppress configuration warnings produced by the Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml configuration validator. false role_config_suppression_ozone-conf/ozone-prometheus.yml_role_safety_valve true
Suppress Configuration Validator: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml configuration validator. false role_config_suppression_ozone-conf/ozone-site.xml_client_config_safety_valve true
Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml configuration validator. false role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve true
Suppress Configuration Validator: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml Whether to suppress configuration warnings produced by the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml configuration validator. false role_config_suppression_ozone-conf/ranger-ozone-audit.xml_role_safety_valve true
Suppress Configuration Validator: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-policymgr-ssl.xml Whether to suppress configuration warnings produced by the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-policymgr-ssl.xml configuration validator. false role_config_suppression_ozone-conf/ranger-ozone-policymgr-ssl.xml_role_safety_valve true
Suppress Configuration Validator: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml Whether to suppress configuration warnings produced by the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml configuration validator. false role_config_suppression_ozone-conf/ranger-ozone-security.xml_role_safety_valve true
Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/scm-audit-log4j2.properties Whether to suppress configuration warnings produced by the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/scm-audit-log4j2.properties configuration validator. false role_config_suppression_ozone-conf/scm-audit-log4j2.properties_role_safety_valve true
Suppress Configuration Validator: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml configuration validator. false role_config_suppression_ozone-conf/ssl-client.xml_client_config_safety_valve true
Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml configuration validator. false role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve true
Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml Whether to suppress configuration warnings produced by the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml configuration validator. false role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve true
Suppress Configuration Validator: Ozone Datanode HTTP Web UI Port Whether to suppress configuration warnings produced by the Ozone Datanode HTTP Web UI Port configuration validator. false role_config_suppression_ozone.datanode.http-port true
Suppress Configuration Validator: Ozone Datanode Port (TLS/SSL) Whether to suppress configuration warnings produced by the Ozone Datanode Port (TLS/SSL) configuration validator. false role_config_suppression_ozone.datanode.https-port true
Suppress Configuration Validator: Ozone Log Directory Whether to suppress configuration warnings produced by the Ozone Log Directory configuration validator. false role_config_suppression_ozone.log.dir true
Suppress Configuration Validator: Storage Container Manager Metadata Directory Whether to suppress configuration warnings produced by the Storage Container Manager Metadata Directory configuration validator. false role_config_suppression_ozone.metadata.dirs true
Suppress Configuration Validator: Ozone Manager Data Directory Whether to suppress configuration warnings produced by the Ozone Manager Data Directory configuration validator. false role_config_suppression_ozone.om.db.dirs true
Suppress Configuration Validator: Ozone Manager HTTP Bind Hostname Whether to suppress configuration warnings produced by the Ozone Manager HTTP Bind Hostname configuration validator. false role_config_suppression_ozone.om.http-bind-host true
Suppress Configuration Validator: Ozone Manager HTTP Web UI Port Whether to suppress configuration warnings produced by the Ozone Manager HTTP Web UI Port configuration validator. false role_config_suppression_ozone.om.http-port true
Suppress Configuration Validator: Secure Ozone Manager HTTPS Bind Hostname Whether to suppress configuration warnings produced by the Secure Ozone Manager HTTPS Bind Hostname configuration validator. false role_config_suppression_ozone.om.https-bind-host true
Suppress Configuration Validator: Secure Ozone Manager Web UI Port (TLS/SSL) Whether to suppress configuration warnings produced by the Secure Ozone Manager Web UI Port (TLS/SSL) configuration validator. false role_config_suppression_ozone.om.https-port true
Suppress Configuration Validator: Ozone Manager Ratis port Whether to suppress configuration warnings produced by the Ozone Manager Ratis port configuration validator. false role_config_suppression_ozone.om.ratis-port true
Suppress Configuration Validator: Ozone Manager Ratis Storage Directory Whether to suppress configuration warnings produced by the Ozone Manager Ratis Storage Directory configuration validator. false role_config_suppression_ozone.om.ratis.storage.dir true
Suppress Configuration Validator: Ozone Manager RPC port Whether to suppress configuration warnings produced by the Ozone Manager RPC port configuration validator. false role_config_suppression_ozone.om.rpc-port true
Suppress Configuration Validator: Prometheus Data Retention time. Whether to suppress configuration warnings produced by the Prometheus Data Retention time. configuration validator. false role_config_suppression_ozone.prometheus.data.retention.time true
Suppress Configuration Validator: Prometheus Data Directory Whether to suppress configuration warnings produced by the Prometheus Data Directory configuration validator. false role_config_suppression_ozone.prometheus.db.dir true
Suppress Configuration Validator: Prometheus server extra flags. Whether to suppress configuration warnings produced by the Prometheus server extra flags. configuration validator. false role_config_suppression_ozone.prometheus.extra.flags true
Suppress Configuration Validator: Prometheus HTTP Port Whether to suppress configuration warnings produced by the Prometheus HTTP Port configuration validator. false role_config_suppression_ozone.prometheus.http-port true
Suppress Configuration Validator: Prometheus server log level. Whether to suppress configuration warnings produced by the Prometheus server log level. configuration validator. false role_config_suppression_ozone.prometheus.log.level true
Suppress Configuration Validator: Recon Data Directory Whether to suppress configuration warnings produced by the Recon Data Directory configuration validator. false role_config_suppression_ozone.recon.db.dir true
Suppress Configuration Validator: Recon HTTP Bind Hostname Whether to suppress configuration warnings produced by the Recon HTTP Bind Hostname configuration validator. false role_config_suppression_ozone.recon.http-bind-host true
Suppress Configuration Validator: Recon HTTP Web UI Port Whether to suppress configuration warnings produced by the Recon HTTP Web UI Port configuration validator. false role_config_suppression_ozone.recon.http-port true
Suppress Configuration Validator: Secure Recon HTTPS Bind Hostname Whether to suppress configuration warnings produced by the Secure Recon HTTPS Bind Hostname configuration validator. false role_config_suppression_ozone.recon.https-bind-host true
Suppress Configuration Validator: Secure Recon Web UI Port (TLS/SSL) Whether to suppress configuration warnings produced by the Secure Recon Web UI Port (TLS/SSL) configuration validator. false role_config_suppression_ozone.recon.https-port true
Suppress Configuration Validator: Recon OzoneManager Data Directory Whether to suppress configuration warnings produced by the Recon OzoneManager Data Directory configuration validator. false role_config_suppression_ozone.recon.om.db.dir true
Suppress Configuration Validator: Recon RPC Port Whether to suppress configuration warnings produced by the Recon RPC Port configuration validator. false role_config_suppression_ozone.recon.rpc-port true
Suppress Configuration Validator: Recon StorageContainerManager Data Directory Whether to suppress configuration warnings produced by the Recon StorageContainerManager Data Directory configuration validator. false role_config_suppression_ozone.recon.scm.db.dirs true
Suppress Configuration Validator: Ozone S3 Gateway HTTP Bind Hostname Whether to suppress configuration warnings produced by the Ozone S3 Gateway HTTP Bind Hostname configuration validator. false role_config_suppression_ozone.s3g.http-bind-host true
Suppress Configuration Validator: Ozone S3 Gateway HTTP Web UI Port Whether to suppress configuration warnings produced by the Ozone S3 Gateway HTTP Web UI Port configuration validator. false role_config_suppression_ozone.s3g.http-port true
Suppress Configuration Validator: Secure Ozone S3 Gateway HTTPS Bind Hostname Whether to suppress configuration warnings produced by the Secure Ozone S3 Gateway HTTPS Bind Hostname configuration validator. false role_config_suppression_ozone.s3g.https-bind-host true
Suppress Configuration Validator: Secure Ozone S3 Gateway Web UI Port (TLS/SSL) Whether to suppress configuration warnings produced by the Secure Ozone S3 Gateway Web UI Port (TLS/SSL) configuration validator. false role_config_suppression_ozone.s3g.https-port true
Suppress Configuration Validator: Datanode ID Directory Whether to suppress configuration warnings produced by the Datanode ID Directory configuration validator. false role_config_suppression_ozone.scm.datanode.id.dir true
Suppress Configuration Validator: Storage Container Manager Data Directory Whether to suppress configuration warnings produced by the Storage Container Manager Data Directory configuration validator. false role_config_suppression_ozone.scm.db.dirs true
Suppress Configuration Validator: Storage Container Manager HTTP Bind Hostname Whether to suppress configuration warnings produced by the Storage Container Manager HTTP Bind Hostname configuration validator. false role_config_suppression_ozone.scm.http-bind-host true
Suppress Configuration Validator: Storage Container Manager HTTP Web UI Port Whether to suppress configuration warnings produced by the Storage Container Manager HTTP Web UI Port configuration validator. false role_config_suppression_ozone.scm.http-port true
Suppress Configuration Validator: Secure Storage Container Manager HTTPS Bind Hostname Whether to suppress configuration warnings produced by the Secure Storage Container Manager HTTPS Bind Hostname configuration validator. false role_config_suppression_ozone.scm.https-bind-host true
Suppress Configuration Validator: Secure Storage Container Manager Web UI Port (TLS/SSL) Whether to suppress configuration warnings produced by the Secure Storage Container Manager Web UI Port (TLS/SSL) configuration validator. false role_config_suppression_ozone.scm.https-port true
Suppress Configuration Validator: Java Heap Size of DataNode Whether to suppress configuration warnings produced by the Java Heap Size of DataNode configuration validator. false role_config_suppression_ozone_datanode_heap_size true
Suppress Configuration Validator: Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_ozone_datanode_role_env_safety_valve true
Suppress Configuration Validator: Ozone Manager Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ozone Manager Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_ozone_manager_role_env_safety_valve true
Suppress Configuration Validator: Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_ozone_prometheus_role_env_safety_valve true
Suppress Configuration Validator: Java Heap Size of Recon Whether to suppress configuration warnings produced by the Java Heap Size of Recon configuration validator. false role_config_suppression_ozone_recon_max_heap_size true
Suppress Configuration Validator: Ozone Recon Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ozone Recon Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_ozone_recon_role_env_safety_valve true
Suppress Configuration Validator: Java Heap Size of S3 Gateway Whether to suppress configuration warnings produced by the Java Heap Size of S3 Gateway configuration validator. false role_config_suppression_ozone_s3_gateway_max_heap_size true
Suppress Configuration Validator: Prometheus Binary Location Whether to suppress configuration warnings produced by the Prometheus Binary Location configuration validator. false role_config_suppression_prometheus.location true
Suppress Configuration Validator: Ranger Ozone Plugin Conf Path Whether to suppress configuration warnings produced by the Ranger Ozone Plugin Conf Path configuration validator. false role_config_suppression_ranger_ozone_plugin_conf_path true
Suppress Configuration Validator: Ranger Ozone Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the Ranger Ozone Plugin Policy Cache Directory Path configuration validator. false role_config_suppression_ranger_ozone_plugin_policy_cache_directory true
Suppress Configuration Validator: Ranger Ozone Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the Ranger Ozone Plugin Audit Solr Spool Directory Path configuration validator. false role_config_suppression_ranger_ozone_plugin_solr_audit_spool_directory true
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator. false role_config_suppression_rm_custom_resources true
Suppress Configuration Validator: Role Triggers Whether to suppress configuration warnings produced by the Role Triggers configuration validator. false role_config_suppression_role_triggers true
Suppress Configuration Validator: S3 Gateway Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the S3 Gateway Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_s3_gateway_role_env_safety_valve true
Suppress Configuration Validator: Java Heap Size of Storage Container Manager Whether to suppress configuration warnings produced by the Java Heap Size of Storage Container Manager configuration validator. false role_config_suppression_scm_max_heap_size true
Suppress Configuration Validator: Storage Container Manager TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Client Trust Store File configuration validator. false role_config_suppression_ssl_client_truststore_location true
Suppress Configuration Validator: Storage Container Manager TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Client Trust Store Password configuration validator. false role_config_suppression_ssl_client_truststore_password true
Suppress Configuration Validator: Storage Container Manager TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Server JKS Keystore Key Password configuration validator. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Configuration Validator: Storage Container Manager TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Server JKS Keystore File Location configuration validator. false role_config_suppression_ssl_server_keystore_location true
Suppress Configuration Validator: Storage Container Manager TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Server JKS Keystore File Password configuration validator. false role_config_suppression_ssl_server_keystore_password true
Suppress Configuration Validator: Stacks Collection Directory Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. false role_config_suppression_stacks_collection_directory true
Suppress Configuration Validator: Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_storage_container_manager_role_env_safety_valve true
Suppress Configuration Validator: Gateway Count Validator Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator. false service_config_suppression_gateway_count_validator true
Suppress Parameter Validation: Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml parameter. false service_config_suppression_ozone-conf/ozone-site.xml_service_safety_valve true
Suppress Parameter Validation: Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml parameter. false service_config_suppression_ozone-conf/ssl-client.xml_service_safety_valve true
Suppress Parameter Validation: Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml parameter. false service_config_suppression_ozone-conf/ssl-server.xml_service_safety_valve true
Suppress Parameter Validation: Ozone Service ID Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Service ID parameter. false service_config_suppression_ozone.service.id true
Suppress Configuration Validator: Ozone DataNode Count Validator Whether to suppress configuration warnings produced by the Ozone DataNode Count Validator configuration validator. false service_config_suppression_ozone_datanode_count_validator true
Suppress Parameter Validation: Ozone Java Options Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Java Options parameter. false service_config_suppression_ozone_java_opts true
Suppress Configuration Validator: Ozone Manager Count Validator Whether to suppress configuration warnings produced by the Ozone Manager Count Validator configuration validator. false service_config_suppression_ozone_manager_count_validator true
Suppress Configuration Validator: Ozone Prometheus Count Validator Whether to suppress configuration warnings produced by the Ozone Prometheus Count Validator configuration validator. false service_config_suppression_ozone_prometheus_count_validator true
Suppress Configuration Validator: Ozone Recon Count Validator Whether to suppress configuration warnings produced by the Ozone Recon Count Validator configuration validator. false service_config_suppression_ozone_recon_count_validator true
Suppress Parameter Validation: Ozone Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Service Environment Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_ozone_service_env_safety_valve true
Suppress Parameter Validation: System Group Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. false service_config_suppression_process_groupname true
Suppress Parameter Validation: System User Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. false service_config_suppression_process_username true
Suppress Parameter Validation: Ranger Ozone Plugin Hdfs Audit Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Ozone Plugin Hdfs Audit Directory parameter. false service_config_suppression_ranger_ozone_plugin_hdfs_audit_directory true
Suppress Configuration Validator: S3 Gateway Count Validator Whether to suppress configuration warnings produced by the S3 Gateway Count Validator configuration validator. false service_config_suppression_s3_gateway_count_validator true
Suppress Parameter Validation: Service Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. false service_config_suppression_service_triggers true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_smon_derived_configs_safety_valve true
Suppress Configuration Validator: Storage Container Manager Count Validator Whether to suppress configuration warnings produced by the Storage Container Manager Count Validator configuration validator. false service_config_suppression_storage_container_manager_count_validator true

Storage Container Manager

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only. ozone-conf/ozone-site.xml_role_safety_valve false
Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/scm-audit-log4j2.properties For advanced use only. A string to be inserted into ozone-conf/scm-audit-log4j2.properties for this role only. ozone-conf/scm-audit-log4j2.properties_role_safety_valve false
Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only. ozone-conf/ssl-client.xml_role_safety_valve false
Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only. ozone-conf/ssl-server.xml_role_safety_valve false
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false
Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. STORAGE_CONTAINER_MANAGER_role_env_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
Storage Container Manager Log Directory The log directory for log files of the role Storage Container Manager. log.dir /var/log/hadoop-ozone log_dir false
Storage Container Manager Logging Threshold The minimum log level for Storage Container Manager logs INFO log_threshold false
Storage Container Manager Maximum Log File Backups The maximum number of rolled log files to keep for Storage Container Manager logs. Typically used by log4j or logback. 10 max_log_backup_index false
Storage Container Manager Max Log Size The maximum size, in megabytes, per log file for Storage Container Manager logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % storage_container_manager_fd_thresholds false
Storage Container Manager Host Health Test When computing the overall Storage Container Manager health, consider the host's health. true storage_container_manager_host_health_enabled false
Storage Container Manager Process Health Test Enables the health test that the Storage Container Manager's process state is consistent with the role configuration true storage_container_manager_scm_health_enabled false
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Ozone Log Directory Directory where Storage Container Manager logs will be written to ozone.log.dir /var/log/hadoop-ozone ozone.log.dir false
Storage Container Manager Metadata Directory Determines where on the local filesystem SCM security certificates will be stored. ozone.metadata.dirs /var/lib/hadoop-ozone/scm/ozone-metadata ozone.metadata.dirs true
Storage Container Manager Data Directory Directory where the StorageContainerManager stores its metadata ozone.scm.db.dirs /var/lib/hadoop-ozone/scm/data ozone.scm.db.dirs true
Storage Container Manager HTTP Bind Hostname The actual address the SCM web server will bind to. If this optional address is set, it overrides only the hostname portion of 'ozone.scm.http-address'. ozone.scm.http-bind-host 0.0.0.0 ozone.scm.http-bind-host false
Secure Storage Container Manager HTTPS Bind Hostname The actual address the SCM web server will bind to using HTTPS. If this optional address is set, it overrides only the hostname portion of 'ozone.scm.https-address'. ozone.scm.https-bind-host 0.0.0.0 ozone.scm.https-bind-host false
Java Heap Size of Storage Container Manager Maximum size for the Java process heap memory. scm_max_heap_size 4 GiB scm_max_heap_size false

Performance

Display Name Description Related Name Default Value API Name Required
Maximum Process File Descriptors If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. rlimit_fds false

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Storage Container Manager HTTP Web UI Port The base port that the Storage Container Manager web user interface listens on. The host name of the Storage Container Manager is combined with this port to form the 'ozone.scm.http-address'. ozone.scm.http-port 9876 ozone.scm.http-port true
Secure Storage Container Manager Web UI Port (TLS/SSL) The base port that the Storage Container Manager web user interface listens on when using HTTPS. The host name of the Storage Container Manager is combined with this port to form the 'ozone.scm.https-address'. ozone.scm.https-port 9877 ozone.scm.https-port false

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value API Name Required
Storage Container Manager TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Storage Container Manager might connect to. This is used when Storage Container Manager is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. ssl.client.truststore.location ssl_client_truststore_location false
Storage Container Manager TLS/SSL Client Trust Store Password The password for the Storage Container Manager TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. ssl.client.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Storage Container Manager Encrypt communication between clients and Storage Container Manager using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ozone.ssl.enabled false ssl_enabled false
Storage Container Manager TLS/SSL Server JKS Keystore Key Password The password that protects the private key contained in the JKS keystore used when Storage Container Manager is acting as a TLS/SSL server. ssl.server.keystore.keypassword ssl_server_keystore_keypassword false
Storage Container Manager TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Storage Container Manager is acting as a TLS/SSL server. The keystore must be in JKS format. ssl.server.keystore.location ssl_server_keystore_location false
Storage Container Manager TLS/SSL Server JKS Keystore File Password The password for the Storage Container Manager JKS keystore file. ssl.server.keystore.password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Storage Container Manager Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml parameter. false role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve true
Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/scm-audit-log4j2.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/scm-audit-log4j2.properties parameter. false role_config_suppression_ozone-conf/scm-audit-log4j2.properties_role_safety_valve true
Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml parameter. false role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve true
Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml parameter. false role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve true
Suppress Parameter Validation: Ozone Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Log Directory parameter. false role_config_suppression_ozone.log.dir true
Suppress Parameter Validation: Storage Container Manager Metadata Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Metadata Directory parameter. false role_config_suppression_ozone.metadata.dirs true
Suppress Parameter Validation: Storage Container Manager Data Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Data Directory parameter. false role_config_suppression_ozone.scm.db.dirs true
Suppress Parameter Validation: Storage Container Manager HTTP Bind Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager HTTP Bind Hostname parameter. false role_config_suppression_ozone.scm.http-bind-host true
Suppress Parameter Validation: Storage Container Manager HTTP Web UI Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager HTTP Web UI Port parameter. false role_config_suppression_ozone.scm.http-port true
Suppress Parameter Validation: Secure Storage Container Manager HTTPS Bind Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Storage Container Manager HTTPS Bind Hostname parameter. false role_config_suppression_ozone.scm.https-bind-host true
Suppress Parameter Validation: Secure Storage Container Manager Web UI Port (TLS/SSL) Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Storage Container Manager Web UI Port (TLS/SSL) parameter. false role_config_suppression_ozone.scm.https-port true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Java Heap Size of Storage Container Manager Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Storage Container Manager parameter. false role_config_suppression_scm_max_heap_size true
Suppress Parameter Validation: Storage Container Manager TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Storage Container Manager TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Storage Container Manager TLS/SSL Server JKS Keystore Key Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Server JKS Keystore Key Password parameter. false role_config_suppression_ssl_server_keystore_keypassword true
Suppress Parameter Validation: Storage Container Manager TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Storage Container Manager TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Parameter Validation: Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_storage_container_manager_role_env_safety_valve true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_storage_container_manager_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_storage_container_manager_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_storage_container_manager_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_storage_container_manager_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_storage_container_manager_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_storage_container_manager_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ozone_storage_container_manager_unexpected_exits true