Solr 10 Configuration Variables¶

These variables tune the Solr 10 upgrade, cluster sizing, collection geometry and the data migration. Set any of them in config/custom-vars/vars.solr.yml. All are optional — the default shown applies when the variable is not set. Kubernetes install mode only.

Upgrade control¶

Variable	Default	Description
`SOLR_V10_ENABLE`	`true`	Solr 10 is the default on fresh installs and upgrades. Set to `false` to stay on Solr 9, or to roll back an upgraded environment.
`SOLR_MIGRATION_SKIP`	`false`	Cut over without copying the Solr 9 documents. Solr 10 starts empty; the old documents stay on the retained Solr 9 PVCs.
`SOLR_V10_ROLLBACK_WIPE`	`false`	On a rollback, delete the Solr 10 releases, PVCs and `/solr10` ZooKeeper chroot instead of retaining them.

Solr 10 cluster sizing¶

Each defaults to the matching Solr 9 value, so a deployment that sets nothing gets the cluster it already runs. These size Solr 10 alone and leave the Solr 9 cluster unchanged.

Variable	Defaults to
`SOLR10_K8S_CLUSTER_SIZE`	`SOLR_K8S_CLUSTER_SIZE`
`SOLR10_HEAP_MIN_MEMORY_MB`	the Solr 9 minimum heap for your `DEPLOYMENT_SIZE`
`SOLR10_HEAP_MAX_MEMORY_MB`	the Solr 9 maximum heap for your `DEPLOYMENT_SIZE`
`SOLR10_K8S_CPU_REQUESTS`	`SOLR_K8S_CPU_REQUESTS`
`SOLR10_K8S_CPU_LIMITS`	`SOLR_K8S_CPU_LIMITS`
`SOLR10_K8S_PVC_STORAGE_SIZE`	`SOLR_K8S_PVC_STORAGE_SIZE`

Collection geometry¶

Geometry cascades from broadest to most specific — a more specific value wins. A fresh install applies these as set; an upgrade preserves the geometry your Solr 9 collections already have.

Global — applies to every collection without a more specific value:

Variable	Default
`SOLR_COLLECTION_GLOBAL_NUM_SHARDS`	`1`
`SOLR_COLLECTION_GLOBAL_NUM_REPLICAS`	`1`
`SOLR_COLLECTION_GLOBAL_TTL_DAYS`	`none`

Discovery collections — one setting for all Discovery collections together:

Variable	Default
`SOLR_DISCOVERY_COLLECTIONS_NUM_SHARDS`	the Solr 9 Discovery shard count, else the global
`SOLR_DISCOVERY_COLLECTIONS_NUM_REPLICAS`	the Solr 9 Discovery replica count, else the global

Per collection — every collection takes its own NUM_SHARDS, NUM_REPLICAS and TTL_DAYS. Set only the ones you need; an unset value falls back to the Discovery group (for Discovery collections) or the global. A none TTL means the collection is not trimmed by age.

Collection	Variables	Default shards / replicas	Default TTL (days)
`ranger_audits`	`SOLR_COLLECTION_RANGER_AUDITS_NUM_SHARDS` `SOLR_COLLECTION_RANGER_AUDITS_NUM_REPLICAS` `SOLR_COLLECTION_RANGER_AUDITS_TTL_DAYS`	Solr 9 Ranger geometry, else global	`MAX_AUDIT_RETENTION_DAYS`
`admin_audits`	`SOLR_COLLECTION_ADMIN_AUDITS_NUM_SHARDS` `SOLR_COLLECTION_ADMIN_AUDITS_NUM_REPLICAS` `SOLR_COLLECTION_ADMIN_AUDITS_TTL_DAYS`	global	`MAX_AUDIT_RETENTION_DAYS`
`policysync_audit`	`SOLR_COLLECTION_POLICYSYNC_AUDIT_NUM_SHARDS` `SOLR_COLLECTION_POLICYSYNC_AUDIT_NUM_REPLICAS` `SOLR_COLLECTION_POLICYSYNC_AUDIT_TTL_DAYS`	global	`none`
`policysync_resource`	`SOLR_COLLECTION_POLICYSYNC_RESOURCE_NUM_SHARDS` `SOLR_COLLECTION_POLICYSYNC_RESOURCE_NUM_REPLICAS` `SOLR_COLLECTION_POLICYSYNC_RESOURCE_TTL_DAYS`	global	`none`
`privacera_alerts`	`SOLR_COLLECTION_PRIVACERA_ALERTS_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_ALERTS_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_ALERTS_TTL_DAYS`	global	`none`
`privacera_audits`	`SOLR_COLLECTION_PRIVACERA_AUDITS_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_AUDITS_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_AUDITS_TTL_DAYS`	global	31
`privacera_aws_audits`	`SOLR_COLLECTION_PRIVACERA_AWS_AUDITS_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_AWS_AUDITS_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_AWS_AUDITS_TTL_DAYS`	global	`none`
`privacera_classification`	`SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	`none`
`privacera_classification_audit_logs`	`SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_AUDIT_LOGS_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_AUDIT_LOGS_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_AUDIT_LOGS_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	`none`
`privacera_classification_audits`	`SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_AUDITS_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_AUDITS_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_CLASSIFICATION_AUDITS_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	`none`
`privacera_discovery_telemetry`	`SOLR_COLLECTION_PRIVACERA_DISCOVERY_TELEMETRY_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_DISCOVERY_TELEMETRY_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_DISCOVERY_TELEMETRY_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	90
`privacera_emr_info`	`SOLR_COLLECTION_PRIVACERA_EMR_INFO_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_EMR_INFO_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_EMR_INFO_TTL_DAYS`	global	`none`
`privacera_lineage`	`SOLR_COLLECTION_PRIVACERA_LINEAGE_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_LINEAGE_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_LINEAGE_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	`none`
`privacera_logs`	`SOLR_COLLECTION_PRIVACERA_LOGS_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_LOGS_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_LOGS_TTL_DAYS`	global	7
`privacera_metrics`	`SOLR_COLLECTION_PRIVACERA_METRICS_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_METRICS_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_METRICS_TTL_DAYS`	global	14
`privacera_offline_scan_cleanup`	`SOLR_COLLECTION_PRIVACERA_OFFLINE_SCAN_CLEANUP_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_OFFLINE_SCAN_CLEANUP_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_OFFLINE_SCAN_CLEANUP_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	10
`privacera_offline_scan_summary`	`SOLR_COLLECTION_PRIVACERA_OFFLINE_SCAN_SUMMARY_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_OFFLINE_SCAN_SUMMARY_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_OFFLINE_SCAN_SUMMARY_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	10
`privacera_peg_telemetry`	`SOLR_COLLECTION_PRIVACERA_PEG_TELEMETRY_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_PEG_TELEMETRY_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_PEG_TELEMETRY_TTL_DAYS`	global	`none`
`privacera_resource`	`SOLR_COLLECTION_PRIVACERA_RESOURCE_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_RESOURCE_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_RESOURCE_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	`none`
`privacera_resource_meta_info`	`SOLR_COLLECTION_PRIVACERA_RESOURCE_META_INFO_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_RESOURCE_META_INFO_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_RESOURCE_META_INFO_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	`none`
`privacera_spark_events`	`SOLR_COLLECTION_PRIVACERA_SPARK_EVENTS_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_SPARK_EVENTS_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_SPARK_EVENTS_TTL_DAYS`	`SOLR_DISCOVERY_COLLECTIONS_*`	31
`privacera_telemetry`	`SOLR_COLLECTION_PRIVACERA_TELEMETRY_NUM_SHARDS` `SOLR_COLLECTION_PRIVACERA_TELEMETRY_NUM_REPLICAS` `SOLR_COLLECTION_PRIVACERA_TELEMETRY_TTL_DAYS`	global	`none`

A collection's _TTL_DAYS can be set on any collection. none — the default for most — keeps the collection's configset default and does no age-based trimming. MAX_AUDIT_RETENTION_DAYS drives the default retention for ranger_audits and admin_audits.

RANGER_SOLR_MAX_SHARDS_PER_NODE and DISCOVERY_SOLR_MAX_SHARDS_PER_NODE no longer have any effect — Solr removed that setting and places replicas itself.

Data migration job¶

Variable	Default	Description
`SOLR_MIGRATION_BATCH_SIZE`	`5000`	Documents copied per batch.
`SOLR_MIGRATION_SORT_BUFFER`	`256M` / `1G` / `4G` by `DEPLOYMENT_SIZE`	Sort buffer. Keep it to no more than a quarter of the pod memory limit.
`SOLR_MIGRATION_K8S_MEM_LIMITS`	`4096` / `8192` / `16384` Mi	Migration pod memory limit. Raise it for a very large collection that is `OOMKilled`.
`SOLR_MIGRATION_K8S_CPU_LIMITS`	`1` / `2` / `4`	Migration pod CPU limit.
`SOLR_MIGRATION_K8S_CPU_REQUESTS`	`0.2`	Migration pod CPU request.
`SOLR_MIGRATION_K8S_WORK_SIZE_LIMIT`	`16Gi` / `64Gi` / `128Gi`	Scratch (ephemeral) space. Raise it if the pod is evicted for ephemeral storage.
`SOLR_MIGRATION_EXTRA_ENV`	`{}`	Extra environment for the migration and collection-manager scripts, for example `SOLR_MIGRATION_ID_WINDOW`, `SOLR_MIGRATION_MAX_TIME_SECS` and `SOLR_MIGRATION_ID_SEPARATOR`.

Prev topic: Solr 10 Upgrade