Key Trustee Server Properties in Cloudera Runtime 7.0.0
Role groups:
Active Database
Categories:
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Active Database Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. |
DB_ACTIVE_role_env_safety_valve
|
false | ||
Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. | false |
process_auto_restart
|
true | |
Enable Metric Collection | Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. | true |
process_should_monitor
|
true | |
Process Start Retry Attempts | Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. | 3 |
process_start_retries
|
false | |
Process Start Wait Timeout | The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. | 20 |
process_start_secs
|
false |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
File Descriptor Monitoring Thresholds | The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. | Warning: 50.0 %, Critical: 70.0 % |
db_active_fd_thresholds
|
false | |
Active Database Host Health Test | When computing the overall Active Database health, consider the host's health. | true |
db_active_host_health_enabled
|
false | |
Active Database Process Health Test | Enables the health test that the Active Database's process state is consistent with the role configuration | true |
db_active_scm_health_enabled
|
false | |
Enable Health Alerts for this Role | When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
Metric Filter | Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
jvm_heap_used_mb metric:
{
"includeHealthTestMetricSet": true,
"filterType": "whitelist",
"metrics": ["jvm_heap_used_mb"]
} |
monitoring_metric_filter
|
false | ||
Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. | Warning: 200 B, Critical: Never |
process_swap_memory_thresholds
|
false | |
Role Triggers | The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
"streamThreshold": 0, "enabled": "true"}] See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
role_triggers
|
true | |
Unexpected Exits Thresholds | The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. | Warning: Never, Critical: Any |
unexpected_exits_thresholds
|
false | |
Unexpected Exits Monitoring Period | The period to review when computing unexpected exits. | 5 minute(s) |
unexpected_exits_window
|
false |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Database Storage Directory | 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. |
db_root
|
/var/lib/keytrustee/db |
db_root
|
false |
Performance
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Maximum Process File Descriptors | If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. |
rlimit_fds
|
false |
Ports and Addresses
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Key Trustee Server Database Port | The Key Trustee Server database server port. Changing this value after the service has been started will have no effect. |
db_port
|
11381 |
db_port
|
true |
Resource Management
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Cgroup CPU Shares | Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. |
cpu.shares
|
1024 |
rm_cpu_shares
|
true |
Custom Control Group Resources (overrides Cgroup settings) | Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** |
custom.cgroups
|
rm_custom_resources
|
false | |
Cgroup I/O Weight | Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. |
blkio.weight
|
500 |
rm_io_weight
|
true |
Cgroup Memory Hard Limit | Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.limit_in_bytes
|
-1 MiB |
rm_memory_hard_limit
|
true |
Cgroup Memory Soft Limit | Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.soft_limit_in_bytes
|
-1 MiB |
rm_memory_soft_limit
|
true |
Suppressions
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Suppress Configuration Validator: CDH Version Validator | Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. | false |
role_config_suppression_cdh_version_validator
|
true | |
Suppress Parameter Validation: Active Database Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Database Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_db_active_role_env_safety_valve
|
true | |
Suppress Parameter Validation: Key Trustee Server Database Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Database Port parameter. | false |
role_config_suppression_db_port
|
true | |
Suppress Parameter Validation: Database Storage Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Database Storage Directory parameter. | false |
role_config_suppression_db_root
|
true | |
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. | false |
role_config_suppression_rm_custom_resources
|
true | |
Suppress Parameter Validation: Role Triggers | Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. | false |
role_config_suppression_role_triggers
|
true | |
Suppress Health Test: Audit Pipeline Test | Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_active_audit_health
|
true | |
Suppress Health Test: File Descriptors | Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_active_file_descriptor
|
true | |
Suppress Health Test: Host Health | Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_active_host_health
|
true | |
Suppress Health Test: Process Status | Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_active_scm_health
|
true | |
Suppress Health Test: Swap Memory Usage | Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_active_swap_memory_usage
|
true | |
Suppress Health Test: Unexpected Exits | Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_active_unexpected_exits
|
true |
Active Key Trustee Server
Categories:
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Active Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. |
KEYTRUSTEE_ACTIVE_SERVER_role_env_safety_valve
|
false | ||
Active Key Trustee Server XML Override | For advanced use only, replace entire XML in the logback configuration file for Active Key Trustee Server, ignoring all logging configuration. |
logback_safety_valve
|
logback_safety_valve
|
false | |
Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. | false |
process_auto_restart
|
true | |
Enable Metric Collection | Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. | true |
process_should_monitor
|
true | |
Process Start Retry Attempts | Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. | 3 |
process_start_retries
|
false | |
Process Start Wait Timeout | The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. | 20 |
process_start_secs
|
false | |
Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties | For advanced use only. A string to be inserted into ssl.properties for this role only. |
ssl.properties_role_safety_valve
|
false |
Logs
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Active Key Trustee Server Logging Threshold | The minimum log level for Active Key Trustee Server logs | INFO |
log_threshold
|
false | |
Active Key Trustee Server Maximum Log File Backups | The maximum number of rolled log files to keep for Active Key Trustee Server logs. Typically used by log4j or logback. | 10 |
max_log_backup_index
|
false | |
Active Key Trustee Server Max Log Size | The maximum size, in megabytes, per log file for Active Key Trustee Server logs. Typically used by log4j or logback. | 200 MiB |
max_log_size
|
false |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Enable Health Alerts for this Role | When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
File Descriptor Monitoring Thresholds | The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. | Warning: 50.0 %, Critical: 70.0 % |
keytrustee_active_server_fd_thresholds
|
false | |
Active Key Trustee Server Host Health Test | When computing the overall Active Key Trustee Server health, consider the host's health. | true |
keytrustee_active_server_host_health_enabled
|
false | |
Active Key Trustee Server Process Health Test | Enables the health test that the Active Key Trustee Server's process state is consistent with the role configuration | true |
keytrustee_active_server_scm_health_enabled
|
false | |
Log Directory Free Space Monitoring Absolute Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. | Warning: 10 GiB, Critical: 5 GiB |
log_directory_free_space_absolute_thresholds
|
false | |
Log Directory Free Space Monitoring Percentage Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. | Warning: Never, Critical: Never |
log_directory_free_space_percentage_thresholds
|
false | |
Metric Filter | Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
jvm_heap_used_mb metric:
{
"includeHealthTestMetricSet": true,
"filterType": "whitelist",
"metrics": ["jvm_heap_used_mb"]
} |
monitoring_metric_filter
|
false | ||
Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. | Warning: 200 B, Critical: Never |
process_swap_memory_thresholds
|
false | |
Role Triggers | The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
"streamThreshold": 0, "enabled": "true"}] See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
role_triggers
|
true | |
Unexpected Exits Thresholds | The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. | Warning: Never, Critical: Any |
unexpected_exits_thresholds
|
false | |
Unexpected Exits Monitoring Period | The period to review when computing unexpected exits. | 5 minute(s) |
unexpected_exits_window
|
false |
Performance
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Maximum Process File Descriptors | If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. |
rlimit_fds
|
false |
Ports and Addresses
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Key Trustee Server Port | The Key Trustee Server port number. |
keytrustee_port
|
11371 |
keytrustee_port
|
true |
Resource Management
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Cgroup CPU Shares | Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. |
cpu.shares
|
1024 |
rm_cpu_shares
|
true |
Custom Control Group Resources (overrides Cgroup settings) | Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** |
custom.cgroups
|
rm_custom_resources
|
false | |
Cgroup I/O Weight | Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. |
blkio.weight
|
500 |
rm_io_weight
|
true |
Cgroup Memory Hard Limit | Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.limit_in_bytes
|
-1 MiB |
rm_memory_hard_limit
|
true |
Cgroup Memory Soft Limit | Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.soft_limit_in_bytes
|
-1 MiB |
rm_memory_soft_limit
|
true |
Security
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) | 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. |
ssl.cacert.location
|
ssl_server_ca_certificate_location
|
false | |
Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format) | 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. |
ssl.cert.location
|
/var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee.pem |
ssl_server_certificate_location
|
false |
Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format) | 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. |
ssl.privatekey.location
|
/var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee-pk.pem |
ssl_server_privatekey_location
|
false |
Active Key Trustee Server TLS/SSL Private Key Password | 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. |
ssl.privatekey.password
|
ssl_server_privatekey_password
|
false |
Suppressions
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Suppress Configuration Validator: CDH Version Validator | Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. | false |
role_config_suppression_cdh_version_validator
|
true | |
Suppress Parameter Validation: Active Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) | 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. | false |
role_config_suppression_keytrustee_active_server_role_env_safety_valve
|
true | |
Suppress Parameter Validation: Key Trustee Server Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Port parameter. | false |
role_config_suppression_keytrustee_port
|
true | |
Suppress Parameter Validation: Active Key Trustee Server XML Override | Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server XML Override parameter. | false |
role_config_suppression_logback_safety_valve
|
true | |
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. | false |
role_config_suppression_rm_custom_resources
|
true | |
Suppress Parameter Validation: Role Triggers | Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. | false |
role_config_suppression_role_triggers
|
true | |
Suppress Parameter Validation: Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties | 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. | false |
role_config_suppression_ssl.properties_role_safety_valve
|
true | |
Suppress Parameter Validation: Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) | 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. | false |
role_config_suppression_ssl_server_ca_certificate_location
|
true | |
Suppress Parameter Validation: Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format) | 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. | false |
role_config_suppression_ssl_server_certificate_location
|
true | |
Suppress Parameter Validation: Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format) | 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. | false |
role_config_suppression_ssl_server_privatekey_location
|
true | |
Suppress Parameter Validation: Active Key Trustee Server TLS/SSL Private Key Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server TLS/SSL Private Key Password parameter. | false |
role_config_suppression_ssl_server_privatekey_password
|
true | |
Suppress Health Test: Audit Pipeline Test | Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_active_server_audit_health
|
true | |
Suppress Health Test: File Descriptors | Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_active_server_file_descriptor
|
true | |
Suppress Health Test: Host Health | Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_active_server_host_health
|
true | |
Suppress Health Test: Log Directory Free Space | Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_active_server_log_directory_free_space
|
true | |
Suppress Health Test: Process Status | Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_active_server_scm_health
|
true | |
Suppress Health Test: Swap Memory Usage | Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_active_server_swap_memory_usage
|
true | |
Suppress Health Test: Unexpected Exits | Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_active_server_unexpected_exits
|
true |
Passive Database
Categories:
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Passive Database Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. |
DB_PASSIVE_role_env_safety_valve
|
false | ||
Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. | false |
process_auto_restart
|
true | |
Enable Metric Collection | Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. | true |
process_should_monitor
|
true | |
Process Start Retry Attempts | Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. | 3 |
process_start_retries
|
false | |
Process Start Wait Timeout | The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. | 20 |
process_start_secs
|
false |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
File Descriptor Monitoring Thresholds | The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. | Warning: 50.0 %, Critical: 70.0 % |
db_passive_fd_thresholds
|
false | |
Passive Database Host Health Test | When computing the overall Passive Database health, consider the host's health. | true |
db_passive_host_health_enabled
|
false | |
Passive Database Process Health Test | Enables the health test that the Passive Database's process state is consistent with the role configuration | true |
db_passive_scm_health_enabled
|
false | |
Enable Health Alerts for this Role | When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
Metric Filter | Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
jvm_heap_used_mb metric:
{
"includeHealthTestMetricSet": true,
"filterType": "whitelist",
"metrics": ["jvm_heap_used_mb"]
} |
monitoring_metric_filter
|
false | ||
Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. | Warning: 200 B, Critical: Never |
process_swap_memory_thresholds
|
false | |
Role Triggers | The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
"streamThreshold": 0, "enabled": "true"}] See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
role_triggers
|
true | |
Unexpected Exits Thresholds | The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. | Warning: Never, Critical: Any |
unexpected_exits_thresholds
|
false | |
Unexpected Exits Monitoring Period | The period to review when computing unexpected exits. | 5 minute(s) |
unexpected_exits_window
|
false |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Database Storage Directory | 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. |
db_root
|
/var/lib/keytrustee/db |
db_root
|
false |
Retry Attempts | Number of times a connection attempt will be made before giving up. |
retry_attempts
|
30 |
retry_attempts
|
true |
Retry Timeout | Number of secconds to wait between retries. |
retry_timeout
|
1 second(s) |
retry_timeout
|
true |
Performance
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Maximum Process File Descriptors | If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. |
rlimit_fds
|
false |
Ports and Addresses
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Key Trustee Server Database Port | The Key Trustee Server database server port. Changing this value after the service has been started will have no effect. |
db_port
|
11381 |
db_port
|
true |
Resource Management
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Cgroup CPU Shares | Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. |
cpu.shares
|
1024 |
rm_cpu_shares
|
true |
Custom Control Group Resources (overrides Cgroup settings) | Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** |
custom.cgroups
|
rm_custom_resources
|
false | |
Cgroup I/O Weight | Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. |
blkio.weight
|
500 |
rm_io_weight
|
true |
Cgroup Memory Hard Limit | Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.limit_in_bytes
|
-1 MiB |
rm_memory_hard_limit
|
true |
Cgroup Memory Soft Limit | Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.soft_limit_in_bytes
|
-1 MiB |
rm_memory_soft_limit
|
true |
Suppressions
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Suppress Configuration Validator: CDH Version Validator | Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. | false |
role_config_suppression_cdh_version_validator
|
true | |
Suppress Parameter Validation: Passive Database Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Database Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_db_passive_role_env_safety_valve
|
true | |
Suppress Parameter Validation: Key Trustee Server Database Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Database Port parameter. | false |
role_config_suppression_db_port
|
true | |
Suppress Parameter Validation: Database Storage Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Database Storage Directory parameter. | false |
role_config_suppression_db_root
|
true | |
Suppress Parameter Validation: Retry Timeout | Whether to suppress configuration warnings produced by the built-in parameter validation for the Retry Timeout parameter. | false |
role_config_suppression_retry_timeout
|
true | |
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. | false |
role_config_suppression_rm_custom_resources
|
true | |
Suppress Parameter Validation: Role Triggers | Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. | false |
role_config_suppression_role_triggers
|
true | |
Suppress Health Test: Audit Pipeline Test | Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_passive_audit_health
|
true | |
Suppress Health Test: File Descriptors | Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_passive_file_descriptor
|
true | |
Suppress Health Test: Host Health | Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_passive_host_health
|
true | |
Suppress Health Test: Process Status | Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_passive_scm_health
|
true | |
Suppress Health Test: Swap Memory Usage | Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_passive_swap_memory_usage
|
true | |
Suppress Health Test: Unexpected Exits | Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_db_passive_unexpected_exits
|
true |
Passive Key Trustee Server
Categories:
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Passive Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. |
KEYTRUSTEE_PASSIVE_SERVER_role_env_safety_valve
|
false | ||
Passive Key Trustee Server XML Override | For advanced use only, replace entire XML in the logback configuration file for Passive Key Trustee Server, ignoring all logging configuration. |
logback_safety_valve
|
logback_safety_valve
|
false | |
Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. | false |
process_auto_restart
|
true | |
Enable Metric Collection | Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. | true |
process_should_monitor
|
true | |
Process Start Retry Attempts | Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. | 3 |
process_start_retries
|
false | |
Process Start Wait Timeout | The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. | 20 |
process_start_secs
|
false | |
Passive Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties | For advanced use only. A string to be inserted into ssl.properties for this role only. |
ssl.properties_role_safety_valve
|
false |
Logs
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Passive Key Trustee Server Logging Threshold | The minimum log level for Passive Key Trustee Server logs | INFO |
log_threshold
|
false | |
Passive Key Trustee Server Maximum Log File Backups | The maximum number of rolled log files to keep for Passive Key Trustee Server logs. Typically used by log4j or logback. | 10 |
max_log_backup_index
|
false | |
Passive Key Trustee Server Max Log Size | The maximum size, in megabytes, per log file for Passive Key Trustee Server logs. Typically used by log4j or logback. | 200 MiB |
max_log_size
|
false |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Enable Health Alerts for this Role | When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
File Descriptor Monitoring Thresholds | The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. | Warning: 50.0 %, Critical: 70.0 % |
keytrustee_passive_server_fd_thresholds
|
false | |
Passive Key Trustee Server Host Health Test | When computing the overall Passive Key Trustee Server health, consider the host's health. | true |
keytrustee_passive_server_host_health_enabled
|
false | |
Passive Key Trustee Server Process Health Test | Enables the health test that the Passive Key Trustee Server's process state is consistent with the role configuration | true |
keytrustee_passive_server_scm_health_enabled
|
false | |
Log Directory Free Space Monitoring Absolute Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. | Warning: 10 GiB, Critical: 5 GiB |
log_directory_free_space_absolute_thresholds
|
false | |
Log Directory Free Space Monitoring Percentage Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. | Warning: Never, Critical: Never |
log_directory_free_space_percentage_thresholds
|
false | |
Metric Filter | Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
jvm_heap_used_mb metric:
{
"includeHealthTestMetricSet": true,
"filterType": "whitelist",
"metrics": ["jvm_heap_used_mb"]
} |
monitoring_metric_filter
|
false | ||
Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. | Warning: 200 B, Critical: Never |
process_swap_memory_thresholds
|
false | |
Role Triggers | The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
"streamThreshold": 0, "enabled": "true"}] See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
role_triggers
|
true | |
Unexpected Exits Thresholds | The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. | Warning: Never, Critical: Any |
unexpected_exits_thresholds
|
false | |
Unexpected Exits Monitoring Period | The period to review when computing unexpected exits. | 5 minute(s) |
unexpected_exits_window
|
false |
Performance
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Maximum Process File Descriptors | If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. |
rlimit_fds
|
false |
Ports and Addresses
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Key Trustee Server Port | The Key Trustee Server port number. |
keytrustee_port
|
11371 |
keytrustee_port
|
true |
Resource Management
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Cgroup CPU Shares | Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. |
cpu.shares
|
1024 |
rm_cpu_shares
|
true |
Custom Control Group Resources (overrides Cgroup settings) | Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** |
custom.cgroups
|
rm_custom_resources
|
false | |
Cgroup I/O Weight | Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. |
blkio.weight
|
500 |
rm_io_weight
|
true |
Cgroup Memory Hard Limit | Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.limit_in_bytes
|
-1 MiB |
rm_memory_hard_limit
|
true |
Cgroup Memory Soft Limit | Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' |
memory.soft_limit_in_bytes
|
-1 MiB |
rm_memory_soft_limit
|
true |
Security
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Passive Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) | 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. |
ssl.cacert.location
|
ssl_server_ca_certificate_location
|
false | |
Passive Key Trustee Server TLS/SSL Server Certificate File (PEM Format) | 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. |
ssl.cert.location
|
/var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee.pem |
ssl_server_certificate_location
|
false |
Passive Key Trustee Server TLS/SSL Server Private Key File (PEM Format) | 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. |
ssl.privatekey.location
|
/var/lib/keytrustee/.keytrustee/.ssl/ssl-cert-keytrustee-pk.pem |
ssl_server_privatekey_location
|
false |
Passive Key Trustee Server TLS/SSL Private Key Password | 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. |
ssl.privatekey.password
|
ssl_server_privatekey_password
|
false |
Suppressions
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Suppress Configuration Validator: CDH Version Validator | Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. | false |
role_config_suppression_cdh_version_validator
|
true | |
Suppress Parameter Validation: Passive Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) | 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. | false |
role_config_suppression_keytrustee_passive_server_role_env_safety_valve
|
true | |
Suppress Parameter Validation: Key Trustee Server Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Port parameter. | false |
role_config_suppression_keytrustee_port
|
true | |
Suppress Parameter Validation: Passive Key Trustee Server XML Override | Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server XML Override parameter. | false |
role_config_suppression_logback_safety_valve
|
true | |
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. | false |
role_config_suppression_rm_custom_resources
|
true | |
Suppress Parameter Validation: Role Triggers | Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. | false |
role_config_suppression_role_triggers
|
true | |
Suppress Parameter Validation: Passive Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties | 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. | false |
role_config_suppression_ssl.properties_role_safety_valve
|
true | |
Suppress Parameter Validation: Passive Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) | 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. | false |
role_config_suppression_ssl_server_ca_certificate_location
|
true | |
Suppress Parameter Validation: Passive Key Trustee Server TLS/SSL Server Certificate File (PEM Format) | 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. | false |
role_config_suppression_ssl_server_certificate_location
|
true | |
Suppress Parameter Validation: Passive Key Trustee Server TLS/SSL Server Private Key File (PEM Format) | 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. | false |
role_config_suppression_ssl_server_privatekey_location
|
true | |
Suppress Parameter Validation: Passive Key Trustee Server TLS/SSL Private Key Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server TLS/SSL Private Key Password parameter. | false |
role_config_suppression_ssl_server_privatekey_password
|
true | |
Suppress Health Test: Audit Pipeline Test | Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_passive_server_audit_health
|
true | |
Suppress Health Test: File Descriptors | Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_passive_server_file_descriptor
|
true | |
Suppress Health Test: Host Health | Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_passive_server_host_health
|
true | |
Suppress Health Test: Log Directory Free Space | Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_passive_server_log_directory_free_space
|
true | |
Suppress Health Test: Process Status | Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_passive_server_scm_health
|
true | |
Suppress Health Test: Swap Memory Usage | Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_passive_server_swap_memory_usage
|
true | |
Suppress Health Test: Unexpected Exits | Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_keytrustee_server_keytrustee_passive_server_unexpected_exits
|
true |
Service-Wide
Categories:
Advanced
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Key Trustee Server Service Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration. |
KEYTRUSTEE_SERVER_service_env_safety_valve
|
false | ||
System Group | The group that this service's processes should run as. | keytrustee |
process_groupname
|
true | |
System User | The user that this service's processes should run as. | keytrustee |
process_username
|
true | |
Key Trustee Server Service Advanced Configuration Snippet (Safety Valve) for ssl.properties | For advanced use only, a string to be inserted into ssl.properties. Applies to configurations of all roles in this service except client configuration. |
ssl.properties_service_safety_valve
|
false |
Monitoring
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Enable Service Level Health Alerts | When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold | true |
enable_alerts
|
false | |
Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false | |
Service Triggers | The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad",
"streamThreshold": 10, "enabled": "true"}] See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
service_triggers
|
true | |
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) | For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. |
smon_derived_configs_safety_valve
|
false |
Other
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Supported Cipher Configuration for SSL | 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 a list of cipher
options, run the following command on the Key Trustee Server
host: If
blank then default ciphers are set. |
ciphers
|
ciphers
|
false | |
Key Trustee Home | Home directory of Key Trustee. |
keytrustee.home
|
/var/lib/keytrustee/.keytrustee |
keytrustee.home
|
false |
Minimum TLS Support | Minimum TLS protocol supported. |
tls.min.protocols
|
TLSv1 |
tls.min.protocols
|
false |
Suppressions
Display Name | Description | Related Name | Default Value | API Name | Required |
---|---|---|---|---|---|
Suppress Configuration Validator: CDH Version Validator | Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. | false |
role_config_suppression_cdh_version_validator
|
true | |
Suppress Configuration Validator: Active Database Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Active Database Environment Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_db_active_role_env_safety_valve
|
true | |
Suppress Configuration Validator: Passive Database Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Passive Database Environment Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_db_passive_role_env_safety_valve
|
true | |
Suppress Configuration Validator: Key Trustee Server Database Port | Whether to suppress configuration warnings produced by the Key Trustee Server Database Port configuration validator. | false |
role_config_suppression_db_port
|
true | |
Suppress Configuration Validator: Database Storage Directory | Whether to suppress configuration warnings produced by the Database Storage Directory configuration validator. | false |
role_config_suppression_db_root
|
true | |
Suppress Configuration Validator: Active Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Active Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_keytrustee_active_server_role_env_safety_valve
|
true | |
Suppress Configuration Validator: Passive Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Passive Key Trustee Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_keytrustee_passive_server_role_env_safety_valve
|
true | |
Suppress Configuration Validator: Key Trustee Server Port | Whether to suppress configuration warnings produced by the Key Trustee Server Port configuration validator. | false |
role_config_suppression_keytrustee_port
|
true | |
Suppress Configuration Validator: Active Key Trustee Server XML Override | Whether to suppress configuration warnings produced by the Active Key Trustee Server XML Override configuration validator. | false |
role_config_suppression_logback_safety_valve
|
true | |
Suppress Configuration Validator: Retry Timeout | Whether to suppress configuration warnings produced by the Retry Timeout configuration validator. | false |
role_config_suppression_retry_timeout
|
true | |
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator. | false |
role_config_suppression_rm_custom_resources
|
true | |
Suppress Configuration Validator: Role Triggers | Whether to suppress configuration warnings produced by the Role Triggers configuration validator. | false |
role_config_suppression_role_triggers
|
true | |
Suppress Configuration Validator: Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties | Whether to suppress configuration warnings produced by the Active Key Trustee Server Advanced Configuration Snippet (Safety Valve) for ssl.properties configuration validator. | false |
role_config_suppression_ssl.properties_role_safety_valve
|
true | |
Suppress Configuration Validator: Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) | Whether to suppress configuration warnings produced by the Active Key Trustee Server TLS/SSL Server CA Certificate (PEM Format) configuration validator. | false |
role_config_suppression_ssl_server_ca_certificate_location
|
true | |
Suppress Configuration Validator: Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format) | Whether to suppress configuration warnings produced by the Active Key Trustee Server TLS/SSL Server Certificate File (PEM Format) configuration validator. | false |
role_config_suppression_ssl_server_certificate_location
|
true | |
Suppress Configuration Validator: Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format) | Whether to suppress configuration warnings produced by the Active Key Trustee Server TLS/SSL Server Private Key File (PEM Format) configuration validator. | false |
role_config_suppression_ssl_server_privatekey_location
|
true | |
Suppress Configuration Validator: Active Key Trustee Server TLS/SSL Private Key Password | Whether to suppress configuration warnings produced by the Active Key Trustee Server TLS/SSL Private Key Password configuration validator. | false |
role_config_suppression_ssl_server_privatekey_password
|
true | |
Suppress Parameter Validation: Supported Cipher Configuration for SSL | Whether to suppress configuration warnings produced by the built-in parameter validation for the Supported Cipher Configuration for SSL parameter. | false |
service_config_suppression_ciphers
|
true | |
Suppress Configuration Validator: Active Database Count Validator | Whether to suppress configuration warnings produced by the Active Database Count Validator configuration validator. | false |
service_config_suppression_db_active_count_validator
|
true | |
Suppress Configuration Validator: Passive Database Count Validator | Whether to suppress configuration warnings produced by the Passive Database Count Validator configuration validator. | false |
service_config_suppression_db_passive_count_validator
|
true | |
Suppress Parameter Validation: Key Trustee Home | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Home parameter. | false |
service_config_suppression_keytrustee.home
|
true | |
Suppress Configuration Validator: Active Key Trustee Server Count Validator | Whether to suppress configuration warnings produced by the Active Key Trustee Server Count Validator configuration validator. | false |
service_config_suppression_keytrustee_active_server_count_validator
|
true | |
Suppress Configuration Validator: Passive Key Trustee Server Count Validator | Whether to suppress configuration warnings produced by the Passive Key Trustee Server Count Validator configuration validator. | false |
service_config_suppression_keytrustee_passive_server_count_validator
|
true | |
Suppress Parameter Validation: Key Trustee Server Service Environment Advanced Configuration Snippet (Safety Valve) | 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. | false |
service_config_suppression_keytrustee_server_service_env_safety_valve
|
true | |
Suppress Parameter Validation: System Group | Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. | false |
service_config_suppression_process_groupname
|
true | |
Suppress Parameter Validation: System User | Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. | false |
service_config_suppression_process_username
|
true | |
Suppress Parameter Validation: Service Triggers | Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. | false |
service_config_suppression_service_triggers
|
true | |
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. | false |
service_config_suppression_smon_derived_configs_safety_valve
|
true | |
Suppress Parameter Validation: Key Trustee Server Service Advanced Configuration Snippet (Safety Valve) for ssl.properties | 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. | false |
service_config_suppression_ssl.properties_service_safety_valve
|
true |