integration/docker/entrypoint.sh - main - githubmirror/alluxio

integration/docker/entrypoint.sh
311 строк10 KB
LuQQiu
Add new Alluxio-FUSE as local cache solution with UFS gateway
02 дек 2022, 22:22
02 дек 2022, 22:227052240
#!/usr/bin/env bash
#
# The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
# (the "License"). You may not use this work except in compliance with the License, which is
# available at www.apache.org/licenses/LICENSE-2.0
#
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
# either express or implied, as more fully set forth in the License.
#
# See the NOTICE file distributed with this work for information regarding copyright ownership.
#

set -e

ALLUXIO_HOME="/opt/alluxio"
NO_FORMAT='--no-format'
FUSE_OPTS='--fuse-opts'
ALLUXIO_USERNAME="${ALLUXIO_USERNAME:-root}"
ALLUXIO_GROUP="${ALLUXIO_GROUP:-root}"
ALLUXIO_UID="${ALLUXIO_UID:-0}"
ALLUXIO_GID="${ALLUXIO_GID:-0}"

# List of environment variables which go in alluxio-env.sh instead of
# alluxio-site.properties
declare -a ALLUXIO_ENV_VARS=(
  ALLUXIO_CLASSPATH
  ALLUXIO_HOSTNAME
  ALLUXIO_JARS
  ALLUXIO_JAVA_OPTS
  ALLUXIO_MASTER_JAVA_OPTS
  ALLUXIO_PROXY_JAVA_OPTS
  ALLUXIO_RAM_FOLDER
  ALLUXIO_USER_JAVA_OPTS
  ALLUXIO_WORKER_JAVA_OPTS
  ALLUXIO_JOB_MASTER_JAVA_OPTS
  ALLUXIO_JOB_WORKER_JAVA_OPTS
  ALLUXIO_FUSE_JAVA_OPTS
)
declare -A ALLUXIO_ENV_MAP
for key in "${!ALLUXIO_ENV_VARS[@]}"; do ALLUXIO_ENV_MAP[${ALLUXIO_ENV_VARS[$key]}]="$key"; done

function printUsage {
  echo "Usage: COMMAND [COMMAND_OPTIONS]"
  echo
  echo "COMMAND is one of:"
  echo -e " master [--no-format]      \t Start Alluxio master. If --no-format is specified, do not format"
  echo -e " master-only [--no-format] \t Start Alluxio master w/o job master. If --no-format is specified, do not format"
  echo -e " worker [--no-format]      \t Start Alluxio worker. If --no-format is specified, do not format"
  echo -e " worker-only [--no-format] \t Start Alluxio worker w/o job worker. If --no-format is specified, do not format"
  echo -e " job-master                \t Start Alluxio job master"
  echo -e " job-worker                \t Start Alluxio job worker"
  echo -e " proxy                     \t Start Alluxio proxy"
  echo -e " fuse [--fuse-opts=opt1,...] [mount_point] [alluxio_path]"
  echo -e "                           \t Start Alluxio FUSE file system, option --fuse-opts expects a list of fuse options separated by commas"
  echo -e " mount ufs_address mount_point [options]"
  echo -e "                           \t Mounts an UFS address to a local mount point, example options include -o attr_timeout=700 -o s3a.accessKeyId=<S3 ACCESS KEY> -o s3a.secretKey=<S3 SECRET KEY>"
  echo -e " logserver                 \t Start Alluxio log server"
  echo -e " csiserver                 \t Start Alluxio CSI server, need option --nodeid={NODE_ID} --endpoint={CSI_ENDPOINT}"
}

function writeConf {
  local IFS=$'\n' # split by line instead of space
  if [ ! -f "conf/alluxio-env.sh" ]; then
    for keyvaluepair in $(env); do
      # split around the first "="
      key=$(echo ${keyvaluepair} | cut -d= -f1)
      value=$(echo ${keyvaluepair} | cut -d= -f2-)
      if [[ -n "${ALLUXIO_ENV_MAP[${key}]}" ]]; then
        echo "export ${key}=\"${value}\"" >> conf/alluxio-env.sh
      fi
    done
  fi
  LOG4J_FILE_TEMPLATE="/tmp/log4j.properties"
  LOG4J_FILE="conf/log4j.properties"
  if [ -f "$LOG4J_FILE_TEMPLATE" ] && [ ! -f "$LOG4J_FILE" ]; then
    cp $LOG4J_FILE_TEMPLATE $LOG4J_FILE
  fi
  if [[ ! -z "${ALLUXIO_LOG4J_PROPERTIES}" ]]; then
    echo "${ALLUXIO_LOG4J_PROPERTIES}" > $LOG4J_FILE
  fi
  if [[ ! -z "${ALLUXIO_SITE_PROPERTIES}" ]]; then
    echo "${ALLUXIO_SITE_PROPERTIES}" > conf/alluxio-site.properties
  fi
}

function formatMasterIfSpecified {
  if [[ -n ${OPTIONS} && ${OPTIONS} != ${NO_FORMAT} ]]; then
    printUsage
    exit 1
  fi
  if [[ ${OPTIONS} != ${NO_FORMAT} ]]; then
    bin/alluxio formatMaster
  fi
}

function formatWorkerIfSpecified {
  if [[ -n ${OPTIONS} && ${OPTIONS} != ${NO_FORMAT} ]]; then
    printUsage
    exit 1
  fi
  if [[ ${OPTIONS} != ${NO_FORMAT} ]]; then
    bin/alluxio formatWorker
  fi
}

function mountAlluxioFSWithFuseOption {
  if [[ -n ${FUSE_ALLUXIO_PATH} || -n ${MOUNT_POINT} ]]; then
    echo "Use of environment variables FUSE_ALLUXIO_PATH and MOUNT_POINT for Alluxio Fuse are deprecated."
    printUsage
    exit 1
  fi
  local mountOptions="$1"
  if [[ "${mountOptions}" =~ ${FUSE_OPTS}=* ]]; then
    exec integration/fuse/bin/alluxio-fuse mount -n -o "${mountOptions#*=}" "${@:2}"
  else
    exec integration/fuse/bin/alluxio-fuse mount -n "${@:1}"
  fi
}

function mountFuseWithUFS {
  exec bin/alluxio-fuse mount "${@}" -f
}

function startCsiServer {
  exec /usr/local/bin/alluxio-csi "${@:1}"
}

# Sends a signal to each of the running background processes
#
# Args:
#     1: the signal to send
function forward_signal {
  local signal="${1}"
  # background jobs don't respond to SIGINT (2)
  # Change to SIGHUP (1)
  if [ "${signal}" -eq "2" ]; then
    signal="1"
  fi

  local procs="$(jobs -p)"
  echo -e "Forwarding signal ${signal} to processes:\n${procs}"
  while read -r proc; do
    if [ -n "${proc}" ]; then
      kill -${signal} "${proc}"
    fi
  done <<< "${procs}"
  # This function may take over execution thread from the "main" function.
  # Wait if the processes are still up. Additional signals of the same type as this
  # will not be able to be processed
  wait
}

# Sets up traps on all signals [1, 31]
#
# Notes about trapping some signals
# - SIGINT (2): Background process (started with &) ignore SIGINT. As a workaround to still
#               terminate processes when SIGINT is passed, convert the signal sent to the
#               processes to be something other than SIGINT
# - SIGKILL (9): Cannot be trapped. It will directly kill the bash parent shell, the child
#                processes will continue to live
function setup_signals {
  for i in {1..31}; do
    trap "forward_signal ${i}" ${i}
  done

  # If the script exits for any reason without a signal, forward a SIGHUP to the children
  trap "forward_signal 1" EXIT
}

# Sets up if the non root is specified
function setup_for_dynamic_non_root {
  if [[ ${ALLUXIO_USERNAME} != "root" ]] && [[ ${ALLUXIO_GROUP} != "root" ]] && \
    [[ ${ALLUXIO_UID} -ne 0 ]] && [[ ${ALLUXIO_GID} -ne 0 ]] && [[ $UID -eq 0 ]]; then
      alp=$(cat /etc/issue|grep -i "Alpine"|wc -l)
      if [ "$alp" == "1" ];then
        addgroup -g ${ALLUXIO_GID} ${ALLUXIO_GROUP}
        adduser -u ${ALLUXIO_UID}  -G ${ALLUXIO_GROUP} --disabled-password ${ALLUXIO_USERNAME}
      else
        groupadd -g ${ALLUXIO_GID} ${ALLUXIO_GROUP} && \
        useradd -u ${ALLUXIO_UID} -g ${ALLUXIO_GROUP} ${ALLUXIO_USERNAME}
      fi
      usermod -a -G root ${ALLUXIO_USERNAME}
      mkdir -p /journal
      chown -R ${ALLUXIO_USERNAME}:${ALLUXIO_GROUP} /opt/* /journal
      chmod -R g=u /opt/* /journal
      # Chmod the dirs of tiered stores for alluxio worker
      # to ensure write permission for non-root user.
      if [[ -n "${ALLUXIO_RAM_FOLDER}" ]]; then
        chmod -R 777 "${ALLUXIO_RAM_FOLDER}"
      fi
      if [[ "$1" == "worker" || "$1" == "worker-only" ]]; then
        echo "${ALLUXIO_JAVA_OPTS} ${ALLUXIO_WORKER_JAVA_OPTS}" | \
          tr ' ' '\n' | \
          grep "alluxio.worker.tieredstore.level[0-9].dirs.path" | \
          cut -d '=' -f 2 | \
          tr ',' '\n' | \
          grep -Ev "^$" | \
          xargs -I {} chmod -R 777 {}
      fi
      exec su ${ALLUXIO_USERNAME} -c "/entrypoint.sh $*"
  fi
}

#######################################
# Sets the Alluxio ram folder if alluxio top tier is MEM and ram folder isn't explicitly configured.
# Globals:
#   ALLUXIO_JAVA_OPTS
#   ALLUXIO_HOME
#   ALLUXIO_WORKER_JAVA_OPTS
# Arguments:
#   None
#######################################
function set_ram_folder_if_needed {
  local tier_alias=$("${ALLUXIO_HOME}"/bin/alluxio getConf alluxio.worker.tieredstore.level0.alias)
  if [[ "${tier_alias}" != "MEM" ]]; then
    # If the top tier is not MEM, skip setting ram folder
    return
  fi
  local full_worker_opts="${ALLUXIO_JAVA_OPTS} ${ALLUXIO_WORKER_JAVA_OPTS}"
  if [[ "${full_worker_opts}" != *"alluxio.worker.tieredstore.level0.dirs.path"* ]]; then
    # Docker will set this tmpfs up by default. Its size is configurable through the
    # --shm-size argument to docker run
    export ALLUXIO_RAM_FOLDER=${ALLUXIO_RAM_FOLDER:-/dev/shm}
  fi
}

function main {
  if [[ "$#" -lt 1 ]]; then
    printUsage
    exit 1
  fi

  local service="$1"
  OPTIONS="$2"

  setup_for_dynamic_non_root "$@"

  cd ${ALLUXIO_HOME}

  writeConf

  local processes
  processes=()
  case "${service}" in
    master)
      formatMasterIfSpecified
      processes+=("job_master")
      processes+=("master")
      ;;
    master-only)
      formatMasterIfSpecified
      processes+=("master")
      ;;
    job-master)
      processes+=("job_master")
      ;;
    worker)
      set_ram_folder_if_needed
      formatWorkerIfSpecified
      processes+=("job_worker")
      processes+=("worker")
      ;;
    worker-only)
      set_ram_folder_if_needed
      formatWorkerIfSpecified
      processes+=("worker")
      ;;
    job-worker)
      processes+=("job_worker")
      ;;
    proxy)
      processes+=("proxy")
      ;;
    fuse)
      mountAlluxioFSWithFuseOption "${@:2}"
      ;;
    mount)
      mountFuseWithUFS "${@:2}"
      ;;
    logserver)
      processes+=("logserver")
      ;;
    csiserver)
      startCsiServer "${@:2}"
      ;;
    *)
      printUsage
      exit 1
      ;;
  esac

  if [ -z "${processes}" ]; then
    printUsage
    exit 1
  fi

  # Only a single process is going to be started, simply exec and replace in the shell
  if [ "${#processes[@]}" -eq 1 ]; then
    exec ./bin/launch-process "${processes[0]}" -c
  fi

  # Multiple processes may be running, so manage them by forwarding any signals to them.
  setup_signals

  for proc in "${processes[@]}"; do
    ./bin/launch-process "${proc}" -c &
  done
  wait
}

main "$@"