Skip to content

Installation

The DataRobot Agentic Workflow Templates repository provides ready-to-use templates for building and deploying AI agents with multi-agent frameworks. These templates streamline the process of setting up your own agents with minimal configuration requirements and support both local development and testing, as well as deployment to production environments within DataRobot.

Before running task start (quickstart.py), you can perform the following installation and setup steps.

System requirements

Ensure your system meets the minimum requirements for running DataRobot Agent Templates.

  • Operating System: macOS or Linux (Windows not supported)
  • Python: Version 3.10 or higher

Operating system compatibility

This repository is only compatible with macOS and Linux operating systems. If you are using Windows, consider using a DataRobot Codespace, Windows Subsystem for Linux (WSL), or a virtual machine running a supported OS.

Required tools

Before running any agentic workflow commands, you must have the following tools installed system-wide (not in a virtual environment) so they are always available in your terminal session.

Tool Version Description
git >= 2.30.0 A version control system.
uv >= 0.6.10 A fast Python package installation manager.
Pulumi >= 3.163.0 An infrastructure as code tool to define and manage cloud infrastructure with common programming languages.
Taskfile >= 3.43.3 A task runner and build tool.

Build tools required

You will also need a compatible C++ compiler and associated build tools installed on your system to compile some Python packages. The required tools vary depending on your operating system. For specific setup details, refer to the OS-specific installation instructions below.

Installation instructions

Follow the OS-specific installation commands to install all required tools.

macOS

Install using Homebrew package manager.

brew install git uv pulumi go-task/tap/go-task
xcode-select --install

Linux

Install using package manager and official installation scripts.

Install tools using apt package manager.

sudo apt-get update && sudo apt-get install git build-essential
curl -LsSf https://astral.sh/uv/install.sh | sh
curl -fsSL https://get.pulumi.com/ | sh
curl -sL https://taskfile.dev/install.sh | sh

Install tools using dnf package manager.

sudo dnf install git
sudo dnf groupinstall "Development Tools"
curl -LsSf https://astral.sh/uv/install.sh | sh
curl -fsSL https://get.pulumi.com/ | sh
curl -sL https://taskfile.dev/install.sh | sh

Install tools using yum package manager.

sudo yum install git
sudo yum groupinstall "Development Tools"
curl -LsSf https://astral.sh/uv/install.sh | sh
curl -fsSL https://get.pulumi.com/ | sh
curl -sL https://taskfile.dev/install.sh | sh

Configure an environment

Configure your development environment with the repository and credentials.

Clone the repository

The first step when developing an agentic workflow locally is to clone the DataRobot agentic templates repository.

Download the repository

Alternatively, you can download the repository as a ZIP file and extract it to your preferred location.

You can either clone the repository to your local machine using Git or download it as a ZIP file.

git clone https://github.com/datarobot-community/datarobot-agent-templates.git
cd datarobot-agent-templates

Clone the release branch for your installation using Git:

git clone -b release/11.3 https://github.com/datarobot-community/datarobot-agent-templates.git
cd datarobot-agent-templates

Customizing workflows

To customize or track your own workflows, you can fork this repository, change the remote URL, or create a new repository.

Configure environment variables

Set up your DataRobot API credentials in a local environment file. Create a .env file in the root directory:

nano .env  # or vim .env, code .env, etc.

Alternatively, copy and rename the sample environment file (.env.template) and provide the necessary environment variables in the file.

cp .env.template .env  
# Previously, .env.template was .env.sample

In the .env file, add the required environment variables:

DataRobot credentials in codespaces

If you are using a DataRobot codespace, remove the DATAROBOT_API_TOKEN and DATAROBOT_ENDPOINT environment variables from the file, as they already exist in the codespace environment.

.env
1
2
3
4
5
# Refer to https://docs.datarobot.com/en/docs/api/api-quickstart/index.html#create-a-datarobot-api-key
# and https://docs.datarobot.com/en/docs/api/api-quickstart/index.html#retrieve-the-api-endpoint
# Can be deleted in a DataRobot codespace
DATAROBOT_API_TOKEN=<DATAROBOT_API_TOKEN>
DATAROBOT_ENDPOINT=<DATAROBOT_ENDPOINT>
Environment variable Description
DATAROBOT_API_TOKEN Generate from the DataRobot UI.
DATAROBOT_ENDPOINT
  • Cloud users: https://app.datarobot.com/api/v2, https://app.eu.datarobot.com/api/v2, or https://app.jp.datarobot.com/api/v2.
  • On-premise users: Use your environment's endpoint.

Restricted network setup

In environments without direct internet access (i.e., air-gapped environments), configure Pulumi to install the DataRobot plugin from an internal proxy instead of GitHub. Setting these environment variables redirects all Pulumi plugin downloads to your internal proxy and disables external update checks.

Add the following variables to your .env file:

.env
PULUMI_SKIP_UPDATE_CHECK=1
PULUMI_DATAROBOT_DEFAULT_URL=http://internal-proxy-for-pulumi
# OPTIONAL
PULUMI_DATAROBOT_PLUGIN_VERSION=v0.10.27
Environment variable Required Description
PULUMI_SKIP_UPDATE_CHECK Yes Set to 1 to enable air-gapped mode. This disables external update checks and allows the use of a custom plugin server.
PULUMI_DATAROBOT_DEFAULT_URL Yes The base URL of your internal proxy server hosting the DataRobot Pulumi plugin. This replaces the default GitHub releases source.
PULUMI_DATAROBOT_PLUGIN_VERSION No The specific version of the DataRobot Pulumi plugin to install. If not specified, it defaults to the version bundled with the templates.

How it works

When PULUMI_SKIP_UPDATE_CHECK=1 is set, deployment tasks execute pulumi plugin install resource datarobot <version> --server <url>. This ensures that plugin downloads are routed through your internal proxy instead of external sources.

Internal proxy requirements

The internal proxy must host the DataRobot Pulumi plugin files in a structure compatible with Pulumi's plugin installation. It should mirror the directory and file structure of the official GitHub releases.

Python packages

In restricted network environments, uv sync operations will fail when attempting to reach the public PyPI. To resolve this, configure uv to use your internal PyPI proxy.

To configure the proxy, edit the agent/pyproject.toml file in your agent project and uncomment the [tool.uv.pip] section, replacing the URL with your internal PyPI proxy. For example:

agent/pyproject.toml
[tool.uv.pip]
extra-index-url = ["https://your-internal-pypi-proxy.example.com/simple/"]

Configuration impact

Once configured, this setting ensures that all Python package installations are routed through your proxy. This applies to:

  • Local development (uv sync)
  • Docker image builds
  • Custom model deployments
  • Playground operations
  • Infrastructure deployments

Finding the configuration

The [tool.uv.pip] section is located at the end of the pyproject.toml file. If it is missing, add it manually.