|
| 1 | +#!/bin/bash |
| 2 | + |
| 3 | +set -eo pipefail |
| 4 | +shopt -s nullglob |
| 5 | + |
| 6 | +DO_CHOWN=1 |
| 7 | +if [ "${CLICKHOUSE_DO_NOT_CHOWN:-0}" = "1" ]; then |
| 8 | + DO_CHOWN=0 |
| 9 | +fi |
| 10 | + |
| 11 | +CLICKHOUSE_UID="${CLICKHOUSE_UID:-"$(id -u clickhouse)"}" |
| 12 | +CLICKHOUSE_GID="${CLICKHOUSE_GID:-"$(id -g clickhouse)"}" |
| 13 | + |
| 14 | +# support --user |
| 15 | +if [ "$(id -u)" = "0" ]; then |
| 16 | + USER=$CLICKHOUSE_UID |
| 17 | + GROUP=$CLICKHOUSE_GID |
| 18 | +else |
| 19 | + USER="$(id -u)" |
| 20 | + GROUP="$(id -g)" |
| 21 | + DO_CHOWN=0 |
| 22 | +fi |
| 23 | + |
| 24 | +# set some vars |
| 25 | +CLICKHOUSE_CONFIG="${CLICKHOUSE_CONFIG:-/etc/clickhouse-server/config.xml}" |
| 26 | + |
| 27 | +# get CH directories locations |
| 28 | +DATA_DIR="$(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key=path || true)" |
| 29 | +TMP_DIR="$(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key=tmp_path || true)" |
| 30 | +USER_PATH="$(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key=user_files_path || true)" |
| 31 | +LOG_PATH="$(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key=logger.log || true)" |
| 32 | +LOG_DIR="" |
| 33 | +if [ -n "$LOG_PATH" ]; then LOG_DIR="$(dirname "$LOG_PATH")"; fi |
| 34 | +ERROR_LOG_PATH="$(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key=logger.errorlog || true)" |
| 35 | +ERROR_LOG_DIR="" |
| 36 | +if [ -n "$ERROR_LOG_PATH" ]; then ERROR_LOG_DIR="$(dirname "$ERROR_LOG_PATH")"; fi |
| 37 | +FORMAT_SCHEMA_PATH="$(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key=format_schema_path || true)" |
| 38 | + |
| 39 | +# There could be many disks declared in config |
| 40 | +readarray -t DISKS_PATHS < <(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key='storage_configuration.disks.*.path' || true) |
| 41 | +readarray -t DISKS_METADATA_PATHS < <(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key='storage_configuration.disks.*.metadata_path' || true) |
| 42 | + |
| 43 | +CLICKHOUSE_USER="${CLICKHOUSE_USER:-default}" |
| 44 | +CLICKHOUSE_PASSWORD_FILE="${CLICKHOUSE_PASSWORD_FILE:-}" |
| 45 | +if [[ -n "${CLICKHOUSE_PASSWORD_FILE}" && -f "${CLICKHOUSE_PASSWORD_FILE}" ]]; then |
| 46 | + CLICKHOUSE_PASSWORD="$(cat "${CLICKHOUSE_PASSWORD_FILE}")" |
| 47 | +fi |
| 48 | +CLICKHOUSE_PASSWORD="${CLICKHOUSE_PASSWORD:-}" |
| 49 | +CLICKHOUSE_DB="${CLICKHOUSE_DB:-}" |
| 50 | +CLICKHOUSE_ACCESS_MANAGEMENT="${CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT:-0}" |
| 51 | + |
| 52 | +function create_directory_and_do_chown() { |
| 53 | + local dir=$1 |
| 54 | + # check if variable not empty |
| 55 | + [ -z "$dir" ] && return |
| 56 | + # ensure directories exist |
| 57 | + if [ "$DO_CHOWN" = "1" ]; then |
| 58 | + mkdir="mkdir" |
| 59 | + else |
| 60 | + # if DO_CHOWN=0 it means that the system does not map root user to "admin" permissions |
| 61 | + # it mainly happens on NFS mounts where root==nobody for security reasons |
| 62 | + # thus mkdir MUST run with user id/gid and not from nobody that has zero permissions |
| 63 | + mkdir="/usr/bin/clickhouse su "${USER}:${GROUP}" mkdir" |
| 64 | + fi |
| 65 | + if ! $mkdir -p "$dir"; then |
| 66 | + echo "Couldn't create necessary directory: $dir" |
| 67 | + exit 1 |
| 68 | + fi |
| 69 | + |
| 70 | + if [ "$DO_CHOWN" = "1" ]; then |
| 71 | + # ensure proper directories permissions |
| 72 | + # but skip it for if directory already has proper premissions, cause recursive chown may be slow |
| 73 | + if [ "$(stat -c %u "$dir")" != "$USER" ] || [ "$(stat -c %g "$dir")" != "$GROUP" ]; then |
| 74 | + chown -R "$USER:$GROUP" "$dir" |
| 75 | + fi |
| 76 | + fi |
| 77 | +} |
| 78 | + |
| 79 | +create_directory_and_do_chown "$DATA_DIR" |
| 80 | + |
| 81 | +# Change working directory to $DATA_DIR in case there're paths relative to $DATA_DIR, also avoids running |
| 82 | +# clickhouse-server at root directory. |
| 83 | +cd "$DATA_DIR" |
| 84 | + |
| 85 | +for dir in "$ERROR_LOG_DIR" \ |
| 86 | + "$LOG_DIR" \ |
| 87 | + "$TMP_DIR" \ |
| 88 | + "$USER_PATH" \ |
| 89 | + "$FORMAT_SCHEMA_PATH" \ |
| 90 | + "${DISKS_PATHS[@]}" \ |
| 91 | + "${DISKS_METADATA_PATHS[@]}" |
| 92 | +do |
| 93 | + create_directory_and_do_chown "$dir" |
| 94 | +done |
| 95 | + |
| 96 | +# if clickhouse user is defined - create it (user "default" already exists out of box) |
| 97 | +if [ -n "$CLICKHOUSE_USER" ] && [ "$CLICKHOUSE_USER" != "default" ] || [ -n "$CLICKHOUSE_PASSWORD" ] || [ "$CLICKHOUSE_ACCESS_MANAGEMENT" != "0" ]; then |
| 98 | + echo "$0: create new user '$CLICKHOUSE_USER' instead 'default'" |
| 99 | + cat <<EOT > /etc/clickhouse-server/users.d/default-user.xml |
| 100 | + <clickhouse> |
| 101 | + <!-- Docs: <https://clickhouse.com/docs/en/operations/settings/settings_users/> --> |
| 102 | + <users> |
| 103 | + <!-- Remove default user --> |
| 104 | + <default remove="remove"> |
| 105 | + </default> |
| 106 | +
|
| 107 | + <${CLICKHOUSE_USER}> |
| 108 | + <profile>default</profile> |
| 109 | + <networks> |
| 110 | + <ip>::/0</ip> |
| 111 | + </networks> |
| 112 | + <password><![CDATA[${CLICKHOUSE_PASSWORD//]]>/]]]]><![CDATA[>}]]></password> |
| 113 | + <quota>default</quota> |
| 114 | + <access_management>${CLICKHOUSE_ACCESS_MANAGEMENT}</access_management> |
| 115 | + </${CLICKHOUSE_USER}> |
| 116 | + </users> |
| 117 | + </clickhouse> |
| 118 | +EOT |
| 119 | +fi |
| 120 | +
|
| 121 | +CLICKHOUSE_ALWAYS_RUN_INITDB_SCRIPTS="${CLICKHOUSE_ALWAYS_RUN_INITDB_SCRIPTS:-}" |
| 122 | +
|
| 123 | +# checking $DATA_DIR for initialization |
| 124 | +if [ -d "${DATA_DIR%/}/data" ]; then |
| 125 | + DATABASE_ALREADY_EXISTS='true' |
| 126 | +fi |
| 127 | +
|
| 128 | +# run initialization if flag CLICKHOUSE_ALWAYS_RUN_INITDB_SCRIPTS is not empty or data directory is empty |
| 129 | +if [[ -n "${CLICKHOUSE_ALWAYS_RUN_INITDB_SCRIPTS}" || -z "${DATABASE_ALREADY_EXISTS}" ]]; then |
| 130 | + RUN_INITDB_SCRIPTS='true' |
| 131 | +fi |
| 132 | +
|
| 133 | +if [ -n "${RUN_INITDB_SCRIPTS}" ]; then |
| 134 | + if [ -n "$(ls /docker-entrypoint-initdb.d/)" ] || [ -n "$CLICKHOUSE_DB" ]; then |
| 135 | + # port is needed to check if clickhouse-server is ready for connections |
| 136 | + HTTP_PORT="$(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key=http_port --try)" |
| 137 | + HTTPS_PORT="$(clickhouse extract-from-config --config-file "$CLICKHOUSE_CONFIG" --key=https_port --try)" |
| 138 | +
|
| 139 | + if [ -n "$HTTP_PORT" ]; then |
| 140 | + URL="http://127.0.0.1:$HTTP_PORT/ping" |
| 141 | + else |
| 142 | + URL="https://127.0.0.1:$HTTPS_PORT/ping" |
| 143 | + fi |
| 144 | +
|
| 145 | + # Listen only on localhost until the initialization is done |
| 146 | + /usr/bin/clickhouse su "${USER}:${GROUP}" /usr/bin/clickhouse-server --config-file="$CLICKHOUSE_CONFIG" -- --listen_host=127.0.0.1 & |
| 147 | + pid="$!" |
| 148 | +
|
| 149 | + # check if clickhouse is ready to accept connections |
| 150 | + # will try to send ping clickhouse via http_port (max 1000 retries by default, with 1 sec timeout and 1 sec delay between retries) |
| 151 | + tries=${CLICKHOUSE_INIT_TIMEOUT:-1000} |
| 152 | + while ! wget --spider --no-check-certificate -T 1 -q "$URL" 2>/dev/null; do |
| 153 | + if [ "$tries" -le "0" ]; then |
| 154 | + echo >&2 'ClickHouse init process failed.' |
| 155 | + exit 1 |
| 156 | + fi |
| 157 | + tries=$(( tries-1 )) |
| 158 | + sleep 1 |
| 159 | + done |
| 160 | +
|
| 161 | + clickhouseclient=( clickhouse-client --multiquery --host "127.0.0.1" -u "$CLICKHOUSE_USER" --password "$CLICKHOUSE_PASSWORD" ) |
| 162 | +
|
| 163 | + echo |
| 164 | +
|
| 165 | + # create default database, if defined |
| 166 | + if [ -n "$CLICKHOUSE_DB" ]; then |
| 167 | + echo "$0: create database '$CLICKHOUSE_DB'" |
| 168 | + "${clickhouseclient[@]}" -q "CREATE DATABASE IF NOT EXISTS $CLICKHOUSE_DB"; |
| 169 | + fi |
| 170 | +
|
| 171 | + for f in /docker-entrypoint-initdb.d/*; do |
| 172 | + case "$f" in |
| 173 | + *.sh) |
| 174 | + if [ -x "$f" ]; then |
| 175 | + echo "$0: running $f" |
| 176 | + "$f" |
| 177 | + else |
| 178 | + echo "$0: sourcing $f" |
| 179 | + # shellcheck source=/dev/null |
| 180 | + . "$f" |
| 181 | + fi |
| 182 | + ;; |
| 183 | + *.sql) echo "$0: running $f"; "${clickhouseclient[@]}" < "$f" ; echo ;; |
| 184 | + *.sql.gz) echo "$0: running $f"; gunzip -c "$f" | "${clickhouseclient[@]}"; echo ;; |
| 185 | + *) echo "$0: ignoring $f" ;; |
| 186 | + esac |
| 187 | + echo |
| 188 | + done |
| 189 | +
|
| 190 | + if ! kill -s TERM "$pid" || ! wait "$pid"; then |
| 191 | + echo >&2 'Finishing of ClickHouse init process failed.' |
| 192 | + exit 1 |
| 193 | + fi |
| 194 | + fi |
| 195 | +else |
| 196 | + echo "ClickHouse Database directory appears to contain a database; Skipping initialization" |
| 197 | +fi |
| 198 | +
|
| 199 | +# if no args passed to `docker run` or first argument start with `--`, then the user is passing clickhouse-server arguments |
| 200 | +if [[ $# -lt 1 ]] || [[ "$1" == "--"* ]]; then |
| 201 | + # Watchdog is launched by default, but does not send SIGINT to the main process, |
| 202 | + # so the container can't be finished by ctrl+c |
| 203 | + CLICKHOUSE_WATCHDOG_ENABLE=${CLICKHOUSE_WATCHDOG_ENABLE:-0} |
| 204 | + export CLICKHOUSE_WATCHDOG_ENABLE |
| 205 | +
|
| 206 | + # An option for easy restarting and replacing clickhouse-server in a container, especially in Kubernetes. |
| 207 | + # For example, you can replace the clickhouse-server binary to another and restart it while keeping the container running. |
| 208 | + if [[ "${CLICKHOUSE_DOCKER_RESTART_ON_EXIT:-0}" -eq "1" ]]; then |
| 209 | + while true; do |
| 210 | + # This runs the server as a child process of the shell script: |
| 211 | + /usr/bin/clickhouse su "${USER}:${GROUP}" /usr/bin/clickhouse-server --config-file="$CLICKHOUSE_CONFIG" "$@" ||: |
| 212 | + echo >&2 'ClickHouse Server exited, and the environment variable CLICKHOUSE_DOCKER_RESTART_ON_EXIT is set to 1. Restarting the server.' |
| 213 | + done |
| 214 | + else |
| 215 | + # This replaces the shell script with the server: |
| 216 | + exec /usr/bin/clickhouse su "${USER}:${GROUP}" /usr/bin/clickhouse-server --config-file="$CLICKHOUSE_CONFIG" "$@" |
| 217 | + fi |
| 218 | +fi |
| 219 | +
|
| 220 | +# Otherwise, we assume the user want to run his own process, for example a `bash` shell to explore this image |
| 221 | +exec "$@" |
0 commit comments