search

jupyterhub / binderhub

Run your code in the cloud, with technology so advanced, it feels like magic!
https://binderhub.readthedocs.io
BSD 3-Clause "New" or "Revised" License
2.57k stars 390 forks source link

Simplify image-cleaner handling #1588

Closed sgaist closed 1 year ago

sgaist commented 1 year ago

This is a follow up of #1531.

This patch refactors the creation and handling of the image cleaner daemonset.

The current behaviour makes it so that if one doesn't disable the host cleaner explicitly when using dind (or pink), they would end up with two cleaners instead of one.

The new behaviour avoids this issue by ensuring that only the container matching the selected imageBuilderType is created. Same goes for the volumes handling.

In order to have consistent naming, the "local" imageBuilderType enumeration value is replaced with "host".

It also deprecates the use of the imageCleaner.host.enabled parameter as you either want image cleanup or not.

manics commented 1 year ago

I've marked this as breaking since it should be considered in conjunction with #1531 so they're best treated as one larger change.

sgaist commented 1 year ago

One practical question for NOTES.txt: I used 0.3.0 as "breaking" version number based on the current tag list from the repository but it will likely be something else. Is there a policy with regard to that kind of value and how to manage it ?

manics commented 1 year ago

For this repo- not at the moment. I'm inclined to not specify the version since the current advice is to always run the latest main branch (this is what we do in https://github.com/jupyterhub/mybinder.org-deploy) so. You could perhaps link to the relevant PR(s) instead?

There's more ongoing refactoring (such as https://github.com/jupyterhub/binderhub/issues/1318 https://github.com/jupyterhub/binderhub/pull/1521) but when the repo is more stable we could consider a 1.0.0 release but that's a separate discussion!