From 1e9663438eb0dd3535ced7086547a0da62bdaad2 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 11 Aug 2019 00:20:48 +0200 Subject: [PATCH 1/4] managing swap --- scripts/install | 27 ++++++++----- scripts/remove | 7 ++++ scripts/ynh_add_swap | 93 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 117 insertions(+), 10 deletions(-) create mode 100644 scripts/ynh_add_swap diff --git a/scripts/install b/scripts/install index 5bc5c23..daa4153 100644 --- a/scripts/install +++ b/scripts/install @@ -10,6 +10,7 @@ source _common.sh source ynh_install_ruby source ynh_add_extra_apt_repos__3 source ynh_send_readme_to_admin__2 +source ynh_add_swap source /usr/share/yunohost/helpers #================================================= @@ -44,16 +45,6 @@ ynh_script_progression --message="Validating installation parameters..." --weigh final_path=/var/www/$app test ! -e "$final_path" || ynh_die --message="This path already contains a folder" -if [ ${PACKAGE_CHECK_EXEC:-0} -eq 1 ]; then - # TODO : to be factorized into a helper someday ? ;) - MEM=$(free | grep "^Mem" | awk '{print $2}') - SWAP=$(free | grep "^Swap" | awk '{print $2}') - TOTAL_MEM_AND_SWAP=$(( ( $MEM+$SWAP ) / 1024 )) # In MB - - [[ $TOTAL_MEM_AND_SWAP -gt 2500 ]] || ynh_die "You need at least 2500 Mo of RAM+Swap to install Mastodon. Please consult the README to learn how to add swap." - -fi - # Register (book) web path ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url @@ -133,6 +124,22 @@ ynh_system_user_create --username=$app --home_dir=$final_path #================================================= # SPECIFIC SETUP +#================================================= +# ADD SWAP IF NEEDED +#================================================= + +total_memory=$(ynh_check_ram) +total_swap=$(ynh_check_ram --only_swap) +swap_needed=0 + +if [ $total_memory -lt 2560 ]; then + # Need a minimum of 8Go of memory + swap_needed=$((2560 - $total_memory)) +fi + +ynh_script_progression --message="Adding $swap_needed Mo to swap..." --weight=1 +ynh_add_swap --size=$swap_needed + #================================================= # INSTALLING RUBY AND BUNDLER #================================================= diff --git a/scripts/remove b/scripts/remove index 19cbf29..a08afb7 100644 --- a/scripts/remove +++ b/scripts/remove @@ -9,6 +9,7 @@ source _common.sh source ynh_install_ruby source ynh_add_extra_apt_repos__3 +source ynh_add_swap source /usr/share/yunohost/helpers #================================================= @@ -101,6 +102,12 @@ ynh_remove_nginx_config # Remove a cron file ynh_secure_remove --file="/etc/cron.d/$app" +# Remove swap + +ynh_del_swap +# Remove swap + +ynh_del_swap #================================================= # GENERIC FINALIZATION diff --git a/scripts/ynh_add_swap b/scripts/ynh_add_swap new file mode 100644 index 0000000..d7ec44b --- /dev/null +++ b/scripts/ynh_add_swap @@ -0,0 +1,93 @@ +#!/bin/bash + +# 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 + else + return 1 + fi +} From 126e04bea66a78e0e40b4f08445e0e1e2e132ccb Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 11 Aug 2019 01:39:55 +0200 Subject: [PATCH 2/4] Fix add_swap --- README.md | 12 ------------ README_fr.md | 11 ----------- scripts/remove | 3 --- 3 files changed, 26 deletions(-) diff --git a/README.md b/README.md index 6458570..b3d4029 100644 --- a/README.md +++ b/README.md @@ -30,18 +30,6 @@ Mastodon is a free, open-source social network. A decentralized alternative to c ### Install -#### Adding "swapfile" If you have less than 2Go of RAM -``` -sudo dd if=/dev/zero of=/swapfile bs=1024 count=1024000 -sudo chmod 600 /swapfile -sudo mkswap /swapfile -sudo swapon /swapfile -``` -add this line on /etc/fstab -``` -/swapfile none swap sw 0 0 -``` - #### Using __screen__ in case of disconnect ``` $ sudo apt-get install screen diff --git a/README_fr.md b/README_fr.md index 803538f..09ceb7b 100644 --- a/README_fr.md +++ b/README_fr.md @@ -28,17 +28,6 @@ Mastodon est un réseau social gratuit et open source. Une alternative décentra ### Installation -#### Ajout d'un "swapfile" si vous avez moins de 2Go de RAM -``` -sudo dd if=/dev/zero of=/swapfile bs=1024 count=1024000 -sudo chmod 600 /swapfile -sudo mkswap /swapfile -sudo swapon /swapfile -``` -ajouter cette ligne dans /etc/fstab -``` -/swapfile none swap sw 0 0 -``` #### Utilisation de __screen__ en cas de déconnection ``` $ sudo apt-get install screen diff --git a/scripts/remove b/scripts/remove index a08afb7..f482ffe 100644 --- a/scripts/remove +++ b/scripts/remove @@ -102,11 +102,8 @@ ynh_remove_nginx_config # Remove a cron file ynh_secure_remove --file="/etc/cron.d/$app" -# Remove swap -ynh_del_swap # Remove swap - ynh_del_swap #================================================= From d406a87de2856be91b82005517106bab0622d28b Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 11 Aug 2019 01:40:06 +0200 Subject: [PATCH 3/4] fix ynh_check_ram --- scripts/install | 1 + scripts/ynh_check_ram | 72 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 scripts/ynh_check_ram diff --git a/scripts/install b/scripts/install index daa4153..1810c9b 100644 --- a/scripts/install +++ b/scripts/install @@ -11,6 +11,7 @@ source ynh_install_ruby source ynh_add_extra_apt_repos__3 source ynh_send_readme_to_admin__2 source ynh_add_swap +source ynh_check_ram source /usr/share/yunohost/helpers #================================================= diff --git a/scripts/ynh_check_ram b/scripts/ynh_check_ram new file mode 100644 index 0000000..11012a3 --- /dev/null +++ b/scripts/ynh_check_ram @@ -0,0 +1,72 @@ +#!/bin/bash + +# Check the amount of available RAM +# +# usage: ynh_check_ram [--required=RAM required in Mb] [--no_swap|--only_swap] [--free_ram] +# | arg: -r, --required= - Amount of RAM required in Mb. The helper will return 0 is there's enough RAM, or 1 otherwise. +# If --required isn't set, the helper will print the amount of RAM, in Mb. +# | arg: -s, --no_swap - Ignore swap +# | arg: -o, --only_swap - Ignore real RAM, consider only swap. +# | arg: -f, --free_ram - Count only free RAM, not the total amount of RAM available. +ynh_check_ram () { + # Declare an array to define the options of this helper. + declare -Ar args_array=( [r]=required= [s]=no_swap [o]=only_swap [f]=free_ram ) + local required + local no_swap + local only_swap + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + required=${required:-} + no_swap=${no_swap:-0} + only_swap=${only_swap:-0} + + local total_ram=$(vmstat --stats --unit M | grep "total memory" | awk '{print $1}') + local total_swap=$(vmstat --stats --unit M | grep "total swap" | awk '{print $1}') + local total_ram_swap=$(( total_ram + total_swap )) + + local free_ram=$(vmstat --stats --unit M | grep "free memory" | awk '{print $1}') + local free_swap=$(vmstat --stats --unit M | grep "free swap" | awk '{print $1}') + local free_ram_swap=$(( free_ram + free_swap )) + + # Use the total amount of ram + local ram=$total_ram_swap + if [ $free_ram -eq 1 ] + then + # Use the total amount of free ram + ram=$free_ram_swap + if [ $no_swap -eq 1 ] + then + # Use only the amount of free ram + ram=$free_ram + elif [ $only_swap -eq 1 ] + then + # Use only the amount of free swap + ram=$free_swap + fi + else + if [ $no_swap -eq 1 ] + then + # Use only the amount of free ram + ram=$total_ram + elif [ $only_swap -eq 1 ] + then + # Use only the amount of free swap + ram=$total_swap + fi + fi + + if [ -n "$required" ] + then + # Return 1 if the amount of ram isn't enough. + if [ $ram -lt $required ] + then + return 1 + else + return 0 + fi + + # If no RAM is required, return the amount of available ram. + else + echo $ram + fi +} From b199de81f9241d0c07ccdd35bf0a8794d855bba6 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 11 Aug 2019 15:58:52 +0200 Subject: [PATCH 4/4] Add swap during upgrade and restore --- scripts/restore | 18 ++++++++++++++++++ scripts/upgrade | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/scripts/restore b/scripts/restore index 59e71fc..1d8180d 100644 --- a/scripts/restore +++ b/scripts/restore @@ -10,6 +10,8 @@ source ../settings/scripts/_common.sh source ../settings/scripts/ynh_install_ruby source ../settings/scripts/ynh_add_extra_apt_repos__3 +source ../settings/scripts/ynh_add_swap +source ../settings/scripts/ynh_check_ram source /usr/share/yunohost/helpers #================================================= @@ -80,6 +82,22 @@ chown -R $app: $final_path #================================================= # SPECIFIC RESTORATION +#================================================= +# ADD SWAP IF NEEDED +#================================================= + +total_memory=$(ynh_check_ram) +total_swap=$(ynh_check_ram --only_swap) +swap_needed=0 + +if [ $total_memory -lt 2560 ]; then + # Need a minimum of 8Go of memory + swap_needed=$((2560 - $total_memory)) +fi + +ynh_script_progression --message="Adding $swap_needed Mo to swap..." --weight=1 +ynh_add_swap --size=$swap_needed + #================================================= # REINSTALL DEPENDENCIES #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 46e7229..b35d643 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,6 +9,8 @@ source _common.sh source ynh_install_ruby source ynh_add_extra_apt_repos__3 +source ynh_add_swap +source ynh_check_ram source /usr/share/yunohost/helpers #================================================= @@ -205,6 +207,22 @@ ynh_system_user_create --username=$app --home_dir=$final_path #================================================= # SPECIFIC UPGRADE +#================================================= +# ADD SWAP IF NEEDED +#================================================= + +total_memory=$(ynh_check_ram) +total_swap=$(ynh_check_ram --only_swap) +swap_needed=0 + +if [ $total_memory -lt 2560 ]; then + # Need a minimum of 8Go of memory + swap_needed=$((2560 - $total_memory)) +fi + +ynh_script_progression --message="Adding $swap_needed Mo to swap..." --weight=1 +ynh_add_swap --size=$swap_needed + #================================================= # INSTALLING RUBY AND BUNDLER #=================================================