Add a contrib Dockerfile for local build image on Linux #4608

agjohnson · 2018-09-05T22:55:31Z

This is necessary as permissions are all incorrect on the paths that are
shared between the host system and the Docker build container.

Closes #2692

humitos

Good that finally, we are solving this issue in an automated way.

I think that there are still some cases to solve/document that I mentioned in the comments. I'd say that after that we can merge this PR.

Summarizing,

re tagging development images
defining setting for python versions

contrib/Dockerfile

contrib/docker_build.sh

docs/development/buildenvironments.rst

contrib/Dockerfile

ericholscher · 2018-11-06T20:39:37Z

Anything we can do to move this along? Seems like a useful improvement.

humitos · 2019-01-09T16:54:57Z

It would be good to finish this PR and merge it. I think it's close.

stale · 2019-03-09T17:05:22Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

codecov · 2019-03-20T18:08:56Z

Codecov Report

Merging #4608 into master will increase coverage by 0.11%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4608      +/-   ##
==========================================
+ Coverage   78.42%   78.54%   +0.11%     
==========================================
  Files         173      164       -9     
  Lines       10692    10089     -603     
  Branches     1357     1279      -78     
==========================================
- Hits         8385     7924     -461     
+ Misses       1958     1831     -127     
+ Partials      349      334      -15

Impacted Files	Coverage Δ
readthedocs/search/views.py	`78.94% <0%> (-11.97%)`	⬇️
readthedocs/analytics/utils.py	`42.85% <0%> (-9.78%)`	⬇️
readthedocs/builds/syncers.py	`33.33% <0%> (-5.23%)`	⬇️
readthedocs/projects/version_handling.py	`91.48% <0%> (-4.26%)`	⬇️
readthedocs/core/views/serve.py	`85.81% <0%> (-3.08%)`	⬇️
readthedocs/builds/models.py	`79.47% <0%> (-3.06%)`	⬇️
readthedocs/sphinx_domains/models.py	`75% <0%> (-1.67%)`	⬇️
readthedocs/gold/views.py	`65.67% <0%> (-1.48%)`	⬇️
readthedocs/projects/views/private.py	`80.62% <0%> (-1.16%)`	⬇️
readthedocs/gold/models.py	`95.65% <0%> (-1.02%)`	⬇️
... and 73 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update edf2e60...22b53d0. Read the comment docs.

This is necessary as permissions are all incorrect on the paths that are shared between the host system and the Docker build container. Closes #2692

humitos · 2019-05-17T12:51:32Z

I rebased this branch and push a new commit to always use latest to build the image and also guide the user to re-tag the Docker image after building it so Read the Docs uses it without changing any setting that could break in other places.

contrib/Dockerfile

This re-reverts back to using label for some of the dockerfile. Also, instead of creating a group, we simply groupmod the existing docs group. This doesn't address the configuration changes necessary for development images yet.

contrib/Dockerfile

docs/development/buildenvironments.rst

agjohnson · 2019-06-06T19:39:10Z

I've updated this pr to use a configurable label in the docker script. The last piece is how to handle DOCKER_IMAGE_SETTINGS, and I think the answer is maybe alter this setting conditionally to point to the dev images.

stsewd

Looks good!

contrib/Dockerfile

contrib/docker_build.sh

contrib/readme.rst

…opment This setting can be used from local_settings.py, and signifies that you have run ``docker_build.sh`` to build local development images that replace the UID/GID.

agjohnson · 2019-06-11T21:56:04Z

I added a quick hack to settings.dev to allow for manual triggering of the docker image name replacement. One last review and I think this is ready.

stsewd

Automatic enough

humitos

👍

agjohnson · 2019-06-13T19:41:34Z

Let's see what new and interesting problems this will likely create for us eventually! 🤞

agjohnson added this to the Development improvements milestone Sep 5, 2018

agjohnson added the Improvement Minor improvement to code label Sep 5, 2018

agjohnson requested a review from a team September 5, 2018 22:56

agjohnson mentioned this pull request Sep 6, 2018

Docker build tip #2692

Closed

humitos requested changes Sep 6, 2018

View reviewed changes

humitos mentioned this pull request Sep 6, 2018

Add cwd to subprocess calls #4611

Merged

ericholscher assigned agjohnson Jan 23, 2019

stale bot added the Status: stale Issue will be considered inactive soon label Mar 9, 2019

stale bot closed this Mar 16, 2019

agjohnson reopened this Mar 20, 2019

stale bot removed the Status: stale Issue will be considered inactive soon label Mar 20, 2019

agjohnson added the Accepted Accepted issue on our roadmap label Mar 20, 2019

ericholscher mentioned this pull request Mar 22, 2019

Added docker set up file #5493

Closed

humitos mentioned this pull request Apr 1, 2019

Run Docker container with a specific user #5556

Closed

agjohnson and others added 2 commits May 17, 2019 14:24

Add a contrib Dockerfile for local build image on Linux

240fe78

This is necessary as permissions are all incorrect on the paths that are shared between the host system and the Docker build container. Closes #2692

Use always latest image to build the Docker image

22b53d0

humitos force-pushed the agj/add-local-dev-docker branch from c3f9aad to 22b53d0 Compare May 17, 2019 12:49

humitos approved these changes May 17, 2019

View reviewed changes

humitos requested a review from a team May 17, 2019 12:52

agjohnson commented Jun 6, 2019

View reviewed changes

contrib/Dockerfile Outdated Show resolved Hide resolved

contrib/Dockerfile Outdated Show resolved Hide resolved

Make image label configurable in docker build script

6ad9930

This re-reverts back to using label for some of the dockerfile. Also, instead of creating a group, we simply groupmod the existing docs group. This doesn't address the configuration changes necessary for development images yet.

agjohnson commented Jun 6, 2019

View reviewed changes

contrib/Dockerfile Show resolved Hide resolved

agjohnson commented Jun 6, 2019

View reviewed changes

docs/development/buildenvironments.rst Show resolved Hide resolved

stsewd reviewed Jun 6, 2019

View reviewed changes

contrib/Dockerfile Show resolved Hide resolved

contrib/docker_build.sh Outdated Show resolved Hide resolved

contrib/readme.rst Outdated Show resolved Hide resolved

agjohnson added 2 commits June 11, 2019 15:26

Update command call for docker_build.sh

16c5ac3

Add configuration option that patches the docker image names in devel…

3d9a84c

…opment This setting can be used from local_settings.py, and signifies that you have run ``docker_build.sh`` to build local development images that replace the UID/GID.

agjohnson requested a review from humitos June 11, 2019 21:56

stsewd approved these changes Jun 11, 2019

View reviewed changes

humitos approved these changes Jun 12, 2019

View reviewed changes

agjohnson merged commit 9dbca65 into master Jun 13, 2019

delete-merged-branch bot deleted the agj/add-local-dev-docker branch June 13, 2019 19:41

humitos mentioned this pull request Oct 16, 2019

Fully working docker-compose file #6295

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a contrib Dockerfile for local build image on Linux #4608

Add a contrib Dockerfile for local build image on Linux #4608

agjohnson commented Sep 5, 2018

humitos left a comment

ericholscher commented Nov 6, 2018

humitos commented Jan 9, 2019

stale bot commented Mar 9, 2019

codecov bot commented Mar 20, 2019 •

edited

Loading

humitos commented May 17, 2019

agjohnson commented Jun 6, 2019

stsewd left a comment

agjohnson commented Jun 11, 2019

stsewd left a comment

humitos left a comment

agjohnson commented Jun 13, 2019

Add a contrib Dockerfile for local build image on Linux #4608

Add a contrib Dockerfile for local build image on Linux #4608

Conversation

agjohnson commented Sep 5, 2018

humitos left a comment

Choose a reason for hiding this comment

ericholscher commented Nov 6, 2018

humitos commented Jan 9, 2019

stale bot commented Mar 9, 2019

codecov bot commented Mar 20, 2019 • edited Loading

Codecov Report

humitos commented May 17, 2019

agjohnson commented Jun 6, 2019

stsewd left a comment

Choose a reason for hiding this comment

agjohnson commented Jun 11, 2019

stsewd left a comment

Choose a reason for hiding this comment

humitos left a comment

Choose a reason for hiding this comment

agjohnson commented Jun 13, 2019

codecov bot commented Mar 20, 2019 •

edited

Loading