Solr Properties in Cloudera Runtime 7.2.18

Role groups:

Gateway

Advanced

Deploy Directory

Description: The directory where the client configs will be deployed
Related Name
Default Value: /etc/solr
API Name: client_config_root_dir
Required: true

Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Logs

Gateway Logging Threshold

Description: The minimum log level for Gateway logs
Related Name
Default Value: INFO
API Name: log_threshold
Required: false

Monitoring

Enable Configuration Change Alerts

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

Other

Alternatives Priority

Description: 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.
Related Name
Default Value: 90
API Name: client_config_priority
Required: true

Suppressions

Suppress Configuration Validator: CDH Version Validator

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

Suppress Parameter Validation: Deploy Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Parameter Validation: Gateway Logging Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Gateway Logging Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Service-Wide

Advanced

System Group

Description: The group that this service's processes should run as.
Related Name
Default Value: solr
API Name: process_groupname
Required: true

System User

Description: The user that this service's processes should run as.
Related Name
Default Value: solr
API Name: process_username
Required: true

Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-audit.xml

Description: 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.
Related Name
Default Value
API Name: ranger_audit_safety_valve
Required: false

Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-policymgr-ssl.xml

Description: For advanced use only, a string to be inserted into ranger-solr-policymgr-ssl.xml. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: ranger_policymgr_ssl_safety_valve
Required: false

Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-security.xml

Description: 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.
Related Name
Default Value
API Name: ranger_security_safety_valve
Required: false

Solr Service Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: 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.
Related Name
Default Value
API Name: solr_core_site_safety_valve
Required: false

Solr Service Environment Advanced Configuration Snippet (Safety Valve)

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

Solr Service Advanced Configuration Snippet (Safety Valve) for hdfs-site.xml

Description: 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.
Related Name
Default Value
API Name: solr_hdfs_site_safety_valve
Required: false

Enable Solrd Watchdog

Description: Enable the background watchdog thread that can kill Catalina process if Solr is not responsive.
Related Name
Default Value: true
API Name: solrd_enable_watchdog
Required: false

Monitoring

Enable Service Level Health Alerts

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

Enable Configuration Change Alerts

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

Service Triggers

Description

The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:

triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
triggerExpression (mandatory) - A tsquery expression representing the trigger.
streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.

For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:

[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad",
  "streamThreshold": 10, "enabled": "true"}]

See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.

Related Name

Default Value

[]

API Name

service_triggers

Required

true

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

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

Healthy Solr Server Monitoring Thresholds

Description: 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.
Related Name
Default Value: Warning: 95.0 %, Critical: 90.0 %
API Name: solr_solr_servers_healthy_thresholds
Required: false

Other

HDFS Data Directory

Description: HDFS directory used for storage by this Solr service.
Related Name
Default Value: /solr
API Name: hdfs_data_dir
Required: true

HDFS Service

Description: Name of the HDFS service that this Search service instance depends on
Related Name
Default Value
API Name: hdfs_service
Required: true

Ranger Plugin Trusted Proxy IP Address

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

Ranger Plugin Use X-Forwarded for IP Address

Description: The parameter is used for identifying the originating IP address of a user connecting to a component through proxy for audit logs.
Related Name: ranger.plugin.solr.use.x-forwarded-for.ipaddress
Default Value: false
API Name: ranger_plugin_use_x_forwarded_for_ipaddress
Required: false

Ranger Service

Description: Name of the Ranger service that this Solr service instance depends on. This config is used for enabling Ranger authorization in the Solr instance not used by Ranger.
Related Name
Default Value
API Name: ranger_service
Required: false

Solr Server for Upgrade

Description: Solr server to be used while upgrading from CDH 5 to CDH 6 or to Cloudera Runtime 7.
Related Name
Default Value
API Name: solr_server_for_upgrade
Required: false

Upgrade Backup Directory

Description: Directory on the HDFS file system that is used as the backup directory while upgrading from CDH 5 to CDH 6 or to Cloudera Runtime 7.
Related Name
Default Value: /user/solr/upgrade_backup
API Name: solr_upgrade_backup_dir
Required: false

Upgrade Metadata Directory

Description: Directory on the local file system containing the migrated configurations and metadata required while upgrading from CDH 5 to CDH 6 or to Cloudera Runtime 7. Note: This directory should be present in the Solr Server specified in 'Solr Server for Upgrade'.
Related Name
Default Value: /var/lib/upgrade/solr_config
API Name: solr_upgrade_metadata_dir
Required: true

Solrd Watchdog Timeout

Description: If Solr does not respond on its web URL within this time interval, the Catalina process is killed.
Related Name
Default Value: 1 minute(s), 10 second(s)
API Name: solrd_watchdog_timeout
Required: false

ZooKeeper Service

Description: Name of the ZooKeeper service that this Search service instance depends on
Related Name
Default Value
API Name: zookeeper_service
Required: true

ZooKeeper Znode

Description: ZooKeeper znode used to store information about this Solr service.
Related Name
Default Value: /solr
API Name: zookeeper_znode
Required: true

Security

Enable Ranger Authorization for the Infrastructure Solr Service

Description: 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.
Related Name
Default Value: false
API Name: enable_ranger_authorization
Required: false

Kerberos Principal

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

Active Directory Domain

Description: 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.
Related Name
Default Value
API Name: ldap_domain
Required: false

Ranger DFS Audit Path

Description: 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.
Related Name: xasecure.audit.destination.hdfs.dir
Default Value: $ranger_base_audit_url/solr
API Name: ranger_audit_hdfs_dir
Required: false

Ranger Audit DFS Spool Dir

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

Ranger Audit Solr Spool Dir

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

Ranger Policy Cache Directory

Description: The directory where Ranger security policies are cached locally.
Related Name: ranger.plugin.solr.policy.cache.dir
Default Value: /var/lib/ranger/solr/policy-cache
API Name: ranger_policy_cache_dir
Required: false

Enable LDAP Authentication

Description: When checked, LDAP-based authentication for users is enabled.
Related Name
Default Value: false
API Name: solr_enable_ldap_auth
Required: false

Solr TLS/SSL Server Keystore File Location

Description: The path to the TLS/SSL keystore file containing the server certificate and private key used for TLS/SSL. Used when Solr is acting as a TLS/SSL server. The keystore must be in the format specified in Administration > Settings > Java Keystore Type.
Related Name
Default Value
API Name: solr_https_keystore_file
Required: false

Solr TLS/SSL Server Keystore File Password

Description: The password for the Solr keystore file.
Related Name: solr.jetty.keystore.password
Default Value
API Name: solr_https_keystore_password
Required: false

Solr TLS/SSL Trust Store File

Description: The location on disk of the trust store, in .jks format, used to confirm the authenticity of TLS/SSL servers that Solr might connect to. This trust store must contain the certificate(s) used to sign the service(s) connected to. If this parameter is not provided, the default list of well-known certificate authorities is used instead.
Related Name
Default Value
API Name: solr_https_truststore_file
Required: false

Solr TLS/SSL Trust Store Password

Description: The password for the Solr TLS/SSL Trust Store File. This password is not required to access the trust store; this field can be left blank. This password provides optional integrity checking of the file. The contents of trust stores are certificates, and certificates are public information.
Related Name: solr.jetty.truststore.password
Default Value
API Name: solr_https_truststore_password
Required: false

LDAP BaseDN

Description: 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.
Related Name
Default Value
API Name: solr_ldap_basedn
Required: false

Enable LDAP TLS

Description: 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".
Related Name
Default Value: false
API Name: solr_ldap_enable_starttls
Required: false

LDAP URL

Description: 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.
Related Name
Default Value
API Name: solr_ldap_uri
Required: false

Solr Secure Authentication

Description: Choose the authentication mechanism used by Solr.
Related Name
Default Value: simple
API Name: solr_security_authentication
Required: false

Enable TLS/SSL for Solr

Description: 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.
Related Name
Default Value: false
API Name: solr_use_ssl
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

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

Suppress Configuration Validator: Deploy Directory

Description: Whether to suppress configuration warnings produced by the Deploy Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Configuration Validator: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the JMX Exporter Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Configuration Validator: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the JMX Exporter configuration YAML configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

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

Description: Whether to suppress configuration warnings produced by the Solr Server Logging Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_log4j_safety_valve
Required: true

Suppress Configuration Validator: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the Heap Dump Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Exporters Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Extensions Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Processors Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Receivers Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Service Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Configuration Validator: Role Triggers

Description: Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Configuration Validator: Solr Admin Port

Description: Whether to suppress configuration warnings produced by the Solr Admin Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_admin_port
Required: true

Suppress Configuration Validator: Solr Data Directory

Description: Whether to suppress configuration warnings produced by the Solr Data Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_data_dir
Required: true

Suppress Configuration Validator: Solr HTTP Port

Description: Whether to suppress configuration warnings produced by the Solr HTTP Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_http_port
Required: true

Suppress Configuration Validator: Solr HTTPS port

Description: Whether to suppress configuration warnings produced by the Solr HTTPS port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_https_port
Required: true

Suppress Configuration Validator: Java Heap Size of Solr Server in Bytes

Description: Whether to suppress configuration warnings produced by the Java Heap Size of Solr Server in Bytes configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_java_heapsize
Required: true

Suppress Configuration Validator: Java Configuration Options for Solr Server

Description: Whether to suppress configuration warnings produced by the Java Configuration Options for Solr Server configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_java_opts
Required: true

Suppress Configuration Validator: Solr Load Balancer

Description: Whether to suppress configuration warnings produced by the Solr Load Balancer configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_load_balancer
Required: true

Suppress Configuration Validator: Solr Server Log Directory

Description: Whether to suppress configuration warnings produced by the Solr Server Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_log_dir
Required: true

Suppress Configuration Validator: Solr Plugins Directory

Description: Whether to suppress configuration warnings produced by the Solr Plugins Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_solr_plugins_dir
Required: true

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

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

Suppress Configuration Validator: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the Stacks Collection Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Configuration Validator: Gateway Count Validator

Description: Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_gateway_count_validator
Required: true

Suppress Parameter Validation: HDFS Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Data Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_hdfs_data_dir
Required: true

Suppress Parameter Validation: Kerberos Principal

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter.
Related Name
Default Value: false
API Name: service_config_suppression_kerberos_princ_name
Required: true

Suppress Parameter Validation: Active Directory Domain

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Directory Domain parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ldap_domain
Required: true

Suppress Parameter Validation: System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
Related Name
Default Value: false
API Name: service_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
Related Name
Default Value: false
API Name: service_config_suppression_process_username
Required: true

Suppress Parameter Validation: Ranger DFS Audit Path

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger DFS Audit Path parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_hdfs_dir
Required: true

Suppress Parameter Validation: Ranger Audit DFS Spool Dir

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit DFS Spool Dir parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_hdfs_spool_dir
Required: true

Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-audit.xml

Description: 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.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_safety_valve
Required: true

Suppress Parameter Validation: Ranger Audit Solr Spool Dir

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Audit Solr Spool Dir parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_audit_solr_spool_dir
Required: true

Suppress Parameter Validation: Ranger Plugin Trusted Proxy IP Address

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Ranger Plugin Trusted Proxy IP Address parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_plugin_trusted_proxy_ipaddress
Required: true

Suppress Parameter Validation: Ranger Policy Cache Directory

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

Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-policymgr-ssl.xml

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-policymgr-ssl.xml parameter.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_policymgr_ssl_safety_valve
Required: true

Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for ranger-solr-security.xml

Description: 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.
Related Name
Default Value: false
API Name: service_config_suppression_ranger_security_safety_valve
Required: true

Suppress Parameter Validation: Service Triggers

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

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

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

Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for core-site.xml

Description: 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.
Related Name
Default Value: false
API Name: service_config_suppression_solr_core_site_safety_valve
Required: true

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

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

Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for hdfs-site.xml

Description: 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.
Related Name
Default Value: false
API Name: service_config_suppression_solr_hdfs_site_safety_valve
Required: true

Suppress Parameter Validation: Solr TLS/SSL Server Keystore File Location

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

Suppress Parameter Validation: Solr TLS/SSL Server Keystore File Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Server Keystore File Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_solr_https_keystore_password
Required: true

Suppress Parameter Validation: Solr TLS/SSL Trust Store File

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Trust Store File parameter.
Related Name
Default Value: false
API Name: service_config_suppression_solr_https_truststore_file
Required: true

Suppress Parameter Validation: Solr TLS/SSL Trust Store Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Trust Store Password parameter.
Related Name
Default Value: false
API Name: service_config_suppression_solr_https_truststore_password
Required: true

Suppress Parameter Validation: LDAP BaseDN

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP BaseDN parameter.
Related Name
Default Value: false
API Name: service_config_suppression_solr_ldap_basedn
Required: true

Suppress Configuration Validator: LDAP TLS Validator

Description: Whether to suppress configuration warnings produced by the LDAP TLS Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_solr_ldap_tls_validator
Required: true

Suppress Parameter Validation: LDAP URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP URL parameter.
Related Name
Default Value: false
API Name: service_config_suppression_solr_ldap_uri
Required: true

Suppress Configuration Validator: LDAP Secure URI and Start TLS Validator

Description: Whether to suppress configuration warnings produced by the LDAP Secure URI and Start TLS Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_solr_ldaps_or_tls_validator
Required: true

Suppress Configuration Validator: Solr Server Count Validator

Description: Whether to suppress configuration warnings produced by the Solr Server Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_solr_server_count_validator
Required: true

Suppress Parameter Validation: Upgrade Backup Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Upgrade Backup Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_solr_upgrade_backup_dir
Required: true

Suppress Parameter Validation: Upgrade Metadata Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Upgrade Metadata Directory parameter.
Related Name
Default Value: false
API Name: service_config_suppression_solr_upgrade_metadata_dir
Required: true

Suppress Parameter Validation: Solrd Watchdog Timeout

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solrd Watchdog Timeout parameter.
Related Name
Default Value: false
API Name: service_config_suppression_solrd_watchdog_timeout
Required: true

Suppress Parameter Validation: ZooKeeper Znode

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Znode parameter.
Related Name
Default Value: false
API Name: service_config_suppression_zookeeper_znode
Required: true

Suppress Health Test: Solr Server Health

Description: 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.
Related Name
Default Value: false
API Name: service_health_suppression_solr_solr_servers_healthy
Required: true

Solr Server

Advanced

Solr Server Logging Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a string to be inserted into log4j.properties for this role only.
Related Name
Default Value
API Name: log4j_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Heap Dump Directory

Description: Path to directory where heap dumps are generated when java.lang.OutOfMemoryError error is thrown. This directory is automatically created if it does not exist. If this directory already exists, it will be owned by the current role user with 1777 permissions. Sharing the same directory among multiple roles will cause an ownership race. The heap dump files are created with 600 permissions and are owned by the role user. The amount of free space in this directory should be greater than the maximum Java Process heap size configured for this role.
Related Name: oom_heap_dump_dir
Default Value: /tmp
API Name: oom_heap_dump_dir
Required: false

Dump Heap When Out of Memory

Description: When set, generates a heap dump file when when an out-of-memory error occurs.
Related Name
Default Value: true
API Name: oom_heap_dump_enabled
Required: true

Kill When Out of Memory

Description: When set, a SIGKILL signal is sent to the role process when java.lang.OutOfMemoryError is thrown.
Related Name
Default Value: true
API Name: oom_sigkill_enabled
Required: true

Automatically Restart Process

Description: When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Enable Metric Collection

Description: Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Java Configuration Options for Solr Server

Description: These arguments will be passed as part of the Java command line. Commonly, garbage collection flags, PermGen, or extra debugging flags would be passed here. 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.
Related Name
Default Value: JAVA_GC_ARGS
API Name: solr_java_opts
Required: false

Solr Server Environment Advanced Configuration Snippet (Safety Valve)

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

ZooKeeper Client Timeout

Description: The time in milliseconds a client is allowed to not talk to ZooKeeper before its session expires.
Related Name: zkClientTimeout
Default Value: 15 second(s)
API Name: zookeeper_client_timeout
Required: true

Logs

Solr Server Logging Threshold

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

Solr Server Maximum Log File Backups

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

Solr Server Max Log Size

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

Solr Server Log Directory

Description: Directory where Solr Server will place its log files.
Related Name
Default Value: /var/log/solr
API Name: solr_log_dir
Required: true

Monitoring

Enable Health Alerts for this Role

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

Enable Configuration Change Alerts

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

Heap Dump Directory Free Space Monitoring Absolute Thresholds

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

Heap Dump Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: heap_dump_directory_free_space_percentage_thresholds
Required: false

Enable JMX Exporter (beta)

Description: JMX Exporter support is a beta feature. If enabled, CM configures the role to run JMX Exporter in agent mode with the provided port and YAML configuration. This exporter then can be used with the OpenTelemetry Collector feature. See the JMX Exporter documentation.
Related Name
Default Value: false
API Name: jmx_exporter_enabled
Required: true

JMX Exporter Port

Description: JMX Exporter needs a port to implement a Prometheus exporter.
Related Name
Default Value
API Name: jmx_exporter_port
Required: false

JMX Exporter configuration YAML

Description: This configuration is passed to JMX Exporter as it is. See the JMX Exporter documentation.
Related Name
Default Value
API Name: jmx_exporter_yaml
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

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

Log Directory Free Space Monitoring Percentage Thresholds

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

Navigator Audit Failure Thresholds

Description: 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.
Related Name: mgmt.navigator.failure.thresholds
Default Value: Warning: Never, Critical: Any
API Name: mgmt_navigator_failure_thresholds
Required: false

Monitoring Period For Audit Failures

Description: The period to review when checking if audits are blocked and not getting processed.
Related Name: mgmt.navigator.failure.window
Default Value: 20 minute(s)
API Name: mgmt_navigator_failure_window
Required: false

Navigator Audit Pipeline Health Check

Description: 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.
Related Name: mgmt.navigator.status.check.enabled
Default Value: true
API Name: mgmt_navigator_status_check_enabled
Required: false

Metric Filter

Description

Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:

Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.

If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:

Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb

You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:

{
  "includeHealthTestMetricSet": true, 
  "filterType": "whitelist",
  "metrics": ["jvm_heap_used_mb"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) auth: authenticator: basicauth/common tls: insecure_skip_verify: true retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: basicauth/common: client_auth: username: $ROLE_PARAM(otelcol_remote_write_user) password: '$ROLE_PARAM(otelcol_remote_write_password)'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:

triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression (mandatory) - A tsquery expression representing the trigger.
streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.

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"}]

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Solr Server API Liveness

Description: 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.
Related Name
Default Value: true
API Name: solr_core_status_collection_health_enabled
Required: false

Solr Server API Liveness Request Duration

Description: The health test thresholds on the duration of the Solr Server API request.
Related Name
Default Value: Warning: 10 second(s), Critical: Never
API Name: solr_core_status_collection_thresholds
Required: false

Solr Critical State Cores

Description: Enables the health test that checks for Solr cores in Down or Recovery Failed state on a Solr Server.
Related Name
Default Value: false
API Name: solr_critical_core_health_enabled
Required: false

Solr Critical State Cores Percentage

Description: The health test thresholds for the percentage of Solr cores in Down or Recovery Failed state on a Solr Server.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: solr_critical_core_thresholds
Required: false

Solr Recovering Cores

Description: Enables the health test that checks for Recovering Solr cores on a Solr Server.
Related Name
Default Value: false
API Name: solr_recovering_core_health_enabled
Required: false

Solr Recovering Cores Percentage

Description: The health test thresholds for the percentage of Solr cores in Recovering state on a Solr Server.
Related Name
Default Value: Warning: Any, Critical: Never
API Name: solr_recovering_core_thresholds
Required: false

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: solr_server_fd_thresholds
Required: false

Garbage Collection Duration Thresholds

Description: The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time.
Related Name
Default Value: Warning: 30.0, Critical: 60.0
API Name: solr_server_gc_duration_thresholds
Required: false

Garbage Collection Duration Monitoring Period

Description: The period to review when computing the moving average of garbage collection time.
Related Name
Default Value: 5 minute(s)
API Name: solr_server_gc_duration_window
Required: false

Solr Server Host Health Test

Description: When computing the overall Solr Server health, consider the host's health.
Related Name
Default Value: true
API Name: solr_server_host_health_enabled
Required: false

Solr Server Process Health Test

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

Web Metric Collection

Description: Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server.
Related Name
Default Value: true
API Name: solr_server_web_metric_collection_enabled
Required: false

Web Metric Collection Duration

Description: The health test thresholds on the duration of the metrics request to the web server.
Related Name
Default Value: Warning: 10 second(s), Critical: Never
API Name: solr_server_web_metric_collection_thresholds
Required: false

Unexpected Exits Thresholds

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

Unexpected Exits Monitoring Period

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

Other

Solr Data Directory

Description: Directory on local file system where Solr Server keeps the configurations for collections.
Related Name
Default Value: /var/lib/solr
API Name: solr_data_dir
Required: true

Graceful Shutdown Timeout

Description: 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.
Related Name
Default Value: 3 minute(s)
API Name: solr_graceful_stop_timeout
Required: false

Solr Load Balancer

Description: Address of the load balancer, specified in host:port format.
Related Name
Default Value
API Name: solr_load_balancer
Required: false

Solr Plugins Directory

Description: 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.
Related Name
Default Value
API Name: solr_plugins_dir
Required: false

Performance

Maximum Process File Descriptors

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

Solr Max Connector Threads

Description: 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.
Related Name
Default Value: 10000
API Name: solr_max_connector_thread
Required: true

Ports and Addresses

Solr Admin Port

Description: Admin port of the Solr Server.
Related Name
Default Value: 8984
API Name: solr_admin_port
Required: true

Solr HTTP Port

Description: HTTP port of Solr Server.
Related Name: solr_http_port
Default Value: 8983
API Name: solr_http_port
Required: true

Resource Management

Cgroup CPU Shares

Description: Number of CPU shares to assign to this role. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup I/O Weight

Description: Weight for the read I/O requests issued by this role. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
Related Name: blkio.weight
Default Value: 500
API Name: rm_io_weight
Required: true

Cgroup Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit
Required: true

Cgroup Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit
Required: true

HDFS Block Cache Blocks per Slab

Description: 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.
Related Name: solr.hdfs.blockcache.blocksperbank
Default Value: 16384
API Name: solr_hdfs_blockcache_blocksperbank
Required: true

HDFS Block Cache Off-Heap Memory

Description: Use off-heap memory when caching HDFS blocks in Solr.
Related Name: solr.hdfs.blockcache.direct.memory.allocation
Default Value: true
API Name: solr_hdfs_blockcache_direct_memory_allocation
Required: true

HDFS Block Cache

Description: 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.
Related Name: solr.hdfs.blockcache.enabled
Default Value: true
API Name: solr_hdfs_blockcache_enabled
Required: true

HDFS Block Cache Number of Slabs

Description: 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.
Related Name: solr.hdfs.blockcache.slab.count
Default Value: 1
API Name: solr_hdfs_blockcache_slab_count
Required: true

Java Direct Memory Size of Solr Server in Bytes

Description: 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.
Related Name
Default Value: 1 GiB
API Name: solr_java_direct_memory_size
Required: false

Java Heap Size of Solr Server in Bytes

Description: Maximum size in bytes for the Java Process heap memory. Passed to Java -Xmx.
Related Name
Default Value: 1 GiB
API Name: solr_java_heapsize
Required: false

Security

Solr HTTPS port

Description: HTTPS port of Solr Server.
Related Name: solr_https_port
Default Value: 8985
API Name: solr_https_port
Required: false

Stacks Collection

Stacks Collection Data Retention

Description: The amount of stacks data that is retained. After the retention limit is reached, the oldest data is deleted.
Related Name: stacks_collection_data_retention
Default Value: 100 MiB
API Name: stacks_collection_data_retention
Required: false

Stacks Collection Directory

Description: The directory in which stacks logs are placed. If not set, stacks are logged into a stacks subdirectory of the role's log directory. If this directory already exists, it will be owned by the current role user with 755 permissions. Sharing the same directory among multiple roles will cause an ownership race.
Related Name: stacks_collection_directory
Default Value
API Name: stacks_collection_directory
Required: false

Stacks Collection Enabled

Description: Whether or not periodic stacks collection is enabled.
Related Name: stacks_collection_enabled
Default Value: false
API Name: stacks_collection_enabled
Required: true

Stacks Collection Frequency

Description: The frequency with which stacks are collected.
Related Name: stacks_collection_frequency
Default Value: 5.0 second(s)
API Name: stacks_collection_frequency
Required: false

Stacks Collection Method

Description: The method used to collect stacks. The jstack option involves periodically running the jstack command against the role's daemon process. The servlet method is available for those roles that have an HTTP server endpoint exposing the current stacks traces of all threads. When the servlet method is selected, that HTTP endpoint is periodically scraped.
Related Name: stacks_collection_method
Default Value: jstack
API Name: stacks_collection_method
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

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

Suppress Parameter Validation: JMX Exporter Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_port
Required: true

Suppress Parameter Validation: JMX Exporter configuration YAML

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the JMX Exporter configuration YAML parameter.
Related Name
Default Value: false
API Name: role_config_suppression_jmx_exporter_yaml
Required: true

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

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

Suppress Parameter Validation: Heap Dump Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Heap Dump Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_oom_heap_dump_dir
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

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

Suppress Parameter Validation: Solr Admin Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Admin Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_solr_admin_port
Required: true

Suppress Parameter Validation: Solr Data Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Data Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_solr_data_dir
Required: true

Suppress Parameter Validation: Solr HTTP Port

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

Suppress Parameter Validation: Solr HTTPS port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr HTTPS port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_solr_https_port
Required: true

Suppress Parameter Validation: Java Heap Size of Solr Server in Bytes

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Heap Size of Solr Server in Bytes parameter.
Related Name
Default Value: false
API Name: role_config_suppression_solr_java_heapsize
Required: true

Suppress Parameter Validation: Java Configuration Options for Solr Server

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Java Configuration Options for Solr Server parameter.
Related Name
Default Value: false
API Name: role_config_suppression_solr_java_opts
Required: true

Suppress Parameter Validation: Solr Load Balancer

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

Suppress Parameter Validation: Solr Server Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Server Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_solr_log_dir
Required: true

Suppress Parameter Validation: Solr Plugins Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Plugins Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_solr_plugins_dir
Required: true

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

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

Suppress Parameter Validation: Stacks Collection Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Stacks Collection Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_stacks_collection_directory
Required: true

Suppress Health Test: Solr Server API Liveness

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_solr_core_status_collection_health
Required: true

Suppress Health Test: Solr Server Critical State Cores

Description: Whether to suppress the results of the Solr Server Critical State Cores heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_solr_critical_cores_health
Required: true

Suppress Health Test: Solr Server Recovering Cores

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

Suppress Health Test: Audit Pipeline Test

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

Suppress Health Test: File Descriptors

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

Suppress Health Test: GC Duration

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_solr_server_gc_duration
Required: true

Suppress Health Test: Heap Dump Directory Free Space

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_solr_server_heap_dump_directory_free_space
Required: true

Suppress Health Test: Host Health

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

Suppress Health Test: Log Directory Free Space

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

Suppress Health Test: Otelcol Health

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

Suppress Health Test: Process Status

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

Suppress Health Test: Swap Memory Usage

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

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_solr_server_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

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

Suppress Health Test: Web Server Status

Description: 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.
Related Name
Default Value: false
API Name: role_health_suppression_solr_server_web_metric_collection
Required: true