Merge pull request #4 from YanziNetworks/users/emmanuel/active-rm

Active removal of containers

Author: efrecon

Dockerfile

@@ -20,6 +20,7 @@ ENV NAMES=
 ENV EXCLUDE=
 ENV RESOURCES=
 ENV AGE=
+ENV ANCIENT=
 ENV TIMEOUT=
 
 # Add dependency and main script

README.md

@@ -29,9 +29,15 @@ use the `--names` and `--exclude` command-line options to consider only a subset
 of the containers.
 
 Exited and dead containers are as reported by Docker. Stale containers are
-containers that are created but hasn't moved to any other state after a given
+containers that are created but have not moved to any other state after a given
 timeout.
 
+In addition, it is possible to forcedly remove ancient, but still running
+containers using the `--ancient` option. This might be a dangerous operation,
+and it is turned off by default.
+
+  [cprune]: https://docs.docker.com/engine/reference/commandline/container_prune/
+
 ### Images
 
 All dangling and orphan images will be removed. This also provides filtering
@@ -43,6 +49,8 @@ Dangling images are layers that have no relationship to any tagged images.
 Orphan images are images that are not used by any container, whichever state the
 container is in (including created or exited state).
 
+  [iprune]: https://docs.docker.com/engine/reference/commandline/image_prune/
+
 ### Volumes
 
 All "empty" dangling volumes will be removed. The script will count the files
@@ -53,8 +61,6 @@ volumes. Volumes that have a name that was automatically generated are
 automatically selected. File count is achieved through mounting the volumes into
 a temporary [busybox] container.
 
-  [cprune]: https://docs.docker.com/engine/reference/commandline/container_prune/
-  [iprune]: https://docs.docker.com/engine/reference/commandline/image_prune/
   [busybox]: https://hub.docker.com/_/busybox
 
 ## Command-Line Options
@@ -70,10 +76,17 @@ dash, `--`.
 
 ### `-v` or `--verbose`
 
-This will increase the verbosity of the script, output will be sent to the
-`stderr` and lines will contain the name of the script, together with the
-timestamp. When used in interactive mode, the script will automatically colour
-the log.
+This will select the verbosity of the script (default: `info`), output will be
+sent to the `stderr` and lines will contain the name of the script, together
+with the timestamp. When used in interactive mode, the script will automatically
+colour the log. Available levels are: `error`, `warn`, `notice`, `info`,
+`debug`.
+
+### `--non-interactive`, `--no-colour` or `--no-color`
+
+Forcedly remove colouring from logs. Otherwise, logs will be coloured in
+interactive mode, but kept without colouring when invoked within pipes or
+without a (pseudo-)tty.
 
 ### `-h` or `--help`
 
@@ -83,7 +96,7 @@ Print out help and exit.
 
 Just print out what would be perform, do not remove anything at all. This option
 can be used to assess what the script would do when experimenting with options
-such as `--names`, `--exclude` or `--age`.
+such as `--names`, `--exclude`, `--age` or `--ancient`.
 
 ### `-r` or `--resources`
 
@@ -112,7 +125,17 @@ that should be kept.
 ### `-a` or `--age`
 
 Age of dangling images to consider for removal (default: `6m`). The age can be
-expressed in human-readable format, e.g. `6m` (for 6 months), `3 days`, etc.
+expressed in human-readable format, e.g. `6m` (for 6 months), `3 days`, etc. Set
+this to an empty string to skip removal of named dangling images totally.
+
+### `--ancient`
+
+Age of running containers to consider for removal (default: empty). The age can
+be expressed in human-readable format, e.g. `6m` (for 6 months), `3 days`, etc.
+Unnamed containers or containers that match the `--names` and `--exclude` filter
+and exclusion will be forced removed. This operation cannot be undone! The
+default is an empty sting, in which case no running container will ever be
+stopped and removed.
 
 ### `-t` or `--timeout`
 
@@ -142,6 +165,21 @@ parsed at run-time to detect if containers are "unnamed" containers.
   [source]: https://raw.githubusercontent.com/moby/moby/master/pkg/namesgenerator/names-generator.go
   [golang]: https://golang.org/
 
+## Environment Variables
+
+This script also recognises a number of environment variables, these can be used
+instead of (some of) the command-line options. Command-line options always have
+precedence over the environment variables. Recognised variables are:
+
+- `BUSYBOX`: same as `--busybox`
+- `MAXFILES`: same as `--limit`
+- `NAMES`: same as `--names`
+- `EXCLUDE`: same as `--exclude`
+- `RESOURCES`: same as `--resources`
+- `AGE`: same as `--age`
+- `ANCIENT`: same as `--ancient`
+- `TIMEOUT`: same as `--timeout`
+
 ## Docker
 
 This script also comes as a Docker [image]. To be able to run it from a
@@ -163,7 +201,7 @@ to double check what the command would do...
 ```shell
 ./prune.sh \
     --verbose debug \
-    --names '^runner-[[:alnum:]]+-project-[0-9]+-.*' \
+    --names '^runner-[[:alnum:]_]+-project-[0-9]+-.*' \
     --age 2d
 ```
 

prune.sh

@@ -35,6 +35,7 @@ NAMES=${NAMES:-}
 EXCLUDE=${EXCLUDE:-}
 RESOURCES=${RESOURCES:-"images volumes containers"}
 AGE=${AGE:-"6m"}
+ANCIENT=${ANCIENT:-}
 NAMESGEN=https://raw.githubusercontent.com/moby/moby/master/pkg/namesgenerator/names-generator.go
 TIMEOUT=${TIMEOUT:-"30s"}
 INTERMEDIATE=0
@@ -66,12 +67,15 @@ Usage:
     -x | --exclude   Regular expression to exclude from names selected above,
                      this eases selecting away important containers/volumes.
     -a | --age       Age of dangling image to consider it for removal (default:
-                     6m). The age can be expressed in yush_human_period-readable format, e.g.
-                     6m (== 6 months), 3 days, etc.
+                     6m). The age can be expressed in yush_human_period-readable
+                     format, e.g. 6m (== 6 months), 3 days, etc.
+    --ancient        Age of ancient container. Matching or unnamed containers
+                     at least this old will be forced removed. Default is empty,
+                     no removal at all!
     -t | --timeout   Timeout to wait for created containers to change status,
-                     they will be consideyush_red as stale and removed if status has
-                     not changed. This can be expressed in yush_human_period-readable format.
-                     Default is 30 seconds.
+                     they will be consideyush_red as stale and removed if status
+                     has not changed. This can be expressed in human-readable
+                     format. Default is 30 seconds, e.g. 30s.
     --busybox        Docker busybox image tag to be used for volume content
                      collection.
     --namesgen       URL to go implementation for Docker container names
@@ -114,6 +118,11 @@ while [ $# -gt 0 ]; do
         --age=*)
             AGE="${1#*=}"; shift 1;;
 
+        --ancient)
+            ANCIENT="$2"; shift 2;;
+        --ancient=*)
+            ANCIENT="${1#*=}"; shift 1;;
+
         -t | --timeout)
             TIMEOUT="$2"; shift 2;;
         --timeout=*)
@@ -234,10 +243,10 @@ rm_image() {
     # for removal.
     CONSIDER=0
     creation=$(docker image inspect --format '{{.Created}}' "$1")
-    howold=$((now-$(yush_iso8601 "$creation")))
+    howold=$(( now - $(yush_iso8601 "$creation") ))
     if [ -z "$tags" ] && [ -z "$digests" ]; then
         CONSIDER=1
-    elif [ "$howold" -ge "$AGE" ]; then
+    elif [ -n "$AGE" ] && [ "$howold" -ge "$AGE" ]; then
         CONSIDER=1
     fi
 
@@ -254,12 +263,23 @@ rm_image() {
     fi
 }
 
-# Convert period
-if printf %s\\n "$AGE"|grep -Eq '[0-9]+[[:space:]]*[A-Za-z]+'; then
-    NEWAGE=$(yush_howlong "$AGE")
-    yush_debug "Converted yush_human_period-readable age $AGE to $NEWAGE seconds"
-    AGE=$NEWAGE
-fi
+to_seconds() {
+    if [ -n "$1" ]; then
+        if printf %s\\n "$1"|grep -Eq '[0-9]+[[:space:]]*[A-Za-z]+'; then
+            NEWAGE=$(yush_howlong "$1")
+            if [ -n "$NEWAGE" ]; then
+                yush_debug "Converted human-readable age $1 to $NEWAGE seconds"
+                printf %d\\n "$NEWAGE"
+            else
+                abort "Could not convert human-readable $1 to a period!"
+            fi
+        fi
+    fi
+}
+
+# Convert human-readable periods
+AGE=$(to_seconds "$AGE")
+ANCIENT=$(to_seconds "$ANCIENT")
 
 NAMES_DICTIONARY=
 if [ -n "$NAMESGEN" ]; then
@@ -276,7 +296,7 @@ fi
 # Start by cleaning up containers so we can free as many (dependent) resources
 # as possible.
 if printf %s\\n "$RESOURCES" | grep -qo "container"; then
-    yush_notice "Cleaning up exited and dead containers..."
+    yush_notice "Cleaning up exited, dead and ancient containers..."
     for cnr in $(docker container ls -a --filter status=exited --filter status=dead --format '{{.Names}}'); do
         rm_container "$cnr"
     done
@@ -301,6 +321,21 @@ if printf %s\\n "$RESOURCES" | grep -qo "container"; then
             fi
         done
     fi
+
+    if [ -n "$ANCIENT" ]; then
+        now=$(date -u +'%s')
+        for cnr in $(docker container ls --filter status=running --format '{{.Names}}'); do
+            started=$(docker container inspect --format '{{.State.StartedAt}}' "$cnr")
+            started_secs=$(yush_iso8601 "$started")
+            howold=$(( now - started_secs ))
+            if [ "$howold" -gt "$ANCIENT" ]; then
+                yush_info "Container $cnr is $(yush_human_period "$howold")ancient"
+                rm_container "$cnr"
+            else
+                yush_debug "Container $cnr is still young"
+            fi
+        done
+    fi
 fi
 
 if printf %s\\n "$RESOURCES" | grep -qo "volume"; then