Skip to main content

Deployments

Promote sources, destinations, and pipelines across workspaces (dev → stage → prod) with automatic dependency analysis.

Overview​

Deployments enable cross-workspace promotion of sources, destinations, and pipelines. Build and test in a development workspace, then deploy to staging and production environments. The deployment system automatically analyzes dependencies, identifies missing requirements, and tracks all changes.

Common use cases:

  • Promote tested pipelines from dev to prod
  • Set up new environments (copy sources and destinations to stage/prod)
  • Deploy multiple related objects together in batches
  • Maintain consistency across workspaces

Prerequisites: At least two workspaces (source and destination).

To access: Navigate to Deployments in the sidebar, then click + Create Deployment.


Deployments List​

The deployments list shows deployment history for objects deployed FROM the current workspace.

List Columns​

ColumnDescription
TypeDatasource or Pipeline
ObjectName of object deployed
Source → DestinationWorkspace flow (e.g., "Dev → Prod")
Started AtWhen deployment began
DurationExecution time
StatusSucceeded, Failed, Skipped, Deploying, etc.
ActionCreate, Update, or Skip
DetailsView deployment details modal

Search and Filters​

Search Bar:

  • Search by object name or workspace name
  • Real-time filtering

Type Filter:

  • All Types, Datasource, Pipeline

Status Filter:

  • All Status, Succeeded, Failed, Skipped, Analyzing, Deploying

Refresh:

  • Manual refresh button
  • Shows "Last refreshed: X minutes ago"

Deployment Details Modal​

To open: Click Details button on any deployment row

The modal shows:

  • General Information - Start/end time, duration, action, workspaces, created by
  • Analysis - Warnings, errors, missing dependencies
  • Metadata - Deployment options, affected objects
  • Errors - Full error message if deployment failed

Creating a Deployment​

To start:

  1. Navigate to Deployments in the sidebar
  2. Click + Create Deployment
  3. The deployment wizard opens (5 steps)

Step 1: Select Type​

Choose what to deploy:

  • Datasource - Deploy source or destination connection
  • Pipeline - Deploy ingestion or activation pipeline

Click Continue.


Step 2: Select Destination Workspace​

Choose target workspace:

The workspace list shows all workspaces except the current one. Each workspace displays:

  • Workspace name
  • Environment badge (Dev, Stage, Prod, or none)
  • Last updated timestamp

Common promotion paths:

  • Dev → Stage → Prod (recommended)
  • Dev → Prod (skip staging)

Select a workspace and click Continue.


Step 3: Select Items to Deploy​

Choose objects to deploy:

For Datasources:

  • List of all active sources and destinations in the current workspace
  • Shows connector icon, name, API name, state
  • Multi-select with checkboxes

For Pipelines:

  • List of all active pipelines in current workspace
  • Shows pipeline icon, pipeline name, API name, project, source → destination
  • Multi-select with checkboxes

Select one or more items and click Continue.


Step 4: Analyze Dependencies​

The system automatically analyzes each selected item:

  1. Checks if object exists in destination:

    • Exists → Action: Update (if overwrite enabled) or Skip
    • Doesn't exist → Action: Create
  2. Checks for missing dependencies:

    • Pipelines require their source and destination connections
    • If missing → Shows error with "Add Dependencies" button

Analysis Results Table:

ColumnDescription
ObjectName of item being deployed
ActionCreate, Update, or Skip
StatusReady (✅) or Error (❌)
MessagesWarnings and errors

Add Dependencies Button:

  • Automatically adds missing sources and destinations to the deployment
  • Sources and destinations deploy first, then pipelines (correct order)

Deployment Options:

  • Overwrite existing objects - Update existing objects in destination (default: off)
  • Force overwrite even with active pipelines - Update existing connections in the target workspace when deploying pipelines (default: off)

Review warnings/errors, add dependencies if needed, configure options, then click Continue.


Step 5: Review & Deploy​

Final review before deployment:

Summary:

  • Destination workspace name and environment
  • Deployment type (Datasource or Pipeline)
  • Count of items to create, update, or skip

Options Summary:

  • Overwrite existing: Yes/No
  • Force overwrite with pipelines: Yes/No

Impact Warnings:

  • Lists objects that will be created or overwritten

To deploy: Click Deploy


What Happens After Deployment​

Deployment process:

  1. Analyzing - Validates dependencies in destination workspace
  2. Deploying - Deploys sources and destinations first, then pipelines
  3. Succeeded or Failed - Updates deployment history

You are redirected to the deployments list where the new deployment appears at the top. Refresh the page to check status updates.


Deployment Statuses​

StatusDescription
AnalyzingChecking dependencies and validating
DeployingExecuting deployment
SucceededSuccessfully deployed
FailedDeployment encountered errors
SkippedObject unchanged, skipped

Deployment Actions​

ActionDescription
CreateCreate new object in destination (object doesn't exist)
UpdateOverwrite existing object (object exists and "Overwrite" enabled)
SkipDo nothing (object exists and "Overwrite" disabled)

Troubleshooting​

Deployment Failed with "Missing Dependency"​

Problem: Pipeline deployment fails because source or destination doesn't exist.

Solution:

  • Click Add Dependencies button during analysis step
  • Or manually create the missing source or destination in the target workspace first
  • Then retry deployment

Deployment Stuck in "Analyzing"​

Problem: Deployment shows "analyzing" status for extended period.

Solution:

  • Refresh deployments page to check for status update
  • If still analyzing after 5 minutes, contact support

Overwrite Didn't Update Object​

Problem: Enabled "Overwrite existing" but object wasn't updated.

Solution:

  • Check deployment details for error messages
  • Verify you have permissions in destination workspace
  • Common issues: validation errors, object locked by another user

Pipeline Deployed but Shows "Inactive"​

Problem: Pipeline deployed successfully but state is "inactive" in destination.

Solution:

  • Deployed pipelines inherit state from source
  • Activate source pipeline before deploying, or manually activate in destination

Can't Find Destination Workspace​

Problem: Expected workspace doesn't appear in destination selection.

Solution:

  • Workspace must be active
  • You must have owner/editor role in destination workspace
  • Can't deploy to current workspace (deployment is always to a different workspace)
  • Refresh page if workspace list is stale


Support​

Need help? Contact us at support@supa-flow.io