Ranger KMS Properties in Cloudera Runtime 7.2.x

Role groups:

Ranger KMS Server

Advanced

Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml

Description
For advanced use only. A string to be inserted into conf/core-site.xml for this role only.
Related Name
Default Value
API Name
conf/core-site.xml_role_safety_valve
Required
false

Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml

Description
For advanced use only. A string to be inserted into conf/dbks-site.xml for this role only.
Related Name
Default Value
API Name
conf/dbks-site.xml_role_safety_valve
Required
false

Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml

Description
For advanced use only. A string to be inserted into conf/hdfs-site.xml for this role only.
Related Name
Default Value
API Name
conf/hdfs-site.xml_role_safety_valve
Required
false

Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml

Description
For advanced use only. A string to be inserted into conf/kms-site.xml for this role only.
Related Name
Default Value
API Name
conf/kms-site.xml_role_safety_valve
Required
false

Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml

Description
For advanced use only. A string to be inserted into conf/ranger-kms-audit.xml for this role only.
Related Name
Default Value
API Name
conf/ranger-kms-audit.xml_role_safety_valve
Required
false

Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml

Description
For advanced use only. A string to be inserted into conf/ranger-kms-policymgr-ssl.xml for this role only.
Related Name
Default Value
API Name
conf/ranger-kms-policymgr-ssl.xml_role_safety_valve
Required
false

Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml

Description
For advanced use only. A string to be inserted into conf/ranger-kms-security.xml for this role only.
Related Name
Default Value
API Name
conf/ranger-kms-security.xml_role_safety_valve
Required
false

Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml

Description
For advanced use only. A string to be inserted into conf/ranger-kms-site.xml for this role only.
Related Name
Default Value
API Name
conf/ranger-kms-site.xml_role_safety_valve
Required
false

Ranger KMS Server 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

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, 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.
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 heap dump file when java.lang.OutOfMemoryError is thrown.
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

Ranger KMS Server Environment Advanced Configuration Snippet (Safety Valve)

Description
For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration.
Related Name
Default Value
API Name
RANGER_KMS_SERVER_role_env_safety_valve
Required
false

Logs

Ranger KMS Server Log Directory

Description
The log directory for log files of the role Ranger KMS Server.
Related Name
log_dir
Default Value
/var/log/ranger/kms
API Name
log_dir
Required
false

Ranger KMS Server Logging Threshold

Description
The minimum log level for Ranger KMS Server logs
Related Name
Default Value
INFO
API Name
log_threshold
Required
false

Ranger KMS Server Maximum Log File Backups

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

Ranger KMS Server Max Log Size

Description
The maximum size, in megabytes, per log file for Ranger KMS Server logs. Typically used by log4j or logback.
Related Name
Default Value
200 MiB
API Name
max_log_size
Required
false

Monitoring

Enable Health Alerts for this Role

Description
When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value
true
API Name
enable_alerts
Required
false

Enable Configuration Change Alerts

Description
When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value
false
API Name
enable_config_alerts
Required
false

Log Directory Free Space Monitoring Absolute Thresholds

Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value
Warning: 10 GiB, Critical: 5 GiB
API Name
log_directory_free_space_absolute_thresholds
Required
false

Log Directory Free Space Monitoring Percentage Thresholds

Description
The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value
Warning: Never, Critical: Never
API Name
log_directory_free_space_percentage_thresholds
Required
false

Metric Filter

Description
Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
Related Name
Default Value
API Name
monitoring_metric_filter
Required
false

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

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

Ranger KMS Server Host Health Test

Description
When computing the overall Ranger KMS Server health, consider the host's health.
Related Name
Default Value
true
API Name
ranger_kms_server_host_health_enabled
Required
false

Ranger KMS Server Process Health Test

Description
Enables the health test that the Ranger KMS Server's process state is consistent with the role configuration
Related Name
Default Value
true
API Name
ranger_kms_server_scm_health_enabled
Required
false

Role Triggers

Description
The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
Related Name
Default Value
[]
API Name
role_triggers
Required
true

Unexpected Exits Thresholds

Description
The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value
Warning: Never, Critical: Any
API Name
unexpected_exits_thresholds
Required
false

Unexpected Exits Monitoring Period

Description
The period to review when computing unexpected exits.
Related Name
Default Value
5 minute(s)
API Name
unexpected_exits_window
Required
false

Other

Ranger KMS Server Diagnostics Collection Timeout

Description
The timeout in milliseconds to wait for diagnostics collection to complete.
Related Name
Default Value
5 minute(s)
API Name
csd_role_diagnostics_timeout
Required
false

Graceful Shutdown Timeout

Description
The timeout in milliseconds to wait for graceful shutdown to complete.
Related Name
Default Value
18 second(s)
API Name
graceful_stop_timeout
Required
false

Hadoop KMS Audit Aggregation Window In Milliseconds

Description
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.
Related Name
hadoop.kms.audit.aggregation.window.ms
Default Value
10 second(s)
API Name
hadoop_kms_audit_aggregation_window_ms
Required
false

Hadoop KMS Authentication Signer Secret Provider

Description
Indicates how the secret to sign the authentication cookies will be stored. Options are 'random' (default), 'string' and 'zookeeper'. If using a setup with multiple KMS instances, 'zookeeper' should be used.
Related Name
hadoop.kms.authentication.signer.secret.provider
Default Value
random
API Name
hadoop_kms_authentication_signer_secret_provider
Required
false

Hadoop KMS Authentication Signer Secret Provider Zookeeper Auth Type

Description
The Zookeeper authentication type, 'none' or kerberos.
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
false

Hadoop KMS Authentication Signer Secret Provider Zookeeper Path

Description
The Zookeeper ZNode path where the KMS instances will store and retrieve the secret from.
Related Name
hadoop.kms.authentication.signer.secret.provider.zookeeper.path
Default Value
/hadoop-kms/hadoop-auth-signature-secret
API Name
hadoop_kms_authentication_signer_secret_provider_zookeeper_path
Required
false

Hadoop KMS Blacklist Decrypt EEK

Description
Add user which is needed to be blacklist for decrypt EncryptedKey CryptoExtension operations. Multiple list os user's can be added with comma separated.
Related Name
hadoop.kms.blacklist.DECRYPT_EEK
Default Value
hdfs
API Name
hadoop_kms_blacklist_decrypt_eek
Required
false

Hadoop KMS Cache Enable

Description
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.
Related Name
hadoop.kms.cache.enable
Default Value
true
API Name
hadoop_kms_cache_enable
Required
false

Hadoop Kms Cache Timeout In Milliseconds

Description
Expiry time for the KMS key version and key metadata cache, in milliseconds. This affects getKeyVersion and getMetadata.
Related Name
hadoop.kms.cache.timeout.ms
Default Value
10 minute(s)
API Name
hadoop_kms_cache_timeout_ms
Required
false

Hadoop KMS Current Key Cache Timeout In Milliseconds

Description
Expiry time for the KMS current key cache, in milliseconds. This affects getCurrentKey operations.
Related Name
hadoop.kms.current.key.cache.timeout.ms
Default Value
30 second(s)
API Name
hadoop_kms_current_key_cache_timeout_ms
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

Livy Proxy User Groups

Description
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_'.
Related Name
hadoop.kms.proxyuser.livy.groups
Default Value
*
API Name
hadoop_kms_proxyuser_livy_groups
Required
false

Livy Proxy User Hosts

Description
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'.
Related Name
hadoop.kms.proxyuser.livy.hosts
Default Value
*
API Name
hadoop_kms_proxyuser_livy_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

Ranger Proxy User Groups

Description
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_'.
Related Name
hadoop.kms.proxyuser.ranger.groups
Default Value
*
API Name
hadoop_kms_proxyuser_ranger_groups
Required
false

Ranger Proxy User Hosts

Description
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'.
Related Name
hadoop.kms.proxyuser.ranger.hosts
Default Value
*
API Name
hadoop_kms_proxyuser_ranger_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

Zeppelin Proxy User Groups

Description
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_'.
Related Name
hadoop.kms.proxyuser.zeppelin.groups
Default Value
*
API Name
hadoop_kms_proxyuser_zeppelin_groups
Required
false

Zeppelin Proxy User Hosts

Description
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'.
Related Name
hadoop.kms.proxyuser.zeppelin.hosts
Default Value
*
API Name
hadoop_kms_proxyuser_zeppelin_hosts
Required
false

Hadoop Security Keystore JavaKeyStoreProvider Password

Description
If using the JavaKeyStoreProvider, the password for the keystore file.
Related Name
hadoop.security.keystore.JavaKeyStoreProvider.password
Default Value
API Name
hadoop_security_keystore_javakeystoreprovider_password
Required
false

Azure Client ID

Description
Azure client id is a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
Related Name
ranger.kms.azure.client.id
Default Value
API Name
ranger_kms_azure_client_id
Required
false

Azure Client Secret

Description
Azure client secret to authenticate to key vault.
Related Name
ranger.kms.azure.client.secret
Default Value
API Name
ranger_kms_azure_client_secret
Required
false

Azure key vault cerificate password

Description
Azure key vault cerificate password.
Related Name
ranger.kms.azure.keyvault.certificate.password
Default Value
API Name
ranger_kms_azure_keyvault_certificate_password
Required
false

Azure Key Vault Cerificate Path

Description
Azure key vault cerificate path.
Related Name
ranger.kms.azure.keyvault.certificate.path
Default Value
API Name
ranger_kms_azure_keyvault_certificate_path
Required
false

Enable Azure Key Vault SSL

Description
Azure authentication via certificate or password.
Related Name
ranger.kms.azure.keyvault.ssl.enabled
Default Value
false
API Name
ranger_kms_azure_keyvault_ssl_enabled
Required
false

Azure Master Key Name

Description
Azure master key name.
Related Name
ranger.kms.azure.masterkey.name
Default Value
API Name
ranger_kms_azure_masterkey_name
Required
false

Azure Master Key Type

Description
Select the type for the Master key. Key Vault supports RSA and Elliptic Curve keys.
Related Name
ranger.kms.azure.masterkey.type
Default Value
RSA
API Name
ranger_kms_azure_masterkey_type
Required
false

Azure Zonekey Encryption Algorithm

Description
A supported algorithm for a encryption zone key operation.
Related Name
ranger.kms.azure.zonekey.encryption.algorithm
Default Value
RSA1_5
API Name
ranger_kms_azure_zonekey_encryption_algorithm
Required
false

Enable Azure Key Vault

Description
Whether to enable Azure key vault for secure key management.
Related Name
ranger.kms.azurekeyvault.enabled
Default Value
false
API Name
ranger_kms_azurekeyvault_enabled
Required
false

Azure Key Vault Url

Description
Azure Key Vault URL in the following format: https://keyvault-name.vault.azure.net/, where keyvault-name is the name for a key vault in the Microsoft Azure Key Vault service.
Related Name
ranger.kms.azurekeyvault.url
Default Value
API Name
ranger_kms_azurekeyvault_url
Required
false

Enable Hardware Security Module (HSM) For Ranger KMS (Luna)

Description
Whether to enable HSM for protection of cryptographic keys.
Related Name
ranger.ks.hsm.enabled
Default Value
false
API Name
ranger_kms_hsm_enabled
Required
false

HSM Partition Name

Description
Independent logical HSM partition that resides within Luna SA appliance's physical K6 HSM appliances. It manage access controls, security policies and administration access. In case of high availabilty enter the group name.
Related Name
ranger.ks.hsm.partition.name
Default Value
API Name
ranger_kms_hsm_partition_name
Required
false

HSM partition password

Description
Password for securing HSM partition.
Related Name
ranger.ks.hsm.partition.password
Default Value
API Name
ranger_kms_hsm_partition_password
Required
false

HSM Type

Description
Select HSM type.
Related Name
ranger.ks.hsm.type
Default Value
LunaProvider
API Name
ranger_kms_hsm_type
Required
false

Enable SafeNet Keysecure For Ranger KMS

Description
Whether to enable Keysecure for secure and centralized key management.
Related Name
ranger.kms.keysecure.enabled
Default Value
false
API Name
ranger_kms_keysecure_enabled
Required
false

SafeNet Keysecure Hostname

Description
Hostname of SafeNet Keysecure.
Related Name
ranger.kms.keysecure.hostname
Default Value
API Name
ranger_kms_keysecure_hostname
Required
false

SafeNet Keysecure Login Password

Description
Login Password for accessing SafeNet Keysecure.
Related Name
ranger.kms.keysecure.login.password
Default Value
API Name
ranger_kms_keysecure_login_password
Required
false

SafeNet Keysecure Login Username

Description
Login Username for accessing SafeNet Keysecure.
Related Name
ranger.kms.keysecure.login.username
Default Value
API Name
ranger_kms_keysecure_login_username
Required
false

SafeNet Keysecure MasterKey Name

Description
Enter Keysecure masterkey Name. It is used for encrypting/decrypting zone keys.
Related Name
ranger.kms.keysecure.masterkey.name
Default Value
API Name
ranger_kms_keysecure_masterkey_name
Required
false

SafeNet Keysecure Masterkey Size

Description
SafeNet Keysecure Masterkey Size.
Related Name
ranger.kms.keysecure.masterkey.size
Default Value
256
API Name
ranger_kms_keysecure_masterkey_size
Required
false

SafeNet Keysecure Sunpkcs11 cfg Filepath

Description
SafeNet Keysecure sunpkcs11 cfg filepath.
Related Name
ranger.kms.keysecure.sunpkcs11.cfg.filepath
Default Value
API Name
ranger_kms_keysecure_sunpkcs11_cfg_filepath
Required
false

Enable SafeNet Keysecure User Password Authentication

Description
Whether to enable SafeNet Keysecure user password authentication.
Related Name
ranger.kms.keysecure.UserPassword.Authentication
Default Value
false
API Name
ranger_kms_keysecure_userpassword_authentication
Required
false

Ranger KMS Master Key Password

Description
Password for Ranger KMS Master Key.
Related Name
ranger.db.encrypt.key.password
Default Value
API Name
ranger_kms_master_key_password
Required
true

Ranger KMS Max Heapsize

Description
Maximum size for the Java Process heap. Passed to Java -Xmx. Measured in megabytes.
Related Name
ranger_kms_max_heap_size
Default Value
1 GiB
API Name
ranger_kms_max_heap_size
Required
true

Ranger KMS Plugin Audit Hdfs Spool Directory Path

Description
Spool directory for Ranger audits being written to DFS.
Related Name
xasecure.audit.destination.hdfs.batch.filespool.dir
Default Value
/var/log/kms/audit/hdfs/spool
API Name
ranger_kms_plugin_hdfs_audit_spool_directory
Required
true

Ranger KMS Plugin Policy Cache Directory Path

Description
The directory where Ranger security policies are cached locally.
Related Name
ranger.plugin.kms.policy.cache.dir
Default Value
/var/lib/ranger/kms/policy-cache
API Name
ranger_kms_plugin_policy_cache_directory
Required
true

Ranger KMS Plugin Audit Solr Spool Directory Path

Description
Spool directory for Ranger audits being written to Solr.
Related Name
xasecure.audit.destination.solr.batch.filespool.dir
Default Value
/var/log/kms/audit/solr/spool
API Name
ranger_kms_plugin_solr_audit_spool_directory
Required
true

Ranger Kms Server Canary Health Enabled

Description
Ranger Kms Server Canary is enabled/disabled
Related Name
ranger_kms_server_canary_health_enabled
Default Value
true
API Name
ranger_kms_server_canary_health_enabled
Required
false

Ranger Kms Server Canary Health Timeout

Description
Timeout for Ranger Kms Server Canary health check.
Related Name
ranger_kms_server_canary_health_timeout
Default Value
30 second(s)
API Name
ranger_kms_server_canary_health_timeout
Required
false

Ranger KMS Tomcat Work Dir

Description
Tomcat work directory for Ranger KMS. This should generally not be changed.
Related Name
ranger_kms_tomcat_work_dir
Default Value
/var/lib/ranger/kms
API Name
ranger_kms_tomcat_work_dir
Required
true

Ranger Plugin Trusted Proxy IP Address

Description
Accepts a list of IP addresses of proxy servers for trusting.
Related Name
ranger.plugin.kms.trusted.proxy.ipaddress
Default Value
API Name
ranger_plugin_trusted_proxy_ipaddress
Required
false

Ranger Plugin Use X-Forwarded For IP Address

Description
The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs.
Related Name
ranger.plugin.kms.use.x-forwarded-for.ipaddress
Default Value
false
API Name
ranger_plugin_use_x_forwarded_for_ipaddress
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

Ranger KMS HTTP Port

Description
HTTP Port for Ranger KMS.
Related Name
ranger.service.http.port
Default Value
9292
API Name
ranger_kms_http_port
Required
false

Ranger KMS HTTPS Port

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

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 end 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 end 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

Ranger KMS Server TLS/SSL Client 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 Ranger KMS Server might connect to. This is used when Ranger KMS Server 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.
Related Name
xasecure.policymgr.clientssl.truststore
Default Value
API Name
ssl_client_truststore_location
Required
false

Ranger KMS Server TLS/SSL Client Trust Store Password

Description
The password for the Ranger KMS Server 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.
Related Name
xasecure.policymgr.clientssl.truststore.password
Default Value
API Name
ssl_client_truststore_password
Required
false

Enable TLS/SSL for Ranger KMS Server

Description
Encrypt communication between clients and Ranger KMS Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name
ranger.service.https.attrib.ssl.enabled
Default Value
false
API Name
ssl_enabled
Required
false

Ranger KMS Server TLS/SSL Server JKS 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 Ranger KMS Server is acting as a TLS/SSL server. The keystore must be in JKS format.
Related Name
ranger.service.https.attrib.keystore.file
Default Value
API Name
ssl_server_keystore_location
Required
false

Ranger KMS Server TLS/SSL Server JKS Keystore File Password

Description
The password for the Ranger KMS Server JKS keystore file.
Related Name
ranger.service.https.attrib.keystore.pass
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.
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: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/core-site.xml_role_safety_valve
Required
true

Suppress Parameter Validation: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/dbks-site.xml_role_safety_valve
Required
true

Suppress Parameter Validation: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/hdfs-site.xml_role_safety_valve
Required
true

Suppress Parameter Validation: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/kms-site.xml_role_safety_valve
Required
true

Suppress Parameter Validation: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-kms-audit.xml_role_safety_valve
Required
true

Suppress Parameter Validation: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-kms-policymgr-ssl.xml_role_safety_valve
Required
true

Suppress Parameter Validation: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-kms-security.xml_role_safety_valve
Required
true

Suppress Parameter Validation: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml parameter.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-kms-site.xml_role_safety_valve
Required
true

Suppress Parameter Validation: Hadoop KMS Authentication Signer Secret Provider Zookeeper Path

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop KMS Authentication Signer Secret Provider Zookeeper Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_authentication_signer_secret_provider_zookeeper_path
Required
true

Suppress Parameter Validation: Hadoop KMS Blacklist Decrypt EEK

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop KMS Blacklist Decrypt EEK parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_blacklist_decrypt_eek
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: Livy Proxy User Groups

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Proxy User Groups parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_livy_groups
Required
true

Suppress Parameter Validation: Livy Proxy User Hosts

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Livy Proxy User Hosts parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_livy_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: Ranger Proxy User Groups

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Proxy User Groups parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_ranger_groups
Required
true

Suppress Parameter Validation: Ranger Proxy User Hosts

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Proxy User Hosts parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_ranger_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: Zeppelin Proxy User Groups

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Proxy User Groups parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_zeppelin_groups
Required
true

Suppress Parameter Validation: Zeppelin Proxy User Hosts

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Zeppelin Proxy User Hosts parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_zeppelin_hosts
Required
true

Suppress Parameter Validation: Hadoop Security Keystore JavaKeyStoreProvider Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Hadoop Security Keystore JavaKeyStoreProvider Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_security_keystore_javakeystoreprovider_password
Required
true

Suppress Parameter Validation: Ranger KMS Server Logging Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server 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: Ranger KMS Server Log Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server 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: Azure Client ID

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Azure Client ID parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_client_id
Required
true

Suppress Parameter Validation: Azure Client Secret

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Azure Client Secret parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_client_secret
Required
true

Suppress Parameter Validation: Azure key vault cerificate password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Azure key vault cerificate password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_keyvault_certificate_password
Required
true

Suppress Parameter Validation: Azure Key Vault Cerificate Path

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Azure Key Vault Cerificate Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_keyvault_certificate_path
Required
true

Suppress Parameter Validation: Azure Master Key Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Azure Master Key Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_masterkey_name
Required
true

Suppress Parameter Validation: Azure Key Vault Url

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Azure Key Vault Url parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azurekeyvault_url
Required
true

Suppress Parameter Validation: HSM Partition Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the HSM Partition Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_hsm_partition_name
Required
true

Suppress Parameter Validation: HSM partition password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the HSM partition password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_hsm_partition_password
Required
true

Suppress Parameter Validation: Ranger KMS HTTP Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS HTTP Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_http_port
Required
true

Suppress Parameter Validation: Ranger KMS HTTPS Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS HTTPS Port parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_https_port
Required
true

Suppress Parameter Validation: SafeNet Keysecure Hostname

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SafeNet Keysecure Hostname parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_hostname
Required
true

Suppress Parameter Validation: SafeNet Keysecure Login Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SafeNet Keysecure Login Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_login_password
Required
true

Suppress Parameter Validation: SafeNet Keysecure Login Username

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SafeNet Keysecure Login Username parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_login_username
Required
true

Suppress Parameter Validation: SafeNet Keysecure MasterKey Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SafeNet Keysecure MasterKey Name parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_masterkey_name
Required
true

Suppress Parameter Validation: SafeNet Keysecure Sunpkcs11 cfg Filepath

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the SafeNet Keysecure Sunpkcs11 cfg Filepath parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_sunpkcs11_cfg_filepath
Required
true

Suppress Parameter Validation: Ranger KMS Master Key Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Master Key Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_master_key_password
Required
true

Suppress Parameter Validation: Ranger KMS Max Heapsize

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Max Heapsize parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_max_heap_size
Required
true

Suppress Parameter Validation: Ranger KMS Plugin Audit Hdfs Spool Directory Path

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Plugin Audit Hdfs Spool Directory Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_plugin_hdfs_audit_spool_directory
Required
true

Suppress Parameter Validation: Ranger KMS Plugin Policy Cache Directory Path

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Plugin Policy Cache Directory Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_plugin_policy_cache_directory
Required
true

Suppress Parameter Validation: Ranger KMS Plugin Audit Solr Spool Directory Path

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Plugin Audit Solr Spool Directory Path parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_plugin_solr_audit_spool_directory
Required
true

Suppress Parameter Validation: Ranger KMS Server Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Ranger KMS Tomcat Work Dir

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Tomcat Work Dir parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_tomcat_work_dir
Required
true

Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_plugin_trusted_proxy_ipaddress
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: Ranger KMS Server TLS/SSL Client Trust Store File

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server TLS/SSL Client Trust Store File parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true

Suppress Parameter Validation: Ranger KMS Server TLS/SSL Client Trust Store Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server TLS/SSL Client Trust Store Password parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_password
Required
true

Suppress Parameter Validation: Ranger KMS Server TLS/SSL Server JKS Keystore File Location

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server TLS/SSL Server JKS Keystore File Location parameter.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true

Suppress Parameter Validation: Ranger KMS Server TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Server TLS/SSL Server JKS 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_ranger_kms_ranger_kms_server_audit_health
Required
true

Suppress Health Test: File Descriptors

Description
Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_ranger_kms_ranger_kms_server_file_descriptor
Required
true

Suppress Health Test: Host Health

Description
Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_ranger_kms_ranger_kms_server_host_health
Required
true

Suppress Health Test: Log Directory Free Space

Description
Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_ranger_kms_ranger_kms_server_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_ranger_kms_ranger_kms_server_scm_health
Required
true

Suppress Health Test: Swap Memory Usage

Description
Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value
false
API Name
role_health_suppression_ranger_kms_ranger_kms_server_swap_memory_usage
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_ranger_kms_ranger_kms_server_unexpected_exits
Required
true

Suppress Health Test: Ranger KMS URL Canary Check.

Description
Whether to suppress the results of the Ranger KMS URL Canary Check. 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_ranger_kms_server_canary
Required
true

Service-Wide

Advanced

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

Ranger 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
RANGER_KMS_service_env_safety_valve
Required
false

Database

Ranger KMS Database Host

Description
Hostname of the database used by Ranger KMS. If the port is non-default for your database type, use host:port notation.
Related Name
ranger_kms_database_host
Default Value
localhost
API Name
ranger_kms_database_host
Required
true

Ranger KMS Database Name

Description
Name of Ranger KMS database.
Related Name
ranger_kms_database_name
Default Value
rangerkms
API Name
ranger_kms_database_name
Required
true

Ranger KMS Database User Password

Description
Password for Ranger KMS database.
Related Name
ranger.ks.jpa.jdbc.password
Default Value
API Name
ranger_kms_database_password
Required
true

Ranger KMS Database Port

Description
Port for Ranger KMS database.
Related Name
ranger_kms_database_port
Default Value
5432
API Name
ranger_kms_database_port
Required
true

Ranger KMS Database Type

Description
Database type to be used (postgres).
Related Name
ranger_kms_database_type
Default Value
postgresql
API Name
ranger_kms_database_type
Required
true

Ranger KMS Database User

Description
User for Ranger KMS database.
Related Name
ranger.ks.jpa.jdbc.user
Default Value
rangerkms
API Name
ranger_kms_database_user
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

Healthy Ranger KMS Server Monitoring Thresholds

Description
The health test thresholds of the overall Ranger KMS Server health. The check returns "Concerning" health if the percentage of "Healthy" Ranger KMS Servers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Ranger KMS Servers falls below the critical threshold.
Related Name
Default Value
Warning: 99.0 %, Critical: 49.0 %
API Name
RANGER_KMS_RANGER_KMS_SERVER_healthy_thresholds
Required
false

Service Triggers

Description
The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad", "streamThreshold": 10, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
Related Name
Default Value
[]
API Name
service_triggers
Required
true

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description
For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
Related Name
Default Value
API Name
smon_derived_configs_safety_valve
Required
false

Other

Ranger KMS Authentication Type

Description
Authentication type for the Ranger KMS. Can either be "simple" or "kerberos".
Related Name
hadoop.kms.authentication.type
Default Value
kerberos
API Name
hadoop_kms_authentication_type
Required
true

Ranger KMS Load Balancer

Description
Only required when Ranger KMS is running with High Availability.
Related Name
ranger_kms_load_balancer
Default Value
API Name
ranger_kms_load_balancer
Required
false

Ranger KMS Plugin Hdfs Audit Directory

Description
The DFS path on which Ranger audits are written.
Related Name
ranger_kms_plugin_hdfs_audit_directory
Default Value
$ranger_base_audit_url/kms
API Name
ranger_kms_plugin_hdfs_audit_directory
Required
false

ZooKeeper Service

Description
Name of the ZooKeeper service that this Ranger KMS service instance depends on
Related Name
Default Value
API Name
zookeeper_service
Required
false

Security

Kerberos Principal

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

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description
Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_cdh_version_validator
Required
true

Suppress Configuration Validator: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/core-site.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/core-site.xml_role_safety_valve
Required
true

Suppress Configuration Validator: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/dbks-site.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/dbks-site.xml_role_safety_valve
Required
true

Suppress Configuration Validator: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/hdfs-site.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/hdfs-site.xml_role_safety_valve
Required
true

Suppress Configuration Validator: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/kms-site.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/kms-site.xml_role_safety_valve
Required
true

Suppress Configuration Validator: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-audit.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-kms-audit.xml_role_safety_valve
Required
true

Suppress Configuration Validator: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-policymgr-ssl.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-kms-policymgr-ssl.xml_role_safety_valve
Required
true

Suppress Configuration Validator: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-security.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-kms-security.xml_role_safety_valve
Required
true

Suppress Configuration Validator: Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Advanced Configuration Snippet (Safety Valve) for conf/ranger-kms-site.xml configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_conf/ranger-kms-site.xml_role_safety_valve
Required
true

Suppress Configuration Validator: Hadoop KMS Authentication Signer Secret Provider Zookeeper Path

Description
Whether to suppress configuration warnings produced by the Hadoop KMS Authentication Signer Secret Provider Zookeeper Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_authentication_signer_secret_provider_zookeeper_path
Required
true

Suppress Configuration Validator: Hadoop KMS Blacklist Decrypt EEK

Description
Whether to suppress configuration warnings produced by the Hadoop KMS Blacklist Decrypt EEK configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_blacklist_decrypt_eek
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: Livy Proxy User Groups

Description
Whether to suppress configuration warnings produced by the Livy Proxy User Groups configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_livy_groups
Required
true

Suppress Configuration Validator: Livy Proxy User Hosts

Description
Whether to suppress configuration warnings produced by the Livy Proxy User Hosts configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_livy_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: Ranger Proxy User Groups

Description
Whether to suppress configuration warnings produced by the Ranger Proxy User Groups configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_ranger_groups
Required
true

Suppress Configuration Validator: Ranger Proxy User Hosts

Description
Whether to suppress configuration warnings produced by the Ranger Proxy User Hosts configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_ranger_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: Zeppelin Proxy User Groups

Description
Whether to suppress configuration warnings produced by the Zeppelin Proxy User Groups configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_zeppelin_groups
Required
true

Suppress Configuration Validator: Zeppelin Proxy User Hosts

Description
Whether to suppress configuration warnings produced by the Zeppelin Proxy User Hosts configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_kms_proxyuser_zeppelin_hosts
Required
true

Suppress Configuration Validator: Hadoop Security Keystore JavaKeyStoreProvider Password

Description
Whether to suppress configuration warnings produced by the Hadoop Security Keystore JavaKeyStoreProvider Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_hadoop_security_keystore_javakeystoreprovider_password
Required
true

Suppress Configuration Validator: Ranger KMS Server Logging Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server 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: Ranger KMS Server Log Directory

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server 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: Azure Client ID

Description
Whether to suppress configuration warnings produced by the Azure Client ID configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_client_id
Required
true

Suppress Configuration Validator: Azure Client Secret

Description
Whether to suppress configuration warnings produced by the Azure Client Secret configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_client_secret
Required
true

Suppress Configuration Validator: Azure key vault cerificate password

Description
Whether to suppress configuration warnings produced by the Azure key vault cerificate password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_keyvault_certificate_password
Required
true

Suppress Configuration Validator: Azure Key Vault Cerificate Path

Description
Whether to suppress configuration warnings produced by the Azure Key Vault Cerificate Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_keyvault_certificate_path
Required
true

Suppress Configuration Validator: Azure Master Key Name

Description
Whether to suppress configuration warnings produced by the Azure Master Key Name configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azure_masterkey_name
Required
true

Suppress Configuration Validator: Azure Key Vault Url

Description
Whether to suppress configuration warnings produced by the Azure Key Vault Url configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_azurekeyvault_url
Required
true

Suppress Configuration Validator: HSM Partition Name

Description
Whether to suppress configuration warnings produced by the HSM Partition Name configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_hsm_partition_name
Required
true

Suppress Configuration Validator: HSM partition password

Description
Whether to suppress configuration warnings produced by the HSM partition password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_hsm_partition_password
Required
true

Suppress Configuration Validator: Ranger KMS HTTP Port

Description
Whether to suppress configuration warnings produced by the Ranger KMS HTTP Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_http_port
Required
true

Suppress Configuration Validator: Ranger KMS HTTPS Port

Description
Whether to suppress configuration warnings produced by the Ranger KMS HTTPS Port configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_https_port
Required
true

Suppress Configuration Validator: SafeNet Keysecure Hostname

Description
Whether to suppress configuration warnings produced by the SafeNet Keysecure Hostname configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_hostname
Required
true

Suppress Configuration Validator: SafeNet Keysecure Login Password

Description
Whether to suppress configuration warnings produced by the SafeNet Keysecure Login Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_login_password
Required
true

Suppress Configuration Validator: SafeNet Keysecure Login Username

Description
Whether to suppress configuration warnings produced by the SafeNet Keysecure Login Username configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_login_username
Required
true

Suppress Configuration Validator: SafeNet Keysecure MasterKey Name

Description
Whether to suppress configuration warnings produced by the SafeNet Keysecure MasterKey Name configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_masterkey_name
Required
true

Suppress Configuration Validator: SafeNet Keysecure Sunpkcs11 cfg Filepath

Description
Whether to suppress configuration warnings produced by the SafeNet Keysecure Sunpkcs11 cfg Filepath configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_keysecure_sunpkcs11_cfg_filepath
Required
true

Suppress Configuration Validator: Ranger KMS Master Key Password

Description
Whether to suppress configuration warnings produced by the Ranger KMS Master Key Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_master_key_password
Required
true

Suppress Configuration Validator: Ranger KMS Max Heapsize

Description
Whether to suppress configuration warnings produced by the Ranger KMS Max Heapsize configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_max_heap_size
Required
true

Suppress Configuration Validator: Ranger KMS Plugin Audit Hdfs Spool Directory Path

Description
Whether to suppress configuration warnings produced by the Ranger KMS Plugin Audit Hdfs Spool Directory Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_plugin_hdfs_audit_spool_directory
Required
true

Suppress Configuration Validator: Ranger KMS Plugin Policy Cache Directory Path

Description
Whether to suppress configuration warnings produced by the Ranger KMS Plugin Policy Cache Directory Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_plugin_policy_cache_directory
Required
true

Suppress Configuration Validator: Ranger KMS Plugin Audit Solr Spool Directory Path

Description
Whether to suppress configuration warnings produced by the Ranger KMS Plugin Audit Solr Spool Directory Path configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_plugin_solr_audit_spool_directory
Required
true

Suppress Configuration Validator: Ranger KMS Server Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Configuration Validator: Ranger KMS Tomcat Work Dir

Description
Whether to suppress configuration warnings produced by the Ranger KMS Tomcat Work Dir configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_kms_tomcat_work_dir
Required
true

Suppress Configuration Validator: Ranger Plugin Trusted Proxy IP Address

Description
Whether to suppress configuration warnings produced by the Ranger Plugin Trusted Proxy IP Address configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ranger_plugin_trusted_proxy_ipaddress
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: Ranger KMS Server TLS/SSL Client Trust Store File

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server TLS/SSL Client Trust Store File configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_location
Required
true

Suppress Configuration Validator: Ranger KMS Server TLS/SSL Client Trust Store Password

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server TLS/SSL Client Trust Store Password configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_client_truststore_password
Required
true

Suppress Configuration Validator: Ranger KMS Server TLS/SSL Server JKS Keystore File Location

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server TLS/SSL Server JKS Keystore File Location configuration validator.
Related Name
Default Value
false
API Name
role_config_suppression_ssl_server_keystore_location
Required
true

Suppress Configuration Validator: Ranger KMS Server TLS/SSL Server JKS Keystore File Password

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server TLS/SSL Server JKS 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: Kerberos Principal

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter.
Related Name
Default Value
false
API Name
service_config_suppression_kerberos_princ_name
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: Ranger KMS Database Host

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Database Host parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_kms_database_host
Required
true

Suppress Parameter Validation: Ranger KMS Database Name

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Database Name parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_kms_database_name
Required
true

Suppress Parameter Validation: Ranger KMS Database User Password

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Database User Password parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_kms_database_password
Required
true

Suppress Parameter Validation: Ranger KMS Database Port

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Database Port parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_kms_database_port
Required
true

Suppress Parameter Validation: Ranger KMS Database User

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Database User parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_kms_database_user
Required
true

Suppress Parameter Validation: Ranger KMS Load Balancer

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Load Balancer parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_kms_load_balancer
Required
true

Suppress Parameter Validation: Ranger KMS Plugin Hdfs Audit Directory

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Plugin Hdfs Audit Directory parameter.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_kms_plugin_hdfs_audit_directory
Required
true

Suppress Configuration Validator: Ranger KMS Server Count Validator

Description
Whether to suppress configuration warnings produced by the Ranger KMS Server Count Validator configuration validator.
Related Name
Default Value
false
API Name
service_config_suppression_ranger_kms_server_count_validator
Required
true

Suppress Parameter Validation: Ranger KMS Service Environment Advanced Configuration Snippet (Safety Valve)

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

Suppress Parameter Validation: Service Triggers

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.
Related Name
Default Value
false
API Name
service_config_suppression_service_triggers
Required
true

Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description
Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value
false
API Name
service_config_suppression_smon_derived_configs_safety_valve
Required
true

Suppress Health Test: Ranger KMS Server Health

Description
Whether to suppress the results of the Ranger KMS Server 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
service_health_suppression_ranger_kms_ranger_kms_server_healthy
Required
true