From 80b52db29537ef68284834ec34c8413802d3479b Mon Sep 17 00:00:00 2001 From: Krakinou Date: Sat, 26 Nov 2022 16:25:43 +0100 Subject: [PATCH] Add swap file --- scripts/_common.sh | 95 +++++++++++++++++++++++++++++++++++++++++++++- scripts/install | 29 ++++++++++++++ scripts/upgrade | 31 ++++++++++++++- 3 files changed, 153 insertions(+), 2 deletions(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index 0a02cf0..21222da 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -3,7 +3,7 @@ #================================================= # COMMON VARIABLES #================================================= -# dependencies used by the app (must be on a single line) +MEMORY_NEEDED="10240" NODEJS_VERSION=18 #================================================= @@ -14,6 +14,99 @@ NODEJS_VERSION=18 # EXPERIMENTAL HELPERS #================================================= +# Add swap +# +# usage: ynh_add_swap --size=SWAP in Mb +# | arg: -s, --size= - Amount of SWAP to add in Mb. +ynh_add_swap () { + # Declare an array to define the options of this helper. + declare -Ar args_array=( [s]=size= ) + local size + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + + local swap_max_size=$(( $size * 1024 )) + + local free_space=$(df --output=avail / | sed 1d) + # Because we don't want to fill the disk with a swap file, divide by 2 the available space. + local usable_space=$(( $free_space / 2 )) + + SD_CARD_CAN_SWAP=${SD_CARD_CAN_SWAP:-0} + + # Swap on SD card only if it's is specified + if ynh_is_main_device_a_sd_card && [ "$SD_CARD_CAN_SWAP" == "0" ] + then + ynh_print_warn --message="The main mountpoint of your system '/' is on an SD card, swap will not be added to prevent some damage of this one, but that can cause troubles for the app $app. If you still want activate the swap, you can relaunch the command preceded by 'SD_CARD_CAN_SWAP=1'" + return + fi + + # Compare the available space with the size of the swap. + # And set a acceptable size from the request + if [ $usable_space -ge $swap_max_size ] + then + local swap_size=$swap_max_size + elif [ $usable_space -ge $(( $swap_max_size / 2 )) ] + then + local swap_size=$(( $swap_max_size / 2 )) + elif [ $usable_space -ge $(( $swap_max_size / 3 )) ] + then + local swap_size=$(( $swap_max_size / 3 )) + elif [ $usable_space -ge $(( $swap_max_size / 4 )) ] + then + local swap_size=$(( $swap_max_size / 4 )) + else + echo "Not enough space left for a swap file" >&2 + local swap_size=0 + fi + + # If there's enough space for a swap, and no existing swap here + if [ $swap_size -ne 0 ] && [ ! -e /swap_$app ] + then + # Preallocate space for the swap file, fallocate may sometime not be used, use dd instead in this case + if ! fallocate -l ${swap_size}K /swap_$app + then + dd if=/dev/zero of=/swap_$app bs=1024 count=${swap_size} + fi + chmod 0600 /swap_$app + # Create the swap + mkswap /swap_$app + # And activate it + swapon /swap_$app + # Then add an entry in fstab to load this swap at each boot. + echo -e "/swap_$app swap swap defaults 0 0 #Swap added by $app" >> /etc/fstab + fi +} + +ynh_del_swap () { + # If there a swap at this place + if [ -e /swap_$app ] + then + # Clean the fstab + sed -i "/#Swap added by $app/d" /etc/fstab + # Desactive the swap file + swapoff /swap_$app + # And remove it + rm /swap_$app + fi +} + +# Check if the device of the main mountpoint "/" is an SD card +# +# [internal] +# +# return 0 if it's an SD card, else 1 +ynh_is_main_device_a_sd_card () { + local main_device=$(lsblk --output PKNAME --noheadings $(findmnt / --nofsroot --uniq --output source --noheadings --first-only)) + + if echo $main_device | grep --quiet "mmc" && [ $(tail -n1 /sys/block/$main_device/queue/rotational) == "0" ] + then + return 0 + e +lse + return 1 + fi +} + #================================================= # FUTURE OFFICIAL HELPERS #================================================= \ No newline at end of file diff --git a/scripts/install b/scripts/install index 993fc81..f07f112 100755 --- a/scripts/install +++ b/scripts/install @@ -48,6 +48,24 @@ ynh_script_progression --message="Storing installation settings..." --weight=1 ynh_app_setting_set --app=$app --key=domain --value=$domain ynh_app_setting_set --app=$app --key=path --value=$path_url +#================================================= +# ADD SWAP IF NEEDED +#================================================= +#https://github.com/zwave-js/zwave-js-ui/issues/2699 +ynh_script_progression --message="Adding swap if needed for compiling..." + +total_memory=$(ynh_get_ram --total) +swap_needed=0 + +if [ $total_memory -lt $MEMORY_NEEDED ]; then + # Need a minimum of 2Go of memory + swap_needed=$(($MEMORY_NEEDED - $total_memory)) + ynh_script_progression --message="Adding $swap_needed Mo to swap..." + SD_CARD_CAN_SWAP=1 + ynh_add_swap --size=$swap_needed + +fi + #================================================= # STANDARD MODIFICATIONS #================================================= @@ -100,6 +118,10 @@ pushd "$final_path" ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn plugin import workspace-tools ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn workspaces focus --production ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn install --network-timeout 1000000000 + #On slow/low memory system, yarn silently fails with a 0 return code and nothing seems to be doable about that so far. + #relaunching yarn install seems to do the trick for raspberry at least as it resumes from where it fails + #https://github.com/yarnpkg/berry/issues/3996 + #https://github.com/yarnpkg/berry/issues/5065 ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn install --network-timeout 1000000000 ynh_script_progression --message="Cleaning cache... " --weight=3 ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn cache clean 2>&1 @@ -114,7 +136,14 @@ chmod -R o-rwx "$final_path" chown -R $app: "$final_path" +#================================================= +# REMOVE ADDITIONNAL SWAP +#================================================= +ynh_script_progression --message="Remove additionnal swap..." --weight=2 +if [ $swap_needed > 0 ]; then + ynh_del_swap +fi #================================================= # NGINX CONFIGURATION #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index dbb3735..3009b88 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -55,7 +55,22 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app #================================================= #ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -# +#================================================= +# ADD SWAP IF NEEDED +#================================================= +#https://github.com/zwave-js/zwave-js-ui/issues/2699 +ynh_script_progression --message="Adding swap if needed for compiling..." + +total_memory=$(ynh_get_ram --total) +swap_needed=0 + +if [ $total_memory -lt $MEMORY_NEEDED ]; then + # Need a minimum of 2Go of memory + swap_needed=$(($MEMORY_NEEDED - $total_memory)) + ynh_script_progression --message="Adding $swap_needed Mo to swap..." + SD_CARD_CAN_SWAP=1 + ynh_add_swap --size=$swap_needed +fi #================================================= # CREATE DEDICATED USER @@ -95,6 +110,10 @@ then ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn plugin import workspace-tools ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn workspaces focus --production ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn install --network-timeout 1000000000 + #On slow/low memory system, yarn silently fails with a 0 return code and nothing seems to be doable about that so far. + #relaunching yarn install seems to do the trick for raspberry at least as it resumes from where it fails + #https://github.com/yarnpkg/berry/issues/3996 + #https://github.com/yarnpkg/berry/issues/5065 ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn install --network-timeout 1000000000 ynh_script_progression --message="Cleaning cache... " --weight=3 ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn cache clean 2>&1 @@ -110,6 +129,16 @@ then fi +#================================================= +# REMOVE ADDITIONNAL SWAP +#================================================= +ynh_script_progression --message="Remove additionnal swap..." --weight=2 + +if [ $swap_needed > 0 ]; then + ynh_del_swap +fi + + #================================================= # NGINX CONFIGURATION #=================================================