#!/usr/bin/env bash set -eo pipefail shopt -s nullglob MARIADB_ROOT_HOST="%" MARIADB_AUTO_UPGRADE="yes" MARIADB_DATABASE="$DATABASE_CREATE" MARIADB_USER="$DATABASE_USER_NORMAL" MARIADB_PASSWORD="$DATABASE_PASS_NORMAL" MARIADB_ROOT_PASSWORD="$DATABASE_PASS_ROOT" MARIADB_ALLOW_EMPTY_ROOT_PASSWORD="" MARIADB_INITDB_SKIP_TZINFO="" MARIADB_RANDOM_ROOT_PASSWORD="" # logging functions mysql_log() { local type="$1" shift printf '%s [%s] [Entrypoint]: %s\n' "$(date --rfc-3339=seconds)" "$type" "$*" } mysql_note() { mysql_log Note "$@" } mysql_warn() { mysql_log Warn "$@" >&2 } mysql_error() { mysql_log ERROR "$@" >&2 exit 1 } # usage: file_env VAR [DEFAULT] # ie: file_env 'XYZ_DB_PASSWORD' 'example' # (will allow for "$XYZ_DB_PASSWORD_FILE" to fill in the value of # "$XYZ_DB_PASSWORD" from a file, especially for Docker's secrets feature) file_env() { local var="$1" local fileVar="${var}_FILE" local def="${2:-}" if [ "${!var:-}" ] && [ "${!fileVar:-}" ]; then mysql_error "Both $var and $fileVar are set (but are exclusive)" fi local val="$def" if [ "${!var:-}" ]; then val="${!var}" elif [ "${!fileVar:-}" ]; then val="$(<"${!fileVar}")" fi export "$var"="$val" unset "$fileVar" } # set MARIADB_xyz from MYSQL_xyz when MARIADB_xyz is unset # and make them the same value (so user scripts can use either) _mariadb_file_env() { local var="$1" shift local maria="MARIADB_${var#MYSQL_}" file_env "$var" "$@" file_env "$maria" "${!var}" if [ "${!maria:-}" ]; then export "$var"="${!maria}" fi } # check to see if this file is being run or sourced from another script _is_sourced() { # https://unix.stackexchange.com/a/215279 [ "${#FUNCNAME[@]}" -ge 2 ] && [ "${FUNCNAME[0]}" = '_is_sourced' ] && [ "${FUNCNAME[1]}" = 'source' ] } # usage: docker_process_init_files [file [file [...]]] # ie: docker_process_init_files /always-initdb.d/* # process initializer files, based on file extensions docker_process_init_files() { # mysql here for backwards compatibility "${mysql[@]}" # ShellCheck: mysql appears unused. Verify use (or export if used externally) # shellcheck disable=SC2034 mysql=(docker_process_sql) echo local f for f; do case "$f" in *.sh) # https://github.com/docker-library/postgres/issues/450#issuecomment-393167936 # https://github.com/docker-library/postgres/pull/452 if [ -x "$f" ]; then mysql_note "$0: running $f" "$f" else mysql_note "$0: sourcing $f" # ShellCheck can't follow non-constant source. Use a directive to specify location. # shellcheck disable=SC1090 . "$f" fi ;; *.sql) mysql_note "$0: running $f" docker_process_sql <"$f" echo ;; *.sql.gz) mysql_note "$0: running $f" gunzip -c "$f" | docker_process_sql echo ;; *.sql.xz) mysql_note "$0: running $f" xzcat "$f" | docker_process_sql echo ;; *.sql.zst) mysql_note "$0: running $f" zstd -dc "$f" | docker_process_sql echo ;; *) mysql_warn "$0: ignoring $f" ;; esac echo done } # arguments necessary to run "mariadbd --verbose --help" successfully (used for testing configuration validity and for extracting default/configured values) _verboseHelpArgs=( --verbose --help ) mysql_check_config() { local toRun=("$@" "${_verboseHelpArgs[@]}") errors if ! errors="$("${toRun[@]}" 2>&1 >/dev/null)"; then mysql_error $'mariadbd failed while attempting to check config\n\tcommand was: '"${toRun[*]}"$'\n\t'"$errors" fi } # Fetch value from server config # We use mariadbd --verbose --help instead of my_print_defaults because the # latter only show values present in config files, and not server defaults mysql_get_config() { local conf="$1" shift "$@" "${_verboseHelpArgs[@]}" 2>/dev/null | awk -v conf="$conf" '$1 == conf && /^[^ \t]/ { sub(/^[^ \t]+[ \t]+/, ""); print; exit }' # match "datadir /some/path with/spaces in/it here" but not "--xyz=abc\n datadir (xyz)" } # Do a temporary startup of the MariaDB server, for init purposes docker_temp_server_start() { "$@" --skip-networking --default-time-zone=SYSTEM --socket="${SOCKET}" --wsrep_on=OFF \ --expire-logs-days=0 \ --loose-innodb_buffer_pool_load_at_startup=0 & declare -g MARIADB_PID MARIADB_PID=$! mysql_note "Waiting for server startup" # only use the root password if the database has already been initialized # so that it won't try to fill in a password file when it hasn't been set yet extraArgs=() if [ -z "$DATABASE_ALREADY_EXISTS" ]; then extraArgs+=('--dont-use-mysql-root-password') fi local i for i in {30..0}; do if docker_process_sql "${extraArgs[@]}" --database=mysql <<<'SELECT 1' &>/dev/null; then break fi sleep 1 done if [ "$i" = 0 ]; then mysql_error "Unable to start server." fi } # Stop the server. When using a local socket file mariadb-admin will block until # the shutdown is complete. docker_temp_server_stop() { kill "$MARIADB_PID" wait "$MARIADB_PID" } # Verify that the minimally required password settings are set for new databases. docker_verify_minimum_env() { if [ -z "$MARIADB_ROOT_PASSWORD" ] && [ -z "$MARIADB_ROOT_PASSWORD_HASH" ] && [ -z "$MARIADB_ALLOW_EMPTY_ROOT_PASSWORD" ] && [ -z "$MARIADB_RANDOM_ROOT_PASSWORD" ]; then mysql_error $'Database is uninitialized and password option is not specified\n\tYou need to specify one of MARIADB_ROOT_PASSWORD, MARIADB_ROOT_PASSWORD_HASH, MARIADB_ALLOW_EMPTY_ROOT_PASSWORD and MARIADB_RANDOM_ROOT_PASSWORD' fi # More preemptive exclusions of combinations should have been made before *PASSWORD_HASH was added, but for now we don't enforce due to compatibility. if [ -n "$MARIADB_ROOT_PASSWORD" ] || [ -n "$MARIADB_ALLOW_EMPTY_ROOT_PASSWORD" ] || [ -n "$MARIADB_RANDOM_ROOT_PASSWORD" ] && [ -n "$MARIADB_ROOT_PASSWORD_HASH" ]; then mysql_error "Cannot specify MARIADB_ROOT_PASSWORD_HASH and another MARIADB_ROOT_PASSWORD* option." fi if [ -n "$MARIADB_PASSWORD" ] && [ -n "$MARIADB_PASSWORD_HASH" ]; then mysql_error "Cannot specify MARIADB_PASSWORD_HASH and MARIADB_PASSWORD option." fi } # creates folders for the database # also ensures permission for user mysql of run as root docker_create_db_directories() { local user user="$(id -u)" # TODO other directories that are used by default? like /var/lib/mysql-files # see https://github.com/docker-library/mysql/issues/562 mkdir -p "$DATADIR" if [ "$user" = "0" ]; then # this will cause less disk access than `chown -R` find "$DATADIR" \! -user mysql -exec chown mysql: '{}' + # See https://github.com/MariaDB/mariadb-docker/issues/363 find "${SOCKET%/*}" -maxdepth 0 \! -user mysql -exec chown mysql: '{}' \; fi } _mariadb_version() { local mariaVersion="${MARIADB_VERSION##*:}" mariaVersion="${mariaVersion%%[-+~]*}" echo -n "${mariaVersion}-MariaDB" } # initializes the database directory docker_init_database_dir() { mysql_note "Initializing database files" installArgs=(--datadir="$DATADIR" --rpm --auth-root-authentication-method=normal) # "Other options are passed to mariadbd." (so we pass all "mysqld" arguments directly here) mariadb-install-db "${installArgs[@]}" "${@:2}" \ --skip-test-db \ --old-mode='UTF8_IS_UTF8MB3' \ --default-time-zone=SYSTEM --enforce-storage-engine= \ --skip-log-bin \ --expire-logs-days=0 \ --loose-innodb_buffer_pool_load_at_startup=0 \ --loose-innodb_buffer_pool_dump_at_shutdown=0 mysql_note "Database files initialized" } # Loads various settings that are used elsewhere in the script # This should be called after mysql_check_config, but before any other functions docker_setup_env() { # Get config declare -g DATADIR SOCKET DATADIR="$(mysql_get_config 'datadir' "$@")" SOCKET="$(mysql_get_config 'socket' "$@")" # Initialize values that might be stored in a file _mariadb_file_env 'MYSQL_ROOT_HOST' '%' _mariadb_file_env 'MYSQL_DATABASE' _mariadb_file_env 'MYSQL_USER' _mariadb_file_env 'MYSQL_PASSWORD' _mariadb_file_env 'MYSQL_ROOT_PASSWORD' # No MYSQL_ compatibility needed for new variables file_env 'MARIADB_PASSWORD_HASH' file_env 'MARIADB_ROOT_PASSWORD_HASH' # set MARIADB_ from MYSQL_ when it is unset and then make them the same value : "${MARIADB_ALLOW_EMPTY_ROOT_PASSWORD:=${MYSQL_ALLOW_EMPTY_PASSWORD:-}}" export MYSQL_ALLOW_EMPTY_PASSWORD="$MARIADB_ALLOW_EMPTY_ROOT_PASSWORD" MARIADB_ALLOW_EMPTY_ROOT_PASSWORD : "${MARIADB_RANDOM_ROOT_PASSWORD:=${MYSQL_RANDOM_ROOT_PASSWORD:-}}" export MYSQL_RANDOM_ROOT_PASSWORD="$MARIADB_RANDOM_ROOT_PASSWORD" MARIADB_RANDOM_ROOT_PASSWORD : "${MARIADB_INITDB_SKIP_TZINFO:=${MYSQL_INITDB_SKIP_TZINFO:-}}" export MYSQL_INITDB_SKIP_TZINFO="$MARIADB_INITDB_SKIP_TZINFO" MARIADB_INITDB_SKIP_TZINFO declare -g DATABASE_ALREADY_EXISTS if [ -d "$DATADIR/mysql" ]; then DATABASE_ALREADY_EXISTS='true' fi } # Execute the client, use via docker_process_sql to handle root password docker_exec_client() { # args sent in can override this db, since they will be later in the command if [ -n "$MYSQL_DATABASE" ]; then set -- --database="$MYSQL_DATABASE" "$@" fi mariadb --protocol=socket -uroot -hlocalhost --socket="${SOCKET}" "$@" } # Execute sql script, passed via stdin # usage: docker_process_sql [--dont-use-mysql-root-password] [mysql-cli-args] # ie: docker_process_sql --database=mydb <<<'INSERT ...' # ie: docker_process_sql --dont-use-mysql-root-password --database=mydb "${DATADIR}/${backup_db}"; then mysql_error "Unable backup system database for upgrade from $oldfullversion." fi mysql_note "Backing up complete" } # perform mariadb-upgrade # backup the mysql database if this is a major upgrade docker_mariadb_upgrade() { if [ -z "$MARIADB_AUTO_UPGRADE" ] || [ "$MARIADB_AUTO_UPGRADE" = 0 ]; then mysql_note "MariaDB upgrade (mariadb-upgrade) required, but skipped due to \$MARIADB_AUTO_UPGRADE setting" return fi mysql_note "Starting temporary server" docker_temp_server_start "$@" --skip-grant-tables \ --loose-innodb_buffer_pool_dump_at_shutdown=0 \ --skip-slave-start mysql_note "Temporary server started." docker_mariadb_backup_system mysql_note "Starting mariadb-upgrade" mariadb-upgrade --upgrade-system-tables mysql_note "Finished mariadb-upgrade" mysql_note "Stopping temporary server" docker_temp_server_stop mysql_note "Temporary server stopped" } _check_if_upgrade_is_needed() { if [ ! -f "$DATADIR"/mariadb_upgrade_info ]; then mysql_note "MariaDB upgrade information missing, assuming required" return 0 fi local mariadbVersion mariadbVersion="$(_mariadb_version)" IFS='.-' read -ra newversion <<<"$mariadbVersion" IFS='.-' read -ra oldversion <"$DATADIR"/mariadb_upgrade_info || true if [[ ${#newversion[@]} -lt 2 ]] || [[ ${#oldversion[@]} -lt 2 ]] || [[ ${oldversion[0]} -lt ${newversion[0]} ]] || [[ ${oldversion[0]} -eq ${newversion[0]} && ${oldversion[1]} -lt ${newversion[1]} ]]; then return 0 fi mysql_note "MariaDB upgrade not required" return 1 } # check arguments for an option that would cause mariadbd to stop # return true if there is one _mysql_want_help() { local arg for arg; do case "$arg" in -'?' | --help | --print-defaults | -V | --version) return 0 ;; esac done return 1 } _main() { # if command starts with an option, prepend mariadbd if [ "${1:0:1}" = '-' ]; then set -- mariadbd "$@" fi #ENDOFSUBSTITUTIONS # skip setup if they aren't running mysqld or want an option that stops mysqld if [ "$1" = 'mariadbd' ] || [ "$1" = 'mysqld' ] && ! _mysql_want_help "$@"; then mysql_note "Entrypoint script for MariaDB Server ${MARIADB_VERSION} started." mysql_check_config "$@" # Load various environment variables docker_setup_env "$@" docker_create_db_directories # If container is started as root user, restart as dedicated mysql user if [ "$(id -u)" = "0" ]; then mysql_note "Switching to dedicated user 'mysql'" exec gosu mysql "${BASH_SOURCE[0]}" "$@" fi # there's no database, so it needs to be initialized if [ -z "$DATABASE_ALREADY_EXISTS" ]; then docker_verify_minimum_env # check dir permissions to reduce likelihood of half-initialized database ls /docker-entrypoint-initdb.d/ >/dev/null docker_init_database_dir "$@" mysql_note "Starting temporary server" docker_temp_server_start "$@" mysql_note "Temporary server started." docker_setup_db docker_process_init_files /docker-entrypoint-initdb.d/* # Wait until after /docker-entrypoint-initdb.d is performed before setting # root@localhost password to a hash we don't know the password for. if [ -n "${MARIADB_ROOT_PASSWORD_HASH}" ]; then mysql_note "Setting root@localhost password hash" docker_process_sql --dont-use-mysql-root-password --binary-mode <<-EOSQL SET @@SESSION.SQL_LOG_BIN=0; SET PASSWORD FOR 'root'@'localhost'= '${MARIADB_ROOT_PASSWORD_HASH}'; EOSQL fi mysql_note "Stopping temporary server" docker_temp_server_stop mysql_note "Temporary server stopped" echo mysql_note "MariaDB init process done. Ready for start up." echo # MDEV-27636 mariadb_upgrade --check-if-upgrade-is-needed cannot be run offline #elif mariadb-upgrade --check-if-upgrade-is-needed; then elif _check_if_upgrade_is_needed; then docker_mariadb_upgrade "$@" fi fi exec "$@" } # If we are sourced from elsewhere, don't perform any further actions if ! _is_sourced; then _main "$@" fi