Ozone Properties in Cloudera Runtime 7.2.18

Role groups:

Gateway

Advanced

Deploy Directory

Description: The directory where the client configs will be deployed
Related Name
Default Value: /etc/ozone
API Name: client_config_root_dir
Required: true

Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-metrics2.properties

Description: For advanced use only, a string to be inserted into the client configuration for ozone-conf/hadoop-metrics2.properties.
Related Name
Default Value
API Name: ozone-conf/hadoop-metrics2.properties_client_config_safety_valve
Required: false

Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: For advanced use only, a string to be inserted into the client configuration for ozone-conf/ozone-site.xml.
Related Name
Default Value
API Name: ozone-conf/ozone-site.xml_client_config_safety_valve
Required: false

Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: For advanced use only, a string to be inserted into the client configuration for ozone-conf/ssl-client.xml.
Related Name
Default Value
API Name: ozone-conf/ssl-client.xml_client_config_safety_valve
Required: false

Logs

Gateway Logging Threshold

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

Monitoring

Enable Configuration Change Alerts

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

Other

Alternatives Priority

Description: 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.
Related Name
Default Value: 50
API Name: client_config_priority
Required: true

Security

Gateway TLS/SSL Trust Store File

Description: 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 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.
Related Name: ssl.client.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

Gateway TLS/SSL Trust Store Password

Description: The password for the Gateway TLS/SSL 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.
Related Name: ssl.client.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Deploy Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Parameter Validation: Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-metrics2.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-metrics2.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/hadoop-metrics2.properties_client_config_safety_valve
Required: true

Suppress Parameter Validation: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_client_config_safety_valve
Required: true

Suppress Parameter Validation: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_client_config_safety_valve
Required: true

Suppress Parameter Validation: Gateway TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Parameter Validation: Gateway TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

HttpFS Gateway

Advanced

HttpFS Gateway Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: HTTPFS_GATEWAY_role_env_safety_valve
Required: false

HttpFS Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/httpfs-site.xml

Description: For advanced use only. A string to be inserted into ozone-conf/httpfs-site.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/httpfs-site.xml_role_safety_valve
Required: false

HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ozone-site.xml_role_safety_valve
Required: false

HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-client.xml_role_safety_valve
Required: false

HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-server.xml_role_safety_valve
Required: false

Automatically Restart Process

Description: 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.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Role Specific System Group

Description: The group that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_groupname
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: 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.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: 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.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Role Specific System User

Description: The user that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_username
Required: true

Logs

HttpFS Gateway Log Directory

Description: The log directory for log files of the role HttpFS Gateway.
Related Name: log.dir
Default Value: /var/log/hadoop-ozone
API Name: log_dir
Required: false

HttpFS Gateway Logging Threshold

Description: The minimum log level for HttpFS Gateway logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

HttpFS Gateway Maximum Log File Backups

Description: The maximum number of rolled log files to keep for HttpFS Gateway logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

HttpFS Gateway Max Log Size

Description: The maximum size, in megabytes, per log file for HttpFS Gateway logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

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

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: httpfs_gateway_fd_thresholds
Required: false

HttpFS Gateway Host Health Test

Description: When computing the overall HttpFS Gateway health, consider the host's health.
Related Name
Default Value: true
API Name: httpfs_gateway_host_health_enabled
Required: false

HttpFS Gateway Process Health Test

Description: Enables the health test that the HttpFS Gateway's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: httpfs_gateway_scm_health_enabled
Required: false

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: false
API Name: jmx_exporter_enabled
Required: true

JMX Exporter Port

Description: JMX Exporter needs a port to implement a Prometheus exporter.
Related Name
Default Value
API Name: jmx_exporter_port
Required: false

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Metric Filter

Description

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"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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.

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Hive Proxy User Groups for Ozone HttpFS

Description: Comma-delimited list of groups from which to allow the Hive user to impersonate others when connecting to Ozone HttpFS. To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: httpfs.proxyuser.hive.groups
Default Value: *
API Name: httpfs.proxyuser.hive.groups
Required: true

Hive Proxy User Hosts for Ozone HttpFS

Description: Comma-delimited list of hosts from which to allow the Hive user to impersonate others when connecting to Ozone HttpFS. To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: httpfs.proxyuser.hive.hosts
Default Value: *
API Name: httpfs.proxyuser.hive.hosts
Required: true

Hue Proxy User Groups for Ozone HttpFS

Description: Comma-delimited list of groups from which to allow the Hue user to impersonate others when connecting to Ozone HttpFS. To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: httpfs.proxyuser.hue.groups
Default Value: *
API Name: httpfs.proxyuser.hue.groups
Required: true

Hue Proxy User Hosts for Ozone HttpFS

Description: Comma-delimited list of hosts from which to allow the Hue user to impersonate others when connecting to Ozone HttpFS. To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: httpfs.proxyuser.hue.hosts
Default Value: *
API Name: httpfs.proxyuser.hue.hosts
Required: true

Ozone HttpFS Gateway HTTP Bind Hostname

Description: The actual address the HttpFS Gateway web server will bind to. If this optional address is set, it overrides only the hostname portion of 'ozone.httpfs.http-address'.
Related Name: ozone.httpfs.http-bind-host
Default Value: 0.0.0.0
API Name: ozone.httpfs.http-bind-host
Required: false

Java Heap Size of HttpFS Gateway

Description: Maximum size for the Java process heap memory.
Related Name: ozone_httpfs_gateway_max_heap_size
Default Value: 1 GiB
API Name: ozone_httpfs_gateway_max_heap_size
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Ozone HttpFS Gateway HTTP Web UI Port

Description: The base port that the HttpFS Gateway web user interface listens on. The host name of the HttpFS Gateway is combined with this port to form the 'ozone.httpfs.http-address'.
Related Name: ozone.httpfs.http-port
Default Value: 9778
API Name: ozone.httpfs.http-port
Required: true

Resource Management

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: 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.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Role-Specific Kerberos Principal

Description: Kerberos principal used by the HttpFS Gateway roles.
Related Name
Default Value: httpfs
API Name: kerberos_role_princ_name
Required: true

HttpFS Gateway TLS/SSL Trust Store File

Description: The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that HttpFS Gateway might connect to. 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.
Related Name: ssl.client.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

HttpFS Gateway TLS/SSL Trust Store Password

Description: The password for the HttpFS Gateway TLS/SSL 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.
Related Name: ssl.client.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL for HttpFS Gateway

Description: Encrypt communication between clients and HttpFS Gateway using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ozone.ssl.enabled
Default Value: false
API Name: ssl_enabled
Required: false

HttpFS Gateway TLS/SSL Server Keystore Key Password

Description: The password that protects the private key contained in the keystore used when HttpFS Gateway is acting as a TLS/SSL server.
Related Name: ssl.server.keystore.keypassword
Default Value
API Name: ssl_server_keystore_keypassword
Required: false

HttpFS Gateway TLS/SSL Server Keystore File Location

Description: The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when HttpFS Gateway is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name: ssl.server.keystore.location
Default Value
API Name: ssl_server_keystore_location
Required: false

HttpFS Gateway TLS/SSL Server Keystore File Password

Description: The password for the HttpFS Gateway keystore file.
Related Name: ssl.server.keystore.password
Default Value
API Name: ssl_server_keystore_password
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Hive Proxy User Groups for Ozone HttpFS

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Proxy User Groups for Ozone HttpFS parameter.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs.proxyuser.hive.groups
Required: true

Suppress Parameter Validation: Hive Proxy User Hosts for Ozone HttpFS

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Proxy User Hosts for Ozone HttpFS parameter.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs.proxyuser.hive.hosts
Required: true

Suppress Parameter Validation: Hue Proxy User Groups for Ozone HttpFS

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Proxy User Groups for Ozone HttpFS parameter.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs.proxyuser.hue.groups
Required: true

Suppress Parameter Validation: Hue Proxy User Hosts for Ozone HttpFS

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Proxy User Hosts for Ozone HttpFS parameter.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs.proxyuser.hue.hosts
Required: true

Suppress Parameter Validation: HttpFS Gateway Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs_gateway_role_env_safety_valve
Required: true

Suppress Parameter Validation: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Parameter Validation: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role-Specific Kerberos Principal parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Parameter Validation: HttpFS Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: HttpFS Gateway Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/httpfs-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/httpfs-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/httpfs-site.xml_role_safety_valve
Required: true

Suppress Parameter Validation: HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve
Required: true

Suppress Parameter Validation: HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve
Required: true

Suppress Parameter Validation: HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone HttpFS Gateway HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone HttpFS Gateway HTTP Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.httpfs.http-bind-host
Required: true

Suppress Parameter Validation: Ozone HttpFS Gateway HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone HttpFS Gateway HTTP Web UI Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.httpfs.http-port
Required: true

Suppress Parameter Validation: Java Heap Size of HttpFS Gateway

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of HttpFS Gateway parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_httpfs_gateway_max_heap_size
Required: true

Suppress Parameter Validation: Role Specific System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: Role Specific System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_username
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: HttpFS Gateway TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Parameter Validation: HttpFS Gateway TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

Suppress Parameter Validation: HttpFS Gateway TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Parameter Validation: HttpFS Gateway TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Parameter Validation: HttpFS Gateway TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Gateway TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_otelcol_health
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_httpfs_gateway_unexpected_exits
Required: true

Ozone DataNode

Advanced

Ozone DataNode Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties

Description: For advanced use only. A string to be inserted into ozone-conf/dn-audit-log4j2.properties for this role only.
Related Name
Default Value
API Name: ozone-conf/dn-audit-log4j2.properties_role_safety_valve
Required: false

Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-container-log4j2.properties

Description: For advanced use only. A string to be inserted into ozone-conf/dn-container-log4j2.properties for this role only.
Related Name
Default Value
API Name: ozone-conf/dn-container-log4j2.properties_role_safety_valve
Required: false

Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ozone-site.xml_role_safety_valve
Required: false

Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-client.xml_role_safety_valve
Required: false

Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-server.xml_role_safety_valve
Required: false

Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: OZONE_DATANODE_role_env_safety_valve
Required: false

Automatically Restart Process

Description: 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.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Role Specific System Group

Description: The group that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_groupname
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: 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.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: 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.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Role Specific System User

Description: The user that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_username
Required: true

Logs

Ozone DataNode Log Directory

Description: The log directory for log files of the role Ozone DataNode.
Related Name: log.dir
Default Value: /var/log/hadoop-ozone
API Name: log_dir
Required: false

Ozone DataNode Logging Threshold

Description: The minimum log level for Ozone DataNode logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

Ozone DataNode Maximum Log File Backups

Description: The maximum number of rolled log files to keep for Ozone DataNode logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

Ozone DataNode Max Log Size

Description: The maximum size, in megabytes, per log file for Ozone DataNode logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

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

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: false
API Name: jmx_exporter_enabled
Required: true

JMX Exporter Port

Description: JMX Exporter needs a port to implement a Prometheus exporter.
Related Name
Default Value
API Name: jmx_exporter_port
Required: false

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Metric Filter

Description

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.

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"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: ozone_datanode_fd_thresholds
Required: false

Ozone DataNode Host Health Test

Description: When computing the overall Ozone DataNode health, consider the host's health.
Related Name
Default Value: true
API Name: ozone_datanode_host_health_enabled
Required: false

Ozone DataNode Process Health Test

Description: Enables the health test that the Ozone DataNode's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: ozone_datanode_scm_health_enabled
Required: false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Datanode Ratis Metadata Directory

Description: One or more directories used for storing Datanode Ratis metadata. Ideally, this should be mapped to a fast disk like an SSD.
Related Name: dfs.container.ratis.datanode.storage.dir
Default Value: /var/lib/hadoop-ozone/datanode/ratis/data
API Name: dfs.container.ratis.datanode.storage.dir
Required: true

Number of Disks where Blocks are Stored that are Allowed to Fail

Description: The number of disks where blocks are stored that are allowed to fail before a datanode stops offering service. Set this property to -1 to specify that an unlimited number of disks can fail. If set to -1, there must be at least one good disk remaining on which to store blocks.
Related Name: failed.data.volumes.tolerated
Default Value: -1
API Name: failed.data.volumes.tolerated
Required: false

Number of Disks that Store Block Metadata that are Allowed to Fail

Description: The number of disks that store block metadata that are allowed to fail before a datanode stops offering service. Set this property to -1 to specify that an unlimited number of disks can fail. If set to -1, there must be at least one good disk remaining on which to store block metadata.
Related Name: failed.metadata.volumes.tolerated
Default Value: -1
API Name: failed.metadata.volumes.tolerated
Required: false

Graceful Shutdown Timeout

Description: The timeout in milliseconds to wait for graceful shutdown to complete.
Related Name
Default Value: 2 minute(s)
API Name: graceful_stop_timeout
Required: false

Datanode Data Directory

Description: Determines where on the local filesystem HDDS data will be stored.
Related Name: hdds.datanode.dir
Default Value: /var/lib/hadoop-ozone/datanode/data
API Name: hdds.datanode.dir
Required: true

Datanode Out-Of-Service Replication Limit Factor

Description: Decommissioning and maintenance nodes can handle more replication commands than in-service nodes due to reduced load. This multiplier determines the increased queue capacity and executor pool size. The current default is 2.0
Related Name: hdds.datanode.replication.outofservice.limit.factor
Default Value
API Name: hdds.datanode.replication.outofservice.limit.factor
Required: false

Datanode Replication Streams Limit

Description: The maximum number of replication commands a single datanode can execute simultaneously. The current default is 10.
Related Name: hdds.datanode.replication.streams.limit
Default Value
API Name: hdds.datanode.replication.streams.limit
Required: false

Ozone Datanode HTTP Bind Hostname

Description: The actual address the Ozone Datanode web server will bind to. If this optional address is set, it overrides only the hostname portion of 'ozone.datanode.http-address'.
Related Name: ozone.datanode.http-bind-host
Default Value: 0.0.0.0
API Name: ozone.datanode.http-bind-host
Required: false

Secure Ozone Datanode HTTPS Bind Hostname

Description: The actual address the Ozone Datanode web server will bind to using HTTPS. If this optional address is set, it overrides only the hostname portion of 'ozone.datanode.https-address'.
Related Name: ozone.datanode.https-bind-host
Default Value: 0.0.0.0
API Name: ozone.datanode.https-bind-host
Required: false

HSTS Header for DataNode UI

Description: HSTS Header (Strict-Transport-Security) value to use
Related Name: ozone.http.header.Strict-Transport-Security
Default Value: max-age=63072000; includeSubDomains;
API Name: ozone.http.header.Strict-Transport-Security
Required: false

Datanode Metadata Directory

Description: Determines where on the local filesystem datanode security certificates will be stored.
Related Name: ozone.metadata.dirs
Default Value: /var/lib/hadoop-ozone/datanode/ozone-metadata
API Name: ozone.metadata.dirs
Required: true

Datanode ID Directory

Description: Ozone Datanode ID Directory
Related Name: ozone.scm.datanode.id.dir
Default Value: /var/lib/hadoop-ozone/datanode
API Name: ozone.scm.datanode.id.dir
Required: true

Java Heap Size of DataNode

Description: Maximum size for the Java process heap memory.
Related Name: ozone_datanode_heap_size
Default Value: 4 GiB
API Name: ozone_datanode_heap_size
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Datanode Ratis IPC Port for Admin Requests

Description: The container IPC port number for admin requests.
Related Name: dfs.container.ratis.admin.port
Default Value: 9857
API Name: dfs.container.ratis.admin.port
Required: true

Datanode Ratis IPC Port for Server-to-Server Communication

Description: The container IPC port number for server-to-server communication.
Related Name: dfs.container.ratis.server.port
Default Value: 9856
API Name: dfs.container.ratis.server.port
Required: true

Ozone Datanode HTTP Web UI Port

Description: 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'.
Related Name: ozone.datanode.http-port
Default Value: 9882
API Name: ozone.datanode.http-port
Required: true

Ozone Datanode Port (TLS/SSL)

Description: 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'.
Related Name: ozone.datanode.https-port
Default Value: 9883
API Name: ozone.datanode.https-port
Required: false

Resource Management

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: 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.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Role-Specific Kerberos Principal

Description: Kerberos principal used by the Ozone DataNode roles.
Related Name
Default Value: dn
API Name: kerberos_role_princ_name
Required: true

Ozone DataNode TLS/SSL Trust Store File

Description: 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 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.
Related Name: ssl.client.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

Ozone DataNode TLS/SSL Trust Store Password

Description: The password for the Ozone DataNode TLS/SSL 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.
Related Name: ssl.client.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL for Ozone DataNode

Description: Encrypt communication between clients and Ozone DataNode using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ozone.ssl.enabled
Default Value: false
API Name: ssl_enabled
Required: false

Ozone DataNode TLS/SSL Server Keystore Key Password

Description: The password that protects the private key contained in the keystore used when Ozone DataNode is acting as a TLS/SSL server.
Related Name: ssl.server.keystore.keypassword
Default Value
API Name: ssl_server_keystore_keypassword
Required: false

Ozone DataNode TLS/SSL Server Keystore File Location

Description: 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 the format specified in Administration > Settings > Java Keystore Type.
Related Name: ssl.server.keystore.location
Default Value
API Name: ssl_server_keystore_location
Required: false

Ozone DataNode TLS/SSL Server Keystore File Password

Description: The password for the Ozone DataNode keystore file.
Related Name: ssl.server.keystore.password
Default Value
API Name: ssl_server_keystore_password
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Datanode Ratis IPC Port for Admin Requests

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Ratis IPC Port for Admin Requests parameter.
Related Name
Default Value: false
API Name: role_config_suppression_dfs.container.ratis.admin.port
Required: true

Suppress Parameter Validation: Datanode Ratis Metadata Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Ratis Metadata Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_dfs.container.ratis.datanode.storage.dir
Required: true

Suppress Parameter Validation: Datanode Ratis IPC Port for Server-to-Server Communication

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Ratis IPC Port for Server-to-Server Communication parameter.
Related Name
Default Value: false
API Name: role_config_suppression_dfs.container.ratis.server.port
Required: true

Suppress Parameter Validation: Datanode Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Data Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.datanode.dir
Required: true

Suppress Parameter Validation: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Parameter Validation: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role-Specific Kerberos Principal parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Parameter Validation: Ozone DataNode Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Ozone DataNode Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/dn-audit-log4j2.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-container-log4j2.properties

Description: 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-container-log4j2.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/dn-container-log4j2.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Datanode HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Datanode HTTP Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.datanode.http-bind-host
Required: true

Suppress Parameter Validation: Ozone Datanode HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Datanode HTTP Web UI Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.datanode.http-port
Required: true

Suppress Parameter Validation: Secure Ozone Datanode HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone Datanode HTTPS Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.datanode.https-bind-host
Required: true

Suppress Parameter Validation: Ozone Datanode Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Datanode Port (TLS/SSL) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.datanode.https-port
Required: true

Suppress Parameter Validation: HSTS Header for DataNode UI

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HSTS Header for DataNode UI parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.http.header.strict-transport-security
Required: true

Suppress Parameter Validation: Datanode Metadata Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Metadata Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.metadata.dirs
Required: true

Suppress Parameter Validation: Datanode ID Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode ID Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.datanode.id.dir
Required: true

Suppress Parameter Validation: Java Heap Size of DataNode

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of DataNode parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_datanode_heap_size
Required: true

Suppress Parameter Validation: Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_datanode_role_env_safety_valve
Required: true

Suppress Parameter Validation: Role Specific System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: Role Specific System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_username
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: Ozone DataNode TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Parameter Validation: Ozone DataNode TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

Suppress Parameter Validation: Ozone DataNode TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Parameter Validation: Ozone DataNode TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Parameter Validation: Ozone DataNode TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone DataNode TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_otelcol_health
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_datanode_unexpected_exits
Required: true

Ozone Manager

Advanced

Ozone Manager Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties

Description: For advanced use only. A string to be inserted into ozone-conf/om-audit-log4j2.properties for this role only.
Related Name
Default Value
API Name: ozone-conf/om-audit-log4j2.properties_role_safety_valve
Required: false

Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ozone-site.xml_role_safety_valve
Required: false

Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ranger-ozone-audit.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ranger-ozone-audit.xml_role_safety_valve
Required: false

Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-policymgr-ssl.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ranger-ozone-policymgr-ssl.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ranger-ozone-policymgr-ssl.xml_role_safety_valve
Required: false

Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ranger-ozone-security.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ranger-ozone-security.xml_role_safety_valve
Required: false

Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-client.xml_role_safety_valve
Required: false

Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-server.xml_role_safety_valve
Required: false

Ozone Manager Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: OZONE_MANAGER_role_env_safety_valve
Required: false

Automatically Restart Process

Description: 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.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Role Specific System Group

Description: The group that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_groupname
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: 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.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: 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.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Role Specific System User

Description: The user that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_username
Required: true

Logs

Ozone Manager Log Directory

Description: The log directory for log files of the role Ozone Manager.
Related Name: log.dir
Default Value: /var/log/hadoop-ozone
API Name: log_dir
Required: false

Ozone Manager Logging Threshold

Description: The minimum log level for Ozone Manager logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

Ozone Manager Maximum Log File Backups

Description: The maximum number of rolled log files to keep for Ozone Manager logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

Ozone Manager Max Log Size

Description: The maximum size, in megabytes, per log file for Ozone Manager logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

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

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: false
API Name: jmx_exporter_enabled
Required: true

JMX Exporter Port

Description: JMX Exporter needs a port to implement a Prometheus exporter.
Related Name
Default Value
API Name: jmx_exporter_port
Required: false

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Metric Filter

Description

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.

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"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: ozone_manager_fd_thresholds
Required: false

Ozone Manager Host Health Test

Description: When computing the overall Ozone Manager health, consider the host's health.
Related Name
Default Value: true
API Name: ozone_manager_host_health_enabled
Required: false

Ozone Manager Process Health Test

Description: Enables the health test that the Ozone Manager's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: ozone_manager_scm_health_enabled
Required: false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Graceful Shutdown Timeout

Description: The timeout in milliseconds to wait for graceful shutdown to complete.
Related Name
Default Value: 2 minute(s)
API Name: graceful_stop_timeout
Required: false

OM ID

Description: ID uniquely identifying each broker or controller. Never set this property at the group level; it should always be overridden on instance level.
Related Name: om.id
Default Value
API Name: om.id
Required: false

Java Heap Size of Ozone Manager

Description: Maximum size for the Java process heap memory.
Related Name: om_max_heap_size
Default Value: 4 GiB
API Name: om_max_heap_size
Required: false

Ozone Default Bucket Layout

Description: This configuration controls the default bucket layout that the OM will use when creating a bucket if the client does not specify one. Supported values are OBJECT_STORE, FILE_SYSTEM_OPTIMIZED, and LEGACY.
Related Name: ozone.default.bucket.layout
Default Value
API Name: ozone.default.bucket.layout
Required: false

Ozone Filesystem Trash Checkpoint Interval

Description: Number of minutes between trash checkpoints
Related Name: ozone.fs.trash.checkpoint.interval
Default Value: 1 hour(s)
API Name: ozone.fs.trash.checkpoint.interval
Required: false

Ozone Filesystem Trash Interval

Description: Controls the number of minutes after which a trash checkpoint directory is deleted permanently
Related Name: ozone.fs.trash.interval
Default Value: 1 day(s)
API Name: ozone.fs.trash.interval
Required: false

HSTS Header for Ozone Manager UI

Description: HSTS Header (Strict-Transport-Security) value to use
Related Name: ozone.http.header.Strict-Transport-Security
Default Value: max-age=63072000; includeSubDomains;
API Name: ozone.http.header.Strict-Transport-Security
Required: false

Ozone Manager Metadata Directory

Description: Determines where on the local filesystem Ozone Manager security certificates will be stored.
Related Name: ozone.metadata.dirs
Default Value: /var/lib/hadoop-ozone/om/ozone-metadata
API Name: ozone.metadata.dirs
Required: true

Ozone Manager Data Directory

Description: Directory where the OzoneManager stores its metadata.
Related Name: ozone.om.db.dirs
Default Value: /var/lib/hadoop-ozone/om/data
API Name: ozone.om.db.dirs
Required: true

Ozone Manager HTTP Bind Hostname

Description: 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'.
Related Name: ozone.om.http-bind-host
Default Value: 0.0.0.0
API Name: ozone.om.http-bind-host
Required: false

Secure Ozone Manager HTTPS Bind Hostname

Description: 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'.
Related Name: ozone.om.https-bind-host
Default Value: 0.0.0.0
API Name: ozone.om.https-bind-host
Required: false

Enable Ozone S3 Multi-Tenancy feature

Description: Enable Ozone S3 Multi-Tenancy feature in Ozone Manager. This feature requires Kerberos Authentication to be enabled.
Related Name: ozone.om.multitenancy.enabled
Default Value: false
API Name: ozone.om.multitenancy.enabled
Required: false

New Ozone Manager Nodes

Description: Hostnames of newly added ozone manager nodes. If more than one hostname is to be added then put a ',' between hostnames, e.g, [hostname1,hostname2,hostname3]'.
Related Name: ozone.om.new.added.nodes
Default Value
API Name: ozone.om.new.added.nodes
Required: false

Ozone Manager Ratis Storage Directory

Description: 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.
Related Name: ozone.om.ratis.storage.dir
Default Value: /var/lib/hadoop-ozone/om/ratis
API Name: ozone.om.ratis.storage.dir
Required: true

Ozone Server Replication Factor

Description: The default value of the replication factor for objects. The default is used if replication is not specified when creating a key or if no default replication is set at the bucket. Supported values for RATIS are 1, 3. Supported values for EC are rs-3-2-1024k, rs-6-3-1024k, rs-10-4-1024k, XOR-3-2-1024k, XOR-6-3-1024k, XOR-10-4-4096K (i.e XOR-3-2-{CHUNK_SIZE})
Related Name: ozone.server.default.replication
Default Value: 3
API Name: ozone.server.default.replication
Required: true

Ozone Server Replication Type

Description: The default replication type to be used for Objects. The default is used when a type is not specified when creating an Object or no default value is set for the bucket. Supported values are RATIS, STAND_ALONE, and EC.
Related Name: ozone.server.default.replication.type
Default Value: RATIS
API Name: ozone.server.default.replication.type
Required: true

Ozone Manager Upgrade Need Finalization Canary Enabled

Description: Determines if the Ozone Manager Upgrade Need Finalization Canary is enabled.
Related Name: ozone_om_upgrade_need_finalization_canary_enabled
Default Value: true
API Name: ozone_om_upgrade_need_finalization_canary_enabled
Required: false

Ozone Manager Upgrade Need Finalization Canary Timeout

Description: Sets Ozone Manager Upgrade Need Finalization Canary's timeout.
Related Name: ozone_om_upgrade_need_finalization_canary_timeout
Default Value: 30 second(s)
API Name: ozone_om_upgrade_need_finalization_canary_timeout
Required: false

Ranger Ozone Plugin Conf Path

Description: Staging directory for Ranger Ozone Plugin Configuration. This should generally not be changed.
Related Name: ranger_ozone_plugin_conf_path
Default Value: /etc/ranger/ozone-plugin
API Name: ranger_ozone_plugin_conf_path
Required: true

Ranger Ozone Plugin Policy Cache Directory Path

Description: The directory where Ranger security policies are cached locally.
Related Name: ranger.plugin.ozone.policy.cache.dir
Default Value: /var/lib/ranger/ozone/policy-cache
API Name: ranger_ozone_plugin_policy_cache_directory
Required: true

Ranger Ozone Plugin Audit Solr Spool Directory Path

Description: Spool directory for Ranger audits being written to Solr.
Related Name: xasecure.audit.destination.solr.batch.filespool.dir
Default Value: /var/log/hadoop-ozone/ranger-audit/solr/spool
API Name: ranger_ozone_plugin_solr_audit_spool_directory
Required: true

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Ozone Manager HTTP Web UI Port

Description: 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'.
Related Name: ozone.om.http-port
Default Value: 9874
API Name: ozone.om.http-port
Required: true

Secure Ozone Manager Web UI Port (TLS/SSL)

Description: 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'.
Related Name: ozone.om.https-port
Default Value: 9875
API Name: ozone.om.https-port
Required: false

Ozone Manager Ratis port

Description: The base port that Ozone Manager's Ratis Server listens on if multiple Ozone Manager's are configured.
Related Name: ozone.om.ratis-port
Default Value: 9872
API Name: ozone.om.ratis-port
Required: false

Ozone Manager RPC port

Description: 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'.
Related Name: ozone.om.rpc-port
Default Value: 9862
API Name: ozone.om.rpc-port
Required: false

Resource Management

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: 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.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Role-Specific Kerberos Principal

Description: Kerberos principal used by the Ozone Manager roles.
Related Name
Default Value: om
API Name: kerberos_role_princ_name
Required: true

Ozone Manager TLS/SSL Trust Store File

Description: 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 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.
Related Name: ssl.client.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

Ozone Manager TLS/SSL Trust Store Password

Description: The password for the Ozone Manager TLS/SSL 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.
Related Name: ssl.client.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL for Ozone Manager

Description: Encrypt communication between clients and Ozone Manager using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ozone.ssl.enabled
Default Value: false
API Name: ssl_enabled
Required: false

Ozone Manager TLS/SSL Server Keystore Key Password

Description: The password that protects the private key contained in the keystore used when Ozone Manager is acting as a TLS/SSL server.
Related Name: ssl.server.keystore.keypassword
Default Value
API Name: ssl_server_keystore_keypassword
Required: false

Ozone Manager TLS/SSL Server Keystore File Location

Description: 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 the format specified in Administration > Settings > Java Keystore Type.
Related Name: ssl.server.keystore.location
Default Value
API Name: ssl_server_keystore_location
Required: false

Ozone Manager TLS/SSL Server Keystore File Password

Description: The password for the Ozone Manager keystore file.
Related Name: ssl.server.keystore.password
Default Value
API Name: ssl_server_keystore_password
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Parameter Validation: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role-Specific Kerberos Principal parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Parameter Validation: Ozone Manager Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Ozone Manager Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: OM ID

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OM ID parameter.
Related Name
Default Value: false
API Name: role_config_suppression_om.id
Required: true

Suppress Parameter Validation: Java Heap Size of Ozone Manager

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Ozone Manager parameter.
Related Name
Default Value: false
API Name: role_config_suppression_om_max_heap_size
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/om-audit-log4j2.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ranger-ozone-audit.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-policymgr-ssl.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ranger-ozone-policymgr-ssl.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ranger-ozone-security.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve
Required: true

Suppress Parameter Validation: HSTS Header for Ozone Manager UI

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HSTS Header for Ozone Manager UI parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.http.header.strict-transport-security
Required: true

Suppress Parameter Validation: Ozone Manager Metadata Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Metadata Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.metadata.dirs
Required: true

Suppress Parameter Validation: Ozone Manager Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Data Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.db.dirs
Required: true

Suppress Parameter Validation: Ozone Manager HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager HTTP Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.http-bind-host
Required: true

Suppress Parameter Validation: Ozone Manager HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager HTTP Web UI Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.http-port
Required: true

Suppress Parameter Validation: Secure Ozone Manager HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone Manager HTTPS Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.https-bind-host
Required: true

Suppress Parameter Validation: Secure Ozone Manager Web UI Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone Manager Web UI Port (TLS/SSL) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.https-port
Required: true

Suppress Parameter Validation: New Ozone Manager Nodes

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the New Ozone Manager Nodes parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.new.added.nodes
Required: true

Suppress Parameter Validation: Ozone Manager Ratis port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Ratis port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.ratis-port
Required: true

Suppress Parameter Validation: Ozone Manager Ratis Storage Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Ratis Storage Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.ratis.storage.dir
Required: true

Suppress Parameter Validation: Ozone Manager RPC port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager RPC port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.rpc-port
Required: true

Suppress Parameter Validation: Ozone Server Replication Factor

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Server Replication Factor parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.server.default.replication
Required: true

Suppress Parameter Validation: Ozone Server Replication Type

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Server Replication Type parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.server.default.replication.type
Required: true

Suppress Parameter Validation: Ozone Manager Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_manager_role_env_safety_valve
Required: true

Suppress Parameter Validation: Role Specific System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: Role Specific System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_username
Required: true

Suppress Parameter Validation: Ranger Ozone Plugin Conf Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Ozone Plugin Conf Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_ozone_plugin_conf_path
Required: true

Suppress Parameter Validation: Ranger Ozone Plugin Policy Cache Directory Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Ozone Plugin Policy Cache Directory Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_ozone_plugin_policy_cache_directory
Required: true

Suppress Parameter Validation: Ranger Ozone Plugin Audit Solr Spool Directory Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Ozone Plugin Audit Solr Spool Directory Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_ozone_plugin_solr_audit_spool_directory
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: Ozone Manager TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Parameter Validation: Ozone Manager TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

Suppress Parameter Validation: Ozone Manager TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Parameter Validation: Ozone Manager TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Parameter Validation: Ozone Manager TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Manager TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Health Test: Ozone Manager Upgrade Need Finalization Canary

Description: Whether to suppress the results of the Ozone Manager Upgrade Need Finalization Canary 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_om_upgrade_need_finalization_canary
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_otelcol_health
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_manager_unexpected_exits
Required: true

Ozone Prometheus

Advanced

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml

Description: For advanced use only. A string to be inserted into ozone-conf/ozone-prometheus.yml for this role only.
Related Name
Default Value
API Name: ozone-conf/ozone-prometheus.yml_role_safety_valve
Required: false

Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/prometheus-token

Description: For advanced use only. A string to be inserted into ozone-conf/prometheus-token for this role only.
Related Name
Default Value
API Name: ozone-conf/prometheus-token_role_safety_valve
Required: false

Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: OZONE_PROMETHEUS_role_env_safety_valve
Required: false

Automatically Restart Process

Description: 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.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Role Specific System Group

Description: The group that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_groupname
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: 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.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: 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.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Role Specific System User

Description: The user that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_username
Required: true

Logs

Ozone Prometheus Log Directory

Description: The log directory for log files of the role Ozone Prometheus.
Related Name: log.dir
Default Value: /var/log/hadoop-ozone
API Name: log_dir
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

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

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Metric Filter

Description

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.

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"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: ozone_prometheus_fd_thresholds
Required: false

Ozone Prometheus Host Health Test

Description: When computing the overall Ozone Prometheus health, consider the host's health.
Related Name
Default Value: true
API Name: ozone_prometheus_host_health_enabled
Required: false

Ozone Prometheus Process Health Test

Description: Enables the health test that the Ozone Prometheus's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: ozone_prometheus_scm_health_enabled
Required: false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

CA File Path

Description: Location of the CA File for Prometheus
Related Name: ozone.prometheus.ca.file
Default Value: AUTO_TLS_CA_FILE
API Name: ozone.prometheus.ca.file
Required: false

Prometheus Data Retention time.

Description: How long to retain samples in storage. Units Supported: y, w, d, h, m, s, ms.
Related Name: ozone.prometheus.data.retention.time
Default Value: 15d
API Name: ozone.prometheus.data.retention.time
Required: false

Prometheus Data Directory

Description: Directory where the Prometheus Server stores its metadata.
Related Name: ozone.prometheus.db.dir
Default Value: /var/lib/hadoop-ozone/prometheus/data
API Name: ozone.prometheus.db.dir
Required: true

Prometheus server extra flags.

Description: Extra command line flags that can be used while starting up the server. For example, '--query.timeout=2m --query.max-samples=5000'
Related Name: ozone.prometheus.extra.flags
Default Value
API Name: ozone.prometheus.extra.flags
Required: false

Prometheus server log level.

Description: Only log messages with the given severity or above. One of: [debug, info, warn, error]
Related Name: ozone.prometheus.log.level
Default Value: info
API Name: ozone.prometheus.log.level
Required: false

Prometheus Binary Location

Description: Location of the unarchived Prometheus binary.
Related Name: prometheus.location
Default Value
API Name: prometheus.location
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Prometheus HTTP Port

Description: The base port that the prometheus web user interface listens on.
Related Name: ozone.prometheus.http-port
Default Value: 9094
API Name: ozone.prometheus.http-port
Required: true

Resource Management

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: 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.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Ozone Prometheus Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Prometheus Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-prometheus.yml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/prometheus-token

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/prometheus-token parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/prometheus-token_role_safety_valve
Required: true

Suppress Parameter Validation: CA File Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the CA File Path parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.ca.file
Required: true

Suppress Parameter Validation: Prometheus Data Retention time.

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus Data Retention time. parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.data.retention.time
Required: true

Suppress Parameter Validation: Prometheus Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus Data Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.db.dir
Required: true

Suppress Parameter Validation: Prometheus server extra flags.

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus server extra flags. parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.extra.flags
Required: true

Suppress Parameter Validation: Prometheus HTTP Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus HTTP Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.http-port
Required: true

Suppress Parameter Validation: Prometheus server log level.

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus server log level. parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.log.level
Required: true

Suppress Parameter Validation: Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_prometheus_role_env_safety_valve
Required: true

Suppress Parameter Validation: Role Specific System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: Role Specific System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_username
Required: true

Suppress Parameter Validation: Prometheus Binary Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Prometheus Binary Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_prometheus.location
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_otelcol_health
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_prometheus_unexpected_exits
Required: true

Ozone Recon

Advanced

Ozone Recon Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ozone-site.xml_role_safety_valve
Required: false

Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-client.xml_role_safety_valve
Required: false

Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-server.xml_role_safety_valve
Required: false

Ozone Recon Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: OZONE_RECON_role_env_safety_valve
Required: false

Automatically Restart Process

Description: 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.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Role Specific System Group

Description: The group that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_groupname
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: 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.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: 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.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Role Specific System User

Description: The user that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_username
Required: true

Logs

Ozone Recon Log Directory

Description: The log directory for log files of the role Ozone Recon.
Related Name: log.dir
Default Value: /var/log/hadoop-ozone
API Name: log_dir
Required: false

Ozone Recon Logging Threshold

Description: The minimum log level for Ozone Recon logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

Ozone Recon Maximum Log File Backups

Description: The maximum number of rolled log files to keep for Ozone Recon logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

Ozone Recon Max Log Size

Description: The maximum size, in megabytes, per log file for Ozone Recon logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

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

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: false
API Name: jmx_exporter_enabled
Required: true

JMX Exporter Port

Description: JMX Exporter needs a port to implement a Prometheus exporter.
Related Name
Default Value
API Name: jmx_exporter_port
Required: false

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Metric Filter

Description

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.

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"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: ozone_recon_fd_thresholds
Required: false

Ozone Recon Host Health Test

Description: When computing the overall Ozone Recon health, consider the host's health.
Related Name
Default Value: true
API Name: ozone_recon_host_health_enabled
Required: false

Ozone Recon Process Health Test

Description: Enables the health test that the Ozone Recon's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: ozone_recon_scm_health_enabled
Required: false

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

HSTS Header for Recon UI

Description: HSTS Header (Strict-Transport-Security) value to use
Related Name: ozone.http.header.Strict-Transport-Security
Default Value: max-age=63072000; includeSubDomains;
API Name: ozone.http.header.Strict-Transport-Security
Required: false

Recon Metadata Directory

Description: Determines where on the local filesystem recon security certificates will be stored.
Related Name: ozone.metadata.dirs
Default Value: /var/lib/hadoop-ozone/recon/ozone-metadata
API Name: ozone.metadata.dirs
Required: true

Recon Data Directory

Description: Directory where the Recon Server stores its metadata.
Related Name: ozone.recon.db.dir
Default Value: /var/lib/hadoop-ozone/recon/data
API Name: ozone.recon.db.dir
Required: true

Enable HeatMap Feature in Recon

Description: Enables HeatMap Feature in Recon.
Related Name: ozone.recon.heatmap.enable
Default Value: true
API Name: ozone.recon.heatmap.enable
Required: false

Recon HTTP Bind Hostname

Description: 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'.
Related Name: ozone.recon.http-bind-host
Default Value: 0.0.0.0
API Name: ozone.recon.http-bind-host
Required: false

Secure Recon HTTPS Bind Hostname

Description: 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'.
Related Name: ozone.recon.https-bind-host
Default Value: 0.0.0.0
API Name: ozone.recon.https-bind-host
Required: false

Recon OzoneManager Data Directory

Description: Directory where the Recon Server stores OzoneManager's metadata
Related Name: ozone.recon.om.db.dir
Default Value: /var/lib/hadoop-ozone/recon/om/data
API Name: ozone.recon.om.db.dir
Required: true

Recon StorageContainerManager Data Directory

Description: Directory where the Recon Server stores StorageContainerManager's metadata
Related Name: ozone.recon.scm.db.dirs
Default Value: /var/lib/hadoop-ozone/recon/scm/data
API Name: ozone.recon.scm.db.dirs
Required: true

Java Heap Size of Recon

Description: Maximum size for the Java process heap memory.
Related Name: ozone_recon_max_heap_size
Default Value: 1 GiB
API Name: ozone_recon_max_heap_size
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Recon HTTP Web UI Port

Description: 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'.
Related Name: ozone.recon.http-port
Default Value: 9888
API Name: ozone.recon.http-port
Required: true

Secure Recon Web UI Port (TLS/SSL)

Description: 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'.
Related Name: ozone.recon.https-port
Default Value: 9889
API Name: ozone.recon.https-port
Required: false

Recon RPC Port

Description: 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'.
Related Name: ozone.recon.rpc-port
Default Value: 9891
API Name: ozone.recon.rpc-port
Required: true

Resource Management

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: 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.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Role-Specific Kerberos Principal

Description: Kerberos principal used by the Ozone Recon roles.
Related Name
Default Value: recon
API Name: kerberos_role_princ_name
Required: true

Ozone Recon TLS/SSL Trust Store File

Description: 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 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.
Related Name: ssl.client.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

Ozone Recon TLS/SSL Trust Store Password

Description: The password for the Ozone Recon TLS/SSL 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.
Related Name: ssl.client.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL for Ozone Recon

Description: Encrypt communication between clients and Ozone Recon using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ozone.ssl.enabled
Default Value: false
API Name: ssl_enabled
Required: false

Ozone Recon TLS/SSL Server Keystore Key Password

Description: The password that protects the private key contained in the keystore used when Ozone Recon is acting as a TLS/SSL server.
Related Name: ssl.server.keystore.keypassword
Default Value
API Name: ssl_server_keystore_keypassword
Required: false

Ozone Recon TLS/SSL Server Keystore File Location

Description: 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 the format specified in Administration > Settings > Java Keystore Type.
Related Name: ssl.server.keystore.location
Default Value
API Name: ssl_server_keystore_location
Required: false

Ozone Recon TLS/SSL Server Keystore File Password

Description: The password for the Ozone Recon keystore file.
Related Name: ssl.server.keystore.password
Default Value
API Name: ssl_server_keystore_password
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Parameter Validation: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role-Specific Kerberos Principal parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Parameter Validation: Ozone Recon Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Ozone Recon Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Ozone Recon Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve
Required: true

Suppress Parameter Validation: HSTS Header for Recon UI

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HSTS Header for Recon UI parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.http.header.strict-transport-security
Required: true

Suppress Parameter Validation: Recon Metadata Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon Metadata Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.metadata.dirs
Required: true

Suppress Parameter Validation: Recon Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon Data Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.db.dir
Required: true

Suppress Parameter Validation: Recon HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon HTTP Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.http-bind-host
Required: true

Suppress Parameter Validation: Recon HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon HTTP Web UI Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.http-port
Required: true

Suppress Parameter Validation: Secure Recon HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Recon HTTPS Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.https-bind-host
Required: true

Suppress Parameter Validation: Secure Recon Web UI Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Recon Web UI Port (TLS/SSL) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.https-port
Required: true

Suppress Parameter Validation: Recon OzoneManager Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon OzoneManager Data Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.om.db.dir
Required: true

Suppress Parameter Validation: Recon RPC Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon RPC Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.rpc-port
Required: true

Suppress Parameter Validation: Recon StorageContainerManager Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Recon StorageContainerManager Data Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.scm.db.dirs
Required: true

Suppress Parameter Validation: Java Heap Size of Recon

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Recon parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_recon_max_heap_size
Required: true

Suppress Parameter Validation: Ozone Recon Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_recon_role_env_safety_valve
Required: true

Suppress Parameter Validation: Role Specific System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: Role Specific System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_username
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: Ozone Recon TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Parameter Validation: Ozone Recon TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

Suppress Parameter Validation: Ozone Recon TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Parameter Validation: Ozone Recon TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Parameter Validation: Ozone Recon TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Recon TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_otelcol_health
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_ozone_recon_unexpected_exits
Required: true

S3 Gateway

Advanced

S3 Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ozone-site.xml_role_safety_valve
Required: false

S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/s3g-audit-log4j2.properties

Description: For advanced use only. A string to be inserted into ozone-conf/s3g-audit-log4j2.properties for this role only.
Related Name
Default Value
API Name: ozone-conf/s3g-audit-log4j2.properties_role_safety_valve
Required: false

S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-client.xml_role_safety_valve
Required: false

S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-server.xml_role_safety_valve
Required: false

Automatically Restart Process

Description: 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.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Role Specific System Group

Description: The group that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_groupname
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: 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.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: 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.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Role Specific System User

Description: The user that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_username
Required: true

S3 Gateway Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: S3_GATEWAY_role_env_safety_valve
Required: false

Logs

S3 Gateway Log Directory

Description: The log directory for log files of the role S3 Gateway.
Related Name: log.dir
Default Value: /var/log/hadoop-ozone
API Name: log_dir
Required: false

S3 Gateway Logging Threshold

Description: The minimum log level for S3 Gateway logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

S3 Gateway Maximum Log File Backups

Description: The maximum number of rolled log files to keep for S3 Gateway logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

S3 Gateway Max Log Size

Description: The maximum size, in megabytes, per log file for S3 Gateway logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

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

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: false
API Name: jmx_exporter_enabled
Required: true

JMX Exporter Port

Description: JMX Exporter needs a port to implement a Prometheus exporter.
Related Name
Default Value
API Name: jmx_exporter_port
Required: false

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Metric Filter

Description

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.

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"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: s3_gateway_fd_thresholds
Required: false

S3 Gateway Host Health Test

Description: When computing the overall S3 Gateway health, consider the host's health.
Related Name
Default Value: true
API Name: s3_gateway_host_health_enabled
Required: false

S3 Gateway Process Health Test

Description: Enables the health test that the S3 Gateway's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: s3_gateway_scm_health_enabled
Required: false

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

HSTS Header for S3G HTTPS Endpoint

Description: HSTS Header (Strict-Transport-Security) value to use
Related Name: ozone.http.header.Strict-Transport-Security
Default Value: max-age=63072000; includeSubDomains;
API Name: ozone.http.header.Strict-Transport-Security
Required: false

Ozone S3 Gateway HTTP Bind Hostname

Description: 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'.
Related Name: ozone.s3g.http-bind-host
Default Value: 0.0.0.0
API Name: ozone.s3g.http-bind-host
Required: false

Secure Ozone S3 Gateway HTTPS Bind Hostname

Description: 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'.
Related Name: ozone.s3g.https-bind-host
Default Value: 0.0.0.0
API Name: ozone.s3g.https-bind-host
Required: false

Java Heap Size of S3 Gateway

Description: Maximum size for the Java process heap memory.
Related Name: ozone_S3_gateway_max_heap_size
Default Value: 1 GiB
API Name: ozone_S3_gateway_max_heap_size
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Ozone S3 Gateway HTTP Web UI Port

Description: 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'.
Related Name: ozone.s3g.http-port
Default Value: 9878
API Name: ozone.s3g.http-port
Required: true

Secure Ozone S3 Gateway Web UI Port (TLS/SSL)

Description: 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'.
Related Name: ozone.s3g.https-port
Default Value: 9879
API Name: ozone.s3g.https-port
Required: false

Resource Management

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: 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.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Role-Specific Kerberos Principal

Description: Kerberos principal used by the S3 Gateway roles.
Related Name
Default Value: s3g
API Name: kerberos_role_princ_name
Required: true

S3 Gateway TLS/SSL Trust Store File

Description: 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 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.
Related Name: ssl.client.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

S3 Gateway TLS/SSL Trust Store Password

Description: The password for the S3 Gateway TLS/SSL 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.
Related Name: ssl.client.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL for S3 Gateway

Description: Encrypt communication between clients and S3 Gateway using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ozone.ssl.enabled
Default Value: false
API Name: ssl_enabled
Required: false

S3 Gateway TLS/SSL Server Keystore Key Password

Description: The password that protects the private key contained in the keystore used when S3 Gateway is acting as a TLS/SSL server.
Related Name: ssl.server.keystore.keypassword
Default Value
API Name: ssl_server_keystore_keypassword
Required: false

S3 Gateway TLS/SSL Server Keystore File Location

Description: 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 the format specified in Administration > Settings > Java Keystore Type.
Related Name: ssl.server.keystore.location
Default Value
API Name: ssl_server_keystore_location
Required: false

S3 Gateway TLS/SSL Server Keystore File Password

Description: The password for the S3 Gateway keystore file.
Related Name: ssl.server.keystore.password
Default Value
API Name: ssl_server_keystore_password
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Parameter Validation: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role-Specific Kerberos Principal parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Parameter Validation: S3 Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: S3 Gateway Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve
Required: true

Suppress Parameter Validation: S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/s3g-audit-log4j2.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/s3g-audit-log4j2.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/s3g-audit-log4j2.properties_role_safety_valve
Required: true

Suppress Parameter Validation: S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve
Required: true

Suppress Parameter Validation: S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve
Required: true

Suppress Parameter Validation: HSTS Header for S3G HTTPS Endpoint

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HSTS Header for S3G HTTPS Endpoint parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.http.header.strict-transport-security
Required: true

Suppress Parameter Validation: Ozone S3 Gateway HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone S3 Gateway HTTP Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.s3g.http-bind-host
Required: true

Suppress Parameter Validation: Ozone S3 Gateway HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone S3 Gateway HTTP Web UI Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.s3g.http-port
Required: true

Suppress Parameter Validation: Secure Ozone S3 Gateway HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone S3 Gateway HTTPS Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.s3g.https-bind-host
Required: true

Suppress Parameter Validation: Secure Ozone S3 Gateway Web UI Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Ozone S3 Gateway Web UI Port (TLS/SSL) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.s3g.https-port
Required: true

Suppress Parameter Validation: Java Heap Size of S3 Gateway

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of S3 Gateway parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_s3_gateway_max_heap_size
Required: true

Suppress Parameter Validation: Role Specific System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: Role Specific System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_username
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: S3 Gateway Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_s3_gateway_role_env_safety_valve
Required: true

Suppress Parameter Validation: S3 Gateway TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Parameter Validation: S3 Gateway TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

Suppress Parameter Validation: S3 Gateway TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Parameter Validation: S3 Gateway TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Parameter Validation: S3 Gateway TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the S3 Gateway TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_otelcol_health
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_s3_gateway_unexpected_exits
Required: true

Service-Wide

Advanced

Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: 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.
Related Name
Default Value
API Name: ozone-conf/ozone-site.xml_service_safety_valve
Required: false

Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: 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.
Related Name
Default Value
API Name: ozone-conf/ssl-client.xml_service_safety_valve
Required: false

Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: 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.
Related Name
Default Value
API Name: ozone-conf/ssl-server.xml_service_safety_valve
Required: false

Ozone Service Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: OZONE_service_env_safety_valve
Required: false

System Group

Description: The group that this service's processes should run as.
Related Name
Default Value: hdfs
API Name: process_groupname
Required: true

System User

Description: The user that this service's processes should run as.
Related Name
Default Value: hdfs
API Name: process_username
Required: true

Monitoring

Enable Service Level Health Alerts

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

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

Healthy Ozone DataNode Monitoring Thresholds

Description: The health test thresholds of the overall Ozone DataNode health. The check returns "Concerning" health if the percentage of "Healthy" Ozone DataNodes falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Ozone DataNodes falls below the critical threshold.
Related Name
Default Value: Warning: 99.0 %, Critical: 90.0 %
API Name: OZONE_OZONE_DATANODE_healthy_thresholds
Required: false

Healthy Ozone Manager Monitoring Thresholds

Description: The health test thresholds of the overall Ozone Manager health. The check returns "Concerning" health if the percentage of "Healthy" Ozone Managers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Ozone Managers falls below the critical threshold.
Related Name
Default Value: Warning: 75.0 %, Critical: 50.0 %
API Name: OZONE_OZONE_MANAGER_healthy_thresholds
Required: false

Healthy Storage Container Manager Monitoring Thresholds

Description: The health test thresholds of the overall Storage Container Manager health. The check returns "Concerning" health if the percentage of "Healthy" Storage Container Managers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Storage Container Managers falls below the critical threshold.
Related Name
Default Value: Warning: 75.0 %, Critical: 50.0 %
API Name: OZONE_STORAGE_CONTAINER_MANAGER_healthy_thresholds
Required: false

Service Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

service_triggers

Required

true

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
Related Name
Default Value
API Name: smon_derived_configs_safety_valve
Required: false

Other

CM API Bucket Owner

Description: Name of the role to use to get credentials for the kerberos principal to set the owner when creating a bucket via CM APIs. If no role name is specified, the Hive kerberos principal is used by default.
Related Name: cm.api.bucket.owner
Default Value
API Name: cm.api.bucket.owner
Required: false

Ozone HttpFS Gateway Proxy User Groups

Description: Comma-delimited list of groups to allow the Ozone HttpFS Gateway to impersonate.To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: hadoop.proxyuser.httpfs.groups
Default Value: *
API Name: hadoop.proxyuser.httpfs.groups
Required: true

Ozone HttpFS Gateway Proxy User Hosts

Description: Comma-delimited list of hosts to allow the Ozone HttpFS Gateway to impersonate.To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: hadoop.proxyuser.httpfs.hosts
Default Value: *
API Name: hadoop.proxyuser.httpfs.hosts
Required: true

Hue Proxy User Groups

Description: Comma-delimited list of groups to allow the Hue user to impersonate.To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: hadoop.proxyuser.hue.groups
Default Value: *
API Name: hadoop.proxyuser.hue.groups
Required: true

Hue Proxy User Hosts

Description: Comma-delimited list of hosts to allow the Hue user to impersonate.To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: hadoop.proxyuser.hue.hosts
Default Value: *
API Name: hadoop.proxyuser.hue.hosts
Required: true

Ozone Proxy User Groups

Description: Comma-delimited list of groups to allow the Ozone user to impersonate.To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: hadoop.proxyuser.om.groups
Default Value: *
API Name: hadoop.proxyuser.om.groups
Required: true

Ozone Proxy User Hosts

Description: Comma-delimited list of hosts to allow the Ozone user to impersonate.To disable entirely, use a string that does not correspond to a group name, such as '_no_group_
Related Name: hadoop.proxyuser.om.hosts
Default Value: *
API Name: hadoop.proxyuser.om.hosts
Required: true

Choose RocksDB profile

Description: This property allows user to pick a configuration that tunes the RocksDB settings for the hardware it is running on. Right now, we have SSD and DISK as profile options.
Related Name: hdds.db.profile
Default Value: DISK
API Name: hdds.db.profile
Required: false

Enable HDDS gRPC Server TLS

Description: Enable HDDS gRPC server TLS on this cluster. Please note this won't take effect unless Kerberos Authentication (ozone.security.enabled) is enabled as well.
Related Name: hdds.grpc.tls.enabled
Default Value: false
API Name: hdds.grpc.tls.enabled
Required: false

Ozone Prometheus Endpoint Token

Description: Enables token based authentication for Prometheus servlet endpoints. This will disable SPNEGO based authentication on the endpoints.
Related Name: hdds.prometheus.endpoint.token
Default Value
API Name: hdds.prometheus.endpoint.token
Required: false

HDFS Service

Description: Name of the HDFS service that this Ozone service instance depends on
Related Name
Default Value
API Name: hdfs_service
Required: false

Ozone Administrators

Description: A comma separated list of Kerberos principals of Ozone Administrators. This will be effective only when security is enabled.
Related Name: ozone.administrators
Default Value
API Name: ozone.administrators
Required: false

Ozone Replication Factor

Description: 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.
Related Name: ozone.replication
Default Value: 3
API Name: ozone.replication
Required: true

Ozone Incremental Replication Extra Snapshots to Keep

Description: How many extra snapshots to keep that have been created by incremental Ozone replication on source and target clusters. By using the default value (0) only the snapshot from the latest incremental replication will be kept.
Related Name: ozone.replication.incremental.snapshots.keep
Default Value: 0
API Name: ozone.replication.incremental.snapshots.keep
Required: false

Ozone SCM Primordial Node ID

Description: SCM Primordial Node ID is the hostname of the SCM which should act as a Root Certificate Authority(CA) for Ozone during security initialization. It is mandatory to have a Primordial Node ID when there is more than one SCM instance configured.
Related Name: ozone.scm.primordial.node.id
Default Value
API Name: ozone.scm.primordial.node.id
Required: false

Ozone SCM Service ID

Description: A final alphanumerical name to identify this Ozone service. The value is configured during installation, and should not be modified after that, as any change in the service id may cause service disruption.
Related Name: ozone.scm.service.id
Default Value: scm1
API Name: ozone.scm.service.id
Required: true

Enable Kerberos Authentication

Description: Enables Kerberos authentication for Ozone.
Related Name: ozone.security.enabled
Default Value: false
API Name: ozone.security.enabled
Required: false

Enable Kerberos Authentication for HTTP web consoles

Description: 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.
Related Name: ozone.security.http.kerberos.enabled
Default Value: false
API Name: ozone.security.http.kerberos.enabled
Required: false

Ozone Service ID

Description: A final alphanumerical name to identify this Ozone service. The value is configured during installation, and should not be modified after that, as any change in the service id may cause service disruption.
Related Name: ozone.service.id
Default Value
API Name: ozone.service.id
Required: true

Ozone Basic Health Check Enabled

Description: Determines if the Ozone Basic health check is enabled.
Related Name: ozone_basic_health_check_enabled
Default Value: true
API Name: ozone_basic_health_check_enabled
Required: false

Ozone Basic Health Check's Keystore's Key Encryption Algorithm

Description: Ozone Basic Health Check's Keystore's Key Encryption Algorithm
Related Name: ozone_basic_health_check_keystore_key_encryption_algo
Default Value: AES
API Name: ozone_basic_health_check_keystore_key_encryption_algo
Required: false

Ozone Basic Health Check's Keystore Type

Description: Ozone Basic Health Check's Keystore Type
Related Name: ozone_basic_health_check_keystore_type
Default Value: JCEKS
API Name: ozone_basic_health_check_keystore_type
Required: false

Ozone Basic Health Check's Timeout

Description: Ozone Basic Health Check's Timeout
Related Name: ozone_basic_health_check_timeout
Default Value: 1 minute(s)
API Name: ozone_basic_health_check_timeout
Required: false

Ozone Java Options

Description: These arguments will be passed as part of the Java command line. Commonly, garbage collection flags or extra debugging flags would be passed here.
Related Name: ozone_java_opts
Default Value: java_args
API Name: ozone_java_opts
Required: false

Ranger Ozone Plugin Hdfs Audit Directory

Description: The DFS path on which Ranger audits are written.
Related Name: ranger_ozone_plugin_hdfs_audit_directory
Default Value: $ranger_base_audit_url/ozone
API Name: ranger_ozone_plugin_hdfs_audit_directory
Required: false

RANGER Service

Description: Name of the RANGER service that this Ozone service instance depends on
Related Name
Default Value
API Name: ranger_service
Required: false

Solr Service

Description: Name of the Solr service that this Ozone service instance depends on
Related Name
Default Value
API Name: solr_service
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Configuration Validator: Deploy Directory

Description: Whether to suppress configuration warnings produced by the Deploy Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Configuration Validator: Datanode Ratis IPC Port for Admin Requests

Description: Whether to suppress configuration warnings produced by the Datanode Ratis IPC Port for Admin Requests configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_dfs.container.ratis.admin.port
Required: true

Suppress Configuration Validator: Datanode Ratis Metadata Directory

Description: Whether to suppress configuration warnings produced by the Datanode Ratis Metadata Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_dfs.container.ratis.datanode.storage.dir
Required: true

Suppress Configuration Validator: Datanode Ratis IPC Port for Server-to-Server Communication

Description: Whether to suppress configuration warnings produced by the Datanode Ratis IPC Port for Server-to-Server Communication configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_dfs.container.ratis.server.port
Required: true

Suppress Configuration Validator: Balancing Interval

Description: Whether to suppress configuration warnings produced by the Balancing Interval configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.balancing.iteration.interval
Required: true

Suppress Configuration Validator: Exclude Containers from Balancing

Description: Whether to suppress configuration warnings produced by the Exclude Containers from Balancing configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.exclude.containers
Required: true

Suppress Configuration Validator: Exclude Datanodes

Description: Whether to suppress configuration warnings produced by the Exclude Datanodes configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.exclude.datanodes
Required: true

Suppress Configuration Validator: Include Datanodes

Description: Whether to suppress configuration warnings produced by the Include Datanodes configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.include.datanodes
Required: true

Suppress Configuration Validator: Container Move Replication Timeout

Description: Whether to suppress configuration warnings produced by the Container Move Replication Timeout configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.move.replication.timeout
Required: true

Suppress Configuration Validator: Container Move Timeout

Description: Whether to suppress configuration warnings produced by the Container Move Timeout configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.move.timeout
Required: true

Suppress Configuration Validator: Maximum Size Entering Target

Description: Whether to suppress configuration warnings produced by the Maximum Size Entering Target configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.size.entering.target.max
Required: true

Suppress Configuration Validator: Maximum Size Leaving Source

Description: Whether to suppress configuration warnings produced by the Maximum Size Leaving Source configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.size.leaving.source.max
Required: true

Suppress Configuration Validator: Maximum Size to Move in Balancing

Description: Whether to suppress configuration warnings produced by the Maximum Size to Move in Balancing configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.size.moved.max.per.iteration
Required: true

Suppress Configuration Validator: Datanode Data Directory

Description: Whether to suppress configuration warnings produced by the Datanode Data Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.datanode.dir
Required: true

Suppress Configuration Validator: Over Replication Processing Interval

Description: Whether to suppress configuration warnings produced by the Over Replication Processing Interval configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.scm.replication.over.replicated.interval
Required: true

Suppress Configuration Validator: Replication Thread Interval

Description: Whether to suppress configuration warnings produced by the Replication Thread Interval configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.scm.replication.thread.interval
Required: true

Suppress Configuration Validator: Under Replication Processing Interval

Description: Whether to suppress configuration warnings produced by the Under Replication Processing Interval configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.scm.replication.under.replicated.interval
Required: true

Suppress Configuration Validator: Datanode Container Protocol ACL

Description: Whether to suppress configuration warnings produced by the Datanode Container Protocol ACL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.security.client.datanode.container.protocol.acl
Required: true

Suppress Configuration Validator: SCM Client Certificate Protocol ACL

Description: Whether to suppress configuration warnings produced by the SCM Client Certificate Protocol ACL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.security.client.scm.certificate.protocol.acl
Required: true

Suppress Configuration Validator: Hive Proxy User Groups for Ozone HttpFS

Description: Whether to suppress configuration warnings produced by the Hive Proxy User Groups for Ozone HttpFS configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs.proxyuser.hive.groups
Required: true

Suppress Configuration Validator: Hive Proxy User Hosts for Ozone HttpFS

Description: Whether to suppress configuration warnings produced by the Hive Proxy User Hosts for Ozone HttpFS configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs.proxyuser.hive.hosts
Required: true

Suppress Configuration Validator: Hue Proxy User Groups for Ozone HttpFS

Description: Whether to suppress configuration warnings produced by the Hue Proxy User Groups for Ozone HttpFS configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs.proxyuser.hue.groups
Required: true

Suppress Configuration Validator: Hue Proxy User Hosts for Ozone HttpFS

Description: Whether to suppress configuration warnings produced by the Hue Proxy User Hosts for Ozone HttpFS configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs.proxyuser.hue.hosts
Required: true

Suppress Configuration Validator: HttpFS Gateway Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the HttpFS Gateway Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_httpfs_gateway_role_env_safety_valve
Required: true

Suppress Configuration Validator: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the JMX Exporter Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Configuration Validator: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the JMX Exporter configuration YAML configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Configuration Validator: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the Role-Specific Kerberos Principal configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Configuration Validator: Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Configuration Validator: Storage Container Manager Log Directory

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Configuration Validator: Topology Script File Name

Description: Whether to suppress configuration warnings produced by the Topology Script File Name configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_net.topology.script.file.name
Required: true

Suppress Configuration Validator: OM ID

Description: Whether to suppress configuration warnings produced by the OM ID configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_om.id
Required: true

Suppress Configuration Validator: Java Heap Size of Ozone Manager

Description: Whether to suppress configuration warnings produced by the Java Heap Size of Ozone Manager configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_om_max_heap_size
Required: true

Suppress Configuration Validator: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Exporters Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Extensions Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Processors Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Receivers Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Service Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Configuration Validator: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties

Description: Whether to suppress configuration warnings produced by the Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-audit-log4j2.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/dn-audit-log4j2.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-container-log4j2.properties

Description: Whether to suppress configuration warnings produced by the Ozone DataNode Advanced Configuration Snippet (Safety Valve) for ozone-conf/dn-container-log4j2.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/dn-container-log4j2.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-metrics2.properties

Description: Whether to suppress configuration warnings produced by the Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-metrics2.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/hadoop-metrics2.properties_client_config_safety_valve
Required: true

Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-policy.xml

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-policy.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/hadoop-policy.xml_role_safety_valve
Required: true

Suppress Configuration Validator: HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/httpfs-site.xml

Description: Whether to suppress configuration warnings produced by the HttpFS Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/httpfs-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/httpfs-site.xml_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties

Description: Whether to suppress configuration warnings produced by the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/om-audit-log4j2.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/om-audit-log4j2.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml

Description: Whether to suppress configuration warnings produced by the Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-prometheus.yml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-prometheus.yml_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: Whether to suppress configuration warnings produced by the Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_client_config_safety_valve
Required: true

Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/prometheus-token

Description: Whether to suppress configuration warnings produced by the Ozone Prometheus Advanced Configuration Snippet (Safety Valve) for ozone-conf/prometheus-token configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/prometheus-token_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml

Description: Whether to suppress configuration warnings produced by the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-audit.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ranger-ozone-audit.xml_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-policymgr-ssl.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ranger-ozone-policymgr-ssl.xml_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml

Description: Whether to suppress configuration warnings produced by the Ozone Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ranger-ozone-security.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ranger-ozone-security.xml_role_safety_valve
Required: true

Suppress Configuration Validator: S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/s3g-audit-log4j2.properties

Description: Whether to suppress configuration warnings produced by the S3 Gateway Advanced Configuration Snippet (Safety Valve) for ozone-conf/s3g-audit-log4j2.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/s3g-audit-log4j2.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/scm-audit-log4j2.properties

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/scm-audit-log4j2.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: Whether to suppress configuration warnings produced by the Ozone Client Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_client_config_safety_valve
Required: true

Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve
Required: true

Suppress Configuration Validator: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve
Required: true

Suppress Configuration Validator: Ozone Datanode HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the Ozone Datanode HTTP Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.datanode.http-bind-host
Required: true

Suppress Configuration Validator: Ozone Datanode HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the Ozone Datanode HTTP Web UI Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.datanode.http-port
Required: true

Suppress Configuration Validator: Secure Ozone Datanode HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the Secure Ozone Datanode HTTPS Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.datanode.https-bind-host
Required: true

Suppress Configuration Validator: Ozone Datanode Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the Ozone Datanode Port (TLS/SSL) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.datanode.https-port
Required: true

Suppress Configuration Validator: HSTS Header for Ozone SCM UI

Description: Whether to suppress configuration warnings produced by the HSTS Header for Ozone SCM UI configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.http.header.strict-transport-security
Required: true

Suppress Configuration Validator: Ozone HttpFS Gateway HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the Ozone HttpFS Gateway HTTP Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.httpfs.http-bind-host
Required: true

Suppress Configuration Validator: Ozone HttpFS Gateway HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the Ozone HttpFS Gateway HTTP Web UI Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.httpfs.http-port
Required: true

Suppress Configuration Validator: Storage Container Manager Metadata Directory

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Metadata Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.metadata.dirs
Required: true

Suppress Configuration Validator: Ozone Manager Data Directory

Description: Whether to suppress configuration warnings produced by the Ozone Manager Data Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.db.dirs
Required: true

Suppress Configuration Validator: Ozone Manager HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the Ozone Manager HTTP Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.http-bind-host
Required: true

Suppress Configuration Validator: Ozone Manager HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the Ozone Manager HTTP Web UI Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.http-port
Required: true

Suppress Configuration Validator: Secure Ozone Manager HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the Secure Ozone Manager HTTPS Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.https-bind-host
Required: true

Suppress Configuration Validator: Secure Ozone Manager Web UI Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the Secure Ozone Manager Web UI Port (TLS/SSL) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.https-port
Required: true

Suppress Configuration Validator: New Ozone Manager Nodes

Description: Whether to suppress configuration warnings produced by the New Ozone Manager Nodes configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.new.added.nodes
Required: true

Suppress Configuration Validator: Ozone Manager Ratis port

Description: Whether to suppress configuration warnings produced by the Ozone Manager Ratis port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.ratis-port
Required: true

Suppress Configuration Validator: Ozone Manager Ratis Storage Directory

Description: Whether to suppress configuration warnings produced by the Ozone Manager Ratis Storage Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.ratis.storage.dir
Required: true

Suppress Configuration Validator: Ozone Manager RPC port

Description: Whether to suppress configuration warnings produced by the Ozone Manager RPC port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.om.rpc-port
Required: true

Suppress Configuration Validator: CA File Path

Description: Whether to suppress configuration warnings produced by the CA File Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.ca.file
Required: true

Suppress Configuration Validator: Prometheus Data Retention time.

Description: Whether to suppress configuration warnings produced by the Prometheus Data Retention time. configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.data.retention.time
Required: true

Suppress Configuration Validator: Prometheus Data Directory

Description: Whether to suppress configuration warnings produced by the Prometheus Data Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.db.dir
Required: true

Suppress Configuration Validator: Prometheus server extra flags.

Description: Whether to suppress configuration warnings produced by the Prometheus server extra flags. configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.extra.flags
Required: true

Suppress Configuration Validator: Prometheus HTTP Port

Description: Whether to suppress configuration warnings produced by the Prometheus HTTP Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.http-port
Required: true

Suppress Configuration Validator: Prometheus server log level.

Description: Whether to suppress configuration warnings produced by the Prometheus server log level. configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.prometheus.log.level
Required: true

Suppress Configuration Validator: Recon Data Directory

Description: Whether to suppress configuration warnings produced by the Recon Data Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.db.dir
Required: true

Suppress Configuration Validator: Recon HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the Recon HTTP Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.http-bind-host
Required: true

Suppress Configuration Validator: Recon HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the Recon HTTP Web UI Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.http-port
Required: true

Suppress Configuration Validator: Secure Recon HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the Secure Recon HTTPS Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.https-bind-host
Required: true

Suppress Configuration Validator: Secure Recon Web UI Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the Secure Recon Web UI Port (TLS/SSL) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.https-port
Required: true

Suppress Configuration Validator: Recon OzoneManager Data Directory

Description: Whether to suppress configuration warnings produced by the Recon OzoneManager Data Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.om.db.dir
Required: true

Suppress Configuration Validator: Recon RPC Port

Description: Whether to suppress configuration warnings produced by the Recon RPC Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.rpc-port
Required: true

Suppress Configuration Validator: Recon StorageContainerManager Data Directory

Description: Whether to suppress configuration warnings produced by the Recon StorageContainerManager Data Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.recon.scm.db.dirs
Required: true

Suppress Configuration Validator: Ozone S3 Gateway HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the Ozone S3 Gateway HTTP Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.s3g.http-bind-host
Required: true

Suppress Configuration Validator: Ozone S3 Gateway HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the Ozone S3 Gateway HTTP Web UI Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.s3g.http-port
Required: true

Suppress Configuration Validator: Secure Ozone S3 Gateway HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the Secure Ozone S3 Gateway HTTPS Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.s3g.https-bind-host
Required: true

Suppress Configuration Validator: Secure Ozone S3 Gateway Web UI Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the Secure Ozone S3 Gateway Web UI Port (TLS/SSL) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.s3g.https-port
Required: true

Suppress Configuration Validator: Storage Container Manager Block Client port

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Block Client port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.block.client.port
Required: true

Suppress Configuration Validator: Storage Container Manager Client port

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Client port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.client.port
Required: true

Suppress Configuration Validator: Datanode ID Directory

Description: Whether to suppress configuration warnings produced by the Datanode ID Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.datanode.id.dir
Required: true

Suppress Configuration Validator: Storage Container Manager Datanode port

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Datanode port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.datanode.port
Required: true

Suppress Configuration Validator: Storage Container Manager Data Directory

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Data Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.db.dirs
Required: true

Suppress Configuration Validator: Storage Container Manager GRPC port

Description: Whether to suppress configuration warnings produced by the Storage Container Manager GRPC port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.grpc.port
Required: true

Suppress Configuration Validator: Storage Container Manager Ratis Storage Directory

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Ratis Storage Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.ha.ratis.storage.dir
Required: true

Suppress Configuration Validator: Storage Container Manager HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the Storage Container Manager HTTP Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.http-bind-host
Required: true

Suppress Configuration Validator: Storage Container Manager HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the Storage Container Manager HTTP Web UI Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.http-port
Required: true

Suppress Configuration Validator: Secure Storage Container Manager HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the Secure Storage Container Manager HTTPS Bind Hostname configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.https-bind-host
Required: true

Suppress Configuration Validator: Secure Storage Container Manager Web UI Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the Secure Storage Container Manager Web UI Port (TLS/SSL) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.https-port
Required: true

Suppress Configuration Validator: Storage Container Manager Ratis port

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Ratis port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.ratis.port
Required: true

Suppress Configuration Validator: Storage Container Manager Security Service port

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Security Service port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.security.service.port
Required: true

Suppress Configuration Validator: Ozone Server Replication Factor

Description: Whether to suppress configuration warnings produced by the Ozone Server Replication Factor configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.server.default.replication
Required: true

Suppress Configuration Validator: Ozone Server Replication Type

Description: Whether to suppress configuration warnings produced by the Ozone Server Replication Type configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.server.default.replication.type
Required: true

Suppress Configuration Validator: Java Heap Size of DataNode

Description: Whether to suppress configuration warnings produced by the Java Heap Size of DataNode configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_datanode_heap_size
Required: true

Suppress Configuration Validator: Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Ozone DataNode Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_datanode_role_env_safety_valve
Required: true

Suppress Configuration Validator: Java Heap Size of HttpFS Gateway

Description: Whether to suppress configuration warnings produced by the Java Heap Size of HttpFS Gateway configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_httpfs_gateway_max_heap_size
Required: true

Suppress Configuration Validator: Ozone Manager Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Ozone Manager Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_manager_role_env_safety_valve
Required: true

Suppress Configuration Validator: Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Ozone Prometheus Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_prometheus_role_env_safety_valve
Required: true

Suppress Configuration Validator: Java Heap Size of Recon

Description: Whether to suppress configuration warnings produced by the Java Heap Size of Recon configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_recon_max_heap_size
Required: true

Suppress Configuration Validator: Ozone Recon Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Ozone Recon Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_recon_role_env_safety_valve
Required: true

Suppress Configuration Validator: Java Heap Size of S3 Gateway

Description: Whether to suppress configuration warnings produced by the Java Heap Size of S3 Gateway configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ozone_s3_gateway_max_heap_size
Required: true

Suppress Configuration Validator: Role Specific System Group

Description: Whether to suppress configuration warnings produced by the Role Specific System Group configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_process_groupname
Required: true

Suppress Configuration Validator: Role Specific System User

Description: Whether to suppress configuration warnings produced by the Role Specific System User configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_process_username
Required: true

Suppress Configuration Validator: Prometheus Binary Location

Description: Whether to suppress configuration warnings produced by the Prometheus Binary Location configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_prometheus.location
Required: true

Suppress Configuration Validator: Ranger Ozone Plugin Conf Path

Description: Whether to suppress configuration warnings produced by the Ranger Ozone Plugin Conf Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_ozone_plugin_conf_path
Required: true

Suppress Configuration Validator: Ranger Ozone Plugin Policy Cache Directory Path

Description: Whether to suppress configuration warnings produced by the Ranger Ozone Plugin Policy Cache Directory Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_ozone_plugin_policy_cache_directory
Required: true

Suppress Configuration Validator: Ranger Ozone Plugin Audit Solr Spool Directory Path

Description: Whether to suppress configuration warnings produced by the Ranger Ozone Plugin Audit Solr Spool Directory Path configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ranger_ozone_plugin_solr_audit_spool_directory
Required: true

Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Configuration Validator: Role Triggers

Description: Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Configuration Validator: S3 Gateway Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the S3 Gateway Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_s3_gateway_role_env_safety_valve
Required: true

Suppress Configuration Validator: Java Heap Size of Storage Container Manager

Description: Whether to suppress configuration warnings produced by the Java Heap Size of Storage Container Manager configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_scm_max_heap_size
Required: true

Suppress Configuration Validator: Storage Container Manager TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Trust Store File configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Configuration Validator: Storage Container Manager TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Trust Store Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

Suppress Configuration Validator: Storage Container Manager TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Server Keystore Key Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Configuration Validator: Storage Container Manager TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Server Keystore File Location configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Configuration Validator: Storage Container Manager TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the Storage Container Manager TLS/SSL Server Keystore File Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Configuration Validator: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Configuration Validator: Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_storage_container_manager_role_env_safety_valve
Required: true

Suppress Parameter Validation: CM API Bucket Owner

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the CM API Bucket Owner parameter.
Related Name
Default Value: false
API Name: service_config_suppression_cm.api.bucket.owner
Required: true

Suppress Configuration Validator: Gateway Count Validator

Description: Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_gateway_count_validator
Required: true

Suppress Parameter Validation: Ozone HttpFS Gateway Proxy User Groups

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone HttpFS Gateway Proxy User Groups parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop.proxyuser.httpfs.groups
Required: true

Suppress Parameter Validation: Ozone HttpFS Gateway Proxy User Hosts

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone HttpFS Gateway Proxy User Hosts parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop.proxyuser.httpfs.hosts
Required: true

Suppress Parameter Validation: Hue Proxy User Groups

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Proxy User Groups parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop.proxyuser.hue.groups
Required: true

Suppress Parameter Validation: Hue Proxy User Hosts

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Proxy User Hosts parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop.proxyuser.hue.hosts
Required: true

Suppress Parameter Validation: Ozone Proxy User Groups

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Proxy User Groups parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop.proxyuser.om.groups
Required: true

Suppress Parameter Validation: Ozone Proxy User Hosts

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Proxy User Hosts parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hadoop.proxyuser.om.hosts
Required: true

Suppress Parameter Validation: Ozone Prometheus Endpoint Token

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Prometheus Endpoint Token parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hdds.prometheus.endpoint.token
Required: true

Suppress Configuration Validator: HttpFS Gateway Count Validator

Description: Whether to suppress configuration warnings produced by the HttpFS Gateway Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_httpfs_gateway_count_validator
Required: true

Suppress Parameter Validation: Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: 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.
Related Name
Default Value: false
API Name: service_config_suppression_ozone-conf/ozone-site.xml_service_safety_valve
Required: true

Suppress Parameter Validation: Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: 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.
Related Name
Default Value: false
API Name: service_config_suppression_ozone-conf/ssl-client.xml_service_safety_valve
Required: true

Suppress Parameter Validation: Ozone Service Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: 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.
Related Name
Default Value: false
API Name: service_config_suppression_ozone-conf/ssl-server.xml_service_safety_valve
Required: true

Suppress Parameter Validation: Ozone Administrators

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Administrators parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ozone.administrators
Required: true

Suppress Parameter Validation: Ozone SCM Primordial Node ID

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone SCM Primordial Node ID parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ozone.scm.primordial.node.id
Required: true

Suppress Parameter Validation: Ozone SCM Service ID

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone SCM Service ID parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ozone.scm.service.id
Required: true

Suppress Parameter Validation: Ozone Service ID

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Service ID parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ozone.service.id
Required: true

Suppress Parameter Validation: Ozone Basic Health Check's Keystore's Key Encryption Algorithm

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Basic Health Check's Keystore's Key Encryption Algorithm parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ozone_basic_health_check_keystore_key_encryption_algo
Required: true

Suppress Parameter Validation: Ozone Basic Health Check's Keystore Type

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Basic Health Check's Keystore Type parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ozone_basic_health_check_keystore_type
Required: true

Suppress Configuration Validator: Ozone DataNode Count Validator

Description: Whether to suppress configuration warnings produced by the Ozone DataNode Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_ozone_datanode_count_validator
Required: true

Suppress Parameter Validation: Ozone Java Options

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Java Options parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ozone_java_opts
Required: true

Suppress Configuration Validator: Ozone Manager Count Validator

Description: Whether to suppress configuration warnings produced by the Ozone Manager Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_ozone_manager_count_validator
Required: true

Suppress Configuration Validator: Ozone Prometheus Count Validator

Description: Whether to suppress configuration warnings produced by the Ozone Prometheus Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_ozone_prometheus_count_validator
Required: true

Suppress Configuration Validator: Ozone Recon Count Validator

Description: Whether to suppress configuration warnings produced by the Ozone Recon Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_ozone_recon_count_validator
Required: true

Suppress Parameter Validation: Ozone Service Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ozone Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ozone_service_env_safety_valve
Required: true

Suppress Parameter Validation: System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
Related Name
Default Value: false
API Name: service_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
Related Name
Default Value: false
API Name: service_config_suppression_process_username
Required: true

Suppress Parameter Validation: Ranger Ozone Plugin Hdfs Audit Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Ozone Plugin Hdfs Audit Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_ozone_plugin_hdfs_audit_directory
Required: true

Suppress Configuration Validator: S3 Gateway Count Validator

Description: Whether to suppress configuration warnings produced by the S3 Gateway Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_s3_gateway_count_validator
Required: true

Suppress Parameter Validation: Service Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.
Related Name
Default Value: false
API Name: service_config_suppression_service_triggers
Required: true

Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_smon_derived_configs_safety_valve
Required: true

Suppress Configuration Validator: Storage Container Manager Count Validator

Description: Whether to suppress configuration warnings produced by the Storage Container Manager Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_storage_container_manager_count_validator
Required: true

Suppress Health Test: Ozone Basic Canary

Description: Whether to suppress the results of the Ozone Basic Canary 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.
Related Name
Default Value: false
API Name: service_health_suppression_ozone_basic_health_check
Required: true

Suppress Health Test: Ozone DataNode Health

Description: Whether to suppress the results of the Ozone DataNode 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.
Related Name
Default Value: false
API Name: service_health_suppression_ozone_ozone_datanode_healthy
Required: true

Suppress Health Test: Ozone Manager Health

Description: Whether to suppress the results of the Ozone Manager 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.
Related Name
Default Value: false
API Name: service_health_suppression_ozone_ozone_manager_healthy
Required: true

Suppress Health Test: Storage Container Manager Health

Description: Whether to suppress the results of the Storage Container Manager 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.
Related Name
Default Value: false
API Name: service_health_suppression_ozone_storage_container_manager_healthy
Required: true

Storage Container Manager

Advanced

Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Heap Dump Directory

Description: 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, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. 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.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-policy.xml

Description: For advanced use only. A string to be inserted into ozone-conf/hadoop-policy.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/hadoop-policy.xml_role_safety_valve
Required: false

Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ozone-site.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ozone-site.xml_role_safety_valve
Required: false

Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/scm-audit-log4j2.properties

Description: For advanced use only. A string to be inserted into ozone-conf/scm-audit-log4j2.properties for this role only.
Related Name
Default Value
API Name: ozone-conf/scm-audit-log4j2.properties_role_safety_valve
Required: false

Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-client.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-client.xml_role_safety_valve
Required: false

Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: For advanced use only. A string to be inserted into ozone-conf/ssl-server.xml for this role only.
Related Name
Default Value
API Name: ozone-conf/ssl-server.xml_role_safety_valve
Required: false

Automatically Restart Process

Description: 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.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Role Specific System Group

Description: The group that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_groupname
Required: true

Enable Metric Collection

Description: 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.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: 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.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: 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.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Role Specific System User

Description: The user that this role's processes should run as.
Related Name
Default Value: hdfs
API Name: process_username
Required: true

Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve)

Description: 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.
Related Name
Default Value
API Name: STORAGE_CONTAINER_MANAGER_role_env_safety_valve
Required: false

Logs

Storage Container Manager Log Directory

Description: The log directory for log files of the role Storage Container Manager.
Related Name: log.dir
Default Value: /var/log/hadoop-ozone
API Name: log_dir
Required: false

Storage Container Manager Logging Threshold

Description: The minimum log level for Storage Container Manager logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

Storage Container Manager Maximum Log File Backups

Description: The maximum number of rolled log files to keep for Storage Container Manager logs. Typically used by log4j or logback.
Related Name
Default Value: 10
API Name: max_log_backup_index
Required: false

Storage Container Manager Max Log Size

Description: The maximum size, in megabytes, per log file for Storage Container Manager logs. Typically used by log4j or logback.
Related Name
Default Value: 200 MiB
API Name: max_log_size
Required: false

Monitoring

Enable Health Alerts for this Role

Description: 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
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

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

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: false
API Name: jmx_exporter_enabled
Required: true

JMX Exporter Port

Description: JMX Exporter needs a port to implement a Prometheus exporter.
Related Name
Default Value
API Name: jmx_exporter_port
Required: false

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

Metric Filter

Description

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.

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"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: storage_container_manager_fd_thresholds
Required: false

Storage Container Manager Host Health Test

Description: When computing the overall Storage Container Manager health, consider the host's health.
Related Name
Default Value: true
API Name: storage_container_manager_host_health_enabled
Required: false

Storage Container Manager Process Health Test

Description: Enables the health test that the Storage Container Manager's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: storage_container_manager_scm_health_enabled
Required: false

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Graceful Shutdown Timeout

Description: The timeout in milliseconds to wait for graceful shutdown to complete.
Related Name
Default Value: 2 minute(s)
API Name: graceful_stop_timeout
Required: false

Balancing Interval

Description: The interval period between each iteration of Container Balancer. The current default is 70m. This means that Container Balancer will balance every 70 minutes. Units supported: d, h, m, s, ms.
Related Name: hdds.container.balancer.balancing.iteration.interval
Default Value
API Name: hdds.container.balancer.balancing.iteration.interval
Required: false

Maximum Percentage of Datanodes Involved in Balancing

Description: Maximum percentage of healthy, in-service datanodes that can be involved in balancing in one iteration (for example, '20' for 20%).
Related Name: hdds.container.balancer.datanodes.involved.max.percentage.per.iteration
Default Value: 20
API Name: hdds.container.balancer.datanodes.involved.max.percentage.per.iteration
Required: false

Exclude Containers from Balancing

Description: Containers to exclude from balancing. Specified as a string of Container IDs (for example, '1, 2, 3').
Related Name: hdds.container.balancer.exclude.containers
Default Value
API Name: hdds.container.balancer.exclude.containers
Required: false

Exclude Datanodes

Description: A comma separated string of Datanode hostnames or IP addresses that will be excluded from balancing.
Related Name: hdds.container.balancer.exclude.datanodes
Default Value
API Name: hdds.container.balancer.exclude.datanodes
Required: false

Include Datanodes

Description: A comma separated string of Datanode hostnames or IP addresses that will be the only participants in balancing.
Related Name: hdds.container.balancer.include.datanodes
Default Value
API Name: hdds.container.balancer.include.datanodes
Required: false

Number of Balancing Iterations

Description: Number of iterations that Container Balancer will run for.
Related Name: hdds.container.balancer.iterations
Default Value: 10
API Name: hdds.container.balancer.iterations
Required: false

Container Move Replication Timeout

Description: The amount of time to allow a single container's replication from source to target as part of container move. The current default is 50m. This means that if "hdds.container.balancer.move.timeout" is 65m, then out of those 65 minutes 50 minutes will be the deadline for replication to complete. The value of this configuration should always be less than "hdds.container.balancer.move.timeout". Units supported: d, h, m, s, ms.
Related Name: hdds.container.balancer.move.replication.timeout
Default Value
API Name: hdds.container.balancer.move.replication.timeout
Required: false

Container Move Timeout

Description: The amount of time to allow a single container to move from source to target. The current default is 65m. This means that a container is allowed a total of 65 minutes to complete its move from a source Datanode to a target Datanode, as part of container balancing. Units supported: d, h, m, s, ms.
Related Name: hdds.container.balancer.move.timeout
Default Value
API Name: hdds.container.balancer.move.timeout
Required: false

Maximum Size Entering Target

Description: The maximum size that can enter a target datanode in each iteration while balancing. This is the sum of data from multiple sources. Units supported: eb, pb, tb, gb, mb, kb, b.
Related Name: hdds.container.balancer.size.entering.target.max
Default Value: 26gb
API Name: hdds.container.balancer.size.entering.target.max
Required: false

Maximum Size Leaving Source

Description: The maximum size that can leave a source datanode in each iteration while balancing. This is the sum of data moving to multiple targets. Units supported: eb, pb, tb, gb, mb, kb, b.
Related Name: hdds.container.balancer.size.leaving.source.max
Default Value: 26gb
API Name: hdds.container.balancer.size.leaving.source.max
Required: false

Maximum Size to Move in Balancing

Description: The maximum size of data that will be moved by Container Balancer in one iteration. Units supported: eb, pb, tb, gb, mb, kb, b.
Related Name: hdds.container.balancer.size.moved.max.per.iteration
Default Value: 500gb
API Name: hdds.container.balancer.size.moved.max.per.iteration
Required: false

Balancing Threshold

Description: The percentage deviation from average utilization, after which a node will be rebalanced (for example, '10' for 10%).
Related Name: hdds.container.balancer.utilization.threshold
Default Value: 10.0
API Name: hdds.container.balancer.utilization.threshold
Required: false

Datanode Delete Container Limit

Description: A limit to restrict the total number of delete container commands queued on a datanode.
Related Name: hdds.scm.replication.datanode.delete.container.limit
Default Value
API Name: hdds.scm.replication.datanode.delete.container.limit
Required: false

Datanode Reconstruction Weight

Description: When counting the number of replication commands on a datanode, the number of reconstruction commands is multiplied by this weight to ensure reconstruction commands use more of the "hdds.scm.replication.datanode.replication.limit" capacity, as they are more expensive to process. The current default is 3.
Related Name: hdds.scm.replication.datanode.reconstruction.weight
Default Value
API Name: hdds.scm.replication.datanode.reconstruction.weight
Required: false

Datanode Replication Limit

Description: A limit to restrict the total number of replication and reconstruction commands queued on a datanode. The current default is 20.
Related Name: hdds.scm.replication.datanode.replication.limit
Default Value
API Name: hdds.scm.replication.datanode.replication.limit
Required: false

Inflight Limit Factor

Description: The overall replication task limit on a cluster is the number of healthy nodes, times the "hdds.scm.replication.datanode.replication.limit". This factor, which should be from zero through 1, scales that limit down to reduce the overall number of replicas pending creation on the cluster. A setting of zero disables global limit checking. A setting of 1 effectively disables it, by making the limit equal to the above equation. The current default is 0.75.
Related Name: hdds.scm.replication.inflight.limit.factor
Default Value
API Name: hdds.scm.replication.inflight.limit.factor
Required: false

Remaining Redundancy For Maintenance

Description: The number of redundant container replicas which must be available for a node to enter maintenance. If putting a node into maintenance reduces the redundancy below this value, the node will remain in the ENTERING_MAINTENANCE state until a new replica is created. For an EC container, redundancy is 1 if there are a total of data + 1 replicas, meaning 1 more replica can be lost before this container becomes unrecoverable. Example configurations: Consider an EC(3-2) container. If the value of this configuration is 1, then 1 Datanode hosting its replica can be put into maintenance and 4 other replicas should be available. If the value is 0, then 2 Datanodes hosting its replicas can be put into maintenance and 3 other replicas should be available. Set this to a high value to be safer but require more time for nodes to enter maintenance. The current default is 1.
Related Name: hdds.scm.replication.maintenance.remaining.redundancy
Default Value
API Name: hdds.scm.replication.maintenance.remaining.redundancy
Required: false

Over Replication Processing Interval

Description: How frequently to check if there is work to process on the over replicated queue. The current default is 30s. This means that every 30 seconds, this thread will process over replicated containers identified by Replication Manager. Units supported: d, h, m, s, ms.
Related Name: hdds.scm.replication.over.replicated.interval
Default Value
API Name: hdds.scm.replication.over.replicated.interval
Required: false

Replication Thread Interval

Description: There is a replication monitor thread running inside SCM which takes care of replicating the containers in the cluster. This property is used to configure the interval in which that thread runs. The current default is 300s. This means that the replication thread will run every 300 seconds. Units supported: d, h, m, s, ms.
Related Name: hdds.scm.replication.thread.interval
Default Value
API Name: hdds.scm.replication.thread.interval
Required: false

Under Replication Processing Interval

Description: How frequently to check if there is work to process on the under replicated queue. The current default is 30s. This means that every 30 seconds, this thread will process under replicated containers identified by Replication Manager. Units supported: d, h, m, s, ms.
Related Name: hdds.scm.replication.under.replicated.interval
Default Value
API Name: hdds.scm.replication.under.replicated.interval
Required: false

Datanode Container Protocol ACL

Description: ACLs that define which users can access the Datanode Container Protocol in SCM. It is a comma separated list of Kerberos Principals.
Related Name: hdds.security.client.datanode.container.protocol.acl
Default Value: OZONE_SERVICE_PRINCIPALS
API Name: hdds.security.client.datanode.container.protocol.acl
Required: false

SCM Client Certificate Protocol ACL

Description: ACLs that define which users can access the SCM Certificate Protocol. It is a comma separated list of Kerberos Principals.
Related Name: hdds.security.client.scm.certificate.protocol.acl
Default Value: OZONE_ADMINS, OZONE_SERVICE_PRINCIPALS
API Name: hdds.security.client.scm.certificate.protocol.acl
Required: false

Topology Script File Name

Description: Full path to a custom topology script on the host file system. The topology script is used to determine the rack location of nodes. If left with "{{DEFAULT_TOPOLOGY_SCRIPT}}", a topology script will be provided that uses your hosts' rack information, visible in the "Hosts" page.
Related Name: net.topology.script.file.name
Default Value: DEFAULT_TOPOLOGY_SCRIPT
API Name: net.topology.script.file.name
Required: false

HSTS Header for Ozone SCM UI

Description: HSTS Header (Strict-Transport-Security) value to use
Related Name: ozone.http.header.Strict-Transport-Security
Default Value: max-age=63072000; includeSubDomains;
API Name: ozone.http.header.Strict-Transport-Security
Required: false

Storage Container Manager Metadata Directory

Description: Determines where on the local filesystem SCM security certificates will be stored.
Related Name: ozone.metadata.dirs
Default Value: /var/lib/hadoop-ozone/scm/ozone-metadata
API Name: ozone.metadata.dirs
Required: true

Storage Container Manager Data Directory

Description: Directory where the StorageContainerManager stores its metadata
Related Name: ozone.scm.db.dirs
Default Value: /var/lib/hadoop-ozone/scm/data
API Name: ozone.scm.db.dirs
Required: true

Storage Container Manager Ratis Storage Directory

Description: Storage directory used by SCM to write Ratis logs.
Related Name: ozone.scm.ha.ratis.storage.dir
Default Value: /var/lib/hadoop-ozone/scm/ratis
API Name: ozone.scm.ha.ratis.storage.dir
Required: true

Storage Container Manager HTTP Bind Hostname

Description: 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'.
Related Name: ozone.scm.http-bind-host
Default Value: 0.0.0.0
API Name: ozone.scm.http-bind-host
Required: false

Secure Storage Container Manager HTTPS Bind Hostname

Description: 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'.
Related Name: ozone.scm.https-bind-host
Default Value: 0.0.0.0
API Name: ozone.scm.https-bind-host
Required: false

Pipeline Per Volume Factor

Description: Non negative number that scales the number of Erasure Coding pipelines per Erasure Coding scheme. The maximum number of pipelines will be limited to the number of healthy volumes in the cluster divided by the number of nodes required for the EC scheme, multiplied by this factor. The current default is 1.
Related Name: ozone.scm.pipeline.per.volume.factor
Default Value
API Name: ozone.scm.pipeline.per.volume.factor
Required: false

Ozone Storage Container Manager Safemode Canary Enabled

Description: Determines if the Ozone Storage Container Manager Safemode checker canary is enabled.
Related Name: ozone_scm_safemode_canary_enabled
Default Value: true
API Name: ozone_scm_safemode_canary_enabled
Required: false

Ozone Storage Container Manager Safemode Canary Timeout

Description: Ozone Storage Container Manager Safemode Canary's timeout
Related Name: ozone_scm_safemode_canary_timeout
Default Value: 30 second(s)
API Name: ozone_scm_safemode_canary_timeout
Required: false

Ozone Storage Container Manager Upgrade Need Finalization Canary Enabled

Description: Determines if the Ozone Storage Container Manager Upgrade Need Finalization Canary is enabled.
Related Name: ozone_scm_upgrade_need_finalization_canary_enabled
Default Value: true
API Name: ozone_scm_upgrade_need_finalization_canary_enabled
Required: false

Ozone Storage Container Manager Upgrade Need Finalization Canary Timeout

Description: Sets Ozone Storage Container Manager Upgrade Need Finalization Canary's timeout.
Related Name: ozone_scm_upgrade_need_finalization_canary_timeout
Default Value: 30 second(s)
API Name: ozone_scm_upgrade_need_finalization_canary_timeout
Required: false

Java Heap Size of Storage Container Manager

Description: Maximum size for the Java process heap memory.
Related Name: scm_max_heap_size
Default Value: 4 GiB
API Name: scm_max_heap_size
Required: false

Performance

Maximum Process File Descriptors

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

Ports and Addresses

Storage Container Manager Block Client port

Description: The port number of the Ozone SCM block client service.
Related Name: ozone.scm.block.client.port
Default Value: 9863
API Name: ozone.scm.block.client.port
Required: false

Storage Container Manager Client port

Description: The port number of the Ozone SCM block client service.
Related Name: ozone.scm.client.port
Default Value: 9860
API Name: ozone.scm.client.port
Required: false

Storage Container Manager Datanode port

Description: The port number of the Ozone SCM service.
Related Name: ozone.scm.datanode.port
Default Value: 9861
API Name: ozone.scm.datanode.port
Required: false

Storage Container Manager GRPC port

Description: Port used by SCM for Grpc Server.
Related Name: ozone.scm.grpc.port
Default Value: 9895
API Name: ozone.scm.grpc.port
Required: false

Storage Container Manager HTTP Web UI Port

Description: 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'.
Related Name: ozone.scm.http-port
Default Value: 9876
API Name: ozone.scm.http-port
Required: true

Secure Storage Container Manager Web UI Port (TLS/SSL)

Description: 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'.
Related Name: ozone.scm.https-port
Default Value: 9877
API Name: ozone.scm.https-port
Required: false

Storage Container Manager Ratis port

Description: The base port that SCM's Ratis Server listens on if multiple SCM's are configured.
Related Name: ozone.scm.ratis.port
Default Value: 9894
API Name: ozone.scm.ratis.port
Required: false

Storage Container Manager Security Service port

Description: SCM security server port.
Related Name: ozone.scm.security.service.port
Default Value: 9961
API Name: ozone.scm.security.service.port
Required: false

Resource Management

Cgroup CPU Shares

Description: 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.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: 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.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: 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.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: 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'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: 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'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

Security

Role-Specific Kerberos Principal

Description: Kerberos principal used by the Storage Container Manager roles.
Related Name
Default Value: scm
API Name: kerberos_role_princ_name
Required: true

Storage Container Manager TLS/SSL Trust Store File

Description: 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 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.
Related Name: ssl.client.truststore.location
Default Value
API Name: ssl_client_truststore_location
Required: false

Storage Container Manager TLS/SSL Trust Store Password

Description: The password for the Storage Container Manager TLS/SSL 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.
Related Name: ssl.client.truststore.password
Default Value
API Name: ssl_client_truststore_password
Required: false

Enable TLS/SSL for Storage Container Manager

Description: Encrypt communication between clients and Storage Container Manager using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ozone.ssl.enabled
Default Value: false
API Name: ssl_enabled
Required: false

Storage Container Manager TLS/SSL Server Keystore Key Password

Description: The password that protects the private key contained in the keystore used when Storage Container Manager is acting as a TLS/SSL server.
Related Name: ssl.server.keystore.keypassword
Default Value
API Name: ssl_server_keystore_keypassword
Required: false

Storage Container Manager TLS/SSL Server Keystore File Location

Description: 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 the format specified in Administration > Settings > Java Keystore Type.
Related Name: ssl.server.keystore.location
Default Value
API Name: ssl_server_keystore_location
Required: false

Storage Container Manager TLS/SSL Server Keystore File Password

Description: The password for the Storage Container Manager keystore file.
Related Name: ssl.server.keystore.password
Default Value
API Name: ssl_server_keystore_password
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: 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.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Balancing Interval

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Balancing Interval parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.balancing.iteration.interval
Required: true

Suppress Parameter Validation: Exclude Containers from Balancing

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Exclude Containers from Balancing parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.exclude.containers
Required: true

Suppress Parameter Validation: Exclude Datanodes

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Exclude Datanodes parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.exclude.datanodes
Required: true

Suppress Parameter Validation: Include Datanodes

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Include Datanodes parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.include.datanodes
Required: true

Suppress Parameter Validation: Container Move Replication Timeout

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Container Move Replication Timeout parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.move.replication.timeout
Required: true

Suppress Parameter Validation: Container Move Timeout

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Container Move Timeout parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.move.timeout
Required: true

Suppress Parameter Validation: Maximum Size Entering Target

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Maximum Size Entering Target parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.size.entering.target.max
Required: true

Suppress Parameter Validation: Maximum Size Leaving Source

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Maximum Size Leaving Source parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.size.leaving.source.max
Required: true

Suppress Parameter Validation: Maximum Size to Move in Balancing

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Maximum Size to Move in Balancing parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.container.balancer.size.moved.max.per.iteration
Required: true

Suppress Parameter Validation: Over Replication Processing Interval

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Over Replication Processing Interval parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.scm.replication.over.replicated.interval
Required: true

Suppress Parameter Validation: Replication Thread Interval

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Replication Thread Interval parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.scm.replication.thread.interval
Required: true

Suppress Parameter Validation: Under Replication Processing Interval

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Under Replication Processing Interval parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.scm.replication.under.replicated.interval
Required: true

Suppress Parameter Validation: Datanode Container Protocol ACL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Datanode Container Protocol ACL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.security.client.datanode.container.protocol.acl
Required: true

Suppress Parameter Validation: SCM Client Certificate Protocol ACL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the SCM Client Certificate Protocol ACL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_hdds.security.client.scm.certificate.protocol.acl
Required: true

Suppress Parameter Validation: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

Suppress Parameter Validation: Role-Specific Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role-Specific Kerberos Principal parameter.
Related Name
Default Value: false
API Name: role_config_suppression_kerberos_role_princ_name
Required: true

Suppress Parameter Validation: Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Parameter Validation: Storage Container Manager Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: Topology Script File Name

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Topology Script File Name parameter.
Related Name
Default Value: false
API Name: role_config_suppression_net.topology.script.file.name
Required: true

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/hadoop-policy.xml

Description: 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/hadoop-policy.xml parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/hadoop-policy.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ozone-site.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ozone-site.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/scm-audit-log4j2.properties

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/scm-audit-log4j2.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-client.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-client.xml_role_safety_valve
Required: true

Suppress Parameter Validation: Storage Container Manager Advanced Configuration Snippet (Safety Valve) for ozone-conf/ssl-server.xml

Description: 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.
Related Name
Default Value: false
API Name: role_config_suppression_ozone-conf/ssl-server.xml_role_safety_valve
Required: true

Suppress Parameter Validation: HSTS Header for Ozone SCM UI

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HSTS Header for Ozone SCM UI parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.http.header.strict-transport-security
Required: true

Suppress Parameter Validation: Storage Container Manager Metadata Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Metadata Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.metadata.dirs
Required: true

Suppress Parameter Validation: Storage Container Manager Block Client port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Block Client port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.block.client.port
Required: true

Suppress Parameter Validation: Storage Container Manager Client port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Client port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.client.port
Required: true

Suppress Parameter Validation: Storage Container Manager Datanode port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Datanode port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.datanode.port
Required: true

Suppress Parameter Validation: Storage Container Manager Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Data Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.db.dirs
Required: true

Suppress Parameter Validation: Storage Container Manager GRPC port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager GRPC port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.grpc.port
Required: true

Suppress Parameter Validation: Storage Container Manager Ratis Storage Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Ratis Storage Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.ha.ratis.storage.dir
Required: true

Suppress Parameter Validation: Storage Container Manager HTTP Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager HTTP Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.http-bind-host
Required: true

Suppress Parameter Validation: Storage Container Manager HTTP Web UI Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager HTTP Web UI Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.http-port
Required: true

Suppress Parameter Validation: Secure Storage Container Manager HTTPS Bind Hostname

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Storage Container Manager HTTPS Bind Hostname parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.https-bind-host
Required: true

Suppress Parameter Validation: Secure Storage Container Manager Web UI Port (TLS/SSL)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Secure Storage Container Manager Web UI Port (TLS/SSL) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.https-port
Required: true

Suppress Parameter Validation: Storage Container Manager Ratis port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Ratis port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.ratis.port
Required: true

Suppress Parameter Validation: Storage Container Manager Security Service port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Security Service port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ozone.scm.security.service.port
Required: true

Suppress Parameter Validation: Role Specific System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System Group parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: Role Specific System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Specific System User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_process_username
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: Java Heap Size of Storage Container Manager

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Storage Container Manager parameter.
Related Name
Default Value: false
API Name: role_config_suppression_scm_max_heap_size
Required: true

Suppress Parameter Validation: Storage Container Manager TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_location
Required: true

Suppress Parameter Validation: Storage Container Manager TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_client_truststore_password
Required: true

Suppress Parameter Validation: Storage Container Manager TLS/SSL Server Keystore Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Server Keystore Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_keypassword
Required: true

Suppress Parameter Validation: Storage Container Manager TLS/SSL Server Keystore File Location

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Server Keystore File Location parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_location
Required: true

Suppress Parameter Validation: Storage Container Manager TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_keystore_password
Required: true

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Parameter Validation: Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Storage Container Manager Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_storage_container_manager_role_env_safety_valve
Required: true

Suppress Health Test: Ozone SCM Safemode Canary

Description: Whether to suppress the results of the Ozone SCM Safemode Canary 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_scm_safemode_canary
Required: true

Suppress Health Test: Ozone SCM Upgrade Need Finalization Canary

Description: Whether to suppress the results of the Ozone SCM Upgrade Need Finalization Canary 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_scm_upgrade_need_finalization_canary
Required: true

Suppress Health Test: Audit Pipeline Test

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_otelcol_health
Required: true

Suppress Health Test: Process Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_ozone_storage_container_manager_unexpected_exits
Required: true