Merge pull request #240 from jdeathe/issue/235

CLOSES #235: Adds improved basic initialisation SQL feature.

Author: jdeathe

CHANGELOG.md

@@ -25,8 +25,11 @@ CentOS-6 6.10 x86_64 - MySQL 5.1.
 - Adds improvement to pull logic in systemd unit install template.
 - Adds `SSH_AUTOSTART_SUPERVISOR_STDOUT` with a value "false", disabling startup of `supervisor_stdout`.
 - Adds improved `healtchcheck`, `sshd-bootstrap` and `sshd-wrapper` scripts.
+- Adds `MYSQL_INIT_LIMIT` with a default value of "60" seconds.
+- Adds `MYSQL_INIT_SQL` with a default empty value "".
+- Deprecates `CUSTOM_MYSQL_INIT_SQL`, use `MYSQL_INIT_SQL` instead.
 - Removes use of `/etc/services-config` paths.
-- Removes code from configuration file `/etc/mysqld-bootstrap.conf`.
+- Removes use of `/etc/mysqld-bootstrap.conf`.
 - Removes X-Fleet section from etcd register template unit-file.
 - Removes the unused group element from the default container name.
 - Removes the node element from the default container name.

Dockerfile

@@ -31,7 +31,7 @@ RUN sed -i \
 		-e "s~{{RELEASE_VERSION}}~${RELEASE_VERSION}~g" \
 		/etc/systemd/system/centos-ssh-mysql@.service \
 	&& chmod 600 \
-		/etc/{my.cnf,mysqld-bootstrap.conf} \
+		/etc/my.cnf \
 	&& chmod 644 \
 		/etc/supervisord.d/mysqld-{bootstrap,wrapper}.conf \
 	&& chmod 700 \
@@ -44,6 +44,8 @@ EXPOSE 3306
 # ------------------------------------------------------------------------------
 ENV MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP="true" \
 	MYSQL_AUTOSTART_MYSQLD_WRAPPER="true" \
+	MYSQL_INIT_LIMIT="60" \
+	MYSQL_INIT_SQL="" \
 	MYSQL_ROOT_PASSWORD="" \
 	MYSQL_ROOT_PASSWORD_HASHED="false" \
 	MYSQL_SUBNET="127.0.0.1" \

README.md

@@ -54,9 +54,7 @@ $ docker logs mysql.1
 
 On the first run, there will be additional output showing the initialisation SQL template and, before mysqld-bootstrap completes, the MySQL Details which shows the configured database, if applicable, and any associated user credentials.
 
-![Docker Logs - MySQL Initialisation SQL Template](https://raw.github.com/jdeathe/centos-ssh-mysql/centos-6/images/docker-logs-mysqld-bootstrap-initialisation-sql.png)
-
-![Docker Logs - MySQL Details](https://raw.github.com/jdeathe/centos-ssh-mysql/centos-6/images/docker-logs-mysqld-bootstrap-details.png)
+![Docker Logs - MySQL Bootstrap](https://raw.github.com/jdeathe/centos-ssh-mysql/centos-6/images/docker-logs-mysqld-bootstrap.png)
 
 The MySQL table data is persistent across container restarts by setting the MySQL data directory `/var/lib/mysql` as a data volume. We didn't specify a name or docker_host path so Docker will give it a unique name and store it in `/var/lib/docker/volumes/`; to find out where the data is stored on the Docker host you can use `docker inspect`.
 
@@ -289,6 +287,34 @@ It may be desirable to prevent the startup of the mysqld-bootstrap and/or mysqld
 ...
 ```
 
+##### MYSQL_INIT_LIMIT
+
+The default timeout for MySQL initialisation is 60 seconds. Use `MYSQL_INIT_LIMIT` to change this value when necessary.
+
+```
+...
+  --env "MYSQL_INIT_LIMIT=120" \
+...
+```
+
+##### MYSQL_INIT_SQL
+
+To add custom SQL to the MySQL intitialisation use `MYSQL_INIT_SQL` where the following placeholders are will get replaced with the appropriate values:
+
+- `{{MYSQL_ROOT_PASSWORD}}`
+- `{{MYSQL_USER}}`
+- `{{MYSQL_USER_DATABASE}}`
+- `{{MYSQL_USER_HOST}}`
+- `{{MYSQL_USER_PASSWORD}}`
+
+*Note:* The backtick "\`" character will need escaping as show in the example.
+
+```
+...
+  --env "MYSQL_INIT=CREATE DATABASE \`{{MYSQL_USER_DATABASE}}-1\`; GRANT ALL PRIVILEGES ON \`{{MYSQL_USER_DATABASE}}-%\`.* TO '{{MYSQL_USER}}'@'{{MYSQL_USER_HOST}}';" \
+...
+```
+
 ##### MYSQL_ROOT_PASSWORD
 
 On first run the root user is created with an auto-generated password. If you require a specific password,  `MYSQL_ROOT_PASSWORD` can be used when running the container.

default.mk

@@ -43,6 +43,8 @@ define DOCKER_CONTAINER_PARAMETERS
 --restart $(DOCKER_RESTART_POLICY) \
 --env "MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP=$(MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP)" \
 --env "MYSQL_AUTOSTART_MYSQLD_WRAPPER=$(MYSQL_AUTOSTART_MYSQLD_WRAPPER)" \
+--env "MYSQL_INIT_LIMIT=$(MYSQL_INIT_LIMIT)" \
+--env "MYSQL_INIT_SQL=$(MYSQL_INIT_SQL)" \
 --env "MYSQL_ROOT_PASSWORD=$(MYSQL_ROOT_PASSWORD)" \
 --env "MYSQL_ROOT_PASSWORD_HASHED=$(MYSQL_ROOT_PASSWORD_HASHED)" \
 --env "MYSQL_SUBNET=$(MYSQL_SUBNET)" \

environment.mk

@@ -34,6 +34,8 @@ STARTUP_TIME ?= 7
 # ------------------------------------------------------------------------------
 MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP ?= true
 MYSQL_AUTOSTART_MYSQLD_WRAPPER ?= true
+MYSQL_INIT_LIMIT ?= 60
+MYSQL_INIT_SQL ?=
 MYSQL_ROOT_PASSWORD ?=
 MYSQL_ROOT_PASSWORD_HASHED ?= false
 MYSQL_SUBNET ?= 127.0.0.1

images/docker-logs-mysqld-bootstrap.png

@@ -58,6 +58,8 @@ Environment="DOCKER_PORT_MAP_TCP_3306=3306"
 Environment="DOCKER_USER=jdeathe"
 Environment="MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP=true"
 Environment="MYSQL_AUTOSTART_MYSQLD_WRAPPER=true"
+Environment="MYSQL_INIT_LIMIT="
+Environment="MYSQL_INIT_SQL="
 Environment="MYSQL_ROOT_PASSWORD="
 Environment="MYSQL_ROOT_PASSWORD_HASHED=false"
 Environment="MYSQL_SUBNET=127.0.0.1"
@@ -123,6 +125,8 @@ ExecStart=/bin/bash -c \
     --name %p.%i \
     --env \"MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP=${MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP}\" \
     --env \"MYSQL_AUTOSTART_MYSQLD_WRAPPER=${MYSQL_AUTOSTART_MYSQLD_WRAPPER}\" \
+    --env \"MYSQL_INIT_LIMIT=${MYSQL_INIT_LIMIT}\" \
+    --env \"MYSQL_INIT_SQL=${MYSQL_INIT_SQL}\" \
     --env \"MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}\" \
     --env \"MYSQL_ROOT_PASSWORD_HASHED=${MYSQL_ROOT_PASSWORD_HASHED}\" \
     --env \"MYSQL_SUBNET=${MYSQL_SUBNET}\" \

src/etc/mysqld-bootstrap.conf

@@ -48,6 +48,8 @@ DOCKER_CONTAINER_PARAMETERS="--name ${DOCKER_NAME} \
 --restart ${DOCKER_RESTART_POLICY} \
 --env \"MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP=${MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP}\" \
 --env \"MYSQL_AUTOSTART_MYSQLD_WRAPPER=${MYSQL_AUTOSTART_MYSQLD_WRAPPER}\" \
+--env \"MYSQL_INIT_LIMIT=${MYSQL_INIT_LIMIT}\" \
+--env \"MYSQL_INIT_SQL=${MYSQL_INIT_SQL}\" \
 --env \"MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}\" \
 --env \"MYSQL_ROOT_PASSWORD_HASHED=${MYSQL_ROOT_PASSWORD_HASHED}\" \
 --env \"MYSQL_SUBNET=${MYSQL_SUBNET}\" \

src/etc/systemd/system/centos-ssh-mysql@.service

@@ -38,6 +38,8 @@ REGISTER_UPDATE_INTERVAL="${REGISTER_UPDATE_INTERVAL:-95}"
 # ------------------------------------------------------------------------------
 MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP="${MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP:-true}"
 MYSQL_AUTOSTART_MYSQLD_WRAPPER="${MYSQL_AUTOSTART_MYSQLD_WRAPPER:-true}"
+MYSQL_INIT_LIMIT="${MYSQL_INIT_LIMIT:-60}"
+MYSQL_INIT_SQL="${MYSQL_INIT_SQL:-}"
 MYSQL_ROOT_PASSWORD="${MYSQL_ROOT_PASSWORD:-}"
 MYSQL_ROOT_PASSWORD_HASHED="${MYSQL_ROOT_PASSWORD_HASHED:-false}"
 MYSQL_SUBNET="${MYSQL_SUBNET:-127.0.0.1}"

src/opt/scmi/default.sh

@@ -8,6 +8,8 @@ readonly SERVICE_UNIT_ENVIRONMENT_KEYS="
  DOCKER_PORT_MAP_TCP_3306
  MYSQL_AUTOSTART_MYSQLD_BOOTSTRAP
  MYSQL_AUTOSTART_MYSQLD_WRAPPER
+ MYSQL_INIT_LIMIT
+ MYSQL_INIT_SQL
  MYSQL_ROOT_PASSWORD
  MYSQL_ROOT_PASSWORD_HASHED
  MYSQL_SUBNET

src/opt/scmi/environment.sh

@@ -1,7 +1,5 @@
 #!/usr/bin/env bash
 
-source /etc/mysqld-bootstrap.conf
-
 # Set MySQL client root user password
 # - Prefer to store encrypted via mysql_config_editor.
 # - Fallback to store as plaintext in secured file.
@@ -136,7 +134,8 @@ function __get_mysql_init_sql ()
 {
 	local -r default_value="${1:-"-- Custom Initialisation SQL"}"
 
-	local value="${MYSQL_INIT_SQL}"
+	# CUSTOM_MYSQL_INIT_SQL is deprecated, use MYSQL_INIT_SQL
+	local value="${MYSQL_INIT_SQL:-"${CUSTOM_MYSQL_INIT_SQL}"}"
 
 	if ! __is_valid_mysql_init_sql "${value}"
 	then
@@ -246,7 +245,7 @@ function __get_mysql_init_template ()
 
 		printf \
 			-v template_user \
-			-- "%s\nCREATE USER '%s'@'%s' \n%s '%s';" \
+			-- "%s\nCREATE USER '%s'@'%s'\n%s '%s';" \
 			"${template_user}" \
 			"{{MYSQL_USER}}" \
 			"{{MYSQL_USER_HOST}}" \
@@ -260,14 +259,20 @@ function __get_mysql_init_template ()
 	then
 		printf \
 			-v template_privileges \
-			-- "%s\nGRANT %s \nON \`%s\`.* \nTO '%s'@'%s';" \
+			-- "%s\nGRANT %s\nON \`%s\`.*\nTO '%s'@'%s';" \
 			"${template_privileges}" \
 			"ALL PRIVILEGES" \
 			"{{MYSQL_USER_DATABASE}}" \
 			"{{MYSQL_USER}}" \
 			"{{MYSQL_USER_HOST}}"
 	fi
 
+	# Each statement must be on a single line and should not include comments.
+	# Append a newline character to SQL line ending characters ";".
+	init_sql="${init_sql//; /;}"
+	init_sql="${init_sql//;/;$'\n'}"
+	init_sql="${init_sql/%$'\n'}"
+
 	# Listen for the template and output as required
 	if [[ ${compact} == false ]]
 	then
@@ -312,8 +317,8 @@ function __get_mysql_init_template ()
 		-- Custom Initialisation SQL end
 		-- -----------------------------------------------------------------------------
 		${template_privileges}
-		GRANT ALL PRIVILEGES 
-		ON *.* 
+		GRANT ALL PRIVILEGES
+		ON *.*
 		TO 'root'@'localhost' IDENTIFIED BY '{{MYSQL_ROOT_PASSWORD}}' WITH GRANT OPTION;
 		FLUSH PRIVILEGES;
 		-- -----------------------------------------------------------------------------

src/opt/scmi/service-unit.sh

@@ -2,8 +2,6 @@
 
 set -e
 
-source /etc/mysqld-bootstrap.conf
-
 function __is_valid_mysql_autostart_mysqld_bootstrap ()
 {
 	local -r boolean_value='^(true|false)$'