whaler
What? A command-line tool for visually investigating the disk usage of docker images
Why? Large images are slow to move and expensive to store. They cost developer productivity by lengthening devops tasks and often contain unnecessary data
Who is this for? Primarily for engineers working with images containing Python packages.
User Stories
This tool should allow you to answer questions such as:
- Which file types are occupying the most disk space?
- Which are my largest Python packages?
- What are my unknown causes of high disk usage?
Quick start
pip install whaler
Run against a local directory
➜ whaler .venv
Running bash -c cd .venv && du -a -k
Done. Serving output at http://localhost:8000 (ctrl+c to exit)
Running python3 -m http.server 8000 --directory=_whaler/html
Run against a docker image
The tool will pull the image first if it is not present.
whaler --image='hl:latest' /
Running docker run --rm --entrypoint=du --workdir=/ hl:latest -a -k
Ignoring what seems to be non-fatal error(s):
du: cannot access './proc/1/task/1/fd/4': No such file or directory
du: cannot access './proc/1/task/1/fdinfo/4': No such file or directory
du: cannot access './proc/1/fd/3': No such file or directory
du: cannot access './proc/1/fdinfo/3': No such file or directory
Done. Serving output at http://localhost:8000 (ctrl+c to exit)
Running python3 -m http.server 8000 --directory=_whaler/html
Play with a hosted demo
Limitations
- Platform: whaler uses
duto gather disk usage data. It must be present in your docker image - Scale: I have tested the web UI with up to 500,000 file system nodes with
duoutput of up to ~100MB.
Alternatives/Complements to this tool:
- Whaler can tell you what is taking up space in the final layer of your Docker image, but you may have intermediate layers which are contributing to the image size. For diving through the layers, use dive
- Related: read up on multi-stage builds to understand how to mitigate the problem of intermediate layers bloating your image.
- For investigating disk usage in non-docker directories, Disk Inventory X is a great tool on OS X which I have based whaler on.
- GoogleContainerTools/distroless for base images not containing standard linux distro contents
See also
Developing
See .github/workflows/test.yml for the development platform and setup.
For UI, see whaler-ui
68 Dec 22, 2022
1 Dec 18, 2021
1 Nov 11, 2021
55 Aug 27, 2022
0 Dec 14, 2021
1 Jan 13, 2022
11 Dec 30, 2022
4 Aug 18, 2022
4 Jan 12, 2022
6 Nov 17, 2022
19 May 06, 2022
1.9k Jan 01, 2023
534 Dec 29, 2022
55.9k Jan 04, 2023
129 Dec 17, 2022
4k Dec 31, 2022
9 Dec 18, 2022
1 Nov 13, 2022
22 Dec 24, 2022
1 Jan 01, 2022
1.3k Dec 30, 2022
13 Nov 11, 2022
5 Dec 10, 2022
287 Nov 09, 2022
13.8k Jan 06, 2023
28.6k Jan 01, 2023
19 Dec 17, 2022
2.3k Jan 06, 2023