Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

Add a custom environment

Availability information

Custom execution environment management in NextGen is on by default.

Feature flag: Enable Custom Execution Environments NextGen UI

To add a custom environment, you must upload a compressed folder in .tar, .tar.gz, or .zip format. Be sure to review the guidelines for preparing a custom environment folder before proceeding. You may also consider creating a custom drop-in environment by adding Scoring Code and a start_server.sh file to your environment folder.

Environment and version limits

Next to the + Add environment and the + Add version buttons, there is a User-created environments badge indicating how many environments (or environment versions) you've added and how many environments (or environment versions) you can add in total. With the correct permissions, an administrator can set these limits at a user or group level. The following status categories are available in this badge.

Environment and version limits

Next to the + Add environment and the + Add version buttons, there is a User-created environments badge indicating how many environments (or environment versions) you've added and how many environments (or environment versions) you can add in total. With the correct permissions, an administrator can set these limits at a user, group, or organization level. The following status categories are available in this badge.

Navigate to the Registry and click the Environments tab. Click + Add environment to configure the environment details and add it to the workshop.

In the Add environment panel, provide the following:

Field Description
Environment files
Context file The archive containing a Dockerfile and any other files needed to build the environment image. This file is not required if you supply a pre-built image.
Prebuilt image (Optional + Premium feature) A prebuilt environment image saved as a tarball using the Docker save command.
Configuration
Name The name of the environment.
Supports The DataRobot artifact types supported by the environment: Models and Jobs, Applications, and Notebooks.
Programming Language The language in which the environment was made.
Description (Optional) A description of the custom environment.

Premium feature: Prebuilt images

Prebuilt image upload is a premium feature. Contact your DataRobot representative or administrator for information on enabling the feature.

When all fields are configured, click Add environment. The custom environment is ready for use.

After you upload an environment, it is only available to you unless you share it with other individuals. To make changes to an existing environment, create a new version.

Add an environment version

Troubleshoot or update a custom environment by adding a new version of it to the environment workshop. Navigate to the Registry and click the Environments tab. Click a custom environment, then + Add version to configure the environment details and add it to the workshop.

In the Add environment version panel, provide the following:

Field Description
Environment files
Context file The archive containing a Dockerfile and any other files needed to build the environment image. This file is not required if you supply a pre-built image.
Prebuilt image (Optional + Premium feature) A prebuilt environment image saved as a tarball using the Docker save command.
Configuration
Description (Optional) A description of the custom environment version.

Premium feature: Prebuilt images

Prebuilt image upload is a premium feature. Contact your DataRobot representative or administrator for information on enabling the feature.

All past environment versions are saved, providing an accessible history of the custom environment.

By default, when creating a model version, if the selected execution environment does not change, the version of that execution environment persists from the previous custom model version, even if a newer environment version is available. For more information on how to ensure the custom model version uses the latest version of the execution environment, see Trigger base execution environment update.

Trigger base execution environment update

To override the default behavior for execution environment version selection, where the execution environment version persists between custom model versions even when a new environment version is available, you must temporarily change the Base Environment setting. To do this, create a new custom model version using a different Base Environment setting, then create a new custom model version, switching back to the intended Base Environment. After this change, the latest version of the custom model uses the latest version of the execution environment.

View environment information

There is a variety of information available for each custom and built-in environment. Navigate to the Registry and then click the Environments tab. Click a custom environment, and access the following tabs:

Tab Description
Overview View environment information including:
  • ID (click to copy)
  • Language
  • Supports
  • Created by
View environment version information including:
  • Version ID (click to copy)
  • Description
  • Created
  • Image ID (click to copy)
  • Build Status
  • Content (click Download to download the context file or built image)
  • Logs (click View log to open the Execution environment version log dialog box)
Deployments For environments supporting custom models and jobs, view any associated deployments.
Notebooks For environments supporting notebooks, view any associated notebooks.

Manage environments

You can manage custom environments from the actions menu in the environment list or panel. From the actions menu, you can Share custom environments with anyone in your organization or Delete the custom environment:

Implicit sharing of environments

An environment is not available in the registry for other users unless it was explicitly shared. That does not, however, limit users' ability to use blueprints that include tasks that use that environment. See the description of implicit sharing for more information.


Updated June 18, 2024