Downloading the runtime definition

Every custom image that you create must be based on one of the standard images that are included in 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.

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-251l-py JupyterLab with Python 3.12
jupyter-251n-py Jupyter Notebook with Python 3.12
jupyter-251l-pygpu JupyterLab with Python 3.12 with GPU support
jupyter-251n-pygpu Jupyter Notebook with Python 3.12 with GPU support
jupyter-251n-r Jupyter Notebook with R 4.4

Runtime definitions for RStudio images

Table 2. Runtime definitions for the RStudio images that are included in Watson Studio
Runtime definition name Image description
rstudio-251 RStudio with Runtime 25.1 on R 4.4

Runtime definitions for SPSS Modeler images

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

Downloading the runtime definition file

Follow these steps to get the runtime definition by using the API and store it as a json file:
  1. Get an authorization token. 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"
    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.
  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 -ksS -X GET -H "Authorization: ZenApiKey ${TOKEN}" "${CPD_URL}/v2/runtime_definitions?include=launch_configuration" | jq '.resources[] | select(.entity.name=="'${myRuntimeDefinition}'") | .entity'  > ${myRuntimeDefinition}-server.json