Solr Properties in Cloudera Runtime 7.0.0
Role groups:
Gateway
Categories:
Advanced
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Deploy Directory | The directory where the client configs will be deployed | /etc/solr |
client_config_root_dir
|
true | |
| Gateway 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 |
Logs
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Gateway Logging Threshold | The minimum log level for Gateway logs | INFO |
log_threshold
|
false |
Monitoring
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Enable Configuration Change Alerts | When set, Cloudera Manager will send alerts when this entity's configuration changes. | false |
enable_config_alerts
|
false |
Other
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Alternatives Priority | The priority level that the client configuration will have in the Alternatives system on the hosts. Higher priority levels will cause Alternatives to prefer this configuration over any others. | 90 |
client_config_priority
|
true |
Suppressions
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Suppress Configuration Validator: CDH Version Validator | Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator. | false |
role_config_suppression_cdh_version_validator
|
true | |
| Suppress Parameter Validation: Deploy Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter. | false |
role_config_suppression_client_config_root_dir
|
true | |
| Suppress Parameter Validation: Gateway Logging Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_log4j_safety_valve
|
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. | solr |
process_groupname
|
true | |
| System User | The user that this service's processes should run as. | solr |
process_username
|
true | |
| Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-audit.xml | For advanced use only, a string to be inserted into ranger-solr-audit.xml. Applies to configurations of all roles in this service except client configuration. |
ranger_audit_safety_valve
|
false | ||
| Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-security.xml | For advanced use only, a string to be inserted into ranger-solr-security.xml. Applies to configurations of all roles in this service except client configuration. |
ranger_security_safety_valve
|
false | ||
| Solr Service Advanced Configuration Snippet (Safety Valve) for core-site.xml | For advanced use only, a string to be inserted into core-site.xml. Applies to configurations of all roles in this service except client configuration. |
solr_core_site_safety_valve
|
false | ||
| Solr 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. |
solr_env_safety_valve
|
false | ||
| Solr Service Advanced Configuration Snippet (Safety Valve) for hdfs-site.xml | For advanced use only, a string to be inserted into hdfs-site.xml. Applies to configurations of all roles in this service except client configuration. |
solr_hdfs_site_safety_valve
|
false | ||
| Enable Solrd Watchdog | Enable the background watchdog thread that can kill Catalina process if Solr is not responsive. | true |
solrd_enable_watchdog
|
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 | |
| Service Triggers | The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad",
"streamThreshold": 10, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
service_triggers
|
true | |
| Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) | For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones. |
smon_derived_configs_safety_valve
|
false | ||
| Healthy Solr Server Monitoring Thresholds | The health test thresholds of the overall Solr Server health. The check returns "Concerning" health if the percentage of "Healthy" Solr Servers falls below the warning threshold. The check is unhealthy if the total percentage of "Healthy" and "Concerning" Solr Servers falls below the critical threshold. | Warning: 95.0 %, Critical: 90.0 % |
solr_solr_servers_healthy_thresholds
|
false |
Other
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| HDFS Data Directory | HDFS directory used for storage by this Solr service. | /solr |
hdfs_data_dir
|
true | |
| HDFS Service | Name of the HDFS service that this Search service instance depends on |
hdfs_service
|
true | ||
| Ranger Plugin Trusted Proxy IP Address | Accepts a list of IP addresses of proxy servers for trusting. |
ranger.plugin.solr.trusted.proxy.ipaddress
|
ranger_plugin_trusted_proxy_ipaddress
|
false | |
| Ranger Plugin Use X-Forwarded for IP Address | The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs. |
ranger.plugin.solr.use.x-forwarded-for.ipaddress
|
false |
ranger_plugin_use_x_forwarded_for_ipaddress
|
false |
| Ranger Service | Name of the Ranger service that this Solr service instance depends on |
ranger_service
|
false | ||
| Solr Server for Upgrade | Solr server to be used while upgrading from CDH 5 to CDH 6. |
solr_server_for_upgrade
|
false | ||
| Upgrade Backup Directory | Directory on the HDFS file system that is used as the backup directory while upgrading from CDH 5 to CDH 6. | /user/solr/upgrade_backup |
solr_upgrade_backup_dir
|
false | |
| Upgrade Metadata Directory | Directory on the local file system containing the migrated configurations and metadata required while upgrading from CDH 5 to CDH 6. Note: This directory should be present in the Solr Server specified in s'Solr Server for Upgrade'. | /var/lib/upgrade/c6_config |
solr_upgrade_metadata_dir
|
true | |
| Solrd Watchdog Timeout | If Solr does not respond on its web URL within this time interval, the Catalina process is killed. | 1 minute(s), 10 second(s) |
solrd_watchdog_timeout
|
false | |
| ZooKeeper Service | Name of the ZooKeeper service that this Search service instance depends on |
zookeeper_service
|
true | ||
| ZooKeeper Znode | ZooKeeper znode used to store information about this Solr service. | /solr |
zookeeper_znode
|
true |
Security
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Enable Ranger Authorization for the Infrastructure Solr Service | Enable fine-grained security using Ranger for the infrastructure (infra) Solr service. This option is only for the Solr service that the Ranger service is using (for ranger-audits, etc.). No other Solr service can or should enable this option. | false |
enable_ranger_authorization
|
false | |
| Kerberos Principal | Kerberos principal short name used by all roles of this service. | solr |
kerberos_princ_name
|
true | |
| Active Directory Domain | Use this field for Active Directory configurations only, when combined with a simple username value in the "LDAP Bind User Distinguished Name" field, it will result in a UPM of user@example.com used for search/bind operations for authenticated user lookups. |
ldap_domain
|
false | ||
| Ranger DFS Audit Path | The DFS path on which Ranger audits are written. The special placeholder '${ranger_base_audit_url}' should be used as the prefix, in order to use the centralized location defined in the Ranger service. |
xasecure.audit.destination.hdfs.dir
|
$ranger_base_audit_url/solr |
ranger_audit_hdfs_dir
|
false |
| Ranger Audit DFS Spool Dir | Spool directory for Ranger audits being written to DFS. |
xasecure.audit.destination.hdfs.batch.filespool.dir
|
/var/log/solr/audit/hdfs/spool |
ranger_audit_hdfs_spool_dir
|
false |
| Ranger Audit Solr Spool Dir | Spool directory for Ranger audits being written to Solr. |
xasecure.audit.destination.solr.batch.filespool.dir
|
/var/log/solr/audit/solr/spool |
ranger_audit_solr_spool_dir
|
false |
| Ranger Policy Cache Directory | The directory where Ranger security policies are cached locally. |
ranger.plugin.solr.policy.cache.dir
|
/var/lib/ranger/solr/policy-cache |
ranger_policy_cache_dir
|
false |
| Enable LDAP Authentication | When checked, LDAP-based authentication for users is enabled. | false |
solr_enable_ldap_auth
|
false | |
| Solr 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 Solr is acting as a TLS/SSL server. The keystore must be in JKS format. |
solr_https_keystore_file
|
false | ||
| Solr TLS/SSL Server JKS Keystore File Password | The password for the Solr JKS keystore file. |
solr.jetty.keystore.password
|
solr_https_keystore_password
|
false | |
| Solr 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 Solr might connect to. This is used when Solr 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. |
solr_https_truststore_file
|
false | ||
| Solr TLS/SSL Client Trust Store Password | The password for the Solr 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. |
solr.jetty.truststore.password
|
solr_https_truststore_password
|
false | |
| LDAP BaseDN | This parameter is useful when authenticating against a non-Active Directory server, such as OpenLDAP. When set, this parameter is used to convert the username into the LDAP Distinguished Name (DN), so that the resulting DN looks like uid=username,this parameter. For example, if this parameter is set to "ou=People,dc=cloudera,dc=com", and the username passed in is "mike", the resulting authentication passed to the LDAP server look like "uid=mike,ou=People,dc=cloudera,dc=com". This parameter is mutually exclusive with Active Directory Domain. |
solr_ldap_basedn
|
false | ||
| Enable LDAP TLS | If true, attempts to establish a TLS (Transport Layer Security) connection with an LDAP server that was specified with ldap://. Not required when using an LDAP URL with prefix ldaps://, because that already specifies TLS. This option is also known as "Use StartTLS". | false |
solr_ldap_enable_starttls
|
false | |
| LDAP URL | The URL of the LDAP Server. The URL must be prefixed with ldap:// or ldaps:// . The URL can optionally specify a custom port if necessary, but by default the ldap:// will connect to port 389, and the ldaps:// will connect to port 636. Note that passwords will be in the clear if ldap:// is used, and by fall 2020 Active directory servers will no longer allow non LDAPS connections to bind to AD hosts with LDAP signing enabled. See microsoft knowledge document 935834 for more information. |
solr_ldap_uri
|
false | ||
| Solr Secure Authentication | Choose the authentication mechanism used by Solr. | simple |
solr_security_authentication
|
false | |
| Enable TLS/SSL for Solr | Encrypt communication between clients and Solr using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)). Additional manual steps must be performed; see Enabling TLS/SSL for Solr. | false |
solr_use_ssl
|
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 Configuration Validator: Deploy Directory | Whether to suppress configuration warnings produced by the Deploy Directory configuration validator. | false |
role_config_suppression_client_config_root_dir
|
true | |
| Suppress Configuration Validator: Solr Server Logging Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Solr Server Logging Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_log4j_safety_valve
|
true | |
| Suppress Configuration Validator: Heap Dump Directory | Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator. | false |
role_config_suppression_oom_heap_dump_dir
|
true | |
| Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator. | false |
role_config_suppression_rm_custom_resources
|
true | |
| Suppress Configuration Validator: Role Triggers | Whether to suppress configuration warnings produced by the Role Triggers configuration validator. | false |
role_config_suppression_role_triggers
|
true | |
| Suppress Configuration Validator: Solr Admin Port | Whether to suppress configuration warnings produced by the Solr Admin Port configuration validator. | false |
role_config_suppression_solr_admin_port
|
true | |
| Suppress Configuration Validator: Solr Data Directory | Whether to suppress configuration warnings produced by the Solr Data Directory configuration validator. | false |
role_config_suppression_solr_data_dir
|
true | |
| Suppress Configuration Validator: Solr HTTP Port | Whether to suppress configuration warnings produced by the Solr HTTP Port configuration validator. | false |
role_config_suppression_solr_http_port
|
true | |
| Suppress Configuration Validator: Solr HTTPS port | Whether to suppress configuration warnings produced by the Solr HTTPS port configuration validator. | false |
role_config_suppression_solr_https_port
|
true | |
| Suppress Configuration Validator: Java Heap Size of Solr Server in Bytes | Whether to suppress configuration warnings produced by the Java Heap Size of Solr Server in Bytes configuration validator. | false |
role_config_suppression_solr_java_heapsize
|
true | |
| Suppress Configuration Validator: Java Configuration Options for Solr Server | Whether to suppress configuration warnings produced by the Java Configuration Options for Solr Server configuration validator. | false |
role_config_suppression_solr_java_opts
|
true | |
| Suppress Configuration Validator: Solr Load Balancer | Whether to suppress configuration warnings produced by the Solr Load Balancer configuration validator. | false |
role_config_suppression_solr_load_balancer
|
true | |
| Suppress Configuration Validator: Solr Server Log Directory | Whether to suppress configuration warnings produced by the Solr Server Log Directory configuration validator. | false |
role_config_suppression_solr_log_dir
|
true | |
| Suppress Configuration Validator: Solr Plugins Directory | Whether to suppress configuration warnings produced by the Solr Plugins Directory configuration validator. | false |
role_config_suppression_solr_plugins_dir
|
true | |
| Suppress Configuration Validator: Solr Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the Solr Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator. | false |
role_config_suppression_solr_server_role_env_safety_valve
|
true | |
| Suppress Configuration Validator: Stacks Collection Directory | Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator. | false |
role_config_suppression_stacks_collection_directory
|
true | |
| Suppress Configuration Validator: Gateway Count Validator | Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator. | false |
service_config_suppression_gateway_count_validator
|
true | |
| Suppress Parameter Validation: HDFS Data Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Data Directory parameter. | false |
service_config_suppression_hdfs_data_dir
|
true | |
| Suppress Parameter Validation: Kerberos Principal | Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter. | false |
service_config_suppression_kerberos_princ_name
|
true | |
| Suppress Parameter Validation: Active Directory Domain | Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Directory Domain parameter. | false |
service_config_suppression_ldap_domain
|
true | |
| Suppress Parameter Validation: System Group | Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter. | false |
service_config_suppression_process_groupname
|
true | |
| Suppress Parameter Validation: System User | Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter. | false |
service_config_suppression_process_username
|
true | |
| Suppress Parameter Validation: Ranger DFS Audit Path | Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger DFS Audit Path parameter. | false |
service_config_suppression_ranger_audit_hdfs_dir
|
true | |
| Suppress Parameter Validation: Ranger Audit DFS Spool Dir | Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit DFS Spool Dir parameter. | false |
service_config_suppression_ranger_audit_hdfs_spool_dir
|
true | |
| Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-audit.xml | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-audit.xml parameter. | false |
service_config_suppression_ranger_audit_safety_valve
|
true | |
| Suppress Parameter Validation: Ranger Audit Solr Spool Dir | Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit Solr Spool Dir parameter. | false |
service_config_suppression_ranger_audit_solr_spool_dir
|
true | |
| Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address | Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter. | false |
service_config_suppression_ranger_plugin_trusted_proxy_ipaddress
|
true | |
| Suppress Parameter Validation: Ranger Policy Cache Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Policy Cache Directory parameter. | false |
service_config_suppression_ranger_policy_cache_dir
|
true | |
| Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-security.xml | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-security.xml parameter. | false |
service_config_suppression_ranger_security_safety_valve
|
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 Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for core-site.xml | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Service Advanced Configuration Snippet (Safety Valve) for core-site.xml parameter. | false |
service_config_suppression_solr_core_site_safety_valve
|
true | |
| Suppress Parameter Validation: Solr Service Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Service Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
service_config_suppression_solr_env_safety_valve
|
true | |
| Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for hdfs-site.xml | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Service Advanced Configuration Snippet (Safety Valve) for hdfs-site.xml parameter. | false |
service_config_suppression_solr_hdfs_site_safety_valve
|
true | |
| Suppress Parameter Validation: Solr TLS/SSL Server JKS Keystore File Location | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Server JKS Keystore File Location parameter. | false |
service_config_suppression_solr_https_keystore_file
|
true | |
| Suppress Parameter Validation: Solr TLS/SSL Server JKS Keystore File Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Server JKS Keystore File Password parameter. | false |
service_config_suppression_solr_https_keystore_password
|
true | |
| Suppress Parameter Validation: Solr TLS/SSL Client Trust Store File | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Client Trust Store File parameter. | false |
service_config_suppression_solr_https_truststore_file
|
true | |
| Suppress Parameter Validation: Solr TLS/SSL Client Trust Store Password | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Client Trust Store Password parameter. | false |
service_config_suppression_solr_https_truststore_password
|
true | |
| Suppress Parameter Validation: LDAP BaseDN | Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP BaseDN parameter. | false |
service_config_suppression_solr_ldap_basedn
|
true | |
| Suppress Configuration Validator: LDAP TLS Validator | Whether to suppress configuration warnings produced by the LDAP TLS Validator configuration validator. | false |
service_config_suppression_solr_ldap_tls_validator
|
true | |
| Suppress Parameter Validation: LDAP URL | Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP URL parameter. | false |
service_config_suppression_solr_ldap_uri
|
true | |
| Suppress Configuration Validator: LDAP Secure URI and Start TLS Validator | Whether to suppress configuration warnings produced by the LDAP Secure URI and Start TLS Validator configuration validator. | false |
service_config_suppression_solr_ldaps_or_tls_validator
|
true | |
| Suppress Configuration Validator: Solr Server Count Validator | Whether to suppress configuration warnings produced by the Solr Server Count Validator configuration validator. | false |
service_config_suppression_solr_server_count_validator
|
true | |
| Suppress Parameter Validation: Upgrade Backup Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Upgrade Backup Directory parameter. | false |
service_config_suppression_solr_upgrade_backup_dir
|
true | |
| Suppress Parameter Validation: Upgrade Metadata Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Upgrade Metadata Directory parameter. | false |
service_config_suppression_solr_upgrade_metadata_dir
|
true | |
| Suppress Parameter Validation: Solrd Watchdog Timeout | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solrd Watchdog Timeout parameter. | false |
service_config_suppression_solrd_watchdog_timeout
|
true | |
| Suppress Parameter Validation: ZooKeeper Znode | Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Znode parameter. | false |
service_config_suppression_zookeeper_znode
|
true | |
| Suppress Health Test: Solr Server Health | Whether to suppress the results of the Solr Server Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts. | false |
service_health_suppression_solr_solr_servers_healthy
|
true |
Solr Server
Categories:
Advanced
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Solr Server Logging Advanced Configuration Snippet (Safety Valve) | For advanced use only, a string to be inserted into log4j.properties for this role only. |
log4j_safety_valve
|
false | ||
| Heap Dump Directory | Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, role user must have write access to this directory. If this directory is shared among multiple roles, it should have 1777 permissions. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role. |
oom_heap_dump_dir
|
/tmp |
oom_heap_dump_dir
|
false |
| Dump Heap When Out of Memory | When set, generates heap dump file when java.lang.OutOfMemoryError is thrown. | true |
oom_heap_dump_enabled
|
true | |
| Kill When Out of Memory | When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown. | true |
oom_sigkill_enabled
|
true | |
| Automatically Restart Process | When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period. | false |
process_auto_restart
|
true | |
| Enable Metric Collection | Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process. | true |
process_should_monitor
|
true | |
| Process Start Retry Attempts | Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period. | 3 |
process_start_retries
|
false | |
| Process Start Wait Timeout | The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature. | 20 |
process_start_secs
|
false | |
| Java Configuration Options for Solr Server | These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. Note: When CM version is 6.3.0 or greater, {{JAVA_GC_ARGS}} will be replaced by JVM Garbage Collection arguments based on the runtime Java JVM version. | JAVA_GC_ARGS |
solr_java_opts
|
false | |
| Solr Server Environment Advanced Configuration Snippet (Safety Valve) | For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration. |
SOLR_SERVER_role_env_safety_valve
|
false | ||
| ZooKeeper Client Timeout | The time in milliseconds a client is allowed to not talk to ZooKeeper before its session expires. |
zkClientTimeout
|
15 second(s) |
zookeeper_client_timeout
|
true |
Logs
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Solr Server Logging Threshold | The minimum log level for Solr Server logs | INFO |
log_threshold
|
false | |
| Solr Server Maximum Log File Backups | The maximum number of rolled log files to keep for Solr Server logs. Typically used by log4j or logback. | 10 |
max_log_backup_index
|
false | |
| Solr Server Max Log Size | The maximum size, in megabytes, per log file for Solr Server logs. Typically used by log4j or logback. | 200 MiB |
max_log_size
|
false | |
| Solr Server Log Directory | Directory where Solr Server will place its log files. | /var/log/solr |
solr_log_dir
|
true |
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 | |
| Heap Dump Directory Free Space Monitoring Absolute Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. | Warning: 10 GiB, Critical: 5 GiB |
heap_dump_directory_free_space_absolute_thresholds
|
false | |
| Heap Dump Directory Free Space Monitoring Percentage Thresholds | The health test thresholds for monitoring of free space on the filesystem that contains this role's heap dump directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Heap Dump Directory Free Space Monitoring Absolute Thresholds setting is configured. | Warning: Never, Critical: Never |
heap_dump_directory_free_space_percentage_thresholds
|
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 | |
| Navigator Audit Failure Thresholds | The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server. |
mgmt.navigator.failure.thresholds
|
Warning: Never, Critical: Any |
mgmt_navigator_failure_thresholds
|
false |
| Monitoring Period For Audit Failures | The period to review when checking if audits are blocked and not getting processed. |
mgmt.navigator.failure.window
|
20 minute(s) |
mgmt_navigator_failure_window
|
false |
| Navigator Audit Pipeline Health Check | Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit. |
mgmt.navigator.status.check.enabled
|
true |
mgmt_navigator_status_check_enabled
|
false |
| Metric Filter | Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:
jvm_heap_used_mb metric:
{
"includeHealthTestMetricSet": true,
"filterType": "whitelist",
"metrics": ["jvm_heap_used_mb"]
} |
monitoring_metric_filter
|
false | ||
| Process Swap Memory Thresholds | The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold. | Warning: 200 B, Critical: Never |
process_swap_memory_thresholds
|
false | |
| Role Triggers | The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:
[{"triggerName": "sample-trigger",
"triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
"streamThreshold": 0, "enabled": "true"}]See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases. |
[] |
role_triggers
|
true | |
| Solr Server API Liveness | Enables the health test that the Cloudera Manager Agent can successfully contact and gather status of Solr Cores from the Solr Server with a simple API request. | true |
solr_core_status_collection_health_enabled
|
false | |
| Solr Server API Liveness Request Duration | The health test thresholds on the duration of the Solr Server API request. | Warning: 10 second(s), Critical: Never |
solr_core_status_collection_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 % |
solr_server_fd_thresholds
|
false | |
| Garbage Collection Duration Thresholds | The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time. | Warning: 30.0, Critical: 60.0 |
solr_server_gc_duration_thresholds
|
false | |
| Garbage Collection Duration Monitoring Period | The period to review when computing the moving average of garbage collection time. | 5 minute(s) |
solr_server_gc_duration_window
|
false | |
| Solr Server Host Health Test | When computing the overall Solr Server health, consider the host's health. | true |
solr_server_host_health_enabled
|
false | |
| Solr Server Process Health Test | Enables the health test that the Solr Server's process state is consistent with the role configuration | true |
solr_server_scm_health_enabled
|
false | |
| Web Metric Collection | Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server. | true |
solr_server_web_metric_collection_enabled
|
false | |
| Web Metric Collection Duration | The health test thresholds on the duration of the metrics request to the web server. | Warning: 10 second(s), Critical: Never |
solr_server_web_metric_collection_thresholds
|
false | |
| 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 |
|---|---|---|---|---|---|
| Solr Data Directory | Directory on local file system where Solr Server keeps the configurations for collections. | /var/lib/solr |
solr_data_dir
|
true | |
| Graceful Shutdown Timeout | Timeout (in seconds) for graceful shutdown of this Solr server. Once this timeout is reached, Solr server is abruptly shutdown. A value of 0 means no timeout. | 3 minute(s) |
solr_graceful_stop_timeout
|
false | |
| Solr Load Balancer | Address of the load balancer, specified in host:port format. |
solr_load_balancer
|
false | ||
| Solr Plugins Directory | Directory on local file system where Solr Server can find additional JARs. This directory is not monitored for changes during the lifetime of a solr server, and a restart is required to read any updates to the directory contents. |
solr_plugins_dir
|
false |
Performance
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Maximum Process File Descriptors | If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value. |
rlimit_fds
|
false | ||
| Solr Max Connector Threads | The maximum number of request processing threads to be created by Solr server, which determines the maximum number of simultaneous requests that can be handled. | 10000 |
solr_max_connector_thread
|
true |
Ports and Addresses
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Solr Admin Port | Admin port of the Solr Server. | 8984 |
solr_admin_port
|
true | |
| Solr HTTP Port | HTTP port of Solr Server. |
solr_http_port
|
8983 |
solr_http_port
|
true |
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 |
| HDFS Block Cache Blocks per Slab | Number of blocks per cache slab. The size of the cache is 8 KB (the block size) times the number of blocks per slab times the number of slabs. |
solr.hdfs.blockcache.blocksperbank
|
16384 |
solr_hdfs_blockcache_blocksperbank
|
true |
| HDFS Block Cache Off-Heap Memory | Use off-heap memory when caching HDFS blocks in Solr. |
solr.hdfs.blockcache.direct.memory.allocation
|
true |
solr_hdfs_blockcache_direct_memory_allocation
|
true |
| HDFS Block Cache | Enable caching of HDFS blocks in Solr. There is one block cache per Solr collection. configured to use off-heap memory, Maximum Off-Heap Memory must be set high enough to account for all block caches. |
solr.hdfs.blockcache.enabled
|
true |
solr_hdfs_blockcache_enabled
|
true |
| HDFS Block Cache Number of Slabs | Number of slabs per block cache. The size of the cache is 8 KB (the block size) times the number of blocks per slab times the number of slabs. |
solr.hdfs.blockcache.slab.count
|
1 |
solr_hdfs_blockcache_slab_count
|
true |
| Java Direct Memory Size of Solr Server in Bytes | Maximum amount of off-heap memory in bytes that may be allocated by the Java process. Passed to Java -XX:MaxDirectMemorySize. If unset, defaults to the size of the heap. | 1 GiB |
solr_java_direct_memory_size
|
false | |
| Java Heap Size of Solr Server in Bytes | Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx. | 1 GiB |
solr_java_heapsize
|
false |
Security
| Display Name | Description | Related Name | Default Value | API Name | Required |
|---|---|---|---|---|---|
| Solr HTTPS port | HTTPS port of Solr Server. |
solr_https_port
|
8985 |
solr_https_port
|
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: Solr Server Logging Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Server Logging Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_log4j_safety_valve
|
true | |
| Suppress Parameter Validation: Heap Dump Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter. | false |
role_config_suppression_oom_heap_dump_dir
|
true | |
| Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter. | false |
role_config_suppression_rm_custom_resources
|
true | |
| Suppress Parameter Validation: Role Triggers | Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter. | false |
role_config_suppression_role_triggers
|
true | |
| Suppress Parameter Validation: Solr Admin Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Admin Port parameter. | false |
role_config_suppression_solr_admin_port
|
true | |
| Suppress Parameter Validation: Solr Data Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Data Directory parameter. | false |
role_config_suppression_solr_data_dir
|
true | |
| Suppress Parameter Validation: Solr HTTP Port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr HTTP Port parameter. | false |
role_config_suppression_solr_http_port
|
true | |
| Suppress Parameter Validation: Solr HTTPS port | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr HTTPS port parameter. | false |
role_config_suppression_solr_https_port
|
true | |
| Suppress Parameter Validation: Java Heap Size of Solr Server in Bytes | Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Solr Server in Bytes parameter. | false |
role_config_suppression_solr_java_heapsize
|
true | |
| Suppress Parameter Validation: Java Configuration Options for Solr Server | Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for Solr Server parameter. | false |
role_config_suppression_solr_java_opts
|
true | |
| Suppress Parameter Validation: Solr Load Balancer | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Load Balancer parameter. | false |
role_config_suppression_solr_load_balancer
|
true | |
| Suppress Parameter Validation: Solr Server Log Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Server Log Directory parameter. | false |
role_config_suppression_solr_log_dir
|
true | |
| Suppress Parameter Validation: Solr Plugins Directory | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Plugins Directory parameter. | false |
role_config_suppression_solr_plugins_dir
|
true | |
| Suppress Parameter Validation: Solr Server Environment Advanced Configuration Snippet (Safety Valve) | Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Server Environment Advanced Configuration Snippet (Safety Valve) parameter. | false |
role_config_suppression_solr_server_role_env_safety_valve
|
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: Solr Server API Liveness | Whether to suppress the results of the Solr Server API Liveness 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_solr_core_status_collection_health
|
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_solr_server_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_solr_server_file_descriptor
|
true | |
| Suppress Health Test: GC Duration | Whether to suppress the results of the GC Duration 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_solr_server_gc_duration
|
true | |
| Suppress Health Test: Heap Dump Directory Free Space | Whether to suppress the results of the Heap Dump 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_solr_server_heap_dump_directory_free_space
|
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_solr_server_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_solr_server_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_solr_server_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_solr_server_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_solr_server_unexpected_exits
|
true | |
| Suppress Health Test: Web Server Status | Whether to suppress the results of the Web Server 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_solr_server_web_metric_collection
|
true |
