Java KeyStore KMS Properties in CDH 5.16.0
Role groups:
Key Management Server
Categories:
Advanced
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Key Management Server Advanced Configuration Snippet (Safety Valve) for core-site.xml | For advanced use only. A string to be inserted into core-site.xml for this role only. |
core-site.xml_role_safety_valve
|
false | ||
| Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-acls.xml | For advanced use only. A string to be inserted into kms-acls.xml for this role only. |
kms-acls.xml_role_safety_valve
|
false | ||
| Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-site.xml | For advanced use only. A string to be inserted into kms-site.xml for this role only. |
kms-site.xml_role_safety_valve
|
false | ||
| Key Management 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. |
KMS_role_env_safety_valve
|
false | ||
| Key Management Server Logging Advanced Configuration Snippet (Safety Valve) | For advanced use only, a string to be inserted into log4j.properties for this role only. |
log4j_safety_valve
|
false | ||
| Heap Dump Directory | Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. |
oom_heap_dump_dir
|
/tmp |
oom_heap_dump_dir
|
false |
| Dump Heap When Out of Memory | When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. | true |
oom_heap_dump_enabled
|
true | |
| Kill When Out of Memory | When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. | true |
oom_sigkill_enabled
|
true | |
| Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. | false |
process_auto_restart
|
true | |
| Enable Metric Collection | Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. | true |
process_should_monitor
|
true | |
| Process Start Retry Attempts | Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. | 3 |
process_start_retries
|
false | |
| Process Start Wait Timeout | The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. | 20 |
process_start_secs
|
false |
Logs
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Key Management Server Log Directory | The log directory for log files of the role Key Management Server. |
log.dir
|
/var/log/hadoop-kms |
log_dir
|
false |
| Key Management Server Logging Threshold | The minimum log level for Key Management Server logs | INFO |
log_threshold
|
false | |
| Key Management Server Maximum Log File Backups | The maximum number of rolled log files to keep for Key Management Server logs. Typically used by log4j or logback. | 10 |
max_log_backup_index
|
false | |
| Key Management Server Max Log Size | The maximum size, in megabytes, per log file for Key Management Server logs. Typically used by log4j or logback. | 200 MiB |
max_log_size
|
false |
Monitoring
| Display Name | Description | Property 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 % |
kms_fd_thresholds
|
false | |
| Key Management Server Host Health Test | When computing the overall Key Management Server health, consider the host's health. | true |
kms_host_health_enabled
|
false | |
| Key Management Server Process Health Test | Enables the health test that the Key Management Server's process state is consistent with the role configuration | true |
kms_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 |
Other
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Flume Proxy User Groups | Allows the flume superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.flume.groups
|
* |
hadoop_kms_proxyuser_flume_groups
|
false |
| Flume Proxy User Hosts | Comma-delimited list of hosts where you want to allow the flume user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.flume.hosts
|
* |
hadoop_kms_proxyuser_flume_hosts
|
false |
| HDFS Proxy User Groups | Allows the hdfs superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.hdfs.groups
|
* |
hadoop_kms_proxyuser_hdfs_groups
|
false |
| HDFS Proxy User Hosts | Comma-delimited list of hosts where you want to allow the hdfs user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.hdfs.hosts
|
* |
hadoop_kms_proxyuser_hdfs_hosts
|
false |
| Hive Proxy User Groups | Allows the hive superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.hive.groups
|
* |
hadoop_kms_proxyuser_hive_groups
|
false |
| Hive Proxy User Hosts | Comma-delimited list of hosts where you want to allow the hive user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.hive.hosts
|
* |
hadoop_kms_proxyuser_hive_hosts
|
false |
| HTTP Proxy User Groups | Allows the HTTP superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.HTTP.groups
|
* |
hadoop_kms_proxyuser_HTTP_groups
|
false |
| HTTP Proxy User Hosts | Comma-delimited list of hosts where you want to allow the HTTP user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.HTTP.hosts
|
* |
hadoop_kms_proxyuser_HTTP_hosts
|
false |
| HttpFS Proxy User Groups | Allows the httpfs superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.httpfs.groups
|
* |
hadoop_kms_proxyuser_httpfs_groups
|
false |
| HttpFS Proxy User Hosts | Comma-delimited list of hosts where you want to allow the httpfs user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.httpfs.hosts
|
* |
hadoop_kms_proxyuser_httpfs_hosts
|
false |
| Hue Proxy User Groups | Allows the hue superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.hue.groups
|
* |
hadoop_kms_proxyuser_hue_groups
|
false |
| Hue Proxy User Hosts | Comma-delimited list of hosts where you want to allow the hue user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.hue.hosts
|
* |
hadoop_kms_proxyuser_hue_hosts
|
false |
| Mapred Proxy User Groups | Allows the mapred superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.mapred.groups
|
* |
hadoop_kms_proxyuser_mapred_groups
|
false |
| Mapred Proxy User Hosts | Comma-delimited list of hosts where you want to allow the mapred user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.mapred.hosts
|
* |
hadoop_kms_proxyuser_mapred_hosts
|
false |
| Oozie Proxy User Groups | Allows the oozie superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.oozie.groups
|
* |
hadoop_kms_proxyuser_oozie_groups
|
false |
| Oozie Proxy User Hosts | Comma-delimited list of hosts where you want to allow the oozie user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.oozie.hosts
|
* |
hadoop_kms_proxyuser_oozie_hosts
|
false |
| YARN Proxy User Groups | Allows the yarn superuser to impersonate any members of a comma-delimited list of groups. The default '*' allows all groups. To disable entirely, use a string that doesn't correspond to a group name, such as '_no_group_'. |
hadoop.kms.proxyuser.yarn.groups
|
* |
hadoop_kms_proxyuser_yarn_groups
|
false |
| YARN Proxy User Hosts | Comma-delimited list of hosts where you want to allow the yarn user to impersonate other users. The default '*' allows all hosts. To disable entirely, use a string that doesn't correspond to a host name, such as '_no_host'. |
hadoop.kms.proxyuser.yarn.hosts
|
* |
hadoop_kms_proxyuser_yarn_hosts
|
false |
| JavaKeyStoreProvider Directory | Directory of the keystore file kms.keystore used by JavaKeyStoreProvider that backs the KMS. |
hadoop.kms.key.provider.uri
|
/var/lib/kms |
hadoop_security_key_provider_dir
|
true |
| KMS Accept Count | The maximum queue length for incoming connection requests when all possible request processing threads are in use. Any requests received when the queue is full will be refused.This configuration is only supported in CDH 5.11 and up. |
kms_accept_count
|
500 |
kms_accept_count
|
false |
| KMS Acceptor Thread Count | The number of threads to be used to accept connections. Increase this value on a multi CPU machine, although you would never really need more than 2. Also, with a lot of non keep alive connections, you might want to increase this value as well.This setting only works with Tomcat's NIO handler protocol.This configuration is only supported in CDH 5.11 and up. |
kms_acceptor_thread_count
|
1 |
kms_acceptor_thread_count
|
false |
| KMS Blacklist Users | A comma-separated list of users (no spaces) for whom to disallow access to key material. These users can still fetch key metadata and create encrypted encryption keys, but are unable to do any other KMS operations. Typically, HDFS superusers will be specified here. |
kms_blacklist_users
|
kms_blacklist_users
|
false | |
| KMS Heap Size | Maximum heap size of the KMS. |
kms_heap_size
|
1 GiB |
kms_heap_size
|
true |
| Additional Java Configuration Options for KMS | These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. |
kms_java_opts
|
kms_java_opts
|
false | |
| KMS Max Threads | Maximum number of threads used to handle KMS requests. |
kms_max_threads
|
250 |
kms_max_threads
|
false |
| KMS Handler Protocol | The Tomcat handler protocol. The default HTTP/1.1 handler is a thread-per-request model.This configuration is only supported in CDH 5.11 and up. |
kms_protocol
|
HTTP/1.1 |
kms_protocol
|
false |
| KMS Staging Directory | Directory where configuration and binaries are staged before starting KMS. Does not normally need to be modified. |
kms_staging_dir
|
/var/lib/hadoop-kms |
kms_staging_dir
|
true |
Performance
| Display Name | Description | Property 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 | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| KMS Admin Port | Port used to access the KMS' embedded Tomcat admin console. |
kms_admin_port
|
16001 |
kms_admin_port
|
true |
| KMS HTTP Port | Port used by clients to interact with the KMS. |
kms_http_port
|
16000 |
kms_http_port
|
true |
Resource Management
| Display Name | Description | Property 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 | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Enable TLS/SSL for Key Management Server | Encrypt communication between clients and Key Management Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). | false |
ssl_enabled
|
false | |
| Key Management Server TLS/SSL Server JKS Keystore File Location | The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Key Management Server is acting as a TLS/SSL server. The keystore must be in JKS format. |
ssl_server_keystore_location
|
false | ||
| Key Management Server TLS/SSL Server JKS Keystore File Password | The password for the Key Management Server JKS keystore file. |
ssl_server_keystore_password
|
false |
Stacks Collection
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Stacks Collection Data Retention | The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. |
stacks_collection_data_retention
|
100 MiB |
stacks_collection_data_retention
|
false |
| Stacks Collection Directory | The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. |
stacks_collection_directory
|
stacks_collection_directory
|
false | |
| Stacks Collection Enabled | Whether or not periodic stacks collection is enabled. |
stacks_collection_enabled
|
false |
stacks_collection_enabled
|
true |
| Stacks Collection Frequency | The frequency with which stacks are collected. |
stacks_collection_frequency
|
5.0 second(s) |
stacks_collection_frequency
|
false |
| Stacks Collection Method | The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. |
stacks_collection_method
|
jstack |
stacks_collection_method
|
false |
Suppressions
| Display Name | Description | Property 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: Key Management Server Advanced Configuration Snippet (Safety Valve) for core-site.xml | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter. | false |
role_config_suppression_core-site.xml_role_safety_valve
|
true | |
| Suppress Parameter Validation: Flume Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the Flume Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_flume_groups
|
true | |
| Suppress Parameter Validation: Flume Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the Flume Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_flume_hosts
|
true | |
| Suppress Parameter Validation: HDFS Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_hdfs_groups
|
true | |
| Suppress Parameter Validation: HDFS Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_hdfs_hosts
|
true | |
| Suppress Parameter Validation: Hive Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_hive_groups
|
true | |
| Suppress Parameter Validation: Hive Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_hive_hosts
|
true | |
| Suppress Parameter Validation: HTTP Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_http_groups
|
true | |
| Suppress Parameter Validation: HTTP Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_http_hosts
|
true | |
| Suppress Parameter Validation: HttpFS Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_httpfs_groups
|
true | |
| Suppress Parameter Validation: HttpFS Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_httpfs_hosts
|
true | |
| Suppress Parameter Validation: Hue Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_hue_groups
|
true | |
| Suppress Parameter Validation: Hue Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_hue_hosts
|
true | |
| Suppress Parameter Validation: Mapred Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the Mapred Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_mapred_groups
|
true | |
| Suppress Parameter Validation: Mapred Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the Mapred Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_mapred_hosts
|
true | |
| Suppress Parameter Validation: Oozie Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_oozie_groups
|
true | |
| Suppress Parameter Validation: Oozie Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_oozie_hosts
|
true | |
| Suppress Parameter Validation: YARN Proxy User Groups | Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Proxy User Groups parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_yarn_groups
|
true | |
| Suppress Parameter Validation: YARN Proxy User Hosts | Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Proxy User Hosts parameter. | false |
role_config_suppression_hadoop_kms_proxyuser_yarn_hosts
|
true | |
| Suppress Parameter Validation: JavaKeyStoreProvider Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the JavaKeyStoreProvider Directory parameter. | false |
role_config_suppression_hadoop_security_key_provider_dir
|
true | |
| Suppress Parameter Validation: Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-acls.xml | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-acls.xml parameter. | false |
role_config_suppression_kms-acls.xml_role_safety_valve
|
true | |
| Suppress Parameter Validation: Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-site.xml | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-site.xml parameter. | false |
role_config_suppression_kms-site.xml_role_safety_valve
|
true | |
| Suppress Parameter Validation: KMS Acceptor Thread Count | Whether to suppress configuration warnings produced by the built-in parameter validation for the KMS Acceptor Thread Count parameter. | false |
role_config_suppression_kms_acceptor_thread_count
|
true | |
| Suppress Parameter Validation: KMS Admin Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the KMS Admin Port parameter. | false |
role_config_suppression_kms_admin_port
|
true | |
| Suppress Parameter Validation: KMS Blacklist Users | Whether to suppress configuration warnings produced by the built-in parameter validation for the KMS Blacklist Users parameter. | false |
role_config_suppression_kms_blacklist_users
|
true | |
| Suppress Parameter Validation: KMS HTTP Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the KMS HTTP Port parameter. | false |
role_config_suppression_kms_http_port
|
true | |
| Suppress Parameter Validation: Additional Java Configuration Options for KMS | Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Java Configuration Options for KMS parameter. | false |
role_config_suppression_kms_java_opts
|
true | |
| Suppress Parameter Validation: Key Management Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_kms_role_env_safety_valve
|
true | |
| Suppress Parameter Validation: KMS Staging Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the KMS Staging Directory parameter. | false |
role_config_suppression_kms_staging_dir
|
true | |
| Suppress Parameter Validation: Key Management Server Logging Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Logging Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_log4j_safety_valve
|
true | |
| Suppress Parameter Validation: Key Management Server Log Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Log Directory parameter. | false |
role_config_suppression_log_dir
|
true | |
| Suppress Parameter Validation: Heap Dump Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. | false |
role_config_suppression_oom_heap_dump_dir
|
true | |
| Suppress Parameter Validation: 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: Key Management Server TLS/SSL Server JKS Keystore File Location | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server TLS/SSL Server JKS Keystore File Location parameter. | false |
role_config_suppression_ssl_server_keystore_location
|
true | |
| Suppress Parameter Validation: Key Management Server TLS/SSL Server JKS Keystore File Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server TLS/SSL Server JKS Keystore File Password parameter. | false |
role_config_suppression_ssl_server_keystore_password
|
true | |
| Suppress Parameter Validation: Stacks Collection Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. | false |
role_config_suppression_stacks_collection_directory
|
true | |
| Suppress Health Test: Audit Pipeline Test | Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
role_health_suppression_kms_kms_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_kms_kms_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_kms_kms_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_kms_kms_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_kms_kms_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_kms_kms_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_kms_kms_unexpected_exits
|
true |
Service-Wide
Categories:
Advanced
| Display Name | Description | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Java KeyStore KMS 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. |
KMS_service_env_safety_valve
|
false | ||
| System Group | The group that this service's processes should run as. | kms |
process_groupname
|
true | |
| System User | The user that this service's processes should run as. | kms |
process_username
|
true |
Monitoring
| Display Name | Description | Property 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 | Property Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Authentication Type | Authentication type for the KMS. Can either be "simple" or "kerberos". |
hadoop.kms.authentication.type
|
simple |
hadoop_kms_authentication_type
|
true |
Suppressions
| Display Name | Description | Property 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: Key Management Server Advanced Configuration Snippet (Safety Valve) for core-site.xml | Whether to suppress configuration warnings produced by the Key Management Server Advanced Configuration Snippet (Safety Valve) for core-site.xml configuration validator. | false |
role_config_suppression_core-site.xml_role_safety_valve
|
true | |
| Suppress Configuration Validator: Flume Proxy User Groups | Whether to suppress configuration warnings produced by the Flume Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_flume_groups
|
true | |
| Suppress Configuration Validator: Flume Proxy User Hosts | Whether to suppress configuration warnings produced by the Flume Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_flume_hosts
|
true | |
| Suppress Configuration Validator: HDFS Proxy User Groups | Whether to suppress configuration warnings produced by the HDFS Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_hdfs_groups
|
true | |
| Suppress Configuration Validator: HDFS Proxy User Hosts | Whether to suppress configuration warnings produced by the HDFS Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_hdfs_hosts
|
true | |
| Suppress Configuration Validator: Hive Proxy User Groups | Whether to suppress configuration warnings produced by the Hive Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_hive_groups
|
true | |
| Suppress Configuration Validator: Hive Proxy User Hosts | Whether to suppress configuration warnings produced by the Hive Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_hive_hosts
|
true | |
| Suppress Configuration Validator: HTTP Proxy User Groups | Whether to suppress configuration warnings produced by the HTTP Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_http_groups
|
true | |
| Suppress Configuration Validator: HTTP Proxy User Hosts | Whether to suppress configuration warnings produced by the HTTP Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_http_hosts
|
true | |
| Suppress Configuration Validator: HttpFS Proxy User Groups | Whether to suppress configuration warnings produced by the HttpFS Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_httpfs_groups
|
true | |
| Suppress Configuration Validator: HttpFS Proxy User Hosts | Whether to suppress configuration warnings produced by the HttpFS Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_httpfs_hosts
|
true | |
| Suppress Configuration Validator: Hue Proxy User Groups | Whether to suppress configuration warnings produced by the Hue Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_hue_groups
|
true | |
| Suppress Configuration Validator: Hue Proxy User Hosts | Whether to suppress configuration warnings produced by the Hue Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_hue_hosts
|
true | |
| Suppress Configuration Validator: Mapred Proxy User Groups | Whether to suppress configuration warnings produced by the Mapred Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_mapred_groups
|
true | |
| Suppress Configuration Validator: Mapred Proxy User Hosts | Whether to suppress configuration warnings produced by the Mapred Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_mapred_hosts
|
true | |
| Suppress Configuration Validator: Oozie Proxy User Groups | Whether to suppress configuration warnings produced by the Oozie Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_oozie_groups
|
true | |
| Suppress Configuration Validator: Oozie Proxy User Hosts | Whether to suppress configuration warnings produced by the Oozie Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_oozie_hosts
|
true | |
| Suppress Configuration Validator: YARN Proxy User Groups | Whether to suppress configuration warnings produced by the YARN Proxy User Groups configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_yarn_groups
|
true | |
| Suppress Configuration Validator: YARN Proxy User Hosts | Whether to suppress configuration warnings produced by the YARN Proxy User Hosts configuration validator. | false |
role_config_suppression_hadoop_kms_proxyuser_yarn_hosts
|
true | |
| Suppress Configuration Validator: JavaKeyStoreProvider Directory | Whether to suppress configuration warnings produced by the JavaKeyStoreProvider Directory configuration validator. | false |
role_config_suppression_hadoop_security_key_provider_dir
|
true | |
| Suppress Configuration Validator: Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-acls.xml | Whether to suppress configuration warnings produced by the Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-acls.xml configuration validator. | false |
role_config_suppression_kms-acls.xml_role_safety_valve
|
true | |
| Suppress Configuration Validator: Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-site.xml | Whether to suppress configuration warnings produced by the Key Management Server Advanced Configuration Snippet (Safety Valve) for kms-site.xml configuration validator. | false |
role_config_suppression_kms-site.xml_role_safety_valve
|
true | |
| Suppress Configuration Validator: KMS Acceptor Thread Count | Whether to suppress configuration warnings produced by the KMS Acceptor Thread Count configuration validator. | false |
role_config_suppression_kms_acceptor_thread_count
|
true | |
| Suppress Configuration Validator: KMS Admin Port | Whether to suppress configuration warnings produced by the KMS Admin Port configuration validator. | false |
role_config_suppression_kms_admin_port
|
true | |
| Suppress Configuration Validator: KMS Blacklist Users | Whether to suppress configuration warnings produced by the KMS Blacklist Users configuration validator. | false |
role_config_suppression_kms_blacklist_users
|
true | |
| Suppress Configuration Validator: KMS HTTP Port | Whether to suppress configuration warnings produced by the KMS HTTP Port configuration validator. | false |
role_config_suppression_kms_http_port
|
true | |
| Suppress Configuration Validator: Additional Java Configuration Options for KMS | Whether to suppress configuration warnings produced by the Additional Java Configuration Options for KMS configuration validator. | false |
role_config_suppression_kms_java_opts
|
true | |
| Suppress Configuration Validator: Key Management Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Key Management Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_kms_role_env_safety_valve
|
true | |
| Suppress Configuration Validator: KMS Staging Directory | Whether to suppress configuration warnings produced by the KMS Staging Directory configuration validator. | false |
role_config_suppression_kms_staging_dir
|
true | |
| Suppress Configuration Validator: Key Management Server Logging Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Key Management Server Logging Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_log4j_safety_valve
|
true | |
| Suppress Configuration Validator: Key Management Server Log Directory | Whether to suppress configuration warnings produced by the Key Management Server Log Directory configuration validator. | false |
role_config_suppression_log_dir
|
true | |
| Suppress Configuration Validator: Heap Dump Directory | Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator. | false |
role_config_suppression_oom_heap_dump_dir
|
true | |
| Suppress Configuration Validator: 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: Key Management Server TLS/SSL Server JKS Keystore File Location | Whether to suppress configuration warnings produced by the Key Management Server TLS/SSL Server JKS Keystore File Location configuration validator. | false |
role_config_suppression_ssl_server_keystore_location
|
true | |
| Suppress Configuration Validator: Key Management Server TLS/SSL Server JKS Keystore File Password | Whether to suppress configuration warnings produced by the Key Management Server TLS/SSL Server JKS Keystore File Password configuration validator. | false |
role_config_suppression_ssl_server_keystore_password
|
true | |
| Suppress Configuration Validator: Stacks Collection Directory | Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. | false |
role_config_suppression_stacks_collection_directory
|
true | |
| Suppress Configuration Validator: Key Management Server Count Validator | Whether to suppress configuration warnings produced by the Key Management Server Count Validator configuration validator. | false |
service_config_suppression_kms_count_validator
|
true | |
| Suppress Parameter Validation: Java KeyStore KMS Service Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Java KeyStore KMS Service Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
service_config_suppression_kms_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 |
