From 7abeee62135a721eb75a7d4d3bbfb965a6b576cf Mon Sep 17 00:00:00 2001 From: Bitnami Bot Date: Mon, 19 May 2025 17:15:07 +0200 Subject: [PATCH] [bitnami/influxdb] Release 3.0.3-debian-12-r0 (#81385) Signed-off-by: Bitnami Bot --- bitnami/influxdb/3/debian-12/Dockerfile | 62 ++ .../influxdb/3/debian-12/docker-compose.yml | 15 + .../opt/bitnami/.bitnami_components.json | 20 + .../opt/bitnami/licenses/licenses.txt | 2 + .../opt/bitnami/scripts/libbitnami.sh | 53 ++ .../prebuildfs/opt/bitnami/scripts/libfile.sh | 141 ++++ .../prebuildfs/opt/bitnami/scripts/libfs.sh | 193 +++++ .../prebuildfs/opt/bitnami/scripts/libhook.sh | 18 + .../prebuildfs/opt/bitnami/scripts/liblog.sh | 146 ++++ .../prebuildfs/opt/bitnami/scripts/libnet.sh | 171 +++++ .../prebuildfs/opt/bitnami/scripts/libos.sh | 657 ++++++++++++++++++ .../opt/bitnami/scripts/libpersistence.sh | 124 ++++ .../opt/bitnami/scripts/libservice.sh | 496 +++++++++++++ .../opt/bitnami/scripts/libvalidations.sh | 294 ++++++++ .../opt/bitnami/scripts/libversion.sh | 51 ++ .../opt/bitnami/scripts/libwebserver.sh | 476 +++++++++++++ .../prebuildfs/usr/sbin/install_packages | 27 + .../debian-12/prebuildfs/usr/sbin/run-script | 24 + .../opt/bitnami/scripts/influxdb-env.sh | 156 +++++ .../bitnami/scripts/influxdb/entrypoint.sh | 38 + .../bitnami/scripts/influxdb/postunpack.sh | 32 + .../opt/bitnami/scripts/influxdb/run.sh | 31 + .../opt/bitnami/scripts/influxdb/setup.sh | 31 + .../rootfs/opt/bitnami/scripts/libinfluxdb.sh | 613 ++++++++++++++++ bitnami/influxdb/3/debian-12/tags-info.yaml | 5 + bitnami/influxdb/README.md | 222 ++---- bitnami/influxdb/docker-compose.yml | 8 +- 27 files changed, 3919 insertions(+), 187 deletions(-) create mode 100644 bitnami/influxdb/3/debian-12/Dockerfile create mode 100644 bitnami/influxdb/3/debian-12/docker-compose.yml create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh create mode 100644 bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh create mode 100755 bitnami/influxdb/3/debian-12/prebuildfs/usr/sbin/install_packages create mode 100755 bitnami/influxdb/3/debian-12/prebuildfs/usr/sbin/run-script create mode 100644 bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb-env.sh create mode 100755 bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/entrypoint.sh create mode 100755 bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/postunpack.sh create mode 100755 bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/run.sh create mode 100755 bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/setup.sh create mode 100644 bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/libinfluxdb.sh create mode 100644 bitnami/influxdb/3/debian-12/tags-info.yaml diff --git a/bitnami/influxdb/3/debian-12/Dockerfile b/bitnami/influxdb/3/debian-12/Dockerfile new file mode 100644 index 000000000000..d9e1ec9857f2 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/Dockerfile @@ -0,0 +1,62 @@ +# 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 com.vmware.cp.artifact.flavor="sha256:c50c90cfd9d12b445b011e6ad529f1ad3daea45c26d20b00732fae3cd71f6a83" \ + org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \ + org.opencontainers.image.created="2025-05-19T14:50:18Z" \ + org.opencontainers.image.description="Application packaged by Broadcom, Inc." \ + org.opencontainers.image.documentation="https://github.com/bitnami/containers/tree/main/bitnami/influxdb/README.md" \ + org.opencontainers.image.ref.name="3.0.3-debian-12-r0" \ + org.opencontainers.image.source="https://github.com/bitnami/containers/tree/main/bitnami/influxdb" \ + org.opencontainers.image.title="influxdb" \ + org.opencontainers.image.vendor="Broadcom, Inc." \ + org.opencontainers.image.version="3.0.3" + +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 jq libbz2-1.0 libcom-err2 libcrypt1 libffi8 libgcc-s1 libgssapi-krb5-2 libk5crypto3 libkeyutils1 libkrb5-3 libkrb5support0 liblzma5 libncursesw6 libnsl2 libreadline8 libsqlite3-0 libssl3 libtinfo6 libtirpc3 procps zlib1g +RUN mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ || exit 1 ; \ + COMPONENTS=( \ + "python-3.12.10-12-linux-${OS_ARCH}-debian-12" \ + "influxdb-3.0.3-0-linux-${OS_ARCH}-debian-12" \ + "wait-for-port-1.0.8-16-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/influxdb/postunpack.sh +ENV APP_VERSION="3.0.3" \ + BITNAMI_APP_NAME="influxdb" \ + LD_LIBRARY_PATH="/opt/bitnami/python/lib:$LD_LIBRARY_PATH" \ + PATH="/opt/bitnami/python/bin:/opt/bitnami/influxdb/bin:/opt/bitnami/common/bin:$PATH" + +VOLUME [ "/bitnami/influxdb" ] + +EXPOSE 8088 8181 + +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/influxdb/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/influxdb/run.sh" ] diff --git a/bitnami/influxdb/3/debian-12/docker-compose.yml b/bitnami/influxdb/3/debian-12/docker-compose.yml new file mode 100644 index 000000000000..de923b1167a2 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/docker-compose.yml @@ -0,0 +1,15 @@ +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +services: + influxdb: + image: docker.io/bitnami/influxdb:3 + ports: + - 8181:8181 + environment: + - INFLUXDB_NODE_ID=0 + volumes: + - influxdb_data:/bitnami/influxdb +volumes: + influxdb_data: + driver: local diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json new file mode 100644 index 000000000000..5b49176124d5 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json @@ -0,0 +1,20 @@ +{ + "influxdb": { + "arch": "amd64", + "distro": "debian-12", + "type": "NAMI", + "version": "3.0.3-0" + }, + "python": { + "arch": "amd64", + "distro": "debian-12", + "type": "NAMI", + "version": "3.12.10-12" + }, + "wait-for-port": { + "arch": "amd64", + "distro": "debian-12", + "type": "NAMI", + "version": "1.0.8-16" + } +} \ No newline at end of file diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 000000000000..76956b38e82c --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,2 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 000000000000..00d053b5215a --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,53 @@ +#!/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 "Did you know there are enterprise versions of the Bitnami catalog? For enhanced secure software supply chain features, unlimited pulls from Docker, LTS support, or application customization, see Bitnami Premium or Tanzu Application Catalog. See https://www.arrow.com/globalecs/na/vendors/bitnami/ for more information." + info "" +} + diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 000000000000..1c69e0e48a5d --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,141 @@ +#!/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 +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 000000000000..1337f6c2dd59 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,193 @@ +#!/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 +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 000000000000..f3a5fe7868ee --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library to use for scripts expected to be used as Kubernetes lifecycle hooks + +# shellcheck disable=SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh + +# Override functions that log to stdout/stderr of the current process, so they print to process 1 +for function_to_override in stderr_print debug_execute; do + # Output is sent to output of process 1 and thus end up in the container log + # The hook output in general isn't saved + eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2" +done diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 000000000000..1e18ef9866fa --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,146 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for logging functions + +# Constants +RESET='\033[0m' +RED='\033[38;5;1m' +GREEN='\033[38;5;2m' +YELLOW='\033[38;5;3m' +MAGENTA='\033[38;5;5m' +CYAN='\033[38;5;6m' + +# Functions + +######################## +# Print to STDERR +# Arguments: +# Message to print +# Returns: +# None +######################### +stderr_print() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_QUIET:-false}" + # 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}/" +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 000000000000..004e426fba17 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,171 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Resolve IP address for a host/domain (i.e. DNS lookup) +# Arguments: +# $1 - Hostname to resolve +# $2 - IP address version (v4, v6), leave empty for resolving to any version +# Returns: +# IP +######################### +dns_lookup() { + local host="${1:?host is missing}" + local ip_version="${2:-}" + getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1 +} + +######################### +# Wait for a hostname and return the IP +# Arguments: +# $1 - hostname +# $2 - number of retries +# $3 - seconds to wait between retries +# Returns: +# - IP address that corresponds to the hostname +######################### +wait_for_dns_lookup() { + local hostname="${1:?hostname is missing}" + local retries="${2:-5}" + local seconds="${3:-1}" + check_host() { + if [[ $(dns_lookup "$hostname") == "" ]]; then + false + else + true + fi + } + # Wait for the host to be ready + retry_while "check_host ${hostname}" "$retries" "$seconds" + dns_lookup "$hostname" +} + +######################## +# Get machine's IP +# Arguments: +# None +# Returns: +# Machine IP +######################### +get_machine_ip() { + local -a ip_addresses + local hostname + hostname="$(hostname)" + read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" + if [[ "${#ip_addresses[@]}" -gt 1 ]]; then + warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" + elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then + error "Could not find any IP address associated to hostname ${hostname}" + exit 1 + fi + # Check if the first IP address is IPv6 to add brackets + if validate_ipv6 "${ip_addresses[0]}" ; then + echo "[${ip_addresses[0]}]" + else + echo "${ip_addresses[0]}" + fi +} + +######################## +# Check if the provided argument is a resolved hostname +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_hostname_resolved() { + local -r host="${1:?missing value}" + if [[ -n "$(dns_lookup "$host")" ]]; then + true + else + false + fi +} + +######################## +# Parse URL +# Globals: +# None +# Arguments: +# $1 - uri - String +# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String +# Returns: +# String +parse_uri() { + local uri="${1:?uri is missing}" + local component="${2:?component is missing}" + + # Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with + # additional sub-expressions to split authority into userinfo, host and port + # Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969) + local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-9]+))?))?(/([^?#]*))?(\?([^#]*))?(#(.*))?' + # || | ||| | | | | | | | | | + # |2 scheme | ||6 userinfo 7 host | 9 port | 11 rpath | 13 query | 15 fragment + # 1 scheme: | |5 userinfo@ 8 :... 10 path 12 ?... 14 #... + # | 4 authority + # 3 //... + local index=0 + case "$component" in + scheme) + index=2 + ;; + authority) + index=4 + ;; + userinfo) + index=6 + ;; + host) + index=7 + ;; + port) + index=9 + ;; + path) + index=10 + ;; + query) + index=13 + ;; + fragment) + index=14 + ;; + *) + stderr_print "unrecognized component $component" + return 1 + ;; + esac + [[ "$uri" =~ $URI_REGEX ]] && echo "${BASH_REMATCH[${index}]}" +} + +######################## +# Wait for a HTTP connection to succeed +# Globals: +# * +# Arguments: +# $1 - URL to wait for +# $2 - Maximum amount of retries (optional) +# $3 - Time between retries (optional) +# Returns: +# true if the HTTP connection succeeded, false otherwise +######################### +wait_for_http_connection() { + local url="${1:?missing url}" + local retries="${2:-}" + local sleep_time="${3:-}" + if ! retry_while "debug_execute curl --silent ${url}" "$retries" "$sleep_time"; then + error "Could not connect to ${url}" + return 1 + fi +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 000000000000..9d908c48579b --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,657 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Check if an user exists in the system +# Arguments: +# $1 - user +# Returns: +# Boolean +######################### +user_exists() { + local user="${1:?user is missing}" + id "$user" >/dev/null 2>&1 +} + +######################## +# Check if a group exists in the system +# Arguments: +# $1 - group +# Returns: +# Boolean +######################### +group_exists() { + local group="${1:?group is missing}" + getent group "$group" >/dev/null 2>&1 +} + +######################## +# Create a group in the system if it does not exist already +# Arguments: +# $1 - group +# Flags: +# -i|--gid - the ID for the new group +# -s|--system - Whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + local gid="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --gid) + shift + gid="${1:?missing gid}" + ;; + -s | --system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! group_exists "$group"; then + local -a args=("$group") + if [[ -n "$gid" ]]; then + if group_exists "$gid"; then + error "The GID $gid is already in use." >&2 + return 1 + fi + args+=("--gid" "$gid") + fi + $is_system_user && args+=("--system") + groupadd "${args[@]}" >/dev/null 2>&1 + fi +} + +######################## +# Create an user in the system if it does not exist already +# Arguments: +# $1 - user +# Flags: +# -i|--uid - the ID for the new user +# -g|--group - the group the new user should belong to +# -a|--append-groups - comma-separated list of supplemental groups to append to the new user +# -h|--home - the home directory for the new user +# -s|--system - whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_user_exists() { + local user="${1:?user is missing}" + local uid="" + local group="" + local append_groups="" + local home="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --uid) + shift + uid="${1:?missing uid}" + ;; + -g | --group) + shift + group="${1:?missing group}" + ;; + -a | --append-groups) + shift + append_groups="${1:?missing append_groups}" + ;; + -h | --home) + shift + home="${1:?missing home directory}" + ;; + -s | --system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! user_exists "$user"; then + local -a user_args=("-N" "$user") + if [[ -n "$uid" ]]; then + if user_exists "$uid"; then + error "The UID $uid is already in use." + return 1 + fi + user_args+=("--uid" "$uid") + else + $is_system_user && user_args+=("--system") + fi + useradd "${user_args[@]}" >/dev/null 2>&1 + fi + + if [[ -n "$group" ]]; then + local -a group_args=("$group") + $is_system_user && group_args+=("--system") + ensure_group_exists "${group_args[@]}" + usermod -g "$group" "$user" >/dev/null 2>&1 + fi + + if [[ -n "$append_groups" ]]; then + local -a groups + read -ra groups <<<"$(tr ',;' ' ' <<<"$append_groups")" + for group in "${groups[@]}"; do + ensure_group_exists "$group" + usermod -aG "$group" "$user" >/dev/null 2>&1 + done + fi + + if [[ -n "$home" ]]; then + mkdir -p "$home" + usermod -d "$home" "$user" >/dev/null 2>&1 + configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group" + fi +} + +######################## +# Check if the script is currently running as root +# Arguments: +# $1 - user +# $2 - group +# Returns: +# Boolean +######################### +am_i_root() { + if [[ "$(id -u)" = "0" ]]; then + true + else + false + fi +} + +######################## +# Print OS metadata +# Arguments: +# $1 - Flag name +# Flags: +# --id - Distro ID +# --version - Distro version +# --branch - Distro branch +# --codename - Distro codename +# --name - Distro name +# --pretty-name - Distro pretty name +# Returns: +# String +######################### +get_os_metadata() { + local -r flag_name="${1:?missing flag}" + # Helper function + get_os_release_metadata() { + local -r env_name="${1:?missing environment variable name}" + ( + . /etc/os-release + echo "${!env_name}" + ) + } + case "$flag_name" in + --id) + get_os_release_metadata ID + ;; + --version) + get_os_release_metadata VERSION_ID + ;; + --branch) + get_os_release_metadata VERSION_ID | sed 's/\..*//' + ;; + --codename) + get_os_release_metadata VERSION_CODENAME + ;; + --name) + get_os_release_metadata NAME + ;; + --pretty-name) + get_os_release_metadata PRETTY_NAME + ;; + *) + error "Unknown flag ${flag_name}" + return 1 + ;; + esac +} + +######################## +# Get total memory available +# Arguments: +# None +# Returns: +# Memory in bytes +######################### +get_total_memory() { + echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024)) +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# None +# Flags: +# --memory - memory size (optional) +# Returns: +# Detected instance size +######################### +get_machine_size() { + local memory="" + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + --memory) + shift + memory="${1:?missing memory}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + if [[ -z "$memory" ]]; then + debug "Memory was not specified, detecting available memory automatically" + memory="$(get_total_memory)" + fi + sanitized_memory=$(convert_to_mb "$memory") + if [[ "$sanitized_memory" -gt 26000 ]]; then + echo 2xlarge + elif [[ "$sanitized_memory" -gt 13000 ]]; then + echo xlarge + elif [[ "$sanitized_memory" -gt 6000 ]]; then + echo large + elif [[ "$sanitized_memory" -gt 3000 ]]; then + echo medium + elif [[ "$sanitized_memory" -gt 1500 ]]; then + echo small + else + echo micro + fi +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# $1 - memory size (optional) +# Returns: +# Detected instance size +######################### +get_supported_machine_sizes() { + echo micro small medium large xlarge 2xlarge +} + +######################## +# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048) +# Globals: +# None +# Arguments: +# $1 - memory size +# Returns: +# Result of the conversion +######################### +convert_to_mb() { + local amount="${1:-}" + if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then + size="${BASH_REMATCH[1]}" + unit="${BASH_REMATCH[2]}" + if [[ "$unit" = "g" || "$unit" = "G" ]]; then + amount="$((size * 1024))" + else + amount="$size" + fi + fi + echo "$amount" +} + +######################### +# Redirects output to /dev/null if debug mode is disabled +# Globals: +# BITNAMI_DEBUG +# Arguments: +# $@ - Command to execute +# Returns: +# None +######################### +debug_execute() { + if is_boolean_yes "${BITNAMI_DEBUG:-false}"; then + "$@" + else + "$@" >/dev/null 2>&1 + fi +} + +######################## +# Retries a command a given number of times +# Arguments: +# $1 - cmd (as a string) +# $2 - max retries. Default: 12 +# $3 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +retry_while() { + local cmd="${1:?cmd is missing}" + local retries="${2:-12}" + local sleep_time="${3:-5}" + local return_value=1 + + read -r -a command <<<"$cmd" + for ((i = 1; i <= retries; i += 1)); do + "${command[@]}" && return_value=0 && break + sleep "$sleep_time" + done + return $return_value +} + +######################## +# Generate a random string +# Arguments: +# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii +# -c|--count - Number of characters, defaults to 32 +# Arguments: +# None +# Returns: +# None +# Returns: +# String +######################### +generate_random_string() { + local type="ascii" + local count="32" + local filter + local result + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + -t | --type) + shift + type="$1" + ;; + -c | --count) + shift + count="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Validate type + case "$type" in + ascii) + filter="[:print:]" + ;; + numeric) + filter="0-9" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + alphanumeric+special|special+alphanumeric) + # Limit variety of special characters, so there is a higher chance of containing more alphanumeric characters + # Special characters are harder to write, and it could impact the overall UX if most passwords are too complex + filter='a-zA-Z0-9:@.,/+!=' + ;; + *) + echo "Invalid type ${type}" >&2 + return 1 + ;; + esac + # Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size + # Note there is a very small chance of strings starting with EOL character + # Therefore, the higher amount of lines read, this will happen less frequently + result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")" + echo "$result" +} + +######################## +# Create md5 hash from a string +# Arguments: +# $1 - string +# Returns: +# md5 hash - string +######################### +generate_md5_hash() { + local -r str="${1:?missing input string}" + echo -n "$str" | md5sum | awk '{print $1}' +} + +######################## +# Create sha1 hash from a string +# Arguments: +# $1 - string +# $2 - algorithm - 1 (default), 224, 256, 384, 512 +# Returns: +# sha1 hash - string +######################### +generate_sha_hash() { + local -r str="${1:?missing input string}" + local -r algorithm="${2:-1}" + echo -n "$str" | "sha${algorithm}sum" | awk '{print $1}' +} + +######################## +# Converts a string to its hexadecimal representation +# Arguments: +# $1 - string +# Returns: +# hexadecimal representation of the string +######################### +convert_to_hex() { + local -r str=${1:?missing input string} + local -i iterator + local char + for ((iterator = 0; iterator < ${#str}; iterator++)); do + char=${str:iterator:1} + printf '%x' "'${char}" + done +} + +######################## +# Get boot time +# Globals: +# None +# Arguments: +# None +# Returns: +# Boot time metadata +######################### +get_boot_time() { + stat /proc --format=%Y +} + +######################## +# Get machine ID +# Globals: +# None +# Arguments: +# None +# Returns: +# Machine ID +######################### +get_machine_id() { + local machine_id + if [[ -f /etc/machine-id ]]; then + machine_id="$(cat /etc/machine-id)" + fi + if [[ -z "$machine_id" ]]; then + # Fallback to the boot-time, which will at least ensure a unique ID in the current session + machine_id="$(get_boot_time)" + fi + echo "$machine_id" +} + +######################## +# Get the root partition's disk device ID (e.g. /dev/sda1) +# Globals: +# None +# Arguments: +# None +# Returns: +# Root partition disk ID +######################### +get_disk_device_id() { + local device_id="" + if grep -q ^/dev /proc/mounts; then + device_id="$(grep ^/dev /proc/mounts | awk '$2 == "/" { print $1 }' | tail -1)" + fi + # If it could not be autodetected, fallback to /dev/sda1 as a default + if [[ -z "$device_id" || ! -b "$device_id" ]]; then + device_id="/dev/sda1" + fi + echo "$device_id" +} + +######################## +# Get the root disk device ID (e.g. /dev/sda) +# Globals: +# None +# Arguments: +# None +# Returns: +# Root disk ID +######################### +get_root_disk_device_id() { + get_disk_device_id | sed -E 's/p?[0-9]+$//' +} + +######################## +# Get the root disk size in bytes +# Globals: +# None +# Arguments: +# None +# Returns: +# Root disk size in bytes +######################### +get_root_disk_size() { + fdisk -l "$(get_root_disk_device_id)" | grep 'Disk.*bytes' | sed -E 's/.*, ([0-9]+) bytes,.*/\1/' || true +} + +######################## +# Run command as a specific user and group (optional) +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Returns: +# Exit code of the specified command +######################### +run_as_user() { + run_chroot "$@" +} + +######################## +# Execute command as a specific user and group (optional), +# replacing the current process image +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Returns: +# Exit code of the specified command +######################### +exec_as_user() { + run_chroot --replace-process "$@" +} + +######################## +# Run a command using chroot +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Flags: +# -r | --replace-process - Replace the current process image (optional) +# Returns: +# Exit code of the specified command +######################### +run_chroot() { + local userspec + local user + local homedir + local replace=false + local -r cwd="$(pwd)" + + # Parse and validate flags + while [[ "$#" -gt 0 ]]; do + case "$1" in + -r | --replace-process) + replace=true + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + # Parse and validate arguments + if [[ "$#" -lt 2 ]]; then + echo "expected at least 2 arguments" + return 1 + else + userspec=$1 + shift + + # userspec can optionally include the group, so we parse the user + user=$(echo "$userspec" | cut -d':' -f1) + fi + + if ! am_i_root; then + error "Could not switch to '${userspec}': Operation not permitted" + return 1 + fi + + # Get the HOME directory for the user to switch, as chroot does + # not properly update this env and some scripts rely on it + homedir=$(eval echo "~${user}") + if [[ ! -d $homedir ]]; then + homedir="${HOME:-/}" + fi + + # Obtaining value for "$@" indirectly in order to properly support shell parameter expansion + if [[ "$replace" = true ]]; then + exec chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@" + else + chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@" + fi +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 000000000000..18445e7d27fa --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,124 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami persistence library +# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libversion.sh + +# Functions + +######################## +# Persist an application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# $2 - List of app files to persist +# Returns: +# true if all steps succeeded, false otherwise +######################### +persist_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_persist <<< "$(tr ',;:' ' ' <<< "$2")" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Persist the individual files + if [[ "${#files_to_persist[@]}" -le 0 ]]; then + warn "No files are configured to be persisted" + return + fi + pushd "$install_dir" >/dev/null || exit + local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder + local -r tmp_file="/tmp/perms.acl" + for file_to_persist in "${files_to_persist[@]}"; do + if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then + error "Cannot persist '${file_to_persist}' because it does not exist" + return 1 + fi + file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")" + file_to_persist_destination="${persist_dir}/${file_to_persist_relative}" + file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")" + # Get original permissions for existing files, which will be applied later + # Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume + getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file" + # Copy directories to the volume + ensure_dir_exists "$file_to_persist_destination_folder" + cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder" + # Restore permissions + pushd "$persist_dir" >/dev/null || exit + if am_i_root; then + setfacl --restore="$tmp_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file") + fi + popd >/dev/null || exit + done + popd >/dev/null || exit + rm -f "$tmp_file" + # Install the persisted files into the installation directory, via symlinks + restore_persisted_app "$@" +} + +######################## +# Restore a persisted application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# FORCE_MAJOR_UPGRADE +# Arguments: +# $1 - App folder name +# $2 - List of app files to restore +# Returns: +# true if all steps succeeded, false otherwise +######################### +restore_persisted_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_restore <<< "$(tr ',;:' ' ' <<< "$2")" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Restore the individual persisted files + if [[ "${#files_to_restore[@]}" -le 0 ]]; then + warn "No persisted files are configured to be restored" + return + fi + local file_to_restore_relative file_to_restore_origin file_to_restore_destination + for file_to_restore in "${files_to_restore[@]}"; do + file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")" + # We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed + file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")" + file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")" + rm -rf "$file_to_restore_origin" + ln -sfn "$file_to_restore_destination" "$file_to_restore_origin" + done +} + +######################## +# Check if an application directory was already persisted +# Globals: +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# Returns: +# true if all steps succeeded, false otherwise +######################### +is_app_initialized() { + local -r app="${1:?missing app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + if ! is_mounted_dir_empty "$persist_dir"; then + true + else + false + fi +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 000000000000..1f9b33096b02 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,496 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for managing services + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Read the provided pid file and returns a PID +# Arguments: +# $1 - Pid file +# Returns: +# PID +######################### +get_pid_from_file() { + local pid_file="${1:?pid file is missing}" + + if [[ -f "$pid_file" ]]; then + if [[ -n "$(< "$pid_file")" ]] && [[ "$(< "$pid_file")" -gt 0 ]]; then + echo "$(< "$pid_file")" + fi + fi +} + +######################## +# Check if a provided PID corresponds to a running service +# Arguments: +# $1 - PID +# Returns: +# Boolean +######################### +is_service_running() { + local pid="${1:?pid is missing}" + + kill -0 "$pid" 2>/dev/null +} + +######################## +# Stop a service by sending a termination signal to its pid +# Arguments: +# $1 - Pid file +# $2 - Signal number (optional) +# Returns: +# None +######################### +stop_service_using_pid() { + local pid_file="${1:?pid file is missing}" + local signal="${2:-}" + local pid + + pid="$(get_pid_from_file "$pid_file")" + [[ -z "$pid" ]] || ! is_service_running "$pid" && return + + if [[ -n "$signal" ]]; then + kill "-${signal}" "$pid" + else + kill "$pid" + fi + + local counter=10 + while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do + sleep 1 + counter=$((counter - 1)) + done +} + +######################## +# Start cron daemon +# Arguments: +# None +# Returns: +# true if started correctly, false otherwise +######################### +cron_start() { + if [[ -x "/usr/sbin/cron" ]]; then + /usr/sbin/cron + elif [[ -x "/usr/sbin/crond" ]]; then + /usr/sbin/crond + else + false + fi +} + +######################## +# Generate a cron configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Command +# Flags: +# --run-as - User to run as (default: root) +# --schedule - Cron schedule configuration (default: * * * * *) +# Returns: +# None +######################### +generate_cron_conf() { + local service_name="${1:?service name is missing}" + local cmd="${2:?command is missing}" + local run_as="root" + local schedule="* * * * *" + local clean="true" + + # Parse optional CLI flags + shift 2 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --run-as) + shift + run_as="$1" + ;; + --schedule) + shift + schedule="$1" + ;; + --no-clean) + clean="false" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + mkdir -p /etc/cron.d + if "$clean"; then + cat > "/etc/cron.d/${service_name}" <> /etc/cron.d/"$service_name" + fi +} + +######################## +# Remove a cron configuration file for a given service +# Arguments: +# $1 - Service name +# Returns: +# None +######################### +remove_cron_conf() { + local service_name="${1:?service name is missing}" + local cron_conf_dir="/etc/monit/conf.d" + rm -f "${cron_conf_dir}/${service_name}" +} + +######################## +# Generate a monit configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Pid file +# $3 - Start command +# $4 - Stop command +# Flags: +# --disable - Whether to disable the monit configuration +# Returns: +# None +######################### +generate_monit_conf() { + local service_name="${1:?service name is missing}" + local pid_file="${2:?pid file is missing}" + local start_command="${3:?start command is missing}" + local stop_command="${4:?stop command is missing}" + local monit_conf_dir="/etc/monit/conf.d" + local disabled="no" + + # Parse optional CLI flags + shift 4 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --disable) + disabled="yes" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + is_boolean_yes "$disabled" && conf_suffix=".disabled" + mkdir -p "$monit_conf_dir" + cat > "${monit_conf_dir}/${service_name}.conf${conf_suffix:-}" <&2 + return 1 + ;; + esac + shift + done + + mkdir -p "$logrotate_conf_dir" + cat < "${logrotate_conf_dir}/${service_name}" +# 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="" + # Parse CLI flags + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --name \ + | --type \ + | --user \ + | --group \ + | --exec-start \ + | --exec-stop \ + | --exec-reload \ + | --restart \ + | --pid-file \ + | --standard-output \ + | --standard-error \ + | --success-exit-status \ + | --custom-service-content \ + | --working-directory \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "$var_name"="${1:?"${var_name} value is missing"}" + ;; + --limit-*) + [[ -n "$limits_content" ]] && limits_content+=$'\n' + var_name="${1//--limit-}" + shift + limits_content+="Limit${var_name^^}=${1:?"--limit-${var_name} value is missing"}" + ;; + --exec-start-pre) + shift + [[ -n "$exec_start_pre" ]] && exec_start_pre+=$'\n' + exec_start_pre+="ExecStartPre=${1:?"--exec-start-pre value is missing"}" + ;; + --exec-start-post) + shift + [[ -n "$exec_start_post" ]] && exec_start_post+=$'\n' + exec_start_post+="ExecStartPost=${1:?"--exec-start-post value is missing"}" + ;; + --environment) + shift + # It is possible to add multiple environment lines + [[ -n "$environment" ]] && environment+=$'\n' + environment+="Environment=${1:?"--environment value is missing"}" + ;; + --environment-file) + shift + # It is possible to add multiple environment-file lines + [[ -n "$environment_file" ]] && environment_file+=$'\n' + environment_file+="EnvironmentFile=${1:?"--environment-file value is missing"}" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + # Validate inputs + local error="no" + if [[ -z "$exec_start" ]]; then + error "The --exec-start option is required" + error="yes" + fi + if [[ "$error" != "no" ]]; then + return 1 + fi + # Generate the Systemd unit + cat > "$service_file" <> "$service_file" <<< "WorkingDirectory=${working_directory}" + fi + if [[ -n "$exec_start_pre" ]]; then + # This variable may contain multiple ExecStartPre= directives + cat >> "$service_file" <<< "$exec_start_pre" + fi + if [[ -n "$exec_start" ]]; then + cat >> "$service_file" <<< "ExecStart=${exec_start}" + fi + if [[ -n "$exec_start_post" ]]; then + # This variable may contain multiple ExecStartPost= directives + cat >> "$service_file" <<< "$exec_start_post" + fi + # Optional stop and reload commands + if [[ -n "$exec_stop" ]]; then + cat >> "$service_file" <<< "ExecStop=${exec_stop}" + fi + if [[ -n "$exec_reload" ]]; then + cat >> "$service_file" <<< "ExecReload=${exec_reload}" + fi + # User and group + if [[ -n "$user" ]]; then + cat >> "$service_file" <<< "User=${user}" + fi + if [[ -n "$group" ]]; then + cat >> "$service_file" <<< "Group=${group}" + fi + # PID file allows to determine if the main process is running properly (for Restart=always) + if [[ -n "$pid_file" ]]; then + cat >> "$service_file" <<< "PIDFile=${pid_file}" + fi + if [[ -n "$restart" ]]; then + cat >> "$service_file" <<< "Restart=${restart}" + fi + # Environment flags + if [[ -n "$environment" ]]; then + # This variable may contain multiple Environment= directives + cat >> "$service_file" <<< "$environment" + fi + if [[ -n "$environment_file" ]]; then + # This variable may contain multiple EnvironmentFile= directives + cat >> "$service_file" <<< "$environment_file" + fi + # Logging + if [[ -n "$standard_output" ]]; then + cat >> "$service_file" <<< "StandardOutput=${standard_output}" + fi + if [[ -n "$standard_error" ]]; then + cat >> "$service_file" <<< "StandardError=${standard_error}" + fi + if [[ -n "$custom_service_content" ]]; then + # This variable may contain multiple miscellaneous directives + cat >> "$service_file" <<< "$custom_service_content" + fi + if [[ -n "$success_exit_status" ]]; then + cat >> "$service_file" <> "$service_file" <> "$service_file" <> "$service_file" <= 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 +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 000000000000..f0d5a5cd3389 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,51 @@ +#!/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 +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 000000000000..acb84fc2339b --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,476 @@ +#!/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 +} + +######################## +# Restart web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_restart() { + info "Restarting $(web_server_type)" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl restart "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" + fi +} + +######################## +# Reload web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_reload() { + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl reload "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" + fi +} + +######################## +# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --type - Application type, which has an effect on which configuration template to use +# --hosts - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disable - Whether to render server configurations with a .disabled prefix +# --disable-http - Whether to render the app's HTTP server configuration with a .disabled prefix +# --disable-https - Whether to render the app's HTTPS server configuration with a .disabled prefix +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --document-root - Path to document root directory +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-additional-http-configuration - Additional HTTP vhost configuration (no default) +# --apache-additional-https-configuration - Additional HTTPS vhost configuration (no default) +# --apache-before-vhost-configuration - Configuration to add before the directive (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no' and type is not defined) +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-proxy-address - Address where to proxy requests +# --apache-proxy-configuration - Extra configuration for the proxy +# --apache-proxy-http-configuration - Extra configuration for the proxy HTTP vhost +# --apache-proxy-https-configuration - Extra configuration for the proxy HTTPS vhost +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup (only allowed when type is not defined) +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# --nginx-external-configuration - Configuration external to server block (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_app_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --disable \ + | --disable-http \ + | --disable-https \ + ) + apache_args+=("$1") + nginx_args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --type \ + | --allow-remote-connections \ + | --http-port \ + | --https-port \ + | --document-root \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-additional-http-configuration \ + | --apache-additional-https-configuration \ + | --apache-before-vhost-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-proxy-address \ + | --apache-proxy-configuration \ + | --apache-proxy-http-configuration \ + | --apache-proxy-https-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "${2:?missing value}") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration \ + | --nginx-external-configuration) + nginx_args+=("${1//nginx-/}" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_web_server_app_configuration_not_exists() { + local app="${1:?missing app}" + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app" + done +} + +######################## +# Ensure the web server loads the configuration for an application in a URL prefix +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --document-root - Path to document root directory +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --type - Application type, which has an effect on what configuration template will be used +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_prefix_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --allow-remote-connections \ + | --document-root \ + | --prefix \ + | --type \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "$2") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + nginx_args+=("${1//nginx-/}" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --enable-http - Enable HTTP app configuration (if not enabled already) +# --enable-https - Enable HTTPS app configuration (if not enabled already) +# --disable-http - Disable HTTP app configuration (if not disabled already) +# --disable-https - Disable HTTPS app configuration (if not disabled already) +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +web_server_update_app_configuration() { + local app="${1:?missing app}" + shift + local -a args web_servers + args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --enable-http \ + | --enable-https \ + | --disable-http \ + | --disable-https \ + ) + args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}" + done +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_enable_loading_page() { + ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \ + --apache-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +RedirectMatch 503 ^/$ +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +ErrorDocument 404 /index.html +ErrorDocument 503 /index.html" \ + --nginx-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +location / { + return 503; +} +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +error_page 404 @installing; +error_page 503 @installing; +location @installing { + rewrite ^(.*)$ /index.html break; +}" + web_server_reload +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_disable_install_page() { + ensure_web_server_app_configuration_not_exists "__loading" + web_server_reload +} diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/usr/sbin/install_packages b/bitnami/influxdb/3/debian-12/prebuildfs/usr/sbin/install_packages new file mode 100755 index 000000000000..ccce248b2d14 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,27 @@ +#!/bin/sh +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +set -eu + +n=0 +max=2 +export DEBIAN_FRONTEND=noninteractive + +until [ $n -gt $max ]; do + set +e + ( + apt-get update -qq && + apt-get install -y --no-install-recommends "$@" + ) + CODE=$? + set -e + if [ $CODE -eq 0 ]; then + break + fi + if [ $n -eq $max ]; then + exit $CODE + fi + echo "apt failed, retrying" + n=$(($n + 1)) +done +apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives diff --git a/bitnami/influxdb/3/debian-12/prebuildfs/usr/sbin/run-script b/bitnami/influxdb/3/debian-12/prebuildfs/usr/sbin/run-script new file mode 100755 index 000000000000..0e07c9038dfd --- /dev/null +++ b/bitnami/influxdb/3/debian-12/prebuildfs/usr/sbin/run-script @@ -0,0 +1,24 @@ +#!/bin/sh +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +set -u + +if [ $# -eq 0 ]; then + >&2 echo "No arguments provided" + exit 1 +fi + +script=$1 +exit_code="${2:-96}" +fail_if_not_present="${3:-n}" + +if test -f "$script"; then + sh $script + + if [ $? -ne 0 ]; then + exit $((exit_code)) + fi +elif [ "$fail_if_not_present" = "y" ]; then + >&2 echo "script not found: $script" + exit 127 +fi diff --git a/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb-env.sh b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb-env.sh new file mode 100644 index 000000000000..e91cba88296d --- /dev/null +++ b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb-env.sh @@ -0,0 +1,156 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Environment configuration for influxdb + +# 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:-influxdb}" +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 +influxdb_env_vars=( + INFLUXDB_DATA_DIR + INFLUXDB_DATA_WAL_DIR + INFLUXDB_META_DIR + INFLUXDB_CONF_FILE_FORMAT + INFLUXD_CONFIG_PATH + INFLUXDB_HTTP_PORT_NUMBER + INFLUXDB_HTTP_BIND_ADDRESS + INFLUXDB_REPORTING_DISABLED + INFLUXDB_PORT_NUMBER + INFLUXDB_BIND_ADDRESS + INFLUXDB_HTTP_READINESS_TIMEOUT + INFLUXDB_PORT_READINESS_TIMEOUT + INFLUXDB_NODE_ID + INFLUXDB_OBJECT_STORE + INFLUXDB_INIT_MODE + INFLUXDB_INIT_V1_DIR + INFLUXDB_INIT_V1_CONFIG + INFLUXDB_UPGRADE_LOG_FILE + INFLUXDB_CONTINUOUS_QUERY_EXPORT_FILE + INFLUXDB_HTTP_AUTH_ENABLED + INFLUXDB_ADMIN_USER + INFLUXDB_ADMIN_USER_PASSWORD + INFLUXDB_ADMIN_USER_TOKEN + INFLUXDB_ADMIN_CONFIG_NAME + INFLUXDB_ADMIN_ORG + INFLUXDB_ADMIN_BUCKET + INFLUXDB_ADMIN_RETENTION + INFLUXDB_USER + INFLUXDB_USER_PASSWORD + INFLUXDB_USER_ORG + INFLUXDB_USER_BUCKET + INFLUXDB_CREATE_USER_TOKEN + INFLUXDB_READ_USER + INFLUXDB_READ_USER_PASSWORD + INFLUXDB_WRITE_USER + INFLUXDB_WRITE_USER_PASSWORD + INFLUXDB_DB + INFLUXDB_CREATE_ADMIN_TOKEN + INFLUXDB_ADMIN_TOKEN + INFLUXDB_DATABASES +) +for env_var in "${influxdb_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 influxdb_env_vars + +# Paths +export INFLUXDB_BASE_DIR="${BITNAMI_ROOT_DIR}/influxdb" +export INFLUXDB_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/influxdb" +export INFLUXDB_BIN_DIR="${INFLUXDB_BASE_DIR}/bin" +export INFLUXDB_DATA_DIR="${INFLUXDB_DATA_DIR:-${INFLUXDB_VOLUME_DIR}/data}" +export INFLUXDB3_DB_DIR="$INFLUXDB_DATA_DIR" +export INFLUXDB_DATA_WAL_DIR="${INFLUXDB_DATA_WAL_DIR:-${INFLUXDB_VOLUME_DIR}/wal}" +export INFLUXDB_META_DIR="${INFLUXDB_META_DIR:-${INFLUXDB_VOLUME_DIR}/meta}" +export INFLUXDB_CONF_DIR="${INFLUXDB_BASE_DIR}/etc" +export INFLUXDB_DEFAULT_CONF_DIR="${INFLUXDB_BASE_DIR}/etc.default" +export INFLUXDB_CONF_FILE_FORMAT="${INFLUXDB_CONF_FILE_FORMAT:-yaml}" +export INFLUXDB_CONF_FILE="${INFLUXDB_CONF_DIR}/config.${INFLUXDB_CONF_FILE_FORMAT}" +export INFLUXDB_INITSCRIPTS_DIR="/docker-entrypoint-initdb.d" + +# InfluxDB 2.x aliases +export INFLUXD_ENGINE_PATH="${INFLUXDB_VOLUME_DIR}" +export INFLUXD_BOLT_PATH="${INFLUXDB_VOLUME_DIR}/influxd.bolt" +export INFLUXD_CONFIG_PATH="${INFLUXD_CONFIG_PATH:-${INFLUXDB_CONF_DIR}}" +export INFLUX_CONFIGS_PATH="${INFLUXDB_VOLUME_DIR}/configs" + +# System users (when running with a privileged user) +export INFLUXDB_DAEMON_USER="influxdb" +export INFLUXDB_DAEMON_GROUP="influxdb" + +# InfluxDB common server settings +export INFLUXDB_HTTP_PORT_NUMBER="${INFLUXDB_HTTP_PORT_NUMBER:-8181}" +export INFLUXDB_HTTP_BIND_ADDRESS="${INFLUXDB_HTTP_BIND_ADDRESS:-0.0.0.0:${INFLUXDB_HTTP_PORT_NUMBER}}" +export INFLUXD_HTTP_BIND_ADDRESS="$INFLUXDB_HTTP_BIND_ADDRESS" +export INFLUXDB3_HTTP_BIND_ADDR="$INFLUXDB_HTTP_BIND_ADDRESS" + +# InfluxDB 2.x server settings +export INFLUXDB_REPORTING_DISABLED="${INFLUXDB_REPORTING_DISABLED:-true}" +export INFLUXDB_PORT_NUMBER="${INFLUXDB_PORT_NUMBER:-8088}" +export INFLUXDB_BIND_ADDRESS="${INFLUXDB_BIND_ADDRESS:-0.0.0.0:${INFLUXDB_PORT_NUMBER}}" +export INFLUXDB_HTTP_READINESS_TIMEOUT="${INFLUXDB_HTTP_READINESS_TIMEOUT:-60}" +export INFLUXDB_PORT_READINESS_TIMEOUT="${INFLUXDB_PORT_READINESS_TIMEOUT:-30}" + +# InfluxDB 3.x server settings +export INFLUXDB_NODE_ID="${INFLUXDB_NODE_ID:-}" +export INFLUXDB3_NODE_IDENTIFIER_PREFIX="$INFLUXDB_NODE_ID" +export INFLUXDB_OBJECT_STORE="${INFLUXDB_OBJECT_STORE:-file}" +export INFLUXDB3_OBJECT_STORE="$INFLUXDB_OBJECT_STORE" + +# InfluxDB 1.x to 2.x upgrade settings +export INFLUXDB_INIT_MODE="${INFLUXDB_INIT_MODE:-setup}" +export INFLUXDB_INIT_V1_DIR="${INFLUXDB_INIT_V1_DIR:-${BITNAMI_VOLUME_DIR}/v1}" +export INFLUXDB_INIT_V1_CONFIG="${INFLUXDB_INIT_V1_CONFIG:-${BITNAMI_VOLUME_DIR}/v1/config.yaml}" +export INFLUXDB_UPGRADE_LOG_FILE="${INFLUXDB_UPGRADE_LOG_FILE:-${INFLUXDB_INIT_V1_DIR}/upgrade.log}" +export INFLUXDB_CONTINUOUS_QUERY_EXPORT_FILE="${INFLUXDB_CONTINUOUS_QUERY_EXPORT_FILE:-${INFLUXDB_INIT_V1_DIR}/v1-cq-export.txt}" + +# InfluxDB 2.x auth settings +export INFLUXDB_HTTP_AUTH_ENABLED="${INFLUXDB_HTTP_AUTH_ENABLED:-true}" +export INFLUXDB_ADMIN_USER="${INFLUXDB_ADMIN_USER:-admin}" +export INFLUXDB_ADMIN_USER_PASSWORD="${INFLUXDB_ADMIN_USER_PASSWORD:-}" +export INFLUXDB_ADMIN_USER_TOKEN="${INFLUXDB_ADMIN_USER_TOKEN:-}" +export INFLUXDB_ADMIN_CONFIG_NAME="${INFLUXDB_ADMIN_CONFIG_NAME:-default}" +export INFLUXDB_ADMIN_ORG="${INFLUXDB_ADMIN_ORG:-primary}" +export INFLUXDB_ADMIN_BUCKET="${INFLUXDB_ADMIN_BUCKET:-primary}" +export INFLUXDB_ADMIN_RETENTION="${INFLUXDB_ADMIN_RETENTION:-0}" +export INFLUXDB_USER="${INFLUXDB_USER:-}" +export INFLUXDB_USER_PASSWORD="${INFLUXDB_USER_PASSWORD:-}" +export INFLUXDB_USER_ORG="${INFLUXDB_USER_ORG:-${INFLUXDB_ADMIN_ORG}}" +export INFLUXDB_USER_BUCKET="${INFLUXDB_USER_BUCKET:-}" +export INFLUXDB_CREATE_USER_TOKEN="${INFLUXDB_CREATE_USER_TOKEN:-no}" +export INFLUXDB_READ_USER="${INFLUXDB_READ_USER:-}" +export INFLUXDB_READ_USER_PASSWORD="${INFLUXDB_READ_USER_PASSWORD:-}" +export INFLUXDB_WRITE_USER="${INFLUXDB_WRITE_USER:-}" +export INFLUXDB_WRITE_USER_PASSWORD="${INFLUXDB_WRITE_USER_PASSWORD:-}" +export INFLUXDB_DB="${INFLUXDB_DB:-}" + +# InfluxDB 3.x auth settings +export INFLUXDB_CREATE_ADMIN_TOKEN="${INFLUXDB_CREATE_ADMIN_TOKEN:-no}" +export INFLUXDB_ADMIN_TOKEN="${INFLUXDB_ADMIN_TOKEN:-}" +export INFLUXDB_DATABASES="${INFLUXDB_DATABASES:-}" + +# Custom environment variables may be defined below diff --git a/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/entrypoint.sh b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/entrypoint.sh new file mode 100755 index 000000000000..6ba88d390f9f --- /dev/null +++ b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/entrypoint.sh @@ -0,0 +1,38 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/libinfluxdb.sh + +# Load InfluxDB environment variables +. /opt/bitnami/scripts/influxdb-env.sh + +print_welcome_page + +if ! is_influxdb_3 && ! is_dir_empty "$INFLUXDB_DEFAULT_CONF_DIR"; then + # We add the copy from default config in the entrypoint to not break users + # bypassing the setup.sh logic. If the file already exists do not overwrite (in + # case someone mounts a configuration file in /opt/bitnami/influxdb/etc) + debug "Copying files from $INFLUXDB_DEFAULT_CONF_DIR to $INFLUXDB_CONF_DIR" + cp -nr "$INFLUXDB_DEFAULT_CONF_DIR"/. "$INFLUXDB_CONF_DIR" +fi + +if [[ "$*" = *"/opt/bitnami/scripts/influxdb/run.sh"* ]]; then + info "** Starting InfluxDB setup **" + /opt/bitnami/scripts/influxdb/setup.sh + info "** InfluxDB setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/postunpack.sh b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/postunpack.sh new file mode 100755 index 000000000000..6145576ac387 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/postunpack.sh @@ -0,0 +1,32 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +# Load libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libinfluxdb.sh + +# Load InfluxDB environment variables +. /opt/bitnami/scripts/influxdb-env.sh + +ensure_user_exists "$INFLUXDB_DAEMON_USER" --group "$INFLUXDB_DAEMON_GROUP" + +# Ensure directories used by InfluxDB exist and have proper ownership and permissions +dirs_to_exist=("$INFLUXDB_VOLUME_DIR" "$INFLUXDB_INITSCRIPTS_DIR") +! is_influxdb_3 && dirs_to_exist+=("$INFLUXDB_CONF_DIR" "$INFLUXDB_DEFAULT_CONF_DIR") +for dir in "${dirs_to_exist[@]}"; do + ensure_dir_exists "$dir" + chmod -R g+rwX "$dir" + chown -R "${INFLUXDB_DAEMON_USER}:root" "$dir" +done + +if ! is_influxdb_3; then + touch "$HOME/.influx_history" && chmod g+rwX "$HOME/.influx_history" + if ! is_dir_empty "$INFLUXDB_CONF_DIR"; then + # Copy all initially generated configuration files to the default directory + # (this is to avoid breaking when entrypoint is being overridden) + cp -r "${INFLUXDB_CONF_DIR}/"* "$INFLUXDB_DEFAULT_CONF_DIR" + fi +fi diff --git a/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/run.sh b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/run.sh new file mode 100755 index 000000000000..505f31ffa3ff --- /dev/null +++ b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/run.sh @@ -0,0 +1,31 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libinfluxdb.sh + +# Load InfluxDB environment variables +. /opt/bitnami/scripts/influxdb-env.sh + +info "** Starting InfluxDB **" +start_command=("$(influxdb_binary)") +if is_influxdb_3; then + start_command+=("serve" "--node-id" "$INFLUXDB_NODE_ID" "--object-store" "$INFLUXDB_OBJECT_STORE") +else + export HOME="/bitnami/influxdb" +fi +if am_i_root; then + exec_as_user "$INFLUXDB_DAEMON_USER" "${start_command[@]}" "$@" +else + exec "${start_command[@]}" "$@" +fi diff --git a/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/setup.sh b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/setup.sh new file mode 100755 index 000000000000..81f2308b6a0b --- /dev/null +++ b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/influxdb/setup.sh @@ -0,0 +1,31 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libinfluxdb.sh + +# Load InfluxDB environment variables +. /opt/bitnami/scripts/influxdb-env.sh + +# Ensure InfluxDB environment variables are valid +influxdb_validate +# Ensure InfluxDB user and group exist when running as 'root' +if am_i_root; then + chown -R "$INFLUXDB_DAEMON_USER" "$INFLUXDB_VOLUME_DIR" "$INFLUXDB_CONF_DIR" +fi +# Ensure InfluxDB is stopped when this script ends. +trap "influxdb_stop" EXIT +# Ensure InfluxDB is initialized +influxdb_initialize +# Allow running custom initialization scripts +influxdb_custom_init_scripts diff --git a/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/libinfluxdb.sh b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/libinfluxdb.sh new file mode 100644 index 000000000000..c7a3859af49f --- /dev/null +++ b/bitnami/influxdb/3/debian-12/rootfs/opt/bitnami/scripts/libinfluxdb.sh @@ -0,0 +1,613 @@ +#!/bin/bash +# Copyright Broadcom, Inc. All Rights Reserved. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami InfluxDB library + +# shellcheck disable=SC1090,SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/libversion.sh + +# Functions + +######################## +# Returns true if InfluxDB version is 3.x +# Globals: +# None +# Arguments: +# None +# Returns: +# true/false +######################### +is_influxdb_3() { + local -r major_version="$(get_sematic_version "$APP_VERSION" 1)" + if [[ "$major_version" -eq 3 ]]; then + return 0 + fi + return 1 +} + +######################## +# Returns full path to InfluxDB binary +# Globals: +# INFLUXDB_BIN_DIR +# Arguments: +# None +# Returns: +# Path to InfluxDB binary +######################### +influxdb_binary() { + if is_influxdb_3; then + echo "${INFLUXDB_BIN_DIR}/influxdb3" + else + echo "${INFLUXDB_BIN_DIR}/influxd" + fi +} + +######################## +# Returns full path to InfluxDB CLI binary +# Globals: +# INFLUXDB_BIN_DIR +# Arguments: +# None +# Returns: +# Path to InfluxDB CLI binary +######################### +influxdb_cli_binary() { + if is_influxdb_3; then + echo "${INFLUXDB_BIN_DIR}/influxdb3" + else + echo "${INFLUXDB_BIN_DIR}/influx" + fi +} + +######################## +# Validate settings in INFLUXDB_* env vars +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_validate() { + local error_code=0 + debug "Validating settings in INFLUXDB_* env vars..." + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + check_yes_no_value() { + if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}"; then + print_validation_error "The allowed values for ${1} are: yes no" + fi + } + check_multi_value() { + if [[ " ${2} " != *" ${!1} "* ]]; then + print_validation_error "The allowed values for ${1} are: ${2}" + fi + } + check_valid_port() { + local port_var="${1:?missing port variable}" + local err + if ! err="$(validate_port -unprivileged "${!port_var}")"; then + print_validation_error "An invalid port was specified in the environment variable ${port_var}: ${err}." + fi + } + check_conflicting_ports() { + local -r total="$#" + for i in $(seq 1 "$((total - 1))"); do + for j in $(seq "$((i + 1))" "$total"); do + if [[ "${!i}" -eq "${!j}" ]]; then + print_validation_error "${!i} and ${!j} are bound to the same port" + fi + done + done + } + + # Boolean validations + for var in "INFLUXDB_CREATE_USER_TOKEN" "INFLUXDB_CREATE_ADMIN_TOKEN" "INFLUXDB_REPORTING_DISABLED" "INFLUXDB_HTTP_AUTH_ENABLED"; do + check_yes_no_value "$var" + done + + if is_influxdb_3; then + if [[ -z "$INFLUXDB_NODE_ID" ]]; then + print_validation_error "Node ID is required. Please, specify it by setting the 'INFLUXDB_NODE_ID' environment variable." + fi + if [[ -z "$INFLUXDB_OBJECT_STORE" ]]; then + print_validation_error "Object store is required. Please, specify it by setting the 'INFLUXDB_OBJECT_STORE' environment variable." + fi + # InfluxDB 3.x authentication validations + if is_boolean_yes "$INFLUXDB_CREATE_ADMIN_TOKEN"; then + if [[ -n "${INFLUXDB_ADMIN_TOKEN:-}" ]]; then + print_validation_error "The 'INFLUXDB_ADMIN_TOKEN' environment variable is not needed when 'INFLUXDB_CREATE_ADMIN_TOKEN' is set to 'yes'." + elif [[ "$INFLUXDB_OBJECT_STORE" =~ memory ]]; then + print_validation_error "No admin token can be created during initialization when using memory object store. Please, ensure 'INFLUXDB_CREATE_ADMIN_TOKEN' is set to 'no'." + fi + elif [[ "$INFLUXDB_OBJECT_STORE" =~ memory ]] && [[ -n "${INFLUXDB_DATABASES:-}" ]]; then + print_validation_error "No databases can be created during initialization when using memory object store. Please, ensure 'INFLUXDB_DATABASES' is not set." + elif [[ -z "${INFLUXDB_ADMIN_TOKEN:-}" ]] && [[ -n "${INFLUXDB_DATABASES:-}" ]]; then + print_validation_error "No admin token to be created during initialization nor provided, hence, no databases can be created. Please, specify the token by setting the 'INFLUXDB_ADMIN_TOKEN' or 'INFLUXDB_ADMIN_TOKEN_FILE' environment variables." + else + warn "No admin token to be created during initialization, manually creating it will be required to interact with the InfluxDB API." + fi + else + # InfluxDB 2.x authentication validations + if [[ -z "${INFLUXDB_ADMIN_USER_PASSWORD:-}" ]]; then + print_validation_error "Admin authentication is required. Please, specify a password for the ${INFLUXDB_ADMIN_USER} user by setting the 'INFLUXDB_ADMIN_USER_PASSWORD' or 'INFLUXDB_ADMIN_USER_PASSWORD_FILE' environment variables." + fi + if [[ -z "${INFLUXDB_ADMIN_USER_TOKEN:-}" ]]; then + warn "No admin token provided. Notice some internal features require it, like performing HTTP API requests." + warn "A token for the ${INFLUXDB_ADMIN_USER} user can be provided by setting the 'INFLUXDB_ADMIN_USER_TOKEN' or 'INFLUXDB_ADMIN_USER_TOKEN_FILE' environment variables." + fi + if [[ -n "${INFLUXDB_USER:-}" ]] && [[ -z "${INFLUXDB_USER_PASSWORD:-}" ]]; then + print_validation_error "User authentication is required. Please, specify a password for the ${INFLUXDB_USER} user by setting the 'INFLUXDB_USER_PASSWORD' or 'INFLUXDB_USER_PASSWORD_FILE' environment variables." + fi + # InfluxDB 1.x to 2.x upgrade validations + check_multi_value "INFLUXDB_INIT_MODE" "setup upgrade" + if [[ "$INFLUXDB_INIT_MODE" = "upgrade" ]] && [[ -n "${INFLUXDB_INIT_V1_DIR:-}" ]] && [[ -z "${INFLUXDB_INIT_V1_CONFIG:-}" ]]; then + print_validation_error "InfluxDB 1.x data not found. Please, specify its location by setting the 'INFLUXDB_INIT_V1_DIR' or 'INFLUXDB_INIT_V1_CONFIG' environment variables." + fi + # Validate InfluxDB 2.x configuration file format + [[ -n "${INFLUXDB_CONF_FILE_FORMAT:-}" ]] && check_multi_value "INFLUXDB_CONF_FILE_FORMAT" "yaml json yml toml" + fi + + # InfluxDB port validations + local -a ports_envs=("INFLUXDB_HTTP_PORT_NUMBER") + ! is_influxdb_3 && ports_envs+=("INFLUXDB_PORT_NUMBER") + for p in "${ports_envs[@]}"; do + check_valid_port "$p" + done + check_conflicting_ports "${ports_envs[@]}" + + [[ "$error_code" -eq 0 ]] || exit "$error_code" +} + +######################## +# Create basic influxdb.conf file using the example provided in the etc/ folder +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_create_config() { + local config_file="${INFLUXDB_CONF_FILE}" + + if [[ -f "${config_file}" ]]; then + info "Custom configuration ${INFLUXDB_CONF_FILE} detected!" + warn "The 'INFLUXDB_' environment variables override the equivalent options in the configuration file." + warn "If a configuration option is not specified in either the configuration file or in an environment variable, InfluxDB uses its internal default configuration" + else + info "No injected configuration files found. Creating default config files..." + touch "${config_file}" + fi +} + +######################## +# Create primary setup +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_create_primary_setup() { + local -a args=( + --force + --name "${INFLUXDB_ADMIN_CONFIG_NAME}" + --org "${INFLUXDB_ADMIN_ORG}" + --bucket "${INFLUXDB_ADMIN_BUCKET}" + --username "${INFLUXDB_ADMIN_USER}" + --password "${INFLUXDB_ADMIN_USER_PASSWORD}" + --retention "${INFLUXDB_ADMIN_RETENTION}" + ) + + if [ -n "${INFLUXDB_ADMIN_USER_TOKEN}" ]; then + args+=('--token' "${INFLUXDB_ADMIN_USER_TOKEN}") + fi + + local setup_command=("$(influxdb_cli_binary)" setup "${args[@]}") + am_i_root && setup_command=("run_as_user" "$INFLUXDB_DAEMON_USER" "${setup_command[@]}") + debug_execute "${setup_command[@]}" +} + +######################## +# Upgrade V1 data into the V2 format +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_run_upgrade() { + local -a args=( + --force + --org "${INFLUXDB_ADMIN_ORG}" + --bucket "${INFLUXDB_ADMIN_BUCKET}" + --username "${INFLUXDB_ADMIN_USER}" + --password "${INFLUXDB_ADMIN_USER_PASSWORD}" + --retention "${INFLUXDB_ADMIN_RETENTION}" + --v2-config-path "${INFLUXDB_CONF_FILE}" + --influx-configs-path "${INFLUX_CONFIGS_PATH}" + --continuous-query-export-path "${INFLUXDB_CONTINUOUS_QUERY_EXPORT_FILE}" + --log-path "${INFLUXDB_UPGRADE_LOG_FILE}" + --bolt-path "${INFLUXD_BOLT_PATH}" + --engine-path "${INFLUXD_ENGINE_PATH}" + --v1-dir "${INFLUXDB_INIT_V1_DIR}" + ) + + if [ -n "${INFLUXDB_ADMIN_USER_TOKEN}" ]; then + args+=('--token' "${INFLUXDB_ADMIN_USER_TOKEN}") + fi + + local logLevel="info" + is_boolean_yes "${BITNAMI_DEBUG}" && logLevel="debug" + args+=('--log-level' "${logLevel}") + + + local upgrade_command=("$(influxdb_binary)" upgrade "${args[@]}") + am_i_root && upgrade_command=("run_as_user" "$INFLUXDB_DAEMON_USER" "${upgrade_command[@]}") + debug_execute "${upgrade_command[@]}" +} + +######################## +# Create organization +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_create_org() { + INFLUX_ACTIVE_CONFIG="${INFLUXDB_ADMIN_CONFIG_NAME}" "$(influxdb_cli_binary)" org create --name "${INFLUXDB_USER_ORG}" +} + +######################## +# Create bucket +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_create_bucket() { + INFLUX_ACTIVE_CONFIG="${INFLUXDB_ADMIN_CONFIG_NAME}" "$(influxdb_cli_binary)" bucket create \ + "--org" "${INFLUXDB_USER_ORG:-${INFLUXDB_ADMIN_ORG}}" \ + "--name" "${INFLUXDB_USER_BUCKET}" +} + +######################## +# Create user +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_create_user() { + local username=${1:?missing username} + local password=${2:?missing password} + local kind=${3:-"admin"} + + local params=("--org" "${INFLUXDB_USER_ORG:-${INFLUXDB_ADMIN_ORG}}" "--name" "${username}" "--password" "${password}") + INFLUX_ACTIVE_CONFIG="${INFLUXDB_ADMIN_CONFIG_NAME}" "$(influxdb_cli_binary)" user create "${params[@]}" + + if is_boolean_yes "${INFLUXDB_CREATE_USER_TOKEN}"; then + local read_grants=("--read-buckets" "--read-checks" "--read-dashboards" "--read-dbrp" "--read-notificationEndpoints" "--read-notificationRules" "--read-orgs" "--read-tasks") + local write_grants=("--write-buckets" "--write-checks" "--write-dashboards" "--write-dbrp" "--write-notificationEndpoints" "--write-notificationRules" "--write-orgs" "--write-tasks") + + local -a grants + if [[ ${kind} = "admin" ]] || [[ ${kind} = "write" ]]; then + grants+=("${read_grants[@]}" "${write_grants[@]}") + elif [[ ${kind} = "read" ]]; then + grants+=("${read_grants[@]}") + else + echo "not supported user kind: ${kind}" && exit 1 + fi + + INFLUX_ACTIVE_CONFIG="${INFLUXDB_ADMIN_CONFIG_NAME}" "$(influxdb_cli_binary)" auth create \ + --user "${username}" \ + --org "${INFLUXDB_USER_ORG:-${INFLUXDB_ADMIN_ORG}}" "${grants[@]}" + fi +} + +######################## +# Waits for InfluxDB to be ready +# Times out after 60 seconds +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################## +wait_for_influxdb() { + curl -sSL -I "127.0.0.1:${INFLUXDB_HTTP_PORT_NUMBER}/ping?wait_for_leader=${INFLUXDB_HTTP_READINESS_TIMEOUT}s" >/dev/null 2>&1 +} + +######################## +# Start InfluxDB in background disabling authentication and waits until it's ready +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_start_bg() { + is_influxdb_running && return + + info "Starting InfluxDB in background..." + local start_command=("$(influxdb_binary)") + # if root user then run it with chroot + am_i_root && start_command=("run_as_user" "$INFLUXDB_DAEMON_USER" "${start_command[@]}") + + if is_influxdb_3; then + start_command+=("serve" "--node-id" "$INFLUXDB_NODE_ID" "--object-store" "$INFLUXDB_OBJECT_STORE" "--http-bind" "127.0.0.1:${INFLUXDB_HTTP_PORT_NUMBER}") + debug_execute "${start_command[@]}" & + wait-for-port "$INFLUXDB_HTTP_PORT_NUMBER" + else + INFLUXDB_HTTP_HTTPS_ENABLED=false INFLUXDB_HTTP_BIND_ADDRESS="127.0.0.1:${INFLUXDB_HTTP_PORT_NUMBER}" debug_execute "${start_command[@]}" & + wait-for-port --timeout="$INFLUXDB_PORT_READINESS_TIMEOUT" "$INFLUXDB_HTTP_PORT_NUMBER" + wait_for_influxdb + fi +} + +######################## +# Check if InfluxDB is running +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# Boolean +######################### +is_influxdb_running() { + # VMs use a PID file, but containers do not, so check if the variable exists to cover both scenarios + binary_fullpath="$(influxdb_binary)" + if [[ -n "${INFLUXDB_PID_FILE:-}" ]]; then + # influxdb does not create any PID file + # We regenerate the PID file for each time we query it to avoid getting outdated + pgrep "$(basename "$binary_fullpath")" | head -n 1 > "$INFLUXDB_PID_FILE" + + local pid + pid="$(get_pid_from_file "$INFLUXDB_PID_FILE")" + if [[ -z "$pid" ]]; then + false + else + is_service_running "$pid" + fi + elif pgrep "$(basename "$binary_fullpath")" >/dev/null 2>&1; then + true + else + false + fi +} + +######################## +# Check if InfluxDB is not running +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# Boolean +######################### +is_influxdb_not_running() { + ! is_influxdb_running +} + +######################## +# Stop InfluxDB +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_stop() { + is_influxdb_not_running && return + + info "Stopping InfluxDB..." + pkill --full --signal TERM "$(influxdb_binary)" + wait-for-port --state free "$INFLUXDB_HTTP_PORT_NUMBER" +} + +######################## +# Creates the admin token +# Ref: https://docs.influxdata.com/influxdb3/core/get-started/#authentication-and-authorization +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb3_create_admin_token() { + local create_command=("$(influxdb_binary)" "create" "token" "--admin" "--host" "http://127.0.0.1:${INFLUXDB_HTTP_PORT_NUMBER}" "--format" "json") + + local token_file="${INFLUXDB_VOLUME_DIR}/.token" + info "Creating admin token..." + "${create_command[@]}" | jq -r ".token" > "$token_file" + chmod 600 "$token_file" + INFLUXDB_ADMIN_TOKEN="$(<"$token_file")" + export INFLUXDB_ADMIN_TOKEN + warn "Auto-generated admin token saved in ${token_file} for later use. Please, ensure you use it to regenerate it and remove the file afterwards." +} + +######################## +# Creates the databases +# Ref: https://docs.influxdata.com/influxdb3/core/admin/databases/create/ +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb3_create_databases() { + local -r binary_fullpath="$(influxdb_binary)" + + read -r -a dbs <<< "$(tr ',;' ' ' <<< "$INFLUXDB_DATABASES")" + read -r -a existingDbs <<< "$($binary_fullpath show databases --host "http://127.0.0.1:${INFLUXDB_HTTP_PORT_NUMBER}" --token "$INFLUXDB_ADMIN_TOKEN" --format json | jq -r '.[]."iox::database"' | tr -s '\n' ' ')" + info "Creating databases: ${dbs[*]}..." + for db in "${dbs[@]}"; do + if [[ "${existingDbs[*]}" =~ $db ]]; then + debug "Database \"${db}\" already exists. Skipping..." + continue + fi + debug "Creating database \"${db}\"..." + "$binary_fullpath" create database "$db" --host "http://127.0.0.1:${INFLUXDB_HTTP_PORT_NUMBER}" --token "$INFLUXDB_ADMIN_TOKEN" || true + done +} + +######################## +# Ensure InfluxDB is initialized +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_initialize() { + if is_influxdb_3; then + local init_required="no" + if is_boolean_yes "$INFLUXDB_CREATE_ADMIN_TOKEN" && [[ "$INFLUXDB_OBJECT_STORE" = "file" ]] && ! is_dir_empty "$INFLUXDB_DATA_DIR"; then + warn "InfluxDB data directory is not empty, admin token creation will be skipped" + elif is_boolean_yes "$INFLUXDB_CREATE_ADMIN_TOKEN"; then + init_required="yes" + fi + # We create the databases regardless there's existing data or not + [[ -n "${INFLUXDB_DATABASES:-}" ]] && init_required="yes" + # We can't initialize if the object store is memory-based + [[ "$INFLUXDB_OBJECT_STORE" =~ memory ]] && init_required="no" + if is_boolean_yes "$init_required"; then + info "Initializing..." + influxdb_start_bg + is_boolean_yes "$INFLUXDB_CREATE_ADMIN_TOKEN" && is_dir_empty "$INFLUXDB_DATA_DIR" && influxdb3_create_admin_token + [[ -n "${INFLUXDB_DATABASES:-}" ]] && influxdb3_create_databases + else + info "Skipping initialization..." + fi + elif [[ ! -f "${INFLUX_CONFIGS_PATH}" ]]; then + if [[ "${INFLUXDB_INIT_MODE}" = "setup" ]]; then + influxdb_create_config + influxdb_start_bg + info "Deploying InfluxDB from scratch" + info "Creating primary setup..." + influxdb_create_primary_setup + elif [[ "${INFLUXDB_INIT_MODE}" = "upgrade" ]]; then + info "Migrating InfluxDB 1.x data into 2.x format" + influxdb_run_upgrade + influxdb_start_bg + else + error "INFLUXDB_INIT_MODE only accepts 'setup' (default) or 'upgrade' values" + exit 1 + fi + + if [[ -n "${INFLUXDB_USER_ORG}" ]] && [[ "${INFLUXDB_USER_ORG}" != "${INFLUXDB_ADMIN_ORG}" ]]; then + info "Creating custom org with id: ${INFLUXDB_USER_ORG}..." + influxdb_create_org + fi + + if [[ -n "${INFLUXDB_USER_BUCKET}" ]]; then + info "Creating custom bucket with id: ${INFLUXDB_USER_BUCKET} in org with id: ${INFLUXDB_USER_ORG:-${INFLUXDB_ADMIN_ORG}}..." + influxdb_create_bucket + fi + + if [[ -n "${INFLUXDB_USER}" ]]; then + info "Creating custom user with username: ${INFLUXDB_USER} in org with id: ${INFLUXDB_USER_ORG:-${INFLUXDB_ADMIN_ORG}}..." + influxdb_create_user "${INFLUXDB_USER}" "${INFLUXDB_USER_PASSWORD}" + fi + if [[ -n "${INFLUXDB_READ_USER}" ]]; then + info "Creating custom user with username: ${INFLUXDB_READ_USER} in org with id: ${INFLUXDB_USER_ORG:-${INFLUXDB_ADMIN_ORG}}..." + influxdb_create_user "${INFLUXDB_READ_USER}" "${INFLUXDB_READ_USER_PASSWORD}" "read" + fi + if [[ -n "${INFLUXDB_WRITE_USER}" ]]; then + info "Creating custom user with username: ${INFLUXDB_WRITE_USER} in org with id: ${INFLUXDB_USER_ORG:-${INFLUXDB_ADMIN_ORG}}..." + influxdb_create_user "${INFLUXDB_WRITE_USER}" "${INFLUXDB_WRITE_USER_PASSWORD}" "write" + fi + else + info "influx CLI configuration ${INFLUXDB_CONF_FILE} detected!" + info "Deploying InfluxDB with persisted data" + fi + + true +} + +######################## +# Execute an arbitrary query using InfluxDB CLI +# Globals: +# INFLUXDB_* +# Arguments: +# $1 - Query to execute +# $2 - Whether to use admin credentials to run the command or not +# Returns: +# None +######################### +influxdb_execute_query() { + local -r query="${1:-query is required}" + local authenticate="${2:-false}" + local flags=("-host" "127.0.0.1" "-port" "$INFLUXDB_HTTP_PORT_NUMBER") + + is_boolean_yes "$authenticate" && flags+=("-username" "${INFLUXDB_ADMIN_USER}" "-password" "${INFLUXDB_ADMIN_USER_PASSWORD}") + debug_execute "$(influxdb_cli_binary)" "${flags[@]}" "-execute" "$query" +} + +######################## +# Run custom initialization scripts +# Globals: +# INFLUXDB_* +# Arguments: +# None +# Returns: +# None +######################### +influxdb_custom_init_scripts() { + if [[ -n $(find "${INFLUXDB_INITSCRIPTS_DIR}/" -type f -regex ".*\.\(sh\|txt\)") ]] && [[ ! -f "${INFLUXDB_VOLUME_DIR}/.user_scripts_initialized" ]]; then + info "Loading user's custom files from ${INFLUXDB_INITSCRIPTS_DIR} ..." + local -r tmp_file="/tmp/filelist" + is_influxdb_not_running && influxdb_start_bg + find "${INFLUXDB_INITSCRIPTS_DIR}/" -type f -regex ".*\.\(sh\|txt\)" | sort >"$tmp_file" + while read -r f; do + case "$f" in + *.sh) + if [[ -x "$f" ]]; then + debug "Executing $f" + "$f" + else + debug "Sourcing $f" + . "$f" + fi + ;; + *.txt) + if is_influxdb_3; then + debug "Ignoring $f" + else + debug "Executing $f" + influxdb_execute_query "$(<"$f")" + fi + ;; + *) debug "Ignoring $f" ;; + esac + done <$tmp_file + rm -f "$tmp_file" + touch "$INFLUXDB_VOLUME_DIR"/.user_scripts_initialized + fi +} diff --git a/bitnami/influxdb/3/debian-12/tags-info.yaml b/bitnami/influxdb/3/debian-12/tags-info.yaml new file mode 100644 index 000000000000..def8b154c090 --- /dev/null +++ b/bitnami/influxdb/3/debian-12/tags-info.yaml @@ -0,0 +1,5 @@ +rolling-tags: +- "3" +- 3-debian-12 +- 3.0.3 +- latest diff --git a/bitnami/influxdb/README.md b/bitnami/influxdb/README.md index 9602e43e3475..17b0396b3f9e 100644 --- a/bitnami/influxdb/README.md +++ b/bitnami/influxdb/README.md @@ -1,10 +1,10 @@ # Bitnami Stack for InfluxDB™ -## What is InfluxDB™? +## What is InfluxDB™ Core? -> InfluxDB™ is an open source time-series database. It is a core component of the TICK (Telegraf, InfluxDB™, Chronograf, Kapacitor) stack. +> InfluxDB™ Core is an open source time-series database. It is a core component of the FDAP (Apache Flight, DataFusion, Arrow, and Parquet) stack. -[Overview of InfluxDB™](https://www.influxdata.com/products/influxdb-overview) +[Overview of InfluxDB™ Core](https://www.influxdata.com/products/influxdb-overview) InfluxDB(TM) is a trademark owned by InfluxData, which is not affiliated with, and does not endorse, this site. ## TL;DR @@ -22,11 +22,11 @@ docker run --name influxdb bitnami/influxdb:latest * All Bitnami images available in Docker Hub are signed with [Notation](https://notaryproject.dev/). [Check this post](https://blog.bitnami.com/2024/03/bitnami-packaged-containers-and-helm.html) to know how to verify the integrity of the images. * Bitnami container images are released on a regular basis with the latest distribution packages available. -Looking to use InfluxDB™ in production? Try [VMware Tanzu Application Catalog](https://bitnami.com/enterprise), the commercial edition of the Bitnami catalog. +Looking to use InfluxDB™ Core in production? Try [VMware Tanzu Application Catalog](https://bitnami.com/enterprise), the commercial edition of the Bitnami catalog. -## How to deploy InfluxDB (TM) in Kubernetes? +## How to deploy InfluxDB™ Core in Kubernetes? -Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami InfluxDB (TM) Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/influxdb). +Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami InfluxDB™ Core Chart GitHub repository](https://github.com/bitnami/charts/tree/master/bitnami/influxdb). ## Only the latest stable branch maintained in the free Bitnami catalog @@ -44,7 +44,7 @@ Subscribe to project updates by watching the [bitnami/containers GitHub repo](ht ## Get this image -The recommended way to get the Bitnami InfluxDB (TM) Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/influxdb). +The recommended way to get the Bitnami InfluxDB™ Core Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/influxdb). ```console docker pull bitnami/influxdb:latest @@ -73,7 +73,7 @@ For persistence you should mount a directory at the `/bitnami/influxdb` path. If ```console docker run \ --volume /path/to/influxdb-persistence:/bitnami/influxdb \ - --env INFLUXDB_HTTP_AUTH_ENABLED=false \ + --env INFLUXDB_NODE_ID=0 \ bitnami/influxdb:latest ``` @@ -95,7 +95,7 @@ Containers attached to the same network can communicate with each other using th ### Using the Command Line -In this example, we will create a InfluxDB (TM) client instance that will connect to the server instance that is running on the same docker network as the client. +In this example, we will create a InfluxDB™ Core client instance that will connect to the server instance that is running on the same docker network as the client. #### Step 1: Create a network @@ -103,30 +103,30 @@ In this example, we will create a InfluxDB (TM) client instance that will connec docker network create my-network --driver bridge ``` -#### Step 2: Launch the InfluxDB (TM) container within your network +#### Step 2: Launch the InfluxDB™ Core container within your network Use the `--network ` argument to the `docker run` command to attach the container to the `my-network` network. ```console docker run -d --name influxdb-server \ --network my-network \ - --env INFLUXDB_HTTP_AUTH_ENABLED=false \ + --env INFLUXDB_NODE_ID=0 \ bitnami/influxdb:latest ``` -#### Step 3: Launch your InfluxDB (TM) client instance +#### Step 3: Launch your InfluxDB™ Core client instance -Finally we create a new container instance to launch the InfluxDB (TM) client and connect to the server created in the previous step: +Finally we create a new container instance to launch the InfluxDB™ Core client and connect to the server created in the previous step: ```console docker run -it --rm \ --network my-network \ - bitnami/influxdb:latest influx -host influxdb-server + bitnami/influxdb:latest influxdb3 show databases --host http://influxdb-server:8181 ``` ### Using a Docker Compose file -When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new `bridge` network named `my-network`. In this example we assume that you want to connect to the InfluxDB (TM) server from your own custom application image which is identified in the following snippet by the service name `myapp`. +When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new `bridge` network named `my-network`. In this example we assume that you want to connect to the InfluxDB™ Core server from your own custom application image which is identified in the following snippet by the service name `myapp`. ```yaml version: '2' @@ -139,7 +139,7 @@ services: influxdb: image: bitnami/influxdb:latest environment: - - INFLUXDB_HTTP_AUTH_ENABLED=false + - INFLUXDB_NODE_ID=0 networks: - my-network myapp: @@ -151,7 +151,7 @@ services: > **IMPORTANT**: > > 1. Please update the `YOUR_APPLICATION_IMAGE` placeholder in the above snippet with your application image -> 2. In your application container, use the hostname `influxdb` to connect to the InfluxDB (TM) server +> 2. In your application container, use the hostname `influxdb` to connect to the InfluxDB™ Core server Launch the containers using: @@ -161,7 +161,7 @@ docker-compose up -d ## Configuration -InfluxDB (TM) can be configured via environment variables or using a configuration file (`config.yaml`). If a configuration option is not specified in either the configuration file or in an environment variable, InfluxDB (TM) uses its internal default configuration. +InfluxDB™ Core can be configured via environment variables or using CLI flags. If a configuration option is not specified in either CLI flags or in an environment variable, InfluxDB™ Core uses its internal default configuration. ### Environment variables @@ -174,13 +174,15 @@ InfluxDB (TM) can be configured via environment variables or using a configurati | `INFLUXDB_META_DIR` | InfluxDB directory where metadata is stored. | `${INFLUXDB_VOLUME_DIR}/meta` | | `INFLUXDB_CONF_FILE_FORMAT` | InfluxDB configuration file format, supported formats: yaml, yml, toml, json | `yaml` | | `INFLUXD_CONFIG_PATH` | InfluxDB 2.x alias for configuration file path. | `${INFLUXDB_CONF_DIR}` | -| `INFLUXDB_REPORTING_DISABLED` | Whether to disable InfluxDB reporting. | `true` | -| `INFLUXDB_HTTP_PORT_NUMBER` | Port number used by InfluxDB HTTP server. | `8086` | +| `INFLUXDB_HTTP_PORT_NUMBER` | Port number used by InfluxDB HTTP server. | `8181` | | `INFLUXDB_HTTP_BIND_ADDRESS` | InfluxDB HTTP bind address. | `0.0.0.0:${INFLUXDB_HTTP_PORT_NUMBER}` | -| `INFLUXDB_HTTP_READINESS_TIMEOUT` | InfluxDB HTTP port readiness timeout in seconds. | `60` | +| `INFLUXDB_REPORTING_DISABLED` | Whether to disable InfluxDB reporting. | `true` | | `INFLUXDB_PORT_NUMBER` | Port number used by InfluxDB. | `8088` | | `INFLUXDB_BIND_ADDRESS` | InfluxDB bind address. | `0.0.0.0:${INFLUXDB_PORT_NUMBER}` | +| `INFLUXDB_HTTP_READINESS_TIMEOUT` | InfluxDB HTTP port readiness timeout in seconds. | `60` | | `INFLUXDB_PORT_READINESS_TIMEOUT` | InfluxDB port readiness timeout in seconds. | `30` | +| `INFLUXDB_NODE_ID` | InfluxDB node identifier used as a prefix in all object store file paths. | `nil` | +| `INFLUXDB_OBJECT_STORE` | InfluxDB object storage to use to store Parquet files. | `file` | | `INFLUXDB_INIT_MODE` | InfluxDB init mode. | `setup` | | `INFLUXDB_INIT_V1_DIR` | Path to InfluxDB 1.x data to be imported into 2.x format | `${BITNAMI_VOLUME_DIR}/v1` | | `INFLUXDB_INIT_V1_CONFIG` | Path to InfluxDB 1.x config file | `${BITNAMI_VOLUME_DIR}/v1/config.yaml` | @@ -204,6 +206,9 @@ InfluxDB (TM) can be configured via environment variables or using a configurati | `INFLUXDB_WRITE_USER` | Additional InfluxDB username with write privileges. | `nil` | | `INFLUXDB_WRITE_USER_PASSWORD` | Additional InfluxDB user with write privileges. | `nil` | | `INFLUXDB_DB` | InfluxDB database name. | `nil` | +| `INFLUXDB_CREATE_ADMIN_TOKEN` | Whether to create admin token during initialization. | `no` | +| `INFLUXDB_ADMIN_TOKEN` | InfluxDB admin token. | `nil` | +| `INFLUXDB_DATABASES` | Comma or semicolon separated list of databases to be created during initialization. | `nil` | #### Read-only environment variables @@ -222,49 +227,22 @@ InfluxDB (TM) can be configured via environment variables or using a configurati | `INFLUXDB_DAEMON_USER` | InfluxDB system user. | `influxdb` | | `INFLUXDB_DAEMON_GROUP` | InfluxDB system group. | `influxdb` | -Additionally, InfluxDB (TM) can be configured using its internal environment variables prefixed by `INFLUXD_`, find more information [here](https://docs.influxdata.com/influxdb/v2.0/reference/config-options). +Additionally, InfluxDB™ Core can be configured using its internal environment variables prefixed by `INFLUXDB3_`, find more information [here](https://docs.influxdata.com/influxdb3/core/reference/config-options). -> Note: The settings at the environment variables override the equivalent options in the configuration file." - -### Configuration file - -The configuration can easily be setup by mounting your own configuration file (`config.yaml`) on the directory `/opt/bitnami/influxdb/etc/`: - -```console -docker run --name influxdb \ - --volume /path/to/config.yaml:/opt/bitnami/influxdb/etc/config.yaml:ro \ - bitnami/influxdb:latest -``` - -or using Docker Compose: - -```yaml -version: '2' - -services: - influxdb: - image: bitnami/influxdb:latest - volumes: - - /path/to/config.yaml:/opt/bitnami/influxdb/etc/config.yaml:ro -``` +> Note: The settings at the environment variables override the equivalent options in the configuration file. ### Initializing a new instance -When the container is executed for the first time, it will execute the files with extensions `.sh`, and `.txt` located at `/docker-entrypoint-initdb.d`. +When the container is executed for the first time, it will execute the files with extensions `.sh` located at `/docker-entrypoint-initdb.d`. In order to have your custom files inside the docker image you can mount them as a volume. -### Setting the admin password on first run +### Setting the admin token on first run -The admin user and password can easily be setup with the Bitnami InfluxDB (TM) Docker image using the following environment variables: - -* `INFLUXDB_ADMIN_USER`: The database admin user. Defaults to `admin`. -* `INFLUXDB_ADMIN_USER_PASSWORD`: The database admin user password. No defaults. - -Passing the `INFLUXDB_ADMIN_USER_PASSWORD` environment variable when running the image for the first time will set the password of the `INFLUXDB_ADMIN_USER` user to the value of `INFLUXDB_ADMIN_USER_PASSWORD`. +The admin token can easily be setup with the Bitnami InfluxDB™ Core Docker image setting the environment variable `INFLUXDB_CREATE_ADMIN_TOKEN` to `yes`. ```console -docker run --name influxdb -e INFLUXDB_ADMIN_USER_PASSWORD=password123 bitnami/influxdb:latest +docker run --name influxdb -e INFLUXDB_CREATE_ADMIN_TOKEN=yes bitnami/influxdb:latest ``` or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/influxdb/docker-compose.yml) file present in this repository: @@ -274,144 +252,24 @@ services: influxdb: ... environment: - - INFLUXDB_ADMIN_USER_PASSWORD=password123 + - INFLUXDB_CREATE_ADMIN_TOKEN=yes ... ``` -**Warning** In case you want to allow users to access the database without credentials, set the environment variable `INFLUXDB_HTTP_AUTH_ENABLED=false`. **This is recommended only for development**. If you are using InfluxDB (TM) v2 authentication is required and `INFLUXDB_HTTP_AUTH_ENABLED` will be ignored. +### Creating databases during initialization -### Allowing empty passwords - -By default the InfluxDB (TM) image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the `INFLUXDB_HTTP_AUTH_ENABLED=false` env variable. This env variable is only recommended for testing or development purposes. We strongly recommend specifying the `INFLUXDB_ADMIN_USER_PASSWORD` for any other scenario. If you are using InfluxDB (TM) v2, authentication is required and `INFLUXDB_HTTP_AUTH_ENABLED` will be ignored. - -```console -docker run --name influxdb --env INFLUXDB_HTTP_AUTH_ENABLED=false bitnami/influxdb:latest -``` - -or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/influxdb/docker-compose.yml) file present in this repository: - -```yaml -services: - influxdb: - ... - environment: - - INFLUXDB_HTTP_AUTH_ENABLED=false - ... -``` - -### Creating a database on first run - -For InfluxDB (TM) v2 you can pass `INFLUXDB_USER_BUCKET` environment variable when running the image for the first time, a new bucket will be created. This is useful if your application requires that a bucket already exists, saving you from having to manually create the bucket using the InfluxDB (TM) CLI. +You can use the `INFLUXDB_DATABASES` environment variable to specify a comma separated list of databases to created during the container initialization. This is useful if your application requires databases ready to be consumed, saving you from having to manually create them using the InfluxDB™ Core CLI. ```console docker run --name influxdb \ - -e INFLUXDB_ADMIN_USER_PASSWORD=password123 \ - -e INFLUXDB_USER_BUCKET=my_bucket \ + -e INFLUXDB_CREATE_ADMIN_TOKEN=yes \ + -e INFLUXDB_DATABASES=foo,bar \ bitnami/influxdb:latest ``` -### Creating a database user on first run - -You can create a restricted database user that only has permissions for the database created with the [`INFLUXDB_DB`](#creating-a-database-on-first-run) environment variable. To do this, provide the `INFLUXDB_USER` environment variable and to set a password for the database user provide the `INFLUXDB_USER_PASSWORD` variable. - -```console -docker run --name influxdb \ - -e INFLUXDB_ADMIN_USER_PASSWORD=password123 \ - -e INFLUXDB_USER=my_user \ - -e INFLUXDB_USER_PASSWORD=my_password \ - -e INFLUXDB_DB=my_database \ - bitnami/influxdb:latest -``` - -or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/influxdb/docker-compose.yml) file present in this repository: - -```yaml -services: - influxdb: - ... - environment: - - INFLUXDB_ADMIN_USER_PASSWORD=password123 - - INFLUXDB_USER=my_user - - INFLUXDB_USER_PASSWORD=my_password - - INFLUXDB_DB=my_database - ... -``` - -You can also create users with restricted privileges in the database in a very similar way. To do so, user the environment variables below: - -* `INFLUXDB_READ_USER`: Specify the user with "read" privileges in the database. -* `INFLUXDB_READ_USER_PASSWORD`: Specify the password of the `INFLUXDB_READ_USER` user. -* `INFLUXDB_WRITE_USER`: Specify the user with "write" privileges in the database. -* `INFLUXDB_WRITE_USER_PASSWORD`: Specify the password of the `INFLUXDB_WRITE_USER` user. - -### Customize the HTTP port readiness - -You can modify the timeout for the HTTP port readiness probe where the container waits until the HTTP port is actually ready to receive queries before finish the setup. Use `INFLUXDB_HTTP_READINESS_TIMEOUT` to do this. - -```console -docker run --name influxdb \ - -e INFLUXDB_ADMIN_USER_PASSWORD=password123 \ - -e INFLUXDB_USER=my_user \ - -e INFLUXDB_USER_PASSWORD=my_password \ - -e INFLUXDB_DB=my_database \ - -e INFLUXDB_HTTP_READINESS_TIMEOUT=30 \ - bitnami/influxdb:latest -``` - -or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/influxdb/docker-compose.yml) file present in this repository: - -```yaml -services: - influxdb: - ... - environment: - - INFLUXDB_ADMIN_USER_PASSWORD=password123 - - INFLUXDB_USER=my_user - - INFLUXDB_USER_PASSWORD=my_password - - INFLUXDB_DB=my_database - - INFLUXDB_HTTP_READINESS_TIMEOUT=30 - ... -``` - -* `INFLUXDB_HTTP_READINESS_TIMEOUT`: Spacify the time to wait until the HTTP endpoint is ready in seconds. Default: 60 - -### Migrate InfluxDB 1.x data into 2.x format - -You can migrate your InfluxDB 1.x data into 2.x format by setting `INFLUXDB_INIT_MODE=upgrade`, and mounting the InfluxDB 1.x data into the container (let the initialization logic know where it is located with the `INFLUXDB_INIT_V1_DIR` variable). Do not point `INFLUXDB_INIT_V1_DIR` into `INFLUXDB_VOLUME_DIR` (default: `/bitnami/influxdb`), or the upgrade process will fail. - -```console -docker run --name influxdb \ - -e INFLUXDB_ADMIN_USER_PASSWORD=password123 \ - -e INFLUXDB_USER=my_user \ - -e INFLUXDB_USER_PASSWORD=my_password \ - -e INFLUXDB_DB=my_database \ - -e INFLUXDB_INIT_MODE=upgrade \ - -e INFLUXDB_INIT_V1_DIR=/bitnami/v1 \ - bitnami/influxdb:latest -``` - -or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/influxdb/docker-compose.yml) file present in this repository: - -```yaml -services: - influxdb: - ... - environment: - - INFLUXDB_ADMIN_USER_PASSWORD=password123 - - INFLUXDB_USER=my_user - - INFLUXDB_USER_PASSWORD=my_password - - INFLUXDB_DB=my_database - - INFLUXDB_INIT_MODE=upgrade - - INFLUXDB_INIT_V1_DIR=/bitnami/v1 - ... -``` - -* `INFLUXDB_INIT_MODE`: InfluxDB init mode. `['setup', 'upgrade']`. Default: `setup`. -* `INFLUXDB_INIT_V1_DIR`: Path to InfluxDB 1.x data to be imported into 2.x format. Default: `${BITNAMI_VOLUME_DIR}/v1`. - ## Logging -The Bitnami InfluxDB (TM) Docker image sends the container logs to `stdout`. To view the logs: +The Bitnami InfluxDB™ Core Docker image sends the container logs to `stdout`. To view the logs: ```console docker logs influxdb @@ -423,7 +281,7 @@ You can configure the containers [logging driver](https://docs.docker.com/engine ### Upgrade this image -Bitnami provides up-to-date versions of InfluxDB (TM), including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. +Bitnami provides up-to-date versions of InfluxDB™ Core, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. #### Step 1: Get the updated image @@ -509,4 +367,4 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -InfluxDB (TM) is a trademark owned by InfluxData, which is not affiliated with, and does not endorse, this product. +InfluxDB™ Core is a trademark owned by InfluxData, which is not affiliated with, and does not endorse, this product. diff --git a/bitnami/influxdb/docker-compose.yml b/bitnami/influxdb/docker-compose.yml index d41d0c09421f..de923b1167a2 100644 --- a/bitnami/influxdb/docker-compose.yml +++ b/bitnami/influxdb/docker-compose.yml @@ -3,13 +3,11 @@ services: influxdb: - image: docker.io/bitnami/influxdb:2 + image: docker.io/bitnami/influxdb:3 ports: - - 8086:8086 - - 8088:8088 + - 8181:8181 environment: - - INFLUXDB_ADMIN_USER_PASSWORD=bitnami123 - - INFLUXDB_ADMIN_USER_TOKEN=admintoken123 + - INFLUXDB_NODE_ID=0 volumes: - influxdb_data:/bitnami/influxdb volumes: