[SOLR-17111] SIP-21: Standardize system property naming

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Assignee: Unassigned
• Reporter: Jan Høydahl
• Created: 05/Jan/24 15:28
• Updated: 18/Jan/24 22:35

Description

SIP-21 Standardize system property naming (dev-list thread)

Followup from SOLR-15960.

This Jira will standardize naming of system properties in use by Solr with rules

• Lowercase [a-z0-9\.] only
• All props start with solr.
• All props === env.var (when uppercased and .replace("-","_"))

See EnvToSyspropMappings.properties for a list of identified non-standard system property names. It may not be complete. And some are impossible to change, such as SOLR_PORT=jetty.port.

I think it makes sense to add one child-task for each of the vars we want to standardize, so we can target one variable/property at a time. The process will be (using enable.packages as example:

1. Make our code and docs use "solr.enable.packages" everywhere
2. Make sure the old sysprop still works in 9.x (This may be automated using the properties file above)
3. Make a note in 9.x upgrade notes that "-Denable.packages" is deprecated
4. Add a section to 10.0 major changes that "-Denable.packages" no longer works from 10.0
5. Add a test? Perhaps it is enough to test the EnvUtils logic, i.e. that no matter which way you set the env/property our code EnvUtils.getProp("solr.enable.packages") gets hold of it?

 

Issue Links

• depends upon: SOLR-15960 Unified use of system properties and environment variables
• mentioned in: Page Loading...
• mentioned in: Page Loading...