scripte/pvekclean
1
0
Fork 0
mirror of https://github.com/jordanhillis/pvekclean.git synced 2026-06-20 10:23:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update pvekclean.sh v1.3

Browse Source 
Please see release notes for full description of changes
This commit is contained in:
Jordan
2023-11-12 13:34:03 +01:00
committed by GitHub
parent a5efad9440
commit 88fbd694fe
1 changed files with 252 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pvekclean.sh
+246 -90
View File
@@ -4,13 +4,13 @@ ______________________________________________
PVE Kernel Cleaner
By Jordan Hillis
contact@jordanhillis.com
jordan@hillis.email
https://jordanhillis.com
______________________________________________
MIT License
Copyright (c) 2018 Jordan S. Hillis
Copyright (c) 2023 Jordan Hillis - jordan@hillis.email - https://jordanhillis.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -33,6 +33,12 @@ ______________________________________________
# Percentage of used space in the /boot which would consider it critically full
boot_critical_percent="80"
# To check for updates or not
check_for_updates=true
# Debug mode is for testing without actually removing anything
debug=false
# Current kernel
current_kernel=$(uname -r)
@@ -40,104 +46,140 @@ current_kernel=$(uname -r)
program_name="pvekclean"
# Version
version="1.2"
version="1.3"
# Check if force removal argument is added
if [ "$1" == "-f" ] || [ "$1" == "--force" ]; then
force_purge=true
else
force_purge=false
fi
# Text Colors
black="\e[38;2;0;0;0m"
gray="\e[30m"
red="\e[31m"
green="\e[32m"
yellow="\e[33m"
blue="\e[34m"
magenta="\e[35m"
cyan="\e[36m"
white="\e[37m"
orange="\e[38;5;202m"
# Background Colors
bg_black="\e[40m"
bg_red="\e[41m"
bg_green="\e[42m"
bg_yellow="\e[43m"
bg_blue="\e[44m"
bg_magenta="\e[45m"
bg_cyan="\e[46m"
bg_white="\e[47m"
bg_orange="\e[48;5;202m"
# Text Styles
bold="\e[1m"
# Reset formatting
reset="\e[0m"
# Force purging without dialog confirms
force_purge=false
# Allow removing kernels newer than current
remove_newer=false
# Check if script is ran as root, if not exit
function check_root {
check_root() {
if [[ $EUID -ne 0 ]]; then
printf "[!] Error: this script must be ran as the root user.\n"
printf "${bold}[!] Error:${reset} this script must be ran as the root user.\n"
exit 1
fi
}
# Shown current version
function version(){
version() {
printf $version"\n"
exit 1
exit 0
}
# Header for PVE Kernel Cleaner
function header_info {
echo -e "
█▀▀█ ▀█ █▀ █▀▀ █ █ █▀▀ █▀▀█ █▀▀▄ █▀▀ █
█ █ █▄█ █▀▀ █▀▄ █▀▀ █▄▄▀ █ █ █▀▀ █
█▀▀▀ ▀ ▀▀▀ ▀ ▀ ▀▀▀ ▀ ▀▀ ▀ ▀ ▀▀▀ ▀▀▀
█▀▀ █ █▀▀ █▀▀█ █▀▀▄ █▀▀ █▀▀█
█ █ █▀▀ █▄▄█ █ █ █▀▀ █▄▄▀ ⎦˚◡˚⎣ v$version
▀▀▀ ▀▀▀ ▀▀▀ ▀ ▀ ▀ ▀ ▀▀▀ ▀ ▀▀
By Jordan Hillis [contact@jordanhillis.com]
header_info() {
echo -e " ${bg_black}${orange} ${reset}
${bg_black}${orange} █▀▀█ ▀█ █▀ █▀▀ █ █ █▀▀ █▀▀█ █▀▀▄ █▀▀ █ ${reset}
${bg_black}${orange} █ █ █▄█ █▀▀ █▀▄ █▀▀ █▄▄▀ █ █ █▀▀ █ ${reset}
${bg_black}${orange} █▀▀▀ ▀ ▀▀▀ ▀ ▀ ▀▀▀ ▀ ▀▀ ▀ ▀ ▀▀▀ ▀▀▀ ${reset}
${bg_black}${orange} ${reset}
${bg_black}${white} █▀▀ █ █▀▀ █▀▀█ █▀▀▄ █▀▀ █▀▀█ ${reset}
${bg_black}${white} █ █ █▀▀ █▄▄█ █ █ █▀▀ █▄▄▀ ${white}${bold}⎦˚◡˚⎣ v$version ${reset}
${bg_black}${white} ▀▀▀ ▀▀▀ ▀▀▀ ▀ ▀ ▀ ▀ ▀▀▀ ▀ ▀▀ ${reset}
${bg_orange}${black} ${bold}By Jordan Hillis [jordan@hillis.email] ${reset}
___________________________________________
"
if [ "$debug" == "true" ]; then
printf " ${bg_black}${orange}${bold} DEBUG MODE IS ${green}ON ${reset}\n\n"
fi
}
# Show current system information
function kernel_info {
kernel_info() {
# Lastest kernel installed
latest_kernel=$(dpkg --list| grep 'pve-kernel-.*-pve' | awk '{print $2}' | tac | head -n 1)
latest_kernel=$(dpkg --list | awk '/proxmox-kernel-.*-pve/{print $2}' | sed -n 's/proxmox-kernel-//p' | sort -V | tail -n 1 | tr -d '[:space:]')
# Show operating system used
printf "OS: $(cat /etc/os-release | grep "PRETTY_NAME" | sed 's/PRETTY_NAME=//g' | sed 's/["]//g' | awk '{print $0}')\n"
printf " ${bold}OS:${reset} $(cat /etc/os-release | grep "PRETTY_NAME" | sed 's/PRETTY_NAME=//g' | sed 's/["]//g' | awk '{print $0}')\n"
# Get information about the /boot folder
boot_info=($(echo $(df -Ph /boot | tail -1) | sed 's/%//g'))
boot_info=($(echo $(df -Ph | grep /boot | tail -1) | sed 's/%//g'))
# Show information about the /boot
printf "Boot Disk: ${boot_info[4]}%% full [${boot_info[2]}/${boot_info[1]} used, ${boot_info[3]} free] \n"
printf " ${bold}Boot Disk:${reset} ${boot_info[4]}%% full [${boot_info[2]}/${boot_info[1]} used, ${boot_info[3]} free] \n"
# Show current kernel in use
printf "Current Kernel: pve-kernel-$current_kernel\n"
printf " ${bold}Current Kernel:${reset} $current_kernel\n"
# Check if they are running a PVE kernel
if [[ "$current_kernel" == *"pve"* ]]; then
# Check if we are running the latest kernel, if not warn
if [[ "$latest_kernel" != *"$current_kernel"* ]]; then
printf "Latest Kernel: $latest_kernel\n"
printf " ${bold}Latest Kernel:${reset} $latest_kernel\n"
fi
# Warn them that they aren't on a PVE kernel
else
printf "___________________________________________\n\n"
printf "[!] Warning, you're not running a PVE kernel\n"
printf "${bold}[!]${reset} Warning, you're not running a PVE kernel\n"
# Ask them if they want to continue
read -p "[*] Would you like to continue [y/N] " -n 1 -r
printf "${bold}[*]${reset} Would you like to continue [y/N] "
read -n 1 -r
printf "\n"
if [[ $REPLY =~ ^[Yy]$ ]]; then
# Continue on if they wish
printf "[-] Alright, we will continue on\n"
printf "${bold}[-]${reset} Alright, we will continue on\n"
else
# Exit script
printf "\nGood bye!\n"
exit 1
exit 0
fi
fi
printf "___________________________________________\n\n"
}
# Usage information on how to use PVE Kernel Clean
function show_usage {
show_usage() {
# Skip showing usage when force_purge is enabled
if [ $force_purge == false ]; then
printf "Usage: $(basename $0) [OPTION]\n\n"
printf " -f, --force Remove all old PVE kernels without confirm prompts\n"
printf " -s --scheduler Have old PVE kernels removed on a scheduled basis\n"
printf "${bold}Usage:${reset} $(basename $0) [OPTION1] [OPTION2]...\n\n"
printf " -k, --keep [number] Keep the specified number of most recent PVE kernels on the system\n"
printf " Can be used with -f or --force for non-interactive removal\n"
printf " -f, --force Force the removal of old PVE kernels without confirm prompts\n"
printf " -rn, --remove-newer Remove kernels that are newer than the currently running kernel\n"
printf " -s, --scheduler Have old PVE kernels removed on a scheduled basis\n"
printf " -v, --version Shows current version of $program_name\n"
printf " -r --remove Uninstall $program_name from the system\n"
printf " -r, --remove Uninstall $program_name from the system\n"
printf " -d, --debug Run the program in debug mode for testing without making system changes\n"
printf "___________________________________________\n\n"
fi
}
# Schedule PVE Kernel Cleaner at a time desired
function scheduler(){
scheduler() {
# Check if pvekclean is on the system, if not exit
if [ ! -f /usr/local/sbin/$program_name ]; then
printf "[!] Sorry $program_name is required to be installed on the system for this functionality.\n"
printf "${bold}[!]${reset} Sorry $program_name is required to be installed on the system for this functionality.\n"
exit 1
fi
# Check if cron is installed
if ! [ -x "$(command -v crontab)" ]; then
printf "[*] Error, cron does not appear to be installed.\n"
printf "${bold}[*]${reset} Error, cron does not appear to be installed.\n"
printf " Please install cron with the command 'sudo apt-get install cron'\n\n"
exit 1
fi
@@ -148,7 +190,8 @@ function scheduler(){
# Get the current cronjob scheduling
cron_current=$(crontab -l | grep "$program_name" | sed "s/[^a-zA-Z']/ /g" | sed -e "s/\b\(.\)/\u\1/g" | awk '{print $1;}')
# Ask the user if they would like to remove the scheduling
read -p "[-] Would you like to remove the currently scheduled PVE Kernel Cleaner? (Current: $cron_current) [y/N] " -n 1 -r
printf "${bold}[-]${reset} Would you like to remove the currently scheduled PVE Kernel Cleaner? (Current: $cron_current) [y/N] "
read -n 1 -r
if [[ $REPLY =~ ^[Yy]$ ]]; then
# Remove the cronjob
(crontab -l | grep -v "$program_name")| crontab -
@@ -160,7 +203,7 @@ function scheduler(){
# Cronjob does not exist
else
# Ask how often the would like to check for old PVE kernels
printf "[-] How often would you like to check for old PVE kernels?\n 1) Daily\n 2) Weekly\n 3) Monthly\n\n - Enter a number option above? "
printf "${bold}[-]${reset} How often would you like to check for old PVE kernels?\n 1) Daily\n 2) Weekly\n 3) Monthly\n\n - Enter a number option above? "
read -r -p "" response
case "$response" in
1)
@@ -177,15 +220,24 @@ function scheduler(){
exit 1
;;
esac
# Ask if they want to set a specific number of kernels to keep
printf "${bold}[-]${reset} Enter the number of latest kernels to keep (or press Enter to skip): "
read number_of_kernels
if [[ "$number_of_kernels" =~ ^[0-9]+$ ]]; then
kernel_option=" -k $number_of_kernels"
printf "${bold}[-]${reset} Okay, we will keep at least $number_of_kernels kernels on the system."
else
kernel_option=""
fi
# Add the cronjob
(crontab -l ; echo "@$cron_time /usr/local/sbin/$program_name -f")| crontab -
(crontab -l ; echo "@$cron_time /usr/local/sbin/$program_name -f$kernel_option")| crontab -
printf "\n[-] Scheduled $cron_time PVE Kernel Cleaner successfully!\n"
fi
exit 1
exit 0
}
# Installs PVE Kernel Cleaner for easier access
function install_program(){
install_program() {
force_pvekclean_update=false
# If pvekclean exists on the system
if [ -e /usr/local/sbin/$program_name ]; then
@@ -193,8 +245,8 @@ function install_program(){
pvekclean_installed_version=$(/usr/local/sbin/$program_name -v | awk '{printf $0}')
# If the version differs, update it to the latest from the script
if [ $version != $pvekclean_installed_version ] && [ $force_purge == false ]; then
printf "[!] A new version of PVE Kernel Cleaner has been detected (Installed: $pvekclean_installed_version | New: $version).\n"
printf "[*] Installing update...\n"
printf "${bold}[!]${reset} A new version of PVE Kernel Cleaner has been detected (Installed: $pvekclean_installed_version | New: $version).\n"
printf "${bold}[*]${reset} Installing update...\n"
force_pvekclean_update=true
fi
fi
@@ -205,7 +257,8 @@ function install_program(){
REPLY="n"
else
# Ask if we can install it
read -p "[-] Can we install PVE Kernel Cleaner to your /usr/local/sbin for easier access [y/N] " -n 1 -r
printf "${bold}[-]${reset} Can we install PVE Kernel Cleaner to your /usr/local/sbin for easier access [y/N] "
read -n 1 -r
printf "\n"
fi
# User agrees to have it installed
@@ -214,103 +267,177 @@ function install_program(){
cp $0 /usr/local/sbin/$program_name
chmod +x /usr/local/sbin/$program_name
# Tell user how to use it
printf "[*] Installed PVE Kernel Cleaner to /usr/local/sbin/$program_name\n"
printf "[*] Run the command \"$program_name\" to begin using this program.\n"
printf "[-] Run the command \"$program_name -r\" to remove this program at any time.\n"
exit 1
printf "${bold}[*]${reset} Installed PVE Kernel Cleaner to /usr/local/sbin/$program_name\n"
printf "${bold}[*]${reset} Run the command \"$program_name\" to begin using this program.\n"
printf "${bold}[-]${reset} Run the command \"$program_name -r\" to remove this program at any time.\n"
exit 0
fi
fi
}
# Uninstall pvekclean from the system
function uninstall_program(){
uninstall_program() {
# If pvekclean exists on the system
if [ -e /usr/local/sbin/$program_name ]; then
# Confirm that they wish to remove it
read -p "[-] Are you sure that you would like to remove $program_name? [y/N] " -n 1 -r
printf "${bold}[-]${reset} Are you sure that you would like to remove $program_name? [y/N] "
read -n 1 -r
printf "\n"
if [[ $REPLY =~ ^[Yy]$ ]]; then
# Remove the program
rm -f /usr/local/sbin/$program_name
printf "[*] Successfully removed PVE Kernel Cleaner from the system!\n"
printf "[-] Sorry to see you go :(\n"
printf "${bold}[*]${reset} Successfully removed PVE Kernel Cleaner from the system!\n"
printf "${bold}[-]${reset} Sorry to see you go :(\n"
else
printf "\nExiting...\nThat was a close one ⎦˚◡˚⎣\n"
fi
exit 1
exit 0
else
# Tell the user that it is not installed
printf "[!] This program is not installed on the system.\n"
printf "${bold}[!]${reset} This program is not installed on the system.\n"
exit 1
fi
}
# PVE Kernel Clean main function
function pve_kernel_clean {
pve_kernel_clean() {
# Find all the PVE kernels on the system
kernels=$(dpkg --list| grep 'pve-kernel-.*-pve' | awk '{print $2}' | sort -V)
kernels=$(dpkg --list | grep -E '(pve-kernel|proxmox-kernel)-.*-pve' | awk '{print $2}' | sed -n 's/\(pve\|proxmox\)-kernel-\(.*\)/\2/p' | sort -V)
# List of kernels that will be removed (adds them as the script goes on)
kernels_to_remove=""
kernels_to_remove=()
# Check the /boot used
printf "[*] Boot disk space used is "
printf "${bold}[*]${reset} Boot disk space used is "
# Warn user when the /boot is critically full
if [[ "${boot_info[4]}" -ge "$boot_critical_percent" ]]; then
printf "critically full "
printf "${bold}${orange}critically full${reset} "
# Tell them if it is at an acceptable percentage
else
printf "healthy "
printf "${bold}${green}healthy${reset} "
fi
# Display percentage used and available space left
printf "at ${boot_info[4]}%% capacity (${boot_info[3]} free)\n"
printf "[-] Searching for old PVE kernels on your system...\n"
# For each kernel that was found via dpkg
for kernel in $kernels
do
# If the kernel listed from dpkg is our current then break
if [ "$(echo $kernel | grep $current_kernel)" ]; then
# Only if not removing newer kernels and kernel matches the current kernel
if [ "$(echo $kernel | grep "$current_kernel")" ]; then
if [ "$remove_newer" == "false" ]; then
break
else
continue
fi
# Add kernel to the list of removal since it is old
else
printf "[*] \"$kernel\" has been added to the kernel remove list\n"
kernels_to_remove+=" $kernel"
kernels_to_remove+=("$kernel") # Add the kernel to the array
fi
done
printf "[-] PVE kernel search complete!\n"
# If keep_kernels is set we remove this number from the array to remove
if [[ -n "$keep_kernels" ]] && [[ "$keep_kernels" =~ ^[0-9]+$ ]]; then
if [ $keep_kernels -gt 0 ]; then
printf "${bold}[*]${reset} The last ${bold}$keep_kernels${reset} kernel$([ "$keep_kernels" -eq 1 ] || echo 's') will be held back from being removed.\n"
# Check if the number of kernels to keep is greater than or equal to the number of kernels in the array
if [ "$keep_kernels" -ge "${#kernels_to_remove[@]}" ]; then
# Set keep_kernels to the number of kernels in the array
keep_kernels="${#kernels_to_remove[@]}"
fi
kernels_to_keep=("${kernels_to_remove[@]:${#kernels_to_remove[@]}-$keep_kernels:$keep_kernels}")
kernels_to_remove=("${kernels_to_remove[@]::${#kernels_to_remove[@]}-$keep_kernels}")
fi
fi
# Show kernels to be removed
printf "${bold}[-]${reset} Searching for old PVE kernels on your system...\n"
for kernel in "${kernels_to_remove[@]}"
do
printf " ${bold}${green}+${reset} \"$kernel\" added to the kernel remove list\n"
done
for kernel in "${kernels_to_keep[@]}"
do
printf " ${bold}${red}-${reset} \"$kernel\" is being held back from removal\n"
done
printf "${bold}[-]${reset} PVE kernel search complete!\n"
# If there are no kernels to be removed then exit
if [[ "$kernels_to_remove" != *"pve"* ]]; then
printf "[!] It appears there are no old PVE kernels on your system ⎦˚◡˚⎣\n"
printf "[-] Good bye!\n"
if [ ${#kernels_to_remove[@]} -eq 0 ]; then
printf "${bold}[!]${reset} It appears there are no old PVE kernels on your system ⎦˚◡˚⎣\n"
printf "${bold}[-]${reset} Good bye!\n"
# Kernels found in removal list
else
num_to_remove=${#kernels_to_remove[@]}
# Check if force removal was passed
if [ $force_purge == true ]; then
REPLY="y"
# Ask the user if they want to remove the selected kernels found
else
read -p "[!] Would you like to remove the $(echo $kernels_to_remove | awk '{print NF}') selected PVE kernels listed above? [y/N]: " -n 1 -r
printf "${bold}[!]${reset} Would you like to remove the ${bold}$num_to_remove${reset} selected PVE kernel$([ "$num_to_remove" -eq 1 ] || echo 's') listed above? [y/N]: "
read -n 1 -r
printf "\n"
fi
# User wishes to remove the kernels
if [[ $REPLY =~ ^[Yy]$ ]]; then
printf "[*] Removing $(echo $kernels_to_remove | awk '{print NF}') old PVE kernels..."
printf "${bold}[*]${reset} Removing $num_to_remove old PVE kernel$([ "$num_to_remove" -eq 1 ] || echo 's')...\n"
for kernel in "${kernels_to_remove[@]}"
do
printf "${bold}[-]${reset} Removing kernel: $kernel..."
# Purge the old kernels via apt and suppress output
/usr/bin/apt purge -y $kernels_to_remove > /dev/null 2>&1
if [ "$debug" != "true" ]; then
/usr/bin/apt purge -y pve-kernel-$kernel > /dev/null 2>&1
/usr/bin/apt purge -y proxmox-kernel-$kernel > /dev/null 2>&1
/usr/bin/apt purge -y pve-kernel-${kernel%-pve} > /dev/null 2>&1
/usr/bin/apt purge -y proxmox-kernel-${kernel%-pve} > /dev/null 2>&1
fi
sleep 1
printf "DONE!\n"
printf "[*] Updating GRUB..."
done
printf "${bold}[*]${reset} Updating GRUB..."
# Update grub after kernels are removed, suppress output
if [ "$debug" != "true" ]; then
/usr/sbin/update-grub > /dev/null 2>&1
fi
printf "DONE!\n"
# Script finished successfully
printf "[-] Have a nice day ⎦˚◡˚⎣\n"
printf "${bold}[-]${reset} Have a nice $(timeGreeting) ⎦˚◡˚⎣\n"
# User wishes to not remove the kernels above, exit
else
printf "\nExiting...\n"
printf "See you later ⎦˚◡˚⎣\n"
fi
fi
exit 0
}
function main {
# Function to check for updates
check_for_update() {
if [ "$check_for_updates" == "true" ] && [ "$force_purge" == "false" ]; then
local remote_version=$(curl -s https://raw.githubusercontent.com/jordanhillis/pvekclean/master/version.txt)
if [ "$remote_version" != "$version" ]; then
printf "*** A new version $remote_version is available! ***\n"
printf "${bold}[*]${reset} Do you want to update? [y/N] "
read -n 1 -r
printf "\n"
if [[ $REPLY =~ ^[Yy]$ ]]; then
local updated_script=$(curl -s https://raw.githubusercontent.com/jordanhillis/pvekclean/master/pvekclean.sh)
# Check if the updated script contains the shebang line
if [[ "$updated_script" == "#!/bin/bash"* ]]; then
echo "$updated_script" > "$0" # Overwrite the current script
printf "${bold}[*]${reset} Successfully updated to version $remote_version\n"
exec "$0" "$@"
else
printf "${bold}[*]${reset} The updated script does not contain the expected shebang line.\n"
printf "${bold}[*]${reset} Update aborted!\n"
fi
fi
fi
fi
}
timeGreeting() {
h=$(date +%H)
((h >= 5 && h < 12)) && echo "morning" && return
((h >= 12 && h < 17)) && echo "afternoon" && return
((h >= 17 && h < 21)) && echo "evening" && return
echo "night"
}
main() {
# Check for root
check_root
# Show header information
@@ -319,32 +446,61 @@ function main {
show_usage
# Show kernel information
kernel_info
# Check for updates
check_for_update
# Install program to /usr/local/sbin/
install_program
}
while true; do
while [[ $# -gt 0 ]]; do
case "$1" in
-r | --remove )
-r|--remove )
main
uninstall_program
;;
-s | --scheduler )
-s|--scheduler)
main
scheduler
;;
-v | --version )
-v|--version)
version
;;
-h | --help )
-h|--help)
main
exit 1
exit 0
;;
* )
main
pve_kernel_clean
-k|--keep)
if [[ $# -gt 1 && "$2" =~ ^[0-9]+$ ]]; then
keep_kernels="$2"
shift 2
continue
else
echo -e "${bold}Error:${reset} --keep/-k requires a number argument."
exit 1
fi
;;
-f|--force)
force_purge=true
shift
continue
;;
-rn|--remove-newer)
remove_newer=true
shift
continue
;;
-d|--debug)
debug=true
shift
continue
;;
*)
echo -e "${bold}Unknown option:${reset} $1"
exit 1
;;
esac
shift
done
main
pve_kernel_clean