350 lines
22 KiB
JSON
350 lines
22 KiB
JSON
[
|
|
{
|
|
"desc": "If Solr does not respond on its web URL within this time interval, the Catalina process is killed.",
|
|
"display_name": "Solrd Watchdog Timeout",
|
|
"name": "solrd_watchdog_timeout",
|
|
"value": "70"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Service Advanced Configuration Snippet (Safety Valve) for sentry-site.xml parameter.",
|
|
"display_name": "Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for sentry-site.xml",
|
|
"name": "service_config_suppression_solr_sentry_safety_valve",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "Solr TLS/SSL Certificate Trust Store File",
|
|
"name": "solr_https_truststore_file",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the Solr Server Count Validator configuration validator.",
|
|
"display_name": "Suppress Configuration Validator: Solr Server Count Validator",
|
|
"name": "service_config_suppression_solr_server_count_validator",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the LDAP Secure URI and Start TLS Validator configuration validator.",
|
|
"display_name": "Suppress Configuration Validator: LDAP Secure URI and Start TLS Validator",
|
|
"name": "service_config_suppression_solr_ldaps_or_tls_validator",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for core-site.xml",
|
|
"name": "service_config_suppression_solr_core_site_safety_valve",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "The user that this service's processes should run as.",
|
|
"display_name": "System User",
|
|
"name": "process_username",
|
|
"value": "solr"
|
|
},
|
|
{
|
|
"desc": "Name of the Sentry service that this Solr service instance depends on. If selected, Solr uses this Sentry service to look up authorization privileges. Before enabling Sentry, read the requirements and configuration steps in <a class=\"bold\" href=\"http://tiny.cloudera.com/sentry-service-cm5\" target=\"_blank\">Setting Up The Sentry Service<i class=\"externalLink\"></i></a>.",
|
|
"display_name": "Sentry Service",
|
|
"name": "sentry_service",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP URL parameter.",
|
|
"display_name": "Suppress Parameter Validation: LDAP URL",
|
|
"name": "service_config_suppression_solr_ldap_uri",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "This parameter is useful when authenticating against an Active Directory server. This value is appended to all usernames before authenticating against AD. For example, if this parameter is set to \"my.domain.com\", and the user authenticating is \"mike\", then \"mike@my.domain.com\" is passed to AD. If this field is unset, the username remains unaltered before being passed to AD.",
|
|
"display_name": "Active Directory Domain",
|
|
"name": "ldap_domain",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "Solr TLS/SSL Certificate Trust Store Password",
|
|
"name": "solr_https_truststore_password",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "The password for the Solr JKS keystore file.",
|
|
"display_name": "Solr TLS/SSL Server JKS Keystore File Password",
|
|
"name": "solr_https_keystore_password",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "Name of the HDFS service that this Search service instance depends on",
|
|
"display_name": "HDFS Service",
|
|
"name": "hdfs_service",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "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\".",
|
|
"display_name": "Enable LDAP TLS",
|
|
"name": "solr_ldap_enable_starttls",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr Service Environment Advanced Configuration Snippet (Safety Valve) parameter.",
|
|
"display_name": "Suppress Parameter Validation: Solr Service Environment Advanced Configuration Snippet (Safety Valve)",
|
|
"name": "service_config_suppression_solr_env_safety_valve",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the HDFS Data Directory parameter.",
|
|
"display_name": "Suppress Parameter Validation: HDFS Data Directory",
|
|
"name": "service_config_suppression_hdfs_data_dir",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Name of the ZooKeeper service that this Search service instance depends on",
|
|
"display_name": "ZooKeeper Service",
|
|
"name": "zookeeper_service",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Certificate Trust Store File parameter.",
|
|
"display_name": "Suppress Parameter Validation: Solr TLS/SSL Certificate Trust Store File",
|
|
"name": "service_config_suppression_solr_https_truststore_file",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "Solr Service Environment Advanced Configuration Snippet (Safety Valve)",
|
|
"name": "solr_env_safety_valve",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "HDFS directory used for storage by this Solr service.",
|
|
"display_name": "HDFS Data Directory",
|
|
"name": "hdfs_data_dir",
|
|
"value": "/solr"
|
|
},
|
|
{
|
|
"desc": "HDFS path to the global policy file for Sentry authorization. This should be a relative path (and not a full HDFS URL). The global policy file must be in Sentry policy file format.",
|
|
"display_name": "Sentry Global Policy File",
|
|
"name": "sentry_solr_provider_resource",
|
|
"value": "/user/solr/sentry/sentry-provider.ini"
|
|
},
|
|
{
|
|
"desc": "Kerberos principal short name used by all roles of this service.",
|
|
"display_name": "Kerberos Principal",
|
|
"name": "kerberos_princ_name",
|
|
"value": "solr"
|
|
},
|
|
{
|
|
"desc": "For advanced use only, a string to be inserted into <strong>hdfs-site.xml</strong>. Applies to configurations of all roles in this service except client configuration.",
|
|
"display_name": "Solr Service Advanced Configuration Snippet (Safety Valve) for hdfs-site.xml",
|
|
"name": "solr_hdfs_site_safety_valve",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "Healthy Solr Server Monitoring Thresholds",
|
|
"name": "solr_solr_servers_healthy_thresholds",
|
|
"value": "{\"critical\":\"90.0\",\"warning\":\"95.0\"}"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Sentry Global Policy File parameter.",
|
|
"display_name": "Suppress Parameter Validation: Sentry Global Policy File",
|
|
"name": "service_config_suppression_sentry_solr_provider_resource",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Solrd Watchdog Timeout parameter.",
|
|
"display_name": "Suppress Parameter Validation: Solrd Watchdog Timeout",
|
|
"name": "service_config_suppression_solrd_watchdog_timeout",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "When checked, LDAP-based authentication for users is enabled.",
|
|
"display_name": "Enable LDAP Authentication",
|
|
"name": "solr_enable_ldap_auth",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "The group that this service's processes should run as.",
|
|
"display_name": "System Group",
|
|
"name": "process_groupname",
|
|
"value": "solr"
|
|
},
|
|
{
|
|
"desc": "Choose the authentication mechanism used by Solr.",
|
|
"display_name": "Solr Secure Authentication",
|
|
"name": "solr_security_authentication",
|
|
"value": "simple"
|
|
},
|
|
{
|
|
"desc": "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 <a class=\"bold\" href=\"http://tiny.cloudera.com/solr-ssl-5.4\" target=\"_blank\">Enabling TLS/SSL for Solr<i class=\"externalLink\"></i></a>.",
|
|
"display_name": "Enable TLS/SSL for Solr",
|
|
"name": "solr_use_ssl",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "The class to use in Sentry authorization for user to group mapping. Sentry authorization may be configured to use either Hadoop groups or local groups defined in the policy file. When configured with Hadoop groups, Sentry will ask the HDFS Namenode for group mapping for a given user to determine authorization access.",
|
|
"display_name": "Sentry User to Group Mapping Class",
|
|
"name": "solr_sentry_provider",
|
|
"value": "org.apache.sentry.provider.file.HadoopGroupResourceAuthorizationProvider"
|
|
},
|
|
{
|
|
"desc": "For advanced use only, a string to be inserted into <strong>core-site.xml</strong>. Applies to configurations of all roles in this service except client configuration.",
|
|
"display_name": "Solr Service Advanced Configuration Snippet (Safety Valve) for core-site.xml",
|
|
"name": "solr_core_site_safety_valve",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "When set, Cloudera Manager will send alerts when this entity's configuration changes.",
|
|
"display_name": "Enable Configuration Change Alerts",
|
|
"name": "enable_config_alerts",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the LDAP TLS Validator configuration validator.",
|
|
"display_name": "Suppress Configuration Validator: LDAP TLS Validator",
|
|
"name": "service_config_suppression_solr_ldap_tls_validator",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.",
|
|
"display_name": "Suppress Parameter Validation: Service Triggers",
|
|
"name": "service_config_suppression_service_triggers",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Use Sentry to enable role-based, fine-grained authorization. This configuration enables Sentry using policy files. To enable Sentry using Sentry service instead (supported in CDH 5.8 and later), add Sentry service as a dependency to Solr service. <strong>Sentry service provides concurrent and secure access to authorization policy metadata and is recommended for enabling Sentry. </strong> Sentry with policy files is supported only on CDH 5 or later deployments. Sentry requires authentication to be turned on for Solr.",
|
|
"display_name": "Enable Sentry Authorization using Policy Files",
|
|
"name": "solr_sentry_enabled",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Server JKS Keystore File Password parameter.",
|
|
"display_name": "Suppress Parameter Validation: Solr TLS/SSL Server JKS Keystore File Password",
|
|
"name": "service_config_suppression_solr_https_keystore_password",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "For advanced use only, a string to be inserted into <strong>sentry-site.xml</strong>. Applies to configurations of all roles in this service except client configuration.",
|
|
"display_name": "Solr Service Advanced Configuration Snippet (Safety Valve) for sentry-site.xml",
|
|
"name": "solr_sentry_safety_valve",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "Enable the background watchdog thread that can kill Catalina process if Solr is not responsive.",
|
|
"display_name": "Enable Solrd Watchdog",
|
|
"name": "solrd_enable_watchdog",
|
|
"value": "true"
|
|
},
|
|
{
|
|
"desc": "<p>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.</p><p>Each trigger has the following fields:</p><ul><li><code>triggerName</code> <b>(mandatory)</b> - The name of the trigger. This value must be unique for the specific service. </li><li><code>triggerExpression</code> <b>(mandatory)</b> - A tsquery expression representing the trigger. </li><li><code>streamThreshold</code> <b>(optional)</b> - 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. </li><li><code>enabled</code> <b> (optional)</b> - By default set to 'true'. If set to 'false', the trigger is not evaluated.</li><li><code>expressionEditorConfig</code> <b> (optional)</b> - 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.</li></ul><p>For example, the followig JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:</p><p><pre>[{\"triggerName\": \"sample-trigger\",\n \"triggerExpression\": \"IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad\",\n \"streamThreshold\": 10, \"enabled\": \"true\"}]</pre></p><p>See the trigger rules documentation for more details on how to write triggers using tsquery.</p><p>The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.</p>",
|
|
"display_name": "Service Triggers",
|
|
"name": "service_triggers",
|
|
"value": "[]"
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "Suppress Parameter Validation: Solr Service Advanced Configuration Snippet (Safety Valve) for hdfs-site.xml",
|
|
"name": "service_config_suppression_solr_hdfs_site_safety_valve",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.",
|
|
"display_name": "Suppress Parameter Validation: System User",
|
|
"name": "service_config_suppression_process_username",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "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",
|
|
"display_name": "Enable Service Level Health Alerts",
|
|
"name": "enable_alerts",
|
|
"value": "true"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Kerberos Principal parameter.",
|
|
"display_name": "Suppress Parameter Validation: Kerberos Principal",
|
|
"name": "service_config_suppression_kerberos_princ_name",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator.",
|
|
"display_name": "Suppress Configuration Validator: Gateway Count Validator",
|
|
"name": "service_config_suppression_gateway_count_validator",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "<p>The URL of the LDAP server. The URL must be prefixed with ldap:// or ldaps://. The URL can optionally specify a custom port, for example: ldaps://ldap_server.example.com:1636. Note that usernames and passwords will be transmitted in the clear unless either an ldaps:// URL is used, or \"Enable LDAP TLS\" is turned on (where available). Also note that encryption must be in use between the client and this service for the same reason.</p><p>For more detail on the LDAP URL format, see <a target=\"_blank\" href=\"http://www.ietf.org/rfc/rfc2255.txt\">RFC 2255 <i class=\"externalLink\"></i></a>. A space-separated list of URLs can be entered; in this case the URLs will each be tried in turn until one replies.</p>",
|
|
"display_name": "LDAP URL",
|
|
"name": "solr_ldap_uri",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the ZooKeeper Znode parameter.",
|
|
"display_name": "Suppress Parameter Validation: ZooKeeper Znode",
|
|
"name": "service_config_suppression_zookeeper_znode",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.",
|
|
"display_name": "Suppress Parameter Validation: System Group",
|
|
"name": "service_config_suppression_process_groupname",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "Solr TLS/SSL Server JKS Keystore File Location",
|
|
"name": "solr_https_keystore_file",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "ZooKeeper znode used to store information about this Solr service.",
|
|
"display_name": "ZooKeeper Znode",
|
|
"name": "zookeeper_znode",
|
|
"value": "/solr"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the LDAP BaseDN parameter.",
|
|
"display_name": "Suppress Parameter Validation: LDAP BaseDN",
|
|
"name": "service_config_suppression_solr_ldap_basedn",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.",
|
|
"display_name": "Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)",
|
|
"name": "service_config_suppression_smon_derived_configs_safety_valve",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Server JKS Keystore File Location parameter.",
|
|
"display_name": "Suppress Parameter Validation: Solr TLS/SSL Server JKS Keystore File Location",
|
|
"name": "service_config_suppression_solr_https_keystore_file",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Solr TLS/SSL Certificate Trust Store Password parameter.",
|
|
"display_name": "Suppress Parameter Validation: Solr TLS/SSL Certificate Trust Store Password",
|
|
"name": "service_config_suppression_solr_https_truststore_password",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "Suppress Health Test: Solr Server Health",
|
|
"name": "service_health_suppression_solr_solr_servers_healthy",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"desc": "For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.",
|
|
"display_name": "Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)",
|
|
"name": "smon_derived_configs_safety_valve",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "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.",
|
|
"display_name": "LDAP BaseDN",
|
|
"name": "solr_ldap_basedn",
|
|
"value": null
|
|
},
|
|
{
|
|
"desc": "Whether to suppress configuration warnings produced by the built-in parameter validation for the Active Directory Domain parameter.",
|
|
"display_name": "Suppress Parameter Validation: Active Directory Domain",
|
|
"name": "service_config_suppression_ldap_domain",
|
|
"value": "false"
|
|
}
|
|
] |