From 47b0474f381619ad752956d84ea3dc2eea0314b4 Mon Sep 17 00:00:00 2001 From: WickedYoda <68271168+wickedyoda@users.noreply.github.com> Date: Fri, 20 Feb 2026 20:24:01 -0600 Subject: [PATCH] Add remote Docker cleanup script --- .../docker-cleanup-remote.cpython-314.pyc | Bin 0 -> 8232 bytes docker/docker-cleanup-remote.py | 178 ++++++++++++++++++ docker/docker-cleanup-remote.sh | 85 +++++++++ docker/machines.txt | 5 + 4 files changed, 268 insertions(+) create mode 100644 docker/__pycache__/docker-cleanup-remote.cpython-314.pyc create mode 100644 docker/docker-cleanup-remote.py create mode 100755 docker/docker-cleanup-remote.sh create mode 100644 docker/machines.txt diff --git a/docker/__pycache__/docker-cleanup-remote.cpython-314.pyc b/docker/__pycache__/docker-cleanup-remote.cpython-314.pyc new file mode 100644 index 0000000000000000000000000000000000000000..9140010203a4daa71c1084b1c2568a236f0e4d81 GIT binary patch literal 8232 zcmb_hU2q%Mb-oKMfCaGlApsKn0m-HKCrBhjQL-q@mKd7ipF~OMl0lM|A_fAM6eezkg8&%VzjMImn zdlw6U3@y7qOJeWcd(S=h@7!~~bM8sI&4S>$@UPpkzi}hgZ@kmB1 zh^OYMIi0NQ!Fk=hUe=S8mT5@!^M*NtY#?>?ym8JXn@HX;&&-)+a}VlNTUlg_AMuVG zl+5x*58_Q86nDxto`JlXY^}@GRtQB=5Z0#M{q*7on&fAuqbw+>35Hd(qkI zn9ovb<~GIa`Vfb1T8$`b#FRZSTG`Tt7B0rnEBY=JqkPWHYkWGvT~0>s2qG7W3*kgM z#YK|q>)}LH;*tqY6xNfnz}-$tvc$z>k}O2ISb__4valg@tFgG?_fd*9oJb_)upCP! zr0ej_M8mQm$JPbN(}A#j8>b7eXVO&j$>tR{K9UN17qGVd9 z)MTVOyAgFp{?w+zhC#{!om$HkH_!0q11(%yT|L!i2is@K z+?>L)#er~XvX)H9;aEZtrC~0%9$ph5eLWdZ!*&jHAbeaxknbkNJ46V>@%YzDU{sJI zVl0J4P+`}@k=wvLgymDACNf%qza z6*e4=hM<;|DSAm36@3g^Sjcg~HIh%KSk$EoMPnl22`wcou^cC2@esSU7da1q4qsWc z+tl*T?YFzjO+$sIp<?J3Zn z3e#G#H|;uI53c08KX9KaI!7zE={++twCy8>m$;HT5eT+ax9(?}E7wf9TP8ru0GmP_=Fi z`u3u$Pz4$RFUg@NsMqvI54t*wkQsFYC05p78q)IW$oXG@9S{Z?lK{1O$ zI2yv114J+tkI8X3q>^GFc}Qe9z=|=PN(qUmk0v{$7>Man7%_Y|gvk|}G{Rdx$W;Ya zvBZ|bIJhAW+q|@Dg{ifh%KVRq~TyDz``j^DlAE$ z4x@^xs!_x)pdgZ~(6^Gw_}2>U1)!JkK4YOhL3y6xSH)u6)8n+=tER_Ks_D6xN&3`a zerAArb)JnT4C@IpPb2IEm_GPapFqv@X(b5N(Mie>G#n+a4egIGhV}M!k?Taj=_s)T zAq?t*Ajm;I93^ZdtA?}(E!PaG6HQYym*Dsqfy)twGib!7bG$m2yD(F6BV}GPr7S@v zP&26Y8EOY8&{Qweaetkpl~3Xx6yb(?Cl-ujRCHrEEbu;L%F!DQ^lI zS;RAA4Tm{s)l@(fgvN`GZW*-J_abNwwAXoRIiArdG=6I^>aXHgrv?bZYAs$k0#@UX zTl_zdz_xU&?GJ24pr5cV!s8@TM%pCwsj-hrQ!hkG2|CSF)2zJT|cK#mQ44Q>br2OVSs*7?rsc_p0E*<0hC1r zZYk3IYeyq z4lg`aBWl6 zdFbMkp^L?#i4y&-J>7r-(4zgm{hqzj(q3ul!vF5hN;_BSJXY!GskC+NH6gQSADPXT z=dH-y_h4dcs?vX=+&^CEAAh8OyqNDFFZRzD*xs$_?Q<1p%hqJ2x$WJPZ=HO5q})7M zXdcYneYlx#9xOIbLdzFax!T{o^wy=aYpmcJE4t2ZU4F{8mRWCs^=^x~zFbT0*7kCV zJ@JX7x#H|7JGp|B%ehL#GyT9P>&n=bQ|3m7h4%dS} zxxZQCpYNM|-2b@sv6%0@QgU9cc)S3e&5rx*J@zl{&(6Sd>>Wo=_nxIz_}hImVq5l+ z&d^d}n#)XEfoaQkUU+oo(ZC}y-~L*Onfl1#ehN!Yc>He943xhEXrprd3;UPS9Bkz; zr#fdw(LZ|H@OyL!-v89rg5PIa;r;7Q9e$5mXHV*X{YuO1p#FU)J?lsB4;rB4{gZl} z_czZW{Q=01ts%h=Sh2m>_gCRMHsUJi`8s&M29#1OVf!4-QdHkF^4^N5sfuNwy7ttt z%zpvGX>{W?eGSfd4b`lICGeu<8W!TIx)o|D)zwQ^02D8qwB7*pSMi8ef>Vt;(BPhH z_1Y+o!YNuE2>`qRmuU8M4e-f<(d&a0i^dL*wuWMYwb@}uqs9d`?En}0FqejvFlcjw zI2c}uTBv|GYBeuJE{!e;iFh^eHfbEHyz#D+Cs502B^ZU)F~$pfq=R&AriXhpAL_9# z2bOwG!yIcU=|w#rg)q7k4Ji*(SYi?ekh8G&=ukj4@)JwG- z@6fmbdT@^EQ^vZ?E^``{M)M+B3>?#_>uJ!~74AiN#9N)w@^DYfB zze0tmv@Wd=)nc50!Yu)9i?l|N^6qcC0x-vx1DN+{eyv!pdCvh#9XQ@U1JA+QuoG=T zE6}wcpgWpl2chh2q+IrCQwUnYYoS3yoX|?@Y0$!Z$E(toVjB=L_`86qnH6fd!H-EX z4WsMAeKwx)uUI`ocW|~>LGFU)L%humyt}_4Z$fv7_s`X!0rAq%S+EB90WYn7rh0-5 ztSc8Z!}w`U_6|_=22F?NW(MSrqvOEO3$gY-h$>?QeG+K`vj)1{i((MJ?}Fa&-@=7z zJp9=8jQ5&~@wljf!w?X_*u21LfG~4vJ^_#n!jXU|F%W~QP5Cwi`bO5dR4fH?KDD~m zpzE3%ifjloLZqBqO{Npk3tYx^U5!FYY6-N5LJp85#NO4YJBHF6Al3N*2T?*`lMwtF zKMpf$(E;wbglWQ&2r$L0MGlWp3tswwWBa$OkpwP6BHr9BffLqK@}@sy$E>vQ0wxVq zLk+)AdUNS^OoC|xbBy?27r1l+1`+*V$8@Xr2_$ag&oluvmt%>vFu@()Jarw$tx%g8 z%TzcK5#j*m{fa}4%W6O~l(7wbZ(w~O8XA}zxHhnuq5S}N73wbW62yLxri@pMH&^dA z0IqVdMIzi|T;N2A0HBOr+aeq-h856REEyMEizEQ)*X~4Mi!(Im_xm%}i?xT#uw3oq zq6H$0M__RAI_|{0`0c5w>BU9h&&*8DFHB#C9EUGoz!^xz1zGTOi|I&2kfhagHQEgn z&S7pw^<>B*L5XD{xkkd(7dT(58mXOt4irO5gg~zv(8Qrl#UgB^0Qh4m5wYhFuF?jC zI3*GwQw*_0DlLmx(I}=hLBid{Al+f%U(SI|i~7vdHC zje$OK%X~J4#<68JsER{hbw>pJnq*=%Cax_TdsULNXI2 z=3BpUI6rfFw&`-4uh8Zzx=xf`FBM!b6^N6&oGUuc|2`RQ-qTU$^eY{g`M(D%bPp_i?AiRpw+o;Gpswf(jC zue?9&F87`<^qzmzQ|z73b65VkKkvAao!fP|-kJN+n`Os9!7)&D45`7-hixA?Ue3-v zwL5^P&7PfkYHqsUb+7Azl>5$BSJ^yLGLJm$XmBgW|Bm?w_HWr=+VkVH;G?u(DKS@T z)!UbLhIhIj%K3J@il4gMw=VCpO)!fcI`{g{Qoebt#Ga|tT&zFcIlD9X(3bDIRAMJS zYwE-9V0$nAZ}a|?{Rvy?9N4!So9$b#J$E9wE^vCbPyd*GVA^%IY@2iaxz>E^@siV5 zbDeT8?=0=iJnYZ+j(_Mp|J2#K-TPzf10yD9a_*cl-#S!s9du<_uJ^OoKceXN2z zc*nYRI!_`^{5BS5F%L<)roMD`tGngM~R1^3j=gRlng2B=vHP zOM$);xRKRNTeXVZm1)IcT+>>uQE$(*s@06AT3)?Kt5x`1iYXL=O1N3Fz#UT>u2k{; zC-!heaBh$o!7ri&O!$n(W4F{BDI;7|fld^$eHMw*vCgljlA=6~V=&@nTuiQx0FqRd z13sd7iulyy{uVdk26=rNLK`GtO?)x+NHedlC!^`Oa7o;NHV`;Kk_4|kJw;LfhUWeq z9s3kHK0@}7QP;<)?PKKGqxF>gBii+!7K2Ndb$sE3tJ*L8a0T;4GeoSv_(KZ2etSzg zM6+9&lD_>n7WZ3AZwHGOZ=Uu((<8d$w|lb&#JKhmMY$^u*AM1!XYMa0?ESn)Pj;YR Ob(kjy^}iaR;QilX5U#}l literal 0 HcmV?d00001 diff --git a/docker/docker-cleanup-remote.py b/docker/docker-cleanup-remote.py new file mode 100644 index 0000000..a875fff --- /dev/null +++ b/docker/docker-cleanup-remote.py @@ -0,0 +1,178 @@ +#!/usr/bin/env python3 +"""Run Docker cleanup commands on remote hosts listed in a text file.""" + +from __future__ import annotations + +import argparse +import getpass +from datetime import datetime +from pathlib import Path +from typing import List + +try: + import paramiko +except ImportError: # pragma: no cover - runtime environment dependent + paramiko = None + + +DOCKER_COMMANDS = [ + "docker container prune -f", + "docker image prune -a -f", + "docker volume prune -f", + "docker network prune -f", +] + + +def parse_args() -> argparse.Namespace: + script_dir = Path(__file__).resolve().parent + parser = argparse.ArgumentParser( + description=( + "Clean up Docker containers, images, volumes, and networks " + "on all hosts listed in a text file." + ) + ) + parser.add_argument( + "machine_file", + nargs="?", + default=str(script_dir / "machines.txt"), + help="Path to host list file (default: docker/machines.txt).", + ) + parser.add_argument( + "--timeout", + type=int, + default=20, + help="SSH connection timeout in seconds (default: 20).", + ) + return parser.parse_args() + + +def load_hosts(machine_file: Path) -> List[str]: + hosts: List[str] = [] + for raw_line in machine_file.read_text(encoding="utf-8").splitlines(): + line = raw_line.split("#", 1)[0].strip() + if line: + hosts.append(line) + return hosts + + +def run_remote_cleanup( + host: str, username: str, password: str, timeout: int, log_handle +) -> bool: + client = paramiko.SSHClient() + client.set_missing_host_key_policy(paramiko.AutoAddPolicy()) + try: + client.connect( + hostname=host, + username=username, + password=password, + timeout=timeout, + auth_timeout=timeout, + banner_timeout=timeout, + look_for_keys=False, + allow_agent=False, + ) + + for cmd in DOCKER_COMMANDS: + stdin, stdout, stderr = client.exec_command(cmd, timeout=300) + _ = stdin + out = stdout.read().decode("utf-8", errors="replace") + err = stderr.read().decode("utf-8", errors="replace") + code = stdout.channel.recv_exit_status() + + log_handle.write(f"$ {cmd}\n") + if out: + log_handle.write(out) + if not out.endswith("\n"): + log_handle.write("\n") + if err: + log_handle.write(err) + if not err.endswith("\n"): + log_handle.write("\n") + + if code != 0: + log_handle.write(f"Command failed with exit code {code}\n") + return False + return True + except Exception as exc: # pylint: disable=broad-except + log_handle.write(f"Connection or execution error: {exc}\n") + return False + finally: + client.close() + + +def main() -> int: + args = parse_args() + + if paramiko is None: + print("Missing dependency: paramiko") + print("Install it with: python -m pip install paramiko") + return 1 + + machine_file = Path(args.machine_file).expanduser().resolve() + if not machine_file.exists(): + print(f"Machine list file not found: {machine_file}") + return 1 + + hosts = load_hosts(machine_file) + if not hosts: + print(f"No hosts found in: {machine_file}") + print("Add one hostname or IP per line.") + return 1 + + username = input("SSH username (same account for all machines): ").strip() + if not username: + print("Username cannot be empty.") + return 1 + + password = getpass.getpass("SSH password: ").strip() + if not password: + print("Password cannot be empty.") + return 1 + + print( + "This will remove unused Docker containers, images, volumes, and " + "networks on all listed hosts." + ) + confirm = input("Continue? (y/N): ").strip().lower() + if confirm != "y": + print("Cancelled.") + return 0 + + log_name = f"docker_cleanup_{datetime.now().strftime('%Y%m%d_%H%M%S')}.log" + log_path = Path(__file__).resolve().parent / log_name + + success = 0 + failed = 0 + + with log_path.open("w", encoding="utf-8") as log_handle: + log_handle.write(f"Docker cleanup run started: {datetime.now()}\n") + log_handle.write(f"Machine file: {machine_file}\n\n") + + for host in hosts: + print(f"Running cleanup on {host} ...") + log_handle.write(f"========== {host} ==========\n") + + ok = run_remote_cleanup( + host=host, + username=username, + password=password, + timeout=args.timeout, + log_handle=log_handle, + ) + + if ok: + success += 1 + print(f"SUCCESS: {host}") + log_handle.write(f"SUCCESS: {host}\n\n") + else: + failed += 1 + print(f"FAILED: {host}") + log_handle.write(f"FAILED: {host}\n\n") + + print(f"Run complete. Successful hosts: {success}, Failed hosts: {failed}") + print(f"Log file: {log_path}") + return 0 if failed == 0 else 2 + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/docker/docker-cleanup-remote.sh b/docker/docker-cleanup-remote.sh new file mode 100755 index 0000000..4a599c4 --- /dev/null +++ b/docker/docker-cleanup-remote.sh @@ -0,0 +1,85 @@ +#!/usr/bin/env bash + +set -u + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +MACHINE_FILE="${1:-$SCRIPT_DIR/machines.txt}" +LOG_FILE="$SCRIPT_DIR/docker_cleanup_$(date +%Y%m%d_%H%M%S).log" + +if [[ ! -f "$MACHINE_FILE" ]]; then + echo "Machine list file not found: $MACHINE_FILE" + echo "Create it with one hostname or IP per line." + exit 1 +fi + +if ! command -v sshpass >/dev/null 2>&1; then + echo "sshpass is required but not installed." + echo "Install it and run the script again." + exit 1 +fi + +read -r -p "SSH username (same account for all machines): " SSH_USER +if [[ -z "$SSH_USER" ]]; then + echo "Username cannot be empty." + exit 1 +fi + +read -r -s -p "SSH password: " SSH_PASS +echo +if [[ -z "$SSH_PASS" ]]; then + echo "Password cannot be empty." + exit 1 +fi + +trap 'unset SSH_PASS' EXIT + +echo "This will remove unused Docker containers, images, volumes, and networks on all listed hosts." +read -r -p "Continue? (y/N): " CONFIRM +if [[ ! "$CONFIRM" =~ ^[Yy]$ ]]; then + echo "Cancelled." + exit 0 +fi + +echo "Docker cleanup run started: $(date)" | tee "$LOG_FILE" +echo "Machine file: $MACHINE_FILE" | tee -a "$LOG_FILE" +echo | tee -a "$LOG_FILE" + +SUCCESS_COUNT=0 +FAIL_COUNT=0 + +while IFS= read -r RAW_LINE || [[ -n "$RAW_LINE" ]]; do + HOST="$(printf '%s' "$RAW_LINE" | sed 's/#.*$//' | xargs)" + + if [[ -z "$HOST" ]]; then + continue + fi + + echo "========== $HOST ==========" | tee -a "$LOG_FILE" + + if sshpass -p "$SSH_PASS" ssh \ + -o StrictHostKeyChecking=no \ + -o UserKnownHostsFile=/dev/null \ + -o ConnectTimeout=12 \ + "$SSH_USER@$HOST" 'bash -s' >>"$LOG_FILE" 2>&1 <<'REMOTE_CLEANUP' +set -e + +docker container prune -f +docker image prune -a -f +docker volume prune -f +docker network prune -f +REMOTE_CLEANUP + then + echo "SUCCESS: $HOST" | tee -a "$LOG_FILE" + SUCCESS_COUNT=$((SUCCESS_COUNT + 1)) + else + echo "FAILED: $HOST" | tee -a "$LOG_FILE" + FAIL_COUNT=$((FAIL_COUNT + 1)) + fi + + echo | tee -a "$LOG_FILE" +done < "$MACHINE_FILE" + +echo "Run complete: $(date)" | tee -a "$LOG_FILE" +echo "Successful hosts: $SUCCESS_COUNT" | tee -a "$LOG_FILE" +echo "Failed hosts: $FAIL_COUNT" | tee -a "$LOG_FILE" +echo "Log file: $LOG_FILE" diff --git a/docker/machines.txt b/docker/machines.txt new file mode 100644 index 0000000..de78d39 --- /dev/null +++ b/docker/machines.txt @@ -0,0 +1,5 @@ +# One hostname or IP per line. +# Lines starting with # are ignored. +# Example: +# docker-host-01 +# 192.168.1.20