diff --git a/Dockerfile b/Dockerfile index 2a65d35..3e7189e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,23 +1,74 @@ -# Ver: 1.0 by Endial Fang (endial@126.com) +# Ver: 1.2 by Endial Fang (endial@126.com) # -# 指定原始系统镜像,常用镜像为 colovu/ubuntu:18.04、colovu/debian:10、colovu/alpine:3.12、colovu/openjdk:8u252-jre -FROM colovu/debian:10 -# ARG参数使用"--build-arg"指定,如 "--build-arg apt_source=tencent" +# 预处理 ========================================================================= +FROM colovu/dbuilder as builder + # sources.list 可使用版本:default / tencent / ustc / aliyun / huawei ARG apt_source=default -# 外部指定应用版本信息,如 "--build-arg app_ver=6.0.0" -ARG app_ver=6.0.5 - -# 编译镜像时指定本地服务器地址,如 "--build-arg local_url=http://172.29.14.108/dist-files/" +# 编译镜像时指定用于加速的本地服务器地址 ARG local_url="" -# 定义应用基础常量信息,该常量在容器内可使用 -ENV APP_NAME=redis \ - APP_EXEC=redis-server +WORKDIR /usr/local + +RUN select_source ${apt_source}; +#RUN install_pkg xz-utils + +# 下载并解压软件包 +RUN set -eux; \ + appVersion=1.0.0; \ + appName="wait-for-port-${appVersion}-1-linux-amd64-debian-10.tar.gz"; \ + [ ! -z ${local_url} ] && localURL=${local_url}/bitnami; \ + appUrls="${localURL:-} \ + https://downloads.bitnami.com/files/stacksmith \ + "; \ + download_pkg unpack ${appName} "${appUrls}"; \ + chmod +x /usr/local/wait-for-port-1.0.0-1-linux-amd64-debian-10/files/common/bin/wait-for-port; + +RUN set -eux; \ + appVersion=6.0.5; \ + appName="redis-${appVersion}.tar.gz"; \ + sha256="42cf86a114d2a451b898fcda96acd4d01062a7dbaaad2801d9164a36f898f596"; \ + [ ! -z ${local_url} ] && localURL=${local_url}/redis; \ + appUrls="${localURL:-} \ + http://download.redis.io/releases \ + "; \ + download_pkg unpack ${appName} "${appUrls}" -s "${sha256}"; \ + mkdir -p /usr/local/redis; \ + cd /usr/local/redis-${appVersion}; \ +# 禁用安全保护模式,在 Docker 中运行时不需要 + grep -E '^ *createBoolConfig[(]"protected-mode",.*, *1 *,.*[)],$' /usr/local/redis-${appVersion}/src/config.c; \ + sed -ri 's!^( *createBoolConfig[(]"protected-mode",.*, *)1( *,.*[)],)$!\10\2!' /usr/local/redis-${appVersion}/src/config.c; \ + grep -E '^ *createBoolConfig[(]"protected-mode",.*, *0 *,.*[)],$' /usr/local/redis-${appVersion}/src/config.c; \ + make BUILD_TLS=yes MALLOC=libc \ + -j "$(nproc)" all; \ + make PREFIX=/usr/local/redis install; \ + \ +# 删除重复的应用程序,并生成对应的连接 + serverMd5="$(md5sum /usr/local/redis/bin/redis-server | cut -d' ' -f1)"; export serverMd5; \ + find /usr/local/redis/bin/redis* -maxdepth 0 \ + -type f -not -name redis-server \ + -exec sh -eux -c ' \ + md5="$(md5sum "$1" | cut -d" " -f1)"; \ + test "$md5" = "$serverMd5"; \ + ' -- '{}' ';' \ + -exec ln -svfT 'redis-server' '{}' ';' ; + + +#find /usr/local/redis/bin -type f -executable -exec ldd '{}' ';' | awk '/=>/ { print $(NF-1) }' | sort -u | xargs -r dpkg-query --search | cut -d: -f1 | sort -u + +# 镜像生成 ======================================================================== +FROM colovu/debian:10 + +ARG apt_source=default +ARG local_url="" + +ENV APP_NAME=redis \ + APP_USER=redis \ + APP_EXEC=redis-server \ + APP_VERSION=6.0.5 -# 定义应用基础目录信息,该常量在容器内可使用 ENV APP_HOME_DIR=/usr/local/${APP_NAME} \ APP_DEF_DIR=/etc/${APP_NAME} \ APP_CONF_DIR=/srv/conf/${APP_NAME} \ @@ -28,154 +79,44 @@ ENV APP_HOME_DIR=/usr/local/${APP_NAME} \ APP_LOG_DIR=/var/log/${APP_NAME} \ APP_CERT_DIR=/srv/cert/${APP_NAME} -# 设置应用需要的特定环境变量 ENV \ PATH="${APP_HOME_DIR}/bin:${PATH}" LABEL \ - "Version"="v${app_ver}" \ - "Description"="Docker image for ${APP_NAME}(v${app_ver})." \ + "Version"="v${APP_VERSION}" \ + "Description"="Docker image for ${APP_NAME}(v${APP_VERSION})." \ "Dockerfile"="https://github.com/colovu/docker-${APP_NAME}" \ "Vendor"="Endial Fang (endial@126.com)" -# 拷贝默认 Shell 脚本至容器相关目录中 -COPY prebuilds / - -# 镜像内相应应用及依赖软件包的安装脚本;以下脚本可按照不同需求拆分为多个段,但需要注意各个段在结束前需要清空缓存 -RUN \ -# 设置程序使用静默安装,而非交互模式;默认情况下,类似 tzdata/gnupg/ca-certificates 等程序配置需要交互 - export DEBIAN_FRONTEND=noninteractive; \ - \ -# 设置 shell 执行参数,分别为 -e(命令执行错误则退出脚本) -u(变量未定义则报错) -x(打印实际待执行的命令行) - set -eux; \ - \ -# 更改源为当次编译指定的源 - cp /etc/apt/sources.list.${apt_source} /etc/apt/sources.list; \ - \ -# 为应用创建对应的组、用户、相关目录 - export APP_VERSION=${app_ver}; \ - export APP_DIRS="${APP_DEF_DIR:-} ${APP_CONF_DIR:-} ${APP_DATA_DIR:-} ${APP_CACHE_DIR:-} ${APP_RUN_DIR:-} ${APP_LOG_DIR:-} ${APP_CERT_DIR:-} ${APP_DATA_LOG_DIR:-} ${APP_HOME_DIR:-${APP_DATA_DIR}}"; \ - mkdir -p ${APP_DIRS}; \ - groupadd -r -g 998 ${APP_NAME}; \ - useradd -r -g ${APP_NAME} -u 999 -s /usr/sbin/nologin -d ${APP_DATA_DIR} ${APP_NAME}; \ - \ -# 应用软件包及依赖项。相关软件包在镜像创建完成时,不会被清理 - appDeps=" \ - libnss-wrapper \ - xz-utils \ - "; \ - savedAptMark="$(apt-mark showmanual) ${appDeps}"; \ - \ - \ - \ -# 安装临时使用的软件包及依赖项。相关软件包在镜像创建完后时,会被清理 - fetchDeps=" \ - wget \ - ca-certificates \ - \ - autoconf \ - automake \ - gcc \ - g++ \ - gcc-multilib \ - make \ - \ - "; \ - apt-get update; \ - apt-get install -y --no-install-recommends ${fetchDeps}; \ - \ - \ - \ -# 下载需要的软件包资源。可使用 不校验、签名校验、SHA256 校验 三种方式 - DIST_NAME="wait-for-port-1.0.0-1-linux-amd64-debian-10"; \ - DIST_URLS=" \ - ${local_url} \ - https://downloads.bitnami.com/files/stacksmith/ \ - "; \ - . /usr/local/scripts/libdownload.sh && download_dist "${DIST_NAME}.tar.gz" "${DIST_URLS}"; \ - \ - \ - \ -# 二进制解压方式安装: 解压后将原始配置文件拷贝至 ${APP_DEF_DIR} 中 - APP_BIN="/usr/local/bin"; \ - tar --extract --file "${DIST_NAME}.tar.gz" --directory "${APP_BIN}" --strip-components 4 "${DIST_NAME}/files/common/bin/"; \ - rm -rf "${DIST_NAME}.tar.gz" "/usr/local/bin/.buildcomplete"; \ - \ - \ - \ -# 下载需要的软件包资源。可使用 不校验、签名校验、SHA256 校验 三种方式 - DIST_NAME="${APP_NAME}-${APP_VERSION}.tar.gz"; \ - DIST_SHA256="42cf86a114d2a451b898fcda96acd4d01062a7dbaaad2801d9164a36f898f596"; \ - DIST_URLS=" \ - ${local_url} \ - http://download.redis.io/releases/ \ - "; \ - . /usr/local/scripts/libdownload.sh && download_dist "${DIST_NAME}" "${DIST_URLS}" --checksum "${DIST_SHA256}"; \ - \ -# 源码编译 - APP_SRC="/usr/local/src/${APP_NAME}-${APP_VERSION}"; \ - mkdir -p ${APP_SRC}; \ - tar --extract --file "${DIST_NAME}" --directory "${APP_SRC}" --strip-components 1; \ - cd ${APP_SRC}; \ - \ - make -j "$(nproc)" all; \ - make install; \ - cp -rf ./*.conf ${APP_DEF_DIR}/; \ - cd /; \ - rm -rf ${APP_SRC} ${DIST_NAME}; \ - \ - \ - \ -# 包管理方式安装: 增加软件包特有源,并使用系统包管理方式安装软件; - apt-get install -y --no-install-recommends ${appDeps}; \ - \ - \ - \ -# 设置应用关联目录的权限信息 - chown -Rf ${APP_NAME}:${APP_NAME} ${APP_DIRS}; \ - \ -# 查找新安装的应用及应用依赖软件包,并标识为'manual',防止后续自动清理时被删除 - apt-mark auto '.*' > /dev/null; \ - { [ -z "$savedAptMark" ] || apt-mark manual $savedAptMark; }; \ - find /usr/local -type f -executable -exec ldd '{}' ';' \ - | awk '/=>/ { print $(NF-1) }' \ - | sort -u \ - | xargs -r dpkg-query --search \ - | cut -d: -f1 \ - | sort -u \ - | xargs -r apt-mark manual; \ - \ -# 删除安装的临时依赖软件包,清理缓存 - apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false ${fetchDeps}; \ - apt-get autoclean -y; \ - rm -rf /var/lib/apt/lists/*; \ - :; - -# 拷贝应用专用 Shell 脚本至容器相关目录中 COPY customer / +# 以包管理方式安装软件包(Optional) +RUN select_source ${apt_source} +RUN install_pkg libssl1.1 + +RUN create_user && prepare_env + +# 从预处理过程中拷贝软件包(Optional) +COPY --from=builder /usr/local/wait-for-port-1.0.0-1-linux-amd64-debian-10/files/common/bin/ /usr/local/bin/ +COPY --from=builder /usr/local/redis /usr/local/redis +COPY --from=builder /usr/local/redis-${APP_VERSION}/*.conf ${APP_DEF_DIR}/ + +# 执行预处理脚本,并验证安装的软件包 RUN set -eux; \ -# 设置容器入口脚本的可执行权限 - chmod +x /usr/local/bin/entrypoint.sh; \ - \ -# 检测是否存在对应版本的 overrides 脚本文件;如果存在,执行 - { [ ! -e "/usr/local/overrides/overrides-${app_ver}.sh" ] || /bin/bash "/usr/local/overrides/overrides-${app_ver}.sh"; }; \ - \ -# 验证安装的软件是否可以正常运行,常规情况下放置在命令行的最后 - gosu ${APP_NAME} redis-cli --version; \ - gosu ${APP_NAME} redis-server --version; \ + override_file="/usr/local/overrides/overrides-${APP_VERSION}.sh"; \ + [ -e "${override_file}" ] && /bin/bash "${override_file}"; \ + gosu ${APP_USER} redis-cli --version; \ + gosu ${APP_USER} redis-server --version; \ :; # 默认提供的数据卷 -VOLUME ["/srv/conf", "/srv/data", "/srv/cert", "/srv/datalog", "/var/log"] +VOLUME ["/srv/conf", "/srv/data", "/srv/datalog", "/srv/cert", "/var/log"] # 默认使用gosu切换为新建用户启动,必须保证端口在1024之上 EXPOSE 6379 -# 容器初始化命令,默认存放在:/usr/local/bin/entrypoint.sh -ENTRYPOINT ["entrypoint.sh"] - -WORKDIR ${APP_DATA_DIR} +# 容器初始化命令,默认存放在:/usr/local/bin/entry.sh +ENTRYPOINT ["entry.sh"] # 应用程序的服务命令,必须使用非守护进程方式运行。如果使用变量,则该变量必须在运行环境中存在(ENV可以获取) CMD ["${APP_EXEC}", "${REDIS_CONF_FILE}"] diff --git a/customer/usr/local/bin/appcommon.sh b/customer/usr/local/bin/appcommon.sh index 1be2842..14cc856 100644 --- a/customer/usr/local/bin/appcommon.sh +++ b/customer/usr/local/bin/appcommon.sh @@ -5,12 +5,12 @@ # 加载依赖脚本 . /usr/local/scripts/libcommon.sh # 通用函数库 + . /usr/local/scripts/libfile.sh . /usr/local/scripts/libfs.sh . /usr/local/scripts/libos.sh . /usr/local/scripts/libservice.sh . /usr/local/scripts/libvalidations.sh -. /usr/local/scripts/libnet.sh # 函数列表 @@ -21,16 +21,16 @@ # *_* : 应用配置文件使用的全局变量,变量名根据配置项定义 # 返回值: # 可以被 'eval' 使用的序列化输出 -docker_app_env() { - cat <<"EOF" +app_env() { + cat <<-'EOF' # Common Settings export ENV_DEBUG=${ENV_DEBUG:-false} -export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}" +export ALLOW_ANONYMOUS_LOGIN="${ALLOW_ANONYMOUS_LOGIN:-no}" # Paths export REDIS_CONF_FILE="${APP_CONF_DIR}/redis.conf" -export REDIS_PID_FILE="${APP_RUN_DIR}/redis.pid" export REDIS_SENTINEL_FILE="${APP_CONF_DIR}/sentinel.conf" +export REDIS_PID_FILE="${APP_RUN_DIR}/redis.pid" # Users @@ -121,8 +121,6 @@ redis_common_conf_set() { } # 获取配置文件中指定关键字对应的值 -# 全局变量: -# APP_CONF_DIR # 变量: # $1 - 变量 redis_conf_get() { @@ -132,8 +130,6 @@ redis_conf_get() { } # 更新 redis.conf 配置文件中指定变量值,设置关键字及对应值 -# 全局变量: -# APP_CONF_DIR # 变量: # $1 - 变量 # $2 - 值(列表) @@ -142,18 +138,14 @@ redis_conf_set() { } # 更新 sentinel.conf 配置文件中指定变量值,设置关键字及对应值 -# 全局变量: -# APP_CONF_DIR # 变量: # $1 - 变量 # $2 - 值(列表) redis_sentinel_conf_set() { - redis_common_conf_set "${APP_CONF_DIR}/sentinel.conf" "$@" + redis_common_conf_set "${REDIS_SENTINEL_FILE}" "$@" } # 更新 redis.conf 配置文件中指定变量值,取消关键字设置信息 -# 全局变量: -# APP_CONF_DIR # 变量: # $1 - 变量 redis_conf_unset() { @@ -162,22 +154,16 @@ redis_conf_unset() { } # 获取 Redis 版本信息 -# 返回值: -# Redis 版本号 redis_version() { redis-cli --version | grep -E -o "[0-9]+.[0-9]+.[0-9]+" } # 获取 Redis 主版本号 -# 返回值: -# Redis 主版本号 redis_major_version() { redis_version | grep -E -o "^[0-9]+" } # 禁用 Redis 不安全的命令 -# Globals: -# REDIS_BASEDIR # 参数: # $1 - 待禁用的命令列表 redis_disable_unsafe_commands() { @@ -196,8 +182,6 @@ redis_disable_unsafe_commands() { } # 生成默认配置文件 -# 全局变量: -# REDIS_* redis_generate_conf() { redis_conf_set port "$REDIS_PORT" redis_conf_set dir "${APP_DATA_DIR}" @@ -240,8 +224,6 @@ redis_generate_conf() { } # 配置 Redis 复制模式参数 -# 全局变量: -# REDIS_* # 参数: # $1 - 复制模式 redis_configure_replication() { @@ -280,8 +262,6 @@ redis_configure_replication() { } # 检测用户参数信息是否满足条件; 针对部分权限过于开放情况,打印提示信息 -# 全局变量: -# REDIS_* app_verify_minimum_env() { local error_code=0 LOG_D "Validating settings in REDIS_* env vars..." @@ -293,10 +273,10 @@ app_verify_minimum_env() { } # Redis authentication validations - if is_boolean_yes "$ALLOW_EMPTY_PASSWORD"; then - LOG_W "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD}. For safety reasons, do not use this flag in a production environment." + if is_boolean_yes "$ALLOW_ANONYMOUS_LOGIN"; then + LOG_W "You set the environment variable ALLOW_ANONYMOUS_LOGIN=${ALLOW_ANONYMOUS_LOGIN}. For safety reasons, do not use this flag in a production environment." elif [[ -z "$REDIS_PASSWORD" ]]; then - print_validation_error "The REDIS_PASSWORD environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow the container to be started with blank passwords. This is recommended only for development." + print_validation_error "The REDIS_PASSWORD environment variable is empty or not set. Set the environment variable ALLOW_ANONYMOUS_LOGIN=yes to allow the container to be started with blank passwords. This is recommended only for development." fi if [[ -n "$REDIS_REPLICATION_MODE" ]]; then @@ -306,8 +286,8 @@ app_verify_minimum_env() { print_validation_error "An invalid port was specified in the environment variable REDIS_MASTER_PORT_NUMBER: $err" fi fi - if ! is_boolean_yes "$ALLOW_EMPTY_PASSWORD" && [[ -z "$REDIS_MASTER_PASSWORD" ]]; then - print_validation_error "The REDIS_MASTER_PASSWORD environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow the container to be started with blank passwords. This is recommended only for development." + if ! is_boolean_yes "$ALLOW_ANONYMOUS_LOGIN" && [[ -z "$REDIS_MASTER_PASSWORD" ]]; then + print_validation_error "The REDIS_MASTER_PASSWORD environment variable is empty or not set. Set the environment variable ALLOW_ANONYMOUS_LOGIN=yes to allow the container to be started with blank passwords. This is recommended only for development." fi elif [[ "$REDIS_REPLICATION_MODE" != "master" ]]; then print_validation_error "Invalid replication mode. Available options are 'master/replica'" @@ -351,9 +331,6 @@ app_enable_remote_connections() { } # 以后台方式启动应用服务,并等待启动就绪 -# 全局变量: -# REDIS_* -# ENV_DEBUG app_start_server_bg() { is_app_server_running && return @@ -382,8 +359,6 @@ app_start_server_bg() { } # 停止应用服务 -# 全局变量: -# REDIS_PID_FILE app_stop_server() { is_app_server_running || return @@ -415,10 +390,6 @@ app_stop_server() { } # 检测应用服务是否在后台运行中 -# 全局变量: -# REDIS_PID_FILE -# 返回值: -# 布尔值 is_app_server_running() { LOG_D "Check if ${APP_NAME} is running..." local pid @@ -438,13 +409,10 @@ app_clean_tmp_file() { } # 在重新启动容器时,删除标志文件及必须删除的临时文件 (容器重新启动) -# 全局变量: -# APP_* -# REDIS_* app_clean_from_restart() { LOG_D "Clean ${APP_NAME} tmp files for restart..." local -r -a files=( - "/var/run/${APP_NAME}/${APP_NAME}.pid" + "${REDIS_PID_FILE}" ) for file in ${files[@]}; do @@ -457,7 +425,7 @@ app_clean_from_restart() { # 应用默认初始化操作 # 执行完毕后,生成文件 ${APP_CONF_DIR}/.app_init_flag 及 ${APP_DATA_DIR}/.data_init_flag 文件 -docker_app_init() { +app_default_init() { app_clean_from_restart LOG_D "Check init status of ${APP_NAME}..." @@ -491,7 +459,7 @@ docker_app_init() { # 用户自定义的前置初始化操作,依次执行目录 preinitdb.d 中的初始化脚本 # 执行完毕后,生成文件 ${APP_DATA_DIR}/.custom_preinit_flag -docker_custom_preinit() { +app_custom_preinit() { LOG_D "Check custom pre-init status of ${APP_NAME}..." # 检测用户配置文件目录是否存在 preinitdb.d 文件夹,如果存在,尝试执行目录中的初始化脚本 @@ -502,7 +470,7 @@ docker_custom_preinit() { LOG_I "Process custom pre-init scripts from /srv/conf/${APP_NAME}/preinitdb.d..." # 检索所有可执行脚本,排序后执行 - find "/srv/conf/${APP_NAME}/preinitdb.d/" -type f -regex ".*\.\(sh\)" | sort | docker_process_init_files + find "/srv/conf/${APP_NAME}/preinitdb.d/" -type f -regex ".*\.\(sh\)" | sort | process_init_files touch ${APP_DATA_DIR}/.custom_preinit_flag echo "$(date '+%Y-%m-%d %H:%M:%S') : Init success." >> ${APP_DATA_DIR}/.custom_preinit_flag @@ -511,24 +479,29 @@ docker_custom_preinit() { LOG_I "Custom preinit for ${APP_NAME} already done before, skipping initialization." fi fi + + # 检测依赖的服务是否就绪 + #for i in ${SERVICE_PRECONDITION[@]}; do + # app_wait_service "${i}" + #done } # 用户自定义的应用初始化操作,依次执行目录initdb.d中的初始化脚本 # 执行完毕后,生成文件 ${APP_DATA_DIR}/.custom_init_flag -docker_custom_init() { +app_custom_init() { LOG_D "Check custom init status of ${APP_NAME}..." # 检测用户配置文件目录是否存在 initdb.d 文件夹,如果存在,尝试执行目录中的初始化脚本 if [ -d "/srv/conf/${APP_NAME}/initdb.d" ]; then # 检测数据存储目录是否存在已初始化标志文件;如果不存在,检索可执行脚本文件并进行初始化操作 - if [[ -n $(find "/srv/conf/${APP_NAME}/initdb.d/" -type f -regex ".*\.\(sh\)") ]] && \ + if [[ -n $(find "/srv/conf/${APP_NAME}/initdb.d/" -type f -regex ".*\.\(sh\|sql\|sql.gz\)") ]] && \ [[ ! -f "${APP_DATA_DIR}/.custom_init_flag" ]]; then LOG_I "Process custom init scripts from /srv/conf/${APP_NAME}/initdb.d..." #app_start_server_bg # 检索所有可执行脚本,排序后执行 - find "/srv/conf/${APP_NAME}/initdb.d/" -type f -regex ".*\.\(sh\)" | sort | while read -r f; do + find "/srv/conf/${APP_NAME}/initdb.d/" -type f -regex ".*\.\(sh\|sql\|sql.gz\)" | sort | while read -r f; do case "$f" in *.sh) if [[ -x "$f" ]]; then diff --git a/customer/usr/local/bin/entry.sh b/customer/usr/local/bin/entry.sh new file mode 100755 index 0000000..f3728ea --- /dev/null +++ b/customer/usr/local/bin/entry.sh @@ -0,0 +1,36 @@ +#!/bin/bash +# Ver: 1.0 by Endial Fang (endial@126.com) +# +# 容器入口脚本 + +# 设置 shell 执行参数,可使用'-'(打开)'+'(关闭)控制。常用: +# -e: 命令执行错误则报错; -u: 变量未定义则报错; -x: 打印实际待执行的命令行; -o pipefail: 设置管道中命令遇到失败则报错 +set -eu +set -o pipefail + +. /usr/local/bin/appcommon.sh # 应用专用函数库 + +eval "$(app_env)" +LOG_I "** Processing entry.sh **" + +if ! is_sourced; then + # 替换命令行中的变量 + set -- $(eval echo "$@") + + [ "${1:0:1}" = '-' ] && set -- "${APP_EXEC:-}" "$@" + + print_image_welcome + print_command_help "$@" + + if [ "$1" = "${APP_EXEC}" ] && is_root; then + /usr/local/bin/setup.sh + + LOG_I "Restart with non-root user: ${APP_USER:-APP_NAME}\n" + exec gosu "${APP_USER:-APP_NAME}" "$0" "$@" + fi + + [ "$1" = "${APP_EXEC}" ] && /usr/local/bin/init.sh + + LOG_I "Start container with command: $@" + exec tini -- "$@" +fi diff --git a/customer/usr/local/bin/entrypoint.sh b/customer/usr/local/bin/entrypoint.sh deleted file mode 100644 index e76f73e..0000000 --- a/customer/usr/local/bin/entrypoint.sh +++ /dev/null @@ -1,109 +0,0 @@ -#!/bin/bash -# Ver: 1.0 by Endial Fang (endial@126.com) -# -# 容器入口脚本 - -# 设置遇到执行错误则退出执行 -set -o errexit -# 设置脚本遇到未初始化或声明的变量退出执行 -set -o nounset -# 设置遇到管道命令失败则退出执行 -set -o pipefail -# 设置调试信息输出,及命令在执行前先打印命令执行前的命令内容 -# set -o xtrace - -# 加载依赖脚本 -#. /usr/local/scripts/liblog.sh # 日志输出函数库 -#. /usr/local/scripts/libcommon.sh # 通用函数库 -. /usr/local/bin/appcommon.sh # 应用专用函数库 - -LOG_D "Process entrypoint.sh..." - -# 初始化环境变量。 docker_app_env()函数在文件 appcommon.sh 中定义 -eval "$(docker_app_env)" - -# 定义容器中使用的默认目录(未定义时设置默认值为空"") -APP_DIRS="${APP_CONF_DIR:-} ${APP_DATA_DIR:-} ${APP_LOG_DIR:-} ${APP_CERT_DIR:-} ${APP_DATA_LOG_DIR:-}" - -# 打印镜像欢迎信息 -docker_print_welcome - -# 检测数据卷中相关目录,创建默认的关联目录,并拷贝所必须的默认配置文件及初始化文件 -# 全局变量: -# APP_* -docker_ensure_dir_and_configs() { - _is_restart && return - - local user_id; user_id="$(id -u)" - - LOG_D "Check directories..." - for dir in ${APP_DIRS}; do - LOG_D " Check $dir" - ensure_dir_exists "$dir" - done - - # 检测指定文件是否在配置文件存储目录存在,如果不存在则拷贝(新挂载数据卷、手动删除都会导致不存在) - LOG_D "Check config files..." - if [[ ! -z "$(ls -A "${APP_DEF_DIR}")" ]]; then - ensure_config_file_exist "${APP_DEF_DIR}" $(ls -A "${APP_DEF_DIR}") - fi -} - -_main() { - # 替换命令行中的变量 - set -- $(eval echo "$@") - - # 如果命令行参数是以配置参数("-")开始,修改执行命令,确保使用可执行应用命令启动服务器 - if [ "${1:0:1}" = '-' ]; then - set -- "${APP_EXEC}" "$@" - fi - - # 命令行参数以可执行应用命令起始,且不包含直接返回的命令(如:-V、--version、--help)时,执行初始化操作 - if [ "$1" = "${APP_EXEC}" ] && ! docker_command_help "$@"; then - # 检测启动容器时设置的环境变量是否有效 - app_verify_minimum_env - - # 检测应用需要使用的目录及配置文件是否存在 - docker_ensure_dir_and_configs - - # 以root用户运行时,会使用gosu重新以"APP_NAME"用户运行当前脚本 - if _is_run_as_root; then - LOG_D "Change permissions when run as root" - - # 以root用户启动时,修改相应目录的所属用户信息为 APP_NAME ,确保切换用户时,权限正常 - for dir in ${APP_DIRS}; do - chmod 755 ${dir} - configure_permissions_ownership "$dir" -u "${APP_NAME}" -g "${APP_NAME}" - : - done - - # 解决使用gosu后,nginx: [emerg] open() "/dev/stdout" failed (13: Permission denied) - LOG_D "Change permissions of stdout/stderr to 0622" - chmod 0622 /dev/stdout /dev/stderr - - LOG_I "" - LOG_I "Restart container with default user: ${APP_NAME}" - LOG_I " command: $@" - export RESTART_FLAG=1 - exec gosu "${APP_NAME}" "$0" "$@" - fi - - # 执行应用预初始化操作 - docker_custom_preinit - - # 执行应用初始化操作 - docker_app_init - - # 执行用户自定义初始化脚本 - docker_custom_init - fi - - LOG_I "Start container with command: $@" - # 执行命令行。 - exec "$@" -} - -# 脚本入口命令 -if ! _is_sourced; then - _main "$@" -fi diff --git a/customer/usr/local/bin/init.sh b/customer/usr/local/bin/init.sh new file mode 100755 index 0000000..727d9fa --- /dev/null +++ b/customer/usr/local/bin/init.sh @@ -0,0 +1,25 @@ +#!/bin/bash +# Ver: 1.0 by Endial Fang (endial@126.com) +# +# 应用初始化脚本 + +# 设置 shell 执行参数,可使用'-'(打开)'+'(关闭)控制。常用: +# -e: 命令执行错误则报错; -u: 变量未定义则报错; -x: 打印实际待执行的命令行; -o pipefail: 设置管道中命令遇到失败则报错 +set -eu +set -o pipefail + +. /usr/local/bin/appcommon.sh # 应用专用函数库 + +eval "$(app_env)" +LOG_I "** Processing init.sh **" + +# 执行应用预初始化操作 +app_custom_preinit + +# 执行应用初始化操作 +app_default_init + +# 执行用户自定义初始化脚本 +app_custom_init + +LOG_I "** Processing init.sh finished! **" diff --git a/customer/usr/local/bin/run.sh b/customer/usr/local/bin/run.sh new file mode 100755 index 0000000..73dc478 --- /dev/null +++ b/customer/usr/local/bin/run.sh @@ -0,0 +1,25 @@ +#!/bin/bash +# Ver: 1.0 by Endial Fang (endial@126.com) +# +# 应用启动脚本 + +# 设置 shell 执行参数,可使用'-'(打开)'+'(关闭)控制。常用: +# -e: 命令执行错误则报错; -u: 变量未定义则报错; -x: 打印实际待执行的命令行; -o pipefail: 设置管道中命令遇到失败则报错 +set -eu +set -o pipefail + +. /usr/local/bin/appcommon.sh # 应用专用函数库 + +eval "$(app_env)" +LOG_I "** Processing run.sh **" + +flags=("${APP_CONF_FILE:-}") +[[ -z "${APP_EXTRA_FLAGS:-}" ]] || flags=("${flags[@]}" "${APP_EXTRA_FLAGS[@]}") +START_COMMAND=("${APP_EXEC:-/bin/bash}" "${flags[@]}") + +LOG_I "** Starting ${APP_NAME} **" +if is_root; then + exec gosu "${APP_USER:-APP_NAME}" tini -s -- "${START_COMMAND[@]}" +else + exec tini -s -- "${START_COMMAND[@]}" +fi diff --git a/customer/usr/local/bin/setup.sh b/customer/usr/local/bin/setup.sh new file mode 100755 index 0000000..ae59c47 --- /dev/null +++ b/customer/usr/local/bin/setup.sh @@ -0,0 +1,37 @@ +#!/bin/bash +# Ver: 1.0 by Endial Fang (endial@126.com) +# +# 应用环境及依赖文件设置脚本 + +# 设置 shell 执行参数,可使用'-'(打开)'+'(关闭)控制。常用: +# -e: 命令执行错误则报错; -u: 变量未定义则报错; -x: 打印实际待执行的命令行; -o pipefail: 设置管道中命令遇到失败则报错 +set -eu +set -o pipefail + +. /usr/local/bin/appcommon.sh # 应用专用函数库 + +eval "$(app_env)" +LOG_I "** Processing setup.sh **" + +APP_DIRS="${APP_CONF_DIR:-} ${APP_DATA_DIR:-} ${APP_LOG_DIR:-} ${APP_CERT_DIR:-} ${APP_DATA_LOG_DIR:-}" +for dir in ${APP_DIRS}; do + ensure_dir_exists ${dir} +done + +app_verify_minimum_env + +# 检测指定文件是否在配置文件存储目录存在,如果不存在则拷贝(新挂载数据卷、手动删除都会导致不存在) +LOG_I "Check config files in: ${APP_CONF_DIR}" +if [[ ! -z "$(ls -A "${APP_DEF_DIR}")" ]]; then + ensure_config_file_exist "${APP_DEF_DIR}" $(ls -A "${APP_DEF_DIR}") +fi + +for dir in ${APP_DIRS}; do + configure_permissions_ownership "$dir" -u "${APP_USER}" -g "${APP_USER}" +done + +# 解决使用gosu后,nginx: [emerg] open() "/dev/stdout" failed (13: Permission denied) +LOG_D "Change permissions of stdout/stderr to 0622" +chmod 0622 /dev/stdout /dev/stderr + +LOG_I "** Processing setup.sh finished! **" diff --git a/customer/usr/local/overrides/overrides-6.0.5.sh b/customer/usr/local/overrides/overrides-6.0.5.sh index a30ea95..7861c99 100644 --- a/customer/usr/local/overrides/overrides-6.0.5.sh +++ b/customer/usr/local/overrides/overrides-6.0.5.sh @@ -4,16 +4,14 @@ # 定义要修改的文件 CONF_FILE="${APP_DEF_DIR}/redis.conf" - echo "Process overrides for: ${CONF_FILE}" # 修改默认配置信息 sed -i -E 's/^bind .*/bind 127.0.0.1/g' "${CONF_FILE}" -sed -i -E 's/^pidfile .*/pidfile \/var\/run\/redis\/redis.pid/g' "${CONF_FILE}" sed -i -E 's/^daemonize .*/daemonize yes/g' "${CONF_FILE}" +sed -i -E 's/^pidfile .*/pidfile \/var\/run\/redis\/redis.pid/g' "${CONF_FILE}" sed -i -E 's/^logfile .*/logfile \"\/var\/log\/redis\/redis.log\"/g' "${CONF_FILE}" SENTINEL_FILE="${APP_DEF_DIR}/sentinel.conf" - echo "Process overrides for: ${SENTINEL_FILE}" # 修改 Sentinel 默认配置信息 sed -i -E 's/^daemonize .*/daemonize yes/g' "${SENTINEL_FILE}" diff --git a/customer/usr/sbin/create_user b/customer/usr/sbin/create_user new file mode 100755 index 0000000..78c4251 --- /dev/null +++ b/customer/usr/sbin/create_user @@ -0,0 +1,9 @@ +#!/bin/bash +# shell 执行参数,分别为 -e(命令执行错误则退出脚本) -u(变量未定义则报错) -x(打印实际待执行的命令行) +set -eux +groupadd --gid 998 --system ${APP_USER} +useradd --gid 998 --uid 999 --shell /usr/sbin/nologin --home ${APP_DATA_DIR} --system ${APP_USER} + +# 如果需要 sudo 权限,需要安装 su 软件包:apk add sudo +#sed -i -e 's/^\sDefaults\s*secure_path\s*=/# Defaults secure_path=/' /etc/sudoers +#echo "${APP_USER} ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers diff --git a/customer/usr/sbin/prepare_env b/customer/usr/sbin/prepare_env new file mode 100755 index 0000000..cb7b34b --- /dev/null +++ b/customer/usr/sbin/prepare_env @@ -0,0 +1,8 @@ +#!/bin/bash +# shell 执行参数,分别为 -e(命令执行错误则退出脚本) -u(变量未定义则报错) -x(打印实际待执行的命令行) +set -eux + +APP_DIRS="${APP_DEF_DIR:-} ${APP_CONF_DIR:-} ${APP_DATA_DIR:-} ${APP_DATA_LOG_DIR:-} ${APP_CACHE_DIR:-} ${APP_RUN_DIR:-} ${APP_LOG_DIR:-} ${APP_CERT_DIR:-} ${APP_HOME_DIR:-}" + +mkdir -p ${APP_DIRS} +chown -Rf ${APP_USER}:${APP_USER} ${APP_DIRS}; diff --git a/docker-compose-cluster.yml b/docker-compose-cluster.yml index 86ba8b6..9107849 100644 --- a/docker-compose-cluster.yml +++ b/docker-compose-cluster.yml @@ -1,10 +1,10 @@ -version: '3.6' +version: '3.8' # 可以使用 scale 动态扩容容器:docker-compose scale redis-replica=3 services: redis-primary: - image: 'colovu/redis:latest' + image: 'colovu/redis' ports: - '6379:6379' environment: @@ -15,7 +15,7 @@ services: - 'redis_data:/srv/data' redis-replica: - image: 'colovu/redis:latest' + image: 'colovu/redis' ports: - '6379' environment: @@ -28,6 +28,7 @@ services: depends_on: - redis-primary +# 定义本地数据卷,由系统管理,需要手动删除 volumes: redis_data: driver: local \ No newline at end of file diff --git a/docker-compose-sentinel.yml b/docker-compose-sentinel.yml new file mode 100644 index 0000000..9069d45 --- /dev/null +++ b/docker-compose-sentinel.yml @@ -0,0 +1,2 @@ +version: '3.8' + diff --git a/docker-compose.yml b/docker-compose.yml index 3b48aab..9abf8d1 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,19 +1,20 @@ -version: '3.6' +version: '3.8' # Docker-Compose 单容器使用参考 YAML 配置文件 # 更多配置参数请参考镜像 README.md 文档中说明 services: redis: - image: 'colovu/redis:latest' + image: 'colovu/redis' ports: - '6379:6379' environment: - # ALLOW_EMPTY_PASSWORD is recommended only for development. - - ALLOW_EMPTY_PASSWORD=yes + # ALLOW_ANONYMOUS_LOGIN is recommended only for development. + - ALLOW_ANONYMOUS_LOGIN=yes - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL volumes: - 'redis_data:/srv/data' +# 定义本地数据卷,由系统管理,需要手动删除 volumes: redis_data: driver: local diff --git a/prebuilds/usr/local/license/LICENSE b/prebuilds/usr/local/license/LICENSE deleted file mode 100644 index 80e3bb7..0000000 --- a/prebuilds/usr/local/license/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2020 Endial Fang (endial@126.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/prebuilds/usr/local/scripts/libcommon.sh b/prebuilds/usr/local/scripts/libcommon.sh deleted file mode 100644 index 0175ac3..0000000 --- a/prebuilds/usr/local/scripts/libcommon.sh +++ /dev/null @@ -1,146 +0,0 @@ -#!/bin/bash -# Ver: 1.1 by Endial Fang (endial@126.com) -# - -# shellcheck disable=SC1091 - -BOLD='\033[1m' - -# 加载依赖项 -. /usr/local/scripts/liblog.sh # 日志输出函数库 - -# 函数列表 - -# 打印包含包含Logo的欢迎信息 -# 全局变量: -# APP_NAME -print_image_welcome_page() { - _is_restart && return - - local github_url="https://github.com/colovu/docker-${APP_NAME}" - LOG_I "" - LOG_I " ######## ######## ### ######## ### ## ### ##" - LOG_I " ### ## ### ## ### ### ## ### ## ### ##" - LOG_I " ### ### ## ### ### ## ### ## ### ##" - LOG_I " ### ### ## ### ### ## ### ## ### ##" - LOG_I " ### ### ## ### ### ## ### ## ### ##" - LOG_I " ### ## ### ## ### ### ## #### ### ##" - LOG_I "######## ######## ######## ######## ## ########" - LOG_I "" - LOG_I "Welcome to the ${BOLD}${APP_NAME}${RESET} container" - LOG_I "Project on Github: ${BOLD}${github_url}${RESET}" - LOG_I "Send us your feedback at ${BOLD}endial@126.com${RESET}" - LOG_I "" -} - -# 根据需要打印欢迎信息 -# 全局变量: -# ENV_DISABLE_WELCOME_MESSAGE -# APP_NAME -docker_print_welcome() { - if [[ -z "${ENV_DISABLE_WELCOME_MESSAGE:-}" ]]; then - if [[ -n "$APP_NAME" ]]; then - print_image_welcome_page - fi - fi -} - -# 检测可能导致容器执行后直接退出的命令,如"--help";如果存在,直接返回 0 -# 参数: -# $1 - 待检测的参数表 -docker_command_help() { - local arg - for arg; do - case "$arg" in - -'?'|--help|-V|--version) - return 0 - ;; - esac - done - return 1 -} - -# 根据脚本扩展名及权限,执行相应的初始化脚本 -# 参数: -# $1 - 文件列表,支持路径通配符 -# 使用: -# docker_process_init_files [file [file [...]]] -# 例子: -# docker_process_init_files /src/conf/${APP_NAME}/initdb.d/* -docker_process_init_files() { - echo - local f - for f; do - case "$f" in - *.sh) - if [ -x "$f" ]; then - LOG_I "$0: running $f" - "$f" - else - LOG_I "$0: sourcing $f" - . "$f" - fi - ;; - *) LOG_W "$0: ignoring $f" ;; - esac - echo - done -} - -# 检测应用相应的配置文件是否存在,如果不存在,则从默认配置文件目录拷贝一份 -# 默认配置文件路径:/etc/${APP_NAME} -# 目标配置文件路径:/srv/conf/${APP_NAME} -# 参数: -# $1 - 基础路径 -# $* - 基础路径下的文件及目录列表,以" "分割 -# 例子: -# ensure_config_file_exist /etc/${APP_NAME} conf.d server.conf -ensure_config_file_exist() { - local -r base_path="${1:?paths is missing}" - local f="" - local dist="" - - shift 1 - LOG_D "List to check: $@" - while [ "$#" -gt 0 ]; do - f="${1}" - LOG_D "Process \"${f}\"" - if [ -d "${base_path}/${f}" ]; then - dist="$(echo ${base_path}/${f} | sed -e 's/\/etc/\/srv\/conf/g')" - [[ ! -d "${dist}" ]] && LOG_I "Create directory: ${dist}" && mkdir -p "${dist}" - [[ ! -z $(ls -A "${base_path}/${f}") ]] && ensure_config_file_exist "${base_path}/${f}" $(ls -A "${base_path}/${f}") - else - dist="$(echo ${base_path}/${f} | sed -e 's/\/etc/\/srv\/conf/g')" - [[ ! -e "${dist}" ]] && LOG_I "Copy: ${base_path}/${f} ===> ${dist}" && cp "${base_path}/${f}" "${dist}" && rm -rf "/srv/conf/${APP_NAME}/.app_init_flag" - fi - shift - done -} - -# 检测当前用户是否为 root -# 返回值: -# 布尔值 -_is_run_as_root() { - if [[ "$(id -u)" = "0" ]]; then - LOG_D "Check if run as root: Yes" - true - else - LOG_D "Check if run as root: No (ID $(id -u))" - false - fi -} - -_is_restart() { - if [ x"${RESTART_FLAG:-}" = "x" ]; then - false - else - true - fi -} - -# 检测当前脚本是被直接执行的,还是从其他脚本中使用 "source" 调用的 -_is_sourced() { - [ "${#FUNCNAME[@]}" -ge 2 ] \ - && [ "${FUNCNAME[0]}" = '_is_sourced' ] \ - && [ "${FUNCNAME[1]}" = 'source' ] -} diff --git a/prebuilds/usr/local/scripts/libdownload.sh b/prebuilds/usr/local/scripts/libdownload.sh deleted file mode 100644 index c83513d..0000000 --- a/prebuilds/usr/local/scripts/libdownload.sh +++ /dev/null @@ -1,97 +0,0 @@ -#!/bin/bash -# Ver: 1.0 by Endial Fang (endial@126.com) -# -# 从服务器(列表)下载相应软件包 - -# Constants -#CV_BASE="http://archive.colovu.com/dist-files/" -#CV_BASE="http://10.37.129.2/dist-files/" -CV_BASE="" - -# 检测软件包签名是否正确 -# 参数: -# $1 - 软件包签名文件 -# $2 - 软件包文件 -# $3 - PGPKEY -check_pgp() { - local name_asc=${1:?missing asc file name} - local name=${2:?missing file name} - local keys="${3:?missing key id}" - - GNUPGHOME="$(mktemp -d)" - for key in $keys; do - gpg --batch --keyserver ha.pool.sks-keyservers.net --recv-keys "${key}" || - gpg --batch --keyserver pgp.mit.edu --recv-keys "${key}" || - gpg --batch --keyserver keys.gnupg.net --recv-keys "${key}" || - gpg --batch --keyserver keyserver.pgp.com --recv-keys "${key}"; - done - gpg --batch --verify "$name_asc" "$name" - command -v gpgconf > /dev/null && gpgconf --kill all - rm -rf "$GNUPGHOME" "$name_asc" -} - -# 从私有服务器下载软件包,如果不存在,则从官网服务器下载 -# 参数: -# $1 - 软件包全名(字符串) -# $2 - 官网路径(字符串) -# $3 - "-c"/"--checksum" -# $4 - 软件包SHA256值 -# $3 - "-g"/"--pgpkey" -# $4 - 用于软件包签名的KEY ID -# 例子: -# . /usr/local/scripts/libdownload.sh && download_dist "java" "11.0.7-0" --checksum 02a1fc9b79b11617ad39221667f6a34209f5c45ca908268f8ba6c264a2577ee2 -download_dist() { - local name="${1:?name is required}" - local base_urls="${2:?url is required}" - local package_sha256="" - local pgp_key="" - local success="" - - # 获取SHA256或PGP KEY - shift 2 - while [ "$#" -gt 0 ]; do - case "$1" in - -c|--checksum) - shift - package_sha256="${1:?missing package checksum}" - ;; - -g|--pgpkey) - shift - pgp_key="${1:?missing package PGP key}" - ;; - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - - echo "Downloading $name package" - for url in $CV_BASE $base_urls; do - if wget -O "$name" "$url$name" && [ -s "$name" ]; then - if [ -n "$pgp_key" ]; then - wget -O "$name.asc" "$url$name.asc" - if [ ! -e "$name.asc" ]; then - wget -O "$name.asc" "$url$name.sig" - fi - fi - success=1 - break - fi - done - - if [ -n "$success" ]; then - if [ -n "$package_sha256" ]; then - echo "Verifying package whith sha256" - echo "$package_sha256 *${name}" | sha256sum --check - - fi - - if [ -n "$pgp_key" ]; then - echo "Verifying package with PGP" - check_pgp "$name.asc" "$name" "$pgp_key" - fi - else - [ -n "$success" ] - fi -} diff --git a/prebuilds/usr/local/scripts/libfile.sh b/prebuilds/usr/local/scripts/libfile.sh deleted file mode 100644 index 1e664c1..0000000 --- a/prebuilds/usr/local/scripts/libfile.sh +++ /dev/null @@ -1,78 +0,0 @@ -#!/bin/bash -# Ver: 1.0 by Endial Fang (endial@126.com) -# -# 文件操作函数库 - -# 加载依赖项 -. /usr/local/scripts/liblog.sh # 日志输出函数库 - -# 函数列表 - -# 检测"*_FILE"文件,并从文件中读取信息作为参数值;环境变量不允许 VAR 与 VAR_FILE 方式并存 -# 变量: -# $1 - 需要设置的环境变量名称 -# $2 - 该变量对应的默认值(Option) -# -# 使用: file_env ENV_VAR [DEFAULT] -file_env() { - local var="$1" - local fileVar="${var}_FILE" - local def="${2:-}" - if [ "${!var:-}" ] && [ "${!fileVar:-}" ]; then - LOG_E "Both $var and $fileVar are set (but are exclusive)" - exit 1 - fi - - local val="$def" - if [ "${!var:-}" ]; then - val="${!var}" - elif [ "${!fileVar:-}" ]; then - val="$(< "${!fileVar}")" - fi - - export "$var"="$val" - unset "$fileVar" -} - -# 使用规则表达式在文件中替换数据 -# 参数: -# $1 - 文件名 -# $2 - 正则表达式 -# $3 - 替代数据表达式 -# $4 - 是否使用POSIX表达式. Default: true -replace_in_file() { - local filename="${1:?filename is required}" - local match_regex="${2:?match regex is required}" - local substitute_regex="${3:?substitute regex is required}" - local posix_regex=${4:-true} - - local result - - # 因部分系统兼容性问题,需要防止使用 'sed in-place' 方式操作 - if [[ $posix_regex = true ]]; then - result="$(sed -E "s@$match_regex@$substitute_regex@g" "$filename")" - else - result="$(sed "s@$match_regex@$substitute_regex@g" "$filename")" - fi - echo "$result" > "$filename" -} - -# 使用规则表达式在文件中删除数据 -# 参数: -# $1 - 文件名 -# $2 - 正则表达式 -# $3 - 是否使用POSIX表达式. Default: true -remove_in_file() { - local filename="${1:?filename is required}" - local match_regex="${2:?match regex is required}" - local posix_regex=${3:-true} - local result - - # 因部分系统兼容性问题,需要防止使用 'sed in-place' 方式操作 - if [[ $posix_regex = true ]]; then - result="$(sed -E "/$match_regex/d" "$filename")" - else - result="$(sed "/$match_regex/d" "$filename")" - fi - echo "$result" > "$filename" -} diff --git a/prebuilds/usr/local/scripts/libfs.sh b/prebuilds/usr/local/scripts/libfs.sh deleted file mode 100644 index f9f73d3..0000000 --- a/prebuilds/usr/local/scripts/libfs.sh +++ /dev/null @@ -1,120 +0,0 @@ -#!/bin/bash -# Ver: 1.1 by Endial Fang (endial@126.com) -# -# 文件管理函数库 - -# 加载依赖项 -. /usr/local/scripts/liblog.sh # 日志输出函数库 - -# 函数列表 - -# Ensure a file/directory is owned (user and group) but the given user -# Arguments: -# $1 - filepath -# $2 - owner -ensure_owned_by() { - local path="${1:?path is missing}" - local owner="${2:?owner is missing}" - - chown "$owner":"$owner" "$path" -} - -# 检测目录是否存在,如果不存在则创建,同时修改为指定的用户 -# Arguments: -# $1 - directory -# $2 - owner -ensure_dir_exists() { - local dir="${1:?directory is missing}" - local owner="${2:-}" - - mkdir -p "${dir}" - if [[ -n $owner ]]; then - ensure_owned_by "$dir" "$owner" - fi -} - -# 检测目录是否存在或为空 -# 参数: -# $1 - 目录路径 -# 返回值: -# 布尔值 -is_dir_empty() { - local dir="${1:?missing directory}" - - if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then - true - else - false - fi -} - -# 循环设置目录中子目录及文件权限 -# 参数: -# $1 - paths (as a string). -# Flags: -# -f|--file-mode - 文件权限模式 -# -d|--dir-mode - 目录权限模式 -# -u|--user - 用户 -# -g|--group - 用户组 -configure_permissions_ownership() { - local -r paths="${1:?paths is missing}" - local dir_mode="" - local file_mode="" - local user="" - local group="" - - # Validate arguments - shift 1 - while [ "$#" -gt 0 ]; do - case "$1" in - -f|--file-mode) - shift - file_mode="${1:?missing mode for files}" - ;; - -d|--dir-mode) - shift - dir_mode="${1:?missing mode for directories}" - ;; - -u|--user) - shift - user="${1:?missing user}" - ;; - -g|--group) - shift - group="${1:?missing group}" - ;; - *) - LOG_E "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - - read -r -a filepaths <<< "$paths" - for p in "${filepaths[@]}"; do - if [[ -e "$p" ]]; then - LOG_D "Check $p" - if [[ -n ${dir_mode} ]]; then - LOG_D "Change permissions to ${dir_mode} of directories in $p" - find -L "$p" -type d -print | xargs -i chmod "${dir_mode}" '{}' - fi - if [[ -n ${file_mode} ]]; then - LOG_D "Change permissions to ${file_mode} of files in $p" - find -L "$p" -type f -print | xargs -i chmod "${file_mode}" '{}' - fi - if [[ -n $user ]] && [[ -n ${group} ]]; then - LOG_D "Change ownership to ${user}:${group} of files and directories in $p" - find -L "$p" \( \! -user ${user} -or \! -group ${group} \) -print | xargs -i chown -L "${user}":"${group}" '{}' - elif [[ -n $user ]] && [[ -z $group ]]; then - LOG_D "Change user to ${user} of files and directories in $p" - find -L "$p" \! -user ${user} -print | xargs -i chown -L "${user}" '{}' - elif [[ -z $user ]] && [[ -n $group ]]; then - LOG_D "Change group to ${group} of files and directories in $p" - find -L "$p" \! -group ${group} -print | xargs -i chgrp -L "${group}" '{}' - fi - else - LOG_E "$p does not exist" - fi - done -} \ No newline at end of file diff --git a/prebuilds/usr/local/scripts/liblog.sh b/prebuilds/usr/local/scripts/liblog.sh deleted file mode 100644 index 3d91af4..0000000 --- a/prebuilds/usr/local/scripts/liblog.sh +++ /dev/null @@ -1,66 +0,0 @@ -#!/bin/bash -# Ver: 1.0 by Endial Fang (endial@126.com) -# -# 日志处理函数库 - -# 定义颜色信息 -RESET='\033[0m' -RED='\033[31;1m' -GREEN='\033[32;2m' -YELLOW='\033[33;1m' -MAGENTA='\033[36;2m' -CYAN='\033[35;2m' -BLUE='\033[34;2m' - -# 函数列表 - -# 输出实际日志信息 -# 参数: -# $1 - 日志类型 -# $2 - 日志信息 -LOG_RAW() { - local type="$1"; shift - case "${type}" in - x) printf "${CYAN}${APP_NAME:-} ${MAGENTA}%s ${RESET}${BLUE}DEBUG${RESET} %b\n" "$(date "+%T.%2N")" "${*}" ;; - I) printf "${CYAN}${APP_NAME:-} ${MAGENTA}%s ${RESET}${GREEN}INFO ${RESET} %b\n" "$(date "+%T.%2N")" "${*}";; - W) printf "${CYAN}${APP_NAME:-} ${MAGENTA}%s ${RESET}${YELLOW}WARN ${RESET} %b\n" "$(date "+%T.%2N")" "${*}";; - E) printf "${CYAN}${APP_NAME:-} ${MAGENTA}%s ${RESET}${RED}ERROR${RESET} %b\n" "$(date "+%T.%2N")" "${*}";; - esac -} - -# 输出调试类日志信息,尽量少使用 -# 参数: -# $1 - 日志类型 -# $2 - 日志信息 -LOG_D() { - local -r bool="${ENV_DEBUG:-false}" - shopt -s nocasematch - if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then - LOG_RAW x "$@" - fi -} - -# 输出提示信息类日志信息 -# 参数: -# $1 - 日志类型 -# $2 - 日志信息 -LOG_I() { - shopt -s nocasematch - LOG_RAW I "$@" -} - -# 输出警告类日志信息至sterr -# 参数: -# $1 - 日志类型 -# $2 - 日志信息 -LOG_W() { - LOG_RAW W "$@" >&2 -} - -# 输出错误类日志信息至sterr,并退出脚本 -# 参数: -# $1 - 日志类型 -# $2 - 日志信息 -LOG_E() { - LOG_RAW E "$@" >&2 -} diff --git a/prebuilds/usr/local/scripts/libnet.sh b/prebuilds/usr/local/scripts/libnet.sh deleted file mode 100644 index b5136c7..0000000 --- a/prebuilds/usr/local/scripts/libnet.sh +++ /dev/null @@ -1,120 +0,0 @@ -#!/bin/bash -# Ver: 1.0 by Endial Fang (endial@126.com) -# -# 网络管理函数库 - -# shellcheck disable=SC1091 - -# 加载依赖项 -. /usr/local/scripts/liblog.sh # 日志输出函数库 - -# 函数列表 - -# 解析主机名为 IP -# 参数: -# $1 - 待解析的主机名 -# 返回值: -# IP 地址 -######################### -dns_lookup() { - local host="${1:?host is missing}" - getent ahosts "$host" | awk '/STREAM/ {print $1 }' -} - -# 等待主机名解析,并返回 IP -# 参数: -# $1 - 主机名 -# $2 - 重试次数 -# $3 - 重试间隔(秒) -# 返回值: -# - IP 地址 -wait_for_dns_lookup() { - local hostname="${1:?hostname is missing}" - local retries="${2:-5}" - local seconds="${3:-1}" - check_host() { - if [[ $(dns_lookup "$hostname") == "" ]]; then - false - else - true - fi - } - # Wait for the host to be ready - retry_while "check_host ${hostname}" "$retries" "$seconds" - dns_lookup "$hostname" -} - -# 获取机器的 IP -# 返回值: -# - IP 地址 -get_machine_ip() { - dns_lookup "$(hostname)" -} - -# 检测提供的参数是否为可解析地址的主机名 -# 参数: -# $1 - 待检测值 -# 返回值: -# 布尔值 -is_hostname_resolved() { - local -r host="${1:?missing value}" - if [[ -n "$(dns_lookup "$host")" ]]; then - true - else - false - fi -} - -# 解析 URL -# 参数: -# $1 - URI 字符串 -# $2 - 待解析参数字符串。有效值 (scheme, authority, userinfo, host, port, path, query or fragment) -# 返回值: -# 字符串 -parse_uri() { - local uri="${1:?uri is missing}" - local component="${2:?component is missing}" - - # Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with - # additional sub-expressions to split authority into userinfo, host and port - # Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969) - local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-9]+))?))?(/([^?#]*))?(\?([^#]*))?(#(.*))?' - # || | ||| | | | | | | | | | - # |2 scheme | ||6 userinfo 7 host | 9 port | 11 rpath | 13 query | 15 fragment - # 1 scheme: | |5 userinfo@ 8 :... 10 path 12 ?... 14 #... - # | 4 authority - # 3 //... - local index=0 - case "$component" in - scheme) - index=2 - ;; - authority) - index=4 - ;; - userinfo) - index=6 - ;; - host) - index=7 - ;; - port) - index=9 - ;; - path) - index=10 - ;; - query) - index=13 - ;; - fragment) - index=14 - ;; - *) - stderr_print "unrecognized component $component" - return 1 - ;; - esac - [[ "$uri" =~ $URI_REGEX ]] && echo "${BASH_REMATCH[${index}]}" -} - \ No newline at end of file diff --git a/prebuilds/usr/local/scripts/libos.sh b/prebuilds/usr/local/scripts/libos.sh deleted file mode 100644 index db4fcb2..0000000 --- a/prebuilds/usr/local/scripts/libos.sh +++ /dev/null @@ -1,159 +0,0 @@ -#!/bin/bash -# Ver: 1.0 by Endial Fang (endial@126.com) -# -# 操作系统控制函数库 - -# shellcheck disable=SC1091 - -# 加载依赖项 -. /usr/local/scripts/liblog.sh # 日志输出函数库 - -# 函数列表 - -# 检测指定用户账户是否存在 -# 参数: -# $1 - 用户账户 -# 返回值: -# 布尔值 -user_exists() { - local user="${1:?user is missing}" - id "$user" >/dev/null 2>&1 -} - -# 检测指定用户分组是否存在 -# 参数: -# $1 - 用户组 -# 返回值: -# 布尔值 -group_exists() { - local group="${1:?group is missing}" - getent group "$group" >/dev/null 2>&1 -} - -# 确保用户组存在,如果不存在则创建相应用户组 -# 参数: -# $1 - 用户组 -ensure_group_exists() { - local group="${1:?group is missing}" - - if ! group_exists "$group"; then - groupadd "$group" >/dev/null 2>&1 - fi -} - -# 确保用户组及用户账户存在,如果不存在则创建相应用户组及账户 -# 参数: -# $1 - 用户 -# $2 - 用户组 -ensure_user_exists() { - local user="${1:?user is missing}" - local group="${2:-}" - - if ! user_exists "$user"; then - useradd "$user" >/dev/null 2>&1 - fi - - if [[ -n "$group" ]]; then - ensure_group_exists "$group" - fi - - usermod -a -G "$group" "$user" >/dev/null 2>&1 -} - -# 获取系统可用内存 -# 返回值: -# 内存大小(MB) -get_total_memory() { - echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024)) -} - -# 获取以定量方式描述的内存大小 -# 参数: -# $1 - 内存大小 (可选) -# 返回值: -# 基于定量内存大小的内存大小描述 -get_machine_size() { - local memory="${1:-}" - if [[ -z "$memory" ]]; then - debug "Memory was not specified, detecting available memory automatically" - memory="$(get_total_memory)" - fi - sanitized_memory=$(convert_to_mb "$memory") - if [[ "$sanitized_memory" -gt 26000 ]]; then - echo 2xlarge - elif [[ "$sanitized_memory" -gt 13000 ]]; then - echo xlarge - elif [[ "$sanitized_memory" -gt 6000 ]]; then - echo large - elif [[ "$sanitized_memory" -gt 3000 ]]; then - echo medium - elif [[ "$sanitized_memory" -gt 1500 ]]; then - echo small - else - echo micro - fi -} - -# 获取已定义的所有内存大小描述 -# 返回值: -# 内存大小描述 -get_supported_machine_sizes() { - echo micro small medium large xlarge 2xlarge -} - -# 将以字符串表示的内存大小转换为以MB为单位的内存大小值 (i.e. 2G -> 2048) -# 参数: -# $1 - 内存大小 -# 返回值: -# 内存大小值(以MB为单位) -convert_to_mb() { - local amount="${1:-}" - if [[ $amount =~ ^([0-9]+)(M|G) ]]; then - size="${BASH_REMATCH[1]}" - unit="${BASH_REMATCH[2]}" - if [[ "$unit" = "G" ]]; then - amount="$((size * 1024))" - else - amount="$size" - fi - fi - echo "$amount" -} - -# 如果禁用调试模式,将输出信息重定向至 /dev/null -# 全局变量: -# ENV_DEBUG -# 参数: -# $@ - 待执行的命令 -debug_execute() { - local -r bool="${ENV_DEBUG:-false}" - shopt -s nocasematch - if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then - "$@" >/dev/null 2>&1 - else - "$@" - fi -} - -# 重试执行命令 -# 参数: -# $1 - cmd (as a string) -# $2 - 最大尝试次数. Default: 12 -# $3 - 重试前等待时间(秒). Default: 5 -# 返回值: -# 布尔值 -retry_while() { - local -r cmd="${1:?cmd is missing}" - local -r retries="${2:-12}" - local -r sleep_time="${3:-5}" - local return_value=1 - - read -r -a command <<< "$cmd" - for ((i = 1 ; i <= retries ; i+=1 )); do - "${command[@]}" && return_value=0 && break - sleep "$sleep_time" - done - return $return_value -} - - \ No newline at end of file diff --git a/prebuilds/usr/local/scripts/libservice.sh b/prebuilds/usr/local/scripts/libservice.sh deleted file mode 100644 index 5d0948c..0000000 --- a/prebuilds/usr/local/scripts/libservice.sh +++ /dev/null @@ -1,132 +0,0 @@ -#!/bin/bash -# Ver: 1.0 by Endial Fang (endial@126.com) -# -# 服务管理函数库 - -# shellcheck disable=SC1091 - -# 加载依赖项 -. /usr/local/scripts/liblog.sh # 日志输出函数库 - -# 函数列表 - -# 获取并返回服务 PID -# 参数: -# $1 - PID 文件 -# 返回值: -# PID -get_pid_from_file() { - local pid_file="${1:?pid file is missing}" - - if [[ -f "$pid_file" ]]; then - if [[ -n "$(< "$pid_file")" ]] && [[ "$(< "$pid_file")" -gt 0 ]]; then - echo "$(< "$pid_file")" - fi - fi -} - -# 检测 PID 对应的服务是否在运行中 -# 参数: -# $1 - PID -# 返回值: -# Boolean -is_service_running() { - local pid="${1:?pid is missing}" - - kill -0 "$pid" 2>/dev/null -} - -# 通过发送信号停止一个指定的服务 -# 参数: -# $1 - PID 文件 -# $2 - 信号 (可选) -stop_service_using_pid() { - local pid_file="${1:?pid file is missing}" - local signal="${2:-}" - local pid - - pid="$(get_pid_from_file "$pid_file")" - [[ -z "$pid" ]] || ! is_service_running "$pid" && return - - if [[ -n "$signal" ]]; then - kill "-${signal}" "$pid" - else - kill "$pid" - fi - - local counter=10 - while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do - sleep 1 - counter=$((counter - 1)) - done -} - -# 为指定的服务生成一个监控配置文件 -# Arguments: -# $1 - 服务名 -# $2 - PID 文件 -# $3 - 启动命令 -# $4 - 停止命令 -# Flags: -# --disabled - Whether to disable the monit configuration -generate_monit_conf() { - local service_name="${1:?service name is missing}" - local pid_file="${2:?pid file is missing}" - local start_command="${3:?start command is missing}" - local stop_command="${4:?stop command is missing}" - local monit_conf_dir="/etc/monit/conf.d" - local disabled="no" - - # Parse optional CLI flags - shift 4 - while [[ "$#" -gt 0 ]]; do - case "$1" in - --disabled) - shift - disabled="$1" - ;; - *) - echo "Invalid command line flag ${1}" >&2 - return 1 - ;; - esac - shift - done - - is_boolean_yes "$disabled" && conf_suffix=".disabled" - mkdir -p "$monit_conf_dir" - cat >"${monit_conf_dir}/${service_name}.conf${conf_suffix:-}" <"${logrotate_conf_dir}/${service_name}" <= 0 )); then - true - else - false - fi -} - -# 检测数据是否为布尔值 '1' 或字符串 'yes/true' -# 参数: -# $1 - 待检测的数据 -# 返回值: -# 布尔值 -is_boolean_yes() { - local -r bool="${1:-}" - # comparison is performed without regard to the case of alphabetic characters - shopt -s nocasematch - if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then - true - else - false - fi -} - -# 检测数据是否为字符串 'yes/no' -# 参数: -# $1 - 待检测的数据 -# 返回值: -# 布尔值 -is_yes_no_value() { - local -r bool="${1:-}" - if [[ "$bool" =~ ^(yes|no)$ ]]; then - true - else - false - fi -} - -# 检测数据是否为字符串 'true/false' -# 参数: -# $1 - 待检测的数据 -# 返回值: -# 布尔值 -is_true_false_value() { - local -r bool="${1:-}" - if [[ "$bool" =~ ^(true|false)$ ]]; then - true - else - false - fi -} - -# 检测提供的参数是否为空字符串或未定义 -# 参数: -# $1 - 待检测的数据 -# 返回值: -# 布尔值 -is_empty_value() { - local -r val="${1:-}" - if [[ -z "$val" ]]; then - true - else - false - fi -} - -# 检测数据是否为有效的端口号 -# 参数: -# $1 - 待检测的数据 -# 返回值: -# 布尔值 或 错误消息 -validate_port() { - local value - local unprivileged=0 - - # Parse flags - while [[ "$#" -gt 0 ]]; do - case "$1" in - -unprivileged) - unprivileged=1 - ;; - --) - shift - break - ;; - -*) - stderr_print "unrecognized flag $1" - return 1 - ;; - *) - break - ;; - esac - shift - done - - if [[ "$#" -gt 1 ]]; then - echo "too many arguments provided" - return 2 - elif [[ "$#" -eq 0 ]]; then - stderr_print "missing port argument" - return 1 - else - value=$1 - fi - - if [[ -z "$value" ]]; then - echo "the value is empty" - return 1 - else - if ! is_int "$value"; then - echo "value is not an integer" - return 2 - elif [[ "$value" -lt 0 ]]; then - echo "negative value provided" - return 2 - elif [[ "$value" -gt 65535 ]]; then - echo "requested port is greater than 65535" - return 2 - elif [[ "$unprivileged" = 1 && "$value" -lt 1024 ]]; then - echo "privileged port requested" - return 3 - fi - fi -} - -# 检测数据是否为有效的IPv4地址 -# 参数: -# $1 - 待检测的数据 -# 返回值: -# 布尔值 -validate_ipv4() { - local ip="${1:?ip is missing}" - local stat=1 - - if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then - read -r -a ip_array <<< "$(tr '.' ' ' <<< "$ip")" - [[ ${ip_array[0]} -le 255 && ${ip_array[1]} -le 255 \ - && ${ip_array[2]} -le 255 && ${ip_array[3]} -le 255 ]] - stat=$? - fi - return $stat -} - -# 校验字符串格式 -# 参数: -# $1 - 待检测的数据 -# 返回值: -# 布尔值 -validate_string() { - local string - local min_length=-1 - local max_length=-1 - - # Parse flags - while [ "$#" -gt 0 ]; do - case "$1" in - -min-length) - shift - min_length=${1:-} - ;; - -max-length) - shift - max_length=${1:-} - ;; - --) - shift - break - ;; - -*) - stderr_print "unrecognized flag $1" - return 1 - ;; - *) - break - ;; - esac - shift - done - - if [ "$#" -gt 1 ]; then - stderr_print "too many arguments provided" - return 2 - elif [ "$#" -eq 0 ]; then - stderr_print "missing string" - return 1 - else - string=$1 - fi - - if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then - echo "string length is less than $min_length" - return 1 - fi - if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then - echo "string length is great than $max_length" - return 1 - fi -} \ No newline at end of file