Key Trustee KMS Properties in Cloudera Runtime 7.1.7
Role groups:
Key Management Server Proxy
Advanced
Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for core-site.xml
- Description
- For advanced use only. A string to be inserted into core-site.xml for this role only.
- Related Name
- Default Value
- API Name
-
core-site.xml_role_safety_valve
- Required
- false
Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-acls.xml
- Description
- For advanced use only. A string to be inserted into kms-acls.xml for this role only.
- Related Name
- Default Value
- API Name
-
kms-acls.xml_role_safety_valve
- Required
- false
Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-site.xml
- Description
- For advanced use only. A string to be inserted into kms-site.xml for this role only.
- Related Name
- Default Value
- API Name
-
kms-site.xml_role_safety_valve
- Required
- false
Key Management Server Proxy Environment Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration.
- Related Name
- Default Value
- API Name
-
KMS_KEYTRUSTEE_role_env_safety_valve
- Required
- false
Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kts-site.xml
- Description
- For advanced use only. A string to be inserted into kts-site.xml for this role only.
- Related Name
- Default Value
- API Name
-
kts-site.xml_role_safety_valve
- Required
- false
Key Management Server Proxy Logging Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a string to be inserted into log4j.properties for this role only.
- Related Name
- Default Value
- API Name
-
log4j_safety_valve
- Required
- false
Enable auto refresh for metric configurations
- Description
- When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
- Related Name
- Default Value
- false
- API Name
-
metric_config_auto_refresh
- Required
- false
Heap Dump Directory
- Description
- Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
- Related Name
-
oom_heap_dump_dir
- Default Value
- /tmp
- API Name
-
oom_heap_dump_dir
- Required
- false
Dump Heap When Out of Memory
- Description
- When set, generates a heap dump file when when an out-of-memory error occurs.
- Related Name
- Default Value
- true
- API Name
-
oom_heap_dump_enabled
- Required
- true
Kill When Out of Memory
- Description
- When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
- Related Name
- Default Value
- true
- API Name
-
oom_sigkill_enabled
- Required
- true
Automatically Restart Process
- Description
- When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
- Related Name
- Default Value
- false
- API Name
-
process_auto_restart
- Required
- true
Enable Metric Collection
- Description
- Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
- Related Name
- Default Value
- true
- API Name
-
process_should_monitor
- Required
- true
Process Start Retry Attempts
- Description
- Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
- Related Name
- Default Value
- 3
- API Name
-
process_start_retries
- Required
- false
Process Start Wait Timeout
- Description
- The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
- Related Name
- Default Value
- 20
- API Name
-
process_start_secs
- Required
- false
Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for ssl-server.xml
- Description
- For advanced use only. A string to be inserted into ssl-server.xml for this role only.
- Related Name
- Default Value
- API Name
-
ssl-server.xml_role_safety_valve
- Required
- false
Logs
Key Management Server Proxy Log Directory
- Description
- The log directory for log files of the role Key Management Server Proxy.
- Related Name
-
log.dir
- Default Value
- /var/log/kms-keytrustee
- API Name
-
log_dir
- Required
- false
Key Management Server Proxy Logging Threshold
- Description
- The minimum log level for Key Management Server Proxy logs
- Related Name
- Default Value
- INFO
- API Name
-
log_threshold
- Required
- false
Key Management Server Proxy Maximum Log File Backups
- Description
- The maximum number of rolled log files to keep for Key Management Server Proxy logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 10
- API Name
-
max_log_backup_index
- Required
- false
Key Management Server Proxy Max Log Size
- Description
- The maximum size, in megabytes, per log file for Key Management Server Proxy logs. Typically used by log4j or logback.
- Related Name
- Default Value
- 200 MiB
- API Name
-
max_log_size
- Required
- false
Monitoring
Enable Health Alerts for this Role
- Description
- When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
File Descriptor Monitoring Thresholds
- Description
- The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
- Related Name
- Default Value
- Warning: 50.0 %, Critical: 70.0 %
- API Name
-
kms_keytrustee_fd_thresholds
- Required
- false
Key Management Server Proxy Host Health Test
- Description
- When computing the overall Key Management Server Proxy health, consider the host's health.
- Related Name
- Default Value
- true
- API Name
-
kms_keytrustee_host_health_enabled
- Required
- false
Key Management Server Proxy Process Health Test
- Description
- Enables the health test that the Key Management Server Proxy's process state is consistent with the role configuration
- Related Name
- Default Value
- true
- API Name
-
kms_keytrustee_scm_health_enabled
- Required
- false
Log Directory Free Space Monitoring Absolute Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
- Related Name
- Default Value
- Warning: 10 GiB, Critical: 5 GiB
- API Name
-
log_directory_free_space_absolute_thresholds
- Required
- false
Log Directory Free Space Monitoring Percentage Thresholds
- Description
- The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
log_directory_free_space_percentage_thresholds
- Required
- false
Metric Filter
- Description
- Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
- Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
- Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
- Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
- Metric Name - The name of a metric that will be included or excluded during metric collection.
jvm_heap_used_mb
metric:- Include only Health Test Metric Set: Selected.
- Include/Exclude Custom Metrics: Set to Include.
- Metric Name:
jvm_heap_used_mb
{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
- Related Name
- Default Value
- API Name
-
monitoring_metric_filter
- Required
- false
Swap Memory Usage Rate Thresholds
- Description
- The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
- Related Name
- Default Value
- Warning: Never, Critical: Never
- API Name
-
process_swap_memory_rate_thresholds
- Required
- false
Swap Memory Usage Rate Window
- Description
- The period to review when computing unexpected swap memory usage change of the process.
- Related Name
-
common.process.swap_memory_rate_window
- Default Value
- 5 minute(s)
- API Name
-
process_swap_memory_rate_window
- Required
- false
Process Swap Memory Thresholds
- Description
- The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
- Related Name
- Default Value
- Warning: 200 B, Critical: Never
- API Name
-
process_swap_memory_thresholds
- Required
- false
Role Triggers
- Description
- The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName
(mandatory) - The name of the trigger. This value must be unique for the specific role.triggerExpression
(mandatory) - A tsquery expression representing the trigger.streamThreshold
(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]
See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. - Related Name
- Default Value
- []
- API Name
-
role_triggers
- Required
- true
Unexpected Exits Thresholds
- Description
- The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
- Related Name
- Default Value
- Warning: Never, Critical: Any
- API Name
-
unexpected_exits_thresholds
- Required
- false
Unexpected Exits Monitoring Period
- Description
- The period to review when computing unexpected exits.
- Related Name
- Default Value
- 5 minute(s)
- API Name
-
unexpected_exits_window
- Required
- false
Other
Key Trustee Server Auth Code
- Description
- Key Trustee Server auth code used for KMS to authenticate against the server
- Related Name
-
cloudera.trustee.keyprovider.auth
- Default Value
- API Name
-
cloudera_trustee_keyprovider_auth
- Required
- true
Active Key Trustee Server
- Description
- Active Key Trustee Server hostname that backs the KMS.
- Related Name
-
cloudera.trustee.keyprovider.hostname-ACTIVE
- Default Value
- API Name
-
cloudera_trustee_keyprovider_hostname-ACTIVE
- Required
- true
Passive Key Trustee Server
- Description
- Passive Key Trustee Server hostname that backs the KMS. Only needed for Key Trustee Server high availability.
- Related Name
-
cloudera.trustee.keyprovider.hostname-PASSIVE
- Default Value
- API Name
-
cloudera_trustee_keyprovider_hostname-PASSIVE
- Required
- false
Key Trustee Server Org Name
- Description
- Key Trustee Server Organization that keys are stored against.
- Related Name
-
cloudera.trustee.keyprovider.org
- Default Value
- API Name
-
cloudera_trustee_keyprovider_org
- Required
- true
Key Trustee Server Key Provider Pool Timeout
- Description
- Key Trustee key provider pool timeout.
- Related Name
-
cloudera.trustee.keyprovider.pool.abandoned.timeout
- Default Value
- 5 minute(s)
- API Name
-
cloudera_trustee_keyprovider_pool_abandoned_timeout
- Required
- true
Key Trustee Server Key Provider Max Connections
- Description
- Key Trustee Server Key Provider Max Connections.
- Related Name
-
cloudera.trustee.keyprovider.pool.max
- Default Value
- 5
- API Name
-
cloudera_trustee_keyprovider_pool_max
- Required
- true
Key Trustee Server Key Provider Pool Max Idle
- Description
- Key Trustee Server Key Provider Pool Max Idle.
- Related Name
-
cloudera.trustee.keyprovider.pool.max.idle
- Default Value
- 2
- API Name
-
cloudera_trustee_keyprovider_pool_max_idle
- Required
- true
Key Trustee Server Key Provider Pool Min Idle
- Description
- Key Trustee Server Key Provider Pool Min Idle.
- Related Name
-
cloudera.trustee.keyprovider.pool.min.idle
- Default Value
- 1
- API Name
-
cloudera_trustee_keyprovider_pool_min_idle
- Required
- true
Key Trustee Server Round Robin Reads
- Description
- Distribute read requests amongst the available Key Trustee Servers. Only effective when a passive server is specified.
- Related Name
-
cloudera.trustee.keyprovider.roundrobin
- Default Value
- true
- API Name
-
cloudera_trustee_keyprovider_roundrobin
- Required
- false
Flume Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.flume.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_flume_groups
- Required
- false
Flume Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.flume.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_flume_hosts
- Required
- false
HDFS Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.hdfs.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_hdfs_groups
- Required
- false
HDFS Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.hdfs.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_hdfs_hosts
- Required
- false
Hive Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.hive.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_hive_groups
- Required
- false
Hive Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.hive.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_hive_hosts
- Required
- false
HTTP Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.HTTP.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_HTTP_groups
- Required
- false
HTTP Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.HTTP.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_HTTP_hosts
- Required
- false
HttpFS Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.httpfs.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_httpfs_groups
- Required
- false
HttpFS Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.httpfs.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_httpfs_hosts
- Required
- false
Hue Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.hue.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_hue_groups
- Required
- false
Hue Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.hue.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_hue_hosts
- Required
- false
Mapred Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.mapred.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_mapred_groups
- Required
- false
Mapred Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.mapred.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_mapred_hosts
- Required
- false
Oozie Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.oozie.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_oozie_groups
- Required
- false
Oozie Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.oozie.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_oozie_hosts
- Required
- false
YARN Proxy User Groups
- Description
- 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_'.
- Related Name
-
hadoop.kms.proxyuser.yarn.groups
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_yarn_groups
- Required
- false
YARN Proxy User Hosts
- Description
- 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'.
- Related Name
-
hadoop.kms.proxyuser.yarn.hosts
- Default Value
- *
- API Name
-
hadoop_kms_proxyuser_yarn_hosts
- Required
- false
Key Trustee KeyStoreProvider Directory
- Description
- Directory to the keystore file used by Key Trustee KeyStoreProvider that backs the KMS.
- Related Name
-
hadoop.kms.key.provider.uri
- Default Value
- /var/lib/kms-keytrustee
- API Name
-
hadoop_security_key_provider_dir
- Required
- true
Key Trustee KeyStoreProvider Configuration Directory
- Description
- Directory to store configuration of keystore file used by Key Trustee KeyStoreProvider that backs the KMS.
- Related Name
-
keytrustee.kms.key.provider.conf.uri
- Default Value
- /var/lib/kms-keytrustee/keytrustee
- API Name
-
keytrustee_security_key_provider_conf_dir
- Required
- true
KMS Accept Count
- Description
- 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.
- Related Name
-
hadoop.http.accept.queue.size
- Default Value
- 500
- API Name
-
kms_accept_count
- Required
- false
KMS Blacklist Users
- Description
- 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.
- Related Name
-
kms_blacklist_users
- Default Value
- API Name
-
kms_blacklist_users
- Required
- false
KMS Heap Size
- Description
- Maximum heap size of the KMS.
- Related Name
-
kms_heap_size
- Default Value
- 1 GiB
- API Name
-
kms_heap_size
- Required
- true
Additional Java Configuration Options for KMS
- Description
- 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.
- Related Name
-
kms_java_opts
- Default Value
- API Name
-
kms_java_opts
- Required
- false
KMS Max Threads
- Description
- Maximum number of threads used to handle KMS requests.
- Related Name
-
hadoop.http.max.threads
- Default Value
- 250
- API Name
-
kms_max_threads
- Required
- false
Performance
Maximum Process File Descriptors
- Description
- If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
- Related Name
- Default Value
- API Name
-
rlimit_fds
- Required
- false
Ports and Addresses
KMS HTTP Port
- Description
- Port used by clients to interact with the KMS.
- Related Name
-
hadoop.kms.http.port
- Default Value
- 16000
- API Name
-
kms_http_port
- Required
- true
Resource Management
Cgroup CPU Shares
- Description
- Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
- Related Name
-
cpu.shares
- Default Value
- 1024
- API Name
-
rm_cpu_shares
- Required
- true
Custom Control Group Resources (overrides Cgroup settings)
- Description
- Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
- Related Name
-
custom.cgroups
- Default Value
- API Name
-
rm_custom_resources
- Required
- false
Cgroup I/O Weight
- Description
- Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
- Related Name
-
blkio.weight
- Default Value
- 500
- API Name
-
rm_io_weight
- Required
- true
Cgroup Memory Hard Limit
- Description
- Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_hard_limit
- Required
- true
Cgroup Memory Soft Limit
- Description
- Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
- Related Name
-
memory.soft_limit_in_bytes
- Default Value
- -1 MiB
- API Name
-
rm_memory_soft_limit
- Required
- true
Security
Key Management Server Proxy TLS/SSL Trust Store File
- Description
- The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Key Management Server Proxy might connect to. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
- Related Name
-
ssl.truststore.location
- Default Value
- API Name
-
ssl_client_truststore_location
- Required
- false
Key Management Server Proxy TLS/SSL Trust Store Password
- Description
- The password for the Key Management Server Proxy TLS/SSL Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information.
- Related Name
-
ssl.truststore.password.generator
- Default Value
- API Name
-
ssl_client_truststore_password
- Required
- false
Enable TLS/SSL for Key Management Server Proxy
- Description
- Encrypt communication between clients and Key Management Server Proxy using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
- Related Name
-
hadoop.kms.ssl.enabled
- Default Value
- false
- API Name
-
ssl_enabled
- Required
- false
Key Management Server Proxy TLS/SSL Server Keystore Key Password
- Description
- The password that protects the private key contained in the keystore used when Key Management Server Proxy is acting as a TLS/SSL server.
- Related Name
-
ssl.server.keystore.keypassword
- Default Value
- API Name
-
ssl_server_keystore_keypassword
- Required
- false
Key Management Server Proxy TLS/SSL Server Keystore File Location
- Description
- The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Key Management Server Proxy is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
- Related Name
-
ssl.server.keystore.location
- Default Value
- API Name
-
ssl_server_keystore_location
- Required
- false
Key Management Server Proxy TLS/SSL Server Keystore File Password
- Description
- The password for the Key Management Server Proxy keystore file.
- Related Name
-
ssl.server.keystore.password
- Default Value
- API Name
-
ssl_server_keystore_password
- Required
- false
Stacks Collection
Stacks Collection Data Retention
- Description
- The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
- Related Name
-
stacks_collection_data_retention
- Default Value
- 100 MiB
- API Name
-
stacks_collection_data_retention
- Required
- false
Stacks Collection Directory
- Description
- The directory in which stacks logs are placed. If not set, stacks are logged into a
stacks
subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race. - Related Name
-
stacks_collection_directory
- Default Value
- API Name
-
stacks_collection_directory
- Required
- false
Stacks Collection Enabled
- Description
- Whether or not periodic stacks collection is enabled.
- Related Name
-
stacks_collection_enabled
- Default Value
- false
- API Name
-
stacks_collection_enabled
- Required
- true
Stacks Collection Frequency
- Description
- The frequency with which stacks are collected.
- Related Name
-
stacks_collection_frequency
- Default Value
- 5.0 second(s)
- API Name
-
stacks_collection_frequency
- Required
- false
Stacks Collection Method
- Description
- The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
- Related Name
-
stacks_collection_method
- Default Value
- jstack
- API Name
-
stacks_collection_method
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Parameter Validation: Key Trustee Server Auth Code
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Auth Code parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cloudera_trustee_keyprovider_auth
- Required
- true
Suppress Parameter Validation: Active Key Trustee Server
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cloudera_trustee_keyprovider_hostname-active
- Required
- true
Suppress Parameter Validation: Passive Key Trustee Server
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cloudera_trustee_keyprovider_hostname-passive
- Required
- true
Suppress Parameter Validation: Key Trustee Server Org Name
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Org Name parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cloudera_trustee_keyprovider_org
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for core-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_core-site.xml_role_safety_valve
- Required
- true
Suppress Parameter Validation: Flume Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Flume Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_flume_groups
- Required
- true
Suppress Parameter Validation: Flume Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Flume Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_flume_hosts
- Required
- true
Suppress Parameter Validation: HDFS Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hdfs_groups
- Required
- true
Suppress Parameter Validation: HDFS Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hdfs_hosts
- Required
- true
Suppress Parameter Validation: Hive Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hive_groups
- Required
- true
Suppress Parameter Validation: Hive Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Hive Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hive_hosts
- Required
- true
Suppress Parameter Validation: HTTP Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_http_groups
- Required
- true
Suppress Parameter Validation: HTTP Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HTTP Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_http_hosts
- Required
- true
Suppress Parameter Validation: HttpFS Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_httpfs_groups
- Required
- true
Suppress Parameter Validation: HttpFS Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the HttpFS Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_httpfs_hosts
- Required
- true
Suppress Parameter Validation: Hue Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hue_groups
- Required
- true
Suppress Parameter Validation: Hue Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Hue Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hue_hosts
- Required
- true
Suppress Parameter Validation: Mapred Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Mapred Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_mapred_groups
- Required
- true
Suppress Parameter Validation: Mapred Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Mapred Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_mapred_hosts
- Required
- true
Suppress Parameter Validation: Oozie Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_oozie_groups
- Required
- true
Suppress Parameter Validation: Oozie Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Oozie Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_oozie_hosts
- Required
- true
Suppress Parameter Validation: YARN Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Proxy User Groups parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_yarn_groups
- Required
- true
Suppress Parameter Validation: YARN Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the YARN Proxy User Hosts parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_yarn_hosts
- Required
- true
Suppress Parameter Validation: Key Trustee KeyStoreProvider Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee KeyStoreProvider Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_security_key_provider_dir
- Required
- true
Suppress Parameter Validation: Key Trustee KeyStoreProvider Configuration Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee KeyStoreProvider Configuration Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_keytrustee_security_key_provider_conf_dir
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-acls.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-acls.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms-acls.xml_role_safety_valve
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms-site.xml_role_safety_valve
- Required
- true
Suppress Parameter Validation: KMS Blacklist Users
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the KMS Blacklist Users parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms_blacklist_users
- Required
- true
Suppress Parameter Validation: KMS HTTP Port
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the KMS HTTP Port parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms_http_port
- Required
- true
Suppress Parameter Validation: Additional Java Configuration Options for KMS
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Additional Java Configuration Options for KMS parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms_java_opts
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms_keytrustee_role_env_safety_valve
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kts-site.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kts-site.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kts-site.xml_role_safety_valve
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy Logging Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy Log Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy Log Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log_dir
- Required
- true
Suppress Parameter Validation: Heap Dump Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_oom_heap_dump_dir
- Required
- true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_rm_custom_resources
- Required
- true
Suppress Parameter Validation: Role Triggers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_role_triggers
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for ssl-server.xml
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for ssl-server.xml parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl-server.xml_role_safety_valve
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy TLS/SSL Trust Store File
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy TLS/SSL Trust Store File parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_client_truststore_location
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy TLS/SSL Trust Store Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy TLS/SSL Trust Store Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_client_truststore_password
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy TLS/SSL Server Keystore Key Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy TLS/SSL Server Keystore Key Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_server_keystore_keypassword
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy TLS/SSL Server Keystore File Location parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_server_keystore_location
- Required
- true
Suppress Parameter Validation: Key Management Server Proxy TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Management Server Proxy TLS/SSL Server Keystore File Password parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_server_keystore_password
- Required
- true
Suppress Parameter Validation: Stacks Collection Directory
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_stacks_collection_directory
- Required
- true
Suppress Health Test: Audit Pipeline Test
- Description
- Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_keytrustee_kms_keytrustee_audit_health
- Required
- true
Suppress Health Test: File Descriptors
- Description
- Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_keytrustee_kms_keytrustee_file_descriptor
- Required
- true
Suppress Health Test: Host Health
- Description
- Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_keytrustee_kms_keytrustee_host_health
- Required
- true
Suppress Health Test: Log Directory Free Space
- Description
- Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_keytrustee_kms_keytrustee_log_directory_free_space
- Required
- true
Suppress Health Test: Process Status
- Description
- Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_keytrustee_kms_keytrustee_scm_health
- Required
- true
Suppress Health Test: Swap Memory Usage
- Description
- Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_keytrustee_kms_keytrustee_swap_memory_usage
- Required
- true
Suppress Health Test: Swap Memory Usage Rate Beta
- Description
- Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_keytrustee_kms_keytrustee_swap_memory_usage_rate
- Required
- true
Suppress Health Test: Unexpected Exits
- Description
- Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
- Related Name
- Default Value
- false
- API Name
-
role_health_suppression_keytrustee_kms_keytrustee_unexpected_exits
- Required
- true
Service-Wide
Advanced
Key Trustee KMS Service Environment Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration.
- Related Name
- Default Value
- API Name
-
KEYTRUSTEE_service_env_safety_valve
- Required
- false
System Group
- Description
- The group that this service's processes should run as.
- Related Name
- Default Value
- kms
- API Name
-
process_groupname
- Required
- true
System User
- Description
- The user that this service's processes should run as.
- Related Name
- Default Value
- kms
- API Name
-
process_username
- Required
- true
Monitoring
Enable Service Level Health Alerts
- Description
- When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
- Related Name
- Default Value
- true
- API Name
-
enable_alerts
- Required
- false
Enable Configuration Change Alerts
- Description
- When set, Cloudera Manager will send alerts when this entity's configuration changes.
- Related Name
- Default Value
- false
- API Name
-
enable_config_alerts
- Required
- false
Service Triggers
- Description
- The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
triggerName
(mandatory) - The name of the trigger. This value must be unique for the specific service.triggerExpression
(mandatory) - A tsquery expression representing the trigger.streamThreshold
(optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.enabled
(optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.expressionEditorConfig
(optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]
See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. - Related Name
- Default Value
- []
- API Name
-
service_triggers
- Required
- true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)
- Description
- For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
- Related Name
- Default Value
- API Name
-
smon_derived_configs_safety_valve
- Required
- false
Other
ZooKeeper Authentication Type for Secret Signer
- Description
- ZooKeeper Authentication for Secret Signer. Can be either "none" or "sasl"
- Related Name
-
hadoop.kms.authentication.signer.secret.provider.zookeeper.auth.type
- Default Value
- none
- API Name
-
hadoop_kms_authentication_signer_secret_provider_zookeeper_auth_type
- Required
- true
Authentication Secret Signer ZooKeeper Path
- Description
- Authentication Secret Signer ZooKeeper path. Is required to be set for KMS High Availability deployments
- Related Name
-
hadoop.kms.authentication.signer.secret.provider.zookeeper.path
- Default Value
- /kmsZKRoot
- API Name
-
hadoop_kms_authentication_signer_secret_provider_zookeeper_path
- Required
- true
Authentication Type
- Description
- Authentication type for the KMS. Can either be "simple" or "kerberos".
- Related Name
-
hadoop.kms.authentication.type
- Default Value
- simple
- API Name
-
hadoop_kms_authentication_type
- Required
- true
KMS Load Balancer
- Description
- Key Management Store Load Balancer, used with multiple KMS roles (KMS high availability). In CDH 5.4 and higher, this Key Trustee KMS service typically has the ZooKeeper dependency set, and this property is left blank. In this case, the ZooKeeper-based high availability URL is automatically generated for clients. To use an external load balancer, specify the URL to that load balancer. When using the ZooKeeper-based load balancer, all KMS roles must listen on the same port.
- Related Name
-
kms_load_balancer
- Default Value
- API Name
-
kms_load_balancer
- Required
- false
ZooKeeper Service
- Description
- Name of the ZooKeeper service that this Key Trustee KMS service instance depends on
- Related Name
- Default Value
- API Name
-
zookeeper_service
- Required
- false
Suppressions
Suppress Configuration Validator: CDH Version Validator
- Description
- Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cdh_version_validator
- Required
- true
Suppress Configuration Validator: Key Trustee Server Auth Code
- Description
- Whether to suppress configuration warnings produced by the Key Trustee Server Auth Code configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cloudera_trustee_keyprovider_auth
- Required
- true
Suppress Configuration Validator: Active Key Trustee Server
- Description
- Whether to suppress configuration warnings produced by the Active Key Trustee Server configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cloudera_trustee_keyprovider_hostname-active
- Required
- true
Suppress Configuration Validator: Passive Key Trustee Server
- Description
- Whether to suppress configuration warnings produced by the Passive Key Trustee Server configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cloudera_trustee_keyprovider_hostname-passive
- Required
- true
Suppress Configuration Validator: Key Trustee Server Org Name
- Description
- Whether to suppress configuration warnings produced by the Key Trustee Server Org Name configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_cloudera_trustee_keyprovider_org
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for core-site.xml
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for core-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_core-site.xml_role_safety_valve
- Required
- true
Suppress Configuration Validator: Flume Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the Flume Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_flume_groups
- Required
- true
Suppress Configuration Validator: Flume Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the Flume Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_flume_hosts
- Required
- true
Suppress Configuration Validator: HDFS Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the HDFS Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hdfs_groups
- Required
- true
Suppress Configuration Validator: HDFS Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the HDFS Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hdfs_hosts
- Required
- true
Suppress Configuration Validator: Hive Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the Hive Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hive_groups
- Required
- true
Suppress Configuration Validator: Hive Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the Hive Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hive_hosts
- Required
- true
Suppress Configuration Validator: HTTP Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the HTTP Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_http_groups
- Required
- true
Suppress Configuration Validator: HTTP Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the HTTP Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_http_hosts
- Required
- true
Suppress Configuration Validator: HttpFS Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the HttpFS Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_httpfs_groups
- Required
- true
Suppress Configuration Validator: HttpFS Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the HttpFS Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_httpfs_hosts
- Required
- true
Suppress Configuration Validator: Hue Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the Hue Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hue_groups
- Required
- true
Suppress Configuration Validator: Hue Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the Hue Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_hue_hosts
- Required
- true
Suppress Configuration Validator: Mapred Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the Mapred Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_mapred_groups
- Required
- true
Suppress Configuration Validator: Mapred Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the Mapred Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_mapred_hosts
- Required
- true
Suppress Configuration Validator: Oozie Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the Oozie Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_oozie_groups
- Required
- true
Suppress Configuration Validator: Oozie Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the Oozie Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_oozie_hosts
- Required
- true
Suppress Configuration Validator: YARN Proxy User Groups
- Description
- Whether to suppress configuration warnings produced by the YARN Proxy User Groups configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_yarn_groups
- Required
- true
Suppress Configuration Validator: YARN Proxy User Hosts
- Description
- Whether to suppress configuration warnings produced by the YARN Proxy User Hosts configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_kms_proxyuser_yarn_hosts
- Required
- true
Suppress Configuration Validator: Key Trustee KeyStoreProvider Directory
- Description
- Whether to suppress configuration warnings produced by the Key Trustee KeyStoreProvider Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_hadoop_security_key_provider_dir
- Required
- true
Suppress Configuration Validator: Key Trustee KeyStoreProvider Configuration Directory
- Description
- Whether to suppress configuration warnings produced by the Key Trustee KeyStoreProvider Configuration Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_keytrustee_security_key_provider_conf_dir
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-acls.xml
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-acls.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms-acls.xml_role_safety_valve
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-site.xml
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kms-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms-site.xml_role_safety_valve
- Required
- true
Suppress Configuration Validator: KMS Blacklist Users
- Description
- Whether to suppress configuration warnings produced by the KMS Blacklist Users configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms_blacklist_users
- Required
- true
Suppress Configuration Validator: KMS HTTP Port
- Description
- Whether to suppress configuration warnings produced by the KMS HTTP Port configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms_http_port
- Required
- true
Suppress Configuration Validator: Additional Java Configuration Options for KMS
- Description
- Whether to suppress configuration warnings produced by the Additional Java Configuration Options for KMS configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms_java_opts
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kms_keytrustee_role_env_safety_valve
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kts-site.xml
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for kts-site.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_kts-site.xml_role_safety_valve
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Logging Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Logging Advanced Configuration Snippet (Safety Valve) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log4j_safety_valve
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Log Directory
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Log Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_log_dir
- Required
- true
Suppress Configuration Validator: Heap Dump Directory
- Description
- Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_oom_heap_dump_dir
- Required
- true
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)
- Description
- Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_rm_custom_resources
- Required
- true
Suppress Configuration Validator: Role Triggers
- Description
- Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_role_triggers
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for ssl-server.xml
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Advanced Configuration Snippet (Safety Valve) for ssl-server.xml configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl-server.xml_role_safety_valve
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy TLS/SSL Trust Store File
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy TLS/SSL Trust Store File configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_client_truststore_location
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy TLS/SSL Trust Store Password
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy TLS/SSL Trust Store Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_client_truststore_password
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy TLS/SSL Server Keystore Key Password
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy TLS/SSL Server Keystore Key Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_server_keystore_keypassword
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy TLS/SSL Server Keystore File Location
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy TLS/SSL Server Keystore File Location configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_server_keystore_location
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy TLS/SSL Server Keystore File Password
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy TLS/SSL Server Keystore File Password configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_ssl_server_keystore_password
- Required
- true
Suppress Configuration Validator: Stacks Collection Directory
- Description
- Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
- Related Name
- Default Value
- false
- API Name
-
role_config_suppression_stacks_collection_directory
- Required
- true
Suppress Parameter Validation: Authentication Secret Signer ZooKeeper Path
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Authentication Secret Signer ZooKeeper Path parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_hadoop_kms_authentication_signer_secret_provider_zookeeper_path
- Required
- true
Suppress Parameter Validation: Key Trustee KMS Service Environment Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee KMS Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_keytrustee_service_env_safety_valve
- Required
- true
Suppress Configuration Validator: Key Management Server Proxy Count Validator
- Description
- Whether to suppress configuration warnings produced by the Key Management Server Proxy Count Validator configuration validator.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_kms_keytrustee_count_validator
- Required
- true
Suppress Parameter Validation: KMS Load Balancer
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the KMS Load Balancer parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_kms_load_balancer
- Required
- true
Suppress Parameter Validation: System Group
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_process_groupname
- Required
- true
Suppress Parameter Validation: System User
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_process_username
- Required
- true
Suppress Parameter Validation: Service Triggers
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_service_triggers
- Required
- true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)
- Description
- Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
- Related Name
- Default Value
- false
- API Name
-
service_config_suppression_smon_derived_configs_safety_valve
- Required
- true