diff --git a/README.md b/README.md index f6a4852..be6b8f4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # dockcheck -### A script checking updates for docker images **without the need of pulling** - then having the option to auto-update. +### A script checking updates for docker images **without the need of pulling** - then having the option to auto-update either all or selecting specific containers. -With the help of [`regctl`](https://github.com/regclient/regclient). -This is just a concept for fun and inspiration, use with care. +With the help of [`regctl`](https://github.com/regclient/regclient). This is just a concept for inspiration, use with care. ___ ## Dependencies: @@ -13,11 +12,12 @@ ___ ## `dockcheck.sh` ```bash $ ./dockcheck.sh -h -Syntax: dockcheck.sh [OPTION] [optional string to filter names] +Syntax: dockcheck.sh [OPTION] [part of name to filter] +Example: dockcheck.sh -a ng Options: -h Print this Help. --a Automatic updates, without interaction. +-a|y Automatic updates, without interaction. -n No updates, only checking availability. ``` @@ -29,15 +29,21 @@ Basic example: ```bash $ ./dockcheck.sh . . . -Containers with updates available: -whoogle-search - Containers on latest version: glances homer -Do you want to update? y/[n] -y +Containers with updates available: +0) ALL +1) adguardhome +2) syncthing +3) whoogle-search + + +Do you want to update? y/[n] y +What containers do you like to update? +Enter number(s) separated by comma: 1,3 + ``` Then it proceedes to run `pull` and `up -d` on every container with updates. @@ -64,12 +70,14 @@ No updates installed, exiting - ~~Multi-digest images didn't correctly check with registry, giving false positives on updates.~~ ### :hammer: Known issues -- ~~No granular choice of what to update (except initial name filter).~~ - - Now in [`experimental_dockcheck.sh`](https://github.com/mag37/dockcheck/blob/main/experimental_dockcheck.sh) +- ~~No granular choice of what to update (except initial name filter).~~ - No detailed error feedback (just skip + list what's skipped) . ## `dockcheck_docker-run_ver.sh` -Alternative version for people who use `docker run` and no composes. Consider that this will restart updated containers without taking into account any other containers relying or depending on said container - might need to restart relating containers afterwards. +### Wont auto-update the containers, only their images. (compose is recommended) +Alternative version for people who use `docker run` and no composes. +`docker run` dont support using new images just by restarting a container. +Containers need to be stopped, removed and created again to run on the new image. ## `dupc_function.sh` diff --git a/dockcheck.sh b/dockcheck.sh index dcd0446..11b46e0 100644 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -7,25 +7,17 @@ Help() { echo echo "Options:" echo "-h Print this Help." - echo "-a Automatic updates, without interaction." + echo "-a|y Automatic updates, without interaction." echo "-n No updates, only checking availability." } -while getopts "anh" options; do +while getopts "aynh" options; do case "${options}" in - a) - UpdYes="yes" - ;; - n) - UpdYes="no" - ;; - h|*) # help or unknown option: - Help - exit 0;; + a|y) UpdYes="yes" ;; + n) UpdYes="no" ;; + h|*) Help ; exit 0 ;; esac done - -### Set $1 back to $1 (ignoring the places held by getops) shift "$((OPTIND-1))" ### Set $1 to a variable for later @@ -37,77 +29,114 @@ if [[ $(builtin type -P "regctl") ]]; then elif [[ -f "./regctl" ]]; then regbin="./regctl" else - printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n]\n" + printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n] " read GetDep if [ "$GetDep" != "${GetDep#[Yy]}" ]; then ### Check arch: case "$(uname --machine)" in - x86_64|amd64) - architecture="amd64";; - arm64|aarch64) - architecture="arm64";; + x86_64|amd64) architecture="amd64" ;; + arm64|aarch64) architecture="arm64";; *) echo "Architecture not supported, exiting." ; exit ;; esac curl -L https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture >./regctl chmod 755 ./regctl regbin="./regctl" else - printf "Dependency missing, quitting.\n" + printf "%s\n" "Dependency missing, quitting." exit fi fi +### Check docker compose binary: +if docker compose &> /dev/null ; then + DockerBin="docker compose" +elif docker-compose &> /dev/null; then + DockerBin="docker-compose" +else + printf "%s\n" "No docker compose binary available, quitting." + exit +fi + +### Numbered List -function: +options() { +num=0 +for i in "${NumberedUpdates[@]}"; do + echo "$num) $i" + ((num++)) +done +} + +### Choose from list -function: +choosecontainers() { + while [[ "$ChoiceClean" =~ [A-Za-z] || -z "$ChoiceClean" ]]; do + printf "What containers do you like to update? \n" + # options + read -p 'Enter number(s) separated by comma (eg. 1,3,4): ' Choice + if [ "$Choice" == "0" ] ; then + SelectedUpdates=( ${NumberedUpdates[@]:1} ) + ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g') + else + ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g') + for s in $ChoiceClean; do + SelectedUpdates+=( ${NumberedUpdates[$s]} ) + done + fi + done + printf "\nYou've SelectedUpdates:\n" + printf "%s\n" "${SelectedUpdates[@]}" +} ### Check the image-hash of every running container VS the registry -for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') -do -printf ". " +for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do + printf ". " RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}') LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}') RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null) # Check if regtcl produces errors - add to GotErrors if so. if [ $? -eq 0 ] ; then - if [[ "$LocalHash" = *"$RegHash"* ]] ; then - NoUpdates+=("$i") - else - GotUpdates+=("$i") - fi + if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi else GotErrors+=("$i") fi done +### Create new Array to use for the numbered list: +NumberedUpdates=(ALL "${GotUpdates[@]}") + ### List what containers got updates or not if [ -n "$NoUpdates" ] ; then printf "\n\033[32;1mContainers on latest version:\033[0m\n" printf "%s\n" "${NoUpdates[@]}" fi -if [ -n "$GotUpdates" ] ; then - printf "\n\033[31;1mContainers with updates available:\033[0m\n" - printf "%s\n" "${GotUpdates[@]}" -fi if [ -n "$GotErrors" ] ; then printf "\n\033[33;1mContainers with errors, wont get updated:\033[0m\n" printf "%s\n" "${GotErrors[@]}" fi +if [ -n "$GotUpdates" ] ; then + printf "\n\033[31;1mContainers with updates available:\033[0m\n" + [ -z "$UpdYes" ] && options || printf "%s\n" "${GotUpdates[@]}" +fi ### Optionally get updates if there's any if [ -n "$GotUpdates" ] ; then if [ -z "$UpdYes" ] ; then - printf "\n\033[36;1mDo you want to update? y/[n]\033[0m\n" + printf "\n\033[36;1mDo you want to update? y/[n]\033[0m " read UpdYes + [ "$UpdYes" != "${UpdYes#[Yy]}" ] && choosecontainers + else + SelectedUpdates=( "${GotUpdates[@]}" ) + fi + if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then + for i in "${SelectedUpdates[@]}" + do + ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir"}}') + $DockerBin -f "$ContPath/docker-compose.yml" pull + $DockerBin -f "$ContPath/docker-compose.yml" up -d + done + else + printf "\nNo updates installed, exiting.\n" fi - if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then - for i in "${GotUpdates[@]}" - do - # Check what compose-type is installed: - if docker compose &> /dev/null ; then DockerBin="docker compose" ; else DockerBin="docker-compose" ; fi - ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir"}}') - $DockerBin -f "$ContPath/docker-compose.yml" pull - $DockerBin -f "$ContPath/docker-compose.yml" up -d - done - else - printf "\nNo updates installed, exiting.\n" - fi else printf "\nNo updates available, exiting.\n" fi + +exit 0 diff --git a/dockcheck_docker-run_ver.sh b/dockcheck_docker-run_ver.sh index b844b2c..ed7f104 100644 --- a/dockcheck_docker-run_ver.sh +++ b/dockcheck_docker-run_ver.sh @@ -1,7 +1,9 @@ #!/bin/bash -### DOCKER RUN - VERSION. -### If running docker compose, use the main version. +### DOCKER RUN - VERSION + +### WARNING WONT REBUILD CONTAINERS - ONLY GRAB NEW IMAGES +### If running docker compose, use the main version. (recommended!) # Help Function: Help() { @@ -10,25 +12,17 @@ Help() { echo echo "Options:" echo "-h Print this Help." - echo "-a Automatic updates, without interaction." + echo "-a|y Automatic updates, without interaction." echo "-n No updates, only checking availability." } -while getopts "anh" options; do +while getopts "aynh" options; do case "${options}" in - a) - UpdYes="yes" - ;; - n) - UpdYes="no" - ;; - h|*) # help or unknown option: - Help - exit 0;; + a|y) UpdYes="yes" ;; + n) UpdYes="no" ;; + h|*) Help ; exit 0 ;; esac done - -### Set $1 back to $1 (ignoring the places held by getops) shift "$((OPTIND-1))" ### Set $1 to a variable for later @@ -40,75 +34,113 @@ if [[ $(builtin type -P "regctl") ]]; then elif [[ -f "./regctl" ]]; then regbin="./regctl" else - printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n]\n" + printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n] " read GetDep if [ "$GetDep" != "${GetDep#[Yy]}" ]; then ### Check arch: case "$(uname --machine)" in - x86_64|amd64) - architecture="amd64";; - arm64|aarch64) - architecture="arm64";; + x86_64|amd64) architecture="amd64" ;; + arm64|aarch64) architecture="arm64";; *) echo "Architecture not supported, exiting." ; exit ;; esac curl -L https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture >./regctl chmod 755 ./regctl regbin="./regctl" else - printf "Dependency missing, quitting.\n" + printf "%s\n" "Dependency missing, quitting." exit fi fi +### Check docker compose binary: +if docker compose &> /dev/null ; then + DockerBin="docker compose" +elif docker-compose &> /dev/null; then + DockerBin="docker-compose" +else + printf "%s\n" "No docker compose binary available, quitting." + exit +fi + +### Numbered List -function: +options() { +num=0 +for i in "${NumberedUpdates[@]}"; do + echo "$num) $i" + ((num++)) +done +} + +### Choose from list -function: +choosecontainers() { + while [[ "$ChoiceClean" =~ [A-Za-z] || -z "$ChoiceClean" ]]; do + printf "What containers do you like to update? \n" + # options + read -p 'Enter number(s) separated by comma (eg. 1,3,4): ' Choice + if [ "$Choice" == "0" ] ; then + SelectedUpdates=( ${NumberedUpdates[@]:1} ) + ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g') + else + ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g') + for s in $ChoiceClean; do + SelectedUpdates+=( ${NumberedUpdates[$s]} ) + done + fi + done + printf "\nYou've SelectedUpdates:\n" + printf "%s\n" "${SelectedUpdates[@]}" +} ### Check the image-hash of every running container VS the registry -for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') -do -printf ". " +for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do + printf ". " RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}') LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}') RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null) # Check if regtcl produces errors - add to GotErrors if so. if [ $? -eq 0 ] ; then - if [[ "$LocalHash" = *"$RegHash"* ]] ; then - NoUpdates+=("$i") - else - GotUpdates+=("$i") - fi + if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi else GotErrors+=("$i") fi done +### Create new Array to use for the numbered list: +NumberedUpdates=(ALL "${GotUpdates[@]}") + ### List what containers got updates or not if [ -n "$NoUpdates" ] ; then printf "\n\033[32;1mContainers on latest version:\033[0m\n" printf "%s\n" "${NoUpdates[@]}" fi -if [ -n "$GotUpdates" ] ; then - printf "\n\033[31;1mContainers with updates available:\033[0m\n" - printf "%s\n" "${GotUpdates[@]}" -fi if [ -n "$GotErrors" ] ; then printf "\n\033[33;1mContainers with errors, wont get updated:\033[0m\n" printf "%s\n" "${GotErrors[@]}" fi +if [ -n "$GotUpdates" ] ; then + printf "\n\033[31;1mContainers with updates available:\033[0m\n" + [ -z "$UpdYes" ] && options || printf "%s\n" "${GotUpdates[@]}" +fi ### Optionally get updates if there's any if [ -n "$GotUpdates" ] ; then if [ -z "$UpdYes" ] ; then - printf "\n\033[36;1mDo you want to update? y/[n]\033[0m\n" + printf "\n\033[36;1mDo you want to update? y/[n]\033[0m " read UpdYes + [ "$UpdYes" != "${UpdYes#[Yy]}" ] && choosecontainers + else + SelectedUpdates=( "${GotUpdates[@]}" ) + fi + if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then + for i in "${SelectedUpdates[@]}"; do + ContImage=$(docker inspect "$i" --format='{{.Config.Image}}') + docker pull $ContImage + printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters" + done + else + printf "\nNo updates installed, exiting.\n" fi - if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then - for i in "${GotUpdates[@]}" - do - ContImage=$(docker inspect "$i" --format='{{.Config.Image}}') - docker pull $ContImage - docker restart $i - done - else - printf "\nNo updates installed, exiting.\n" - fi else printf "\nNo updates available, exiting.\n" fi + +exit 0 diff --git a/experimental_dockcheck.sh b/experimental_dockcheck.sh deleted file mode 100644 index 6d7dc27..0000000 --- a/experimental_dockcheck.sh +++ /dev/null @@ -1,142 +0,0 @@ -#!/bin/bash - -# Help Function: -Help() { - echo "Syntax: dockcheck.sh [OPTION] [part of name to filter]" - echo "Example: dockcheck.sh -a ng" - echo - echo "Options:" - echo "-h Print this Help." - echo "-a|y Automatic updates, without interaction." - echo "-n No updates, only checking availability." -} - -while getopts "aynh" options; do - case "${options}" in - a|y) UpdYes="yes" ;; - n) UpdYes="no" ;; - h|*) Help ; exit 0 ;; - esac -done -shift "$((OPTIND-1))" - -### Set $1 to a variable for later -SearchName="$1" - -### Check if required binary exists in PATH or directory: -if [[ $(builtin type -P "regctl") ]]; then - regbin="regctl" -elif [[ -f "./regctl" ]]; then - regbin="./regctl" -else - printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n] " - read GetDep - if [ "$GetDep" != "${GetDep#[Yy]}" ]; then - ### Check arch: - case "$(uname --machine)" in - x86_64|amd64) architecture="amd64" ;; - arm64|aarch64) architecture="arm64";; - *) echo "Architecture not supported, exiting." ; exit ;; - esac - curl -L https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture >./regctl - chmod 755 ./regctl - regbin="./regctl" - else - printf "%s\n" "Dependency missing, quitting." - exit - fi -fi -### Check docker compose binary: -if docker compose &> /dev/null ; then - DockerBin="docker compose" -elif docker-compose &> /dev/null; then - DockerBin="docker-compose" -else - printf "%s\n" "No docker compose binary available, quitting." - exit -fi - -### Numbered List -function: -options() { -num=0 -for i in "${NumberedUpdates[@]}"; do - echo "$num) $i" - ((num++)) -done -} - -### Choose from list -function: -choosecontainers() { - while [[ "$ChoiceClean" =~ [A-Za-z] || -z "$ChoiceClean" ]]; do - printf "What containers do you like to update? \n" - # options - read -p 'Enter number(s) separated by , : ' Choice - if [ "$Choice" == "0" ] ; then - SelectedUpdates=( ${NumberedUpdates[@]:1} ) - ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g') - else - ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g') - for s in $ChoiceClean; do - SelectedUpdates+=( ${NumberedUpdates[$s]} ) - done - fi - done - printf "\nYou've SelectedUpdates:\n" - printf "%s\n" "${SelectedUpdates[@]}" -} - -### Check the image-hash of every running container VS the registry -for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do - printf ". " - RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}') - LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}') - RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null) - # Check if regtcl produces errors - add to GotErrors if so. - if [ $? -eq 0 ] ; then - if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi - else - GotErrors+=("$i") - fi -done - -### Create new Array to use for the numbered list: -NumberedUpdates=(ALL "${GotUpdates[@]}") - -### List what containers got updates or not -if [ -n "$NoUpdates" ] ; then - printf "\n\033[32;1mContainers on latest version:\033[0m\n" - printf "%s\n" "${NoUpdates[@]}" -fi -if [ -n "$GotErrors" ] ; then - printf "\n\033[33;1mContainers with errors, wont get updated:\033[0m\n" - printf "%s\n" "${GotErrors[@]}" -fi -if [ -n "$GotUpdates" ] ; then - printf "\n\033[31;1mContainers with updates available:\033[0m\n" - [ -z "$UpdYes" ] && options || printf "%s\n" "${GotUpdates[@]}" -fi - -### Optionally get updates if there's any -if [ -n "$GotUpdates" ] ; then - if [ -z "$UpdYes" ] ; then - printf "\n\033[36;1mDo you want to update? y/[n]\033[0m " - read UpdYes - [ "$UpdYes" != "${UpdYes#[Yy]}" ] && choosecontainers - else - SelectedUpdates=( "${GotUpdates[@]}" ) - fi - if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then - for i in "${SelectedUpdates[@]}" - do - ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir"}}') - $DockerBin -f "$ContPath/docker-compose.yml" pull - $DockerBin -f "$ContPath/docker-compose.yml" up -d - done - else - printf "\nNo updates installed, exiting.\n" - fi -else - printf "\nNo updates available, exiting.\n" -fi - -exit 0