diff --git a/helpers/helpers.v1.d/hardware b/helpers/helpers.v1.d/hardware index 091f023f68..9f0e447ddb 100644 --- a/helpers/helpers.v1.d/hardware +++ b/helpers/helpers.v1.d/hardware @@ -103,3 +103,124 @@ ynh_require_ram() { return 0 fi } + + +# Ask the creation of a swap file for the application. +# The helper might or might not create the swap file, considering the machine's configuration. +# +# [packagingv1] +# +# usage: ynh_add_swap --size=SWAP in Mib +# | arg: -s, --size= - Amount of SWAP to add in Mib. +ynh_add_swap () { + # Declare an array to define the options of this helper. + local -A args_array=( [s]=size= ) + local size + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + + # Could be moved to an argument + swapfile_dir="$(realpath /)" + swapfile_path="$(realpath "$swapfile_dir/swap_yunohost")" + + # Early warning exit: Can't swap inside LXD + if [[ "$(systemd-detect-virt)" == "lxc" ]]; then + ynh_print_warn --message="You are inside a LXC container, swap will not be added." + ynh_print_warn --message="That can cause troubles for $app. Please make sure you have more than $((size/1024))G of RAM/swap available." + return + fi + + # Early warning exit: Preserve SD cards and do not swap on them + if ynh_is_on_sd_card --dir="$swapfile_dir" && [[ "${SD_CARD_CAN_SWAP:-0}" == "0" ]]; then + ynh_print_warn --message="Swap files on an SD card is not recommended, swap will not be added." + ynh_print_warn --message="That can cause troubles for $app. Please make sure you have more than $((size/1024))G of RAM/swap available." + ynh_print_warn --message="If you still want activate the swap, you can relaunch the command preceded by 'SD_CARD_CAN_SWAP=1'" + return + fi + + # Early warning exit: swapfile already exists + if [ -f "$swapfile_path" ]; then + ynh_print_warn --message="Swap file $swapfile_path already exists!" + return + fi + + + local free_space_kb + free_space_kb=$(df --block-size=K --output=avail "$swapfile_dir" | sed 1d | sed -e 's/K$//') + # We don't want to fill the disk with a swap file. + local usable_space=$(( free_space_kb / 1024 - 1024 )) + + # Compare the available space with the size of the swap. + if (( size > usable_space )); then + ynh_print_warn --message="Not enough space for a swap file at $swapfile_path." + return + fi + swap_size_kb=$(( size * 1024 )) + + # Configure swappiness + if [ ! -f /etc/sysctl.d/999-yunohost-swap.conf ]; then + echo "vm.swappiness=10" > /etc/sysctl.d/999-ynhswap.conf + sysctl --quiet --system + fi + + # Workaround for some copy-on-write filesystems like btrfs. + # Create the file + truncate -s 0 "$swapfile_path" + # Set the No_COW attribute on the swapfile with chattr + chattr +C "$swapfile_path" || true + # Set the final file size + dd if=/dev/zero of="$swapfile_path" bs=1024 count="$swap_size_kb" + chmod 0600 "$swapfile_path" + + # Create the swap + mkswap "$swapfile_path" + # And activate it + swapon "$swapfile_path" + # Then add an entry in fstab to load this swap at each boot. + echo -e "$swapfile_path swap swap defaults 0 0 #Swap added by $app" >> /etc/fstab +} + +# Delete the swap file created for the app by ynh_add_swap. +# +# [packagingv1] +# +ynh_del_swap () { + # Could be moved to an argument + swapfile_dir="$(realpath /)" + swapfile_path="$(realpath "$swapfile_dir/swap_yunohost")" + + if [ ! -f "$swapfile_path" ]; then + return + fi + + # Clean the fstab... + sed -i "/#Swap added by $app/d" /etc/fstab + # Desactive the swap file... + swapoff "$swapfile_path" + # And remove it. + rm "$swapfile_path" +} + +# Check if the device of the provided directory is an SD card +# +# [internal] +# +# usage: ynh_is_on_sd_card --dir=/ +# | arg: -d, --dir= - Directory to check +ynh_is_on_sd_card () { + # Declare an array to define the options of this helper. + local -A args_array=( [d]=dir= ) + local dir + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + + device_dev=$(findmnt --nofsroot --uniq --output source --noheadings --first-only --target "$dir") + device_pkname=$(lsblk --output PKNAME --noheadings "$device_dev") + device_rotational=$(lsblk --output ROTA --noheadings "$device_dev") + + if [[ "$device_pkname" == *"mmc"* ]] && [[ "$device_rotational" == "0" ]]; then + return 0 + else + return 1 + fi +} diff --git a/hooks/conf_regen/53-swap b/hooks/conf_regen/53-swap new file mode 100755 index 0000000000..fdb719afaa --- /dev/null +++ b/hooks/conf_regen/53-swap @@ -0,0 +1,31 @@ +#!/bin/bash + +source /usr/share/yunohost/helpers + +do_pre_regen() { + : +} + +do_post_regen() { + swapfile_enabled="$(yunohost settings get 'swap.swapfile.swapfile_enabled')" + swapfile_size="$(yunohost settings get 'swap.swapfile.swapfile_size')" + + if [ ${swapfile_enabled} -eq 1 ]; then + # If a swapfile is requested + if [ -f /swap_file ] && [ $(stat -c%s /swap_file) -ne $swapfile_size ]; then + # Let's delete it first if it is not of the requested size + ynh_print_info --message="Deleting swap first..." + ynh_del_swap + fi + # create the swapfile + ynh_print_info --message="Attempting to create $swapfile_size MB swap..." + ynh_add_swap --size=$swapfile_size + ynh_print_info --message="A $((swap_size / 1024)) MB swap has been created." + else + # If not, make sure it is deleted + ynh_print_info --message="Deleting swap..." + ynh_del_swap + fi +} + +do_$1_regen ${@:2} diff --git a/share/config_global.toml b/share/config_global.toml index 2b2795a5cd..a04a76fa20 100644 --- a/share/config_global.toml +++ b/share/config_global.toml @@ -176,4 +176,27 @@ i18n = "global_settings_setting" pattern.regexp = '^(([^\W_A-Z]+([-]*[^\W_A-Z]+)*\.)+((xn--)?[^\W_]{2,}));(([^\W_A-Z]+([-]*[^\W_A-Z]+)*\.)+((xn--)?([^\W_]{2,}|[0-9]{1,3})));[0-9]{1,}$' pattern.error = "You should specify a list of items formatted as DOMAIN;DESTINATION;DESTPORT, such as yolo.test;192.168.1.42;443" default = "" - visible = "tls_passthrough_enabled" + visible = "tls_passthrough_enabled" + +[swap] +name = "Swap" + [swap.swapfile] + name = "Swap file configuration" + [swap.swapfile.swapfile_warning] + ask = "Absolutely do not create a swap file if your root partition is on a SD card!" + help = "The intensive writing on the SD card will degrade it fast." + type = "alert" + style = "warning" + + [swap.swapfile.swapfile_enabled] + ask = "Do you need to create a swap file?" + help = "A swap file will extend the available RAM by using some of your storage space." + type = "boolean" + default = false + + [swap.swapfile.swapfile_size] + ask = "How many Mebibytes should the swap file be?" + help = "Only integers are accepted ( 1 MiB = 1024 B). Beware, if you reduce its current size, you may crash your server." + type = "number" + default = 1024 + visible = "swapfile_enabled" \ No newline at end of file diff --git a/src/settings.py b/src/settings.py index 1027a55a0b..1e004e9efe 100644 --- a/src/settings.py +++ b/src/settings.py @@ -377,3 +377,9 @@ def reconfigure_dovecot(setting_name, old_value, new_value): regen_conf(names=["dovecot"]) command = ["apt-get", "-y", "remove", "dovecot-pop3d"] subprocess.call(command, env=environment) + +@post_change_hook("swapfile_enabled") +@post_change_hook("swapfile_size") +def reconfigure_swapfile(setting_name, old_value, new_value): + if old_value != new_value: + regen_conf(names=["swap"])