Ranger Properties in Cloudera Runtime 7.0.3

Role groups:

Ranger Admin

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ranger Admin Advanced Configuration Snippet (Safety Valve) for conf/ranger-admin-site.xml For advanced use only. A string to be inserted into conf/ranger-admin-site.xml for this role only. conf/ranger-admin-site.xml_role_safety_valve false
Ranger Admin Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false
Ranger Admin Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. RANGER_ADMIN_role_env_safety_valve false

Logs

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

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % ranger_admin_fd_thresholds false
Ranger Admin Host Health Test When computing the overall Ranger Admin health, consider the host's health. true ranger_admin_host_health_enabled false
Ranger Admin Process Health Test Enables the health test that the Ranger Admin's process state is consistent with the role configuration true ranger_admin_scm_health_enabled false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Ranger Admin Diagnostics Collection Timeout The timeout in milliseconds to wait for diagnostics collection to complete. 5 minute(s) csd_role_diagnostics_timeout false
Graceful Shutdown Timeout The timeout in milliseconds to wait for graceful shutdown to complete. 18 second(s) graceful_stop_timeout false
Kerberos Cookie Path Kerberos Cookie path ranger.admin.kerberos.cookie.path / ranger.admin.kerberos.cookie.path false
Kerberos Token Valid Seconds Kerberos token validity ranger.admin.kerberos.token.valid.seconds 30 ranger.admin.kerberos.token.valid.seconds false
Maximum Shards for Solr Collection of Ranger Audits Maximum number of shards for the Ranger Audit Solr collection. The recommended value is, number of replica given multiple by number of shards given for the collection. ranger.audit.solr.max.shards.per.node 1 ranger.audit.solr.max.shards.per.node true
Replicas for Solr Collection of Ranger Audits Number of replicas for Ranger Audit Solr collection. The recommended value is, number of Solr servers running in the current cluster divided by number of shards for the collection. ranger.audit.solr.no.replica 1 ranger.audit.solr.no.replica true
Shards for Solr Collection of Ranger Audits Number of shards required for Ranger Audit Solr collection. The recommended number of shards is equal or less than the number of Solr Server running in the current cluster. ranger.audit.solr.no.shards 1 ranger.audit.solr.no.shards true
Enable Knox Trusted Proxy Support Determine if the Ranger service should allow authentication using Knox trusted proxy. ranger.authentication.allow.trustedproxy false ranger.authentication.allow.trustedproxy false
Default Policy Groups Single or comma separated list of groups that are required in default policies for Ranger plugin services. The groups will be added for any new Ranger Plugin services created in Ranger Admin after setting value to this parameter. ranger.default.policy.groups ranger.default.policy.groups false
Default Policy Users Single or comma separated list of users that are required in default policies for Ranger plugin services. The users will be added for any new Ranger Plugin services created in Ranger Admin after setting value to this parameter. ranger.default.policy.users ranger.default.policy.users false
Admin AD Auth Base DN This parameter is only used if Authentication method is AD. The Distinguished Name (DN) of the starting point for directory server searches. ranger.ldap.ad.base.dn ranger.ldap.ad.base.dn false
Admin AD Auth Bind DN Full distinguished name (DN), including common name (CN), of an AD user account that has privileges to search for users. Only used if Authentication method is AD ranger.ldap.ad.bind.dn ranger.ldap.ad.bind.dn false
Admin AD Auth Domain Name AD domain. Only used if Authentication method is AD. ranger.ldap.ad.domain ranger.ldap.ad.domain false
Admin AD Auth Referral This parameter is only used if Authentication method is AD. Set to follow if multiple AD servers are configured to return continuation references for results. Set to ignore (default) if no referrals should be followed. ranger.ldap.ad.referral ignore ranger.ldap.ad.referral false
Admin AD Auth URL AD URL. Only used if Authentication method is AD ranger.ldap.ad.url ranger.ldap.ad.url false
Admin AD Auth User Search Filter AD user search filter. Only used if Authentication method is AD. ranger.ldap.ad.user.searchfilter ranger.ldap.ad.user.searchfilter false
Admin LDAP Auth Base DN The Distinguished Name (DN) of the starting point for directory server searches. Only used if Authentication method is LDAP. ranger.ldap.base.dn ranger.ldap.base.dn false
Admin LDAP Auth Bind User Full distinguished name (DN), including common name (CN), of an LDAP user account that has privileges to search for users. This user is used for searching the users. This could be read-only LDAP user. Example: cn=admin,dc=example,dc=com ranger.ldap.bind.dn ranger.ldap.bind.dn false
Admin LDAP Auth Group Role Attribute LDAP group role attribute. Only used if Authentication method is LDAP. ranger.ldap.group.roleattribute ranger.ldap.group.roleattribute false
Admin LDAP Auth Group Search Base LDAP group searchbase. Only used if Authentication method is LDAP. ranger.ldap.group.searchbase ranger.ldap.group.searchbase false
Admin LDAP Auth Group Search Filter LDAP group search filter. Only used if Authentication method is LDAP. ranger.ldap.group.searchfilter ranger.ldap.group.searchfilter false
Admin LDAP Auth Referral This parameter is only used if Authentication method is LDAP. Set to follow if multiple LDAP servers are configured to return continuation references for results. Set to ignore (default) if no referrals should be followed. When this parameter is set to throw, all of the normal entries are returned in the enumeration first, before the ReferralException is thrown. ranger.ldap.referral ignore ranger.ldap.referral false
Admin LDAP Auth URL LDAP server URL. Example: value = ldap://localhost:389 or ldaps://localhost:636 ranger.ldap.url ranger.ldap.url false
Admin LDAP Auth User DN Pattern LDAP user DN. Only used if Authentication method is LDAP. ranger.ldap.user.dnpattern ranger.ldap.user.dnpattern false
Admin LDAP Auth User Search Filter LDAP user search filter. Only used if Authentication method is LDAP. ranger.ldap.user.searchfilter ranger.ldap.user.searchfilter false
SSO Browser Useragent Comma seperated values of browser agent ranger.sso.browser.useragent Mozilla, chrome ranger.sso.browser.useragent false
Enable Ranger SSO Determine if Ranger is Knox SSO enabled or not ? ranger.sso.enabled false ranger.sso.enabled false
SSO Provider Url SSO provider url Example: https://KNOX_HOST:KNOX_PORT/gateway/KNOXSSO_TOPOLOGY_NAME/api/v1/websso ranger.sso.providerurl ranger.sso.providerurl false
SSO Public Key Public key for SSO cookie verification ranger.sso.publicKey ranger.sso.publicKey false
Enable Auto Create Tag Service Whether to create tag service in Ranger Admin. ranger.tagservice.auto.create true ranger.tagservice.auto.create false
Enable Tag Service Auto Link Whether to link the Tag service set in "Tag Service Name" parameter to all available services in Ranger Admin. ranger.tagservice.auto.link true ranger.tagservice.auto.link false
Tag Service Name Name of the tag service that will be created in Ranger Admin when "Enable Auto Create Tag Service" parameter is enabled. ranger.tagservice.auto.name cm_tag ranger.tagservice.auto.name false
Admin UNIX Auth Remote Login Whether remote login is enabled. Only used if Authentication method is UNIX. ranger.unixauth.remote.login.enabled true ranger.unixauth.remote.login.enabled false
Admin UNIX Auth Service Hostname Host where unix authentication service is running. Only used if Authentication method is UNIX. {{RANGER_USERSYNC_HOST}} is a placeholder value which will be replaced with the host where Ranger Usersync will be installed in the current cluster. ranger.unixauth.service.hostname RANGER_USERSYNC_HOST ranger.unixauth.service.hostname false
Ranger Admin Conf Path Staging directory for Ranger Admin Configuration. This should generally not be changed. ranger_admin_conf_path /etc/ranger/admin ranger_admin_conf_path true
Ranger Admin Max Heapsize Maximum size for the Java Process heap. Passed to Java -Xmx. Measured in megabytes. ranger_admin_max_heap_size 1 GiB ranger_admin_max_heap_size true
Admin Authentication Method Authentication Method for login to Ranger Admin. ranger.authentication.method UNIX ranger_authentication_method false
Ranger Database Host Hostname of the database used by Ranger Admin. If the port is non-default for your database type, use host:port notation. ranger_database_host ranger_database_host true
Ranger Database Name Name of Ranger Admin database. ranger_database_name ranger ranger_database_name true
Ranger Database User Password Password for Ranger Admin database. ranger.jpa.jdbc.password ranger_database_password true
Ranger Database Type Database type to be used. ranger_database_type PostgreSQL ranger_database_type true
Ranger Database User User for Ranger Admin database. ranger.jpa.jdbc.user rangeradmin ranger_database_user true
Admin AD Auth Bind Password Password for the account that can search for users. Only used if Authentication method is AD ranger.ldap.ad.bind.password ranger_ldap_ad_bind_password false
Admin LDAP Auth Bind User Password Password for the account that can search for users. ranger.ldap.bind.password ranger_ldap_bind_password false
Knox Proxy User Groups Accepts a list of group names. The Knox user can impersonate only the users that belong to the groups specified in the list. The wildcard value * may be used to allow impersonation of any user belonging to any group. ranger.proxyuser.knox.groups * ranger_proxyuser_knox_groups false
Knox Proxy User Hosts Accepts a list of IP addresses, IP address ranges in CIDR format and/or host names. The Knox user can impersonate only the requests coming from hosts specified in the list. The wildcard value * may be used to allow impersonation from any host. ranger.proxyuser.knox.hosts * ranger_proxyuser_knox_hosts false
Knox Proxy User Users Accepts a list of usernames. The Knox user can impersonate only the users specified in the list. The wildcard value * may be used to allow impersonation of any user. ranger.proxyuser.knox.users * ranger_proxyuser_knox_users false
Ranger Tomcat Work Dir Tomcat work directory for Ranger Admin. This should generally not be changed. ranger_tomcat_work_dir /var/lib/ranger/admin ranger_tomcat_work_dir true

Performance

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

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Admin Unix Auth Service Port Port for unix authentication service. Only used if Authentication method is UNIX. ranger.unixauth.service.port 5151 ranger.unixauth.service.port false

Resource Management

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

Security

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

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Ranger Admin Advanced Configuration Snippet (Safety Valve) for conf/ranger-admin-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin Advanced Configuration Snippet (Safety Valve) for conf/ranger-admin-site.xml parameter. false role_config_suppression_conf/ranger-admin-site.xml_role_safety_valve true
Suppress Parameter Validation: Ranger Admin Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Ranger Admin Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Kerberos Cookie Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Cookie Path parameter. false role_config_suppression_ranger.admin.kerberos.cookie.path true
Suppress Parameter Validation: Default Policy Groups Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Policy Groups parameter. false role_config_suppression_ranger.default.policy.groups true
Suppress Parameter Validation: Default Policy Users Whether to suppress configuration warnings produced by the built-in parameter validation for the Default Policy Users parameter. false role_config_suppression_ranger.default.policy.users true
Suppress Parameter Validation: Admin AD Auth Base DN Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin AD Auth Base DN parameter. false role_config_suppression_ranger.ldap.ad.base.dn true
Suppress Parameter Validation: Admin AD Auth Bind DN Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin AD Auth Bind DN parameter. false role_config_suppression_ranger.ldap.ad.bind.dn true
Suppress Parameter Validation: Admin AD Auth Domain Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin AD Auth Domain Name parameter. false role_config_suppression_ranger.ldap.ad.domain true
Suppress Parameter Validation: Admin AD Auth URL Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin AD Auth URL parameter. false role_config_suppression_ranger.ldap.ad.url true
Suppress Parameter Validation: Admin AD Auth User Search Filter Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin AD Auth User Search Filter parameter. false role_config_suppression_ranger.ldap.ad.user.searchfilter true
Suppress Parameter Validation: Admin LDAP Auth Base DN Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth Base DN parameter. false role_config_suppression_ranger.ldap.base.dn true
Suppress Parameter Validation: Admin LDAP Auth Bind User Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth Bind User parameter. false role_config_suppression_ranger.ldap.bind.dn true
Suppress Parameter Validation: Admin LDAP Auth Group Role Attribute Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth Group Role Attribute parameter. false role_config_suppression_ranger.ldap.group.roleattribute true
Suppress Parameter Validation: Admin LDAP Auth Group Search Base Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth Group Search Base parameter. false role_config_suppression_ranger.ldap.group.searchbase true
Suppress Parameter Validation: Admin LDAP Auth Group Search Filter Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth Group Search Filter parameter. false role_config_suppression_ranger.ldap.group.searchfilter true
Suppress Parameter Validation: Admin LDAP Auth URL Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth URL parameter. false role_config_suppression_ranger.ldap.url true
Suppress Parameter Validation: Admin LDAP Auth User DN Pattern Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth User DN Pattern parameter. false role_config_suppression_ranger.ldap.user.dnpattern true
Suppress Parameter Validation: Admin LDAP Auth User Search Filter Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth User Search Filter parameter. false role_config_suppression_ranger.ldap.user.searchfilter true
Suppress Parameter Validation: SSO Browser Useragent Whether to suppress configuration warnings produced by the built-in parameter validation for the SSO Browser Useragent parameter. false role_config_suppression_ranger.sso.browser.useragent true
Suppress Parameter Validation: SSO Provider Url Whether to suppress configuration warnings produced by the built-in parameter validation for the SSO Provider Url parameter. false role_config_suppression_ranger.sso.providerurl true
Suppress Parameter Validation: SSO Public Key Whether to suppress configuration warnings produced by the built-in parameter validation for the SSO Public Key parameter. false role_config_suppression_ranger.sso.publickey true
Suppress Parameter Validation: Tag Service Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Tag Service Name parameter. false role_config_suppression_ranger.tagservice.auto.name true
Suppress Parameter Validation: Admin UNIX Auth Service Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin UNIX Auth Service Hostname parameter. false role_config_suppression_ranger.unixauth.service.hostname true
Suppress Parameter Validation: Admin Unix Auth Service Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin Unix Auth Service Port parameter. false role_config_suppression_ranger.unixauth.service.port true
Suppress Parameter Validation: Ranger Admin Conf Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin Conf Path parameter. false role_config_suppression_ranger_admin_conf_path true
Suppress Parameter Validation: Ranger Admin Max Heapsize Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin Max Heapsize parameter. false role_config_suppression_ranger_admin_max_heap_size true
Suppress Parameter Validation: Ranger Admin Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_ranger_admin_role_env_safety_valve true
Suppress Parameter Validation: Ranger Database Host Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Database Host parameter. false role_config_suppression_ranger_database_host true
Suppress Parameter Validation: Ranger Database Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Database Name parameter. false role_config_suppression_ranger_database_name true
Suppress Parameter Validation: Ranger Database User Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Database User Password parameter. false role_config_suppression_ranger_database_password true
Suppress Parameter Validation: Ranger Database User Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Database User parameter. false role_config_suppression_ranger_database_user true
Suppress Parameter Validation: Admin AD Auth Bind Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin AD Auth Bind Password parameter. false role_config_suppression_ranger_ldap_ad_bind_password true
Suppress Parameter Validation: Admin LDAP Auth Bind User Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin LDAP Auth Bind User Password parameter. false role_config_suppression_ranger_ldap_bind_password true
Suppress Parameter Validation: Knox Proxy User Groups Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy User Groups parameter. false role_config_suppression_ranger_proxyuser_knox_groups true
Suppress Parameter Validation: Knox Proxy User Hosts Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy User Hosts parameter. false role_config_suppression_ranger_proxyuser_knox_hosts true
Suppress Parameter Validation: Knox Proxy User Users Whether to suppress configuration warnings produced by the built-in parameter validation for the Knox Proxy User Users parameter. false role_config_suppression_ranger_proxyuser_knox_users true
Suppress Parameter Validation: Ranger Tomcat Work Dir Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tomcat Work Dir parameter. false role_config_suppression_ranger_tomcat_work_dir true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Ranger Admin TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Ranger Admin TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Ranger Admin TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Ranger Admin TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_admin_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_admin_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_admin_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_admin_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_admin_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_admin_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_admin_unexpected_exits true

Ranger Tagsync

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties For advanced use only. A string to be inserted into conf/atlas-application.properties for this role only. conf/atlas-application.properties_role_safety_valve false
Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-policymgr-ssl.xml For advanced use only. A string to be inserted into conf/ranger-tagsync-policymgr-ssl.xml for this role only. conf/ranger-tagsync-policymgr-ssl.xml_role_safety_valve false
Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-site.xml For advanced use only. A string to be inserted into conf/ranger-tagsync-site.xml for this role only. conf/ranger-tagsync-site.xml_role_safety_valve false
Ranger Tagsync Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false
Ranger Tagsync Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. RANGER_TAGSYNC_role_env_safety_valve false

Logs

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

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % ranger_tagsync_fd_thresholds false
Ranger Tagsync Host Health Test When computing the overall Ranger Tagsync health, consider the host's health. true ranger_tagsync_host_health_enabled false
Ranger Tagsync Process Health Test Enables the health test that the Ranger Tagsync's process state is consistent with the role configuration true ranger_tagsync_scm_health_enabled false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Atlas Source: Kafka Consumer Group Kafka consumer group. atlas.kafka.entities.group.id ranger_entities_consumer atlas.kafka.entities.group.id false
Graceful Shutdown Timeout The timeout in milliseconds to wait for graceful shutdown to complete. 18 second(s) graceful_stop_timeout false
Capture Cluster name Capture cluster name. ranger.tagsync.atlas.default.cluster.name ranger.tagsync.atlas.default.cluster.name false
Enable Ranger Tagsync Cookie Authentication Enable cookie-based authentication for requests going from Ranger Tagsync to Ranger Admin. ranger.tagsync.cookie.enabled true ranger.tagsync.cookie.enabled false
Ranger Tagsync Username Ranger Tagsync username in Ranger Admin. ranger.tagsync.dest.ranger.username rangertagsync ranger.tagsync.dest.ranger.username false
Enable File Tag Source Whether to sync tags from file. ranger.tagsync.source.file false ranger.tagsync.source.file false
File Source: File Update Polling Interval Sync Interval for updating tags from file. ranger.tagsync.source.file.check.interval.millis 1 minute(s) ranger.tagsync.source.file.check.interval.millis false
File Source: Filename Filename containing tags. ranger.tagsync.source.file.filename ranger.tagsync.source.file.filename false
Ranger Tagsync Conf Path Staging directory for Ranger Tagsync Configuration. This should generally not be changed. ranger_tagsync_conf_path /etc/ranger/tagsync ranger_tagsync_conf_path true
Ranger Tagsync Max Heapsize Maximum size for the Java Process heap. Passed to Java -Xmx. Measured in megabytes. ranger_tagsync_max_heap_size 1 GiB ranger_tagsync_max_heap_size true

Performance

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

Resource Management

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

Security

Display Name Description Related Name Default Value API Name Required
Ranger Tagsync TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Ranger Tagsync might connect to. This is used when Ranger Tagsync is the client in a TLS/SSL connection. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead. xasecure.policymgr.clientssl.truststore ssl_client_truststore_location false
Ranger Tagsync TLS/SSL Client Trust Store Password The password for the Ranger Tagsync TLS/SSL Certificate Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information. xasecure.policymgr.clientssl.truststore.password ssl_client_truststore_password false
Enable TLS/SSL for Ranger Tagsync Encrypt communication between clients and Ranger Tagsync using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). false ssl_enabled false
Ranger Tagsync TLS/SSL Server JKS Keystore File Location The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Ranger Tagsync is acting as a TLS/SSL server. The keystore must be in JKS format. xasecure.policymgr.clientssl.keystore ssl_server_keystore_location false
Ranger Tagsync TLS/SSL Server JKS Keystore File Password The password for the Ranger Tagsync JKS keystore file. xasecure.policymgr.clientssl.keystore.password ssl_server_keystore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Parameter Validation: Atlas Source: Kafka Consumer Group Whether to suppress configuration warnings produced by the built-in parameter validation for the Atlas Source: Kafka Consumer Group parameter. false role_config_suppression_atlas.kafka.entities.group.id true
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties parameter. false role_config_suppression_conf/atlas-application.properties_role_safety_valve true
Suppress Parameter Validation: Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-policymgr-ssl.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-policymgr-ssl.xml parameter. false role_config_suppression_conf/ranger-tagsync-policymgr-ssl.xml_role_safety_valve true
Suppress Parameter Validation: Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-site.xml parameter. false role_config_suppression_conf/ranger-tagsync-site.xml_role_safety_valve true
Suppress Parameter Validation: Ranger Tagsync Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Ranger Tagsync Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Capture Cluster name Whether to suppress configuration warnings produced by the built-in parameter validation for the Capture Cluster name parameter. false role_config_suppression_ranger.tagsync.atlas.default.cluster.name true
Suppress Parameter Validation: Ranger Tagsync Username Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Username parameter. false role_config_suppression_ranger.tagsync.dest.ranger.username true
Suppress Parameter Validation: File Source: Filename Whether to suppress configuration warnings produced by the built-in parameter validation for the File Source: Filename parameter. false role_config_suppression_ranger.tagsync.source.file.filename true
Suppress Parameter Validation: Ranger Tagsync Conf Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Conf Path parameter. false role_config_suppression_ranger_tagsync_conf_path true
Suppress Parameter Validation: Ranger Tagsync Max Heapsize Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Max Heapsize parameter. false role_config_suppression_ranger_tagsync_max_heap_size true
Suppress Parameter Validation: Ranger Tagsync Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_ranger_tagsync_role_env_safety_valve true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Ranger Tagsync TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Ranger Tagsync TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Ranger Tagsync TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync TLS/SSL Server JKS Keystore File Location parameter. false role_config_suppression_ssl_server_keystore_location true
Suppress Parameter Validation: Ranger Tagsync TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync TLS/SSL Server JKS Keystore File Password parameter. false role_config_suppression_ssl_server_keystore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_tagsync_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_tagsync_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_tagsync_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_tagsync_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_tagsync_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_tagsync_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_tagsync_unexpected_exits true

Ranger Usersync

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
Ranger Usersync Advanced Configuration Snippet (Safety Valve) for conf/ranger-ugsync-site.xml For advanced use only. A string to be inserted into conf/ranger-ugsync-site.xml for this role only. conf/ranger-ugsync-site.xml_role_safety_valve false
Ranger Usersync Logging Advanced Configuration Snippet (Safety Valve) For advanced use only, a string to be inserted into log4j.properties for this role only. log4j_safety_valve false
Heap Dump Directory Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. oom_heap_dump_dir /tmp oom_heap_dump_dir false
Dump Heap When Out of Memory When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. true oom_heap_dump_enabled true
Kill When Out of Memory When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. true oom_sigkill_enabled true
Automatically Restart Process When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. false process_auto_restart true
Enable Metric Collection Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. true process_should_monitor true
Process Start Retry Attempts Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. 3 process_start_retries false
Process Start Wait Timeout The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. 20 process_start_secs false
Ranger Usersync Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. RANGER_USERSYNC_role_env_safety_valve false

Logs

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

Monitoring

Display Name Description Related Name Default Value API Name Required
Enable Health Alerts for this Role When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold true enable_alerts false
Enable Configuration Change Alerts When set, Cloudera Manager will send alerts when this entity's configuration changes. false enable_config_alerts false
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Warning: 10 GiB, Critical: 5 GiB log_directory_free_space_absolute_thresholds false
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. Warning: Never, Critical: Never log_directory_free_space_percentage_thresholds false
Metric Filter Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
  • Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
  • Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
  • Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
  • Metric Name - The name of a metric that will be included or excluded during metric collection.
If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:
  • Include only Health Test Metric Set: Selected.
  • Include/Exclude Custom Metrics: Set to Include.
  • Metric Name: jvm_heap_used_mb
You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:{ "includeHealthTestMetricSet": true, "filterType": "whitelist", "metrics": ["jvm_heap_used_mb"] }
monitoring_metric_filter false
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. Warning: 200 B, Critical: Never process_swap_memory_thresholds false
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. Warning: 50.0 %, Critical: 70.0 % ranger_usersync_fd_thresholds false
Ranger Usersync Host Health Test When computing the overall Ranger Usersync health, consider the host's health. true ranger_usersync_host_health_enabled false
Ranger Usersync Process Health Test Enables the health test that the Ranger Usersync's process state is consistent with the role configuration true ranger_usersync_scm_health_enabled false
Role Triggers The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
  • triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
  • triggerExpression (mandatory) - A tsquery expression representing the trigger.
  • streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
  • enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
  • expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.
For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:[{"triggerName": "sample-trigger", "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad", "streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.
[] role_triggers true
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. Warning: Never, Critical: Any unexpected_exits_thresholds false
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. 5 minute(s) unexpected_exits_window false

Other

Display Name Description Related Name Default Value API Name Required
Graceful Shutdown Timeout The timeout in milliseconds to wait for graceful shutdown to complete. 18 second(s) graceful_stop_timeout false
Enable Ranger Usersync Cookie Authentication Enable cookie-based authentication for requests going from Ranger Usersync to Ranger Admin. ranger.usersync.cookie.enabled true ranger.usersync.cookie.enabled false
Enable User Sync Should users and groups be synchronized to Ranger Database? Required to setup Ranger policies. ranger.usersync.enabled true ranger.usersync.enabled false
Usersync Filesource File Name Path to the file with the users and groups information. Only used when Usersync Sync Source is set to "org.apache.ranger.unixusersync.process.FileSourceUserGroupBuilder". Example: /tmp/usergroup.json or /tmp/usergroup.csv or /tmp/usergroup.txt ranger.usersync.filesource.file ranger.usersync.filesource.file false
Usersync Filesource Delimiter Delimiter used in file, if File based user sync is used ranger.usersync.filesource.text.delimiter , ranger.usersync.filesource.text.delimiter false
Ranger Usersync Group Based Role Assignment Rules The parameter is used to assign roles to users and groups synced in Ranger Admin. Based on the given values specified in the above delimiter parameters, Ranger Usersync will parse the value specified in this parameter and sync users and groups along with roles given. Example - "&ROLE_SYS_ADMIN:u:username1,username2&ROLE_KEY_ADMIN:g:groupname1". ranger.usersync.group.based.role.assignment.rules ranger.usersync.group.based.role.assignment.rules false
Usersync Group Member Attribute LDAP group member attribute name. Example: member ranger.usersync.group.memberattributename ranger.usersync.group.memberattributename false
Usersync Group Name Attribute LDAP group name attribute. Example: cn ranger.usersync.group.nameattribute ranger.usersync.group.nameattribute false
Usersync Group Object Class LDAP Group object class. Example: group ranger.usersync.group.objectclass ranger.usersync.group.objectclass false
Usersync Enable Group Search First Enable Group Search First. ranger.usersync.group.search.first.enabled false ranger.usersync.group.search.first.enabled false
Usersync Group Search Base Search base for groups. Sample value would be ou=groups,dc=hadoop,dc=apache,dc=org. The parameter overrides value specified in ranger.usersync.ldap.searchBase, ranger.usersync.ldap.user.searchbase. If a value is not specified, takes the value of ranger.usersync.ldap.searchBase. If ranger.usersync.ldap.searchBase is also not specified, takes the value of ranger.usersync.ldap.user.searchbase. Multiple Ous can be configured with ; (semicolon) separated eg: ou=groups,DC=example,DC=com;ou=group1,ou=group2 ranger.usersync.group.searchbase ranger.usersync.group.searchbase false
Usersync Enable Group Sync Whether Usersync should use ldapsearch to find groups instead of relying on user entry attributes. ranger.usersync.group.searchenabled true ranger.usersync.group.searchenabled false
Usersync Group Search Filter Optional additional filter constraining the groups selected for syncing. A sample value would be (dept=eng) ranger.usersync.group.searchfilter ranger.usersync.group.searchfilter false
Usersync Group Search Scope Search scope for the groups. Value "base" indicates that only the entry specified as the search base in ranger.usersync.group.searchbase should be considered. One "indicates" that only the immediate children of the entry specified as the search base in ranger.usersync.group.searchbase should be considered. "Sub" indicates that the entry specified as the search base in ranger.usersync.group.searchbase, and all of its subordinates to any depth, should be considered. ranger.usersync.group.searchscope sub ranger.usersync.group.searchscope false
Usersync Group Usermap Sync Whether to sync all groups for a user. ranger.usersync.group.usermapsyncenabled true ranger.usersync.group.usermapsyncenabled false
Usersync Bind User Full distinguished name (DN), including common name (CN), of an LDAP user account that has privileges to search for users. This user is used for searching the users. This could be read-only LDAP user. Example: cn=admin,dc=example,dc=com ranger.usersync.ldap.binddn ranger.usersync.ldap.binddn false
Usersync Incremental Sync Enable Incremental Sync. ranger.usersync.ldap.deltasync true ranger.usersync.ldap.deltasync false
Usersync Group Hierarchy Levels Levels of LDAP directory tree where the groups need to be searched. ranger.usersync.ldap.grouphierarchylevels 0 ranger.usersync.ldap.grouphierarchylevels false
Usersync Groupname Case Conversion Used for converting syncing groups to the selected case conversion. ranger.usersync.ldap.groupname.caseconversion none ranger.usersync.ldap.groupname.caseconversion false
Usersync Referral Set to follow if multiple LDAP/AD servers are configured to return continuation references for results. Set to ignore if no referrals should be followed. When this parameter is set to throw, all of the normal entries are returned in the enumeration first, before the ReferralException is thrown. ranger.usersync.ldap.referral ignore ranger.usersync.ldap.referral false
Usersync Search Base Search base for users and groups. Sample value would be dc=hadoop,dc=apache,dc=org.Multiple Ous can be configured with ; (semicolon) separated. ranger.usersync.ldap.searchBase ranger.usersync.ldap.searchBase false
Usersync Enable STARTTLS Enable LDAP STARTTLS. ranger.usersync.ldap.starttls false ranger.usersync.ldap.starttls false
Usersync LDAP/AD URL LDAP server URL. Example: value = ldap://localhost:389 or ldaps://localhost:636 ranger.usersync.ldap.url ranger.usersync.ldap.url false
Usersync User Group Name Attribute LDAP user group name attribute. Generally it is the same as username attribute. Example: sAMAccountName in AD, uid or cn in OpenLDAP ranger.usersync.ldap.user.groupnameattribute ranger.usersync.ldap.user.groupnameattribute false
Usersync User Name Attribute LDAP user name attribute. Example: sAMAccountName in AD, uid or cn in OpenLDAP ranger.usersync.ldap.user.nameattribute ranger.usersync.ldap.user.nameattribute false
Usersync User Object Class LDAP User Object Class. Example: person or user ranger.usersync.ldap.user.objectclass ranger.usersync.ldap.user.objectclass false
Usersync User Search Base Search base for users. Sample value would be ou=users,dc=hadoop,dc=apache,dc=org. Overrides value specified in ranger.usersync.ldap.searchBase. Multiple Ous can be configured with ; (semicolon) separated eg: cn=users,dc=example,dc=com;ou=example1,ou=example2 ranger.usersync.ldap.user.searchbase ranger.usersync.ldap.user.searchbase false
Usersync User Search Filter Optional additional filter constraining the users selected for syncing. A sample value would be (dept=eng). Customize the value to suit your deployment. ranger.usersync.ldap.user.searchfilter ranger.usersync.ldap.user.searchfilter false
Usersync User Search Scope Search scope for the users. Value "base" indicates that only the entry specified as the search base in ranger.usersync.ldap.user.searchbase should be considered. "One" indicates that only the immediate children of the entry specified as the search base in ranger.usersync.ldap.user.searchbase should be considered. "Sub" indicates that the entry specified as the search base in ranger.usersync.ldap.user.searchbase, and all of its subordinates to any depth, should be considered. ranger.usersync.ldap.user.searchscope sub ranger.usersync.ldap.user.searchscope false
Usersync Username Case Conversion Used for converting syncing users to the selected case conversion. ranger.usersync.ldap.username.caseconversion none ranger.usersync.ldap.username.caseconversion false
Enable Results to be Paged for User/Group Request Whether results can be paged for User/Group requests. ranger.usersync.pagedresultsenabled true ranger.usersync.pagedresultsenabled false
User/Group Request Page size. Enter Page size for User/Group Request. ranger.usersync.pagedresultssize 500 ranger.usersync.pagedresultssize false
Maximum Records Per API Call Maximum number of records to be returned per API call. ranger.usersync.policymanager.maxrecordsperapicall 1000 ranger.usersync.policymanager.maxrecordsperapicall true
Ranger Usersync Policymgr Username Ranger Usersync username in Ranger Admin. ranger.usersync.policymgr.username rangerusersync ranger.usersync.policymgr.username false
Unix Auth Service Hostname Port for Unix authentication service. ranger.usersync.port 5151 ranger.usersync.port true
Ranger Usersync Role Assignment List Delimiter The parameter is used to specify delimiter while syncing roles to users and groups in Ranger Admin. It is a delimiter for roles. Example - "ROLE_SYS_ADMIN:u:username1,username2&ROLE_KEY_ADMIN:g:groupname1", where ROLE_SYS_ADMIN and ROLE_KEY_ADMIN are roles in Ranger Admin separated by delimiter &. Note - All the delimiters parameters ranger.usersync.role.assignment.list.delimiter, ranger.usersync.users.groups.assignment.list.delimiter and ranger.usersync.username.groupname.assignment.list.delimiter should have different values. The delimiters should not contain characters that are allowed in username or groupname. ranger.usersync.role.assignment.list.delimiter & ranger.usersync.role.assignment.list.delimiter false
Usersync Sleeptime interval Sleep time interval between user sync operations in milliseconds. ranger.usersync.sleeptimeinmillisbetweensynccycle 1 minute(s) ranger.usersync.sleeptimeinmillisbetweensynccycle false
Source for Syncing User and Groups For syncing from Ldap source, use "org.apache.ranger.ldapusersync.process.LdapUserGroupBuilder". For syncing from Unix source, use "org.apache.ranger.unixusersync.process.UnixUserGroupBuilder". For syncing from File source, use "org.apache.ranger.unixusersync.process.FileSourceUserGroupBuilder" ranger.usersync.source.impl.class org.apache.ranger.unixusersync.process.UnixUserGroupBuilder ranger.usersync.source.impl.class true
Ranger Usersync Unix Backend The backend mechanism to read users and groups from a UNIX system. The value is applicable only on UNIX-based systems. ranger.usersync.unix.backend nss ranger.usersync.unix.backend false
Usersync UNIX Minimum User ID Minimum User ID to start syncing. This should be set to avoid syncing of UNIX system-level users in the Ranger Admin. ranger.usersync.unix.minUserId 500 ranger.usersync.unix.minUserId false
Usersync Enable User Search Enable User Search, when ranger.usersync.group.search.first.enabled is set to true. ranger.usersync.user.searchenabled false ranger.usersync.user.searchenabled false
Ranger Usersync Username Groupname Assignment List Delimiter The parameter is used to specify a delimiter while syncing users and groups in Ranger Admin. Used as a delimiter to differentiate between two or more users and groups. Example - "ROLE_SYS_ADMIN:u:username1,username2", where username1 and username2 are separated by ,. Note - All the delimiters parameters ranger.usersync.role.assignment.list.delimiter, ranger.usersync.users.groups.assignment.list.delimiter and ranger.usersync.username.groupname.assignment.list.delimiter should have different values. The delimiters should not contain characters that are allowed in username or groupname. ranger.usersync.username.groupname.assignment.list.delimiter , ranger.usersync.username.groupname.assignment.list.delimiter false
Ranger Usersync User Groups Assignment List Delimiter The parameter is used to specify delimiter while syncing users and groups along with specified roles in Ranger Admin. It is a delimiter to differentiate between users and groups from respective roles. Example - "ROLE_SYS_ADMIN:u:username1,username2&ROLE_SYS_ADMIN:g:groupname1,groupname2", where ROLE_SYS_ADMIN is a role. "u" is used to denote the list of users followed by actual usernames which are username1 and username2. While "g" is used to denote the list of groups followed by actual groupnames which are groupname1 and groupname2. Note - All the delimiters parameters ranger.usersync.role.assignment.list.delimiter, ranger.usersync.users.groups.assignment.list.delimiter and ranger.usersync.username.groupname.assignment.list.delimiter should have different values. The delimiters should not contain characters that are allowed in username or groupname. ranger.usersync.users.groups.assignment.list.delimiter : ranger.usersync.users.groups.assignment.list.delimiter false
Ranger Usersync Conf Path Staging directory for Ranger Usersync Configuration. This should generally not be changed. ranger_usersync_conf_path /etc/ranger/usersync ranger_usersync_conf_path true
Usersync Bind User Password Password for the LDAP bind user used for searching users. ranger.usersync.ldap.ldapbindpassword ranger_usersync_ldap_ldapbindpassword false
Ranger Usersync Max Heapsize Maximum size for the Java Process heap. Passed to Java -Xmx. Measured in megabytes. ranger_usersync_max_heap_size 1 GiB ranger_usersync_max_heap_size true

Performance

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

Resource Management

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

Security

Display Name Description Related Name Default Value API Name Required
Ranger Usersync TLS/SSL Client Trust Store File The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Ranger Usersync might connect to. This is used when Ranger Usersync 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. ranger.usersync.truststore.file ssl_client_truststore_location false
Ranger Usersync TLS/SSL Client Trust Store Password The password for the Ranger Usersync 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. ranger.usersync.truststore.password ssl_client_truststore_password false

Stacks Collection

Display Name Description Related Name Default Value API Name Required
Stacks Collection Data Retention The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted. stacks_collection_data_retention 100 MiB stacks_collection_data_retention false
Stacks Collection Directory The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. stacks_collection_directory stacks_collection_directory false
Stacks Collection Enabled Whether or not periodic stacks collection is enabled. stacks_collection_enabled false stacks_collection_enabled true
Stacks Collection Frequency The frequency with which stacks are collected. stacks_collection_frequency 5.0 second(s) stacks_collection_frequency false
Stacks Collection Method The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped. stacks_collection_method jstack stacks_collection_method false

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Parameter Validation: Ranger Usersync Advanced Configuration Snippet (Safety Valve) for conf/ranger-ugsync-site.xml Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Advanced Configuration Snippet (Safety Valve) for conf/ranger-ugsync-site.xml parameter. false role_config_suppression_conf/ranger-ugsync-site.xml_role_safety_valve true
Suppress Parameter Validation: Ranger Usersync Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Logging Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_log4j_safety_valve true
Suppress Parameter Validation: Ranger Usersync Log Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Log Directory parameter. false role_config_suppression_log_dir true
Suppress Parameter Validation: Heap Dump Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. false role_config_suppression_oom_heap_dump_dir true
Suppress Parameter Validation: Usersync Filesource File Name Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Filesource File Name parameter. false role_config_suppression_ranger.usersync.filesource.file true
Suppress Parameter Validation: Usersync Filesource Delimiter Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Filesource Delimiter parameter. false role_config_suppression_ranger.usersync.filesource.text.delimiter true
Suppress Parameter Validation: Ranger Usersync Group Based Role Assignment Rules Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Group Based Role Assignment Rules parameter. false role_config_suppression_ranger.usersync.group.based.role.assignment.rules true
Suppress Parameter Validation: Usersync Group Member Attribute Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Group Member Attribute parameter. false role_config_suppression_ranger.usersync.group.memberattributename true
Suppress Parameter Validation: Usersync Group Name Attribute Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Group Name Attribute parameter. false role_config_suppression_ranger.usersync.group.nameattribute true
Suppress Parameter Validation: Usersync Group Object Class Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Group Object Class parameter. false role_config_suppression_ranger.usersync.group.objectclass true
Suppress Parameter Validation: Usersync Group Search Base Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Group Search Base parameter. false role_config_suppression_ranger.usersync.group.searchbase true
Suppress Parameter Validation: Usersync Group Search Filter Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Group Search Filter parameter. false role_config_suppression_ranger.usersync.group.searchfilter true
Suppress Parameter Validation: Usersync Bind User Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Bind User parameter. false role_config_suppression_ranger.usersync.ldap.binddn true
Suppress Parameter Validation: Usersync Search Base Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Search Base parameter. false role_config_suppression_ranger.usersync.ldap.searchbase true
Suppress Parameter Validation: Usersync LDAP/AD URL Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync LDAP/AD URL parameter. false role_config_suppression_ranger.usersync.ldap.url true
Suppress Parameter Validation: Usersync User Group Name Attribute Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync User Group Name Attribute parameter. false role_config_suppression_ranger.usersync.ldap.user.groupnameattribute true
Suppress Parameter Validation: Usersync User Name Attribute Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync User Name Attribute parameter. false role_config_suppression_ranger.usersync.ldap.user.nameattribute true
Suppress Parameter Validation: Usersync User Object Class Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync User Object Class parameter. false role_config_suppression_ranger.usersync.ldap.user.objectclass true
Suppress Parameter Validation: Usersync User Search Base Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync User Search Base parameter. false role_config_suppression_ranger.usersync.ldap.user.searchbase true
Suppress Parameter Validation: Usersync User Search Filter Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync User Search Filter parameter. false role_config_suppression_ranger.usersync.ldap.user.searchfilter true
Suppress Parameter Validation: Ranger Usersync Policymgr Username Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Policymgr Username parameter. false role_config_suppression_ranger.usersync.policymgr.username true
Suppress Parameter Validation: Unix Auth Service Hostname Whether to suppress configuration warnings produced by the built-in parameter validation for the Unix Auth Service Hostname parameter. false role_config_suppression_ranger.usersync.port true
Suppress Parameter Validation: Ranger Usersync Role Assignment List Delimiter Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Role Assignment List Delimiter parameter. false role_config_suppression_ranger.usersync.role.assignment.list.delimiter true
Suppress Parameter Validation: Ranger Usersync Username Groupname Assignment List Delimiter Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Username Groupname Assignment List Delimiter parameter. false role_config_suppression_ranger.usersync.username.groupname.assignment.list.delimiter true
Suppress Parameter Validation: Ranger Usersync User Groups Assignment List Delimiter Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync User Groups Assignment List Delimiter parameter. false role_config_suppression_ranger.usersync.users.groups.assignment.list.delimiter true
Suppress Parameter Validation: Ranger Usersync Conf Path Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Conf Path parameter. false role_config_suppression_ranger_usersync_conf_path true
Suppress Parameter Validation: Usersync Bind User Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Usersync Bind User Password parameter. false role_config_suppression_ranger_usersync_ldap_ldapbindpassword true
Suppress Parameter Validation: Ranger Usersync Max Heapsize Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Max Heapsize parameter. false role_config_suppression_ranger_usersync_max_heap_size true
Suppress Parameter Validation: Ranger Usersync Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync Environment Advanced Configuration Snippet (Safety Valve) parameter. false role_config_suppression_ranger_usersync_role_env_safety_valve true
Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. false role_config_suppression_rm_custom_resources true
Suppress Parameter Validation: Role Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. false role_config_suppression_role_triggers true
Suppress Parameter Validation: Ranger Usersync TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync TLS/SSL Client Trust Store File parameter. false role_config_suppression_ssl_client_truststore_location true
Suppress Parameter Validation: Ranger Usersync TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync TLS/SSL Client Trust Store Password parameter. false role_config_suppression_ssl_client_truststore_password true
Suppress Parameter Validation: Stacks Collection Directory Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter. false role_config_suppression_stacks_collection_directory true
Suppress Health Test: Audit Pipeline Test Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_usersync_audit_health true
Suppress Health Test: File Descriptors Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_usersync_file_descriptor true
Suppress Health Test: Host Health Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_usersync_host_health true
Suppress Health Test: Log Directory Free Space Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_usersync_log_directory_free_space true
Suppress Health Test: Process Status Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_usersync_scm_health true
Suppress Health Test: Swap Memory Usage Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_usersync_swap_memory_usage true
Suppress Health Test: Unexpected Exits Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false role_health_suppression_ranger_ranger_usersync_unexpected_exits true

Service-Wide

Categories:

Advanced

Display Name Description Related Name Default Value API Name Required
System Group The group that this service's processes should run as. ranger process_groupname true
System User The user that this service's processes should run as. ranger process_username true
Ranger Service Environment Advanced Configuration Snippet (Safety Valve) For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration. RANGER_service_env_safety_valve false

Monitoring

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

Other

Display Name Description Related Name Default Value API Name Required
HDFS Service Name of the HDFS service that this Ranger service instance depends on hdfs_service true
Ranger KMS Keyadmin User Initial Password Password for the Ranger administrator, whose login name is "keyadmin". The password should be minimum 8 characters long, with at least one alphabetic and one numeric character. The following characters are invalid: " ' \ ` ´. Note that this password is only used to setup Ranger in the cluster: any subsequent changes will not be effective. This password can be later changed from the Ranger Admin UI under the user profile page. keyadmin_user_password keyadmin_user_password true
Load Balancer Address Load Balancer Address used by clients to access Ranger Admin. Only required when Ranger Admin is running with High Availability. Example: http://load-balancer-host:load-balancer-port ranger.externalurl load_balancer_url false
Ranger Plugin DFS Audit URL An absolute URL with no trailing slash should be entered, or leave the value empty. Allows setting up a centralized storage location for Ranger audits. This URL is used as the base for audit directories: all services plugging into Ranger will prepend this URL to their configured path used to store Ranger audits. ranger_plugin_hdfs_audit_url /ranger/audit ranger_plugin_hdfs_audit_url false
Ranger Admin User Initial Password Password for the Ranger administrator, whose login name is "admin". The password should be minimum 8 characters long, with at least one alphabetic and one numeric character. The following characters are invalid: " ' \ ` ´. Note that this password is only used to setup Ranger in the cluster: any subsequent changes will not be effective. This password can be later changed from the Ranger Admin UI under the user profile page. rangeradmin_user_password rangeradmin_user_password true
Ranger Tagsync User Initial Password Password for the Ranger administrator, whose login name is "rangertagsync". The password should be minimum 8 characters long, with at least one alphabetic and one numeric character. The following characters are invalid: " ' \ ` ´. Note that this password is only used to setup Ranger in the cluster: any subsequent changes will not be effective. This password can be later changed from the Ranger Admin UI under the user profile page. rangertagsync_user_password rangertagsync_user_password true
Ranger Usersync User Initial Password Password for the Ranger administrator, whose login name is "rangerusersync". The password should be minimum 8 characters long, with at least one alphabetic and one numeric character. The following characters are invalid: " ' \ ` ´. Note that this password is only used to setup Ranger in the cluster: any subsequent changes will not be effective. This password can be later changed from the Ranger Admin UI under the user profile page. rangerusersync_user_password rangerusersync_user_password true
Solr Service Name of the Solr service that this Ranger service instance depends on solr_service true

Ports and Addresses

Display Name Description Related Name Default Value API Name Required
Admin HTTP Port HTTP Port for Ranger Admin. ranger.service.http.port 6080 ranger_service_http_port true
Admin HTTPS port HTTPS Port for Ranger Admin. Only used when SSL is enabled for Ranger Admin. ranger.service.https.port 6182 ranger_service_https_port true

Suppressions

Display Name Description Related Name Default Value API Name Required
Suppress Configuration Validator: Atlas Source: Kafka Consumer Group Whether to suppress configuration warnings produced by the Atlas Source: Kafka Consumer Group configuration validator. false role_config_suppression_atlas.kafka.entities.group.id true
Suppress Configuration Validator: CDH Version Validator Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. false role_config_suppression_cdh_version_validator true
Suppress Configuration Validator: Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties Whether to suppress configuration warnings produced by the Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/atlas-application.properties configuration validator. false role_config_suppression_conf/atlas-application.properties_role_safety_valve true
Suppress Configuration Validator: Ranger Admin Advanced Configuration Snippet (Safety Valve) for conf/ranger-admin-site.xml Whether to suppress configuration warnings produced by the Ranger Admin Advanced Configuration Snippet (Safety Valve) for conf/ranger-admin-site.xml configuration validator. false role_config_suppression_conf/ranger-admin-site.xml_role_safety_valve true
Suppress Configuration Validator: Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-policymgr-ssl.xml Whether to suppress configuration warnings produced by the Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-policymgr-ssl.xml configuration validator. false role_config_suppression_conf/ranger-tagsync-policymgr-ssl.xml_role_safety_valve true
Suppress Configuration Validator: Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-site.xml Whether to suppress configuration warnings produced by the Ranger Tagsync Advanced Configuration Snippet (Safety Valve) for conf/ranger-tagsync-site.xml configuration validator. false role_config_suppression_conf/ranger-tagsync-site.xml_role_safety_valve true
Suppress Configuration Validator: Ranger Usersync Advanced Configuration Snippet (Safety Valve) for conf/ranger-ugsync-site.xml Whether to suppress configuration warnings produced by the Ranger Usersync Advanced Configuration Snippet (Safety Valve) for conf/ranger-ugsync-site.xml configuration validator. false role_config_suppression_conf/ranger-ugsync-site.xml_role_safety_valve true
Suppress Configuration Validator: Ranger Admin Logging Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ranger Admin Logging Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_log4j_safety_valve true
Suppress Configuration Validator: Ranger Admin Log Directory Whether to suppress configuration warnings produced by the Ranger Admin Log Directory configuration validator. false role_config_suppression_log_dir true
Suppress Configuration Validator: Heap Dump Directory Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator. false role_config_suppression_oom_heap_dump_dir true
Suppress Configuration Validator: Kerberos Cookie Path Whether to suppress configuration warnings produced by the Kerberos Cookie Path configuration validator. false role_config_suppression_ranger.admin.kerberos.cookie.path true
Suppress Configuration Validator: Default Policy Groups Whether to suppress configuration warnings produced by the Default Policy Groups configuration validator. false role_config_suppression_ranger.default.policy.groups true
Suppress Configuration Validator: Default Policy Users Whether to suppress configuration warnings produced by the Default Policy Users configuration validator. false role_config_suppression_ranger.default.policy.users true
Suppress Configuration Validator: Admin AD Auth Base DN Whether to suppress configuration warnings produced by the Admin AD Auth Base DN configuration validator. false role_config_suppression_ranger.ldap.ad.base.dn true
Suppress Configuration Validator: Admin AD Auth Bind DN Whether to suppress configuration warnings produced by the Admin AD Auth Bind DN configuration validator. false role_config_suppression_ranger.ldap.ad.bind.dn true
Suppress Configuration Validator: Admin AD Auth Domain Name Whether to suppress configuration warnings produced by the Admin AD Auth Domain Name configuration validator. false role_config_suppression_ranger.ldap.ad.domain true
Suppress Configuration Validator: Admin AD Auth URL Whether to suppress configuration warnings produced by the Admin AD Auth URL configuration validator. false role_config_suppression_ranger.ldap.ad.url true
Suppress Configuration Validator: Admin AD Auth User Search Filter Whether to suppress configuration warnings produced by the Admin AD Auth User Search Filter configuration validator. false role_config_suppression_ranger.ldap.ad.user.searchfilter true
Suppress Configuration Validator: Admin LDAP Auth Base DN Whether to suppress configuration warnings produced by the Admin LDAP Auth Base DN configuration validator. false role_config_suppression_ranger.ldap.base.dn true
Suppress Configuration Validator: Admin LDAP Auth Bind User Whether to suppress configuration warnings produced by the Admin LDAP Auth Bind User configuration validator. false role_config_suppression_ranger.ldap.bind.dn true
Suppress Configuration Validator: Admin LDAP Auth Group Role Attribute Whether to suppress configuration warnings produced by the Admin LDAP Auth Group Role Attribute configuration validator. false role_config_suppression_ranger.ldap.group.roleattribute true
Suppress Configuration Validator: Admin LDAP Auth Group Search Base Whether to suppress configuration warnings produced by the Admin LDAP Auth Group Search Base configuration validator. false role_config_suppression_ranger.ldap.group.searchbase true
Suppress Configuration Validator: Admin LDAP Auth Group Search Filter Whether to suppress configuration warnings produced by the Admin LDAP Auth Group Search Filter configuration validator. false role_config_suppression_ranger.ldap.group.searchfilter true
Suppress Configuration Validator: Admin LDAP Auth URL Whether to suppress configuration warnings produced by the Admin LDAP Auth URL configuration validator. false role_config_suppression_ranger.ldap.url true
Suppress Configuration Validator: Admin LDAP Auth User DN Pattern Whether to suppress configuration warnings produced by the Admin LDAP Auth User DN Pattern configuration validator. false role_config_suppression_ranger.ldap.user.dnpattern true
Suppress Configuration Validator: Admin LDAP Auth User Search Filter Whether to suppress configuration warnings produced by the Admin LDAP Auth User Search Filter configuration validator. false role_config_suppression_ranger.ldap.user.searchfilter true
Suppress Configuration Validator: SSO Browser Useragent Whether to suppress configuration warnings produced by the SSO Browser Useragent configuration validator. false role_config_suppression_ranger.sso.browser.useragent true
Suppress Configuration Validator: SSO Provider Url Whether to suppress configuration warnings produced by the SSO Provider Url configuration validator. false role_config_suppression_ranger.sso.providerurl true
Suppress Configuration Validator: SSO Public Key Whether to suppress configuration warnings produced by the SSO Public Key configuration validator. false role_config_suppression_ranger.sso.publickey true
Suppress Configuration Validator: Tag Service Name Whether to suppress configuration warnings produced by the Tag Service Name configuration validator. false role_config_suppression_ranger.tagservice.auto.name true
Suppress Configuration Validator: Capture Cluster name Whether to suppress configuration warnings produced by the Capture Cluster name configuration validator. false role_config_suppression_ranger.tagsync.atlas.default.cluster.name true
Suppress Configuration Validator: Ranger Tagsync Username Whether to suppress configuration warnings produced by the Ranger Tagsync Username configuration validator. false role_config_suppression_ranger.tagsync.dest.ranger.username true
Suppress Configuration Validator: File Source: Filename Whether to suppress configuration warnings produced by the File Source: Filename configuration validator. false role_config_suppression_ranger.tagsync.source.file.filename true
Suppress Configuration Validator: Admin UNIX Auth Service Hostname Whether to suppress configuration warnings produced by the Admin UNIX Auth Service Hostname configuration validator. false role_config_suppression_ranger.unixauth.service.hostname true
Suppress Configuration Validator: Admin Unix Auth Service Port Whether to suppress configuration warnings produced by the Admin Unix Auth Service Port configuration validator. false role_config_suppression_ranger.unixauth.service.port true
Suppress Configuration Validator: Usersync Filesource File Name Whether to suppress configuration warnings produced by the Usersync Filesource File Name configuration validator. false role_config_suppression_ranger.usersync.filesource.file true
Suppress Configuration Validator: Usersync Filesource Delimiter Whether to suppress configuration warnings produced by the Usersync Filesource Delimiter configuration validator. false role_config_suppression_ranger.usersync.filesource.text.delimiter true
Suppress Configuration Validator: Ranger Usersync Group Based Role Assignment Rules Whether to suppress configuration warnings produced by the Ranger Usersync Group Based Role Assignment Rules configuration validator. false role_config_suppression_ranger.usersync.group.based.role.assignment.rules true
Suppress Configuration Validator: Usersync Group Member Attribute Whether to suppress configuration warnings produced by the Usersync Group Member Attribute configuration validator. false role_config_suppression_ranger.usersync.group.memberattributename true
Suppress Configuration Validator: Usersync Group Name Attribute Whether to suppress configuration warnings produced by the Usersync Group Name Attribute configuration validator. false role_config_suppression_ranger.usersync.group.nameattribute true
Suppress Configuration Validator: Usersync Group Object Class Whether to suppress configuration warnings produced by the Usersync Group Object Class configuration validator. false role_config_suppression_ranger.usersync.group.objectclass true
Suppress Configuration Validator: Usersync Group Search Base Whether to suppress configuration warnings produced by the Usersync Group Search Base configuration validator. false role_config_suppression_ranger.usersync.group.searchbase true
Suppress Configuration Validator: Usersync Group Search Filter Whether to suppress configuration warnings produced by the Usersync Group Search Filter configuration validator. false role_config_suppression_ranger.usersync.group.searchfilter true
Suppress Configuration Validator: Usersync Bind User Whether to suppress configuration warnings produced by the Usersync Bind User configuration validator. false role_config_suppression_ranger.usersync.ldap.binddn true
Suppress Configuration Validator: Usersync Search Base Whether to suppress configuration warnings produced by the Usersync Search Base configuration validator. false role_config_suppression_ranger.usersync.ldap.searchbase true
Suppress Configuration Validator: Usersync LDAP/AD URL Whether to suppress configuration warnings produced by the Usersync LDAP/AD URL configuration validator. false role_config_suppression_ranger.usersync.ldap.url true
Suppress Configuration Validator: Usersync User Group Name Attribute Whether to suppress configuration warnings produced by the Usersync User Group Name Attribute configuration validator. false role_config_suppression_ranger.usersync.ldap.user.groupnameattribute true
Suppress Configuration Validator: Usersync User Name Attribute Whether to suppress configuration warnings produced by the Usersync User Name Attribute configuration validator. false role_config_suppression_ranger.usersync.ldap.user.nameattribute true
Suppress Configuration Validator: Usersync User Object Class Whether to suppress configuration warnings produced by the Usersync User Object Class configuration validator. false role_config_suppression_ranger.usersync.ldap.user.objectclass true
Suppress Configuration Validator: Usersync User Search Base Whether to suppress configuration warnings produced by the Usersync User Search Base configuration validator. false role_config_suppression_ranger.usersync.ldap.user.searchbase true
Suppress Configuration Validator: Usersync User Search Filter Whether to suppress configuration warnings produced by the Usersync User Search Filter configuration validator. false role_config_suppression_ranger.usersync.ldap.user.searchfilter true
Suppress Configuration Validator: Ranger Usersync Policymgr Username Whether to suppress configuration warnings produced by the Ranger Usersync Policymgr Username configuration validator. false role_config_suppression_ranger.usersync.policymgr.username true
Suppress Configuration Validator: Unix Auth Service Hostname Whether to suppress configuration warnings produced by the Unix Auth Service Hostname configuration validator. false role_config_suppression_ranger.usersync.port true
Suppress Configuration Validator: Ranger Usersync Role Assignment List Delimiter Whether to suppress configuration warnings produced by the Ranger Usersync Role Assignment List Delimiter configuration validator. false role_config_suppression_ranger.usersync.role.assignment.list.delimiter true
Suppress Configuration Validator: Ranger Usersync Username Groupname Assignment List Delimiter Whether to suppress configuration warnings produced by the Ranger Usersync Username Groupname Assignment List Delimiter configuration validator. false role_config_suppression_ranger.usersync.username.groupname.assignment.list.delimiter true
Suppress Configuration Validator: Ranger Usersync User Groups Assignment List Delimiter Whether to suppress configuration warnings produced by the Ranger Usersync User Groups Assignment List Delimiter configuration validator. false role_config_suppression_ranger.usersync.users.groups.assignment.list.delimiter true
Suppress Configuration Validator: Ranger Admin Conf Path Whether to suppress configuration warnings produced by the Ranger Admin Conf Path configuration validator. false role_config_suppression_ranger_admin_conf_path true
Suppress Configuration Validator: Ranger Admin Max Heapsize Whether to suppress configuration warnings produced by the Ranger Admin Max Heapsize configuration validator. false role_config_suppression_ranger_admin_max_heap_size true
Suppress Configuration Validator: Ranger Admin Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ranger Admin Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_ranger_admin_role_env_safety_valve true
Suppress Configuration Validator: Ranger Database Host Whether to suppress configuration warnings produced by the Ranger Database Host configuration validator. false role_config_suppression_ranger_database_host true
Suppress Configuration Validator: Ranger Database Name Whether to suppress configuration warnings produced by the Ranger Database Name configuration validator. false role_config_suppression_ranger_database_name true
Suppress Configuration Validator: Ranger Database User Password Whether to suppress configuration warnings produced by the Ranger Database User Password configuration validator. false role_config_suppression_ranger_database_password true
Suppress Configuration Validator: Ranger Database User Whether to suppress configuration warnings produced by the Ranger Database User configuration validator. false role_config_suppression_ranger_database_user true
Suppress Configuration Validator: Admin AD Auth Bind Password Whether to suppress configuration warnings produced by the Admin AD Auth Bind Password configuration validator. false role_config_suppression_ranger_ldap_ad_bind_password true
Suppress Configuration Validator: Admin LDAP Auth Bind User Password Whether to suppress configuration warnings produced by the Admin LDAP Auth Bind User Password configuration validator. false role_config_suppression_ranger_ldap_bind_password true
Suppress Configuration Validator: Knox Proxy User Groups Whether to suppress configuration warnings produced by the Knox Proxy User Groups configuration validator. false role_config_suppression_ranger_proxyuser_knox_groups true
Suppress Configuration Validator: Knox Proxy User Hosts Whether to suppress configuration warnings produced by the Knox Proxy User Hosts configuration validator. false role_config_suppression_ranger_proxyuser_knox_hosts true
Suppress Configuration Validator: Knox Proxy User Users Whether to suppress configuration warnings produced by the Knox Proxy User Users configuration validator. false role_config_suppression_ranger_proxyuser_knox_users true
Suppress Configuration Validator: Ranger Tagsync Conf Path Whether to suppress configuration warnings produced by the Ranger Tagsync Conf Path configuration validator. false role_config_suppression_ranger_tagsync_conf_path true
Suppress Configuration Validator: Ranger Tagsync Max Heapsize Whether to suppress configuration warnings produced by the Ranger Tagsync Max Heapsize configuration validator. false role_config_suppression_ranger_tagsync_max_heap_size true
Suppress Configuration Validator: Ranger Tagsync Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ranger Tagsync Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_ranger_tagsync_role_env_safety_valve true
Suppress Configuration Validator: Ranger Tomcat Work Dir Whether to suppress configuration warnings produced by the Ranger Tomcat Work Dir configuration validator. false role_config_suppression_ranger_tomcat_work_dir true
Suppress Configuration Validator: Ranger Usersync Conf Path Whether to suppress configuration warnings produced by the Ranger Usersync Conf Path configuration validator. false role_config_suppression_ranger_usersync_conf_path true
Suppress Configuration Validator: Usersync Bind User Password Whether to suppress configuration warnings produced by the Usersync Bind User Password configuration validator. false role_config_suppression_ranger_usersync_ldap_ldapbindpassword true
Suppress Configuration Validator: Ranger Usersync Max Heapsize Whether to suppress configuration warnings produced by the Ranger Usersync Max Heapsize configuration validator. false role_config_suppression_ranger_usersync_max_heap_size true
Suppress Configuration Validator: Ranger Usersync Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the Ranger Usersync Environment Advanced Configuration Snippet (Safety Valve) configuration validator. false role_config_suppression_ranger_usersync_role_env_safety_valve true
Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings) Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator. false role_config_suppression_rm_custom_resources true
Suppress Configuration Validator: Role Triggers Whether to suppress configuration warnings produced by the Role Triggers configuration validator. false role_config_suppression_role_triggers true
Suppress Configuration Validator: Ranger Admin TLS/SSL Client Trust Store File Whether to suppress configuration warnings produced by the Ranger Admin TLS/SSL Client Trust Store File configuration validator. false role_config_suppression_ssl_client_truststore_location true
Suppress Configuration Validator: Ranger Admin TLS/SSL Client Trust Store Password Whether to suppress configuration warnings produced by the Ranger Admin TLS/SSL Client Trust Store Password configuration validator. false role_config_suppression_ssl_client_truststore_password true
Suppress Configuration Validator: Ranger Admin TLS/SSL Server JKS Keystore File Location Whether to suppress configuration warnings produced by the Ranger Admin TLS/SSL Server JKS Keystore File Location configuration validator. false role_config_suppression_ssl_server_keystore_location true
Suppress Configuration Validator: Ranger Admin TLS/SSL Server JKS Keystore File Password Whether to suppress configuration warnings produced by the Ranger Admin TLS/SSL Server JKS Keystore File Password configuration validator. false role_config_suppression_ssl_server_keystore_password true
Suppress Configuration Validator: Stacks Collection Directory Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. false role_config_suppression_stacks_collection_directory true
Suppress Parameter Validation: Ranger KMS Keyadmin User Initial Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger KMS Keyadmin User Initial Password parameter. false service_config_suppression_keyadmin_user_password true
Suppress Parameter Validation: Load Balancer Address Whether to suppress configuration warnings produced by the built-in parameter validation for the Load Balancer Address parameter. false service_config_suppression_load_balancer_url true
Suppress Parameter Validation: System Group Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. false service_config_suppression_process_groupname true
Suppress Parameter Validation: System User Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. false service_config_suppression_process_username true
Suppress Configuration Validator: Ranger Admin Count Validator Whether to suppress configuration warnings produced by the Ranger Admin Count Validator configuration validator. false service_config_suppression_ranger_admin_count_validator true
Suppress Parameter Validation: Ranger Plugin DFS Audit URL Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin DFS Audit URL parameter. false service_config_suppression_ranger_plugin_hdfs_audit_url true
Suppress Parameter Validation: Ranger Service Environment Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Service Environment Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_ranger_service_env_safety_valve true
Suppress Parameter Validation: Admin HTTP Port Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin HTTP Port parameter. false service_config_suppression_ranger_service_http_port true
Suppress Parameter Validation: Admin HTTPS port Whether to suppress configuration warnings produced by the built-in parameter validation for the Admin HTTPS port parameter. false service_config_suppression_ranger_service_https_port true
Suppress Configuration Validator: Ranger Tagsync Count Validator Whether to suppress configuration warnings produced by the Ranger Tagsync Count Validator configuration validator. false service_config_suppression_ranger_tagsync_count_validator true
Suppress Configuration Validator: Ranger Usersync Count Validator Whether to suppress configuration warnings produced by the Ranger Usersync Count Validator configuration validator. false service_config_suppression_ranger_usersync_count_validator true
Suppress Parameter Validation: Ranger Admin User Initial Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Admin User Initial Password parameter. false service_config_suppression_rangeradmin_user_password true
Suppress Parameter Validation: Ranger Tagsync User Initial Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Tagsync User Initial Password parameter. false service_config_suppression_rangertagsync_user_password true
Suppress Parameter Validation: Ranger Usersync User Initial Password Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Usersync User Initial Password parameter. false service_config_suppression_rangerusersync_user_password true
Suppress Parameter Validation: Service Triggers Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter. false service_config_suppression_service_triggers true
Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter. false service_config_suppression_smon_derived_configs_safety_valve true
Suppress Health Test: Ranger Admin Health Whether to suppress the results of the Ranger Admin Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false service_health_suppression_ranger_ranger_admin_healthy true
Suppress Health Test: Ranger Tagsync Health Whether to suppress the results of the Ranger Tagsync Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false service_health_suppression_ranger_ranger_ranger_tagsync_health true
Suppress Health Test: Ranger Usersync Health Whether to suppress the results of the Ranger Usersync Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. false service_health_suppression_ranger_ranger_ranger_usersync_health true