Missing solr scripts and their documentation

[davisagli]

The Makefile doesn't include the commands I am used to (make solr-start etc) and the readme doesn't explain how I should run solr when I am working on the package.

[reekitconcept]

Originally these were present (both docs and scripts), however they were removed in the process of transforming into the new package structure.

The roadmap is that Erico will add these first to kitconcept.intranet (see ticket https://gitlab.kitconcept.io/kitconcept/kitconcept-intranet/-/issues/108), then I will update kitconcept.solr similarly.

As a baseline, I copy the same description here:

Missing solr scripts

The following scripts are essential and should be in makefile:

• make solr-start - start the solr container

• make solr-stop - stop the solr container

• make solr-activate-and-reindex - as the name says.

The starting and stopping can utilize the existing stack image and control just the solr profile from there.

The activate and reindex script can call the corresponding script in kitconcept.solr which offers a module that is made importable from a local script.

In addition we find the following useful:

• make solr-start-and-rebuild - this forces a rebuild, it's useful when the schema has changed or a rebuild is otherwise mandatory.
• make solr-logs - just log the docker container. (Optional but it may be helpful.)

As an example for this, we use the following in a customer project. These probably need to be customized but can be a good reference point.

.PHONY: solr-start
solr-start: test-compose-project-name ## Start solr
	@echo "Start solr"
	@COMPOSE_PROJECT_NAME=${STACK_NAME} docker compose -f ${SOLR_ONLY_COMPOSE} up -d

.PHONY: solr-start-and-rebuild
solr-start-and-rebuild: ## Start solr, force rebuild
	@echo "Start solr, force rebuild, erases data"
	@COMPOSE_PROJECT_NAME=${STACK_NAME} docker compose -f ${SOLR_ONLY_COMPOSE} up -d --build

.PHONY: solr-stop
solr-stop: test-compose-project-name ## Stop solr
	@echo "Stop solr"
	@COMPOSE_PROJECT_NAME=${STACK_NAME} docker compose -f ${SOLR_ONLY_COMPOSE} down

.PHONY: solr-logs
solr-logs: test-compose-project-name ## Show solr logs
	@echo "Show solr logs"
	@STACK_NAME=${STACK_NAME} docker compose -f ${SOLR_ONLY_COMPOSE} logs -f

.PHONY: solr-activate-and-reindex
solr-activate-and-reindex:  ## Activate and reindex solr
	(cd backend; PYTHONWARNINGS=ignore ./bin/zconsole run instance/etc/zope.conf scripts/solr_activate_and_reindex.py --clear)

And the activate_and_reindex script:

from kitconcept.solr.reindex_helpers import activate_and_reindex
from Testing.makerequest import makerequest
from zope.site.hooks import setSite

import sys
import transaction


if __name__ == "__main__":
    app = makerequest(app)  # noQA

    # Set site to Plone
    site_id = "Plone"
    portal = app.unrestrictedTraverse(site_id)
    setSite(portal)

    activate_and_reindex(portal, clear="--clear" in sys.argv)

    transaction.commit()
    app._p_jar.sync()

[davisagli]

@reekitconcept Thanks. @ericof added the scripts to kitconcept.intranet last week.

[davisagli]

This was done in #58