Skip to content

USHIFT-979: Sanitize the values of wait timeout and max boots from greenboot.conf #1526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-robot merged 1 commit into from
Mar 19, 2023
Merged

USHIFT-979: Sanitize the values of wait timeout and max boots from greenboot.conf #1526

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions packaging/greenboot/functions.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,38 @@ OCGET_CMD="oc get ${OCCONFIG_OPT}"
#
# The base value for the timeout and the maximum boot attempts can be defined in
# the /etc/greenboot/greenboot.conf file using the MICROSHIFT_WAIT_TIMEOUT_SEC
# and GREENBOOT_MAX_BOOTS settings.
# and GREENBOOT_MAX_BOOTS settings. These values can be in the [60..9999] range
# for MICROSHIFT_WAIT_TIMEOUT_SEC and the [1..9] range for GREENBOOT_MAX_BOOTS.
#
# args: None
# return: Print the recommended timeout value to stdout
function get_wait_timeout() {
# Source Greenboot configuration file if it exists
local conf_file=/etc/greenboot/greenboot.conf
[ -f "${conf_file}" ] && source ${conf_file}

# Read and verify the wait timeout value, allowing for the [60..9999] range
local base_timeout=${MICROSHIFT_WAIT_TIMEOUT_SEC:-300}
local reSecs='^[1-9]{1}[0-9]{0,3}$'
if [[ ! ${base_timeout} =~ $reSecs ]] ; then
base_timeout=300
echo "Could not parse MICROSHIFT_WAIT_TIMEOUT_SEC value '${MICROSHIFT_WAIT_TIMEOUT_SEC}': using '${base_timeout}' instead"
fi
if [[ ${base_timeout} -lt 60 ]] ; then
base_timeout=60
echo "MICROSHIFT_WAIT_TIMEOUT_SEC value '${MICROSHIFT_WAIT_TIMEOUT_SEC}' is less than 60: using '${base_timeout}' instead"
fi

# Read and verify the max boots value, allowing for the [1..9] range
local max_boots=${GREENBOOT_MAX_BOOTS:-3}
local reBoots='^[1-9]{1}$'
if [[ ! ${max_boots} =~ $reBoots ]] ; then
max_boots=3
echo "GREENBOOT_MAX_BOOTS value '${GREENBOOT_MAX_BOOTS}' is not in the [1..9] range: using '${max_boots}' instead"
fi

# Update the wait timeout according to the boot counter.
# The new wait timeout is a product of the timeout base and the number of boot attempts.
local max_boots=${GREENBOOT_MAX_BOOTS:-3}
local boot_counter=$(grub2-editenv - list | grep ^boot_counter= | awk -F= '{print $2}')
[ -z "${boot_counter}" ] && boot_counter=$(( $max_boots - 1 ))

Expand Down