mirror of
https://github.com/bitnami/containers.git
synced 2026-03-03 06:58:07 +08:00
9.0.0-debian-10-r0 release
This commit is contained in:
Bitnami Bot
35
bitnami/sonarqube/9/debian-10/Dockerfile
Normal file
35
bitnami/sonarqube/9/debian-10/Dockerfile
Normal file
@@ -0,0 +1,35 @@
|
||||
FROM docker.io/bitnami/minideb:buster
|
||||
LABEL maintainer "Bitnami <containers@bitnami.com>"
|
||||
|
||||
ENV HOME="/" \
|
||||
OS_ARCH="amd64" \
|
||||
OS_FLAVOUR="debian-10" \
|
||||
OS_NAME="linux"
|
||||
|
||||
COPY prebuildfs /
|
||||
# Install required system packages and dependencies
|
||||
RUN install_packages acl ca-certificates curl gzip libbsd0 libc6 libedit2 libffi6 libgcc1 libgmp10 libgnutls30 libhogweed4 libicu63 libidn2-0 libldap-2.4-2 liblzma5 libnettle6 libp11-kit0 libsasl2-2 libssl1.1 libstdc++6 libtasn1-6 libtinfo6 libunistring2 libuuid1 libxml2 libxslt1.1 procps tar zlib1g
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "postgresql-client" "13.3.0-0" --checksum 1202c736e3c5b28de1dd1deb05eb2d68bd7ebccc54c9ed1eab05220f346456c3
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "java" "11.0.11-0" --checksum 8cf28afc1090b0fec1ad841012ead25b59d2d5f4212742c3d62e6007ef57850b
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "sonarqube" "9.0.0-0" --checksum 825ed93fac5e7d9a0ecce33251b76f3daf445a80ca457d59d161e9f761426caa
|
||||
RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "gosu" "1.13.0-0" --checksum fd7257c2736164d02832dbf72e2c1ed9d875bf3e32f0988520796bc503330129
|
||||
RUN chmod g+rwX /opt/bitnami
|
||||
|
||||
COPY rootfs /
|
||||
RUN /opt/bitnami/scripts/sonarqube/postunpack.sh
|
||||
ENV BITNAMI_APP_NAME="sonarqube" \
|
||||
BITNAMI_IMAGE_VERSION="9.0.0-debian-10-r0" \
|
||||
PATH="/opt/bitnami/postgresql/bin:/opt/bitnami/java/bin:/opt/bitnami/common/bin:$PATH" \
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_NAME="" \
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD="" \
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME="" \
|
||||
POSTGRESQL_HOST="postgresql" \
|
||||
POSTGRESQL_PORT_NUMBER="5432" \
|
||||
POSTGRESQL_ROOT_PASSWORD="" \
|
||||
POSTGRESQL_ROOT_USER="postgres"
|
||||
|
||||
EXPOSE 9000
|
||||
|
||||
USER 1001
|
||||
ENTRYPOINT [ "/opt/bitnami/scripts/sonarqube/entrypoint.sh" ]
|
||||
CMD [ "/opt/bitnami/scripts/sonarqube/run.sh" ]
|
||||
29
bitnami/sonarqube/9/debian-10/docker-compose.yml
Normal file
29
bitnami/sonarqube/9/debian-10/docker-compose.yml
Normal file
@@ -0,0 +1,29 @@
|
||||
version: '2'
|
||||
services:
|
||||
postgresql:
|
||||
image: docker.io/bitnami/postgresql:13
|
||||
volumes:
|
||||
- 'postgresql_data:/bitnami/postgresql'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- POSTGRESQL_USERNAME=bn_sonarqube
|
||||
- POSTGRESQL_DATABASE=bitnami_sonarqube
|
||||
sonarqube:
|
||||
image: docker.io/bitnami/sonarqube:9
|
||||
ports:
|
||||
- '80:9000'
|
||||
volumes:
|
||||
- 'sonarqube_data:/bitnami/sonarqube'
|
||||
depends_on:
|
||||
- postgresql
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- SONARQUBE_DATABASE_HOST=postgresql
|
||||
- SONARQUBE_DATABASE_PORT_NUMBER=5432
|
||||
- SONARQUBE_DATABASE_USER=bn_sonarqube
|
||||
- SONARQUBE_DATABASE_NAME=bitnami_sonarqube
|
||||
volumes:
|
||||
postgresql_data:
|
||||
driver: local
|
||||
sonarqube_data:
|
||||
driver: local
|
||||
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"gosu": {
|
||||
"arch": "amd64",
|
||||
"digest": "fd7257c2736164d02832dbf72e2c1ed9d875bf3e32f0988520796bc503330129",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "1.13.0-0"
|
||||
},
|
||||
"java": {
|
||||
"arch": "amd64",
|
||||
"digest": "8cf28afc1090b0fec1ad841012ead25b59d2d5f4212742c3d62e6007ef57850b",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "11.0.11-0"
|
||||
},
|
||||
"postgresql-client": {
|
||||
"arch": "amd64",
|
||||
"digest": "1202c736e3c5b28de1dd1deb05eb2d68bd7ebccc54c9ed1eab05220f346456c3",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "13.3.0-0"
|
||||
},
|
||||
"sonarqube": {
|
||||
"arch": "amd64",
|
||||
"digest": "825ed93fac5e7d9a0ecce33251b76f3daf445a80ca457d59d161e9f761426caa",
|
||||
"distro": "debian-10",
|
||||
"type": "NAMI",
|
||||
"version": "9.0.0-0"
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
@@ -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 ""
|
||||
}
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for managing Bitnami components
|
||||
|
||||
# Constants
|
||||
CACHE_ROOT="/tmp/bitnami/pkg/cache"
|
||||
DOWNLOAD_URL="https://downloads.bitnami.com/files/stacksmith"
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Download and unpack a Bitnami package
|
||||
# Globals:
|
||||
# OS_NAME
|
||||
# OS_ARCH
|
||||
# OS_FLAVOUR
|
||||
# Arguments:
|
||||
# $1 - component's name
|
||||
# $2 - component's version
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
component_unpack() {
|
||||
local name="${1:?name is required}"
|
||||
local version="${2:?version is required}"
|
||||
local base_name="${name}-${version}-${OS_NAME}-${OS_ARCH}-${OS_FLAVOUR}"
|
||||
local package_sha256=""
|
||||
local directory="/opt/bitnami"
|
||||
|
||||
# Validate arguments
|
||||
shift 2
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-c|--checksum)
|
||||
shift
|
||||
package_sha256="${1:?missing package checksum}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
echo "Downloading $base_name package"
|
||||
if [ -f "${CACHE_ROOT}/${base_name}.tar.gz" ]; then
|
||||
echo "${CACHE_ROOT}/${base_name}.tar.gz already exists, skipping download."
|
||||
cp "${CACHE_ROOT}/${base_name}.tar.gz" .
|
||||
rm "${CACHE_ROOT}/${base_name}.tar.gz"
|
||||
if [ -f "${CACHE_ROOT}/${base_name}.tar.gz.sha256" ]; then
|
||||
echo "Using the local sha256 from ${CACHE_ROOT}/${base_name}.tar.gz.sha256"
|
||||
package_sha256="$(< "${CACHE_ROOT}/${base_name}.tar.gz.sha256")"
|
||||
rm "${CACHE_ROOT}/${base_name}.tar.gz.sha256"
|
||||
fi
|
||||
else
|
||||
curl --remote-name --silent "${DOWNLOAD_URL}/${base_name}.tar.gz"
|
||||
fi
|
||||
if [ -n "$package_sha256" ]; then
|
||||
echo "Verifying package integrity"
|
||||
echo "$package_sha256 ${base_name}.tar.gz" | sha256sum --check -
|
||||
fi
|
||||
tar --directory "${directory}" --extract --gunzip --file "${base_name}.tar.gz" --no-same-owner --strip-components=2 "${base_name}/files/"
|
||||
rm "${base_name}.tar.gz"
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for managing files
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Replace a regex in a file
|
||||
# Arguments:
|
||||
# $1 - filename
|
||||
# $2 - match regex
|
||||
# $3 - substitute regex
|
||||
# $4 - use POSIX regex. Default: true
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
replace_in_file() {
|
||||
local filename="${1:?filename is required}"
|
||||
local match_regex="${2:?match regex is required}"
|
||||
local substitute_regex="${3:?substitute regex is required}"
|
||||
local posix_regex=${4:-true}
|
||||
|
||||
local result
|
||||
|
||||
# We should avoid using 'sed in-place' substitutions
|
||||
# 1) They are not compatible with files mounted from ConfigMap(s)
|
||||
# 2) We found incompatibility issues with Debian10 and "in-place" substitutions
|
||||
del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues
|
||||
if [[ $posix_regex = true ]]; then
|
||||
result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")"
|
||||
else
|
||||
result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")"
|
||||
fi
|
||||
echo "$result" > "$filename"
|
||||
}
|
||||
|
||||
########################
|
||||
# Remove a line in a file based on a regex
|
||||
# Arguments:
|
||||
# $1 - filename
|
||||
# $2 - match regex
|
||||
# $3 - use POSIX regex. Default: true
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
remove_in_file() {
|
||||
local filename="${1:?filename is required}"
|
||||
local match_regex="${2:?match regex is required}"
|
||||
local posix_regex=${3:-true}
|
||||
local result
|
||||
|
||||
# We should avoid using 'sed in-place' substitutions
|
||||
# 1) They are not compatible with files mounted from ConfigMap(s)
|
||||
# 2) We found incompatibility issues with Debian10 and "in-place" substitutions
|
||||
if [[ $posix_regex = true ]]; then
|
||||
result="$(sed -E "/$match_regex/d" "$filename")"
|
||||
else
|
||||
result="$(sed "/$match_regex/d" "$filename")"
|
||||
fi
|
||||
echo "$result" > "$filename"
|
||||
}
|
||||
|
||||
########################
|
||||
# Appends text after the last line matching a pattern
|
||||
# Arguments:
|
||||
# $1 - file
|
||||
# $2 - match regex
|
||||
# $3 - contents to add
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
append_file_after_last_match() {
|
||||
local file="${1:?missing file}"
|
||||
local match_regex="${2:?missing pattern}"
|
||||
local value="${3:?missing value}"
|
||||
|
||||
# We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again
|
||||
result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)"
|
||||
echo "$result" > "$file"
|
||||
}
|
||||
|
||||
########################
|
||||
# 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
|
||||
}
|
||||
@@ -0,0 +1,183 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for file system actions
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Ensure a file/directory is owned (user and group) but the given user
|
||||
# Arguments:
|
||||
# $1 - filepath
|
||||
# $2 - owner
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
owned_by() {
|
||||
local path="${1:?path is missing}"
|
||||
local owner="${2:?owner is missing}"
|
||||
|
||||
chown "$owner":"$owner" "$path"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure a directory exists and, optionally, is owned by the given user
|
||||
# Arguments:
|
||||
# $1 - directory
|
||||
# $2 - owner
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
ensure_dir_exists() {
|
||||
local dir="${1:?directory is missing}"
|
||||
local owner="${2:-}"
|
||||
|
||||
mkdir -p "${dir}"
|
||||
if [[ -n $owner ]]; then
|
||||
owned_by "$dir" "$owner"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Checks whether a directory is empty or not
|
||||
# arguments:
|
||||
# $1 - directory
|
||||
# returns:
|
||||
# boolean
|
||||
#########################
|
||||
is_dir_empty() {
|
||||
local dir="${1:?missing directory}"
|
||||
|
||||
if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Checks whether a mounted directory is empty or not
|
||||
# arguments:
|
||||
# $1 - directory
|
||||
# returns:
|
||||
# boolean
|
||||
#########################
|
||||
is_mounted_dir_empty() {
|
||||
local dir="${1:?missing directory}"
|
||||
|
||||
if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Checks whether a file can be written to or not
|
||||
# arguments:
|
||||
# $1 - file
|
||||
# returns:
|
||||
# boolean
|
||||
#########################
|
||||
is_file_writable() {
|
||||
local file="${1:?missing file}"
|
||||
local dir
|
||||
dir="$(dirname "$file")"
|
||||
|
||||
if [[ ( -f "$file" && -w "$file" ) || ( ! -f "$file" && -d "$dir" && -w "$dir" ) ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Relativize a path
|
||||
# arguments:
|
||||
# $1 - path
|
||||
# $2 - base
|
||||
# returns:
|
||||
# None
|
||||
#########################
|
||||
relativize() {
|
||||
local -r path="${1:?missing path}"
|
||||
local -r base="${2:?missing base}"
|
||||
pushd "$base" >/dev/null || 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
|
||||
}
|
||||
@@ -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
|
||||
@@ -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}/"
|
||||
}
|
||||
@@ -0,0 +1,142 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for network functions
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Resolve IP address for a host/domain (i.e. DNS lookup)
|
||||
# Arguments:
|
||||
# $1 - Hostname to resolve
|
||||
# $2 - IP address version (v4, v6), leave empty for resolving to any version
|
||||
# Returns:
|
||||
# IP
|
||||
#########################
|
||||
dns_lookup() {
|
||||
local host="${1:?host is missing}"
|
||||
local ip_version="${2:-}"
|
||||
getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1
|
||||
}
|
||||
|
||||
#########################
|
||||
# Wait for a hostname and return the IP
|
||||
# Arguments:
|
||||
# $1 - hostname
|
||||
# $2 - number of retries
|
||||
# $3 - seconds to wait between retries
|
||||
# Returns:
|
||||
# - IP address that corresponds to the hostname
|
||||
#########################
|
||||
wait_for_dns_lookup() {
|
||||
local hostname="${1:?hostname is missing}"
|
||||
local retries="${2:-5}"
|
||||
local seconds="${3:-1}"
|
||||
check_host() {
|
||||
if [[ $(dns_lookup "$hostname") == "" ]]; then
|
||||
false
|
||||
else
|
||||
true
|
||||
fi
|
||||
}
|
||||
# Wait for the host to be ready
|
||||
retry_while "check_host ${hostname}" "$retries" "$seconds"
|
||||
dns_lookup "$hostname"
|
||||
}
|
||||
|
||||
########################
|
||||
# Get machine's IP
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Machine IP
|
||||
#########################
|
||||
get_machine_ip() {
|
||||
local -a ip_addresses
|
||||
local hostname
|
||||
hostname="$(hostname)"
|
||||
read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)"
|
||||
if [[ "${#ip_addresses[@]}" -gt 1 ]]; then
|
||||
warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}"
|
||||
elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then
|
||||
error "Could not find any IP address associated to hostname ${hostname}"
|
||||
exit 1
|
||||
fi
|
||||
echo "${ip_addresses[0]}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a resolved hostname
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_hostname_resolved() {
|
||||
local -r host="${1:?missing value}"
|
||||
if [[ -n "$(dns_lookup "$host")" ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Parse URL
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# $1 - uri - String
|
||||
# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String
|
||||
# Returns:
|
||||
# String
|
||||
parse_uri() {
|
||||
local uri="${1:?uri is missing}"
|
||||
local component="${2:?component is missing}"
|
||||
|
||||
# Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with
|
||||
# additional sub-expressions to split authority into userinfo, host and port
|
||||
# Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969)
|
||||
local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-9]+))?))?(/([^?#]*))?(\?([^#]*))?(#(.*))?'
|
||||
# || | ||| | | | | | | | | |
|
||||
# |2 scheme | ||6 userinfo 7 host | 9 port | 11 rpath | 13 query | 15 fragment
|
||||
# 1 scheme: | |5 userinfo@ 8 :... 10 path 12 ?... 14 #...
|
||||
# | 4 authority
|
||||
# 3 //...
|
||||
local index=0
|
||||
case "$component" in
|
||||
scheme)
|
||||
index=2
|
||||
;;
|
||||
authority)
|
||||
index=4
|
||||
;;
|
||||
userinfo)
|
||||
index=6
|
||||
;;
|
||||
host)
|
||||
index=7
|
||||
;;
|
||||
port)
|
||||
index=9
|
||||
;;
|
||||
path)
|
||||
index=10
|
||||
;;
|
||||
query)
|
||||
index=13
|
||||
;;
|
||||
fragment)
|
||||
index=14
|
||||
;;
|
||||
*)
|
||||
stderr_print "unrecognized component $component"
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
[[ "$uri" =~ $URI_REGEX ]] && echo "${BASH_REMATCH[${index}]}"
|
||||
}
|
||||
@@ -0,0 +1,364 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Library for operating system actions
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Check if an user exists in the system
|
||||
# Arguments:
|
||||
# $1 - user
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
user_exists() {
|
||||
local user="${1:?user is missing}"
|
||||
id "$user" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if a group exists in the system
|
||||
# Arguments:
|
||||
# $1 - group
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
group_exists() {
|
||||
local group="${1:?group is missing}"
|
||||
getent group "$group" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
########################
|
||||
# Create a group in the system if it does not exist already
|
||||
# Arguments:
|
||||
# $1 - group
|
||||
# Flags:
|
||||
# -s|--system - Whether to create new user as system user (uid <= 999)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
ensure_group_exists() {
|
||||
local group="${1:?group is missing}"
|
||||
local is_system_user=false
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-s|--system)
|
||||
is_system_user=true
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if ! group_exists "$group"; then
|
||||
local -a args=("$group")
|
||||
$is_system_user && args+=("--system")
|
||||
groupadd "${args[@]}" >/dev/null 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Create an user in the system if it does not exist already
|
||||
# Arguments:
|
||||
# $1 - user
|
||||
# Flags:
|
||||
# -g|--group - the group the new user should belong to
|
||||
# -h|--home - the home directory for the new user
|
||||
# -s|--system - whether to create new user as system user (uid <= 999)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
ensure_user_exists() {
|
||||
local user="${1:?user is missing}"
|
||||
local group=""
|
||||
local home=""
|
||||
local is_system_user=false
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-g|--group)
|
||||
shift
|
||||
group="${1:?missing group}"
|
||||
;;
|
||||
-h|--home)
|
||||
shift
|
||||
home="${1:?missing home directory}"
|
||||
;;
|
||||
-s|--system)
|
||||
is_system_user=true
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if ! user_exists "$user"; then
|
||||
local -a user_args=("-N" "$user")
|
||||
$is_system_user && user_args+=("--system")
|
||||
useradd "${user_args[@]}" >/dev/null 2>&1
|
||||
fi
|
||||
|
||||
if [[ -n "$group" ]]; then
|
||||
local -a group_args=("$group")
|
||||
$is_system_user && group_args+=("--system")
|
||||
ensure_group_exists "${group_args[@]}"
|
||||
usermod -g "$group" "$user" >/dev/null 2>&1
|
||||
fi
|
||||
|
||||
if [[ -n "$home" ]]; then
|
||||
mkdir -p "$home"
|
||||
usermod -d "$home" "$user" >/dev/null 2>&1
|
||||
configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the script is currently running as root
|
||||
# Arguments:
|
||||
# $1 - user
|
||||
# $2 - group
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
am_i_root() {
|
||||
if [[ "$(id -u)" = "0" ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Get total memory available
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Memory in bytes
|
||||
#########################
|
||||
get_total_memory() {
|
||||
echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024))
|
||||
}
|
||||
|
||||
########################
|
||||
# Get machine size depending on specified memory
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Flags:
|
||||
# --memory - memory size (optional)
|
||||
# Returns:
|
||||
# Detected instance size
|
||||
#########################
|
||||
get_machine_size() {
|
||||
local memory=""
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--memory)
|
||||
shift
|
||||
memory="${1:?missing memory}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
if [[ -z "$memory" ]]; then
|
||||
debug "Memory was not specified, detecting available memory automatically"
|
||||
memory="$(get_total_memory)"
|
||||
fi
|
||||
sanitized_memory=$(convert_to_mb "$memory")
|
||||
if [[ "$sanitized_memory" -gt 26000 ]]; then
|
||||
echo 2xlarge
|
||||
elif [[ "$sanitized_memory" -gt 13000 ]]; then
|
||||
echo xlarge
|
||||
elif [[ "$sanitized_memory" -gt 6000 ]]; then
|
||||
echo large
|
||||
elif [[ "$sanitized_memory" -gt 3000 ]]; then
|
||||
echo medium
|
||||
elif [[ "$sanitized_memory" -gt 1500 ]]; then
|
||||
echo small
|
||||
else
|
||||
echo micro
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Get machine size depending on specified memory
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# $1 - memory size (optional)
|
||||
# Returns:
|
||||
# Detected instance size
|
||||
#########################
|
||||
get_supported_machine_sizes() {
|
||||
echo micro small medium large xlarge 2xlarge
|
||||
}
|
||||
|
||||
########################
|
||||
# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048)
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# $1 - memory size
|
||||
# Returns:
|
||||
# Result of the conversion
|
||||
#########################
|
||||
convert_to_mb() {
|
||||
local amount="${1:-}"
|
||||
if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then
|
||||
size="${BASH_REMATCH[1]}"
|
||||
unit="${BASH_REMATCH[2]}"
|
||||
if [[ "$unit" = "g" || "$unit" = "G" ]]; then
|
||||
amount="$((size * 1024))"
|
||||
else
|
||||
amount="$size"
|
||||
fi
|
||||
fi
|
||||
echo "$amount"
|
||||
}
|
||||
|
||||
|
||||
#########################
|
||||
# Redirects output to /dev/null if debug mode is disabled
|
||||
# Globals:
|
||||
# BITNAMI_DEBUG
|
||||
# Arguments:
|
||||
# $@ - Command to execute
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
debug_execute() {
|
||||
if ${BITNAMI_DEBUG:-false}; then
|
||||
"$@"
|
||||
else
|
||||
"$@" >/dev/null 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Retries a command a given number of times
|
||||
# Arguments:
|
||||
# $1 - cmd (as a string)
|
||||
# $2 - max retries. Default: 12
|
||||
# $3 - sleep between retries (in seconds). Default: 5
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
retry_while() {
|
||||
local cmd="${1:?cmd is missing}"
|
||||
local retries="${2:-12}"
|
||||
local sleep_time="${3:-5}"
|
||||
local return_value=1
|
||||
|
||||
read -r -a command <<< "$cmd"
|
||||
for ((i = 1 ; i <= retries ; i+=1 )); do
|
||||
"${command[@]}" && return_value=0 && break
|
||||
sleep "$sleep_time"
|
||||
done
|
||||
return $return_value
|
||||
}
|
||||
|
||||
########################
|
||||
# Generate a random string
|
||||
# Arguments:
|
||||
# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii
|
||||
# -c|--count - Number of characters, defaults to 32
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
# Returns:
|
||||
# String
|
||||
#########################
|
||||
generate_random_string() {
|
||||
local type="ascii"
|
||||
local count="32"
|
||||
local filter
|
||||
local result
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
-t|--type)
|
||||
shift
|
||||
type="$1"
|
||||
;;
|
||||
-c|--count)
|
||||
shift
|
||||
count="$1"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
# Validate type
|
||||
case "$type" in
|
||||
ascii)
|
||||
filter="[:print:]"
|
||||
;;
|
||||
alphanumeric)
|
||||
filter="a-zA-Z0-9"
|
||||
;;
|
||||
numeric)
|
||||
filter="0-9"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid type ${type}" >&2
|
||||
return 1
|
||||
esac
|
||||
# Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size
|
||||
# Note there is a very small chance of strings starting with EOL character
|
||||
# Therefore, the higher amount of lines read, this will happen less frequently
|
||||
result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")"
|
||||
echo "$result"
|
||||
}
|
||||
|
||||
########################
|
||||
# Create md5 hash from a string
|
||||
# Arguments:
|
||||
# $1 - string
|
||||
# Returns:
|
||||
# md5 hash - string
|
||||
#########################
|
||||
generate_md5_hash() {
|
||||
local -r str="${1:?missing input string}"
|
||||
echo -n "$str" | md5sum | awk '{print $1}'
|
||||
}
|
||||
|
||||
########################
|
||||
# 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}'
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -0,0 +1,235 @@
|
||||
#!/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
|
||||
}
|
||||
|
||||
########################
|
||||
# Generate a monit configuration file for a given service
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# $2 - Pid file
|
||||
# $3 - Start command
|
||||
# $4 - Stop command
|
||||
# Flags:
|
||||
# --disabled - Whether to disable the monit configuration
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
generate_monit_conf() {
|
||||
local service_name="${1:?service name is missing}"
|
||||
local pid_file="${2:?pid file is missing}"
|
||||
local start_command="${3:?start command is missing}"
|
||||
local stop_command="${4:?stop command is missing}"
|
||||
local monit_conf_dir="/etc/monit/conf.d"
|
||||
local disabled="no"
|
||||
|
||||
# Parse optional CLI flags
|
||||
shift 4
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--disabled)
|
||||
shift
|
||||
disabled="$1"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag ${1}" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
is_boolean_yes "$disabled" && conf_suffix=".disabled"
|
||||
mkdir -p "$monit_conf_dir"
|
||||
cat >"${monit_conf_dir}/${service_name}.conf${conf_suffix:-}" <<EOF
|
||||
check process ${service_name}
|
||||
with pidfile "${pid_file}"
|
||||
start program = "${start_command}" with timeout 90 seconds
|
||||
stop program = "${stop_command}" with timeout 90 seconds
|
||||
EOF
|
||||
}
|
||||
|
||||
########################
|
||||
# Generate a logrotate configuration file
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# $2 - Log files pattern
|
||||
# Flags:
|
||||
# --period - Period
|
||||
# --rotations - Number of rotations to store
|
||||
# --extra - Extra options (Optional)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
generate_logrotate_conf() {
|
||||
local service_name="${1:?service name is missing}"
|
||||
local log_path="${2:?log path is missing}"
|
||||
local period="weekly"
|
||||
local rotations="150"
|
||||
local extra=""
|
||||
local logrotate_conf_dir="/etc/logrotate.d"
|
||||
local var_name
|
||||
# Parse optional CLI flags
|
||||
shift 2
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--period|--rotations|--extra)
|
||||
var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
|
||||
shift
|
||||
declare "$var_name"="${1:?"$var_name" is missing}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag ${1}" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
mkdir -p "$logrotate_conf_dir"
|
||||
cat <<EOF | sed '/^\s*$/d' >"${logrotate_conf_dir}/${service_name}"
|
||||
${log_path} {
|
||||
${period}
|
||||
rotate ${rotations}
|
||||
dateext
|
||||
compress
|
||||
copytruncate
|
||||
missingok
|
||||
$(indent "$extra" 2)
|
||||
}
|
||||
EOF
|
||||
}
|
||||
@@ -0,0 +1,248 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Validation functions library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Check if the provided argument is an integer
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_int() {
|
||||
local -r int="${1:?missing value}"
|
||||
if [[ "$int" =~ ^-?[0-9]+ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a positive integer
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_positive_int() {
|
||||
local -r int="${1:?missing value}"
|
||||
if is_int "$int" && (( "${int}" >= 0 )); then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a boolean or is the string 'yes/true'
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_boolean_yes() {
|
||||
local -r bool="${1:-}"
|
||||
# comparison is performed without regard to the case of alphabetic characters
|
||||
shopt -s nocasematch
|
||||
if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a boolean yes/no value
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_yes_no_value() {
|
||||
local -r bool="${1:-}"
|
||||
if [[ "$bool" =~ ^(yes|no)$ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a boolean true/false value
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_true_false_value() {
|
||||
local -r bool="${1:-}"
|
||||
if [[ "$bool" =~ ^(true|false)$ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is an empty string or not defined
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_empty_value() {
|
||||
local -r val="${1:-}"
|
||||
if [[ -z "$val" ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate if the provided argument is a valid port
|
||||
# Arguments:
|
||||
# $1 - Port to validate
|
||||
# Returns:
|
||||
# Boolean and error message
|
||||
#########################
|
||||
validate_port() {
|
||||
local value
|
||||
local unprivileged=0
|
||||
|
||||
# Parse flags
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
-unprivileged)
|
||||
unprivileged=1
|
||||
;;
|
||||
--)
|
||||
shift
|
||||
break
|
||||
;;
|
||||
-*)
|
||||
stderr_print "unrecognized flag $1"
|
||||
return 1
|
||||
;;
|
||||
*)
|
||||
break
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if [[ "$#" -gt 1 ]]; then
|
||||
echo "too many arguments provided"
|
||||
return 2
|
||||
elif [[ "$#" -eq 0 ]]; then
|
||||
stderr_print "missing port argument"
|
||||
return 1
|
||||
else
|
||||
value=$1
|
||||
fi
|
||||
|
||||
if [[ -z "$value" ]]; then
|
||||
echo "the value is empty"
|
||||
return 1
|
||||
else
|
||||
if ! is_int "$value"; then
|
||||
echo "value is not an integer"
|
||||
return 2
|
||||
elif [[ "$value" -lt 0 ]]; then
|
||||
echo "negative value provided"
|
||||
return 2
|
||||
elif [[ "$value" -gt 65535 ]]; then
|
||||
echo "requested port is greater than 65535"
|
||||
return 2
|
||||
elif [[ "$unprivileged" = 1 && "$value" -lt 1024 ]]; then
|
||||
echo "privileged port requested"
|
||||
return 3
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate if the provided argument is a valid IPv4 address
|
||||
# Arguments:
|
||||
# $1 - IP to validate
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
validate_ipv4() {
|
||||
local ip="${1:?ip is missing}"
|
||||
local stat=1
|
||||
|
||||
if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
|
||||
read -r -a ip_array <<< "$(tr '.' ' ' <<< "$ip")"
|
||||
[[ ${ip_array[0]} -le 255 && ${ip_array[1]} -le 255 \
|
||||
&& ${ip_array[2]} -le 255 && ${ip_array[3]} -le 255 ]]
|
||||
stat=$?
|
||||
fi
|
||||
return $stat
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate a string format
|
||||
# Arguments:
|
||||
# $1 - String to validate
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
validate_string() {
|
||||
local string
|
||||
local min_length=-1
|
||||
local max_length=-1
|
||||
|
||||
# Parse flags
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-min-length)
|
||||
shift
|
||||
min_length=${1:-}
|
||||
;;
|
||||
-max-length)
|
||||
shift
|
||||
max_length=${1:-}
|
||||
;;
|
||||
--)
|
||||
shift
|
||||
break
|
||||
;;
|
||||
-*)
|
||||
stderr_print "unrecognized flag $1"
|
||||
return 1
|
||||
;;
|
||||
*)
|
||||
break
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if [ "$#" -gt 1 ]; then
|
||||
stderr_print "too many arguments provided"
|
||||
return 2
|
||||
elif [ "$#" -eq 0 ]; then
|
||||
stderr_print "missing string"
|
||||
return 1
|
||||
else
|
||||
string=$1
|
||||
fi
|
||||
|
||||
if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then
|
||||
echo "string length is less than $min_length"
|
||||
return 1
|
||||
fi
|
||||
if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then
|
||||
echo "string length is great than $max_length"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -0,0 +1,431 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Bitnami web server handler library
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
# Load generic libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
########################
|
||||
# Execute a command (or list of commands) with the web server environment and library loaded
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_execute() {
|
||||
local -r web_server="${1:?missing web server}"
|
||||
shift
|
||||
# Run program in sub-shell to avoid web server environment getting loaded when not necessary
|
||||
(
|
||||
. "/opt/bitnami/scripts/lib${web_server}.sh"
|
||||
. "/opt/bitnami/scripts/${web_server}-env.sh"
|
||||
"$@"
|
||||
)
|
||||
}
|
||||
|
||||
########################
|
||||
# Prints the list of enabled web servers
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_list() {
|
||||
local -r -a supported_web_servers=(apache nginx)
|
||||
local -a existing_web_servers=()
|
||||
for web_server in "${supported_web_servers[@]}"; do
|
||||
[[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server")
|
||||
done
|
||||
echo "${existing_web_servers[@]:-}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Prints the currently-enabled web server type (only one, in order of preference)
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_type() {
|
||||
local -a web_servers
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
echo "${web_servers[0]:-}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate that a supported web server is configured
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_validate() {
|
||||
local error_code=0
|
||||
local supported_web_servers=("apache" "nginx")
|
||||
|
||||
# Auxiliary functions
|
||||
print_validation_error() {
|
||||
error "$1"
|
||||
error_code=1
|
||||
}
|
||||
|
||||
if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then
|
||||
print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}"
|
||||
elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then
|
||||
print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable."
|
||||
fi
|
||||
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Check whether the web server is running
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# true if the web server is running, false otherwise
|
||||
#########################
|
||||
is_web_server_running() {
|
||||
"is_$(web_server_type)_running"
|
||||
}
|
||||
|
||||
########################
|
||||
# Start web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_start() {
|
||||
info "Starting $(web_server_type) in background"
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh"
|
||||
}
|
||||
|
||||
########################
|
||||
# Stop web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_stop() {
|
||||
info "Stopping $(web_server_type)"
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh"
|
||||
}
|
||||
|
||||
########################
|
||||
# Restart web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_restart() {
|
||||
info "Restarting $(web_server_type)"
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh"
|
||||
}
|
||||
|
||||
########################
|
||||
# Reload web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_reload() {
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block)
|
||||
# It serves as a wrapper for the specific web server function
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - App name
|
||||
# Flags:
|
||||
# --hosts - Hosts to enable
|
||||
# --type - Application type, which has an effect on which configuration template to use
|
||||
# --allow-remote-connections - Whether to allow remote connections or to require local connections
|
||||
# --disabled - Whether to render the file with a .disabled prefix
|
||||
# --enable-https - Enable app configuration on HTTPS port
|
||||
# --http-port - HTTP port number
|
||||
# --https-port - HTTPS port number
|
||||
# --document-root - Path to document root directory
|
||||
# Apache-specific flags:
|
||||
# --apache-additional-configuration - Additional vhost configuration (no default)
|
||||
# --apache-before-vhost-configuration - Configuration to add before the <VirtualHost> directive (no default)
|
||||
# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no')
|
||||
# --apache-extra-directory-configuration - Extra configuration for the document root directory
|
||||
# --apache-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
|
||||
# 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
|
||||
--hosts \
|
||||
| --type \
|
||||
| --allow-remote-connections \
|
||||
| --disabled \
|
||||
| --enable-https \
|
||||
| --http-port \
|
||||
| --https-port \
|
||||
| --document-root \
|
||||
)
|
||||
apache_args+=("$1" "${2:?missing value}")
|
||||
nginx_args+=("$1" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific Apache flags
|
||||
--apache-additional-configuration \
|
||||
| --apache-before-vhost-configuration \
|
||||
| --apache-allow-override \
|
||||
| --apache-extra-directory-configuration \
|
||||
| --apache-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 - Hosts to enable
|
||||
# --enable-https - Update HTTPS app configuration
|
||||
# --http-port - HTTP port number
|
||||
# --https-port - HTTPS port number
|
||||
# Returns:
|
||||
# true if the configuration was updated, false otherwise
|
||||
########################
|
||||
web_server_update_app_configuration() {
|
||||
local app="${1:?missing app}"
|
||||
shift
|
||||
local -a args web_servers
|
||||
args=("$app")
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
# Common flags
|
||||
--hosts \
|
||||
| --enable-https \
|
||||
| --http-port \
|
||||
| --https-port \
|
||||
)
|
||||
args+=("$1" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Enable loading page, which shows users that the initialization process is not yet completed
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_enable_loading_page() {
|
||||
ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \
|
||||
--apache-additional-configuration "
|
||||
# Show a HTTP 503 Service Unavailable page by default
|
||||
RedirectMatch 503 ^/$
|
||||
# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes
|
||||
ErrorDocument 404 /index.html
|
||||
ErrorDocument 503 /index.html" \
|
||||
--nginx-additional-configuration "
|
||||
# Show a HTTP 503 Service Unavailable page by default
|
||||
location / {
|
||||
return 503;
|
||||
}
|
||||
# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes
|
||||
error_page 404 @installing;
|
||||
error_page 503 @installing;
|
||||
location @installing {
|
||||
rewrite ^(.*)$ /index.html break;
|
||||
}"
|
||||
web_server_reload
|
||||
}
|
||||
|
||||
########################
|
||||
# Enable loading page, which shows users that the initialization process is not yet completed
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_disable_install_page() {
|
||||
ensure_web_server_app_configuration_not_exists "__loading"
|
||||
web_server_reload
|
||||
}
|
||||
24
bitnami/sonarqube/9/debian-10/prebuildfs/usr/sbin/install_packages
Executable file
24
bitnami/sonarqube/9/debian-10/prebuildfs/usr/sbin/install_packages
Executable file
@@ -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
|
||||
@@ -0,0 +1,389 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Bitnami PostgreSQL Client library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/libvalidations.sh
|
||||
|
||||
########################
|
||||
# Validate settings in POSTGRESQL_CLIENT_* environment variables
|
||||
# Globals:
|
||||
# POSTGRESQL_CLIENT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
postgresql_client_validate() {
|
||||
info "Validating settings in POSTGRESQL_CLIENT_* env vars"
|
||||
local error_code=0
|
||||
|
||||
# Auxiliary functions
|
||||
print_validation_error() {
|
||||
error "$1"
|
||||
error_code=1
|
||||
}
|
||||
|
||||
empty_password_enabled_warn() {
|
||||
warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD}. For safety reasons, do not use this flag in a production environment."
|
||||
}
|
||||
empty_password_error() {
|
||||
print_validation_error "The $1 environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow the container to be started with blank passwords. This is recommended only for development."
|
||||
}
|
||||
|
||||
# Only validate environment variables if any action needs to be performed
|
||||
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" || -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" ]]; then
|
||||
if is_boolean_yes "$ALLOW_EMPTY_PASSWORD"; then
|
||||
empty_password_enabled_warn
|
||||
else
|
||||
if [[ -z "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD" ]]; then
|
||||
empty_password_error "POSTGRESQL_CLIENT_POSTGRES_PASSWORD"
|
||||
fi
|
||||
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" ]] && [[ -z "$POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD" ]]; then
|
||||
empty_password_error "POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
# When enabling extensions, the DB name must be provided
|
||||
local -a extensions
|
||||
read -r -a extensions <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS")"
|
||||
if [[ -z "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" && "${#extensions[@]}" -gt 0 ]]; then
|
||||
print_validation_error "POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS requires POSTGRESQL_CLIENT_CREATE_DATABASE_NAME to be set."
|
||||
fi
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Perform actions to a database
|
||||
# Globals:
|
||||
# POSTGRESQL_CLIENT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
postgresql_client_initialize() {
|
||||
# Wait for the database to be accessible if any action needs to be performed
|
||||
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" || -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" ]]; then
|
||||
info "Trying to connect to the database server"
|
||||
check_postgresql_connection() {
|
||||
echo "SELECT 1" | postgresql_remote_execute "$POSTGRESQL_CLIENT_DATABASE_HOST" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER" "" "$POSTGRESQL_CLIENT_POSTGRES_USER" "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD"
|
||||
}
|
||||
if ! retry_while "check_postgresql_connection"; then
|
||||
error "Could not connect to the database server"
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
# Ensure a database user exists in the server
|
||||
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" ]]; then
|
||||
info "Creating database user ${POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME}"
|
||||
local -a args=("$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" "--host" "$POSTGRESQL_CLIENT_DATABASE_HOST" "--port" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER")
|
||||
[[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD" ]] && args+=("-p" "$POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD")
|
||||
postgresql_ensure_user_exists "${args[@]}"
|
||||
fi
|
||||
# Ensure a database exists in the server (and that the user has write privileges, if specified)
|
||||
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" ]]; then
|
||||
info "Creating database ${POSTGRESQL_CLIENT_CREATE_DATABASE_NAME}"
|
||||
local -a createdb_args=("$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" "--host" "$POSTGRESQL_CLIENT_DATABASE_HOST" "--port" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER")
|
||||
[[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" ]] && createdb_args+=("-u" "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME")
|
||||
postgresql_ensure_database_exists "${createdb_args[@]}"
|
||||
# Ensure the list of extensions are enabled in the specified database
|
||||
local -a extensions
|
||||
read -r -a extensions <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS")"
|
||||
if [[ "${#extensions[@]}" -gt 0 ]]; then
|
||||
for extension_to_create in "${extensions[@]}"; do
|
||||
echo "CREATE EXTENSION IF NOT EXISTS ${extension_to_create}" | postgresql_remote_execute "$POSTGRESQL_CLIENT_DATABASE_HOST" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER" "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAME" "$POSTGRESQL_CLIENT_POSTGRES_USER" "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD"
|
||||
done
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Return PostgreSQL major version
|
||||
# Globals:
|
||||
# POSTGRESQL_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# String
|
||||
#########################
|
||||
postgresql_get_major_version() {
|
||||
psql --version | grep -oE "[0-9]+\.[0-9]+" | grep -oE "^[0-9]+"
|
||||
}
|
||||
|
||||
########################
|
||||
# Gets an environment variable name based on the suffix
|
||||
# Arguments:
|
||||
# $1 - environment variable suffix
|
||||
# Returns:
|
||||
# environment variable name
|
||||
#########################
|
||||
get_env_var_value() {
|
||||
local env_var_suffix="${1:?missing suffix}"
|
||||
local env_var_name
|
||||
for env_var_prefix in POSTGRESQL POSTGRESQL_CLIENT; do
|
||||
env_var_name="${env_var_prefix}_${env_var_suffix}"
|
||||
if [[ -n "${!env_var_name:-}" ]]; then
|
||||
echo "${!env_var_name}"
|
||||
break
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute an arbitrary query/queries against the running PostgreSQL service and print the output
|
||||
# Stdin:
|
||||
# Query/queries to execute
|
||||
# Globals:
|
||||
# BITNAMI_DEBUG
|
||||
# POSTGRESQL_*
|
||||
# Arguments:
|
||||
# $1 - Database where to run the queries
|
||||
# $2 - User to run queries
|
||||
# $3 - Password
|
||||
# $4 - Extra options (eg. -tA)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
postgresql_execute_print_output() {
|
||||
local -r db="${1:-}"
|
||||
local -r user="${2:-postgres}"
|
||||
local -r pass="${3:-}"
|
||||
local opts
|
||||
read -r -a opts <<<"${@:4}"
|
||||
|
||||
local args=("-U" "$user")
|
||||
[[ -n "$db" ]] && args+=("-d" "$db")
|
||||
[[ "${#opts[@]}" -gt 0 ]] && args+=("${opts[@]}")
|
||||
|
||||
# Obtain the command specified via stdin
|
||||
local sql_cmd
|
||||
sql_cmd="$(</dev/stdin)"
|
||||
debug "Executing SQL command:\n$sql_cmd"
|
||||
PGPASSWORD=$pass psql "${args[@]}" <<<"$sql_cmd"
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute an arbitrary query/queries against the running PostgreSQL service
|
||||
# Stdin:
|
||||
# Query/queries to execute
|
||||
# Globals:
|
||||
# BITNAMI_DEBUG
|
||||
# POSTGRESQL_*
|
||||
# Arguments:
|
||||
# $1 - Database where to run the queries
|
||||
# $2 - User to run queries
|
||||
# $3 - Password
|
||||
# $4 - Extra options (eg. -tA)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
postgresql_execute() {
|
||||
if [[ "${BITNAMI_DEBUG:-false}" = true ]]; then
|
||||
"postgresql_execute_print_output" "$@"
|
||||
elif [[ "${NO_ERRORS:-false}" = true ]]; then
|
||||
"postgresql_execute_print_output" "$@" 2>/dev/null
|
||||
else
|
||||
"postgresql_execute_print_output" "$@" >/dev/null 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute an arbitrary query/queries against a remote PostgreSQL service and print to stdout
|
||||
# Stdin:
|
||||
# Query/queries to execute
|
||||
# Globals:
|
||||
# BITNAMI_DEBUG
|
||||
# DB_*
|
||||
# Arguments:
|
||||
# $1 - Remote PostgreSQL service hostname
|
||||
# $2 - Remote PostgreSQL service port
|
||||
# $3 - Database where to run the queries
|
||||
# $4 - User to run queries
|
||||
# $5 - Password
|
||||
# $6 - Extra options (eg. -tA)
|
||||
# Returns:
|
||||
# None
|
||||
postgresql_remote_execute_print_output() {
|
||||
local -r hostname="${1:?hostname is required}"
|
||||
local -r port="${2:?port is required}"
|
||||
local -a args=("-h" "$hostname" "-p" "$port")
|
||||
shift 2
|
||||
"postgresql_execute_print_output" "$@" "${args[@]}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute an arbitrary query/queries against a remote PostgreSQL service
|
||||
# Stdin:
|
||||
# Query/queries to execute
|
||||
# Globals:
|
||||
# BITNAMI_DEBUG
|
||||
# DB_*
|
||||
# Arguments:
|
||||
# $1 - Remote PostgreSQL service hostname
|
||||
# $2 - Remote PostgreSQL service port
|
||||
# $3 - Database where to run the queries
|
||||
# $4 - User to run queries
|
||||
# $5 - Password
|
||||
# $6 - Extra options (eg. -tA)
|
||||
# Returns:
|
||||
# None
|
||||
postgresql_remote_execute() {
|
||||
if [[ "${BITNAMI_DEBUG:-false}" = true ]]; then
|
||||
"postgresql_remote_execute_print_output" "$@"
|
||||
elif [[ "${NO_ERRORS:-false}" = true ]]; then
|
||||
"postgresql_remote_execute_print_output" "$@" 2>/dev/null
|
||||
else
|
||||
"postgresql_remote_execute_print_output" "$@" >/dev/null 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Optionally create the given database user
|
||||
# Flags:
|
||||
# -p|--password - database password
|
||||
# --host - database host
|
||||
# --port - database port
|
||||
# Arguments:
|
||||
# $1 - user
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
postgresql_ensure_user_exists() {
|
||||
local -r user="${1:?user is missing}"
|
||||
local password=""
|
||||
# For accessing an external database
|
||||
local db_host=""
|
||||
local db_port=""
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-p | --password)
|
||||
shift
|
||||
password="${1:?missing password}"
|
||||
;;
|
||||
--host)
|
||||
shift
|
||||
db_host="${1:?missing database host}"
|
||||
;;
|
||||
--port)
|
||||
shift
|
||||
db_port="${1:?missing database port}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
local -a postgresql_execute_cmd=("postgresql_execute")
|
||||
[[ -n "$db_host" && -n "$db_port" ]] && postgresql_execute_cmd=("postgresql_remote_execute" "$db_host" "$db_port")
|
||||
local -a postgresql_execute_flags=("" "$(get_env_var_value POSTGRES_USER)" "$(get_env_var_value POSTGRES_PASSWORD)")
|
||||
|
||||
"${postgresql_execute_cmd[@]}" "${postgresql_execute_flags[@]}" <<EOF
|
||||
DO
|
||||
\$do\$
|
||||
BEGIN
|
||||
IF NOT EXISTS (
|
||||
SELECT FROM pg_catalog.pg_roles WHERE rolname = '${user}'
|
||||
) THEN
|
||||
CREATE ROLE "${user}" LOGIN PASSWORD '${password}';
|
||||
END IF;
|
||||
END
|
||||
\$do\$;
|
||||
EOF
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure a user has all privileges to access a database
|
||||
# Arguments:
|
||||
# $1 - database name
|
||||
# $2 - database user
|
||||
# $3 - database host (optional)
|
||||
# $4 - database port (optional)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
postgresql_ensure_user_has_database_privileges() {
|
||||
local -r user="${1:?user is required}"
|
||||
local -r database="${2:?db is required}"
|
||||
local -r db_host="${3:-}"
|
||||
local -r db_port="${4:-}"
|
||||
|
||||
local -a postgresql_execute_cmd=("postgresql_execute")
|
||||
[[ -n "$db_host" && -n "$db_port" ]] && postgresql_execute_cmd=("postgresql_remote_execute" "$db_host" "$db_port")
|
||||
local -a postgresql_execute_flags=("" "$(get_env_var_value POSTGRES_USER)" "$(get_env_var_value POSTGRES_PASSWORD)")
|
||||
|
||||
debug "Providing privileges to username ${user} on database ${database}"
|
||||
"${postgresql_execute_cmd[@]}" "${postgresql_execute_flags[@]}" <<EOF
|
||||
GRANT ALL PRIVILEGES ON DATABASE "${database}" TO "${user}";
|
||||
ALTER DATABASE "${database}" OWNER TO "${user}";
|
||||
EOF
|
||||
}
|
||||
|
||||
########################
|
||||
# Optionally create the given database, and then optionally give a user
|
||||
# full privileges on the database.
|
||||
# Flags:
|
||||
# -u|--user - database user
|
||||
# --host - database host
|
||||
# --port - database port
|
||||
# Arguments:
|
||||
# $1 - database name
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
postgresql_ensure_database_exists() {
|
||||
local -r database="${1:?database is missing}"
|
||||
local user=""
|
||||
# For accessing an external database
|
||||
local db_host=""
|
||||
local db_port=""
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-u | --user)
|
||||
shift
|
||||
user="${1:?missing database user}"
|
||||
;;
|
||||
--host)
|
||||
shift
|
||||
db_host="${1:?missing database host}"
|
||||
;;
|
||||
--port)
|
||||
shift
|
||||
db_port="${1:?missing database port}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
local -a postgresql_execute_cmd=("postgresql_execute")
|
||||
[[ -n "$db_host" && -n "$db_port" ]] && postgresql_execute_cmd=("postgresql_remote_execute" "$db_host" "$db_port")
|
||||
local -a postgresql_execute_flags=("" "$(get_env_var_value POSTGRES_USER)" "$(get_env_var_value POSTGRES_PASSWORD)")
|
||||
|
||||
"${postgresql_execute_cmd[@]}" "${postgresql_execute_flags[@]}" <<EOF
|
||||
SELECT 'CREATE DATABASE "${database}"'
|
||||
WHERE NOT EXISTS (SELECT FROM pg_database WHERE datname = '${database}')\gexec
|
||||
EOF
|
||||
if [[ -n "$user" ]]; then
|
||||
local -a grant_flags=("$user" "$database")
|
||||
[[ -n "$db_host" ]] && grant_flags+=("$db_host")
|
||||
[[ -n "$db_port" ]] && grant_flags+=("$db_port")
|
||||
postgresql_ensure_user_has_database_privileges "${grant_flags[@]}"
|
||||
fi
|
||||
}
|
||||
@@ -0,0 +1,370 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Bitnami SonarQube library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load generic libraries
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/libnet.sh
|
||||
. /opt/bitnami/scripts/libfile.sh
|
||||
. /opt/bitnami/scripts/libvalidations.sh
|
||||
. /opt/bitnami/scripts/libpersistence.sh
|
||||
. /opt/bitnami/scripts/libservice.sh
|
||||
|
||||
# Load database library
|
||||
if [[ -f /opt/bitnami/scripts/libpostgresqlclient.sh ]]; then
|
||||
. /opt/bitnami/scripts/libpostgresqlclient.sh
|
||||
elif [[ -f /opt/bitnami/scripts/libpostgresql.sh ]]; then
|
||||
. /opt/bitnami/scripts/libpostgresql.sh
|
||||
fi
|
||||
|
||||
########################
|
||||
# Validate settings in SONARQUBE_* env vars
|
||||
# Globals:
|
||||
# SONARQUBE_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# 0 if the validation succeeded, 1 otherwise
|
||||
#########################
|
||||
sonarqube_validate() {
|
||||
debug "Validating settings in SONARQUBE_* environment variables..."
|
||||
local error_code=0
|
||||
|
||||
# Auxiliary functions
|
||||
print_validation_error() {
|
||||
error "$1"
|
||||
error_code=1
|
||||
}
|
||||
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_multi_value() {
|
||||
if [[ " ${2} " != *" ${!1} "* ]]; then
|
||||
print_validation_error "The allowed values for ${1} are: ${2}"
|
||||
fi
|
||||
}
|
||||
check_resolved_hostname() {
|
||||
if ! is_hostname_resolved "$1"; then
|
||||
warn "Hostname ${1} could not be resolved, this could lead to connection issues"
|
||||
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
|
||||
}
|
||||
|
||||
# Validate user inputs
|
||||
check_yes_no_value "SONARQUBE_SKIP_BOOTSTRAP"
|
||||
check_valid_port "SONARQUBE_PORT_NUMBER"
|
||||
check_valid_port "SONARQUBE_ELASTICSEARCH_PORT_NUMBER"
|
||||
! is_empty_value "$SONARQUBE_DATABASE_HOST" && check_resolved_hostname "$SONARQUBE_DATABASE_HOST"
|
||||
! is_empty_value "$SONARQUBE_DATABASE_PORT_NUMBER" && check_valid_port "SONARQUBE_DATABASE_PORT_NUMBER"
|
||||
|
||||
# Validate credentials
|
||||
if is_boolean_yes "${ALLOW_EMPTY_PASSWORD:-}"; then
|
||||
warn "You set the environment variable ALLOW_EMPTY_PASSWORD=${ALLOW_EMPTY_PASSWORD:-}. For safety reasons, do not use this flag in a production environment."
|
||||
else
|
||||
for empty_env_var in "SONARQUBE_DATABASE_PASSWORD" "SONARQUBE_PASSWORD"; do
|
||||
is_empty_value "${!empty_env_var}" && print_validation_error "The ${empty_env_var} environment variable is empty or not set. Set the environment variable ALLOW_EMPTY_PASSWORD=yes to allow a blank password. This is only recommended for development environments."
|
||||
done
|
||||
fi
|
||||
|
||||
# Validate SMTP credentials
|
||||
if ! is_empty_value "$SONARQUBE_SMTP_HOST"; then
|
||||
for empty_env_var in "SONARQUBE_SMTP_USER" "SONARQUBE_SMTP_PASSWORD"; do
|
||||
is_empty_value "${!empty_env_var}" && warn "The ${empty_env_var} environment variable is empty or not set."
|
||||
done
|
||||
is_empty_value "$SONARQUBE_SMTP_PORT_NUMBER" && print_validation_error "The SONARQUBE_SMTP_PORT_NUMBER environment variable is empty or not set."
|
||||
! is_empty_value "$SONARQUBE_SMTP_PORT_NUMBER" && check_valid_port "SONARQUBE_SMTP_PORT_NUMBER"
|
||||
! is_empty_value "$SONARQUBE_SMTP_PROTOCOL" && check_multi_value "SONARQUBE_SMTP_PROTOCOL" "ssl tls"
|
||||
fi
|
||||
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure SonarQube is initialized
|
||||
# Globals:
|
||||
# SONARQUBE_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
sonarqube_initialize() {
|
||||
local -a postgresql_execute_args=("$SONARQUBE_DATABASE_HOST" "$SONARQUBE_DATABASE_PORT_NUMBER" "$SONARQUBE_DATABASE_NAME" "$SONARQUBE_DATABASE_USER" "$SONARQUBE_DATABASE_PASSWORD")
|
||||
|
||||
# Based on https://github.com/SonarSource/sonarqube/blob/master/sonar-application/src/main/assembly/conf/sonar.properties
|
||||
info "Creating SonarQube configuration"
|
||||
# Database configuration
|
||||
sonarqube_conf_set "sonar.jdbc.username" "$SONARQUBE_DATABASE_USER"
|
||||
sonarqube_conf_set "sonar.jdbc.password" "$SONARQUBE_DATABASE_PASSWORD"
|
||||
# SonarQube includes multiple examples of JDBC configuration, but we want to set it in the PostgreSQL section
|
||||
local jdbc_url="jdbc:postgresql://${SONARQUBE_DATABASE_HOST}:${SONARQUBE_DATABASE_PORT_NUMBER}/${SONARQUBE_DATABASE_NAME}"
|
||||
replace_in_file "$SONARQUBE_CONF_FILE" "^#sonar.jdbc.url=jdbc:postgresql.*" "sonar.jdbc.url=${jdbc_url}"
|
||||
# Web server parameters (NOTE: Avoid exposing SonarQube)
|
||||
sonarqube_conf_set "sonar.web.port" "$SONARQUBE_PORT_NUMBER"
|
||||
sonarqube_conf_set "sonar.web.host" "127.0.0.1"
|
||||
# Search server parameters (NOTE: Elasticsearch is bundled within SonarQube)
|
||||
sonarqube_conf_set "sonar.search.port" "$SONARQUBE_ELASTICSEARCH_PORT_NUMBER"
|
||||
sonarqube_conf_set "sonar.search.host" "127.0.0.1"
|
||||
# Java additional opts
|
||||
! is_empty_value "$SONARQUBE_CE_JAVA_ADD_OPTS" && sonarqube_conf_set "sonar.ce.javaAdditionalOpts" "$SONARQUBE_CE_JAVA_ADD_OPTS"
|
||||
! is_empty_value "$SONARQUBE_ELASTICSEARCH_JAVA_ADD_OPTS" && sonarqube_conf_set "sonar.search.javaAdditionalOpts" "$SONARQUBE_ELASTICSEARCH_JAVA_ADD_OPTS"
|
||||
! is_empty_value "$SONARQUBE_WEB_JAVA_ADD_OPTS" && sonarqube_conf_set "sonar.web.javaAdditionalOpts" "$SONARQUBE_WEB_JAVA_ADD_OPTS"
|
||||
# Disable log rotation (to be handled externally)
|
||||
sonarqube_conf_set "sonar.log.rollingPolicy" "none"
|
||||
# Additional properties
|
||||
local -a additional_properties
|
||||
IFS=',' read -r -a additional_properties <<< "$SONARQUBE_EXTRA_PROPERTIES"
|
||||
if [[ "${#additional_properties[@]}" -gt 0 ]]; then
|
||||
info "Adding properties provided via SONARQUBE_EXTRA_PROPERTIES to sonar.properties"
|
||||
for property in "${additional_properties[@]}"; do
|
||||
sonar_conf_set "${property%=*}" "${property#*=}"
|
||||
done
|
||||
fi
|
||||
|
||||
info "Trying to connect to the database server"
|
||||
sonarqube_wait_for_postgresql_connection "${postgresql_execute_args[@]}"
|
||||
|
||||
# Check if SonarQube has already been initialized and persisted in a previous run
|
||||
local -r app_name="sonarqube"
|
||||
if ! is_app_initialized "$app_name"; then
|
||||
# Ensure SonarQube persisted directories exist (i.e. when a volume has been mounted to /bitnami)
|
||||
info "Ensuring SonarQube directories exist"
|
||||
ensure_dir_exists "$SONARQUBE_VOLUME_DIR"
|
||||
# Use daemon:root ownership for compatibility when running as a non-root user
|
||||
am_i_root && configure_permissions_ownership "$SONARQUBE_VOLUME_DIR" -d "775" -f "664" -u "$SONARQUBE_DAEMON_USER" -g "root"
|
||||
|
||||
# Start SonarQube to initialize database, in order to be able to update users
|
||||
sonarqube_start_bg
|
||||
|
||||
if ! is_boolean_yes "$SONARQUBE_SKIP_BOOTSTRAP"; then
|
||||
# Unfortunately SonarQube does not provide a CLI to perform actions like enabling authentication or to reset credentials
|
||||
|
||||
# Pasword hashing algorithm defined in https://github.com/SonarSource/sonarqube/blob/master/server/sonar-webserver-auth/src/main/java/org/sonar/server/authentication/CredentialsLocalAuthentication.java#L191
|
||||
# Note: As of version 8.6, admin user account is forced to reset the password, we disable this behavior with 'reset_password=f'
|
||||
info "Configuring user credentials"
|
||||
local salt encrypted_password
|
||||
salt="$(generate_random_string -t alphanumeric -c 40)"
|
||||
encrypted_password="$(generate_sha_hash "--${salt}--${SONARQUBE_PASSWORD}--")"
|
||||
postgresql_remote_execute "${postgresql_execute_args[@]}" <<EOF
|
||||
UPDATE users SET login = '${SONARQUBE_USERNAME}', email = '${SONARQUBE_EMAIL}', salt = '${salt}', crypted_password = '${encrypted_password}', hash_method = 'SHA1', reset_password = 'f' WHERE login = 'admin';
|
||||
EOF
|
||||
|
||||
# SMTP configuration
|
||||
# Based on https://github.com/SonarSource/sonarqube/blob/master/sonar-plugin-api/src/main/java/org/sonar/api/config/EmailSettings.java#L39
|
||||
if ! is_empty_value "$SONARQUBE_SMTP_HOST"; then
|
||||
info "Configuring SMTP"
|
||||
local -a settings_to_update+=("email.smtp_host.secured=${SONARQUBE_SMTP_HOST}")
|
||||
! is_empty_value "$SONARQUBE_SMTP_PORT_NUMBER" && settings_to_update+=("email.smtp_port.secured=${SONARQUBE_SMTP_PORT_NUMBER}")
|
||||
! is_empty_value "$SONARQUBE_SMTP_USER" && settings_to_update+=("email.smtp_username.secured=${SONARQUBE_SMTP_USER}")
|
||||
! is_empty_value "$SONARQUBE_SMTP_PASSWORD" && settings_to_update+=("email.smtp_password.secured=${SONARQUBE_SMTP_PASSWORD}")
|
||||
[[ "$SONARQUBE_SMTP_PROTOCOL" = "ssl" || "$SONARQUBE_SMTP_PROTOCOL" = "tls" ]] && settings_to_update+=("email.smtp_secure_connection.secured=starttls")
|
||||
local unix_timestamp_ms
|
||||
unix_timestamp_ms="$(date '+%s%N' | cut -b1-13)"
|
||||
for setting in "${settings_to_update[@]}"; do
|
||||
postgresql_remote_execute "${postgresql_execute_args[@]}" <<EOF
|
||||
INSERT INTO properties (uuid, prop_key, is_empty, text_value, created_at) VALUES ('$(generate_random_string -t alphanumeric -c 20)', '${setting%=*}', '0', '${setting#*=}', '${unix_timestamp_ms}');
|
||||
EOF
|
||||
done
|
||||
fi
|
||||
else
|
||||
info "An already initialized SonarQube database was provided, configuration will be skipped"
|
||||
fi
|
||||
|
||||
info "Stopping SonarQube"
|
||||
sonarqube_stop
|
||||
|
||||
info "Persisting SonarQube installation"
|
||||
persist_app "$app_name" "$SONARQUBE_DATA_TO_PERSIST"
|
||||
else
|
||||
info "Restoring persisted SonarQube installation"
|
||||
restore_persisted_app "$app_name" "$SONARQUBE_DATA_TO_PERSIST"
|
||||
fi
|
||||
|
||||
# At this point it is safe to expose SonarQube publicly
|
||||
sonarqube_conf_set "sonar.web.host" "0.0.0.0"
|
||||
sonarqube_conf_set "sonar.web.context" "$SONARQUBE_WEB_CONTEXT"
|
||||
|
||||
# Also configure memory options at this point, to avoid any possible issues during initialization
|
||||
if ! is_empty_value "$SONARQUBE_MAX_HEAP_SIZE" && ! is_empty_value "$SONARQUBE_MIN_HEAP_SIZE"; then
|
||||
sonarqube_set_heap_size "$SONARQUBE_MAX_HEAP_SIZE" "$SONARQUBE_MIN_HEAP_SIZE"
|
||||
fi
|
||||
|
||||
# Avoid exit code of previous commands to affect the result of this function
|
||||
true
|
||||
}
|
||||
|
||||
########################
|
||||
# Start SonarQube in background
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
sonarqube_start_bg() {
|
||||
is_sonarqube_running && return
|
||||
|
||||
info "Starting SonarQube in background"
|
||||
(
|
||||
cd "$SONARQUBE_BASE_DIR" || return 1
|
||||
if am_i_root; then
|
||||
debug_execute gosu "$SONARQUBE_DAEMON_USER" "${SONARQUBE_BIN_DIR}/sonar.sh" "start"
|
||||
else
|
||||
debug_execute "${SONARQUBE_BIN_DIR}/sonar.sh" "start"
|
||||
fi
|
||||
info "Waiting for SonarQube to start..."
|
||||
wait_for_log_entry "SonarQube is up" "$SONARQUBE_LOG_FILE" "$SONARQUBE_START_TIMEOUT" "1"
|
||||
)
|
||||
}
|
||||
|
||||
########################
|
||||
# Add or modify an entry in the SonarQube configuration file
|
||||
# Globals:
|
||||
# SONARQUBE_*
|
||||
# Arguments:
|
||||
# $1 - Variable name
|
||||
# $2 - Value to assign to the variable
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
sonarqube_conf_set() {
|
||||
local -r key="${1:?key missing}"
|
||||
local -r value="${2:-}"
|
||||
debug "Setting ${key} to '${value}' in SonarQube configuration"
|
||||
# Sanitize key (sed does not support fixed string substitutions)
|
||||
local sanitized_pattern
|
||||
sanitized_pattern="^\s*(#\s*)?$(sed 's/[]\[^$.*/]/\\&/g' <<< "$key")\s*=.*"
|
||||
local entry="${key}=${value}"
|
||||
# Check if the configuration exists in the file
|
||||
if grep -q -E "$sanitized_pattern" "$SONARQUBE_CONF_FILE"; then
|
||||
# It exists, so replace the line
|
||||
replace_in_file "$SONARQUBE_CONF_FILE" "$sanitized_pattern" "$entry"
|
||||
else
|
||||
# It doesn't exist, so append to the end of the file
|
||||
cat >> "$SONARQUBE_CONF_FILE" <<< "$entry"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Configure SonarQube heap size
|
||||
# Globals:
|
||||
# SONARQUBE_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
sonarqube_set_heap_size() {
|
||||
local max="${1:?max heap size value missing}"
|
||||
local min="${2:?min heap size value missing}"
|
||||
info "Setting heap size to -Xmx${max} -Xms${min}"
|
||||
sonarqube_conf_set "sonar.ce.javaOpts" "-Xmx${max} -Xms${min} -XX:+HeapDumpOnOutOfMemoryError"
|
||||
sonarqube_conf_set "sonar.web.javaOpts" "-Xmx${max} -Xms${min} -XX:+HeapDumpOnOutOfMemoryError"
|
||||
# It is recommended to configure the heap size for Elasticsearch to the same value (in this case, to the max value)
|
||||
sonarqube_conf_set "sonar.search.javaOpts" "-Xmx${max} -Xms${max} -XX:+HeapDumpOnOutOfMemoryError"
|
||||
}
|
||||
|
||||
########################
|
||||
# Get an entry from the SonarQube configuration file
|
||||
# Globals:
|
||||
# SONARQUBE_*
|
||||
# Arguments:
|
||||
# $1 - Variable name
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
sonarqube_conf_get() {
|
||||
local -r key="${1:?key missing}"
|
||||
debug "Getting ${key} from SonarQube configuration"
|
||||
# Sanitize key (sed does not support fixed string substitutions)
|
||||
local sanitized_pattern
|
||||
sanitized_pattern="^\s*(#\s*)?$(sed 's/[]\[^$.*/]/\\&/g' <<< "$key")\s*=([^;]+);"
|
||||
grep -E "$sanitized_pattern" "$SONARQUBE_CONF_FILE" | sed -E "s|${sanitized_pattern}|\2|" | tr -d "\"' "
|
||||
}
|
||||
|
||||
########################
|
||||
# Wait until the database is accessible with the currently-known credentials
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - database host
|
||||
# $2 - database port
|
||||
# $3 - database name
|
||||
# $4 - database username
|
||||
# $5 - database user password (optional)
|
||||
# Returns:
|
||||
# true if the database connection succeeded, false otherwise
|
||||
#########################
|
||||
sonarqube_wait_for_postgresql_connection() {
|
||||
local -r db_host="${1:?missing database host}"
|
||||
local -r db_port="${2:?missing database port}"
|
||||
local -r db_name="${3:?missing database name}"
|
||||
local -r db_user="${4:?missing database user}"
|
||||
local -r db_pass="${5:-}"
|
||||
check_postgresql_connection() {
|
||||
echo "SELECT 1" | postgresql_remote_execute "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
}
|
||||
if ! retry_while "check_postgresql_connection"; then
|
||||
error "Could not connect to the database"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if SonarQube is running
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_sonarqube_running() {
|
||||
# The 'sonar.sh status' command checks whether the PID file exists, and a process exists with that PID
|
||||
# That way we do not need to re-implement such logic
|
||||
if am_i_root; then
|
||||
debug_execute gosu "$SONARQUBE_DAEMON_USER" "${SONARQUBE_BIN_DIR}/sonar.sh" "status"
|
||||
else
|
||||
debug_execute "${SONARQUBE_BIN_DIR}/sonar.sh" "status"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if SonarQube is not running
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_sonarqube_not_running() {
|
||||
! is_sonarqube_running
|
||||
}
|
||||
|
||||
########################
|
||||
# Stop SonarQube
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
sonarqube_stop() {
|
||||
! is_sonarqube_running && return
|
||||
if am_i_root; then
|
||||
debug_execute gosu "$SONARQUBE_DAEMON_USER" "${SONARQUBE_BIN_DIR}/sonar.sh" "stop"
|
||||
else
|
||||
debug_execute "${SONARQUBE_BIN_DIR}/sonar.sh" "stop"
|
||||
fi
|
||||
}
|
||||
@@ -0,0 +1,81 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Environment configuration for postgresql-client
|
||||
|
||||
# The values for all environment variables will be set in the below order of precedence
|
||||
# 1. Custom environment variables defined below after Bitnami defaults
|
||||
# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR
|
||||
# 3. Environment variables overridden via external files using *_FILE variables (see below)
|
||||
# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata)
|
||||
|
||||
# Load logging library
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||
|
||||
# Logging configuration
|
||||
export MODULE="${MODULE:-postgresql-client}"
|
||||
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
|
||||
postgresql_client_env_vars=(
|
||||
ALLOW_EMPTY_PASSWORD
|
||||
POSTGRESQL_CLIENT_DATABASE_HOST
|
||||
POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER
|
||||
POSTGRESQL_CLIENT_POSTGRES_USER
|
||||
POSTGRESQL_CLIENT_POSTGRES_PASSWORD
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_NAME
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS
|
||||
POSTGRESQL_HOST
|
||||
POSTGRESQL_PORT_NUMBER
|
||||
POSTGRESQL_CLIENT_ROOT_USER
|
||||
POSTGRESQL_POSTGRES_USER
|
||||
POSTGRESQL_ROOT_USER
|
||||
POSTGRESQL_CLIENT_ROOT_PASSWORD
|
||||
POSTGRESQL_POSTGRES_PASSWORD
|
||||
POSTGRESQL_ROOT_PASSWORD
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_USER
|
||||
)
|
||||
for env_var in "${postgresql_client_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 postgresql_client_env_vars
|
||||
|
||||
# Paths
|
||||
export POSTGRESQL_BASE_DIR="/opt/bitnami/postgresql"
|
||||
export POSTGRESQL_BIN_DIR="$POSTGRESQL_BASE_DIR/bin"
|
||||
export PATH="${POSTGRESQL_BIN_DIR}:${PATH}"
|
||||
|
||||
# PostgreSQL settings
|
||||
export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}"
|
||||
POSTGRESQL_CLIENT_DATABASE_HOST="${POSTGRESQL_CLIENT_DATABASE_HOST:-"${POSTGRESQL_HOST:-}"}"
|
||||
export POSTGRESQL_CLIENT_DATABASE_HOST="${POSTGRESQL_CLIENT_DATABASE_HOST:-postgresql}"
|
||||
POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER="${POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER:-"${POSTGRESQL_PORT_NUMBER:-}"}"
|
||||
export POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER="${POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER:-5432}"
|
||||
POSTGRESQL_CLIENT_POSTGRES_USER="${POSTGRESQL_CLIENT_POSTGRES_USER:-"${POSTGRESQL_CLIENT_ROOT_USER:-}"}"
|
||||
POSTGRESQL_CLIENT_POSTGRES_USER="${POSTGRESQL_CLIENT_POSTGRES_USER:-"${POSTGRESQL_POSTGRES_USER:-}"}"
|
||||
POSTGRESQL_CLIENT_POSTGRES_USER="${POSTGRESQL_CLIENT_POSTGRES_USER:-"${POSTGRESQL_ROOT_USER:-}"}"
|
||||
export POSTGRESQL_CLIENT_POSTGRES_USER="${POSTGRESQL_CLIENT_POSTGRES_USER:-postgres}" # only used during the first initialization
|
||||
POSTGRESQL_CLIENT_POSTGRES_PASSWORD="${POSTGRESQL_CLIENT_POSTGRES_PASSWORD:-"${POSTGRESQL_CLIENT_ROOT_PASSWORD:-}"}"
|
||||
POSTGRESQL_CLIENT_POSTGRES_PASSWORD="${POSTGRESQL_CLIENT_POSTGRES_PASSWORD:-"${POSTGRESQL_POSTGRES_PASSWORD:-}"}"
|
||||
POSTGRESQL_CLIENT_POSTGRES_PASSWORD="${POSTGRESQL_CLIENT_POSTGRES_PASSWORD:-"${POSTGRESQL_ROOT_PASSWORD:-}"}"
|
||||
export POSTGRESQL_CLIENT_POSTGRES_PASSWORD="${POSTGRESQL_CLIENT_POSTGRES_PASSWORD:-}" # only used during the first initialization
|
||||
export POSTGRESQL_CLIENT_CREATE_DATABASE_NAME="${POSTGRESQL_CLIENT_CREATE_DATABASE_NAME:-}" # only used during the first initialization
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME="${POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME:-"${POSTGRESQL_CLIENT_CREATE_DATABASE_USER:-}"}"
|
||||
export POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME="${POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME:-}" # only used during the first initialization
|
||||
export POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD="${POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD:-}" # only used during the first initialization
|
||||
export POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS="${POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS:-}" # only used during the first initialization
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
@@ -0,0 +1,19 @@
|
||||
#!/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/libpostgresqlclient.sh
|
||||
|
||||
# Load PostgreSQL Client environment variables
|
||||
. /opt/bitnami/scripts/postgresql-client-env.sh
|
||||
|
||||
# Ensure PostgreSQL Client environment variables settings are valid
|
||||
postgresql_client_validate
|
||||
# Ensure PostgreSQL Client is initialized
|
||||
postgresql_client_initialize
|
||||
@@ -0,0 +1,142 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Environment configuration for sonarqube
|
||||
|
||||
# The values for all environment variables will be set in the below order of precedence
|
||||
# 1. Custom environment variables defined below after Bitnami defaults
|
||||
# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR
|
||||
# 3. Environment variables overridden via external files using *_FILE variables (see below)
|
||||
# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata)
|
||||
|
||||
# Load logging library
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||
|
||||
# Logging configuration
|
||||
export MODULE="${MODULE:-sonarqube}"
|
||||
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
|
||||
sonarqube_env_vars=(
|
||||
SONARQUBE_DATA_TO_PERSIST
|
||||
SONARQUBE_PORT_NUMBER
|
||||
SONARQUBE_ELASTICSEARCH_PORT_NUMBER
|
||||
SONARQUBE_START_TIMEOUT
|
||||
SONARQUBE_SKIP_BOOTSTRAP
|
||||
SONARQUBE_WEB_CONTEXT
|
||||
SONARQUBE_MAX_HEAP_SIZE
|
||||
SONARQUBE_MIN_HEAP_SIZE
|
||||
SONARQUBE_CE_JAVA_ADD_OPTS
|
||||
SONARQUBE_ELASTICSEARCH_JAVA_ADD_OPTS
|
||||
SONARQUBE_WEB_JAVA_ADD_OPTS
|
||||
SONARQUBE_EXTRA_PROPERTIES
|
||||
SONARQUBE_USERNAME
|
||||
SONARQUBE_PASSWORD
|
||||
SONARQUBE_EMAIL
|
||||
SONARQUBE_SMTP_HOST
|
||||
SONARQUBE_SMTP_PORT_NUMBER
|
||||
SONARQUBE_SMTP_USER
|
||||
SONARQUBE_SMTP_PASSWORD
|
||||
SONARQUBE_SMTP_PROTOCOL
|
||||
SONARQUBE_DATABASE_HOST
|
||||
SONARQUBE_DATABASE_PORT_NUMBER
|
||||
SONARQUBE_DATABASE_NAME
|
||||
SONARQUBE_DATABASE_USER
|
||||
SONARQUBE_DATABASE_PASSWORD
|
||||
SONARQUBE_PROPERTIES
|
||||
SMTP_HOST
|
||||
SMTP_PORT
|
||||
SONARQUBE_SMTP_PORT
|
||||
SMTP_USER
|
||||
SMTP_PASSWORD
|
||||
SMTP_PROTOCOL
|
||||
POSTGRESQL_HOST
|
||||
POSTGRESQL_PORT_NUMBER
|
||||
POSTGRESQL_DATABASE_NAME
|
||||
POSTGRESQL_DATABASE_USER
|
||||
POSTGRESQL_DATABASE_USERNAME
|
||||
POSTGRESQL_DATABASE_PASSWORD
|
||||
)
|
||||
for env_var in "${sonarqube_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 sonarqube_env_vars
|
||||
|
||||
# Paths
|
||||
export SONARQUBE_BASE_DIR="${BITNAMI_ROOT_DIR}/sonarqube"
|
||||
export SONARQUBE_DATA_DIR="${SONARQUBE_BASE_DIR}/data"
|
||||
export SONARQUBE_EXTENSIONS_DIR="${SONARQUBE_BASE_DIR}/extensions"
|
||||
export SONARQUBE_CONF_DIR="${SONARQUBE_BASE_DIR}/conf"
|
||||
export SONARQUBE_CONF_FILE="${SONARQUBE_CONF_DIR}/sonar.properties"
|
||||
export SONARQUBE_LOGS_DIR="${SONARQUBE_BASE_DIR}/logs"
|
||||
export SONARQUBE_LOG_FILE="${SONARQUBE_LOGS_DIR}/sonar.log"
|
||||
export SONARQUBE_TMP_DIR="${SONARQUBE_BASE_DIR}/temp"
|
||||
export SONARQUBE_PID_FILE="${SONARQUBE_BASE_DIR}/pids/SonarQube.pid"
|
||||
export SONARQUBE_BIN_DIR="${SONARQUBE_BASE_DIR}/bin/linux-x86-64"
|
||||
|
||||
# SonarQube persistence configuration
|
||||
export SONARQUBE_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/sonarqube"
|
||||
export SONARQUBE_DATA_TO_PERSIST="${SONARQUBE_DATA_TO_PERSIST:-${SONARQUBE_DATA_DIR} ${SONARQUBE_EXTENSIONS_DIR}}"
|
||||
|
||||
# System users (when running with a privileged user)
|
||||
export SONARQUBE_DAEMON_USER="sonarqube"
|
||||
export SONARQUBE_DAEMON_GROUP="sonarqube"
|
||||
|
||||
# SonarQube configuration
|
||||
export SONARQUBE_PORT_NUMBER="${SONARQUBE_PORT_NUMBER:-9000}"
|
||||
export SONARQUBE_ELASTICSEARCH_PORT_NUMBER="${SONARQUBE_ELASTICSEARCH_PORT_NUMBER:-9001}"
|
||||
export SONARQUBE_START_TIMEOUT="${SONARQUBE_START_TIMEOUT:-300}" # only used during the first initialization
|
||||
export SONARQUBE_SKIP_BOOTSTRAP="${SONARQUBE_SKIP_BOOTSTRAP:-no}" # only used during the first initialization
|
||||
export SONARQUBE_WEB_CONTEXT="${SONARQUBE_WEB_CONTEXT:-/}"
|
||||
export SONARQUBE_MAX_HEAP_SIZE="${SONARQUBE_MAX_HEAP_SIZE:-}"
|
||||
export SONARQUBE_MIN_HEAP_SIZE="${SONARQUBE_MIN_HEAP_SIZE:-}"
|
||||
export SONARQUBE_CE_JAVA_ADD_OPTS="${SONARQUBE_CE_JAVA_ADD_OPTS:-}"
|
||||
export SONARQUBE_ELASTICSEARCH_JAVA_ADD_OPTS="${SONARQUBE_ELASTICSEARCH_JAVA_ADD_OPTS:-}"
|
||||
export SONARQUBE_WEB_JAVA_ADD_OPTS="${SONARQUBE_WEB_JAVA_ADD_OPTS:-}"
|
||||
SONARQUBE_EXTRA_PROPERTIES="${SONARQUBE_EXTRA_PROPERTIES:-"${SONARQUBE_PROPERTIES:-}"}"
|
||||
export SONARQUBE_EXTRA_PROPERTIES="${SONARQUBE_EXTRA_PROPERTIES:-}"
|
||||
|
||||
# SonarQube credentials
|
||||
export SONARQUBE_USERNAME="${SONARQUBE_USERNAME:-admin}" # only used during the first initialization
|
||||
export SONARQUBE_PASSWORD="${SONARQUBE_PASSWORD:-bitnami}" # only used during the first initialization
|
||||
export SONARQUBE_EMAIL="${SONARQUBE_EMAIL:-user@example.com}" # only used during the first initialization
|
||||
|
||||
# SonarQube SMTP credentials
|
||||
SONARQUBE_SMTP_HOST="${SONARQUBE_SMTP_HOST:-"${SMTP_HOST:-}"}"
|
||||
export SONARQUBE_SMTP_HOST="${SONARQUBE_SMTP_HOST:-}" # only used during the first initialization
|
||||
SONARQUBE_SMTP_PORT_NUMBER="${SONARQUBE_SMTP_PORT_NUMBER:-"${SMTP_PORT:-}"}"
|
||||
SONARQUBE_SMTP_PORT_NUMBER="${SONARQUBE_SMTP_PORT_NUMBER:-"${SONARQUBE_SMTP_PORT:-}"}"
|
||||
export SONARQUBE_SMTP_PORT_NUMBER="${SONARQUBE_SMTP_PORT_NUMBER:-}" # only used during the first initialization
|
||||
SONARQUBE_SMTP_USER="${SONARQUBE_SMTP_USER:-"${SMTP_USER:-}"}"
|
||||
export SONARQUBE_SMTP_USER="${SONARQUBE_SMTP_USER:-}" # only used during the first initialization
|
||||
SONARQUBE_SMTP_PASSWORD="${SONARQUBE_SMTP_PASSWORD:-"${SMTP_PASSWORD:-}"}"
|
||||
export SONARQUBE_SMTP_PASSWORD="${SONARQUBE_SMTP_PASSWORD:-}" # only used during the first initialization
|
||||
SONARQUBE_SMTP_PROTOCOL="${SONARQUBE_SMTP_PROTOCOL:-"${SMTP_PROTOCOL:-}"}"
|
||||
export SONARQUBE_SMTP_PROTOCOL="${SONARQUBE_SMTP_PROTOCOL:-}" # only used during the first initialization
|
||||
|
||||
# Database configuration
|
||||
export SONARQUBE_DEFAULT_DATABASE_HOST="postgresql" # only used at build time
|
||||
SONARQUBE_DATABASE_HOST="${SONARQUBE_DATABASE_HOST:-"${POSTGRESQL_HOST:-}"}"
|
||||
export SONARQUBE_DATABASE_HOST="${SONARQUBE_DATABASE_HOST:-$SONARQUBE_DEFAULT_DATABASE_HOST}" # only used during the first initialization
|
||||
SONARQUBE_DATABASE_PORT_NUMBER="${SONARQUBE_DATABASE_PORT_NUMBER:-"${POSTGRESQL_PORT_NUMBER:-}"}"
|
||||
export SONARQUBE_DATABASE_PORT_NUMBER="${SONARQUBE_DATABASE_PORT_NUMBER:-5432}" # only used during the first initialization
|
||||
SONARQUBE_DATABASE_NAME="${SONARQUBE_DATABASE_NAME:-"${POSTGRESQL_DATABASE_NAME:-}"}"
|
||||
export SONARQUBE_DATABASE_NAME="${SONARQUBE_DATABASE_NAME:-bitnami_sonarqube}" # only used during the first initialization
|
||||
SONARQUBE_DATABASE_USER="${SONARQUBE_DATABASE_USER:-"${POSTGRESQL_DATABASE_USER:-}"}"
|
||||
SONARQUBE_DATABASE_USER="${SONARQUBE_DATABASE_USER:-"${POSTGRESQL_DATABASE_USERNAME:-}"}"
|
||||
export SONARQUBE_DATABASE_USER="${SONARQUBE_DATABASE_USER:-bn_sonarqube}" # only used during the first initialization
|
||||
SONARQUBE_DATABASE_PASSWORD="${SONARQUBE_DATABASE_PASSWORD:-"${POSTGRESQL_DATABASE_PASSWORD:-}"}"
|
||||
export SONARQUBE_DATABASE_PASSWORD="${SONARQUBE_DATABASE_PASSWORD:-}" # only used during the first initialization
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
@@ -0,0 +1,27 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purpose
|
||||
|
||||
# Load SonarQube environment
|
||||
. /opt/bitnami/scripts/sonarqube-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libbitnami.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
print_welcome_page
|
||||
|
||||
if [[ "$1" = "/opt/bitnami/scripts/sonarqube/run.sh" ]]; then
|
||||
/opt/bitnami/scripts/postgresql-client/setup.sh
|
||||
/opt/bitnami/scripts/sonarqube/setup.sh
|
||||
/post-init.sh
|
||||
info "** SonarQube setup finished! **"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
exec "$@"
|
||||
@@ -0,0 +1,42 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purpose
|
||||
|
||||
# Load SonarQube environment
|
||||
. /opt/bitnami/scripts/sonarqube-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libsonarqube.sh
|
||||
. /opt/bitnami/scripts/libfile.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
info "Updating PID files location"
|
||||
replace_in_file "${SONARQUBE_BIN_DIR}/sonar.sh" "PIDDIR=\"\.\"" "PIDDIR=\"../../pids\""
|
||||
|
||||
info "Updating log file location"
|
||||
replace_in_file "${SONARQUBE_CONF_DIR}/wrapper.conf" "\.\./\.\./sonar\.YYYYMMDD\.log" "../../sonar.log"
|
||||
|
||||
# Log rotation will be handled externally
|
||||
# Refer to "Log Rotation" section in https://docs.sonarqube.org/latest/instance-administration/system-info/
|
||||
info "Disabling log rolling"
|
||||
replace_in_file "${SONARQUBE_CONF_DIR}/wrapper.conf" "^[#\s]*wrapper.logfile.rollmode\s*=.*" "wrapper.logfile.rollmode=NONE"
|
||||
|
||||
# Ensure the SonarQube base directory exists and has proper permissions
|
||||
# Based on https://github.com/SonarSource/docker-sonarqube/blob/master/9/community/Dockerfile#L129
|
||||
info "Configuring file permissions for SonarQube"
|
||||
ensure_user_exists "$SONARQUBE_DAEMON_USER" --group "$SONARQUBE_DAEMON_GROUP" --system
|
||||
for dir in "$SONARQUBE_DATA_DIR" "$SONARQUBE_EXTENSIONS_DIR" "$SONARQUBE_LOGS_DIR" "$SONARQUBE_TMP_DIR" "${SONARQUBE_BASE_DIR}/pids" "$SONARQUBE_VOLUME_DIR"; do
|
||||
ensure_dir_exists "$dir"
|
||||
# Use daemon:root ownership for compatibility when running as a non-root user
|
||||
configure_permissions_ownership "$dir" -d "775" -f "664" -u "$SONARQUBE_DAEMON_USER" -g "root"
|
||||
done
|
||||
|
||||
# The installation directory needs to be writable in order for persistence logic to work (i.e. deleting folders inside it)
|
||||
# The 'sonar.sh' file needs to be writable when running as a non-root user since it si going to be modified during initialization
|
||||
chmod g+w "$SONARQUBE_CONF_FILE" "$SONARQUBE_BASE_DIR"
|
||||
29
bitnami/sonarqube/9/debian-10/rootfs/opt/bitnami/scripts/sonarqube/run.sh
Executable file
29
bitnami/sonarqube/9/debian-10/rootfs/opt/bitnami/scripts/sonarqube/run.sh
Executable file
@@ -0,0 +1,29 @@
|
||||
#!/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 SonarQube environment
|
||||
. /opt/bitnami/scripts/sonarqube-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libsonarqube.sh
|
||||
|
||||
# Using 'sonar.sh console' to start SonarQube in foreground
|
||||
START_CMD=("${SONARQUBE_BIN_DIR}/sonar.sh" "console")
|
||||
|
||||
# SonarQube expects files and folders (i.e. temp or data) to be relative to the CWD by default
|
||||
cd "$SONARQUBE_BASE_DIR"
|
||||
|
||||
info "** Starting SonarQube **"
|
||||
if am_i_root; then
|
||||
exec gosu "$SONARQUBE_DAEMON_USER" "${START_CMD[@]}" "$@"
|
||||
else
|
||||
exec "${START_CMD[@]}" "$@"
|
||||
fi
|
||||
27
bitnami/sonarqube/9/debian-10/rootfs/opt/bitnami/scripts/sonarqube/setup.sh
Executable file
27
bitnami/sonarqube/9/debian-10/rootfs/opt/bitnami/scripts/sonarqube/setup.sh
Executable file
@@ -0,0 +1,27 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purpose
|
||||
|
||||
# Load SonarQube environment
|
||||
. /opt/bitnami/scripts/sonarqube-env.sh
|
||||
|
||||
# Load PostgreSQL Client environment for 'postgresql_remote_execute' (after 'sonarqube-env.sh' so that MODULE is not set to a wrong value)
|
||||
if [[ -f /opt/bitnami/scripts/postgresql-client-env.sh ]]; then
|
||||
. /opt/bitnami/scripts/postgresql-client-env.sh
|
||||
elif [[ -f /opt/bitnami/scripts/postgresql-env.sh ]]; then
|
||||
. /opt/bitnami/scripts/postgresql-env.sh
|
||||
fi
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libsonarqube.sh
|
||||
|
||||
# Ensure SonarQube environment variables are valid
|
||||
sonarqube_validate
|
||||
|
||||
# Ensure SonarQube is initialized
|
||||
sonarqube_initialize
|
||||
36
bitnami/sonarqube/9/debian-10/rootfs/post-init.d/shell.sh
Executable file
36
bitnami/sonarqube/9/debian-10/rootfs/post-init.d/shell.sh
Executable file
@@ -0,0 +1,36 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Executes custom Bash init scripts
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries with logging functions
|
||||
if [[ -f /opt/bitnami/base/functions ]]; then
|
||||
. /opt/bitnami/base/functions
|
||||
else
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
fi
|
||||
|
||||
# Loop through all input files passed via stdin
|
||||
read -r -a custom_init_scripts <<< "$@"
|
||||
failure=0
|
||||
if [[ "${#custom_init_scripts[@]}" -gt 0 ]]; then
|
||||
for custom_init_script in "${custom_init_scripts[@]}"; do
|
||||
[[ "$custom_init_script" != *".sh" ]] && continue
|
||||
if [[ -x "$custom_init_script" ]]; then
|
||||
info "Executing ${custom_init_script}"
|
||||
"$custom_init_script" || failure="1"
|
||||
else
|
||||
info "Sourcing ${custom_init_script} as it is not executable by the current user, any error may cause initialization to fail"
|
||||
. "$custom_init_script"
|
||||
fi
|
||||
[[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}"
|
||||
done
|
||||
fi
|
||||
|
||||
exit "$failure"
|
||||
50
bitnami/sonarqube/9/debian-10/rootfs/post-init.d/sql-postgresql.sh
Executable file
50
bitnami/sonarqube/9/debian-10/rootfs/post-init.d/sql-postgresql.sh
Executable file
@@ -0,0 +1,50 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Executes custom Ruby init scripts
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries with logging functions
|
||||
if [[ -f /opt/bitnami/base/functions ]]; then
|
||||
. /opt/bitnami/base/functions
|
||||
else
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
fi
|
||||
|
||||
postgresql_execute() {
|
||||
local -r sql_file="${1:?missing file}"
|
||||
if [[ -n "$POSTGRESQL_PASSWORD" ]]; then
|
||||
export PGPASSWORD=$POSTGRESQL_PASSWORD
|
||||
fi
|
||||
local -a psql=("psql")
|
||||
if [[ -n "${POSTGRESQL_USER:-}" ]]; then
|
||||
psql+=("-U" "$POSTGRESQL_USER")
|
||||
else
|
||||
psql+=("-U" "$POSTGRESQL_USERNAME")
|
||||
fi
|
||||
if [[ "$sql_file" == *".sql" ]]; then
|
||||
"${psql[@]}" -f "$sql_file" || failure=$?
|
||||
elif [[ "$sql_file" == *".sql.gz" ]]; then
|
||||
gunzip -c "$sql_file" | "${psql[@]}" || failure=$?
|
||||
fi
|
||||
return "$failure"
|
||||
}
|
||||
|
||||
# Loop through all input files passed via stdin
|
||||
read -r -a custom_init_scripts <<< "$@"
|
||||
failure=0
|
||||
if [[ "${#custom_init_scripts[@]}" -gt 0 ]]; then
|
||||
for custom_init_script in "${custom_init_scripts[@]}"; do
|
||||
[[ ! "$custom_init_script" =~ ^.*(\.sql|\.sql\.gz)$ ]] && continue
|
||||
info "Executing ${custom_init_script}"
|
||||
postgresql_execute "$custom_init_script" || failure=1
|
||||
[[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}"
|
||||
done
|
||||
fi
|
||||
|
||||
exit "$failure"
|
||||
23
bitnami/sonarqube/9/debian-10/rootfs/post-init.sh
Executable file
23
bitnami/sonarqube/9/debian-10/rootfs/post-init.sh
Executable file
@@ -0,0 +1,23 @@
|
||||
#!/bin/bash
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Only execute init scripts once
|
||||
if [[ ! -f "/bitnami/sonarqube/.user_scripts_initialized" && -d "/docker-entrypoint-init.d" ]]; then
|
||||
read -r -a init_scripts <<< "$(find "/docker-entrypoint-init.d" -type f -print0 | sort -z | xargs -0)"
|
||||
if [[ "${#init_scripts[@]}" -gt 0 ]] && [[ ! -f "/bitnami/sonarqube/.user_scripts_initialized" ]]; then
|
||||
mkdir -p "/bitnami/sonarqube"
|
||||
for init_script in "${init_scripts[@]}"; do
|
||||
for init_script_type_handler in /post-init.d/*.sh; do
|
||||
"$init_script_type_handler" "$init_script"
|
||||
done
|
||||
done
|
||||
fi
|
||||
|
||||
touch "/bitnami/sonarqube/.user_scripts_initialized"
|
||||
fi
|
||||
@@ -1,53 +1,67 @@
|
||||
# Bitnami Docker Image for SonarQube
|
||||
|
||||
# What is SonarQube?
|
||||
## What is SonarQube?
|
||||
|
||||
> SonarQube is an open source quality management platform, dedicated to continuously analyze and measure technical quality, from project portfolio to method.
|
||||
|
||||
https://www.sonarqube.org/
|
||||
|
||||
# TL;DR
|
||||
|
||||
## Docker Compose
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
$ curl -LO https://raw.githubusercontent.com/bitnami/bitnami-docker-sonarqube/master/docker-compose.yml
|
||||
$ docker-compose up
|
||||
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-sonarqube/master/docker-compose.yml > docker-compose.yml
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
You can find the default credentials and available configuration options in the [Environment Variables](#environment-variables) section.
|
||||
|
||||
# Why use Bitnami Images?
|
||||
|
||||
* Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
|
||||
* With Bitnami images the latest bug fixes and features are available as soon as possible.
|
||||
* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
|
||||
* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
|
||||
* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images.
|
||||
* Bitnami container images are released daily with the latest distribution packages available.
|
||||
## Why use Bitnami Images?
|
||||
|
||||
- Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
|
||||
- With Bitnami images the latest bug fixes and features are available as soon as possible.
|
||||
- Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
|
||||
- All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
|
||||
- All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images.
|
||||
- Bitnami container images are released daily with the latest distribution packages available.
|
||||
|
||||
> This [CVE scan report](https://quay.io/repository/bitnami/sonarqube?tab=tags) contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.
|
||||
|
||||
# Supported tags and respective `Dockerfile` links
|
||||
## Why use a non-root container?
|
||||
|
||||
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/tutorials/work-with-non-root-containers/).
|
||||
|
||||
## Supported tags and respective `Dockerfile` links
|
||||
|
||||
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
|
||||
|
||||
|
||||
* [`8`, `8-debian-10`, `8.9.1`, `8.9.1-debian-10-r24`, `latest` (8/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-sonarqube/blob/8.9.1-debian-10-r24/8/debian-10/Dockerfile)
|
||||
- [`9`, `9-debian-10`, `9.0.0`, `9.0.0-debian-10-r0`, `latest` (9/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-sonarqube/blob/9.0.0-debian-10-r0/9/debian-10/Dockerfile)
|
||||
|
||||
Subscribe to project updates by watching the [bitnami/sonarqube GitHub repo](https://github.com/bitnami/bitnami-docker-sonarqube).
|
||||
|
||||
# Prerequisites
|
||||
## Get this image
|
||||
|
||||
To run this application you need [Docker Engine](https://www.docker.com/products/docker-engine) >= `1.10.0`. [Docker Compose](https://www.docker.com/products/docker-compose) is recommended with a version `1.6.0` or later.
|
||||
The recommended way to get the Bitnami SonarQube Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/sonarqube).
|
||||
|
||||
Please also make sure your host machine meets the [requirements of SonarQube](https://docs.sonarqube.org/latest/requirements/requirements/) itself, taking extra care about [the platform notes section](https://docs.sonarqube.org/latest/requirements/requirements/#header-6).
|
||||
```console
|
||||
$ docker pull bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
# How to use this image
|
||||
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/sonarqube/tags/) in the Docker Hub Registry.
|
||||
|
||||
SonarQube requires access to a PostgreSQL database to store information. We'll use our very own [PostgreSQL image](https://www.github.com/bitnami/bitnami-docker-postgresql) for the database requirements.
|
||||
```console
|
||||
$ docker pull bitnami/sonarqube:[TAG]
|
||||
```
|
||||
|
||||
## Using Docker Compose
|
||||
If you wish, you can also build the image yourself.
|
||||
|
||||
```console
|
||||
$ docker build -t bitnami/sonarqube:latest 'https://github.com/bitnami/bitnami-docker-sonarqube.git#master:9/debian-10'
|
||||
```
|
||||
|
||||
## How to use this image
|
||||
|
||||
SonarQube requires access to a PostgreSQL database to store information. We'll use the [Bitnami Docker Image for PostgreSQL](https://www.github.com/bitnami/bitnami-docker-postgresql) for the database requirements.
|
||||
|
||||
### Run the application using Docker Compose
|
||||
|
||||
@@ -58,347 +72,409 @@ $ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-sonarqube/m
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
## Using the Docker Command Line
|
||||
### Using the Docker Command Line
|
||||
|
||||
If you want to run the application manually instead of using `docker-compose`, these are the basic steps you need to run:
|
||||
|
||||
1. Create a network
|
||||
#### Step 1: Create a network
|
||||
|
||||
```console
|
||||
$ docker network create sonarqube-tier
|
||||
```
|
||||
```console
|
||||
$ docker network create sonarqube-network
|
||||
```
|
||||
|
||||
2. Create a volume for PostgreSQL persistence and create a PostgreSQL container
|
||||
#### Step 2: Create a volume for PostgreSQL persistence and create a PostgreSQL container
|
||||
|
||||
```console
|
||||
$ docker volume create --name postgresql_data
|
||||
$ docker run -d --name postgresql \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e POSTGRESQL_USERNAME=bn_sonarqube \
|
||||
-e POSTGRESQL_DATABASE=bitnami_sonarqube \
|
||||
-e POSTGRESQL_PASSWORD=bitnami1234 \
|
||||
--net sonarqube-tier \
|
||||
--volume postgresql_data:/bitnami/postgresql \
|
||||
bitnami/postgresql:latest
|
||||
```
|
||||
```console
|
||||
$ docker volume create --name postgresql_data
|
||||
$ docker run -d --name postgresql \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env POSTGRESQL_USERNAME=bn_sonarqube \
|
||||
--env POSTGRESQL_PASSWORD=bitnami \
|
||||
--env POSTGRESQL_DATABASE=bitnami_sonarqube \
|
||||
--network sonarqube-network \
|
||||
--volume postgresql_data:/bitnami/postgresql \
|
||||
bitnami/postgresql:latest
|
||||
```
|
||||
|
||||
3. Create volumes for SonarQube persistence and launch the container
|
||||
#### Step 3: Create volumes for SonarQube persistence and launch the container
|
||||
|
||||
```console
|
||||
$ docker volume create --name sonarqube_data
|
||||
$ docker run -d --name sonarqube -p 80:9000 \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e SONARQUBE_DATABASE_USER=bn_sonarqube \
|
||||
-e SONARQUBE_DATABASE_NAME=bitnami_sonarqube \
|
||||
-e SONARQUBE_DATABASE_PASSWORD=bitnami1234 \
|
||||
--net sonarqube-tier \
|
||||
--volume sonarqube_data:/bitnami \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
```console
|
||||
$ docker volume create --name sonarqube_data
|
||||
$ docker run -d --name sonarqube \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env SONARQUBE_DATABASE_USER=bn_sonarqube \
|
||||
--env SONARQUBE_DATABASE_PASSWORD=bitnami \
|
||||
--env SONARQUBE_DATABASE_NAME=bitnami_sonarqube \
|
||||
--network sonarqube-network \
|
||||
--volume sonarqube_data:/bitnami/sonarqube \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
Access your application at http://your-ip:9000
|
||||
Access your application at *http://your-ip/*
|
||||
|
||||
## Persisting your application
|
||||
|
||||
If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
|
||||
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
|
||||
|
||||
For persistence you should mount a volume at the `/bitnami` path. Additionally you should mount a volume for [persistence of the PostgreSQL data](https://github.com/bitnami/bitnami-docker-postgresql#persisting-your-database).
|
||||
For persistence you should mount a directory at the `/bitnami/sonarqube` path. If the mounted directory is empty, it will be initialized on the first run. Additionally you should [mount a volume for persistence of the PostgreSQL data](https://github.com/bitnami/bitnami-docker-postgresql#persisting-your-database).
|
||||
|
||||
The above examples define docker volumes namely `postgresql_data` and `sonarqube_data`. The Sonarqube application state will persist as long as these volumes are not removed.
|
||||
The above examples define the Docker volumes named `postgresql_data` and `sonarqube_data`. The SonarQube application state will persist as long as volumes are not removed.
|
||||
|
||||
To avoid inadvertent removal of these volumes you can [mount host directories as data volumes](https://docs.docker.com/engine/tutorials/dockervolumes/). Alternatively you can make use of volume plugins to host the volume data.
|
||||
To avoid inadvertent removal of volumes, you can [mount host directories as data volumes](https://docs.docker.com/engine/tutorials/dockervolumes/). Alternatively you can make use of volume plugins to host the volume data.
|
||||
|
||||
### Mount host directories as data volumes with Docker Compose
|
||||
|
||||
The following `docker-compose.yml` template demonstrates the use of host directories as data volumes.
|
||||
This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-sonarqube/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
|
||||
services:
|
||||
postgresql:
|
||||
image: 'bitnami/postgresql:latest'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- POSTGRESQL_USER=bn_sonarqube
|
||||
- POSTGRESQL_DATABASE=bitnami_sonarqube
|
||||
- POSTGRESQL_PASSWORD=bitnami1234
|
||||
volumes:
|
||||
- /path/to/postgresql-persistence:/bitnami/postgresql
|
||||
sonarqube:
|
||||
image: bitnami/sonarqube:latest
|
||||
depends_on:
|
||||
- postgresql
|
||||
ports:
|
||||
- '80:9000'
|
||||
environment:
|
||||
- SONARQUBE_DATABASE_USER=bn_sonarqube
|
||||
- SONARQUBE_DATABASE_NAME=bitnami_sonarqube
|
||||
- SONARQUBE_DATABASE_PASSWORD=bitnami1234
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
volumes:
|
||||
- /path/to/sonarqube-persistence:/bitnami
|
||||
```diff
|
||||
postgresql:
|
||||
...
|
||||
volumes:
|
||||
- - 'postgresql_data:/bitnami/postgresql'
|
||||
+ - /path/to/postgresql-persistence:/bitnami/postgresql
|
||||
...
|
||||
sonarqube:
|
||||
...
|
||||
volumes:
|
||||
- - 'sonarqube_data:/bitnami/sonarqube'
|
||||
+ - /path/to/sonarqube-persistence:/bitnami/sonarqube
|
||||
...
|
||||
-volumes:
|
||||
- postgresql_data:
|
||||
- driver: local
|
||||
- sonarqube_data:
|
||||
- driver: local
|
||||
```
|
||||
|
||||
> NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.
|
||||
|
||||
### Mount host directories as data volumes using the Docker command line
|
||||
|
||||
1. Create a network (if it does not exist)
|
||||
|
||||
```console
|
||||
$ docker network create sonarqube-tier
|
||||
```
|
||||
|
||||
2. Create a PostgreSQL container with host volume
|
||||
|
||||
```console
|
||||
$ docker run -d --name postgresql \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e POSTGRESQL_USERNAME=bn_sonarqube \
|
||||
-e POSTGRESQL_DATABASE=bitnami_sonarqube \
|
||||
-e POSTGRESQL_PASSWORD=bitnami1234 \
|
||||
--net sonarqube-tier \
|
||||
--volume /path/to/postgresql-persistence:/bitnami/postgresql \
|
||||
bitnami/postgresql:latest
|
||||
```
|
||||
|
||||
3. Create the SonarQube container with host volumes
|
||||
|
||||
```console
|
||||
$ docker run -d --name sonarqube -p 80:9000 \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e SONARQUBE_DATABASE_USER=bn_sonarqube \
|
||||
-e SONARQUBE_DATABASE_NAME=bitnami_sonarqube \
|
||||
-e SONARQUBE_DATABASE_PASSWORD=bitnami1234 \
|
||||
--net sonarqube-tier \
|
||||
--volume /path/to/sonarqube-persistence:/bitnami \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
# Upgrading SonarQube
|
||||
|
||||
Bitnami provides up-to-date versions of PostgreSQL and SonarQube, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the SonarQube container. For the PostgreSQL upgrade see https://github.com/bitnami/bitnami-docker-postgresql/blob/master/README.md#upgrade-this-image
|
||||
|
||||
The `bitnami/sonarqube:latest` tag always points to the most recent release. To get the most recent release you can simple repull the `latest` tag from the Docker Hub with `docker pull bitnami/sonarqube:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/sonarqube/tags/).
|
||||
|
||||
1. Get the updated images:
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
2. Stop your container
|
||||
|
||||
* For docker-compose: `$ docker-compose stop sonarqube`
|
||||
* For manual execution: `$ docker stop sonarqube`
|
||||
|
||||
3. Take a snapshot of the application state
|
||||
#### Step 1: Create a network (if it does not exist)
|
||||
|
||||
```console
|
||||
$ rsync -a /path/to/sonarqube-persistence /path/to/sonarqube-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
|
||||
$ docker network create sonarqube-network
|
||||
```
|
||||
|
||||
Additionally, [snapshot the PostgreSQL data](https://github.com/bitnami/bitnami-docker-postgresql#step-2-stop-and-backup-the-currently-running-container)
|
||||
#### Step 2. Create a PostgreSQL container with host volume
|
||||
|
||||
You can use these snapshots to restore the application state should the upgrade fail.
|
||||
```console
|
||||
$ docker run -d --name postgresql \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env POSTGRESQL_USERNAME=bn_sonarqube \
|
||||
--env POSTGRESQL_PASSWORD=bitnami \
|
||||
--env POSTGRESQL_DATABASE=bitnami_sonarqube \
|
||||
--network sonarqube-network \
|
||||
--volume /path/to/postgresql-persistence:/bitnami/postgresql \
|
||||
bitnami/postgresql:latest
|
||||
```
|
||||
|
||||
4. Remove the stopped container
|
||||
#### Step 3. Create the SonarQube container with host volumes
|
||||
|
||||
* For docker-compose: `$ docker-compose rm sonarqube`
|
||||
* For manual execution: `$ docker rm sonarqube`
|
||||
```console
|
||||
$ docker run -d --name sonarqube \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env SONARQUBE_DATABASE_USER=bn_sonarqube \
|
||||
--env SONARQUBE_DATABASE_PASSWORD=bitnami \
|
||||
--env SONARQUBE_DATABASE_NAME=bitnami_sonarqube \
|
||||
--network sonarqube-network \
|
||||
--volume /path/to/sonarqube-persistence:/bitnami/sonarqube \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
5. Run the new image
|
||||
## Configuration
|
||||
|
||||
* For docker-compose: `$ docker-compose up sonarqube`
|
||||
* For manual execution ([mount](#mount-persistent-folders-manually) the directories if needed): `docker run --name sonarqube bitnami/sonarqube:latest`
|
||||
### Environment variables
|
||||
|
||||
# Configuration
|
||||
When you start the SonarQube image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the `docker run` command line. If you want to add a new environment variable:
|
||||
|
||||
## Environment variables
|
||||
- For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-sonarqube/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
The SonarQube instance can be customized by specifying environment variables on the first run. The following environment values are provided to custom SonarQube:
|
||||
```yaml
|
||||
sonarqube:
|
||||
...
|
||||
environment:
|
||||
- SONARQUBE_PASSWORD=my_password
|
||||
...
|
||||
```
|
||||
|
||||
- For manual execution add a `--env` option with each variable and value:
|
||||
|
||||
```console
|
||||
$ docker run -d --name sonarqube -p 80:8080 -p 443:8443 \
|
||||
--env SONARQUBE_PASSWORD=my_password \
|
||||
--network sonarqube-tier \
|
||||
--volume /path/to/sonarqube-persistence:/bitnami \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
Available environment variables:
|
||||
|
||||
##### User and Site configuration
|
||||
|
||||
- `SONARQUBE_USERNAME`: SonarQube application username. Default: **admin**
|
||||
- `SONARQUBE_PASSWORD`: SonarQube application password. Default: **bitnami**
|
||||
- `SONARQUBE_PORT_NUMBER`: SonarQube Web application port. Default: **9000**
|
||||
- `SONARQUBE_ELASTICSEARCH_PORT_NUMBER`: SonarQube Elasticsearch application port. Default: **9001**
|
||||
- `SONARQUBE_ENABLE_DEMO_DATA`: It can be used to import a sample project and install a sample plugin. Default: **no**
|
||||
- `SONARQUBE_EMAIL`: SonarQube application email. Default: **user@example.com**
|
||||
- `SONARQUBE_SKIP_BOOTSTRAP`: Whether to perform initial bootstrapping for the application. This is necessary in case you use a database that already has SonarQube data. Default: **no**
|
||||
- `SONARQUBE_PORT_NUMBER`: SonarQube Web application port number. Default: **9000**
|
||||
- `SONARQUBE_ELASTICSEARCH_PORT_NUMBER`: SonarQube Elasticsearch application port number. Default: **9001**
|
||||
- `SONARQUBE_WEB_CONTEXT`: SonarQube prefix used to access to the application. Default: **/**
|
||||
- `SONARQUBE_MAX_HEAP_SIZE`: Maximum heap size for SonarQube services (CE, Search and Web). No defaults.
|
||||
- `SONARQUBE_MIN_HEAP_SIZE`: Minimum heap size for SonarQube services (CE, Search and Web). No defaults.
|
||||
- `SONARQUBE_CE_JAVA_ADD_OPTS`: Additional Java options for Compute Engine. No defaults.
|
||||
- `SONARQUBE_ELASTICSEARCH_JAVA_ADD_OPTS`: Additional Java options for Elasticsearch. No defaults.
|
||||
- `SONARQUBE_WEB_JAVA_ADD_OPTS`: Additional Java options for Web. No defaults.
|
||||
- `SONARQUBE_PROPERTIES`: Comma separated list of properties to be set in the sonar.properties file, i.e `my.sonar.property1=property_value,my.sonar.property2=property_value`. No defaults.
|
||||
- `SONARQUBE_EXTRA_PROPERTIES`: Comma separated list of properties to be set in the sonar.properties file, e.g. `my.sonar.property1=property_value,my.sonar.property2=property_value`. No defaults.
|
||||
- `SONARQUBE_START_TIMEOUT`: Timeout for the application to start in seconds. Default: **300**.
|
||||
|
||||
##### Use an existing database
|
||||
##### Database connection configuration
|
||||
|
||||
- `POSTGRESQL_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
|
||||
- `POSTGRESQL_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
|
||||
- `SONARQUBE_DATABASE_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
|
||||
- `SONARQUBE_DATABASE_PORT_NUMBER`: Port used by the PostgreSQL server. Default: **5432**
|
||||
- `SONARQUBE_DATABASE_NAME`: Database name that SonarQube will use to connect with the database. Default: **bitnami_sonarqube**
|
||||
- `SONARQUBE_DATABASE_USER`: Database user that SonarQube will use to connect with the database. Default: **bn_sonarqube**
|
||||
- `SONARQUBE_DATABASE_PASSWORD`: Database password that SonarQube will use to connect with the database. No defaults.
|
||||
- `SONARQUBE_DATABASE_PASSWORD`: Database password that SonarQube will use to connect with the database. No default.
|
||||
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||
|
||||
##### Create a database for SonarQube using postgresql-client
|
||||
|
||||
- `POSTGRESQL_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
|
||||
- `POSTGRESQL_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
|
||||
- `POSTGRESQL_ROOT_USER`: Database admin user. Default: **root**
|
||||
- `POSTGRESQL_ROOT_PASSWORD`: Database password for the `POSTGRESQL_ROOT_USER` user. No defaults.
|
||||
- `POSTGRESQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the postgresql client module. No defaults.
|
||||
- `POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME`: New database user to be created by the postgresql client module. No defaults.
|
||||
- `POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME` user. No defaults.
|
||||
- `POSTGRESQL_CLIENT_DATABASE_HOST`: Hostname for the PostgreSQL server. Default: **postgresql**
|
||||
- `POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER`: Port used by the PostgreSQL server. Default: **5432**
|
||||
- `POSTGRESQL_CLIENT_DATABASE_ROOT_USER`: Database admin user. Default: **root**
|
||||
- `POSTGRESQL_CLIENT_DATABASE_ROOT_PASSWORD`: Database password for the database admin user. No default.
|
||||
- `POSTGRESQL_CLIENT_CREATE_DATABASE_NAME`: New database to be created by the mysql client module. No default.
|
||||
- `POSTGRESQL_CLIENT_CREATE_DATABASE_USER`: New database user to be created by the mysql client module. No default.
|
||||
- `POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD`: Database password for the `POSTGRESQL_CLIENT_CREATE_DATABASE_USER` user. No default.
|
||||
- `POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS`: PostgreSQL extensions to enable in the specified database during the first initialization. No default.
|
||||
- `POSTGRESQL_CLIENT_ENABLE_SSL`: Whether to enable SSL connections for the new database. Default: **no**
|
||||
- `POSTGRESQL_CLIENT_SSL_CA_FILE`: Path to the SSL CA file for the new database. No default.
|
||||
- `ALLOW_EMPTY_PASSWORD`: It can be used to allow blank passwords. Default: **no**
|
||||
|
||||
### Specifying Environment variables using Docker Compose
|
||||
|
||||
This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-sonarqube/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
postgresql:
|
||||
...
|
||||
environment:
|
||||
- POSTGRESQL_USER=bn_sonarqube
|
||||
- POSTGRESQL_DATABASE=bitnami_sonarqube
|
||||
- POSTGRESQL_PASSWORD=bitnami1234
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
...
|
||||
sonarqube:
|
||||
...
|
||||
environment:
|
||||
- POSTGRESQL_HOST=postgresql
|
||||
- POSTGRESQL_PORT_NUMBER=5432
|
||||
- SONARQUBE_DATABASE_USER=bn_sonarqube
|
||||
- SONARQUBE_DATABASE_NAME=bitnami_sonarqube
|
||||
- SONARQUBE_DATABASE_PASSWORD=bitnami1234
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
...
|
||||
```
|
||||
|
||||
### Specifying Environment variables on the Docker command line
|
||||
|
||||
```console
|
||||
$ docker run -d --name sonarqube -p 80:9000 \
|
||||
--net sonarqube-tier \
|
||||
-e ALLOW_EMPTY_PASSWORD=yes \
|
||||
-e SONARQUBE_DATABASE_USER=bn_sonarqube \
|
||||
-e SONARQUBE_DATABASE_NAME=bitnami_sonarqube \
|
||||
-e SONARQUBE_PASSWORD=my_password \
|
||||
--volume sonarqube_data:/bitnami \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
### SMTP Configuration
|
||||
##### SMTP Configuration
|
||||
|
||||
To configure SonarQube to send email using SMTP you can set the following environment variables:
|
||||
- `SMTP_HOST`: Host for outgoing SMTP email. No defaults.
|
||||
- `SMTP_PORT`: Port for outgoing SMTP email. No defaults.
|
||||
- `SMTP_USER`: User of SMTP used for authentication (likely email). No defaults.
|
||||
- `SMTP_PASSWORD`: Password for SMTP. No defaults.
|
||||
- `SMTP_PROTOCOL`: Secure connection protocol to use for SMTP [tls, ssl, none]. No defaults.
|
||||
|
||||
This would be an example of SMTP configuration using a GMail account:
|
||||
- `SONARQUBE_SMTP_HOST`: SMTP host.
|
||||
- `SONARQUBE_SMTP_PORT_NUMBER`: SMTP port.
|
||||
- `SONARQUBE_SMTP_USER`: SMTP account user.
|
||||
- `SONARQUBE_SMTP_PASSWORD`: SMTP account password.
|
||||
- `SONARQUBE_SMTP_PROTOCOL`: If specified, SMTP protocol to use. Allowed values: *tls*, *ssl*. No default.
|
||||
|
||||
* Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-sonarqube/blob/master/docker-compose.yml) file present in this repository:
|
||||
#### Examples
|
||||
|
||||
```yaml
|
||||
sonarqube:
|
||||
...
|
||||
environment:
|
||||
- POSTGRESQL_HOST=postgresql
|
||||
- POSTGRESQL_PORT_NUMBER=5432
|
||||
- SONARQUBE_DATABASE_USER=bn_sonarqube
|
||||
- SONARQUBE_DATABASE_NAME=bitnami_sonarqube
|
||||
- SONARQUBE_DATABASE_PASSWORD=bitnami1234
|
||||
- SMTP_HOST=smtp.gmail.com
|
||||
- SMTP_PORT=587
|
||||
- SMTP_USER=your_email@gmail.com
|
||||
- SMTP_PASSWORD=your_password
|
||||
- SMTP_PROTOCOL=tls
|
||||
...
|
||||
```
|
||||
##### SMTP configuration using a Gmail account
|
||||
|
||||
* For manual execution:
|
||||
This would be an example of SMTP configuration using a Gmail account:
|
||||
|
||||
- Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-sonarqube/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
sonarqube:
|
||||
...
|
||||
environment:
|
||||
- SONARQUBE_DATABASE_USER=bn_sonarqube
|
||||
- SONARQUBE_DATABASE_NAME=bitnami_sonarqube
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- SONARQUBE_SMTP_HOST=smtp.gmail.com
|
||||
- SONARQUBE_SMTP_PORT_NUMBER=587
|
||||
- SONARQUBE_SMTP_USER=your_email@gmail.com
|
||||
- SONARQUBE_SMTP_PASSWORD=your_password
|
||||
...
|
||||
```
|
||||
|
||||
- For manual execution:
|
||||
|
||||
```console
|
||||
$ docker run -d --name sonarqube -p 80:8080 -p 443:8443 \
|
||||
--env SONARQUBE_DATABASE_USER=bn_sonarqube \
|
||||
--env SONARQUBE_DATABASE_NAME=bitnami_sonarqube \
|
||||
--env SONARQUBE_SMTP_HOST=smtp.gmail.com \
|
||||
--env SONARQUBE_SMTP_PORT_NUMBER=587 \
|
||||
--env SONARQUBE_SMTP_USER=your_email@gmail.com \
|
||||
--env SONARQUBE_SMTP_PASSWORD=your_password \
|
||||
--network sonarqube-tier \
|
||||
--volume /path/to/sonarqube-persistence:/bitnami \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
##### Connect SonarQube container to an existing database
|
||||
|
||||
The Bitnami SonarQube container supports connecting the SonarQube application to an external database. This would be an example of using an external database for SonarQube.
|
||||
|
||||
- Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-sonarqube/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
```diff
|
||||
sonarqube:
|
||||
...
|
||||
environment:
|
||||
- - SONARQUBE_DATABASE_HOST=mariadb
|
||||
+ - SONARQUBE_DATABASE_HOST=mariadb_host
|
||||
- SONARQUBE_DATABASE_PORT_NUMBER=3306
|
||||
- SONARQUBE_DATABASE_NAME=sonarqube_db
|
||||
- SONARQUBE_DATABASE_USER=sonarqube_user
|
||||
- - ALLOW_EMPTY_PASSWORD=yes
|
||||
+ - SONARQUBE_DATABASE_PASSWORD=sonarqube_password
|
||||
...
|
||||
```
|
||||
|
||||
- For manual execution:
|
||||
|
||||
```console
|
||||
$ docker run -d --name sonarqube\
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--network sonarqube-network \
|
||||
--env SONARQUBE_DATABASE_HOST=mariadb_host \
|
||||
--env SONARQUBE_DATABASE_PORT_NUMBER=3306 \
|
||||
--env SONARQUBE_DATABASE_NAME=sonarqube_db \
|
||||
--env SONARQUBE_DATABASE_USER=sonarqube_user \
|
||||
--env SONARQUBE_DATABASE_PASSWORD=sonarqube_password \
|
||||
--volume sonarqube_data:/bitnami/sonarqube \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
In case the database already contains data from a previous SonarQube installation, you need to set the variable `SONARQUBE_SKIP_BOOTSTRAP` to `yes`. Otherwise, the container would execute the installation wizard and could modify the existing data in the database. Note that, when setting `SONARQUBE_SKIP_BOOTSTRAP` to `yes`, values for environment variables such as `SONARQUBE_USERNAME`, `SONARQUBE_PASSWORD` or `SONARQUBE_EMAIL` will be ignored.
|
||||
|
||||
## Logging
|
||||
|
||||
The Bitnami SonarQube Docker image sends the container logs to `stdout`. To view the logs:
|
||||
|
||||
```console
|
||||
$ docker run -d --name sonarqube -p 80:9000 \
|
||||
--net sonarqube-tier \
|
||||
--env SMTP_HOST=smtp.gmail.com --env SMTP_PORT=587 \
|
||||
--env SMTP_USER=your_email@gmail.com --env SMTP_PASSWORD=your_password \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes --env SONARQUBE_DATABASE_USER=bn_sonarqube \
|
||||
--env SONARQUBE_DATABASE_NAME=bitnami_sonarqube \
|
||||
--volume sonarqube_data:/bitnami \
|
||||
bitnami/sonarqube:latest
|
||||
$ docker logs sonarqube
|
||||
```
|
||||
|
||||
### Connect SonarQube docker container to an existing database
|
||||
|
||||
The Bitnami SonarQube container supports connecting the SonarQube application to an external database. In order to configure it, you should set the following environment variables:
|
||||
- `POSTGRESQL_HOST`: Hostname for PostgreSQL server. Default: **postgresql**
|
||||
- `POSTGRESQL_PORT_NUMBER`: Port used by PostgreSQL server. Default: **5432**
|
||||
- `SONARQUBE_DATABASE_NAME`: Database name that SonarQube will use to connect with the database. Default: **bitnami_sonarqube**
|
||||
- `SONARQUBE_DATABASE_USER`: Database user that SonarQube will use to connect with the database. Default: **bn_sonarqube**
|
||||
- `SONARQUBE_DATABASE_PASSWORD`: Database password that SonarQube will use to connect with the database. No defaults.
|
||||
|
||||
This would be an example of using an external database for SonarQube.
|
||||
|
||||
* Modify the [`docker-compose.yml`](https://github.com/bitnami/bitnami-docker-sonarqube/blob/master/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
sonarqube:
|
||||
...
|
||||
environment:
|
||||
- POSTGRESQL_HOST=postgresql_host
|
||||
- POSTGRESQL_ROOT_USER=postgresql_root_user
|
||||
- POSTGRESQL_ROOT_PASSWORD=postgresql_root_password
|
||||
- POSTGRESQL_PORT_NUMBER=5432
|
||||
- SONARQUBE_DATABASE_NAME=sonarqube_db
|
||||
- SONARQUBE_DATABASE_USER=sonarqube_user
|
||||
- SONARQUBE_DATABASE_PASSWORD=sonarqube_password
|
||||
...
|
||||
```
|
||||
|
||||
* For manual execution:
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
$ docker run -d --name sonarqube -p 80:9000 \
|
||||
--net sonarqube-tier \
|
||||
--env POSTGRESQL_HOST=postgresql_host \
|
||||
--env POSTGRESQL_PORT_NUMBER=5432 \
|
||||
--env POSTGRESQL_ROOT_USER=postgresql_root_user \
|
||||
--env POSTGRESQL_ROOT_PASSWORD=postgresql_root_password \
|
||||
--env SONARQUBE_DATABASE_NAME=sonarqube_db \
|
||||
--env SONARQUBE_DATABASE_USER=sonarqube_user \
|
||||
--env SONARQUBE_DATABASE_PASSWORD=sonarqube_password \
|
||||
--volume sonarqube_data:/bitnami \
|
||||
bitnami/sonarqube:latest
|
||||
$ docker-compose logs sonarqube
|
||||
```
|
||||
|
||||
# Contributing
|
||||
You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Backing up your container
|
||||
|
||||
To backup your data, configuration and logs, follow these simple steps:
|
||||
|
||||
#### Step 1: Stop the currently running container
|
||||
|
||||
```console
|
||||
$ docker stop sonarqube
|
||||
```
|
||||
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
$ docker-compose stop sonarqube
|
||||
```
|
||||
|
||||
#### Step 2: Run the backup command
|
||||
|
||||
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
|
||||
|
||||
```console
|
||||
$ docker run --rm -v /path/to/sonarqube-backups:/backups --volumes-from sonarqube busybox \
|
||||
cp -a /bitnami/sonarqube /backups/latest
|
||||
```
|
||||
|
||||
### Restoring a backup
|
||||
|
||||
Restoring a backup is as simple as mounting the backup as volumes in the containers.
|
||||
|
||||
For the PostgreSQL database container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name postgresql \
|
||||
...
|
||||
- --volume /path/to/postgresql-persistence:/bitnami/postgresql \
|
||||
+ --volume /path/to/postgresql-backups/latest:/bitnami/postgresql \
|
||||
bitnami/postgresql:latest
|
||||
```
|
||||
|
||||
For the SonarQube container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name sonarqube \
|
||||
...
|
||||
- --volume /path/to/sonarqube-persistence:/bitnami/sonarqube \
|
||||
+ --volume /path/to/sonarqube-backups/latest:/bitnami/sonarqube \
|
||||
bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
### Upgrade this image
|
||||
|
||||
Bitnami provides up-to-date versions of PostgreSQL and SonarQube, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the SonarQube container. For the PostgreSQL upgrade see: https://github.com/bitnami/bitnami-docker-postgresql/blob/master/README.md#upgrade-this-image
|
||||
|
||||
The `bitnami/sonarqube:latest` tag always points to the most recent release. To get the most recent release you can simple repull the `latest` tag from the Docker Hub with `docker pull bitnami/sonarqube:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/sonarqube/tags/).
|
||||
|
||||
#### Step 1: Get the updated image
|
||||
|
||||
```console
|
||||
$ docker pull bitnami/sonarqube:latest
|
||||
```
|
||||
|
||||
#### Step 2: Stop the running container
|
||||
|
||||
Stop the currently running container using the command
|
||||
|
||||
```console
|
||||
$ docker-compose stop sonarqube
|
||||
```
|
||||
|
||||
#### Step 3: Take a snapshot of the application state
|
||||
|
||||
Follow the steps in [Backing up your container](#backing-up-your-container) to take a snapshot of the current application state.
|
||||
|
||||
#### Step 4: Remove the currently running container
|
||||
|
||||
Remove the currently running container by executing the following command:
|
||||
|
||||
```console
|
||||
docker-compose rm -v sonarqube
|
||||
```
|
||||
|
||||
#### Step 5: Run the new image
|
||||
|
||||
Update the image tag in `docker-compose.yml` and re-create your container with the new image:
|
||||
|
||||
```console
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
# Notable Changes
|
||||
|
||||
### 9.0.0-debian-10-r0
|
||||
|
||||
- The size of the container image has been decreased.
|
||||
- The configuration logic is now based on Bash scripts in the *rootfs/* folder.
|
||||
- The SonarQube container image has been migrated to a "non-root" user approach. Previously the container ran as the `root` user and the SonarQube daemon was started as the `sonarqube` user. From now on, both the container and the SonarQube daemon run as user `1001`. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile, or `user: root` in `docker-compose.yml`. Consequences:
|
||||
- Backwards compatibility is not guaranteed when data is persisted using docker or docker-compose. We highly recommend migrating the SonarQube site by exporting its content, and importing it on a new SonarQube container. Follow the steps in [Backing up your container](#backing-up-your-container) and [Restoring a backup](#restoring-a-backup) to migrate the data between the old and new container.
|
||||
|
||||
## Contributing
|
||||
|
||||
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-sonarqube/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-sonarqube/pulls) with your contribution.
|
||||
|
||||
# Issues
|
||||
## Issues
|
||||
|
||||
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-sonarqube/issues/new). For us to provide better support, be sure to include the following information in your issue:
|
||||
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-sonarqube/issues). For us to provide better support, be sure to include the following information in your issue:
|
||||
|
||||
- Host OS and version
|
||||
- Docker version (`$ docker version`)
|
||||
- Output of `$ docker info`
|
||||
- Version of this container (`$ echo $BITNAMI_IMAGE_VERSION` inside the container)
|
||||
- Docker version (`docker version`)
|
||||
- Output of `docker info`
|
||||
- Version of this container
|
||||
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
|
||||
|
||||
# License
|
||||
## License
|
||||
|
||||
Copyright 2015-2021 Bitnami
|
||||
Copyright (c) 2021 Bitnami
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
<http://www.apache.org/licenses/LICENSE-2.0>
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
|
||||
@@ -1,29 +1,29 @@
|
||||
version: '2'
|
||||
|
||||
services:
|
||||
postgresql:
|
||||
image: docker.io/bitnami/postgresql:10
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
image: docker.io/bitnami/postgresql:13
|
||||
volumes:
|
||||
- 'postgresql_data:/bitnami/postgresql'
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- POSTGRESQL_USERNAME=bn_sonarqube
|
||||
- POSTGRESQL_DATABASE=bitnami_sonarqube
|
||||
sonarqube:
|
||||
image: docker.io/bitnami/sonarqube:8
|
||||
image: docker.io/bitnami/sonarqube:9
|
||||
ports:
|
||||
- '80:9000'
|
||||
environment:
|
||||
- POSTGRESQL_HOST=postgresql
|
||||
- POSTGRESQL_ROOT_USER=postgres
|
||||
- POSTGRESQL_CLIENT_CREATE_DATABASE_NAME=bitnami_sonarqube
|
||||
- POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME=bn_sonarqube
|
||||
- POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD=bitnami1234
|
||||
- SONARQUBE_DATABASE_NAME=bitnami_sonarqube
|
||||
- SONARQUBE_DATABASE_USER=bn_sonarqube
|
||||
- SONARQUBE_DATABASE_PASSWORD=bitnami1234
|
||||
volumes:
|
||||
- sonarqube_data:/bitnami
|
||||
- 'sonarqube_data:/bitnami/sonarqube'
|
||||
depends_on:
|
||||
- postgresql
|
||||
environment:
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- SONARQUBE_DATABASE_HOST=postgresql
|
||||
- SONARQUBE_DATABASE_PORT_NUMBER=5432
|
||||
- SONARQUBE_DATABASE_USER=bn_sonarqube
|
||||
- SONARQUBE_DATABASE_NAME=bitnami_sonarqube
|
||||
volumes:
|
||||
sonarqube_data:
|
||||
driver: local
|
||||
postgresql_data:
|
||||
driver: local
|
||||
sonarqube_data:
|
||||
driver: local
|
||||
|
||||
Reference in New Issue
Block a user