Solr configuration parameters
To configure the service, use the following configuration parameters in ADCM.
|
NOTE
|
| Parameter | Description | Default value |
|---|---|---|
SOLR_HOME |
The location for index data and configs |
/srv/solr/server |
SOLR_AUTH_TYPE |
Specifies the authentication type for Solr |
— |
SOLR_AUTHENTICATION_OPTS |
Solr authentication options |
— |
SOLR_AUTHENTICATION_OPTS_CUSTOM |
Custom authentication options for Solr |
— |
GC_TUNE |
JVM parameters for Solr |
-XX:-UseLargePages |
SOLR_SSL_KEY_STORE |
Path to the Solr keystore file |
— |
SOLR_SSL_KEY_STORE_TYPE |
The type of the keystore |
JKS |
SOLR_SSL_KEY_STORE_PASSWORD |
The password to the Solr keystore file |
— |
SOLR_SSL_TRUST_STORE |
Path to the Solr truststore file |
— |
SOLR_SSL_TRUST_STORE_TYPE |
The type of the truststore |
JKS |
SOLR_SSL_TRUST_STORE_PASSWORD |
The password to the Solr truststore file |
— |
SOLR_SSL_NEED_CLIENT_AUTH |
Defines if client authentication is enabled |
false |
SOLR_SSL_WANT_CLIENT_AUTH |
Enables clients to authenticate (but not requires) |
false |
SOLR_SSL_CLIENT_HOSTNAME_VERIFICATION |
Defines whether to enable hostname verification |
false |
SOLR_HOST |
Specifies the host name of the Solr server |
— |
SOLR_PORT |
The port number for Solr nodes to listen |
8983 |
LOG4J_PROPS |
A list of comma-separated paths to Log4j configuration files used by Solr |
/etc/solr/conf/log4j2.xml,/etc/solr/conf/log4j2-console.xml |
| Parameter | Description | Default value |
|---|---|---|
ZK_HOST |
Comma-separated locations of all servers in the ensemble and the ports on which they communicate.
You can put ZooKeeper chroot at the end of your |
— |
The external zookeeper is kerberized |
If the external ZooKeeper is kerberized, the value must be set to |
false |
| Parameter | Description | Default value |
|---|---|---|
Solr Server Heap Memory |
Sets initial (-Xms) and maximum (-Xmx) Java heap size for Solr Server |
-Xms512m -Xmx512m |
| Parameter | Description | Default value |
|---|---|---|
collection_name |
Name of the collection to configure auto-purging |
— |
ttl |
The TTL (time-to-live) for documents in the collection |
— |
auto_delete_period |
Time period to automatically delete documents from the collection |
— |
| Parameter | Description | Default value |
|---|---|---|
Credstore password |
The encryption provider password |
false |
Credstore options |
Defines a way to store the encryption provider password. The following options are available:
|
no password |
Credential provider path |
Path to a keystore file with secrets |
jceks://file/etc/solr/conf/solr.jceks |
Ranger plugin credential provider path |
Path to a Ranger keystore file with secrets |
jceks://file/etc/solr/conf/ranger-solr.jceks |
Custom jceks |
Set to |
false |
| Parameter | Description | Default value |
|---|---|---|
xasecure.audit.is.enabled |
Enables Ranger audit |
true |
xasecure.audit.solr.solr_url |
A path to a Solr collection to store audit logs |
— |
xasecure.audit.solr.async.max.queue.size |
Maximum size of internal queue used for storing audit logs |
1 |
xasecure.audit.solr.async.max.flush.interval.ms |
Maximum time interval between flushes to disk (in milliseconds) |
100 |
xasecure.audit.solr.is.enabled |
Enables Ranger audit for Solr |
true |
ranger.solr.plugin.audit.excluded.users |
A list of users to exclude audit records |
HTTP,rangeradmin,rangerkms |
| Parameter | Description | Default value |
|---|---|---|
ranger.plugin.solr.policy.rest.url |
The URL to Ranger Admin |
— |
ranger.plugin.solr.service.name |
The name of the Ranger service containing policies for this instance |
— |
ranger.plugin.solr.policy.cache.dir |
The directory where Ranger policies are cached after successful retrieval from the source |
/srv/ranger/solr/policycache |
ranger.plugin.solr.policy.pollIntervalMs |
Defines how often to poll for changes in policies |
30000 |
ranger.plugin.solr.policy.rest.client.connection.timeoutMs |
The Solr Plugin RangerRestClient connection timeout (in milliseconds) |
120000 |
ranger.plugin.solr.policy.rest.client.read.timeoutMs |
The Solr Plugin RangerRestClient read timeout (in milliseconds) |
30000 |
ranger.plugin.solr.policy.rest.ssl.config.file |
Path to the file containing SSL details to contact Ranger Admin |
/usr/lib/solr/server/resources/ranger-solr-policymgr-ssl.xml |
ranger.plugin.solr.policy.source.impl |
Class to retrieve policies from the source |
org.apache.ranger.admin.client.RangerAdminRESTClient |
| Parameter | Description | Default value |
|---|---|---|
xasecure.policymgr.clientssl.keystore |
Path to the keystore file used by Ranger |
— |
xasecure.policymgr.clientssl.keystore.credential.file |
Path to the keystore credentials file |
/etc/solr/conf/ranger-solr.jceks |
xasecure.policymgr.clientssl.truststore.credential.file |
Path to the truststore credentials file |
/etc/solr/conf/ranger-solr.jceks |
xasecure.policymgr.clientssl.truststore |
Path to the truststore file used by Ranger |
— |
xasecure.policymgr.clientssl.keystore.password |
Password to the keystore file |
— |
xasecure.policymgr.clientssl.truststore.password |
Password to the truststore file |
— |
| Parameter | Description | Default value |
|---|---|---|
solr.xml |
The content of solr.xml |
|
Custom solr-env.sh |
In this section you can define values for custom parameters that are not displayed in ADCM UI, but are allowed in the configuration file solr-env.sh |
— |
Ranger plugin enabled |
Shows status of the Ranger plugin |
false |
Custom ranger-solr-audit.xml |
In this section you can define values for custom parameters that are not displayed in ADCM UI, but are allowed in the ranger-solr-audit.xml configuration file |
— |
Custom ranger-solr-security.xml |
In this section you can define values for custom parameters that are not displayed in ADCM UI, but are allowed in the ranger-solr-security.xml configuration file |
— |
Custom ranger-solr-policymgr-ssl.xml |
In this section you can define values for custom parameters that are not displayed in ADCM UI, but are allowed in the ranger-solr-policymgr-ssl.xml configuration file |
— |