mirror of
https://github.com/bitnami/containers.git
synced 2026-10-18 07:48:55 +02:00
[bitnami/jasperreports] Deprecate JasperReports container (#58013)
Signed-off-by: mdhont <michield@vmware.com>
This commit is contained in:
Michiel
@@ -1,15 +0,0 @@
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
gossfile:
|
||||
# Goss tests exclusive to the current container
|
||||
../../jasperreports/goss/jasperreports.yaml: {}
|
||||
# Load scripts from .vib/common/goss/templates
|
||||
../../common/goss/templates/check-binaries.yaml: {}
|
||||
../../common/goss/templates/check-broken-symlinks.yaml: {}
|
||||
../../common/goss/templates/check-ca-certs.yaml: {}
|
||||
../../common/goss/templates/check-directories.yaml: {}
|
||||
../../common/goss/templates/check-files.yaml: {}
|
||||
../../common/goss/templates/check-linked-libraries.yaml: {}
|
||||
../../common/goss/templates/check-sed-in-place.yaml: {}
|
||||
../../common/goss/templates/check-spdx.yaml: {}
|
||||
@@ -1,25 +0,0 @@
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
command:
|
||||
check-app-version:
|
||||
exec: ls /opt/bitnami/jasperreports/buildomatic/conf_source/ieCe/lib/jasperserver-war-jar-*.jar | grep {{ .Env.APP_VERSION }}
|
||||
exit-status: 0
|
||||
file:
|
||||
/opt/bitnami/jasperreports/buildomatic/default_master.properties:
|
||||
exists: true
|
||||
filetype: file
|
||||
contents:
|
||||
- "appServerDir=/opt/bitnami/tomcat"
|
||||
- "jdbcDriverClass=org.mariadb.jdbc.Driver"
|
||||
/opt/bitnami/jasperreports/buildomatic/bin/app-server.xml:
|
||||
exists: true
|
||||
filetype: file
|
||||
contents:
|
||||
- '!<var name="warTargetDirDel"'
|
||||
group:
|
||||
tomcat:
|
||||
exists: true
|
||||
user:
|
||||
tomcat:
|
||||
exists: true
|
||||
@@ -1,22 +0,0 @@
|
||||
binaries:
|
||||
- java
|
||||
- mysql
|
||||
- psql
|
||||
- render-template
|
||||
directories:
|
||||
- mode: "0775"
|
||||
paths:
|
||||
- /bitnami/jasperreports
|
||||
- /opt/bitnami/jasperreports
|
||||
- /opt/bitnami/jasperreports/apache-ant/bin
|
||||
- /opt/bitnami/jasperreports/buildomatic
|
||||
files:
|
||||
- mode: "0775"
|
||||
paths:
|
||||
- /opt/bitnami/jasperreports/apache-ant/bin/ant
|
||||
- /opt/bitnami/jasperreports/apache-ant/bin/antRun
|
||||
- /opt/bitnami/jasperreports/buildomatic/bin/do-js-migrate.sh
|
||||
- /opt/bitnami/jasperreports/buildomatic/bin/do-js-setup.sh
|
||||
- /opt/bitnami/jasperreports/buildomatic/js-ant
|
||||
- /opt/bitnami/jasperreports/buildomatic/js-mvn
|
||||
root_dir: /opt/bitnami
|
||||
@@ -1,73 +0,0 @@
|
||||
{
|
||||
"context": {
|
||||
"resources": {
|
||||
"url": "{SHA_ARCHIVE}",
|
||||
"path": "{VIB_ENV_PATH}"
|
||||
},
|
||||
"runtime_parameters": "Y29tbWFuZDogWyJ0YWlsIiwgIi1mIiwgIi9kZXYvbnVsbCJd"
|
||||
},
|
||||
"phases": {
|
||||
"package": {
|
||||
"actions": [
|
||||
{
|
||||
"action_id": "container-image-package",
|
||||
"params": {
|
||||
"application": {
|
||||
"details": {
|
||||
"name": "{VIB_ENV_CONTAINER}",
|
||||
"tag": "{VIB_ENV_TAG}"
|
||||
}
|
||||
},
|
||||
"architectures": [
|
||||
"linux/amd64",
|
||||
"linux/arm64"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"action_id": "container-image-lint",
|
||||
"params": {
|
||||
"threshold": "error"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"verify": {
|
||||
"actions": [
|
||||
{
|
||||
"action_id": "goss",
|
||||
"params": {
|
||||
"resources": {
|
||||
"path": "/.vib"
|
||||
},
|
||||
"tests_file": "jasperreports/goss/goss.yaml",
|
||||
"vars_file": "jasperreports/goss/vars.yaml",
|
||||
"remote": {
|
||||
"pod": {
|
||||
"workload": "deploy-jasperreports"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"action_id": "trivy",
|
||||
"params": {
|
||||
"threshold": "CRITICAL",
|
||||
"vuln_type": [
|
||||
"OS"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"action_id": "grype",
|
||||
"params": {
|
||||
"threshold": "CRITICAL",
|
||||
"package_type": [
|
||||
"OS"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,65 +0,0 @@
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
FROM docker.io/bitnami/minideb:bullseye
|
||||
|
||||
ARG JAVA_EXTRA_SECURITY_DIR="/bitnami/java/extra-security"
|
||||
ARG TARGETARCH
|
||||
|
||||
LABEL com.vmware.cp.artifact.flavor="sha256:1e1b4657a77f0d47e9220f0c37b9bf7802581b93214fff7d1bd2364c8bf22e8e" \
|
||||
org.opencontainers.image.base.name="docker.io/bitnami/minideb:bullseye" \
|
||||
org.opencontainers.image.created="2024-02-11T23:39:32Z" \
|
||||
org.opencontainers.image.description="Application packaged by VMware, Inc" \
|
||||
org.opencontainers.image.licenses="Apache-2.0" \
|
||||
org.opencontainers.image.ref.name="8.2.0-debian-11-r107" \
|
||||
org.opencontainers.image.title="jasperreports" \
|
||||
org.opencontainers.image.vendor="VMware, Inc." \
|
||||
org.opencontainers.image.version="8.2.0"
|
||||
|
||||
ENV HOME="/" \
|
||||
OS_ARCH="${TARGETARCH:-amd64}" \
|
||||
OS_FLAVOUR="debian-11" \
|
||||
OS_NAME="linux"
|
||||
|
||||
COPY prebuildfs /
|
||||
SHELL ["/bin/bash", "-o", "errexit", "-o", "nounset", "-o", "pipefail", "-c"]
|
||||
# Install required system packages and dependencies
|
||||
RUN install_packages acl ca-certificates curl fontconfig git libaudit1 libbsd0 libcap-ng0 libedit2 libffi7 libgcc-s1 libgmp10 libgnutls30 libhogweed6 libicu67 libidn2-0 libldap-2.4-2 liblzma5 libmd0 libncurses6 libnettle8 libp11-kit0 libpam0g libsasl2-2 libssl1.1 libstdc++6 libtasn1-6 libtinfo6 libunistring2 libuuid1 libxml2 libxslt1.1 procps xmlstarlet zlib1g
|
||||
RUN mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ ; \
|
||||
COMPONENTS=( \
|
||||
"render-template-1.0.6-8-linux-${OS_ARCH}-debian-11" \
|
||||
"java-1.8.402-7-1-linux-${OS_ARCH}-debian-11" \
|
||||
"tomcat-9.0.85-2-linux-${OS_ARCH}-debian-11" \
|
||||
"postgresql-client-15.6.0-0-linux-${OS_ARCH}-debian-11" \
|
||||
"mysql-client-10.11.7-0-linux-${OS_ARCH}-debian-11" \
|
||||
"jasperreports-8.2.0-7-linux-${OS_ARCH}-debian-11" \
|
||||
) ; \
|
||||
for COMPONENT in "${COMPONENTS[@]}"; do \
|
||||
if [ ! -f "${COMPONENT}.tar.gz" ]; then \
|
||||
curl -SsLf "https://downloads.bitnami.com/files/stacksmith/${COMPONENT}.tar.gz" -O ; \
|
||||
curl -SsLf "https://downloads.bitnami.com/files/stacksmith/${COMPONENT}.tar.gz.sha256" -O ; \
|
||||
fi ; \
|
||||
sha256sum -c "${COMPONENT}.tar.gz.sha256" ; \
|
||||
tar -zxf "${COMPONENT}.tar.gz" -C /opt/bitnami --strip-components=2 --no-same-owner --wildcards '*/files' ; \
|
||||
rm -rf "${COMPONENT}".tar.gz{,.sha256} ; \
|
||||
done
|
||||
RUN apt-get update && apt-get upgrade -y && \
|
||||
apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives
|
||||
RUN chmod g+rwX /opt/bitnami
|
||||
RUN find / -perm /6000 -type f -exec chmod a-s {} \; || true
|
||||
|
||||
COPY rootfs /
|
||||
RUN /opt/bitnami/scripts/tomcat/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/jasperreports/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/java/postunpack.sh
|
||||
RUN /opt/bitnami/scripts/mysql-client/postunpack.sh
|
||||
ENV APP_VERSION="8.2.0" \
|
||||
BITNAMI_APP_NAME="jasperreports" \
|
||||
JAVA_HOME="/opt/bitnami/java" \
|
||||
PATH="/opt/bitnami/common/bin:/opt/bitnami/java/bin:/opt/bitnami/tomcat/bin:/opt/bitnami/postgresql/bin:/opt/bitnami/mysql/bin:$PATH"
|
||||
|
||||
EXPOSE 8009 8080 8443
|
||||
|
||||
USER 1001
|
||||
ENTRYPOINT [ "/opt/bitnami/scripts/jasperreports/entrypoint.sh" ]
|
||||
CMD [ "/opt/bitnami/scripts/tomcat/run.sh" ]
|
||||
@@ -1,34 +0,0 @@
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
version: '2'
|
||||
services:
|
||||
mariadb:
|
||||
image: docker.io/bitnami/mariadb:10.11
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami/mariadb'
|
||||
environment:
|
||||
# ALLOW_EMPTY_PASSWORD is recommended only for development.
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- MARIADB_USER=bn_jasperreports
|
||||
- MARIADB_DATABASE=bitnami_jasperreports
|
||||
jasperreports:
|
||||
image: docker.io/bitnami/jasperreports:8
|
||||
ports:
|
||||
- '80:8080'
|
||||
volumes:
|
||||
- 'jasperreports_data:/bitnami/jasperreports'
|
||||
depends_on:
|
||||
- mariadb
|
||||
environment:
|
||||
# ALLOW_EMPTY_PASSWORD is recommended only for development.
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- JASPERREPORTS_DATABASE_HOST=mariadb
|
||||
- JASPERREPORTS_DATABASE_PORT_NUMBER=3306
|
||||
- JASPERREPORTS_DATABASE_USER=bn_jasperreports
|
||||
- JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports
|
||||
volumes:
|
||||
mariadb_data:
|
||||
driver: local
|
||||
jasperreports_data:
|
||||
driver: local
|
||||
@@ -1,38 +0,0 @@
|
||||
{
|
||||
"jasperreports": {
|
||||
"arch": "amd64",
|
||||
"distro": "debian-11",
|
||||
"type": "NAMI",
|
||||
"version": "8.2.0-7"
|
||||
},
|
||||
"java": {
|
||||
"arch": "amd64",
|
||||
"distro": "debian-11",
|
||||
"type": "NAMI",
|
||||
"version": "1.8.402-7-1"
|
||||
},
|
||||
"mysql-client": {
|
||||
"arch": "amd64",
|
||||
"distro": "debian-11",
|
||||
"type": "NAMI",
|
||||
"version": "10.11.7-0"
|
||||
},
|
||||
"postgresql-client": {
|
||||
"arch": "amd64",
|
||||
"distro": "debian-11",
|
||||
"type": "NAMI",
|
||||
"version": "15.6.0-0"
|
||||
},
|
||||
"render-template": {
|
||||
"arch": "amd64",
|
||||
"distro": "debian-11",
|
||||
"type": "NAMI",
|
||||
"version": "1.0.6-8"
|
||||
},
|
||||
"tomcat": {
|
||||
"arch": "amd64",
|
||||
"distro": "debian-11",
|
||||
"type": "NAMI",
|
||||
"version": "9.0.85-2"
|
||||
}
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
Bitnami containers ship with software bundles. You can find the licenses under:
|
||||
/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt
|
||||
@@ -1,53 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Bitnami custom library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Constants
|
||||
BOLD='\033[1m'
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Print the welcome page
|
||||
# Globals:
|
||||
# DISABLE_WELCOME_MESSAGE
|
||||
# BITNAMI_APP_NAME
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
print_welcome_page() {
|
||||
if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then
|
||||
if [[ -n "$BITNAMI_APP_NAME" ]]; then
|
||||
print_image_welcome_page
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Print the welcome page for a Bitnami Docker image
|
||||
# Globals:
|
||||
# BITNAMI_APP_NAME
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
print_image_welcome_page() {
|
||||
local github_url="https://github.com/bitnami/containers"
|
||||
|
||||
info ""
|
||||
info "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}"
|
||||
info "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}"
|
||||
info "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}"
|
||||
info ""
|
||||
}
|
||||
|
||||
@@ -1,141 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Library for managing files
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Replace a regex-matching string in a file
|
||||
# Arguments:
|
||||
# $1 - filename
|
||||
# $2 - match regex
|
||||
# $3 - substitute regex
|
||||
# $4 - use POSIX regex. Default: true
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
replace_in_file() {
|
||||
local filename="${1:?filename is required}"
|
||||
local match_regex="${2:?match regex is required}"
|
||||
local substitute_regex="${3:?substitute regex is required}"
|
||||
local posix_regex=${4:-true}
|
||||
|
||||
local result
|
||||
|
||||
# We should avoid using 'sed in-place' substitutions
|
||||
# 1) They are not compatible with files mounted from ConfigMap(s)
|
||||
# 2) We found incompatibility issues with Debian10 and "in-place" substitutions
|
||||
local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues
|
||||
if [[ $posix_regex = true ]]; then
|
||||
result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")"
|
||||
else
|
||||
result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")"
|
||||
fi
|
||||
echo "$result" > "$filename"
|
||||
}
|
||||
|
||||
########################
|
||||
# Replace a regex-matching multiline string in a file
|
||||
# Arguments:
|
||||
# $1 - filename
|
||||
# $2 - match regex
|
||||
# $3 - substitute regex
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
replace_in_file_multiline() {
|
||||
local filename="${1:?filename is required}"
|
||||
local match_regex="${2:?match regex is required}"
|
||||
local substitute_regex="${3:?substitute regex is required}"
|
||||
|
||||
local result
|
||||
local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues
|
||||
result="$(perl -pe "BEGIN{undef $/;} s${del}${match_regex}${del}${substitute_regex}${del}sg" "$filename")"
|
||||
echo "$result" > "$filename"
|
||||
}
|
||||
|
||||
########################
|
||||
# Remove a line in a file based on a regex
|
||||
# Arguments:
|
||||
# $1 - filename
|
||||
# $2 - match regex
|
||||
# $3 - use POSIX regex. Default: true
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
remove_in_file() {
|
||||
local filename="${1:?filename is required}"
|
||||
local match_regex="${2:?match regex is required}"
|
||||
local posix_regex=${3:-true}
|
||||
local result
|
||||
|
||||
# We should avoid using 'sed in-place' substitutions
|
||||
# 1) They are not compatible with files mounted from ConfigMap(s)
|
||||
# 2) We found incompatibility issues with Debian10 and "in-place" substitutions
|
||||
if [[ $posix_regex = true ]]; then
|
||||
result="$(sed -E "/$match_regex/d" "$filename")"
|
||||
else
|
||||
result="$(sed "/$match_regex/d" "$filename")"
|
||||
fi
|
||||
echo "$result" > "$filename"
|
||||
}
|
||||
|
||||
########################
|
||||
# Appends text after the last line matching a pattern
|
||||
# Arguments:
|
||||
# $1 - file
|
||||
# $2 - match regex
|
||||
# $3 - contents to add
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
append_file_after_last_match() {
|
||||
local file="${1:?missing file}"
|
||||
local match_regex="${2:?missing pattern}"
|
||||
local value="${3:?missing value}"
|
||||
|
||||
# We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again
|
||||
result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)"
|
||||
echo "$result" > "$file"
|
||||
}
|
||||
|
||||
########################
|
||||
# Wait until certain entry is present in a log file
|
||||
# Arguments:
|
||||
# $1 - entry to look for
|
||||
# $2 - log file
|
||||
# $3 - max retries. Default: 12
|
||||
# $4 - sleep between retries (in seconds). Default: 5
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
wait_for_log_entry() {
|
||||
local -r entry="${1:-missing entry}"
|
||||
local -r log_file="${2:-missing log file}"
|
||||
local -r retries="${3:-12}"
|
||||
local -r interval_time="${4:-5}"
|
||||
local attempt=0
|
||||
|
||||
check_log_file_for_entry() {
|
||||
if ! grep -qE "$entry" "$log_file"; then
|
||||
debug "Entry \"${entry}\" still not present in ${log_file} (attempt $((++attempt))/${retries})"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
debug "Checking that ${log_file} log file contains entry \"${entry}\""
|
||||
if retry_while check_log_file_for_entry "$retries" "$interval_time"; then
|
||||
debug "Found entry \"${entry}\" in ${log_file}"
|
||||
true
|
||||
else
|
||||
error "Could not find entry \"${entry}\" in ${log_file} after ${retries} retries"
|
||||
debug_execute cat "$log_file"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
@@ -1,193 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Library for file system actions
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Ensure a file/directory is owned (user and group) but the given user
|
||||
# Arguments:
|
||||
# $1 - filepath
|
||||
# $2 - owner
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
owned_by() {
|
||||
local path="${1:?path is missing}"
|
||||
local owner="${2:?owner is missing}"
|
||||
local group="${3:-}"
|
||||
|
||||
if [[ -n $group ]]; then
|
||||
chown "$owner":"$group" "$path"
|
||||
else
|
||||
chown "$owner":"$owner" "$path"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure a directory exists and, optionally, is owned by the given user
|
||||
# Arguments:
|
||||
# $1 - directory
|
||||
# $2 - owner
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
ensure_dir_exists() {
|
||||
local dir="${1:?directory is missing}"
|
||||
local owner_user="${2:-}"
|
||||
local owner_group="${3:-}"
|
||||
|
||||
[ -d "${dir}" ] || mkdir -p "${dir}"
|
||||
if [[ -n $owner_user ]]; then
|
||||
owned_by "$dir" "$owner_user" "$owner_group"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Checks whether a directory is empty or not
|
||||
# arguments:
|
||||
# $1 - directory
|
||||
# returns:
|
||||
# boolean
|
||||
#########################
|
||||
is_dir_empty() {
|
||||
local -r path="${1:?missing directory}"
|
||||
# Calculate real path in order to avoid issues with symlinks
|
||||
local -r dir="$(realpath "$path")"
|
||||
if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Checks whether a mounted directory is empty or not
|
||||
# arguments:
|
||||
# $1 - directory
|
||||
# returns:
|
||||
# boolean
|
||||
#########################
|
||||
is_mounted_dir_empty() {
|
||||
local dir="${1:?missing directory}"
|
||||
|
||||
if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Checks whether a file can be written to or not
|
||||
# arguments:
|
||||
# $1 - file
|
||||
# returns:
|
||||
# boolean
|
||||
#########################
|
||||
is_file_writable() {
|
||||
local file="${1:?missing file}"
|
||||
local dir
|
||||
dir="$(dirname "$file")"
|
||||
|
||||
if [[ (-f "$file" && -w "$file") || (! -f "$file" && -d "$dir" && -w "$dir") ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Relativize a path
|
||||
# arguments:
|
||||
# $1 - path
|
||||
# $2 - base
|
||||
# returns:
|
||||
# None
|
||||
#########################
|
||||
relativize() {
|
||||
local -r path="${1:?missing path}"
|
||||
local -r base="${2:?missing base}"
|
||||
pushd "$base" >/dev/null || exit
|
||||
realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||'
|
||||
popd >/dev/null || exit
|
||||
}
|
||||
|
||||
########################
|
||||
# Configure permisions and ownership recursively
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# $1 - paths (as a string).
|
||||
# Flags:
|
||||
# -f|--file-mode - mode for directories.
|
||||
# -d|--dir-mode - mode for files.
|
||||
# -u|--user - user
|
||||
# -g|--group - group
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
configure_permissions_ownership() {
|
||||
local -r paths="${1:?paths is missing}"
|
||||
local dir_mode=""
|
||||
local file_mode=""
|
||||
local user=""
|
||||
local group=""
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-f | --file-mode)
|
||||
shift
|
||||
file_mode="${1:?missing mode for files}"
|
||||
;;
|
||||
-d | --dir-mode)
|
||||
shift
|
||||
dir_mode="${1:?missing mode for directories}"
|
||||
;;
|
||||
-u | --user)
|
||||
shift
|
||||
user="${1:?missing user}"
|
||||
;;
|
||||
-g | --group)
|
||||
shift
|
||||
group="${1:?missing group}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
read -r -a filepaths <<<"$paths"
|
||||
for p in "${filepaths[@]}"; do
|
||||
if [[ -e "$p" ]]; then
|
||||
find -L "$p" -printf ""
|
||||
if [[ -n $dir_mode ]]; then
|
||||
find -L "$p" -type d ! -perm "$dir_mode" -print0 | xargs -r -0 chmod "$dir_mode"
|
||||
fi
|
||||
if [[ -n $file_mode ]]; then
|
||||
find -L "$p" -type f ! -perm "$file_mode" -print0 | xargs -r -0 chmod "$file_mode"
|
||||
fi
|
||||
if [[ -n $user ]] && [[ -n $group ]]; then
|
||||
find -L "$p" -print0 | xargs -r -0 chown "${user}:${group}"
|
||||
elif [[ -n $user ]] && [[ -z $group ]]; then
|
||||
find -L "$p" -print0 | xargs -r -0 chown "${user}"
|
||||
elif [[ -z $user ]] && [[ -n $group ]]; then
|
||||
find -L "$p" -print0 | xargs -r -0 chgrp "${group}"
|
||||
fi
|
||||
else
|
||||
stderr_print "$p does not exist"
|
||||
fi
|
||||
done
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Library to use for scripts expected to be used as Kubernetes lifecycle hooks
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load generic libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
|
||||
# Override functions that log to stdout/stderr of the current process, so they print to process 1
|
||||
for function_to_override in stderr_print debug_execute; do
|
||||
# Output is sent to output of process 1 and thus end up in the container log
|
||||
# The hook output in general isn't saved
|
||||
eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2"
|
||||
done
|
||||
@@ -1,114 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Library for logging functions
|
||||
|
||||
# Constants
|
||||
RESET='\033[0m'
|
||||
RED='\033[38;5;1m'
|
||||
GREEN='\033[38;5;2m'
|
||||
YELLOW='\033[38;5;3m'
|
||||
MAGENTA='\033[38;5;5m'
|
||||
CYAN='\033[38;5;6m'
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Print to STDERR
|
||||
# Arguments:
|
||||
# Message to print
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
stderr_print() {
|
||||
# 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it
|
||||
local bool="${BITNAMI_QUIET:-false}"
|
||||
# comparison is performed without regard to the case of alphabetic characters
|
||||
shopt -s nocasematch
|
||||
if ! [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then
|
||||
printf "%b\\n" "${*}" >&2
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Log message
|
||||
# Arguments:
|
||||
# Message to log
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
log() {
|
||||
stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}"
|
||||
}
|
||||
########################
|
||||
# Log an 'info' message
|
||||
# Arguments:
|
||||
# Message to log
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
info() {
|
||||
log "${GREEN}INFO ${RESET} ==> ${*}"
|
||||
}
|
||||
########################
|
||||
# Log message
|
||||
# Arguments:
|
||||
# Message to log
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
warn() {
|
||||
log "${YELLOW}WARN ${RESET} ==> ${*}"
|
||||
}
|
||||
########################
|
||||
# Log an 'error' message
|
||||
# Arguments:
|
||||
# Message to log
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
error() {
|
||||
log "${RED}ERROR${RESET} ==> ${*}"
|
||||
}
|
||||
########################
|
||||
# Log a 'debug' message
|
||||
# Globals:
|
||||
# BITNAMI_DEBUG
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
debug() {
|
||||
# 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it
|
||||
local bool="${BITNAMI_DEBUG:-false}"
|
||||
# comparison is performed without regard to the case of alphabetic characters
|
||||
shopt -s nocasematch
|
||||
if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then
|
||||
log "${MAGENTA}DEBUG${RESET} ==> ${*}"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Indent a string
|
||||
# Arguments:
|
||||
# $1 - string
|
||||
# $2 - number of indentation characters (default: 4)
|
||||
# $3 - indentation character (default: " ")
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
indent() {
|
||||
local string="${1:-}"
|
||||
local num="${2:?missing num}"
|
||||
local char="${3:-" "}"
|
||||
# Build the indentation unit string
|
||||
local indent_unit=""
|
||||
for ((i = 0; i < num; i++)); do
|
||||
indent_unit="${indent_unit}${char}"
|
||||
done
|
||||
# shellcheck disable=SC2001
|
||||
# Complex regex, see https://github.com/koalaman/shellcheck/wiki/SC2001#exceptions
|
||||
echo "$string" | sed "s/^/${indent_unit}/"
|
||||
}
|
||||
@@ -1,165 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Library for network functions
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Resolve IP address for a host/domain (i.e. DNS lookup)
|
||||
# Arguments:
|
||||
# $1 - Hostname to resolve
|
||||
# $2 - IP address version (v4, v6), leave empty for resolving to any version
|
||||
# Returns:
|
||||
# IP
|
||||
#########################
|
||||
dns_lookup() {
|
||||
local host="${1:?host is missing}"
|
||||
local ip_version="${2:-}"
|
||||
getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1
|
||||
}
|
||||
|
||||
#########################
|
||||
# Wait for a hostname and return the IP
|
||||
# Arguments:
|
||||
# $1 - hostname
|
||||
# $2 - number of retries
|
||||
# $3 - seconds to wait between retries
|
||||
# Returns:
|
||||
# - IP address that corresponds to the hostname
|
||||
#########################
|
||||
wait_for_dns_lookup() {
|
||||
local hostname="${1:?hostname is missing}"
|
||||
local retries="${2:-5}"
|
||||
local seconds="${3:-1}"
|
||||
check_host() {
|
||||
if [[ $(dns_lookup "$hostname") == "" ]]; then
|
||||
false
|
||||
else
|
||||
true
|
||||
fi
|
||||
}
|
||||
# Wait for the host to be ready
|
||||
retry_while "check_host ${hostname}" "$retries" "$seconds"
|
||||
dns_lookup "$hostname"
|
||||
}
|
||||
|
||||
########################
|
||||
# Get machine's IP
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Machine IP
|
||||
#########################
|
||||
get_machine_ip() {
|
||||
local -a ip_addresses
|
||||
local hostname
|
||||
hostname="$(hostname)"
|
||||
read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)"
|
||||
if [[ "${#ip_addresses[@]}" -gt 1 ]]; then
|
||||
warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}"
|
||||
elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then
|
||||
error "Could not find any IP address associated to hostname ${hostname}"
|
||||
exit 1
|
||||
fi
|
||||
echo "${ip_addresses[0]}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a resolved hostname
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_hostname_resolved() {
|
||||
local -r host="${1:?missing value}"
|
||||
if [[ -n "$(dns_lookup "$host")" ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Parse URL
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# $1 - uri - String
|
||||
# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String
|
||||
# Returns:
|
||||
# String
|
||||
parse_uri() {
|
||||
local uri="${1:?uri is missing}"
|
||||
local component="${2:?component is missing}"
|
||||
|
||||
# Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with
|
||||
# additional sub-expressions to split authority into userinfo, host and port
|
||||
# Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969)
|
||||
local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-9]+))?))?(/([^?#]*))?(\?([^#]*))?(#(.*))?'
|
||||
# || | ||| | | | | | | | | |
|
||||
# |2 scheme | ||6 userinfo 7 host | 9 port | 11 rpath | 13 query | 15 fragment
|
||||
# 1 scheme: | |5 userinfo@ 8 :... 10 path 12 ?... 14 #...
|
||||
# | 4 authority
|
||||
# 3 //...
|
||||
local index=0
|
||||
case "$component" in
|
||||
scheme)
|
||||
index=2
|
||||
;;
|
||||
authority)
|
||||
index=4
|
||||
;;
|
||||
userinfo)
|
||||
index=6
|
||||
;;
|
||||
host)
|
||||
index=7
|
||||
;;
|
||||
port)
|
||||
index=9
|
||||
;;
|
||||
path)
|
||||
index=10
|
||||
;;
|
||||
query)
|
||||
index=13
|
||||
;;
|
||||
fragment)
|
||||
index=14
|
||||
;;
|
||||
*)
|
||||
stderr_print "unrecognized component $component"
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
[[ "$uri" =~ $URI_REGEX ]] && echo "${BASH_REMATCH[${index}]}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Wait for a HTTP connection to succeed
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - URL to wait for
|
||||
# $2 - Maximum amount of retries (optional)
|
||||
# $3 - Time between retries (optional)
|
||||
# Returns:
|
||||
# true if the HTTP connection succeeded, false otherwise
|
||||
#########################
|
||||
wait_for_http_connection() {
|
||||
local url="${1:?missing url}"
|
||||
local retries="${2:-}"
|
||||
local sleep_time="${3:-}"
|
||||
if ! retry_while "debug_execute curl --silent ${url}" "$retries" "$sleep_time"; then
|
||||
error "Could not connect to ${url}"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
@@ -1,657 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Library for operating system actions
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/libvalidations.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Check if an user exists in the system
|
||||
# Arguments:
|
||||
# $1 - user
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
user_exists() {
|
||||
local user="${1:?user is missing}"
|
||||
id "$user" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if a group exists in the system
|
||||
# Arguments:
|
||||
# $1 - group
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
group_exists() {
|
||||
local group="${1:?group is missing}"
|
||||
getent group "$group" >/dev/null 2>&1
|
||||
}
|
||||
|
||||
########################
|
||||
# Create a group in the system if it does not exist already
|
||||
# Arguments:
|
||||
# $1 - group
|
||||
# Flags:
|
||||
# -i|--gid - the ID for the new group
|
||||
# -s|--system - Whether to create new user as system user (uid <= 999)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
ensure_group_exists() {
|
||||
local group="${1:?group is missing}"
|
||||
local gid=""
|
||||
local is_system_user=false
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-i | --gid)
|
||||
shift
|
||||
gid="${1:?missing gid}"
|
||||
;;
|
||||
-s | --system)
|
||||
is_system_user=true
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if ! group_exists "$group"; then
|
||||
local -a args=("$group")
|
||||
if [[ -n "$gid" ]]; then
|
||||
if group_exists "$gid"; then
|
||||
error "The GID $gid is already in use." >&2
|
||||
return 1
|
||||
fi
|
||||
args+=("--gid" "$gid")
|
||||
fi
|
||||
$is_system_user && args+=("--system")
|
||||
groupadd "${args[@]}" >/dev/null 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Create an user in the system if it does not exist already
|
||||
# Arguments:
|
||||
# $1 - user
|
||||
# Flags:
|
||||
# -i|--uid - the ID for the new user
|
||||
# -g|--group - the group the new user should belong to
|
||||
# -a|--append-groups - comma-separated list of supplemental groups to append to the new user
|
||||
# -h|--home - the home directory for the new user
|
||||
# -s|--system - whether to create new user as system user (uid <= 999)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
ensure_user_exists() {
|
||||
local user="${1:?user is missing}"
|
||||
local uid=""
|
||||
local group=""
|
||||
local append_groups=""
|
||||
local home=""
|
||||
local is_system_user=false
|
||||
|
||||
# Validate arguments
|
||||
shift 1
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-i | --uid)
|
||||
shift
|
||||
uid="${1:?missing uid}"
|
||||
;;
|
||||
-g | --group)
|
||||
shift
|
||||
group="${1:?missing group}"
|
||||
;;
|
||||
-a | --append-groups)
|
||||
shift
|
||||
append_groups="${1:?missing append_groups}"
|
||||
;;
|
||||
-h | --home)
|
||||
shift
|
||||
home="${1:?missing home directory}"
|
||||
;;
|
||||
-s | --system)
|
||||
is_system_user=true
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if ! user_exists "$user"; then
|
||||
local -a user_args=("-N" "$user")
|
||||
if [[ -n "$uid" ]]; then
|
||||
if user_exists "$uid"; then
|
||||
error "The UID $uid is already in use."
|
||||
return 1
|
||||
fi
|
||||
user_args+=("--uid" "$uid")
|
||||
else
|
||||
$is_system_user && user_args+=("--system")
|
||||
fi
|
||||
useradd "${user_args[@]}" >/dev/null 2>&1
|
||||
fi
|
||||
|
||||
if [[ -n "$group" ]]; then
|
||||
local -a group_args=("$group")
|
||||
$is_system_user && group_args+=("--system")
|
||||
ensure_group_exists "${group_args[@]}"
|
||||
usermod -g "$group" "$user" >/dev/null 2>&1
|
||||
fi
|
||||
|
||||
if [[ -n "$append_groups" ]]; then
|
||||
local -a groups
|
||||
read -ra groups <<<"$(tr ',;' ' ' <<<"$append_groups")"
|
||||
for group in "${groups[@]}"; do
|
||||
ensure_group_exists "$group"
|
||||
usermod -aG "$group" "$user" >/dev/null 2>&1
|
||||
done
|
||||
fi
|
||||
|
||||
if [[ -n "$home" ]]; then
|
||||
mkdir -p "$home"
|
||||
usermod -d "$home" "$user" >/dev/null 2>&1
|
||||
configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the script is currently running as root
|
||||
# Arguments:
|
||||
# $1 - user
|
||||
# $2 - group
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
am_i_root() {
|
||||
if [[ "$(id -u)" = "0" ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Print OS metadata
|
||||
# Arguments:
|
||||
# $1 - Flag name
|
||||
# Flags:
|
||||
# --id - Distro ID
|
||||
# --version - Distro version
|
||||
# --branch - Distro branch
|
||||
# --codename - Distro codename
|
||||
# --name - Distro name
|
||||
# --pretty-name - Distro pretty name
|
||||
# Returns:
|
||||
# String
|
||||
#########################
|
||||
get_os_metadata() {
|
||||
local -r flag_name="${1:?missing flag}"
|
||||
# Helper function
|
||||
get_os_release_metadata() {
|
||||
local -r env_name="${1:?missing environment variable name}"
|
||||
(
|
||||
. /etc/os-release
|
||||
echo "${!env_name}"
|
||||
)
|
||||
}
|
||||
case "$flag_name" in
|
||||
--id)
|
||||
get_os_release_metadata ID
|
||||
;;
|
||||
--version)
|
||||
get_os_release_metadata VERSION_ID
|
||||
;;
|
||||
--branch)
|
||||
get_os_release_metadata VERSION_ID | sed 's/\..*//'
|
||||
;;
|
||||
--codename)
|
||||
get_os_release_metadata VERSION_CODENAME
|
||||
;;
|
||||
--name)
|
||||
get_os_release_metadata NAME
|
||||
;;
|
||||
--pretty-name)
|
||||
get_os_release_metadata PRETTY_NAME
|
||||
;;
|
||||
*)
|
||||
error "Unknown flag ${flag_name}"
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
########################
|
||||
# Get total memory available
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Memory in bytes
|
||||
#########################
|
||||
get_total_memory() {
|
||||
echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024))
|
||||
}
|
||||
|
||||
########################
|
||||
# Get machine size depending on specified memory
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Flags:
|
||||
# --memory - memory size (optional)
|
||||
# Returns:
|
||||
# Detected instance size
|
||||
#########################
|
||||
get_machine_size() {
|
||||
local memory=""
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--memory)
|
||||
shift
|
||||
memory="${1:?missing memory}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
if [[ -z "$memory" ]]; then
|
||||
debug "Memory was not specified, detecting available memory automatically"
|
||||
memory="$(get_total_memory)"
|
||||
fi
|
||||
sanitized_memory=$(convert_to_mb "$memory")
|
||||
if [[ "$sanitized_memory" -gt 26000 ]]; then
|
||||
echo 2xlarge
|
||||
elif [[ "$sanitized_memory" -gt 13000 ]]; then
|
||||
echo xlarge
|
||||
elif [[ "$sanitized_memory" -gt 6000 ]]; then
|
||||
echo large
|
||||
elif [[ "$sanitized_memory" -gt 3000 ]]; then
|
||||
echo medium
|
||||
elif [[ "$sanitized_memory" -gt 1500 ]]; then
|
||||
echo small
|
||||
else
|
||||
echo micro
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Get machine size depending on specified memory
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# $1 - memory size (optional)
|
||||
# Returns:
|
||||
# Detected instance size
|
||||
#########################
|
||||
get_supported_machine_sizes() {
|
||||
echo micro small medium large xlarge 2xlarge
|
||||
}
|
||||
|
||||
########################
|
||||
# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048)
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# $1 - memory size
|
||||
# Returns:
|
||||
# Result of the conversion
|
||||
#########################
|
||||
convert_to_mb() {
|
||||
local amount="${1:-}"
|
||||
if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then
|
||||
size="${BASH_REMATCH[1]}"
|
||||
unit="${BASH_REMATCH[2]}"
|
||||
if [[ "$unit" = "g" || "$unit" = "G" ]]; then
|
||||
amount="$((size * 1024))"
|
||||
else
|
||||
amount="$size"
|
||||
fi
|
||||
fi
|
||||
echo "$amount"
|
||||
}
|
||||
|
||||
#########################
|
||||
# Redirects output to /dev/null if debug mode is disabled
|
||||
# Globals:
|
||||
# BITNAMI_DEBUG
|
||||
# Arguments:
|
||||
# $@ - Command to execute
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
debug_execute() {
|
||||
if is_boolean_yes "${BITNAMI_DEBUG:-false}"; then
|
||||
"$@"
|
||||
else
|
||||
"$@" >/dev/null 2>&1
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Retries a command a given number of times
|
||||
# Arguments:
|
||||
# $1 - cmd (as a string)
|
||||
# $2 - max retries. Default: 12
|
||||
# $3 - sleep between retries (in seconds). Default: 5
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
retry_while() {
|
||||
local cmd="${1:?cmd is missing}"
|
||||
local retries="${2:-12}"
|
||||
local sleep_time="${3:-5}"
|
||||
local return_value=1
|
||||
|
||||
read -r -a command <<<"$cmd"
|
||||
for ((i = 1; i <= retries; i += 1)); do
|
||||
"${command[@]}" && return_value=0 && break
|
||||
sleep "$sleep_time"
|
||||
done
|
||||
return $return_value
|
||||
}
|
||||
|
||||
########################
|
||||
# Generate a random string
|
||||
# Arguments:
|
||||
# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii
|
||||
# -c|--count - Number of characters, defaults to 32
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
# Returns:
|
||||
# String
|
||||
#########################
|
||||
generate_random_string() {
|
||||
local type="ascii"
|
||||
local count="32"
|
||||
local filter
|
||||
local result
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
-t | --type)
|
||||
shift
|
||||
type="$1"
|
||||
;;
|
||||
-c | --count)
|
||||
shift
|
||||
count="$1"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
# Validate type
|
||||
case "$type" in
|
||||
ascii)
|
||||
filter="[:print:]"
|
||||
;;
|
||||
numeric)
|
||||
filter="0-9"
|
||||
;;
|
||||
alphanumeric)
|
||||
filter="a-zA-Z0-9"
|
||||
;;
|
||||
alphanumeric+special|special+alphanumeric)
|
||||
# Limit variety of special characters, so there is a higher chance of containing more alphanumeric characters
|
||||
# Special characters are harder to write, and it could impact the overall UX if most passwords are too complex
|
||||
filter='a-zA-Z0-9:@.,/+!='
|
||||
;;
|
||||
*)
|
||||
echo "Invalid type ${type}" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
# Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size
|
||||
# Note there is a very small chance of strings starting with EOL character
|
||||
# Therefore, the higher amount of lines read, this will happen less frequently
|
||||
result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")"
|
||||
echo "$result"
|
||||
}
|
||||
|
||||
########################
|
||||
# Create md5 hash from a string
|
||||
# Arguments:
|
||||
# $1 - string
|
||||
# Returns:
|
||||
# md5 hash - string
|
||||
#########################
|
||||
generate_md5_hash() {
|
||||
local -r str="${1:?missing input string}"
|
||||
echo -n "$str" | md5sum | awk '{print $1}'
|
||||
}
|
||||
|
||||
########################
|
||||
# Create sha1 hash from a string
|
||||
# Arguments:
|
||||
# $1 - string
|
||||
# $2 - algorithm - 1 (default), 224, 256, 384, 512
|
||||
# Returns:
|
||||
# sha1 hash - string
|
||||
#########################
|
||||
generate_sha_hash() {
|
||||
local -r str="${1:?missing input string}"
|
||||
local -r algorithm="${2:-1}"
|
||||
echo -n "$str" | "sha${algorithm}sum" | awk '{print $1}'
|
||||
}
|
||||
|
||||
########################
|
||||
# Converts a string to its hexadecimal representation
|
||||
# Arguments:
|
||||
# $1 - string
|
||||
# Returns:
|
||||
# hexadecimal representation of the string
|
||||
#########################
|
||||
convert_to_hex() {
|
||||
local -r str=${1:?missing input string}
|
||||
local -i iterator
|
||||
local char
|
||||
for ((iterator = 0; iterator < ${#str}; iterator++)); do
|
||||
char=${str:iterator:1}
|
||||
printf '%x' "'${char}"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Get boot time
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Boot time metadata
|
||||
#########################
|
||||
get_boot_time() {
|
||||
stat /proc --format=%Y
|
||||
}
|
||||
|
||||
########################
|
||||
# Get machine ID
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Machine ID
|
||||
#########################
|
||||
get_machine_id() {
|
||||
local machine_id
|
||||
if [[ -f /etc/machine-id ]]; then
|
||||
machine_id="$(cat /etc/machine-id)"
|
||||
fi
|
||||
if [[ -z "$machine_id" ]]; then
|
||||
# Fallback to the boot-time, which will at least ensure a unique ID in the current session
|
||||
machine_id="$(get_boot_time)"
|
||||
fi
|
||||
echo "$machine_id"
|
||||
}
|
||||
|
||||
########################
|
||||
# Get the root partition's disk device ID (e.g. /dev/sda1)
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Root partition disk ID
|
||||
#########################
|
||||
get_disk_device_id() {
|
||||
local device_id=""
|
||||
if grep -q ^/dev /proc/mounts; then
|
||||
device_id="$(grep ^/dev /proc/mounts | awk '$2 == "/" { print $1 }' | tail -1)"
|
||||
fi
|
||||
# If it could not be autodetected, fallback to /dev/sda1 as a default
|
||||
if [[ -z "$device_id" || ! -b "$device_id" ]]; then
|
||||
device_id="/dev/sda1"
|
||||
fi
|
||||
echo "$device_id"
|
||||
}
|
||||
|
||||
########################
|
||||
# Get the root disk device ID (e.g. /dev/sda)
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Root disk ID
|
||||
#########################
|
||||
get_root_disk_device_id() {
|
||||
get_disk_device_id | sed -E 's/p?[0-9]+$//'
|
||||
}
|
||||
|
||||
########################
|
||||
# Get the root disk size in bytes
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# Root disk size in bytes
|
||||
#########################
|
||||
get_root_disk_size() {
|
||||
fdisk -l "$(get_root_disk_device_id)" | grep 'Disk.*bytes' | sed -E 's/.*, ([0-9]+) bytes,.*/\1/' || true
|
||||
}
|
||||
|
||||
########################
|
||||
# Run command as a specific user and group (optional)
|
||||
# Arguments:
|
||||
# $1 - USER(:GROUP) to switch to
|
||||
# $2..$n - command to execute
|
||||
# Returns:
|
||||
# Exit code of the specified command
|
||||
#########################
|
||||
run_as_user() {
|
||||
run_chroot "$@"
|
||||
}
|
||||
|
||||
########################
|
||||
# Execute command as a specific user and group (optional),
|
||||
# replacing the current process image
|
||||
# Arguments:
|
||||
# $1 - USER(:GROUP) to switch to
|
||||
# $2..$n - command to execute
|
||||
# Returns:
|
||||
# Exit code of the specified command
|
||||
#########################
|
||||
exec_as_user() {
|
||||
run_chroot --replace-process "$@"
|
||||
}
|
||||
|
||||
########################
|
||||
# Run a command using chroot
|
||||
# Arguments:
|
||||
# $1 - USER(:GROUP) to switch to
|
||||
# $2..$n - command to execute
|
||||
# Flags:
|
||||
# -r | --replace-process - Replace the current process image (optional)
|
||||
# Returns:
|
||||
# Exit code of the specified command
|
||||
#########################
|
||||
run_chroot() {
|
||||
local userspec
|
||||
local user
|
||||
local homedir
|
||||
local replace=false
|
||||
local -r cwd="$(pwd)"
|
||||
|
||||
# Parse and validate flags
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
-r | --replace-process)
|
||||
replace=true
|
||||
;;
|
||||
--)
|
||||
shift
|
||||
break
|
||||
;;
|
||||
-*)
|
||||
stderr_print "unrecognized flag $1"
|
||||
return 1
|
||||
;;
|
||||
*)
|
||||
break
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
# Parse and validate arguments
|
||||
if [[ "$#" -lt 2 ]]; then
|
||||
echo "expected at least 2 arguments"
|
||||
return 1
|
||||
else
|
||||
userspec=$1
|
||||
shift
|
||||
|
||||
# userspec can optionally include the group, so we parse the user
|
||||
user=$(echo "$userspec" | cut -d':' -f1)
|
||||
fi
|
||||
|
||||
if ! am_i_root; then
|
||||
error "Could not switch to '${userspec}': Operation not permitted"
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Get the HOME directory for the user to switch, as chroot does
|
||||
# not properly update this env and some scripts rely on it
|
||||
homedir=$(eval echo "~${user}")
|
||||
if [[ ! -d $homedir ]]; then
|
||||
homedir="${HOME:-/}"
|
||||
fi
|
||||
|
||||
# Obtaining value for "$@" indirectly in order to properly support shell parameter expansion
|
||||
if [[ "$replace" = true ]]; then
|
||||
exec chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@"
|
||||
else
|
||||
chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@"
|
||||
fi
|
||||
}
|
||||
@@ -1,124 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Bitnami persistence library
|
||||
# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libversion.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Persist an application directory
|
||||
# Globals:
|
||||
# BITNAMI_ROOT_DIR
|
||||
# BITNAMI_VOLUME_DIR
|
||||
# Arguments:
|
||||
# $1 - App folder name
|
||||
# $2 - List of app files to persist
|
||||
# Returns:
|
||||
# true if all steps succeeded, false otherwise
|
||||
#########################
|
||||
persist_app() {
|
||||
local -r app="${1:?missing app}"
|
||||
local -a files_to_restore
|
||||
read -r -a files_to_persist <<< "$(tr ',;:' ' ' <<< "$2")"
|
||||
local -r install_dir="${BITNAMI_ROOT_DIR}/${app}"
|
||||
local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}"
|
||||
# Persist the individual files
|
||||
if [[ "${#files_to_persist[@]}" -le 0 ]]; then
|
||||
warn "No files are configured to be persisted"
|
||||
return
|
||||
fi
|
||||
pushd "$install_dir" >/dev/null || exit
|
||||
local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder
|
||||
local -r tmp_file="/tmp/perms.acl"
|
||||
for file_to_persist in "${files_to_persist[@]}"; do
|
||||
if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then
|
||||
error "Cannot persist '${file_to_persist}' because it does not exist"
|
||||
return 1
|
||||
fi
|
||||
file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")"
|
||||
file_to_persist_destination="${persist_dir}/${file_to_persist_relative}"
|
||||
file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")"
|
||||
# Get original permissions for existing files, which will be applied later
|
||||
# Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume
|
||||
getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file"
|
||||
# Copy directories to the volume
|
||||
ensure_dir_exists "$file_to_persist_destination_folder"
|
||||
cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder"
|
||||
# Restore permissions
|
||||
pushd "$persist_dir" >/dev/null || exit
|
||||
if am_i_root; then
|
||||
setfacl --restore="$tmp_file"
|
||||
else
|
||||
# When running as non-root, don't change ownership
|
||||
setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file")
|
||||
fi
|
||||
popd >/dev/null || exit
|
||||
done
|
||||
popd >/dev/null || exit
|
||||
rm -f "$tmp_file"
|
||||
# Install the persisted files into the installation directory, via symlinks
|
||||
restore_persisted_app "$@"
|
||||
}
|
||||
|
||||
########################
|
||||
# Restore a persisted application directory
|
||||
# Globals:
|
||||
# BITNAMI_ROOT_DIR
|
||||
# BITNAMI_VOLUME_DIR
|
||||
# FORCE_MAJOR_UPGRADE
|
||||
# Arguments:
|
||||
# $1 - App folder name
|
||||
# $2 - List of app files to restore
|
||||
# Returns:
|
||||
# true if all steps succeeded, false otherwise
|
||||
#########################
|
||||
restore_persisted_app() {
|
||||
local -r app="${1:?missing app}"
|
||||
local -a files_to_restore
|
||||
read -r -a files_to_restore <<< "$(tr ',;:' ' ' <<< "$2")"
|
||||
local -r install_dir="${BITNAMI_ROOT_DIR}/${app}"
|
||||
local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}"
|
||||
# Restore the individual persisted files
|
||||
if [[ "${#files_to_restore[@]}" -le 0 ]]; then
|
||||
warn "No persisted files are configured to be restored"
|
||||
return
|
||||
fi
|
||||
local file_to_restore_relative file_to_restore_origin file_to_restore_destination
|
||||
for file_to_restore in "${files_to_restore[@]}"; do
|
||||
file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")"
|
||||
# We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed
|
||||
file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")"
|
||||
file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")"
|
||||
rm -rf "$file_to_restore_origin"
|
||||
ln -sfn "$file_to_restore_destination" "$file_to_restore_origin"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if an application directory was already persisted
|
||||
# Globals:
|
||||
# BITNAMI_VOLUME_DIR
|
||||
# Arguments:
|
||||
# $1 - App folder name
|
||||
# Returns:
|
||||
# true if all steps succeeded, false otherwise
|
||||
#########################
|
||||
is_app_initialized() {
|
||||
local -r app="${1:?missing app}"
|
||||
local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}"
|
||||
if ! is_mounted_dir_empty "$persist_dir"; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
@@ -1,496 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Library for managing services
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/libvalidations.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Read the provided pid file and returns a PID
|
||||
# Arguments:
|
||||
# $1 - Pid file
|
||||
# Returns:
|
||||
# PID
|
||||
#########################
|
||||
get_pid_from_file() {
|
||||
local pid_file="${1:?pid file is missing}"
|
||||
|
||||
if [[ -f "$pid_file" ]]; then
|
||||
if [[ -n "$(< "$pid_file")" ]] && [[ "$(< "$pid_file")" -gt 0 ]]; then
|
||||
echo "$(< "$pid_file")"
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if a provided PID corresponds to a running service
|
||||
# Arguments:
|
||||
# $1 - PID
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_service_running() {
|
||||
local pid="${1:?pid is missing}"
|
||||
|
||||
kill -0 "$pid" 2>/dev/null
|
||||
}
|
||||
|
||||
########################
|
||||
# Stop a service by sending a termination signal to its pid
|
||||
# Arguments:
|
||||
# $1 - Pid file
|
||||
# $2 - Signal number (optional)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
stop_service_using_pid() {
|
||||
local pid_file="${1:?pid file is missing}"
|
||||
local signal="${2:-}"
|
||||
local pid
|
||||
|
||||
pid="$(get_pid_from_file "$pid_file")"
|
||||
[[ -z "$pid" ]] || ! is_service_running "$pid" && return
|
||||
|
||||
if [[ -n "$signal" ]]; then
|
||||
kill "-${signal}" "$pid"
|
||||
else
|
||||
kill "$pid"
|
||||
fi
|
||||
|
||||
local counter=10
|
||||
while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do
|
||||
sleep 1
|
||||
counter=$((counter - 1))
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Start cron daemon
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# true if started correctly, false otherwise
|
||||
#########################
|
||||
cron_start() {
|
||||
if [[ -x "/usr/sbin/cron" ]]; then
|
||||
/usr/sbin/cron
|
||||
elif [[ -x "/usr/sbin/crond" ]]; then
|
||||
/usr/sbin/crond
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Generate a cron configuration file for a given service
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# $2 - Command
|
||||
# Flags:
|
||||
# --run-as - User to run as (default: root)
|
||||
# --schedule - Cron schedule configuration (default: * * * * *)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
generate_cron_conf() {
|
||||
local service_name="${1:?service name is missing}"
|
||||
local cmd="${2:?command is missing}"
|
||||
local run_as="root"
|
||||
local schedule="* * * * *"
|
||||
local clean="true"
|
||||
|
||||
# Parse optional CLI flags
|
||||
shift 2
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--run-as)
|
||||
shift
|
||||
run_as="$1"
|
||||
;;
|
||||
--schedule)
|
||||
shift
|
||||
schedule="$1"
|
||||
;;
|
||||
--no-clean)
|
||||
clean="false"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag ${1}" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
mkdir -p /etc/cron.d
|
||||
if "$clean"; then
|
||||
cat > "/etc/cron.d/${service_name}" <<EOF
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
${schedule} ${run_as} ${cmd}
|
||||
EOF
|
||||
else
|
||||
echo "${schedule} ${run_as} ${cmd}" >> /etc/cron.d/"$service_name"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Remove a cron configuration file for a given service
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
remove_cron_conf() {
|
||||
local service_name="${1:?service name is missing}"
|
||||
local cron_conf_dir="/etc/monit/conf.d"
|
||||
rm -f "${cron_conf_dir}/${service_name}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Generate a monit configuration file for a given service
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# $2 - Pid file
|
||||
# $3 - Start command
|
||||
# $4 - Stop command
|
||||
# Flags:
|
||||
# --disable - Whether to disable the monit configuration
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
generate_monit_conf() {
|
||||
local service_name="${1:?service name is missing}"
|
||||
local pid_file="${2:?pid file is missing}"
|
||||
local start_command="${3:?start command is missing}"
|
||||
local stop_command="${4:?stop command is missing}"
|
||||
local monit_conf_dir="/etc/monit/conf.d"
|
||||
local disabled="no"
|
||||
|
||||
# Parse optional CLI flags
|
||||
shift 4
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--disable)
|
||||
disabled="yes"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag ${1}" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
is_boolean_yes "$disabled" && conf_suffix=".disabled"
|
||||
mkdir -p "$monit_conf_dir"
|
||||
cat > "${monit_conf_dir}/${service_name}.conf${conf_suffix:-}" <<EOF
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
########################
|
||||
# Remove a monit configuration file for a given service
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
remove_monit_conf() {
|
||||
local service_name="${1:?service name is missing}"
|
||||
local monit_conf_dir="/etc/monit/conf.d"
|
||||
rm -f "${monit_conf_dir}/${service_name}.conf"
|
||||
}
|
||||
|
||||
########################
|
||||
# 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}"
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
${log_path} {
|
||||
${period}
|
||||
rotate ${rotations}
|
||||
dateext
|
||||
compress
|
||||
copytruncate
|
||||
missingok
|
||||
$(indent "$extra" 2)
|
||||
}
|
||||
EOF
|
||||
}
|
||||
|
||||
########################
|
||||
# Remove a logrotate configuration file
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
remove_logrotate_conf() {
|
||||
local service_name="${1:?service name is missing}"
|
||||
local logrotate_conf_dir="/etc/logrotate.d"
|
||||
rm -f "${logrotate_conf_dir}/${service_name}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Generate a Systemd configuration file
|
||||
# Arguments:
|
||||
# $1 - Service name
|
||||
# Flags:
|
||||
# --custom-service-content - Custom content to add to the [service] block
|
||||
# --environment - Environment variable to define (multiple --environment options may be passed)
|
||||
# --environment-file - Text file with environment variables (multiple --environment-file options may be passed)
|
||||
# --exec-start - Start command (required)
|
||||
# --exec-start-pre - Pre-start command (optional)
|
||||
# --exec-start-post - Post-start command (optional)
|
||||
# --exec-stop - Stop command (optional)
|
||||
# --exec-reload - Reload command (optional)
|
||||
# --group - System group to start the service with
|
||||
# --name - Service full name (e.g. Apache HTTP Server, defaults to $1)
|
||||
# --restart - When to restart the Systemd service after being stopped (defaults to always)
|
||||
# --pid-file - Service PID file
|
||||
# --standard-output - File where to print stdout output
|
||||
# --standard-error - File where to print stderr output
|
||||
# --success-exit-status - Exit code that indicates a successful shutdown
|
||||
# --type - Systemd unit type (defaults to forking)
|
||||
# --user - System user to start the service with
|
||||
# --working-directory - Working directory at which to start the service
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
generate_systemd_conf() {
|
||||
local -r service_name="${1:?service name is missing}"
|
||||
local -r systemd_units_dir="/etc/systemd/system"
|
||||
local -r service_file="${systemd_units_dir}/bitnami.${service_name}.service"
|
||||
# Default values
|
||||
local name="$service_name"
|
||||
local type="forking"
|
||||
local user=""
|
||||
local group=""
|
||||
local environment=""
|
||||
local environment_file=""
|
||||
local exec_start=""
|
||||
local exec_start_pre=""
|
||||
local exec_start_post=""
|
||||
local exec_stop=""
|
||||
local exec_reload=""
|
||||
local restart="always"
|
||||
local pid_file=""
|
||||
local standard_output="journal"
|
||||
local standard_error=""
|
||||
local limits_content=""
|
||||
local success_exit_status=""
|
||||
local custom_service_content=""
|
||||
local working_directory=""
|
||||
# Parse CLI flags
|
||||
shift
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--name \
|
||||
| --type \
|
||||
| --user \
|
||||
| --group \
|
||||
| --exec-start \
|
||||
| --exec-stop \
|
||||
| --exec-reload \
|
||||
| --restart \
|
||||
| --pid-file \
|
||||
| --standard-output \
|
||||
| --standard-error \
|
||||
| --success-exit-status \
|
||||
| --custom-service-content \
|
||||
| --working-directory \
|
||||
)
|
||||
var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
|
||||
shift
|
||||
declare "$var_name"="${1:?"${var_name} value is missing"}"
|
||||
;;
|
||||
--limit-*)
|
||||
[[ -n "$limits_content" ]] && limits_content+=$'\n'
|
||||
var_name="${1//--limit-}"
|
||||
shift
|
||||
limits_content+="Limit${var_name^^}=${1:?"--limit-${var_name} value is missing"}"
|
||||
;;
|
||||
--exec-start-pre)
|
||||
shift
|
||||
[[ -n "$exec_start_pre" ]] && exec_start_pre+=$'\n'
|
||||
exec_start_pre+="ExecStartPre=${1:?"--exec-start-pre value is missing"}"
|
||||
;;
|
||||
--exec-start-post)
|
||||
shift
|
||||
[[ -n "$exec_start_post" ]] && exec_start_post+=$'\n'
|
||||
exec_start_post+="ExecStartPost=${1:?"--exec-start-post value is missing"}"
|
||||
;;
|
||||
--environment)
|
||||
shift
|
||||
# It is possible to add multiple environment lines
|
||||
[[ -n "$environment" ]] && environment+=$'\n'
|
||||
environment+="Environment=${1:?"--environment value is missing"}"
|
||||
;;
|
||||
--environment-file)
|
||||
shift
|
||||
# It is possible to add multiple environment-file lines
|
||||
[[ -n "$environment_file" ]] && environment_file+=$'\n'
|
||||
environment_file+="EnvironmentFile=${1:?"--environment-file value is missing"}"
|
||||
;;
|
||||
*)
|
||||
echo "Invalid command line flag ${1}" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
# Validate inputs
|
||||
local error="no"
|
||||
if [[ -z "$exec_start" ]]; then
|
||||
error "The --exec-start option is required"
|
||||
error="yes"
|
||||
fi
|
||||
if [[ "$error" != "no" ]]; then
|
||||
return 1
|
||||
fi
|
||||
# Generate the Systemd unit
|
||||
cat > "$service_file" <<EOF
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
[Unit]
|
||||
Description=Bitnami service for ${name}
|
||||
# Starting/stopping the main bitnami service should cause the same effect for this service
|
||||
PartOf=bitnami.service
|
||||
|
||||
[Service]
|
||||
Type=${type}
|
||||
EOF
|
||||
if [[ -n "$working_directory" ]]; then
|
||||
cat >> "$service_file" <<< "WorkingDirectory=${working_directory}"
|
||||
fi
|
||||
if [[ -n "$exec_start_pre" ]]; then
|
||||
# This variable may contain multiple ExecStartPre= directives
|
||||
cat >> "$service_file" <<< "$exec_start_pre"
|
||||
fi
|
||||
if [[ -n "$exec_start" ]]; then
|
||||
cat >> "$service_file" <<< "ExecStart=${exec_start}"
|
||||
fi
|
||||
if [[ -n "$exec_start_post" ]]; then
|
||||
# This variable may contain multiple ExecStartPost= directives
|
||||
cat >> "$service_file" <<< "$exec_start_post"
|
||||
fi
|
||||
# Optional stop and reload commands
|
||||
if [[ -n "$exec_stop" ]]; then
|
||||
cat >> "$service_file" <<< "ExecStop=${exec_stop}"
|
||||
fi
|
||||
if [[ -n "$exec_reload" ]]; then
|
||||
cat >> "$service_file" <<< "ExecReload=${exec_reload}"
|
||||
fi
|
||||
# User and group
|
||||
if [[ -n "$user" ]]; then
|
||||
cat >> "$service_file" <<< "User=${user}"
|
||||
fi
|
||||
if [[ -n "$group" ]]; then
|
||||
cat >> "$service_file" <<< "Group=${group}"
|
||||
fi
|
||||
# PID file allows to determine if the main process is running properly (for Restart=always)
|
||||
if [[ -n "$pid_file" ]]; then
|
||||
cat >> "$service_file" <<< "PIDFile=${pid_file}"
|
||||
fi
|
||||
if [[ -n "$restart" ]]; then
|
||||
cat >> "$service_file" <<< "Restart=${restart}"
|
||||
fi
|
||||
# Environment flags
|
||||
if [[ -n "$environment" ]]; then
|
||||
# This variable may contain multiple Environment= directives
|
||||
cat >> "$service_file" <<< "$environment"
|
||||
fi
|
||||
if [[ -n "$environment_file" ]]; then
|
||||
# This variable may contain multiple EnvironmentFile= directives
|
||||
cat >> "$service_file" <<< "$environment_file"
|
||||
fi
|
||||
# Logging
|
||||
if [[ -n "$standard_output" ]]; then
|
||||
cat >> "$service_file" <<< "StandardOutput=${standard_output}"
|
||||
fi
|
||||
if [[ -n "$standard_error" ]]; then
|
||||
cat >> "$service_file" <<< "StandardError=${standard_error}"
|
||||
fi
|
||||
if [[ -n "$custom_service_content" ]]; then
|
||||
# This variable may contain multiple miscellaneous directives
|
||||
cat >> "$service_file" <<< "$custom_service_content"
|
||||
fi
|
||||
if [[ -n "$success_exit_status" ]]; then
|
||||
cat >> "$service_file" <<EOF
|
||||
# When the process receives a SIGTERM signal, it exits with code ${success_exit_status}
|
||||
SuccessExitStatus=${success_exit_status}
|
||||
EOF
|
||||
fi
|
||||
cat >> "$service_file" <<EOF
|
||||
# Optimizations
|
||||
TimeoutStartSec=2min
|
||||
TimeoutStopSec=30s
|
||||
IgnoreSIGPIPE=no
|
||||
KillMode=mixed
|
||||
EOF
|
||||
if [[ -n "$limits_content" ]]; then
|
||||
cat >> "$service_file" <<EOF
|
||||
# Limits
|
||||
${limits_content}
|
||||
EOF
|
||||
fi
|
||||
cat >> "$service_file" <<EOF
|
||||
|
||||
[Install]
|
||||
# Enabling/disabling the main bitnami service should cause the same effect for this service
|
||||
WantedBy=bitnami.service
|
||||
EOF
|
||||
}
|
||||
@@ -1,304 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Validation functions library
|
||||
|
||||
# shellcheck disable=SC1091,SC2086
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
|
||||
########################
|
||||
# Check if the provided argument is an integer
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_int() {
|
||||
local -r int="${1:?missing value}"
|
||||
if [[ "$int" =~ ^-?[0-9]+ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a positive integer
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_positive_int() {
|
||||
local -r int="${1:?missing value}"
|
||||
if is_int "$int" && (( "${int}" >= 0 )); then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a boolean or is the string 'yes/true'
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_boolean_yes() {
|
||||
local -r bool="${1:-}"
|
||||
# comparison is performed without regard to the case of alphabetic characters
|
||||
shopt -s nocasematch
|
||||
if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a boolean yes/no value
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_yes_no_value() {
|
||||
local -r bool="${1:-}"
|
||||
if [[ "$bool" =~ ^(yes|no)$ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a boolean true/false value
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_true_false_value() {
|
||||
local -r bool="${1:-}"
|
||||
if [[ "$bool" =~ ^(true|false)$ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is a boolean 1/0 value
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_1_0_value() {
|
||||
local -r bool="${1:-}"
|
||||
if [[ "$bool" =~ ^[10]$ ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if the provided argument is an empty string or not defined
|
||||
# Arguments:
|
||||
# $1 - Value to check
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
is_empty_value() {
|
||||
local -r val="${1:-}"
|
||||
if [[ -z "$val" ]]; then
|
||||
true
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate if the provided argument is a valid port
|
||||
# Arguments:
|
||||
# $1 - Port to validate
|
||||
# Returns:
|
||||
# Boolean and error message
|
||||
#########################
|
||||
validate_port() {
|
||||
local value
|
||||
local unprivileged=0
|
||||
|
||||
# Parse flags
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
-unprivileged)
|
||||
unprivileged=1
|
||||
;;
|
||||
--)
|
||||
shift
|
||||
break
|
||||
;;
|
||||
-*)
|
||||
stderr_print "unrecognized flag $1"
|
||||
return 1
|
||||
;;
|
||||
*)
|
||||
break
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if [[ "$#" -gt 1 ]]; then
|
||||
echo "too many arguments provided"
|
||||
return 2
|
||||
elif [[ "$#" -eq 0 ]]; then
|
||||
stderr_print "missing port argument"
|
||||
return 1
|
||||
else
|
||||
value=$1
|
||||
fi
|
||||
|
||||
if [[ -z "$value" ]]; then
|
||||
echo "the value is empty"
|
||||
return 1
|
||||
else
|
||||
if ! is_int "$value"; then
|
||||
echo "value is not an integer"
|
||||
return 2
|
||||
elif [[ "$value" -lt 0 ]]; then
|
||||
echo "negative value provided"
|
||||
return 2
|
||||
elif [[ "$value" -gt 65535 ]]; then
|
||||
echo "requested port is greater than 65535"
|
||||
return 2
|
||||
elif [[ "$unprivileged" = 1 && "$value" -lt 1024 ]]; then
|
||||
echo "privileged port requested"
|
||||
return 3
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate if the provided argument is a valid IPv6 address
|
||||
# Arguments:
|
||||
# $1 - IP to validate
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
validate_ipv6() {
|
||||
local ip="${1:?ip is missing}"
|
||||
local stat=1
|
||||
local full_address_regex='^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$'
|
||||
local short_address_regex='^((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}){0,6}::(([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}){0,6})$'
|
||||
|
||||
if [[ $ip =~ $full_address_regex || $ip =~ $short_address_regex || $ip == "::" ]]; then
|
||||
stat=0
|
||||
fi
|
||||
return $stat
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate if the provided argument is a valid IPv4 address
|
||||
# Arguments:
|
||||
# $1 - IP to validate
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
validate_ipv4() {
|
||||
local ip="${1:?ip is missing}"
|
||||
local stat=1
|
||||
|
||||
if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
|
||||
read -r -a ip_array <<< "$(tr '.' ' ' <<< "$ip")"
|
||||
[[ ${ip_array[0]} -le 255 && ${ip_array[1]} -le 255 \
|
||||
&& ${ip_array[2]} -le 255 && ${ip_array[3]} -le 255 ]]
|
||||
stat=$?
|
||||
fi
|
||||
return $stat
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate if the provided argument is a valid IPv4 or IPv6 address
|
||||
# Arguments:
|
||||
# $1 - IP to validate
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
validate_ip() {
|
||||
local ip="${1:?ip is missing}"
|
||||
local stat=1
|
||||
|
||||
if validate_ipv4 "$ip"; then
|
||||
stat=0
|
||||
else
|
||||
stat=$(validate_ipv6 "$ip")
|
||||
fi
|
||||
return $stat
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate a string format
|
||||
# Arguments:
|
||||
# $1 - String to validate
|
||||
# Returns:
|
||||
# Boolean
|
||||
#########################
|
||||
validate_string() {
|
||||
local string
|
||||
local min_length=-1
|
||||
local max_length=-1
|
||||
|
||||
# Parse flags
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
-min-length)
|
||||
shift
|
||||
min_length=${1:-}
|
||||
;;
|
||||
-max-length)
|
||||
shift
|
||||
max_length=${1:-}
|
||||
;;
|
||||
--)
|
||||
shift
|
||||
break
|
||||
;;
|
||||
-*)
|
||||
stderr_print "unrecognized flag $1"
|
||||
return 1
|
||||
;;
|
||||
*)
|
||||
break
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if [ "$#" -gt 1 ]; then
|
||||
stderr_print "too many arguments provided"
|
||||
return 2
|
||||
elif [ "$#" -eq 0 ]; then
|
||||
stderr_print "missing string"
|
||||
return 1
|
||||
else
|
||||
string=$1
|
||||
fi
|
||||
|
||||
if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then
|
||||
echo "string length is less than $min_length"
|
||||
return 1
|
||||
fi
|
||||
if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then
|
||||
echo "string length is great than $max_length"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Library for managing versions strings
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Functions
|
||||
########################
|
||||
# Gets semantic version
|
||||
# Arguments:
|
||||
# $1 - version: string to extract major.minor.patch
|
||||
# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch
|
||||
# Returns:
|
||||
# array with the major, minor and release
|
||||
#########################
|
||||
get_sematic_version () {
|
||||
local version="${1:?version is required}"
|
||||
local section="${2:?section is required}"
|
||||
local -a version_sections
|
||||
|
||||
#Regex to parse versions: x.y.z
|
||||
local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?'
|
||||
|
||||
if [[ "$version" =~ $regex ]]; then
|
||||
local i=1
|
||||
local j=1
|
||||
local n=${#BASH_REMATCH[*]}
|
||||
|
||||
while [[ $i -lt $n ]]; do
|
||||
if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then
|
||||
version_sections[j]="${BASH_REMATCH[$i]}"
|
||||
((j++))
|
||||
fi
|
||||
((i++))
|
||||
done
|
||||
|
||||
local number_regex='^[0-9]+$'
|
||||
if [[ "$section" =~ $number_regex ]] && (( section > 0 )) && (( section <= 3 )); then
|
||||
echo "${version_sections[$section]}"
|
||||
return
|
||||
else
|
||||
stderr_print "Section allowed values are: 1, 2, and 3"
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
}
|
||||
@@ -1,476 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Bitnami web server handler library
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
# Load generic libraries
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
########################
|
||||
# Execute a command (or list of commands) with the web server environment and library loaded
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_execute() {
|
||||
local -r web_server="${1:?missing web server}"
|
||||
shift
|
||||
# Run program in sub-shell to avoid web server environment getting loaded when not necessary
|
||||
(
|
||||
. "/opt/bitnami/scripts/lib${web_server}.sh"
|
||||
. "/opt/bitnami/scripts/${web_server}-env.sh"
|
||||
"$@"
|
||||
)
|
||||
}
|
||||
|
||||
########################
|
||||
# Prints the list of enabled web servers
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_list() {
|
||||
local -r -a supported_web_servers=(apache nginx)
|
||||
local -a existing_web_servers=()
|
||||
for web_server in "${supported_web_servers[@]}"; do
|
||||
[[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server")
|
||||
done
|
||||
echo "${existing_web_servers[@]:-}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Prints the currently-enabled web server type (only one, in order of preference)
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_type() {
|
||||
local -a web_servers
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
echo "${web_servers[0]:-}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Validate that a supported web server is configured
|
||||
# Globals:
|
||||
# None
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_validate() {
|
||||
local error_code=0
|
||||
local supported_web_servers=("apache" "nginx")
|
||||
|
||||
# Auxiliary functions
|
||||
print_validation_error() {
|
||||
error "$1"
|
||||
error_code=1
|
||||
}
|
||||
|
||||
if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then
|
||||
print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}"
|
||||
elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then
|
||||
print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable."
|
||||
fi
|
||||
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Check whether the web server is running
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# true if the web server is running, false otherwise
|
||||
#########################
|
||||
is_web_server_running() {
|
||||
"is_$(web_server_type)_running"
|
||||
}
|
||||
|
||||
########################
|
||||
# Start web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_start() {
|
||||
info "Starting $(web_server_type) in background"
|
||||
if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then
|
||||
systemctl start "bitnami.$(web_server_type).service"
|
||||
else
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Stop web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_stop() {
|
||||
info "Stopping $(web_server_type)"
|
||||
if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then
|
||||
systemctl stop "bitnami.$(web_server_type).service"
|
||||
else
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Restart web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_restart() {
|
||||
info "Restarting $(web_server_type)"
|
||||
if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then
|
||||
systemctl restart "bitnami.$(web_server_type).service"
|
||||
else
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Reload web server
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_reload() {
|
||||
if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then
|
||||
systemctl reload "bitnami.$(web_server_type).service"
|
||||
else
|
||||
"${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block)
|
||||
# It serves as a wrapper for the specific web server function
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - App name
|
||||
# Flags:
|
||||
# --type - Application type, which has an effect on which configuration template to use
|
||||
# --hosts - Host listen addresses
|
||||
# --server-name - Server name
|
||||
# --server-aliases - Server aliases
|
||||
# --allow-remote-connections - Whether to allow remote connections or to require local connections
|
||||
# --disable - Whether to render server configurations with a .disabled prefix
|
||||
# --disable-http - Whether to render the app's HTTP server configuration with a .disabled prefix
|
||||
# --disable-https - Whether to render the app's HTTPS server configuration with a .disabled prefix
|
||||
# --http-port - HTTP port number
|
||||
# --https-port - HTTPS port number
|
||||
# --document-root - Path to document root directory
|
||||
# Apache-specific flags:
|
||||
# --apache-additional-configuration - Additional vhost configuration (no default)
|
||||
# --apache-additional-http-configuration - Additional HTTP vhost configuration (no default)
|
||||
# --apache-additional-https-configuration - Additional HTTPS vhost configuration (no default)
|
||||
# --apache-before-vhost-configuration - Configuration to add before the <VirtualHost> directive (no default)
|
||||
# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no' and type is not defined)
|
||||
# --apache-extra-directory-configuration - Extra configuration for the document root directory
|
||||
# --apache-proxy-address - Address where to proxy requests
|
||||
# --apache-proxy-configuration - Extra configuration for the proxy
|
||||
# --apache-proxy-http-configuration - Extra configuration for the proxy HTTP vhost
|
||||
# --apache-proxy-https-configuration - Extra configuration for the proxy HTTPS vhost
|
||||
# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup (only allowed when type is not defined)
|
||||
# NGINX-specific flags:
|
||||
# --nginx-additional-configuration - Additional server block configuration (no default)
|
||||
# --nginx-external-configuration - Configuration external to server block (no default)
|
||||
# Returns:
|
||||
# true if the configuration was enabled, false otherwise
|
||||
########################
|
||||
ensure_web_server_app_configuration_exists() {
|
||||
local app="${1:?missing app}"
|
||||
shift
|
||||
local -a apache_args nginx_args web_servers args_var
|
||||
apache_args=("$app")
|
||||
nginx_args=("$app")
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
# Common flags
|
||||
--disable \
|
||||
| --disable-http \
|
||||
| --disable-https \
|
||||
)
|
||||
apache_args+=("$1")
|
||||
nginx_args+=("$1")
|
||||
;;
|
||||
--hosts \
|
||||
| --server-name \
|
||||
| --server-aliases \
|
||||
| --type \
|
||||
| --allow-remote-connections \
|
||||
| --http-port \
|
||||
| --https-port \
|
||||
| --document-root \
|
||||
)
|
||||
apache_args+=("$1" "${2:?missing value}")
|
||||
nginx_args+=("$1" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific Apache flags
|
||||
--apache-additional-configuration \
|
||||
| --apache-additional-http-configuration \
|
||||
| --apache-additional-https-configuration \
|
||||
| --apache-before-vhost-configuration \
|
||||
| --apache-allow-override \
|
||||
| --apache-extra-directory-configuration \
|
||||
| --apache-proxy-address \
|
||||
| --apache-proxy-configuration \
|
||||
| --apache-proxy-http-configuration \
|
||||
| --apache-proxy-https-configuration \
|
||||
| --apache-move-htaccess \
|
||||
)
|
||||
apache_args+=("${1//apache-/}" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific NGINX flags
|
||||
--nginx-additional-configuration \
|
||||
| --nginx-external-configuration)
|
||||
nginx_args+=("${1//nginx-/}" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
args_var="${web_server}_args[@]"
|
||||
web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block)
|
||||
# It serves as a wrapper for the specific web server function
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - App name
|
||||
# Returns:
|
||||
# true if the configuration was disabled, false otherwise
|
||||
########################
|
||||
ensure_web_server_app_configuration_not_exists() {
|
||||
local app="${1:?missing app}"
|
||||
local -a web_servers
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure the web server loads the configuration for an application in a URL prefix
|
||||
# It serves as a wrapper for the specific web server function
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - App name
|
||||
# Flags:
|
||||
# --allow-remote-connections - Whether to allow remote connections or to require local connections
|
||||
# --document-root - Path to document root directory
|
||||
# --prefix - URL prefix from where it will be accessible (i.e. /myapp)
|
||||
# --type - Application type, which has an effect on what configuration template will be used
|
||||
# Apache-specific flags:
|
||||
# --apache-additional-configuration - Additional vhost configuration (no default)
|
||||
# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no')
|
||||
# --apache-extra-directory-configuration - Extra configuration for the document root directory
|
||||
# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup
|
||||
# NGINX-specific flags:
|
||||
# --nginx-additional-configuration - Additional server block configuration (no default)
|
||||
# Returns:
|
||||
# true if the configuration was enabled, false otherwise
|
||||
########################
|
||||
ensure_web_server_prefix_configuration_exists() {
|
||||
local app="${1:?missing app}"
|
||||
shift
|
||||
local -a apache_args nginx_args web_servers args_var
|
||||
apache_args=("$app")
|
||||
nginx_args=("$app")
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
# Common flags
|
||||
--allow-remote-connections \
|
||||
| --document-root \
|
||||
| --prefix \
|
||||
| --type \
|
||||
)
|
||||
apache_args+=("$1" "${2:?missing value}")
|
||||
nginx_args+=("$1" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific Apache flags
|
||||
--apache-additional-configuration \
|
||||
| --apache-allow-override \
|
||||
| --apache-extra-directory-configuration \
|
||||
| --apache-move-htaccess \
|
||||
)
|
||||
apache_args+=("${1//apache-/}" "$2")
|
||||
shift
|
||||
;;
|
||||
|
||||
# Specific NGINX flags
|
||||
--nginx-additional-configuration)
|
||||
nginx_args+=("${1//nginx-/}" "$2")
|
||||
shift
|
||||
;;
|
||||
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
args_var="${web_server}_args[@]"
|
||||
web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports)
|
||||
# It serves as a wrapper for the specific web server function
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# $1 - App name
|
||||
# Flags:
|
||||
# --hosts - Host listen addresses
|
||||
# --server-name - Server name
|
||||
# --server-aliases - Server aliases
|
||||
# --enable-http - Enable HTTP app configuration (if not enabled already)
|
||||
# --enable-https - Enable HTTPS app configuration (if not enabled already)
|
||||
# --disable-http - Disable HTTP app configuration (if not disabled already)
|
||||
# --disable-https - Disable HTTPS app configuration (if not disabled already)
|
||||
# --http-port - HTTP port number
|
||||
# --https-port - HTTPS port number
|
||||
# Returns:
|
||||
# true if the configuration was updated, false otherwise
|
||||
########################
|
||||
web_server_update_app_configuration() {
|
||||
local app="${1:?missing app}"
|
||||
shift
|
||||
local -a args web_servers
|
||||
args=("$app")
|
||||
# Validate arguments
|
||||
while [[ "$#" -gt 0 ]]; do
|
||||
case "$1" in
|
||||
# Common flags
|
||||
--enable-http \
|
||||
| --enable-https \
|
||||
| --disable-http \
|
||||
| --disable-https \
|
||||
)
|
||||
args+=("$1")
|
||||
;;
|
||||
--hosts \
|
||||
| --server-name \
|
||||
| --server-aliases \
|
||||
| --http-port \
|
||||
| --https-port \
|
||||
)
|
||||
args+=("$1" "${2:?missing value}")
|
||||
shift
|
||||
;;
|
||||
|
||||
*)
|
||||
echo "Invalid command line flag $1" >&2
|
||||
return 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
read -r -a web_servers <<< "$(web_server_list)"
|
||||
for web_server in "${web_servers[@]}"; do
|
||||
web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}"
|
||||
done
|
||||
}
|
||||
|
||||
########################
|
||||
# Enable loading page, which shows users that the initialization process is not yet completed
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_enable_loading_page() {
|
||||
ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \
|
||||
--apache-additional-configuration "
|
||||
# Show a HTTP 503 Service Unavailable page by default
|
||||
RedirectMatch 503 ^/$
|
||||
# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes
|
||||
ErrorDocument 404 /index.html
|
||||
ErrorDocument 503 /index.html" \
|
||||
--nginx-additional-configuration "
|
||||
# Show a HTTP 503 Service Unavailable page by default
|
||||
location / {
|
||||
return 503;
|
||||
}
|
||||
# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes
|
||||
error_page 404 @installing;
|
||||
error_page 503 @installing;
|
||||
location @installing {
|
||||
rewrite ^(.*)$ /index.html break;
|
||||
}"
|
||||
web_server_reload
|
||||
}
|
||||
|
||||
########################
|
||||
# Enable loading page, which shows users that the initialization process is not yet completed
|
||||
# Globals:
|
||||
# *
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
web_server_disable_install_page() {
|
||||
ensure_web_server_app_configuration_not_exists "__loading"
|
||||
web_server_reload
|
||||
}
|
||||
@@ -1,27 +0,0 @@
|
||||
#!/bin/sh
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
set -eu
|
||||
|
||||
n=0
|
||||
max=2
|
||||
export DEBIAN_FRONTEND=noninteractive
|
||||
|
||||
until [ $n -gt $max ]; do
|
||||
set +e
|
||||
(
|
||||
apt-get update -qq &&
|
||||
apt-get install -y --no-install-recommends "$@"
|
||||
)
|
||||
CODE=$?
|
||||
set -e
|
||||
if [ $CODE -eq 0 ]; then
|
||||
break
|
||||
fi
|
||||
if [ $n -eq $max ]; then
|
||||
exit $CODE
|
||||
fi
|
||||
echo "apt failed, retrying"
|
||||
n=$(($n + 1))
|
||||
done
|
||||
apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives
|
||||
@@ -1,24 +0,0 @@
|
||||
#!/bin/sh
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
set -u
|
||||
|
||||
if [ $# -eq 0 ]; then
|
||||
>&2 echo "No arguments provided"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
script=$1
|
||||
exit_code="${2:-96}"
|
||||
fail_if_not_present="${3:-n}"
|
||||
|
||||
if test -f "$script"; then
|
||||
sh $script
|
||||
|
||||
if [ $? -ne 0 ]; then
|
||||
exit $((exit_code))
|
||||
fi
|
||||
elif [ "$fail_if_not_present" = "y" ]; then
|
||||
>&2 echo "script not found: $script"
|
||||
exit 127
|
||||
fi
|
||||
@@ -1,129 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Environment configuration for jasperreports
|
||||
|
||||
# The values for all environment variables will be set in the below order of precedence
|
||||
# 1. Custom environment variables defined below after Bitnami defaults
|
||||
# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR
|
||||
# 3. Environment variables overridden via external files using *_FILE variables (see below)
|
||||
# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata)
|
||||
|
||||
# Load logging library
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||
|
||||
# Logging configuration
|
||||
export MODULE="${MODULE:-jasperreports}"
|
||||
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
|
||||
jasperreports_env_vars=(
|
||||
JASPERREPORTS_DATA_TO_PERSIST
|
||||
JASPERREPORTS_HOST
|
||||
JASPERREPORTS_SKIP_BOOTSTRAP
|
||||
JASPERREPORTS_USE_ROOT_URL
|
||||
JASPERREPORTS_USERNAME
|
||||
JASPERREPORTS_PASSWORD
|
||||
JASPERREPORTS_EMAIL
|
||||
JASPERREPORTS_SMTP_HOST
|
||||
JASPERREPORTS_SMTP_PORT_NUMBER
|
||||
JASPERREPORTS_SMTP_USER
|
||||
JASPERREPORTS_SMTP_PASSWORD
|
||||
JASPERREPORTS_SMTP_PROTOCOL
|
||||
JASPERREPORTS_SMTP_EMAIL
|
||||
JASPERREPORTS_DATABASE_TYPE
|
||||
JASPERREPORTS_DATABASE_HOST
|
||||
JASPERREPORTS_DATABASE_PORT_NUMBER
|
||||
JASPERREPORTS_DATABASE_NAME
|
||||
JASPERREPORTS_DATABASE_USER
|
||||
JASPERREPORTS_DATABASE_PASSWORD
|
||||
SMTP_HOST
|
||||
SMTP_PORT
|
||||
JASPERREPORTS_SMTP_PORT
|
||||
SMTP_USER
|
||||
SMTP_PASSWORD
|
||||
SMTP_PROTOCOL
|
||||
SMTP_EMAIL
|
||||
JASPERREPORTS_SMTP_USER
|
||||
MARIADB_HOST
|
||||
MARIADB_PORT_NUMBER
|
||||
MARIADB_DATABASE_NAME
|
||||
MARIADB_DATABASE_USER
|
||||
MARIADB_DATABASE_PASSWORD
|
||||
)
|
||||
for env_var in "${jasperreports_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 jasperreports_env_vars
|
||||
|
||||
# Paths
|
||||
export JASPERREPORTS_BASE_DIR="${BITNAMI_ROOT_DIR}/jasperreports"
|
||||
export JASPERREPORTS_CONF_DIR="${JASPERREPORTS_BASE_DIR}/buildomatic"
|
||||
export JASPERREPORTS_LOGS_DIR="${JASPERREPORTS_BASE_DIR}/WEB-INF/logs"
|
||||
export JASPERREPORTS_LOG_FILE="${JASPERREPORTS_LOGS_DIR}/jasperserver.log"
|
||||
export JASPERREPORTS_CONF_FILE="${JASPERREPORTS_CONF_DIR}/default_master.properties"
|
||||
export PATH="${BITNAMI_ROOT_DIR}/common/bin:${PATH}"
|
||||
|
||||
# JasperReports persistence configuration
|
||||
export JASPERREPORTS_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/jasperreports"
|
||||
export JASPERREPORTS_DATA_TO_PERSIST="${JASPERREPORTS_DATA_TO_PERSIST:-buildomatic/default_master.properties buildomatic/conf_source/db/mysql/db.template.properties buildomatic/conf_source/db/postgresql/db.template.properties .jrsks .jrsksp}"
|
||||
|
||||
# System users (when running with a privileged user)
|
||||
export JASPERREPORTS_DAEMON_USER="tomcat"
|
||||
export JASPERREPORTS_DAEMON_GROUP="tomcat"
|
||||
|
||||
# JasperReports configuration
|
||||
export JASPERREPORTS_HOST="${JASPERREPORTS_HOST:-localhost}" # only used during the first initialization
|
||||
export JASPERREPORTS_SKIP_BOOTSTRAP="${JASPERREPORTS_SKIP_BOOTSTRAP:-no}" # only used during the first initialization
|
||||
export JASPERREPORTS_USE_ROOT_URL="${JASPERREPORTS_USE_ROOT_URL:-false}" # only used during the first initialization
|
||||
|
||||
# JasperReports credentials
|
||||
export JASPERREPORTS_USERNAME="${JASPERREPORTS_USERNAME:-jasperadmin}" # only used during the first initialization
|
||||
export JASPERREPORTS_PASSWORD="${JASPERREPORTS_PASSWORD:-bitnami}" # only used during the first initialization
|
||||
export JASPERREPORTS_EMAIL="${JASPERREPORTS_EMAIL:-user@example.com}" # only used during the first initialization
|
||||
|
||||
# JasperReports SMTP credentials
|
||||
JASPERREPORTS_SMTP_HOST="${JASPERREPORTS_SMTP_HOST:-"${SMTP_HOST:-}"}"
|
||||
export JASPERREPORTS_SMTP_HOST="${JASPERREPORTS_SMTP_HOST:-}" # only used during the first initialization
|
||||
JASPERREPORTS_SMTP_PORT_NUMBER="${JASPERREPORTS_SMTP_PORT_NUMBER:-"${SMTP_PORT:-}"}"
|
||||
JASPERREPORTS_SMTP_PORT_NUMBER="${JASPERREPORTS_SMTP_PORT_NUMBER:-"${JASPERREPORTS_SMTP_PORT:-}"}"
|
||||
export JASPERREPORTS_SMTP_PORT_NUMBER="${JASPERREPORTS_SMTP_PORT_NUMBER:-}" # only used during the first initialization
|
||||
JASPERREPORTS_SMTP_USER="${JASPERREPORTS_SMTP_USER:-"${SMTP_USER:-}"}"
|
||||
export JASPERREPORTS_SMTP_USER="${JASPERREPORTS_SMTP_USER:-}" # only used during the first initialization
|
||||
JASPERREPORTS_SMTP_PASSWORD="${JASPERREPORTS_SMTP_PASSWORD:-"${SMTP_PASSWORD:-}"}"
|
||||
export JASPERREPORTS_SMTP_PASSWORD="${JASPERREPORTS_SMTP_PASSWORD:-}" # only used during the first initialization
|
||||
JASPERREPORTS_SMTP_PROTOCOL="${JASPERREPORTS_SMTP_PROTOCOL:-"${SMTP_PROTOCOL:-}"}"
|
||||
export JASPERREPORTS_SMTP_PROTOCOL="${JASPERREPORTS_SMTP_PROTOCOL:-smtp}" # only used during the first initialization
|
||||
JASPERREPORTS_SMTP_EMAIL="${JASPERREPORTS_SMTP_EMAIL:-"${SMTP_EMAIL:-}"}"
|
||||
JASPERREPORTS_SMTP_EMAIL="${JASPERREPORTS_SMTP_EMAIL:-"${JASPERREPORTS_SMTP_USER:-}"}"
|
||||
export JASPERREPORTS_SMTP_EMAIL="${JASPERREPORTS_SMTP_EMAIL:-fromuser@example.com}" # only used during the first initialization
|
||||
|
||||
# Database configuration
|
||||
export JASPERREPORTS_DATABASE_TYPE="${JASPERREPORTS_DATABASE_TYPE:-mariadb}" # only used during the first initialization
|
||||
export JASPERREPORTS_DEFAULT_DATABASE_HOST="mariadb" # only used at build time
|
||||
JASPERREPORTS_DATABASE_HOST="${JASPERREPORTS_DATABASE_HOST:-"${MARIADB_HOST:-}"}"
|
||||
export JASPERREPORTS_DATABASE_HOST="${JASPERREPORTS_DATABASE_HOST:-$JASPERREPORTS_DEFAULT_DATABASE_HOST}" # only used during the first initialization
|
||||
JASPERREPORTS_DATABASE_PORT_NUMBER="${JASPERREPORTS_DATABASE_PORT_NUMBER:-"${MARIADB_PORT_NUMBER:-}"}"
|
||||
export JASPERREPORTS_DATABASE_PORT_NUMBER="${JASPERREPORTS_DATABASE_PORT_NUMBER:-3306}" # only used during the first initialization
|
||||
JASPERREPORTS_DATABASE_NAME="${JASPERREPORTS_DATABASE_NAME:-"${MARIADB_DATABASE_NAME:-}"}"
|
||||
export JASPERREPORTS_DATABASE_NAME="${JASPERREPORTS_DATABASE_NAME:-bitnami_jasperreports}" # only used during the first initialization
|
||||
JASPERREPORTS_DATABASE_USER="${JASPERREPORTS_DATABASE_USER:-"${MARIADB_DATABASE_USER:-}"}"
|
||||
export JASPERREPORTS_DATABASE_USER="${JASPERREPORTS_DATABASE_USER:-bn_jasperreports}" # only used during the first initialization
|
||||
JASPERREPORTS_DATABASE_PASSWORD="${JASPERREPORTS_DATABASE_PASSWORD:-"${MARIADB_DATABASE_PASSWORD:-}"}"
|
||||
export JASPERREPORTS_DATABASE_PASSWORD="${JASPERREPORTS_DATABASE_PASSWORD:-}" # only used during the first initialization
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
-38
@@ -1,38 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load JasperReports environment
|
||||
. /opt/bitnami/scripts/jasperreports-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libbitnami.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
|
||||
print_welcome_page
|
||||
|
||||
if [[ "$1" = "/opt/bitnami/scripts/tomcat/run.sh" ]]; then
|
||||
/opt/bitnami/scripts/mysql-client/setup.sh
|
||||
/opt/bitnami/scripts/postgresql-client/setup.sh
|
||||
# For compatibility with previous Helm charts, disable Tomcat auth by default
|
||||
TOMCAT_ENABLE_AUTH="${TOMCAT_ENABLE_AUTH:-no}" /opt/bitnami/scripts/tomcat/setup.sh
|
||||
/opt/bitnami/scripts/jasperreports/setup.sh
|
||||
/post-init.sh
|
||||
if ! is_dir_empty "/bitnami/jasperreports-mounted-conf"; then
|
||||
info "** User provided config detected **"
|
||||
info "** Copy and overwrite Jasper config located into config folder and replace into WEB-INF Jasper **"
|
||||
cp -r -L /bitnami/jasperreports-mounted-conf/* /opt/bitnami/jasperreports/WEB-INF/
|
||||
fi
|
||||
info "** JasperReports setup finished! **"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
exec "$@"
|
||||
-61
@@ -1,61 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load JasperReports environment
|
||||
. /opt/bitnami/scripts/jasperreports-env.sh
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libjasperreports.sh
|
||||
. /opt/bitnami/scripts/libfile.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Copy and configure configuration file
|
||||
cp "${JASPERREPORTS_CONF_DIR}/sample_conf/mysql_master.properties" "$JASPERREPORTS_CONF_FILE"
|
||||
|
||||
# Delete duplicate example MySQL configuration lines in the configuration file so it does not break the jasperreports_conf_set function
|
||||
remove_in_file "$JASPERREPORTS_CONF_FILE" "jdbcDriverClass=com.mysql.*"
|
||||
remove_in_file "$JASPERREPORTS_CONF_FILE" "jdbcDataSourceClass=com.mysql"
|
||||
remove_in_file "$JASPERREPORTS_CONF_FILE" "maven.jdbc.groupId=mysql"
|
||||
remove_in_file "$JASPERREPORTS_CONF_FILE" "maven.jdbc.artifactId=mysql.*"
|
||||
remove_in_file "$JASPERREPORTS_CONF_FILE" "maven.jdbc.version=.*bin"
|
||||
remove_in_file "$JASPERREPORTS_CONF_FILE" "# appServerDir"
|
||||
|
||||
# Configure default MariaDB settings
|
||||
jasperreports_conf_set "jdbcDriverClass" "org.mariadb.jdbc.Driver"
|
||||
jasperreports_conf_set "jdbcDataSourceClass" "org.mariadb.jdbc.MySQLDataSource"
|
||||
jasperreports_conf_set "maven.jdbc.groupId" "org.mariadb.jdbc"
|
||||
jasperreports_conf_set "maven.jdbc.artifactId" "mariadb-java-client"
|
||||
jasperreports_conf_set "dbPassword" ""
|
||||
|
||||
# Configure Tomcat path
|
||||
jasperreports_conf_set "appServerDir" "${BITNAMI_ROOT_DIR}/tomcat"
|
||||
|
||||
# Set keystore location (based on https://community.jaspersoft.com/wiki/encryption-jasperreports-server-75)
|
||||
cat <<EOF >"${JASPERREPORTS_CONF_DIR}/keystore.init.properties"
|
||||
ks=${JASPERREPORTS_BASE_DIR}
|
||||
ksp=${JASPERREPORTS_BASE_DIR}
|
||||
EOF
|
||||
|
||||
# Ensure the JasperReports base directory exists and has proper permissions
|
||||
info "Configuring file permissions for JasperReports"
|
||||
ensure_user_exists "$JASPERREPORTS_DAEMON_USER" --group "$JASPERREPORTS_DAEMON_GROUP" --system
|
||||
for dir in "$JASPERREPORTS_BASE_DIR" "$JASPERREPORTS_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 "$JASPERREPORTS_DAEMON_USER" -g "root"
|
||||
done
|
||||
|
||||
# Disable variable that deletes the JASPERREPORTS_BASE_DIR folder when deploying the war file
|
||||
xmlstarlet ed -L -d '//var[@name="warTargetDirDel"]' "${JASPERREPORTS_CONF_DIR}/bin/app-server.xml"
|
||||
|
||||
# Grant execution permissions to the buildomatic and ant scripts
|
||||
chmod +x "$JASPERREPORTS_CONF_DIR"/*.sh "$JASPERREPORTS_CONF_DIR"/bin/*.sh "$JASPERREPORTS_CONF_DIR"/js-ant "$JASPERREPORTS_CONF_DIR"/js-mvn "${JASPERREPORTS_BASE_DIR}/apache-ant/bin/ant" "${JASPERREPORTS_BASE_DIR}/apache-ant/bin/antRun"
|
||||
@@ -1,38 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load JasperReports environment
|
||||
. /opt/bitnami/scripts/jasperreports-env.sh
|
||||
|
||||
# Load MySQL Client environment for 'mysql_remote_execute' (after 'jasperreports-env.sh' so that MODULE is not set to a wrong value)
|
||||
if [[ -f /opt/bitnami/scripts/mysql-client-env.sh ]]; then
|
||||
. /opt/bitnami/scripts/mysql-client-env.sh
|
||||
elif [[ -f /opt/bitnami/scripts/mysql-env.sh ]]; then
|
||||
. /opt/bitnami/scripts/mysql-env.sh
|
||||
elif [[ -f /opt/bitnami/scripts/mariadb-env.sh ]]; then
|
||||
. /opt/bitnami/scripts/mariadb-env.sh
|
||||
fi
|
||||
|
||||
# Load PostgreSQL client environment for 'postgresql_remote_execute' (after 'jasperreports-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/libjasperreports.sh
|
||||
|
||||
# Ensure JasperReports environment variables are valid
|
||||
jasperreports_validate
|
||||
|
||||
# Ensure JasperReports is initialized
|
||||
jasperreports_initialize
|
||||
@@ -1,19 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libbitnami.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
print_welcome_page
|
||||
|
||||
echo ""
|
||||
exec "$@"
|
||||
@@ -1,26 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libfile.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
#
|
||||
# Java post-unpack operations
|
||||
#
|
||||
|
||||
# Override default files in the Java security directory. This is used for
|
||||
# custom base images (with custom CA certificates or block lists is used)
|
||||
|
||||
if [[ -n "${JAVA_EXTRA_SECURITY_DIR:-}" ]] && ! is_dir_empty "$JAVA_EXTRA_SECURITY_DIR"; then
|
||||
info "Adding custom CAs to the Java security folder"
|
||||
cp -Lr "${JAVA_EXTRA_SECURITY_DIR}/." /opt/bitnami/java/lib/security
|
||||
fi
|
||||
@@ -1,536 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Bitnami JasperReports 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 MYSQL/MariaDB database library
|
||||
if [[ -f /opt/bitnami/scripts/libmysqlclient.sh ]]; then
|
||||
. /opt/bitnami/scripts/libmysqlclient.sh
|
||||
elif [[ -f /opt/bitnami/scripts/libmysql.sh ]]; then
|
||||
. /opt/bitnami/scripts/libmysql.sh
|
||||
elif [[ -f /opt/bitnami/scripts/libmariadb.sh ]]; then
|
||||
. /opt/bitnami/scripts/libmariadb.sh
|
||||
fi
|
||||
|
||||
# Load PostgreSQL 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 JASPERREPORTS_* env vars
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# 0 if the validation succeeded, 1 otherwise
|
||||
#########################
|
||||
jasperreports_validate() {
|
||||
debug "Validating settings in JASPERREPORTS_* 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
|
||||
}
|
||||
|
||||
check_multi_value "JASPERREPORTS_DATABASE_TYPE" "mysql mariadb postgresql"
|
||||
|
||||
check_empty_value "JASPERREPORTS_HOST"
|
||||
check_yes_no_value "JASPERREPORTS_SKIP_BOOTSTRAP"
|
||||
! is_empty_value "$JASPERREPORTS_DATABASE_HOST" && check_resolved_hostname "$JASPERREPORTS_DATABASE_HOST"
|
||||
! is_empty_value "$JASPERREPORTS_DATABASE_PORT_NUMBER" && check_valid_port "JASPERREPORTS_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 "JASPERREPORTS_DATABASE_PASSWORD" "JASPERREPORTS_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 "$JASPERREPORTS_SMTP_HOST"; then
|
||||
for empty_env_var in "JASPERREPORTS_SMTP_USER" "JASPERREPORTS_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 "$JASPERREPORTS_SMTP_PORT_NUMBER" && print_validation_error "The JASPERREPORTS_SMTP_PORT_NUMBER environment variable is empty or not set."
|
||||
! is_empty_value "$JASPERREPORTS_SMTP_PORT_NUMBER" && check_valid_port "JASPERREPORTS_SMTP_PORT_NUMBER"
|
||||
! is_empty_value "$JASPERREPORTS_SMTP_PROTOCOL" && check_multi_value "JASPERREPORTS_SMTP_PROTOCOL" "smtp smtps"
|
||||
fi
|
||||
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Configure JasperReports database
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_configure_db() {
|
||||
local db_type client_version
|
||||
|
||||
db_type="$JASPERREPORTS_DATABASE_TYPE"
|
||||
|
||||
if [[ "$db_type" = "postgresql" ]]; then
|
||||
jasperreports_conf_set "dbType" "postgresql"
|
||||
else
|
||||
jasperreports_conf_set "dbType" "mysql"
|
||||
fi
|
||||
jasperreports_conf_set "dbPort" "$JASPERREPORTS_DATABASE_PORT_NUMBER"
|
||||
jasperreports_conf_set "dbHost" "$JASPERREPORTS_DATABASE_HOST"
|
||||
! is_boolean_yes "$ALLOW_EMPTY_PASSWORD" && jasperreports_conf_set "dbPassword" "$JASPERREPORTS_DATABASE_PASSWORD"
|
||||
jasperreports_conf_set "dbUsername" "$JASPERREPORTS_DATABASE_USER"
|
||||
jasperreports_conf_set "js.dbName" "$JASPERREPORTS_DATABASE_NAME"
|
||||
|
||||
if [[ "$db_type" = "postgresql" ]]; then
|
||||
# Extract PostgreSQL client version from the library jar. We do it at initialization time to avoid issues when updating
|
||||
local -r postgresql_client_jar="$(realpath "${JASPERREPORTS_CONF_DIR}/conf_source/db/postgresql/jdbc"/postgresql-*)"
|
||||
client_version="${postgresql_client_jar##*-}"
|
||||
client_version="${client_version%.jar}"
|
||||
# Setting the admin database url (which will be the same as JASPERREPORTS_DATABASE_NAME), which is used by the installer
|
||||
# to perform several checks
|
||||
jasperreports_conf_set "admin.jdbcUrl" "jdbc:postgresql://${JASPERREPORTS_DATABASE_HOST}:${JASPERREPORTS_DATABASE_PORT_NUMBER}/${JASPERREPORTS_DATABASE_NAME}" "${JASPERREPORTS_CONF_DIR}/conf_source/db/postgresql/db.template.properties"
|
||||
|
||||
# Override default mysql configuration to PostgreSQL
|
||||
jasperreports_conf_set "maven.jdbc.artifactId" "postgresql"
|
||||
jasperreports_conf_set "jdbcDriverClass" "org.postgresql.Driver"
|
||||
jasperreports_conf_set "jdbcDataSourceClass" "org.postgresql.ds.PGConnectionPoolDataSource"
|
||||
jasperreports_conf_set "maven.jdbc.groupId" "org.postgresql"
|
||||
jasperreports_conf_set "maven.jdbc.artifactId" "postgresql"
|
||||
else
|
||||
# Extract MariaDB client version from the library jar. We do it at initialization time to avoid issues when updating
|
||||
local -r mariadb_client_jar="$(realpath "${JASPERREPORTS_CONF_DIR}/conf_source/db/mysql/jdbc"/mariadb-java-client-*)"
|
||||
client_version="${mariadb_client_jar##*-}"
|
||||
client_version="${client_version%.jar}"
|
||||
# Setting the admin database url (which will be the same as JASPERREPORTS_DATABASE_NAME), which is used by the installer
|
||||
# to perform several checks
|
||||
jasperreports_conf_set "admin.jdbcUrl" "jdbc:mysql://${JASPERREPORTS_DATABASE_HOST}:${JASPERREPORTS_DATABASE_PORT_NUMBER}/${JASPERREPORTS_DATABASE_NAME}" "${JASPERREPORTS_CONF_DIR}/conf_source/db/mysql/db.template.properties"
|
||||
fi
|
||||
jasperreports_conf_set "maven.jdbc.version" "${client_version}"
|
||||
}
|
||||
|
||||
########################
|
||||
# Configure JasperReports SMTP
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_configure_smtp() {
|
||||
info "Configuring SMTP"
|
||||
jasperreports_conf_set "quartz.mail.sender.host" "$JASPERREPORTS_SMTP_HOST"
|
||||
jasperreports_conf_set "quartz.mail.sender.port" "$JASPERREPORTS_SMTP_PORT_NUMBER"
|
||||
jasperreports_conf_set "quartz.mail.sender.protocol" "$JASPERREPORTS_SMTP_PROTOCOL"
|
||||
jasperreports_conf_set "quartz.mail.sender.username" "$JASPERREPORTS_SMTP_USER"
|
||||
jasperreports_conf_set "quartz.mail.sender.password" "$JASPERREPORTS_SMTP_PASSWORD"
|
||||
jasperreports_conf_set "quartz.mail.sender.from" "$JASPERREPORTS_SMTP_EMAIL"
|
||||
# We only need to configure the URL when sending reports via email, so the user gets the proper URL for accessing the report
|
||||
# Source: https://community.jaspersoft.com/documentation/tibco-jasperreports-server-installation-guide/v720/configuring-report-scheduling
|
||||
jasperreports_conf_set "quartz.web.deployment.uri" "$JASPERREPORTS_HOST"
|
||||
}
|
||||
|
||||
########################
|
||||
# Configure JasperReports User
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_configure_user() {
|
||||
local db_type
|
||||
db_type="$JASPERREPORTS_DATABASE_TYPE"
|
||||
|
||||
info "Configuring users"
|
||||
|
||||
# Change the default user username and mail using the database
|
||||
if [[ "$db_type" = "postgresql" ]]; then
|
||||
postgresql_remote_execute "$JASPERREPORTS_DATABASE_HOST" "$JASPERREPORTS_DATABASE_PORT_NUMBER" "$JASPERREPORTS_DATABASE_NAME" "$JASPERREPORTS_DATABASE_USER" "$JASPERREPORTS_DATABASE_PASSWORD" <<-EOF
|
||||
UPDATE JIUser SET emailAddress='${JASPERREPORTS_EMAIL}' WHERE id=1;
|
||||
UPDATE JIUser SET username='${JASPERREPORTS_USERNAME}' WHERE id=1;
|
||||
EOF
|
||||
|
||||
else
|
||||
mysql_remote_execute "$JASPERREPORTS_DATABASE_HOST" "$JASPERREPORTS_DATABASE_PORT_NUMBER" "$JASPERREPORTS_DATABASE_NAME" "$JASPERREPORTS_DATABASE_USER" "$JASPERREPORTS_DATABASE_PASSWORD" <<-EOF
|
||||
UPDATE JIUser SET emailAddress='${JASPERREPORTS_EMAIL}' WHERE id=1;
|
||||
UPDATE JIUser SET username='${JASPERREPORTS_USERNAME}' WHERE id=1;
|
||||
EOF
|
||||
fi
|
||||
|
||||
# Change the default user password using the export-import scripts
|
||||
# Based on https://community.jaspersoft.com/documentation/jasperreports-server-administration-guide/v550/import-and-export-through-command-line
|
||||
debug_execute "${JASPERREPORTS_CONF_DIR}/js-export.sh" --users "$JASPERREPORTS_USERNAME" --output-dir "${JASPERREPORTS_CONF_DIR}/JS"
|
||||
xmlstarlet ed -L -u '//password' -v "$JASPERREPORTS_PASSWORD" "${JASPERREPORTS_CONF_DIR}/JS/users/${JASPERREPORTS_USERNAME}.xml"
|
||||
debug_execute "${JASPERREPORTS_CONF_DIR}/js-import.sh" --input-dir "${JASPERREPORTS_CONF_DIR}/JS" --update
|
||||
|
||||
# Delete created user folder
|
||||
rm -rf "${JASPERREPORTS_CONF_DIR}/JS"
|
||||
}
|
||||
|
||||
########################
|
||||
# Run JasperReports installation scripts
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_run_install_scripts() {
|
||||
local db_type
|
||||
db_type="$JASPERREPORTS_DATABASE_TYPE"
|
||||
|
||||
info "Executing installation scripts"
|
||||
|
||||
# In order to allow empty passwords and permission issues with the ant scripts, we will use the manual database initialization steps detailed in
|
||||
# the official installation guide: https://community.jaspersoft.com/wiki/installation-steps-war-file-binary-distribution
|
||||
# Using source to avoid generating too much output
|
||||
if [[ "$db_type" = "postgresql" ]]; then
|
||||
postgresql_remote_execute "$JASPERREPORTS_DATABASE_HOST" "$JASPERREPORTS_DATABASE_PORT_NUMBER" "$JASPERREPORTS_DATABASE_NAME" "$JASPERREPORTS_DATABASE_USER" "$JASPERREPORTS_DATABASE_PASSWORD" <<<"\i ${JASPERREPORTS_CONF_DIR}/install_resources/sql/postgresql/js-create.ddl"
|
||||
postgresql_remote_execute "$JASPERREPORTS_DATABASE_HOST" "$JASPERREPORTS_DATABASE_PORT_NUMBER" "$JASPERREPORTS_DATABASE_NAME" "$JASPERREPORTS_DATABASE_USER" "$JASPERREPORTS_DATABASE_PASSWORD" <<<"\i ${JASPERREPORTS_CONF_DIR}/install_resources/sql/postgresql/quartz.ddl"
|
||||
|
||||
else
|
||||
mysql_remote_execute "$JASPERREPORTS_DATABASE_HOST" "$JASPERREPORTS_DATABASE_PORT_NUMBER" "$JASPERREPORTS_DATABASE_NAME" "$JASPERREPORTS_DATABASE_USER" "$JASPERREPORTS_DATABASE_PASSWORD" <<<"SOURCE ${JASPERREPORTS_CONF_DIR}/install_resources/sql/mysql/js-create.ddl"
|
||||
mysql_remote_execute "$JASPERREPORTS_DATABASE_HOST" "$JASPERREPORTS_DATABASE_PORT_NUMBER" "$JASPERREPORTS_DATABASE_NAME" "$JASPERREPORTS_DATABASE_USER" "$JASPERREPORTS_DATABASE_PASSWORD" <<<"SOURCE ${JASPERREPORTS_CONF_DIR}/install_resources/sql/mysql/quartz.ddl"
|
||||
fi
|
||||
|
||||
# We need to move to the buildomatic folder to execute scripts
|
||||
cd "${JASPERREPORTS_CONF_DIR}" || exit
|
||||
|
||||
# We set "y" to accept a warning on the keystore files
|
||||
if am_i_root; then
|
||||
echo "y" | debug_execute run_as_user "$JASPERREPORTS_DAEMON_USER" "${JASPERREPORTS_CONF_DIR}/js-ant" "import-minimal-ce"
|
||||
|
||||
else
|
||||
echo "y" | debug_execute "${JASPERREPORTS_CONF_DIR}/js-ant" "import-minimal-ce"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Run JasperReports deployment scripts
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_run_deployment_scripts() {
|
||||
info "Executing deployment scripts"
|
||||
|
||||
# We need to move to the buildomatic folder to execute scripts
|
||||
cd "$JASPERREPORTS_CONF_DIR" || return 1
|
||||
if am_i_root; then
|
||||
# During the deployment, it will copy one library file to the tomcat lib folder. We need to temporarily grant write permissions
|
||||
# for the installer to finish successfully. We restore the initial permissions after the operation
|
||||
chmod o+w "$BITNAMI_ROOT_DIR/tomcat/lib"
|
||||
debug_execute run_as_user "$JASPERREPORTS_DAEMON_USER" "${JASPERREPORTS_CONF_DIR}/js-ant" "deploy-webapp-ce"
|
||||
chmod o-w "$BITNAMI_ROOT_DIR/tomcat/lib"
|
||||
else
|
||||
debug_execute "${JASPERREPORTS_CONF_DIR}/js-ant" "deploy-webapp-ce"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Run JasperReports upgrade scripts
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_run_upgrade_scripts() {
|
||||
info "Executing upgrade scripts"
|
||||
|
||||
# We need to move to the buildomatic folder to execute scripts
|
||||
# Source: https://community.jaspersoft.com/documentation/tibco-jasperreports-server-community-project-upgrade-guide/v71/upgrading-64-71-0
|
||||
info "Running upgrade script"
|
||||
cd "${JASPERREPORTS_CONF_DIR}" || exit
|
||||
if am_i_root; then
|
||||
debug_execute run_as_user "$JASPERREPORTS_DAEMON_USER" "${JASPERREPORTS_CONF_DIR}/js-upgrade-samedb-ce.sh"
|
||||
|
||||
else
|
||||
debug_execute "${JASPERREPORTS_CONF_DIR}/js-upgrade-samedb-ce.sh"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure JasperReports is initialized
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_initialize() {
|
||||
# Check if JasperReports has already been initialized and persisted in a previous run
|
||||
local db_type db_host db_port db_name db_user db_pass
|
||||
local -r app_name="jasperreports"
|
||||
|
||||
if ! [[ -e "$BITNAMI_ROOT_DIR/tomcat/webapps/jasperserver" ]]; then
|
||||
ln -s "$JASPERREPORTS_BASE_DIR" "$BITNAMI_ROOT_DIR/tomcat/webapps/jasperserver"
|
||||
fi
|
||||
|
||||
if ! is_app_initialized "$app_name"; then
|
||||
# Ensure JasperReports persisted directories exist (i.e. when a volume has been mounted to /bitnami)
|
||||
info "Ensuring JasperReports directories exist"
|
||||
ensure_dir_exists "$JASPERREPORTS_VOLUME_DIR"
|
||||
# Use daemon:root ownership for compatibility when running as a non-root user
|
||||
am_i_root && configure_permissions_ownership "$JASPERREPORTS_VOLUME_DIR" -d "775" -f "664" -u "$JASPERREPORTS_DAEMON_USER" -g "root"
|
||||
info "Trying to connect to the database server"
|
||||
db_type="$JASPERREPORTS_DATABASE_TYPE"
|
||||
db_host="$JASPERREPORTS_DATABASE_HOST"
|
||||
db_port="$JASPERREPORTS_DATABASE_PORT_NUMBER"
|
||||
db_name="$JASPERREPORTS_DATABASE_NAME"
|
||||
db_user="$JASPERREPORTS_DATABASE_USER"
|
||||
db_pass="$JASPERREPORTS_DATABASE_PASSWORD"
|
||||
[[ "$db_type" = "mariadb" || "$db_type" = "mysql" ]] && jasperreports_wait_for_mysql_connection "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
[[ "$db_type" = "postgresql" ]] && jasperreports_wait_for_postgresql_connection "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
|
||||
# Configure JasperReports based on environment variables
|
||||
info "Configuring JasperReports with settings provided via environment variables"
|
||||
jasperreports_configure_db
|
||||
|
||||
if ! is_empty_value "$JASPERREPORTS_SMTP_HOST"; then
|
||||
jasperreports_configure_smtp
|
||||
fi
|
||||
|
||||
if ! is_boolean_yes "$JASPERREPORTS_SKIP_BOOTSTRAP"; then
|
||||
jasperreports_run_install_scripts
|
||||
jasperreports_run_deployment_scripts
|
||||
jasperreports_configure_user
|
||||
else
|
||||
info "An already initialized JasperReports database was provided, configuration will be skipped"
|
||||
jasperreports_run_upgrade_scripts
|
||||
jasperreports_run_deployment_scripts
|
||||
fi
|
||||
|
||||
info "Persisting JasperReports installation"
|
||||
persist_app "$app_name" "$JASPERREPORTS_DATA_TO_PERSIST"
|
||||
else
|
||||
# Compatibility with previous container images for newly added persisted file
|
||||
local -r postgresql_conf_file="buildomatic/conf_source/db/postgresql/db.template.properties"
|
||||
if [[ " ${JASPERREPORTS_DATA_TO_PERSIST} " = *" ${postgresql_conf_file} "* && ! -e "${JASPERREPORTS_VOLUME_DIR}/${postgresql_conf_file}" ]]; then
|
||||
warn "Could not find required file ${JASPERREPORTS_VOLUME_DIR}/${postgresql_conf_file}, it will be created"
|
||||
ensure_dir_exists "$(dirname "${JASPERREPORTS_VOLUME_DIR}/${postgresql_conf_file}")"
|
||||
am_i_root && configure_permissions_ownership "$(dirname "${JASPERREPORTS_VOLUME_DIR}/${postgresql_conf_file}")" -d "775" -f "664" -u "$JASPERREPORTS_DAEMON_USER" -g "root"
|
||||
cp "${JASPERREPORTS_BASE_DIR}/${postgresql_conf_file}" "${JASPERREPORTS_VOLUME_DIR}/${postgresql_conf_file}"
|
||||
fi
|
||||
|
||||
info "Restoring persisted JasperReports installation"
|
||||
restore_persisted_app "$app_name" "$JASPERREPORTS_DATA_TO_PERSIST"
|
||||
info "Trying to connect to the database server"
|
||||
local db_type db_host db_port db_name db_user db_pass
|
||||
db_type="$(jasperreports_conf_get "dbType")"
|
||||
db_host="$(jasperreports_conf_get "dbHost")"
|
||||
db_port="$(jasperreports_conf_get "dbPort")"
|
||||
db_name="$(jasperreports_conf_get "js.dbName")"
|
||||
db_user="$(jasperreports_conf_get "dbUsername")"
|
||||
# Adding true as the password may not be set
|
||||
db_pass="$(jasperreports_conf_get "dbPassword" || true)"
|
||||
[[ "$db_type" = "mariadb" || "$db_type" = "mysql" ]] && jasperreports_wait_for_mysql_connection "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
[[ "$db_type" = "postgresql" ]] && jasperreports_wait_for_postgresql_connection "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
jasperreports_run_upgrade_scripts
|
||||
jasperreports_run_deployment_scripts
|
||||
fi
|
||||
|
||||
if ! is_empty_value "$JASPERREPORTS_SMTP_HOST"; then
|
||||
# Fix that needs to be done after the installation on SMTP
|
||||
# Source: https://github.com/bitnami/bitnami-docker-jasperreports/issues/49
|
||||
# We need to use * in the XPath expressions because it is a namespaced XML but the namespace is not properly detected
|
||||
# in regular XPath experssions with namespace
|
||||
# Set mail.smtp.auth to true
|
||||
xmlstarlet ed -L -u '//*[name()="prop" and @key="mail.smtp.auth"]' -v "true" "${JASPERREPORTS_BASE_DIR}/WEB-INF/applicationContext-report-scheduling.xml"
|
||||
# Add a new prop node with mail.smtp.startls.enable=true
|
||||
xmlstarlet ed -L --subnode '//*[name()="property" and @name="javaMailProperties"]/*[name()="props"]' --type elem -n "prop" -v "true" "${JASPERREPORTS_BASE_DIR}/WEB-INF/applicationContext-report-scheduling.xml"
|
||||
xmlstarlet ed -L -i '//*[name()="prop" and not(@key)]' --type "attr" -n "key" -v "mail.smtp.starttls.enable" "${JASPERREPORTS_BASE_DIR}/WEB-INF/applicationContext-report-scheduling.xml"
|
||||
# Add a new prop node with mail.smtp.ssl.protocols=TLSv1.2 (see issue [#112](https://github.com/bitnami/bitnami-docker-jasperreports/#112)).
|
||||
xmlstarlet ed -L --subnode '//*[name()="property" and @name="javaMailProperties"]/*[name()="props"]' --type elem -n "prop" -v "TLSv1.2" "${JASPERREPORTS_BASE_DIR}/WEB-INF/applicationContext-report-scheduling.xml"
|
||||
xmlstarlet ed -L -i '//*[name()="prop" and not(@key)]' --type "attr" -n "key" -v "mail.smtp.ssl.protocols" "${JASPERREPORTS_BASE_DIR}/WEB-INF/applicationContext-report-scheduling.xml"
|
||||
fi
|
||||
|
||||
# Disable JNDI
|
||||
# Source: https://github.com/bitnami/bitnami-docker-jasperreports/pull/46
|
||||
echo "tbeller.usejndi=false" >>"${JASPERREPORTS_BASE_DIR}/WEB-INF/classes/resfactory.properties"
|
||||
|
||||
# Add log file and fix permissions of the files created after the installation
|
||||
ensure_dir_exists "$JASPERREPORTS_LOGS_DIR"
|
||||
touch "$JASPERREPORTS_LOG_FILE"
|
||||
if am_i_root; then
|
||||
configure_permissions_ownership "$JASPERREPORTS_LOGS_DIR" -u "$JASPERREPORTS_DAEMON_USER" -g "$JASPERREPORTS_DAEMON_GROUP" -f "664"
|
||||
configure_permissions_ownership "$JASPERREPORTS_BASE_DIR/.jrsks" -u "$JASPERREPORTS_DAEMON_USER" -g "$JASPERREPORTS_DAEMON_GROUP" -f "664"
|
||||
configure_permissions_ownership "$JASPERREPORTS_BASE_DIR/.jrsksp" -u "$JASPERREPORTS_DAEMON_USER" -g "$JASPERREPORTS_DAEMON_GROUP" -f "664"
|
||||
fi
|
||||
|
||||
# Make Tomcat redirect to /jasperserver
|
||||
replace_in_file "$BITNAMI_ROOT_DIR/tomcat/webapps/ROOT/index.jsp" '<%\s*$' '<%\nresponse.sendRedirect("/jasperserver");'
|
||||
|
||||
# Move JasperServer to default Tomcat URL
|
||||
if is_boolean_yes "${JASPERREPORTS_USE_ROOT_URL}"; then
|
||||
rm -rf "$BITNAMI_ROOT_DIR/tomcat/webapps/ROOT"
|
||||
rm "$BITNAMI_ROOT_DIR/tomcat/webapps/jasperserver"
|
||||
ln -s "$JASPERREPORTS_BASE_DIR" "$BITNAMI_ROOT_DIR/tomcat/webapps/ROOT"
|
||||
fi
|
||||
|
||||
# Avoid exit code of previous commands to affect the result of this function
|
||||
true
|
||||
}
|
||||
|
||||
########################
|
||||
# Add or modify an entry in the JasperReports configuration file
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# $1 - Variable name
|
||||
# $2 - Value to assign to the variable
|
||||
# $3 - Whether the value is a literal, or if instead it should be quoted (default: no)
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_conf_set() {
|
||||
local -r key="${1:?key missing}"
|
||||
local -r value="${2:-}"
|
||||
local -r file="${3:-"$JASPERREPORTS_CONF_FILE"}"
|
||||
debug "Setting ${key} to '${value}' in JasperReports configuration file ${file}"
|
||||
# Sanitize key (sed does not support fixed string substitutions)
|
||||
local sanitized_pattern
|
||||
sanitized_pattern="^[#]?\s*(//\s*)?$(sed 's/[]\[^$.*/]/\\&/g' <<<"$key")\s*=.*"
|
||||
local -r entry="${key}=${value}"
|
||||
# Check if the configuration exists in the file
|
||||
if grep -q -E "$sanitized_pattern" "$file"; then
|
||||
# It exists, so replace the line
|
||||
replace_in_file "$file" "$sanitized_pattern" "$entry"
|
||||
else
|
||||
# The JasperReports configuration file includes all supported keys, but because of its format,
|
||||
# we cannot append contents to the end. We can assume this should never happen.
|
||||
warn "Could not set the JasperReports '${key}' configuration. Check that the file has not been modified externally."
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Get an entry from the JasperReports configuration file
|
||||
# Globals:
|
||||
# JASPERREPORTS_*
|
||||
# Arguments:
|
||||
# $1 - Variable name
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
jasperreports_conf_get() {
|
||||
local -r key="${1:?key missing}"
|
||||
debug "Getting ${key} from JasperReports 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" "$JASPERREPORTS_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
|
||||
#########################
|
||||
jasperreports_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
|
||||
}
|
||||
|
||||
########################
|
||||
# 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
|
||||
#########################
|
||||
jasperreports_wait_for_mysql_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_mysql_connection() {
|
||||
echo "SELECT 1" | mysql_remote_execute "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass"
|
||||
}
|
||||
if ! retry_while "check_mysql_connection"; then
|
||||
error "Could not connect to the database"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,424 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# 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
|
||||
local -a database_names
|
||||
read -r -a database_names <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES")"
|
||||
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" || "${#database_names[@]}" -gt 0 ]]; 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 [[ "${#database_names[@]}" -le 0 && "${#extensions[@]}" -gt 0 ]]; then
|
||||
print_validation_error "POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS requires POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES to be set."
|
||||
fi
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Perform actions to a database
|
||||
# Globals:
|
||||
# POSTGRESQL_CLIENT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
postgresql_client_initialize() {
|
||||
local -a database_names
|
||||
read -r -a database_names <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES")"
|
||||
# Wait for the database to be accessible if any action needs to be performed
|
||||
if [[ -n "$POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME" || "${#database_names[@]}" -gt 0 ]]; 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" "postgres" "$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 [[ "${#database_names[@]}" -gt 0 ]]; then
|
||||
local -a createdb_args extensions
|
||||
read -r -a extensions <<< "$(tr ',;' ' ' <<< "$POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS")"
|
||||
for database_name in "${database_names[@]}"; do
|
||||
info "Creating database ${database_name}"
|
||||
createdb_args=("$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
|
||||
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" "$database_name" "$POSTGRESQL_CLIENT_POSTGRES_USER" "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD"
|
||||
done
|
||||
fi
|
||||
done
|
||||
fi
|
||||
# Execute a custom SQL script
|
||||
if [[ -n "$POSTGRESQL_CLIENT_EXECUTE_SQL" ]]; then
|
||||
info "Executing custom SQL script"
|
||||
echo "$POSTGRESQL_CLIENT_EXECUTE_SQL" | postgresql_remote_execute "$POSTGRESQL_CLIENT_DATABASE_HOST" "$POSTGRESQL_CLIENT_DATABASE_PORT_NUMBER" "postgres" "$POSTGRESQL_CLIENT_POSTGRES_USER" "$POSTGRESQL_CLIENT_POSTGRES_PASSWORD"
|
||||
fi
|
||||
# Avoid exit code of previous commands to affect the result of this function
|
||||
true
|
||||
}
|
||||
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC2148
|
||||
|
||||
########################
|
||||
# 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" "-p" "${POSTGRESQL_PORT_NUMBER:-5432}")
|
||||
[[ -n "$db" ]] && args+=("-d" "$db")
|
||||
[[ "${#opts[@]}" -gt 0 ]] && args+=("${opts[@]}")
|
||||
|
||||
# Execute the Query/queries from stdin
|
||||
PGPASSWORD=$pass psql "${args[@]}"
|
||||
}
|
||||
|
||||
########################
|
||||
# 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=("postgres" "$(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=("postgres" "$(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=("postgres" "$(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
|
||||
}
|
||||
|
||||
########################
|
||||
# Retrieves the WAL directory in use by PostgreSQL / to use if not initialized yet
|
||||
# Globals:
|
||||
# REPMGR_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# the path to the WAL directory, or empty if not set
|
||||
#########################
|
||||
postgresql_get_waldir() {
|
||||
if [[ -L "${POSTGRESQL_DATA_DIR}/pg_wal" && -d "${POSTGRESQL_DATA_DIR}/pg_wal" ]]; then
|
||||
readlink -f "${POSTGRESQL_DATA_DIR}/pg_wal"
|
||||
else
|
||||
# Uninitialized - using value from $POSTGRESQL_INITDB_WAL_DIR if set
|
||||
echo "$POSTGRESQL_INITDB_WAL_DIR"
|
||||
fi
|
||||
}
|
||||
@@ -1,312 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Bitnami Tomcat library
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
# Load Generic Libraries
|
||||
. /opt/bitnami/scripts/libfile.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/libservice.sh
|
||||
. /opt/bitnami/scripts/libvalidations.sh
|
||||
|
||||
########################
|
||||
# Validate settings in TOMCAT_* environment variables
|
||||
# Globals:
|
||||
# DB_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_validate() {
|
||||
debug "Validating settings in TOMCAT_* env vars..."
|
||||
local error_code=0
|
||||
|
||||
# Auxiliary functions
|
||||
print_validation_error() {
|
||||
error "$1"
|
||||
error_code=1
|
||||
}
|
||||
check_yes_no_value() {
|
||||
if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}" && ! is_1_0_value "${!1}"; then
|
||||
print_validation_error "The allowed values for ${1} are: yes no"
|
||||
fi
|
||||
}
|
||||
check_conflicting_ports() {
|
||||
local -r total="$#"
|
||||
for i in $(seq 1 "$((total - 1))"); do
|
||||
for j in $(seq "$((i + 1))" "$total"); do
|
||||
var_i="${!i}"
|
||||
var_j="${!j}"
|
||||
if [[ -n "${!var_i:-}" ]] && [[ -n "${!var_j:-}" ]] && [[ "${!var_i:-}" = "${!var_j:-}" ]]; then
|
||||
print_validation_error "${var_i} and ${var_j} are bound to the same port"
|
||||
fi
|
||||
done
|
||||
done
|
||||
}
|
||||
check_allowed_port() {
|
||||
local validate_port_args="-unprivileged"
|
||||
|
||||
if ! err=$(validate_port "${validate_port_args[@]}" "${!1}"); then
|
||||
print_validation_error "An invalid port was specified in the environment variable $1: $err"
|
||||
fi
|
||||
}
|
||||
|
||||
check_yes_no_value TOMCAT_ALLOW_REMOTE_MANAGEMENT
|
||||
check_yes_no_value TOMCAT_ENABLE_AUTH
|
||||
check_yes_no_value TOMCAT_ENABLE_AJP
|
||||
|
||||
check_allowed_port TOMCAT_HTTP_PORT_NUMBER
|
||||
check_allowed_port TOMCAT_AJP_PORT_NUMBER
|
||||
check_allowed_port TOMCAT_SHUTDOWN_PORT_NUMBER
|
||||
|
||||
check_conflicting_ports TOMCAT_HTTP_PORT_NUMBER TOMCAT_AJP_PORT_NUMBER TOMCAT_SHUTDOWN_PORT_NUMBER
|
||||
|
||||
# Validate credentials
|
||||
if is_boolean_yes "$TOMCAT_ENABLE_AUTH"; then
|
||||
if is_boolean_yes "${ALLOW_EMPTY_PASSWORD:-no}"; 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
|
||||
is_empty_value "$TOMCAT_PASSWORD" && print_validation_error "The TOMCAT_PASSWORD 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."
|
||||
fi
|
||||
fi
|
||||
|
||||
return "$error_code"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure that a Tomcat user exists
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# $1 - Username
|
||||
# $2 - Password
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_ensure_user_exists() {
|
||||
local username="${1:?username is missing}"
|
||||
local password="${2:-}"
|
||||
|
||||
# This command will create a new user in tomcat-users.xml (inside <tomcat-users>) - How it works:
|
||||
# 0. Assign the XML namespace 'x' (required because it uses a non-standard namespace)
|
||||
# 1. Remove any existing <user> entry for $USERNAME
|
||||
# 2. Create a new subnode in <tomcat-users>
|
||||
# 3. Store that element in a variable so it can be accessed later
|
||||
# 4. Set the "username", "password" and "roles" attributes with their values
|
||||
# shellcheck disable=SC2016
|
||||
xmlstarlet ed -S --inplace -N x="http://tomcat.apache.org/xml" \
|
||||
-d '//x:user[@username="manager"]' \
|
||||
--subnode '//x:tomcat-users' --type elem --name 'user' \
|
||||
--var new_node '$prev' \
|
||||
--insert '$new_node' --type attr --name 'username' --value "$username" \
|
||||
--insert '$new_node' --type attr --name 'password' --value "$password" \
|
||||
--insert '$new_node' --type attr --name 'roles' --value "manager-gui,admin-gui" \
|
||||
"$TOMCAT_USERS_CONF_FILE"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure that the Tomcat AJP connector is enabled
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# $1 - Tomcat AJP connector port number
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_enable_ajp() {
|
||||
local ajp_port="${1:?missing ajp port}"
|
||||
# We want to locate the AJP connector right after the related comment, hence the substitution and not using xmlstarlet
|
||||
# Unfortunately the AJP connector is inside a multi-line comment, so the simplest approach is to add a new line in the proper location
|
||||
local ajp_protocol="AJP/1.3"
|
||||
local ajp_selector="//Connector[@protocol=\"${ajp_protocol}\"]"
|
||||
if is_empty_value "$(xmlstarlet sel --template --value-of "${ajp_selector}/@port" "$TOMCAT_CONF_FILE")"; then
|
||||
# Ensure that it is only added once
|
||||
local ajp_connector="<Connector protocol=\"${ajp_protocol}\" address=\"localhost\" secretRequired=\"false\" port=\"${ajp_port}\" redirectPort=\"8443\"/>"
|
||||
replace_in_file "$TOMCAT_CONF_FILE" "^(\s*)(<!-- Define an AJP .* -->)$" "\1\2\n\1${ajp_connector}"
|
||||
else
|
||||
# If it was already added, update the port number
|
||||
xmlstarlet ed -S --inplace --update "${ajp_selector}/@port" --value "$ajp_port" "$TOMCAT_CONF_FILE"
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Enable a specific Tomcat application for public access
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# $1 - Tomcat application to enable
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_enable_application() {
|
||||
local application="${1:?missing application}"
|
||||
# Access control is configured in the application's context.xml with a Valve element
|
||||
# context.xml docs: https://tomcat.apache.org/tomcat-9.0-doc/config/context.html
|
||||
# Valve docs for Access Control: https://tomcat.apache.org/tomcat-9.0-doc/config/valve.html#Access_Control
|
||||
[[ ! -f "${TOMCAT_WEBAPPS_DIR}/${application}/META-INF/context.xml" ]] && return
|
||||
xmlstarlet ed -S --inplace --update '//Valve/@allow' --value '\d+\.\d+\.\d+\.\d+' "${TOMCAT_WEBAPPS_DIR}/${application}/META-INF/context.xml"
|
||||
}
|
||||
|
||||
########################
|
||||
# Ensure Tomcat is initialized
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_initialize() {
|
||||
if ! is_empty_value "$TOMCAT_EXTRA_JAVA_OPTS"; then
|
||||
cat >>"${TOMCAT_BIN_DIR}/setenv.sh" <<EOF
|
||||
|
||||
# Additional configuration
|
||||
export JAVA_OPTS="\${JAVA_OPTS} ${TOMCAT_EXTRA_JAVA_OPTS}"
|
||||
EOF
|
||||
fi
|
||||
|
||||
# server.xml docs: https://tomcat.apache.org/tomcat-9.0-doc/config/server.html
|
||||
info "Configuring port numbers"
|
||||
xmlstarlet ed -S --inplace --update '//Server/@port' --value "$TOMCAT_SHUTDOWN_PORT_NUMBER" "$TOMCAT_CONF_FILE"
|
||||
xmlstarlet ed -S --inplace --update '//Connector[@protocol="HTTP/1.1"]/@port' --value "$TOMCAT_HTTP_PORT_NUMBER" "$TOMCAT_CONF_FILE"
|
||||
|
||||
if is_boolean_yes "$TOMCAT_ENABLE_AJP"; then
|
||||
info "Enabling AJP"
|
||||
tomcat_enable_ajp "$TOMCAT_AJP_PORT_NUMBER"
|
||||
fi
|
||||
|
||||
if is_boolean_yes "$TOMCAT_ENABLE_AUTH"; then
|
||||
info "Creating Tomcat user"
|
||||
tomcat_ensure_user_exists "$TOMCAT_USERNAME" "$TOMCAT_PASSWORD"
|
||||
fi
|
||||
|
||||
# Fix to make upgrades from old images work
|
||||
# Before, we were persisting 'data' dir instead of 'webapps', causing errors when restoring persisted data
|
||||
if ! is_dir_empty "$TOMCAT_WEBAPPS_DIR" || ! is_dir_empty "${TOMCAT_VOLUME_DIR}/data"; then
|
||||
info "Persisted webapps detected"
|
||||
if [[ ! -e "$TOMCAT_WEBAPPS_DIR" && -e "${TOMCAT_VOLUME_DIR}/data" ]]; then
|
||||
warn "Detected legacy configuration directory path ${TOMCAT_VOLUME_DIR}/conf in volume"
|
||||
warn "Creating ${TOMCAT_BASE_DIR}/webapps symlink pointing to ${TOMCAT_VOLUME_DIR}/data"
|
||||
ln -sf "${TOMCAT_VOLUME_DIR}/data" "${TOMCAT_BASE_DIR}/webapps"
|
||||
fi
|
||||
else
|
||||
info "Ensuring Tomcat directories exist"
|
||||
ensure_dir_exists "$TOMCAT_WEBAPPS_DIR"
|
||||
# Use tomcat:root ownership for compatibility when running as a non-root user
|
||||
am_i_root && configure_permissions_ownership "$TOMCAT_WEBAPPS_DIR" -d "775" -f "664" -u "$TOMCAT_DAEMON_USER" -g "root"
|
||||
|
||||
if is_boolean_yes "$TOMCAT_INSTALL_DEFAULT_WEBAPPS"; then
|
||||
info "Deploying Tomcat from scratch"
|
||||
cp -rp "$TOMCAT_BASE_DIR"/webapps_default/* "$TOMCAT_WEBAPPS_DIR"
|
||||
|
||||
# These applications have been enabled for historical reasons, and do not pose any security threat
|
||||
tomcat_enable_application examples
|
||||
tomcat_enable_application docs
|
||||
if is_boolean_yes "$TOMCAT_ALLOW_REMOTE_MANAGEMENT"; then
|
||||
# These applications should not be enabled by default, for security reasons
|
||||
info "Enabling remote connections for manager and host-manager applications"
|
||||
tomcat_enable_application manager
|
||||
tomcat_enable_application host-manager
|
||||
fi
|
||||
else
|
||||
info "Skipping deployment of default webapps"
|
||||
fi
|
||||
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Start Tomcat in background
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_start_bg() {
|
||||
is_tomcat_running && return
|
||||
|
||||
info "Starting Tomcat in background"
|
||||
local start_error=0
|
||||
if am_i_root; then
|
||||
debug_execute run_as_user "$TOMCAT_DAEMON_USER" "${TOMCAT_BIN_DIR}/startup.sh" || start_error="$?"
|
||||
else
|
||||
debug_execute "${TOMCAT_BIN_DIR}/startup.sh" || start_error="$?"
|
||||
fi
|
||||
|
||||
if [[ "$start_error" -ne 0 ]]; then
|
||||
error "Tomcat failed to start with exit code ${start_error}"
|
||||
return "$start_error"
|
||||
fi
|
||||
wait_for_log_entry "Catalina.start Server startup" "$TOMCAT_LOG_FILE" "$TOMCAT_START_RETRIES" 10
|
||||
}
|
||||
|
||||
########################
|
||||
# Stop Tomcat daemon
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
tomcat_stop() {
|
||||
is_tomcat_not_running && return
|
||||
|
||||
info "Stopping Tomcat"
|
||||
local stop_error=0
|
||||
# 'shutdown.sh stop n -force' - Stop Catalina, wait up to n seconds and then use kill -KILL if still running
|
||||
# The default timeout is 5 seconds, and some apps require even more, so give double the amount of time
|
||||
# In addition, force the shutdown if it did not stop in time to ensure that the shutdown (almost) never fails
|
||||
local tomcat_shutdown_timeout=10
|
||||
if am_i_root; then
|
||||
debug_execute run_as_user "$TOMCAT_DAEMON_USER" "${TOMCAT_BIN_DIR}/shutdown.sh" "$tomcat_shutdown_timeout" -force || stop_error="$?"
|
||||
else
|
||||
debug_execute "${TOMCAT_BIN_DIR}/shutdown.sh" "$tomcat_shutdown_timeout" -force || stop_error="$?"
|
||||
fi
|
||||
|
||||
if [[ "$stop_error" -ne 0 ]]; then
|
||||
error "Tomcat failed to stop with exit code ${stop_error}"
|
||||
return "$stop_error"
|
||||
fi
|
||||
|
||||
retry_while "is_tomcat_not_running"
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if Tomcat is running
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
is_tomcat_running() {
|
||||
local pid
|
||||
pid="$(get_pid_from_file "${TOMCAT_PID_FILE}")"
|
||||
if [[ -n "${pid}" ]]; then
|
||||
is_service_running "${pid}"
|
||||
else
|
||||
false
|
||||
fi
|
||||
}
|
||||
|
||||
########################
|
||||
# Check if Tomcat is not running
|
||||
# Globals:
|
||||
# TOMCAT_*
|
||||
# Arguments:
|
||||
# None
|
||||
# Returns:
|
||||
# None
|
||||
#########################
|
||||
is_tomcat_not_running() {
|
||||
! is_tomcat_running
|
||||
}
|
||||
@@ -1,127 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Environment configuration for mysql
|
||||
|
||||
# The values for all environment variables will be set in the below order of precedence
|
||||
# 1. Custom environment variables defined below after Bitnami defaults
|
||||
# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR
|
||||
# 3. Environment variables overridden via external files using *_FILE variables (see below)
|
||||
# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata)
|
||||
|
||||
# Load logging library
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||
|
||||
# Logging configuration
|
||||
export MODULE="${MODULE:-mysql}"
|
||||
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
|
||||
mysql_env_vars=(
|
||||
MYSQL_CLIENT_FLAVOR
|
||||
ALLOW_EMPTY_PASSWORD
|
||||
MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN
|
||||
MYSQL_CLIENT_DATABASE_HOST
|
||||
MYSQL_CLIENT_DATABASE_PORT_NUMBER
|
||||
MYSQL_CLIENT_DATABASE_ROOT_USER
|
||||
MYSQL_CLIENT_DATABASE_ROOT_PASSWORD
|
||||
MYSQL_CLIENT_CREATE_DATABASE_NAME
|
||||
MYSQL_CLIENT_CREATE_DATABASE_USER
|
||||
MYSQL_CLIENT_CREATE_DATABASE_PASSWORD
|
||||
MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET
|
||||
MYSQL_CLIENT_CREATE_DATABASE_COLLATE
|
||||
MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES
|
||||
MYSQL_CLIENT_ENABLE_SSL_WRAPPER
|
||||
MYSQL_CLIENT_ENABLE_SSL
|
||||
MYSQL_CLIENT_SSL_CA_FILE
|
||||
MYSQL_CLIENT_SSL_CERT_FILE
|
||||
MYSQL_CLIENT_SSL_KEY_FILE
|
||||
MYSQL_CLIENT_EXTRA_FLAGS
|
||||
MARIADB_AUTHENTICATION_PLUGIN
|
||||
MARIADB_HOST
|
||||
MARIADB_PORT_NUMBER
|
||||
MARIADB_ROOT_USER
|
||||
MARIADB_ROOT_PASSWORD
|
||||
)
|
||||
for env_var in "${mysql_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 mysql_env_vars
|
||||
export MYSQL_CLIENT_FLAVOR="${MYSQL_CLIENT_FLAVOR:-mariadb}"
|
||||
export DB_FLAVOR="$MYSQL_CLIENT_FLAVOR"
|
||||
|
||||
# Paths
|
||||
export DB_BASE_DIR="${BITNAMI_ROOT_DIR}/mysql"
|
||||
export DB_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/mysql"
|
||||
export DB_DATA_DIR="${DB_VOLUME_DIR}/data"
|
||||
export DB_BIN_DIR="${DB_BASE_DIR}/bin"
|
||||
export DB_SBIN_DIR="${DB_BASE_DIR}/bin"
|
||||
export DB_CONF_DIR="${DB_BASE_DIR}/conf"
|
||||
export DB_LOGS_DIR="${DB_BASE_DIR}/logs"
|
||||
export DB_TMP_DIR="${DB_BASE_DIR}/tmp"
|
||||
export DB_CONF_FILE="${DB_CONF_DIR}/my.cnf"
|
||||
export DB_PID_FILE="${DB_TMP_DIR}/mysqld.pid"
|
||||
export DB_SOCKET_FILE="${DB_TMP_DIR}/mysql.sock"
|
||||
export PATH="${DB_SBIN_DIR}:${DB_BIN_DIR}:/opt/bitnami/common/bin:${PATH}"
|
||||
|
||||
# System users (when running with a privileged user)
|
||||
export DB_DAEMON_USER="mysql"
|
||||
export DB_DAEMON_GROUP="mysql"
|
||||
|
||||
# MySQL client configuration
|
||||
export ALLOW_EMPTY_PASSWORD="${ALLOW_EMPTY_PASSWORD:-no}"
|
||||
MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN="${MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN:-"${MARIADB_AUTHENTICATION_PLUGIN:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN="${MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN:-}"
|
||||
export DB_AUTHENTICATION_PLUGIN="$MYSQL_CLIENT_DATABASE_AUTHENTICATION_PLUGIN"
|
||||
MYSQL_CLIENT_DATABASE_HOST="${MYSQL_CLIENT_DATABASE_HOST:-"${MARIADB_HOST:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_HOST="${MYSQL_CLIENT_DATABASE_HOST:-mariadb}"
|
||||
export DB_HOST="$MYSQL_CLIENT_DATABASE_HOST"
|
||||
MYSQL_CLIENT_DATABASE_PORT_NUMBER="${MYSQL_CLIENT_DATABASE_PORT_NUMBER:-"${MARIADB_PORT_NUMBER:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_PORT_NUMBER="${MYSQL_CLIENT_DATABASE_PORT_NUMBER:-3306}"
|
||||
export DB_PORT_NUMBER="$MYSQL_CLIENT_DATABASE_PORT_NUMBER"
|
||||
MYSQL_CLIENT_DATABASE_ROOT_USER="${MYSQL_CLIENT_DATABASE_ROOT_USER:-"${MARIADB_ROOT_USER:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_ROOT_USER="${MYSQL_CLIENT_DATABASE_ROOT_USER:-root}"
|
||||
export DB_ROOT_USER="$MYSQL_CLIENT_DATABASE_ROOT_USER" # only used during the first initialization
|
||||
MYSQL_CLIENT_DATABASE_ROOT_PASSWORD="${MYSQL_CLIENT_DATABASE_ROOT_PASSWORD:-"${MARIADB_ROOT_PASSWORD:-}"}"
|
||||
export MYSQL_CLIENT_DATABASE_ROOT_PASSWORD="${MYSQL_CLIENT_DATABASE_ROOT_PASSWORD:-}"
|
||||
export DB_ROOT_PASSWORD="$MYSQL_CLIENT_DATABASE_ROOT_PASSWORD" # only used during the first initialization
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_NAME="${MYSQL_CLIENT_CREATE_DATABASE_NAME:-}"
|
||||
export DB_CREATE_DATABASE_NAME="$MYSQL_CLIENT_CREATE_DATABASE_NAME" # only used during the first initialization
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_USER="${MYSQL_CLIENT_CREATE_DATABASE_USER:-}"
|
||||
export DB_CREATE_DATABASE_USER="$MYSQL_CLIENT_CREATE_DATABASE_USER"
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_PASSWORD="${MYSQL_CLIENT_CREATE_DATABASE_PASSWORD:-}"
|
||||
export DB_CREATE_DATABASE_PASSWORD="$MYSQL_CLIENT_CREATE_DATABASE_PASSWORD"
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET="${MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET:-}"
|
||||
export DB_CREATE_DATABASE_CHARACTER_SET="$MYSQL_CLIENT_CREATE_DATABASE_CHARACTER_SET"
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_COLLATE="${MYSQL_CLIENT_CREATE_DATABASE_COLLATE:-}"
|
||||
export DB_CREATE_DATABASE_COLLATE="$MYSQL_CLIENT_CREATE_DATABASE_COLLATE"
|
||||
export MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES="${MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES:-}"
|
||||
export DB_CREATE_DATABASE_PRIVILEGES="$MYSQL_CLIENT_CREATE_DATABASE_PRIVILEGES"
|
||||
export MYSQL_CLIENT_ENABLE_SSL_WRAPPER="${MYSQL_CLIENT_ENABLE_SSL_WRAPPER:-no}"
|
||||
export DB_ENABLE_SSL_WRAPPER="$MYSQL_CLIENT_ENABLE_SSL_WRAPPER"
|
||||
export MYSQL_CLIENT_ENABLE_SSL="${MYSQL_CLIENT_ENABLE_SSL:-no}"
|
||||
export DB_ENABLE_SSL="$MYSQL_CLIENT_ENABLE_SSL"
|
||||
export MYSQL_CLIENT_SSL_CA_FILE="${MYSQL_CLIENT_SSL_CA_FILE:-}"
|
||||
export DB_SSL_CA_FILE="$MYSQL_CLIENT_SSL_CA_FILE"
|
||||
export MYSQL_CLIENT_SSL_CERT_FILE="${MYSQL_CLIENT_SSL_CERT_FILE:-}"
|
||||
export DB_SSL_CERT_FILE="$MYSQL_CLIENT_SSL_CERT_FILE"
|
||||
export MYSQL_CLIENT_SSL_KEY_FILE="${MYSQL_CLIENT_SSL_KEY_FILE:-}"
|
||||
export DB_SSL_KEY_FILE="$MYSQL_CLIENT_SSL_KEY_FILE"
|
||||
export MYSQL_CLIENT_EXTRA_FLAGS="${MYSQL_CLIENT_EXTRA_FLAGS:-no}"
|
||||
export DB_EXTRA_FLAGS="$MYSQL_CLIENT_EXTRA_FLAGS"
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
|
||||
# Load MySQL Client environment variables
|
||||
. /opt/bitnami/scripts/mysql-client-env.sh
|
||||
|
||||
for dir in "$DB_BIN_DIR" "${DB_BASE_DIR}/.bin"; do
|
||||
ensure_dir_exists "$dir"
|
||||
chmod g+rwX "$dir"
|
||||
done
|
||||
@@ -1,21 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libmysqlclient.sh
|
||||
|
||||
# Load MySQL Client environment variables
|
||||
. /opt/bitnami/scripts/mysql-client-env.sh
|
||||
|
||||
# Ensure MySQL Client environment variables settings are valid
|
||||
mysql_client_validate
|
||||
# Ensure MySQL Client is initialized
|
||||
mysql_client_initialize
|
||||
@@ -1,88 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# 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
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||
|
||||
# Logging configuration
|
||||
export MODULE="${MODULE:-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_NAMES
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_USERNAME
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_PASSWORD
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_EXTENSIONS
|
||||
POSTGRESQL_CLIENT_EXECUTE_SQL
|
||||
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_NAME
|
||||
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
|
||||
POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES="${POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES:-"${POSTGRESQL_CLIENT_CREATE_DATABASE_NAME:-}"}"
|
||||
export POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES="${POSTGRESQL_CLIENT_CREATE_DATABASE_NAMES:-}" # 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
|
||||
export POSTGRESQL_CLIENT_EXECUTE_SQL="${POSTGRESQL_CLIENT_EXECUTE_SQL:-}" # only used during the first initialization
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/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
|
||||
@@ -1,93 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Environment configuration for tomcat
|
||||
|
||||
# The values for all environment variables will be set in the below order of precedence
|
||||
# 1. Custom environment variables defined below after Bitnami defaults
|
||||
# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR
|
||||
# 3. Environment variables overridden via external files using *_FILE variables (see below)
|
||||
# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata)
|
||||
|
||||
# Load logging library
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
export BITNAMI_ROOT_DIR="/opt/bitnami"
|
||||
export BITNAMI_VOLUME_DIR="/bitnami"
|
||||
|
||||
# Logging configuration
|
||||
export MODULE="${MODULE:-tomcat}"
|
||||
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
|
||||
tomcat_env_vars=(
|
||||
TOMCAT_SHUTDOWN_PORT_NUMBER
|
||||
TOMCAT_HTTP_PORT_NUMBER
|
||||
TOMCAT_AJP_PORT_NUMBER
|
||||
TOMCAT_USERNAME
|
||||
TOMCAT_PASSWORD
|
||||
TOMCAT_ALLOW_REMOTE_MANAGEMENT
|
||||
TOMCAT_ENABLE_AUTH
|
||||
TOMCAT_ENABLE_AJP
|
||||
TOMCAT_START_RETRIES
|
||||
TOMCAT_EXTRA_JAVA_OPTS
|
||||
TOMCAT_INSTALL_DEFAULT_WEBAPPS
|
||||
JAVA_OPTS
|
||||
)
|
||||
for env_var in "${tomcat_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 tomcat_env_vars
|
||||
|
||||
# Paths
|
||||
export TOMCAT_BASE_DIR="${BITNAMI_ROOT_DIR}/tomcat"
|
||||
export TOMCAT_VOLUME_DIR="/bitnami/tomcat"
|
||||
export TOMCAT_BIN_DIR="${TOMCAT_BASE_DIR}/bin"
|
||||
export TOMCAT_LIB_DIR="${TOMCAT_BASE_DIR}/lib"
|
||||
export TOMCAT_WORK_DIR="${TOMCAT_BASE_DIR}/work"
|
||||
export TOMCAT_WEBAPPS_DIR="${TOMCAT_VOLUME_DIR}/webapps"
|
||||
export TOMCAT_CONF_DIR="${TOMCAT_BASE_DIR}/conf"
|
||||
export TOMCAT_CONF_FILE="${TOMCAT_CONF_DIR}/server.xml"
|
||||
export TOMCAT_USERS_CONF_FILE="${TOMCAT_CONF_DIR}/tomcat-users.xml"
|
||||
export TOMCAT_LOGS_DIR="${TOMCAT_BASE_DIR}/logs"
|
||||
export TOMCAT_TMP_DIR="${TOMCAT_BASE_DIR}/temp"
|
||||
export TOMCAT_LOG_FILE="${TOMCAT_LOGS_DIR}/catalina.out"
|
||||
export TOMCAT_PID_FILE="${TOMCAT_TMP_DIR}/catalina.pid"
|
||||
export TOMCAT_HOME="$TOMCAT_BASE_DIR"
|
||||
|
||||
# System users (when running with a privileged user)
|
||||
export TOMCAT_DAEMON_USER="tomcat"
|
||||
export TOMCAT_DAEMON_GROUP="tomcat"
|
||||
|
||||
# Tomcat configuration
|
||||
export TOMCAT_SHUTDOWN_PORT_NUMBER="${TOMCAT_SHUTDOWN_PORT_NUMBER:-8005}"
|
||||
export TOMCAT_HTTP_PORT_NUMBER="${TOMCAT_HTTP_PORT_NUMBER:-8080}"
|
||||
export TOMCAT_AJP_PORT_NUMBER="${TOMCAT_AJP_PORT_NUMBER:-8009}"
|
||||
export TOMCAT_USERNAME="${TOMCAT_USERNAME:-manager}"
|
||||
export TOMCAT_PASSWORD="${TOMCAT_PASSWORD:-}"
|
||||
export TOMCAT_ALLOW_REMOTE_MANAGEMENT="${TOMCAT_ALLOW_REMOTE_MANAGEMENT:-yes}" # only used during the first initialization
|
||||
export TOMCAT_ENABLE_AUTH="${TOMCAT_ENABLE_AUTH:-yes}"
|
||||
export TOMCAT_ENABLE_AJP="${TOMCAT_ENABLE_AJP:-no}"
|
||||
export TOMCAT_START_RETRIES="${TOMCAT_START_RETRIES:-12}"
|
||||
export TOMCAT_EXTRA_JAVA_OPTS="${TOMCAT_EXTRA_JAVA_OPTS:-}"
|
||||
export TOMCAT_INSTALL_DEFAULT_WEBAPPS="${TOMCAT_INSTALL_DEFAULT_WEBAPPS:-yes}"
|
||||
|
||||
# Default JVM configuration
|
||||
export JAVA_HOME="${BITNAMI_ROOT_DIR}/java"
|
||||
export JAVA_OPTS="${JAVA_OPTS:--Djava.awt.headless=true -XX:+UseG1GC -Dfile.encoding=UTF-8 -Djava.net.preferIPv4Stack=true -Djava.net.preferIPv4Addresses=true -Duser.home=${TOMCAT_HOME}}"
|
||||
|
||||
# Other parameters
|
||||
export PATH="${TOMCAT_BASE_DIR}/bin:${JAVA_HOME}/bin:${BITNAMI_ROOT_DIR}/common/bin:${PATH}"
|
||||
|
||||
# Custom environment variables may be defined below
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
export JAVA_HOME="{{JAVA_HOME}}"
|
||||
export JAVA_OPTS="{{JAVA_OPTS}}"
|
||||
export CATALINA_PID="{{TOMCAT_PID_FILE}}"
|
||||
|
||||
# Load Tomcat Native library
|
||||
export LD_LIBRARY_PATH="{{TOMCAT_LIB_DIR}}:${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}"
|
||||
@@ -1,29 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
. /opt/bitnami/scripts/libbitnami.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
print_welcome_page
|
||||
|
||||
if [[ "$*" = *"/opt/bitnami/scripts/tomcat/run.sh"* ]]; then
|
||||
info "** Starting tomcat setup **"
|
||||
/opt/bitnami/scripts/tomcat/setup.sh
|
||||
info "** tomcat setup finished! **"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
exec "$@"
|
||||
@@ -1,51 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
# Ensure 'tomcat' user exists when running as 'root'
|
||||
ensure_user_exists "$TOMCAT_DAEMON_USER" --group "$TOMCAT_DAEMON_GROUP" --system
|
||||
# By default, the upstream Tomcat tarball includes very specific permissions on its files
|
||||
# For simplicity purposes, since Bitnami Tomcat is considered a development environment, we reset to OS defaults
|
||||
configure_permissions_ownership "$TOMCAT_BASE_DIR" -d "755" -f "644"
|
||||
chmod a+x "$TOMCAT_BIN_DIR"/*.sh
|
||||
# Make TOMCAT_HOME writable (non-recursively, for security reasons) both for root and non-root approaches
|
||||
chown "$TOMCAT_DAEMON_USER" "$TOMCAT_HOME"
|
||||
chmod g+rwX "$TOMCAT_HOME"
|
||||
# Make TOMCAT_LIB_DIR writable (non-recursively, for security reasons) for non-root approach, some apps may copy files there
|
||||
chmod g+rwX "$TOMCAT_LIB_DIR"
|
||||
# Make required folders writable by the Tomcat web server user
|
||||
for dir in "$TOMCAT_TMP_DIR" "$TOMCAT_LOGS_DIR" "$TOMCAT_CONF_DIR" "$TOMCAT_WORK_DIR" "$TOMCAT_WEBAPPS_DIR" "${TOMCAT_BASE_DIR}/webapps"; do
|
||||
ensure_dir_exists "$dir"
|
||||
# Use tomcat:root ownership for compatibility when running as a non-root user
|
||||
configure_permissions_ownership "$dir" -d "775" -f "664" -u "$TOMCAT_DAEMON_USER" -g "root"
|
||||
done
|
||||
|
||||
# Allow enabling custom Tomcat webapps
|
||||
mv "${TOMCAT_BASE_DIR}/webapps" "${TOMCAT_BASE_DIR}/webapps_default"
|
||||
ln -sf "$TOMCAT_WEBAPPS_DIR" "${TOMCAT_BASE_DIR}/webapps"
|
||||
|
||||
# Create a setenv.sh script
|
||||
# For more info, refer to section '(3.4) Using the "setenv" script' from https://tomcat.apache.org/tomcat-9.0-doc/RUNNING.txt
|
||||
declare template_dir="${BITNAMI_ROOT_DIR}/scripts/tomcat/bitnami-templates"
|
||||
render-template "${template_dir}/setenv.sh.tpl" > "${TOMCAT_BIN_DIR}/setenv.sh"
|
||||
chmod g+rwX "${TOMCAT_BIN_DIR}/setenv.sh"
|
||||
|
||||
# Create 'apache-tomcat' symlink pointing to the 'tomcat' directory, for compatibility with Bitnami Docs guides
|
||||
ln -sf tomcat "${BITNAMI_ROOT_DIR}/apache-tomcat"
|
||||
|
||||
# Users can mount their webapps at /app
|
||||
ln -sf "$TOMCAT_WEBAPPS_DIR" /app
|
||||
@@ -1,19 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
/opt/bitnami/scripts/tomcat/stop.sh
|
||||
/opt/bitnami/scripts/tomcat/start.sh
|
||||
@@ -1,25 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
. /opt/bitnami/scripts/liblog.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
info "** Starting Tomcat **"
|
||||
|
||||
if am_i_root; then
|
||||
exec_as_user "$TOMCAT_DAEMON_USER" "${TOMCAT_BIN_DIR}/catalina.sh" run "$@"
|
||||
else
|
||||
exec "${TOMCAT_BIN_DIR}/catalina.sh" run "$@"
|
||||
fi
|
||||
@@ -1,24 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
. /opt/bitnami/scripts/libfs.sh
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
# Ensure Tomcat environment variables are valid
|
||||
tomcat_validate
|
||||
|
||||
# Ensure tomcat is initialized
|
||||
tomcat_initialize
|
||||
@@ -1,38 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
error_code=0
|
||||
start_error=0
|
||||
|
||||
if is_tomcat_not_running; then
|
||||
if am_i_root; then
|
||||
run_as_user "$TOMCAT_DAEMON_USER" "${TOMCAT_BIN_DIR}/startup.sh" || start_error="$?"
|
||||
else
|
||||
"${TOMCAT_BIN_DIR}/startup.sh" || start_error="$?"
|
||||
fi
|
||||
if [[ "$start_error" -ne 0 ]] || ! retry_while "is_tomcat_running"; then
|
||||
error "tomcat did not start"
|
||||
error_code=1
|
||||
else
|
||||
info "tomcat started"
|
||||
fi
|
||||
else
|
||||
info "tomcat is already running"
|
||||
fi
|
||||
|
||||
exit "$error_code"
|
||||
@@ -1,22 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
if is_tomcat_running; then
|
||||
info "tomcat is already running"
|
||||
else
|
||||
info "tomcat is not running"
|
||||
fi
|
||||
@@ -1,34 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Load libraries
|
||||
. /opt/bitnami/scripts/libos.sh
|
||||
. /opt/bitnami/scripts/libtomcat.sh
|
||||
|
||||
# Load Tomcat environment variables
|
||||
. /opt/bitnami/scripts/tomcat-env.sh
|
||||
|
||||
error_code=0
|
||||
stop_error=0
|
||||
|
||||
if is_tomcat_running; then
|
||||
BITNAMI_QUIET=1 tomcat_stop || stop_error="$?"
|
||||
if [[ "$stop_error" -ne 0 ]] || ! retry_while "is_tomcat_not_running"; then
|
||||
error "tomcat could not be stopped"
|
||||
error_code=1
|
||||
else
|
||||
info "tomcat stopped"
|
||||
fi
|
||||
else
|
||||
info "tomcat is not running"
|
||||
fi
|
||||
|
||||
exit "$error_code"
|
||||
@@ -1,38 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# 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"
|
||||
@@ -1,48 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
#
|
||||
# Executes custom MySQL (.sql or .sql.gz) 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
|
||||
|
||||
mysql_execute() {
|
||||
local -r sql_file="${1:?missing file}"
|
||||
local failure=0
|
||||
mysql_cmd=("mysql" "-h" "$MARIADB_HOST" "-P" "$MARIADB_PORT_NUMBER" "-u" "$MARIADB_ROOT_USER")
|
||||
if [[ "${ALLOW_EMPTY_PASSWORD:-no}" != "yes" ]]; then
|
||||
mysql_cmd+=("-p${MARIADB_ROOT_PASSWORD}")
|
||||
fi
|
||||
if [[ "$sql_file" == *".sql" ]]; then
|
||||
"${mysql_cmd[@]}" < "$sql_file" || failure=$?
|
||||
elif [[ "$sql_file" == *".sql.gz" ]]; then
|
||||
gunzip -c "$sql_file" | "${mysql_cmd[@]}" || 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}"
|
||||
mysql_execute "$custom_init_script" || failure=1
|
||||
[[ "$failure" -ne 0 ]] && error "Failed to execute ${custom_init_script}"
|
||||
done
|
||||
fi
|
||||
|
||||
exit "$failure"
|
||||
@@ -1,25 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
# shellcheck disable=SC1091
|
||||
|
||||
set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
# set -o xtrace # Uncomment this line for debugging purposes
|
||||
|
||||
# Only execute init scripts once
|
||||
if [[ ! -f "/bitnami/jasperreports/.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/jasperreports/.user_scripts_initialized" ]]; then
|
||||
mkdir -p "/bitnami/jasperreports"
|
||||
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/jasperreports/.user_scripts_initialized"
|
||||
fi
|
||||
@@ -1,5 +0,0 @@
|
||||
rolling-tags:
|
||||
- "8"
|
||||
- 8-debian-11
|
||||
- 8.2.0
|
||||
- latest
|
||||
@@ -1,498 +0,0 @@
|
||||
# Bitnami package for JasperReports
|
||||
|
||||
## Deprecation Notice
|
||||
|
||||
The JasperReports container is no longer maintained by upstream and is now deprecated. This image will no longer be released in our catalog, but already released container images will still persist in the registries.
|
||||
|
||||
## What is JasperReports?
|
||||
|
||||
> JasperReports Server is a stand-alone and embeddable reporting server. It is a central information hub, with reporting and analytics that can be embedded into web and mobile applications.
|
||||
|
||||
[Overview of JasperReports](http://community.jaspersoft.com/project/jasperreports-server)
|
||||
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
|
||||
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
docker run --name jasperreports bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
**Warning**: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the [Environment Variables](#environment-variables) section for a more secure deployment.
|
||||
|
||||
## 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 that gives you a small base container image and the familiarity of a leading Linux distribution- or **scratch** -an explicitly empty image-.
|
||||
* 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 on a regular basis with the latest distribution packages available.
|
||||
|
||||
Looking to use JasperReports in production? Try [VMware Tanzu Application Catalog](https://bitnami.com/enterprise), the enterprise edition of Bitnami Application Catalog.
|
||||
|
||||
## How to deploy JasperReports Server in Kubernetes?
|
||||
|
||||
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami JasperReports Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/jasperreports).
|
||||
|
||||
Bitnami containers can be used with [Kubeapps](https://kubeapps.dev/) for deployment and management of Helm Charts in clusters.
|
||||
|
||||
## Why use a non-root container?
|
||||
|
||||
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/tutorials/work-with-non-root-containers/).
|
||||
|
||||
## Supported tags and respective `Dockerfile` links
|
||||
|
||||
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
|
||||
|
||||
You can see the equivalence between the different tags by taking a look at the `tags-info.yaml` file present in the branch folder, i.e `bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml`.
|
||||
|
||||
Subscribe to project updates by watching the [bitnami/containers GitHub repo](https://github.com/bitnami/containers).
|
||||
|
||||
## Get this image
|
||||
|
||||
The recommended way to get the Bitnami JasperReports Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/jasperreports).
|
||||
|
||||
```console
|
||||
docker pull bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/jasperreports/tags/) in the Docker Hub Registry.
|
||||
|
||||
```console
|
||||
docker pull bitnami/jasperreports:[TAG]
|
||||
```
|
||||
|
||||
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the `docker build` command. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.
|
||||
|
||||
```console
|
||||
git clone https://github.com/bitnami/containers.git
|
||||
cd bitnami/APP/VERSION/OPERATING-SYSTEM
|
||||
docker build -t bitnami/APP:latest .
|
||||
```
|
||||
|
||||
## How to use this image
|
||||
|
||||
JasperReports requires access to a MySQL or MariaDB database to store information. We'll use the [Bitnami Docker Image for MariaDB](https://github.com/bitnami/containers/tree/main/bitnami/mariadb) for the database requirements.
|
||||
|
||||
### Provide jasper specific file config
|
||||
|
||||
```diff
|
||||
...
|
||||
jasperreports:
|
||||
image: docker.io/bitnami/jasperreports:latest
|
||||
ports:
|
||||
- '80:8080'
|
||||
volumes:
|
||||
- 'jasperreports_data:/bitnami/jasperreports'
|
||||
# The line below allows you to provide your own JasperReports configuration files, to be copied to WEB-INF
|
||||
# - "./config:/bitnami/jasperreports-mounted-conf"
|
||||
depends_on:
|
||||
- mariadb
|
||||
environment:
|
||||
# ALLOW_EMPTY_PASSWORD is recommended only for development.
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- JASPERREPORTS_DATABASE_HOST=mariadb
|
||||
- JASPERREPORTS_DATABASE_PORT_NUMBER=3306
|
||||
- JASPERREPORTS_DATABASE_USER=bn_jasperreports
|
||||
- JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports
|
||||
|
||||
```
|
||||
|
||||
### Using the Docker Command Line
|
||||
|
||||
#### Step 1: Create a network
|
||||
|
||||
```console
|
||||
docker network create jasperreports-network
|
||||
```
|
||||
|
||||
#### Step 2: Create a volume for MariaDB persistence and create a MariaDB container
|
||||
|
||||
```console
|
||||
$ docker volume create --name mariadb_data
|
||||
docker run -d --name mariadb \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env MARIADB_USER=bn_jasperreports \
|
||||
--env MARIADB_PASSWORD=bitnami \
|
||||
--env MARIADB_DATABASE=bitnami_jasperreports \
|
||||
--network jasperreports-network \
|
||||
--volume mariadb_data:/bitnami/mariadb \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
#### Step 3: Create volumes for JasperReports persistence and launch the container
|
||||
|
||||
```console
|
||||
$ docker volume create --name jasperreports_data
|
||||
docker run -d --name jasperreports \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
|
||||
--env JASPERREPORTS_DATABASE_PASSWORD=bitnami \
|
||||
--env JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports \
|
||||
--network jasperreports-network \
|
||||
--volume jasperreports_data:/bitnami/jasperreports \
|
||||
bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
Access your application at `http://your-ip/`
|
||||
|
||||
### Run the application using Docker Compose
|
||||
|
||||
```console
|
||||
curl -sSL https://raw.githubusercontent.com/bitnami/containers/main/bitnami/jasperreports/docker-compose.yml > docker-compose.yml
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated [Bitnami Helm chart](https://github.com/bitnami/charts/tree/main/bitnami/jasperreports).
|
||||
|
||||
If you detect any issue in the `docker-compose.yaml` file, feel free to report it or contribute with a fix by following our [Contributing Guidelines](https://github.com/bitnami/containers/blob/main/CONTRIBUTING.md).
|
||||
|
||||
## Persisting your application
|
||||
|
||||
If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.
|
||||
|
||||
For persistence, you should mount a directory at the `/bitnami/jasperreports` 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 MariaDB data](https://github.com/bitnami/containers/blob/main/bitnami/mariadb#persisting-your-database).
|
||||
|
||||
The above examples define the Docker volumes named `mariadb_data` and `jasperreports_data`. The JasperReports application state will persist as long as volumes are not removed.
|
||||
|
||||
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
|
||||
|
||||
This requires a minor change to the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jasperreports/docker-compose.yml) file present in this repository:
|
||||
|
||||
```diff
|
||||
mariadb:
|
||||
...
|
||||
volumes:
|
||||
- - 'mariadb_data:/bitnami/mariadb'
|
||||
+ - /path/to/mariadb-persistence:/bitnami/mariadb
|
||||
...
|
||||
jasperreports:
|
||||
...
|
||||
volumes:
|
||||
- - 'jasperreports_data:/bitnami/jasperreports'
|
||||
+ - /path/to/jasperreports-persistence:/bitnami/jasperreports
|
||||
...
|
||||
-volumes:
|
||||
- mariadb_data:
|
||||
- driver: local
|
||||
- jasperreports_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
|
||||
|
||||
#### Step 1: Create a network (if it does not exist)
|
||||
|
||||
```console
|
||||
docker network create jasperreports-network
|
||||
```
|
||||
|
||||
#### Step 2. Create a MariaDB container with host volume
|
||||
|
||||
```console
|
||||
docker run -d --name mariadb \
|
||||
--env ALLOW_EMPTY_PASSWORD=yes \
|
||||
--env MARIADB_USER=bn_jasperreports \
|
||||
--env MARIADB_PASSWORD=bitnami \
|
||||
--env MARIADB_DATABASE=bitnami_jasperreports \
|
||||
--network jasperreports-network \
|
||||
--volume /path/to/mariadb-persistence:/bitnami/mariadb \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
#### Step 3. Create the JasperReports container with host volumes
|
||||
|
||||
```console
|
||||
docker run -d --name jasperreports \
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
|
||||
--env JASPERREPORTS_DATABASE_PASSWORD=bitnami \
|
||||
--env JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports \
|
||||
--network jasperreports-network \
|
||||
--volume /path/to/jasperreports-persistence:/bitnami/jasperreports \
|
||||
bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment variables
|
||||
|
||||
#### Customizable environment variables
|
||||
|
||||
| Name | Description | Default Value |
|
||||
|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `JASPERREPORTS_DATA_TO_PERSIST` | Files to persist relative to the JasperReports installation directory. To provide multiple values, separate them with a whitespace. | `buildomatic/default_master.properties buildomatic/conf_source/db/mysql/db.template.properties buildomatic/conf_source/db/postgresql/db.template.properties .jrsks .jrsksp` |
|
||||
| `JASPERREPORTS_HOST` | JasperReports host name. | `localhost` |
|
||||
| `JASPERREPORTS_SKIP_BOOTSTRAP` | Whether to perform initial bootstrapping for the application. | `no` |
|
||||
| `JASPERREPORTS_USE_ROOT_URL` | Move the application to root. | `false` |
|
||||
| `JASPERREPORTS_USERNAME` | JasperReports user name. | `jasperadmin` |
|
||||
| `JASPERREPORTS_PASSWORD` | JasperReports user password. | `bitnami` |
|
||||
| `JASPERREPORTS_EMAIL` | JasperReports user e-mail address. | `user@example.com` |
|
||||
| `JASPERREPORTS_SMTP_PROTOCOL` | JasperReports SMTP server protocol to use. | `smtp` |
|
||||
| `JASPERREPORTS_SMTP_EMAIL` | JasperReports SMTP server email to use. | `fromuser@example.com` |
|
||||
| `JASPERREPORTS_DATABASE_TYPE` | Database server type. | `mariadb` |
|
||||
| `JASPERREPORTS_DATABASE_HOST` | Database server host. | `$JASPERREPORTS_DEFAULT_DATABASE_HOST` |
|
||||
| `JASPERREPORTS_DATABASE_PORT_NUMBER` | Database server port. | `3306` |
|
||||
| `JASPERREPORTS_DATABASE_NAME` | Database name. | `bitnami_jasperreports` |
|
||||
| `JASPERREPORTS_DATABASE_USER` | Database user name. | `bn_jasperreports` |
|
||||
|
||||
#### Read-only environment variables
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|----------------------------------------------------------|-------------------------------------------------------|
|
||||
| `JASPERREPORTS_BASE_DIR` | JasperReports installation directory. | `${BITNAMI_ROOT_DIR}/jasperreports` |
|
||||
| `JASPERREPORTS_CONF_DIR` | Configuration directory for JasperReports. | `${JASPERREPORTS_BASE_DIR}/buildomatic` |
|
||||
| `JASPERREPORTS_LOGS_DIR` | Log directory for JasperReports. | `${JASPERREPORTS_BASE_DIR}/WEB-INF/logs` |
|
||||
| `JASPERREPORTS_LOG_FILE` | Log file for JasperReports. | `${JASPERREPORTS_LOGS_DIR}/jasperserver.log` |
|
||||
| `JASPERREPORTS_CONF_FILE` | Configuration file for JasperReports. | `${JASPERREPORTS_CONF_DIR}/default_master.properties` |
|
||||
| `JASPERREPORTS_VOLUME_DIR` | JasperReports directory for mounted configuration files. | `${BITNAMI_VOLUME_DIR}/jasperreports` |
|
||||
| `JASPERREPORTS_DAEMON_USER` | JasperReports system user. | `tomcat` |
|
||||
| `JASPERREPORTS_DAEMON_GROUP` | JasperReports system group. | `tomcat` |
|
||||
| `JASPERREPORTS_TOMCAT_AJP_PORT_NUMBER` | Tomcat AJP port number. | `8009` |
|
||||
| `JASPERREPORTS_DEFAULT_DATABASE_HOST` | Default database server host. | `mariadb` |
|
||||
| `JASPERREPORTS_DEFAULT_DATABASE_HOST` | Default database server host. | `127.0.0.1` |
|
||||
|
||||
When you start the JasperReports 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:
|
||||
|
||||
* For docker-compose add the variable name and value under the application section in the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jasperreports/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
jasperreports:
|
||||
...
|
||||
environment:
|
||||
- JASPERREPORTS_PASSWORD=my_password
|
||||
...
|
||||
```
|
||||
|
||||
* For manual execution add a `--env` option with each variable and value:
|
||||
|
||||
```console
|
||||
$ docker run -d --name jasperreports -p 80:8080 -p 443:8443 \
|
||||
--env JASPERREPORTS_PASSWORD=my_password \
|
||||
--network jasperreports-tier \
|
||||
--volume /path/to/jasperreports-persistence:/bitnami \
|
||||
bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
#### Examples
|
||||
|
||||
##### SMTP configuration using a Gmail account
|
||||
|
||||
This would be an example of SMTP configuration using a Gmail account:
|
||||
|
||||
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jasperreports/docker-compose.yml) file present in this repository:
|
||||
|
||||
```yaml
|
||||
jasperreports:
|
||||
...
|
||||
environment:
|
||||
- JASPERREPORTS_DATABASE_USER=bn_jasperreports
|
||||
- JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- JASPERREPORTS_SMTP_HOST=smtp.gmail.com
|
||||
- JASPERREPORTS_SMTP_PORT_NUMBER=587
|
||||
- JASPERREPORTS_SMTP_PROTOCOL=smtps
|
||||
- JASPERREPORTS_SMTP_USER=your_email@gmail.com
|
||||
- JASPERREPORTS_SMTP_PASSWORD=your_password
|
||||
...
|
||||
```
|
||||
|
||||
* For manual execution:
|
||||
|
||||
```console
|
||||
$ docker run -d --name jasperreports -p 80:8080 -p 443:8443 \
|
||||
--env JASPERREPORTS_DATABASE_USER=bn_jasperreports \
|
||||
--env JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports \
|
||||
--env JASPERREPORTS_SMTP_HOST=smtp.gmail.com \
|
||||
--env JASPERREPORTS_SMTP_PORT_NUMBER=587 \
|
||||
--env JASPERREPORTS_SMTP_PROTOCOL=smtps \
|
||||
--env JASPERREPORTS_SMTP_USER=your_email@gmail.com \
|
||||
--env JASPERREPORTS_SMTP_PASSWORD=your_password \
|
||||
--network jasperreports-tier \
|
||||
--volume /path/to/jasperreports-persistence:/bitnami \
|
||||
bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
##### Connect JasperReports container to an existing database
|
||||
|
||||
The Bitnami JasperReports container supports connecting the JasperReports application to an external database. This would be an example of using an external database for JasperReports.
|
||||
|
||||
* Modify the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/jasperreports/docker-compose.yml) file present in this repository:
|
||||
|
||||
```diff
|
||||
jasperreports:
|
||||
...
|
||||
environment:
|
||||
- - JASPERREPORTS_DATABASE_HOST=mariadb
|
||||
+ - JASPERREPORTS_DATABASE_HOST=mariadb_host
|
||||
- JASPERREPORTS_DATABASE_PORT_NUMBER=3306
|
||||
- JASPERREPORTS_DATABASE_NAME=jasperreports_db
|
||||
- JASPERREPORTS_DATABASE_USER=jasperreports_user
|
||||
- - ALLOW_EMPTY_PASSWORD=yes
|
||||
+ - JASPERREPORTS_DATABASE_PASSWORD=jasperreports_password
|
||||
...
|
||||
```
|
||||
|
||||
* For manual execution:
|
||||
|
||||
```console
|
||||
$ docker run -d --name jasperreports\
|
||||
-p 8080:8080 -p 8443:8443 \
|
||||
--network jasperreports-network \
|
||||
--env JASPERREPORTS_DATABASE_HOST=mariadb_host \
|
||||
--env JASPERREPORTS_DATABASE_PORT_NUMBER=3306 \
|
||||
--env JASPERREPORTS_DATABASE_NAME=jasperreports_db \
|
||||
--env JASPERREPORTS_DATABASE_USER=jasperreports_user \
|
||||
--env JASPERREPORTS_DATABASE_PASSWORD=jasperreports_password \
|
||||
--volume jasperreports_data:/bitnami/jasperreports \
|
||||
bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
In case the database already contains data from a previous JasperReports installation, you need to set the variable `JASPERREPORTS_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 `JASPERREPORTS_SKIP_BOOTSTRAP` to `yes`, values for environment variables such as `JASPERREPORTS_USERNAME`, `JASPERREPORTS_PASSWORD` or `JASPERREPORTS_EMAIL` will be ignored.
|
||||
|
||||
## Logging
|
||||
|
||||
The Bitnami JasperReports Docker image sends the container logs to `stdout`. To view the logs:
|
||||
|
||||
```console
|
||||
docker logs jasperreports
|
||||
```
|
||||
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
docker-compose logs jasperreports
|
||||
```
|
||||
|
||||
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 jasperreports
|
||||
```
|
||||
|
||||
Or using Docker Compose:
|
||||
|
||||
```console
|
||||
docker-compose stop jasperreports
|
||||
```
|
||||
|
||||
#### 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/jasperreports-backups:/backups --volumes-from jasperreports bitnami/minideb \
|
||||
cp -a /bitnami/jasperreports /backups/latest
|
||||
```
|
||||
|
||||
### Restoring a backup
|
||||
|
||||
Restoring a backup is as simple as mounting the backup as volumes in the containers.
|
||||
|
||||
For the MariaDB database container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name mariadb \
|
||||
...
|
||||
- --volume /path/to/mariadb-persistence:/bitnami/mariadb \
|
||||
+ --volume /path/to/mariadb-backups/latest:/bitnami/mariadb \
|
||||
bitnami/mariadb:latest
|
||||
```
|
||||
|
||||
For the JasperReports container:
|
||||
|
||||
```diff
|
||||
$ docker run -d --name jasperreports \
|
||||
...
|
||||
- --volume /path/to/jasperreports-persistence:/bitnami/jasperreports \
|
||||
+ --volume /path/to/jasperreports-backups/latest:/bitnami/jasperreports \
|
||||
bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
### Upgrade this image
|
||||
|
||||
Bitnami provides up-to-date versions of MariaDB and JasperReports, 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 JasperReports container. For the MariaDB upgrade see: <https://github.com/bitnami/containers/tree/main/bitnami/mariadb#upgrade-this-image>
|
||||
|
||||
The `bitnami/jasperreports: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/jasperreports:latest`. However it is recommended to use [tagged versions](https://hub.docker.com/r/bitnami/jasperreports/tags/).
|
||||
|
||||
#### Step 1: Get the updated image
|
||||
|
||||
```console
|
||||
docker pull bitnami/jasperreports:latest
|
||||
```
|
||||
|
||||
#### Step 2: Stop the running container
|
||||
|
||||
Stop the currently running container using the command
|
||||
|
||||
```console
|
||||
docker-compose stop jasperreports
|
||||
```
|
||||
|
||||
#### 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 jasperreports
|
||||
```
|
||||
|
||||
#### 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
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/containers/issues) or submitting a [pull request](https://github.com/bitnami/containers/pulls) with your contribution.
|
||||
|
||||
## Issues
|
||||
|
||||
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/containers/issues/new/choose). For us to provide better support, be sure to fill the issue template.
|
||||
|
||||
## Notable Changes
|
||||
|
||||
## 7.8.0-debian-10-r275
|
||||
|
||||
* The size of the container image has been reduced.
|
||||
* The configuration logic is now based on Bash scripts in the *rootfs/* folder.
|
||||
* The container has been migrated to a non-root user approach. Previously the container ran as the `root` user and the Tomcat daemon was started as the `tomcat` user. From now on, both the container and the Tomcat daemon run as user `1001`. As a consequence, the data directory must be writable by that user. You can revert this behavior by changing `USER 1001` to `USER root` in the Dockerfile.
|
||||
|
||||
## 7.2.0-debian-10-r64
|
||||
|
||||
* Java distribution has been migrated from AdoptOpenJDK to OpenJDK Liberica. As part of VMware, we have an agreement with Bell Software to distribute the Liberica distribution of OpenJDK. That way, we can provide support & the latest versions and security releases for Java.
|
||||
|
||||
## License
|
||||
|
||||
Copyright © 2024 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
<http://www.apache.org/licenses/LICENSE-2.0>
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -1,34 +0,0 @@
|
||||
# Copyright VMware, Inc.
|
||||
# SPDX-License-Identifier: APACHE-2.0
|
||||
|
||||
version: '2'
|
||||
services:
|
||||
mariadb:
|
||||
image: docker.io/bitnami/mariadb:10.11
|
||||
volumes:
|
||||
- 'mariadb_data:/bitnami/mariadb'
|
||||
environment:
|
||||
# ALLOW_EMPTY_PASSWORD is recommended only for development.
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- MARIADB_USER=bn_jasperreports
|
||||
- MARIADB_DATABASE=bitnami_jasperreports
|
||||
jasperreports:
|
||||
image: docker.io/bitnami/jasperreports:8
|
||||
ports:
|
||||
- '80:8080'
|
||||
volumes:
|
||||
- 'jasperreports_data:/bitnami/jasperreports'
|
||||
depends_on:
|
||||
- mariadb
|
||||
environment:
|
||||
# ALLOW_EMPTY_PASSWORD is recommended only for development.
|
||||
- ALLOW_EMPTY_PASSWORD=yes
|
||||
- JASPERREPORTS_DATABASE_HOST=mariadb
|
||||
- JASPERREPORTS_DATABASE_PORT_NUMBER=3306
|
||||
- JASPERREPORTS_DATABASE_USER=bn_jasperreports
|
||||
- JASPERREPORTS_DATABASE_NAME=bitnami_jasperreports
|
||||
volumes:
|
||||
mariadb_data:
|
||||
driver: local
|
||||
jasperreports_data:
|
||||
driver: local
|
||||
Reference in New Issue
Block a user