From 9ac0c78daea7bbbefdfc4fbb7bdcea920cf32f5f Mon Sep 17 00:00:00 2001 From: Heavybullets8 Date: Tue, 6 Sep 2022 03:59:15 +0000 Subject: [PATCH] Update README --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8d4a3bfe..cfa6c6b8 100644 --- a/README.md +++ b/README.md @@ -32,25 +32,25 @@ | -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
_Look at the bottom of this page for an example_ | | -S | -S | None | Shutdown the application prior to updating it | -| -t | -t 150 | Integer | 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"_ | +| -t | -t 150 | Integer | Time in seconds that HeavyScript will wait for an application to no longer be deploying before declaring failure
Default: 500 | | -s | -s | None | Sync Catalogs prior to updating | | -p | -p | None | Prune old/unused docker images | | --self-update | --self-update | None | Updates HeavyScript prior to running any other commands | ### Example -#### Typical Cron Job +#### Cron Job ``` -bash heavy_script.sh --self-update -b 10 -i portainer -i arch -i sonarr -i radarr -t 600 -rsp -u 5 +bash heavy_script.sh --self-update -b 10 -i nextcloud -i sonarr -t 600 -rsp -u 5 ``` > `-b` is set to 10. Up to 10 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. +> `-i` is set to ignore __nextcloud__ and __sonarr__. These applications will be skipped if they have an update. -> `-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. +> `-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 rolling back to the previous version since `-r` is used. -> `-r` Will rollback applications if they fail to deploy after updating. +> `-r` Will rollback applications if they fail to deploy within the timeout, after updating. > `-s` will just sync the repositories, ensuring you are downloading the latest updates. @@ -80,7 +80,7 @@ bash heavy_script.sh --self-update -b 10 -i portainer -i arch -i sonarr -i radar #### Mounting PVC Data ``` -bash /mnt/tank/scripts/heavy_script.sh -t 300 --mount +bash /mnt/tank/scripts/heavy_script.sh --mount ``` #### Restoring ix-applications dataset