How to remove pre-configured runtime image configurations (or add your own)

[ptitzler]

Elyra uses runtime images to execute generic pipeline nodes. The Elyra installation pre-configures multiple example runtime image configurations to make it easier to get started with pipelines. These configurations are associated with container images that are provided as-is and should not be used in production environments. You can remove these runtime image configurations or add your own runtime image configurations by following the instructions below.

Background information

pip install elyra pre-installs this set of runtime image configuration metadata files by default in the {sys.prefix}/share/jupyter/metdata/runtime-images Jupyter data directory.

$ pip install elyra
  ...

$ elyra-metadata list runtime-images
Available metadata instances for runtime-images (includes invalid):

Schema          Instance               Resource                                                                                       
------          --------               --------                                                                                       
runtime-image   anaconda               /path/to/share/jupyter/metadata/runtime-images/anaconda.json     
 ...        

When JupyterLab/Elyra starts up, these configurations are pre-loaded and listed in the runtime image configuration panel:

If a user makes an attempt to remove these images using the GUI or the CLI an error is raised:

Removing the example runtime image configurations

To remove the read-only example configurations:

• Locate the Jupyter data directory where the example runtime image configuration metadata files were pre-installed:

  $ elyra-metadata list runtime-images
  Available metadata instances for runtime-images (includes invalid):
  
  Schema          Instance               Resource                                                                                       
  ------          --------               --------                                                                                       
  runtime-image   anaconda               /path/to/share/jupyter/metadata/runtime-images/anaconda.json               
  ...
  

  Note: The path (in above example /path/to) is specific to your runtime environment.

• Remove the desired files

  # Remove a specific example runtime image configuration
  $ rm /path/to/share/jupyter/metadata/runtime-images/anaconda.json
  # Remove all example image configurations
  $ rm /path/to/share/jupyter/metadata/runtime-images/*.json
  

Note: If you re-install Elyra the example runtime image configurations will be recreated.

Adding your own runtime image configurations

You can add your own runtime image configurations after installing Elyra.

Adding adding runtime image configurations

Read/write runtime image configurations can be modified and deleted by users using the JupyterLab GUI and the elyra-metadata CLI.

To add a read/write runtime image configuration to an Elyra installation run the elyra-metadata create runtime-images command, replacing <..._placeholder> below as appropriate:

$ elyra-metadata create runtime-images \
       --name "<name_placeholder>" \
       --display_name "<display_name_placeholder>" \
       --description "<description_plaeholder>" \
       --image_name "<container_image_placeholder>" \
       --pull_policy "<policy_placeholder>"

Refer to the documentation for a list of supported parameters. Note that the referenced container image must meet the prerequisites listed in the Creating a custom runtime container image documentation topic

Example:

$ elyra-metadata create runtime-images \
       --name "my_image_name" \
       --display_name "My runtime image" \
       --description "My other custom runtime container image" \
       --image_name "jdoe/my-other-image:1.0.1" \
       --pull_policy "IfNotPresent"

yields: