From cbfbce7cfe7b819b6b5e62e64958d74cf1602292 Mon Sep 17 00:00:00 2001 From: Christopher Recla Date: Wed, 17 Feb 2021 14:07:44 -0700 Subject: [PATCH 1/3] Initial bitnami redis --- .gitignore | 11 + 5.0/debian-10/Dockerfile | 56 ++ 5.0/debian-10/docker-compose.yml | 17 + 5.0/debian-10/hardening_manifest.yaml | 47 ++ .../opt/bitnami/.bitnami_components.json | 23 + .../opt/bitnami/licenses/licenses.txt | 3 + .../opt/bitnami/scripts/libbitnami.sh | 51 ++ .../opt/bitnami/scripts/libcomponent.sh | 65 ++ .../prebuildfs/opt/bitnami/scripts/libfile.sh | 80 +++ .../prebuildfs/opt/bitnami/scripts/libfs.sh | 183 ++++++ .../prebuildfs/opt/bitnami/scripts/libhook.sh | 16 + .../prebuildfs/opt/bitnami/scripts/liblog.sh | 110 ++++ .../prebuildfs/opt/bitnami/scripts/libnet.sh | 142 ++++ .../prebuildfs/opt/bitnami/scripts/libos.sh | 350 ++++++++++ .../opt/bitnami/scripts/libpersistence.sh | 122 ++++ .../opt/bitnami/scripts/libservice.sh | 225 +++++++ .../opt/bitnami/scripts/libvalidations.sh | 248 +++++++ .../opt/bitnami/scripts/libversion.sh | 49 ++ .../opt/bitnami/scripts/libwebserver.sh | 421 ++++++++++++ .../prebuildfs/usr/sbin/install_packages | 24 + .../rootfs/opt/bitnami/scripts/libredis.sh | 405 ++++++++++++ .../rootfs/opt/bitnami/scripts/redis-env.sh | 112 ++++ .../opt/bitnami/scripts/redis/entrypoint.sh | 26 + .../opt/bitnami/scripts/redis/postunpack.sh | 29 + .../rootfs/opt/bitnami/scripts/redis/run.sh | 33 + .../rootfs/opt/bitnami/scripts/redis/setup.sh | 23 + 6.0/debian-10/Dockerfile | 56 ++ 6.0/debian-10/docker-compose.yml | 17 + 6.0/debian-10/hardening_manifest.yaml | 47 ++ .../opt/bitnami/.bitnami_components.json | 23 + .../opt/bitnami/licenses/licenses.txt | 3 + .../opt/bitnami/scripts/libbitnami.sh | 51 ++ .../opt/bitnami/scripts/libcomponent.sh | 65 ++ .../prebuildfs/opt/bitnami/scripts/libfile.sh | 80 +++ .../prebuildfs/opt/bitnami/scripts/libfs.sh | 183 ++++++ .../prebuildfs/opt/bitnami/scripts/libhook.sh | 16 + .../prebuildfs/opt/bitnami/scripts/liblog.sh | 110 ++++ .../prebuildfs/opt/bitnami/scripts/libnet.sh | 142 ++++ .../prebuildfs/opt/bitnami/scripts/libos.sh | 350 ++++++++++ .../opt/bitnami/scripts/libpersistence.sh | 122 ++++ .../opt/bitnami/scripts/libservice.sh | 225 +++++++ .../opt/bitnami/scripts/libvalidations.sh | 248 +++++++ .../opt/bitnami/scripts/libversion.sh | 49 ++ .../opt/bitnami/scripts/libwebserver.sh | 421 ++++++++++++ .../prebuildfs/usr/sbin/install_packages | 24 + .../rootfs/opt/bitnami/scripts/libredis.sh | 405 ++++++++++++ .../rootfs/opt/bitnami/scripts/redis-env.sh | 112 ++++ .../opt/bitnami/scripts/redis/entrypoint.sh | 26 + .../opt/bitnami/scripts/redis/postunpack.sh | 29 + .../rootfs/opt/bitnami/scripts/redis/run.sh | 33 + .../rootfs/opt/bitnami/scripts/redis/setup.sh | 23 + LICENSE | 13 + README.md | 605 +++++++++++++++++- docker-compose-replicaset.yml | 31 + docker-compose.yml | 17 + 55 files changed, 6395 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 5.0/debian-10/Dockerfile create mode 100644 5.0/debian-10/docker-compose.yml create mode 100644 5.0/debian-10/hardening_manifest.yaml create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh create mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh create mode 100755 5.0/debian-10/prebuildfs/usr/sbin/install_packages create mode 100644 5.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh create mode 100644 5.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh create mode 100755 5.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh create mode 100755 5.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh create mode 100755 5.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh create mode 100755 5.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh create mode 100644 6.0/debian-10/Dockerfile create mode 100644 6.0/debian-10/docker-compose.yml create mode 100644 6.0/debian-10/hardening_manifest.yaml create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh create mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh create mode 100755 6.0/debian-10/prebuildfs/usr/sbin/install_packages create mode 100644 6.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh create mode 100644 6.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh create mode 100755 6.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh create mode 100755 6.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh create mode 100755 6.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh create mode 100755 6.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh create mode 100644 LICENSE create mode 100644 docker-compose-replicaset.yml create mode 100644 docker-compose.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..16386c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +# Default ignored files +/shelf/ +/workspace.xml +*.pyc +*.lock +*.idea +*config.json +*nohup.out +node_modules +package-lock.json +*.eslintcache \ No newline at end of file diff --git a/5.0/debian-10/Dockerfile b/5.0/debian-10/Dockerfile new file mode 100644 index 0000000..91dc148 --- /dev/null +++ b/5.0/debian-10/Dockerfile @@ -0,0 +1,56 @@ +ARG BASE_REGISTRY=registry1.dsop.io +ARG BASE_IMAGE=ironbank/redhat/openjdk/openjdk11 +ARG BASE_TAG=1.11 + +FROM bitnami/redis:6.0.4 as base +FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} as staging +ARG BITNAMI_HOME=/opt/bitnami +USER 0 +RUN mkdir /staging +COPY --from=base ${BITNAMI_HOME} /staging +RUN rm -rf /staging/java + +FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} +ARG PKG=redis +ARG BITNAMI_HOME=/opt/bitnami +ARG REDIS_HOME=${BITNAMI_HOME}/redis + +ARG REDIS_USER_ID="1001" +ARG REDIS_USER_NAME=${PKG} + +ENV REDIS_CONFIG_DIR=${REDIS_HOME}/config \ + REDIS_SERVER_HOME=${REDIS_HOME} \ + REDIS_BROKER_ID=0 \ + REDIS_LOG_DIRS=/tmp/redis-logs \ + REDIS_OFFSETS_TOPIC_REPLICATION_FACTOR=1 \ + REDIS_TRANSACTION_STATE_LOG_REPLICATION_FACTOR=1 \ + REDIS_TRANSACTION_STATE_LOG_MIN_ISR=1 \ + BITNAMI_APP_NAME=redis \ + PATH="${REDIS_HOME}/bin:/opt/bitnami/common/bin:$PATH" + +USER 0 + +RUN dnf update -y --nodocs && \ + dnf clean all && \ + rm -rf /var/cache/dnf && \ + mkdir -p ${BITNAMI_HOME} && \ + mkdir /docker-entrypoint-initdb.d + +COPY --from=staging /staging ${BITNAMI_HOME} +COPY scripts ${BITNAMI_HOME}/scripts + +RUN ln -s ${BITNAMI_HOME}/scripts/redis/entrypoint.sh /entrypoint.sh && \ + ln -s ${BITNAMI_HOME}/scripts/redis/run.sh /run.sh && \ + useradd -u ${REDIS_USER_ID} -g 0 -M -d ${REDIS_HOME} ${REDIS_USER_NAME} && \ + chown -R ${REDIS_USER_NAME}:0 ${REDIS_HOME} + +USER ${REDIS_USER_ID} + +WORKDIR ${REDIS_HOME} + +EXPOSE 6379 + +HEALTHCHECK --interval=10s --timeout=5s --retries=3 CMD zkServer.sh status || exit 1 + +ENTRYPOINT [ "/opt/bitnami/scripts/redis/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/redis/run.sh" ] diff --git a/5.0/debian-10/docker-compose.yml b/5.0/debian-10/docker-compose.yml new file mode 100644 index 0000000..209d1f4 --- /dev/null +++ b/5.0/debian-10/docker-compose.yml @@ -0,0 +1,17 @@ +version: '2' + +services: + redis: + image: 'docker.io/bitnami/redis:5.0-debian-10' + environment: + # ALLOW_EMPTY_PASSWORD is recommended only for development. + - ALLOW_EMPTY_PASSWORD=yes + - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL + ports: + - '6379:6379' + volumes: + - 'redis_data:/bitnami/redis/data' + +volumes: + redis_data: + driver: local diff --git a/5.0/debian-10/hardening_manifest.yaml b/5.0/debian-10/hardening_manifest.yaml new file mode 100644 index 0000000..6060994 --- /dev/null +++ b/5.0/debian-10/hardening_manifest.yaml @@ -0,0 +1,47 @@ +--- +apiVersion: v1 + +# The repository name in registry1, excluding /ironbank/ +name: "bitnami/redis" + +# List of tags to push for the repository in registry1 +# The most specific version should be the first tag and will be shown +# on ironbank.dsop.io +tags: +- "3.6.2" + +# Build args passed to Dockerfile ARGs +args: + BASE_IMAGE: "redhat/openjdk/openjdk11" + BASE_TAG: "1.11" + +# Docker image labels +labels: + org.opencontainers.image.title: "redis" + ## Human-readable description of the software packaged in the image + org.opencontainers.image.description: "Apache Redis® is a distributed streaming platform." + ## License(s) under which contained software is distributed + org.opencontainers.image.licenses: "Apache-2.0" + ## URL to find more information on the image + org.opencontainers.image.url: "https://bitnami.com/stack/redis/containers" + ## Name of the distributing entity, organization or individual + org.opencontainers.image.vendor: "Bitnami" + org.opencontainers.image.version: "3.6.2" + ## Keywords to help with search (ex. "cicd,gitops,golang") + mil.dso.ironbank.image.keywords: "dataflow,streaming" + ## This value can be "opensource" or "commercial" + mil.dso.ironbank.image.type: "opensource" + ## Product the image belongs to for grouping multiple images + mil.dso.ironbank.product.name: "Redis" + +# List of resources to make available to the offline build context +resources: +- tag: bitnami/redis:6.0.4 + url: docker://docker.io/bitnami/redis@sha256:b9e6ff6325a798c7c7c1cf0d45724f3c490d2916b0725f7151873f54d1275203 + +# List of project maintainers +maintainers: +- name: "Chris Recla" + username: "crecla" + email: "chrisrecla@seed-innovations.com" + cht_member: false \ No newline at end of file diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json b/5.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json new file mode 100644 index 0000000..46901a6 --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json @@ -0,0 +1,23 @@ +{ + "gosu": { + "arch": "amd64", + "digest": "4d858ac600c38af8de454c27b7f65c0074ec3069880cb16d259a6e40a46bbc50", + "distro": "debian-10", + "type": "NAMI", + "version": "1.12.0-2" + }, + "redis": { + "arch": "amd64", + "digest": "c97eda540863e3d0960b27c25a6530244abb606f858cf089ef88ae66397f9161", + "distro": "debian-10", + "type": "NAMI", + "version": "5.0.10-0" + }, + "wait-for-port": { + "arch": "amd64", + "digest": "7521d9a4f9e4e182bf32977e234026caa7b03759799868335bccb1edd8f8fd12", + "distro": "debian-10", + "type": "NAMI", + "version": "1.0.0-3" + } +} \ No newline at end of file diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt b/5.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 0000000..c76ba31 --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,3 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/nami/COPYING +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 0000000..ef29e36 --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# +# Bitnami custom library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Constants +BOLD='\033[1m' + +# Functions + +######################## +# Print the welcome page +# Globals: +# DISABLE_WELCOME_MESSAGE +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_welcome_page() { + if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then + if [[ -n "$BITNAMI_APP_NAME" ]]; then + print_image_welcome_page + fi + fi +} + +######################## +# Print the welcome page for a Bitnami Docker image +# Globals: +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_image_welcome_page() { + local github_url="https://github.com/bitnami/bitnami-docker-${BITNAMI_APP_NAME}" + + log "" + log "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + log "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" + log "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" + log "" +} + diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh new file mode 100644 index 0000000..1d8c6bf --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh @@ -0,0 +1,65 @@ +#!/bin/bash +# +# Library for managing Bitnami components + +# Constants +CACHE_ROOT="/tmp/bitnami/pkg/cache" +DOWNLOAD_URL="https://downloads.bitnami.com/files/stacksmith" + +# Functions + +######################## +# Download and unpack a Bitnami package +# Globals: +# OS_NAME +# OS_ARCH +# OS_FLAVOUR +# Arguments: +# $1 - component's name +# $2 - component's version +# Returns: +# None +######################### +component_unpack() { + local name="${1:?name is required}" + local version="${2:?version is required}" + local base_name="${name}-${version}-${OS_NAME}-${OS_ARCH}-${OS_FLAVOUR}" + local package_sha256="" + local directory="/opt/bitnami" + + # Validate arguments + shift 2 + while [ "$#" -gt 0 ]; do + case "$1" in + -c|--checksum) + shift + package_sha256="${1:?missing package checksum}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + echo "Downloading $base_name package" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz" ]; then + echo "${CACHE_ROOT}/${base_name}.tar.gz already exists, skipping download." + cp "${CACHE_ROOT}/${base_name}.tar.gz" . + rm "${CACHE_ROOT}/${base_name}.tar.gz" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz.sha256" ]; then + echo "Using the local sha256 from ${CACHE_ROOT}/${base_name}.tar.gz.sha256" + package_sha256="$(< "${CACHE_ROOT}/${base_name}.tar.gz.sha256")" + rm "${CACHE_ROOT}/${base_name}.tar.gz.sha256" + fi + else + curl --remote-name --silent "${DOWNLOAD_URL}/${base_name}.tar.gz" + fi + if [ -n "$package_sha256" ]; then + echo "Verifying package integrity" + echo "$package_sha256 ${base_name}.tar.gz" | sha256sum --check - + fi + tar --directory "${directory}" --extract --gunzip --file "${base_name}.tar.gz" --no-same-owner --strip-components=2 "${base_name}/files/" + rm "${base_name}.tar.gz" +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 0000000..b09575c --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,80 @@ +#!/bin/bash +# +# Library for managing files + +# Functions + +######################## +# Replace a regex in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# $4 - use POSIX regex. Default: true +# Returns: +# None +######################### +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 + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + if [[ $posix_regex = true ]]; then + result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + else + result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Remove a line in a file based on a regex +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - use POSIX regex. Default: true +# Returns: +# None +######################### +remove_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local posix_regex=${3:-true} + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + if [[ $posix_regex = true ]]; then + result="$(sed -E "/$match_regex/d" "$filename")" + else + result="$(sed "/$match_regex/d" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Appends text after the last line matching a pattern +# Arguments: +# $1 - file +# $2 - match regex +# $3 - contents to add +# Returns: +# None +######################### +append_file_after_last_match() { + local file="${1:?missing file}" + local match_regex="${2:?missing pattern}" + local value="${3:?missing value}" + + # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again + result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" + echo "$result" > "$file" +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 0000000..8f37ecb --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,183 @@ +#!/bin/bash +# +# Library for file system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Ensure a file/directory is owned (user and group) but the given user +# Arguments: +# $1 - filepath +# $2 - owner +# Returns: +# None +######################### +owned_by() { + local path="${1:?path is missing}" + local owner="${2:?owner is missing}" + + chown "$owner":"$owner" "$path" +} + +######################## +# Ensure a directory exists and, optionally, is owned by the given user +# Arguments: +# $1 - directory +# $2 - owner +# Returns: +# None +######################### +ensure_dir_exists() { + local dir="${1:?directory is missing}" + local owner="${2:-}" + + mkdir -p "${dir}" + if [[ -n $owner ]]; then + owned_by "$dir" "$owner" + fi +} + +######################## +# Checks whether a directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_dir_empty() { + local dir="${1:?missing directory}" + + if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then + true + else + false + fi +} + +######################## +# Checks whether a mounted directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_mounted_dir_empty() { + local dir="${1:?missing directory}" + + if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then + true + else + false + fi +} + +######################## +# Checks whether a file can be written to or not +# arguments: +# $1 - file +# returns: +# boolean +######################### +is_file_writable() { + local file="${1:?missing file}" + local dir + dir="$(dirname "$file")" + + if [[ ( -f "$file" && -w "$file" ) || ( ! -f "$file" && -d "$dir" && -w "$dir" ) ]]; then + true + else + false + fi +} + +######################## +# Relativize a path +# arguments: +# $1 - path +# $2 - base +# returns: +# None +######################### +relativize() { + local -r path="${1:?missing path}" + local -r base="${2:?missing base}" + pushd "$base" >/dev/null + realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' + popd >/dev/null +} + +######################## +# Configure permisions and ownership recursively +# Globals: +# None +# Arguments: +# $1 - paths (as a string). +# Flags: +# -f|--file-mode - mode for directories. +# -d|--dir-mode - mode for files. +# -u|--user - user +# -g|--group - group +# Returns: +# None +######################### +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}" + ;; + *) + echo "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 + if [[ -n $dir_mode ]]; then + find -L "$p" -type d -exec chmod "$dir_mode" {} \; + fi + if [[ -n $file_mode ]]; then + find -L "$p" -type f -exec chmod "$file_mode" {} \; + fi + if [[ -n $user ]] && [[ -n $group ]]; then + chown -LR "$user":"$group" "$p" + elif [[ -n $user ]] && [[ -z $group ]]; then + chown -LR "$user" "$p" + elif [[ -z $user ]] && [[ -n $group ]]; then + chgrp -LR "$group" "$p" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 0000000..9694852 --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,16 @@ +#!/bin/bash +# +# Library to use for scripts expected to be used as Kubernetes lifecycle hooks + +# shellcheck disable=SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh + +# Override functions that log to stdout/stderr of the current process, so they print to process 1 +for function_to_override in stderr_print debug_execute; do + # Output is sent to output of process 1 and thus end up in the container log + # The hook output in general isn't saved + eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2" +done diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 0000000..60ec4cb --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,110 @@ +#!/bin/bash +# +# Library for logging functions + +# Constants +RESET='\033[0m' +RED='\033[38;5;1m' +GREEN='\033[38;5;2m' +YELLOW='\033[38;5;3m' +MAGENTA='\033[38;5;5m' +CYAN='\033[38;5;6m' + +# Functions + +######################## +# Print to STDERR +# Arguments: +# Message to print +# Returns: +# None +######################### +stderr_print() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_QUIET:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if ! [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + printf "%b\\n" "${*}" >&2 + fi +} + +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +log() { + stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" +} +######################## +# Log an 'info' message +# Arguments: +# Message to log +# Returns: +# None +######################### +info() { + log "${GREEN}INFO ${RESET} ==> ${*}" +} +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +warn() { + log "${YELLOW}WARN ${RESET} ==> ${*}" +} +######################## +# Log an 'error' message +# Arguments: +# Message to log +# Returns: +# None +######################### +error() { + log "${RED}ERROR${RESET} ==> ${*}" +} +######################## +# Log a 'debug' message +# Globals: +# BITNAMI_DEBUG +# Arguments: +# None +# Returns: +# None +######################### +debug() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_DEBUG:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + log "${MAGENTA}DEBUG${RESET} ==> ${*}" + fi +} + +######################## +# Indent a string +# Arguments: +# $1 - string +# $2 - number of indentation characters (default: 4) +# $3 - indentation character (default: " ") +# Returns: +# None +######################### +indent() { + local string="${1:-}" + local num="${2:?missing num}" + local char="${3:-" "}" + # Build the indentation unit string + local indent_unit="" + for ((i = 0; i < num; i++)); do + indent_unit="${indent_unit}${char}" + done + echo "$string" | sed "s/^/${indent_unit}/" +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 0000000..4391dac --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,142 @@ +#!/bin/bash +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Resolve IP address for a host/domain (i.e. DNS lookup) +# Arguments: +# $1 - Hostname to resolve +# $2 - IP address version (v4, v6), leave empty for resolving to any version +# Returns: +# IP +######################### +dns_lookup() { + local host="${1:?host is missing}" + local ip_version="${2:-}" + getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1 +} + +######################### +# Wait for a hostname and return the IP +# Arguments: +# $1 - hostname +# $2 - number of retries +# $3 - seconds to wait between retries +# Returns: +# - IP address that corresponds to the hostname +######################### +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" +} + +######################## +# Get machine's IP +# Arguments: +# None +# Returns: +# Machine IP +######################### +get_machine_ip() { + local -a ip_addresses + local hostname + hostname="$(hostname)" + read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" + if [[ "${#ip_addresses[@]}" -gt 1 ]]; then + warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" + elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then + error "Could not find any IP address associated to hostname ${hostname}" + exit 1 + fi + echo "${ip_addresses[0]}" +} + +######################## +# Check if the provided argument is a resolved hostname +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_hostname_resolved() { + local -r host="${1:?missing value}" + if [[ -n "$(dns_lookup "$host")" ]]; then + true + else + false + fi +} + +######################## +# Parse URL +# Globals: +# None +# Arguments: +# $1 - uri - String +# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String +# Returns: +# String +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}]}" +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 0000000..6a75122 --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,350 @@ +#!/bin/bash +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh + +# Functions + +######################## +# Check if an user exists in the system +# Arguments: +# $1 - user +# Returns: +# Boolean +######################### +user_exists() { + local user="${1:?user is missing}" + id "$user" >/dev/null 2>&1 +} + +######################## +# Check if a group exists in the system +# Arguments: +# $1 - group +# Returns: +# Boolean +######################### +group_exists() { + local group="${1:?group is missing}" + getent group "$group" >/dev/null 2>&1 +} + +######################## +# Create a group in the system if it does not exist already +# Arguments: +# $1 - group +# Flags: +# -s|--system - Whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -s|--system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! group_exists "$group"; then + local -a args=("$group") + $is_system_user && args+=("--system") + groupadd "${args[@]}" >/dev/null 2>&1 + fi +} + +######################## +# Create an user in the system if it does not exist already +# Arguments: +# $1 - user +# Flags: +# -g|--group - the group the new user should belong to +# -h|--home - the home directory for the new user +# -s|--system - whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_user_exists() { + local user="${1:?user is missing}" + local group="" + local home="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -g|--group) + shift + group="${1:?missing group}" + ;; + -h|--home) + shift + home="${1:?missing home directory}" + ;; + -s|--system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! user_exists "$user"; then + local -a user_args=("-N" "$user") + $is_system_user && user_args+=("--system") + useradd "${user_args[@]}" >/dev/null 2>&1 + fi + + if [[ -n "$group" ]]; then + local -a group_args=("$group") + $is_system_user && group_args+=("--system") + ensure_group_exists "${group_args[@]}" + usermod -g "$group" "$user" >/dev/null 2>&1 + fi + + if [[ -n "$home" ]]; then + mkdir -p "$home" + usermod -d "$home" "$user" >/dev/null 2>&1 + configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group" + fi +} + +######################## +# Check if the script is currently running as root +# Arguments: +# $1 - user +# $2 - group +# Returns: +# Boolean +######################### +am_i_root() { + if [[ "$(id -u)" = "0" ]]; then + true + else + false + fi +} + +######################## +# Get total memory available +# Arguments: +# None +# Returns: +# Memory in bytes +######################### +get_total_memory() { + echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024)) +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# None +# Flags: +# --memory - memory size (optional) +# Returns: +# Detected instance size +######################### +get_machine_size() { + local memory="" + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + --memory) + shift + memory="${1:?missing memory}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + 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 machine size depending on specified memory +# Globals: +# None +# Arguments: +# $1 - memory size (optional) +# Returns: +# Detected instance size +######################### +get_supported_machine_sizes() { + echo micro small medium large xlarge 2xlarge +} + +######################## +# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048) +# Globals: +# None +# Arguments: +# $1 - memory size +# Returns: +# Result of the conversion +######################### +convert_to_mb() { + local amount="${1:-}" + if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then + size="${BASH_REMATCH[1]}" + unit="${BASH_REMATCH[2]}" + if [[ "$unit" = "g" || "$unit" = "G" ]]; then + amount="$((size * 1024))" + else + amount="$size" + fi + fi + echo "$amount" +} + + +######################### +# Redirects output to /dev/null if debug mode is disabled +# Globals: +# BITNAMI_DEBUG +# Arguments: +# $@ - Command to execute +# Returns: +# None +######################### +debug_execute() { + if ${BITNAMI_DEBUG:-false}; then + "$@" + else + "$@" >/dev/null 2>&1 + fi +} + +######################## +# Retries a command a given number of times +# Arguments: +# $1 - cmd (as a string) +# $2 - max retries. Default: 12 +# $3 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +retry_while() { + local cmd="${1:?cmd is missing}" + local retries="${2:-12}" + local 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 +} + +######################## +# Generate a random string +# Arguments: +# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii +# -c|--count - Number of characters, defaults to 32 +# Arguments: +# None +# Returns: +# None +# Returns: +# String +######################### +generate_random_string() { + local type="ascii" + local count="32" + local filter + local result + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + -t|--type) + shift + type="$1" + ;; + -c|--count) + shift + count="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Validate type + case "$type" in + ascii) + filter="[:print:]" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + numeric) + filter="0-9" + ;; + *) + echo "Invalid type ${type}" >&2 + return 1 + esac + # Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size + # Note there is a very small chance of strings starting with EOL character + # Therefore, the higher amount of lines read, this will happen less frequently + result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")" + echo "$result" +} + +######################## +# Create md5 hash from a string +# Arguments: +# $1 - string +# Returns: +# md5 hash - string +######################### +generate_md5_hash() { + local -r str="${1:?missing input string}" + echo -n "$str" | md5sum | awk '{print $1}' +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 0000000..452c1f4 --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,122 @@ +#!/bin/bash +# +# Bitnami persistence library +# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libversion.sh + +# Functions + +######################## +# Persist an application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# $2 - List of app files to persist +# Returns: +# true if all steps succeeded, false otherwise +######################### +persist_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_persist <<< "$2" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Persist the individual files + if [[ "${#files_to_persist[@]}" -lt 0 ]]; then + warn "No files are configured to be persisted" + return + fi + pushd "$install_dir" >/dev/null + local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder + local -r tmp_file="/tmp/perms.acl" + for file_to_persist in "${files_to_persist[@]}"; do + if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then + error "Cannot persist '${file_to_persist}' because it does not exist" + return 1 + fi + file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")" + file_to_persist_destination="${persist_dir}/${file_to_persist_relative}" + file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")" + # Get original permissions for existing files, which will be applied later + # Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume + getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file" + # Copy directories to the volume + ensure_dir_exists "$file_to_persist_destination_folder" + cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder" + # Restore permissions + pushd "$persist_dir" >/dev/null + if am_i_root; then + setfacl --restore="$tmp_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file") + fi + popd >/dev/null + done + popd >/dev/null + rm -f "$tmp_file" + # Install the persisted files into the installation directory, via symlinks + restore_persisted_app "$@" +} + +######################## +# Restore a persisted application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# FORCE_MAJOR_UPGRADE +# Arguments: +# $1 - App folder name +# $2 - List of app files to restore +# Returns: +# true if all steps succeeded, false otherwise +######################### +restore_persisted_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_restore <<< "$2" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Restore the individual persisted files + if [[ "${#files_to_restore[@]}" -lt 0 ]]; then + warn "No persisted files are configured to be restored" + return + fi + local file_to_restore_relative file_to_restore_origin file_to_restore_destination + for file_to_restore in "${files_to_restore[@]}"; do + file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")" + # We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed + file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")" + file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")" + rm -rf "$file_to_restore_origin" + ln -sfn "$file_to_restore_destination" "$file_to_restore_origin" + done +} + +######################## +# Check if an application directory was already persisted +# Globals: +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# Returns: +# true if all steps succeeded, false otherwise +######################### +is_app_initialized() { + local -r app="${1:?missing app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + if ! is_mounted_dir_empty "$persist_dir"; then + true + else + false + fi +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 0000000..55e1dfc --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,225 @@ +#!/bin/bash +# +# Library for managing services + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Read the provided pid file and returns a PID +# Arguments: +# $1 - Pid file +# Returns: +# 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 +} + +######################## +# Check if a provided PID corresponds to a running service +# Arguments: +# $1 - PID +# Returns: +# Boolean +######################### +is_service_running() { + local pid="${1:?pid is missing}" + + kill -0 "$pid" 2>/dev/null +} + +######################## +# Stop a service by sending a termination signal to its pid +# Arguments: +# $1 - Pid file +# $2 - Signal number (optional) +# Returns: +# None +######################### +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 +} + +######################## +# Start cron daemon +# Arguments: +# None +# Returns: +# true if started correctly, false otherwise +######################### +cron_start() { + if [[ -x "/usr/sbin/cron" ]]; then + /usr/sbin/cron + elif [[ -x "/usr/sbin/crond" ]]; then + /usr/sbin/crond + else + false + fi +} + +######################## +# Generate a cron configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Command +# Flags: +# --run-as - User to run as (default: root) +# --schedule - Cron schedule configuration (default: * * * * *) +# Returns: +# None +######################### +generate_cron_conf() { + local service_name="${1:?service name is missing}" + local cmd="${2:?command is missing}" + local run_as="root" + local schedule="* * * * *" + + # Parse optional CLI flags + shift 2 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --run-as) + shift + run_as="$1" + ;; + --schedule) + shift + schedule="$1" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + mkdir -p /etc/cron.d + echo "${schedule} ${run_as} ${cmd}" > /etc/cron.d/"$service_name" +} + +######################## +# Generate a monit configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Pid file +# $3 - Start command +# $4 - Stop command +# Flags: +# --disabled - Whether to disable the monit configuration +# Returns: +# None +######################### +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:-}" <&2 + return 1 + ;; + esac + shift + done + + mkdir -p "$logrotate_conf_dir" + cat <"${logrotate_conf_dir}/${service_name}" +${log_path} { + ${period} + rotate ${rotations} + dateext + compress + copytruncate + missingok +$(indent "$extra" 2) +} +EOF +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh new file mode 100644 index 0000000..8d82792 --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh @@ -0,0 +1,248 @@ +#!/bin/bash +# +# Validation functions library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Check if the provided argument is an integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_int() { + local -r int="${1:?missing value}" + if [[ "$int" =~ ^-?[0-9]+ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a positive integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_positive_int() { + local -r int="${1:?missing value}" + if is_int "$int" && (( "${int}" >= 0 )); then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean or is the string 'yes/true' +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +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 +} + +######################## +# Check if the provided argument is a boolean yes/no value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_yes_no_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(yes|no)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean true/false value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_true_false_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(true|false)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is an empty string or not defined +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_empty_value() { + local -r val="${1:-}" + if [[ -z "$val" ]]; then + true + else + false + fi +} + +######################## +# Validate if the provided argument is a valid port +# Arguments: +# $1 - Port to validate +# Returns: +# Boolean and error message +######################### +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 +} + +######################## +# Validate if the provided argument is a valid IPv4 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +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 +} + +######################## +# Validate a string format +# Arguments: +# $1 - String to validate +# Returns: +# Boolean +######################### +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 +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 0000000..66d4f45 --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,49 @@ +#!/bin/bash +# +# Library for managing versions strings + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions +######################## +# Gets semantic version +# Arguments: +# $1 - version: string to extract major.minor.patch +# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch +# Returns: +# array with the major, minor and release +######################### +get_sematic_version () { + local version="${1:?version is required}" + local section="${2:?section is required}" + local -a version_sections + + #Regex to parse versions: x.y.z + local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?' + + if [[ "$version" =~ $regex ]]; then + local i=1 + local j=1 + local n=${#BASH_REMATCH[*]} + + while [[ $i -lt $n ]]; do + if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then + version_sections[$j]=${BASH_REMATCH[$i]} + ((j++)) + fi + ((i++)) + done + + local number_regex='^[0-9]+$' + if [[ "$section" =~ $number_regex ]] && (( $section > 0 )) && (( $section <= 3 )); then + echo "${version_sections[$section]}" + return + else + stderr_print "Section allowed values are: 1, 2, and 3" + return 1 + fi + fi +} diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 0000000..25bff4a --- /dev/null +++ b/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,421 @@ +#!/bin/bash +# +# Bitnami web server handler library + +# shellcheck disable=SC1090,SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh + +######################## +# Execute a command (or list of commands) with the web server environment and library loaded +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_execute() { + local -r web_server="${1:?missing web server}" + shift + # Run program in sub-shell to avoid web server environment getting loaded when not necessary + ( + . "/opt/bitnami/scripts/lib${web_server}.sh" + . "/opt/bitnami/scripts/${web_server}-env.sh" + "$@" + ) +} + +######################## +# Prints the list of enabled web servers +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_list() { + local -r -a supported_web_servers=(apache nginx) + local -a existing_web_servers=() + for web_server in "${supported_web_servers[@]}"; do + [[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server") + done + echo "${existing_web_servers[@]:-}" +} + +######################## +# Prints the currently-enabled web server type (only one, in order of preference) +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_type() { + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + echo "${web_servers[0]:-}" +} + +######################## +# Validate that a supported web server is configured +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_validate() { + local error_code=0 + local supported_web_servers=("apache" "nginx") + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then + print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}" + elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then + print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable." + fi + + return "$error_code" +} + +######################## +# Check whether the web server is running +# Globals: +# * +# Arguments: +# None +# Returns: +# true if the web server is running, false otherwise +######################### +is_web_server_running() { + "is_$(web_server_type)_running" +} + +######################## +# Start web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_start() { + info "Starting $(web_server_type) in background" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" +} + +######################## +# Stop web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_stop() { + info "Stopping $(web_server_type)" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" +} + +######################## +# Restart web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_restart() { + info "Restarting $(web_server_type)" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" +} + +######################## +# Reload web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_reload() { + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" +} + +######################## +# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --type - Application type, which has an effect on which configuration template to use +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disabled - Whether to render the file with a .disabled prefix +# --enable-https - Enable app configuration on HTTPS port +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --document-root - Path to document root directory +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-before-vhost-configuration - Configuration to add before the directive (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_app_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --hosts \ + | --type \ + | --allow-remote-connections \ + | --disabled \ + | --enable-https \ + | --http-port \ + | --https-port \ + | --document-root \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-before-vhost-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "${2:?missing value}") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + nginx_args+=("${1//nginx-/}" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_web_server_app_configuration_not_exists() { + local app="${1:?missing app}" + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app" + done +} + +######################## +# Ensure the web server loads the configuration for an application in a URL prefix +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --document-root - Path to document root directory +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --type - Application type, which has an effect on what configuration template will be used +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_prefix_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --allow-remote-connections \ + | --document-root \ + | --prefix \ + | --type \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "$2") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + nginx_args+=("${1//nginx-/}" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --enable-https - Update HTTPS app configuration +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +web_server_update_app_configuration() { + local app="${1:?missing app}" + shift + local -a args web_servers + args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --hosts \ + | --enable-https \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}" + done +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_enable_loading_page() { + ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \ + --apache-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +RedirectMatch 503 ^/$ +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +ErrorDocument 404 /index.html +ErrorDocument 503 /index.html" \ + --nginx-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +location / { + return 503; +} +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +error_page 404 @installing; +error_page 503 @installing; +location @installing { + rewrite ^(.*)$ /index.html break; +}" + web_server_reload +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_disable_install_page() { + ensure_web_server_app_configuration_not_exists "__loading" + web_server_reload +} diff --git a/5.0/debian-10/prebuildfs/usr/sbin/install_packages b/5.0/debian-10/prebuildfs/usr/sbin/install_packages new file mode 100755 index 0000000..c957764 --- /dev/null +++ b/5.0/debian-10/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,24 @@ +#!/bin/sh +set -e +set -u +export DEBIAN_FRONTEND=noninteractive +n=0 +max=2 +until [ $n -gt $max ]; do + set +e + ( + apt-get update -qq && + apt-get install -y --no-install-recommends "$@" + ) + CODE=$? + set -e + if [ $CODE -eq 0 ]; then + break + fi + if [ $n -eq $max ]; then + exit $CODE + fi + echo "apt failed, retrying" + n=$(($n + 1)) +done +rm -r /var/lib/apt/lists /var/cache/apt/archives diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh b/5.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh new file mode 100644 index 0000000..3c5dd5f --- /dev/null +++ b/5.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh @@ -0,0 +1,405 @@ +#!/bin/bash +# +# Bitnami Redis library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libnet.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Retrieve a configuration setting value +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - key +# Returns: +# None +######################### +redis_conf_get() { + local -r key="${1:?missing key}" + + if grep -q -E "^\s*$key " "${REDIS_BASE_DIR}/etc/redis.conf"; then + grep -E "^\s*$key " "${REDIS_BASE_DIR}/etc/redis.conf" | awk '{print $2}' + fi +} + +######################## +# Set a configuration setting value +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - key +# $2 - value +# Returns: +# None +######################### +redis_conf_set() { + local -r key="${1:?missing key}" + local value="${2:-}" + + # Sanitize inputs + value="${value//\\/\\\\}" + value="${value//&/\\&}" + value="${value//\?/\\?}" + [[ "$value" = "" ]] && value="\"$value\"" + + replace_in_file "${REDIS_BASE_DIR}/etc/redis.conf" "^#*\s*${key} .*" "${key} ${value}" false +} + +######################## +# Unset a configuration setting value +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - key +# Returns: +# None +######################### +redis_conf_unset() { + local -r key="${1:?missing key}" + remove_in_file "${REDIS_BASE_DIR}/etc/redis.conf" "^\s*$key .*" false +} + +######################## +# Get Redis version +# Globals: +# REDIS_BASE_DIR +# Arguments: +# None +# Returns: +# Redis versoon +######################### +redis_version() { + "${REDIS_BASE_DIR}/bin/redis-cli" --version | grep -E -o "[0-9]+.[0-9]+.[0-9]+" +} + +######################## +# Get Redis major version +# Globals: +# REDIS_BASE_DIR +# Arguments: +# None +# Returns: +# Redis major version +######################### +redis_major_version() { + redis_version | grep -E -o "^[0-9]+" +} + +######################## +# Check if redis is running +# Globals: +# REDIS_BASE_DIR +# Arguments: +# None +# Returns: +# Boolean +######################### +is_redis_running() { + local pid + pid="$(get_pid_from_file "$REDIS_BASE_DIR/tmp/redis.pid")" + + if [[ -z "$pid" ]]; then + false + else + is_service_running "$pid" + fi +} + +######################## +# Check if redis is not running +# Globals: +# REDIS_BASE_DIR +# Arguments: +# None +# Returns: +# Boolean +######################### +is_redis_not_running() { + ! is_redis_running +} + +######################## +# Stop Redis +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_stop() { + local pass + local port + local args + + ! is_redis_running && return + pass="$(redis_conf_get "requirepass")" + is_boolean_yes "$REDIS_TLS_ENABLED" && port="$(redis_conf_get "tls-port")" || port="$(redis_conf_get "port")" + + [[ -n "$pass" ]] && args+=("-a" "$pass") + [[ "$port" != "0" ]] && args+=("-p" "$port") + + debug "Stopping Redis" + if am_i_root; then + gosu "$REDIS_DAEMON_USER" "${REDIS_BASE_DIR}/bin/redis-cli" "${args[@]}" shutdown + else + "${REDIS_BASE_DIR}/bin/redis-cli" "${args[@]}" shutdown + fi +} + +######################## +# Validate settings in REDIS_* env vars. +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_validate() { + debug "Validating settings in REDIS_* env vars.." + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + empty_password_enabled_warn() { + warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD}. For safety reasons, do not use this flag in a production environment." + } + empty_password_error() { + print_validation_error "The $1 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_EMPTY_PASSWORD"; then + empty_password_enabled_warn + else + [[ -z "$REDIS_PASSWORD" ]] && empty_password_error REDIS_PASSWORD + fi + if [[ -n "$REDIS_REPLICATION_MODE" ]]; then + if [[ "$REDIS_REPLICATION_MODE" =~ ^(slave|replica)$ ]]; then + if [[ -n "$REDIS_MASTER_PORT_NUMBER" ]]; then + if ! err=$(validate_port "$REDIS_MASTER_PORT_NUMBER"); then + 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 + empty_password_error REDIS_MASTER_PASSWORD + fi + elif [[ "$REDIS_REPLICATION_MODE" != "master" ]]; then + print_validation_error "Invalid replication mode. Available options are 'master/replica'" + fi + fi + if is_boolean_yes "$REDIS_TLS_ENABLED"; then + if [[ "$REDIS_PORT_NUMBER" == "$REDIS_TLS_PORT" ]] && [[ "$REDIS_PORT_NUMBER" != "6379" ]]; then + # If both ports are assigned the same numbers and they are different to the default settings + print_validation_error "Environment variables REDIS_PORT_NUMBER and REDIS_TLS_PORT point to the same port number (${REDIS_PORT_NUMBER}). Change one of them or disable non-TLS traffic by setting REDIS_PORT_NUMBER=0" + fi + if [[ -z "$REDIS_TLS_CERT_FILE" ]]; then + print_validation_error "You must provide a X.509 certificate in order to use TLS" + elif [[ ! -f "$REDIS_TLS_CERT_FILE" ]]; then + print_validation_error "The X.509 certificate file in the specified path ${REDIS_TLS_CERT_FILE} does not exist" + fi + if [[ -z "$REDIS_TLS_KEY_FILE" ]]; then + print_validation_error "You must provide a private key in order to use TLS" + elif [[ ! -f "$REDIS_TLS_KEY_FILE" ]]; then + print_validation_error "The private key file in the specified path ${REDIS_TLS_KEY_FILE} does not exist" + fi + if [[ -z "$REDIS_TLS_CA_FILE" ]]; then + print_validation_error "You must provide a CA X.509 certificate in order to use TLS" + elif [[ ! -f "$REDIS_TLS_CA_FILE" ]]; then + print_validation_error "The CA X.509 certificate file in the specified path ${REDIS_TLS_CA_FILE} does not exist" + fi + if [[ -n "$REDIS_TLS_DH_PARAMS_FILE" ]] && [[ ! -f "$REDIS_TLS_DH_PARAMS_FILE" ]]; then + print_validation_error "The DH param file in the specified path ${REDIS_TLS_DH_PARAMS_FILE} does not exist" + fi + fi + + [[ "$error_code" -eq 0 ]] || exit "$error_code" +} + +######################## +# Configure Redis replication +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - Replication mode +# Returns: +# None +######################### +redis_configure_replication() { + info "Configuring replication mode" + + redis_conf_set replica-announce-ip "${REDIS_REPLICA_IP:-$(get_machine_ip)}" + redis_conf_set replica-announce-port "${REDIS_REPLICA_PORT:-$REDIS_MASTER_PORT_NUMBER}" + # Use TLS in the replication connections + if is_boolean_yes "$REDIS_TLS_ENABLED"; then + redis_conf_set tls-replication yes + fi + if [[ "$REDIS_REPLICATION_MODE" = "master" ]]; then + if [[ -n "$REDIS_PASSWORD" ]]; then + redis_conf_set masterauth "$REDIS_PASSWORD" + fi + elif [[ "$REDIS_REPLICATION_MODE" =~ ^(slave|replica)$ ]]; then + if [[ -n "$REDIS_SENTINEL_HOST" ]]; then + local sentinel_info_command + if is_boolean_yes "$REDIS_TLS_ENABLED"; then + sentinel_info_command="redis-cli -h ${REDIS_SENTINEL_HOST} -p ${REDIS_SENTINEL_PORT_NUMBER} --tls --cert ${REDIS_TLS_CERT_FILE} --key ${REDIS_TLS_KEY_FILE} --cacert ${REDIS_TLS_CA_FILE} sentinel get-master-addr-by-name ${REDIS_SENTINEL_MASTER_NAME}" + else + sentinel_info_command="redis-cli -h ${REDIS_SENTINEL_HOST} -p ${REDIS_SENTINEL_PORT_NUMBER} sentinel get-master-addr-by-name ${REDIS_SENTINEL_MASTER_NAME}" + fi + REDIS_SENTINEL_INFO=($($sentinel_info_command)) + REDIS_MASTER_HOST=${REDIS_SENTINEL_INFO[0]} + REDIS_MASTER_PORT_NUMBER=${REDIS_SENTINEL_INFO[1]} + fi + wait-for-port --host "$REDIS_MASTER_HOST" "$REDIS_MASTER_PORT_NUMBER" + [[ -n "$REDIS_MASTER_PASSWORD" ]] && redis_conf_set masterauth "$REDIS_MASTER_PASSWORD" + # Starting with Redis 5, use 'replicaof' instead of 'slaveof'. Maintaining both for backward compatibility + local parameter="replicaof" + [[ $(redis_major_version) -lt 5 ]] && parameter="slaveof" + redis_conf_set "$parameter" "$REDIS_MASTER_HOST $REDIS_MASTER_PORT_NUMBER" + fi +} + +######################## +# Disable Redis command(s) +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - Array of commands to disable +# Returns: +# None +######################### +redis_disable_unsafe_commands() { + # The current syntax gets a comma separated list of commands, we split them + # before passing to redis_disable_unsafe_commands + read -r -a disabledCommands <<< "$(tr ',' ' ' <<< "$REDIS_DISABLE_COMMANDS")" + debug "Disabling commands: ${disabledCommands[*]}" + for cmd in "${disabledCommands[@]}"; do + if grep -E -q "^\s*rename-command\s+$cmd\s+\"\"\s*$" "$REDIS_CONF_FILE"; then + debug "$cmd was already disabled" + continue + fi + echo "rename-command $cmd \"\"" >> "$REDIS_CONF_FILE" + done +} + +######################## +# Redis configure perissions +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_configure_permissions() { + debug "Ensuring expected directories/files exist" + for dir in "${REDIS_BASE_DIR}" "${REDIS_DATA_DIR}" "${REDIS_BASE_DIR}/tmp" "${REDIS_LOG_DIR}"; do + ensure_dir_exists "$dir" + if am_i_root; then + chown "$REDIS_DAEMON_USER:$REDIS_DAEMON_GROUP" "$dir" + fi + done +} + +######################## +# Redis specific configuration to override the default one +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_override_conf() { + if [[ ! -e "${REDIS_MOUNTED_CONF_DIR}/redis.conf" ]]; then + # Configure Replication mode + if [[ -n "$REDIS_REPLICATION_MODE" ]]; then + redis_configure_replication + fi + fi +} + +######################## +# Ensure Redis is initialized +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_initialize() { + redis_configure_default + redis_override_conf +} + +######################## +# Configures Redis permissions and general parameters (also used in redis-cluster container) +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_configure_default() { + info "Initializing Redis" + + # This fixes an issue where the trap would kill the entrypoint.sh, if a PID was left over from a previous run + # Exec replaces the process without creating a new one, and when the container is restarted it may have the same PID + rm -f "$REDIS_BASE_DIR/tmp/redis.pid" + + redis_configure_permissions + + # User injected custom configuration + if [[ -e "${REDIS_MOUNTED_CONF_DIR}/redis.conf" ]]; then + if [[ -e "$REDIS_BASE_DIR/etc/redis-default.conf" ]]; then + rm "${REDIS_BASE_DIR}/etc/redis-default.conf" + fi + cp "${REDIS_MOUNTED_CONF_DIR}/redis.conf" "${REDIS_BASE_DIR}/etc/redis.conf" + else + info "Setting Redis config file" + is_boolean_yes "$REDIS_ALLOW_REMOTE_CONNECTIONS" && redis_conf_set bind 0.0.0.0 # Allow remote connections + # Enable AOF https://redis.io/topics/persistence#append-only-file + # Leave default fsync (every second) + redis_conf_set appendonly "${REDIS_AOF_ENABLED}" + redis_conf_set port "$REDIS_PORT_NUMBER" + # TLS configuration + if is_boolean_yes "$REDIS_TLS_ENABLED"; then + if [[ "$REDIS_PORT_NUMBER" == "6379" ]] && [[ "$REDIS_TLS_PORT" == "6379" ]]; then + # If both ports are set to default values, enable TLS traffic only + redis_conf_set port 0 + redis_conf_set tls-port "$REDIS_TLS_PORT" + else + # Different ports were specified + redis_conf_set tls-port "$REDIS_TLS_PORT" + fi + redis_conf_set tls-cert-file "$REDIS_TLS_CERT_FILE" + redis_conf_set tls-key-file "$REDIS_TLS_KEY_FILE" + redis_conf_set tls-ca-cert-file "$REDIS_TLS_CA_FILE" + [[ -n "$REDIS_TLS_DH_PARAMS_FILE" ]] && redis_conf_set tls-dh-params-file "$REDIS_TLS_DH_PARAMS_FILE" + redis_conf_set tls-auth-clients "$REDIS_TLS_AUTH_CLIENTS" + fi + if [[ -n "$REDIS_PASSWORD" ]]; then + redis_conf_set requirepass "$REDIS_PASSWORD" + else + redis_conf_unset requirepass + fi + if [[ -n "$REDIS_DISABLE_COMMANDS" ]]; then + redis_disable_unsafe_commands + fi + fi +} diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh new file mode 100644 index 0000000..4092e0f --- /dev/null +++ b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh @@ -0,0 +1,112 @@ +#!/bin/bash +# +# Environment configuration for redis + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +# Load logging library +. /opt/bitnami/scripts/liblog.sh + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-redis}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# By setting an environment variable matching *_FILE to a file path, the prefixed environment +# variable will be overridden with the value specified in that file +redis_env_vars=( + REDIS_DATA_DIR + REDIS_DISABLE_COMMANDS + REDIS_DATABASE + REDIS_AOF_ENABLED + REDIS_MASTER_HOST + REDIS_MASTER_PORT_NUMBER + REDIS_PORT_NUMBER + REDIS_ALLOW_REMOTE_CONNECTIONS + REDIS_REPLICATION_MODE + REDIS_REPLICA_IP + REDIS_REPLICA_PORT + ALLOW_EMPTY_PASSWORD + REDIS_PASSWORD + REDIS_MASTER_PASSWORD + REDIS_TLS_ENABLED + REDIS_TLS_PORT_NUMBER + REDIS_TLS_CERT_FILE + REDIS_TLS_KEY_FILE + REDIS_TLS_CA_FILE + REDIS_TLS_DH_PARAMS_FILE + REDIS_TLS_AUTH_CLIENTS + REDIS_SENTINEL_MASTER_NAME + REDIS_SENTINEL_HOST + REDIS_SENTINEL_PORT_NUMBER + REDIS_TLS_PORT +) +for env_var in "${redis_env_vars[@]}"; do + file_env_var="${env_var}_FILE" + if [[ -n "${!file_env_var:-}" ]]; then + if [[ -r "${!file_env_var:-}" ]]; then + export "${env_var}=$(< "${!file_env_var}")" + unset "${file_env_var}" + else + warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable." + fi + fi +done +unset redis_env_vars + +# Paths +export REDIS_VOLUME_DIR="/bitnami/redis" +export REDIS_BASE_DIR="${BITNAMI_ROOT_DIR}/redis" +export REDIS_CONF_DIR="${REDIS_BASE_DIR}/etc" +export REDIS_DATA_DIR="${REDIS_DATA_DIR:-${REDIS_VOLUME_DIR}/data}" +export REDIS_MOUNTED_CONF_DIR="${REDIS_BASE_DIR}/mounted-etc" +export REDIS_CONF_FILE="${REDIS_CONF_DIR}/redis.conf" +export REDIS_LOG_DIR="${REDIS_BASE_DIR}/logs" +export REDIS_LOG_FILE="${REDIS_LOG_DIR}/redis.log" +export REDIS_TMP_DIR="${REDIS_BASE_DIR}/tmp" +export REDIS_PID_FILE="${REDIS_TMP_DIR}/redis.pid" +export REDIS_BIN_DIR="${REDIS_BASE_DIR}/bin" +export PATH="${REDIS_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" + +# System users (when running with a privileged user) +export REDIS_DAEMON_USER="redis" +export REDIS_DAEMON_GROUP="redis" + +# Redis settings +export REDIS_DISABLE_COMMANDS="${REDIS_DISABLE_COMMANDS:-}" +export REDIS_DATABASE="${REDIS_DATABASE:-redis}" +export REDIS_AOF_ENABLED="${REDIS_AOF_ENABLED:-yes}" +export REDIS_MASTER_HOST="${REDIS_MASTER_HOST:-}" +export REDIS_MASTER_PORT_NUMBER="${REDIS_MASTER_PORT_NUMBER:-6379}" +export REDIS_DEFAULT_PORT_NUMBER="6379" # only used at build time +export REDIS_PORT_NUMBER="${REDIS_PORT_NUMBER:-$REDIS_DEFAULT_PORT_NUMBER}" +export REDIS_ALLOW_REMOTE_CONNECTIONS="${REDIS_ALLOW_REMOTE_CONNECTIONS:-yes}" +export REDIS_REPLICATION_MODE="${REDIS_REPLICATION_MODE:-}" +export REDIS_REPLICA_IP="${REDIS_REPLICA_IP:-}" +export REDIS_REPLICA_PORT="${REDIS_REPLICA_PORT:-}" +export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}" +export REDIS_PASSWORD="${REDIS_PASSWORD:-}" +export REDIS_MASTER_PASSWORD="${REDIS_MASTER_PASSWORD:-}" + +# TLS settings +export REDIS_TLS_ENABLED="${REDIS_TLS_ENABLED:-no}" +REDIS_TLS_PORT_NUMBER="${REDIS_TLS_PORT_NUMBER:-"${REDIS_TLS_PORT:-}"}" +export REDIS_TLS_PORT_NUMBER="${REDIS_TLS_PORT_NUMBER:-6379}" +export REDIS_TLS_CERT_FILE="${REDIS_TLS_CERT_FILE:-}" +export REDIS_TLS_KEY_FILE="${REDIS_TLS_KEY_FILE:-}" +export REDIS_TLS_CA_FILE="${REDIS_TLS_CA_FILE:-}" +export REDIS_TLS_DH_PARAMS_FILE="${REDIS_TLS_DH_PARAMS_FILE:-}" +export REDIS_TLS_AUTH_CLIENTS="${REDIS_TLS_AUTH_CLIENTS:-yes}" + +# Redis Sentinel cluster settings +export REDIS_SENTINEL_MASTER_NAME="${REDIS_SENTINEL_MASTER_NAME:-}" +export REDIS_SENTINEL_HOST="${REDIS_SENTINEL_HOST:-}" +export REDIS_SENTINEL_PORT_NUMBER="${REDIS_SENTINEL_PORT_NUMBER:-26379}" + +# Custom environment variables may be defined below diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh new file mode 100755 index 0000000..b50f640 --- /dev/null +++ b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load Redis environment variables +. /opt/bitnami/scripts/redis-env.sh + +# Load libraries +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/libredis.sh + +print_welcome_page + +if [[ "$*" = *"/opt/bitnami/scripts/redis/run.sh"* || "$*" = *"/run.sh"* ]]; then + info "** Starting Redis setup **" + /opt/bitnami/scripts/redis/setup.sh + info "** Redis setup finished! **" +fi + +echo "" +exec "$@" diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh new file mode 100755 index 0000000..52254db --- /dev/null +++ b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh @@ -0,0 +1,29 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load Redis environment variables +. /opt/bitnami/scripts/redis-env.sh + +# Load libraries +. /opt/bitnami/scripts/libredis.sh +. /opt/bitnami/scripts/libfs.sh + +for dir in "$REDIS_VOLUME_DIR" "$REDIS_DATA_DIR" "$REDIS_BASE_DIR" "$REDIS_CONF_DIR"; do + ensure_dir_exists "$dir" +done +chmod -R g+rwX /bitnami "$REDIS_VOLUME_DIR" "$REDIS_BASE_DIR" + +cp "${REDIS_BASE_DIR}/etc/redis-default.conf" "$REDIS_CONF_FILE" +chmod g+rw "$REDIS_CONF_FILE" +# Default Redis config +info "Setting Redis config file..." +redis_conf_set port "$REDIS_DEFAULT_PORT_NUMBER" +redis_conf_set dir "$REDIS_DATA_DIR" +redis_conf_set pidfile "$REDIS_PID_FILE" +redis_conf_set daemonize yes diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh new file mode 100755 index 0000000..30c3a63 --- /dev/null +++ b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load Redis environment variables +. /opt/bitnami/scripts/redis-env.sh + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libredis.sh + +# Constants +REDIS_EXTRA_FLAGS=${REDIS_EXTRA_FLAGS:-} + +# Parse CLI flags to pass to the 'redis-server' call +args=("$REDIS_BASE_DIR/etc/redis.conf" "--daemonize" "no") +# Add flags specified via the 'REDIS_EXTRA_FLAGS' environment variable +read -r -a extra_flags <<< "$REDIS_EXTRA_FLAGS" +[[ "${#extra_flags[@]}" -gt 0 ]] && args+=("${extra_flags[@]}") +# Add flags passed to this script +args+=("$@") + +info "** Starting Redis **" +if am_i_root; then + exec gosu "$REDIS_DAEMON_USER" redis-server "${args[@]}" +else + exec redis-server "${args[@]}" +fi diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh new file mode 100755 index 0000000..d54a3cf --- /dev/null +++ b/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load Redis environment variables +. /opt/bitnami/scripts/redis-env.sh + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libredis.sh + +# Ensure Redis environment variables settings are valid +redis_validate +# Ensure Redis daemon user exists when running as root +am_i_root && ensure_user_exists "$REDIS_DAEMON_USER" --group "$REDIS_DAEMON_GROUP" +# Ensure Redis is initialized +redis_initialize diff --git a/6.0/debian-10/Dockerfile b/6.0/debian-10/Dockerfile new file mode 100644 index 0000000..91dc148 --- /dev/null +++ b/6.0/debian-10/Dockerfile @@ -0,0 +1,56 @@ +ARG BASE_REGISTRY=registry1.dsop.io +ARG BASE_IMAGE=ironbank/redhat/openjdk/openjdk11 +ARG BASE_TAG=1.11 + +FROM bitnami/redis:6.0.4 as base +FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} as staging +ARG BITNAMI_HOME=/opt/bitnami +USER 0 +RUN mkdir /staging +COPY --from=base ${BITNAMI_HOME} /staging +RUN rm -rf /staging/java + +FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} +ARG PKG=redis +ARG BITNAMI_HOME=/opt/bitnami +ARG REDIS_HOME=${BITNAMI_HOME}/redis + +ARG REDIS_USER_ID="1001" +ARG REDIS_USER_NAME=${PKG} + +ENV REDIS_CONFIG_DIR=${REDIS_HOME}/config \ + REDIS_SERVER_HOME=${REDIS_HOME} \ + REDIS_BROKER_ID=0 \ + REDIS_LOG_DIRS=/tmp/redis-logs \ + REDIS_OFFSETS_TOPIC_REPLICATION_FACTOR=1 \ + REDIS_TRANSACTION_STATE_LOG_REPLICATION_FACTOR=1 \ + REDIS_TRANSACTION_STATE_LOG_MIN_ISR=1 \ + BITNAMI_APP_NAME=redis \ + PATH="${REDIS_HOME}/bin:/opt/bitnami/common/bin:$PATH" + +USER 0 + +RUN dnf update -y --nodocs && \ + dnf clean all && \ + rm -rf /var/cache/dnf && \ + mkdir -p ${BITNAMI_HOME} && \ + mkdir /docker-entrypoint-initdb.d + +COPY --from=staging /staging ${BITNAMI_HOME} +COPY scripts ${BITNAMI_HOME}/scripts + +RUN ln -s ${BITNAMI_HOME}/scripts/redis/entrypoint.sh /entrypoint.sh && \ + ln -s ${BITNAMI_HOME}/scripts/redis/run.sh /run.sh && \ + useradd -u ${REDIS_USER_ID} -g 0 -M -d ${REDIS_HOME} ${REDIS_USER_NAME} && \ + chown -R ${REDIS_USER_NAME}:0 ${REDIS_HOME} + +USER ${REDIS_USER_ID} + +WORKDIR ${REDIS_HOME} + +EXPOSE 6379 + +HEALTHCHECK --interval=10s --timeout=5s --retries=3 CMD zkServer.sh status || exit 1 + +ENTRYPOINT [ "/opt/bitnami/scripts/redis/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/redis/run.sh" ] diff --git a/6.0/debian-10/docker-compose.yml b/6.0/debian-10/docker-compose.yml new file mode 100644 index 0000000..cb198cb --- /dev/null +++ b/6.0/debian-10/docker-compose.yml @@ -0,0 +1,17 @@ +version: '2' + +services: + redis: + image: 'docker.io/bitnami/redis:6.0-debian-10' + environment: + # ALLOW_EMPTY_PASSWORD is recommended only for development. + - ALLOW_EMPTY_PASSWORD=yes + - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL + ports: + - '6379:6379' + volumes: + - 'redis_data:/bitnami/redis/data' + +volumes: + redis_data: + driver: local diff --git a/6.0/debian-10/hardening_manifest.yaml b/6.0/debian-10/hardening_manifest.yaml new file mode 100644 index 0000000..6060994 --- /dev/null +++ b/6.0/debian-10/hardening_manifest.yaml @@ -0,0 +1,47 @@ +--- +apiVersion: v1 + +# The repository name in registry1, excluding /ironbank/ +name: "bitnami/redis" + +# List of tags to push for the repository in registry1 +# The most specific version should be the first tag and will be shown +# on ironbank.dsop.io +tags: +- "3.6.2" + +# Build args passed to Dockerfile ARGs +args: + BASE_IMAGE: "redhat/openjdk/openjdk11" + BASE_TAG: "1.11" + +# Docker image labels +labels: + org.opencontainers.image.title: "redis" + ## Human-readable description of the software packaged in the image + org.opencontainers.image.description: "Apache Redis® is a distributed streaming platform." + ## License(s) under which contained software is distributed + org.opencontainers.image.licenses: "Apache-2.0" + ## URL to find more information on the image + org.opencontainers.image.url: "https://bitnami.com/stack/redis/containers" + ## Name of the distributing entity, organization or individual + org.opencontainers.image.vendor: "Bitnami" + org.opencontainers.image.version: "3.6.2" + ## Keywords to help with search (ex. "cicd,gitops,golang") + mil.dso.ironbank.image.keywords: "dataflow,streaming" + ## This value can be "opensource" or "commercial" + mil.dso.ironbank.image.type: "opensource" + ## Product the image belongs to for grouping multiple images + mil.dso.ironbank.product.name: "Redis" + +# List of resources to make available to the offline build context +resources: +- tag: bitnami/redis:6.0.4 + url: docker://docker.io/bitnami/redis@sha256:b9e6ff6325a798c7c7c1cf0d45724f3c490d2916b0725f7151873f54d1275203 + +# List of project maintainers +maintainers: +- name: "Chris Recla" + username: "crecla" + email: "chrisrecla@seed-innovations.com" + cht_member: false \ No newline at end of file diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json b/6.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json new file mode 100644 index 0000000..90a9989 --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json @@ -0,0 +1,23 @@ +{ + "gosu": { + "arch": "amd64", + "digest": "4d858ac600c38af8de454c27b7f65c0074ec3069880cb16d259a6e40a46bbc50", + "distro": "debian-10", + "type": "NAMI", + "version": "1.12.0-2" + }, + "redis": { + "arch": "amd64", + "digest": "ceac371afa2fe829fb0ca26cbd6a90c17536293f3f65182da37e7a5cb01d9aa2", + "distro": "debian-10", + "type": "NAMI", + "version": "6.0.10-0" + }, + "wait-for-port": { + "arch": "amd64", + "digest": "7521d9a4f9e4e182bf32977e234026caa7b03759799868335bccb1edd8f8fd12", + "distro": "debian-10", + "type": "NAMI", + "version": "1.0.0-3" + } +} \ No newline at end of file diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt b/6.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 0000000..c76ba31 --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,3 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/nami/COPYING +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 0000000..ef29e36 --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# +# Bitnami custom library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Constants +BOLD='\033[1m' + +# Functions + +######################## +# Print the welcome page +# Globals: +# DISABLE_WELCOME_MESSAGE +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_welcome_page() { + if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then + if [[ -n "$BITNAMI_APP_NAME" ]]; then + print_image_welcome_page + fi + fi +} + +######################## +# Print the welcome page for a Bitnami Docker image +# Globals: +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_image_welcome_page() { + local github_url="https://github.com/bitnami/bitnami-docker-${BITNAMI_APP_NAME}" + + log "" + log "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + log "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" + log "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" + log "" +} + diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh new file mode 100644 index 0000000..1d8c6bf --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh @@ -0,0 +1,65 @@ +#!/bin/bash +# +# Library for managing Bitnami components + +# Constants +CACHE_ROOT="/tmp/bitnami/pkg/cache" +DOWNLOAD_URL="https://downloads.bitnami.com/files/stacksmith" + +# Functions + +######################## +# Download and unpack a Bitnami package +# Globals: +# OS_NAME +# OS_ARCH +# OS_FLAVOUR +# Arguments: +# $1 - component's name +# $2 - component's version +# Returns: +# None +######################### +component_unpack() { + local name="${1:?name is required}" + local version="${2:?version is required}" + local base_name="${name}-${version}-${OS_NAME}-${OS_ARCH}-${OS_FLAVOUR}" + local package_sha256="" + local directory="/opt/bitnami" + + # Validate arguments + shift 2 + while [ "$#" -gt 0 ]; do + case "$1" in + -c|--checksum) + shift + package_sha256="${1:?missing package checksum}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + echo "Downloading $base_name package" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz" ]; then + echo "${CACHE_ROOT}/${base_name}.tar.gz already exists, skipping download." + cp "${CACHE_ROOT}/${base_name}.tar.gz" . + rm "${CACHE_ROOT}/${base_name}.tar.gz" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz.sha256" ]; then + echo "Using the local sha256 from ${CACHE_ROOT}/${base_name}.tar.gz.sha256" + package_sha256="$(< "${CACHE_ROOT}/${base_name}.tar.gz.sha256")" + rm "${CACHE_ROOT}/${base_name}.tar.gz.sha256" + fi + else + curl --remote-name --silent "${DOWNLOAD_URL}/${base_name}.tar.gz" + fi + if [ -n "$package_sha256" ]; then + echo "Verifying package integrity" + echo "$package_sha256 ${base_name}.tar.gz" | sha256sum --check - + fi + tar --directory "${directory}" --extract --gunzip --file "${base_name}.tar.gz" --no-same-owner --strip-components=2 "${base_name}/files/" + rm "${base_name}.tar.gz" +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 0000000..b09575c --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,80 @@ +#!/bin/bash +# +# Library for managing files + +# Functions + +######################## +# Replace a regex in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# $4 - use POSIX regex. Default: true +# Returns: +# None +######################### +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 + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + if [[ $posix_regex = true ]]; then + result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + else + result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Remove a line in a file based on a regex +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - use POSIX regex. Default: true +# Returns: +# None +######################### +remove_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local posix_regex=${3:-true} + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + if [[ $posix_regex = true ]]; then + result="$(sed -E "/$match_regex/d" "$filename")" + else + result="$(sed "/$match_regex/d" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Appends text after the last line matching a pattern +# Arguments: +# $1 - file +# $2 - match regex +# $3 - contents to add +# Returns: +# None +######################### +append_file_after_last_match() { + local file="${1:?missing file}" + local match_regex="${2:?missing pattern}" + local value="${3:?missing value}" + + # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again + result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" + echo "$result" > "$file" +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 0000000..8f37ecb --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,183 @@ +#!/bin/bash +# +# Library for file system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Ensure a file/directory is owned (user and group) but the given user +# Arguments: +# $1 - filepath +# $2 - owner +# Returns: +# None +######################### +owned_by() { + local path="${1:?path is missing}" + local owner="${2:?owner is missing}" + + chown "$owner":"$owner" "$path" +} + +######################## +# Ensure a directory exists and, optionally, is owned by the given user +# Arguments: +# $1 - directory +# $2 - owner +# Returns: +# None +######################### +ensure_dir_exists() { + local dir="${1:?directory is missing}" + local owner="${2:-}" + + mkdir -p "${dir}" + if [[ -n $owner ]]; then + owned_by "$dir" "$owner" + fi +} + +######################## +# Checks whether a directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_dir_empty() { + local dir="${1:?missing directory}" + + if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then + true + else + false + fi +} + +######################## +# Checks whether a mounted directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_mounted_dir_empty() { + local dir="${1:?missing directory}" + + if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then + true + else + false + fi +} + +######################## +# Checks whether a file can be written to or not +# arguments: +# $1 - file +# returns: +# boolean +######################### +is_file_writable() { + local file="${1:?missing file}" + local dir + dir="$(dirname "$file")" + + if [[ ( -f "$file" && -w "$file" ) || ( ! -f "$file" && -d "$dir" && -w "$dir" ) ]]; then + true + else + false + fi +} + +######################## +# Relativize a path +# arguments: +# $1 - path +# $2 - base +# returns: +# None +######################### +relativize() { + local -r path="${1:?missing path}" + local -r base="${2:?missing base}" + pushd "$base" >/dev/null + realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' + popd >/dev/null +} + +######################## +# Configure permisions and ownership recursively +# Globals: +# None +# Arguments: +# $1 - paths (as a string). +# Flags: +# -f|--file-mode - mode for directories. +# -d|--dir-mode - mode for files. +# -u|--user - user +# -g|--group - group +# Returns: +# None +######################### +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}" + ;; + *) + echo "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 + if [[ -n $dir_mode ]]; then + find -L "$p" -type d -exec chmod "$dir_mode" {} \; + fi + if [[ -n $file_mode ]]; then + find -L "$p" -type f -exec chmod "$file_mode" {} \; + fi + if [[ -n $user ]] && [[ -n $group ]]; then + chown -LR "$user":"$group" "$p" + elif [[ -n $user ]] && [[ -z $group ]]; then + chown -LR "$user" "$p" + elif [[ -z $user ]] && [[ -n $group ]]; then + chgrp -LR "$group" "$p" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 0000000..9694852 --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,16 @@ +#!/bin/bash +# +# Library to use for scripts expected to be used as Kubernetes lifecycle hooks + +# shellcheck disable=SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh + +# Override functions that log to stdout/stderr of the current process, so they print to process 1 +for function_to_override in stderr_print debug_execute; do + # Output is sent to output of process 1 and thus end up in the container log + # The hook output in general isn't saved + eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2" +done diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 0000000..60ec4cb --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,110 @@ +#!/bin/bash +# +# Library for logging functions + +# Constants +RESET='\033[0m' +RED='\033[38;5;1m' +GREEN='\033[38;5;2m' +YELLOW='\033[38;5;3m' +MAGENTA='\033[38;5;5m' +CYAN='\033[38;5;6m' + +# Functions + +######################## +# Print to STDERR +# Arguments: +# Message to print +# Returns: +# None +######################### +stderr_print() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_QUIET:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if ! [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + printf "%b\\n" "${*}" >&2 + fi +} + +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +log() { + stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" +} +######################## +# Log an 'info' message +# Arguments: +# Message to log +# Returns: +# None +######################### +info() { + log "${GREEN}INFO ${RESET} ==> ${*}" +} +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +warn() { + log "${YELLOW}WARN ${RESET} ==> ${*}" +} +######################## +# Log an 'error' message +# Arguments: +# Message to log +# Returns: +# None +######################### +error() { + log "${RED}ERROR${RESET} ==> ${*}" +} +######################## +# Log a 'debug' message +# Globals: +# BITNAMI_DEBUG +# Arguments: +# None +# Returns: +# None +######################### +debug() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_DEBUG:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + log "${MAGENTA}DEBUG${RESET} ==> ${*}" + fi +} + +######################## +# Indent a string +# Arguments: +# $1 - string +# $2 - number of indentation characters (default: 4) +# $3 - indentation character (default: " ") +# Returns: +# None +######################### +indent() { + local string="${1:-}" + local num="${2:?missing num}" + local char="${3:-" "}" + # Build the indentation unit string + local indent_unit="" + for ((i = 0; i < num; i++)); do + indent_unit="${indent_unit}${char}" + done + echo "$string" | sed "s/^/${indent_unit}/" +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 0000000..4391dac --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,142 @@ +#!/bin/bash +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Resolve IP address for a host/domain (i.e. DNS lookup) +# Arguments: +# $1 - Hostname to resolve +# $2 - IP address version (v4, v6), leave empty for resolving to any version +# Returns: +# IP +######################### +dns_lookup() { + local host="${1:?host is missing}" + local ip_version="${2:-}" + getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1 +} + +######################### +# Wait for a hostname and return the IP +# Arguments: +# $1 - hostname +# $2 - number of retries +# $3 - seconds to wait between retries +# Returns: +# - IP address that corresponds to the hostname +######################### +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" +} + +######################## +# Get machine's IP +# Arguments: +# None +# Returns: +# Machine IP +######################### +get_machine_ip() { + local -a ip_addresses + local hostname + hostname="$(hostname)" + read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" + if [[ "${#ip_addresses[@]}" -gt 1 ]]; then + warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" + elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then + error "Could not find any IP address associated to hostname ${hostname}" + exit 1 + fi + echo "${ip_addresses[0]}" +} + +######################## +# Check if the provided argument is a resolved hostname +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_hostname_resolved() { + local -r host="${1:?missing value}" + if [[ -n "$(dns_lookup "$host")" ]]; then + true + else + false + fi +} + +######################## +# Parse URL +# Globals: +# None +# Arguments: +# $1 - uri - String +# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String +# Returns: +# String +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}]}" +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 0000000..6a75122 --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,350 @@ +#!/bin/bash +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh + +# Functions + +######################## +# Check if an user exists in the system +# Arguments: +# $1 - user +# Returns: +# Boolean +######################### +user_exists() { + local user="${1:?user is missing}" + id "$user" >/dev/null 2>&1 +} + +######################## +# Check if a group exists in the system +# Arguments: +# $1 - group +# Returns: +# Boolean +######################### +group_exists() { + local group="${1:?group is missing}" + getent group "$group" >/dev/null 2>&1 +} + +######################## +# Create a group in the system if it does not exist already +# Arguments: +# $1 - group +# Flags: +# -s|--system - Whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -s|--system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! group_exists "$group"; then + local -a args=("$group") + $is_system_user && args+=("--system") + groupadd "${args[@]}" >/dev/null 2>&1 + fi +} + +######################## +# Create an user in the system if it does not exist already +# Arguments: +# $1 - user +# Flags: +# -g|--group - the group the new user should belong to +# -h|--home - the home directory for the new user +# -s|--system - whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_user_exists() { + local user="${1:?user is missing}" + local group="" + local home="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -g|--group) + shift + group="${1:?missing group}" + ;; + -h|--home) + shift + home="${1:?missing home directory}" + ;; + -s|--system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! user_exists "$user"; then + local -a user_args=("-N" "$user") + $is_system_user && user_args+=("--system") + useradd "${user_args[@]}" >/dev/null 2>&1 + fi + + if [[ -n "$group" ]]; then + local -a group_args=("$group") + $is_system_user && group_args+=("--system") + ensure_group_exists "${group_args[@]}" + usermod -g "$group" "$user" >/dev/null 2>&1 + fi + + if [[ -n "$home" ]]; then + mkdir -p "$home" + usermod -d "$home" "$user" >/dev/null 2>&1 + configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group" + fi +} + +######################## +# Check if the script is currently running as root +# Arguments: +# $1 - user +# $2 - group +# Returns: +# Boolean +######################### +am_i_root() { + if [[ "$(id -u)" = "0" ]]; then + true + else + false + fi +} + +######################## +# Get total memory available +# Arguments: +# None +# Returns: +# Memory in bytes +######################### +get_total_memory() { + echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024)) +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# None +# Flags: +# --memory - memory size (optional) +# Returns: +# Detected instance size +######################### +get_machine_size() { + local memory="" + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + --memory) + shift + memory="${1:?missing memory}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + 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 machine size depending on specified memory +# Globals: +# None +# Arguments: +# $1 - memory size (optional) +# Returns: +# Detected instance size +######################### +get_supported_machine_sizes() { + echo micro small medium large xlarge 2xlarge +} + +######################## +# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048) +# Globals: +# None +# Arguments: +# $1 - memory size +# Returns: +# Result of the conversion +######################### +convert_to_mb() { + local amount="${1:-}" + if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then + size="${BASH_REMATCH[1]}" + unit="${BASH_REMATCH[2]}" + if [[ "$unit" = "g" || "$unit" = "G" ]]; then + amount="$((size * 1024))" + else + amount="$size" + fi + fi + echo "$amount" +} + + +######################### +# Redirects output to /dev/null if debug mode is disabled +# Globals: +# BITNAMI_DEBUG +# Arguments: +# $@ - Command to execute +# Returns: +# None +######################### +debug_execute() { + if ${BITNAMI_DEBUG:-false}; then + "$@" + else + "$@" >/dev/null 2>&1 + fi +} + +######################## +# Retries a command a given number of times +# Arguments: +# $1 - cmd (as a string) +# $2 - max retries. Default: 12 +# $3 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +retry_while() { + local cmd="${1:?cmd is missing}" + local retries="${2:-12}" + local 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 +} + +######################## +# Generate a random string +# Arguments: +# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii +# -c|--count - Number of characters, defaults to 32 +# Arguments: +# None +# Returns: +# None +# Returns: +# String +######################### +generate_random_string() { + local type="ascii" + local count="32" + local filter + local result + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + -t|--type) + shift + type="$1" + ;; + -c|--count) + shift + count="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Validate type + case "$type" in + ascii) + filter="[:print:]" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + numeric) + filter="0-9" + ;; + *) + echo "Invalid type ${type}" >&2 + return 1 + esac + # Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size + # Note there is a very small chance of strings starting with EOL character + # Therefore, the higher amount of lines read, this will happen less frequently + result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")" + echo "$result" +} + +######################## +# Create md5 hash from a string +# Arguments: +# $1 - string +# Returns: +# md5 hash - string +######################### +generate_md5_hash() { + local -r str="${1:?missing input string}" + echo -n "$str" | md5sum | awk '{print $1}' +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 0000000..452c1f4 --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,122 @@ +#!/bin/bash +# +# Bitnami persistence library +# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libversion.sh + +# Functions + +######################## +# Persist an application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# $2 - List of app files to persist +# Returns: +# true if all steps succeeded, false otherwise +######################### +persist_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_persist <<< "$2" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Persist the individual files + if [[ "${#files_to_persist[@]}" -lt 0 ]]; then + warn "No files are configured to be persisted" + return + fi + pushd "$install_dir" >/dev/null + local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder + local -r tmp_file="/tmp/perms.acl" + for file_to_persist in "${files_to_persist[@]}"; do + if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then + error "Cannot persist '${file_to_persist}' because it does not exist" + return 1 + fi + file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")" + file_to_persist_destination="${persist_dir}/${file_to_persist_relative}" + file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")" + # Get original permissions for existing files, which will be applied later + # Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume + getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file" + # Copy directories to the volume + ensure_dir_exists "$file_to_persist_destination_folder" + cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder" + # Restore permissions + pushd "$persist_dir" >/dev/null + if am_i_root; then + setfacl --restore="$tmp_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file") + fi + popd >/dev/null + done + popd >/dev/null + rm -f "$tmp_file" + # Install the persisted files into the installation directory, via symlinks + restore_persisted_app "$@" +} + +######################## +# Restore a persisted application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# FORCE_MAJOR_UPGRADE +# Arguments: +# $1 - App folder name +# $2 - List of app files to restore +# Returns: +# true if all steps succeeded, false otherwise +######################### +restore_persisted_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_restore <<< "$2" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Restore the individual persisted files + if [[ "${#files_to_restore[@]}" -lt 0 ]]; then + warn "No persisted files are configured to be restored" + return + fi + local file_to_restore_relative file_to_restore_origin file_to_restore_destination + for file_to_restore in "${files_to_restore[@]}"; do + file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")" + # We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed + file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")" + file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")" + rm -rf "$file_to_restore_origin" + ln -sfn "$file_to_restore_destination" "$file_to_restore_origin" + done +} + +######################## +# Check if an application directory was already persisted +# Globals: +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# Returns: +# true if all steps succeeded, false otherwise +######################### +is_app_initialized() { + local -r app="${1:?missing app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + if ! is_mounted_dir_empty "$persist_dir"; then + true + else + false + fi +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 0000000..55e1dfc --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,225 @@ +#!/bin/bash +# +# Library for managing services + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Read the provided pid file and returns a PID +# Arguments: +# $1 - Pid file +# Returns: +# 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 +} + +######################## +# Check if a provided PID corresponds to a running service +# Arguments: +# $1 - PID +# Returns: +# Boolean +######################### +is_service_running() { + local pid="${1:?pid is missing}" + + kill -0 "$pid" 2>/dev/null +} + +######################## +# Stop a service by sending a termination signal to its pid +# Arguments: +# $1 - Pid file +# $2 - Signal number (optional) +# Returns: +# None +######################### +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 +} + +######################## +# Start cron daemon +# Arguments: +# None +# Returns: +# true if started correctly, false otherwise +######################### +cron_start() { + if [[ -x "/usr/sbin/cron" ]]; then + /usr/sbin/cron + elif [[ -x "/usr/sbin/crond" ]]; then + /usr/sbin/crond + else + false + fi +} + +######################## +# Generate a cron configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Command +# Flags: +# --run-as - User to run as (default: root) +# --schedule - Cron schedule configuration (default: * * * * *) +# Returns: +# None +######################### +generate_cron_conf() { + local service_name="${1:?service name is missing}" + local cmd="${2:?command is missing}" + local run_as="root" + local schedule="* * * * *" + + # Parse optional CLI flags + shift 2 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --run-as) + shift + run_as="$1" + ;; + --schedule) + shift + schedule="$1" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + mkdir -p /etc/cron.d + echo "${schedule} ${run_as} ${cmd}" > /etc/cron.d/"$service_name" +} + +######################## +# Generate a monit configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Pid file +# $3 - Start command +# $4 - Stop command +# Flags: +# --disabled - Whether to disable the monit configuration +# Returns: +# None +######################### +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:-}" <&2 + return 1 + ;; + esac + shift + done + + mkdir -p "$logrotate_conf_dir" + cat <"${logrotate_conf_dir}/${service_name}" +${log_path} { + ${period} + rotate ${rotations} + dateext + compress + copytruncate + missingok +$(indent "$extra" 2) +} +EOF +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh new file mode 100644 index 0000000..8d82792 --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh @@ -0,0 +1,248 @@ +#!/bin/bash +# +# Validation functions library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Check if the provided argument is an integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_int() { + local -r int="${1:?missing value}" + if [[ "$int" =~ ^-?[0-9]+ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a positive integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_positive_int() { + local -r int="${1:?missing value}" + if is_int "$int" && (( "${int}" >= 0 )); then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean or is the string 'yes/true' +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +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 +} + +######################## +# Check if the provided argument is a boolean yes/no value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_yes_no_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(yes|no)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean true/false value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_true_false_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(true|false)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is an empty string or not defined +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_empty_value() { + local -r val="${1:-}" + if [[ -z "$val" ]]; then + true + else + false + fi +} + +######################## +# Validate if the provided argument is a valid port +# Arguments: +# $1 - Port to validate +# Returns: +# Boolean and error message +######################### +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 +} + +######################## +# Validate if the provided argument is a valid IPv4 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +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 +} + +######################## +# Validate a string format +# Arguments: +# $1 - String to validate +# Returns: +# Boolean +######################### +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 +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 0000000..66d4f45 --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,49 @@ +#!/bin/bash +# +# Library for managing versions strings + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions +######################## +# Gets semantic version +# Arguments: +# $1 - version: string to extract major.minor.patch +# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch +# Returns: +# array with the major, minor and release +######################### +get_sematic_version () { + local version="${1:?version is required}" + local section="${2:?section is required}" + local -a version_sections + + #Regex to parse versions: x.y.z + local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?' + + if [[ "$version" =~ $regex ]]; then + local i=1 + local j=1 + local n=${#BASH_REMATCH[*]} + + while [[ $i -lt $n ]]; do + if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then + version_sections[$j]=${BASH_REMATCH[$i]} + ((j++)) + fi + ((i++)) + done + + local number_regex='^[0-9]+$' + if [[ "$section" =~ $number_regex ]] && (( $section > 0 )) && (( $section <= 3 )); then + echo "${version_sections[$section]}" + return + else + stderr_print "Section allowed values are: 1, 2, and 3" + return 1 + fi + fi +} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 0000000..25bff4a --- /dev/null +++ b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,421 @@ +#!/bin/bash +# +# Bitnami web server handler library + +# shellcheck disable=SC1090,SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh + +######################## +# Execute a command (or list of commands) with the web server environment and library loaded +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_execute() { + local -r web_server="${1:?missing web server}" + shift + # Run program in sub-shell to avoid web server environment getting loaded when not necessary + ( + . "/opt/bitnami/scripts/lib${web_server}.sh" + . "/opt/bitnami/scripts/${web_server}-env.sh" + "$@" + ) +} + +######################## +# Prints the list of enabled web servers +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_list() { + local -r -a supported_web_servers=(apache nginx) + local -a existing_web_servers=() + for web_server in "${supported_web_servers[@]}"; do + [[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server") + done + echo "${existing_web_servers[@]:-}" +} + +######################## +# Prints the currently-enabled web server type (only one, in order of preference) +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_type() { + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + echo "${web_servers[0]:-}" +} + +######################## +# Validate that a supported web server is configured +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_validate() { + local error_code=0 + local supported_web_servers=("apache" "nginx") + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then + print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}" + elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then + print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable." + fi + + return "$error_code" +} + +######################## +# Check whether the web server is running +# Globals: +# * +# Arguments: +# None +# Returns: +# true if the web server is running, false otherwise +######################### +is_web_server_running() { + "is_$(web_server_type)_running" +} + +######################## +# Start web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_start() { + info "Starting $(web_server_type) in background" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" +} + +######################## +# Stop web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_stop() { + info "Stopping $(web_server_type)" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" +} + +######################## +# Restart web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_restart() { + info "Restarting $(web_server_type)" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" +} + +######################## +# Reload web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_reload() { + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" +} + +######################## +# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --type - Application type, which has an effect on which configuration template to use +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disabled - Whether to render the file with a .disabled prefix +# --enable-https - Enable app configuration on HTTPS port +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --document-root - Path to document root directory +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-before-vhost-configuration - Configuration to add before the directive (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_app_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --hosts \ + | --type \ + | --allow-remote-connections \ + | --disabled \ + | --enable-https \ + | --http-port \ + | --https-port \ + | --document-root \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-before-vhost-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "${2:?missing value}") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + nginx_args+=("${1//nginx-/}" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_web_server_app_configuration_not_exists() { + local app="${1:?missing app}" + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app" + done +} + +######################## +# Ensure the web server loads the configuration for an application in a URL prefix +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --document-root - Path to document root directory +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --type - Application type, which has an effect on what configuration template will be used +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_prefix_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --allow-remote-connections \ + | --document-root \ + | --prefix \ + | --type \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "$2") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + nginx_args+=("${1//nginx-/}" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --enable-https - Update HTTPS app configuration +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +web_server_update_app_configuration() { + local app="${1:?missing app}" + shift + local -a args web_servers + args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --hosts \ + | --enable-https \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}" + done +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_enable_loading_page() { + ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \ + --apache-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +RedirectMatch 503 ^/$ +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +ErrorDocument 404 /index.html +ErrorDocument 503 /index.html" \ + --nginx-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +location / { + return 503; +} +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +error_page 404 @installing; +error_page 503 @installing; +location @installing { + rewrite ^(.*)$ /index.html break; +}" + web_server_reload +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_disable_install_page() { + ensure_web_server_app_configuration_not_exists "__loading" + web_server_reload +} diff --git a/6.0/debian-10/prebuildfs/usr/sbin/install_packages b/6.0/debian-10/prebuildfs/usr/sbin/install_packages new file mode 100755 index 0000000..c957764 --- /dev/null +++ b/6.0/debian-10/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,24 @@ +#!/bin/sh +set -e +set -u +export DEBIAN_FRONTEND=noninteractive +n=0 +max=2 +until [ $n -gt $max ]; do + set +e + ( + apt-get update -qq && + apt-get install -y --no-install-recommends "$@" + ) + CODE=$? + set -e + if [ $CODE -eq 0 ]; then + break + fi + if [ $n -eq $max ]; then + exit $CODE + fi + echo "apt failed, retrying" + n=$(($n + 1)) +done +rm -r /var/lib/apt/lists /var/cache/apt/archives diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh new file mode 100644 index 0000000..3c5dd5f --- /dev/null +++ b/6.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh @@ -0,0 +1,405 @@ +#!/bin/bash +# +# Bitnami Redis library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libnet.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Retrieve a configuration setting value +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - key +# Returns: +# None +######################### +redis_conf_get() { + local -r key="${1:?missing key}" + + if grep -q -E "^\s*$key " "${REDIS_BASE_DIR}/etc/redis.conf"; then + grep -E "^\s*$key " "${REDIS_BASE_DIR}/etc/redis.conf" | awk '{print $2}' + fi +} + +######################## +# Set a configuration setting value +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - key +# $2 - value +# Returns: +# None +######################### +redis_conf_set() { + local -r key="${1:?missing key}" + local value="${2:-}" + + # Sanitize inputs + value="${value//\\/\\\\}" + value="${value//&/\\&}" + value="${value//\?/\\?}" + [[ "$value" = "" ]] && value="\"$value\"" + + replace_in_file "${REDIS_BASE_DIR}/etc/redis.conf" "^#*\s*${key} .*" "${key} ${value}" false +} + +######################## +# Unset a configuration setting value +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - key +# Returns: +# None +######################### +redis_conf_unset() { + local -r key="${1:?missing key}" + remove_in_file "${REDIS_BASE_DIR}/etc/redis.conf" "^\s*$key .*" false +} + +######################## +# Get Redis version +# Globals: +# REDIS_BASE_DIR +# Arguments: +# None +# Returns: +# Redis versoon +######################### +redis_version() { + "${REDIS_BASE_DIR}/bin/redis-cli" --version | grep -E -o "[0-9]+.[0-9]+.[0-9]+" +} + +######################## +# Get Redis major version +# Globals: +# REDIS_BASE_DIR +# Arguments: +# None +# Returns: +# Redis major version +######################### +redis_major_version() { + redis_version | grep -E -o "^[0-9]+" +} + +######################## +# Check if redis is running +# Globals: +# REDIS_BASE_DIR +# Arguments: +# None +# Returns: +# Boolean +######################### +is_redis_running() { + local pid + pid="$(get_pid_from_file "$REDIS_BASE_DIR/tmp/redis.pid")" + + if [[ -z "$pid" ]]; then + false + else + is_service_running "$pid" + fi +} + +######################## +# Check if redis is not running +# Globals: +# REDIS_BASE_DIR +# Arguments: +# None +# Returns: +# Boolean +######################### +is_redis_not_running() { + ! is_redis_running +} + +######################## +# Stop Redis +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_stop() { + local pass + local port + local args + + ! is_redis_running && return + pass="$(redis_conf_get "requirepass")" + is_boolean_yes "$REDIS_TLS_ENABLED" && port="$(redis_conf_get "tls-port")" || port="$(redis_conf_get "port")" + + [[ -n "$pass" ]] && args+=("-a" "$pass") + [[ "$port" != "0" ]] && args+=("-p" "$port") + + debug "Stopping Redis" + if am_i_root; then + gosu "$REDIS_DAEMON_USER" "${REDIS_BASE_DIR}/bin/redis-cli" "${args[@]}" shutdown + else + "${REDIS_BASE_DIR}/bin/redis-cli" "${args[@]}" shutdown + fi +} + +######################## +# Validate settings in REDIS_* env vars. +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_validate() { + debug "Validating settings in REDIS_* env vars.." + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + empty_password_enabled_warn() { + warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD}. For safety reasons, do not use this flag in a production environment." + } + empty_password_error() { + print_validation_error "The $1 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_EMPTY_PASSWORD"; then + empty_password_enabled_warn + else + [[ -z "$REDIS_PASSWORD" ]] && empty_password_error REDIS_PASSWORD + fi + if [[ -n "$REDIS_REPLICATION_MODE" ]]; then + if [[ "$REDIS_REPLICATION_MODE" =~ ^(slave|replica)$ ]]; then + if [[ -n "$REDIS_MASTER_PORT_NUMBER" ]]; then + if ! err=$(validate_port "$REDIS_MASTER_PORT_NUMBER"); then + 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 + empty_password_error REDIS_MASTER_PASSWORD + fi + elif [[ "$REDIS_REPLICATION_MODE" != "master" ]]; then + print_validation_error "Invalid replication mode. Available options are 'master/replica'" + fi + fi + if is_boolean_yes "$REDIS_TLS_ENABLED"; then + if [[ "$REDIS_PORT_NUMBER" == "$REDIS_TLS_PORT" ]] && [[ "$REDIS_PORT_NUMBER" != "6379" ]]; then + # If both ports are assigned the same numbers and they are different to the default settings + print_validation_error "Environment variables REDIS_PORT_NUMBER and REDIS_TLS_PORT point to the same port number (${REDIS_PORT_NUMBER}). Change one of them or disable non-TLS traffic by setting REDIS_PORT_NUMBER=0" + fi + if [[ -z "$REDIS_TLS_CERT_FILE" ]]; then + print_validation_error "You must provide a X.509 certificate in order to use TLS" + elif [[ ! -f "$REDIS_TLS_CERT_FILE" ]]; then + print_validation_error "The X.509 certificate file in the specified path ${REDIS_TLS_CERT_FILE} does not exist" + fi + if [[ -z "$REDIS_TLS_KEY_FILE" ]]; then + print_validation_error "You must provide a private key in order to use TLS" + elif [[ ! -f "$REDIS_TLS_KEY_FILE" ]]; then + print_validation_error "The private key file in the specified path ${REDIS_TLS_KEY_FILE} does not exist" + fi + if [[ -z "$REDIS_TLS_CA_FILE" ]]; then + print_validation_error "You must provide a CA X.509 certificate in order to use TLS" + elif [[ ! -f "$REDIS_TLS_CA_FILE" ]]; then + print_validation_error "The CA X.509 certificate file in the specified path ${REDIS_TLS_CA_FILE} does not exist" + fi + if [[ -n "$REDIS_TLS_DH_PARAMS_FILE" ]] && [[ ! -f "$REDIS_TLS_DH_PARAMS_FILE" ]]; then + print_validation_error "The DH param file in the specified path ${REDIS_TLS_DH_PARAMS_FILE} does not exist" + fi + fi + + [[ "$error_code" -eq 0 ]] || exit "$error_code" +} + +######################## +# Configure Redis replication +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - Replication mode +# Returns: +# None +######################### +redis_configure_replication() { + info "Configuring replication mode" + + redis_conf_set replica-announce-ip "${REDIS_REPLICA_IP:-$(get_machine_ip)}" + redis_conf_set replica-announce-port "${REDIS_REPLICA_PORT:-$REDIS_MASTER_PORT_NUMBER}" + # Use TLS in the replication connections + if is_boolean_yes "$REDIS_TLS_ENABLED"; then + redis_conf_set tls-replication yes + fi + if [[ "$REDIS_REPLICATION_MODE" = "master" ]]; then + if [[ -n "$REDIS_PASSWORD" ]]; then + redis_conf_set masterauth "$REDIS_PASSWORD" + fi + elif [[ "$REDIS_REPLICATION_MODE" =~ ^(slave|replica)$ ]]; then + if [[ -n "$REDIS_SENTINEL_HOST" ]]; then + local sentinel_info_command + if is_boolean_yes "$REDIS_TLS_ENABLED"; then + sentinel_info_command="redis-cli -h ${REDIS_SENTINEL_HOST} -p ${REDIS_SENTINEL_PORT_NUMBER} --tls --cert ${REDIS_TLS_CERT_FILE} --key ${REDIS_TLS_KEY_FILE} --cacert ${REDIS_TLS_CA_FILE} sentinel get-master-addr-by-name ${REDIS_SENTINEL_MASTER_NAME}" + else + sentinel_info_command="redis-cli -h ${REDIS_SENTINEL_HOST} -p ${REDIS_SENTINEL_PORT_NUMBER} sentinel get-master-addr-by-name ${REDIS_SENTINEL_MASTER_NAME}" + fi + REDIS_SENTINEL_INFO=($($sentinel_info_command)) + REDIS_MASTER_HOST=${REDIS_SENTINEL_INFO[0]} + REDIS_MASTER_PORT_NUMBER=${REDIS_SENTINEL_INFO[1]} + fi + wait-for-port --host "$REDIS_MASTER_HOST" "$REDIS_MASTER_PORT_NUMBER" + [[ -n "$REDIS_MASTER_PASSWORD" ]] && redis_conf_set masterauth "$REDIS_MASTER_PASSWORD" + # Starting with Redis 5, use 'replicaof' instead of 'slaveof'. Maintaining both for backward compatibility + local parameter="replicaof" + [[ $(redis_major_version) -lt 5 ]] && parameter="slaveof" + redis_conf_set "$parameter" "$REDIS_MASTER_HOST $REDIS_MASTER_PORT_NUMBER" + fi +} + +######################## +# Disable Redis command(s) +# Globals: +# REDIS_BASE_DIR +# Arguments: +# $1 - Array of commands to disable +# Returns: +# None +######################### +redis_disable_unsafe_commands() { + # The current syntax gets a comma separated list of commands, we split them + # before passing to redis_disable_unsafe_commands + read -r -a disabledCommands <<< "$(tr ',' ' ' <<< "$REDIS_DISABLE_COMMANDS")" + debug "Disabling commands: ${disabledCommands[*]}" + for cmd in "${disabledCommands[@]}"; do + if grep -E -q "^\s*rename-command\s+$cmd\s+\"\"\s*$" "$REDIS_CONF_FILE"; then + debug "$cmd was already disabled" + continue + fi + echo "rename-command $cmd \"\"" >> "$REDIS_CONF_FILE" + done +} + +######################## +# Redis configure perissions +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_configure_permissions() { + debug "Ensuring expected directories/files exist" + for dir in "${REDIS_BASE_DIR}" "${REDIS_DATA_DIR}" "${REDIS_BASE_DIR}/tmp" "${REDIS_LOG_DIR}"; do + ensure_dir_exists "$dir" + if am_i_root; then + chown "$REDIS_DAEMON_USER:$REDIS_DAEMON_GROUP" "$dir" + fi + done +} + +######################## +# Redis specific configuration to override the default one +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_override_conf() { + if [[ ! -e "${REDIS_MOUNTED_CONF_DIR}/redis.conf" ]]; then + # Configure Replication mode + if [[ -n "$REDIS_REPLICATION_MODE" ]]; then + redis_configure_replication + fi + fi +} + +######################## +# Ensure Redis is initialized +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_initialize() { + redis_configure_default + redis_override_conf +} + +######################## +# Configures Redis permissions and general parameters (also used in redis-cluster container) +# Globals: +# REDIS_* +# Arguments: +# None +# Returns: +# None +######################### +redis_configure_default() { + info "Initializing Redis" + + # This fixes an issue where the trap would kill the entrypoint.sh, if a PID was left over from a previous run + # Exec replaces the process without creating a new one, and when the container is restarted it may have the same PID + rm -f "$REDIS_BASE_DIR/tmp/redis.pid" + + redis_configure_permissions + + # User injected custom configuration + if [[ -e "${REDIS_MOUNTED_CONF_DIR}/redis.conf" ]]; then + if [[ -e "$REDIS_BASE_DIR/etc/redis-default.conf" ]]; then + rm "${REDIS_BASE_DIR}/etc/redis-default.conf" + fi + cp "${REDIS_MOUNTED_CONF_DIR}/redis.conf" "${REDIS_BASE_DIR}/etc/redis.conf" + else + info "Setting Redis config file" + is_boolean_yes "$REDIS_ALLOW_REMOTE_CONNECTIONS" && redis_conf_set bind 0.0.0.0 # Allow remote connections + # Enable AOF https://redis.io/topics/persistence#append-only-file + # Leave default fsync (every second) + redis_conf_set appendonly "${REDIS_AOF_ENABLED}" + redis_conf_set port "$REDIS_PORT_NUMBER" + # TLS configuration + if is_boolean_yes "$REDIS_TLS_ENABLED"; then + if [[ "$REDIS_PORT_NUMBER" == "6379" ]] && [[ "$REDIS_TLS_PORT" == "6379" ]]; then + # If both ports are set to default values, enable TLS traffic only + redis_conf_set port 0 + redis_conf_set tls-port "$REDIS_TLS_PORT" + else + # Different ports were specified + redis_conf_set tls-port "$REDIS_TLS_PORT" + fi + redis_conf_set tls-cert-file "$REDIS_TLS_CERT_FILE" + redis_conf_set tls-key-file "$REDIS_TLS_KEY_FILE" + redis_conf_set tls-ca-cert-file "$REDIS_TLS_CA_FILE" + [[ -n "$REDIS_TLS_DH_PARAMS_FILE" ]] && redis_conf_set tls-dh-params-file "$REDIS_TLS_DH_PARAMS_FILE" + redis_conf_set tls-auth-clients "$REDIS_TLS_AUTH_CLIENTS" + fi + if [[ -n "$REDIS_PASSWORD" ]]; then + redis_conf_set requirepass "$REDIS_PASSWORD" + else + redis_conf_unset requirepass + fi + if [[ -n "$REDIS_DISABLE_COMMANDS" ]]; then + redis_disable_unsafe_commands + fi + fi +} diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh new file mode 100644 index 0000000..4092e0f --- /dev/null +++ b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh @@ -0,0 +1,112 @@ +#!/bin/bash +# +# Environment configuration for redis + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +# Load logging library +. /opt/bitnami/scripts/liblog.sh + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-redis}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# By setting an environment variable matching *_FILE to a file path, the prefixed environment +# variable will be overridden with the value specified in that file +redis_env_vars=( + REDIS_DATA_DIR + REDIS_DISABLE_COMMANDS + REDIS_DATABASE + REDIS_AOF_ENABLED + REDIS_MASTER_HOST + REDIS_MASTER_PORT_NUMBER + REDIS_PORT_NUMBER + REDIS_ALLOW_REMOTE_CONNECTIONS + REDIS_REPLICATION_MODE + REDIS_REPLICA_IP + REDIS_REPLICA_PORT + ALLOW_EMPTY_PASSWORD + REDIS_PASSWORD + REDIS_MASTER_PASSWORD + REDIS_TLS_ENABLED + REDIS_TLS_PORT_NUMBER + REDIS_TLS_CERT_FILE + REDIS_TLS_KEY_FILE + REDIS_TLS_CA_FILE + REDIS_TLS_DH_PARAMS_FILE + REDIS_TLS_AUTH_CLIENTS + REDIS_SENTINEL_MASTER_NAME + REDIS_SENTINEL_HOST + REDIS_SENTINEL_PORT_NUMBER + REDIS_TLS_PORT +) +for env_var in "${redis_env_vars[@]}"; do + file_env_var="${env_var}_FILE" + if [[ -n "${!file_env_var:-}" ]]; then + if [[ -r "${!file_env_var:-}" ]]; then + export "${env_var}=$(< "${!file_env_var}")" + unset "${file_env_var}" + else + warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable." + fi + fi +done +unset redis_env_vars + +# Paths +export REDIS_VOLUME_DIR="/bitnami/redis" +export REDIS_BASE_DIR="${BITNAMI_ROOT_DIR}/redis" +export REDIS_CONF_DIR="${REDIS_BASE_DIR}/etc" +export REDIS_DATA_DIR="${REDIS_DATA_DIR:-${REDIS_VOLUME_DIR}/data}" +export REDIS_MOUNTED_CONF_DIR="${REDIS_BASE_DIR}/mounted-etc" +export REDIS_CONF_FILE="${REDIS_CONF_DIR}/redis.conf" +export REDIS_LOG_DIR="${REDIS_BASE_DIR}/logs" +export REDIS_LOG_FILE="${REDIS_LOG_DIR}/redis.log" +export REDIS_TMP_DIR="${REDIS_BASE_DIR}/tmp" +export REDIS_PID_FILE="${REDIS_TMP_DIR}/redis.pid" +export REDIS_BIN_DIR="${REDIS_BASE_DIR}/bin" +export PATH="${REDIS_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" + +# System users (when running with a privileged user) +export REDIS_DAEMON_USER="redis" +export REDIS_DAEMON_GROUP="redis" + +# Redis settings +export REDIS_DISABLE_COMMANDS="${REDIS_DISABLE_COMMANDS:-}" +export REDIS_DATABASE="${REDIS_DATABASE:-redis}" +export REDIS_AOF_ENABLED="${REDIS_AOF_ENABLED:-yes}" +export REDIS_MASTER_HOST="${REDIS_MASTER_HOST:-}" +export REDIS_MASTER_PORT_NUMBER="${REDIS_MASTER_PORT_NUMBER:-6379}" +export REDIS_DEFAULT_PORT_NUMBER="6379" # only used at build time +export REDIS_PORT_NUMBER="${REDIS_PORT_NUMBER:-$REDIS_DEFAULT_PORT_NUMBER}" +export REDIS_ALLOW_REMOTE_CONNECTIONS="${REDIS_ALLOW_REMOTE_CONNECTIONS:-yes}" +export REDIS_REPLICATION_MODE="${REDIS_REPLICATION_MODE:-}" +export REDIS_REPLICA_IP="${REDIS_REPLICA_IP:-}" +export REDIS_REPLICA_PORT="${REDIS_REPLICA_PORT:-}" +export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}" +export REDIS_PASSWORD="${REDIS_PASSWORD:-}" +export REDIS_MASTER_PASSWORD="${REDIS_MASTER_PASSWORD:-}" + +# TLS settings +export REDIS_TLS_ENABLED="${REDIS_TLS_ENABLED:-no}" +REDIS_TLS_PORT_NUMBER="${REDIS_TLS_PORT_NUMBER:-"${REDIS_TLS_PORT:-}"}" +export REDIS_TLS_PORT_NUMBER="${REDIS_TLS_PORT_NUMBER:-6379}" +export REDIS_TLS_CERT_FILE="${REDIS_TLS_CERT_FILE:-}" +export REDIS_TLS_KEY_FILE="${REDIS_TLS_KEY_FILE:-}" +export REDIS_TLS_CA_FILE="${REDIS_TLS_CA_FILE:-}" +export REDIS_TLS_DH_PARAMS_FILE="${REDIS_TLS_DH_PARAMS_FILE:-}" +export REDIS_TLS_AUTH_CLIENTS="${REDIS_TLS_AUTH_CLIENTS:-yes}" + +# Redis Sentinel cluster settings +export REDIS_SENTINEL_MASTER_NAME="${REDIS_SENTINEL_MASTER_NAME:-}" +export REDIS_SENTINEL_HOST="${REDIS_SENTINEL_HOST:-}" +export REDIS_SENTINEL_PORT_NUMBER="${REDIS_SENTINEL_PORT_NUMBER:-26379}" + +# Custom environment variables may be defined below diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh new file mode 100755 index 0000000..b50f640 --- /dev/null +++ b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load Redis environment variables +. /opt/bitnami/scripts/redis-env.sh + +# Load libraries +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/libredis.sh + +print_welcome_page + +if [[ "$*" = *"/opt/bitnami/scripts/redis/run.sh"* || "$*" = *"/run.sh"* ]]; then + info "** Starting Redis setup **" + /opt/bitnami/scripts/redis/setup.sh + info "** Redis setup finished! **" +fi + +echo "" +exec "$@" diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh new file mode 100755 index 0000000..52254db --- /dev/null +++ b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh @@ -0,0 +1,29 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load Redis environment variables +. /opt/bitnami/scripts/redis-env.sh + +# Load libraries +. /opt/bitnami/scripts/libredis.sh +. /opt/bitnami/scripts/libfs.sh + +for dir in "$REDIS_VOLUME_DIR" "$REDIS_DATA_DIR" "$REDIS_BASE_DIR" "$REDIS_CONF_DIR"; do + ensure_dir_exists "$dir" +done +chmod -R g+rwX /bitnami "$REDIS_VOLUME_DIR" "$REDIS_BASE_DIR" + +cp "${REDIS_BASE_DIR}/etc/redis-default.conf" "$REDIS_CONF_FILE" +chmod g+rw "$REDIS_CONF_FILE" +# Default Redis config +info "Setting Redis config file..." +redis_conf_set port "$REDIS_DEFAULT_PORT_NUMBER" +redis_conf_set dir "$REDIS_DATA_DIR" +redis_conf_set pidfile "$REDIS_PID_FILE" +redis_conf_set daemonize yes diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh new file mode 100755 index 0000000..30c3a63 --- /dev/null +++ b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load Redis environment variables +. /opt/bitnami/scripts/redis-env.sh + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libredis.sh + +# Constants +REDIS_EXTRA_FLAGS=${REDIS_EXTRA_FLAGS:-} + +# Parse CLI flags to pass to the 'redis-server' call +args=("$REDIS_BASE_DIR/etc/redis.conf" "--daemonize" "no") +# Add flags specified via the 'REDIS_EXTRA_FLAGS' environment variable +read -r -a extra_flags <<< "$REDIS_EXTRA_FLAGS" +[[ "${#extra_flags[@]}" -gt 0 ]] && args+=("${extra_flags[@]}") +# Add flags passed to this script +args+=("$@") + +info "** Starting Redis **" +if am_i_root; then + exec gosu "$REDIS_DAEMON_USER" redis-server "${args[@]}" +else + exec redis-server "${args[@]}" +fi diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh new file mode 100755 index 0000000..d54a3cf --- /dev/null +++ b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load Redis environment variables +. /opt/bitnami/scripts/redis-env.sh + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libredis.sh + +# Ensure Redis environment variables settings are valid +redis_validate +# Ensure Redis daemon user exists when running as root +am_i_root && ensure_user_exists "$REDIS_DAEMON_USER" --group "$REDIS_DAEMON_GROUP" +# Ensure Redis is initialized +redis_initialize diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c850fde --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright (c) 2015-2021 Bitnami + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md index 5dc6fa6..1212caa 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,604 @@ -# +# What is Redis(TM) packaged by Bitnami? -Project template for all Iron Bank container repositories. \ No newline at end of file +Disclaimer: REDIS(r) is a registered trademark of Redis Labs Ltd.Any rights therein are reserved to Redis Labs Ltd. Any use by Bitnami is for referential +purposes only and does not indicate any sponsorship, endorsement, or affiliation between Redis Labs Ltd. + +> Redis(TM) is an advanced key-value cache and store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets, sorted sets, bitmaps and hyperloglogs. + +[redis.io](http://redis.io/) + +# TL;DR + +```console +$ docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis:latest +``` + +## Docker Compose + +```console +$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-redis/master/docker-compose.yml > docker-compose.yml +$ docker-compose up -d +``` + +# Why use Bitnami Images? + +* Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems. +* With Bitnami images the latest bug fixes and features are available as soon as possible. +* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs. +* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution. +* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images. +* Bitnami container images are released daily with the latest distribution packages available. + +> This [CVE scan report](https://quay.io/repository/bitnami/redis?tab=tags) contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page. + +# How to deploy Redis(TM) in Kubernetes? + +Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami Redis(TM) Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/redis). + +Bitnami containers can be used with [Kubeapps](https://kubeapps.com/) for deployment and management of Helm Charts in clusters. + +# Why use a non-root container? + +Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/tutorials/work-with-non-root-containers/). + +# Supported tags and respective `Dockerfile` links + +Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/). + + +* [`6.0`, `6.0-debian-10`, `6.0.10`, `6.0.10-debian-10-r31`, `latest` (6.0/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-redis/blob/6.0.10-debian-10-r31/6.0/debian-10/Dockerfile) +* [`5.0`, `5.0-debian-10`, `5.0.10`, `5.0.10-debian-10-r108` (5.0/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-redis/blob/5.0.10-debian-10-r108/5.0/debian-10/Dockerfile) + +Subscribe to project updates by watching the [bitnami/redis GitHub repo](https://github.com/bitnami/bitnami-docker-redis). + +# Get this image + +The recommended way to get the Bitnami Redis(TM) Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/redis). + +```console +$ docker pull bitnami/redis:latest +``` + +To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/redis/tags/) in the Docker Hub Registry. + +```console +$ docker pull bitnami/redis:[TAG] +``` + +If you wish, you can also build the image yourself. + +```console +$ docker build -t bitnami/redis:latest 'https://github.com/bitnami/bitnami-docker-redis.git#master:6.0/debian-10' +``` + +# Persisting your database + +Redis(TM) provides a different range of [persistence options](https://redis.io/topics/persistence). This contanier uses *AOF persistence by default* but it is easy to overwrite that configuration in a `docker-compose.yaml` file with this entry `command: /opt/bitnami/scripts/redis/run.sh --appendonly no`. Alternatively, you may use the `REDIS_AOF_ENABLED` env variable as explained in [Disabling AOF persistence](https://github.com/bitnami/bitnami-docker-redis#disabling-aof-persistence). + +If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed. + +For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run. + +```console +$ docker run \ + -e ALLOW_EMPTY_PASSWORD=yes \ + -v /path/to/redis-persistence:/bitnami/redis/data \ + bitnami/redis:latest +``` + +You can also do this by modifying the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redis/blob/master/docker-compose.yml) file present in this repository: + +```yaml +services: + redis: + ... + volumes: + - /path/to/redis-persistence:/bitnami/redis/data + ... +``` + +> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`. + +# Connecting to other containers + +Using [Docker container networking](https://docs.docker.com/engine/userguide/networking/), a Redis(TM) server running inside a container can easily be accessed by your application containers. + +Containers attached to the same network can communicate with each other using the container name as the hostname. + +## Using the Command Line + +In this example, we will create a Redis(TM) client instance that will connect to the server instance that is running on the same docker network as the client. + +### Step 1: Create a network + +```console +$ docker network create app-tier --driver bridge +``` + +### Step 2: Launch the Redis(TM) server instance + +Use the `--network app-tier` argument to the `docker run` command to attach the Redis(TM) container to the `app-tier` network. + +```console +$ docker run -d --name redis-server \ + -e ALLOW_EMPTY_PASSWORD=yes \ + --network app-tier \ + bitnami/redis:latest +``` + +### Step 3: Launch your Redis(TM) client instance + +Finally we create a new container instance to launch the Redis(TM) client and connect to the server created in the previous step: + +```console +$ docker run -it --rm \ + --network app-tier \ + bitnami/redis:latest redis-cli -h redis-server +``` + +## Using Docker Compose + +When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new `bridge` network named `app-tier`. In this example we assume that you want to connect to the Redis(TM) server from your own custom application image which is identified in the following snippet by the service name `myapp`. + +```yaml +version: '2' + +networks: + app-tier: + driver: bridge + +services: + redis: + image: 'bitnami/redis:latest' + environment: + - ALLOW_EMPTY_PASSWORD=yes + networks: + - app-tier + myapp: + image: 'YOUR_APPLICATION_IMAGE' + networks: + - app-tier +``` + +> **IMPORTANT**: +> +> 1. Please update the **YOUR_APPLICATION_IMAGE_** placeholder in the above snippet with your application image +> 2. In your application container, use the hostname `redis` to connect to the Redis(TM) server + +Launch the containers using: + +```console +$ docker-compose up -d +``` + +# Configuration + +## Disabling Redis(TM) commands + +For security reasons, you may want to disable some commands. You can specify them by using the following environment variable on the first run: + +- `REDIS_DISABLE_COMMANDS`: Comma-separated list of Redis(TM) commands to disable. Defaults to empty. + +```console +$ docker run --name redis -e REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL,CONFIG bitnami/redis:latest +``` + +Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redis/blob/master/docker-compose.yml) file present in this repository: + +```yaml +services: + redis: + ... + environment: + - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL,CONFIG + ... +``` + +As specified in the docker-compose, `FLUSHDB` and `FLUSHALL` commands are disabled. Comment out or remove the +environment variable if you don't want to disable any commands: + +```yaml +services: + redis: + ... + environment: + # - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL + ... +``` + +## Passing extra command-line flags to redis-server startup + +Passing extra command-line flags to the redis service command is possible by adding them as arguments to *run.sh* script: + +```console +$ docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis:latest /opt/bitnami/scripts/redis/run.sh --maxmemory 100mb +``` + +Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redis/blob/master/docker-compose.yml) file present in this repository: + +```yaml +services: + redis: + ... + environment: + - ALLOW_EMPTY_PASSWORD=yes + command: /opt/bitnami/scripts/redis/run.sh --maxmemory 100mb + ... +``` + +Refer to the [Redis(TM) documentation](https://redis.io/topics/config#passing-arguments-via-the-command-line) for the complete list of arguments. + +## Setting the server password on first run + +Passing the `REDIS_PASSWORD` environment variable when running the image for the first time will set the Redis(TM) server password to the value of `REDIS_PASSWORD` (or the content of the file specified in `REDIS_PASSWORD_FILE`). + +```console +$ docker run --name redis -e REDIS_PASSWORD=password123 bitnami/redis:latest +``` + +Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redis/blob/master/docker-compose.yml) file present in this repository: + +```yaml +services: + redis: + ... + environment: + - REDIS_PASSWORD=password123 + ... +``` + +**NOTE**: The at sign (`@`) is not supported for `REDIS_PASSWORD`. + +**Warning** The Redis(TM) database is always configured with remote access enabled. It's suggested that the `REDIS_PASSWORD` env variable is always specified to set a password. In case you want to access the database without a password set the environment variable `ALLOW_EMPTY_PASSWORD=yes`. **This is recommended only for development**. + +## Allowing empty passwords + +By default the Redis(TM) image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the `ALLOW_EMPTY_PASSWORD=yes` env variable. This env variable is only recommended for testing or development purposes. We strongly recommend specifying the `REDIS_PASSWORD` for any other scenario. + +```console +$ docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis:latest +``` + +Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redis/blob/master/docker-compose.yml) file present in this repository: + +```yaml +services: + redis: + ... + environment: + - ALLOW_EMPTY_PASSWORD=yes + ... +``` + +## Disabling AOF persistence + +Redis(TM) offers different [options](https://redis.io/topics/persistence) when it comes to persistence. By default, this image is set up to use the AOF (Append Only File) approach. Should you need to change this behaviour, setting the `REDIS_AOF_ENABLED=no` env variable will disable this feature. + +```console +$ docker run --name redis -e REDIS_AOF_ENABLED=no bitnami/redis:latest +``` + +Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redis/blob/master/docker-compose.yml) file present in this repository: + +```yaml +services: + redis: + ... + environment: + - REDIS_AOF_ENABLED=no + ... +``` + +## Setting up replication + +A [replication](http://redis.io/topics/replication) cluster can easily be setup with the Bitnami Redis(TM) Docker Image using the following environment variables: + + - `REDIS_REPLICATION_MODE`: The replication mode. Possible values `master`/`slave`. No defaults. + - `REDIS_REPLICA_IP`: The replication announce ip. Defaults to `$(get_machine_ip)` which return the ip of the container. + - `REDIS_REPLICA_PORT`: The replication announce port. Defaults to `REDIS_MASTER_PORT_NUMBER`. + - `REDIS_MASTER_HOST`: Hostname/IP of replication master (replica node parameter). No defaults. + - `REDIS_MASTER_PORT_NUMBER`: Server port of the replication master (replica node parameter). Defaults to `6379`. + - `REDIS_MASTER_PASSWORD`: Password to authenticate with the master (replica node parameter). No defaults. As an alternative, you can mount a file with the password and set the `REDIS_MASTER_PASSWORD_FILE` variable. + +In a replication cluster you can have one master and zero or more replicas. When replication is enabled the master node is in read-write mode, while the replicas are in read-only mode. For best performance its advisable to limit the reads to the replicas. + +### Step 1: Create the replication master + +The first step is to start the Redis(TM) master. + +```console +$ docker run --name redis-master \ + -e REDIS_REPLICATION_MODE=master \ + -e REDIS_PASSWORD=masterpassword123 \ + bitnami/redis:latest +``` + +In the above command the container is configured as the `master` using the `REDIS_REPLICATION_MODE` parameter. The `REDIS_PASSWORD` parameter enables authentication on the Redis(TM) master. + +### Step 2: Create the replica node + +Next we start a Redis(TM) replica container. + +```console +$ docker run --name redis-replica \ + --link redis-master:master \ + -e REDIS_REPLICATION_MODE=slave \ + -e REDIS_MASTER_HOST=master \ + -e REDIS_MASTER_PORT_NUMBER=6379 \ + -e REDIS_MASTER_PASSWORD=masterpassword123 \ + -e REDIS_PASSWORD=password123 \ + bitnami/redis:latest +``` + +In the above command the container is configured as a `slave` using the `REDIS_REPLICATION_MODE` parameter. The `REDIS_MASTER_HOST`, `REDIS_MASTER_PORT_NUMBER` and `REDIS_MASTER_PASSWORD ` parameters are used connect and authenticate with the Redis(TM) master. The `REDIS_PASSWORD` parameter enables authentication on the Redis(TM) replica. + +You now have a two node Redis(TM) master/replica replication cluster up and running which can be scaled by adding/removing replicas. + +If the Redis(TM) master goes down you can reconfigure a replica to become a master using: + +```console +$ docker exec redis-replica redis-cli -a password123 SLAVEOF NO ONE +``` + +> **Note**: The configuration of the other replicas in the cluster needs to be updated so that they are aware of the new master. In our example, this would involve restarting the other replicas with `--link redis-replica:master`. + +With Docker Compose the master/replica mode can be setup using: + +```yaml +version: '2' + +services: + redis-master: + image: 'bitnami/redis:latest' + ports: + - '6379' + environment: + - REDIS_REPLICATION_MODE=master + - REDIS_PASSWORD=my_master_password + volumes: + - '/path/to/redis-persistence:/bitnami' + + redis-replica: + image: 'bitnami/redis:latest' + ports: + - '6379' + depends_on: + - redis-master + environment: + - REDIS_REPLICATION_MODE=slave + - REDIS_MASTER_HOST=redis-master + - REDIS_MASTER_PORT_NUMBER=6379 + - REDIS_MASTER_PASSWORD=my_master_password + - REDIS_PASSWORD=my_replica_password +``` + +Scale the number of replicas using: + +```console +$ docker-compose up --detach --scale redis-master=1 --scale redis-secondary=3 +``` + +The above command scales up the number of replicas to `3`. You can scale down in the same way. + +> **Note**: You should not scale up/down the number of master nodes. Always have only one master node running. + +## Securing Redis(TM) traffic + +Starting with version 6, Redis(TM) adds the support for SSL/TLS connections. Should you desire to enable this optional feature, you may use the following environment variables to configure the application: + + - `REDIS_TLS_ENABLED`: Whether to enable TLS for traffic or not. Defaults to `no`. + - `REDIS_TLS_PORT`: Port used for TLS secure traffic. Defaults to `6379`. + - `REDIS_TLS_CERT_FILE`: File containing the certificate file for the TSL traffic. No defaults. + - `REDIS_TLS_KEY_FILE`: File containing the key for certificate. No defaults. + - `REDIS_TLS_CA_FILE`: File containing the CA of the certificate. No defaults. + - `REDIS_TLS_DH_PARAMS_FILE`: File containing DH params (in order to support DH based ciphers). No defaults. + - `REDIS_TLS_AUTH_CLIENTS`: Whether to require clients to authenticate or not. Defaults to `yes`. + +When enabling TLS, conventional standard traffic is disabled by default. However this new feature is not mutually exclusive, which means it is possible to listen to both TLS and non-TLS connection simultaneously. To enable non-TLS traffic, set `REDIS_TLS_PORT` to another port different than `0`. + +1. Using `docker run` + + ```console + $ docker run --name redis \ + -v /path/to/certs:/opt/bitnami/redis/certs \ + -v /path/to/redis-data-persistence:/bitnami/redis/data \ + -e ALLOW_EMPTY_PASSWORD=yes \ + -e REDIS_TLS_ENABLED=yes \ + -e REDIS_TLS_CERT_FILE=/opt/bitnami/redis/certs/redis.crt \ + -e REDIS_TLS_KEY_FILE=/opt/bitnami/redis/certs/redis.key \ + -e REDIS_TLS_CA_FILE=/opt/bitnami/redis/certs/redisCA.crt \ + bitnami/redis:latest + ``` + +2. Modifying the `docker-compose.yml` file present in this repository: + + ```yaml + services: + redis: + ... + environment: + ... + - REDIS_TLS_ENABLED=yes + - REDIS_TLS_CERT_FILE=/opt/bitnami/redis/certs/redis.crt + - REDIS_TLS_KEY_FILE=/opt/bitnami/redis/certs/redis.key + - REDIS_TLS_CA_FILE=/opt/bitnami/redis/certs/redisCA.crt + ... + volumes: + - /path/to/certs:/opt/bitnami/redis/certs + - /path/to/redis-persistence:/bitnami/redis/data + ... + ``` + +Alternatively, you may also provide with this configuration in your [custom](https://github.com/bitnami/bitnami-docker-redis#configuration-file) configuration file. + +## Configuration file + +The image looks for configurations in `/opt/bitnami/redis/mounted-etc/redis.conf`. You can overwrite the `redis.conf` file using your own custom configuration file. + +```console +$ docker run --name redis \ + -e ALLOW_EMPTY_PASSWORD=yes \ + -v /path/to/your_redis.conf:/opt/bitnami/redis/mounted-etc/redis.conf \ + -v /path/to/redis-data-persistence:/bitnami/redis/data \ + bitnami/redis:latest +``` + +Alternatively, modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-redis/blob/master/docker-compose.yml) file present in this repository: + +```yaml +services: + redis: + ... + volumes: + - /path/to/your_redis.conf:/opt/bitnami/redis/mounted-etc/redis.conf + - /path/to/redis-persistence:/bitnami/redis/data + ... +``` + +Refer to the [Redis(TM) configuration](http://redis.io/topics/config) manual for the complete list of configuration options. + +# Logging + +The Bitnami Redis(TM) Docker image sends the container logs to the `stdout`. To view the logs: + +```console +$ docker logs redis +``` + +or using Docker Compose: + +```console +$ docker-compose logs redis +``` + +You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver. + +# Maintenance + +## Upgrade this image + +Bitnami provides up-to-date versions of Redis(TM), including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. + +### Step 1: Get the updated image + +```console +$ docker pull bitnami/redis:latest +``` + +or if you're using Docker Compose, update the value of the image property to +`bitnami/redis:latest`. + +### Step 2: Stop and backup the currently running container + +Stop the currently running container using the command + +```console +$ docker stop redis +``` + +or using Docker Compose: + +```console +$ docker-compose stop redis +``` + +Next, take a snapshot of the persistent volume `/path/to/redis-persistence` using: + +```console +$ rsync -a /path/to/redis-persistence /path/to/redis-persistence.bkp.$(date +%Y%m%d-%H.%M.%S) +``` + +### Step 3: Remove the currently running container + +```console +$ docker rm -v redis +``` + +or using Docker Compose: + +```console +$ docker-compose rm -v redis +``` + +### Step 4: Run the new image + +Re-create your container from the new image. + +```console +$ docker run --name redis bitnami/redis:latest +``` + +or using Docker Compose: + +```console +$ docker-compose up redis +``` + +# Notable Changes + +## 5.0.8-debian-10-r24 + +- The recommended mount point to use a custom `redis.conf` changes from `/opt/bitnami/redis/etc/ ` to `/opt/bitnami/redis/mounted-etc/`. + +## 5.0.0-r0 + +- Starting with Redis(TM) 5.0 the command [REPLICAOF](https://redis.io/commands/replicaof) is available in favor of `SLAVEOF`. For backward compatibility with previous versions, `slave` replication mode is still supported. We encourage the use of the `REPLICAOF` command if you are using Redis(TM) 5.0. + +## 4.0.1-r24 + +- Decrease the size of the container. It is not necessary Node.js anymore. Redis(TM) configuration moved to bash scripts in the `rootfs/` folder. +- The recommended mount point to persist data changes to `/bitnami/redis/data`. +- The main `redis.conf` file is not persisted in a volume. The path is `/opt/bitnami/redis/mounted-etc/redis.conf`. +- Backwards compatibility is not guaranteed when data is persisted using docker-compose. You can use the workaround below to overcome it: + +```bash +docker-compose down +# Locate your volume and modify the file tree +VOLUME=$(docker volume ls | grep "redis_data" | awk '{print $2}') +docker run --rm -i -v=${VOLUME}:/tmp/redis busybox find /tmp/redis/data -maxdepth 1 -exec mv {} /tmp/redis \; +docker run --rm -i -v=${VOLUME}:/tmp/redis busybox rm -rf /tmp/redis/{data,conf,.initialized} +# Change the mount point +sed -i -e 's#redis_data:/bitnami/redis#redis_data:/bitnami/redis/data#g' docker-compose.yml +# Pull the latest bitnami/redis image +docker pull bitnami/redis:latest +docker-compose up -d +``` + +## 4.0.1-r1 + +- The redis container has been migrated to a non-root container approach. Previously the container run as `root` user and the redis daemon was started as `redis` user. From now own, both the container and the redis daemon run as user `1001`. + As a consequence, the configuration files are writable by the user running the redis process. + +## 3.2.0-r0 + +- All volumes have been merged at `/bitnami/redis`. Now you only need to mount a single volume at `/bitnami/redis` for persistence. +- The logs are always sent to the `stdout` and are no longer collected in the volume. + +# Contributing + +We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-redis/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-redis/pulls) with your contribution. + +# Issues + +If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-redis/issues/new). For us to provide better support, be sure to include the following information in your issue: + +- Host OS and version +- Docker version (`docker version`) +- Output of `docker info` +- Version of this container (`echo $BITNAMI_IMAGE_VERSION` inside the container) +- The command you used to run the container, and any relevant output you saw (masking any sensitive information) + +# License +Copyright (c) 2015-2021 Bitnami + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/docker-compose-replicaset.yml b/docker-compose-replicaset.yml new file mode 100644 index 0000000..90d1892 --- /dev/null +++ b/docker-compose-replicaset.yml @@ -0,0 +1,31 @@ +version: '2' + +services: + redis-primary: + image: 'docker.io/bitnami/redis:6.0-debian-10' + ports: + - '6379' + environment: + - REDIS_REPLICATION_MODE=master + - REDIS_PASSWORD=my_password + - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL + volumes: + - 'redis_data:/bitnami/redis/data' + + redis-secondary: + image: 'docker.io/bitnami/redis:6.0-debian-10' + ports: + - '6379' + depends_on: + - redis-primary + environment: + - REDIS_REPLICATION_MODE=slave + - REDIS_MASTER_HOST=redis-primary + - REDIS_MASTER_PORT_NUMBER=6379 + - REDIS_MASTER_PASSWORD=my_password + - REDIS_PASSWORD=my_password + - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL + +volumes: + redis_data: + driver: local diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..cb198cb --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,17 @@ +version: '2' + +services: + redis: + image: 'docker.io/bitnami/redis:6.0-debian-10' + environment: + # ALLOW_EMPTY_PASSWORD is recommended only for development. + - ALLOW_EMPTY_PASSWORD=yes + - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL + ports: + - '6379:6379' + volumes: + - 'redis_data:/bitnami/redis/data' + +volumes: + redis_data: + driver: local -- GitLab From 56d5158a95881cbb5d7263442bdac03720d255de Mon Sep 17 00:00:00 2001 From: Christopher Recla Date: Wed, 17 Feb 2021 14:45:46 -0700 Subject: [PATCH 2/3] Apply ironbank layout and remove redis5 --- .../issue_templates/Application - Initial.md | 4 +- .../issue_templates/Application - Update.md | 4 +- 5.0/debian-10/docker-compose.yml | 17 - .../opt/bitnami/.bitnami_components.json | 23 - .../opt/bitnami/licenses/licenses.txt | 3 - .../prebuildfs/usr/sbin/install_packages | 24 - 6.0/debian-10/Dockerfile | 56 --- 6.0/debian-10/docker-compose.yml | 17 - 6.0/debian-10/hardening_manifest.yaml | 47 -- .../opt/bitnami/.bitnami_components.json | 23 - .../opt/bitnami/licenses/licenses.txt | 3 - .../opt/bitnami/scripts/libbitnami.sh | 51 --- .../opt/bitnami/scripts/libcomponent.sh | 65 --- .../prebuildfs/opt/bitnami/scripts/libfile.sh | 80 ---- .../prebuildfs/opt/bitnami/scripts/libfs.sh | 183 -------- .../prebuildfs/opt/bitnami/scripts/libhook.sh | 16 - .../prebuildfs/opt/bitnami/scripts/liblog.sh | 110 ----- .../prebuildfs/opt/bitnami/scripts/libnet.sh | 142 ------ .../prebuildfs/opt/bitnami/scripts/libos.sh | 350 --------------- .../opt/bitnami/scripts/libpersistence.sh | 122 ----- .../opt/bitnami/scripts/libservice.sh | 225 ---------- .../opt/bitnami/scripts/libvalidations.sh | 248 ----------- .../opt/bitnami/scripts/libversion.sh | 49 -- .../opt/bitnami/scripts/libwebserver.sh | 421 ------------------ .../prebuildfs/usr/sbin/install_packages | 24 - .../rootfs/opt/bitnami/scripts/libredis.sh | 405 ----------------- .../rootfs/opt/bitnami/scripts/redis-env.sh | 112 ----- .../opt/bitnami/scripts/redis/entrypoint.sh | 26 -- .../opt/bitnami/scripts/redis/postunpack.sh | 29 -- .../rootfs/opt/bitnami/scripts/redis/run.sh | 33 -- .../rootfs/opt/bitnami/scripts/redis/setup.sh | 23 - 5.0/debian-10/Dockerfile => Dockerfile | 4 +- docker-compose-replicaset.yml | 31 -- docker-compose.yml | 17 - ...g_manifest.yaml => hardening_manifest.yaml | 6 +- .../bitnami/scripts => scripts}/libbitnami.sh | 0 .../scripts => scripts}/libcomponent.sh | 0 .../bitnami/scripts => scripts}/libfile.sh | 0 .../opt/bitnami/scripts => scripts}/libfs.sh | 0 .../bitnami/scripts => scripts}/libhook.sh | 0 .../opt/bitnami/scripts => scripts}/liblog.sh | 0 .../opt/bitnami/scripts => scripts}/libnet.sh | 0 .../opt/bitnami/scripts => scripts}/libos.sh | 0 .../scripts => scripts}/libpersistence.sh | 0 .../bitnami/scripts => scripts}/libredis.sh | 0 .../bitnami/scripts => scripts}/libservice.sh | 0 .../scripts => scripts}/libvalidations.sh | 0 .../bitnami/scripts => scripts}/libversion.sh | 0 .../scripts => scripts}/libwebserver.sh | 0 .../bitnami/scripts => scripts}/redis-env.sh | 0 .../scripts => scripts}/redis/entrypoint.sh | 0 .../scripts => scripts}/redis/postunpack.sh | 0 .../bitnami/scripts => scripts}/redis/run.sh | 0 .../scripts => scripts}/redis/setup.sh | 0 54 files changed, 9 insertions(+), 2984 deletions(-) delete mode 100644 5.0/debian-10/docker-compose.yml delete mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json delete mode 100644 5.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt delete mode 100755 5.0/debian-10/prebuildfs/usr/sbin/install_packages delete mode 100644 6.0/debian-10/Dockerfile delete mode 100644 6.0/debian-10/docker-compose.yml delete mode 100644 6.0/debian-10/hardening_manifest.yaml delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh delete mode 100644 6.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh delete mode 100755 6.0/debian-10/prebuildfs/usr/sbin/install_packages delete mode 100644 6.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh delete mode 100644 6.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh delete mode 100755 6.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh delete mode 100755 6.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh delete mode 100755 6.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh delete mode 100755 6.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh rename 5.0/debian-10/Dockerfile => Dockerfile (92%) delete mode 100644 docker-compose-replicaset.yml delete mode 100644 docker-compose.yml rename 5.0/debian-10/hardening_manifest.yaml => hardening_manifest.yaml (94%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libbitnami.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libcomponent.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libfile.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libfs.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libhook.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/liblog.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libnet.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libos.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libpersistence.sh (100%) rename {5.0/debian-10/rootfs/opt/bitnami/scripts => scripts}/libredis.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libservice.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libvalidations.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libversion.sh (100%) rename {5.0/debian-10/prebuildfs/opt/bitnami/scripts => scripts}/libwebserver.sh (100%) rename {5.0/debian-10/rootfs/opt/bitnami/scripts => scripts}/redis-env.sh (100%) rename {5.0/debian-10/rootfs/opt/bitnami/scripts => scripts}/redis/entrypoint.sh (100%) rename {5.0/debian-10/rootfs/opt/bitnami/scripts => scripts}/redis/postunpack.sh (100%) rename {5.0/debian-10/rootfs/opt/bitnami/scripts => scripts}/redis/run.sh (100%) rename {5.0/debian-10/rootfs/opt/bitnami/scripts => scripts}/redis/setup.sh (100%) diff --git a/.gitlab/issue_templates/Application - Initial.md b/.gitlab/issue_templates/Application - Initial.md index 7ddab91..470e36a 100644 --- a/.gitlab/issue_templates/Application - Initial.md +++ b/.gitlab/issue_templates/Application - Initial.md @@ -26,7 +26,7 @@ If this application is owned by a Contributor or Vendor (identifed as `Owner::Co ## Definition of Done Hardening: -- [ ] Hardening manifest is created and adheres to the schema (https://repo1.dsop.io/ironbank-tools/ironbank-pipeline/-/blob/master/schema/hardening_manifest.schema.json) +- [ ] Hardening manifest is created and adheres to the schema (https://repo1.dso.mil/ironbank-tools/ironbank-pipeline/-/blob/master/schema/hardening_manifest.schema.json) - [ ] Container builds successfully through the Gitlab CI pipeline - [ ] Branch has been merged into `development` - [ ] Project is configured for automatic renovate updates (if possible) @@ -50,7 +50,7 @@ Note: If the above approval process is kicked back for any reason, the `Approval ### Continuous Monitoring -Once a container is approved, the `Approved` label will be applied to this issue and it will be closed. You will be able to find your applications on http://ironbank.dsop.io and https://registry1.dsop.io. +Once a container is approved, the `Approved` label will be applied to this issue and it will be closed. You will be able to find your applications on http://ironbank.dso.mil and https://registry1.dso.mil. In addition to the above, your application will now be subscribed to continuous monitoring. This means that any new findings discovered as part of this will need justifications. To satisfy this process, any new findings will trigger a new Gitlab issue in this project with the label `Container::New Findings`. All members listed in the `maintainers` section of the `hardening_manifest.yaml` file will automatically be assigned. It is your responsibility as a Contributor or Vendor to monitor for this and provide justifications in a timely fashion. This newly created issue will have all the instructions necessary to complete the process. Failure to provide justifications could result in the revocation of the application's approval status. diff --git a/.gitlab/issue_templates/Application - Update.md b/.gitlab/issue_templates/Application - Update.md index 569e75d..6cddd40 100644 --- a/.gitlab/issue_templates/Application - Update.md +++ b/.gitlab/issue_templates/Application - Update.md @@ -31,7 +31,7 @@ If this application is owned by a Contributor or Vendor (identifed as `Owner::Co ## Definition of Done Hardening: -- [ ] Hardening manifest has been updated and adheres to the schema (https://repo1.dsop.io/ironbank-tools/ironbank-pipeline/-/blob/master/schema/hardening_manifest.schema.json) +- [ ] Hardening manifest has been updated and adheres to the schema (https://repo1.dso.mil/ironbank-tools/ironbank-pipeline/-/blob/master/schema/hardening_manifest.schema.json) - [ ] Container builds successfully throughthe Gitlab CI pipeline - [ ] Branch has been merged into `development` - [ ] Project is configured for automatic renovate updates (if possible) @@ -59,7 +59,7 @@ Note: If the above approval process is kicked back for any reason, the `Approval ### Continuous Monitoring -Once a container is approved, the `Approved` label will be applied to this issue and it will be closed. You will be able to find your applications on http://ironbank.dsop.io and https://registry1.dsop.io. +Once a container is approved, the `Approved` label will be applied to this issue and it will be closed. You will be able to find your applications on http://ironbank.dso.mil and https://registry1.dso.mil. In addition to the above, your application will now be subscribed to continuous monitoring. This means that any new findings discovered as part of this will need justifications. To satisfy this process, any new findings will trigger a new Gitlab issue in this project with the label `Container::New Findings`. All members listed in the `maintainers` section of the `hardening_manifest.yaml` file will automatically be assigned. It is your responsibility as a Contributor or Vendor to monitor for this and provide justifications in a timely fashion. This newly created issue will have all the instructions necessary to complete the process. Failure to provide justifications could result in the revocation of the application's approval status. diff --git a/5.0/debian-10/docker-compose.yml b/5.0/debian-10/docker-compose.yml deleted file mode 100644 index 209d1f4..0000000 --- a/5.0/debian-10/docker-compose.yml +++ /dev/null @@ -1,17 +0,0 @@ -version: '2' - -services: - redis: - image: 'docker.io/bitnami/redis:5.0-debian-10' - environment: - # ALLOW_EMPTY_PASSWORD is recommended only for development. - - ALLOW_EMPTY_PASSWORD=yes - - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL - ports: - - '6379:6379' - volumes: - - 'redis_data:/bitnami/redis/data' - -volumes: - redis_data: - driver: local diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json b/5.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json deleted file mode 100644 index 46901a6..0000000 --- a/5.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "gosu": { - "arch": "amd64", - "digest": "4d858ac600c38af8de454c27b7f65c0074ec3069880cb16d259a6e40a46bbc50", - "distro": "debian-10", - "type": "NAMI", - "version": "1.12.0-2" - }, - "redis": { - "arch": "amd64", - "digest": "c97eda540863e3d0960b27c25a6530244abb606f858cf089ef88ae66397f9161", - "distro": "debian-10", - "type": "NAMI", - "version": "5.0.10-0" - }, - "wait-for-port": { - "arch": "amd64", - "digest": "7521d9a4f9e4e182bf32977e234026caa7b03759799868335bccb1edd8f8fd12", - "distro": "debian-10", - "type": "NAMI", - "version": "1.0.0-3" - } -} \ No newline at end of file diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt b/5.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt deleted file mode 100644 index c76ba31..0000000 --- a/5.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt +++ /dev/null @@ -1,3 +0,0 @@ -Bitnami containers ship with software bundles. You can find the licenses under: -/opt/bitnami/nami/COPYING -/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/5.0/debian-10/prebuildfs/usr/sbin/install_packages b/5.0/debian-10/prebuildfs/usr/sbin/install_packages deleted file mode 100755 index c957764..0000000 --- a/5.0/debian-10/prebuildfs/usr/sbin/install_packages +++ /dev/null @@ -1,24 +0,0 @@ -#!/bin/sh -set -e -set -u -export DEBIAN_FRONTEND=noninteractive -n=0 -max=2 -until [ $n -gt $max ]; do - set +e - ( - apt-get update -qq && - apt-get install -y --no-install-recommends "$@" - ) - CODE=$? - set -e - if [ $CODE -eq 0 ]; then - break - fi - if [ $n -eq $max ]; then - exit $CODE - fi - echo "apt failed, retrying" - n=$(($n + 1)) -done -rm -r /var/lib/apt/lists /var/cache/apt/archives diff --git a/6.0/debian-10/Dockerfile b/6.0/debian-10/Dockerfile deleted file mode 100644 index 91dc148..0000000 --- a/6.0/debian-10/Dockerfile +++ /dev/null @@ -1,56 +0,0 @@ -ARG BASE_REGISTRY=registry1.dsop.io -ARG BASE_IMAGE=ironbank/redhat/openjdk/openjdk11 -ARG BASE_TAG=1.11 - -FROM bitnami/redis:6.0.4 as base -FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} as staging -ARG BITNAMI_HOME=/opt/bitnami -USER 0 -RUN mkdir /staging -COPY --from=base ${BITNAMI_HOME} /staging -RUN rm -rf /staging/java - -FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} -ARG PKG=redis -ARG BITNAMI_HOME=/opt/bitnami -ARG REDIS_HOME=${BITNAMI_HOME}/redis - -ARG REDIS_USER_ID="1001" -ARG REDIS_USER_NAME=${PKG} - -ENV REDIS_CONFIG_DIR=${REDIS_HOME}/config \ - REDIS_SERVER_HOME=${REDIS_HOME} \ - REDIS_BROKER_ID=0 \ - REDIS_LOG_DIRS=/tmp/redis-logs \ - REDIS_OFFSETS_TOPIC_REPLICATION_FACTOR=1 \ - REDIS_TRANSACTION_STATE_LOG_REPLICATION_FACTOR=1 \ - REDIS_TRANSACTION_STATE_LOG_MIN_ISR=1 \ - BITNAMI_APP_NAME=redis \ - PATH="${REDIS_HOME}/bin:/opt/bitnami/common/bin:$PATH" - -USER 0 - -RUN dnf update -y --nodocs && \ - dnf clean all && \ - rm -rf /var/cache/dnf && \ - mkdir -p ${BITNAMI_HOME} && \ - mkdir /docker-entrypoint-initdb.d - -COPY --from=staging /staging ${BITNAMI_HOME} -COPY scripts ${BITNAMI_HOME}/scripts - -RUN ln -s ${BITNAMI_HOME}/scripts/redis/entrypoint.sh /entrypoint.sh && \ - ln -s ${BITNAMI_HOME}/scripts/redis/run.sh /run.sh && \ - useradd -u ${REDIS_USER_ID} -g 0 -M -d ${REDIS_HOME} ${REDIS_USER_NAME} && \ - chown -R ${REDIS_USER_NAME}:0 ${REDIS_HOME} - -USER ${REDIS_USER_ID} - -WORKDIR ${REDIS_HOME} - -EXPOSE 6379 - -HEALTHCHECK --interval=10s --timeout=5s --retries=3 CMD zkServer.sh status || exit 1 - -ENTRYPOINT [ "/opt/bitnami/scripts/redis/entrypoint.sh" ] -CMD [ "/opt/bitnami/scripts/redis/run.sh" ] diff --git a/6.0/debian-10/docker-compose.yml b/6.0/debian-10/docker-compose.yml deleted file mode 100644 index cb198cb..0000000 --- a/6.0/debian-10/docker-compose.yml +++ /dev/null @@ -1,17 +0,0 @@ -version: '2' - -services: - redis: - image: 'docker.io/bitnami/redis:6.0-debian-10' - environment: - # ALLOW_EMPTY_PASSWORD is recommended only for development. - - ALLOW_EMPTY_PASSWORD=yes - - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL - ports: - - '6379:6379' - volumes: - - 'redis_data:/bitnami/redis/data' - -volumes: - redis_data: - driver: local diff --git a/6.0/debian-10/hardening_manifest.yaml b/6.0/debian-10/hardening_manifest.yaml deleted file mode 100644 index 6060994..0000000 --- a/6.0/debian-10/hardening_manifest.yaml +++ /dev/null @@ -1,47 +0,0 @@ ---- -apiVersion: v1 - -# The repository name in registry1, excluding /ironbank/ -name: "bitnami/redis" - -# List of tags to push for the repository in registry1 -# The most specific version should be the first tag and will be shown -# on ironbank.dsop.io -tags: -- "3.6.2" - -# Build args passed to Dockerfile ARGs -args: - BASE_IMAGE: "redhat/openjdk/openjdk11" - BASE_TAG: "1.11" - -# Docker image labels -labels: - org.opencontainers.image.title: "redis" - ## Human-readable description of the software packaged in the image - org.opencontainers.image.description: "Apache Redis® is a distributed streaming platform." - ## License(s) under which contained software is distributed - org.opencontainers.image.licenses: "Apache-2.0" - ## URL to find more information on the image - org.opencontainers.image.url: "https://bitnami.com/stack/redis/containers" - ## Name of the distributing entity, organization or individual - org.opencontainers.image.vendor: "Bitnami" - org.opencontainers.image.version: "3.6.2" - ## Keywords to help with search (ex. "cicd,gitops,golang") - mil.dso.ironbank.image.keywords: "dataflow,streaming" - ## This value can be "opensource" or "commercial" - mil.dso.ironbank.image.type: "opensource" - ## Product the image belongs to for grouping multiple images - mil.dso.ironbank.product.name: "Redis" - -# List of resources to make available to the offline build context -resources: -- tag: bitnami/redis:6.0.4 - url: docker://docker.io/bitnami/redis@sha256:b9e6ff6325a798c7c7c1cf0d45724f3c490d2916b0725f7151873f54d1275203 - -# List of project maintainers -maintainers: -- name: "Chris Recla" - username: "crecla" - email: "chrisrecla@seed-innovations.com" - cht_member: false \ No newline at end of file diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json b/6.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json deleted file mode 100644 index 90a9989..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/.bitnami_components.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "gosu": { - "arch": "amd64", - "digest": "4d858ac600c38af8de454c27b7f65c0074ec3069880cb16d259a6e40a46bbc50", - "distro": "debian-10", - "type": "NAMI", - "version": "1.12.0-2" - }, - "redis": { - "arch": "amd64", - "digest": "ceac371afa2fe829fb0ca26cbd6a90c17536293f3f65182da37e7a5cb01d9aa2", - "distro": "debian-10", - "type": "NAMI", - "version": "6.0.10-0" - }, - "wait-for-port": { - "arch": "amd64", - "digest": "7521d9a4f9e4e182bf32977e234026caa7b03759799868335bccb1edd8f8fd12", - "distro": "debian-10", - "type": "NAMI", - "version": "1.0.0-3" - } -} \ No newline at end of file diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt b/6.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt deleted file mode 100644 index c76ba31..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt +++ /dev/null @@ -1,3 +0,0 @@ -Bitnami containers ship with software bundles. You can find the licenses under: -/opt/bitnami/nami/COPYING -/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh deleted file mode 100644 index ef29e36..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh +++ /dev/null @@ -1,51 +0,0 @@ -#!/bin/bash -# -# Bitnami custom library - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/liblog.sh - -# Constants -BOLD='\033[1m' - -# Functions - -######################## -# Print the welcome page -# Globals: -# DISABLE_WELCOME_MESSAGE -# BITNAMI_APP_NAME -# Arguments: -# None -# Returns: -# None -######################### -print_welcome_page() { - if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then - if [[ -n "$BITNAMI_APP_NAME" ]]; then - print_image_welcome_page - fi - fi -} - -######################## -# Print the welcome page for a Bitnami Docker image -# Globals: -# BITNAMI_APP_NAME -# Arguments: -# None -# Returns: -# None -######################### -print_image_welcome_page() { - local github_url="https://github.com/bitnami/bitnami-docker-${BITNAMI_APP_NAME}" - - log "" - log "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" - log "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" - log "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" - log "" -} - diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh deleted file mode 100644 index 1d8c6bf..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh +++ /dev/null @@ -1,65 +0,0 @@ -#!/bin/bash -# -# Library for managing Bitnami components - -# Constants -CACHE_ROOT="/tmp/bitnami/pkg/cache" -DOWNLOAD_URL="https://downloads.bitnami.com/files/stacksmith" - -# Functions - -######################## -# Download and unpack a Bitnami package -# Globals: -# OS_NAME -# OS_ARCH -# OS_FLAVOUR -# Arguments: -# $1 - component's name -# $2 - component's version -# Returns: -# None -######################### -component_unpack() { - local name="${1:?name is required}" - local version="${2:?version is required}" - local base_name="${name}-${version}-${OS_NAME}-${OS_ARCH}-${OS_FLAVOUR}" - local package_sha256="" - local directory="/opt/bitnami" - - # Validate arguments - shift 2 - while [ "$#" -gt 0 ]; do - case "$1" in - -c|--checksum) - shift - package_sha256="${1:?missing package checksum}" - ;; - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - - echo "Downloading $base_name package" - if [ -f "${CACHE_ROOT}/${base_name}.tar.gz" ]; then - echo "${CACHE_ROOT}/${base_name}.tar.gz already exists, skipping download." - cp "${CACHE_ROOT}/${base_name}.tar.gz" . - rm "${CACHE_ROOT}/${base_name}.tar.gz" - if [ -f "${CACHE_ROOT}/${base_name}.tar.gz.sha256" ]; then - echo "Using the local sha256 from ${CACHE_ROOT}/${base_name}.tar.gz.sha256" - package_sha256="$(< "${CACHE_ROOT}/${base_name}.tar.gz.sha256")" - rm "${CACHE_ROOT}/${base_name}.tar.gz.sha256" - fi - else - curl --remote-name --silent "${DOWNLOAD_URL}/${base_name}.tar.gz" - fi - if [ -n "$package_sha256" ]; then - echo "Verifying package integrity" - echo "$package_sha256 ${base_name}.tar.gz" | sha256sum --check - - fi - tar --directory "${directory}" --extract --gunzip --file "${base_name}.tar.gz" --no-same-owner --strip-components=2 "${base_name}/files/" - rm "${base_name}.tar.gz" -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh deleted file mode 100644 index b09575c..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh +++ /dev/null @@ -1,80 +0,0 @@ -#!/bin/bash -# -# Library for managing files - -# Functions - -######################## -# Replace a regex in a file -# Arguments: -# $1 - filename -# $2 - match regex -# $3 - substitute regex -# $4 - use POSIX regex. Default: true -# Returns: -# None -######################### -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 - - # We should avoid using 'sed in-place' substitutions - # 1) They are not compatible with files mounted from ConfigMap(s) - # 2) We found incompatibility issues with Debian10 and "in-place" substitutions - del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues - if [[ $posix_regex = true ]]; then - result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" - else - result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" - fi - echo "$result" > "$filename" -} - -######################## -# Remove a line in a file based on a regex -# Arguments: -# $1 - filename -# $2 - match regex -# $3 - use POSIX regex. Default: true -# Returns: -# None -######################### -remove_in_file() { - local filename="${1:?filename is required}" - local match_regex="${2:?match regex is required}" - local posix_regex=${3:-true} - local result - - # We should avoid using 'sed in-place' substitutions - # 1) They are not compatible with files mounted from ConfigMap(s) - # 2) We found incompatibility issues with Debian10 and "in-place" substitutions - if [[ $posix_regex = true ]]; then - result="$(sed -E "/$match_regex/d" "$filename")" - else - result="$(sed "/$match_regex/d" "$filename")" - fi - echo "$result" > "$filename" -} - -######################## -# Appends text after the last line matching a pattern -# Arguments: -# $1 - file -# $2 - match regex -# $3 - contents to add -# Returns: -# None -######################### -append_file_after_last_match() { - local file="${1:?missing file}" - local match_regex="${2:?missing pattern}" - local value="${3:?missing value}" - - # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again - result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" - echo "$result" > "$file" -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh deleted file mode 100644 index 8f37ecb..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh +++ /dev/null @@ -1,183 +0,0 @@ -#!/bin/bash -# -# Library for file system actions - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/liblog.sh - -# Functions - -######################## -# Ensure a file/directory is owned (user and group) but the given user -# Arguments: -# $1 - filepath -# $2 - owner -# Returns: -# None -######################### -owned_by() { - local path="${1:?path is missing}" - local owner="${2:?owner is missing}" - - chown "$owner":"$owner" "$path" -} - -######################## -# Ensure a directory exists and, optionally, is owned by the given user -# Arguments: -# $1 - directory -# $2 - owner -# Returns: -# None -######################### -ensure_dir_exists() { - local dir="${1:?directory is missing}" - local owner="${2:-}" - - mkdir -p "${dir}" - if [[ -n $owner ]]; then - owned_by "$dir" "$owner" - fi -} - -######################## -# Checks whether a directory is empty or not -# arguments: -# $1 - directory -# returns: -# boolean -######################### -is_dir_empty() { - local dir="${1:?missing directory}" - - if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then - true - else - false - fi -} - -######################## -# Checks whether a mounted directory is empty or not -# arguments: -# $1 - directory -# returns: -# boolean -######################### -is_mounted_dir_empty() { - local dir="${1:?missing directory}" - - if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then - true - else - false - fi -} - -######################## -# Checks whether a file can be written to or not -# arguments: -# $1 - file -# returns: -# boolean -######################### -is_file_writable() { - local file="${1:?missing file}" - local dir - dir="$(dirname "$file")" - - if [[ ( -f "$file" && -w "$file" ) || ( ! -f "$file" && -d "$dir" && -w "$dir" ) ]]; then - true - else - false - fi -} - -######################## -# Relativize a path -# arguments: -# $1 - path -# $2 - base -# returns: -# None -######################### -relativize() { - local -r path="${1:?missing path}" - local -r base="${2:?missing base}" - pushd "$base" >/dev/null - realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' - popd >/dev/null -} - -######################## -# Configure permisions and ownership recursively -# Globals: -# None -# Arguments: -# $1 - paths (as a string). -# Flags: -# -f|--file-mode - mode for directories. -# -d|--dir-mode - mode for files. -# -u|--user - user -# -g|--group - group -# Returns: -# None -######################### -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}" - ;; - *) - echo "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 - if [[ -n $dir_mode ]]; then - find -L "$p" -type d -exec chmod "$dir_mode" {} \; - fi - if [[ -n $file_mode ]]; then - find -L "$p" -type f -exec chmod "$file_mode" {} \; - fi - if [[ -n $user ]] && [[ -n $group ]]; then - chown -LR "$user":"$group" "$p" - elif [[ -n $user ]] && [[ -z $group ]]; then - chown -LR "$user" "$p" - elif [[ -z $user ]] && [[ -n $group ]]; then - chgrp -LR "$group" "$p" - fi - else - stderr_print "$p does not exist" - fi - done -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh deleted file mode 100644 index 9694852..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/bash -# -# Library to use for scripts expected to be used as Kubernetes lifecycle hooks - -# shellcheck disable=SC1091 - -# Load generic libraries -. /opt/bitnami/scripts/liblog.sh -. /opt/bitnami/scripts/libos.sh - -# Override functions that log to stdout/stderr of the current process, so they print to process 1 -for function_to_override in stderr_print debug_execute; do - # Output is sent to output of process 1 and thus end up in the container log - # The hook output in general isn't saved - eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2" -done diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh deleted file mode 100644 index 60ec4cb..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh +++ /dev/null @@ -1,110 +0,0 @@ -#!/bin/bash -# -# Library for logging functions - -# Constants -RESET='\033[0m' -RED='\033[38;5;1m' -GREEN='\033[38;5;2m' -YELLOW='\033[38;5;3m' -MAGENTA='\033[38;5;5m' -CYAN='\033[38;5;6m' - -# Functions - -######################## -# Print to STDERR -# Arguments: -# Message to print -# Returns: -# None -######################### -stderr_print() { - # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it - local bool="${BITNAMI_QUIET:-false}" - # comparison is performed without regard to the case of alphabetic characters - shopt -s nocasematch - if ! [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then - printf "%b\\n" "${*}" >&2 - fi -} - -######################## -# Log message -# Arguments: -# Message to log -# Returns: -# None -######################### -log() { - stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" -} -######################## -# Log an 'info' message -# Arguments: -# Message to log -# Returns: -# None -######################### -info() { - log "${GREEN}INFO ${RESET} ==> ${*}" -} -######################## -# Log message -# Arguments: -# Message to log -# Returns: -# None -######################### -warn() { - log "${YELLOW}WARN ${RESET} ==> ${*}" -} -######################## -# Log an 'error' message -# Arguments: -# Message to log -# Returns: -# None -######################### -error() { - log "${RED}ERROR${RESET} ==> ${*}" -} -######################## -# Log a 'debug' message -# Globals: -# BITNAMI_DEBUG -# Arguments: -# None -# Returns: -# None -######################### -debug() { - # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it - local bool="${BITNAMI_DEBUG:-false}" - # comparison is performed without regard to the case of alphabetic characters - shopt -s nocasematch - if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then - log "${MAGENTA}DEBUG${RESET} ==> ${*}" - fi -} - -######################## -# Indent a string -# Arguments: -# $1 - string -# $2 - number of indentation characters (default: 4) -# $3 - indentation character (default: " ") -# Returns: -# None -######################### -indent() { - local string="${1:-}" - local num="${2:?missing num}" - local char="${3:-" "}" - # Build the indentation unit string - local indent_unit="" - for ((i = 0; i < num; i++)); do - indent_unit="${indent_unit}${char}" - done - echo "$string" | sed "s/^/${indent_unit}/" -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh deleted file mode 100644 index 4391dac..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh +++ /dev/null @@ -1,142 +0,0 @@ -#!/bin/bash -# -# Library for network functions - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/liblog.sh - -# Functions - -######################## -# Resolve IP address for a host/domain (i.e. DNS lookup) -# Arguments: -# $1 - Hostname to resolve -# $2 - IP address version (v4, v6), leave empty for resolving to any version -# Returns: -# IP -######################### -dns_lookup() { - local host="${1:?host is missing}" - local ip_version="${2:-}" - getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1 -} - -######################### -# Wait for a hostname and return the IP -# Arguments: -# $1 - hostname -# $2 - number of retries -# $3 - seconds to wait between retries -# Returns: -# - IP address that corresponds to the hostname -######################### -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" -} - -######################## -# Get machine's IP -# Arguments: -# None -# Returns: -# Machine IP -######################### -get_machine_ip() { - local -a ip_addresses - local hostname - hostname="$(hostname)" - read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" - if [[ "${#ip_addresses[@]}" -gt 1 ]]; then - warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" - elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then - error "Could not find any IP address associated to hostname ${hostname}" - exit 1 - fi - echo "${ip_addresses[0]}" -} - -######################## -# Check if the provided argument is a resolved hostname -# Arguments: -# $1 - Value to check -# Returns: -# Boolean -######################### -is_hostname_resolved() { - local -r host="${1:?missing value}" - if [[ -n "$(dns_lookup "$host")" ]]; then - true - else - false - fi -} - -######################## -# Parse URL -# Globals: -# None -# Arguments: -# $1 - uri - String -# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String -# Returns: -# String -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}]}" -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh deleted file mode 100644 index 6a75122..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh +++ /dev/null @@ -1,350 +0,0 @@ -#!/bin/bash -# -# Library for operating system actions - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/liblog.sh -. /opt/bitnami/scripts/libfs.sh - -# Functions - -######################## -# Check if an user exists in the system -# Arguments: -# $1 - user -# Returns: -# Boolean -######################### -user_exists() { - local user="${1:?user is missing}" - id "$user" >/dev/null 2>&1 -} - -######################## -# Check if a group exists in the system -# Arguments: -# $1 - group -# Returns: -# Boolean -######################### -group_exists() { - local group="${1:?group is missing}" - getent group "$group" >/dev/null 2>&1 -} - -######################## -# Create a group in the system if it does not exist already -# Arguments: -# $1 - group -# Flags: -# -s|--system - Whether to create new user as system user (uid <= 999) -# Returns: -# None -######################### -ensure_group_exists() { - local group="${1:?group is missing}" - local is_system_user=false - - # Validate arguments - shift 1 - while [ "$#" -gt 0 ]; do - case "$1" in - -s|--system) - is_system_user=true - ;; - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - - if ! group_exists "$group"; then - local -a args=("$group") - $is_system_user && args+=("--system") - groupadd "${args[@]}" >/dev/null 2>&1 - fi -} - -######################## -# Create an user in the system if it does not exist already -# Arguments: -# $1 - user -# Flags: -# -g|--group - the group the new user should belong to -# -h|--home - the home directory for the new user -# -s|--system - whether to create new user as system user (uid <= 999) -# Returns: -# None -######################### -ensure_user_exists() { - local user="${1:?user is missing}" - local group="" - local home="" - local is_system_user=false - - # Validate arguments - shift 1 - while [ "$#" -gt 0 ]; do - case "$1" in - -g|--group) - shift - group="${1:?missing group}" - ;; - -h|--home) - shift - home="${1:?missing home directory}" - ;; - -s|--system) - is_system_user=true - ;; - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - - if ! user_exists "$user"; then - local -a user_args=("-N" "$user") - $is_system_user && user_args+=("--system") - useradd "${user_args[@]}" >/dev/null 2>&1 - fi - - if [[ -n "$group" ]]; then - local -a group_args=("$group") - $is_system_user && group_args+=("--system") - ensure_group_exists "${group_args[@]}" - usermod -g "$group" "$user" >/dev/null 2>&1 - fi - - if [[ -n "$home" ]]; then - mkdir -p "$home" - usermod -d "$home" "$user" >/dev/null 2>&1 - configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group" - fi -} - -######################## -# Check if the script is currently running as root -# Arguments: -# $1 - user -# $2 - group -# Returns: -# Boolean -######################### -am_i_root() { - if [[ "$(id -u)" = "0" ]]; then - true - else - false - fi -} - -######################## -# Get total memory available -# Arguments: -# None -# Returns: -# Memory in bytes -######################### -get_total_memory() { - echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024)) -} - -######################## -# Get machine size depending on specified memory -# Globals: -# None -# Arguments: -# None -# Flags: -# --memory - memory size (optional) -# Returns: -# Detected instance size -######################### -get_machine_size() { - local memory="" - # Validate arguments - while [[ "$#" -gt 0 ]]; do - case "$1" in - --memory) - shift - memory="${1:?missing memory}" - ;; - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - 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 machine size depending on specified memory -# Globals: -# None -# Arguments: -# $1 - memory size (optional) -# Returns: -# Detected instance size -######################### -get_supported_machine_sizes() { - echo micro small medium large xlarge 2xlarge -} - -######################## -# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048) -# Globals: -# None -# Arguments: -# $1 - memory size -# Returns: -# Result of the conversion -######################### -convert_to_mb() { - local amount="${1:-}" - if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then - size="${BASH_REMATCH[1]}" - unit="${BASH_REMATCH[2]}" - if [[ "$unit" = "g" || "$unit" = "G" ]]; then - amount="$((size * 1024))" - else - amount="$size" - fi - fi - echo "$amount" -} - - -######################### -# Redirects output to /dev/null if debug mode is disabled -# Globals: -# BITNAMI_DEBUG -# Arguments: -# $@ - Command to execute -# Returns: -# None -######################### -debug_execute() { - if ${BITNAMI_DEBUG:-false}; then - "$@" - else - "$@" >/dev/null 2>&1 - fi -} - -######################## -# Retries a command a given number of times -# Arguments: -# $1 - cmd (as a string) -# $2 - max retries. Default: 12 -# $3 - sleep between retries (in seconds). Default: 5 -# Returns: -# Boolean -######################### -retry_while() { - local cmd="${1:?cmd is missing}" - local retries="${2:-12}" - local 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 -} - -######################## -# Generate a random string -# Arguments: -# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii -# -c|--count - Number of characters, defaults to 32 -# Arguments: -# None -# Returns: -# None -# Returns: -# String -######################### -generate_random_string() { - local type="ascii" - local count="32" - local filter - local result - # Validate arguments - while [[ "$#" -gt 0 ]]; do - case "$1" in - -t|--type) - shift - type="$1" - ;; - -c|--count) - shift - count="$1" - ;; - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - # Validate type - case "$type" in - ascii) - filter="[:print:]" - ;; - alphanumeric) - filter="a-zA-Z0-9" - ;; - numeric) - filter="0-9" - ;; - *) - echo "Invalid type ${type}" >&2 - return 1 - esac - # Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size - # Note there is a very small chance of strings starting with EOL character - # Therefore, the higher amount of lines read, this will happen less frequently - result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")" - echo "$result" -} - -######################## -# Create md5 hash from a string -# Arguments: -# $1 - string -# Returns: -# md5 hash - string -######################### -generate_md5_hash() { - local -r str="${1:?missing input string}" - echo -n "$str" | md5sum | awk '{print $1}' -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh deleted file mode 100644 index 452c1f4..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh +++ /dev/null @@ -1,122 +0,0 @@ -#!/bin/bash -# -# Bitnami persistence library -# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/libfs.sh -. /opt/bitnami/scripts/libos.sh -. /opt/bitnami/scripts/liblog.sh -. /opt/bitnami/scripts/libversion.sh - -# Functions - -######################## -# Persist an application directory -# Globals: -# BITNAMI_ROOT_DIR -# BITNAMI_VOLUME_DIR -# Arguments: -# $1 - App folder name -# $2 - List of app files to persist -# Returns: -# true if all steps succeeded, false otherwise -######################### -persist_app() { - local -r app="${1:?missing app}" - local -a files_to_restore - read -r -a files_to_persist <<< "$2" - local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" - local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" - # Persist the individual files - if [[ "${#files_to_persist[@]}" -lt 0 ]]; then - warn "No files are configured to be persisted" - return - fi - pushd "$install_dir" >/dev/null - local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder - local -r tmp_file="/tmp/perms.acl" - for file_to_persist in "${files_to_persist[@]}"; do - if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then - error "Cannot persist '${file_to_persist}' because it does not exist" - return 1 - fi - file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")" - file_to_persist_destination="${persist_dir}/${file_to_persist_relative}" - file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")" - # Get original permissions for existing files, which will be applied later - # Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume - getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file" - # Copy directories to the volume - ensure_dir_exists "$file_to_persist_destination_folder" - cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder" - # Restore permissions - pushd "$persist_dir" >/dev/null - if am_i_root; then - setfacl --restore="$tmp_file" - else - # When running as non-root, don't change ownership - setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file") - fi - popd >/dev/null - done - popd >/dev/null - rm -f "$tmp_file" - # Install the persisted files into the installation directory, via symlinks - restore_persisted_app "$@" -} - -######################## -# Restore a persisted application directory -# Globals: -# BITNAMI_ROOT_DIR -# BITNAMI_VOLUME_DIR -# FORCE_MAJOR_UPGRADE -# Arguments: -# $1 - App folder name -# $2 - List of app files to restore -# Returns: -# true if all steps succeeded, false otherwise -######################### -restore_persisted_app() { - local -r app="${1:?missing app}" - local -a files_to_restore - read -r -a files_to_restore <<< "$2" - local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" - local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" - # Restore the individual persisted files - if [[ "${#files_to_restore[@]}" -lt 0 ]]; then - warn "No persisted files are configured to be restored" - return - fi - local file_to_restore_relative file_to_restore_origin file_to_restore_destination - for file_to_restore in "${files_to_restore[@]}"; do - file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")" - # We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed - file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")" - file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")" - rm -rf "$file_to_restore_origin" - ln -sfn "$file_to_restore_destination" "$file_to_restore_origin" - done -} - -######################## -# Check if an application directory was already persisted -# Globals: -# BITNAMI_VOLUME_DIR -# Arguments: -# $1 - App folder name -# Returns: -# true if all steps succeeded, false otherwise -######################### -is_app_initialized() { - local -r app="${1:?missing app}" - local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" - if ! is_mounted_dir_empty "$persist_dir"; then - true - else - false - fi -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh deleted file mode 100644 index 55e1dfc..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh +++ /dev/null @@ -1,225 +0,0 @@ -#!/bin/bash -# -# Library for managing services - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/libvalidations.sh -. /opt/bitnami/scripts/liblog.sh - -# Functions - -######################## -# Read the provided pid file and returns a PID -# Arguments: -# $1 - Pid file -# Returns: -# 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 -} - -######################## -# Check if a provided PID corresponds to a running service -# Arguments: -# $1 - PID -# Returns: -# Boolean -######################### -is_service_running() { - local pid="${1:?pid is missing}" - - kill -0 "$pid" 2>/dev/null -} - -######################## -# Stop a service by sending a termination signal to its pid -# Arguments: -# $1 - Pid file -# $2 - Signal number (optional) -# Returns: -# None -######################### -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 -} - -######################## -# Start cron daemon -# Arguments: -# None -# Returns: -# true if started correctly, false otherwise -######################### -cron_start() { - if [[ -x "/usr/sbin/cron" ]]; then - /usr/sbin/cron - elif [[ -x "/usr/sbin/crond" ]]; then - /usr/sbin/crond - else - false - fi -} - -######################## -# Generate a cron configuration file for a given service -# Arguments: -# $1 - Service name -# $2 - Command -# Flags: -# --run-as - User to run as (default: root) -# --schedule - Cron schedule configuration (default: * * * * *) -# Returns: -# None -######################### -generate_cron_conf() { - local service_name="${1:?service name is missing}" - local cmd="${2:?command is missing}" - local run_as="root" - local schedule="* * * * *" - - # Parse optional CLI flags - shift 2 - while [[ "$#" -gt 0 ]]; do - case "$1" in - --run-as) - shift - run_as="$1" - ;; - --schedule) - shift - schedule="$1" - ;; - *) - echo "Invalid command line flag ${1}" >&2 - return 1 - ;; - esac - shift - done - - mkdir -p /etc/cron.d - echo "${schedule} ${run_as} ${cmd}" > /etc/cron.d/"$service_name" -} - -######################## -# Generate a monit configuration file for a given service -# Arguments: -# $1 - Service name -# $2 - Pid file -# $3 - Start command -# $4 - Stop command -# Flags: -# --disabled - Whether to disable the monit configuration -# Returns: -# None -######################### -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:-}" <&2 - return 1 - ;; - esac - shift - done - - mkdir -p "$logrotate_conf_dir" - cat <"${logrotate_conf_dir}/${service_name}" -${log_path} { - ${period} - rotate ${rotations} - dateext - compress - copytruncate - missingok -$(indent "$extra" 2) -} -EOF -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh deleted file mode 100644 index 8d82792..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh +++ /dev/null @@ -1,248 +0,0 @@ -#!/bin/bash -# -# Validation functions library - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/liblog.sh - -# Functions - -######################## -# Check if the provided argument is an integer -# Arguments: -# $1 - Value to check -# Returns: -# Boolean -######################### -is_int() { - local -r int="${1:?missing value}" - if [[ "$int" =~ ^-?[0-9]+ ]]; then - true - else - false - fi -} - -######################## -# Check if the provided argument is a positive integer -# Arguments: -# $1 - Value to check -# Returns: -# Boolean -######################### -is_positive_int() { - local -r int="${1:?missing value}" - if is_int "$int" && (( "${int}" >= 0 )); then - true - else - false - fi -} - -######################## -# Check if the provided argument is a boolean or is the string 'yes/true' -# Arguments: -# $1 - Value to check -# Returns: -# Boolean -######################### -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 -} - -######################## -# Check if the provided argument is a boolean yes/no value -# Arguments: -# $1 - Value to check -# Returns: -# Boolean -######################### -is_yes_no_value() { - local -r bool="${1:-}" - if [[ "$bool" =~ ^(yes|no)$ ]]; then - true - else - false - fi -} - -######################## -# Check if the provided argument is a boolean true/false value -# Arguments: -# $1 - Value to check -# Returns: -# Boolean -######################### -is_true_false_value() { - local -r bool="${1:-}" - if [[ "$bool" =~ ^(true|false)$ ]]; then - true - else - false - fi -} - -######################## -# Check if the provided argument is an empty string or not defined -# Arguments: -# $1 - Value to check -# Returns: -# Boolean -######################### -is_empty_value() { - local -r val="${1:-}" - if [[ -z "$val" ]]; then - true - else - false - fi -} - -######################## -# Validate if the provided argument is a valid port -# Arguments: -# $1 - Port to validate -# Returns: -# Boolean and error message -######################### -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 -} - -######################## -# Validate if the provided argument is a valid IPv4 address -# Arguments: -# $1 - IP to validate -# Returns: -# Boolean -######################### -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 -} - -######################## -# Validate a string format -# Arguments: -# $1 - String to validate -# Returns: -# Boolean -######################### -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 -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh deleted file mode 100644 index 66d4f45..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh +++ /dev/null @@ -1,49 +0,0 @@ -#!/bin/bash -# -# Library for managing versions strings - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/liblog.sh - -# Functions -######################## -# Gets semantic version -# Arguments: -# $1 - version: string to extract major.minor.patch -# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch -# Returns: -# array with the major, minor and release -######################### -get_sematic_version () { - local version="${1:?version is required}" - local section="${2:?section is required}" - local -a version_sections - - #Regex to parse versions: x.y.z - local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?' - - if [[ "$version" =~ $regex ]]; then - local i=1 - local j=1 - local n=${#BASH_REMATCH[*]} - - while [[ $i -lt $n ]]; do - if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then - version_sections[$j]=${BASH_REMATCH[$i]} - ((j++)) - fi - ((i++)) - done - - local number_regex='^[0-9]+$' - if [[ "$section" =~ $number_regex ]] && (( $section > 0 )) && (( $section <= 3 )); then - echo "${version_sections[$section]}" - return - else - stderr_print "Section allowed values are: 1, 2, and 3" - return 1 - fi - fi -} diff --git a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh deleted file mode 100644 index 25bff4a..0000000 --- a/6.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh +++ /dev/null @@ -1,421 +0,0 @@ -#!/bin/bash -# -# Bitnami web server handler library - -# shellcheck disable=SC1090,SC1091 - -# Load generic libraries -. /opt/bitnami/scripts/liblog.sh - -######################## -# Execute a command (or list of commands) with the web server environment and library loaded -# Globals: -# * -# Arguments: -# None -# Returns: -# None -######################### -web_server_execute() { - local -r web_server="${1:?missing web server}" - shift - # Run program in sub-shell to avoid web server environment getting loaded when not necessary - ( - . "/opt/bitnami/scripts/lib${web_server}.sh" - . "/opt/bitnami/scripts/${web_server}-env.sh" - "$@" - ) -} - -######################## -# Prints the list of enabled web servers -# Globals: -# None -# Arguments: -# None -# Returns: -# None -######################### -web_server_list() { - local -r -a supported_web_servers=(apache nginx) - local -a existing_web_servers=() - for web_server in "${supported_web_servers[@]}"; do - [[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server") - done - echo "${existing_web_servers[@]:-}" -} - -######################## -# Prints the currently-enabled web server type (only one, in order of preference) -# Globals: -# None -# Arguments: -# None -# Returns: -# None -######################### -web_server_type() { - local -a web_servers - read -r -a web_servers <<< "$(web_server_list)" - echo "${web_servers[0]:-}" -} - -######################## -# Validate that a supported web server is configured -# Globals: -# None -# Arguments: -# None -# Returns: -# None -######################### -web_server_validate() { - local error_code=0 - local supported_web_servers=("apache" "nginx") - - # Auxiliary functions - print_validation_error() { - error "$1" - error_code=1 - } - - if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then - print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}" - elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then - print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable." - fi - - return "$error_code" -} - -######################## -# Check whether the web server is running -# Globals: -# * -# Arguments: -# None -# Returns: -# true if the web server is running, false otherwise -######################### -is_web_server_running() { - "is_$(web_server_type)_running" -} - -######################## -# Start web server -# Globals: -# * -# Arguments: -# None -# Returns: -# None -######################### -web_server_start() { - info "Starting $(web_server_type) in background" - "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" -} - -######################## -# Stop web server -# Globals: -# * -# Arguments: -# None -# Returns: -# None -######################### -web_server_stop() { - info "Stopping $(web_server_type)" - "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" -} - -######################## -# Restart web server -# Globals: -# * -# Arguments: -# None -# Returns: -# None -######################### -web_server_restart() { - info "Restarting $(web_server_type)" - "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" -} - -######################## -# Reload web server -# Globals: -# * -# Arguments: -# None -# Returns: -# None -######################### -web_server_reload() { - "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" -} - -######################## -# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) -# It serves as a wrapper for the specific web server function -# Globals: -# * -# Arguments: -# $1 - App name -# Flags: -# --hosts - Hosts to enable -# --type - Application type, which has an effect on which configuration template to use -# --allow-remote-connections - Whether to allow remote connections or to require local connections -# --disabled - Whether to render the file with a .disabled prefix -# --enable-https - Enable app configuration on HTTPS port -# --http-port - HTTP port number -# --https-port - HTTPS port number -# --document-root - Path to document root directory -# Apache-specific flags: -# --apache-additional-configuration - Additional vhost configuration (no default) -# --apache-before-vhost-configuration - Configuration to add before the directive (no default) -# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') -# --apache-extra-directory-configuration - Extra configuration for the document root directory -# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup -# NGINX-specific flags: -# --nginx-additional-configuration - Additional server block configuration (no default) -# Returns: -# true if the configuration was enabled, false otherwise -######################## -ensure_web_server_app_configuration_exists() { - local app="${1:?missing app}" - shift - local -a apache_args nginx_args web_servers args_var - apache_args=("$app") - nginx_args=("$app") - # Validate arguments - while [[ "$#" -gt 0 ]]; do - case "$1" in - # Common flags - --hosts \ - | --type \ - | --allow-remote-connections \ - | --disabled \ - | --enable-https \ - | --http-port \ - | --https-port \ - | --document-root \ - ) - apache_args+=("$1" "${2:?missing value}") - nginx_args+=("$1" "${2:?missing value}") - shift - ;; - - # Specific Apache flags - --apache-additional-configuration \ - | --apache-before-vhost-configuration \ - | --apache-allow-override \ - | --apache-extra-directory-configuration \ - | --apache-move-htaccess \ - ) - apache_args+=("${1//apache-/}" "${2:?missing value}") - shift - ;; - - # Specific NGINX flags - --nginx-additional-configuration) - nginx_args+=("${1//nginx-/}" "${2:?missing value}") - shift - ;; - - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - read -r -a web_servers <<< "$(web_server_list)" - for web_server in "${web_servers[@]}"; do - args_var="${web_server}_args[@]" - web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}" - done -} - -######################## -# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block) -# It serves as a wrapper for the specific web server function -# Globals: -# * -# Arguments: -# $1 - App name -# Returns: -# true if the configuration was disabled, false otherwise -######################## -ensure_web_server_app_configuration_not_exists() { - local app="${1:?missing app}" - local -a web_servers - read -r -a web_servers <<< "$(web_server_list)" - for web_server in "${web_servers[@]}"; do - web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app" - done -} - -######################## -# Ensure the web server loads the configuration for an application in a URL prefix -# It serves as a wrapper for the specific web server function -# Globals: -# * -# Arguments: -# $1 - App name -# Flags: -# --allow-remote-connections - Whether to allow remote connections or to require local connections -# --document-root - Path to document root directory -# --prefix - URL prefix from where it will be accessible (i.e. /myapp) -# --type - Application type, which has an effect on what configuration template will be used -# Apache-specific flags: -# --apache-additional-configuration - Additional vhost configuration (no default) -# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') -# --apache-extra-directory-configuration - Extra configuration for the document root directory -# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup -# NGINX-specific flags: -# --nginx-additional-configuration - Additional server block configuration (no default) -# Returns: -# true if the configuration was enabled, false otherwise -######################## -ensure_web_server_prefix_configuration_exists() { - local app="${1:?missing app}" - shift - local -a apache_args nginx_args web_servers args_var - apache_args=("$app") - nginx_args=("$app") - # Validate arguments - while [[ "$#" -gt 0 ]]; do - case "$1" in - # Common flags - --allow-remote-connections \ - | --document-root \ - | --prefix \ - | --type \ - ) - apache_args+=("$1" "${2:?missing value}") - nginx_args+=("$1" "${2:?missing value}") - shift - ;; - - # Specific Apache flags - --apache-additional-configuration \ - | --apache-allow-override \ - | --apache-extra-directory-configuration \ - | --apache-move-htaccess \ - ) - apache_args+=("${1//apache-/}" "$2") - shift - ;; - - # Specific NGINX flags - --nginx-additional-configuration) - nginx_args+=("${1//nginx-/}" "$2") - shift - ;; - - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - read -r -a web_servers <<< "$(web_server_list)" - for web_server in "${web_servers[@]}"; do - args_var="${web_server}_args[@]" - web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}" - done -} - -######################## -# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports) -# It serves as a wrapper for the specific web server function -# Globals: -# * -# Arguments: -# $1 - App name -# Flags: -# --hosts - Hosts to enable -# --enable-https - Update HTTPS app configuration -# --http-port - HTTP port number -# --https-port - HTTPS port number -# Returns: -# true if the configuration was updated, false otherwise -######################## -web_server_update_app_configuration() { - local app="${1:?missing app}" - shift - local -a args web_servers - args=("$app") - # Validate arguments - while [[ "$#" -gt 0 ]]; do - case "$1" in - # Common flags - --hosts \ - | --enable-https \ - | --http-port \ - | --https-port \ - ) - args+=("$1" "${2:?missing value}") - shift - ;; - - *) - echo "Invalid command line flag $1" >&2 - return 1 - ;; - esac - shift - done - read -r -a web_servers <<< "$(web_server_list)" - for web_server in "${web_servers[@]}"; do - web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}" - done -} - -######################## -# Enable loading page, which shows users that the initialization process is not yet completed -# Globals: -# * -# Arguments: -# None -# Returns: -# None -######################### -web_server_enable_loading_page() { - ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \ - --apache-additional-configuration " -# Show a HTTP 503 Service Unavailable page by default -RedirectMatch 503 ^/$ -# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes -ErrorDocument 404 /index.html -ErrorDocument 503 /index.html" \ - --nginx-additional-configuration " -# Show a HTTP 503 Service Unavailable page by default -location / { - return 503; -} -# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes -error_page 404 @installing; -error_page 503 @installing; -location @installing { - rewrite ^(.*)$ /index.html break; -}" - web_server_reload -} - -######################## -# Enable loading page, which shows users that the initialization process is not yet completed -# Globals: -# * -# Arguments: -# None -# Returns: -# None -######################### -web_server_disable_install_page() { - ensure_web_server_app_configuration_not_exists "__loading" - web_server_reload -} diff --git a/6.0/debian-10/prebuildfs/usr/sbin/install_packages b/6.0/debian-10/prebuildfs/usr/sbin/install_packages deleted file mode 100755 index c957764..0000000 --- a/6.0/debian-10/prebuildfs/usr/sbin/install_packages +++ /dev/null @@ -1,24 +0,0 @@ -#!/bin/sh -set -e -set -u -export DEBIAN_FRONTEND=noninteractive -n=0 -max=2 -until [ $n -gt $max ]; do - set +e - ( - apt-get update -qq && - apt-get install -y --no-install-recommends "$@" - ) - CODE=$? - set -e - if [ $CODE -eq 0 ]; then - break - fi - if [ $n -eq $max ]; then - exit $CODE - fi - echo "apt failed, retrying" - n=$(($n + 1)) -done -rm -r /var/lib/apt/lists /var/cache/apt/archives diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh deleted file mode 100644 index 3c5dd5f..0000000 --- a/6.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh +++ /dev/null @@ -1,405 +0,0 @@ -#!/bin/bash -# -# Bitnami Redis library - -# shellcheck disable=SC1091 - -# Load Generic Libraries -. /opt/bitnami/scripts/libfile.sh -. /opt/bitnami/scripts/liblog.sh -. /opt/bitnami/scripts/libnet.sh -. /opt/bitnami/scripts/libos.sh -. /opt/bitnami/scripts/libservice.sh -. /opt/bitnami/scripts/libvalidations.sh - -# Functions - -######################## -# Retrieve a configuration setting value -# Globals: -# REDIS_BASE_DIR -# Arguments: -# $1 - key -# Returns: -# None -######################### -redis_conf_get() { - local -r key="${1:?missing key}" - - if grep -q -E "^\s*$key " "${REDIS_BASE_DIR}/etc/redis.conf"; then - grep -E "^\s*$key " "${REDIS_BASE_DIR}/etc/redis.conf" | awk '{print $2}' - fi -} - -######################## -# Set a configuration setting value -# Globals: -# REDIS_BASE_DIR -# Arguments: -# $1 - key -# $2 - value -# Returns: -# None -######################### -redis_conf_set() { - local -r key="${1:?missing key}" - local value="${2:-}" - - # Sanitize inputs - value="${value//\\/\\\\}" - value="${value//&/\\&}" - value="${value//\?/\\?}" - [[ "$value" = "" ]] && value="\"$value\"" - - replace_in_file "${REDIS_BASE_DIR}/etc/redis.conf" "^#*\s*${key} .*" "${key} ${value}" false -} - -######################## -# Unset a configuration setting value -# Globals: -# REDIS_BASE_DIR -# Arguments: -# $1 - key -# Returns: -# None -######################### -redis_conf_unset() { - local -r key="${1:?missing key}" - remove_in_file "${REDIS_BASE_DIR}/etc/redis.conf" "^\s*$key .*" false -} - -######################## -# Get Redis version -# Globals: -# REDIS_BASE_DIR -# Arguments: -# None -# Returns: -# Redis versoon -######################### -redis_version() { - "${REDIS_BASE_DIR}/bin/redis-cli" --version | grep -E -o "[0-9]+.[0-9]+.[0-9]+" -} - -######################## -# Get Redis major version -# Globals: -# REDIS_BASE_DIR -# Arguments: -# None -# Returns: -# Redis major version -######################### -redis_major_version() { - redis_version | grep -E -o "^[0-9]+" -} - -######################## -# Check if redis is running -# Globals: -# REDIS_BASE_DIR -# Arguments: -# None -# Returns: -# Boolean -######################### -is_redis_running() { - local pid - pid="$(get_pid_from_file "$REDIS_BASE_DIR/tmp/redis.pid")" - - if [[ -z "$pid" ]]; then - false - else - is_service_running "$pid" - fi -} - -######################## -# Check if redis is not running -# Globals: -# REDIS_BASE_DIR -# Arguments: -# None -# Returns: -# Boolean -######################### -is_redis_not_running() { - ! is_redis_running -} - -######################## -# Stop Redis -# Globals: -# REDIS_* -# Arguments: -# None -# Returns: -# None -######################### -redis_stop() { - local pass - local port - local args - - ! is_redis_running && return - pass="$(redis_conf_get "requirepass")" - is_boolean_yes "$REDIS_TLS_ENABLED" && port="$(redis_conf_get "tls-port")" || port="$(redis_conf_get "port")" - - [[ -n "$pass" ]] && args+=("-a" "$pass") - [[ "$port" != "0" ]] && args+=("-p" "$port") - - debug "Stopping Redis" - if am_i_root; then - gosu "$REDIS_DAEMON_USER" "${REDIS_BASE_DIR}/bin/redis-cli" "${args[@]}" shutdown - else - "${REDIS_BASE_DIR}/bin/redis-cli" "${args[@]}" shutdown - fi -} - -######################## -# Validate settings in REDIS_* env vars. -# Globals: -# REDIS_* -# Arguments: -# None -# Returns: -# None -######################### -redis_validate() { - debug "Validating settings in REDIS_* env vars.." - local error_code=0 - - # Auxiliary functions - print_validation_error() { - error "$1" - error_code=1 - } - - empty_password_enabled_warn() { - warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD}. For safety reasons, do not use this flag in a production environment." - } - empty_password_error() { - print_validation_error "The $1 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_EMPTY_PASSWORD"; then - empty_password_enabled_warn - else - [[ -z "$REDIS_PASSWORD" ]] && empty_password_error REDIS_PASSWORD - fi - if [[ -n "$REDIS_REPLICATION_MODE" ]]; then - if [[ "$REDIS_REPLICATION_MODE" =~ ^(slave|replica)$ ]]; then - if [[ -n "$REDIS_MASTER_PORT_NUMBER" ]]; then - if ! err=$(validate_port "$REDIS_MASTER_PORT_NUMBER"); then - 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 - empty_password_error REDIS_MASTER_PASSWORD - fi - elif [[ "$REDIS_REPLICATION_MODE" != "master" ]]; then - print_validation_error "Invalid replication mode. Available options are 'master/replica'" - fi - fi - if is_boolean_yes "$REDIS_TLS_ENABLED"; then - if [[ "$REDIS_PORT_NUMBER" == "$REDIS_TLS_PORT" ]] && [[ "$REDIS_PORT_NUMBER" != "6379" ]]; then - # If both ports are assigned the same numbers and they are different to the default settings - print_validation_error "Environment variables REDIS_PORT_NUMBER and REDIS_TLS_PORT point to the same port number (${REDIS_PORT_NUMBER}). Change one of them or disable non-TLS traffic by setting REDIS_PORT_NUMBER=0" - fi - if [[ -z "$REDIS_TLS_CERT_FILE" ]]; then - print_validation_error "You must provide a X.509 certificate in order to use TLS" - elif [[ ! -f "$REDIS_TLS_CERT_FILE" ]]; then - print_validation_error "The X.509 certificate file in the specified path ${REDIS_TLS_CERT_FILE} does not exist" - fi - if [[ -z "$REDIS_TLS_KEY_FILE" ]]; then - print_validation_error "You must provide a private key in order to use TLS" - elif [[ ! -f "$REDIS_TLS_KEY_FILE" ]]; then - print_validation_error "The private key file in the specified path ${REDIS_TLS_KEY_FILE} does not exist" - fi - if [[ -z "$REDIS_TLS_CA_FILE" ]]; then - print_validation_error "You must provide a CA X.509 certificate in order to use TLS" - elif [[ ! -f "$REDIS_TLS_CA_FILE" ]]; then - print_validation_error "The CA X.509 certificate file in the specified path ${REDIS_TLS_CA_FILE} does not exist" - fi - if [[ -n "$REDIS_TLS_DH_PARAMS_FILE" ]] && [[ ! -f "$REDIS_TLS_DH_PARAMS_FILE" ]]; then - print_validation_error "The DH param file in the specified path ${REDIS_TLS_DH_PARAMS_FILE} does not exist" - fi - fi - - [[ "$error_code" -eq 0 ]] || exit "$error_code" -} - -######################## -# Configure Redis replication -# Globals: -# REDIS_BASE_DIR -# Arguments: -# $1 - Replication mode -# Returns: -# None -######################### -redis_configure_replication() { - info "Configuring replication mode" - - redis_conf_set replica-announce-ip "${REDIS_REPLICA_IP:-$(get_machine_ip)}" - redis_conf_set replica-announce-port "${REDIS_REPLICA_PORT:-$REDIS_MASTER_PORT_NUMBER}" - # Use TLS in the replication connections - if is_boolean_yes "$REDIS_TLS_ENABLED"; then - redis_conf_set tls-replication yes - fi - if [[ "$REDIS_REPLICATION_MODE" = "master" ]]; then - if [[ -n "$REDIS_PASSWORD" ]]; then - redis_conf_set masterauth "$REDIS_PASSWORD" - fi - elif [[ "$REDIS_REPLICATION_MODE" =~ ^(slave|replica)$ ]]; then - if [[ -n "$REDIS_SENTINEL_HOST" ]]; then - local sentinel_info_command - if is_boolean_yes "$REDIS_TLS_ENABLED"; then - sentinel_info_command="redis-cli -h ${REDIS_SENTINEL_HOST} -p ${REDIS_SENTINEL_PORT_NUMBER} --tls --cert ${REDIS_TLS_CERT_FILE} --key ${REDIS_TLS_KEY_FILE} --cacert ${REDIS_TLS_CA_FILE} sentinel get-master-addr-by-name ${REDIS_SENTINEL_MASTER_NAME}" - else - sentinel_info_command="redis-cli -h ${REDIS_SENTINEL_HOST} -p ${REDIS_SENTINEL_PORT_NUMBER} sentinel get-master-addr-by-name ${REDIS_SENTINEL_MASTER_NAME}" - fi - REDIS_SENTINEL_INFO=($($sentinel_info_command)) - REDIS_MASTER_HOST=${REDIS_SENTINEL_INFO[0]} - REDIS_MASTER_PORT_NUMBER=${REDIS_SENTINEL_INFO[1]} - fi - wait-for-port --host "$REDIS_MASTER_HOST" "$REDIS_MASTER_PORT_NUMBER" - [[ -n "$REDIS_MASTER_PASSWORD" ]] && redis_conf_set masterauth "$REDIS_MASTER_PASSWORD" - # Starting with Redis 5, use 'replicaof' instead of 'slaveof'. Maintaining both for backward compatibility - local parameter="replicaof" - [[ $(redis_major_version) -lt 5 ]] && parameter="slaveof" - redis_conf_set "$parameter" "$REDIS_MASTER_HOST $REDIS_MASTER_PORT_NUMBER" - fi -} - -######################## -# Disable Redis command(s) -# Globals: -# REDIS_BASE_DIR -# Arguments: -# $1 - Array of commands to disable -# Returns: -# None -######################### -redis_disable_unsafe_commands() { - # The current syntax gets a comma separated list of commands, we split them - # before passing to redis_disable_unsafe_commands - read -r -a disabledCommands <<< "$(tr ',' ' ' <<< "$REDIS_DISABLE_COMMANDS")" - debug "Disabling commands: ${disabledCommands[*]}" - for cmd in "${disabledCommands[@]}"; do - if grep -E -q "^\s*rename-command\s+$cmd\s+\"\"\s*$" "$REDIS_CONF_FILE"; then - debug "$cmd was already disabled" - continue - fi - echo "rename-command $cmd \"\"" >> "$REDIS_CONF_FILE" - done -} - -######################## -# Redis configure perissions -# Globals: -# REDIS_* -# Arguments: -# None -# Returns: -# None -######################### -redis_configure_permissions() { - debug "Ensuring expected directories/files exist" - for dir in "${REDIS_BASE_DIR}" "${REDIS_DATA_DIR}" "${REDIS_BASE_DIR}/tmp" "${REDIS_LOG_DIR}"; do - ensure_dir_exists "$dir" - if am_i_root; then - chown "$REDIS_DAEMON_USER:$REDIS_DAEMON_GROUP" "$dir" - fi - done -} - -######################## -# Redis specific configuration to override the default one -# Globals: -# REDIS_* -# Arguments: -# None -# Returns: -# None -######################### -redis_override_conf() { - if [[ ! -e "${REDIS_MOUNTED_CONF_DIR}/redis.conf" ]]; then - # Configure Replication mode - if [[ -n "$REDIS_REPLICATION_MODE" ]]; then - redis_configure_replication - fi - fi -} - -######################## -# Ensure Redis is initialized -# Globals: -# REDIS_* -# Arguments: -# None -# Returns: -# None -######################### -redis_initialize() { - redis_configure_default - redis_override_conf -} - -######################## -# Configures Redis permissions and general parameters (also used in redis-cluster container) -# Globals: -# REDIS_* -# Arguments: -# None -# Returns: -# None -######################### -redis_configure_default() { - info "Initializing Redis" - - # This fixes an issue where the trap would kill the entrypoint.sh, if a PID was left over from a previous run - # Exec replaces the process without creating a new one, and when the container is restarted it may have the same PID - rm -f "$REDIS_BASE_DIR/tmp/redis.pid" - - redis_configure_permissions - - # User injected custom configuration - if [[ -e "${REDIS_MOUNTED_CONF_DIR}/redis.conf" ]]; then - if [[ -e "$REDIS_BASE_DIR/etc/redis-default.conf" ]]; then - rm "${REDIS_BASE_DIR}/etc/redis-default.conf" - fi - cp "${REDIS_MOUNTED_CONF_DIR}/redis.conf" "${REDIS_BASE_DIR}/etc/redis.conf" - else - info "Setting Redis config file" - is_boolean_yes "$REDIS_ALLOW_REMOTE_CONNECTIONS" && redis_conf_set bind 0.0.0.0 # Allow remote connections - # Enable AOF https://redis.io/topics/persistence#append-only-file - # Leave default fsync (every second) - redis_conf_set appendonly "${REDIS_AOF_ENABLED}" - redis_conf_set port "$REDIS_PORT_NUMBER" - # TLS configuration - if is_boolean_yes "$REDIS_TLS_ENABLED"; then - if [[ "$REDIS_PORT_NUMBER" == "6379" ]] && [[ "$REDIS_TLS_PORT" == "6379" ]]; then - # If both ports are set to default values, enable TLS traffic only - redis_conf_set port 0 - redis_conf_set tls-port "$REDIS_TLS_PORT" - else - # Different ports were specified - redis_conf_set tls-port "$REDIS_TLS_PORT" - fi - redis_conf_set tls-cert-file "$REDIS_TLS_CERT_FILE" - redis_conf_set tls-key-file "$REDIS_TLS_KEY_FILE" - redis_conf_set tls-ca-cert-file "$REDIS_TLS_CA_FILE" - [[ -n "$REDIS_TLS_DH_PARAMS_FILE" ]] && redis_conf_set tls-dh-params-file "$REDIS_TLS_DH_PARAMS_FILE" - redis_conf_set tls-auth-clients "$REDIS_TLS_AUTH_CLIENTS" - fi - if [[ -n "$REDIS_PASSWORD" ]]; then - redis_conf_set requirepass "$REDIS_PASSWORD" - else - redis_conf_unset requirepass - fi - if [[ -n "$REDIS_DISABLE_COMMANDS" ]]; then - redis_disable_unsafe_commands - fi - fi -} diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh deleted file mode 100644 index 4092e0f..0000000 --- a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh +++ /dev/null @@ -1,112 +0,0 @@ -#!/bin/bash -# -# Environment configuration for redis - -# The values for all environment variables will be set in the below order of precedence -# 1. Custom environment variables defined below after Bitnami defaults -# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR -# 3. Environment variables overridden via external files using *_FILE variables (see below) -# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) - -# Load logging library -. /opt/bitnami/scripts/liblog.sh - -export BITNAMI_ROOT_DIR="/opt/bitnami" -export BITNAMI_VOLUME_DIR="/bitnami" - -# Logging configuration -export MODULE="${MODULE:-redis}" -export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" - -# By setting an environment variable matching *_FILE to a file path, the prefixed environment -# variable will be overridden with the value specified in that file -redis_env_vars=( - REDIS_DATA_DIR - REDIS_DISABLE_COMMANDS - REDIS_DATABASE - REDIS_AOF_ENABLED - REDIS_MASTER_HOST - REDIS_MASTER_PORT_NUMBER - REDIS_PORT_NUMBER - REDIS_ALLOW_REMOTE_CONNECTIONS - REDIS_REPLICATION_MODE - REDIS_REPLICA_IP - REDIS_REPLICA_PORT - ALLOW_EMPTY_PASSWORD - REDIS_PASSWORD - REDIS_MASTER_PASSWORD - REDIS_TLS_ENABLED - REDIS_TLS_PORT_NUMBER - REDIS_TLS_CERT_FILE - REDIS_TLS_KEY_FILE - REDIS_TLS_CA_FILE - REDIS_TLS_DH_PARAMS_FILE - REDIS_TLS_AUTH_CLIENTS - REDIS_SENTINEL_MASTER_NAME - REDIS_SENTINEL_HOST - REDIS_SENTINEL_PORT_NUMBER - REDIS_TLS_PORT -) -for env_var in "${redis_env_vars[@]}"; do - file_env_var="${env_var}_FILE" - if [[ -n "${!file_env_var:-}" ]]; then - if [[ -r "${!file_env_var:-}" ]]; then - export "${env_var}=$(< "${!file_env_var}")" - unset "${file_env_var}" - else - warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable." - fi - fi -done -unset redis_env_vars - -# Paths -export REDIS_VOLUME_DIR="/bitnami/redis" -export REDIS_BASE_DIR="${BITNAMI_ROOT_DIR}/redis" -export REDIS_CONF_DIR="${REDIS_BASE_DIR}/etc" -export REDIS_DATA_DIR="${REDIS_DATA_DIR:-${REDIS_VOLUME_DIR}/data}" -export REDIS_MOUNTED_CONF_DIR="${REDIS_BASE_DIR}/mounted-etc" -export REDIS_CONF_FILE="${REDIS_CONF_DIR}/redis.conf" -export REDIS_LOG_DIR="${REDIS_BASE_DIR}/logs" -export REDIS_LOG_FILE="${REDIS_LOG_DIR}/redis.log" -export REDIS_TMP_DIR="${REDIS_BASE_DIR}/tmp" -export REDIS_PID_FILE="${REDIS_TMP_DIR}/redis.pid" -export REDIS_BIN_DIR="${REDIS_BASE_DIR}/bin" -export PATH="${REDIS_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" - -# System users (when running with a privileged user) -export REDIS_DAEMON_USER="redis" -export REDIS_DAEMON_GROUP="redis" - -# Redis settings -export REDIS_DISABLE_COMMANDS="${REDIS_DISABLE_COMMANDS:-}" -export REDIS_DATABASE="${REDIS_DATABASE:-redis}" -export REDIS_AOF_ENABLED="${REDIS_AOF_ENABLED:-yes}" -export REDIS_MASTER_HOST="${REDIS_MASTER_HOST:-}" -export REDIS_MASTER_PORT_NUMBER="${REDIS_MASTER_PORT_NUMBER:-6379}" -export REDIS_DEFAULT_PORT_NUMBER="6379" # only used at build time -export REDIS_PORT_NUMBER="${REDIS_PORT_NUMBER:-$REDIS_DEFAULT_PORT_NUMBER}" -export REDIS_ALLOW_REMOTE_CONNECTIONS="${REDIS_ALLOW_REMOTE_CONNECTIONS:-yes}" -export REDIS_REPLICATION_MODE="${REDIS_REPLICATION_MODE:-}" -export REDIS_REPLICA_IP="${REDIS_REPLICA_IP:-}" -export REDIS_REPLICA_PORT="${REDIS_REPLICA_PORT:-}" -export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}" -export REDIS_PASSWORD="${REDIS_PASSWORD:-}" -export REDIS_MASTER_PASSWORD="${REDIS_MASTER_PASSWORD:-}" - -# TLS settings -export REDIS_TLS_ENABLED="${REDIS_TLS_ENABLED:-no}" -REDIS_TLS_PORT_NUMBER="${REDIS_TLS_PORT_NUMBER:-"${REDIS_TLS_PORT:-}"}" -export REDIS_TLS_PORT_NUMBER="${REDIS_TLS_PORT_NUMBER:-6379}" -export REDIS_TLS_CERT_FILE="${REDIS_TLS_CERT_FILE:-}" -export REDIS_TLS_KEY_FILE="${REDIS_TLS_KEY_FILE:-}" -export REDIS_TLS_CA_FILE="${REDIS_TLS_CA_FILE:-}" -export REDIS_TLS_DH_PARAMS_FILE="${REDIS_TLS_DH_PARAMS_FILE:-}" -export REDIS_TLS_AUTH_CLIENTS="${REDIS_TLS_AUTH_CLIENTS:-yes}" - -# Redis Sentinel cluster settings -export REDIS_SENTINEL_MASTER_NAME="${REDIS_SENTINEL_MASTER_NAME:-}" -export REDIS_SENTINEL_HOST="${REDIS_SENTINEL_HOST:-}" -export REDIS_SENTINEL_PORT_NUMBER="${REDIS_SENTINEL_PORT_NUMBER:-26379}" - -# Custom environment variables may be defined below diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh deleted file mode 100755 index b50f640..0000000 --- a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/bash - -# shellcheck disable=SC1091 - -set -o errexit -set -o nounset -set -o pipefail -# set -o xtrace # Uncomment this line for debugging purpose - -# Load Redis environment variables -. /opt/bitnami/scripts/redis-env.sh - -# Load libraries -. /opt/bitnami/scripts/libbitnami.sh -. /opt/bitnami/scripts/libredis.sh - -print_welcome_page - -if [[ "$*" = *"/opt/bitnami/scripts/redis/run.sh"* || "$*" = *"/run.sh"* ]]; then - info "** Starting Redis setup **" - /opt/bitnami/scripts/redis/setup.sh - info "** Redis setup finished! **" -fi - -echo "" -exec "$@" diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh deleted file mode 100755 index 52254db..0000000 --- a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh +++ /dev/null @@ -1,29 +0,0 @@ -#!/bin/bash - -# shellcheck disable=SC1091 - -set -o errexit -set -o nounset -set -o pipefail -# set -o xtrace # Uncomment this line for debugging purpose - -# Load Redis environment variables -. /opt/bitnami/scripts/redis-env.sh - -# Load libraries -. /opt/bitnami/scripts/libredis.sh -. /opt/bitnami/scripts/libfs.sh - -for dir in "$REDIS_VOLUME_DIR" "$REDIS_DATA_DIR" "$REDIS_BASE_DIR" "$REDIS_CONF_DIR"; do - ensure_dir_exists "$dir" -done -chmod -R g+rwX /bitnami "$REDIS_VOLUME_DIR" "$REDIS_BASE_DIR" - -cp "${REDIS_BASE_DIR}/etc/redis-default.conf" "$REDIS_CONF_FILE" -chmod g+rw "$REDIS_CONF_FILE" -# Default Redis config -info "Setting Redis config file..." -redis_conf_set port "$REDIS_DEFAULT_PORT_NUMBER" -redis_conf_set dir "$REDIS_DATA_DIR" -redis_conf_set pidfile "$REDIS_PID_FILE" -redis_conf_set daemonize yes diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh deleted file mode 100755 index 30c3a63..0000000 --- a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh +++ /dev/null @@ -1,33 +0,0 @@ -#!/bin/bash - -# shellcheck disable=SC1091 - -set -o errexit -set -o nounset -set -o pipefail -# set -o xtrace # Uncomment this line for debugging purposes - -# Load Redis environment variables -. /opt/bitnami/scripts/redis-env.sh - -# Load libraries -. /opt/bitnami/scripts/libos.sh -. /opt/bitnami/scripts/libredis.sh - -# Constants -REDIS_EXTRA_FLAGS=${REDIS_EXTRA_FLAGS:-} - -# Parse CLI flags to pass to the 'redis-server' call -args=("$REDIS_BASE_DIR/etc/redis.conf" "--daemonize" "no") -# Add flags specified via the 'REDIS_EXTRA_FLAGS' environment variable -read -r -a extra_flags <<< "$REDIS_EXTRA_FLAGS" -[[ "${#extra_flags[@]}" -gt 0 ]] && args+=("${extra_flags[@]}") -# Add flags passed to this script -args+=("$@") - -info "** Starting Redis **" -if am_i_root; then - exec gosu "$REDIS_DAEMON_USER" redis-server "${args[@]}" -else - exec redis-server "${args[@]}" -fi diff --git a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh b/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh deleted file mode 100755 index d54a3cf..0000000 --- a/6.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh +++ /dev/null @@ -1,23 +0,0 @@ -#!/bin/bash - -# shellcheck disable=SC1091 - -set -o errexit -set -o nounset -set -o pipefail -# set -o xtrace # Uncomment this line for debugging purposes - -# Load Redis environment variables -. /opt/bitnami/scripts/redis-env.sh - -# Load libraries -. /opt/bitnami/scripts/libos.sh -. /opt/bitnami/scripts/libfs.sh -. /opt/bitnami/scripts/libredis.sh - -# Ensure Redis environment variables settings are valid -redis_validate -# Ensure Redis daemon user exists when running as root -am_i_root && ensure_user_exists "$REDIS_DAEMON_USER" --group "$REDIS_DAEMON_GROUP" -# Ensure Redis is initialized -redis_initialize diff --git a/5.0/debian-10/Dockerfile b/Dockerfile similarity index 92% rename from 5.0/debian-10/Dockerfile rename to Dockerfile index 91dc148..e534462 100644 --- a/5.0/debian-10/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -ARG BASE_REGISTRY=registry1.dsop.io +ARG BASE_REGISTRY=registry1.dso.mil ARG BASE_IMAGE=ironbank/redhat/openjdk/openjdk11 ARG BASE_TAG=1.11 @@ -50,7 +50,7 @@ WORKDIR ${REDIS_HOME} EXPOSE 6379 -HEALTHCHECK --interval=10s --timeout=5s --retries=3 CMD zkServer.sh status || exit 1 +HEALTHCHECK NONE ENTRYPOINT [ "/opt/bitnami/scripts/redis/entrypoint.sh" ] CMD [ "/opt/bitnami/scripts/redis/run.sh" ] diff --git a/docker-compose-replicaset.yml b/docker-compose-replicaset.yml deleted file mode 100644 index 90d1892..0000000 --- a/docker-compose-replicaset.yml +++ /dev/null @@ -1,31 +0,0 @@ -version: '2' - -services: - redis-primary: - image: 'docker.io/bitnami/redis:6.0-debian-10' - ports: - - '6379' - environment: - - REDIS_REPLICATION_MODE=master - - REDIS_PASSWORD=my_password - - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL - volumes: - - 'redis_data:/bitnami/redis/data' - - redis-secondary: - image: 'docker.io/bitnami/redis:6.0-debian-10' - ports: - - '6379' - depends_on: - - redis-primary - environment: - - REDIS_REPLICATION_MODE=slave - - REDIS_MASTER_HOST=redis-primary - - REDIS_MASTER_PORT_NUMBER=6379 - - REDIS_MASTER_PASSWORD=my_password - - REDIS_PASSWORD=my_password - - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL - -volumes: - redis_data: - driver: local diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index cb198cb..0000000 --- a/docker-compose.yml +++ /dev/null @@ -1,17 +0,0 @@ -version: '2' - -services: - redis: - image: 'docker.io/bitnami/redis:6.0-debian-10' - environment: - # ALLOW_EMPTY_PASSWORD is recommended only for development. - - ALLOW_EMPTY_PASSWORD=yes - - REDIS_DISABLE_COMMANDS=FLUSHDB,FLUSHALL - ports: - - '6379:6379' - volumes: - - 'redis_data:/bitnami/redis/data' - -volumes: - redis_data: - driver: local diff --git a/5.0/debian-10/hardening_manifest.yaml b/hardening_manifest.yaml similarity index 94% rename from 5.0/debian-10/hardening_manifest.yaml rename to hardening_manifest.yaml index 6060994..f5cda38 100644 --- a/5.0/debian-10/hardening_manifest.yaml +++ b/hardening_manifest.yaml @@ -6,9 +6,9 @@ name: "bitnami/redis" # List of tags to push for the repository in registry1 # The most specific version should be the first tag and will be shown -# on ironbank.dsop.io +# on ironbank.dso.mil tags: -- "3.6.2" +- "6.0.4" # Build args passed to Dockerfile ARGs args: @@ -26,7 +26,7 @@ labels: org.opencontainers.image.url: "https://bitnami.com/stack/redis/containers" ## Name of the distributing entity, organization or individual org.opencontainers.image.vendor: "Bitnami" - org.opencontainers.image.version: "3.6.2" + org.opencontainers.image.version: "6.0.4" ## Keywords to help with search (ex. "cicd,gitops,golang") mil.dso.ironbank.image.keywords: "dataflow,streaming" ## This value can be "opensource" or "commercial" diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/scripts/libbitnami.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh rename to scripts/libbitnami.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh b/scripts/libcomponent.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh rename to scripts/libcomponent.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh b/scripts/libfile.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh rename to scripts/libfile.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh b/scripts/libfs.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh rename to scripts/libfs.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh b/scripts/libhook.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libhook.sh rename to scripts/libhook.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh b/scripts/liblog.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh rename to scripts/liblog.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh b/scripts/libnet.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh rename to scripts/libnet.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh b/scripts/libos.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh rename to scripts/libos.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/scripts/libpersistence.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libpersistence.sh rename to scripts/libpersistence.sh diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh b/scripts/libredis.sh similarity index 100% rename from 5.0/debian-10/rootfs/opt/bitnami/scripts/libredis.sh rename to scripts/libredis.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh b/scripts/libservice.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh rename to scripts/libservice.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh b/scripts/libvalidations.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh rename to scripts/libvalidations.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh b/scripts/libversion.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh rename to scripts/libversion.sh diff --git a/5.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/scripts/libwebserver.sh similarity index 100% rename from 5.0/debian-10/prebuildfs/opt/bitnami/scripts/libwebserver.sh rename to scripts/libwebserver.sh diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh b/scripts/redis-env.sh similarity index 100% rename from 5.0/debian-10/rootfs/opt/bitnami/scripts/redis-env.sh rename to scripts/redis-env.sh diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh b/scripts/redis/entrypoint.sh similarity index 100% rename from 5.0/debian-10/rootfs/opt/bitnami/scripts/redis/entrypoint.sh rename to scripts/redis/entrypoint.sh diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh b/scripts/redis/postunpack.sh similarity index 100% rename from 5.0/debian-10/rootfs/opt/bitnami/scripts/redis/postunpack.sh rename to scripts/redis/postunpack.sh diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh b/scripts/redis/run.sh similarity index 100% rename from 5.0/debian-10/rootfs/opt/bitnami/scripts/redis/run.sh rename to scripts/redis/run.sh diff --git a/5.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh b/scripts/redis/setup.sh similarity index 100% rename from 5.0/debian-10/rootfs/opt/bitnami/scripts/redis/setup.sh rename to scripts/redis/setup.sh -- GitLab From 23b29bf639b5d13dd480c52f67961a680a7ad4b8 Mon Sep 17 00:00:00 2001 From: Christopher Recla Date: Wed, 17 Feb 2021 17:45:50 -0700 Subject: [PATCH 3/3] Update sha256 from docker hub --- hardening_manifest.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hardening_manifest.yaml b/hardening_manifest.yaml index f5cda38..b7459aa 100644 --- a/hardening_manifest.yaml +++ b/hardening_manifest.yaml @@ -37,7 +37,7 @@ labels: # List of resources to make available to the offline build context resources: - tag: bitnami/redis:6.0.4 - url: docker://docker.io/bitnami/redis@sha256:b9e6ff6325a798c7c7c1cf0d45724f3c490d2916b0725f7151873f54d1275203 + url: docker://docker.io/bitnami/redis@sha256:95846af0d76358b676b6d76dc05831572d62d5f8f25e43d28daf4756dee30dd7 # List of project maintainers maintainers: -- GitLab