From 174450ec3d342f9f6d9f3a5907dc169a302db487 Mon Sep 17 00:00:00 2001 From: Heavybullets8 Date: Tue, 10 May 2022 19:20:01 +0000 Subject: [PATCH] Update Readme --- README.md | 60 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 38 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 4f3fa0b4..aac04cd5 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,51 @@ # heavy_script -Script that can: Update Truenas SCALE applications, Mount and unmount PVC storage, Prune Docker images. +Update | Backup | Restore | Mount PVC | Rollback Applications | Sync Catalog | Prune Docker Images -- -m | Initiates mounting feature, choose between unmounting and mounting PVC data" -- -r | Opens a menu to restore a HeavyScript backup that was taken on you ix-applications pool" -- -b | Back-up your ix-applications dataset, specify a number after -b" -- -i | Add application to ignore list, one by one, see example below." -- -R | Roll-back applications if they fail to update -- -S | Shutdown applications prior to updating -- -v | verbose output -- -t | Set a custom timeout in seconds for -u or -U: This is the ammount of time the script will wait for an application to go from DEPLOYING to ACTIVE" -- -t | Set a custom timeout in seconds for -m: Amount of time script will wait for applications to stop, before timing out" -- -s | sync catalog" -- -U | Update all applications, ignores versions" -- -u | Update all applications, does not update Major releases" -- -p | Prune unused/old docker images" - +| Flag | Example | Parameter | Description | +|------ |------------------------ |----------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| -r | -r | None | Restore HeavyScript specific 'ix-applications dataset' snapshot | +| -m | -m | None | Initiates mounting feature
Choose between unmounting and mounting PVC data | +| -b | -b 14 | int | Backup 'ix-appliactions' dataset
Creates backups up to the number you've chosen | +| -i | -i nextcloud -i sonarr | String | Applications listed will be ignored during updating | +| -R | -R | None | Monitors applications after they update
If the app does not become "ACTIVE" after either:
The custom Timeout, or Default Timeout,
rollback the application. | +| -v | -v | None | Verbose output | +| -S | -S | None | Shutdown applications prior to updating | +| -t | -t 150 | int | Set a custom timeout to be used with either:
-m
- Time the script will wait for application to be "STOPPED"
or
-u/U
- Time the script will wait for application to be either "STOPPED" or "ACTIVE" | +| -s | -s | None | Sync Catalog before updating | +| -U | -U | None | Update applications, ignoring major version changes | +| -u | -u | None | Update applications, do NOT update if there was a major version change | +| -p | -p | None | Prune old/unused docker images | +
+
### Examples -#### bash heavy_script.sh -b 14 -i portainer -i arch -i sonarr -i radarr -t 600 -sup -- This is your typical cron job implementation. +#### Typical Cron Job +``` +bash heavy_script.sh -b 14 -i portainer -i arch -i sonarr -i radarr -t 600 -Rsup +``` + - -b is set to 14. Up to 14 snapshots of your ix-applications dataset will be saved - -i is set to ignore portainer, arch, sonarr, and radarr. These applications will be ignored when it comes to updates. - -t I set it to 600 seconds, this means the script will wait 600 seconds for the application to become ACTIVE before timing out and continuing to a different application. -- -s will just sync the repositories, ensuring you are downloading the latest updates +- -R Will rollback applications if they fail to deploy after updating. +- -s will just sync the repositories, ensuring you are downloading the latest updates. - -u update applications as long as the major version has absolutely no change, if it does have a change it will ask the user to update manually. - -p Prune docker images. -- bash /mnt/tank/scripts/heavy_script.sh -t 8812 -m -- bash /mnt/tank/scripts/heavy_script/heavy_script.sh -r +#### Mounting PVC Data +``` +bash /mnt/tank/scripts/heavy_script.sh -t 300 -m +``` -### My personal Cron Job -- ```git -C /mnt/speed/scripts/heavy_script pull && bash /mnt/speed/scripts/heavy_script/heavy_script.sh -b 14 -Rsup``` +#### Restoring ix-applications dataset + +``` +bash /mnt/tank/scripts/heavy_script/heavy_script.sh -r +``` + +#### My personal Cron Job +``` +git -C /mnt/speed/scripts/heavy_script pull && bash /mnt/speed/scripts/heavy_script/heavy_script.sh -b 14 -Rsup +```