[FEATURE] Introduce TYPO3_SOLR_ENABLED_CORES docker env variable

[christophlehmann]

This adds a startup script which disables all unneeded cores.

Usage:

docker run -e 'TYPO3_SOLR_ENABLED_CORES=english german' -it typo3solr/ext-solr

This enables only the english and german core (core_en, core_de) during startup.

If the env variable is not set, then all cores are enabled (= default behaviour).

Resolves: #3502

---

Maintainers comments:

• move all disabled cores to enabled, if TYPO3_SOLR_ENABLED_CORES is not specified.
• Provide the docs
• implement tests See dkd-kaehm comment
• backport to
  • release-11.5.x
  • release-11.2.x
  • release-11.0.x

[dkd-kaehm]

@christophlehmann
Thanks for this nice feature.
Didn't know about docker-entrypoint-initdb.d/ possibility.

[dkd-kaehm]

The script of solr-ddev-site

https://github.com/TYPO3-Solr/solr-ddev-site/blob/dd776dad79d3ca405652124bb91e5b5d1fd732be/.ddev/solr/docker-overrides-entrypoint.sh

overrideSolrUnixUidAndGidAndSetPermissions ()
{
  if [[ -v SOLR_OVERRIDE_UID ]] && grep -E -q '^[0-9]+$' <<<"${SOLR_OVERRIDE_UID:-}"; then
    usermod --non-unique --uid "$SOLR_OVERRIDE_UID" solr
  fi

  if [[ -v SOLR_OVERRIDE_GID ]] && grep -E -q '^[0-9]+$' <<<"${SOLR_OVERRIDE_GID:-}"; then
    groupmod --non-unique --gid "$SOLR_OVERRIDE_GID" solr
  fi

  chown -R solr:solr /var/solr
}

overrideSolrUnixUidAndGidAndSetPermissions

can be adapted and moved there as well.

[brandung-sjorek]

@christophlehmann In think the cibuild_docker.sh should be updated accordingly; or the github-action workflow which uses this script.

@dkd-kaehm Right?

[dkd-kaehm]

@christophlehmann In think the cibuild_docker.sh should be updated accordingly; or the github-action workflow which uses this script.

@dkd-kaehm Right?

The scripts inside of /docker-entrypoint-initdb.d are executed automatically, no needs to do something else as provided there.
See: https://github.com/apache/solr-docker/blob/3a61966de4da0ef7a3e9f2d29959d6bcb2ea117e/8.11/scripts/run-initdb

Also not more than the Docker-Image tests could be enriched for this stuff.

[brandung-sjorek]

@dkd-kaehm Sorry, maybe I got you wrong. You want (as I suggested) @christophlehmann to implement a test in cibuild_docker.sh, to check if disabling cores works as expected. Correct?

[dkd-kaehm]

@dkd-kaehm Sorry, maybe I got you wrong. You want (as I suggested) @christophlehmann to implement a test in cibuild_docker.sh, to check if disabling cores works as expected. Correct?

Yes, if possible it would be nice to cover it with test cases.
For example:
First start with "de" and "en" and check that they only are enabled,
then remove "de" and add "da" and restart then check if "de" is gone and "da" is there.

---

PS: @brandung-sjorek I thought, your suggestion was for enabling this feature in image at all, not about test scenarios in build process.

[baschny]

👍 great feature, thx!