Downloading the runtime configuration

Every custom image that you create must be based on one of the standard images that are included in IBM Watson Studio. You can get the name of the image that is used by a runtime from its runtime definition. A runtime definition contains an entry for the registry where the image is stored.

For details on existing runtime definitions, see:

For SPSS Modeler, use the spss-modeler runtime definition.

For details on how to download the runtime definition, see Downloading the runtime definition file.

Runtime definitions for Jupyter notebook images

Table 1. Runtime definitions for standard Jupyter notebook images that are included in Watson Studio
Runtime definition name Image description
jupyter-241l-py JupyterLab with Python 3.11
jupyter-241n-py Jupyter Notebook with Python 3.11
jupyter-241l-pygpu JupyterLab with Python 3.11 with GPU support
jupyter-241n-pygpu Jupyter Notebook with Python 3.11 with GPU support
jupyter-231l-py JupyterLab with Python 3.10
jupyter-231n-py Jupyter Notebook with Python 3.10
jupyter-231l-pygpu JupyterLab with Python 3.10 with GPU support
jupyter-231n-pygpu Jupyter Notebook with Python 3.10 with GPU support
jupyter-241n-r Jupyter Notebook with R 4.3
jupyter-231n-r Jupyter Notebook with R 4.2
Note:

Runtime definitions for RStudio images

For RStudio, use the following runtime definitions:

Table 2. Runtime definitions for the RStudio images that are included in Watson Studio
Runtime definition name Image description
rstudio-241 RStudio with Runtime 24.1 on R 4.3
rstudio-rt3 RStudio with Runtime 23.1 on R 4.2
Note:

RStudio with Runtime 23.1 on R 4.2 is deprecated and will be removed in a future release.

Downloading the runtime definition file

Follow these steps to get the runtime definition by using the Cloud Pak for Data API and store it as a json file:

Note:

Add the -k flag to cURL commands if you get a message about certificate issues. The -k flag disables certificate validation. You might not have to do this.

  1. Get an authorization token. For more information, see Generating an API authorization token.

  2. List the names of all available runtime definitions on the cluster:

    curl -k  -X GET -H "Authorization: ZenApiKey ${TOKEN}" "${CPD_URL}/v2/runtime_definitions" | jq -r ".resources[].entity.name"
    
  3. Download the runtime definition.

    Important:
    • Replace <runtime-definition-name> with the name of the runtime definition that you need for your customization.
    • You must append ?include=launch_configuration to the URL. Without that parameter the result will be incomplete.
    • The customization uses only the value of the entity key.

    myRuntimeDefinition=<runtime-definition-name>; curl -k -X GET -H "Authorization: ZenApiKey ${TOKEN}" "${CPD_URL}/v2/runtime_definitions?include=launch_configuration" | jq '.resources[] | select(.entity.name=="'${myRuntimeDefinition}'") | .entity'  > ${myRuntimeDefinition}.json
    

Parent topic: Building custom images