Key Trustee Server Properties in Cloudera Runtime 7.2.18

Role groups:

Active Database

Advanced

Active Database 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
DB_ACTIVE_role_env_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

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

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

Monitoring

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
db_active_fd_thresholds
Required
false

Active Database Host Health Test

Description
When computing the overall Active Database health, consider the host's health.
Related Name
Default Value
true
API Name
db_active_host_health_enabled
Required
false

Active Database Process Health Test

Description
Enables the health test that the Active Database's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
db_active_scm_health_enabled
Required
false

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

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

Database Storage Directory

Description
Directory (local file system) where the Key Trustee Server database will be stored. Changing this value after the service has been started will have no effect.
Related Name
db_root
Default Value
/var/lib/keytrustee/db
API Name
db_root
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

Key Trustee Server Database Port

Description
The Key Trustee Server database server port. Changing this value after the service has been started will have no effect.
Related Name
db_port
Default Value
11381
API Name
db_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: Active Database Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Key Trustee Server Database Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Database Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_db_port
Required
true

Suppress Parameter Validation: Database Storage Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Database Storage Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_db_root
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: 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_keytrustee_server_db_active_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_keytrustee_server_db_active_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_keytrustee_server_db_active_host_health
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_keytrustee_server_db_active_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_keytrustee_server_db_active_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_keytrustee_server_db_active_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_keytrustee_server_db_active_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_keytrustee_server_db_active_unexpected_exits
Required
true

Active Key Trustee Server

Advanced

Active Key Trustee Server 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
KEYTRUSTEE_ACTIVE_SERVER_role_env_safety_valve
Required
false

Active Key Trustee Server XML Override

Description
For advanced use only, replace entire XML in the logback configuration file for Active Key Trustee Server, ignoring all logging configuration.
Related Name
logback_safety_valve
Default Value
API Name
logback_safety_valve
Required
false

Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for logging.conf

Description
For advanced use only. A string to be inserted into logging.conf for this role only.
Related Name
Default Value
API Name
logging.conf_role_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

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

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

Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description
For advanced use only. A string to be inserted into ssl.properties for this role only.
Related Name
Default Value
API Name
ssl.properties_role_safety_valve
Required
false

Logs

Active Key Trustee Server Log Directory

Description
The log directory for log files of the role Active Key Trustee Server.
Related Name
log_dir
Default Value
/var/lib/keytrustee/logs
API Name
log_dir
Required
false

Active Key Trustee Server Logging Threshold

Description
The minimum log level for Active Key Trustee Server logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false

Active Key Trustee Server Maximum Log File Backups

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

Active Key Trustee Server Max Log Size

Description
The maximum size, in megabytes, per log file for Active Key Trustee Server 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
keytrustee_active_server_fd_thresholds
Required
false

Active Key Trustee Server Host Health Test

Description
When computing the overall Active Key Trustee Server health, consider the host's health.
Related Name
Default Value
true
API Name
keytrustee_active_server_host_health_enabled
Required
false

Active Key Trustee Server Process Health Test

Description
Enables the health test that the Active Key Trustee Server's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
keytrustee_active_server_scm_health_enabled
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

KeyTrustee Server Active Database Port

Description
Port used by Active Database role in KeyTrustee Server.
Related Name
db_port
Default Value
11381
API Name
db_port
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

Key Trustee Server Port

Description
The Key Trustee Server port number.
Related Name
keytrustee_port
Default Value
11371
API Name
keytrustee_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

Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format)

Description
The path to the TLS/SSL file containing the certificate of the certificate authority (CA) and any intermediate certificates used to sign the server certificate. Used when Active Key Trustee Server is acting as a TLS/SSL server. The certificate file must be in PEM format, and is usually created by concatenating all of the appropriate root and intermediate certificates.
Related Name
ssl.cacert.location
Default Value
API Name
ssl_server_ca_certificate_location
Required
false

Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format)

Description
The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Active Key Trustee Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name
ssl.cert.location
Default Value
/var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee.pem
API Name
ssl_server_certificate_location
Required
false

Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format)

Description
The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Active Key Trustee Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name
ssl.privatekey.location
Default Value
/var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee-pk.pem
API Name
ssl_server_privatekey_location
Required
false

Active Key Trustee Server TLS/SSL Private Key Password

Description
The password for the private key in the Active Key Trustee Server TLS/SSL Server Certificate and Private Key file. If left blank, the private key is not protected by a password.
Related Name
ssl.privatekey.password
Default Value
API Name
ssl_server_privatekey_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: Active Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_keytrustee_active_server_role_env_safety_valve
Required
true

Suppress Parameter Validation: Key Trustee Server Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_keytrustee_port
Required
true

Suppress Parameter Validation: Active Key Trustee Server Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_dir
Required
true

Suppress Parameter Validation: Active Key Trustee Server XML Override

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server XML Override parameter.
Related Name
Default Value
false
API Name
role_config_suppression_logback_safety_valve
Required
true

Suppress Parameter Validation: Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for logging.conf

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for logging.conf parameter.
Related Name
Default Value
false
API Name
role_config_suppression_logging.conf_role_safety_valve
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: 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: Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl.properties_role_safety_valve
Required
true

Suppress Parameter Validation: Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_ca_certificate_location
Required
true

Suppress Parameter Validation: Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_certificate_location
Required
true

Suppress Parameter Validation: Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_location
Required
true

Suppress Parameter Validation: Active Key Trustee Server TLS/SSL Private Key Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server TLS/SSL Private Key Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_password
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_keytrustee_server_keytrustee_active_server_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_keytrustee_server_keytrustee_active_server_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_keytrustee_server_keytrustee_active_server_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_keytrustee_server_keytrustee_active_server_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_keytrustee_server_keytrustee_active_server_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_keytrustee_server_keytrustee_active_server_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_keytrustee_server_keytrustee_active_server_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_keytrustee_server_keytrustee_active_server_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_keytrustee_server_keytrustee_active_server_unexpected_exits
Required
true

Passive Database

Advanced

Passive Database 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
DB_PASSIVE_role_env_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

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

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

Monitoring

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
db_passive_fd_thresholds
Required
false

Passive Database Host Health Test

Description
When computing the overall Passive Database health, consider the host's health.
Related Name
Default Value
true
API Name
db_passive_host_health_enabled
Required
false

Passive Database Process Health Test

Description
Enables the health test that the Passive Database's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
db_passive_scm_health_enabled
Required
false

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

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

Database Storage Directory

Description
Directory (local file system) where the Key Trustee Server database will be stored. Changing this value after the service has been started will have no effect.
Related Name
db_root
Default Value
/var/lib/keytrustee/db
API Name
db_root
Required
false

Retry Attempts

Description
Number of times a connection attempt will be made before giving up.
Related Name
retry_attempts
Default Value
30
API Name
retry_attempts
Required
true

Retry Timeout

Description
Number of secconds to wait between retries.
Related Name
retry_timeout
Default Value
1 second(s)
API Name
retry_timeout
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

Key Trustee Server Database Port

Description
The Key Trustee Server database server port. Changing this value after the service has been started will have no effect.
Related Name
db_port
Default Value
11381
API Name
db_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: Passive Database Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Key Trustee Server Database Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Database Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_db_port
Required
true

Suppress Parameter Validation: Database Storage Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Database Storage Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_db_root
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: Retry Timeout

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Retry Timeout parameter.
Related Name
Default Value
false
API Name
role_config_suppression_retry_timeout
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_keytrustee_server_db_passive_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_keytrustee_server_db_passive_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_keytrustee_server_db_passive_host_health
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_keytrustee_server_db_passive_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_keytrustee_server_db_passive_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_keytrustee_server_db_passive_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_keytrustee_server_db_passive_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_keytrustee_server_db_passive_unexpected_exits
Required
true

Passive Key Trustee Server

Advanced

Passive Key Trustee Server 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
KEYTRUSTEE_PASSIVE_SERVER_role_env_safety_valve
Required
false

Passive Key Trustee Server XML Override

Description
For advanced use only, replace entire XML in the logback configuration file for Passive Key Trustee Server, ignoring all logging configuration.
Related Name
logback_safety_valve
Default Value
API Name
logback_safety_valve
Required
false

Passive Key Trustee Server Advanced Configuration Snippet (Safety Valve) for logging.conf

Description
For advanced use only. A string to be inserted into logging.conf for this role only.
Related Name
Default Value
API Name
logging.conf_role_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

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

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

Passive Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description
For advanced use only. A string to be inserted into ssl.properties for this role only.
Related Name
Default Value
API Name
ssl.properties_role_safety_valve
Required
false

Logs

Passive Key Trustee Server Log Directory

Description
The log directory for log files of the role Passive Key Trustee Server.
Related Name
log_dir
Default Value
/var/lib/keytrustee/logs
API Name
log_dir
Required
false

Passive Key Trustee Server Logging Threshold

Description
The minimum log level for Passive Key Trustee Server logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false

Passive Key Trustee Server Maximum Log File Backups

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

Passive Key Trustee Server Max Log Size

Description
The maximum size, in megabytes, per log file for Passive Key Trustee Server 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
keytrustee_passive_server_fd_thresholds
Required
false

Passive Key Trustee Server Host Health Test

Description
When computing the overall Passive Key Trustee Server health, consider the host's health.
Related Name
Default Value
true
API Name
keytrustee_passive_server_host_health_enabled
Required
false

Passive Key Trustee Server Process Health Test

Description
Enables the health test that the Passive Key Trustee Server's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
keytrustee_passive_server_scm_health_enabled
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

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

Key Trustee Server Port

Description
The Key Trustee Server port number.
Related Name
keytrustee_port
Default Value
11371
API Name
keytrustee_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

Passive Key Trustee Server TLS/SSL Server CA Certificate (PEM Format)

Description
The path to the TLS/SSL file containing the certificate of the certificate authority (CA) and any intermediate certificates used to sign the server certificate. Used when Passive Key Trustee Server is acting as a TLS/SSL server. The certificate file must be in PEM format, and is usually created by concatenating all of the appropriate root and intermediate certificates.
Related Name
ssl.cacert.location
Default Value
API Name
ssl_server_ca_certificate_location
Required
false

Passive Key Trustee Server TLS/SSL Server Certificate File (PEM Format)

Description
The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Passive Key Trustee Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name
ssl.cert.location
Default Value
/var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee.pem
API Name
ssl_server_certificate_location
Required
false

Passive Key Trustee Server TLS/SSL Server Private Key File (PEM Format)

Description
The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Passive Key Trustee Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name
ssl.privatekey.location
Default Value
/var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee-pk.pem
API Name
ssl_server_privatekey_location
Required
false

Passive Key Trustee Server TLS/SSL Private Key Password

Description
The password for the private key in the Passive Key Trustee Server TLS/SSL Server Certificate and Private Key file. If left blank, the private key is not protected by a password.
Related Name
ssl.privatekey.password
Default Value
API Name
ssl_server_privatekey_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: Passive Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_keytrustee_passive_server_role_env_safety_valve
Required
true

Suppress Parameter Validation: Key Trustee Server Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_keytrustee_port
Required
true

Suppress Parameter Validation: Passive Key Trustee Server Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server Log Directory parameter.
Related Name
Default Value
false
API Name
role_config_suppression_log_dir
Required
true

Suppress Parameter Validation: Passive Key Trustee Server XML Override

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server XML Override parameter.
Related Name
Default Value
false
API Name
role_config_suppression_logback_safety_valve
Required
true

Suppress Parameter Validation: Passive Key Trustee Server Advanced Configuration Snippet (Safety Valve) for logging.conf

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server Advanced Configuration Snippet (Safety Valve) for logging.conf parameter.
Related Name
Default Value
false
API Name
role_config_suppression_logging.conf_role_safety_valve
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: 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: Passive Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl.properties_role_safety_valve
Required
true

Suppress Parameter Validation: Passive Key Trustee Server TLS/SSL Server CA Certificate (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_ca_certificate_location
Required
true

Suppress Parameter Validation: Passive Key Trustee Server TLS/SSL Server Certificate File (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server TLS/SSL Server Certificate File (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_certificate_location
Required
true

Suppress Parameter Validation: Passive Key Trustee Server TLS/SSL Server Private Key File (PEM Format)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server TLS/SSL Server Private Key File (PEM Format) parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_location
Required
true

Suppress Parameter Validation: Passive Key Trustee Server TLS/SSL Private Key Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server TLS/SSL Private Key Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_password
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_keytrustee_server_keytrustee_passive_server_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_keytrustee_server_keytrustee_passive_server_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_keytrustee_server_keytrustee_passive_server_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_keytrustee_server_keytrustee_passive_server_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_keytrustee_server_keytrustee_passive_server_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_keytrustee_server_keytrustee_passive_server_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_keytrustee_server_keytrustee_passive_server_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_keytrustee_server_keytrustee_passive_server_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_keytrustee_server_keytrustee_passive_server_unexpected_exits
Required
true

Service-Wide

Advanced

Key Trustee Server 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
KEYTRUSTEE_SERVER_service_env_safety_valve
Required
false

Key Trustee Server Service Advanced Configuration Snippet (Safety Valve) for logging.conf

Description
For advanced use only, a string to be inserted into logging.conf. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name
logging.conf_service_safety_valve
Required
false

System Group

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

System User

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

Key Trustee Server Service Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description
For advanced use only, a string to be inserted into ssl.properties. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name
ssl.properties_service_safety_valve
Required
false

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

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

Supported Cipher Configuration for SSL

Description
A list of allowed and disallowed ciphers, colon-separated (':'). Using a exclamation mark ('!') in front of the cipher name will disallow the respective cipher. For cipher options check OpenSSL cipher list. If blank then default ciphers are set.
Related Name
ciphers
Default Value
API Name
ciphers
Required
false

Key Trustee Home

Description
Home directory of Key Trustee.
Related Name
keytrustee.home
Default Value
/var/lib/keytrustee/.keytrustee
API Name
keytrustee.home
Required
false

Minimum TLS Support

Description
Minimum TLS protocol supported.
Related Name
tls.min.protocols
Default Value
TLSv1
API Name
tls.min.protocols
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: Active Database Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the Active Database Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_db_active_role_env_safety_valve
Required
true

Suppress Configuration Validator: Passive Database Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the Passive Database Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_db_passive_role_env_safety_valve
Required
true

Suppress Configuration Validator: Database Storage Directory

Description
Whether to suppress configuration warnings produced by the Database Storage Directory configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_db_root
Required
true

Suppress Configuration Validator: Active Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_keytrustee_active_server_role_env_safety_valve
Required
true

Suppress Configuration Validator: Passive Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the Passive Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_keytrustee_passive_server_role_env_safety_valve
Required
true

Suppress Configuration Validator: Key Trustee Server Port

Description
Whether to suppress configuration warnings produced by the Key Trustee Server Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_keytrustee_port
Required
true

Suppress Configuration Validator: Active Key Trustee Server Log Directory

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server Log Directory configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_log_dir
Required
true

Suppress Configuration Validator: Active Key Trustee Server XML Override

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server XML Override configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_logback_safety_valve
Required
true

Suppress Configuration Validator: Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for logging.conf

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for logging.conf configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_logging.conf_role_safety_valve
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: Retry Timeout

Description
Whether to suppress configuration warnings produced by the Retry Timeout configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_retry_timeout
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: Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl.properties_role_safety_valve
Required
true

Suppress Configuration Validator: Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format)

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_ca_certificate_location
Required
true

Suppress Configuration Validator: Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format)

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_certificate_location
Required
true

Suppress Configuration Validator: Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format)

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format) configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_location
Required
true

Suppress Configuration Validator: Active Key Trustee Server TLS/SSL Private Key Password

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server TLS/SSL Private Key Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_privatekey_password
Required
true

Suppress Parameter Validation: Supported Cipher Configuration for SSL

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Supported Cipher Configuration for SSL parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ciphers
Required
true

Suppress Configuration Validator: Active Database Count Validator

Description
Whether to suppress configuration warnings produced by the Active Database Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_db_active_count_validator
Required
true

Suppress Configuration Validator: Passive Database Count Validator

Description
Whether to suppress configuration warnings produced by the Passive Database Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_db_passive_count_validator
Required
true

Suppress Parameter Validation: Key Trustee Home

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Home parameter.
Related Name
Default Value
false
API Name
service_config_suppression_keytrustee.home
Required
true

Suppress Configuration Validator: Active Key Trustee Server Count Validator

Description
Whether to suppress configuration warnings produced by the Active Key Trustee Server Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_keytrustee_active_server_count_validator
Required
true

Suppress Configuration Validator: Passive Key Trustee Server Count Validator

Description
Whether to suppress configuration warnings produced by the Passive Key Trustee Server Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_keytrustee_passive_server_count_validator
Required
true

Suppress Parameter Validation: Key Trustee Server Service Environment Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
service_config_suppression_keytrustee_server_service_env_safety_valve
Required
true

Suppress Parameter Validation: Key Trustee Server Service Advanced Configuration Snippet (Safety Valve) for logging.conf

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Service Advanced Configuration Snippet (Safety Valve) for logging.conf parameter.
Related Name
Default Value
false
API Name
service_config_suppression_logging.conf_service_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: 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 Parameter Validation: Key Trustee Server Service Advanced Configuration Snippet (Safety Valve) for ssl.properties

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Service Advanced Configuration Snippet (Safety Valve) for ssl.properties parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ssl.properties_service_safety_valve
Required
true