diff --git a/bitnami/etcd/3.7/debian-12/Dockerfile b/bitnami/etcd/3.7/debian-12/Dockerfile new file mode 100644 index 000000000000..cbcf6fe48b34 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/Dockerfile @@ -0,0 +1,61 @@ +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +FROM docker.io/bitnami/minideb:bookworm + +ARG DOWNLOADS_URL="https://downloads.bitnami.com/files/stacksmith" +ARG TARGETARCH + +LABEL org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \ + org.opencontainers.image.created="2026-07-10T10:05:38Z" \ + org.opencontainers.image.description="Application packaged by Broadcom, Inc." \ + org.opencontainers.image.documentation="https://github.com/bitnami/containers/tree/main/bitnami/etcd/README.md" \ + org.opencontainers.image.source="https://github.com/bitnami/containers/tree/main/bitnami/etcd" \ + org.opencontainers.image.title="etcd" \ + org.opencontainers.image.vendor="Broadcom, Inc." \ + org.opencontainers.image.version="3.7.0" + +ENV HOME="/" \ + OS_ARCH="${TARGETARCH:-amd64}" \ + OS_FLAVOUR="debian-12" \ + OS_NAME="linux" + +COPY prebuildfs / +SHELL ["/bin/bash", "-o", "errexit", "-o", "nounset", "-o", "pipefail", "-c"] +# Install required system packages and dependencies +RUN install_packages ca-certificates curl procps +RUN --mount=type=secret,id=downloads_url,env=SECRET_DOWNLOADS_URL \ + DOWNLOADS_URL=${SECRET_DOWNLOADS_URL:-${DOWNLOADS_URL}} ; \ + mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ || exit 1 ; \ + COMPONENTS=( \ + "yq-4.53.3-2-linux-${OS_ARCH}-debian-12" \ + "etcd-3.7.0-0-linux-${OS_ARCH}-debian-12" \ + ) ; \ + for COMPONENT in "${COMPONENTS[@]}"; do \ + if [ ! -f "${COMPONENT}.tar.gz" ]; then \ + curl -SsLf "${DOWNLOADS_URL}/${COMPONENT}.tar.gz" -O ; \ + fi ; \ + sha256sum -c "/opt/bitnami/checksums/${COMPONENT}.tar.gz.sha256" ; \ + tar -zxf "${COMPONENT}.tar.gz" -C /opt/bitnami --strip-components=2 --no-same-owner ; \ + rm -rf "${COMPONENT}".tar.gz ; \ + done ; \ + rm -rf /opt/bitnami/checksums ; +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 find / -perm /6000 -type f -exec chmod a-s {} \; || true +RUN uninstall_packages ca-certificates curl + +COPY rootfs / +RUN /opt/bitnami/scripts/etcd/postunpack.sh +ENV APP_VERSION="3.7.0" \ + BITNAMI_APP_NAME="etcd" \ + IMAGE_REVISION="0" \ + PATH="/opt/bitnami/common/bin:/opt/bitnami/etcd/bin:$PATH" + +EXPOSE 2379 2380 + +WORKDIR /opt/bitnami/etcd +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/etcd/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/etcd/run.sh" ] diff --git a/bitnami/etcd/3.7/debian-12/docker-compose.yml b/bitnami/etcd/3.7/debian-12/docker-compose.yml new file mode 100644 index 000000000000..a34f021b4bab --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/docker-compose.yml @@ -0,0 +1,13 @@ +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +services: + etcd: + image: docker.io/bitnami/etcd:3.7 + environment: + - ALLOW_NONE_AUTHENTICATION=yes + volumes: + - etcd_data:/bitnami/etcd +volumes: + etcd_data: + driver: local diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/etcd-3.7.0-0-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/etcd-3.7.0-0-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..feadd4b600fe --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/etcd-3.7.0-0-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +a37278b8a148b216eb6a40bca9aa8941a5c3895e486f3c4453fbc495316d88f6 etcd-3.7.0-0-linux-amd64-debian-12.tar.gz diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/etcd-3.7.0-0-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/etcd-3.7.0-0-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..af523ec86e55 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/etcd-3.7.0-0-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +fb6e0f5602ec63d9a07a74db6cc0369bd9efd4760581988f9acb15bcd45a0c80 etcd-3.7.0-0-linux-arm64-debian-12.tar.gz diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/yq-4.53.3-2-linux-amd64-debian-12.tar.gz.sha256 b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/yq-4.53.3-2-linux-amd64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..159efe9517cd --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/yq-4.53.3-2-linux-amd64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +d7cb02bda9fa20f362656577296b535e338710f43057803014a124d344b0be04 yq-4.53.3-2-linux-amd64-debian-12.tar.gz diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/yq-4.53.3-2-linux-arm64-debian-12.tar.gz.sha256 b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/yq-4.53.3-2-linux-arm64-debian-12.tar.gz.sha256 new file mode 100644 index 000000000000..d360f0478642 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/checksums/yq-4.53.3-2-linux-arm64-debian-12.tar.gz.sha256 @@ -0,0 +1 @@ +bbe968c785b1dad4c8ce87248b6770bb779bb7e72b3338a3a123a9c2602712f8 yq-4.53.3-2-linux-arm64-debian-12.tar.gz diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 000000000000..76956b38e82c --- /dev/null +++ b/bitnami/etcd/3.7/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/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 000000000000..b134a91c7e24 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 "" +} + diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 000000000000..335c1c7c9ef7 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,178 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 +} + +######################## +# Creates a secure temporary file containing the provided secret +# Arguments: +# $1 - secret to write to the temporary file +# Returns: +# String +######################### +credential_to_temp_file() { + local secret="$1" + local tmp_file + + # Use mktemp with a specific prefix for easier debugging if something lingers + if ! tmp_file=$(mktemp "${TMPDIR:-/tmp}/at.cred.XXXXXXXX"); then + echo "Error: Failed to create temp file" >&2 + return 1 + fi + + # Restrict permissions before writing the secret + chmod 0600 "$tmp_file" + # Write secret and ensure it's flushed to disk + printf "%s" "$secret" > "$tmp_file" + # Output the filename so the caller can capture it + echo "$tmp_file" +} + +######################## +# Cleans up temporary files created by credential_to_temp_file +# Arguments: +# None +# Returns: +# None +######################### +cleanup_credentials() { + debug "Cleaning up temporary files containing credentials" + rm -rf "${TMPDIR:-/tmp}"/at.cred.* +} diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 000000000000..b16efabd3230 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,205 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 permissions 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 +# -n|--no-dereference - do not follow symlinks (use for runtime root chown of daemon-writable dirs) +# Returns: +# None +######################### +configure_permissions_ownership() { + local -r paths="${1:?paths is missing}" + local dir_mode="" + local file_mode="" + local user="" + local group="" + local follow_symlinks="yes" + + # 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}" + ;; + -n | --no-dereference) + follow_symlinks="no" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + # -L: follow symlinks and emits the target path + # This is dangerous at runtime, given a co-located lower-privileged process with write access + # to the target path can redirect the chown/chmod to arbitrary paths. Example: + # Lower-privileged process run: ln -s /etc /tmp/etc + # Then, setup.sh runs: configure_permissions_ownership --dir-mode 775 /tmp + local find_L_flag=(); [[ "$follow_symlinks" == "yes" ]] && find_L_flag=("-L") + # -h: changes symlink inode ownership without touching the target. + local chown_flags=(); [[ "$follow_symlinks" == "no" ]] && chown_flags=("-h") + read -r -a filepaths <<<"$paths" + for p in "${filepaths[@]}"; do + if [[ -e "$p" ]]; then + if [[ -n $dir_mode ]]; then + find "${find_L_flag[@]}" "$p" -not -type l -type d ! -perm "$dir_mode" -print0 | xargs -r -0 chmod "$dir_mode" + fi + if [[ -n $file_mode ]]; then + find "${find_L_flag[@]}" "$p" -not -type l -type f ! -perm "$file_mode" -print0 | xargs -r -0 chmod "$file_mode" + fi + if [[ -n $user ]] && [[ -n $group ]]; then + find "${find_L_flag[@]}" "$p" -print0 | xargs -r -0 chown "${chown_flags[@]}" "${user}:${group}" + elif [[ -n $user ]] && [[ -z $group ]]; then + find "${find_L_flag[@]}" "$p" -print0 | xargs -r -0 chown "${chown_flags[@]}" "${user}" + elif [[ -z $user ]] && [[ -n $group ]]; then + find "${find_L_flag[@]}" "$p" -print0 | xargs -r -0 chgrp "${chown_flags[@]}" "${group}" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 000000000000..f3a5fe7868ee --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 000000000000..f873cf875a99 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,146 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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}" + # converts the string to lowercase + local bool_val="${bool,,}" + if ! [[ "$bool_val" = 1 || "$bool_val" =~ ^(yes|true)$ ]]; then + printf "%b\\n" "${*}" >&2 + fi +} + +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +log() { + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" + else + stderr_print "${MODULE:-} $(date "+%T.%2N ")${*}" + fi +} +######################## +# Log an 'info' message +# Arguments: +# Message to log +# Returns: +# None +######################### +info() { + local msg_color="" + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + msg_color="$GREEN" + fi + log "${msg_color}INFO ${RESET} ==> ${*}" +} +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +warn() { + local msg_color="" + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + msg_color="$YELLOW" + fi + log "${msg_color}WARN ${RESET} ==> ${*}" +} +######################## +# Log an 'error' message +# Arguments: +# Message to log +# Returns: +# None +######################### +error() { + local msg_color="" + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + msg_color="$RED" + fi + log "${msg_color}ERROR${RESET} ==> ${*}" +} +######################## +# Log a 'debug' message +# Globals: +# BITNAMI_DEBUG +# Arguments: +# None +# Returns: +# None +######################### +debug() { + local msg_color="" + local color_bool="${BITNAMI_COLOR:-true}" + # converts the string to lowercase + local color_bool_val="${color_bool,,}" + if [[ "$color_bool_val" = 1 || "$color_bool_val" =~ ^(yes|true)$ ]]; then + msg_color="$MAGENTA" + fi + local debug_bool="${BITNAMI_DEBUG:-false}" + if [[ "$debug_bool" = 1 || "$debug_bool" =~ ^(yes|true)$ ]]; then + log "${msg_color}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/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 000000000000..a1592f3bfde8 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,171 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libvalidations.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 + # Check if the first IP address is IPv6 to add brackets + if validate_ipv6 "${ip_addresses[0]}" ; then + echo "[${ip_addresses[0]}]" + else + echo "${ip_addresses[0]}" + fi +} + +######################## +# 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-9a-fA-F:.]+\])(:([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/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 000000000000..2d3c3bdb5f4a --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,657 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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" -n + 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/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 000000000000..833ee5ab1d65 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,124 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 acl_file="$(mktemp "${TMPDIR:-/tmp}"/acl.XXXXXXXXXX)" + 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' > "$acl_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="$acl_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$acl_file") + fi + popd >/dev/null || exit + done + popd >/dev/null || exit + rm -f "$acl_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/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 000000000000..c1d60a5c5f42 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,446 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 +} + +######################## +# Generate a logrotate configuration file +# Arguments: +# $1 - Service name +# $2 - Log files pattern +# Flags: +# --period - Period +# --rotations - Number of rotations to store +# --extra - Extra options (Optional) +# Returns: +# None +######################### +generate_logrotate_conf() { + local service_name="${1:?service name is missing}" + local log_path="${2:?log path is missing}" + local period="weekly" + local rotations="150" + local extra="" + local logrotate_conf_dir="/etc/logrotate.d" + local var_name + # Parse optional CLI flags + shift 2 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --period|--rotations|--extra) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "$var_name"="${1:?"$var_name" is missing}" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + mkdir -p "$logrotate_conf_dir" + cat < "${logrotate_conf_dir}/${service_name}" +# Copyright Broadcom, Inc. All Rights Reserved. +# 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="" + local timeout_start_sec="2min" + local timeout_stop_sec="30s" + # 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 \ + | --timeout-start-sec \ + | --timeout-stop-sec \ + ) + 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" </dev/null + wait + exit $? + } + trap _service_forward_term TERM +} diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh new file mode 100644 index 000000000000..3a996383cfab --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh @@ -0,0 +1,294 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Validation functions library + +# shellcheck disable=SC1091,SC2086 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Check if the provided argument is an integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_int() { + local -r int="${1:?missing value}" + if [[ "$int" =~ ^-?[0-9]+$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a positive integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_positive_int() { + local -r int="${1:?missing value}" + if is_int "$int" && (( "${int}" >= 0 )); then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean or is the string 'yes/true' +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_boolean_yes() { + local -r bool="${1:-}" + # converts the string to lowercase + local bool_val="${bool,,}" + if [[ "$bool_val" = 1 || "$bool_val" =~ ^(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 + ;; + *) + string="$1" + ;; + esac + shift + done + + 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/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 000000000000..770861ecedcd --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,84 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 +} + +######################## +# Compares two semantic versions +# Arguments: +# $1 - version1: first version to compare +# $2 - version2: second version to compare +# Returns: +# -1 if version1 is less than version2 +# 0 if version1 is equal to version2 +# 1 if version1 is greater than version2 +######################### +compare_semantic_versions() { + local version1="${1:?version1 is required}" + local version2="${2:?version2 is required}" + local major1 major2 minor1 minor2 patch1 patch2 + + major1="$(get_sematic_version "$version1" 1)" + major2="$(get_sematic_version "$version2" 1)" + minor1="$(get_sematic_version "$version1" 2)" + minor2="$(get_sematic_version "$version2" 2)" + patch1="$(get_sematic_version "$version1" 3)" + patch2="$(get_sematic_version "$version2" 3)" + + if [[ "$major1" -eq "$major2" ]] && [[ "$minor1" -eq "$minor2" ]] && [[ "$patch1" -eq "$patch2" ]]; then + echo "0" + elif [[ "$major1" -lt "$major2" ]] || + { [[ "$major1" -eq "$major2" ]] && [[ "$minor1" -lt "$minor2" ]]; } || + { [[ "$major1" -eq "$major2" ]] && [[ "$minor1" -eq "$minor2" ]] && [[ "$patch1" -lt "$patch2" ]]; }; then + echo "-1" + else + echo "1" + fi +} diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 000000000000..bbf4709b729f --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,396 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 +} + +######################## +# 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 +} diff --git a/bitnami/etcd/3.7/debian-12/prebuildfs/usr/sbin/install_packages b/bitnami/etcd/3.7/debian-12/prebuildfs/usr/sbin/install_packages new file mode 100755 index 000000000000..ccce248b2d14 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,27 @@ +#!/bin/sh +# Copyright Broadcom, Inc. All Rights Reserved. +# 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/etcd/3.7/debian-12/prebuildfs/usr/sbin/run-script b/bitnami/etcd/3.7/debian-12/prebuildfs/usr/sbin/run-script new file mode 100755 index 000000000000..0e07c9038dfd --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/usr/sbin/run-script @@ -0,0 +1,24 @@ +#!/bin/sh +# Copyright Broadcom, Inc. All Rights Reserved. +# 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/etcd/3.7/debian-12/prebuildfs/usr/sbin/uninstall_packages b/bitnami/etcd/3.7/debian-12/prebuildfs/usr/sbin/uninstall_packages new file mode 100755 index 000000000000..615c430e4e68 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/prebuildfs/usr/sbin/uninstall_packages @@ -0,0 +1,26 @@ +#!/bin/sh +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 autoremove --purge -y "$@" + ) + 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/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd-env.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd-env.sh new file mode 100644 index 000000000000..005cc3a37e8b --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd-env.sh @@ -0,0 +1,113 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Environment configuration for etcd + +# 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:-etcd}" +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 +etcd_env_vars=( + ETCD_SNAPSHOTS_DIR + ETCD_SNAPSHOT_HISTORY_LIMIT + ETCD_INIT_SNAPSHOTS_DIR + ALLOW_NONE_AUTHENTICATION + ETCD_ROOT_PASSWORD + ETCD_CLUSTER_DOMAIN + ETCD_START_FROM_SNAPSHOT + ETCD_DISASTER_RECOVERY + ETCD_ON_K8S + ETCD_INIT_SNAPSHOT_FILENAME + ETCD_PREUPGRADE_START_DELAY + ETCD_NAME + ETCD_LOG_LEVEL + ETCD_LISTEN_CLIENT_URLS + ETCD_ADVERTISE_CLIENT_URLS + ETCD_INITIAL_CLUSTER + ETCD_LISTEN_PEER_URLS + ETCD_INITIAL_ADVERTISE_PEER_URLS + ETCD_INITIAL_CLUSTER_TOKEN + ETCD_AUTO_TLS + ETCD_CERT_FILE + ETCD_KEY_FILE + ETCD_TRUSTED_CA_FILE + ETCD_CLIENT_CERT_AUTH + ETCD_PEER_AUTO_TLS + ETCD_EXTRA_AUTH_FLAGS +) +for env_var in "${etcd_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 etcd_env_vars + +# Paths +export ETCD_BASE_DIR="/opt/bitnami/etcd" +export ETCD_VOLUME_DIR="/bitnami/etcd" +export ETCD_BIN_DIR="${ETCD_BASE_DIR}/bin" +export ETCD_DATA_DIR="${ETCD_VOLUME_DIR}/data" +export ETCD_CONF_DIR="${ETCD_BASE_DIR}/conf" +export ETCD_DEFAULT_CONF_DIR="${ETCD_BASE_DIR}/conf.default" +export ETCD_TMP_DIR="${ETCD_BASE_DIR}/tmp" +export ETCD_CONF_FILE="${ETCD_CONF_DIR}/etcd.yaml" +export ETCD_SNAPSHOTS_DIR="${ETCD_SNAPSHOTS_DIR:-/snapshots}" +export ETCD_SNAPSHOT_HISTORY_LIMIT="${ETCD_SNAPSHOT_HISTORY_LIMIT:-1}" +export ETCD_INIT_SNAPSHOTS_DIR="${ETCD_INIT_SNAPSHOTS_DIR:-/init-snapshot}" +export ETCD_NEW_MEMBERS_ENV_FILE="${ETCD_DATA_DIR}/new_member_envs" +export PATH="${ETCD_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" + +# System users (when running with a privileged user) +export ETCD_DAEMON_USER="etcd" +export ETCD_DAEMON_GROUP="etcd" + +# etcd settings +export ALLOW_NONE_AUTHENTICATION="${ALLOW_NONE_AUTHENTICATION:-no}" +export ETCD_ROOT_PASSWORD="${ETCD_ROOT_PASSWORD:-}" +export ETCD_CLUSTER_DOMAIN="${ETCD_CLUSTER_DOMAIN:-}" +export ETCD_START_FROM_SNAPSHOT="${ETCD_START_FROM_SNAPSHOT:-no}" +export ETCD_DISASTER_RECOVERY="${ETCD_DISASTER_RECOVERY:-no}" +export ETCD_ON_K8S="${ETCD_ON_K8S:-no}" +export ETCD_INIT_SNAPSHOT_FILENAME="${ETCD_INIT_SNAPSHOT_FILENAME:-}" +export ETCD_PREUPGRADE_START_DELAY="${ETCD_PREUPGRADE_START_DELAY:-}" + +# etcd native environment variables (see https://etcd.io/docs/current/op-guide/configuration) +export ETCD_NAME="${ETCD_NAME:-}" +export ETCD_LOG_LEVEL="${ETCD_LOG_LEVEL:-info}" +export ETCD_LISTEN_CLIENT_URLS="${ETCD_LISTEN_CLIENT_URLS:-http://0.0.0.0:2379}" +export ETCD_ADVERTISE_CLIENT_URLS="${ETCD_ADVERTISE_CLIENT_URLS:-http://127.0.0.1:2379}" +export ETCD_INITIAL_CLUSTER="${ETCD_INITIAL_CLUSTER:-}" +export ETCD_LISTEN_PEER_URLS="${ETCD_LISTEN_PEER_URLS:-}" +export ETCD_INITIAL_ADVERTISE_PEER_URLS="${ETCD_INITIAL_ADVERTISE_PEER_URLS:-}" +export ETCD_INITIAL_CLUSTER_TOKEN="${ETCD_INITIAL_CLUSTER_TOKEN:-}" +export ETCD_AUTO_TLS="${ETCD_AUTO_TLS:-false}" +export ETCD_CERT_FILE="${ETCD_CERT_FILE:-}" +export ETCD_KEY_FILE="${ETCD_KEY_FILE:-}" +export ETCD_TRUSTED_CA_FILE="${ETCD_TRUSTED_CA_FILE:-}" +export ETCD_CLIENT_CERT_AUTH="${ETCD_CLIENT_CERT_AUTH:-false}" +export ETCD_PEER_AUTO_TLS="${ETCD_PEER_AUTO_TLS:-false}" +export ETCD_EXTRA_AUTH_FLAGS="${ETCD_EXTRA_AUTH_FLAGS:-}" + +# Custom environment variables may be defined below diff --git a/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/entrypoint.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/entrypoint.sh new file mode 100755 index 000000000000..6502c15e308b --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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/liblog.sh +. /opt/bitnami/scripts/libfs.sh + +# Load etcd environment variables +. /opt/bitnami/scripts/etcd-env.sh + +print_welcome_page + +if ! is_dir_empty "$ETCD_DEFAULT_CONF_DIR"; then + # We add the copy from default config in the entrypoint to not break users + # bypassing the setup.sh logic. If the file already exists do not overwrite (in + # case someone mounts a configuration file in /opt/bitnami/etcd/conf) + debug "Copying files from $ETCD_DEFAULT_CONF_DIR to $ETCD_CONF_DIR" + cp -nfr "$ETCD_DEFAULT_CONF_DIR"/. "$ETCD_CONF_DIR" +fi + +if [[ "$1" = "/opt/bitnami/scripts/etcd/run.sh" ]]; then + info "** Starting etcd setup **" + /opt/bitnami/scripts/etcd/setup.sh + info "** etcd setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/healthcheck.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/healthcheck.sh new file mode 100755 index 000000000000..da546acc9b17 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/healthcheck.sh @@ -0,0 +1,36 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o pipefail +set -o nounset + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libnet.sh +. /opt/bitnami/scripts/libetcd.sh + +# Load etcd environment settings +. /opt/bitnami/scripts/etcd-env.sh + +read -r -a advertised_array <<< "$(tr ',;' ' ' <<< "$ETCD_ADVERTISE_CLIENT_URLS")" +host="$(parse_uri "${advertised_array[0]}" "host")" +port="$(parse_uri "${advertised_array[0]}" "port")" +read -r -a extra_flags <<< "$(etcdctl_auth_norbac_flags)" +! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" +extra_flags+=("--endpoints=${host}:${port}") + +# if ETCD_AUTO_TLS true or CA file not exists, just skip server cert verification +if [[ $ETCD_AUTO_TLS = true ]] || ( [ -n "$ETCD_CERT_FILE" ] && [[ ! -f "$ETCD_TRUSTED_CA_FILE" ]] ); then + extra_flags+=("--insecure-skip-tls-verify") +fi + +if etcdctl endpoint health "${extra_flags[@]}"; then + exit 0 +else + error "Unhealthy endpoint!" + exit 1 +fi diff --git a/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/postunpack.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/postunpack.sh new file mode 100755 index 000000000000..168a8a40331d --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/postunpack.sh @@ -0,0 +1,27 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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 + +# Load etcd environment variables +. /opt/bitnami/scripts/etcd-env.sh + +for dir in "$ETCD_BIN_DIR" "$ETCD_DATA_DIR" "$ETCD_CONF_DIR" "$ETCD_DEFAULT_CONF_DIR" "${ETCD_BASE_DIR}/certs"; do + ensure_dir_exists "$dir" +done +chmod -R g+rwX "$ETCD_DATA_DIR" "${ETCD_BASE_DIR}/certs" + +if ! is_dir_empty "$ETCD_CONF_DIR"; then + # Copy all initially generated configuration files to the default directory + # (this is to avoid breaking when entrypoint is being overridden) + cp -r "${ETCD_CONF_DIR}/"* "$ETCD_DEFAULT_CONF_DIR" +fi \ No newline at end of file diff --git a/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/preupgrade.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/preupgrade.sh new file mode 100755 index 000000000000..2197e36077c1 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/preupgrade.sh @@ -0,0 +1,65 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o pipefail +set -o nounset + +# Load libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libetcd.sh + +# Load etcd environment settings +. /opt/bitnami/scripts/etcd-env.sh + +######################## +# Return a comma separated list of : for each endpoint +# based on "initial-cluster" flag value +# ref: https://etcd.io/docs/latest/op-guide/clustering/#static +# Globals: +# ETCD_INITIAL_CLUSTER +# Arguments: +# None +# Returns: +# String +######################## +endpoints_as_host_port() { + echo "$ETCD_INITIAL_CLUSTER" | tr -s ',' '\n' | awk -F '//' '{print $2}' | tr -s '\n' ',' | sed 's/,$//' +} + +# Remove members that are not listed in ETCD_INITIAL_CLUSTER +# from the cluster before running Helm upgrades that potentially scale +# down the etcd cluster + +read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" +! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" +is_boolean_yes "$ETCD_ON_K8S" && extra_flags+=("--endpoints=$(endpoints_as_host_port)") + +if [[ -n "$ETCD_PREUPGRADE_START_DELAY" ]]; then + info "Waiting for $ETCD_PREUPGRADE_START_DELAY seconds before starting pre-upgrade checks" + sleep "$ETCD_PREUPGRADE_START_DELAY" +fi + +debug "Listing members" +if ! current="$(etcdctl member list "${extra_flags[@]}" --write-out simple | awk -F ", " '{print $3 ":" $1}')"; then + error "Unable to list members, are all members healthy?" + exit 1 +fi +info "Current cluster members are: $(echo "$current" | awk -F: '{print $1}' | tr -s '\n' ',' | sed 's/,$//g')" + +expected="$(echo "$ETCD_INITIAL_CLUSTER" | tr -s ',' '\n' | awk -F= '{print $1}')" +info "Expected cluster members are: $(echo "$expected" | tr -s '\n' ',' | sed 's/,$//g')" +read -r -a obsolete_members <<<"$(comm -23 <(echo "$current" | awk -F: '{print $1}' | sort) <(echo "$expected" | sort) | tr -s '\n' ' ')" +if [[ "${#obsolete_members[@]}" -eq 0 ]]; then + info "No obsolete members to remove." +else + for member in "${obsolete_members[@]}"; do + info "Removing obsolete member $member" + etcdctl member remove "${extra_flags[@]}" "$(echo "$current" | grep "$member" | awk -F: '{print $2}')" + done +fi +info "Pre-upgrade checks completed!" diff --git a/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/run.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/run.sh new file mode 100755 index 000000000000..2c338395ba79 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/run.sh @@ -0,0 +1,37 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1090,SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libetcd.sh + +# Load etcd environment variables +. /opt/bitnami/scripts/etcd-env.sh + +# We need to unset ETCD_ROOT_PASSWORD otherwise it will be logged by etcd process +unset ETCD_ROOT_PASSWORD +# Load env vars of existing cluster +etcd_safe_load_member_env + +declare -a cmd=("etcd") +# If provided, run using configuration file +# Using a configuration file will cause etcd to ignore other flags and environment variables +[[ -f "$ETCD_CONF_FILE" ]] && cmd+=("--config-file" "$ETCD_CONF_FILE") +cmd+=("$@") + +info "** Starting etcd **" +if am_i_root; then + exec_as_user "$ETCD_DAEMON_USER" "${cmd[@]}" +else + exec "${cmd[@]}" +fi diff --git a/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/setup.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/setup.sh new file mode 100755 index 000000000000..ac538eeaae6d --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/setup.sh @@ -0,0 +1,26 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# 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/libetcd.sh + +# Load etcd environment settings +. /opt/bitnami/scripts/etcd-env.sh + +# Ensure etcd environment settings are valid +etcd_validate +# Ensure etcd is stopped when this script ends. +trap "etcd_stop" EXIT +# Ensure 'daemon' user exists when running as 'root' +am_i_root && ensure_user_exists "$ETCD_DAEMON_USER" --group "$ETCD_DAEMON_GROUP" +# Ensure etcd is initialized +etcd_initialize diff --git a/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/snapshot.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/snapshot.sh new file mode 100755 index 000000000000..c65dd58620c8 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/etcd/snapshot.sh @@ -0,0 +1,41 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o pipefail +set -o nounset + +# Load libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libetcd.sh + +# Load etcd environment settings +. /opt/bitnami/scripts/etcd-env.sh + +ensure_dir_exists "$ETCD_SNAPSHOTS_DIR" +endpoints="$(etcdctl_get_endpoints)" +read -r -a endpoints_array <<< "$(tr ',;' ' ' <<< "$endpoints")" +for e in "${endpoints_array[@]}"; do + debug "Using endpoint $e" + read -r -a extra_flags <<< "$(etcdctl_auth_norbac_flags)" + ! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" + extra_flags+=("--endpoints=$e") + if etcdctl endpoint health "${extra_flags[@]}"; then + info "Snapshotting the keyspace" + current_time="$(date -u "+%Y-%m-%d_%H-%M")" + etcdctl snapshot save "${ETCD_SNAPSHOTS_DIR}/db-${current_time}" "${extra_flags[@]}" + find "${ETCD_SNAPSHOTS_DIR}/" -maxdepth 1 -type f -name 'db-*' \! -name "db-${current_time}" \ + | sort -r \ + | tail -n+$((1 + ETCD_SNAPSHOT_HISTORY_LIMIT)) \ + | xargs rm -f + exit 0 + else + warn "etcd endpoint $e not healthy. Trying a different endpoint" + fi +done +error "all etcd endpoints are unhealthy!" +exit 1 diff --git a/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/libetcd.sh b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/libetcd.sh new file mode 100644 index 000000000000..cd3cb753a3a2 --- /dev/null +++ b/bitnami/etcd/3.7/debian-12/rootfs/opt/bitnami/scripts/libetcd.sh @@ -0,0 +1,839 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami etcd library + +# shellcheck disable=SC1090,SC1091,SC2119,SC2120 + +# 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/libnet.sh +. /opt/bitnami/scripts/libservice.sh + +# Functions + +######################## +# Write a configuration setting value +# Globals: +# ETCD_CONF_FILE +# Arguments: +# $1 - key +# $2 - value +# $3 - YAML type (string, int or bool) +# Returns: +# None +######################### +etcd_conf_write() { + local -r key="${1:?Missing key}" + local -r value="${2:-}" + local -r type="${3:-string}" + local -r tempfile=$(mktemp) + + [[ -z "$value" ]] && return + [[ ! -f "$ETCD_CONF_FILE" ]] && touch "$ETCD_CONF_FILE" + case "$type" in + string) + yq eval "(.${key}) |= \"${value}\"" "$ETCD_CONF_FILE" >"$tempfile" + ;; + bool) + yq eval "(.${key}) |= (\"${value}\" | test(\"true\"))" "$ETCD_CONF_FILE" >"$tempfile" + ;; + raw) + yq eval "(.${key}) |= ${value}" "$ETCD_CONF_FILE" >"$tempfile" + ;; + *) + error "Type unknown: ${type}" + return 1 + ;; + esac + cp "$tempfile" "$ETCD_CONF_FILE" +} + +######################## +# Creates etcd configuration file from environment variables +# Globals: +# ETCD_CFG_* +# Arguments: +# None +# Returns: +# None +######################### +etcd_setup_from_environment_variables() { + ## Except for Client and Peer TLS configuration, + ## all etcd settings consists of ETCD_FLAG_NAME + ## transformed into flag-name and configured under the yaml config root. + local -a client_tls_values=( + "ETCD_CFG_CERT_FILE" + "ETCD_CFG_KEY_FILE" + "ETCD_CFG_CLIENT_CERT_AUTH" + "ETCD_CFG_TRUSTED_CA_FILE" + "ETCD_CFG_AUTO_TLS" + "ETCD_CFG_CA_FILE" + ) + info "Generating etcd config file using env variables" + # Map environment variables to config properties for etcd-env.sh + for var in "${!ETCD_CFG_@}"; do + value="${!var:-}" + if [[ -n "$value" ]]; then + type="string" + # Detect if value is digit or bool + if [[ "$value" =~ ^[+-]?[0-9]+([.][0-9]+)?$ || "$value" =~ ^(true|false)$ ]]; then + type="raw" + fi + if [[ ${client_tls_values[*]} =~ ${var} ]]; then + key="$(echo "$var" | sed -e 's/^ETCD_CFG_//g' -e 's/_/-/g' | tr '[:upper:]' '[:lower:]')" + etcd_conf_write "client-transport-security.${key}" "$value" "$type" + elif [[ "$var" =~ "ETCD_CFG_CLIENT_" ]]; then + key="$(echo "$var" | sed -e 's/^ETCD_CFG_CLIENT_//g' -e 's/_/-/g' | tr '[:upper:]' '[:lower:]')" + etcd_conf_write "client-transport-security.${key}" "$value" "$type" + elif [[ "$var" =~ "ETCD_CFG_PEER_" ]]; then + key="$(echo "$var" | sed -e 's/^ETCD_CFG_PEER_//g' -e 's/_/-/g' | tr '[:upper:]' '[:lower:]')" + etcd_conf_write "peer-transport-security.${key}" "$value" "$type" + else + # shellcheck disable=SC2001 + key="$(echo "$var" | sed -e 's/^ETCD_CFG_//g' -e 's/_/-/g' | tr '[:upper:]' '[:lower:]')" + etcd_conf_write "$key" "$value" "$type" + fi + fi + done + if am_i_root && [[ -f "$ETCD_CONF_FILE" ]] ; then + chown "$ETCD_DAEMON_USER" "$ETCD_CONF_FILE" + fi +} + +######################## +# Validate settings in ETCD_* environment variables +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# None +######################### +etcd_validate() { + info "Validating settings in ETCD_* env vars.." + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + if is_boolean_yes "$ALLOW_NONE_AUTHENTICATION"; then + warn "You set the environment variable ALLOW_NONE_AUTHENTICATION=${ALLOW_NONE_AUTHENTICATION}. For safety reasons, do not use this flag in a production environment." + else + is_empty_value "$ETCD_ROOT_PASSWORD" && print_validation_error "The ETCD_ROOT_PASSWORD environment variable is empty or not set. Set the environment variable ALLOW_NONE_AUTHENTICATION=yes to allow a blank password. This is only recommended for development environments." + fi + if is_boolean_yes "$ETCD_START_FROM_SNAPSHOT" && [[ ! -f "${ETCD_INIT_SNAPSHOTS_DIR}/${ETCD_INIT_SNAPSHOT_FILENAME}" ]]; then + print_validation_error "You are trying to initialize etcd from a snapshot, but no snapshot was found. Set the environment variable ETCD_INIT_SNAPSHOT_FILENAME with the snapshot filename and mount it at '${ETCD_INIT_SNAPSHOTS_DIR}' directory." + fi + + [[ "$error_code" -eq 0 ]] || return "$error_code" +} + +######################## +# Check if etcd is running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_etcd_running() { + local pid + pid="$(pgrep -f "^etcd" || true)" + + # etcd does not create any PID file + # We regenerate the PID file for each time we query it to avoid getting outdated + if [[ -n "${ETCD_PID_FILE:-}" ]]; then + echo "$pid" >"$ETCD_PID_FILE" + fi + + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if etcd is running +# Globals: +# ETCD_PID_FILE +# Arguments: +# None +# Returns: +# Whether etcd is not running +######################## +is_etcd_not_running() { + ! is_etcd_running +} + +######################## +# Stop etcd +# Arguments: +# None +# Returns: +# None +######################### +etcd_stop() { + local pid + ! is_etcd_running && return + + info "Stopping etcd" + # Ensure process matches etcd binary with or without options + pid="$(pgrep -f "^etcd")" + local counter=10 + kill "$pid" + while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do + sleep 1 + counter=$((counter - 1)) + done +} + +######################## +# Start etcd in background +# Arguments: +# None +# Returns: +# None +######################### +etcd_start_bg() { + is_etcd_running && return + + info "Starting etcd in background" + local start_command=("etcd") + am_i_root && start_command=("run_as_user" "$ETCD_DAEMON_USER" "${start_command[@]}") + [[ -f "$ETCD_CONF_FILE" ]] && start_command+=("--config-file" "$ETCD_CONF_FILE") + debug_execute "${start_command[@]}" & + sleep 3 +} + +######################## +# Obtain endpoints to connect when running 'ectdctl' +# Globals: +# ETCD_* +# Arguments: +# $1 - exclude current member from the list (default: false) +# Returns: +# String +######################## +etcdctl_get_endpoints() { + local only_others=${1:-false} + local -a endpoints=() + local host domain port + + hostname_has_ips() { + local hostname="${1:?hostname is required}" + [[ "$(getent ahosts "$hostname")" != "" ]] && return 0 + return 1 + } + + # This piece of code assumes this code is executed on a K8s environment + # where etcd members are part of a statefulset that uses a headless service + # to create a unique FQDN per member. Under these circumstances, the + # ETCD_ADVERTISE_CLIENT_URLS env. variable is created as follows: + # SCHEME://POD_NAME.HEADLESS_SVC_DOMAIN:CLIENT_PORT,SCHEME://SVC_DOMAIN:SVC_CLIENT_PORT + # + # Assuming this, we can extract the HEADLESS_SVC_DOMAIN and obtain + # every available endpoint + read -r -a advertised_array <<<"$(tr ',;' ' ' <<<"$ETCD_ADVERTISE_CLIENT_URLS")" + host="$(parse_uri "${advertised_array[0]}" "host")" + port="$(parse_uri "${advertised_array[0]}" "port")" + domain="${host#"${ETCD_NAME}."}" + # When ETCD_CLUSTER_DOMAIN is set, we use that value instead of extracting + # it from ETCD_ADVERTISE_CLIENT_URLS + ! is_empty_value "$ETCD_CLUSTER_DOMAIN" && domain="$ETCD_CLUSTER_DOMAIN" + # Depending on the K8s distro & the DNS plugin, it might need + # a few seconds to associate the POD(s) IP(s) to the headless svc domain + if retry_while "hostname_has_ips $domain"; then + local -r ahosts="$(getent ahosts "$domain" | awk '{print $1}' | uniq | wc -l)" + for i in $(seq 0 $((ahosts - 1))); do + # We use the StatefulSet name stored in MY_STS_NAME to get the peer names based on the number of IPs registered in the headless service + pod_name="${MY_STS_NAME}-${i}" + if ! { [[ $only_others = true ]] && [[ "$pod_name" = "$MY_POD_NAME" ]]; }; then + endpoints+=("${pod_name}.${ETCD_CLUSTER_DOMAIN}:${port:-2380}") + fi + done + fi + echo "${endpoints[*]}" | tr ' ' ',' +} + +######################## +# Obtain etcdctl authentication flags to use (before RBAC is enabled) +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# Array with extra flags to use for authentication +######################### +etcdctl_auth_norbac_flags() { + local -a authFlags=() + + if [[ $ETCD_AUTO_TLS = true ]]; then + authFlags+=("--cert" "${ETCD_DATA_DIR}/fixtures/client/cert.pem" "--key" "${ETCD_DATA_DIR}/fixtures/client/key.pem") + else + [[ -f "$ETCD_CERT_FILE" ]] && [[ -f "$ETCD_KEY_FILE" ]] && authFlags+=("--cert" "$ETCD_CERT_FILE" "--key" "$ETCD_KEY_FILE") + [[ -f "$ETCD_TRUSTED_CA_FILE" ]] && authFlags+=("--cacert" "$ETCD_TRUSTED_CA_FILE") + fi + if [[ -n "$ETCD_EXTRA_AUTH_FLAGS" ]]; then + read -r -a extraAuthFlags <<< "$(tr ',;' ' ' <<< "$ETCD_EXTRA_AUTH_FLAGS")" + authFlags+=("${extraAuthFlags[@]}") + fi + + echo "${authFlags[*]}" +} + +######################## +# Configure etcd RBAC (do not confuse with K8s RBAC) +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# None +######################## +etcd_configure_rbac() { + local orig_listen_client_urls="$ETCD_LISTEN_CLIENT_URLS" + local return_value=0 + + local scheme="http" + [[ $ETCD_AUTO_TLS = true || -f "$ETCD_CERT_FILE" ]] && scheme="https" + export ETCD_LISTEN_CLIENT_URLS="${scheme}://127.0.0.1:2379" + ! is_etcd_running && etcd_start_bg + read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" + extra_flags+=("--endpoints=${scheme}://127.0.0.1:2379") + if retry_while "etcdctl ${extra_flags[*]} member list" >/dev/null 2>&1; then + if retry_while "etcdctl ${extra_flags[*]} auth status" >/dev/null 2>&1; then + if etcdctl "${extra_flags[@]}" auth status | grep -q "Authentication Status: true"; then + info "Authentication already enabled" + else + info "Enabling etcd authentication" + etcdctl "${extra_flags[@]}" user add root --interactive=false <<<"$ETCD_ROOT_PASSWORD" + etcdctl "${extra_flags[@]}" user grant-role root root + etcdctl "${extra_flags[@]}" auth enable + fi + fi + else + error "Failed to enable etcd authentication" + return_value=1 + fi + etcd_stop + export ETCD_LISTEN_CLIENT_URLS="$orig_listen_client_urls" + + return $return_value +} + +######################## +# Wait for primary member to enable RBAC before opening client port +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# None +######################## +etcd_wait_for_rbac() { + local return_value=0 + local orig_listen_client_urls="$ETCD_LISTEN_CLIENT_URLS" + local scheme="http" + + [[ $ETCD_AUTO_TLS = true || -f "$ETCD_CERT_FILE" ]] && scheme="https" + export ETCD_LISTEN_CLIENT_URLS="${scheme}://127.0.0.1:2379" + ! is_etcd_running && etcd_start_bg + + read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" + extra_flags+=("--endpoints=${scheme}://127.0.0.1:2379") + info "Non-primary member: waiting for primary to enable RBAC before opening client port" + # shellcheck disable=SC2329 + _auth_enabled() { + etcdctl "${extra_flags[@]}" auth status | grep -q "Authentication Status: true" + } + if ! retry_while "_auth_enabled"; then + error "Timed out waiting for RBAC — refusing to start production etcd unauthenticated." + return_value=1 + else + info "RBAC is enabled" + fi + etcd_stop + export ETCD_LISTEN_CLIENT_URLS="$orig_listen_client_urls" + + return $return_value +} + +######################## +# Checks if etcd needs to bootstrap a new cluster +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# Boolean +######################## +is_new_etcd_cluster() { + local -a extra_flags + read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" + ! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" + is_boolean_yes "$ETCD_ON_K8S" && extra_flags+=("--endpoints=$(etcdctl_get_endpoints)") + ! debug_execute etcdctl endpoint status --cluster "${extra_flags[@]}" +} + +######################## +# Setup ETCD_ACTIVE_ENDPOINTS environment variable, will return the number of active endpoints , cluster size (including not active member) and the ETCD_ACTIVE_ENDPOINTS (which is also export) +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# List of Numbers (active_endpoints, cluster_size, ETCD_ACTIVE_ENDPOINTS) +######################## +setup_etcd_active_endpoints() { + local active_endpoints=0 + local -a extra_flags active_endpoints_array + local -a endpoints_array=() + local host port + + is_boolean_yes "$ETCD_ON_K8S" && read -r -a endpoints_array <<<"$(tr ',;' ' ' <<<"$(etcdctl_get_endpoints)")" + local -r cluster_size=${#endpoints_array[@]} + read -r -a advertised_array <<<"$(tr ',;' ' ' <<<"$ETCD_ADVERTISE_CLIENT_URLS")" + host="$(parse_uri "${advertised_array[0]}" "host")" + port="$(parse_uri "${advertised_array[0]}" "port")" + if [[ $cluster_size -gt 0 ]]; then + for e in "${endpoints_array[@]}"; do + read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" + ! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" + extra_flags+=("--endpoints=$e") + if [[ "$e" != "$host:$port" ]] && etcdctl endpoint health "${extra_flags[@]}" >/dev/null 2>&1; then + debug "$e endpoint is active" + ((active_endpoints++)) + active_endpoints_array+=("$e") + fi + done + ETCD_ACTIVE_ENDPOINTS=$(echo "${active_endpoints_array[*]}" | tr ' ' ',') + export ETCD_ACTIVE_ENDPOINTS + fi + echo "${active_endpoints} ${cluster_size} ${ETCD_ACTIVE_ENDPOINTS}" +} + +######################## +# Checks if there are enough active members, will also set ETCD_ACTIVE_ENDPOINTS +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# Boolean +######################## +is_healthy_etcd_cluster() { + local return_value=0 + local active_endpoints cluster_size + read -r active_endpoints cluster_size ETCD_ACTIVE_ENDPOINTS <<<"$(setup_etcd_active_endpoints)" + export ETCD_ACTIVE_ENDPOINTS + + if is_boolean_yes "$ETCD_DISASTER_RECOVERY"; then + if [[ -f "/snapshots/.disaster_recovery" ]]; then + # Remove current node from the ones that need to recover + remove_in_file "/snapshots/.disaster_recovery" "$host:$port" + # Remove nodes that do not exist anymore from the ones that need to recover + read -r -a recovery_array <<<"$(tr '\n' ' ' <"/snapshots/.disaster_recovery")" + for r in "${recovery_array[@]}"; do + if [[ ! "${endpoints_array[*]}" =~ $r ]]; then + remove_in_file "/snapshots/.disaster_recovery" "$r" + fi + done + if [[ $(wc -w <"/snapshots/.disaster_recovery") -eq 0 ]]; then + debug "Last member to recover from the disaster!" + rm "/snapshots/.disaster_recovery" + fi + return_value=1 + else + if [[ $active_endpoints -lt $(((cluster_size + 1) / 2)) ]]; then + debug "There are no enough active endpoints!" + for e in "${endpoints_array[@]}"; do + [[ "$e" != "$host:$port" ]] && [[ "$e" != ":$port" ]] && echo "$e" >>"/snapshots/.disaster_recovery" + done + return_value=1 + fi + fi + else + if [[ $active_endpoints -lt $(((cluster_size + 1) / 2)) ]]; then + debug "There are no enough active endpoints!" + return_value=1 + fi + fi + + return $return_value +} + +######################## +# Recalculate initial cluster +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# String +######################## +recalculate_initial_cluster() { + local -a endpoints_array initial_members + local domain host member_host member_port member_id port scheme + + if is_boolean_yes "$ETCD_ON_K8S"; then + read -r -a endpoints_array <<<"$(tr ',;' ' ' <<<"$(etcdctl_get_endpoints)")" + # This piece of code assumes this container is used on a K8s environment + # where etcd members are part of a statefulset that uses a headless service + # to create a unique FQDN per member. Under these circumstances, the + # ETCD_INITIAL_ADVERTISE_PEER_URLS are created as follows: + # SCHEME://POD_NAME.HEADLESS_SVC_DOMAIN:PEER_PORT + # + # Assuming this, we can extract the HEADLESS_SVC_DOMAIN + host="$(parse_uri "$ETCD_INITIAL_ADVERTISE_PEER_URLS" "host")" + scheme="$(parse_uri "$ETCD_INITIAL_ADVERTISE_PEER_URLS" "scheme")" + port="$(parse_uri "$ETCD_INITIAL_ADVERTISE_PEER_URLS" "port")" + domain="${host#"${ETCD_NAME}."}" + # When ETCD_CLUSTER_DOMAIN is set, we use that value instead of extracting + # it from ETCD_INITIAL_ADVERTISE_PEER_URLS + ! is_empty_value "$ETCD_CLUSTER_DOMAIN" && domain="$ETCD_CLUSTER_DOMAIN" + for e in "${endpoints_array[@]}"; do + member_host="$(parse_uri "$scheme://$e" "host")" + member_port="$(parse_uri "$scheme://$e" "port")" + member_id=${e%".$domain:$member_port"} + initial_members+=("${member_id}=${scheme}://${member_host}:$port") + done + echo "${initial_members[*]}" | tr ' ' ',' + else + # Nothing to do + echo "$ETCD_INITIAL_CLUSTER" + fi +} + +######################## +# Remove the old member from the cluster if it exists +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# None +######################### +remove_old_member_if_exist() { + local old_member_id + old_member_id=$(get_member_id) + if ! is_empty_value "$old_member_id"; then + info "Removing old member $old_member_id" + local -a extra_flags + read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" + ! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" + is_boolean_yes "$ETCD_ON_K8S" && extra_flags+=("--endpoints=$(etcdctl_get_endpoints)") + etcdctl member remove "$old_member_id" "${extra_flags[@]}" + fi +} + +######################## +# Add this member as a new member to the cluster +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# None +######################### +add_new_member() { + info "Adding new member to existing cluster" + local -a extra_flags + read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" + ! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" + is_boolean_yes "$ETCD_ON_K8S" && extra_flags+=("--endpoints=$(etcdctl_get_endpoints)") + extra_flags+=("--peer-urls=$ETCD_INITIAL_ADVERTISE_PEER_URLS") + mkdir -p "$(dirname $ETCD_NEW_MEMBERS_ENV_FILE)" || true + etcdctl member add "$ETCD_NAME" "${extra_flags[@]}" | grep "^ETCD_" >"$ETCD_NEW_MEMBERS_ENV_FILE" +} + +######################## +# Safe loader — reads KEY=VALUE without eval or source +# Globals: +# ETCD_NEW_MEMBERS_ENV_FILE +# Arguments: +# None +# Returns: +# None +######################### +etcd_safe_load_member_env() { + [[ -f "$ETCD_NEW_MEMBERS_ENV_FILE" ]] || return 0 + local _k _v + while IFS='=' read -r _k _v; do + [[ "$_k" =~ ^ETCD_[A-Z_]+$ ]] || continue + # etcdctl member add emits shell-quoted KEY="VALUE" lines; strip + # the surrounding double-quotes so they are not passed to etcd. + _v="${_v#\"}" + _v="${_v%\"}" + export "$_k"="$_v" + done < "$ETCD_NEW_MEMBERS_ENV_FILE" +} + +######################## +# Check that this node is still a member of the cluster +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# None +######################### +is_node_still_a_member() { + local tmp_file + local start_command=("etcd") + + tmp_file="$(mktemp)" + # shellcheck disable=SC2064 + trap "rm -f ${tmp_file}" RETURN + + am_i_root && start_command=("run_as_user" "$ETCD_DAEMON_USER" "${start_command[@]}") + [[ -f "$ETCD_CONF_FILE" ]] && start_command+=("--config-file" "$ETCD_CONF_FILE") + "${start_command[@]}" > "$tmp_file" 2>&1 & + + while read -r line; do + debug_execute echo "$line" + if [[ "$line" =~ (established TCP streaming connection with remote peer|the member has been permanently removed from the cluster|ignored streaming request; ID mismatch|\"error\":\"cluster ID mismatch\"|\"level\":\"fatal\") ]]; then + etcd_stop + break + fi + done < <(tail -f "$tmp_file") + + if grep -q "the member has been permanently removed from the cluster\|ignored streaming request; ID mismatch" "$tmp_file"; then + info "The remote member ID is different from the local member ID" + return 1 + elif grep -q "\"error\":\"cluster ID mismatch\"" "$tmp_file"; then + info "The remote cluster ID is different from the local cluster ID" + return 1 + elif grep -q '"level":"fatal"' "$tmp_file"; then + info "etcd exited with a fatal error, treating node as not a member" + return 1 + fi + + info "The member is still part of the cluster" + return 0 +} + +######################## +# Ensure etcd is initialized +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# None +######################### +etcd_initialize() { + local -a extra_flags initial_members + local domain + + info "Initializing etcd" + + # Generate user configuration if ETCD_CFG_* variables are provided + etcd_setup_from_environment_variables + + export ETCD_INITIAL_CLUSTER + [[ -f "$ETCD_CONF_FILE" ]] && etcd_conf_write "initial-cluster" "$ETCD_INITIAL_CLUSTER" + + read -r -a initial_members <<<"$(tr ',;' ' ' <<<"$ETCD_INITIAL_CLUSTER")" + if is_mounted_dir_empty "$ETCD_DATA_DIR"; then + info "There is no data from previous deployments" + if [[ ${#initial_members[@]} -gt 1 ]]; then + if is_new_etcd_cluster; then + info "Bootstrapping a new cluster" + if is_boolean_yes "$ETCD_ON_K8S"; then + debug "Waiting for the headless svc domain to have an IP per initial member in the cluster" + if is_empty_value "$ETCD_CLUSTER_DOMAIN"; then + # This piece of code assumes this container is used on a K8s environment + # where etcd members are part of a statefulset that uses a headless service + # to create a unique FQDN per member. Under these circumstances, the + # ETCD_INITIAL_ADVERTISE_PEER_URLS are created as follows: + # SCHEME://POD_NAME.HEADLESS_SVC_DOMAIN:PEER_PORT + # + # Assuming this, we can extract the HEADLESS_SVC_DOMAIN + host="$(parse_uri "$ETCD_INITIAL_ADVERTISE_PEER_URLS" "host")" + domain="${host#"${ETCD_NAME}."}" + else + # When ETCD_CLUSTER_DOMAIN is set, we use that value instead of extracting + # it from ETCD_INITIAL_ADVERTISE_PEER_URLS + domain="$ETCD_CLUSTER_DOMAIN" + fi + # shellcheck disable=SC2329 + hostname_has_N_ips() { + local -r hostname="${1:?hostname is required}" + local -r n=${2:?number of ips is required} + local -r ready_hosts=$(getent ahosts "$hostname" | awk '{print $1}' | uniq | wc -l) + [[ $((ready_hosts % n)) -eq 0 ]] && [[ $((ready_hosts / n)) -ge 1 ]] && return 0 + return 1 + } + if ! retry_while "hostname_has_N_ips $domain ${#initial_members[@]}"; then + error "Headless service domain does not have an IP per initial member in the cluster" + exit 1 + fi + fi + else + # if an old member with the same name is already registered, we want to remove it first + remove_old_member_if_exist + info "Adding new member to existing cluster" + ensure_dir_exists "$ETCD_DATA_DIR" + add_self_to_cluster + fi + fi + if is_boolean_yes "$ETCD_START_FROM_SNAPSHOT"; then + if [[ -f "${ETCD_INIT_SNAPSHOTS_DIR}/${ETCD_INIT_SNAPSHOT_FILENAME}" ]]; then + info "Restoring snapshot before initializing etcd cluster" + # Only recalculate the initial cluster config if it hasn't + # been provided. + if is_empty_value "$ETCD_INITIAL_CLUSTER"; then + ETCD_INITIAL_CLUSTER="$(recalculate_initial_cluster)" + export ETCD_INITIAL_CLUSTER + fi + + [[ -f "$ETCD_CONF_FILE" ]] && etcd_conf_write "initial-cluster" "$ETCD_INITIAL_CLUSTER" + + local -a restore_args=( + "--data-dir" "$ETCD_DATA_DIR" + "--name" "$ETCD_NAME" + "--initial-cluster" "$ETCD_INITIAL_CLUSTER" + "--initial-cluster-token" "$ETCD_INITIAL_CLUSTER_TOKEN" + "--initial-advertise-peer-urls" "$ETCD_INITIAL_ADVERTISE_PEER_URLS" + ) + debug_execute etcdutl snapshot restore "${ETCD_INIT_SNAPSHOTS_DIR}/${ETCD_INIT_SNAPSHOT_FILENAME}" "${restore_args[@]}" + else + error "There was no snapshot to restore!" + exit 1 + fi + fi + else + info "Detected data from previous deployments" + if [[ $(stat -c "%a" "$ETCD_DATA_DIR") != *700 ]]; then + debug "Setting data directory permissions to 700 in a recursive way (required in etcd >=3.4.10)" + debug_execute chmod -R 700 "$ETCD_DATA_DIR" || true + fi + if [[ ${#initial_members[@]} -gt 1 ]]; then + member_id="$(get_member_id)" + if ! is_healthy_etcd_cluster; then + warn "Cluster not responding!" + if is_boolean_yes "$ETCD_DISASTER_RECOVERY"; then + latest_snapshot_file="$(find /snapshots/ -maxdepth 1 -type f -name 'db-*' | sort | tail -n 1)" + if [[ "${latest_snapshot_file}" != "" ]]; then + info "Restoring etcd cluster from snapshot ${latest_snapshot_file}" + rm -rf "$ETCD_DATA_DIR" + # + # Only recalculate the initial cluster config if it hasn't + # been provided. + # + if is_empty_value "$ETCD_INITIAL_CLUSTER"; then + ETCD_INITIAL_CLUSTER="$(recalculate_initial_cluster)" + export ETCD_INITIAL_CLUSTER + fi + [[ -f "$ETCD_CONF_FILE" ]] && etcd_conf_write "initial-cluster" "$ETCD_INITIAL_CLUSTER" + debug_execute etcdctl snapshot restore "${latest_snapshot_file}" \ + --name "$ETCD_NAME" \ + --data-dir "$ETCD_DATA_DIR" \ + --initial-cluster "$ETCD_INITIAL_CLUSTER" \ + --initial-cluster-token "$ETCD_INITIAL_CLUSTER_TOKEN" \ + --initial-advertise-peer-urls "$ETCD_INITIAL_ADVERTISE_PEER_URLS" + else + error "There was no snapshot to restore!" + exit 1 + fi + else + warn "Disaster recovery is disabled, the cluster will try to recover on it's own" + fi + else + info "Cluster is healthy" + if ! is_node_still_a_member; then + rm -rf "$ETCD_DATA_DIR" + remove_old_member_if_exist + add_new_member + fi + export ETCD_INITIAL_CLUSTER_STATE=existing + [[ -f "$ETCD_CONF_FILE" ]] && etcd_conf_write "initial-cluster-state" "$ETCD_INITIAL_CLUSTER_STATE" + fi + fi + fi + + # For both existing and new deployments, configure RBAC if set + if ! is_empty_value "$ETCD_ROOT_PASSWORD"; then + if [[ ${#initial_members[@]} -gt 1 ]]; then + # When there's more than one etcd replica, RBAC should be only enabled in one member + if [[ "${initial_members[0]}" = *"$ETCD_INITIAL_ADVERTISE_PEER_URLS"* ]]; then + etcd_configure_rbac + elif [[ "${ETCD_INITIAL_CLUSTER_STATE:-}" != "existing" ]]; then + etcd_wait_for_rbac || return 1 + fi + else + etcd_configure_rbac + fi + fi + + # Avoid exit code of previous commands to affect the result of this function + true +} + +######################## +# Add self to cluster if not +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# None +######################### +add_self_to_cluster() { + local -a extra_flags + # is_healthy_etcd_cluster will also set ETCD_ACTIVE_ENDPOINTS + while ! is_healthy_etcd_cluster; do + warn "Cluster not healthy, not adding self to cluster for now, keeping trying..." + sleep 10 + done + + # only send req to healthy nodes + if is_empty_value "$(get_member_id)"; then + read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" + extra_flags+=("--endpoints=${ETCD_ACTIVE_ENDPOINTS}" "--peer-urls=$ETCD_INITIAL_ADVERTISE_PEER_URLS") + ! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" + while ! etcdctl member add "$ETCD_NAME" "${extra_flags[@]}" | grep "^ETCD_" >"$ETCD_NEW_MEMBERS_ENV_FILE"; do + warn "Failed to add self to cluster, keeping trying..." + sleep 10 + done + else + info "Node already in cluster" + fi + info "Loading env vars of existing cluster" + etcd_safe_load_member_env +} + +######################## +# Get this node's member_id in cluster, if not in cluster return empty string +# Globals: +# ETCD_* +# Arguments: +# None +# Returns: +# String +######################### +get_member_id() { + local ret + local -a extra_flags + + read -r -a extra_flags <<<"$(etcdctl_auth_norbac_flags)" + ! is_empty_value "$ETCD_ROOT_PASSWORD" && export ETCDCTL_USER="root:$ETCD_ROOT_PASSWORD" + is_boolean_yes "$ETCD_ON_K8S" && extra_flags+=("--endpoints=$(etcdctl_get_endpoints)") + ret=$(etcdctl "${extra_flags[@]}" member list | grep -w "$ETCD_INITIAL_ADVERTISE_PEER_URLS" | awk -F "," '{ print $1 }') + # if not return zero + if is_empty_value "$ret"; then + info "No member id found" + echo "" + else + info "member id: $ret" + echo "$ret" + fi +} diff --git a/bitnami/etcd/docker-compose-cluster.yml b/bitnami/etcd/docker-compose-cluster.yml index 95fc6874b484..6c8cd9a0d580 100644 --- a/bitnami/etcd/docker-compose-cluster.yml +++ b/bitnami/etcd/docker-compose-cluster.yml @@ -3,7 +3,7 @@ services: etcd1: - image: docker.io/bitnami/etcd:3.6 + image: docker.io/bitnami/etcd:3.7 environment: - ALLOW_NONE_AUTHENTICATION=yes - ETCD_NAME=etcd1 @@ -14,7 +14,7 @@ services: - ETCD_INITIAL_CLUSTER_TOKEN=etcd-cluster - ETCD_INITIAL_CLUSTER=etcd1=http://etcd1:2380,etcd2=http://etcd2:2380,etcd3=http://etcd3:2380 etcd2: - image: docker.io/bitnami/etcd:3.6 + image: docker.io/bitnami/etcd:3.7 environment: - ALLOW_NONE_AUTHENTICATION=yes - ETCD_NAME=etcd2 @@ -25,7 +25,7 @@ services: - ETCD_INITIAL_CLUSTER_TOKEN=etcd-cluster - ETCD_INITIAL_CLUSTER=etcd1=http://etcd1:2380,etcd2=http://etcd2:2380,etcd3=http://etcd3:2380 etcd3: - image: docker.io/bitnami/etcd:3.6 + image: docker.io/bitnami/etcd:3.7 environment: - ALLOW_NONE_AUTHENTICATION=yes - ETCD_NAME=etcd3 diff --git a/bitnami/etcd/docker-compose.yml b/bitnami/etcd/docker-compose.yml index 2cb5dfb3b536..a34f021b4bab 100644 --- a/bitnami/etcd/docker-compose.yml +++ b/bitnami/etcd/docker-compose.yml @@ -3,7 +3,7 @@ services: etcd: - image: docker.io/bitnami/etcd:3.6 + image: docker.io/bitnami/etcd:3.7 environment: - ALLOW_NONE_AUTHENTICATION=yes volumes: