[bitnami/grafana] Update supported branches (#87627)
Signed-off-by: David Gomez <david.gomez@broadcom.com>
This commit is contained in:
		
							parent
							
								
									65bdc0dba4
								
							
						
					
					
						commit
						1f6a0e2175
					
				|  | @ -0,0 +1,10 @@ | ||||||
|  | # ⚠️ Important Notice: Upcoming changes to the Bitnami Catalog | ||||||
|  | 
 | ||||||
|  | Beginning August 28th, 2025, Bitnami will evolve its public catalog to offer a curated set of hardened, security-focused images under the new [Bitnami Secure Images initiative](https://news.broadcom.com/app-dev/broadcom-introduces-bitnami-secure-images-for-production-ready-containerized-applications). As part of this transition: | ||||||
|  | 
 | ||||||
|  | - Granting community users access for the first time to security-optimized versions of popular container images. | ||||||
|  | - Bitnami will begin deprecating support for non-hardened, Debian-based software images in its free tier and will gradually remove non-latest tags from the public catalog. As a result, community users will have access to a reduced number of hardened images. These images are published only under the “latest” tag and are intended for development purposes | ||||||
|  | - Starting August 28th, over two weeks, all existing container images, including older or versioned tags (e.g., 2.50.0, 10.6), will be migrated from the public catalog (docker.io/bitnami) to the “Bitnami Legacy” repository (docker.io/bitnamilegacy), where they will no longer receive updates. | ||||||
|  | - For production workloads and long-term support, users are encouraged to adopt Bitnami Secure Images, which include hardened containers, smaller attack surfaces, CVE transparency (via VEX/KEV), SBOMs, and enterprise support. | ||||||
|  | 
 | ||||||
|  | These changes aim to improve the security posture of all Bitnami users by promoting best practices for software supply chain integrity and up-to-date deployments. For more details, visit the [Bitnami Secure Images announcement](https://github.com/bitnami/containers/issues/83267). | ||||||
|  | @ -0,0 +1,10 @@ | ||||||
|  | # ⚠️ Important Notice: Upcoming changes to the Bitnami Catalog | ||||||
|  | 
 | ||||||
|  | Beginning August 28th, 2025, Bitnami will evolve its public catalog to offer a curated set of hardened, security-focused images under the new [Bitnami Secure Images initiative](https://news.broadcom.com/app-dev/broadcom-introduces-bitnami-secure-images-for-production-ready-containerized-applications). As part of this transition: | ||||||
|  | 
 | ||||||
|  | - Granting community users access for the first time to security-optimized versions of popular container images. | ||||||
|  | - Bitnami will begin deprecating support for non-hardened, Debian-based software images in its free tier and will gradually remove non-latest tags from the public catalog. As a result, community users will have access to a reduced number of hardened images. These images are published only under the “latest” tag and are intended for development purposes | ||||||
|  | - Starting August 28th, over two weeks, all existing container images, including older or versioned tags (e.g., 2.50.0, 10.6), will be migrated from the public catalog (docker.io/bitnami) to the “Bitnami Legacy” repository (docker.io/bitnamilegacy), where they will no longer receive updates. | ||||||
|  | - For production workloads and long-term support, users are encouraged to adopt Bitnami Secure Images, which include hardened containers, smaller attack surfaces, CVE transparency (via VEX/KEV), SBOMs, and enterprise support. | ||||||
|  | 
 | ||||||
|  | These changes aim to improve the security posture of all Bitnami users by promoting best practices for software supply chain integrity and up-to-date deployments. For more details, visit the [Bitnami Secure Images announcement](https://github.com/bitnami/containers/issues/83267). | ||||||
|  | @ -0,0 +1,10 @@ | ||||||
|  | # ⚠️ Important Notice: Upcoming changes to the Bitnami Catalog | ||||||
|  | 
 | ||||||
|  | Beginning August 28th, 2025, Bitnami will evolve its public catalog to offer a curated set of hardened, security-focused images under the new [Bitnami Secure Images initiative](https://news.broadcom.com/app-dev/broadcom-introduces-bitnami-secure-images-for-production-ready-containerized-applications). As part of this transition: | ||||||
|  | 
 | ||||||
|  | - Granting community users access for the first time to security-optimized versions of popular container images. | ||||||
|  | - Bitnami will begin deprecating support for non-hardened, Debian-based software images in its free tier and will gradually remove non-latest tags from the public catalog. As a result, community users will have access to a reduced number of hardened images. These images are published only under the “latest” tag and are intended for development purposes | ||||||
|  | - Starting August 28th, over two weeks, all existing container images, including older or versioned tags (e.g., 2.50.0, 10.6), will be migrated from the public catalog (docker.io/bitnami) to the “Bitnami Legacy” repository (docker.io/bitnamilegacy), where they will no longer receive updates. | ||||||
|  | - For production workloads and long-term support, users are encouraged to adopt Bitnami Secure Images, which include hardened containers, smaller attack surfaces, CVE transparency (via VEX/KEV), SBOMs, and enterprise support. | ||||||
|  | 
 | ||||||
|  | These changes aim to improve the security posture of all Bitnami users by promoting best practices for software supply chain integrity and up-to-date deployments. For more details, visit the [Bitnami Secure Images announcement](https://github.com/bitnami/containers/issues/83267). | ||||||
|  | @ -1,61 +0,0 @@ | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| FROM docker.io/bitnami/minideb:bookworm |  | ||||||
| 
 |  | ||||||
| ARG DOWNLOADS_URL="downloads.bitnami.com/files/stacksmith" |  | ||||||
| ARG TARGETARCH |  | ||||||
| 
 |  | ||||||
| LABEL org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \ |  | ||||||
|       org.opencontainers.image.created="2025-10-14T02:27:34Z" \ |  | ||||||
|       org.opencontainers.image.description="Application packaged by Broadcom, Inc." \ |  | ||||||
|       org.opencontainers.image.documentation="https://github.com/bitnami/containers/tree/main/bitnami/grafana/README.md" \ |  | ||||||
|       org.opencontainers.image.source="https://github.com/bitnami/containers/tree/main/bitnami/grafana" \ |  | ||||||
|       org.opencontainers.image.title="grafana" \ |  | ||||||
|       org.opencontainers.image.vendor="Broadcom, Inc." \ |  | ||||||
|       org.opencontainers.image.version="12.2.0" |  | ||||||
| 
 |  | ||||||
| ENV HOME="/" \ |  | ||||||
|     OS_ARCH="${TARGETARCH:-amd64}" \ |  | ||||||
|     OS_FLAVOUR="debian-12" \ |  | ||||||
|     OS_NAME="linux" |  | ||||||
| 
 |  | ||||||
| COPY prebuildfs / |  | ||||||
| SHELL ["/bin/bash", "-o", "errexit", "-o", "nounset", "-o", "pipefail", "-c"] |  | ||||||
| # Install required system packages and dependencies |  | ||||||
| RUN install_packages ca-certificates curl libaudit1 libcap-ng0 libfontconfig libgcc-s1 libicu72 liblzma5 libncurses6 libpam0g libssl3 libstdc++6 libtinfo6 libxml2 procps zlib1g |  | ||||||
| RUN --mount=type=secret,id=downloads_url,env=SECRET_DOWNLOADS_URL \ |  | ||||||
|     DOWNLOADS_URL=${SECRET_DOWNLOADS_URL:-${DOWNLOADS_URL}} ; \ |  | ||||||
|     mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ || exit 1 ; \ |  | ||||||
|     COMPONENTS=( \ |  | ||||||
|       "mysql-client-12.0.2-0-linux-${OS_ARCH}-debian-12" \ |  | ||||||
|       "ini-file-1.4.9-3-linux-${OS_ARCH}-debian-12" \ |  | ||||||
|       "grafana-12.2.0-2-linux-${OS_ARCH}-debian-12" \ |  | ||||||
|     ) ; \ |  | ||||||
|     for COMPONENT in "${COMPONENTS[@]}"; do \ |  | ||||||
|       if [ ! -f "${COMPONENT}.tar.gz" ]; then \ |  | ||||||
|         curl -SsLf "https://${DOWNLOADS_URL}/${COMPONENT}.tar.gz" -O ; \ |  | ||||||
|         curl -SsLf "https://${DOWNLOADS_URL}/${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 ; \ |  | ||||||
|       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/grafana/postunpack.sh |  | ||||||
| ENV APP_VERSION="12.2.0" \ |  | ||||||
|     BITNAMI_APP_NAME="grafana" \ |  | ||||||
|     IMAGE_REVISION="3" \ |  | ||||||
|     PATH="/opt/bitnami/mysql/bin:/opt/bitnami/common/bin:/opt/bitnami/grafana/bin:$PATH" |  | ||||||
| 
 |  | ||||||
| EXPOSE 3000 |  | ||||||
| 
 |  | ||||||
| WORKDIR /opt/bitnami/grafana |  | ||||||
| USER 1001 |  | ||||||
| ENTRYPOINT [ "/opt/bitnami/scripts/grafana/entrypoint.sh" ] |  | ||||||
| CMD [ "/opt/bitnami/scripts/grafana/run.sh" ] |  | ||||||
|  | @ -1,15 +0,0 @@ | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| services: |  | ||||||
|   grafana: |  | ||||||
|     image: docker.io/bitnami/grafana:12 |  | ||||||
|     ports: |  | ||||||
|       - '3000:3000' |  | ||||||
|     environment: |  | ||||||
|       - 'GF_SECURITY_ADMIN_PASSWORD=bitnami' |  | ||||||
|     volumes: |  | ||||||
|       - grafana_data:/opt/bitnami/grafana/data |  | ||||||
| volumes: |  | ||||||
|   grafana_data: |  | ||||||
|     driver: local |  | ||||||
|  | @ -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 Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Bitnami custom library |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| 
 |  | ||||||
| # Constants |  | ||||||
| BOLD='\033[1m' |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Print the welcome page |  | ||||||
| # Globals: |  | ||||||
| #   DISABLE_WELCOME_MESSAGE |  | ||||||
| #   BITNAMI_APP_NAME |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| print_welcome_page() { |  | ||||||
|     if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then |  | ||||||
|         if [[ -n "$BITNAMI_APP_NAME" ]]; then |  | ||||||
|             print_image_welcome_page |  | ||||||
|         fi |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Print the welcome page for a Bitnami Docker image |  | ||||||
| # Globals: |  | ||||||
| #   BITNAMI_APP_NAME |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| print_image_welcome_page() { |  | ||||||
|     local github_url="https://github.com/bitnami/containers" |  | ||||||
| 
 |  | ||||||
|     info "" |  | ||||||
|     info "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" |  | ||||||
|     info "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" |  | ||||||
|     info "${YELLOW}NOTICE: Starting August 28th, 2025, only a limited subset of images/charts will remain available for free. Backup will be available for some time at the 'Bitnami Legacy' repository. More info at https://github.com/bitnami/containers/issues/83267${RESET}" |  | ||||||
|     info "" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
|  | @ -1,141 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Library for managing files |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/libos.sh |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Replace a regex-matching string in a file |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - filename |  | ||||||
| #   $2 - match regex |  | ||||||
| #   $3 - substitute regex |  | ||||||
| #   $4 - use POSIX regex. Default: true |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| replace_in_file() { |  | ||||||
|     local filename="${1:?filename is required}" |  | ||||||
|     local match_regex="${2:?match regex is required}" |  | ||||||
|     local substitute_regex="${3:?substitute regex is required}" |  | ||||||
|     local posix_regex=${4:-true} |  | ||||||
| 
 |  | ||||||
|     local result |  | ||||||
| 
 |  | ||||||
|     # We should avoid using 'sed in-place' substitutions |  | ||||||
|     # 1) They are not compatible with files mounted from ConfigMap(s) |  | ||||||
|     # 2) We found incompatibility issues with Debian10 and "in-place" substitutions |  | ||||||
|     local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues |  | ||||||
|     if [[ $posix_regex = true ]]; then |  | ||||||
|         result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" |  | ||||||
|     else |  | ||||||
|         result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" |  | ||||||
|     fi |  | ||||||
|     echo "$result" > "$filename" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Replace a regex-matching multiline string in a file |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - filename |  | ||||||
| #   $2 - match regex |  | ||||||
| #   $3 - substitute regex |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| replace_in_file_multiline() { |  | ||||||
|     local filename="${1:?filename is required}" |  | ||||||
|     local match_regex="${2:?match regex is required}" |  | ||||||
|     local substitute_regex="${3:?substitute regex is required}" |  | ||||||
| 
 |  | ||||||
|     local result |  | ||||||
|     local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues |  | ||||||
|     result="$(perl -pe "BEGIN{undef $/;} s${del}${match_regex}${del}${substitute_regex}${del}sg" "$filename")" |  | ||||||
|     echo "$result" > "$filename" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Remove a line in a file based on a regex |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - filename |  | ||||||
| #   $2 - match regex |  | ||||||
| #   $3 - use POSIX regex. Default: true |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| remove_in_file() { |  | ||||||
|     local filename="${1:?filename is required}" |  | ||||||
|     local match_regex="${2:?match regex is required}" |  | ||||||
|     local posix_regex=${3:-true} |  | ||||||
|     local result |  | ||||||
| 
 |  | ||||||
|     # We should avoid using 'sed in-place' substitutions |  | ||||||
|     # 1) They are not compatible with files mounted from ConfigMap(s) |  | ||||||
|     # 2) We found incompatibility issues with Debian10 and "in-place" substitutions |  | ||||||
|     if [[ $posix_regex = true ]]; then |  | ||||||
|         result="$(sed -E "/$match_regex/d" "$filename")" |  | ||||||
|     else |  | ||||||
|         result="$(sed "/$match_regex/d" "$filename")" |  | ||||||
|     fi |  | ||||||
|     echo "$result" > "$filename" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Appends text after the last line matching a pattern |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - file |  | ||||||
| #   $2 - match regex |  | ||||||
| #   $3 - contents to add |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| append_file_after_last_match() { |  | ||||||
|     local file="${1:?missing file}" |  | ||||||
|     local match_regex="${2:?missing pattern}" |  | ||||||
|     local value="${3:?missing value}" |  | ||||||
| 
 |  | ||||||
|     # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again |  | ||||||
|     result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" |  | ||||||
|     echo "$result" > "$file" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Wait until certain entry is present in a log file |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - entry to look for |  | ||||||
| #   $2 - log file |  | ||||||
| #   $3 - max retries. Default: 12 |  | ||||||
| #   $4 - sleep between retries (in seconds). Default: 5 |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| wait_for_log_entry() { |  | ||||||
|     local -r entry="${1:-missing entry}" |  | ||||||
|     local -r log_file="${2:-missing log file}" |  | ||||||
|     local -r retries="${3:-12}" |  | ||||||
|     local -r interval_time="${4:-5}" |  | ||||||
|     local attempt=0 |  | ||||||
| 
 |  | ||||||
|     check_log_file_for_entry() { |  | ||||||
|         if ! grep -qE "$entry" "$log_file"; then |  | ||||||
|             debug "Entry \"${entry}\" still not present in ${log_file} (attempt $((++attempt))/${retries})" |  | ||||||
|             return 1 |  | ||||||
|         fi |  | ||||||
|     } |  | ||||||
|     debug "Checking that ${log_file} log file contains entry \"${entry}\"" |  | ||||||
|     if retry_while check_log_file_for_entry "$retries" "$interval_time"; then |  | ||||||
|         debug "Found entry \"${entry}\" in ${log_file}" |  | ||||||
|         true |  | ||||||
|     else |  | ||||||
|         error "Could not find entry \"${entry}\" in ${log_file} after ${retries} retries" |  | ||||||
|         debug_execute cat "$log_file" |  | ||||||
|         return 1 |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
|  | @ -1,193 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Library for file system actions |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Ensure a file/directory is owned (user and group) but the given user |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - filepath |  | ||||||
| #   $2 - owner |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| owned_by() { |  | ||||||
|     local path="${1:?path is missing}" |  | ||||||
|     local owner="${2:?owner is missing}" |  | ||||||
|     local group="${3:-}" |  | ||||||
| 
 |  | ||||||
|     if [[ -n $group ]]; then |  | ||||||
|         chown "$owner":"$group" "$path" |  | ||||||
|     else |  | ||||||
|         chown "$owner":"$owner" "$path" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Ensure a directory exists and, optionally, is owned by the given user |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - directory |  | ||||||
| #   $2 - owner |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| ensure_dir_exists() { |  | ||||||
|     local dir="${1:?directory is missing}" |  | ||||||
|     local owner_user="${2:-}" |  | ||||||
|     local owner_group="${3:-}" |  | ||||||
| 
 |  | ||||||
|     [ -d "${dir}" ] || mkdir -p "${dir}" |  | ||||||
|     if [[ -n $owner_user ]]; then |  | ||||||
|         owned_by "$dir" "$owner_user" "$owner_group" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Checks whether a directory is empty or not |  | ||||||
| # arguments: |  | ||||||
| #   $1 - directory |  | ||||||
| # returns: |  | ||||||
| #   boolean |  | ||||||
| ######################### |  | ||||||
| is_dir_empty() { |  | ||||||
|     local -r path="${1:?missing directory}" |  | ||||||
|     # Calculate real path in order to avoid issues with symlinks |  | ||||||
|     local -r dir="$(realpath "$path")" |  | ||||||
|     if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then |  | ||||||
|         true |  | ||||||
|     else |  | ||||||
|         false |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Checks whether a mounted directory is empty or not |  | ||||||
| # arguments: |  | ||||||
| #   $1 - directory |  | ||||||
| # returns: |  | ||||||
| #   boolean |  | ||||||
| ######################### |  | ||||||
| is_mounted_dir_empty() { |  | ||||||
|     local dir="${1:?missing directory}" |  | ||||||
| 
 |  | ||||||
|     if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then |  | ||||||
|         true |  | ||||||
|     else |  | ||||||
|         false |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Checks whether a file can be written to or not |  | ||||||
| # arguments: |  | ||||||
| #   $1 - file |  | ||||||
| # returns: |  | ||||||
| #   boolean |  | ||||||
| ######################### |  | ||||||
| is_file_writable() { |  | ||||||
|     local file="${1:?missing file}" |  | ||||||
|     local dir |  | ||||||
|     dir="$(dirname "$file")" |  | ||||||
| 
 |  | ||||||
|     if [[ (-f "$file" && -w "$file") || (! -f "$file" && -d "$dir" && -w "$dir") ]]; then |  | ||||||
|         true |  | ||||||
|     else |  | ||||||
|         false |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Relativize a path |  | ||||||
| # arguments: |  | ||||||
| #   $1 - path |  | ||||||
| #   $2 - base |  | ||||||
| # returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| relativize() { |  | ||||||
|     local -r path="${1:?missing path}" |  | ||||||
|     local -r base="${2:?missing base}" |  | ||||||
|     pushd "$base" >/dev/null || exit |  | ||||||
|     realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' |  | ||||||
|     popd >/dev/null || exit |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Configure permissions and ownership recursively |  | ||||||
| # Globals: |  | ||||||
| #   None |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - paths (as a string). |  | ||||||
| # Flags: |  | ||||||
| #   -f|--file-mode - mode for directories. |  | ||||||
| #   -d|--dir-mode - mode for files. |  | ||||||
| #   -u|--user - user |  | ||||||
| #   -g|--group - group |  | ||||||
| # 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 Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Library to use for scripts expected to be used as Kubernetes lifecycle hooks |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load generic libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| . /opt/bitnami/scripts/libos.sh |  | ||||||
| 
 |  | ||||||
| # Override functions that log to stdout/stderr of the current process, so they print to process 1 |  | ||||||
| for function_to_override in stderr_print debug_execute; do |  | ||||||
|     # Output is sent to output of process 1 and thus end up in the container log |  | ||||||
|     # The hook output in general isn't saved |  | ||||||
|     eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2" |  | ||||||
| done |  | ||||||
|  | @ -1,146 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Library for logging functions |  | ||||||
| 
 |  | ||||||
| # Constants |  | ||||||
| RESET='\033[0m' |  | ||||||
| RED='\033[38;5;1m' |  | ||||||
| GREEN='\033[38;5;2m' |  | ||||||
| YELLOW='\033[38;5;3m' |  | ||||||
| MAGENTA='\033[38;5;5m' |  | ||||||
| CYAN='\033[38;5;6m' |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Print to STDERR |  | ||||||
| # Arguments: |  | ||||||
| #   Message to print |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| stderr_print() { |  | ||||||
|     # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it |  | ||||||
|     local bool="${BITNAMI_QUIET:-false}" |  | ||||||
|     # 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() { |  | ||||||
|     local color_bool="${BITNAMI_COLOR:-true}" |  | ||||||
|     # comparison is performed without regard to the case of alphabetic characters |  | ||||||
|     shopt -s nocasematch |  | ||||||
|     if [[ "$color_bool" = 1 || "$color_bool" =~ ^(yes|true)$ ]]; then |  | ||||||
|         stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" |  | ||||||
|     else |  | ||||||
|         stderr_print "${MODULE:-} $(date "+%T.%2N ")${*}" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| ######################## |  | ||||||
| # Log an 'info' message |  | ||||||
| # Arguments: |  | ||||||
| #   Message to log |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| info() { |  | ||||||
|     local msg_color="" |  | ||||||
|     local color_bool="${BITNAMI_COLOR:-true}" |  | ||||||
|     # comparison is performed without regard to the case of alphabetic characters |  | ||||||
|     shopt -s nocasematch |  | ||||||
|     if [[ "$color_bool" = 1 || "$color_bool" =~ ^(yes|true)$ ]];then |  | ||||||
|         msg_color="$GREEN" |  | ||||||
|     fi |  | ||||||
|     log "${msg_color}INFO ${RESET} ==> ${*}" |  | ||||||
| } |  | ||||||
| ######################## |  | ||||||
| # Log message |  | ||||||
| # Arguments: |  | ||||||
| #   Message to log |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| warn() { |  | ||||||
|     local msg_color="" |  | ||||||
|     local color_bool="${BITNAMI_COLOR:-true}" |  | ||||||
|     # comparison is performed without regard to the case of alphabetic characters |  | ||||||
|     shopt -s nocasematch |  | ||||||
|     if [[ "$color_bool" = 1 || "$color_bool" =~ ^(yes|true)$ ]];then |  | ||||||
|         msg_color="$YELLOW" |  | ||||||
|     fi |  | ||||||
|     log "${msg_color}WARN ${RESET} ==> ${*}" |  | ||||||
| } |  | ||||||
| ######################## |  | ||||||
| # Log an 'error' message |  | ||||||
| # Arguments: |  | ||||||
| #   Message to log |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| error() { |  | ||||||
|     local msg_color="" |  | ||||||
|     local color_bool="${BITNAMI_COLOR:-true}" |  | ||||||
|     # comparison is performed without regard to the case of alphabetic characters |  | ||||||
|     shopt -s nocasematch |  | ||||||
|     if [[ "$color_bool" = 1 || "$color_bool" =~ ^(yes|true)$ ]];then |  | ||||||
|         msg_color="$RED" |  | ||||||
|     fi |  | ||||||
|     log "${msg_color}ERROR${RESET} ==> ${*}" |  | ||||||
| } |  | ||||||
| ######################## |  | ||||||
| # Log a 'debug' message |  | ||||||
| # Globals: |  | ||||||
| #   BITNAMI_DEBUG |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| debug() { |  | ||||||
|     local msg_color="" |  | ||||||
|     local color_bool="${BITNAMI_COLOR:-true}" |  | ||||||
|     # comparison is performed without regard to the case of alphabetic characters |  | ||||||
|     shopt -s nocasematch |  | ||||||
|     if [[ "$color_bool" = 1 || "$color_bool" =~ ^(yes|true)$ ]] ;then |  | ||||||
|         msg_color="$MAGENTA" |  | ||||||
|     fi |  | ||||||
|     local debug_bool="${BITNAMI_DEBUG:-false}" |  | ||||||
|     if [[ "$debug_bool" = 1 || "$debug_bool" =~ ^(yes|true)$ ]]; then |  | ||||||
|         log "${msg_color}DEBUG${RESET} ==> ${*}" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Indent a string |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - string |  | ||||||
| #   $2 - number of indentation characters (default: 4) |  | ||||||
| #   $3 - indentation character (default: " ") |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| indent() { |  | ||||||
|     local string="${1:-}" |  | ||||||
|     local num="${2:?missing num}" |  | ||||||
|     local char="${3:-" "}" |  | ||||||
|     # Build the indentation unit string |  | ||||||
|     local indent_unit="" |  | ||||||
|     for ((i = 0; i < num; i++)); do |  | ||||||
|         indent_unit="${indent_unit}${char}" |  | ||||||
|     done |  | ||||||
|     # shellcheck disable=SC2001 |  | ||||||
|     # Complex regex, see https://github.com/koalaman/shellcheck/wiki/SC2001#exceptions |  | ||||||
|     echo "$string" | sed "s/^/${indent_unit}/" |  | ||||||
| } |  | ||||||
|  | @ -1,171 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Library for network functions |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| . /opt/bitnami/scripts/libvalidations.sh |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Resolve IP address for a host/domain (i.e. DNS lookup) |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Hostname to resolve |  | ||||||
| #   $2 - IP address version (v4, v6), leave empty for resolving to any version |  | ||||||
| # Returns: |  | ||||||
| #   IP |  | ||||||
| ######################### |  | ||||||
| dns_lookup() { |  | ||||||
|     local host="${1:?host is missing}" |  | ||||||
|     local ip_version="${2:-}" |  | ||||||
|     getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1 |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################### |  | ||||||
| # Wait for a hostname and return the IP |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - hostname |  | ||||||
| #   $2 - number of retries |  | ||||||
| #   $3 - seconds to wait between retries |  | ||||||
| # Returns: |  | ||||||
| #   - IP address that corresponds to the hostname |  | ||||||
| ######################### |  | ||||||
| wait_for_dns_lookup() { |  | ||||||
|     local hostname="${1:?hostname is missing}" |  | ||||||
|     local retries="${2:-5}" |  | ||||||
|     local seconds="${3:-1}" |  | ||||||
|     check_host() { |  | ||||||
|         if [[ $(dns_lookup "$hostname") == "" ]]; then |  | ||||||
|             false |  | ||||||
|         else |  | ||||||
|             true |  | ||||||
|         fi |  | ||||||
|     } |  | ||||||
|     # Wait for the host to be ready |  | ||||||
|     retry_while "check_host ${hostname}" "$retries" "$seconds" |  | ||||||
|     dns_lookup "$hostname" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Get machine's IP |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   Machine IP |  | ||||||
| ######################### |  | ||||||
| get_machine_ip() { |  | ||||||
|     local -a ip_addresses |  | ||||||
|     local hostname |  | ||||||
|     hostname="$(hostname)" |  | ||||||
|     read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" |  | ||||||
|     if [[ "${#ip_addresses[@]}" -gt 1 ]]; then |  | ||||||
|         warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" |  | ||||||
|     elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then |  | ||||||
|         error "Could not find any IP address associated to hostname ${hostname}" |  | ||||||
|         exit 1 |  | ||||||
|     fi |  | ||||||
|     # Check if the first IP address is IPv6 to add brackets |  | ||||||
|     if validate_ipv6 "${ip_addresses[0]}" ; then |  | ||||||
|         echo "[${ip_addresses[0]}]" |  | ||||||
|     else |  | ||||||
|         echo "${ip_addresses[0]}" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if the provided argument is a resolved hostname |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Value to check |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| is_hostname_resolved() { |  | ||||||
|     local -r host="${1:?missing value}" |  | ||||||
|     if [[ -n "$(dns_lookup "$host")" ]]; then |  | ||||||
|         true |  | ||||||
|     else |  | ||||||
|         false |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Parse URL |  | ||||||
| # Globals: |  | ||||||
| #   None |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - uri - String |  | ||||||
| #   $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String |  | ||||||
| # Returns: |  | ||||||
| #   String |  | ||||||
| parse_uri() { |  | ||||||
|     local uri="${1:?uri is missing}" |  | ||||||
|     local component="${2:?component is missing}" |  | ||||||
| 
 |  | ||||||
|     # Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with |  | ||||||
|     # additional sub-expressions to split authority into userinfo, host and port |  | ||||||
|     # Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969) |  | ||||||
|     local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-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 Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Library for operating system actions |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| . /opt/bitnami/scripts/libfs.sh |  | ||||||
| . /opt/bitnami/scripts/libvalidations.sh |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if an user exists in the system |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - user |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| user_exists() { |  | ||||||
|     local user="${1:?user is missing}" |  | ||||||
|     id "$user" >/dev/null 2>&1 |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if a group exists in the system |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - group |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| group_exists() { |  | ||||||
|     local group="${1:?group is missing}" |  | ||||||
|     getent group "$group" >/dev/null 2>&1 |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Create a group in the system if it does not exist already |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - group |  | ||||||
| # Flags: |  | ||||||
| #   -i|--gid - the ID for the new group |  | ||||||
| #   -s|--system - Whether to create new user as system user (uid <= 999) |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| ensure_group_exists() { |  | ||||||
|     local group="${1:?group is missing}" |  | ||||||
|     local gid="" |  | ||||||
|     local is_system_user=false |  | ||||||
| 
 |  | ||||||
|     # Validate arguments |  | ||||||
|     shift 1 |  | ||||||
|     while [ "$#" -gt 0 ]; do |  | ||||||
|         case "$1" in |  | ||||||
|         -i | --gid) |  | ||||||
|             shift |  | ||||||
|             gid="${1:?missing gid}" |  | ||||||
|             ;; |  | ||||||
|         -s | --system) |  | ||||||
|             is_system_user=true |  | ||||||
|             ;; |  | ||||||
|         *) |  | ||||||
|             echo "Invalid command line flag $1" >&2 |  | ||||||
|             return 1 |  | ||||||
|             ;; |  | ||||||
|         esac |  | ||||||
|         shift |  | ||||||
|     done |  | ||||||
| 
 |  | ||||||
|     if ! group_exists "$group"; then |  | ||||||
|         local -a args=("$group") |  | ||||||
|         if [[ -n "$gid" ]]; then |  | ||||||
|             if group_exists "$gid"; then |  | ||||||
|                 error "The GID $gid is already in use." >&2 |  | ||||||
|                 return 1 |  | ||||||
|             fi |  | ||||||
|             args+=("--gid" "$gid") |  | ||||||
|         fi |  | ||||||
|         $is_system_user && args+=("--system") |  | ||||||
|         groupadd "${args[@]}" >/dev/null 2>&1 |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Create an user in the system if it does not exist already |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - user |  | ||||||
| # Flags: |  | ||||||
| #   -i|--uid - the ID for the new user |  | ||||||
| #   -g|--group - the group the new user should belong to |  | ||||||
| #   -a|--append-groups - comma-separated list of supplemental groups to append to the new user |  | ||||||
| #   -h|--home - the home directory for the new user |  | ||||||
| #   -s|--system - whether to create new user as system user (uid <= 999) |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| ensure_user_exists() { |  | ||||||
|     local user="${1:?user is missing}" |  | ||||||
|     local uid="" |  | ||||||
|     local group="" |  | ||||||
|     local append_groups="" |  | ||||||
|     local home="" |  | ||||||
|     local is_system_user=false |  | ||||||
| 
 |  | ||||||
|     # Validate arguments |  | ||||||
|     shift 1 |  | ||||||
|     while [ "$#" -gt 0 ]; do |  | ||||||
|         case "$1" in |  | ||||||
|         -i | --uid) |  | ||||||
|             shift |  | ||||||
|             uid="${1:?missing uid}" |  | ||||||
|             ;; |  | ||||||
|         -g | --group) |  | ||||||
|             shift |  | ||||||
|             group="${1:?missing group}" |  | ||||||
|             ;; |  | ||||||
|         -a | --append-groups) |  | ||||||
|             shift |  | ||||||
|             append_groups="${1:?missing append_groups}" |  | ||||||
|             ;; |  | ||||||
|         -h | --home) |  | ||||||
|             shift |  | ||||||
|             home="${1:?missing home directory}" |  | ||||||
|             ;; |  | ||||||
|         -s | --system) |  | ||||||
|             is_system_user=true |  | ||||||
|             ;; |  | ||||||
|         *) |  | ||||||
|             echo "Invalid command line flag $1" >&2 |  | ||||||
|             return 1 |  | ||||||
|             ;; |  | ||||||
|         esac |  | ||||||
|         shift |  | ||||||
|     done |  | ||||||
| 
 |  | ||||||
|     if ! user_exists "$user"; then |  | ||||||
|         local -a user_args=("-N" "$user") |  | ||||||
|         if [[ -n "$uid" ]]; then |  | ||||||
|             if user_exists "$uid"; then |  | ||||||
|                 error "The UID $uid is already in use." |  | ||||||
|                 return 1 |  | ||||||
|             fi |  | ||||||
|             user_args+=("--uid" "$uid") |  | ||||||
|         else |  | ||||||
|             $is_system_user && user_args+=("--system") |  | ||||||
|         fi |  | ||||||
|         useradd "${user_args[@]}" >/dev/null 2>&1 |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     if [[ -n "$group" ]]; then |  | ||||||
|         local -a group_args=("$group") |  | ||||||
|         $is_system_user && group_args+=("--system") |  | ||||||
|         ensure_group_exists "${group_args[@]}" |  | ||||||
|         usermod -g "$group" "$user" >/dev/null 2>&1 |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     if [[ -n "$append_groups" ]]; then |  | ||||||
|         local -a groups |  | ||||||
|         read -ra groups <<<"$(tr ',;' ' ' <<<"$append_groups")" |  | ||||||
|         for group in "${groups[@]}"; do |  | ||||||
|             ensure_group_exists "$group" |  | ||||||
|             usermod -aG "$group" "$user" >/dev/null 2>&1 |  | ||||||
|         done |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     if [[ -n "$home" ]]; then |  | ||||||
|         mkdir -p "$home" |  | ||||||
|         usermod -d "$home" "$user" >/dev/null 2>&1 |  | ||||||
|         configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group" |  | ||||||
|     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 Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Bitnami persistence library |  | ||||||
| # Used for bringing persistence capabilities to applications that don't have clear separation of data and logic |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/libfs.sh |  | ||||||
| . /opt/bitnami/scripts/libos.sh |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| . /opt/bitnami/scripts/libversion.sh |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Persist an application directory |  | ||||||
| # Globals: |  | ||||||
| #   BITNAMI_ROOT_DIR |  | ||||||
| #   BITNAMI_VOLUME_DIR |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - App folder name |  | ||||||
| #   $2 - List of app files to persist |  | ||||||
| # Returns: |  | ||||||
| #   true if all steps succeeded, false otherwise |  | ||||||
| ######################### |  | ||||||
| persist_app() { |  | ||||||
|     local -r app="${1:?missing app}" |  | ||||||
|     local -a files_to_restore |  | ||||||
|     read -r -a files_to_persist <<< "$(tr ',;:' ' ' <<< "$2")" |  | ||||||
|     local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" |  | ||||||
|     local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" |  | ||||||
|     # Persist the individual files |  | ||||||
|     if [[ "${#files_to_persist[@]}" -le 0 ]]; then |  | ||||||
|         warn "No files are configured to be persisted" |  | ||||||
|         return |  | ||||||
|     fi |  | ||||||
|     pushd "$install_dir" >/dev/null || exit |  | ||||||
|     local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder |  | ||||||
|     local -r 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,426 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Library for managing services |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/libvalidations.sh |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Read the provided pid file and returns a PID |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Pid file |  | ||||||
| # Returns: |  | ||||||
| #   PID |  | ||||||
| ######################### |  | ||||||
| get_pid_from_file() { |  | ||||||
|     local pid_file="${1:?pid file is missing}" |  | ||||||
| 
 |  | ||||||
|     if [[ -f "$pid_file" ]]; then |  | ||||||
|         if [[ -n "$(< "$pid_file")" ]] && [[ "$(< "$pid_file")" -gt 0 ]]; then |  | ||||||
|             echo "$(< "$pid_file")" |  | ||||||
|         fi |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if a provided PID corresponds to a running service |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - PID |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| is_service_running() { |  | ||||||
|     local pid="${1:?pid is missing}" |  | ||||||
| 
 |  | ||||||
|     kill -0 "$pid" 2>/dev/null |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Stop a service by sending a termination signal to its pid |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Pid file |  | ||||||
| #   $2 - Signal number (optional) |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| stop_service_using_pid() { |  | ||||||
|     local pid_file="${1:?pid file is missing}" |  | ||||||
|     local signal="${2:-}" |  | ||||||
|     local pid |  | ||||||
| 
 |  | ||||||
|     pid="$(get_pid_from_file "$pid_file")" |  | ||||||
|     [[ -z "$pid" ]] || ! is_service_running "$pid" && return |  | ||||||
| 
 |  | ||||||
|     if [[ -n "$signal" ]]; then |  | ||||||
|         kill "-${signal}" "$pid" |  | ||||||
|     else |  | ||||||
|         kill "$pid" |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     local counter=10 |  | ||||||
|     while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do |  | ||||||
|         sleep 1 |  | ||||||
|         counter=$((counter - 1)) |  | ||||||
|     done |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Start cron daemon |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   true if started correctly, false otherwise |  | ||||||
| ######################### |  | ||||||
| cron_start() { |  | ||||||
|     if [[ -x "/usr/sbin/cron" ]]; then |  | ||||||
|         /usr/sbin/cron |  | ||||||
|     elif [[ -x "/usr/sbin/crond" ]]; then |  | ||||||
|         /usr/sbin/crond |  | ||||||
|     else |  | ||||||
|         false |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Generate a cron configuration file for a given service |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Service name |  | ||||||
| #   $2 - Command |  | ||||||
| # Flags: |  | ||||||
| #   --run-as - User to run as (default: root) |  | ||||||
| #   --schedule - Cron schedule configuration (default: * * * * *) |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| generate_cron_conf() { |  | ||||||
|     local service_name="${1:?service name is missing}" |  | ||||||
|     local cmd="${2:?command is missing}" |  | ||||||
|     local run_as="root" |  | ||||||
|     local schedule="* * * * *" |  | ||||||
|     local clean="true" |  | ||||||
| 
 |  | ||||||
|     # Parse optional CLI flags |  | ||||||
|     shift 2 |  | ||||||
|     while [[ "$#" -gt 0 ]]; do |  | ||||||
|         case "$1" in |  | ||||||
|             --run-as) |  | ||||||
|                 shift |  | ||||||
|                 run_as="$1" |  | ||||||
|                 ;; |  | ||||||
|             --schedule) |  | ||||||
|                 shift |  | ||||||
|                 schedule="$1" |  | ||||||
|                 ;; |  | ||||||
|             --no-clean) |  | ||||||
|                 clean="false" |  | ||||||
|                 ;; |  | ||||||
|             *) |  | ||||||
|                 echo "Invalid command line flag ${1}" >&2 |  | ||||||
|                 return 1 |  | ||||||
|                 ;; |  | ||||||
|         esac |  | ||||||
|         shift |  | ||||||
|     done |  | ||||||
| 
 |  | ||||||
|     mkdir -p /etc/cron.d |  | ||||||
|     if "$clean"; then |  | ||||||
|         cat > "/etc/cron.d/${service_name}" <<EOF |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| ${schedule} ${run_as} ${cmd} |  | ||||||
| EOF |  | ||||||
|     else |  | ||||||
|         echo "${schedule} ${run_as} ${cmd}" >> /etc/cron.d/"$service_name" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Generate a logrotate configuration file |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Service name |  | ||||||
| #   $2 - Log files pattern |  | ||||||
| # Flags: |  | ||||||
| #   --period - Period |  | ||||||
| #   --rotations - Number of rotations to store |  | ||||||
| #   --extra - Extra options (Optional) |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| generate_logrotate_conf() { |  | ||||||
|     local service_name="${1:?service name is missing}" |  | ||||||
|     local log_path="${2:?log path is missing}" |  | ||||||
|     local period="weekly" |  | ||||||
|     local rotations="150" |  | ||||||
|     local extra="" |  | ||||||
|     local logrotate_conf_dir="/etc/logrotate.d" |  | ||||||
|     local var_name |  | ||||||
|     # Parse optional CLI flags |  | ||||||
|     shift 2 |  | ||||||
|     while [[ "$#" -gt 0 ]]; do |  | ||||||
|         case "$1" in |  | ||||||
|             --period|--rotations|--extra) |  | ||||||
|                 var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" |  | ||||||
|                 shift |  | ||||||
|                 declare "$var_name"="${1:?"$var_name" is missing}" |  | ||||||
|                 ;; |  | ||||||
|             *) |  | ||||||
|                 echo "Invalid command line flag ${1}" >&2 |  | ||||||
|                 return 1 |  | ||||||
|                 ;; |  | ||||||
|         esac |  | ||||||
|         shift |  | ||||||
|     done |  | ||||||
| 
 |  | ||||||
|     mkdir -p "$logrotate_conf_dir" |  | ||||||
|     cat <<EOF | sed '/^\s*$/d' > "${logrotate_conf_dir}/${service_name}" |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| ${log_path} { |  | ||||||
|   ${period} |  | ||||||
|   rotate ${rotations} |  | ||||||
|   dateext |  | ||||||
|   compress |  | ||||||
|   copytruncate |  | ||||||
|   missingok |  | ||||||
| $(indent "$extra" 2) |  | ||||||
| } |  | ||||||
| EOF |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Remove a logrotate configuration file |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Service name |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| remove_logrotate_conf() { |  | ||||||
|     local service_name="${1:?service name is missing}" |  | ||||||
|     local logrotate_conf_dir="/etc/logrotate.d" |  | ||||||
|     rm -f "${logrotate_conf_dir}/${service_name}" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Generate a Systemd configuration file |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Service name |  | ||||||
| # Flags: |  | ||||||
| #   --custom-service-content - Custom content to add to the [service] block |  | ||||||
| #   --environment - Environment variable to define (multiple --environment options may be passed) |  | ||||||
| #   --environment-file - Text file with environment variables (multiple --environment-file options may be passed) |  | ||||||
| #   --exec-start - Start command (required) |  | ||||||
| #   --exec-start-pre - Pre-start command (optional) |  | ||||||
| #   --exec-start-post - Post-start command (optional) |  | ||||||
| #   --exec-stop - Stop command (optional) |  | ||||||
| #   --exec-reload - Reload command (optional) |  | ||||||
| #   --group - System group to start the service with |  | ||||||
| #   --name - Service full name (e.g. Apache HTTP Server, defaults to $1) |  | ||||||
| #   --restart - When to restart the Systemd service after being stopped (defaults to always) |  | ||||||
| #   --pid-file - Service PID file |  | ||||||
| #   --standard-output - File where to print stdout output |  | ||||||
| #   --standard-error - File where to print stderr output |  | ||||||
| #   --success-exit-status - Exit code that indicates a successful shutdown |  | ||||||
| #   --type - Systemd unit type (defaults to forking) |  | ||||||
| #   --user - System user to start the service with |  | ||||||
| #   --working-directory - Working directory at which to start the service |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| generate_systemd_conf() { |  | ||||||
|     local -r service_name="${1:?service name is missing}" |  | ||||||
|     local -r systemd_units_dir="/etc/systemd/system" |  | ||||||
|     local -r service_file="${systemd_units_dir}/bitnami.${service_name}.service" |  | ||||||
|     # Default values |  | ||||||
|     local name="$service_name" |  | ||||||
|     local type="forking" |  | ||||||
|     local user="" |  | ||||||
|     local group="" |  | ||||||
|     local environment="" |  | ||||||
|     local environment_file="" |  | ||||||
|     local exec_start="" |  | ||||||
|     local exec_start_pre="" |  | ||||||
|     local exec_start_post="" |  | ||||||
|     local exec_stop="" |  | ||||||
|     local exec_reload="" |  | ||||||
|     local restart="always" |  | ||||||
|     local pid_file="" |  | ||||||
|     local standard_output="journal" |  | ||||||
|     local standard_error="" |  | ||||||
|     local limits_content="" |  | ||||||
|     local success_exit_status="" |  | ||||||
|     local custom_service_content="" |  | ||||||
|     local working_directory="" |  | ||||||
|     local timeout_start_sec="2min" |  | ||||||
|     local timeout_stop_sec="30s" |  | ||||||
|     # Parse CLI flags |  | ||||||
|     shift |  | ||||||
|     while [[ "$#" -gt 0 ]]; do |  | ||||||
|         case "$1" in |  | ||||||
|             --name \ |  | ||||||
|             | --type \ |  | ||||||
|             | --user \ |  | ||||||
|             | --group \ |  | ||||||
|             | --exec-start \ |  | ||||||
|             | --exec-stop \ |  | ||||||
|             | --exec-reload \ |  | ||||||
|             | --restart \ |  | ||||||
|             | --pid-file \ |  | ||||||
|             | --standard-output \ |  | ||||||
|             | --standard-error \ |  | ||||||
|             | --success-exit-status \ |  | ||||||
|             | --custom-service-content \ |  | ||||||
|             | --working-directory \ |  | ||||||
|             | --timeout-start-sec \ |  | ||||||
|             | --timeout-stop-sec \ |  | ||||||
|             ) |  | ||||||
|                 var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" |  | ||||||
|                 shift |  | ||||||
|                 declare "$var_name"="${1:?"${var_name} value is missing"}" |  | ||||||
|                 ;; |  | ||||||
|             --limit-*) |  | ||||||
|                 [[ -n "$limits_content" ]] && limits_content+=$'\n' |  | ||||||
|                 var_name="${1//--limit-}" |  | ||||||
|                 shift |  | ||||||
|                 limits_content+="Limit${var_name^^}=${1:?"--limit-${var_name} value is missing"}" |  | ||||||
|                 ;; |  | ||||||
|             --exec-start-pre) |  | ||||||
|                 shift |  | ||||||
|                 [[ -n "$exec_start_pre" ]] && exec_start_pre+=$'\n' |  | ||||||
|                 exec_start_pre+="ExecStartPre=${1:?"--exec-start-pre value is missing"}" |  | ||||||
|                 ;; |  | ||||||
|             --exec-start-post) |  | ||||||
|                 shift |  | ||||||
|                 [[ -n "$exec_start_post" ]] && exec_start_post+=$'\n' |  | ||||||
|                 exec_start_post+="ExecStartPost=${1:?"--exec-start-post value is missing"}" |  | ||||||
|                 ;; |  | ||||||
|             --environment) |  | ||||||
|                 shift |  | ||||||
|                 # It is possible to add multiple environment lines |  | ||||||
|                 [[ -n "$environment" ]] && environment+=$'\n' |  | ||||||
|                 environment+="Environment=${1:?"--environment value is missing"}" |  | ||||||
|                 ;; |  | ||||||
|             --environment-file) |  | ||||||
|                 shift |  | ||||||
|                 # It is possible to add multiple environment-file lines |  | ||||||
|                 [[ -n "$environment_file" ]] && environment_file+=$'\n' |  | ||||||
|                 environment_file+="EnvironmentFile=${1:?"--environment-file value is missing"}" |  | ||||||
|                 ;; |  | ||||||
|             *) |  | ||||||
|                 echo "Invalid command line flag ${1}" >&2 |  | ||||||
|                 return 1 |  | ||||||
|                 ;; |  | ||||||
|         esac |  | ||||||
|         shift |  | ||||||
|     done |  | ||||||
|     # Validate inputs |  | ||||||
|     local error="no" |  | ||||||
|     if [[ -z "$exec_start" ]]; then |  | ||||||
|         error "The --exec-start option is required" |  | ||||||
|         error="yes" |  | ||||||
|     fi |  | ||||||
|     if [[ "$error" != "no" ]]; then |  | ||||||
|         return 1 |  | ||||||
|     fi |  | ||||||
|     # Generate the Systemd unit |  | ||||||
|     cat > "$service_file" <<EOF |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # 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=${timeout_start_sec} |  | ||||||
| TimeoutStopSec=${timeout_stop_sec} |  | ||||||
| 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,294 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Validation functions library |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091,SC2086 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if the provided argument is an integer |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Value to check |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| is_int() { |  | ||||||
|     local -r int="${1:?missing value}" |  | ||||||
|     if [[ "$int" =~ ^-?[0-9]+ ]]; then |  | ||||||
|         true |  | ||||||
|     else |  | ||||||
|         false |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if the provided argument is a positive integer |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Value to check |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| is_positive_int() { |  | ||||||
|     local -r int="${1:?missing value}" |  | ||||||
|     if is_int "$int" && (( "${int}" >= 0 )); then |  | ||||||
|         true |  | ||||||
|     else |  | ||||||
|         false |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if the provided argument is a boolean or is the string 'yes/true' |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - Value to check |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| is_boolean_yes() { |  | ||||||
|     local -r bool="${1:-}" |  | ||||||
|     # 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 |  | ||||||
|                 ;; |  | ||||||
|             *) |  | ||||||
|                 string="$1" |  | ||||||
|                 ;; |  | ||||||
|         esac |  | ||||||
|         shift |  | ||||||
|     done |  | ||||||
| 
 |  | ||||||
|     if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then |  | ||||||
|         echo "string length is less than $min_length" |  | ||||||
|         return 1 |  | ||||||
|     fi |  | ||||||
|     if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then |  | ||||||
|         echo "string length is great than $max_length" |  | ||||||
|         return 1 |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
|  | @ -1,51 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Library for managing versions strings |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load Generic Libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| 
 |  | ||||||
| # Functions |  | ||||||
| ######################## |  | ||||||
| # Gets semantic version |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - version: string to extract major.minor.patch |  | ||||||
| #   $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch |  | ||||||
| # Returns: |  | ||||||
| #   array with the major, minor and release |  | ||||||
| ######################### |  | ||||||
| get_sematic_version () { |  | ||||||
|     local version="${1:?version is required}" |  | ||||||
|     local section="${2:?section is required}" |  | ||||||
|     local -a version_sections |  | ||||||
| 
 |  | ||||||
|     #Regex to parse versions: x.y.z |  | ||||||
|     local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?' |  | ||||||
| 
 |  | ||||||
|     if [[ "$version" =~ $regex ]]; then |  | ||||||
|         local i=1 |  | ||||||
|         local j=1 |  | ||||||
|         local n=${#BASH_REMATCH[*]} |  | ||||||
| 
 |  | ||||||
|         while [[ $i -lt $n ]]; do |  | ||||||
|             if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]];  then |  | ||||||
|                 version_sections[j]="${BASH_REMATCH[$i]}" |  | ||||||
|                 ((j++)) |  | ||||||
|             fi |  | ||||||
|             ((i++)) |  | ||||||
|         done |  | ||||||
| 
 |  | ||||||
|         local number_regex='^[0-9]+$' |  | ||||||
|         if [[ "$section" =~ $number_regex ]] && (( section > 0 )) && (( section <= 3 )); then |  | ||||||
|              echo "${version_sections[$section]}" |  | ||||||
|              return |  | ||||||
|         else |  | ||||||
|             stderr_print "Section allowed values are: 1, 2, and 3" |  | ||||||
|             return 1 |  | ||||||
|         fi |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
|  | @ -1,396 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Bitnami web server handler library |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1090,SC1091 |  | ||||||
| 
 |  | ||||||
| # Load generic libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Execute a command (or list of commands) with the web server environment and library loaded |  | ||||||
| # Globals: |  | ||||||
| #   * |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| web_server_execute() { |  | ||||||
|     local -r web_server="${1:?missing web server}" |  | ||||||
|     shift |  | ||||||
|     # Run program in sub-shell to avoid web server environment getting loaded when not necessary |  | ||||||
|     ( |  | ||||||
|         . "/opt/bitnami/scripts/lib${web_server}.sh" |  | ||||||
|         . "/opt/bitnami/scripts/${web_server}-env.sh" |  | ||||||
|         "$@" |  | ||||||
|     ) |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Prints the list of enabled web servers |  | ||||||
| # Globals: |  | ||||||
| #   None |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| web_server_list() { |  | ||||||
|     local -r -a supported_web_servers=(apache nginx) |  | ||||||
|     local -a existing_web_servers=() |  | ||||||
|     for web_server in "${supported_web_servers[@]}"; do |  | ||||||
|         [[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server") |  | ||||||
|     done |  | ||||||
|     echo "${existing_web_servers[@]:-}" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Prints the currently-enabled web server type (only one, in order of preference) |  | ||||||
| # Globals: |  | ||||||
| #   None |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| web_server_type() { |  | ||||||
|     local -a web_servers |  | ||||||
|     read -r -a web_servers <<< "$(web_server_list)" |  | ||||||
|     echo "${web_servers[0]:-}" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Validate that a supported web server is configured |  | ||||||
| # Globals: |  | ||||||
| #   None |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| web_server_validate() { |  | ||||||
|     local error_code=0 |  | ||||||
|     local supported_web_servers=("apache" "nginx") |  | ||||||
| 
 |  | ||||||
|     # Auxiliary functions |  | ||||||
|     print_validation_error() { |  | ||||||
|         error "$1" |  | ||||||
|         error_code=1 |  | ||||||
|     } |  | ||||||
| 
 |  | ||||||
|     if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then |  | ||||||
|         print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}" |  | ||||||
|     elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then |  | ||||||
|         print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable." |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     return "$error_code" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check whether the web server is running |  | ||||||
| # Globals: |  | ||||||
| #   * |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   true if the web server is running, false otherwise |  | ||||||
| ######################### |  | ||||||
| is_web_server_running() { |  | ||||||
|     "is_$(web_server_type)_running" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Start web server |  | ||||||
| # Globals: |  | ||||||
| #   * |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| web_server_start() { |  | ||||||
|     info "Starting $(web_server_type) in background" |  | ||||||
|     if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then |  | ||||||
|         systemctl start "bitnami.$(web_server_type).service" |  | ||||||
|     else |  | ||||||
|         "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Stop web server |  | ||||||
| # Globals: |  | ||||||
| #   * |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| web_server_stop() { |  | ||||||
|     info "Stopping $(web_server_type)" |  | ||||||
|     if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then |  | ||||||
|         systemctl stop "bitnami.$(web_server_type).service" |  | ||||||
|     else |  | ||||||
|         "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) |  | ||||||
| # It serves as a wrapper for the specific web server function |  | ||||||
| # Globals: |  | ||||||
| #   * |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - App name |  | ||||||
| # Flags: |  | ||||||
| #   --type - Application type, which has an effect on which configuration template to use |  | ||||||
| #   --hosts - Host listen addresses |  | ||||||
| #   --server-name - Server name |  | ||||||
| #   --server-aliases - Server aliases |  | ||||||
| #   --allow-remote-connections - Whether to allow remote connections or to require local connections |  | ||||||
| #   --disable - Whether to render server configurations with a .disabled prefix |  | ||||||
| #   --disable-http - Whether to render the app's HTTP server configuration with a .disabled prefix |  | ||||||
| #   --disable-https - Whether to render the app's HTTPS server configuration with a .disabled prefix |  | ||||||
| #   --http-port - HTTP port number |  | ||||||
| #   --https-port - HTTPS port number |  | ||||||
| #   --document-root - Path to document root directory |  | ||||||
| # Apache-specific flags: |  | ||||||
| #   --apache-additional-configuration - Additional vhost configuration (no default) |  | ||||||
| #   --apache-additional-http-configuration - Additional HTTP vhost configuration (no default) |  | ||||||
| #   --apache-additional-https-configuration - Additional HTTPS vhost configuration (no default) |  | ||||||
| #   --apache-before-vhost-configuration - Configuration to add before the <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 |  | ||||||
| } |  | ||||||
|  | @ -1,27 +0,0 @@ | ||||||
| #!/bin/sh |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| set -eu |  | ||||||
| 
 |  | ||||||
| n=0 |  | ||||||
| max=2 |  | ||||||
| export DEBIAN_FRONTEND=noninteractive |  | ||||||
| 
 |  | ||||||
| until [ $n -gt $max ]; do |  | ||||||
|     set +e |  | ||||||
|     ( |  | ||||||
|       apt-get update -qq && |  | ||||||
|       apt-get install -y --no-install-recommends "$@" |  | ||||||
|     ) |  | ||||||
|     CODE=$? |  | ||||||
|     set -e |  | ||||||
|     if [ $CODE -eq 0 ]; then |  | ||||||
|         break |  | ||||||
|     fi |  | ||||||
|     if [ $n -eq $max ]; then |  | ||||||
|         exit $CODE |  | ||||||
|     fi |  | ||||||
|     echo "apt failed, retrying" |  | ||||||
|     n=$(($n + 1)) |  | ||||||
| done |  | ||||||
| apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives |  | ||||||
|  | @ -1,24 +0,0 @@ | ||||||
| #!/bin/sh |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| set -u |  | ||||||
| 
 |  | ||||||
| if [ $# -eq 0 ]; then |  | ||||||
|     >&2 echo "No arguments provided" |  | ||||||
|     exit 1 |  | ||||||
| fi |  | ||||||
| 
 |  | ||||||
| script=$1 |  | ||||||
| exit_code="${2:-96}" |  | ||||||
| fail_if_not_present="${3:-n}" |  | ||||||
| 
 |  | ||||||
| if test -f "$script"; then |  | ||||||
|   sh $script |  | ||||||
| 
 |  | ||||||
|   if [ $? -ne 0 ]; then |  | ||||||
|     exit $((exit_code)) |  | ||||||
|   fi |  | ||||||
| elif [ "$fail_if_not_present" = "y" ]; then |  | ||||||
|   >&2 echo "script not found: $script" |  | ||||||
|   exit 127 |  | ||||||
| fi |  | ||||||
|  | @ -1,26 +0,0 @@ | ||||||
| #!/bin/sh |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| set -eu |  | ||||||
| 
 |  | ||||||
| n=0 |  | ||||||
| max=2 |  | ||||||
| export DEBIAN_FRONTEND=noninteractive |  | ||||||
| 
 |  | ||||||
| until [ $n -gt $max ]; do |  | ||||||
|     set +e |  | ||||||
|     ( |  | ||||||
|         apt-get autoremove --purge -y "$@" |  | ||||||
|     ) |  | ||||||
|     CODE=$? |  | ||||||
|     set -e |  | ||||||
|     if [ $CODE -eq 0 ]; then |  | ||||||
|         break |  | ||||||
|     fi |  | ||||||
|     if [ $n -eq $max ]; then |  | ||||||
|         exit $CODE |  | ||||||
|     fi |  | ||||||
|     echo "apt failed, retrying" |  | ||||||
|     n=$(($n + 1)) |  | ||||||
| done |  | ||||||
| apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives |  | ||||||
|  | @ -1,97 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Environment configuration for grafana |  | ||||||
| 
 |  | ||||||
| # 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:-grafana}" |  | ||||||
| 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 |  | ||||||
| grafana_env_vars=( |  | ||||||
|     GRAFANA_TMP_DIR |  | ||||||
|     GRAFANA_PID_FILE |  | ||||||
|     GRAFANA_DEFAULT_CONF_DIR |  | ||||||
|     GRAFANA_DEFAULT_PLUGINS_DIR |  | ||||||
|     GF_PATHS_HOME |  | ||||||
|     GF_PATHS_CONFIG |  | ||||||
|     GF_PATHS_DATA |  | ||||||
|     GF_PATHS_LOGS |  | ||||||
|     GF_PATHS_PLUGINS |  | ||||||
|     GF_PATHS_PROVISIONING |  | ||||||
|     GF_INSTALL_PLUGINS |  | ||||||
|     GF_INSTALL_PLUGINS_SKIP_TLS |  | ||||||
|     GF_FEATURE_TOGGLES |  | ||||||
|     GF_SECURITY_ADMIN_PASSWORD |  | ||||||
|     GRAFANA_MIGRATION_LOCK |  | ||||||
|     GRAFANA_SLEEP_TIME |  | ||||||
|     GRAFANA_RETRY_ATTEMPTS |  | ||||||
|     GRAFANA_PLUGINS |  | ||||||
| ) |  | ||||||
| for env_var in "${grafana_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 grafana_env_vars |  | ||||||
| 
 |  | ||||||
| # Grafana paths |  | ||||||
| export GRAFANA_BASE_DIR="${BITNAMI_ROOT_DIR}/grafana" |  | ||||||
| export GRAFANA_BIN_DIR="${GRAFANA_BASE_DIR}/bin" |  | ||||||
| export GRAFANA_TMP_DIR="${GRAFANA_TMP_DIR:-${GRAFANA_BASE_DIR}/tmp}" |  | ||||||
| export GRAFANA_CONF_DIR="${GRAFANA_BASE_DIR}/conf" |  | ||||||
| export GRAFANA_PID_FILE="${GRAFANA_PID_FILE:-${GRAFANA_TMP_DIR}/grafana.pid}" |  | ||||||
| export PATH="${GRAFANA_BIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" |  | ||||||
| export GRAFANA_DEFAULT_CONF_DIR="${GRAFANA_DEFAULT_CONF_DIR:-${GRAFANA_BASE_DIR}/conf.default}" |  | ||||||
| export GRAFANA_DEFAULT_PLUGINS_DIR="${GRAFANA_DEFAULT_PLUGINS_DIR:-${GRAFANA_BASE_DIR}/default-plugins}" |  | ||||||
| 
 |  | ||||||
| # System users (when running with a privileged user) |  | ||||||
| export GRAFANA_DAEMON_USER="grafana" |  | ||||||
| export GRAFANA_DAEMON_GROUP="grafana" |  | ||||||
| 
 |  | ||||||
| # Grafana configuration |  | ||||||
| export GF_PATHS_HOME="${GF_PATHS_HOME:-$GRAFANA_BASE_DIR}" |  | ||||||
| export GF_PATHS_CONFIG="${GF_PATHS_CONFIG:-${GRAFANA_BASE_DIR}/conf/grafana.ini}" |  | ||||||
| export GF_PATHS_DATA="${GF_PATHS_DATA:-${GRAFANA_BASE_DIR}/data}" |  | ||||||
| export GF_PATHS_LOGS="${GF_PATHS_LOGS:-${GRAFANA_BASE_DIR}/logs}" |  | ||||||
| export GF_PATHS_PLUGINS="${GF_PATHS_PLUGINS:-${GF_PATHS_DATA}/plugins}" |  | ||||||
| export GF_PATHS_PROVISIONING="${GF_PATHS_PROVISIONING:-${GRAFANA_BASE_DIR}/conf/provisioning}" |  | ||||||
| GF_INSTALL_PLUGINS="${GF_INSTALL_PLUGINS:-"${GRAFANA_PLUGINS:-}"}" |  | ||||||
| export GF_INSTALL_PLUGINS="${GF_INSTALL_PLUGINS:-}" |  | ||||||
| export GF_INSTALL_PLUGINS_SKIP_TLS="${GF_INSTALL_PLUGINS_SKIP_TLS:-yes}" |  | ||||||
| export GF_FEATURE_TOGGLES="${GF_FEATURE_TOGGLES:-}" |  | ||||||
| export GF_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/grafana" |  | ||||||
| export GF_SECURITY_ADMIN_PASSWORD="${GF_SECURITY_ADMIN_PASSWORD:-}" |  | ||||||
| export GRAFANA_MIGRATION_LOCK="${GRAFANA_MIGRATION_LOCK:-false}" |  | ||||||
| export GRAFANA_SLEEP_TIME="${GRAFANA_SLEEP_TIME:-10}" |  | ||||||
| export GRAFANA_RETRY_ATTEMPTS="${GRAFANA_RETRY_ATTEMPTS:-12}" |  | ||||||
| 
 |  | ||||||
| # Grafana Operator configuration |  | ||||||
| export GF_OP_PATHS_CONFIG="/etc/grafana/grafana.ini" |  | ||||||
| export GF_OP_PATHS_DATA="/var/lib/grafana" |  | ||||||
| export GF_OP_PATHS_LOGS="/var/log/grafana" |  | ||||||
| export GF_OP_PATHS_PROVISIONING="/etc/grafana/provisioning" |  | ||||||
| export GF_OP_PLUGINS_INIT_DIR="/opt/plugins" |  | ||||||
| 
 |  | ||||||
| # Custom environment variables may be defined below |  | ||||||
|  | @ -1,55 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| set -o errexit |  | ||||||
| set -o nounset |  | ||||||
| set -o pipefail |  | ||||||
| # set -o xtrace # Uncomment this line for debugging purposes |  | ||||||
| 
 |  | ||||||
| # Load Grafana environment |  | ||||||
| . /opt/bitnami/scripts/grafana-env.sh |  | ||||||
| 
 |  | ||||||
| # Load libraries |  | ||||||
| . /opt/bitnami/scripts/libbitnami.sh |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| 
 |  | ||||||
| function is_exec() { |  | ||||||
|     # This checks if the first provided argument is executable or if only args was used |  | ||||||
|     exec_in_path=$(builtin type -P "$1" 2> /dev/null) |  | ||||||
|     if [[ -f "$1" && -x $(realpath "$1" 2> /dev/null) || -x $(realpath "$exec_in_path" 2> /dev/null) ]]; then |  | ||||||
|         true; |  | ||||||
|     else |  | ||||||
|         false; |  | ||||||
|     fi; |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| print_welcome_page |  | ||||||
| 
 |  | ||||||
| # We add the copy from default config in the entrypoint to not break users |  | ||||||
| # bypassing the setup.sh logic. If the file already exists do not overwrite (in |  | ||||||
| # case someone mounts a configuration file in /opt/bitnami/postgresql/conf) |  | ||||||
| debug "Copying files from $GRAFANA_DEFAULT_CONF_DIR to $GRAFANA_CONF_DIR" |  | ||||||
| cp -nr "$GRAFANA_DEFAULT_CONF_DIR"/. "$GRAFANA_CONF_DIR" |  | ||||||
| 
 |  | ||||||
| if [[ "$1" = "/opt/bitnami/scripts/grafana/run.sh" ]] || ! is_exec "$1"; then |  | ||||||
|     # This catches the error-code from libgrafana.sh for the immediate exit when the grafana-operator is used. And ensure that the exit code is kept silently. |  | ||||||
|     /opt/bitnami/scripts/grafana/setup.sh || GRAFANA_OPERATOR_IMMEDIATE_EXIT=$? |  | ||||||
|     if [[ "${GRAFANA_OPERATOR_IMMEDIATE_EXIT:-0}" -eq 255 ]]; then |  | ||||||
|         exit 0 |  | ||||||
|     elif [[ "${GRAFANA_OPERATOR_IMMEDIATE_EXIT:-0}" -ne 0 ]]; then |  | ||||||
|         exit "$GRAFANA_OPERATOR_IMMEDIATE_EXIT" |  | ||||||
|     fi |  | ||||||
|     /post-init.sh |  | ||||||
|     info "** Grafana setup finished! **" |  | ||||||
| fi |  | ||||||
| 
 |  | ||||||
| echo "" |  | ||||||
| 
 |  | ||||||
| if is_exec "$1"; then |  | ||||||
|     exec "$@" |  | ||||||
| else |  | ||||||
|     exec "/opt/bitnami/scripts/grafana/run.sh" "$@" |  | ||||||
| fi |  | ||||||
|  | @ -1,70 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| set -o errexit |  | ||||||
| set -o nounset |  | ||||||
| set -o pipefail |  | ||||||
| # set -o xtrace # Uncomment this line for debugging purposes |  | ||||||
| 
 |  | ||||||
| # Load Grafana environment |  | ||||||
| . /opt/bitnami/scripts/grafana-env.sh |  | ||||||
| 
 |  | ||||||
| # Load libraries |  | ||||||
| . /opt/bitnami/scripts/libfs.sh |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| . /opt/bitnami/scripts/libos.sh |  | ||||||
| . /opt/bitnami/scripts/libgrafana.sh |  | ||||||
| 
 |  | ||||||
| info "Creating configuration file" |  | ||||||
| cp "${GRAFANA_BASE_DIR}/conf/sample.ini" "$(grafana_env_var_value PATHS_CONFIG)" |  | ||||||
| 
 |  | ||||||
| info "Creating system user" |  | ||||||
| ensure_user_exists "$GRAFANA_DAEMON_USER" --group "$GRAFANA_DAEMON_GROUP" --system |  | ||||||
| 
 |  | ||||||
| info "Configuring file permissions" |  | ||||||
| for dir in "$(grafana_env_var_value PATHS_DATA)" "$(grafana_env_var_value PATHS_LOGS)" "$(grafana_env_var_value PATHS_PLUGINS)" "$(grafana_env_var_value PATHS_PROVISIONING)" "$(grafana_env_var_value VOLUME_DIR)" "${GRAFANA_DEFAULT_CONF_DIR}"; do |  | ||||||
|     ensure_dir_exists "$dir" |  | ||||||
|     # Use grafana:root ownership for compatibility when running as a non-root user |  | ||||||
|     configure_permissions_ownership "$dir" -d "775" -f "664" -u "$GRAFANA_DAEMON_USER" -g "root" |  | ||||||
| done |  | ||||||
| 
 |  | ||||||
| # Use grafana:root ownership for compatibility when running as a non-root user |  | ||||||
| configure_permissions_ownership "$(grafana_env_var_value PATHS_CONFIG)" -f "664" -u "$GRAFANA_DAEMON_USER" -g "root" |  | ||||||
| 
 |  | ||||||
| # Ensure permissions to parent directories of configs |  | ||||||
| # Used when replacing configs with symlinks for grafana-operator compatibility |  | ||||||
| for dir in "$(grafana_env_var_value PATHS_CONFIG)" "$(grafana_env_var_value PATHS_DATA)" "$(grafana_env_var_value PATHS_LOGS)" "$(grafana_env_var_value PATHS_PROVISIONING)"; do |  | ||||||
|     chmod 775 "$(dirname "$dir")" |  | ||||||
| done |  | ||||||
| 
 |  | ||||||
| # Install well-known plugins |  | ||||||
| grafana_plugin_list=( |  | ||||||
|     "grafana-clock-panel" |  | ||||||
|     "briangann-gauge-panel" |  | ||||||
|     "jdbranham-diagram-panel" |  | ||||||
|     "vonage-status-panel" |  | ||||||
|     "larona-epict-panel" |  | ||||||
|     "pierosavi-imageit-panel" |  | ||||||
|     "grafana-polystat-panel" |  | ||||||
|     "scadavis-synoptic-panel" |  | ||||||
| ) |  | ||||||
| 
 |  | ||||||
| cd ${GRAFANA_BASE_DIR} || exit 1 |  | ||||||
| for plugin in "${grafana_plugin_list[@]}"; do |  | ||||||
|     info "Installing ${plugin} plugin" |  | ||||||
|     grafana cli --pluginsDir "$(grafana_env_var_value PATHS_PLUGINS)" plugins install "$plugin" |  | ||||||
| done |  | ||||||
| 
 |  | ||||||
| # The Grafana Helm chart mounts the data directory at "/opt/bitnami/grafana/data" |  | ||||||
| # Therefore, all the plugins installed when building the image will be lost |  | ||||||
| # As a workaround, we can move them to a "default-plugins" directory and recover them |  | ||||||
| # during the 1st boot of the container |  | ||||||
| ensure_dir_exists "$GRAFANA_DEFAULT_PLUGINS_DIR" |  | ||||||
| mv "$(grafana_env_var_value PATHS_PLUGINS)"/* "$GRAFANA_DEFAULT_PLUGINS_DIR" |  | ||||||
| 
 |  | ||||||
| # Copy all initially generated configuration files to the default directory |  | ||||||
| # (this is to avoid breaking when entrypoint is being overridden) |  | ||||||
| cp -r "$GRAFANA_CONF_DIR"/* "$GRAFANA_DEFAULT_CONF_DIR" |  | ||||||
|  | @ -1,42 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| set -o errexit |  | ||||||
| set -o nounset |  | ||||||
| set -o pipefail |  | ||||||
| # set -o xtrace # Uncomment this line for debugging purposes |  | ||||||
| 
 |  | ||||||
| # Load Grafana environment |  | ||||||
| . /opt/bitnami/scripts/grafana-env.sh |  | ||||||
| 
 |  | ||||||
| # Load libraries |  | ||||||
| . /opt/bitnami/scripts/libos.sh |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| 
 |  | ||||||
| declare cmd="grafana" |  | ||||||
| declare -a args=( |  | ||||||
|     # Based on https://github.com/grafana/grafana/blob/v8.2.5/packaging/docker/run.sh |  | ||||||
|     "server" |  | ||||||
|     "--homepath=${GF_PATHS_HOME}" |  | ||||||
|     "--config=${GF_PATHS_CONFIG}" |  | ||||||
|     "--pidfile=${GRAFANA_PID_FILE}" |  | ||||||
|     "--packaging=docker" |  | ||||||
|     "$@" |  | ||||||
|     "cfg:default.log.mode=console" |  | ||||||
|     "cfg:default.paths.data=${GF_PATHS_DATA}" |  | ||||||
|     "cfg:default.paths.logs=${GF_PATHS_LOGS}" |  | ||||||
|     "cfg:default.paths.plugins=${GF_PATHS_PLUGINS}" |  | ||||||
|     "cfg:default.paths.provisioning=${GF_PATHS_PROVISIONING}" |  | ||||||
| ) |  | ||||||
| 
 |  | ||||||
| cd "$GRAFANA_BASE_DIR" |  | ||||||
| 
 |  | ||||||
| info "** Starting Grafana **" |  | ||||||
| if am_i_root; then |  | ||||||
|     exec_as_user "$GRAFANA_DAEMON_USER" "$cmd" "${args[@]}" |  | ||||||
| else |  | ||||||
|     exec "$cmd" "${args[@]}" |  | ||||||
| fi |  | ||||||
|  | @ -1,32 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| set -o errexit |  | ||||||
| set -o nounset |  | ||||||
| set -o pipefail |  | ||||||
| # set -o xtrace # Uncomment this line for debugging purposes |  | ||||||
| 
 |  | ||||||
| # Load Grafana environment |  | ||||||
| . /opt/bitnami/scripts/grafana-env.sh |  | ||||||
| 
 |  | ||||||
| # Load MySQL Client environment for 'mysql_remote_execute' (after 'grafana-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 libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| . /opt/bitnami/scripts/libgrafana.sh |  | ||||||
| 
 |  | ||||||
| # Ensure Grafana environment variables are valid |  | ||||||
| grafana_validate |  | ||||||
| 
 |  | ||||||
| # Ensure Grafana is initialized |  | ||||||
| grafana_initialize |  | ||||||
|  | @ -1,404 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| # |  | ||||||
| # Bitnami Grafana library |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| # Load generic libraries |  | ||||||
| . /opt/bitnami/scripts/liblog.sh |  | ||||||
| . /opt/bitnami/scripts/libos.sh |  | ||||||
| . /opt/bitnami/scripts/libvalidations.sh |  | ||||||
| . /opt/bitnami/scripts/libversion.sh |  | ||||||
| 
 |  | ||||||
| # Load 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 |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Print the value of a Grafana environment variable |  | ||||||
| # Globals: |  | ||||||
| #   GF_* |  | ||||||
| #   GRAFANA_CFG_* |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   The value in the environment variable |  | ||||||
| ######################### |  | ||||||
| grafana_env_var_value() { |  | ||||||
|     local -r name="${1:?missing name}" |  | ||||||
|     local gf_env_var="GF_${name}" |  | ||||||
|     local grafana_cfg_env_var="GRAFANA_CFG_${name}" |  | ||||||
|     if [[ -n "${!gf_env_var:-}" ]]; then |  | ||||||
|         echo "${!gf_env_var:-}" |  | ||||||
|     elif [[ -n "${!grafana_cfg_env_var}" ]]; then |  | ||||||
|         echo "${!grafana_cfg_env_var:-}" |  | ||||||
|     else |  | ||||||
|         error "${gf_env_var} or ${grafana_cfg_env_var} must be set" |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Validate settings in GRAFANA_* env vars |  | ||||||
| # Globals: |  | ||||||
| #   GRAFANA_* |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   0 if the validation succeeded, 1 otherwise |  | ||||||
| ######################### |  | ||||||
| grafana_validate() { |  | ||||||
|     debug "Validating settings in GRAFANA_* environment variables..." |  | ||||||
|     local error_code=0 |  | ||||||
| 
 |  | ||||||
|     # Auxiliary functions |  | ||||||
|     print_validation_error() { |  | ||||||
|         error "$1" |  | ||||||
|         error_code=1 |  | ||||||
|     } |  | ||||||
|     check_path_exists() { |  | ||||||
|         if [[ ! -e "$1" ]]; then |  | ||||||
|             print_validation_error "The directory ${1} does not exist" |  | ||||||
|         fi |  | ||||||
|     } |  | ||||||
| 
 |  | ||||||
|     # Validate user inputs |  | ||||||
|     [[ -e "$GF_OP_PATHS_CONFIG" ]] || check_path_exists "$(grafana_env_var_value PATHS_CONFIG)" |  | ||||||
|     [[ -e "$GF_OP_PATHS_DATA" ]] || check_path_exists "$(grafana_env_var_value PATHS_DATA)" |  | ||||||
|     [[ -e "$GF_OP_PATHS_LOGS" ]] || check_path_exists "$(grafana_env_var_value PATHS_LOGS)" |  | ||||||
|     [[ -e "$GF_OP_PATHS_PROVISIONING" ]] || check_path_exists "$(grafana_env_var_value PATHS_PROVISIONING)" |  | ||||||
| 
 |  | ||||||
|     return "$error_code" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Ensure Grafana is initialized |  | ||||||
| # Globals: |  | ||||||
| #   GRAFANA_* |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| grafana_initialize() { |  | ||||||
|     # Ensure compatibility with Grafana Operator |  | ||||||
|     local grafana_var grafana_operator_var |  | ||||||
|     for path_suffix in "config" "data" "logs" "provisioning"; do |  | ||||||
|         grafana_var="GF_PATHS_${path_suffix^^}" |  | ||||||
|         grafana_operator_var="GF_OP_PATHS_${path_suffix^^}" |  | ||||||
|         if [[ -e "${!grafana_operator_var}" && "${!grafana_operator_var}" != "${!grafana_var}" ]]; then |  | ||||||
|             info "Ensuring ${!grafana_operator_var} points to ${!grafana_var}" |  | ||||||
|             rm -rf "${!grafana_var}" |  | ||||||
|             ln -sfn "${!grafana_operator_var}" "${!grafana_var}" |  | ||||||
|         fi |  | ||||||
|     done |  | ||||||
| 
 |  | ||||||
|     if am_i_root; then |  | ||||||
|         for dir in "$GF_PATHS_DATA" "$GF_PATHS_LOGS" "$GF_PATHS_PLUGINS"; do |  | ||||||
|             is_mounted_dir_empty "$dir" && configure_permissions_ownership "$dir" -d "775" -f "664" -u "$GRAFANA_DAEMON_USER" |  | ||||||
|         done |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     # Install plugins in a Grafana operator-compatible environment, useful to for starting the image as an init container |  | ||||||
|     # Based on https://github.com/grafana-operator/grafana-operator/blob/master/controllers/grafana/pluginsHelper.go |  | ||||||
|     if [[ -d "$GF_OP_PLUGINS_INIT_DIR" ]]; then |  | ||||||
|         info "Detected mounted plugins directory at '${GF_OP_PLUGINS_INIT_DIR}'. The container will exit after installing plugins as grafana-operator." |  | ||||||
|         if [[ -n "$GF_INSTALL_PLUGINS" ]]; then |  | ||||||
|             GF_PATHS_PLUGINS="$GF_OP_PLUGINS_INIT_DIR" grafana_install_plugins |  | ||||||
|         else |  | ||||||
|             warn "There are no plugins to install" |  | ||||||
|         fi |  | ||||||
|         return 255 |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     # Recover plugins installed when building the image |  | ||||||
|     if [[ ! -e "$(grafana_env_var_value PATHS_PLUGINS)" ]] || [[ -z "$(ls -A "$(grafana_env_var_value PATHS_PLUGINS)")" ]]; then |  | ||||||
|         mkdir -p "$(grafana_env_var_value PATHS_PLUGINS)" |  | ||||||
|         if [[ -e "$GRAFANA_DEFAULT_PLUGINS_DIR" ]] && [[ -n "$(ls -A "$GRAFANA_DEFAULT_PLUGINS_DIR")" ]]; then |  | ||||||
|             cp -r "$GRAFANA_DEFAULT_PLUGINS_DIR"/* "$(grafana_env_var_value PATHS_PLUGINS)" |  | ||||||
|         fi |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     # Configure configuration file based on environment variables |  | ||||||
|     grafana_configure_from_environment_variables |  | ||||||
| 
 |  | ||||||
|     # Install plugins |  | ||||||
|     grafana_install_plugins |  | ||||||
| 
 |  | ||||||
|     # Configure Grafana feature toggles |  | ||||||
|     ! is_empty_value "$GF_FEATURE_TOGGLES" && grafana_conf_set "feature_toggles" "enable" "$GF_FEATURE_TOGGLES" |  | ||||||
| 
 |  | ||||||
|     # If using an external database, avoid nodes collition during migration |  | ||||||
|     if is_boolean_yes "$GRAFANA_MIGRATION_LOCK"; then |  | ||||||
|         grafana_migrate_db |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     # Avoid exit code of previous commands to affect the result of this function |  | ||||||
|     true |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Runs Grafana migration using a database lock to avoid collision with other Grafana nodes |  | ||||||
| # If database is locked, wait until unlocked and continue. Otherwise, run Grafana to perform migration. |  | ||||||
| # Globals: |  | ||||||
| #   GRAFANA_CFG_* |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| grafana_migrate_db() { |  | ||||||
|     local -r db_host="${GRAFANA_CFG_DATABASE_HOST:-mysql}" |  | ||||||
|     local -r db_port="${GRAFANA_CFG_DATABASE_PORT:-3306}" |  | ||||||
|     local -r db_name="${GRAFANA_CFG_DATABASE_NAME:-}" |  | ||||||
|     local -r db_user="${GRAFANA_CFG_DATABASE_USER:-}" |  | ||||||
|     local -r db_pass="${GRAFANA_CFG_DATABASE_PASSWORD:-}" |  | ||||||
| 
 |  | ||||||
|     local -r grafana_host="${GRAFANA_CFG_SERVER_HTTP_ADDR:-localhost}" |  | ||||||
|     local -r grafana_port="${GRAFANA_CFG_SERVER_HTTP_PORT:-3000}" |  | ||||||
|     local -r grafana_protocol="${GRAFANA_CFG_SERVER_PROTOCOL:-http}" |  | ||||||
| 
 |  | ||||||
|     local -r sleep_time="${GRAFANA_SLEEP_TIME:-5}" |  | ||||||
|     local -r retries="${GRAFANA_RETRY_ATTEMPTS:-12}" |  | ||||||
| 
 |  | ||||||
|     lock_db() { |  | ||||||
|         debug_execute mysql_remote_execute_print_output "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass" <<EOF |  | ||||||
| create table db_lock( |  | ||||||
| id INT PRIMARY KEY |  | ||||||
| ); |  | ||||||
| EOF |  | ||||||
|     } |  | ||||||
|     release_db() { |  | ||||||
|         debug_execute mysql_remote_execute_print_output "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass" <<EOF |  | ||||||
| drop table if exists db_lock; |  | ||||||
| EOF |  | ||||||
|     } |  | ||||||
|     is_db_unlocked() { |  | ||||||
|         local result |  | ||||||
| 
 |  | ||||||
|         result=$(mysql_remote_execute_print_output "$db_host" "$db_port" "$db_name" "$db_user" "$db_pass" <<EOF |  | ||||||
| show tables like 'db_lock'; |  | ||||||
| EOF |  | ||||||
| ) |  | ||||||
|         if grep -q "db_lock" <<<"$result"; then |  | ||||||
|             return 1 |  | ||||||
|         else |  | ||||||
|             return 0 |  | ||||||
|         fi |  | ||||||
|     } |  | ||||||
| 
 |  | ||||||
|     if lock_db; then |  | ||||||
|         info "Starting Grafana database migration" |  | ||||||
|         grafana_start_bg |  | ||||||
|         # Grafana will start listening HTTP connections once the database initialization has succeeded |  | ||||||
|         if ! retry_while "debug_execute curl --silent ${grafana_protocol}://${grafana_host}:${grafana_port}" "$retries" "$sleep_time"; then |  | ||||||
|             error "Grafana failed to start in the background. Releasing database lock before exit." |  | ||||||
|             # Release the lock |  | ||||||
|             release_db |  | ||||||
|             return 1 |  | ||||||
|         fi |  | ||||||
|         grafana_stop |  | ||||||
|         # Release the lock |  | ||||||
|         release_db |  | ||||||
|         info "Grafana database migration completed. Lock released." |  | ||||||
|     else |  | ||||||
|         info "Grafana database migration in progress detected. Waiting for lock to be released before initializing Grafana" |  | ||||||
|         if ! retry_while "is_db_unlocked" "$retries" "$sleep_time"; then |  | ||||||
|             error "Failed waiting for database lock to be released. If there is no migration in progress, manually drop table 'db_lock' from the grafana database" |  | ||||||
|             return 1 |  | ||||||
|         fi |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Start Grafana in background |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| grafana_start_bg() { |  | ||||||
|     local cmd="grafana" |  | ||||||
|     local -a args=( |  | ||||||
|         # Based on https://github.com/grafana/grafana/blob/v8.2.5/packaging/docker/run.sh |  | ||||||
|         "server" |  | ||||||
|         "--homepath=${GF_PATHS_HOME}" |  | ||||||
|         "--config=${GF_PATHS_CONFIG}" |  | ||||||
|         "--packaging=docker" |  | ||||||
|         "--pidfile=${GRAFANA_PID_FILE}" |  | ||||||
|         "cfg:default.log.mode=console" |  | ||||||
|         "cfg:default.paths.data=${GF_PATHS_DATA}" |  | ||||||
|         "cfg:default.paths.logs=${GF_PATHS_LOGS}" |  | ||||||
|         "cfg:default.paths.plugins=${GF_PATHS_PLUGINS}" |  | ||||||
|         "cfg:default.paths.provisioning=${GF_PATHS_PROVISIONING}" |  | ||||||
|     ) |  | ||||||
| 
 |  | ||||||
|     cd "$GRAFANA_BASE_DIR" || return |  | ||||||
| 
 |  | ||||||
|     info "Starting Grafana in background" |  | ||||||
|     if am_i_root; then |  | ||||||
|         debug_execute run_as_user "$GRAFANA_DAEMON_USER" "$cmd" "${args[@]}" & |  | ||||||
|     else |  | ||||||
|         debug_execute "$cmd" "${args[@]}" & |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Update Grafana config file with settings provided via environment variables |  | ||||||
| # Globals: |  | ||||||
| #   GRAFANA_CFG_* |  | ||||||
| #   GF_PATHS_CONFIG |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| grafana_configure_from_environment_variables() { |  | ||||||
|     local section_key_pair section key value |  | ||||||
|     # Map environment variables to config properties |  | ||||||
|     for var in "${!GRAFANA_CFG_@}"; do |  | ||||||
|         # shellcheck disable=SC2001 |  | ||||||
|         section_key_pair="$(sed 's/^GRAFANA_CFG_//g' <<< "$var" | tr '[:upper:]' '[:lower:]')" |  | ||||||
|         section="${section_key_pair/_*}" |  | ||||||
|         key="${section_key_pair#*_}" |  | ||||||
|         value="${!var}" |  | ||||||
|         grafana_conf_set "$section" "$key" "$value" |  | ||||||
|     done |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Update a single configuration in Grafana's config file |  | ||||||
| # Globals: |  | ||||||
| #   GF_PATHS_CONFIG |  | ||||||
| # Arguments: |  | ||||||
| #   $1 - section |  | ||||||
| #   $2 - key |  | ||||||
| #   $3 - value |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| grafana_conf_set() { |  | ||||||
|     local -r section="${1:?missing key}" |  | ||||||
|     local -r key="${2:?missing key}" |  | ||||||
|     local -r value="${3:-}" |  | ||||||
|     debug "Setting configuration ${section}.${key} with value '${value}' to configuration file" |  | ||||||
|     ini-file set --section "$section" --key "$key" --value "$value" "$(grafana_env_var_value PATHS_CONFIG)" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Install plugins |  | ||||||
| # Globals: |  | ||||||
| #   GRAFANA_* |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| grafana_install_plugins() { |  | ||||||
|     [[ -z "$GF_INSTALL_PLUGINS" ]] && return |  | ||||||
| 
 |  | ||||||
|     local -a plugin_list |  | ||||||
|     IFS="," read -r -a plugin_list <<< "$(tr ';' ',' <<< "${GF_INSTALL_PLUGINS}")" |  | ||||||
|     if [[ "${#plugin_list[@]}" -le 0 ]]; then |  | ||||||
|         warn "There are no plugins to install" |  | ||||||
|         return |  | ||||||
|     fi |  | ||||||
| 
 |  | ||||||
|     local plugin_id plugin_version |  | ||||||
|     local -a grafana_plugin_install_args |  | ||||||
|     local -a plugin_url_array |  | ||||||
|     local -a plugin_id_version_array |  | ||||||
|     for plugin in "${plugin_list[@]}"; do |  | ||||||
|         plugin_id="$plugin" |  | ||||||
|         plugin_version="" |  | ||||||
|         grafana_plugin_install_args=("--pluginsDir" "$(grafana_env_var_value PATHS_PLUGINS)") |  | ||||||
|         is_boolean_yes "$GF_INSTALL_PLUGINS_SKIP_TLS" && grafana_plugin_install_args+=("--insecure") |  | ||||||
|         if grep -q '=' <<< "$plugin"; then |  | ||||||
|             read -r -a plugin_url_array <<< "$(tr '=' ' ' <<< "${plugin}")" |  | ||||||
|             info "Installing plugin ${plugin_url_array[0]} from URL ${plugin_url_array[1]}" |  | ||||||
|             plugin_id="${plugin_url_array[0]}" |  | ||||||
|             grafana_plugin_install_args+=("--pluginUrl" "${plugin_url_array[1]}") |  | ||||||
|         elif grep ':' <<< "$plugin"; then |  | ||||||
|             read -r -a plugin_id_version_array <<< "$(tr ':' ' ' <<< "${plugin}")" |  | ||||||
|             plugin_id="${plugin_id_version_array[0]}" |  | ||||||
|             plugin_version="${plugin_id_version_array[1]}" |  | ||||||
|             info "Installing plugin ${plugin_id} @ ${plugin_version}" |  | ||||||
|         elif grep ' ' <<< "$plugin"; then |  | ||||||
|             read -r -a plugin_id_version_array <<< "$plugin" |  | ||||||
|             plugin_id="${plugin_id_version_array[0]}" |  | ||||||
|             plugin_version="${plugin_id_version_array[1]}" |  | ||||||
|             info "Installing plugin ${plugin_id} @ ${plugin_version}" |  | ||||||
|         else |  | ||||||
|             info "Installing plugin ${plugin_id}" |  | ||||||
|         fi |  | ||||||
|         grafana_plugin_install_args+=("plugins" "install" "${plugin_id}") |  | ||||||
|         if [[ -n "$plugin_version" ]]; then |  | ||||||
|             grafana_plugin_install_args+=("$plugin_version") |  | ||||||
|         fi |  | ||||||
|         grafana cli "${grafana_plugin_install_args[@]}" |  | ||||||
|     done |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if Grafana is running |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| is_grafana_running() { |  | ||||||
|     local pid |  | ||||||
|     pid="$(get_pid_from_file "$GRAFANA_PID_FILE")" |  | ||||||
|     if [[ -n "$pid" ]]; then |  | ||||||
|         is_service_running "$pid" |  | ||||||
|     else |  | ||||||
|         false |  | ||||||
|     fi |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Check if Grafana is not running |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   Boolean |  | ||||||
| ######################### |  | ||||||
| is_grafana_not_running() { |  | ||||||
|     ! is_grafana_running |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Stop Grafana |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| grafana_stop() { |  | ||||||
|     is_grafana_not_running && return |  | ||||||
| 
 |  | ||||||
|     info "Stopping Grafana" |  | ||||||
|     stop_service_using_pid "$GRAFANA_PID_FILE" |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| ######################## |  | ||||||
| # Returns grafana major version |  | ||||||
| # Globals: |  | ||||||
| #   GRAFANA_BIN_DIR |  | ||||||
| # Arguments: |  | ||||||
| #   None |  | ||||||
| # Returns: |  | ||||||
| #   None |  | ||||||
| ######################### |  | ||||||
| get_grafana_major_version() { |  | ||||||
|     grafana_version="$("${GRAFANA_BIN_DIR}/grafana" -v)" |  | ||||||
|     grafana_version="${grafana_version#"grafana version "}" |  | ||||||
|     major_version="$(get_sematic_version "$grafana_version" 1)" |  | ||||||
|     echo "${major_version:-0}" |  | ||||||
| } |  | ||||||
|  | @ -1,38 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # 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,25 +0,0 @@ | ||||||
| #!/bin/bash |  | ||||||
| # Copyright Broadcom, Inc. All Rights Reserved. |  | ||||||
| # SPDX-License-Identifier: APACHE-2.0 |  | ||||||
| 
 |  | ||||||
| # shellcheck disable=SC1091 |  | ||||||
| 
 |  | ||||||
| set -o errexit |  | ||||||
| set -o nounset |  | ||||||
| set -o pipefail |  | ||||||
| # set -o xtrace # Uncomment this line for debugging purposes |  | ||||||
| 
 |  | ||||||
| # Only execute init scripts once |  | ||||||
| if [[ ! -f "/bitnami/grafana/.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/grafana/.user_scripts_initialized" ]]; then |  | ||||||
|         mkdir -p "/bitnami/grafana" |  | ||||||
|         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/grafana/.user_scripts_initialized" |  | ||||||
| fi |  | ||||||
		Loading…
	
		Reference in New Issue