Solr#
This topic provides the list of custom properties that can be configured for the Solr service. It covers how you can configure the custom properties in PM CLI and PM UI.
Configuration#
PM CLI#
To use a custom property from the table, just add it to the following YML file in the custom-vars folder configured as per your environment:
- vars.solr.yml
PM UI#
To use a custom property in the UI, do the following:
-
On the PM UI, do one of the following:
If you're on the Setup Environment page, navigate to the Setup Default Services > Configure Solr > Custom tab.
Or
If you're on the PM UI Dashboard, navigate to Solr > Config tab > Custom tab.
-
Click Add Custom Property, and enter a property name and its value.
-
Select the property type: text or password.
-
Click Add.
Properties Table#
| Property | Description | Value | Default Value |
|---|---|---|---|
| SOLR_ENABLE | |||
| SOLR_INSTALL | |||
| SOLR_IMAGE_NAME | |||
| SOLR_IMAGE_TAG | |||
| SOLR_INTERNAL_PORT | |||
| SOLR_EXTERNAL_PORT | Property to change the default port number for Solr. | 8983 | |
| SOLR_SERVICE_NAME | |||
| SOLR_SSL_ENABLE | |||
| SOLR_SSL_SELF_SIGNED | |||
| SOLR_SSL_SIGNED_CERT_FORMAT | |||
| SOLR_GC | |||
| SOLR_HOME | |||
| SOLR_LOGS_DIR | |||
| SOLR_HOST_NAME | |||
| SOLR_INTERNAL_HOST_NAME | |||
| SOLR_SVC_IP | |||
| SOLR_EXTERNAL_HOST_NAME | |||
| SOLR_LISTEN_HOST_NAME | |||
| SOLR_URL_SCHEME | |||
| SOLR_PROTOCOL | |||
| SOLR_URL | |||
| SOLR_URL_EXTERNAL | |||
| SOLR_URL_IP | |||
| SOLR_ZK_HOST | |||
| SOLR_BASIC_AUTH_ENABLED | |||
| SOLR_BASIC_AUTH_USER | |||
| SOLR_BASIC_AUTH_PASSWORD | |||
| SOLR_NODE_COUNT | |||
| SOLR_ZK_HOST_DOCKER | |||
| SOLR_KEYSTORE_ALIAS | |||
| SOLR_KEYSTORE_PASSWORD | |||
| SOLR_TRUSTSTORE_PASSWORD | |||
| SOLR_SSL_TRUSTSTORE | |||
| SOLR_SSL_TRUSTSTORE_TYPE | |||
| SOLR_SSL_KEYSTORE_TYPE | |||
| SOLR_KEYSTORE_FILENAME | |||
| SOLR_SSL_KEYSTORE | |||
| SOLR_SSL_VALIDATE_LOOP_COUNT |
Number of retries to be attempted to validate whether the SOLR service is up and running. PM CLI After adding the property, run the PM UI After adding the property, navigate to the PM UI Dashboard > System Settings > Install and click Install & Start Services. Wait for 30 minutes and then go to the Dashboard and click Restart All Services. Note: In PM CLI and PM UI, restarting the Privacera services does not apply any changes done in the property configuration. You will have to run the install (PM UI) or update (PM CLI) to apply the configuration changes. |
60 | |
| SOLR_SSL_VALIDATE_SLEEP_SECS |
Wait for number of secs before calling the API to validate whether the SOLR service is up and running. PM CLI After adding the property, run the PM UI After adding the property, navigate to the PM UI Dashboard > System Settings > Install and click Install & Start Services. Wait for 30 minutes and then go to the Dashboard and click Restart All Services. Note: In PM CLI and PM UI, restarting the Privacera services does not apply any changes done in the property configuration. You will have to run the install (PM UI) or update (PM CLI) to apply the configuration changes. |
30 | |
| SOLR_SSL_NEED_CLIENT_AUTH | |||
| SOLR_SSL_WANT_CLIENT_AUTH | |||
| SOLR_SSL_CHECK_PEER_NAME | |||
| SOLR_SSL_SIGNED_PKCS12_ALIAS | |||
| SOLR_SSL_SIGNED_PKCS12_FILE | |||
| SOLR_SSL_SIGNED_PEM_FULL_CHAIN | |||
| SOLR_SSL_SIGNED_PEM_PRIVATE_KEY | |||
| SOLR_K8S_CLUSTER_SIZE | |||
| SOLR_K8S_TERMINATION_GRACE_PERIOD_SECS | |||
| SOLR_K8S_READINESS_PROBE_DELAY_SECS | Time in seconds to delay the Kubernetes readiness probe for the Solr pod. | 5 | |
| SOLR_K8S_READINESS_PROBE_FAILURE_THRESHOLD | Failure threshold is the number of times Kubernetes will try to perform the readiness probe for the Solr pod. | 3 | |
| SOLR_K8S_READINESS_PROBE_PERIOD_SECS | Time in seconds to perform the Kubernetes readiness probe for the Solr pod. | 10 | |
| SOLR_K8S_LIVENESS_PROBE_DELAY_SECS | Time in seconds to delay the Kubernetes liveness probe for the Solr pod. | 60 | |
| SOLR_K8S_LIVENESS_PROBE_PERIOD_SECS | Time in seconds to perform the Kubernetes liveness probe for the Solr pod. | 60 | |
| SOLR_K8S_LIVENESS_PROBE_FAILURE_THRESHOLD | Failure threshold is the number of times Kubernetes will try to perform the liveness probe for the Solr pod. | 3 | |
| SOLR_K8S_STARTUP_PROBE_ENABLED | Enable the startup probe for the Solr pod. | true, false | false |
| SOLR_K8S_STARTUP_PROBE_PERIOD_SECS | Time in seconds to perform the Kubernetes startup probe for the Solr pod. | 60 | |
| SOLR_K8S_STARTUP_PROBE_DELAY_SECS | Time in seconds to delay the Kubernetes startup probe for the Solr pod. | 60 | |
| SOLR_K8S_STARTUP_PROBE_FAILURE_THRESHOLD | Failure threshold is the number of times Kubernetes will try to perform the startup probe for the Solr pod. | 3 | |
| SOLR_K8S_LOADBALANCER_EXTERNAL | |||
| SOLR_K8S_ANNOTATION_LOADBALANCER_ANNOTATION | |||
| SOLR_K8S_ANNOTATION_LOADBALANCER_NAME | |||
| SOLR_K8S_ANNOTATION_LOADBALANCER_VALUE | |||
| SOLR_K8S_STORAGE_PROVISIONER | |||
| SOLR_K8S_SC_NAME | |||
| SOLR_K8S_PV_ENCRYPTED | |||
| SOLR_K8S_PV_KEY | |||
| SOLR_K8S_PVC_STORAGE_SIZE | |||
| SOLR_K8S_CPU_REQUESTS | |||
| SOLR_K8S_CPU_LIMITS | |||
| SOLR_K8S_ZK_HOST | |||
| MAX_AUDIT_RETENTION_DAYS | Property to specify how long to retain the Solr audit logs. By default, audit logs are retained for 90 days. | 90 | |
| SOLR_DNS_NAME_CERT | |||
| SOLR_K8S_NETWORKING_LOADBALANCER_IP | |||
| SOLR_K8S_NETWORKING_LOADBALANCER_SOURCE_RANGES | |||
| SOLR_TOPOLOGIES | |||
| SOLR_K8S_SERVICE_ACCOUNT | |||
| SOLR_K8S_POD_DISRUPTION_BUDGET_MIN_AVAILABLE | |||
| Memory Variables | |||
| SOLR_HEAP_MIN_MEMORY_MB | Minimum Java Heap memory in MB used by Solr. For example, SOLR_HEAP_MIN_MEMORY_MB: "1024" | ||
| SOLR_HEAP_MIN_MEMORY | Minimum Java Heap memory used by Solr. Setting this value will override SOLR_HEAP_MIN_MEMORY_MB. For example, SOLR_HEAP_MIN_MEMORY: "1g" | ||
| SOLR_HEAP_MAX_MEMORY_MB | Maximum Java Heap memory in MB used by Solr. For example, SOLR_HEAP_MAX_MEMORY_MB: "1024" | ||
| SOLR_HEAP_MAX_MEMORY | Maximum Java Heap memory used by Solr. Setting this value will override SOLR_HEAP_MAX_MEMORY_MB. For example, SOLR_HEAP_MAX_MEMORY: "1g" | ||
| SOLR_K8S_MEM_REQUESTS_MB | Minimum amount of Kubernetes memory in MB to be requested by Solr. For example, SOLR_K8S_MEM_REQUESTS_MB: "1024" | ||
| SOLR_K8S_MEM_REQUESTS | Minimum amount of Kubernetes memory to be used by Solr. Setting this value will override SOLR_K8S_MEM_REQUESTS_MB. For example, SOLR_K8S_MEM_REQUESTS: "1G" | ||
| SOLR_K8S_MEM_LIMITS_MB | Maximum amount of Kubernetes memory in MB to be requested by Solr. For example, SOLR_K8S_MEM_LIMITS_MB: "1024" | ||
| SOLR_K8S_MEM_LIMITS | Maximum amount of Kubernetes memory to be used by Solr. Setting this value will override SOLR_K8S_MEM_LIMITS_MB. For example, SOLR_K8S_MEM_LIMITS: "1G" | ||
| SOLR_CPU_MIN | Minimum amount of Kubernetes CPU to be requested by Solr. For example, SOLR_CPU_MIN: "0.5" | ||
| SOLR_CPU_MAX | Maximum amount of Kubernetes CPU to be used by Solr. For example, SOLR_CPU_MAX: "0.5" | ||