Skip to content

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:

  1. 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.

  2. Click Add Custom Property, and enter a property name and its value.

  3. Select the property type: text or password.

  4. Click Add.

Properties Table#

Property Description Value Default Value
SOLR_EXTERNAL_PORT Property to change the default port number for Solr.   8983
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 ./privacera-manager.sh update command. Wait for 30 minutes and then run the restart command for the property to take effect. To learn how to restart, click here.

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 ./privacera-manager.sh update command. Wait for 30 minutes and then run the restart command for the property to take effect. To learn how to restart, click here.

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_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
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
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"  

Last update: September 23, 2021