Skip to content

Commit

Permalink
Remove ENV variables from Dockerfile
Browse files Browse the repository at this point in the history
  • Loading branch information
@Minituff
Minituff committed Oct 23, 2023
1 parent d9048f9 commit c03fe11
Show file tree
Hide file tree
Showing 5 changed files with 292 additions and 175 deletions.
37 changes: 0 additions & 37 deletions Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,42 +40,5 @@ RUN mv app/entry.sh /entry.sh
ARG NAUTICAL_VERSION="main"
ENV NAUTICAL_VERSION=${NAUTICAL_VERSION}

# Set default timezone
ENV TZ=Etc/UTC

# Default = Every day at 4am
ENV CRON_SCHEDULE="0 4 * * *"

# Default enable the report file
ENV REPORT_FILE="true"

# Run the backup immediately on start
ENV BACKUP_ON_START="false"

# Use the default rsync args "-raq" (recursive, archive, quiet)
ENV USE_DEFAULT_RSYNC_ARGS="true"

# Apply custom rsync args (in addition to the default args)
ENV RSYNC_CUSTOM_ARGS=""

# Require the Docker Label `nautical-backup.enable=true` to be present on each contianer or it will be skipped.
ENV REQUIRE_LABEL="false"

# Set the default log level to INFO
ENV LOG_LEVEL="INFO"

# Set the default log level for the repot file to INFO
ENV REPORT_FILE_LOG_LEVEL="INFO"

# Only write to the report file when backups run, not on initialization
ENV REPORT_FILE_ON_BACKUP_ONLY="true"

# Mirrior the source directory name to the destination directory name
# When true, and an source dir override is applied, then the destination directory will be same same as the new source directory
ENV KEEP_SRC_DIR_NAME="true"

# Usually combined with BACKUP_ON_START. Essentially, this just exists the container after 1 run.
ENV EXIT_AFTER_INIT="false"

# Run the entry script and pass all variables to it
ENTRYPOINT [ "bash", "-c", "exec ./entry.sh \"${@}\"", "--"]
152 changes: 18 additions & 134 deletions pkg/entry.sh
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
#!/bin/bash
source /app/logger.sh # Use the logger script

create_new_report_file

logThis "Nautical Backup Version: $NAUTICAL_VERSION" "INFO" "init"
logThis "Built for the platform: $TARGETPLATFORM" "DEBUG" "init"
logThis "Using log level: $LOG_LEVEL" "DEBUG" "init"
if [ "$TEST_MODE" == "true" ]; then
echo "Running in test mode"
source "$(dirname $0)"/logger.sh # Use the logger script
source "$(dirname $0)"/utils.sh
source "$(dirname $0)"/env.sh
else
source /app/logger.sh # Use the logger script
source /app/utils.sh
source app/env.sh
fi

# Echo the CRON schedule for logging/debugging
logThis "Installing CRON schedule: $CRON_SCHEDULE in TZ: $TZ" "DEBUG" "init"
Expand All @@ -19,143 +23,23 @@ sed -i '/\/app\/backup.sh/d' tempcron
# Add the new cron job to the file
echo "$CRON_SCHEDULE bash /app/backup.sh" >>tempcron

# Install the new cron jobs
crontab tempcron
rm tempcron

# Variables
export SOURCE_LOCATION=/app/source # Do not include a trailing slash
export DEST_LOCATION=/app/destination # Do not include a trailing slash

logThis "Verifying source directory..." "DEBUG" "init"
if [ ! -d "$SOURCE_LOCATION" ]; then
logThis "Error: Source directory $SOURCE_LOCATION does not exist." "ERROR" "init"
exit 1
elif [ ! -r "$SOURCE_LOCATION" ]; then
logThis "Error: No read access to source directory $SOURCE_LOCATION." "ERROR" "init"
exit 1
fi

logThis "Verifying destination directory..." "DEBUG" "init"
if [ ! -d "$DEST_LOCATION" ]; then
logThis "Error: Destination directory $DEST_LOCATION does not exist." "ERROR" "init"
exit 1
elif [ ! -r "$DEST_LOCATION" ]; then
logThis "Error: No read access to destination directory $DEST_LOCATION." "ERROR" "init"
exit 1
elif [ ! -w "$DEST_LOCATION" ]; then
logThis "Error: No write access to destination directory $DEST_LOCATION." "ERROR" "init"
exit 1
fi

CONTAINER_SKIP_LIST=() # Containers to skips

# Function to populate the skip list array
process_csv() {
local -n skip_list_ref=$1 # Use nameref to update the array passed as argument
local skip_var=$2 # The environment variable containing the skip list

if [ ! -z "$skip_var" ]; then
# Remove quotes and leading/trailing whitespaces
local cleaned_skip_var=$(echo "$skip_var" | sed "s/'//g;s/\"//g" | tr -d ' ')

# Split by commas into an array
IFS=',' read -ra ADDITIONAL_SKIPS <<<"$cleaned_skip_var"

# Add to the existing skip list
skip_list_ref=("${skip_list_ref[@]}" "${ADDITIONAL_SKIPS[@]}")
fi
}

# Declare the CONTAINER_SKIP_LIST array
CONTAINER_SKIP_LIST=()
SKIP_STOPPING_LIST=()

# Populate the skip list
process_csv CONTAINER_SKIP_LIST "$SKIP_CONTAINERS"
process_csv SKIP_STOPPING_LIST "$SKIP_STOPPING"

if [ ! -z "$SKIP_CONTAINERS" ]; then
logThis "SKIP_CONTAINERS: ${CONTAINER_SKIP_LIST[@]}" "DEBUG" "init"
fi

if [ ! -z "$SKIP_STOPPING" ]; then
logThis "SKIP_STOPPING: ${SKIP_STOPPING_LIST[@]}" "DEBUG" "init"
fi

# Get the container ID of the current container
export SELF_CONTAINER_ID=$(cat /proc/self/cgroup | grep 'docker' | sed 's/^.*\///' | tail -n1)
# Add the self container ID to the default skips
CONTAINER_SKIP_LIST+=("$SELF_CONTAINER_ID")

CONTAINER_SKIP_LIST_STR=$(
IFS=,
echo "${CONTAINER_SKIP_LIST[*]}"
) # Convert the array to a string
export CONTAINER_SKIP_LIST_STR # Export the string
# Install the new cron jobs and remove the tempcron file
crontab tempcron && rm tempcron

SKIP_STOPPING_STR=$(
IFS=,
echo "${SKIP_STOPPING[*]}"
) # Convert the array to a string
export SKIP_STOPPING_STR # Export the string

# Assuming OVERRIDE_SOURCE_DIR is passed as an environment variable in the format "container1:dir1,container2:dir2,..."
if [ ! -z "$OVERRIDE_SOURCE_DIR" ]; then
logThis "OVERRIDE_SOURCE_DIR: ${OVERRIDE_SOURCE_DIR}" "DEBUG" "init"
fi
export OVERRIDE_SOURCE_DIR

# Assuming OVERRIDE_DEST_DIR is passed as an environment variable in the format "container1:dir1,container2:dir2,..."
if [ ! -z "$OVERRIDE_DEST_DIR" ]; then
logThis "OVERRIDE_DEST_DIR: ${OVERRIDE_DEST_DIR}" "DEBUG" "init"
fi
export OVERRIDE_DEST_DIR

if [ ! -z "$REPORT_FILE" ]; then
logThis "REPORT_FILE: $REPORT_FILE" "DEBUG" "init"
fi

# Set rsync custom arguments if specified
if [ ! -z "$RSYNC_CUSTOM_ARGS" ]; then
logThis "RSYNC_CUSTOM_ARGS: $RSYNC_CUSTOM_ARGS" "DEBUG" "init"
fi

if [ ! -z "$LOG_RSYNC_COMMANDS" ]; then
logThis "LOG_RSYNC_COMMANDS: $LOG_RSYNC_COMMANDS" "DEBUG" "init"
fi

if [ ! -z "$USE_DEFAULT_RSYNC_ARGS" ]; then
logThis "USE_DEFAULT_RSYNC_ARGS: $USE_DEFAULT_RSYNC_ARGS" "DEBUG" "init"
fi

if [ ! -z "$REQUIRE_LABEL" ]; then
logThis "REQUIRE_LABEL: $REQUIRE_LABEL" "DEBUG" "init"
fi

if [ ! -z "$KEEP_SRC_DIR_NAME" ]; then
logThis "KEEP_SRC_DIR_NAME: $KEEP_SRC_DIR_NAME" "DEBUG" "init"
fi

if [ ! -z "$LOG_LEVEL" ]; then
logThis "LOG_LEVEL: $LOG_LEVEL" "DEBUG" "init"
fi

if [ ! -z "$REPORT_FILE_LOG_LEVEL" ]; then
logThis "REPORT_FILE_LOG_LEVEL: $REPORT_FILE_LOG_LEVEL" "DEBUG" "init"
fi
# Verify the source and destination locations
verify_source_location $SOURCE_LOCATION
verify_destination_location $DEST_LOCATION

if [ "$BACKUP_ON_START" = "true" ]; then
logThis "BACKUP_ON_START: $BACKUP_ON_START" "DEBUG" "init"
echo "Starting backup since BACKUP_ON_START is true" "INFO" "init"
bash ./app/backup.sh
fi

if [ "$EXIT_AFTER_INIT" = "true" ]; then
logThis "EXIT_AFTER_INIT: $EXIT_AFTER_INIT" "DEBUG" "init"
echo "Exiting since EXIT_AFTER_INITis true" "INFO" "init"
exit 0
fi

logThis "Initialization complete. Awaiting CRON schedule: $CRON_SCHEDULE" "INFO" "init"

# Start cron and keep container running
/usr/sbin/crond -f -l 8
/usr/sbin/crond -f -l 8 # Start cron and keep container running
Loading

0 comments on commit c03fe11

Please sign in to comment.