Skip to content

Quick start

Get dss-provisioner running and deploy your first resource in under 5 minutes.

1. Install

pip install git+https://github.com/true-north-partners/dss-provisioner.git

Or for development:

git clone https://github.com/true-north-partners/dss-provisioner.git
cd dss-provisioner
uv sync

See Installation for more options.

2. Set up credentials

export DSS_HOST=https://dss.company.com
export DSS_API_KEY=your-api-key

Tip

Store credentials in environment variables rather than YAML to avoid committing secrets to version control.

3. Create a config file

Create dss-provisioner.yaml in your project root:

provider:
  project: MY_PROJECT

datasets:
  - name: raw_data
    type: filesystem
    connection: filesystem_managed
    path: "${projectKey}/raw"

4. Plan, apply, manage

# Preview changes
dss-provisioner plan

# Apply changes
dss-provisioner apply

# Apply without confirmation prompt
dss-provisioner apply --auto-approve

# Detect drift from manual DSS changes
dss-provisioner drift

# Refresh state from live DSS
dss-provisioner refresh

# Validate configuration
dss-provisioner validate

# Tear down all managed resources
dss-provisioner destroy

# Save plan for later apply
dss-provisioner plan --out plan.json
dss-provisioner apply plan.json

What's next?