spurin / diveintoansible-lab

Dive Into Ansible Lab
900 stars 558 forks source link

Add cleanup script #123

Open sdavids opened 11 months ago

sdavids commented 11 months ago

Hi,

please add a cleanup script to your repo.

After finishing the course one should be able to easily get rid of everything.

The easiest way would be to label all your images, volumes, and networks.


Open Container Initiative - Pre-Defined Annotation Keys

Dockerfile - LABEL Compose file / Networks / labels Compose file / Volumes / labels Compose file / Services / labels


Dockerfile

LABEL org.opencontainers.image.vendor="io.diveinto"

docker-compose.yml

networks:
  diveinto.io:
    name: diveinto.io
    labels:
      org.opencontainers.image.vendor: io.diveinto

You currently use anonymous volumes, so you might want to convert them to named volumes with a label and/or you might want to update your README:

https://github.com/spurin/diveintoansible-lab/blob/b9205dff5607cbc08420338fc0b97e14d8211439/README.md?plain=1#L191

docker-compose rm -v

docker compose rm / options


Instead of (in addition to) org.opencontainers.image.vendor you might want to use your own label io.diveinto.docker.group="diveintoansible-lab" for example.


This is how the cleanup script could look like:

#!/usr/bin/env sh

set -eu

readonly label="org.opencontainers.image.vendor=io.diveinto"

docker-compose rm -v

docker container prune --force --filter="label=${label}"

docker volume prune --force --all --filter="label=${label}"

docker image prune --force --all --filter="label=${label}"

docker network prune --force --filter="label=${label}"

docker image prune - filtering

spurin commented 11 months ago

Thanks for your feedback and insight @sdavids - appreciated.

We use host volume mounts for persistence and the ability to edit files locally, that said though it's not used that often even though it's a feature.

I've been considering removing this and may switch to standard volumes. This is the only variable for me in this feedback, the rest of it are logical improvements.

Again, thanks for your input on this

mvtab commented 3 months ago

I know it's not optimal, but since the only problems are the images and local volumes, you can cleanup like this, while the compose setup is running and you are in the lab root directory:

DIVEINTO_IMAGES=$(docker compose images -q)
docker compose down
docker rmi ${DIVEINTO_IMAGES}
rm -rf ./ansible_home

This will delete all the related images and all the local volumes of the lab. Save your data first, if needed.

spurin commented 3 months ago

Love that approach! It's slick 🙏