Rewrite LocalSettings.php on every container launch in order to reflect env var changes
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	roti_WMDE
	Oct 12 2023, 11:56 AM

Description

Current Situation:
The WikiBase build runs Docker/build/Wikibase/entrypoint.sh on each container start or restart. However, currently a new LocalSettings.php in the container is only created from LocalSettings.php.template with the environment variables substitute if the file has not already been created (see line 24 of Docker/build/Wikibase/entrypoint.sh). This means that after the initial run of the container the environment variables won't be replaced again unless the user directly deletes the LocalSettings.php in the container and restarts it.

Presumably it is done this way to respect changes a user may make to LocalSettings.php after initially creating the container. As long as we want to continue with that behaviour, if the user wants to have environment variable values in that file reflected they will need to intervene by removing the exiting LocalSettings.php and restarting the container.

It would probably be cleaner to not support user changes to that file, and rely upon one of the other mechanisms for setting and overriding values in this base LocalSettings.php file (i.e. volume mapping in your own LocalSettings.php file as described in this comment in example/docker-compose.yml.

The underlying question here is whether we want to continue to implicitly support user changes in the LocalSettings.php in the container?

Goal:

Make it possible to override environment variables without needing to restart the container.

Acceptance Criteria:

[optional] Notes:

Details

Other Assignee: roti_WMDE

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved	Spike	lojo_wmde	T356617 Fix Example a.k.a. Separation of code, config and data
		Resolved		lojo_wmde	T348742 Rewrite LocalSettings.php on every container launch in order to reflect env var changes

Event Timeline

roti_WMDE created this task.Oct 12 2023, 11:56 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 12 2023, 11:56 AM

The WikiBase build runs Docker/build/Wikibase/entrypoint.sh on each container start or restart. However, currently a new LocalSettings.php in the container is only created from LocalSettings.php.template with the environment variables substitute if the file has not already been created (see line 24 of Docker/build/Wikibase/entrypoint.sh). This means that after the initial run of the container the environment variables won't be replaced again unless the user directly deletes the LocalSettings.php in the container and restarts it.

Presumably it is done this way to respect changes a user may make to LocalSettings.php after initially creating the container. As long as we want to continue with that behaviour, if the user wants to have environment variable values in that file reflected they will need to intervene by removing the exiting LocalSettings.php and restarting the container.

I think the underlying question here is whether we want to continue to implicitly support user changes in the LocalSettings.php in the container?

It would probably be cleaner to not support user changes to that file, and rely upon one of the other mechanisms for setting and overriding values in this base LocalSettings.php file (i.e. volume mapping in your own LocalSettings.php file as described in this comment in example/docker-compose.yml.

lojo_wmde moved this task from Inbox to Focus: Initial Setup and Configuration on the Wikibase Suite Team board.Oct 19 2023, 1:15 PM

adee_wmde changed the task status from Open to In Progress.Oct 19 2023, 2:24 PM

adee_wmde claimed this task.

adee_wmde moved this task from Focus: Initial Setup and Configuration to Sprint-∞ on the Wikibase Suite Team board.

adee_wmde edited projects, added Wikibase Suite Team (Sprint-∞); removed Wikibase Suite Team.

adee_wmde moved this task from To do (prio from top to bottom) to Doing on the Wikibase Suite Team (Sprint-∞) board.

darthmon_wmde removed adee_wmde as the assignee of this task.Nov 8 2023, 12:10 PM

darthmon_wmde moved this task from Doing to To do (prio from top to bottom) on the Wikibase Suite Team (Sprint-∞) board.

darthmon_wmde added a project: Initial Setup & Configuration.

darthmon_wmde moved this task from Sprint-∞ to Prioritised + Refined (ready to be moved into the sprint) on the Wikibase Suite Team board.

darthmon_wmde edited projects, added Wikibase Suite Team; removed Wikibase Suite Team (Sprint-∞).

darthmon_wmde added a subscriber: adee_wmde.