Periodic Docker images build #37

jtpio · 2019-06-26T11:31:15Z

For now this can be tested by doing a dev install of TLJH and mounting / installing the plugin in the docker container.

TODO

Add script to install and enable the systemd units: python -m tljh_voila_gallery.install_build_units
Make build_images build from gallery.yaml on the master branch (and default to the package resources)
~~Fetch new gallery.yaml (git pull, requests.get...) and trigger build_images when the new version has been fetched~~
~~Should the systemd units be installed automatically on plugin install? Could be an issue when developing locally.~~ Or run python -m tljh_voila_gallery.install_build_units after installing TLJH and the plugin
~~Fix WorkingDirectory for the systemd unit?~~ -> remove
Update build interval: set to 12h
Rename install_build_units
Prune stopped containers and images before building

jtpio · 2019-06-26T15:51:59Z

This is the current state:

Install TLJH with the tljh-voila-gallery plugin
Run sudo /opt/tljh/hub/bin/python3 -m tljh_voila_gallery.install_builder_units to install the systemd unit files
The systemd timer will trigger the service every 12 hours
The service runs the command: python3 -m tljh_voila_gallery.build_images
The build_images script does the following:
- Prune stopped containers
- Prune dangling images
- Build new images from the gallery.yaml hosted at https://raw.githubusercontent.com/voila-gallery/gallery/master/tljh-voila-gallery/tljh_voila_gallery/gallery.yaml

Also installing the systemd units automatically (to be triggered on plugin install) is probably not something we want by default. What do you think @yuvipanda?

yuvipanda · 2019-06-26T16:38:24Z

I think we should install it by default. You can put it in https://github.com/voila-gallery/gallery/blob/master/tljh-voila-gallery/tljh_voila_gallery/__init__.py#L61, which is executed only when you install TLJH on a machine by running the bootstrapper. Nothing actually happens if you just install the tljh package, so this won't affect local development.

Are rebuilds no-ops if the image is already cached? If so I'd say we should do this every 30min or so instead of 12h. If not, we should make it so and then do it every 30min :D Doesn't need to block this PR though

jtpio · 2019-06-26T17:44:14Z

You can put it in https://github.com/voila-gallery/gallery/blob/master/tljh-voila-gallery/tljh_voila_gallery/__init__.py#L61, which is executed only when you install TLJH on a machine by running the bootstrapper.

Right. Do you think it would also make sense to add a new tljh_post_install hook to TLJH specifically for post install scripts? Even though it's true that the tljh_config_post_install or tljh_custom_jupyterhub_config hooks can execute arbitrary python code, that could make the intent clearer.

Are rebuilds no-ops if the image is already cached?

I don't think that's the case for now.

yuvipanda · 2019-06-26T17:54:39Z

Do you think it would also make sense to add a new tljh_post_install hook to TLJH specifically for post install scripts?

Absolutely! Would love a PR!

yuvipanda · 2019-06-26T18:53:12Z

tljh-voila-gallery/tljh_voila_gallery/__init__.py

@@ -59,6 +53,7 @@ def login_url(self, base_url):

 @hookimpl
 def tljh_custom_jupyterhub_config(c):
+    ensure_builder_units()


I just realized this is the wrong place for this. I meant https://github.com/jupyterhub/the-littlest-jupyterhub/blob/master/tljh/hooks.py#L52, which we don't use right now. Should move to a more explicit post-install hook though.

Agreed. The best is indeed to have a dedicated post install hook (will submit a PR for that soon!).

PR to add the tljh_post_install hook to TLJH: jupyterhub/the-littlest-jupyterhub#389

yuvipanda · 2019-06-26T18:54:15Z

tljh-voila-gallery/tljh_voila_gallery/build_images.py

 from ruamel.yaml import YAML

 logging.basicConfig(level=logging.INFO)

 yaml = YAML()

-GALLERY_PATH = 'gallery.yaml'  # Relative to module root
+GALLERY_URL = 'https://raw.githubusercontent.com/voila-gallery/gallery/master/tljh-voila-gallery/tljh_voila_gallery/gallery.yaml'


How would you test this locally? What happens when the format of the yaml file changes but not the code? IMO we should (for now) still load it from the local package, and have some method of autodeployment instead.

Good catch, we should of course support the local gallery.yaml. The same gallery file is also used on the front page so when a new example is added it should also be reflected there.

What happens when the format of the yaml file changes but not the code? IMO we should (for now) still load it from the local package, and have some method of autodeployment instead.

Maybe one way to ensure consistency between the code and the gallery.yaml would be to reinstall / upgrade the plugin? Followed by the build of the docker images.

Rebased to revert back to reading from the local package.

jtpio · 2019-06-28T12:50:06Z

So to trigger a redeployment of the examples, keeping the timer and systemd unit approach, we could think of:

Re-running the same command to upgrade TLJH with the plugin. Although it doesn't look like TLJH support upgrading plugins? (it does for TLJH itself by passing the --upgrade flag)

curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py \
 | sudo python3 - \
   --plugin git+https://github.com/voila-gallery/gallery@master#"egg=tljh-voila-gallery&subdirectory=tljh-voila-gallery"

Reinstalling (and updating) the tljh_voila_gallery package directly:

sudo /opt/tljh/hub/bin/python3 -m pip install -U git+https://github.com/voila-gallery/gallery@master#"egg=tljh-voila-gallery&subdirectory=tljh-voila-gallery"

Both ways would still ensure that gallery.yaml and the code stay in sync.

yuvipanda · 2019-07-01T18:07:02Z

@jtpio I currently like approach 2 - reinstalling the tljh_voila_gallery package. We can do that in a different PR though.

yuvipanda · 2019-07-01T18:07:55Z

tljh-voila-gallery/tljh_voila_gallery/systemd-units/tljh-voila-gallery-builder.timer

+
+[Timer]
+OnBootSec=1min
+OnUnitActiveSec=12h


Let's bring this down to 2h maybe? 12h seems like a long time :D

ah good catch, I thought it was already lowered. Should be fixed now.

jtpio · 2019-07-02T09:23:27Z

We can do that in a different PR though.

Agree, it can be in a follow-up PR.

yuvipanda · 2019-07-03T00:34:13Z

Thanks, @jtpio!

jtpio · 2019-07-03T08:40:41Z

Thanks for reviewing @yuvipanda!

Script to install docker build systemd units

570621f

jtpio changed the title ~~WIP: Periodic Docker images build~~ Periodic Docker images build Jun 26, 2019

yuvipanda reviewed Jun 26, 2019

View reviewed changes

jtpio added 7 commits June 27, 2019 13:15

Add console_scripts entry for install-build-units

04940e8

Set timer to 12h

2309738

Do not restart the service automatically

26c2441

Remove WorkingDirectory from the service unit

3bb8490

Prune stopped containers and dangling images

9aeeca4

Rename script to install_builder_units

2cf1591

Install the systemd units on plugin install

1deeab2

jtpio force-pushed the systemd-builder branch from cec3088 to 1deeab2 Compare June 27, 2019 11:32

yuvipanda reviewed Jul 1, 2019

View reviewed changes

Set build unit time to 2h

12737b5

yuvipanda merged commit 1924639 into master Jul 3, 2019

jtpio deleted the systemd-builder branch July 3, 2019 08:40

jtpio mentioned this pull request Jul 5, 2019

Update the gallery package before building new images #50

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Periodic Docker images build #37

Periodic Docker images build #37

jtpio commented Jun 26, 2019 •

edited

jtpio commented Jun 26, 2019

yuvipanda commented Jun 26, 2019

jtpio commented Jun 26, 2019

yuvipanda commented Jun 26, 2019

yuvipanda Jun 26, 2019

jtpio Jun 26, 2019

jtpio Jun 27, 2019

yuvipanda Jun 26, 2019

jtpio Jun 26, 2019 •

edited

jtpio Jun 27, 2019

jtpio commented Jun 28, 2019

yuvipanda commented Jul 1, 2019

yuvipanda Jul 1, 2019

jtpio Jul 2, 2019

jtpio commented Jul 2, 2019

yuvipanda commented Jul 3, 2019

jtpio commented Jul 3, 2019

Periodic Docker images build #37

Periodic Docker images build #37

Conversation

jtpio commented Jun 26, 2019 • edited

TODO

jtpio commented Jun 26, 2019

yuvipanda commented Jun 26, 2019

jtpio commented Jun 26, 2019

yuvipanda commented Jun 26, 2019

yuvipanda Jun 26, 2019

Choose a reason for hiding this comment

jtpio Jun 26, 2019

Choose a reason for hiding this comment

jtpio Jun 27, 2019

Choose a reason for hiding this comment

yuvipanda Jun 26, 2019

Choose a reason for hiding this comment

jtpio Jun 26, 2019 • edited

Choose a reason for hiding this comment

jtpio Jun 27, 2019

Choose a reason for hiding this comment

jtpio commented Jun 28, 2019

yuvipanda commented Jul 1, 2019

yuvipanda Jul 1, 2019

Choose a reason for hiding this comment

jtpio Jul 2, 2019

Choose a reason for hiding this comment

jtpio commented Jul 2, 2019

yuvipanda commented Jul 3, 2019

jtpio commented Jul 3, 2019

jtpio commented Jun 26, 2019 •

edited

jtpio Jun 26, 2019 •

edited