Skip to content

Docker instructions should estimate size #5554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jasonaowen opened this issue Apr 1, 2019 · 1 comment · Fixed by #5630
Closed

Docker instructions should estimate size #5554

jasonaowen opened this issue Apr 1, 2019 · 1 comment · Fixed by #5630
Labels
Good First Issue Good for new contributors Needed: documentation Documentation is required

Comments

@jasonaowen
Copy link

Details

The instructions on setting up a Docker build environment describe pulling the build image, but give no sense of how much space will be required. The Docker Hub list of tags does not seem to accurately describe how much space the assembled image requires.

Running docker images after pulling gives a more accurate estimate:

$ docker images
REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
readthedocs/build   latest              6b9ab0a5ddaf        12 months ago       8.86GB

...but still does not account for the temporary space needed to download, decompress, and apply layers.

On my machine, that image required approximately 10GB of space in Docker's data root (which, in the Ubuntu-packaged version, defaults to /var/lib/docker).

(See also #5553, as readthedocs/build:latest may not be the best image to use for estimating.)

Expected Result

The installation instructions should estimate the minimum amount of disk space required, so that users can make sure they are prepared before downloading several gigabytes.

Actual Result

I had to free up extra space and retry the download.

@humitos humitos added the Needed: documentation Documentation is required label Apr 2, 2019
@stsewd
Copy link
Member

stsewd commented Apr 24, 2019

We could mention that each image is around 5 and 9 GB

This are my local images

readthedocs/build-dev                           2.0                         2 months ago        5.48GB
readthedocs/build-dev                           3.0                         2 months ago        8.87GB
readthedocs/build-dev                           stable                      2 months ago        8.87GB
readthedocs/build-dev                           4.0                         2 months ago        6.8GB
readthedocs/build-dev                           latest                      2 months ago        6.8GB

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good for new contributors Needed: documentation Documentation is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants