Addon default image

Impacts all add-ons.

Addons are executed within an image that provides a Python environment and Animator in different versions. Additional Python packages, if the requirement file is placed in backend/requirements.txt, are automatically installed.

Since the introduction of .addon.yaml as the new way to define how addons work, addons can specify their own custom image and have full power over how to set up their environment.

The image provided by the application is deprecated and will be removed eventually. On removal, any addons which do not specify an image (see below) will fail and won’t be executed anymore.

There are two possible solutions:

1. Global default image set on the runner
   The Helm values provide a setting which can be used to set up a default image that all addons will use as long as they do not specify their own one. Adjust worker.runner.defaultImage with the name of the image:

   worker:
     runner:
       defaultImage: python:3.10.13
   

2. Update addons to specify an image to use
   

   Requires that addons are already migrated to make use of the new .addon.yaml specification.

   Any addon can set which image is used when it is being executed. It will take precedence over the default image defined on the runner. Adjust runner.actions.<action>.image within .addon.yaml:

   runner:
     actions:
       default: # identifier of the action
         image: python:3.10