diff --git a/bitnami/rabbitmq/3.12/debian-12/Dockerfile b/bitnami/rabbitmq/3.12/debian-12/Dockerfile new file mode 100644 index 000000000000..04e0321dbd24 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/Dockerfile @@ -0,0 +1,63 @@ +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +FROM docker.io/bitnami/minideb:bookworm + +ARG TARGETARCH + +LABEL com.vmware.cp.artifact.flavor="sha256:c50c90cfd9d12b445b011e6ad529f1ad3daea45c26d20b00732fae3cd71f6a83" \ + org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \ + org.opencontainers.image.created="2024-02-16T18:17:31Z" \ + org.opencontainers.image.description="Application packaged by VMware, Inc" \ + org.opencontainers.image.licenses="Apache-2.0" \ + org.opencontainers.image.ref.name="3.12.13-debian-12-r0" \ + org.opencontainers.image.title="rabbitmq" \ + org.opencontainers.image.vendor="VMware, Inc." \ + org.opencontainers.image.version="3.12.13" + +ENV HOME="/opt/bitnami/rabbitmq/.rabbitmq" \ + OS_ARCH="${TARGETARCH:-amd64}" \ + OS_FLAVOUR="debian-12" \ + OS_NAME="linux" \ + PATH="/opt/bitnami/erlang/bin:/opt/bitnami/rabbitmq/sbin:$PATH" + +COPY prebuildfs / +SHELL ["/bin/bash", "-o", "errexit", "-o", "nounset", "-o", "pipefail", "-c"] +# Install required system packages and dependencies +RUN install_packages ca-certificates curl libgcc-s1 libssl3 libstdc++6 libtinfo6 locales procps zlib1g +RUN mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ ; \ + COMPONENTS=( \ + "erlang-26.2.2-0-linux-${OS_ARCH}-debian-12" \ + "rabbitmq-3.12.13-0-linux-${OS_ARCH}-debian-12" \ + ) ; \ + for COMPONENT in "${COMPONENTS[@]}"; do \ + if [ ! -f "${COMPONENT}.tar.gz" ]; then \ + curl -SsLf "https://downloads.bitnami.com/files/stacksmith/${COMPONENT}.tar.gz" -O ; \ + curl -SsLf "https://downloads.bitnami.com/files/stacksmith/${COMPONENT}.tar.gz.sha256" -O ; \ + fi ; \ + sha256sum -c "${COMPONENT}.tar.gz.sha256" ; \ + tar -zxf "${COMPONENT}.tar.gz" -C /opt/bitnami --strip-components=2 --no-same-owner --wildcards '*/files' ; \ + rm -rf "${COMPONENT}".tar.gz{,.sha256} ; \ + done +RUN apt-get update && apt-get upgrade -y && \ + apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives +RUN chmod g+rwX /opt/bitnami +RUN localedef -c -f UTF-8 -i en_US en_US.UTF-8 +RUN find / -perm /6000 -type f -exec chmod a-s {} \; || true +RUN update-locale LANG=C.UTF-8 LC_MESSAGES=POSIX && \ + DEBIAN_FRONTEND=noninteractive dpkg-reconfigure locales +RUN echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && locale-gen + +COPY rootfs / +RUN /opt/bitnami/scripts/rabbitmq/postunpack.sh +RUN /opt/bitnami/scripts/locales/add-extra-locales.sh +ENV APP_VERSION="3.12.13" \ + BITNAMI_APP_NAME="rabbitmq" \ + LANG="en_US.UTF-8" \ + LANGUAGE="en_US:en" + +EXPOSE 4369 5551 5552 5671 5672 15671 15672 25672 + +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/rabbitmq/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/rabbitmq/run.sh" ] diff --git a/bitnami/rabbitmq/3.12/debian-12/config/advanced.config b/bitnami/rabbitmq/3.12/debian-12/config/advanced.config new file mode 100644 index 000000000000..cec04867a677 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/config/advanced.config @@ -0,0 +1,4 @@ +[{rabbitmq_auth_backend_ldap,[ + {tag_queries, [{administrator, {constant, false}}, + {management, {constant, true}}]} +]}]. diff --git a/bitnami/rabbitmq/3.12/debian-12/docker-compose.yml b/bitnami/rabbitmq/3.12/debian-12/docker-compose.yml new file mode 100644 index 000000000000..706555afcb03 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/docker-compose.yml @@ -0,0 +1,23 @@ +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +version: '2' + +services: + rabbitmq: + image: docker.io/bitnami/rabbitmq:3.12 + ports: + - '4369:4369' + - '5551:5551' + - '5552:5552' + - '5672:5672' + - '25672:25672' + - '15672:15672' + environment: + - RABBITMQ_SECURE_PASSWORD=yes + - RABBITMQ_LOGS=- + volumes: + - 'rabbitmq_data:/bitnami/rabbitmq/mnesia' +volumes: + rabbitmq_data: + driver: local diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json new file mode 100644 index 000000000000..df1290e5e51a --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json @@ -0,0 +1,14 @@ +{ + "erlang": { + "arch": "amd64", + "distro": "debian-12", + "type": "NAMI", + "version": "26.2.2-0" + }, + "rabbitmq": { + "arch": "amd64", + "distro": "debian-12", + "type": "NAMI", + "version": "3.12.13-0" + } +} \ No newline at end of file diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 000000000000..76956b38e82c --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,2 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 000000000000..3853c789b2ea --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,53 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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/containers" + + info "" + info "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + info "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" + info "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" + info "" +} + diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 000000000000..63759c777f3b --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,141 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for managing files + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libos.sh + +# Functions + +######################## +# Replace a regex-matching string 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 + local -r 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" +} + +######################## +# Replace a regex-matching multiline string in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# Returns: +# None +######################### +replace_in_file_multiline() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + + local result + local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + result="$(perl -pe "BEGIN{undef $/;} s${del}${match_regex}${del}${substitute_regex}${del}sg" "$filename")" + 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" +} + +######################## +# Wait until certain entry is present in a log file +# Arguments: +# $1 - entry to look for +# $2 - log file +# $3 - max retries. Default: 12 +# $4 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +wait_for_log_entry() { + local -r entry="${1:-missing entry}" + local -r log_file="${2:-missing log file}" + local -r retries="${3:-12}" + local -r interval_time="${4:-5}" + local attempt=0 + + check_log_file_for_entry() { + if ! grep -qE "$entry" "$log_file"; then + debug "Entry \"${entry}\" still not present in ${log_file} (attempt $((++attempt))/${retries})" + return 1 + fi + } + debug "Checking that ${log_file} log file contains entry \"${entry}\"" + if retry_while check_log_file_for_entry "$retries" "$interval_time"; then + debug "Found entry \"${entry}\" in ${log_file}" + true + else + error "Could not find entry \"${entry}\" in ${log_file} after ${retries} retries" + debug_execute cat "$log_file" + return 1 + fi +} diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 000000000000..96b22f99710c --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,193 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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}" + local group="${3:-}" + + if [[ -n $group ]]; then + chown "$owner":"$group" "$path" + else + chown "$owner":"$owner" "$path" + fi +} + +######################## +# 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_user="${2:-}" + local owner_group="${3:-}" + + [ -d "${dir}" ] || mkdir -p "${dir}" + if [[ -n $owner_user ]]; then + owned_by "$dir" "$owner_user" "$owner_group" + fi +} + +######################## +# Checks whether a directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_dir_empty() { + local -r path="${1:?missing directory}" + # Calculate real path in order to avoid issues with symlinks + local -r dir="$(realpath "$path")" + 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 || exit + realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' + popd >/dev/null || exit +} + +######################## +# 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 + find -L "$p" -printf "" + if [[ -n $dir_mode ]]; then + find -L "$p" -type d ! -perm "$dir_mode" -print0 | xargs -r -0 chmod "$dir_mode" + fi + if [[ -n $file_mode ]]; then + find -L "$p" -type f ! -perm "$file_mode" -print0 | xargs -r -0 chmod "$file_mode" + fi + if [[ -n $user ]] && [[ -n $group ]]; then + find -L "$p" -print0 | xargs -r -0 chown "${user}:${group}" + elif [[ -n $user ]] && [[ -z $group ]]; then + find -L "$p" -print0 | xargs -r -0 chown "${user}" + elif [[ -z $user ]] && [[ -n $group ]]; then + find -L "$p" -print0 | xargs -r -0 chgrp "${group}" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 000000000000..dadd06149e00 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 000000000000..2a9e76a4d725 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,114 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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 + # shellcheck disable=SC2001 + # Complex regex, see https://github.com/koalaman/shellcheck/wiki/SC2001#exceptions + echo "$string" | sed "s/^/${indent_unit}/" +} diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 000000000000..b47c69a56825 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,165 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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}]}" +} + +######################## +# Wait for a HTTP connection to succeed +# Globals: +# * +# Arguments: +# $1 - URL to wait for +# $2 - Maximum amount of retries (optional) +# $3 - Time between retries (optional) +# Returns: +# true if the HTTP connection succeeded, false otherwise +######################### +wait_for_http_connection() { + local url="${1:?missing url}" + local retries="${2:-}" + local sleep_time="${3:-}" + if ! retry_while "debug_execute curl --silent ${url}" "$retries" "$sleep_time"; then + error "Could not connect to ${url}" + return 1 + fi +} diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 000000000000..c0500acee78d --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,657 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libvalidations.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: +# -i|--gid - the ID for the new group +# -s|--system - Whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + local gid="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --gid) + shift + gid="${1:?missing gid}" + ;; + -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") + if [[ -n "$gid" ]]; then + if group_exists "$gid"; then + error "The GID $gid is already in use." >&2 + return 1 + fi + args+=("--gid" "$gid") + fi + $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: +# -i|--uid - the ID for the new user +# -g|--group - the group the new user should belong to +# -a|--append-groups - comma-separated list of supplemental groups to append to the new user +# -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 uid="" + local group="" + local append_groups="" + local home="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --uid) + shift + uid="${1:?missing uid}" + ;; + -g | --group) + shift + group="${1:?missing group}" + ;; + -a | --append-groups) + shift + append_groups="${1:?missing append_groups}" + ;; + -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") + if [[ -n "$uid" ]]; then + if user_exists "$uid"; then + error "The UID $uid is already in use." + return 1 + fi + user_args+=("--uid" "$uid") + else + $is_system_user && user_args+=("--system") + fi + 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 "$append_groups" ]]; then + local -a groups + read -ra groups <<<"$(tr ',;' ' ' <<<"$append_groups")" + for group in "${groups[@]}"; do + ensure_group_exists "$group" + usermod -aG "$group" "$user" >/dev/null 2>&1 + done + 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 +} + +######################## +# Print OS metadata +# Arguments: +# $1 - Flag name +# Flags: +# --id - Distro ID +# --version - Distro version +# --branch - Distro branch +# --codename - Distro codename +# --name - Distro name +# --pretty-name - Distro pretty name +# Returns: +# String +######################### +get_os_metadata() { + local -r flag_name="${1:?missing flag}" + # Helper function + get_os_release_metadata() { + local -r env_name="${1:?missing environment variable name}" + ( + . /etc/os-release + echo "${!env_name}" + ) + } + case "$flag_name" in + --id) + get_os_release_metadata ID + ;; + --version) + get_os_release_metadata VERSION_ID + ;; + --branch) + get_os_release_metadata VERSION_ID | sed 's/\..*//' + ;; + --codename) + get_os_release_metadata VERSION_CODENAME + ;; + --name) + get_os_release_metadata NAME + ;; + --pretty-name) + get_os_release_metadata PRETTY_NAME + ;; + *) + error "Unknown flag ${flag_name}" + return 1 + ;; + esac +} + +######################## +# 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 is_boolean_yes "${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:]" + ;; + numeric) + filter="0-9" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + alphanumeric+special|special+alphanumeric) + # Limit variety of special characters, so there is a higher chance of containing more alphanumeric characters + # Special characters are harder to write, and it could impact the overall UX if most passwords are too complex + filter='a-zA-Z0-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}' +} + +######################## +# Create sha1 hash from a string +# Arguments: +# $1 - string +# $2 - algorithm - 1 (default), 224, 256, 384, 512 +# Returns: +# sha1 hash - string +######################### +generate_sha_hash() { + local -r str="${1:?missing input string}" + local -r algorithm="${2:-1}" + echo -n "$str" | "sha${algorithm}sum" | awk '{print $1}' +} + +######################## +# Converts a string to its hexadecimal representation +# Arguments: +# $1 - string +# Returns: +# hexadecimal representation of the string +######################### +convert_to_hex() { + local -r str=${1:?missing input string} + local -i iterator + local char + for ((iterator = 0; iterator < ${#str}; iterator++)); do + char=${str:iterator:1} + printf '%x' "'${char}" + done +} + +######################## +# Get boot time +# Globals: +# None +# Arguments: +# None +# Returns: +# Boot time metadata +######################### +get_boot_time() { + stat /proc --format=%Y +} + +######################## +# Get machine ID +# Globals: +# None +# Arguments: +# None +# Returns: +# Machine ID +######################### +get_machine_id() { + local machine_id + if [[ -f /etc/machine-id ]]; then + machine_id="$(cat /etc/machine-id)" + fi + if [[ -z "$machine_id" ]]; then + # Fallback to the boot-time, which will at least ensure a unique ID in the current session + machine_id="$(get_boot_time)" + fi + echo "$machine_id" +} + +######################## +# Get the root partition's disk device ID (e.g. /dev/sda1) +# Globals: +# None +# Arguments: +# None +# Returns: +# Root partition disk ID +######################### +get_disk_device_id() { + local device_id="" + if grep -q ^/dev /proc/mounts; then + device_id="$(grep ^/dev /proc/mounts | awk '$2 == "/" { print $1 }' | tail -1)" + fi + # If it could not be autodetected, fallback to /dev/sda1 as a default + if [[ -z "$device_id" || ! -b "$device_id" ]]; then + device_id="/dev/sda1" + fi + echo "$device_id" +} + +######################## +# Get the root disk device ID (e.g. /dev/sda) +# Globals: +# None +# Arguments: +# None +# Returns: +# Root disk ID +######################### +get_root_disk_device_id() { + get_disk_device_id | sed -E 's/p?[0-9]+$//' +} + +######################## +# Get the root disk size in bytes +# Globals: +# None +# Arguments: +# None +# Returns: +# Root disk size in bytes +######################### +get_root_disk_size() { + fdisk -l "$(get_root_disk_device_id)" | grep 'Disk.*bytes' | sed -E 's/.*, ([0-9]+) bytes,.*/\1/' || true +} + +######################## +# Run command as a specific user and group (optional) +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Returns: +# Exit code of the specified command +######################### +run_as_user() { + run_chroot "$@" +} + +######################## +# Execute command as a specific user and group (optional), +# replacing the current process image +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Returns: +# Exit code of the specified command +######################### +exec_as_user() { + run_chroot --replace-process "$@" +} + +######################## +# Run a command using chroot +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Flags: +# -r | --replace-process - Replace the current process image (optional) +# Returns: +# Exit code of the specified command +######################### +run_chroot() { + local userspec + local user + local homedir + local replace=false + local -r cwd="$(pwd)" + + # Parse and validate flags + while [[ "$#" -gt 0 ]]; do + case "$1" in + -r | --replace-process) + replace=true + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + # Parse and validate arguments + if [[ "$#" -lt 2 ]]; then + echo "expected at least 2 arguments" + return 1 + else + userspec=$1 + shift + + # userspec can optionally include the group, so we parse the user + user=$(echo "$userspec" | cut -d':' -f1) + fi + + if ! am_i_root; then + error "Could not switch to '${userspec}': Operation not permitted" + return 1 + fi + + # Get the HOME directory for the user to switch, as chroot does + # not properly update this env and some scripts rely on it + homedir=$(eval echo "~${user}") + if [[ ! -d $homedir ]]; then + homedir="${HOME:-/}" + fi + + # Obtaining value for "$@" indirectly in order to properly support shell parameter expansion + if [[ "$replace" = true ]]; then + exec chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@" + else + chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@" + fi +} diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 000000000000..af6af64d6dd0 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,124 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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 <<< "$(tr ',;:' ' ' <<< "$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[@]}" -le 0 ]]; then + warn "No files are configured to be persisted" + return + fi + pushd "$install_dir" >/dev/null || exit + 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 || exit + 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 || exit + done + popd >/dev/null || exit + 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 <<< "$(tr ',;:' ' ' <<< "$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[@]}" -le 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/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 000000000000..107f54e6b5c9 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,496 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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="* * * * *" + local clean="true" + + # Parse optional CLI flags + shift 2 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --run-as) + shift + run_as="$1" + ;; + --schedule) + shift + schedule="$1" + ;; + --no-clean) + clean="false" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + mkdir -p /etc/cron.d + if "$clean"; then + cat > "/etc/cron.d/${service_name}" <> /etc/cron.d/"$service_name" + fi +} + +######################## +# Remove a cron configuration file for a given service +# Arguments: +# $1 - Service name +# Returns: +# None +######################### +remove_cron_conf() { + local service_name="${1:?service name is missing}" + local cron_conf_dir="/etc/monit/conf.d" + rm -f "${cron_conf_dir}/${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: +# --disable - 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 + --disable) + disabled="yes" + ;; + *) + 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}" +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +${log_path} { + ${period} + rotate ${rotations} + dateext + compress + copytruncate + missingok +$(indent "$extra" 2) +} +EOF +} + +######################## +# Remove a logrotate configuration file +# Arguments: +# $1 - Service name +# Returns: +# None +######################### +remove_logrotate_conf() { + local service_name="${1:?service name is missing}" + local logrotate_conf_dir="/etc/logrotate.d" + rm -f "${logrotate_conf_dir}/${service_name}" +} + +######################## +# Generate a Systemd configuration file +# Arguments: +# $1 - Service name +# Flags: +# --custom-service-content - Custom content to add to the [service] block +# --environment - Environment variable to define (multiple --environment options may be passed) +# --environment-file - Text file with environment variables (multiple --environment-file options may be passed) +# --exec-start - Start command (required) +# --exec-start-pre - Pre-start command (optional) +# --exec-start-post - Post-start command (optional) +# --exec-stop - Stop command (optional) +# --exec-reload - Reload command (optional) +# --group - System group to start the service with +# --name - Service full name (e.g. Apache HTTP Server, defaults to $1) +# --restart - When to restart the Systemd service after being stopped (defaults to always) +# --pid-file - Service PID file +# --standard-output - File where to print stdout output +# --standard-error - File where to print stderr output +# --success-exit-status - Exit code that indicates a successful shutdown +# --type - Systemd unit type (defaults to forking) +# --user - System user to start the service with +# --working-directory - Working directory at which to start the service +# Returns: +# None +######################### +generate_systemd_conf() { + local -r service_name="${1:?service name is missing}" + local -r systemd_units_dir="/etc/systemd/system" + local -r service_file="${systemd_units_dir}/bitnami.${service_name}.service" + # Default values + local name="$service_name" + local type="forking" + local user="" + local group="" + local environment="" + local environment_file="" + local exec_start="" + local exec_start_pre="" + local exec_start_post="" + local exec_stop="" + local exec_reload="" + local restart="always" + local pid_file="" + local standard_output="journal" + local standard_error="" + local limits_content="" + local success_exit_status="" + local custom_service_content="" + local working_directory="" + # Parse CLI flags + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --name \ + | --type \ + | --user \ + | --group \ + | --exec-start \ + | --exec-stop \ + | --exec-reload \ + | --restart \ + | --pid-file \ + | --standard-output \ + | --standard-error \ + | --success-exit-status \ + | --custom-service-content \ + | --working-directory \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "$var_name"="${1:?"${var_name} value is missing"}" + ;; + --limit-*) + [[ -n "$limits_content" ]] && limits_content+=$'\n' + var_name="${1//--limit-}" + shift + limits_content+="Limit${var_name^^}=${1:?"--limit-${var_name} value is missing"}" + ;; + --exec-start-pre) + shift + [[ -n "$exec_start_pre" ]] && exec_start_pre+=$'\n' + exec_start_pre+="ExecStartPre=${1:?"--exec-start-pre value is missing"}" + ;; + --exec-start-post) + shift + [[ -n "$exec_start_post" ]] && exec_start_post+=$'\n' + exec_start_post+="ExecStartPost=${1:?"--exec-start-post value is missing"}" + ;; + --environment) + shift + # It is possible to add multiple environment lines + [[ -n "$environment" ]] && environment+=$'\n' + environment+="Environment=${1:?"--environment value is missing"}" + ;; + --environment-file) + shift + # It is possible to add multiple environment-file lines + [[ -n "$environment_file" ]] && environment_file+=$'\n' + environment_file+="EnvironmentFile=${1:?"--environment-file value is missing"}" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + # Validate inputs + local error="no" + if [[ -z "$exec_start" ]]; then + error "The --exec-start option is required" + error="yes" + fi + if [[ "$error" != "no" ]]; then + return 1 + fi + # Generate the Systemd unit + cat > "$service_file" <> "$service_file" <<< "WorkingDirectory=${working_directory}" + fi + if [[ -n "$exec_start_pre" ]]; then + # This variable may contain multiple ExecStartPre= directives + cat >> "$service_file" <<< "$exec_start_pre" + fi + if [[ -n "$exec_start" ]]; then + cat >> "$service_file" <<< "ExecStart=${exec_start}" + fi + if [[ -n "$exec_start_post" ]]; then + # This variable may contain multiple ExecStartPost= directives + cat >> "$service_file" <<< "$exec_start_post" + fi + # Optional stop and reload commands + if [[ -n "$exec_stop" ]]; then + cat >> "$service_file" <<< "ExecStop=${exec_stop}" + fi + if [[ -n "$exec_reload" ]]; then + cat >> "$service_file" <<< "ExecReload=${exec_reload}" + fi + # User and group + if [[ -n "$user" ]]; then + cat >> "$service_file" <<< "User=${user}" + fi + if [[ -n "$group" ]]; then + cat >> "$service_file" <<< "Group=${group}" + fi + # PID file allows to determine if the main process is running properly (for Restart=always) + if [[ -n "$pid_file" ]]; then + cat >> "$service_file" <<< "PIDFile=${pid_file}" + fi + if [[ -n "$restart" ]]; then + cat >> "$service_file" <<< "Restart=${restart}" + fi + # Environment flags + if [[ -n "$environment" ]]; then + # This variable may contain multiple Environment= directives + cat >> "$service_file" <<< "$environment" + fi + if [[ -n "$environment_file" ]]; then + # This variable may contain multiple EnvironmentFile= directives + cat >> "$service_file" <<< "$environment_file" + fi + # Logging + if [[ -n "$standard_output" ]]; then + cat >> "$service_file" <<< "StandardOutput=${standard_output}" + fi + if [[ -n "$standard_error" ]]; then + cat >> "$service_file" <<< "StandardError=${standard_error}" + fi + if [[ -n "$custom_service_content" ]]; then + # This variable may contain multiple miscellaneous directives + cat >> "$service_file" <<< "$custom_service_content" + fi + if [[ -n "$success_exit_status" ]]; then + cat >> "$service_file" <> "$service_file" <> "$service_file" <> "$service_file" <= 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 a boolean 1/0 value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_1_0_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^[10]$ ]]; 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 IPv6 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ipv6() { + local ip="${1:?ip is missing}" + local stat=1 + local full_address_regex='^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$' + local short_address_regex='^((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}){0,6}::(([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}){0,6})$' + + if [[ $ip =~ $full_address_regex || $ip =~ $short_address_regex || $ip == "::" ]]; then + stat=0 + fi + return $stat +} + +######################## +# 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 if the provided argument is a valid IPv4 or IPv6 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ip() { + local ip="${1:?ip is missing}" + local stat=1 + + if validate_ipv4 "$ip"; then + stat=0 + else + stat=$(validate_ipv6 "$ip") + 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/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 000000000000..6ca71ac7bdbb --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 000000000000..8023f9b0549a --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,476 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# 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" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl start "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" + fi +} + +######################## +# Stop web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_stop() { + info "Stopping $(web_server_type)" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl stop "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" + fi +} + +######################## +# Restart web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_restart() { + info "Restarting $(web_server_type)" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl restart "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" + fi +} + +######################## +# Reload web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_reload() { + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl reload "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" + fi +} + +######################## +# 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: +# --type - Application type, which has an effect on which configuration template to use +# --hosts - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disable - Whether to render server configurations with a .disabled prefix +# --disable-http - Whether to render the app's HTTP server configuration with a .disabled prefix +# --disable-https - Whether to render the app's HTTPS server configuration with a .disabled prefix +# --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-additional-http-configuration - Additional HTTP vhost configuration (no default) +# --apache-additional-https-configuration - Additional HTTPS 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' and type is not defined) +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-proxy-address - Address where to proxy requests +# --apache-proxy-configuration - Extra configuration for the proxy +# --apache-proxy-http-configuration - Extra configuration for the proxy HTTP vhost +# --apache-proxy-https-configuration - Extra configuration for the proxy HTTPS vhost +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup (only allowed when type is not defined) +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# --nginx-external-configuration - Configuration external to server block (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 + --disable \ + | --disable-http \ + | --disable-https \ + ) + apache_args+=("$1") + nginx_args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --type \ + | --allow-remote-connections \ + | --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-additional-http-configuration \ + | --apache-additional-https-configuration \ + | --apache-before-vhost-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-proxy-address \ + | --apache-proxy-configuration \ + | --apache-proxy-http-configuration \ + | --apache-proxy-https-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "${2:?missing value}") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration \ + | --nginx-external-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 - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --enable-http - Enable HTTP app configuration (if not enabled already) +# --enable-https - Enable HTTPS app configuration (if not enabled already) +# --disable-http - Disable HTTP app configuration (if not disabled already) +# --disable-https - Disable HTTPS app configuration (if not disabled already) +# --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 + --enable-http \ + | --enable-https \ + | --disable-http \ + | --disable-https \ + ) + args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --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/bitnami/rabbitmq/3.12/debian-12/prebuildfs/usr/sbin/install_packages b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/usr/sbin/install_packages new file mode 100755 index 000000000000..acbc3173208c --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,27 @@ +#!/bin/sh +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +set -eu + +n=0 +max=2 +export DEBIAN_FRONTEND=noninteractive + +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 +apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives diff --git a/bitnami/rabbitmq/3.12/debian-12/prebuildfs/usr/sbin/run-script b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/usr/sbin/run-script new file mode 100755 index 000000000000..4ca0f897277e --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/prebuildfs/usr/sbin/run-script @@ -0,0 +1,24 @@ +#!/bin/sh +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +set -u + +if [ $# -eq 0 ]; then + >&2 echo "No arguments provided" + exit 1 +fi + +script=$1 +exit_code="${2:-96}" +fail_if_not_present="${3:-n}" + +if test -f "$script"; then + sh $script + + if [ $? -ne 0 ]; then + exit $((exit_code)) + fi +elif [ "$fail_if_not_present" = "y" ]; then + >&2 echo "script not found: $script" + exit 127 +fi diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/librabbitmq.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/librabbitmq.sh new file mode 100644 index 000000000000..c8205f2f014d --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/librabbitmq.sh @@ -0,0 +1,901 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami RabbitMQ library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Validate settings in RABBITMQ_* environment variables +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_validate() { + info "Validating settings in RABBITMQ_* env vars.." + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + check_yes_no_value() { + if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}"; then + print_validation_error "An invalid value was specified in the environment variable ${1}. Valid values are: yes or no" + fi + } + check_true_false_value() { + if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}"; then + print_validation_error "An invalid value was specified in the environment variable ${1}. Valid values are: true or false" + fi + } + check_multi_value() { + if [[ " ${2} " != *" ${!1} "* ]]; then + print_validation_error "The allowed values for ${1} are: ${2}" + fi + } + check_conflicting_ports() { + local -r total="$#" + for i in $(seq 1 "$((total - 1))"); do + for j in $(seq "$((i + 1))" "$total"); do + if (("${!i}" == "${!j}")); then + print_validation_error "${!i} and ${!j} are bound to the same port" + fi + done + done + } + check_allowed_port() { + local port_var="${1:?missing port variable}" + local -a validate_port_args=() + ! am_i_root && validate_port_args+=("-unprivileged") + validate_port_args+=("${!port_var}") + if ! err="$(validate_port "${validate_port_args[@]}")"; then + print_validation_error "An invalid port was specified in the environment variable ${port_var}: ${err}." + fi + } + + check_fqdn() { + if [[ "${!1}" == *.* ]]; then + if [[ "${RABBITMQ_USE_LONGNAME}" = false ]]; then + print_validation_error "The node name appears to be a fully qualified hostname and RABBITMQ_USE_LONGNAME is not set." + fi + fi + } + + check_file_exists_or_path_writable() { + local path_to_check="${!1}" + local full_path_to_check + full_path_to_check=$(realpath "${path_to_check}") + local path_directory_to_check="${full_path_to_check%/*}" + + # check if given path is empty + if [[ -z "${path_to_check}" ]]; then + # not okay if the given path is empty + print_validation_error "The variable ${1} must be set to either an existant file or a non-existant file in a writable directory." + fi + # check if file at given path exists + if [[ ! -f "${path_to_check}" ]]; then + # if the file does not exist, check if the directory is writable + if [[ ! -w "${path_directory_to_check}" ]]; then + # not okay if not writable + print_validation_error "The variable ${1} must be set to either an existant file or a non-existant file in a writable directory." + fi + # ok if writable + fi + # ok if the file exists + } + + check_yes_no_value "RABBITMQ_LOAD_DEFINITIONS" + check_yes_no_value "RABBITMQ_SECURE_PASSWORD" + check_yes_no_value "RABBITMQ_ENABLE_LDAP" + check_yes_no_value "RABBITMQ_LDAP_TLS" + check_conflicting_ports "RABBITMQ_MANAGEMENT_PORT_NUMBER" "RABBITMQ_NODE_PORT_NUMBER" "RABBITMQ_MANAGEMENT_SSL_PORT_NUMBER" "RABBITMQ_NODE_SSL_PORT_NUMBER" + check_multi_value "RABBITMQ_SSL_VERIFY" "verify_none verify_peer" + check_multi_value "RABBITMQ_MANAGEMENT_SSL_VERIFY" "verify_none verify_peer" + check_file_exists_or_path_writable "RABBITMQ_COMBINED_CERT_PATH" + check_true_false_value "RABBITMQ_USE_LONGNAME" + check_fqdn "RABBITMQ_NODE_NAME" + + if is_boolean_yes "$RABBITMQ_LOAD_DEFINITIONS"; then + if [[ -f "$RABBITMQ_DEFINITIONS_FILE" ]]; then + is_boolean_yes "$RABBITMQ_SECURE_PASSWORD" && grep -q '"users"' "$RABBITMQ_DEFINITIONS_FILE" && warn 'A definition file with "users" was found. The RABBITMQ_SECURE_PASSWORD environment variables will be ignored.' + else + print_validation_error "The definitions file $RABBITMQ_DEFINITIONS_FILE is not found. Please ensure that the path is correct or change the RABBITMQ_DEFINITIONS_FILE variable." + fi + elif [[ -z "$RABBITMQ_PASSWORD" ]]; then + print_validation_error "You must indicate a password" + fi + + if is_boolean_yes "$RABBITMQ_ENABLE_LDAP" && { [[ -z "${RABBITMQ_LDAP_SERVERS}" ]] || [[ -z "${RABBITMQ_LDAP_USER_DN_PATTERN}" ]]; }; then + print_validation_error "The LDAP configuration is required when LDAP authentication is enabled. Set the environment variables RABBITMQ_LDAP_SERVERS and RABBITMQ_LDAP_USER_DN_PATTERN." + fi + + if [[ "$RABBITMQ_NODE_TYPE" = "stats" ]]; then + if ! validate_ipv4 "$RABBITMQ_MANAGEMENT_BIND_IP"; then + print_validation_error "An invalid IP was specified in the environment variable RABBITMQ_MANAGEMENT_BIND_IP." + fi + check_allowed_port "RABBITMQ_MANAGEMENT_PORT_NUMBER" + if [[ -n "$RABBITMQ_CLUSTER_NODE_NAME" ]]; then + warn "This node will not be clustered. Use type queue-* instead." + fi + elif [[ "$RABBITMQ_NODE_TYPE" = "queue-disc" ]] || [[ "$RABBITMQ_NODE_TYPE" = "queue-ram" ]]; then + if [[ -z "$RABBITMQ_CLUSTER_NODE_NAME" ]]; then + warn "You did not define any node to cluster with." + fi + else + print_validation_error "${RABBITMQ_NODE_TYPE} is not a valid type. You can use 'stats', 'queue-disc' or 'queue-ram'." + fi + + # Validate high memory watermark + # It can be specified as an absolute value, or as a relative (either in percentage or value between 0 and 1) + if ! is_empty_value "$RABBITMQ_VM_MEMORY_HIGH_WATERMARK" && ! rabbitmq_is_absolute_value "$RABBITMQ_VM_MEMORY_HIGH_WATERMARK" && ! rabbitmq_is_relative_value "$RABBITMQ_VM_MEMORY_HIGH_WATERMARK"; then + print_validation_error "RABBITMQ_VM_MEMORY_HIGH_WATERMARK must be specified as an absolute or relative value. Example of absolute values: 1GiB, 1G, 100M, 1048576. Example of relative values: 50%, 0.5." + fi + + [[ "$error_code" -eq 0 ]] || return "$error_code" +} + +######################## +# Checks whether an input value refers to an absolute memory value +# Globals: +# None +# Arguments: +# $1 - value +# Returns: +# boolean +######################### +rabbitmq_is_absolute_value() { + local value="${1:?missing value}" + [[ "$1" =~ ^[1-9][0-9]*([MG](i?B)?)?$ ]] +} + +######################## +# Checks whether an input value refers to an absolute memory value +# Globals: +# None +# Arguments: +# $1 - value +# Returns: +# boolean +######################### +rabbitmq_is_relative_value() { + local value="${1:?missing value}" + [[ "$1" =~ ^[0-9]+(\.[0-9]+)?%$ || "$1" =~ ^0\.[0-9][0-9]*$ ]] +} + +######################## +# Checks whether SSL configurations should be enabled +# Globals: +# None +# Arguments: +# None +# Returns: +# boolean +######################### +rabbitmq_is_ssl_enabled() { + local -r env_prefix="${1:-ssl}" + local env_var + for ssl_key in cacertfile certfile keyfile; do + env_var="RABBITMQ_${env_prefix^^}_${ssl_key^^}" + ! is_empty_value "${!env_var:-}" && return "$?" + done + false +} + +######################## +# Prints RabbitMQ SSL configuration entries +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_print_ssl_configuration() { + local -r env_prefix="${1:-ssl}" + local -r conf_prefix="${2:-ssl_options}" + + # Assume SSL is disabled when no environment variables matching 'RABBITMQ_SSL_*' have been specified + rabbitmq_is_ssl_enabled "$env_prefix" || return + + local -r -a ssl_keys=( + cacertfile + certfile + keyfile + depth + fail_if_no_peer_cert + verify + ) + local env_var env_var_value + for ssl_key in "${ssl_keys[@]}"; do + env_var="RABBITMQ_${env_prefix^^}_${ssl_key^^}" + env_var_value="${!env_var:-}" + # Skip if the environment variable is empty/not defined + is_empty_value "$env_var_value" && continue + echo -n "${conf_prefix}.${ssl_key} = " + # Process boolean value for 'fail_if_no_peer_cert' + if [[ "$ssl_key" = "fail_if_no_peer_cert" ]]; then + is_boolean_yes "$env_var_value" && echo "true" || echo "false" + else + echo "$env_var_value" + fi + done + echo +} + +######################## +# Prints RabbitMQ networking-specific configuration entries +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_print_networking_configuration() { + echo "## Networking" + if rabbitmq_is_ssl_enabled; then + echo "listeners.ssl.default = ${RABBITMQ_NODE_SSL_PORT_NUMBER}" + rabbitmq_print_ssl_configuration + else + echo "listeners.tcp.default = ${RABBITMQ_NODE_PORT_NUMBER}" + echo + fi +} + +######################## +# Prints RabbitMQ management configuration entries +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_print_management_configuration() { + echo "## Management" + if rabbitmq_is_ssl_enabled "management_ssl"; then + echo "management.ssl.ip = ${RABBITMQ_MANAGEMENT_BIND_IP}" + echo "management.ssl.port = ${RABBITMQ_MANAGEMENT_SSL_PORT_NUMBER}" + rabbitmq_print_ssl_configuration "management_ssl" "management.ssl" + else + # Assume SSL is disabled when no environment variables matching 'RABBITMQ_SSL_*' have been specified + echo "management.tcp.ip = ${RABBITMQ_MANAGEMENT_BIND_IP}" + echo "management.tcp.port = ${RABBITMQ_MANAGEMENT_PORT_NUMBER}" + fi + + # Allow access to web UI + if is_boolean_yes "$RABBITMQ_MANAGEMENT_ALLOW_WEB_ACCESS"; then + echo "loopback_users.${RABBITMQ_USERNAME} = false" + else + echo "loopback_users.${RABBITMQ_USERNAME} = true" + fi + + # End config file section + echo +} + +######################## +# Prints RabbitMQ LDAP-specific configuration entries +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_print_ldap_configuration() { + if is_boolean_yes "$RABBITMQ_ENABLE_LDAP"; then + cat <>"$RABBITMQ_CONF_FILE" +} + +######################## +# Add or modify an entry in the RabbitMQ configuration file +# Globals: +# RABBITMQ_CONF_FILE +# Arguments: +# $1 - key +# $2 - values (array) +# Returns: +# None +######################### +rabbitmq_conf_set() { + local -r key="${1:?missing key}" + shift + local -r -a values=("$@") + + if [[ "${#values[@]}" -eq 0 ]]; then + stderr_print "missing value" + return 1 + elif [[ "${#values[@]}" -ne 1 ]]; then + for i in "${!values[@]}"; do + rabbitmq_conf_set "${key[$i]}" "${values[$i]}" + done + else + value="${values[0]}" + debug "Setting ${key} to '${value}' in $RABBITMQ_CONF_FILE ..." + # Check if the value was set before + if grep -q "^[# ]*$key\s*=.*" "$RABBITMQ_CONF_FILE"; then + # Update the existing key + replace_in_file "$RABBITMQ_CONF_FILE" "^[# ]*${key}\s*=.*" "${key} = ${value}" false + else + # Add a new key + printf '\n%s = %s' "$key" "$value" >>"$RABBITMQ_CONF_FILE" + fi + fi +} + +######################## +# Prints the Erlang root directory +# Globals: +# None +# Arguments: +# None +# Returns: +# Erlang root directory +######################### +rabbitmq_erlang_dir() { + dirname "$(dirname "$(which erl)")" +} + +######################## +# Prints the Erlang SSL directory +# Globals: +# None +# Arguments: +# None +# Returns: +# Erlang SSL directory +######################### +rabbitmq_erlang_ssl_dir() { + echo "$(find "$(rabbitmq_erlang_dir)" -name 'ssl-[0-9]*')/ebin" +} + +######################## +# Create combined SSL certificate and key file +# Ref: https://www.rabbitmq.com/clustering-ssl.html#combined-key-file +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_create_combined_ssl_file() { + if [[ ! -f "$RABBITMQ_COMBINED_CERT_PATH" ]]; then + cat "$RABBITMQ_SSL_CERTFILE" "$RABBITMQ_SSL_KEYFILE" >"$RABBITMQ_COMBINED_CERT_PATH" + fi +} + +######################## +# Creates RabbitMQ environment file +# Globals: +# RABBITMQ_CONF_ENV_FILE +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_create_environment_file() { + debug "Creating environment file..." + { + cat <"$RABBITMQ_CONF_ENV_FILE" +} + +######################## +# Download RabbitMQ custom plugins +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_download_community_plugins() { + debug "Downloading custom plugins..." + read -r -a plugins <<<"$(tr ',;' ' ' <<<"$RABBITMQ_COMMUNITY_PLUGINS")" + cd "$RABBITMQ_PLUGINS_DIR" || return + for plugin in "${plugins[@]}"; do + curl --remote-name --location --silent "$plugin" + done + cd - || return +} + +######################## +# Creates RabbitMQ plugins file +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_create_enabled_plugins_file() { + debug "Creating enabled_plugins file..." + local -a plugins=("rabbitmq_management_agent" "rabbitmq_prometheus") + + if [[ -n "${RABBITMQ_PLUGINS:-}" ]]; then + read -r -a extra_plugins_array <<<"$(tr ',;' ' ' <<<"$RABBITMQ_PLUGINS")" + [[ "${#extra_plugins_array[@]}" -gt 0 ]] && plugins+=("${extra_plugins_array[@]}") + else + if [[ "$RABBITMQ_NODE_TYPE" = "stats" ]]; then + plugins=("rabbitmq_management") + fi + is_boolean_yes "$RABBITMQ_ENABLE_LDAP" && plugins+=("rabbitmq_auth_backend_ldap") + fi + cat >"${RABBITMQ_CONF_DIR}/enabled_plugins" <"${RABBITMQ_HOME_DIR}/.erlang.cookie" +} + +######################## +# Checks if RabbitMQ is running +# Globals: +# RABBITMQ_PID +# RABBITMQ_BIN_DIR +# Arguments: +# None +# Returns: +# Boolean +######################### +is_rabbitmq_running() { + if [[ -z "${RABBITMQ_PID:-}" && -n "${RABBITMQ_PID_FILE:-}" ]]; then + RABBITMQ_PID="$(get_pid_from_file "$RABBITMQ_PID_FILE")" + fi + if [[ -z "${RABBITMQ_PID:-}" ]]; then + false + else + is_service_running "$RABBITMQ_PID" + fi +} + +######################## +# Checks if RabbitMQ is not running +# Globals: +# RABBITMQ_PID +# RABBITMQ_BIN_DIR +# Arguments: +# None +# Returns: +# Boolean +######################### +is_rabbitmq_not_running() { + ! is_rabbitmq_running +} + +######################## +# Checks if a RabbitMQ node is running +# Globals: +# RABBITMQ_BIN_DIR +# Arguments: +# $1 - Node to check +# Returns: +# Boolean +######################### +node_is_running() { + local node="${1:?node is required}" + info "Checking node ${node}" + if debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" await_startup -n "$node"; then + true + else + false + fi +} + +######################## +# Starts RabbitMQ in background and waits until it's ready +# Globals: +# BITNAMI_DEBUG +# RABBITMQ_BIN_DIR +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_start_bg() { + is_rabbitmq_running && return + info "Starting RabbitMQ in background..." + local start_command=("$RABBITMQ_BIN_DIR/rabbitmq-server") + am_i_root && start_command=("run_as_user" "$RABBITMQ_DAEMON_USER" "${start_command[@]}") + debug_execute "${start_command[@]}" & + export RABBITMQ_PID="$!" + + if ! retry_while "debug_execute ${RABBITMQ_BIN_DIR}/rabbitmqctl wait --pid $RABBITMQ_PID --timeout 5" 10 10; then + error "Couldn't start RabbitMQ in background." + return 1 + fi +} + +######################## +# Stop RabbitMQ +# Globals: +# BITNAMI_DEBUG +# RABBITMQ_BIN_DIR +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_stop() { + ! is_rabbitmq_running && return + info "Stopping RabbitMQ..." + + debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" stop + retry_while "is_rabbitmq_running" 10 1 + # We give two extra seconds for halting Erlang VM + sleep 2 +} + +######################## +# Change the password of a user +# Globals: +# BITNAMI_DEBUG +# RABBITMQ_BIN_DIR +# Arguments: +# $1 - User +# $2 - Password +# Returns: +# None +######################### +rabbitmq_change_password() { + local user="${1:?user is required}" + local password="${2:?password is required}" + debug "Changing password for user '${user}'..." + + if ! debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" change_password -- "$user" "$password"; then + error "Couldn't change password for user '${user}'." + return 1 + fi +} + +######################## +# Make a node join a cluster +# Globals: +# BITNAMI_DEBUG +# RABBITMQ_BIN_DIR +# Arguments: +# $1 - Node to cluster with +# $2 - Type of node +# Returns: +# None +######################### +rabbitmq_join_cluster() { + local clusternode="${1:?node is required}" + local type="${2:?type is required}" + + local join_cluster_args=("$clusternode") + [[ "$type" = "queue-ram" ]] && join_cluster_args+=("--ram") + + debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" stop_app + + if ! retry_while "debug_execute ${RABBITMQ_BIN_DIR}/rabbitmq-plugins --node $clusternode is_enabled rabbitmq_management" 120 1; then + error "Node ${clusternode} is not running." + return 1 + fi + + info "Clustering with ${clusternode}" + if ! debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" join_cluster "${join_cluster_args[@]}"; then + error "Couldn't cluster with node '${clusternode}'." + return 1 + fi + + debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" start_app +} + +######################## +# Declare a new virtual host +# Globals: +# BITNAMI_DEBUG +# RABBITMQ_BIN_DIR +# Arguments: +# $1 - Name +# Returns: +# None +######################### +rabbitmq_declare_vhost() { + local name="${1:?name is required}" + debug "Declaring vhost '${name}'..." + + if ! debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" add_vhost -- "${name}"; then + error "Couldn't declared vhost '${name}'." + return 1 + fi +} + +######################## +# Allow a user to access a virtual host +# Globals: +# BITNAMI_DEBUG +# RABBITMQ_BIN_DIR +# Arguments: +# $1 - User +# $2 - Vhost +# Returns: +# None +######################### +rabbitmq_set_user_vhost_permission() { + local user="${1:?user is required}" + local vhost="${2:?vhost is required}" + debug "Assigning permissions to user '${user}' to access vhost '${vhost}'..." + + if ! debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" set_permissions --vhost "${vhost}" "${user}" ".*" ".*" ".*"; then + error "Couldn't assigned perrmissions to user '${user}' to access vhost '${vhost}'." + return 1 + fi +} + +######################## +# Ensure RabbitMQ is initialized +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns: +# None +######################### +rabbitmq_initialize() { + info "Initializing RabbitMQ..." + + # Check for mounted configuration files + if ! is_dir_empty "$RABBITMQ_MOUNTED_CONF_DIR"; then + cp -Lr "$RABBITMQ_MOUNTED_CONF_DIR"/* "$RABBITMQ_CONF_DIR" + fi + [[ ! -f "$RABBITMQ_CONF_FILE" ]] && rabbitmq_create_config_file + rabbitmq_is_ssl_enabled && rabbitmq_create_combined_ssl_file + [[ ! -f "$RABBITMQ_CONF_ENV_FILE" ]] && rabbitmq_create_environment_file + [[ ! -f "${RABBITMQ_CONF_DIR}/enabled_plugins" ]] && rabbitmq_create_enabled_plugins_file + [[ -n "${RABBITMQ_COMMUNITY_PLUGINS:-}" ]] && rabbitmq_download_community_plugins + + # User injected custom configuration + if [[ -f "${RABBITMQ_CONF_DIR}/custom.conf" ]]; then + debug "Injecting custom configuration from custom.conf" + while IFS='=' read -r custom_key custom_value || [[ -n $custom_key ]]; do + rabbitmq_conf_set "$custom_key" "$custom_value" + done < <(grep -E "^\w.*\s?=\s?.*" "${RABBITMQ_CONF_DIR}/custom.conf") + # Remove custom configurafion file once the changes are applied + rm "${RABBITMQ_CONF_DIR}/custom.conf" + fi + + [[ ! -f "${RABBITMQ_LIB_DIR}/.start" ]] && touch "${RABBITMQ_LIB_DIR}/.start" + [[ ! -f "${RABBITMQ_HOME_DIR}/.erlang.cookie" ]] && rabbitmq_create_erlang_cookie + chmod 400 "${RABBITMQ_HOME_DIR}/.erlang.cookie" + ln -sf "${RABBITMQ_HOME_DIR}/.erlang.cookie" "${RABBITMQ_LIB_DIR}/.erlang.cookie" + + debug "Ensuring expected directories/files exist..." + for dir in "$RABBITMQ_DATA_DIR" "$RABBITMQ_LIB_DIR" "$RABBITMQ_HOME_DIR"; do + ensure_dir_exists "$dir" + am_i_root && chown -R "$RABBITMQ_DAEMON_USER:$RABBITMQ_DAEMON_GROUP" "$dir" + done + + # Use realpath to avoid symlink issues + # ref: https://github.com/bitnami/bitnami-docker-rabbitmq/pull/184 + if ! is_mounted_dir_empty "$(realpath "$RABBITMQ_DATA_DIR")"; then + info "Persisted data detected. Restoring..." + if is_boolean_yes "$RABBITMQ_FORCE_BOOT" && ! is_dir_empty "${RABBITMQ_DATA_DIR}/${RABBITMQ_NODE_NAME}"; then + # ref: https://www.rabbitmq.com/rabbitmqctl.8.html#force_boot + warn "Forcing node to start..." + debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" force_boot + fi + else + ! is_rabbitmq_running && rabbitmq_start_bg + if is_boolean_yes "$RABBITMQ_LOAD_DEFINITIONS"; then + if ! grep -q '"users"' "$RABBITMQ_DEFINITIONS_FILE"; then + debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" add_user "$RABBITMQ_USERNAME" "$RABBITMQ_PASSWORD" + debug_execute "${RABBITMQ_BIN_DIR}/rabbitmqctl" set_user_tags "$RABBITMQ_USERNAME" administrator + fi + elif is_boolean_yes "$RABBITMQ_SECURE_PASSWORD"; then + rabbitmq_change_password "$RABBITMQ_USERNAME" "$RABBITMQ_PASSWORD" + fi + + if [[ -n "${RABBITMQ_VHOSTS:-}" ]]; then + for vhost in ${RABBITMQ_VHOSTS}; do + rabbitmq_declare_vhost "${vhost}" + if [[ -n "${RABBITMQ_USERNAME}" ]]; then + rabbitmq_set_user_vhost_permission "${RABBITMQ_USERNAME}" "${vhost}" + fi + done + fi + + if [[ "$RABBITMQ_NODE_TYPE" != "stats" ]] && [[ -n "$RABBITMQ_CLUSTER_NODE_NAME" ]]; then + rabbitmq_join_cluster "$RABBITMQ_CLUSTER_NODE_NAME" "$RABBITMQ_NODE_TYPE" + fi + fi +} + +######################## +# Run custom initialization scripts +# Globals: +# RABBITMQ_* +# Arguments: +# None +# Returns:z< +# None +######################### +rabbitmq_custom_init_scripts() { + if [[ -n $(find "${RABBITMQ_INITSCRIPTS_DIR}/" -type f -regex ".*\.sh") ]]; then + info "Loading user's custom files from $RABBITMQ_INITSCRIPTS_DIR ..." + local -r tmp_file="/tmp/filelist" + find "${RABBITMQ_INITSCRIPTS_DIR}/" -type f -regex ".*\.sh" | sort >"$tmp_file" + while read -r f; do + case "$f" in + *.sh) + if [[ -x "$f" ]]; then + debug "Executing $f" + "$f" + else + debug "Sourcing $f" + # shellcheck disable=SC1090 + . "$f" + fi + ;; + *) + debug "Ignoring $f" + ;; + esac + done <$tmp_file + rm -f "$tmp_file" + else + info "No custom scripts in $RABBITMQ_INITSCRIPTS_DIR" + fi +} diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/locales/add-extra-locales.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/locales/add-extra-locales.sh new file mode 100755 index 000000000000..c937a8fa4b18 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/locales/add-extra-locales.sh @@ -0,0 +1,46 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Defaults +WITH_ALL_LOCALES="${WITH_ALL_LOCALES:-no}" +EXTRA_LOCALES="${EXTRA_LOCALES:-}" + +# Constants +LOCALES_FILE="/etc/locale.gen" +SUPPORTED_LOCALES_FILE="/usr/share/i18n/SUPPORTED" + +# Helper function for enabling locale only when it was not added before +enable_locale() { + local -r locale="${1:?missing locale}" + if ! grep -q -E "^${locale}$" "$SUPPORTED_LOCALES_FILE"; then + echo "Locale ${locale} is not supported in this system" + return 1 + fi + if ! grep -q -E "^${locale}" "$LOCALES_FILE"; then + echo "$locale" >> "$LOCALES_FILE" + else + echo "Locale ${locale} is already enabled" + fi +} + +if [[ "$WITH_ALL_LOCALES" =~ ^(yes|true|1)$ ]]; then + echo "Enabling all locales" + cp "$SUPPORTED_LOCALES_FILE" "$LOCALES_FILE" +else + # shellcheck disable=SC2001 + LOCALES_TO_ADD="$(sed 's/[,;]\s*/\n/g' <<< "$EXTRA_LOCALES")" + while [[ -n "$LOCALES_TO_ADD" ]] && read -r locale; do + echo "Enabling locale ${locale}" + enable_locale "$locale" + done <<< "$LOCALES_TO_ADD" +fi + +locale-gen diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq-env.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq-env.sh new file mode 100644 index 000000000000..df0d413f41b6 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq-env.sh @@ -0,0 +1,184 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Environment configuration for rabbitmq + +# 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 +# shellcheck disable=SC1090,SC1091 +. /opt/bitnami/scripts/liblog.sh + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-rabbitmq}" +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 +rabbitmq_env_vars=( + RABBITMQ_CONF_FILE + RABBITMQ_DEFINITIONS_FILE + RABBITMQ_SECURE_PASSWORD + RABBITMQ_CLUSTER_NODE_NAME + RABBITMQ_CLUSTER_PARTITION_HANDLING + RABBITMQ_DISK_FREE_RELATIVE_LIMIT + RABBITMQ_DISK_FREE_ABSOLUTE_LIMIT + RABBITMQ_ERL_COOKIE + RABBITMQ_VM_MEMORY_HIGH_WATERMARK + RABBITMQ_LOAD_DEFINITIONS + RABBITMQ_MANAGEMENT_BIND_IP + RABBITMQ_MANAGEMENT_PORT_NUMBER + RABBITMQ_MANAGEMENT_ALLOW_WEB_ACCESS + RABBITMQ_NODE_NAME + RABBITMQ_USE_LONGNAME + RABBITMQ_NODE_PORT_NUMBER + RABBITMQ_NODE_TYPE + RABBITMQ_VHOST + RABBITMQ_VHOSTS + RABBITMQ_CLUSTER_REBALANCE + RABBITMQ_CLUSTER_REBALANCE_ATTEMPTS + RABBITMQ_USERNAME + RABBITMQ_PASSWORD + RABBITMQ_FORCE_BOOT + RABBITMQ_ENABLE_LDAP + RABBITMQ_LDAP_TLS + RABBITMQ_LDAP_SERVERS + RABBITMQ_LDAP_SERVERS_PORT + RABBITMQ_LDAP_USER_DN_PATTERN + RABBITMQ_NODE_SSL_PORT_NUMBER + RABBITMQ_SSL_CACERTFILE + RABBITMQ_SSL_CERTFILE + RABBITMQ_SSL_KEYFILE + RABBITMQ_SSL_DEPTH + RABBITMQ_SSL_FAIL_IF_NO_PEER_CERT + RABBITMQ_SSL_VERIFY + RABBITMQ_MANAGEMENT_SSL_PORT_NUMBER + RABBITMQ_MANAGEMENT_SSL_CACERTFILE + RABBITMQ_MANAGEMENT_SSL_CERTFILE + RABBITMQ_MANAGEMENT_SSL_KEYFILE + RABBITMQ_MANAGEMENT_SSL_DEPTH + RABBITMQ_MANAGEMENT_SSL_FAIL_IF_NO_PEER_CERT + RABBITMQ_MANAGEMENT_SSL_VERIFY + RABBITMQ_CONFIG_FILE + RABBITMQ_ERLANG_COOKIE + RABBITMQ_MANAGER_BIND_IP + RABBITMQ_MANAGER_PORT_NUMBER + RABBITMQ_DEFAULT_VHOST + RABBITMQ_DEFAULT_USER + RABBITMQ_DEFAULT_PASS + RABBITMQ_SSL_CACERT_FILE + RABBITMQ_SSL_CERT_FILE + RABBITMQ_SSL_KEY_FILE +) +for env_var in "${rabbitmq_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 rabbitmq_env_vars + +# Paths +export RABBITMQ_VOLUME_DIR="/bitnami/rabbitmq" +export RABBITMQ_BASE_DIR="/opt/bitnami/rabbitmq" +export RABBITMQ_BIN_DIR="${RABBITMQ_BASE_DIR}/sbin" +export RABBITMQ_DATA_DIR="${RABBITMQ_VOLUME_DIR}/mnesia" +export RABBITMQ_CONF_DIR="${RABBITMQ_BASE_DIR}/etc/rabbitmq" +RABBITMQ_CONF_FILE="${RABBITMQ_CONF_FILE:-"${RABBITMQ_CONFIG_FILE:-}"}" +export RABBITMQ_CONF_FILE="${RABBITMQ_CONF_FILE:-${RABBITMQ_CONF_DIR}/rabbitmq.conf}" +export RABBITMQ_CONF_ENV_FILE="${RABBITMQ_CONF_DIR}/rabbitmq-env.conf" +export RABBITMQ_HOME_DIR="${RABBITMQ_BASE_DIR}/.rabbitmq" +export RABBITMQ_LIB_DIR="${RABBITMQ_BASE_DIR}/var/lib/rabbitmq" +export RABBITMQ_INITSCRIPTS_DIR="/docker-entrypoint-initdb.d" +export RABBITMQ_LOGS_DIR="${RABBITMQ_BASE_DIR}/var/log/rabbitmq" +export RABBITMQ_DEFINITIONS_FILE="${RABBITMQ_DEFINITIONS_FILE:-/app/load_definition.json}" +export RABBITMQ_PLUGINS_DIR="${RABBITMQ_BASE_DIR}/plugins" +export RABBITMQ_MOUNTED_CONF_DIR="${RABBITMQ_VOLUME_DIR}/conf" +export PATH="${RABBITMQ_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${BITNAMI_ROOT_DIR}/erlang/bin:${PATH}" + +# System users (when running with a privileged user) +export RABBITMQ_DAEMON_USER="rabbitmq" +export RABBITMQ_DAEMON_GROUP="rabbitmq" + +# RabbitMQ settings +export RABBITMQ_SECURE_PASSWORD="${RABBITMQ_SECURE_PASSWORD:-no}" +export RABBITMQ_CLUSTER_NODE_NAME="${RABBITMQ_CLUSTER_NODE_NAME:-}" +export RABBITMQ_CLUSTER_PARTITION_HANDLING="${RABBITMQ_CLUSTER_PARTITION_HANDLING:-ignore}" +export RABBITMQ_DISK_FREE_RELATIVE_LIMIT="${RABBITMQ_DISK_FREE_RELATIVE_LIMIT:-1.0}" +export RABBITMQ_DISK_FREE_ABSOLUTE_LIMIT="${RABBITMQ_DISK_FREE_ABSOLUTE_LIMIT:-}" +RABBITMQ_ERL_COOKIE="${RABBITMQ_ERL_COOKIE:-"${RABBITMQ_ERLANG_COOKIE:-}"}" +export RABBITMQ_ERL_COOKIE="${RABBITMQ_ERL_COOKIE:-}" +export RABBITMQ_VM_MEMORY_HIGH_WATERMARK="${RABBITMQ_VM_MEMORY_HIGH_WATERMARK:-}" +export RABBITMQ_LOAD_DEFINITIONS="${RABBITMQ_LOAD_DEFINITIONS:-no}" +RABBITMQ_MANAGEMENT_BIND_IP="${RABBITMQ_MANAGEMENT_BIND_IP:-"${RABBITMQ_MANAGER_BIND_IP:-}"}" +export RABBITMQ_MANAGEMENT_BIND_IP="${RABBITMQ_MANAGEMENT_BIND_IP:-0.0.0.0}" +RABBITMQ_MANAGEMENT_PORT_NUMBER="${RABBITMQ_MANAGEMENT_PORT_NUMBER:-"${RABBITMQ_MANAGER_PORT_NUMBER:-}"}" +export RABBITMQ_MANAGEMENT_PORT_NUMBER="${RABBITMQ_MANAGEMENT_PORT_NUMBER:-15672}" +export RABBITMQ_MANAGEMENT_ALLOW_WEB_ACCESS="${RABBITMQ_MANAGEMENT_ALLOW_WEB_ACCESS:-false}" +export RABBITMQ_NODE_NAME="${RABBITMQ_NODE_NAME:-rabbit@localhost}" +export RABBITMQ_USE_LONGNAME="${RABBITMQ_USE_LONGNAME:-false}" +export RABBITMQ_NODE_PORT_NUMBER="${RABBITMQ_NODE_PORT_NUMBER:-5672}" +export RABBITMQ_NODE_TYPE="${RABBITMQ_NODE_TYPE:-stats}" +RABBITMQ_VHOST="${RABBITMQ_VHOST:-"${RABBITMQ_DEFAULT_VHOST:-}"}" +export RABBITMQ_VHOST="${RABBITMQ_VHOST:-/}" +export RABBITMQ_VHOSTS="${RABBITMQ_VHOSTS:-}" +export RABBITMQ_CLUSTER_REBALANCE="${RABBITMQ_CLUSTER_REBALANCE:-false}" +export RABBITMQ_CLUSTER_REBALANCE_ATTEMPTS="${RABBITMQ_CLUSTER_REBALANCE_ATTEMPTS:-100}" + +# RabbitMQ authentication +RABBITMQ_USERNAME="${RABBITMQ_USERNAME:-"${RABBITMQ_DEFAULT_USER:-}"}" +export RABBITMQ_USERNAME="${RABBITMQ_USERNAME:-user}" +RABBITMQ_PASSWORD="${RABBITMQ_PASSWORD:-"${RABBITMQ_DEFAULT_PASS:-}"}" +export RABBITMQ_PASSWORD="${RABBITMQ_PASSWORD:-bitnami}" + +# Force boot cluster +export RABBITMQ_FORCE_BOOT="${RABBITMQ_FORCE_BOOT:-no}" + +# LDAP +export RABBITMQ_ENABLE_LDAP="${RABBITMQ_ENABLE_LDAP:-no}" +export RABBITMQ_LDAP_TLS="${RABBITMQ_LDAP_TLS:-no}" +export RABBITMQ_LDAP_SERVERS="${RABBITMQ_LDAP_SERVERS:-}" +export RABBITMQ_LDAP_SERVERS_PORT="${RABBITMQ_LDAP_SERVERS_PORT:-389}" +export RABBITMQ_LDAP_USER_DN_PATTERN="${RABBITMQ_LDAP_USER_DN_PATTERN:-}" + +# RabbitMQ native environment variables (see https://www.rabbitmq.com/relocate.html) +export RABBITMQ_MNESIA_BASE="$RABBITMQ_DATA_DIR" + +# Print all log messages to standard output + +# SSL/TLS configuration +export RABBITMQ_NODE_SSL_PORT_NUMBER="${RABBITMQ_NODE_SSL_PORT_NUMBER:-5671}" +RABBITMQ_SSL_CACERTFILE="${RABBITMQ_SSL_CACERTFILE:-"${RABBITMQ_SSL_CACERT_FILE:-}"}" +export RABBITMQ_SSL_CACERTFILE="${RABBITMQ_SSL_CACERTFILE:-}" +RABBITMQ_SSL_CERTFILE="${RABBITMQ_SSL_CERTFILE:-"${RABBITMQ_SSL_CERT_FILE:-}"}" +export RABBITMQ_SSL_CERTFILE="${RABBITMQ_SSL_CERTFILE:-}" +RABBITMQ_SSL_KEYFILE="${RABBITMQ_SSL_KEYFILE:-"${RABBITMQ_SSL_KEY_FILE:-}"}" +export RABBITMQ_SSL_KEYFILE="${RABBITMQ_SSL_KEYFILE:-}" +export RABBITMQ_COMBINED_CERT_PATH="${RABBITMQ_COMBINED_CERT_PATH:-/tmp/rabbitmq_combined_keys.pem}" +export RABBITMQ_SSL_DEPTH="${RABBITMQ_SSL_DEPTH:-}" +export RABBITMQ_SSL_FAIL_IF_NO_PEER_CERT="${RABBITMQ_SSL_FAIL_IF_NO_PEER_CERT:-no}" +export RABBITMQ_SSL_VERIFY="${RABBITMQ_SSL_VERIFY:-verify_none}" + +# Management SSL/TLS configuration +export RABBITMQ_MANAGEMENT_SSL_PORT_NUMBER="${RABBITMQ_MANAGEMENT_SSL_PORT_NUMBER:-15671}" +export RABBITMQ_MANAGEMENT_SSL_CACERTFILE="${RABBITMQ_MANAGEMENT_SSL_CACERTFILE:-$RABBITMQ_SSL_CACERTFILE}" +export RABBITMQ_MANAGEMENT_SSL_CERTFILE="${RABBITMQ_MANAGEMENT_SSL_CERTFILE:-$RABBITMQ_SSL_CERTFILE}" +export RABBITMQ_MANAGEMENT_SSL_KEYFILE="${RABBITMQ_MANAGEMENT_SSL_KEYFILE:-$RABBITMQ_SSL_KEYFILE}" +export RABBITMQ_MANAGEMENT_SSL_DEPTH="${RABBITMQ_MANAGEMENT_SSL_DEPTH:-}" +export RABBITMQ_MANAGEMENT_SSL_FAIL_IF_NO_PEER_CERT="${RABBITMQ_MANAGEMENT_SSL_FAIL_IF_NO_PEER_CERT:-yes}" +export RABBITMQ_MANAGEMENT_SSL_VERIFY="${RABBITMQ_MANAGEMENT_SSL_VERIFY:-verify_peer}" + +# Custom environment variables may be defined below diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/apicheck.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/apicheck.sh new file mode 100755 index 000000000000..204a69af0467 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/apicheck.sh @@ -0,0 +1,20 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libos.sh + +URL=$1 +EXPECTED=$2 +ACTUAL=$(curl --silent --show-error --fail "$URL") +info "Actual response: ${ACTUAL}" +info "Expected response: ${EXPECTED}" +test "$EXPECTED" = "$ACTUAL" diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/entrypoint.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/entrypoint.sh new file mode 100755 index 000000000000..7b62114571a2 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/entrypoint.sh @@ -0,0 +1,29 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/librabbitmq.sh +. /opt/bitnami/scripts/liblog.sh + +# Load RabbitMQ environment variables +. /opt/bitnami/scripts/rabbitmq-env.sh + +print_welcome_page + +if [[ "$1" = "/opt/bitnami/scripts/rabbitmq/run.sh" ]]; then + info "** Starting RabbitMQ setup **" + /opt/bitnami/scripts/rabbitmq/setup.sh + info "** RabbitMQ setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/healthcheck.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/healthcheck.sh new file mode 100755 index 000000000000..f62f95ffcb48 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/healthcheck.sh @@ -0,0 +1,29 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/librabbitmq.sh + +# Load RabbitMQ environment variables +. /opt/bitnami/scripts/rabbitmq-env.sh + +if [[ -f "${RABBITMQ_LIB_DIR}/.start" ]]; then + rabbitmq-diagnostics -q ping + RESULT=$? + if [[ $RESULT -ne 0 ]]; then + rabbitmqctl status + exit $? + fi + rm -f "${RABBITMQ_LIB_DIR}/.start" + exit ${RESULT} +fi + +/opt/bitnami/scripts/rabbitmq/apicheck.sh "$1" "$2" diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/nodeshutdown.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/nodeshutdown.sh new file mode 100755 index 000000000000..e88844a4ce37 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/nodeshutdown.sh @@ -0,0 +1,52 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o nounset + +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libhook.sh + +while getopts t:d:h flag +do + case "$flag" in + t) + TERMINATION_GRACE_PERIOD_SECONDS="$OPTARG" + ;; + d) + export BITNAMI_DEBUG="$OPTARG" + ;; + h) + info "Usage: ${0} [ -t ] [ -d ]" + exit 0 + ;; + \?) + error "Invalid option: -${OPTARG}" + exit 1 + ;; + :) + echo error "Option -${OPTARG} requires an argument." + exit 1 + ;; + esac +done + +if [[ "${TERMINATION_GRACE_PERIOD_SECONDS:-}" =~ ^[0-9]+$ ]]; then + RABBITMQ_SYNC_TIMEOUT="$((TERMINATION_GRACE_PERIOD_SECONDS - 10))" +else + RABBITMQ_SYNC_TIMEOUT="0" +fi + +debug "RABBITMQ_SYNC_TIMEOUT is ${RABBITMQ_SYNC_TIMEOUT}" + +if debug_execute rabbitmqctl cluster_status && [[ "$RABBITMQ_SYNC_TIMEOUT" -gt 0 ]]; then + debug "Will wait up to ${RABBITMQ_SYNC_TIMEOUT} seconds for node to make sure cluster is healthy after node shutdown" + debug_execute timeout "$RABBITMQ_SYNC_TIMEOUT" /opt/bitnami/scripts/rabbitmq/waitforsafeshutdown.sh + if [[ "$?" -eq 124 ]]; then + warn "Wait for safe node shutdown has timed out. Continuing to node shutdown anyway." + fi +fi + +rabbitmqctl stop_app diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/postunpack.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/postunpack.sh new file mode 100755 index 000000000000..541a86503d97 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/postunpack.sh @@ -0,0 +1,48 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/librabbitmq.sh + +# Load RabbitMQ environment variables +. /opt/bitnami/scripts/rabbitmq-env.sh + +for dir in "$RABBITMQ_BIN_DIR" "$RABBITMQ_INITSCRIPTS_DIR" "$RABBITMQ_CONF_DIR" "$RABBITMQ_DATA_DIR" "$RABBITMQ_HOME_DIR" "$RABBITMQ_LIB_DIR" "$RABBITMQ_LOGS_DIR" "$RABBITMQ_PLUGINS_DIR"; do + ensure_dir_exists "$dir" +done +chmod -R g+rwX "$RABBITMQ_INITSCRIPTS_DIR" "$RABBITMQ_BIN_DIR" "$RABBITMQ_CONF_DIR" "$RABBITMQ_DATA_DIR" "$RABBITMQ_HOME_DIR" "$RABBITMQ_LIB_DIR" "$RABBITMQ_LOGS_DIR" "$RABBITMQ_PLUGINS_DIR" + +# Adding symlinks to upstream RabbitMQ paths to make the container compatible with the RabbitMQ Cluster Operator + +symlinks=( + "/etc/rabbitmq=${RABBITMQ_CONF_DIR}" + "/var/lib/rabbitmq=${RABBITMQ_HOME_DIR}" + "/var/log/rabbitmq=${RABBITMQ_LOGS_DIR}" +) + +for entry in "${symlinks[@]}"; do + link="${entry%=*}" + file="${entry#*=}" + ln -s "$file" "$link" +done + +# Additionally, ensure that the /var/log is accessible, which may have been hardened +chmod g+x /var/log + +# Special case for RabbitMQ mnesia dir, which will have a different symbolic linking to ensure compatibility with +# the RabbitMQ Cluster Operator + +mkdir -p "/var/lib/rabbitmq/mnesia" +chmod -R g+rwX "/var/lib/rabbitmq/mnesia" +rm -rf "$RABBITMQ_DATA_DIR" +ln -s "/var/lib/rabbitmq/mnesia" "$RABBITMQ_DATA_DIR" diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/run.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/run.sh new file mode 100755 index 000000000000..3cf8219eee90 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/run.sh @@ -0,0 +1,60 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/librabbitmq.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh + +# Load RabbitMQ environment variables +. /opt/bitnami/scripts/rabbitmq-env.sh + +# Set up queue rebalance to run in the background after the cluster is up +if is_boolean_yes "$RABBITMQ_CLUSTER_REBALANCE"; then + ( + current_attempt=1 + rebalanced=false + while [[ "$current_attempt" -le "$RABBITMQ_CLUSTER_REBALANCE_ATTEMPTS" ]]; do + if rabbitmqctl cluster_status >/dev/null; then + rabbitmq-queues rebalance "all" + rebalanced=true + break + else + ((current_attempt++)) + fi + done + if is_boolean_yes "$rebalanced"; then + info "Cluster rebalanced successfully" + else + error "Unable to rebalance cluster" + fi + ) & +fi + +# Resources limits: maximum number of open file descriptors +if [ -n "${RABBITMQ_ULIMIT_NOFILES:-}" ]; then + current_limit=$(ulimit -n) + if [ "$current_limit" != "unlimited" ]; then + # shellcheck disable=SC2086 + if [ $RABBITMQ_ULIMIT_NOFILES -gt $current_limit ]; then + info "Setting file description limit to $RABBITMQ_ULIMIT_NOFILES" + ulimit -n $RABBITMQ_ULIMIT_NOFILES + fi + fi +fi + +info "** Starting RabbitMQ **" +cd "$RABBITMQ_BASE_DIR" +if am_i_root; then + exec_as_user "$RABBITMQ_DAEMON_USER" "${RABBITMQ_BIN_DIR}/rabbitmq-server" +else + exec "${RABBITMQ_BIN_DIR}/rabbitmq-server" +fi diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/setup.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/setup.sh new file mode 100755 index 000000000000..b68057fd9628 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/setup.sh @@ -0,0 +1,28 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/librabbitmq.sh + +# Load RabbitMQ environment variables +. /opt/bitnami/scripts/rabbitmq-env.sh + +# Ensure RabbitMQ environment variables settings are valid +rabbitmq_validate +# Ensure RabbitMQ is stopped when this script ends. +trap "rabbitmq_stop" EXIT +# Ensure 'daemon' user exists when running as 'root' +am_i_root && ensure_user_exists "$RABBITMQ_DAEMON_USER" --group "$RABBITMQ_DAEMON_GROUP" +# Ensure RabbitMQ is initialized +rabbitmq_initialize +# Load custom init scripts +rabbitmq_custom_init_scripts diff --git a/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/waitforsafeshutdown.sh b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/waitforsafeshutdown.sh new file mode 100755 index 000000000000..c5377fab0814 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/rootfs/opt/bitnami/scripts/rabbitmq/waitforsafeshutdown.sh @@ -0,0 +1,27 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o nounset + +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libhook.sh + +while : ; do + waiting="false" + if ! debug_execute rabbitmq-diagnostics -q check_if_node_is_mirror_sync_critical; then + debug "check_if_node_is_mirror_sync_critical returns error. Continuing to wait" + waiting="true" + fi + if ! debug_execute rabbitmq-diagnostics -q check_if_node_is_quorum_critical; then + debug "check_if_node_is_quorum_critical returns error. Continuing to wait" + waiting="true" + fi + if [[ $waiting = "true" ]]; then + sleep 1 + else + break + fi +done diff --git a/bitnami/rabbitmq/3.12/debian-12/tags-info.yaml b/bitnami/rabbitmq/3.12/debian-12/tags-info.yaml new file mode 100644 index 000000000000..b07c185f8225 --- /dev/null +++ b/bitnami/rabbitmq/3.12/debian-12/tags-info.yaml @@ -0,0 +1,5 @@ +rolling-tags: +- "3.12" +- 3.12-debian-12 +- 3.12.13 +- latest