Merge pull request #265 from Automattic/mariadb-extra-options

feat(mariadb): pass extra options to `mariadb`
Automattic · Jun 23, 2024 · 9269733 · 9269733
2 parents 94776c3 + 6b1a871
commit 9269733
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 7 deletions.
diff --git a/features/src/mariadb/devcontainer-feature.json b/features/src/mariadb/devcontainer-feature.json
@@ -1,14 +1,19 @@
 {
     "name": "MariaDB",
     "id": "mariadb",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "Sets up MariaDB into the Dev Environment",
     "options": {
         "installDatabaseToWorkspaces": {
             "type": "boolean",
             "default": false,
             "description": "Set MariaDB data directory to /workspaces/mysql-data to persist data between container rebuilds (GHCS)"
         },
+        "extra-options": {
+            "type": "string",
+            "default": "",
+            "description": "Extra options to pass to the MariaDB server"
+        },
         "install-runit-service": {
             "type": "boolean",
             "default": true,

diff --git a/features/src/mariadb/entrypoint.alpine.tpl b/features/src/mariadb/entrypoint.alpine.tpl
@@ -16,19 +16,21 @@ if [ ! -d "${MARIADB_DATADIR}/mysql" ]; then
 fi
 
 if [ -x /sbin/chpst ]; then
+    # shellcheck disable=SC2086,SC2154 # there could be multiple options in EXTRA_OPTIONS
     exec chpst -u "${MARIADB_USER}:${MARIADB_USER}" \
         mysqld \
             --datadir="${MARIADB_DATADIR}" \
             --sql-mode=ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION \
             --max_allowed_packet=67M \
             --skip_networking=0 \
-            --bind-address=127.0.0.1 &
+            --bind-address=127.0.0.1 ${EXTRA_OPTIONS} &
 else
+    # shellcheck disable=SC2086 # there could be multiple options in EXTRA_OPTIONS
     exec su-exec "${MARIADB_USER}:${MARIADB_USER}" \
         mysqld \
             --datadir="${MARIADB_DATADIR}" \
             --sql-mode=ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION \
             --max_allowed_packet=67M \
             --skip_networking=0 \
-            --bind-address=127.0.0.1 &
+            --bind-address=127.0.0.1 ${EXTRA_OPTIONS} &
 fi
diff --git a/features/src/mariadb/entrypoint.deb.tpl b/features/src/mariadb/entrypoint.deb.tpl
@@ -18,10 +18,11 @@ fi
 MY_UID="$(id -u "${MARIADB_USER}")"
 MY_GID="$(id -g "${MARIADB_USER}")"
 
+# shellcheck disable=SC2086,SC2154 # there could be multiple options in EXTRA_OPTIONS
 exec setpriv --reuid="${MY_UID}" --regid="${MY_GID}" --inh-caps=-all --init-groups \
     mysqld \
         --datadir="${MARIADB_DATADIR}" \
         --sql-mode=ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION \
         --max_allowed_packet=67M \
         --skip_networking=0 \
-        --bind-address=127.0.0.1 &
+        --bind-address=127.0.0.1 ${EXTRA_OPTIONS} &
diff --git a/features/src/mariadb/install.sh b/features/src/mariadb/install.sh
@@ -14,6 +14,7 @@ echo '(*) Installing MariaDB...'
 : "${_REMOTE_USER:?"_REMOTE_USER is required"}"
 : "${INSTALLDATABASETOWORKSPACES:=}"
 : "${INSTALL_RUNIT_SERVICE:=true}"
+: "${EXTRA_OPTIONS:=""}"
 
 if [ "${_REMOTE_USER}" = "root" ]; then
     MARIADB_USER=mysql
@@ -93,17 +94,18 @@ fi
 
 export MARIADB_USER
 export MARIADB_DATADIR
+export EXTRA_OPTIONS
 
 if [ "${INSTALL_RUNIT_SERVICE}" = 'true' ] && [ -d /etc/sv ]; then
     install -D -d -m 0755 -o root -g root /etc/service /etc/sv/mariadb
     # shellcheck disable=SC2016
-    envsubst '$MARIADB_USER $MARIADB_DATADIR' < service-run.tpl > /etc/sv/mariadb/run && chmod 0755 /etc/sv/mariadb/run
+    envsubst '$MARIADB_USER $MARIADB_DATADIR $EXTRA_OPTIONS' < service-run.tpl > /etc/sv/mariadb/run && chmod 0755 /etc/sv/mariadb/run
     ln -sf /etc/sv/mariadb /etc/service/mariadb
 fi
 
 if [ -d /var/lib/entrypoint.d ]; then
     # shellcheck disable=SC2016
-    envsubst '$MARIADB_USER $MARIADB_DATADIR' < "${ENTRYPOINT}" > /var/lib/entrypoint.d/50-mariadb
+    envsubst '$MARIADB_USER $MARIADB_DATADIR $EXTRA_OPTIONS' < "${ENTRYPOINT}" > /var/lib/entrypoint.d/50-mariadb
     chmod 0755 /var/lib/entrypoint.d/50-mariadb
 fi
 

diff --git a/features/src/mariadb/service-run.tpl b/features/src/mariadb/service-run.tpl
@@ -15,10 +15,11 @@ if [ ! -d "${MARIADB_DATADIR}/mysql" ]; then
     mysql_install_db --auth-root-authentication-method=normal --skip-test-db --user="${MARIADB_USER}" --datadir="${MARIADB_DATADIR}"
 fi
 
+# shellcheck disable=SC2086,SC2154 # there could be multiple options in EXTRA_OPTIONS
 exec chpst -u "${MARIADB_USER}:${MARIADB_USER}" \
     mysqld \
         --datadir="${MARIADB_DATADIR}" \
         --sql-mode=ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION \
         --max_allowed_packet=67M \
         --skip_networking=0 \
-        --bind-address=127.0.0.1
+        --bind-address=127.0.0.1 ${EXTRA_OPTIONS}