Framework Guides on Bash Tools Framework Documentation

Configuration Files

Sun, 01 Mar 2026 08:00:00 +0100

1. Config file format and loading rules

Configuration files loading is following these rules or best practices:

all env files are now loaded as properties file, it means bash arrays cannot be declared Eg: arrays should be converted to a string list separated by colon, and has to converted when needed.
All .env files have the ability to override value by env variable
all variables have to be written on one line, it is not possible to cut lines over multiple line
First variable set takes precedence, so writing following file would result to VAR1=value1

VAR1=value1
VAR1=value2

2. Config file overloading values

Best practice is to override variables only by
- command argument –bash-framework-config to allow loading alternate env before other default files
- command argument (–verbose, …) allows to override default displayed log level
- in env files, always allow value to be overridden by prioritized variables
  - using bash variable default value mechanism, in following example, BASH_FRAMEWORK_LOG_LEVEL will be equal to 0 only if it hasn’t been set previously

BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}"

Provide –config argument to see resulting config file + information about order of loaded config files for debugging purpose.

Docker Namespace

Sun, 01 Mar 2026 08:00:00 +0100

Usage example: try to pull image from 3 tags in order (from more specific or recent to the less one)

# try to pull image from 3 tags in order (from more specific or recent to the less one)
args=(
 'id.dkr.ecr.eu-west-1.amazonaws.com/bash-tools:d93e03d5ab9e127647f575855f605bd189ca8a56'
 'id.dkr.ecr.eu-west-1.amazonaws.com/bash-tools:branchName'
 'id.dkr.ecr.eu-west-1.amazonaws.com/bash-tools:master'
)
digestPulled="$(Docker::pullImage "${args[@]}")"

# build the image using eventual image pulled as cache
# image will be tagged bash-tools:latest upon successful build
args=(
 "." ".docker/Dockerfile" "bash-tools"
 # it's important to not double quote following instruction
 $(Docker::getBuildCacheFromArg ${digestPulled})
 # you can add any additional docker build arg as needed
 --build-arg USER_ID="$(id -u)"
 --build-arg GROUP_ID="$(id -g)"
)
Docker::buildImage "${args[@]}"

# tag the image with a remote tag
args=(
 "id.dkr.ecr.eu-west-1.amazonaws.com/bash-tools"
 "bash-tools:latest"
 # tags list
 "branchName" "d93e03d5ab9e127647f575855f605bd189ca8a56"
)
Docker::tagImage "${args[@]}"

# finally push the image
args=(
 "id.dkr.ecr.eu-west-1.amazonaws.com/bash-tools"
 "bash-tools:latest"
 # tags list
 "branchName" "d93e03d5ab9e127647f575855f605bd189ca8a56"
)
Docker::pushImage "${args[@]}"

Best Practices

Sun, 01 Mar 2026 08:00:00 +0100

DISCLAIMER: Some of the best practices mentioned are not fully applied in this project as they were written during development.

1. Framework-Specific Recommendations

1.1. Using @embed Keyword

The @embed keyword is really useful to inline configuration files. However, to run framework functions using sudo, it is recommended to call the same binary but passing options to change the behavior. This way the content of the script file does not seem to be obfuscated.