provision

This guide shows you how to provision a Datafye Foundry deployment on your local machine using Docker containers.

Prerequisites

Before you begin, ensure:

• The Datafye CLI is installed (see Installation)

• Docker Desktop is installed and running on your machine

• You have created the required descriptor files (see Deployment Descriptors)

Provision Command

Use the following command to provision a local Foundry deployment:

datafye foundry local provision [options]

Parameters

Descriptor Parameters

You must provide descriptor files using one of the following approaches:

Option 1: Combined descriptor file

Parameter	Description
--descriptor <path>	Path to a combined descriptor file containing data (and optionally algo) configuration

Option 2: Separate descriptor files

Parameter	Description
--data-descriptor <path>	Path to data descriptor file (required)
--algo-descriptor <path>	Path to algo descriptor file (optional - only for Full Stack scenario)

Run datafye help foundry local provision to see the complete parameter list and usage.

Foundry Scenarios

Local Foundry deployments support two scenarios:

Data Cloud Only

Provisions only the Data Cloud, allowing you to use your own algo containers.

Required descriptors:

• Data descriptor only

Example:

datafye foundry local provision --data-descriptor data.yaml

Full Stack

Provisions Data Cloud, Algo Container runtime, Backtesting Engine, and MCP Server.

Required descriptors:

• Data descriptor

• Algo descriptor

Example:

datafye foundry local provision \
  --data-descriptor data.yaml \
  --algo-descriptor algo.yaml

Or using a combined descriptor:

datafye foundry local provision --descriptor foundry.yaml

Provisioning Process

During provisioning, the CLI will:

1. Validate descriptors - Check schema, semantics, and dependencies

2. Pull Docker images - Download required container images

3. Create Docker network - Set up isolated network for services

4. Start services - Deploy Data Cloud (and Algo Container/Backtesting/MCP if Full Stack)

5. Configure connectivity - Connect to data providers using your credentials

6. Run health checks - Verify all services are running correctly

7. Display access information - Show URLs and connection details

The provisioning process may take 5-10 minutes depending on your internet connection and system resources. Do not interrupt the provisioning process.

After Provisioning

Once provisioning completes successfully, you'll see output with:

• API base URLs for accessing Datafye services

• WebSocket endpoint for real-time data streams

• MCP server endpoint (Full Stack only)

• Health check commands to validate connectivity

Accessing Your Deployment

The local deployment will be accessible at:

• Data Cloud REST API: http://localhost:8080/datafye-api/v1/

• Data Cloud WebSocket: ws://localhost:8080/datafye-ws

• MCP Server (Full Stack only): http://localhost:3000

Validate Connectivity

Test your deployment with:

# Check Data Cloud health
curl http://localhost:8080/datafye-api/v1/health

# Get security master
curl http://localhost:8080/datafye-api/v1/stocks/reference/security-master

Your local Foundry deployment is now running and ready to use!

Next Steps

After provisioning:

• Data Cloud Only: Connect your own algo containers to the Data Cloud APIs (see Building Your First Algo - Using Own Container)

• Full Stack: Start developing your algo using the SDK (see Building Your First Algo - Using Datafye Container)

• Run backtests: Test your strategy with historical data (see Backtesting Your Algo)

Troubleshooting

Docker Not Running

If you see an error about Docker not being available:

1. Ensure Docker Desktop is installed

2. Start Docker Desktop

3. Wait for Docker to fully start (check the system tray/menu bar icon)

4. Retry the provision command

Port Conflicts

If ports are already in use:

1. Stop any services using the conflicting ports (typically 8080, 3000)

2. Or deprovision any existing local deployment first: datafye foundry local deprovision

3. Retry the provision command

Insufficient Resources

If provisioning fails due to resource constraints:

1. Ensure Docker has adequate resources allocated:

   • Minimum 8GB RAM

   • Minimum 20GB disk space

2. Close unnecessary applications

3. In Docker Desktop preferences, increase allocated resources if needed

Descriptor Validation Errors

If descriptor validation fails:

1. Review the error message for specific field issues

2. Check descriptor format matches the schema (see Deployment Descriptors)

3. Verify referenced resources exist (container images, symbols)

4. Ensure credentials are provided via environment variables if using ${VAR} syntax

Data Provider Connection Errors

If data provider connections fail:

1. Verify your data provider credentials are correct

2. Check environment variables are set if using variable substitution

3. Ensure your data provider account is active and has necessary permissions

4. Review data provider status (some providers may have API outages)

Related Commands

• Start a Local Foundry - Start a stopped deployment

• Stop a Local Foundry - Stop a running deployment

• Deprovision a Local Foundry - Remove the deployment

---

Last updated: 2025-10-22