diff --git a/bitnami/jenkins/2/debian-11/Dockerfile b/bitnami/jenkins/2/debian-11/Dockerfile new file mode 100644 index 000000000000..553090459859 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/Dockerfile @@ -0,0 +1,35 @@ +FROM docker.io/bitnami/minideb:bullseye +LABEL maintainer "Bitnami " + +ENV HOME="/" \ + OS_ARCH="amd64" \ + OS_FLAVOUR="debian-11" \ + OS_NAME="linux" + +ARG JAVA_EXTRA_SECURITY_DIR="/bitnami/java/extra-security" + +COPY prebuildfs / +# Install required system packages and dependencies +RUN install_packages acl ca-certificates curl fontconfig gzip libbrotli1 libc6 libcom-err2 libcurl4 libffi7 libfontconfig1 libgcrypt20 libgmp10 libgnutls30 libgpg-error0 libgssapi-krb5-2 libhogweed6 libidn2-0 libk5crypto3 libkeyutils1 libkrb5-3 libkrb5support0 libldap-2.4-2 libnettle8 libnghttp2-14 libp11-kit0 libpsl5 librtmp1 libsasl2-2 libssh2-1 libssl1.1 libtasn1-6 libunistring2 openssh-client procps tar unzip zlib1g +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "gosu" "1.14.0-0" --checksum da4a2f759ccc57c100d795b71ab297f48b31c4dd7578d773d963bbd49c42bd7b +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "render-template" "1.0.3-1" --checksum 8b992a5ee513c5eaca52b19232b21a93588ddf4c4850be4d47c6f19b11d1d90a +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "java" "11.0.15-0" --checksum fe6b65886a6b1f545508e272efbf422054ee030c867f94ebec2f93c5518252de +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "git" "2.36.1-0" --checksum c15ff3fff7478e74922d560c5c4ffcb8d11bff92975f81591b62742902edd731 +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "jenkins" "2.332.3-1" --checksum 89394cca5f34e4bd2ac6a4d813ccbd25bde411ff62b1208419e6ed82c4e94e36 +RUN apt-get update && apt-get upgrade -y && \ + rm -r /var/lib/apt/lists /var/cache/apt/archives +RUN chmod g+rwX /opt/bitnami + +COPY rootfs / +RUN /opt/bitnami/scripts/java/postunpack.sh +RUN /opt/bitnami/scripts/jenkins/postunpack.sh +ENV APP_VERSION="2.332.3" \ + BITNAMI_APP_NAME="jenkins" \ + JAVA_HOME="/opt/bitnami/java" \ + PATH="/opt/bitnami/common/bin:/opt/bitnami/java/bin:/opt/bitnami/git/bin:$PATH" + +EXPOSE 8080 8443 50000 + +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/jenkins/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/jenkins/run.sh" ] diff --git a/bitnami/jenkins/2/debian-11/docker-compose.yml b/bitnami/jenkins/2/debian-11/docker-compose.yml new file mode 100644 index 000000000000..6b41a783b5df --- /dev/null +++ b/bitnami/jenkins/2/debian-11/docker-compose.yml @@ -0,0 +1,15 @@ +version: '2' + +services: + jenkins: + image: docker.io/bitnami/jenkins:2 + ports: + - '80:8080' + environment: + - JENKINS_PASSWORD=bitnami + volumes: + - 'jenkins_data:/bitnami/jenkins' + +volumes: + jenkins_data: + driver: local diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/.bitnami_components.json b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/.bitnami_components.json new file mode 100644 index 000000000000..5b71c05b15de --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/.bitnami_components.json @@ -0,0 +1,37 @@ +{ + "git": { + "arch": "amd64", + "digest": "c15ff3fff7478e74922d560c5c4ffcb8d11bff92975f81591b62742902edd731", + "distro": "debian-11", + "type": "NAMI", + "version": "2.36.1-0" + }, + "gosu": { + "arch": "amd64", + "digest": "da4a2f759ccc57c100d795b71ab297f48b31c4dd7578d773d963bbd49c42bd7b", + "distro": "debian-11", + "type": "NAMI", + "version": "1.14.0-0" + }, + "java": { + "arch": "amd64", + "digest": "fe6b65886a6b1f545508e272efbf422054ee030c867f94ebec2f93c5518252de", + "distro": "debian-11", + "type": "NAMI", + "version": "11.0.15-0" + }, + "jenkins": { + "arch": "amd64", + "digest": "89394cca5f34e4bd2ac6a4d813ccbd25bde411ff62b1208419e6ed82c4e94e36", + "distro": "debian-11", + "type": "NAMI", + "version": "2.332.3-1" + }, + "render-template": { + "arch": "amd64", + "digest": "8b992a5ee513c5eaca52b19232b21a93588ddf4c4850be4d47c6f19b11d1d90a", + "distro": "debian-11", + "type": "NAMI", + "version": "1.0.3-1" + } +} \ No newline at end of file diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/licenses/licenses.txt b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 000000000000..c76ba31f3b8a --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,3 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/nami/COPYING +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 000000000000..ef29e361dad1 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# +# Bitnami custom library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Constants +BOLD='\033[1m' + +# Functions + +######################## +# Print the welcome page +# Globals: +# DISABLE_WELCOME_MESSAGE +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_welcome_page() { + if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then + if [[ -n "$BITNAMI_APP_NAME" ]]; then + print_image_welcome_page + fi + fi +} + +######################## +# Print the welcome page for a Bitnami Docker image +# Globals: +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_image_welcome_page() { + local github_url="https://github.com/bitnami/bitnami-docker-${BITNAMI_APP_NAME}" + + log "" + log "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + log "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" + log "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" + log "" +} + diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libcomponent.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libcomponent.sh new file mode 100644 index 000000000000..e3098a93b7c0 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libcomponent.sh @@ -0,0 +1,65 @@ +#!/bin/bash +# +# Library for managing Bitnami components + +# Constants +CACHE_ROOT="/tmp/bitnami/pkg/cache" +DOWNLOAD_URL="https://downloads.bitnami.com/files/stacksmith" + +# Functions + +######################## +# Download and unpack a Bitnami package +# Globals: +# OS_NAME +# OS_ARCH +# OS_FLAVOUR +# Arguments: +# $1 - component's name +# $2 - component's version +# Returns: +# None +######################### +component_unpack() { + local name="${1:?name is required}" + local version="${2:?version is required}" + local base_name="${name}-${version}-${OS_NAME}-${OS_ARCH}-${OS_FLAVOUR}" + local package_sha256="" + local directory="/opt/bitnami" + + # Validate arguments + shift 2 + while [ "$#" -gt 0 ]; do + case "$1" in + -c|--checksum) + shift + package_sha256="${1:?missing package checksum}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + echo "Downloading $base_name package" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz" ]; then + echo "${CACHE_ROOT}/${base_name}.tar.gz already exists, skipping download." + cp "${CACHE_ROOT}/${base_name}.tar.gz" . + rm "${CACHE_ROOT}/${base_name}.tar.gz" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz.sha256" ]; then + echo "Using the local sha256 from ${CACHE_ROOT}/${base_name}.tar.gz.sha256" + package_sha256="$(< "${CACHE_ROOT}/${base_name}.tar.gz.sha256")" + rm "${CACHE_ROOT}/${base_name}.tar.gz.sha256" + fi + else + curl --remote-name --silent --show-error --fail "${DOWNLOAD_URL}/${base_name}.tar.gz" + fi + if [ -n "$package_sha256" ]; then + echo "Verifying package integrity" + echo "$package_sha256 ${base_name}.tar.gz" | sha256sum --check - || exit "$?" + fi + tar --directory "${directory}" --extract --gunzip --file "${base_name}.tar.gz" --no-same-owner --strip-components=2 + rm "${base_name}.tar.gz" +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libfile.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 000000000000..41ebaf7464f6 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,139 @@ +#!/bin/bash +# +# Library for managing files + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libos.sh + +# Functions + +######################## +# Replace a regex-matching string in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# $4 - use POSIX regex. Default: true +# Returns: +# None +######################### +replace_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + local posix_regex=${4:-true} + + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + if [[ $posix_regex = true ]]; then + result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + else + result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Replace a regex-matching multiline string in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# Returns: +# None +######################### +replace_in_file_multiline() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + + local result + local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + result="$(perl -pe "BEGIN{undef $/;} s${del}${match_regex}${del}${substitute_regex}${del}sg" "$filename")" + echo "$result" > "$filename" +} + +######################## +# Remove a line in a file based on a regex +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - use POSIX regex. Default: true +# Returns: +# None +######################### +remove_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local posix_regex=${3:-true} + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + if [[ $posix_regex = true ]]; then + result="$(sed -E "/$match_regex/d" "$filename")" + else + result="$(sed "/$match_regex/d" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Appends text after the last line matching a pattern +# Arguments: +# $1 - file +# $2 - match regex +# $3 - contents to add +# Returns: +# None +######################### +append_file_after_last_match() { + local file="${1:?missing file}" + local match_regex="${2:?missing pattern}" + local value="${3:?missing value}" + + # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again + result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" + echo "$result" > "$file" +} + +######################## +# Wait until certain entry is present in a log file +# Arguments: +# $1 - entry to look for +# $2 - log file +# $3 - max retries. Default: 12 +# $4 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +wait_for_log_entry() { + local -r entry="${1:-missing entry}" + local -r log_file="${2:-missing log file}" + local -r retries="${3:-12}" + local -r interval_time="${4:-5}" + local attempt=0 + + check_log_file_for_entry() { + if ! grep -qE "$entry" "$log_file"; then + debug "Entry \"${entry}\" still not present in ${log_file} (attempt $((++attempt))/${retries})" + return 1 + fi + } + debug "Checking that ${log_file} log file contains entry \"${entry}\"" + if retry_while check_log_file_for_entry "$retries" "$interval_time"; then + debug "Found entry \"${entry}\" in ${log_file}" + true + else + error "Could not find entry \"${entry}\" in ${log_file} after ${retries} retries" + debug_execute cat "$log_file" + return 1 + fi +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libfs.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 000000000000..1b504b1df458 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,190 @@ +#!/bin/bash +# +# Library for file system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Ensure a file/directory is owned (user and group) but the given user +# Arguments: +# $1 - filepath +# $2 - owner +# Returns: +# None +######################### +owned_by() { + local path="${1:?path is missing}" + local owner="${2:?owner is missing}" + 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:-}" + + mkdir -p "${dir}" + if [[ -n $owner_user ]]; then + owned_by "$dir" "$owner_user" "$owner_group" + fi +} + +######################## +# Checks whether a directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_dir_empty() { + local -r path="${1:?missing directory}" + # Calculate real path in order to avoid issues with symlinks + local -r dir="$(realpath "$path")" + if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then + true + else + false + fi +} + +######################## +# Checks whether a mounted directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_mounted_dir_empty() { + local dir="${1:?missing directory}" + + if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then + true + else + false + fi +} + +######################## +# Checks whether a file can be written to or not +# arguments: +# $1 - file +# returns: +# boolean +######################### +is_file_writable() { + local file="${1:?missing file}" + local dir + dir="$(dirname "$file")" + + if [[ (-f "$file" && -w "$file") || (! -f "$file" && -d "$dir" && -w "$dir") ]]; then + true + else + false + fi +} + +######################## +# Relativize a path +# arguments: +# $1 - path +# $2 - base +# returns: +# None +######################### +relativize() { + local -r path="${1:?missing path}" + local -r base="${2:?missing base}" + pushd "$base" >/dev/null || exit + realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' + popd >/dev/null || exit +} + +######################## +# Configure permisions and ownership recursively +# Globals: +# None +# Arguments: +# $1 - paths (as a string). +# Flags: +# -f|--file-mode - mode for directories. +# -d|--dir-mode - mode for files. +# -u|--user - user +# -g|--group - group +# Returns: +# None +######################### +configure_permissions_ownership() { + local -r paths="${1:?paths is missing}" + local dir_mode="" + local file_mode="" + local user="" + local group="" + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -f | --file-mode) + shift + file_mode="${1:?missing mode for files}" + ;; + -d | --dir-mode) + shift + dir_mode="${1:?missing mode for directories}" + ;; + -u | --user) + shift + user="${1:?missing user}" + ;; + -g | --group) + shift + group="${1:?missing group}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + read -r -a filepaths <<<"$paths" + for p in "${filepaths[@]}"; do + if [[ -e "$p" ]]; then + if [[ -n $dir_mode ]]; then + find -L "$p" -type d -exec chmod "$dir_mode" {} \; + fi + if [[ -n $file_mode ]]; then + find -L "$p" -type f -exec chmod "$file_mode" {} \; + fi + if [[ -n $user ]] && [[ -n $group ]]; then + chown -LR "$user":"$group" "$p" + elif [[ -n $user ]] && [[ -z $group ]]; then + chown -LR "$user" "$p" + elif [[ -z $user ]] && [[ -n $group ]]; then + chgrp -LR "$group" "$p" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libhook.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 000000000000..9694852a7d25 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,16 @@ +#!/bin/bash +# +# Library to use for scripts expected to be used as Kubernetes lifecycle hooks + +# shellcheck disable=SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh + +# Override functions that log to stdout/stderr of the current process, so they print to process 1 +for function_to_override in stderr_print debug_execute; do + # Output is sent to output of process 1 and thus end up in the container log + # The hook output in general isn't saved + eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2" +done diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/liblog.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 000000000000..c7c0f6d4422a --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,112 @@ +#!/bin/bash +# +# Library for logging functions + +# Constants +RESET='\033[0m' +RED='\033[38;5;1m' +GREEN='\033[38;5;2m' +YELLOW='\033[38;5;3m' +MAGENTA='\033[38;5;5m' +CYAN='\033[38;5;6m' + +# Functions + +######################## +# Print to STDERR +# Arguments: +# Message to print +# Returns: +# None +######################### +stderr_print() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_QUIET:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if ! [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + printf "%b\\n" "${*}" >&2 + fi +} + +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +log() { + stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" +} +######################## +# Log an 'info' message +# Arguments: +# Message to log +# Returns: +# None +######################### +info() { + log "${GREEN}INFO ${RESET} ==> ${*}" +} +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +warn() { + log "${YELLOW}WARN ${RESET} ==> ${*}" +} +######################## +# Log an 'error' message +# Arguments: +# Message to log +# Returns: +# None +######################### +error() { + log "${RED}ERROR${RESET} ==> ${*}" +} +######################## +# Log a 'debug' message +# Globals: +# BITNAMI_DEBUG +# Arguments: +# None +# Returns: +# None +######################### +debug() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_DEBUG:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + log "${MAGENTA}DEBUG${RESET} ==> ${*}" + fi +} + +######################## +# Indent a string +# Arguments: +# $1 - string +# $2 - number of indentation characters (default: 4) +# $3 - indentation character (default: " ") +# Returns: +# None +######################### +indent() { + local string="${1:-}" + local num="${2:?missing num}" + local char="${3:-" "}" + # Build the indentation unit string + local indent_unit="" + for ((i = 0; i < num; i++)); do + indent_unit="${indent_unit}${char}" + done + # shellcheck disable=SC2001 + # Complex regex, see https://github.com/koalaman/shellcheck/wiki/SC2001#exceptions + echo "$string" | sed "s/^/${indent_unit}/" +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libnet.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 000000000000..8bbf165e3e2a --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,163 @@ +#!/bin/bash +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Resolve IP address for a host/domain (i.e. DNS lookup) +# Arguments: +# $1 - Hostname to resolve +# $2 - IP address version (v4, v6), leave empty for resolving to any version +# Returns: +# IP +######################### +dns_lookup() { + local host="${1:?host is missing}" + local ip_version="${2:-}" + getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1 +} + +######################### +# Wait for a hostname and return the IP +# Arguments: +# $1 - hostname +# $2 - number of retries +# $3 - seconds to wait between retries +# Returns: +# - IP address that corresponds to the hostname +######################### +wait_for_dns_lookup() { + local hostname="${1:?hostname is missing}" + local retries="${2:-5}" + local seconds="${3:-1}" + check_host() { + if [[ $(dns_lookup "$hostname") == "" ]]; then + false + else + true + fi + } + # Wait for the host to be ready + retry_while "check_host ${hostname}" "$retries" "$seconds" + dns_lookup "$hostname" +} + +######################## +# Get machine's IP +# Arguments: +# None +# Returns: +# Machine IP +######################### +get_machine_ip() { + local -a ip_addresses + local hostname + hostname="$(hostname)" + read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" + if [[ "${#ip_addresses[@]}" -gt 1 ]]; then + warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" + elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then + error "Could not find any IP address associated to hostname ${hostname}" + exit 1 + fi + echo "${ip_addresses[0]}" +} + +######################## +# Check if the provided argument is a resolved hostname +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_hostname_resolved() { + local -r host="${1:?missing value}" + if [[ -n "$(dns_lookup "$host")" ]]; then + true + else + false + fi +} + +######################## +# Parse URL +# Globals: +# None +# Arguments: +# $1 - uri - String +# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String +# Returns: +# String +parse_uri() { + local uri="${1:?uri is missing}" + local component="${2:?component is missing}" + + # Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with + # additional sub-expressions to split authority into userinfo, host and port + # Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969) + local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-9]+))?))?(/([^?#]*))?(\?([^#]*))?(#(.*))?' + # || | ||| | | | | | | | | | + # |2 scheme | ||6 userinfo 7 host | 9 port | 11 rpath | 13 query | 15 fragment + # 1 scheme: | |5 userinfo@ 8 :... 10 path 12 ?... 14 #... + # | 4 authority + # 3 //... + local index=0 + case "$component" in + scheme) + index=2 + ;; + authority) + index=4 + ;; + userinfo) + index=6 + ;; + host) + index=7 + ;; + port) + index=9 + ;; + path) + index=10 + ;; + query) + index=13 + ;; + fragment) + index=14 + ;; + *) + stderr_print "unrecognized component $component" + return 1 + ;; + esac + [[ "$uri" =~ $URI_REGEX ]] && echo "${BASH_REMATCH[${index}]}" +} + +######################## +# 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/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libos.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 000000000000..b6c50da90807 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,466 @@ +#!/bin/bash +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Check if an user exists in the system +# Arguments: +# $1 - user +# Returns: +# Boolean +######################### +user_exists() { + local user="${1:?user is missing}" + id "$user" >/dev/null 2>&1 +} + +######################## +# Check if a group exists in the system +# Arguments: +# $1 - group +# Returns: +# Boolean +######################### +group_exists() { + local group="${1:?group is missing}" + getent group "$group" >/dev/null 2>&1 +} + +######################## +# Create a group in the system if it does not exist already +# Arguments: +# $1 - group +# Flags: +# -i|--gid - the ID for the new group +# -s|--system - Whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + local gid="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --gid) + shift + gid="${1:?missing gid}" + ;; + -s | --system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! group_exists "$group"; then + local -a args=("$group") + if [[ -n "$gid" ]]; then + if group_exists "$gid"; then + error "The GID $gid is already in use." >&2 + return 1 + fi + args+=("--gid" "$gid") + fi + $is_system_user && args+=("--system") + groupadd "${args[@]}" >/dev/null 2>&1 + fi +} + +######################## +# Create an user in the system if it does not exist already +# Arguments: +# $1 - user +# Flags: +# -i|--uid - the ID for the new user +# -g|--group - the group the new user should belong to +# -a|--append-groups - comma-separated list of supplemental groups to append to the new user +# -h|--home - the home directory for the new user +# -s|--system - whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_user_exists() { + local user="${1:?user is missing}" + local uid="" + local group="" + local append_groups="" + local home="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --uid) + shift + uid="${1:?missing uid}" + ;; + -g | --group) + shift + group="${1:?missing group}" + ;; + -a | --append-groups) + shift + append_groups="${1:?missing append_groups}" + ;; + -h | --home) + shift + home="${1:?missing home directory}" + ;; + -s | --system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! user_exists "$user"; then + local -a user_args=("-N" "$user") + if [[ -n "$uid" ]]; then + if user_exists "$uid"; then + error "The UID $uid is already in use." + return 1 + fi + user_args+=("--uid" "$uid") + else + $is_system_user && user_args+=("--system") + fi + useradd "${user_args[@]}" >/dev/null 2>&1 + fi + + if [[ -n "$group" ]]; then + local -a group_args=("$group") + $is_system_user && group_args+=("--system") + ensure_group_exists "${group_args[@]}" + usermod -g "$group" "$user" >/dev/null 2>&1 + fi + + if [[ -n "$append_groups" ]]; then + local -a groups + read -ra groups <<<"$(tr ',;' ' ' <<<"$append_groups")" + for group in "${groups[@]}"; do + ensure_group_exists "$group" + usermod -aG "$group" "$user" >/dev/null 2>&1 + done + fi + + if [[ -n "$home" ]]; then + mkdir -p "$home" + usermod -d "$home" "$user" >/dev/null 2>&1 + configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group" + fi +} + +######################## +# Check if the script is currently running as root +# Arguments: +# $1 - user +# $2 - group +# Returns: +# Boolean +######################### +am_i_root() { + if [[ "$(id -u)" = "0" ]]; then + true + else + false + fi +} + +######################## +# Print OS metadata +# Arguments: +# $1 - Flag name +# Flags: +# --id - Distro ID +# --version - Distro version +# --branch - Distro branch +# --codename - Distro codename +# 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 + ;; + *) + 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:]" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + numeric) + filter="0-9" + ;; + *) + echo "Invalid type ${type}" >&2 + return 1 + ;; + esac + # Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size + # Note there is a very small chance of strings starting with EOL character + # Therefore, the higher amount of lines read, this will happen less frequently + result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")" + echo "$result" +} + +######################## +# Create md5 hash from a string +# Arguments: +# $1 - string +# Returns: +# md5 hash - string +######################### +generate_md5_hash() { + local -r str="${1:?missing input string}" + echo -n "$str" | md5sum | awk '{print $1}' +} + +######################## +# 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 +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 000000000000..99df69681c27 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,122 @@ +#!/bin/bash +# +# Bitnami persistence library +# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libversion.sh + +# Functions + +######################## +# Persist an application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# $2 - List of app files to persist +# Returns: +# true if all steps succeeded, false otherwise +######################### +persist_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_persist <<< "$(tr ',;:' ' ' <<< "$2")" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Persist the individual files + if [[ "${#files_to_persist[@]}" -le 0 ]]; then + warn "No files are configured to be persisted" + return + fi + pushd "$install_dir" >/dev/null || exit + local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder + local -r tmp_file="/tmp/perms.acl" + for file_to_persist in "${files_to_persist[@]}"; do + if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then + error "Cannot persist '${file_to_persist}' because it does not exist" + return 1 + fi + file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")" + file_to_persist_destination="${persist_dir}/${file_to_persist_relative}" + file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")" + # Get original permissions for existing files, which will be applied later + # Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume + getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file" + # Copy directories to the volume + ensure_dir_exists "$file_to_persist_destination_folder" + cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder" + # Restore permissions + pushd "$persist_dir" >/dev/null || exit + if am_i_root; then + setfacl --restore="$tmp_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file") + fi + popd >/dev/null || exit + done + popd >/dev/null || exit + rm -f "$tmp_file" + # Install the persisted files into the installation directory, via symlinks + restore_persisted_app "$@" +} + +######################## +# Restore a persisted application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# FORCE_MAJOR_UPGRADE +# Arguments: +# $1 - App folder name +# $2 - List of app files to restore +# Returns: +# true if all steps succeeded, false otherwise +######################### +restore_persisted_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_restore <<< "$(tr ',;:' ' ' <<< "$2")" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Restore the individual persisted files + if [[ "${#files_to_restore[@]}" -le 0 ]]; then + warn "No persisted files are configured to be restored" + return + fi + local file_to_restore_relative file_to_restore_origin file_to_restore_destination + for file_to_restore in "${files_to_restore[@]}"; do + file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")" + # We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed + file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")" + file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")" + rm -rf "$file_to_restore_origin" + ln -sfn "$file_to_restore_destination" "$file_to_restore_origin" + done +} + +######################## +# Check if an application directory was already persisted +# Globals: +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# Returns: +# true if all steps succeeded, false otherwise +######################### +is_app_initialized() { + local -r app="${1:?missing app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + if ! is_mounted_dir_empty "$persist_dir"; then + true + else + false + fi +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libservice.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 000000000000..a713bd108e15 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,273 @@ +#!/bin/bash +# +# Library for managing services + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Read the provided pid file and returns a PID +# Arguments: +# $1 - Pid file +# Returns: +# PID +######################### +get_pid_from_file() { + local pid_file="${1:?pid file is missing}" + + if [[ -f "$pid_file" ]]; then + if [[ -n "$(< "$pid_file")" ]] && [[ "$(< "$pid_file")" -gt 0 ]]; then + echo "$(< "$pid_file")" + fi + fi +} + +######################## +# Check if a provided PID corresponds to a running service +# Arguments: +# $1 - PID +# Returns: +# Boolean +######################### +is_service_running() { + local pid="${1:?pid is missing}" + + kill -0 "$pid" 2>/dev/null +} + +######################## +# Stop a service by sending a termination signal to its pid +# Arguments: +# $1 - Pid file +# $2 - Signal number (optional) +# Returns: +# None +######################### +stop_service_using_pid() { + local pid_file="${1:?pid file is missing}" + local signal="${2:-}" + local pid + + pid="$(get_pid_from_file "$pid_file")" + [[ -z "$pid" ]] || ! is_service_running "$pid" && return + + if [[ -n "$signal" ]]; then + kill "-${signal}" "$pid" + else + kill "$pid" + fi + + local counter=10 + while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do + sleep 1 + counter=$((counter - 1)) + done +} + +######################## +# Start cron daemon +# Arguments: +# None +# Returns: +# true if started correctly, false otherwise +######################### +cron_start() { + if [[ -x "/usr/sbin/cron" ]]; then + /usr/sbin/cron + elif [[ -x "/usr/sbin/crond" ]]; then + /usr/sbin/crond + else + false + fi +} + +######################## +# Generate a cron configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Command +# Flags: +# --run-as - User to run as (default: root) +# --schedule - Cron schedule configuration (default: * * * * *) +# Returns: +# None +######################### +generate_cron_conf() { + local service_name="${1:?service name is missing}" + local cmd="${2:?command is missing}" + local run_as="root" + local schedule="* * * * *" + local clean="true" + + 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 + echo "${schedule} ${run_as} ${cmd}" > /etc/cron.d/"$service_name" + else + echo "${schedule} ${run_as} ${cmd}" >> /etc/cron.d/"$service_name" + fi +} + +######################## +# Remove a cron configuration file for a given service +# Arguments: +# $1 - Service name +# Returns: +# None +######################### +remove_cron_conf() { + local service_name="${1:?service name is missing}" + local cron_conf_dir="/etc/monit/conf.d" + rm -f "${cron_conf_dir}/${service_name}" +} + +######################## +# Generate a monit configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Pid file +# $3 - Start command +# $4 - Stop command +# Flags: +# --disable - Whether to disable the monit configuration +# Returns: +# None +######################### +generate_monit_conf() { + local service_name="${1:?service name is missing}" + local pid_file="${2:?pid file is missing}" + local start_command="${3:?start command is missing}" + local stop_command="${4:?stop command is missing}" + local monit_conf_dir="/etc/monit/conf.d" + local disabled="no" + + # Parse optional CLI flags + shift 4 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --disable) + disabled="yes" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + is_boolean_yes "$disabled" && conf_suffix=".disabled" + mkdir -p "$monit_conf_dir" + cat >"${monit_conf_dir}/${service_name}.conf${conf_suffix:-}" <&2 + return 1 + ;; + esac + shift + done + + mkdir -p "$logrotate_conf_dir" + cat <"${logrotate_conf_dir}/${service_name}" +${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}" +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libvalidations.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libvalidations.sh new file mode 100644 index 000000000000..2d7aaa943513 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libvalidations.sh @@ -0,0 +1,264 @@ +#!/bin/bash +# +# Validation functions library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Check if the provided argument is an integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_int() { + local -r int="${1:?missing value}" + if [[ "$int" =~ ^-?[0-9]+ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a positive integer +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_positive_int() { + local -r int="${1:?missing value}" + if is_int "$int" && (( "${int}" >= 0 )); then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean or is the string 'yes/true' +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_boolean_yes() { + local -r bool="${1:-}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean yes/no value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_yes_no_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(yes|no)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean true/false value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_true_false_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(true|false)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is 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 IPv4 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ipv4() { + local ip="${1:?ip is missing}" + local stat=1 + + if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then + read -r -a ip_array <<< "$(tr '.' ' ' <<< "$ip")" + [[ ${ip_array[0]} -le 255 && ${ip_array[1]} -le 255 \ + && ${ip_array[2]} -le 255 && ${ip_array[3]} -le 255 ]] + stat=$? + fi + return $stat +} + +######################## +# Validate a string format +# Arguments: +# $1 - String to validate +# Returns: +# Boolean +######################### +validate_string() { + local string + local min_length=-1 + local max_length=-1 + + # Parse flags + while [ "$#" -gt 0 ]; do + case "$1" in + -min-length) + shift + min_length=${1:-} + ;; + -max-length) + shift + max_length=${1:-} + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + if [ "$#" -gt 1 ]; then + stderr_print "too many arguments provided" + return 2 + elif [ "$#" -eq 0 ]; then + stderr_print "missing string" + return 1 + else + string=$1 + fi + + if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then + echo "string length is less than $min_length" + return 1 + fi + if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then + echo "string length is great than $max_length" + return 1 + fi +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libversion.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 000000000000..f3bc7568bfa5 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,49 @@ +#!/bin/bash +# +# Library for managing versions strings + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions +######################## +# Gets semantic version +# Arguments: +# $1 - version: string to extract major.minor.patch +# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch +# Returns: +# array with the major, minor and release +######################### +get_sematic_version () { + local version="${1:?version is required}" + local section="${2:?section is required}" + local -a version_sections + + #Regex to parse versions: x.y.z + local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?' + + if [[ "$version" =~ $regex ]]; then + local i=1 + local j=1 + local n=${#BASH_REMATCH[*]} + + while [[ $i -lt $n ]]; do + if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then + version_sections[$j]=${BASH_REMATCH[$i]} + ((j++)) + fi + ((i++)) + done + + local number_regex='^[0-9]+$' + if [[ "$section" =~ $number_regex ]] && (( section > 0 )) && (( section <= 3 )); then + echo "${version_sections[$section]}" + return + else + stderr_print "Section allowed values are: 1, 2, and 3" + return 1 + fi + fi +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 000000000000..818c2158032b --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,458 @@ +#!/bin/bash +# +# Bitnami web server handler library + +# shellcheck disable=SC1090,SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh + +######################## +# Execute a command (or list of commands) with the web server environment and library loaded +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_execute() { + local -r web_server="${1:?missing web server}" + shift + # Run program in sub-shell to avoid web server environment getting loaded when not necessary + ( + . "/opt/bitnami/scripts/lib${web_server}.sh" + . "/opt/bitnami/scripts/${web_server}-env.sh" + "$@" + ) +} + +######################## +# Prints the list of enabled web servers +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_list() { + local -r -a supported_web_servers=(apache nginx) + local -a existing_web_servers=() + for web_server in "${supported_web_servers[@]}"; do + [[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server") + done + echo "${existing_web_servers[@]:-}" +} + +######################## +# Prints the currently-enabled web server type (only one, in order of preference) +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_type() { + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + echo "${web_servers[0]:-}" +} + +######################## +# Validate that a supported web server is configured +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_validate() { + local error_code=0 + local supported_web_servers=("apache" "nginx") + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then + print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}" + elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then + print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable." + fi + + return "$error_code" +} + +######################## +# Check whether the web server is running +# Globals: +# * +# Arguments: +# None +# Returns: +# true if the web server is running, false otherwise +######################### +is_web_server_running() { + "is_$(web_server_type)_running" +} + +######################## +# Start web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_start() { + info "Starting $(web_server_type) in background" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" +} + +######################## +# Stop web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_stop() { + info "Stopping $(web_server_type)" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" +} + +######################## +# Restart web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_restart() { + info "Restarting $(web_server_type)" + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" +} + +######################## +# Reload web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_reload() { + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" +} + +######################## +# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --type - Application type, which has an effect on which configuration template to use +# --hosts - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disable - Whether to render server configurations with a .disabled prefix +# --disable-http - Whether to render the app's HTTP server configuration with a .disabled prefix +# --disable-https - Whether to render the app's HTTPS server configuration with a .disabled prefix +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --document-root - Path to document root directory +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-additional-http-configuration - Additional HTTP vhost configuration (no default) +# --apache-additional-https-configuration - Additional HTTPS vhost configuration (no default) +# --apache-before-vhost-configuration - Configuration to add before the directive (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no' and type is not defined) +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-proxy-address - Address where to proxy requests +# --apache-proxy-configuration - Extra configuration for the proxy +# --apache-proxy-http-configuration - Extra configuration for the proxy HTTP vhost +# --apache-proxy-https-configuration - Extra configuration for the proxy HTTPS vhost +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup (only allowed when type is not defined) +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# --nginx-external-configuration - Configuration external to server block (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_app_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --disable \ + | --disable-http \ + | --disable-https \ + ) + apache_args+=("$1") + nginx_args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --type \ + | --allow-remote-connections \ + | --http-port \ + | --https-port \ + | --document-root \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-additional-http-configuration \ + | --apache-additional-https-configuration \ + | --apache-before-vhost-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-proxy-address \ + | --apache-proxy-configuration \ + | --apache-proxy-http-configuration \ + | --apache-proxy-https-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "${2:?missing value}") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration \ + | --nginx-external-configuration) + nginx_args+=("${1//nginx-/}" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_web_server_app_configuration_not_exists() { + local app="${1:?missing app}" + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app" + done +} + +######################## +# Ensure the web server loads the configuration for an application in a URL prefix +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --document-root - Path to document root directory +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --type - Application type, which has an effect on what configuration template will be used +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_prefix_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --allow-remote-connections \ + | --document-root \ + | --prefix \ + | --type \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "$2") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + nginx_args+=("${1//nginx-/}" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --enable-http - Enable HTTP app configuration (if not enabled already) +# --enable-https - Enable HTTPS app configuration (if not enabled already) +# --disable-http - Disable HTTP app configuration (if not disabled already) +# --disable-https - Disable HTTPS app configuration (if not disabled already) +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +web_server_update_app_configuration() { + local app="${1:?missing app}" + shift + local -a args web_servers + args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --enable-http \ + | --enable-https \ + | --disable-http \ + | --disable-https \ + ) + args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}" + done +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_enable_loading_page() { + ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \ + --apache-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +RedirectMatch 503 ^/$ +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +ErrorDocument 404 /index.html +ErrorDocument 503 /index.html" \ + --nginx-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +location / { + return 503; +} +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +error_page 404 @installing; +error_page 503 @installing; +location @installing { + rewrite ^(.*)$ /index.html break; +}" + web_server_reload +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_disable_install_page() { + ensure_web_server_app_configuration_not_exists "__loading" + web_server_reload +} diff --git a/bitnami/jenkins/2/debian-11/prebuildfs/usr/sbin/install_packages b/bitnami/jenkins/2/debian-11/prebuildfs/usr/sbin/install_packages new file mode 100755 index 000000000000..c9577647443b --- /dev/null +++ b/bitnami/jenkins/2/debian-11/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,24 @@ +#!/bin/sh +set -e +set -u +export DEBIAN_FRONTEND=noninteractive +n=0 +max=2 +until [ $n -gt $max ]; do + set +e + ( + apt-get update -qq && + apt-get install -y --no-install-recommends "$@" + ) + CODE=$? + set -e + if [ $CODE -eq 0 ]; then + break + fi + if [ $n -eq $max ]; then + exit $CODE + fi + echo "apt failed, retrying" + n=$(($n + 1)) +done +rm -r /var/lib/apt/lists /var/cache/apt/archives diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/jenkins/nss-wrapper/nss_group b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/jenkins/nss-wrapper/nss_group new file mode 100644 index 000000000000..11562584abbc --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/jenkins/nss-wrapper/nss_group @@ -0,0 +1 @@ +jenkins:x:0: diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/jenkins/nss-wrapper/nss_passwd b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/jenkins/nss-wrapper/nss_passwd new file mode 100644 index 000000000000..519bb1eb0f18 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/jenkins/nss-wrapper/nss_passwd @@ -0,0 +1 @@ +jenkins:x:1001:0:Jenkins:/opt/bitnami/jenkins/jenkins_home:/bin/false diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/java/entrypoint.sh b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/java/entrypoint.sh new file mode 100755 index 000000000000..15cf7d1833e5 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/java/entrypoint.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +# 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 + +print_welcome_page + +echo "" +exec "$@" diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/java/postunpack.sh b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/java/postunpack.sh new file mode 100755 index 000000000000..24a5c9bc15fa --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/java/postunpack.sh @@ -0,0 +1,24 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/liblog.sh + +# +# Java post-unpack operations +# + +# Override default files in the Java security directory. This is used for +# custom base images (with custom CA certificates or block lists is used) + +if ! is_dir_empty "$JAVA_EXTRA_SECURITY_DIR"; then + info "Adding custom CAs to the Java security folder" + cp -Lr "$JAVA_EXTRA_SECURITY_DIR" /opt/bitnami/java/lib/security +fi diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins-env.sh b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins-env.sh new file mode 100644 index 000000000000..c527d56af569 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins-env.sh @@ -0,0 +1,106 @@ +#!/bin/bash +# +# Environment configuration for jenkins + +# 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:-jenkins}" +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 +jenkins_env_vars=( + JENKINS_HOME + JENKINS_HTTP_LISTEN_ADDRESS + JENKINS_HTTPS_LISTEN_ADDRESS + JENKINS_HTTP_PORT_NUMBER + JENKINS_HTTPS_PORT_NUMBER + JENKINS_JNLP_PORT_NUMBER + JENKINS_EXTERNAL_HTTP_PORT_NUMBER + JENKINS_EXTERNAL_HTTPS_PORT_NUMBER + JENKINS_HOST + JENKINS_FORCE_HTTPS + JENKINS_SKIP_BOOTSTRAP + JENKINS_ENABLE_SWARM + JENKINS_USERNAME + JENKINS_PASSWORD + JENKINS_EMAIL + JENKINS_SWARM_USERNAME + JENKINS_SWARM_PASSWORD + JAVA_HOME + JAVA_OPTS + DISABLE_JENKINS_INITIALIZATION +) +for env_var in "${jenkins_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 jenkins_env_vars + +# Paths +export JENKINS_BASE_DIR="${BITNAMI_ROOT_DIR}/jenkins" +export JENKINS_LOGS_DIR="${JENKINS_BASE_DIR}/logs" +export JENKINS_LOG_FILE="${JENKINS_LOGS_DIR}/jenkins.log" +export JENKINS_TMP_DIR="${JENKINS_BASE_DIR}/tmp" +export JENKINS_PID_FILE="${JENKINS_TMP_DIR}/jenkins.pid" +export JENKINS_TEMPLATES_DIR="${BITNAMI_ROOT_DIR}/scripts/jenkins/bitnami-templates" + +# Jenkins persistence configuration +export JENKINS_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/jenkins" +export JENKINS_HOME="${JENKINS_HOME:-${JENKINS_VOLUME_DIR}/home}" +export JENKINS_MOUNTED_CONTENT_DIR="/usr/share/jenkins/ref" + +# System users (when running with a privileged user) +export JENKINS_DAEMON_USER="jenkins" +export JENKINS_DAEMON_GROUP="jenkins" + +# Jenkins configuration +export JENKINS_DEFAULT_HTTP_LISTEN_ADDRESS="0.0.0.0" # only used at build time +export JENKINS_DEFAULT_HTTPS_LISTEN_ADDRESS="0.0.0.0" # only used at build time +export JENKINS_DEFAULT_HTTP_PORT_NUMBER="8080" # only used at build time +export JENKINS_DEFAULT_HTTPS_PORT_NUMBER="8443" # only used at build time +export JENKINS_DEFAULT_JNLP_PORT_NUMBER="50000" # only used at build time +export JENKINS_HTTP_LISTEN_ADDRESS="${JENKINS_HTTP_LISTEN_ADDRESS:-}" +export JENKINS_HTTPS_LISTEN_ADDRESS="${JENKINS_HTTPS_LISTEN_ADDRESS:-}" +export JENKINS_HTTP_PORT_NUMBER="${JENKINS_HTTP_PORT_NUMBER:-}" +export JENKINS_HTTPS_PORT_NUMBER="${JENKINS_HTTPS_PORT_NUMBER:-}" +export JENKINS_JNLP_PORT_NUMBER="${JENKINS_JNLP_PORT_NUMBER:-}" +export JENKINS_EXTERNAL_HTTP_PORT_NUMBER="${JENKINS_EXTERNAL_HTTP_PORT_NUMBER:-80}" +export JENKINS_EXTERNAL_HTTPS_PORT_NUMBER="${JENKINS_EXTERNAL_HTTPS_PORT_NUMBER:-443}" +export JENKINS_HOST="${JENKINS_HOST:-}" +export JENKINS_FORCE_HTTPS="${JENKINS_FORCE_HTTPS:-no}" +JENKINS_SKIP_BOOTSTRAP="${JENKINS_SKIP_BOOTSTRAP:-"${DISABLE_JENKINS_INITIALIZATION:-}"}" +export JENKINS_SKIP_BOOTSTRAP="${JENKINS_SKIP_BOOTSTRAP:-no}" # only used during the first initialization +export JENKINS_ENABLE_SWARM="${JENKINS_ENABLE_SWARM:-no}" + +# Jenkins credentials +export JENKINS_USERNAME="${JENKINS_USERNAME:-user}" # only used during the first initialization +export JENKINS_PASSWORD="${JENKINS_PASSWORD:-bitnami}" # only used during the first initialization +export JENKINS_EMAIL="${JENKINS_EMAIL:-user@example.com}" # only used during the first initialization +export JENKINS_SWARM_USERNAME="${JENKINS_SWARM_USERNAME:-swarm}" # only used during the first initialization +export JENKINS_SWARM_PASSWORD="${JENKINS_SWARM_PASSWORD:-}" # only used during the first initialization + +# Java configuration +export JAVA_HOME="${JAVA_HOME:-${BITNAMI_ROOT_DIR}/java}" +export JAVA_OPTS="${JAVA_OPTS:-}" + +# Custom environment variables may be defined below diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/configure-host.groovy.tpl b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/configure-host.groovy.tpl new file mode 100644 index 000000000000..6792ca3bf61e --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/configure-host.groovy.tpl @@ -0,0 +1,3 @@ +location = jenkins.model.JenkinsLocationConfiguration.get() +location.setUrl("{{url}}") +location.save() diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/init-jenkins-swarm.groovy.tpl b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/init-jenkins-swarm.groovy.tpl new file mode 100644 index 000000000000..b3f3bbd269cf --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/init-jenkins-swarm.groovy.tpl @@ -0,0 +1,179 @@ +// Inspired by https://github.com/jenkinsci/jenkins/blob/e1beed03962bbc3777a49a041109b8752d98d2ed/core/src/main/java/jenkins/install/SetupWizard.java + +import jenkins.security.s2m.AdminWhitelistRule; +import hudson.security.csrf.DefaultCrumbIssuer; +import jenkins.security.QueueItemAuthenticatorConfiguration; +import org.jenkinsci.plugins.authorizeproject.*; +import org.jenkinsci.plugins.authorizeproject.strategy.*; +import org.jenkinsci.plugins.matrixauth.*; +import jenkins.model.*; +import jenkins.install.*; +import hudson.security.*; +import hudson.model.*; + +// Set Hudson Security +def jenkins = Jenkins.getInstance() +def securityRealm = new HudsonPrivateSecurityRealm(false, false, null) +jenkins.setSecurityRealm(securityRealm) + +// Create new admin account +println " [bitnami/groovy-init-jenkins-with-slaves] Creating Jenkins users" +def adminUsername = '{{JENKINS_USERNAME}}' +def adminPassword = '{{JENKINS_PASSWORD}}' +securityRealm.createAccount(adminUsername, adminPassword) +println " [bitnami/groovy-init-jenkins-with-slaves] Admin user created: {{JENKINS_USERNAME}}:*******" +if (adminUsername != 'admin') { + // Delete the existing by default admin account + User u = User.get('admin') + u.delete() +} +// Create slave account +def slaveUsername = '{{JENKINS_SWARM_USERNAME}}' +def slavePassword = '{{JENKINS_SWARM_PASSWORD}}' +securityRealm.createAccount(slaveUsername, slavePassword) +println " [bitnami/groovy-init-jenkins-with-slaves] Slave user created: {{JENKINS_SWARM_USERNAME}}:*******" +// Create system account. Same password than admin account +def systemUsername = 'system_user' +def systemPassword = '{{JENKINS_PASSWORD}}' +securityRealm.createAccount(systemUsername, systemPassword) +println " [bitnami/groovy-init-jenkins-with-slaves] System user created: system_user:*******" + +// Set Authorization strategy +// Roles based on https://wiki.jenkins-ci.org/display/JENKINS/Matrix-based+security +println " [bitnami/groovy-init-jenkins-with-slaves] Setting Authorization Strategy" +def strategy = new GlobalMatrixAuthorizationStrategy() +// Setting Slave Permissions +// Slave Permissions +strategy.add(hudson.model.Computer.BUILD, new PermissionEntry(AuthorizationType.USER, slaveUsername)) +strategy.add(hudson.model.Computer.CONFIGURE, new PermissionEntry(AuthorizationType.USER, slaveUsername)) +strategy.add(hudson.model.Computer.CONNECT, new PermissionEntry(AuthorizationType.USER, slaveUsername)) +strategy.add(hudson.model.Computer.CREATE, new PermissionEntry(AuthorizationType.USER, slaveUsername)) +strategy.add(hudson.model.Computer.DELETE, new PermissionEntry(AuthorizationType.USER, slaveUsername)) +strategy.add(hudson.model.Computer.DISCONNECT, new PermissionEntry(AuthorizationType.USER, slaveUsername)) +// Overall Permissions +strategy.add(hudson.model.Hudson.READ, new PermissionEntry(AuthorizationType.USER, slaveUsername)) +// Setting System Permissions +// System Permissions +strategy.add(hudson.model.Computer.BUILD, new PermissionEntry(AuthorizationType.USER, systemUsername)) +strategy.add(hudson.model.Computer.CONFIGURE, new PermissionEntry(AuthorizationType.USER, systemUsername)) +strategy.add(hudson.model.Computer.CONNECT, new PermissionEntry(AuthorizationType.USER, systemUsername)) +strategy.add(hudson.model.Computer.CREATE, new PermissionEntry(AuthorizationType.USER, systemUsername)) +strategy.add(hudson.model.Computer.DELETE, new PermissionEntry(AuthorizationType.USER, systemUsername)) +strategy.add(hudson.model.Computer.DISCONNECT, new PermissionEntry(AuthorizationType.USER, systemUsername)) +// Overall Permissions +strategy.add(hudson.model.Hudson.READ, new PermissionEntry(AuthorizationType.USER, systemUsername)) +// Setting Admin Permissions +// Admin Permissions +strategy.add(hudson.model.Computer.BUILD, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Computer.CONFIGURE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Computer.CONNECT, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Computer.CREATE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Computer.DELETE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Computer.DISCONNECT, new PermissionEntry(AuthorizationType.USER, adminUsername)) +// Credential Permissions +strategy.add(com.cloudbees.plugins.credentials.CredentialsProvider.CREATE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(com.cloudbees.plugins.credentials.CredentialsProvider.DELETE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(com.cloudbees.plugins.credentials.CredentialsProvider.MANAGE_DOMAINS, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(com.cloudbees.plugins.credentials.CredentialsProvider.UPDATE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(com.cloudbees.plugins.credentials.CredentialsProvider.VIEW, new PermissionEntry(AuthorizationType.USER, adminUsername)) +// Overall Permissions +strategy.add(hudson.model.Hudson.ADMINISTER, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.PluginManager.CONFIGURE_UPDATECENTER, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Hudson.READ, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Hudson.RUN_SCRIPTS, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.PluginManager.UPLOAD_PLUGINS, new PermissionEntry(AuthorizationType.USER, adminUsername)) +// Job Permissions +strategy.add(hudson.model.Item.BUILD, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Item.CANCEL, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Item.CONFIGURE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Item.CREATE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Item.DELETE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Item.DISCOVER, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Item.READ, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Item.WORKSPACE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +// Run Permissions +strategy.add(hudson.model.Run.DELETE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.Run.UPDATE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +// View Permissions +strategy.add(hudson.model.View.CONFIGURE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.View.CREATE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.View.DELETE, new PermissionEntry(AuthorizationType.USER, adminUsername)) +strategy.add(hudson.model.View.READ, new PermissionEntry(AuthorizationType.USER, adminUsername)) +jenkins.setAuthorizationStrategy(strategy); +println " [bitnami/groovy-init-jenkins-with-slaves] Authorization Strategy set" + +// Configure Authorize Project Plugin +// Proper rules are needed to increase the security settings of the jobs and to avoid warning messages +println " [bitnami/groovy-init-jenkins-with-slaves] Configuring 'Authorize Project' plugin" +def configureGlobalAuthenticator = true +def configureProjectAuthenticator = true +def authenticators = QueueItemAuthenticatorConfiguration.get().getAuthenticators() +for (authenticator in authenticators) { + if (authenticator instanceof GlobalQueueItemAuthenticator) { + println " [bitnami/groovy-init-jenkins-with-slaves] Skipping global build authenticator, it exists" + configureGlobalAuthenticator = false + } else if (authenticator instanceof ProjectQueueItemAuthenticator) { + println " [bitnami/groovy-init-jenkins-with-slaves] Skipping per-project build authenticator, it exists" + configureProjectAuthenticator = false + } +} +if (configureGlobalAuthenticator) { + def globalStrategy = new SpecificUsersAuthorizationStrategy(systemUsername) + def globalStrategyName = globalStrategy.getDescriptor().getDisplayName() + println " [bitnami/groovy-init-jenkins-with-slaves] Configuring global build authenticator with '${globalStrategyName}' strategy" + authenticators.add(new GlobalQueueItemAuthenticator(globalStrategy)) +} +if (configureProjectAuthenticator) { + def anonymousAuthorizationStrategyDescriptor = jenkins.getDescriptor(AnonymousAuthorizationStrategy.class) + def triggeringUsersAuthorizationStrategyDescriptor = jenkins.getDescriptor(TriggeringUsersAuthorizationStrategy.class) + def specificUsersAuthorizationStrategyDescriptor = jenkins.getDescriptor(SpecificUsersAuthorizationStrategy.class) + def systemAuthorizationStrategyDescriptor = jenkins.getDescriptor(SystemAuthorizationStrategy.class) + def projectStrategy = [ + (anonymousAuthorizationStrategyDescriptor.getId()): true, + (triggeringUsersAuthorizationStrategyDescriptor.getId()): true, + (specificUsersAuthorizationStrategyDescriptor.getId()): true, + (systemAuthorizationStrategyDescriptor.getId()): false + ] + println " [bitnami/groovy-init-jenkins-with-slaves] Configuring per-project build authenticator" + println " [bitnami/groovy-init-jenkins-with-slaves] Allowing '${anonymousAuthorizationStrategyDescriptor.getDisplayName()}' strategy" + println " [bitnami/groovy-init-jenkins-with-slaves] Allowing '${triggeringUsersAuthorizationStrategyDescriptor.getDisplayName()}' strategy" + println " [bitnami/groovy-init-jenkins-with-slaves] Allowing '${specificUsersAuthorizationStrategyDescriptor.getDisplayName()}' strategy" + authenticators.add(new ProjectQueueItemAuthenticator(projectStrategy)) +} +println " [bitnami/groovy-init-jenkins-with-slaves] 'Authorize Project' plugin configuration finished" + +// Configure JNLP port +println " [bitnami/groovy-init-jenkins-with-slaves] Configuring JNLP port" +jenkins.setSlaveAgentPort({{jnlp_port}}) +println " [bitnami/groovy-init-jenkins-with-slaves] JNLP port is set to '{{jnlp_port}}'" + +// require a crumb issuer +println " [bitnami/groovy-init-jenkins] Enabling CSRF Protection" +jenkins.setCrumbIssuer(new DefaultCrumbIssuer(true)); +println " [bitnami/groovy-init-jenkins] CSRF Protection enabled" + +// Set master-slave security +println " [bitnami/groovy-init-jenkins] Setting master-slave security" +jenkins.getInjector().getInstance(AdminWhitelistRule.class).setMasterKillSwitch(false); +println " [bitnami/groovy-init-jenkins] master-slave set" + +// Set master executors +println " [bitnami/groovy-init-jenkins] Setting master executors to 0" +jenkins.setNumExecutors(0); +println " [bitnami/groovy-init-jenkins] master executors set" + +// Setting email address +println " [bitnami/groovy-init-jenkins] Configuring Jenkins adminstrator email address" +location = jenkins.model.JenkinsLocationConfiguration.get() +location.setAdminAddress("{{JENKINS_EMAIL}}") +println " [bitnami/groovy-init-jenkins] Jenkins email is set to '{{JENKINS_EMAIL}}'" +location.save() + +jenkins.save() + +// Complete wizard +println " [bitnami/groovy-init-jenkins-with-slaves] Passing wizard" +def wizard = new SetupWizard() +wizard.init(true) +wizard.completeSetup() +println " [bitnami/groovy-init-jenkins-with-slaves] Wizard passed" diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/init-jenkins.groovy.tpl b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/init-jenkins.groovy.tpl new file mode 100644 index 000000000000..7058e0691751 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/bitnami-templates/init-jenkins.groovy.tpl @@ -0,0 +1,63 @@ +// Inspired by https://github.com/jenkinsci/jenkins/blob/e1beed03962bbc3777a49a041109b8752d98d2ed/core/src/main/java/jenkins/install/SetupWizard.java + +import jenkins.security.s2m.AdminWhitelistRule; +import hudson.security.csrf.DefaultCrumbIssuer +import jenkins.model.*; +import jenkins.install.*; +import hudson.security.*; +import hudson.model.*; + +// Set Hudson Security +def jenkins = Jenkins.getInstance() +def securityRealm = new HudsonPrivateSecurityRealm(false, false, null) +jenkins.setSecurityRealm(securityRealm) + +// Create new admin account +println " [bitnami/groovy-init-jenkins] Creating admin user" +def adminUsername = '{{JENKINS_USERNAME}}' +def adminPassword = '{{JENKINS_PASSWORD}}' +securityRealm.createAccount(adminUsername, adminPassword) +println " [bitnami/groovy-init-jenkins] Admin user created: {{JENKINS_USERNAME}}:*******" +if (adminUsername != 'admin') { + // Delete the existing by default admin account + User u = User.get('admin') + u.delete() +} + +// Set Authorization strategy +println " [bitnami/groovy-init-jenkins] Setting Authorization Strategy" +def authStrategy = new FullControlOnceLoggedInAuthorizationStrategy(); +authStrategy.setAllowAnonymousRead(false); +jenkins.setAuthorizationStrategy(authStrategy); +println " [bitnami/groovy-init-jenkins] Authorization Strategy set" + +// Disable jnlp by default, but honor system properties +println " [bitnami/groovy-init-jenkins] Disabling JNLP" +jenkins.setSlaveAgentPort(-1); +println " [bitnami/groovy-init-jenkins] JNLP disabled" + +// require a crumb issuer +println " [bitnami/groovy-init-jenkins] Enabling CSRF Protection" +jenkins.setCrumbIssuer(new DefaultCrumbIssuer(true)); +println " [bitnami/groovy-init-jenkins] CSRF Protection enabled" + +// Set master-slave security +println " [bitnami/groovy-init-jenkins] Setting master-slave security" +jenkins.getInjector().getInstance(AdminWhitelistRule.class).setMasterKillSwitch(false); +println " [bitnami/groovy-init-jenkins] master-slave security set" + +// Setting email address +println " [bitnami/groovy-init-jenkins] Configuring Jenkins adminstrator email address" +location = jenkins.model.JenkinsLocationConfiguration.get() +location.setAdminAddress("{{JENKINS_EMAIL}}") +location.save() +println " [bitnami/groovy-init-jenkins] Jenkins email is set to '{{JENKINS_EMAIL}}'" + +jenkins.save() + +// Complete wizard +println " [bitnami/groovy-init-jenkins] Passing wizard" +def wizard = new SetupWizard() +wizard.init(true) +wizard.completeSetup() +println " [bitnami/groovy-init-jenkins] Wizard passed" diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/entrypoint.sh b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/entrypoint.sh new file mode 100755 index 000000000000..e5466798a16f --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/entrypoint.sh @@ -0,0 +1,45 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh + +# Load Jenkins environment +. /opt/bitnami/scripts/jenkins-env.sh + +print_welcome_page + +# Set nss_wrapper vars only when running as non-root +# Configure libnss_wrapper based on the UID/GID used to run the container +# This container supports arbitrary UIDs, therefore we have do it dynamically +if ! am_i_root; then + export LNAME="jenkins" + export LD_PRELOAD="/opt/bitnami/common/lib/libnss_wrapper.so" + if ! user_exists "$(id -u)" && [[ -f "$LD_PRELOAD" ]]; then + info "Configuring libnss_wrapper" + NSS_WRAPPER_PASSWD="$(mktemp)" + export NSS_WRAPPER_PASSWD + NSS_WRAPPER_GROUP="$(mktemp)" + export NSS_WRAPPER_GROUP + echo "jenkins:x:$(id -u):$(id -g):Jenkins:${JENKINS_HOME}:/bin/false" >"$NSS_WRAPPER_PASSWD" + echo "jenkins:x:$(id -g):" >"$NSS_WRAPPER_GROUP" + chmod 400 "$NSS_WRAPPER_PASSWD" "$NSS_WRAPPER_GROUP" + fi +fi + +if [[ "$1" = "/opt/bitnami/scripts/jenkins/run.sh" ]]; then + info "** Starting Jenkins setup **" + /opt/bitnami/scripts/jenkins/setup.sh + info "** Jenkins setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/postunpack.sh b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/postunpack.sh new file mode 100755 index 000000000000..cc3b2d8787c7 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/postunpack.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libjenkins.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh + +# Load Jenkins environment +. /opt/bitnami/scripts/jenkins-env.sh + +# Ensure required directories exist +chmod g+rwX "$JENKINS_BASE_DIR" +for dir in "$JENKINS_VOLUME_DIR" "$JENKINS_HOME" "${JENKINS_BASE_DIR}/plugins" "$JENKINS_TMP_DIR" "$JENKINS_LOGS_DIR"; do + ensure_dir_exists "$dir" + configure_permissions_ownership "$dir" -d "775" -f "664" +done diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/run.sh b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/run.sh new file mode 100755 index 000000000000..6524e3d3db7d --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/run.sh @@ -0,0 +1,44 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libjenkins.sh +. /opt/bitnami/scripts/liblog.sh + +# Load Jenkins environment +. /opt/bitnami/scripts/jenkins-env.sh + +declare -a args +if [[ -n "${JAVA_OPTS:-}" ]]; then + read -r -a java_opts <<<"$JAVA_OPTS" + args+=("${java_opts[@]}") +fi +args+=("-Duser.home=${JENKINS_HOME}" "-jar" "${JENKINS_BASE_DIR}/jenkins.war") +if is_boolean_yes "$JENKINS_FORCE_HTTPS"; then + args+=( + "--httpPort=-1" + "--httpsPort=${JENKINS_HTTPS_PORT_NUMBER:-"$JENKINS_DEFAULT_HTTPS_PORT_NUMBER"}" + "--httpsListenAddress=${JENKINS_HTTPS_LISTEN_ADDRESS:-"$JENKINS_DEFAULT_HTTPS_LISTEN_ADDRESS"}" + ) +else + args+=( + "--httpPort=${JENKINS_HTTP_PORT_NUMBER:-"$JENKINS_DEFAULT_HTTP_PORT_NUMBER"}" + "--httpListenAddress=${JENKINS_HTTP_LISTEN_ADDRESS:-"$JENKINS_DEFAULT_HTTP_LISTEN_ADDRESS"}" + "--httpsPort=${JENKINS_HTTPS_PORT_NUMBER:-"$JENKINS_DEFAULT_HTTPS_PORT_NUMBER"}" + "--httpsListenAddress=${JENKINS_HTTPS_LISTEN_ADDRESS:-"$JENKINS_DEFAULT_HTTPS_LISTEN_ADDRESS"}" + ) +fi +args+=("$@") + +info "** Starting Jenkins **" +if am_i_root; then + exec gosu "$JENKINS_DAEMON_USER" java "${args[@]}" +else + exec java "${args[@]}" +fi diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/setup.sh b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/setup.sh new file mode 100755 index 000000000000..c901a9ac4d3b --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/jenkins/setup.sh @@ -0,0 +1,30 @@ +#!/bin/bash + +# shellcheck disable=SC1090,SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purpose + +# Load libraries +. /opt/bitnami/scripts/libjenkins.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh + +# Load Jenkins environment +. /opt/bitnami/scripts/jenkins-env.sh + +# Ensure Jenkins environment variables are valid +jenkins_validate + +if am_i_root; then + info "Creating Jenkins daemon user" + ensure_user_exists "$JENKINS_DAEMON_USER" --group "$JENKINS_DAEMON_GROUP" --home "$JENKINS_HOME" --system +fi + +# Ensure Jenkins is initialized +jenkins_initialize + +# Allow running custom initialization scripts +jenkins_custom_init_scripts diff --git a/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/libjenkins.sh b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/libjenkins.sh new file mode 100644 index 000000000000..b1e55edfdc04 --- /dev/null +++ b/bitnami/jenkins/2/debian-11/rootfs/opt/bitnami/scripts/libjenkins.sh @@ -0,0 +1,384 @@ +#!/bin/bash +# +# Bitnami Jenkins library + +# shellcheck disable=SC1091 +# shellcheck disable=SC1090 + +# Load generic libraries +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libnet.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libpersistence.sh + +######################## +# Check if Jenkins is running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_jenkins_running() { + local pid + pgrep -f "^java.*-jar ${JENKINS_BASE_DIR}/jenkins.war" >"$JENKINS_PID_FILE" + pid="$(get_pid_from_file "$JENKINS_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if Jenkins is not running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_jenkins_not_running() { + ! is_jenkins_running +} + +######################## +# Stop Jenkins +# Arguments: +# None +# Returns: +# None +######################### +jenkins_stop() { + is_jenkins_not_running && return + info "Stopping Jenkins" + stop_service_using_pid "$JENKINS_PID_FILE" +} + +######################## +# Start Jenkins in background +# Arguments: +# None +# Returns: +# None +######################### +jenkins_start_bg() { + local -a args + if [[ -n "${JAVA_OPTS:-}" ]]; then + read -r -a java_opts <<<"$JAVA_OPTS" + args+=("${java_opts[@]}") + fi + args+=("-Duser.home=${JENKINS_HOME}" "-jar" "${JENKINS_BASE_DIR}/jenkins.war" "--httpListenAddress=127.0.0.1") + + is_jenkins_running && return + info "Starting Jenkins in background" + if am_i_root; then + touch "$JENKINS_LOG_FILE" + configure_permissions_ownership "$JENKINS_LOG_FILE" -u "$JENKINS_DAEMON_USER" -g "$JENKINS_DAEMON_GROUP" + gosu "$JENKINS_DAEMON_USER" java "${args[@]}" >>"$JENKINS_LOG_FILE" 2>&1 & + else + java "${args[@]}" >>"$JENKINS_LOG_FILE" 2>&1 & + fi + wait_for_log_entry "Jenkins is fully up and running" "$JENKINS_LOG_FILE" 36 10 +} + +######################## +# Invoke the Jenkins bundled client +# Globals: +# JENKINS_* +# Arguments: +# $@ - Command to execute +# Returns: +# None +######################### +jenkins_cli_execute() { + local -r cli_jar="$(find "${JENKINS_HOME}/war/WEB-INF/lib" -name "cli-*.jar")" + local -r http_port="${JENKINS_HTTP_PORT_NUMBER:-"$JENKINS_DEFAULT_HTTP_PORT_NUMBER"}" + local -r jenkins_url="http://127.0.0.1:${http_port}" + local -r args=("-jar" "${cli_jar}" "-s" "$jenkins_url" "-auth" "${JENKINS_USERNAME}:${JENKINS_PASSWORD}" "$@") + + debug "Executing command: java ${args[*]}" + if am_i_root; then + debug_execute gosu "$JENKINS_DAEMON_USER" java "${args[@]}" + else + debug_execute java "${args[@]}" + fi +} + +######################## +# Validate settings in JENKINS_* env vars +# Globals: +# JENKINS_* +# Arguments: +# None +# Returns: +# 0 if the validation succeeded, 1 otherwise +######################### +jenkins_validate() { + debug "Validating settings in JENKINS_* environment variables..." + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + check_conflicting_ports() { + local -r total="$#" + for i in $(seq 1 "$((total - 1))"); do + for j in $(seq "$((i + 1))" "$total"); do + var_i="${!i}" + var_j="${!j}" + if [[ -n "${!var_i:-}" ]] && [[ -n "${!var_j:-}" ]] && [[ "${!var_i:-}" -eq "${!var_j:-}" ]]; then + print_validation_error "${var_i} and ${var_j} are bound to the same port" + fi + done + done + } + check_resolved_hostname() { + if ! is_hostname_resolved "$1"; then + warn "Hostname ${1} could not be resolved, this could lead to connection issues" + fi + } + check_empty_value() { + if is_empty_value "${!1}"; then + print_validation_error "${1} must be set" + fi + } + check_yes_no_value() { + if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}"; then + print_validation_error "The allowed values for ${1} are: yes no" + fi + } + check_valid_port() { + local port_var="${1:?missing port variable}" + local err + if ! err="$(validate_port "${!port_var}")"; then + print_validation_error "An invalid port was specified in the environment variable ${port_var}: ${err}." + fi + } + + check_yes_no_value "JENKINS_SKIP_BOOTSTRAP" + + # Validate ports + ! is_empty_value "$JENKINS_HTTP_PORT_NUMBER" && check_valid_port "JENKINS_HTTP_PORT_NUMBER" + ! is_empty_value "$JENKINS_HTTPS_PORT_NUMBER" && check_valid_port "JENKINS_HTTPS_PORT_NUMBER" + ! is_empty_value "$JENKINS_JNLP_PORT_NUMBER" && check_valid_port "JENKINS_JNLP_PORT_NUMBER" + check_conflicting_ports "JENKINS_HTTP_PORT_NUMBER" "JENKINS_HTTPS_PORT_NUMBER" "JENKINS_JNLP_PORT_NUMBER" + + # Validate host + check_yes_no_value "JENKINS_FORCE_HTTPS" + if ! is_empty_value "$JENKINS_HOST"; then + check_resolved_hostname "$JENKINS_HOST" + [[ "$JENKINS_HOST" =~ localhost ]] && print_validation_error "JENKINS_HOST must be set to an actual hostname, localhost values are not allowed." + validate_ipv4 "$JENKINS_HOST" && print_validation_error "JENKINS_HOST must be set to an actual hostname, IP addresses are not allowed." + fi + + # Validate credentials + check_empty_value "JENKINS_PASSWORD" + if [[ "${#JENKINS_PASSWORD}" -lt 6 ]]; then + print_validation_error "The admin password must be at least 6 characters long. Set the environment variable JENKINS_PASSWORD with a longer value" + fi + + # Validate swarm configuration + check_yes_no_value "JENKINS_ENABLE_SWARM" + is_boolean_yes "$JENKINS_ENABLE_SWARM" && check_empty_value "JENKINS_SWARM_PASSWORD" + + return "$error_code" +} + +######################## +# Ensure Jenkins is initialized +# Globals: +# JENKINS_* +# Arguments: +# None +# Returns: +# None +######################### +jenkins_initialize() { + local -r init_jenkins_groovy_tpl="${JENKINS_TEMPLATES_DIR}/init-jenkins$(is_boolean_yes "$JENKINS_ENABLE_SWARM" && echo "-swarm").groovy.tpl" + + if am_i_root; then + # Ensure Jenkins daemon user has proper permissions on Jenkins home directory + info "Configuring file permissions for Jenkins" + is_mounted_dir_empty "$JENKINS_HOME" && configure_permissions_ownership "$JENKINS_HOME" -d "755" -f "644" -u "$JENKINS_DAEMON_USER" -g "$JENKINS_DAEMON_GROUP" + fi + + if is_mounted_dir_empty "$JENKINS_HOME"; then + # Plugins + debug "Moving plugins to $JENKINS_HOME" + ensure_dir_exists "${JENKINS_HOME}/plugins" + mv "${JENKINS_BASE_DIR}/plugins"/* "${JENKINS_HOME}/plugins" + am_i_root && configure_permissions_ownership "${JENKINS_HOME}/plugins" -d "755" -f "644" -u "$JENKINS_DAEMON_USER" -g "$JENKINS_DAEMON_GROUP" + if ! is_mounted_dir_empty "$JENKINS_MOUNTED_CONTENT_DIR"; then + info "Moving custom mounted files to Jenkins home directory" + echo "--- Copying files at $(date)" >>"${JENKINS_LOGS_DIR}/copy_reference_file.log" + find "$JENKINS_MOUNTED_CONTENT_DIR" \( -type f -o -type l \) | xargs -I % -P10 bash -c '. /opt/bitnami/scripts/libjenkins.sh && jenkins_add_custom_file %' + fi + # Initialize Jenkins + if ! is_boolean_yes "$JENKINS_SKIP_BOOTSTRAP"; then + # Create init groovy script and initialize Jenkins + info "Creating init script" + ensure_dir_exists "${JENKINS_HOME}/init.groovy.d" + jnlp_port="${JENKINS_JNLP_PORT_NUMBER:-"$JENKINS_DEFAULT_JNLP_PORT_NUMBER"}" render-template "$init_jenkins_groovy_tpl" >"${JENKINS_HOME}/init.groovy.d/init-jenkins.groovy" + jenkins_start_bg + # Configure host + ! is_empty_value "$JENKINS_HOST" && jenkins_configure_host "$JENKINS_HOST" + # Rotate the logs in Jenkins to clean the Jenkins warnings before actually configuring the app + jenkins_stop + mv "$JENKINS_LOG_FILE" "${JENKINS_LOGS_DIR}/jenkins.firstboot.log" + rm "${JENKINS_HOME}/init.groovy.d/init-jenkins.groovy" + else + info "Skipping Bitnami initialization" + fi + else + info "Detected data from previous deployments" + fi + + true +} + +######################### +# Configure Jenkins host +# Globals: +# JENKINS_* +# Arguments: +# $1 - hostname +# Returns: +# None +######################### +jenkins_configure_host() { + local -r hostname="${1:?missing hostname}" + local -r local_port="${JENKINS_HTTP_PORT_NUMBER:-"$JENKINS_DEFAULT_HTTP_PORT_NUMBER"}" + local -r configure_host_groovy_tpl="${JENKINS_TEMPLATES_DIR}/configure-host.groovy.tpl" + local -r retries="30" + local -r interval_time="10" + local base_url + local scheme + + is_boolean_yes "$JENKINS_FORCE_HTTPS" && scheme="https" || scheme="http" + base_url="${scheme}://${hostname}" + if is_boolean_yes "$JENKINS_FORCE_HTTPS"; then + [[ "$JENKINS_EXTERNAL_HTTPS_PORT_NUMBER" != "443" ]] && base_url+=":${JENKINS_EXTERNAL_HTTPS_PORT_NUMBER}" + else + [[ "$JENKINS_EXTERNAL_HTTP_PORT_NUMBER" != "80" ]] && base_url+=":${JENKINS_EXTERNAL_HTTP_PORT_NUMBER}" + fi + info "Configuring Jenkins URL to ${base_url}" + + if ! retry_while "debug_execute curl -sSf http://127.0.0.1:${local_port}/login" "$retries" "$interval_time"; then + error "Jenkins is not accessible" + return 1 + else + configure_host_tmp=$(mktemp) + url="${base_url}" render-template "$configure_host_groovy_tpl" >"$configure_host_tmp" + jenkins_cli_execute "groovy" "=" <"$configure_host_tmp" + rm "$configure_host_tmp" + fi +} + +######################### +# Copy files from JENKINS_MOUNTED_CONTENT_DIR into JENKINS_HOME +# Based on https://github.com/jenkinsci/docker/blob/8e33e547a43d248bbb3cf403fe908dbf11d4ae45/jenkins-support +# Globals: +# JENKINS_* +# Arguments: +# $1 - filepath +# Returns: +# None +######################### +jenkins_add_custom_file() { + local -r filepath="${1:?filepath is required}" + local -r filename="$(basename "$filepath")" + local -r relpath="${filepath#"${JENKINS_MOUNTED_CONTENT_DIR}/"}" + local action + local reason + + get_plugin_version() { + local -r pluginpath="${1:?pluginpath is required}" + local version + # Use unzip -p, which is mean to extract files to pipe + # https://linux.die.net/man/1/unzip + version=$(unzip -p "$pluginpath" META-INF/MANIFEST.MF | grep "^Plugin-Version: " | sed -e 's#^Plugin-Version: ##') + version=${version%%[[:space:]]} + echo "$version" + } + + if [[ $relpath = plugins/*.jpi ]]; then + debug "Adding custom plugin ${filename}" + if [[ -f "${JENKINS_HOME}/${relpath}" ]]; then + debug "Plugin ${filename} already exists" + plugin_version=$(get_plugin_version "${JENKINS_HOME}/${relpath}") + current_version=$(get_plugin_version "$filepath") + if [[ "$(get_sematic_version "$plugin_version" 1)" -gt "$(get_sematic_version "$current_version" 1)" ]]; then + action="UPGRADED" + reason="Installed version ($current_version) is older than installed version ($plugin_version)" + else + action="SKIPPED" + reason="Installed version ($current_version) is lower or equal than installed version ($plugin_version)" + fi + fi + if [[ ! -f "${JENKINS_HOME}/${relpath}" || "$action" = "UPGRADED" ]]; then + action=${action:-"INSTALLED"} + mkdir -p "${JENKINS_HOME}/$(dirname "$relpath")" + cp -pr "$(realpath "${filepath}")" "${JENKINS_HOME}/${relpath}" + fi + else + if [[ ! -f "${JENKINS_HOME}/${relpath}" ]]; then + action="INSTALLED" + mkdir -p "${JENKINS_HOME}/$(dirname "$relpath")" + cp -pr "$(realpath "${filepath}")" "${JENKINS_HOME}/${relpath}" + else + action="SKIPPED" + fi + fi + if [[ -z "$reason" ]]; then + echo "$action $relpath" >>"${JENKINS_LOGS_DIR}/copy_reference_file.log" + else + echo "$action $relpath : $reason" >>"${JENKINS_LOGS_DIR}/copy_reference_file.log" + fi +} + +######################## +# Run custom initialization scripts +# Globals: +# DB_* +# Arguments: +# None +# Returns: +# None +######################### +jenkins_custom_init_scripts() { + if [[ -n $(find /docker-entrypoint-initdb.d/ -type f -regex ".*\.\(sh\|groovy\)") ]] && [[ ! -f "${JENKINS_VOLUME_DIR}/.user_scripts_initialized" ]]; then + info "Loading user's custom files from /docker-entrypoint-initdb.d" + for f in /docker-entrypoint-initdb.d/*; do + debug "Executing $f" + case "$f" in + *.sh) + if [[ -x "$f" ]]; then + if ! "$f"; then + error "Failed executing $f" + return 1 + fi + else + warn "Sourcing $f as it is not executable by the current user, any error may cause initialization to fail" + . "$f" + fi + ;; + *.groovy) + cp "$f" "${JENKINS_HOME}/init.groovy.d" + jenkins_start_bg + jenkins_stop + # Rotate the logs in Jenkins + mv "$JENKINS_LOG_FILE" "${JENKINS_LOGS_DIR}/jenkins.initscripts.log" + rm "${JENKINS_HOME}/init.groovy.d/$(basename "$f")" + ;; + *) + warn "Skipping $f, supported formats are: .sh .sql .sql.gz" + ;; + esac + done + touch "${JENKINS_VOLUME_DIR}/.user_scripts_initialized" + fi +} diff --git a/bitnami/jenkins/README.md b/bitnami/jenkins/README.md index 12475f5eca21..73ef64a86c7f 100644 --- a/bitnami/jenkins/README.md +++ b/bitnami/jenkins/README.md @@ -41,7 +41,7 @@ Non-root container images add an extra layer of security and are generally recom Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/). -* [`2`, `2-debian-10`, `2.332.3`, `2.332.3-debian-10-r3`, `latest` (2/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-jenkins/blob/2.332.3-debian-10-r3/2/debian-10/Dockerfile) +* [`2`, `2-debian-11`, `2.332.3`, `2.332.3-debian-11-r0`, `latest` (2/debian-11/Dockerfile)](https://github.com/bitnami/bitnami-docker-jenkins/blob/2.332.3-debian-11-r0/2/debian-11/Dockerfile) Subscribe to project updates by watching the [bitnami/jenkins GitHub repo](https://github.com/bitnami/bitnami-docker-jenkins). @@ -62,7 +62,7 @@ $ docker pull bitnami/jenkins:[TAG] If you wish, you can also build the image yourself. ```console -$ docker build -t bitnami/jenkins:latest 'https://github.com/bitnami/bitnami-docker-jenkins.git#master:2/debian-10' +$ docker build -t bitnami/jenkins:latest 'https://github.com/bitnami/bitnami-docker-jenkins.git#master:2/debian-11' ``` ## How to use this image