Ranger KMS with Key Trustee Server Properties in Cloudera Runtime 7.2.0

Role groups:

Ranger KMS Server with KTS

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml For advanced use only. A string to be inserted into conf/core-site.xml for this role only. conf/core-site.xml_role_safety_valve false
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml For advanced use only. A string to be inserted into conf/dbks-site.xml for this role only. conf/dbks-site.xml_role_safety_valve false
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml For advanced use only. A string to be inserted into conf/hdfs-site.xml for this role only. conf/hdfs-site.xml_role_safety_valve false
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml For advanced use only. A string to be inserted into conf/kms-site.xml for this role only. conf/kms-site.xml_role_safety_valve false
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kts-site.xml For advanced use only. A string to be inserted into conf/kts-site.xml for this role only. conf/kts-site.xml_role_safety_valve false
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml For advanced use only. A string to be inserted into conf/ranger-kms-audit.xml for this role only. conf/ranger-kms-audit.xml_role_safety_valve false
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml For advanced use only. A string to be inserted into conf/ranger-kms-policymgr-ssl.xml for this role only. conf/ranger-kms-policymgr-ssl.xml_role_safety_valve false
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml For advanced use only. A string to be inserted into conf/ranger-kms-security.xml for this role only. conf/ranger-kms-security.xml_role_safety_valve false
Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml For advanced use only. A string to be inserted into conf/ranger-kms-site.xml for this role only. conf/ranger-kms-site.xml_role_safety_valve false
Ranger KMS Server with KTS 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
Ranger KMS Server with KTS 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. RANGER_KMS_SERVER_KTS_role_env_safety_valve false

Logs

Display Name Description Related Name Default Value API Name Required
Ranger KMS Server with KTS Log Directory The log directory for log files of the role Ranger KMS Server with KTS. log_dir /var/log/ranger/kms log_dir false
Ranger KMS Server with KTS Logging Threshold The minimum log level for Ranger KMS Server with KTS logs INFO log_threshold false
Ranger KMS Server with KTS Maximum Log File Backups The maximum number of rolled log files to keep for Ranger KMS Server with KTS logs. Typically used by log4j or logback. 10 max_log_backup_index false
Ranger KMS Server with KTS Max Log Size The maximum size, in megabytes, per log file for Ranger KMS Server with KTS logs. Typically used by log4j or logback. 200 MiB max_log_size false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
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:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
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
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 % ranger_kms_server_kts_fd_thresholds false
Ranger KMS Server with KTS Host Health Test When computing the overall Ranger KMS Server with KTS health, consider the host's health. true ranger_kms_server_kts_host_health_enabled false
Ranger KMS Server with KTS Process Health Test Enables the health test that the Ranger KMS Server with KTS's process state is consistent with the role configuration true ranger_kms_server_kts_scm_health_enabled 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 (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Key Trustee Server Auth Code Key Trustee Server auth code used for KMS to authenticate against the server cloudera.trustee.keyprovider.auth cloudera_trustee_keyprovider_auth true
Active Key Trustee Server Active Key Trustee Server hostname that backs the KMS. cloudera.trustee.keyprovider.hostname-ACTIVE cloudera_trustee_keyprovider_hostname-ACTIVE true
Passive Key Trustee Server Passive Key Trustee Server hostname that backs the KMS. Only needed for Key Trustee Server high availability. cloudera.trustee.keyprovider.hostname-PASSIVE cloudera_trustee_keyprovider_hostname-PASSIVE false
Key Trustee Server Org Name Key Trustee Server Organization that keys are stored against. cloudera.trustee.keyprovider.org cloudera_trustee_keyprovider_org true
Key Trustee Server Key Provider Pool Timeout Key Trustee key provider pool timeout. cloudera.trustee.keyprovider.pool.abandoned.timeout 5 minute(s) cloudera_trustee_keyprovider_pool_abandoned_timeout true
Key Trustee Server Key Provider Max Connections Key Trustee Server Key Provider Max Connections. cloudera.trustee.keyprovider.pool.max 5 cloudera_trustee_keyprovider_pool_max true
Key Trustee Server Key Provider Pool Max Idle Key Trustee Server Key Provider Pool Max Idle. cloudera.trustee.keyprovider.pool.max.idle 2 cloudera_trustee_keyprovider_pool_max_idle true
Key Trustee Server Key Provider Pool Min Idle Key Trustee Server Key Provider Pool Min Idle. cloudera.trustee.keyprovider.pool.min.idle 1 cloudera_trustee_keyprovider_pool_min_idle true
Key Trustee Server Round Robin Reads Distribute read requests amongst the available Key Trustee Servers. Only effective when a passive server is specified. cloudera.trustee.keyprovider.roundrobin true cloudera_trustee_keyprovider_roundrobin false
Ranger KMS Server with KTS Diagnostics Collection Timeout The timeout in milliseconds to wait for diagnostics collection to complete. 5 minute(s) csd_role_diagnostics_timeout false
Graceful Shutdown Timeout The timeout in milliseconds to wait for graceful shutdown to complete. 18 second(s) graceful_stop_timeout false
Hadoop KMS Audit Aggregation Window Duplicate audit log events within the aggregation window (specified in ms) are quashed to reduce log traffic. A single message for aggregated events is printed at the end of the window, along with a count of the number of aggregated events. hadoop.kms.audit.aggregation.window.ms 10 second(s) hadoop_kms_audit_aggregation_window_ms false
Hadoop KMS Authentication Signer Secret Provider Zookeeper Auth Type The Zookeeper authentication type, 'none' or kerberos. hadoop.kms.authentication.signer.secret.provider.zookeeper.auth.type none hadoop_kms_authentication_signer_secret_provider_zookeeper_auth_type true
Hadoop KMS Authentication Signer Secret Provider Zookeeper Path The Zookeeper ZNode path where the KMS instances will store and retrieve the secret from. hadoop.kms.authentication.signer.secret.provider.zookeeper.path /hadoop-kms/hadoop-auth-signature-secret hadoop_kms_authentication_signer_secret_provider_zookeeper_path true
Hadoop KMS Blacklist Decrypt EEK Add user which is needed to be blacklist for decrypt EncryptedKey CryptoExtension operations. Multiple list os user's can be added with comma separated. hadoop.kms.blacklist.DECRYPT_EEK hdfs hadoop_kms_blacklist_decrypt_eek false
Hadoop KMS Cache Enable Whether the KMS will act as a cache for the backing KeyProvider. When the cache is enabled, operations like getKeyVersion, getMetadata, and getCurrentKey will sometimes return cached data without consulting the backing KeyProvider. Cached values are flushed when keys are deleted or modified. hadoop.kms.cache.enable true hadoop_kms_cache_enable false
Hadoop Kms Cache Timeout Expiry time for the KMS key version and key metadata cache, in milliseconds. This affects getKeyVersion and getMetadata. hadoop.kms.cache.timeout.ms 10 minute(s) hadoop_kms_cache_timeout_ms false
Hadoop KMS Current Key Cache Timeout Expiry time for the KMS current key cache, in milliseconds. This affects getCurrentKey operations. hadoop.kms.current.key.cache.timeout.ms 30 second(s) hadoop_kms_current_key_cache_timeout_ms 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
Livy Proxy User Groups Allows the livy 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.livy.groups * hadoop_kms_proxyuser_livy_groups false
Livy Proxy User Hosts Comma-delimited list of hosts where you want to allow the livy 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.livy.hosts * hadoop_kms_proxyuser_livy_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
Ranger Proxy User Groups Allows the ranger 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.ranger.groups * hadoop_kms_proxyuser_ranger_groups false
Ranger Proxy User Hosts Comma-delimited list of hosts where you want to allow the ranger 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.ranger.hosts * hadoop_kms_proxyuser_ranger_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
Zeppelin Proxy User Groups Allows the zeppelin 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.zeppelin.groups * hadoop_kms_proxyuser_zeppelin_groups false
Zeppelin Proxy User Hosts Comma-delimited list of hosts where you want to allow the zeppelin 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.zeppelin.hosts * hadoop_kms_proxyuser_zeppelin_hosts false
Key Trustee KeyStoreProvider Directory Directory to the keystore file used by Key Trustee KeyStoreProvider that backs the KMS. hadoop.kms.key.provider.uri /var/lib/kms-keytrustee hadoop_security_key_provider_dir true
Hadoop Security Keystore JavaKeyStoreProvider Password If using the JavaKeyStoreProvider, the password for the keystore file. hadoop.security.keystore.JavaKeyStoreProvider.password hadoop_security_keystore_javakeystoreprovider_password false
Key Trustee KeyStoreProvider Configuration Directory Directory to store configuration of keystore file used by Key Trustee KeyStoreProvider that backs the KMS. keytrustee.kms.key.provider.conf.uri /var/lib/kms-keytrustee/keytrustee keytrustee_security_key_provider_conf_dir 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
Ranger KMS Max Heapsize Maximum size for the Java Process heap. Passed to Java -Xmx. Measured in megabytes. ranger_kms_max_heap_size 1 GiB ranger_kms_max_heap_size true
Ranger KMS Plugin Audit Hdfs Spool Directory Path Spool directory for Ranger audits being written to DFS. xasecure.audit.destination.hdfs.batch.filespool.dir /var/log/kms/audit/hdfs/spool ranger_kms_plugin_hdfs_audit_spool_directory true
Ranger KMS Plugin Policy Cache Directory Path The directory where Ranger security policies are cached locally. ranger.plugin.kms.policy.cache.dir /var/lib/ranger/kms/policy-cache ranger_kms_plugin_policy_cache_directory true
Ranger KMS Plugin Audit Solr Spool Directory Path Spool directory for Ranger audits being written to Solr. xasecure.audit.destination.solr.batch.filespool.dir /var/log/kms/audit/solr/spool ranger_kms_plugin_solr_audit_spool_directory true
Ranger KMS Tomcat Work Dir Tomcat work directory for Ranger KMS. This should generally not be changed. ranger_kms_tomcat_work_dir /var/lib/ranger/kms ranger_kms_tomcat_work_dir true
Ranger Plugin Trusted Proxy IP Address Accepts a list of IP addresses of proxy servers for trusting. ranger.plugin.kms.trusted.proxy.ipaddress ranger_plugin_trusted_proxy_ipaddress false
Ranger Plugin Use X-Forwarded For IP Address The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs. ranger.plugin.kms.use.x-forwarded-for.ipaddress false ranger_plugin_use_x_forwarded_for_ipaddress false

Performance

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

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Ranger KMS HTTP Port HTTP Port for Ranger KMS. ranger.service.http.port 9292 ranger_kms_http_port false
Ranger KMS HTTPS Port HTTPS Port for Ranger KMS. Only used when SSL is enabled for Ranger KMS. ranger.service.https.port 9494 ranger_kms_https_port false

Resource Management

Display Name Description Related Name Default Value API Name Required
Cgroup CPU Shares Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager. cpu.shares 1024 rm_cpu_shares true
Custom Control Group Resources (overrides Cgroup settings) Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.*** custom.cgroups rm_custom_resources false
Cgroup I/O Weight Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager. blkio.weight 500 rm_io_weight true
Cgroup Memory Hard Limit Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.limit_in_bytes -1 MiB rm_memory_hard_limit true
Cgroup Memory Soft Limit Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data' memory.soft_limit_in_bytes -1 MiB rm_memory_soft_limit true

Security

Display Name Description Related Name Default Value API Name Required
Ranger KMS Server with KTS TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Ranger KMS Server with KTS might connect to. This is used when Ranger KMS Server with KTS is the client in a TLS/SSL connection. 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. xasecure.policymgr.clientssl.truststore ssl_client_truststore_location false
Ranger KMS Server with KTS TLS/SSL Client Trust Store Password The password for the Ranger KMS Server with KTS TLS/SSL Certificate 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. xasecure.policymgr.clientssl.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Ranger KMS Server with KTS Encrypt communication between clients and Ranger KMS Server with KTS using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). ranger.service.https.attrib.ssl.enabled false ssl_enabled false
Ranger KMS Server with KTS 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 Ranger KMS Server with KTS is acting as a TLS/SSL server. The keystore must be in JKS format. ranger.service.https.attrib.keystore.file ssl_server_keystore_location false
Ranger KMS Server with KTS TLS/SSL Server JKS Keystore File Password The password for the Ranger KMS Server with KTS JKS keystore file. ranger.service.https.attrib.keystore.pass ssl_server_keystore_password false

Stacks Collection

Display Name Description Related 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 Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Key Trustee Server Auth Code Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Auth Code parameter. false role_config_suppression_cloudera_trustee_keyprovider_auth true
Suppress Parameter Validation: Active Key Trustee Server Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Key Trustee Server parameter. false role_config_suppression_cloudera_trustee_keyprovider_hostname-active true
Suppress Parameter Validation: Passive Key Trustee Server Whether to suppress configuration warnings produced by the built-in parameter validation for the Passive Key Trustee Server parameter. false role_config_suppression_cloudera_trustee_keyprovider_hostname-passive true
Suppress Parameter Validation: Key Trustee Server Org Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee Server Org Name parameter. false role_config_suppression_cloudera_trustee_keyprovider_org true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml parameter. false role_config_suppression_conf/core-site.xml_role_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml parameter. false role_config_suppression_conf/dbks-site.xml_role_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml parameter. false role_config_suppression_conf/hdfs-site.xml_role_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml parameter. false role_config_suppression_conf/kms-site.xml_role_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kts-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kts-site.xml parameter. false role_config_suppression_conf/kts-site.xml_role_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml parameter. false role_config_suppression_conf/ranger-kms-audit.xml_role_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml parameter. false role_config_suppression_conf/ranger-kms-policymgr-ssl.xml_role_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml parameter. false role_config_suppression_conf/ranger-kms-security.xml_role_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml parameter. false role_config_suppression_conf/ranger-kms-site.xml_role_safety_valve true
Suppress Parameter Validation: Hadoop KMS Authentication Signer Secret Provider Zookeeper Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop KMS Authentication Signer Secret Provider Zookeeper Path parameter. false role_config_suppression_hadoop_kms_authentication_signer_secret_provider_zookeeper_path true
Suppress Parameter Validation: Hadoop KMS Blacklist Decrypt EEK Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop KMS Blacklist Decrypt EEK parameter. false role_config_suppression_hadoop_kms_blacklist_decrypt_eek 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: Livy Proxy User Groups Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Proxy User Groups parameter. false role_config_suppression_hadoop_kms_proxyuser_livy_groups true
Suppress Parameter Validation: Livy Proxy User Hosts Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Proxy User Hosts parameter. false role_config_suppression_hadoop_kms_proxyuser_livy_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: Ranger Proxy User Groups Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Proxy User Groups parameter. false role_config_suppression_hadoop_kms_proxyuser_ranger_groups true
Suppress Parameter Validation: Ranger Proxy User Hosts Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Proxy User Hosts parameter. false role_config_suppression_hadoop_kms_proxyuser_ranger_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: Zeppelin Proxy User Groups Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Proxy User Groups parameter. false role_config_suppression_hadoop_kms_proxyuser_zeppelin_groups true
Suppress Parameter Validation: Zeppelin Proxy User Hosts Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Proxy User Hosts parameter. false role_config_suppression_hadoop_kms_proxyuser_zeppelin_hosts true
Suppress Parameter Validation: Key Trustee KeyStoreProvider Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee KeyStoreProvider Directory parameter. false role_config_suppression_hadoop_security_key_provider_dir true
Suppress Parameter Validation: Hadoop Security Keystore JavaKeyStoreProvider Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop Security Keystore JavaKeyStoreProvider Password parameter. false role_config_suppression_hadoop_security_keystore_javakeystoreprovider_password true
Suppress Parameter Validation: Key Trustee KeyStoreProvider Configuration Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Key Trustee KeyStoreProvider Configuration Directory parameter. false role_config_suppression_keytrustee_security_key_provider_conf_dir 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: Ranger KMS Server with KTS Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Ranger KMS Server with KTS Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS 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: Ranger KMS HTTP Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS HTTP Port parameter. false role_config_suppression_ranger_kms_http_port true
Suppress Parameter Validation: Ranger KMS HTTPS Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS HTTPS Port parameter. false role_config_suppression_ranger_kms_https_port true
Suppress Parameter Validation: Ranger KMS Max Heapsize Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Max Heapsize parameter. false role_config_suppression_ranger_kms_max_heap_size true
Suppress Parameter Validation: Ranger KMS Plugin Audit Hdfs Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Plugin Audit Hdfs Spool Directory Path parameter. false role_config_suppression_ranger_kms_plugin_hdfs_audit_spool_directory true
Suppress Parameter Validation: Ranger KMS Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Plugin Policy Cache Directory Path parameter. false role_config_suppression_ranger_kms_plugin_policy_cache_directory true
Suppress Parameter Validation: Ranger KMS Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Plugin Audit Solr Spool Directory Path parameter. false role_config_suppression_ranger_kms_plugin_solr_audit_spool_directory true
Suppress Parameter Validation: Ranger KMS Server with KTS Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_ranger_kms_server_kts_role_env_safety_valve true
Suppress Parameter Validation: Ranger KMS Tomcat Work Dir Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Tomcat Work Dir parameter. false role_config_suppression_ranger_kms_tomcat_work_dir true
Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter. false role_config_suppression_ranger_plugin_trusted_proxy_ipaddress 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: Ranger KMS Server with KTS TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Ranger KMS Server with KTS TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Ranger KMS Server with KTS TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Ranger KMS Server with KTS TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server with KTS 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_ranger_kms_kts_ranger_kms_server_kts_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_ranger_kms_kts_ranger_kms_server_kts_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_ranger_kms_kts_ranger_kms_server_kts_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_ranger_kms_kts_ranger_kms_server_kts_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_ranger_kms_kts_ranger_kms_server_kts_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_ranger_kms_kts_ranger_kms_server_kts_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_ranger_kms_kts_ranger_kms_server_kts_unexpected_exits true

Service-Wide

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
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
Ranger KMS with Key Trustee Server Service Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration. RANGER_KMS_KTS_service_env_safety_valve false

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Service Level Health Alerts When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Healthy Ranger KMS Server with KTS Monitoring Thresholds The health test thresholds of the overall Ranger KMS Server with KTS health. The check returns "Concerning" health if the percentage of "Healthy" Ranger KMS Server with KTSs falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Ranger KMS Server with KTSs falls below the critical threshold. Warning: 99.0 %, Critical: 49.0 % RANGER_KMS_KTS_RANGER_KMS_SERVER_KTS_healthy_thresholds 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 (mandatory) - The name of the trigger. This value must be unique for the specific service.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] service_triggers true
Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. smon_derived_configs_safety_valve false

Other

Display Name Description Related Name Default Value API Name Required
Ranger KMS Authentication Type Authentication type for the Ranger KMS. hadoop.kms.authentication.type kerberos hadoop_kms_authentication_type true
Ranger KMS Load Balancer Only required when Ranger KMS is running with High Availability. ranger_kms_load_balancer ranger_kms_load_balancer false
Ranger KMS Plugin Hdfs Audit Directory The DFS path on which Ranger audits are written. ranger_kms_plugin_hdfs_audit_directory $ranger_base_audit_url/kms ranger_kms_plugin_hdfs_audit_directory false
ZooKeeper Service Name of the ZooKeeper service that this Ranger KMS with Key Trustee Server service instance depends on zookeeper_service false

Security

Display Name Description Related Name Default Value API Name Required
Kerberos Principal Kerberos principal short name used by all roles of this service. rangerkms kerberos_princ_name true

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Configuration Validator: Key Trustee Server Auth Code Whether to suppress configuration warnings produced by the Key Trustee Server Auth Code configuration validator. false role_config_suppression_cloudera_trustee_keyprovider_auth true
Suppress Configuration Validator: Active Key Trustee Server Whether to suppress configuration warnings produced by the Active Key Trustee Server configuration validator. false role_config_suppression_cloudera_trustee_keyprovider_hostname-active true
Suppress Configuration Validator: Passive Key Trustee Server Whether to suppress configuration warnings produced by the Passive Key Trustee Server configuration validator. false role_config_suppression_cloudera_trustee_keyprovider_hostname-passive true
Suppress Configuration Validator: Key Trustee Server Org Name Whether to suppress configuration warnings produced by the Key Trustee Server Org Name configuration validator. false role_config_suppression_cloudera_trustee_keyprovider_org true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml configuration validator. false role_config_suppression_conf/core-site.xml_role_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml configuration validator. false role_config_suppression_conf/dbks-site.xml_role_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml configuration validator. false role_config_suppression_conf/hdfs-site.xml_role_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml configuration validator. false role_config_suppression_conf/kms-site.xml_role_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kts-site.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/kts-site.xml configuration validator. false role_config_suppression_conf/kts-site.xml_role_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml configuration validator. false role_config_suppression_conf/ranger-kms-audit.xml_role_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml configuration validator. false role_config_suppression_conf/ranger-kms-policymgr-ssl.xml_role_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml configuration validator. false role_config_suppression_conf/ranger-kms-security.xml_role_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml configuration validator. false role_config_suppression_conf/ranger-kms-site.xml_role_safety_valve true
Suppress Configuration Validator: Hadoop KMS Authentication Signer Secret Provider Zookeeper Path Whether to suppress configuration warnings produced by the Hadoop KMS Authentication Signer Secret Provider Zookeeper Path configuration validator. false role_config_suppression_hadoop_kms_authentication_signer_secret_provider_zookeeper_path true
Suppress Configuration Validator: Hadoop KMS Blacklist Decrypt EEK Whether to suppress configuration warnings produced by the Hadoop KMS Blacklist Decrypt EEK configuration validator. false role_config_suppression_hadoop_kms_blacklist_decrypt_eek 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: Livy Proxy User Groups Whether to suppress configuration warnings produced by the Livy Proxy User Groups configuration validator. false role_config_suppression_hadoop_kms_proxyuser_livy_groups true
Suppress Configuration Validator: Livy Proxy User Hosts Whether to suppress configuration warnings produced by the Livy Proxy User Hosts configuration validator. false role_config_suppression_hadoop_kms_proxyuser_livy_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: Ranger Proxy User Groups Whether to suppress configuration warnings produced by the Ranger Proxy User Groups configuration validator. false role_config_suppression_hadoop_kms_proxyuser_ranger_groups true
Suppress Configuration Validator: Ranger Proxy User Hosts Whether to suppress configuration warnings produced by the Ranger Proxy User Hosts configuration validator. false role_config_suppression_hadoop_kms_proxyuser_ranger_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: Zeppelin Proxy User Groups Whether to suppress configuration warnings produced by the Zeppelin Proxy User Groups configuration validator. false role_config_suppression_hadoop_kms_proxyuser_zeppelin_groups true
Suppress Configuration Validator: Zeppelin Proxy User Hosts Whether to suppress configuration warnings produced by the Zeppelin Proxy User Hosts configuration validator. false role_config_suppression_hadoop_kms_proxyuser_zeppelin_hosts true
Suppress Configuration Validator: Key Trustee KeyStoreProvider Directory Whether to suppress configuration warnings produced by the Key Trustee KeyStoreProvider Directory configuration validator. false role_config_suppression_hadoop_security_key_provider_dir true
Suppress Configuration Validator: Hadoop Security Keystore JavaKeyStoreProvider Password Whether to suppress configuration warnings produced by the Hadoop Security Keystore JavaKeyStoreProvider Password configuration validator. false role_config_suppression_hadoop_security_keystore_javakeystoreprovider_password true
Suppress Configuration Validator: Key Trustee KeyStoreProvider Configuration Directory Whether to suppress configuration warnings produced by the Key Trustee KeyStoreProvider Configuration Directory configuration validator. false role_config_suppression_keytrustee_security_key_provider_conf_dir 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: Ranger KMS Server with KTS Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Logging Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_log4j_safety_valve true
Suppress Configuration Validator: Ranger KMS Server with KTS Log Directory Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS 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: Ranger KMS HTTP Port Whether to suppress configuration warnings produced by the Ranger KMS HTTP Port configuration validator. false role_config_suppression_ranger_kms_http_port true
Suppress Configuration Validator: Ranger KMS HTTPS Port Whether to suppress configuration warnings produced by the Ranger KMS HTTPS Port configuration validator. false role_config_suppression_ranger_kms_https_port true
Suppress Configuration Validator: Ranger KMS Max Heapsize Whether to suppress configuration warnings produced by the Ranger KMS Max Heapsize configuration validator. false role_config_suppression_ranger_kms_max_heap_size true
Suppress Configuration Validator: Ranger KMS Plugin Audit Hdfs Spool Directory Path Whether to suppress configuration warnings produced by the Ranger KMS Plugin Audit Hdfs Spool Directory Path configuration validator. false role_config_suppression_ranger_kms_plugin_hdfs_audit_spool_directory true
Suppress Configuration Validator: Ranger KMS Plugin Policy Cache Directory Path Whether to suppress configuration warnings produced by the Ranger KMS Plugin Policy Cache Directory Path configuration validator. false role_config_suppression_ranger_kms_plugin_policy_cache_directory true
Suppress Configuration Validator: Ranger KMS Plugin Audit Solr Spool Directory Path Whether to suppress configuration warnings produced by the Ranger KMS Plugin Audit Solr Spool Directory Path configuration validator. false role_config_suppression_ranger_kms_plugin_solr_audit_spool_directory true
Suppress Configuration Validator: Ranger KMS Server with KTS Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_ranger_kms_server_kts_role_env_safety_valve true
Suppress Configuration Validator: Ranger KMS Tomcat Work Dir Whether to suppress configuration warnings produced by the Ranger KMS Tomcat Work Dir configuration validator. false role_config_suppression_ranger_kms_tomcat_work_dir true
Suppress Configuration Validator: Ranger Plugin Trusted Proxy IP Address Whether to suppress configuration warnings produced by the Ranger Plugin Trusted Proxy IP Address configuration validator. false role_config_suppression_ranger_plugin_trusted_proxy_ipaddress 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: Ranger KMS Server with KTS TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS TLS/SSL Client Trust Store File configuration validator. false role_config_suppression_ssl_client_truststore_location true
Suppress Configuration Validator: Ranger KMS Server with KTS TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS TLS/SSL Client Trust Store Password configuration validator. false role_config_suppression_ssl_client_truststore_password true
Suppress Configuration Validator: Ranger KMS Server with KTS TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS TLS/SSL Server JKS Keystore File Location configuration validator. false role_config_suppression_ssl_server_keystore_location true
Suppress Configuration Validator: Ranger KMS Server with KTS TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS 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 Parameter Validation: Kerberos Principal Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter. false service_config_suppression_kerberos_princ_name 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: Ranger KMS with Key Trustee Server Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS with Key Trustee Server Service Environment Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_ranger_kms_kts_service_env_safety_valve true
Suppress Parameter Validation: Ranger KMS Load Balancer Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Load Balancer parameter. false service_config_suppression_ranger_kms_load_balancer true
Suppress Parameter Validation: Ranger KMS Plugin Hdfs Audit Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Plugin Hdfs Audit Directory parameter. false service_config_suppression_ranger_kms_plugin_hdfs_audit_directory true
Suppress Configuration Validator: Ranger KMS Server with KTS Count Validator Whether to suppress configuration warnings produced by the Ranger KMS Server with KTS Count Validator configuration validator. false service_config_suppression_ranger_kms_server_kts_count_validator true
Suppress Parameter Validation: Service Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. false service_config_suppression_service_triggers true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_smon_derived_configs_safety_valve true
Suppress Health Test: Ranger KMS Server with KTS Health Whether to suppress the results of the Ranger KMS Server with KTS 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 service_health_suppression_ranger_kms_kts_ranger_kms_server_kts_healthy true