Skip to main content
Last verified: 2024-12-26 This guide is for administrators who need to configure and manage Veratrace environments. Related: Source: Feature Inventory

​
Environment Overview

Veratrace instances can be configured for different environments (development, staging, production). Each environment requires separate instance configuration and AWS Cognito setup. Source: Source: Feature Inventory

​
Development Environment

API Base URL: http://localhost:8080 Frontend URL: http://localhost:5173 Source: Source: Feature Inventory

​
Instance Configuration

Each environment requires:
  • Instance ID - Unique identifier for the instance
  • AWS Cognito User Pool ID - Format: region_xxxxxxxx
  • OIDC Client ID - Cognito OIDC client identifier
  • Region - AWS region (extracted from userPoolId)
Source: Source: Feature Inventory

​
Fetch Instance Configuration

API: GET /instances/:id Example: 
curl -X GET "http://localhost:8080/instances/6d0e296f-24c2-4ea6-989f-394565723291"
Response: 
{
  "id": "6d0e296f-24c2-4ea6-989f-394565723291",
  "userPoolId": "us-east-1_xxxxxxxx",
  "clientId": "...",
  "region": "us-east-1"
}
Source: Source: Feature Inventory

​
AWS Cognito Configuration

Each environment should use a separate Cognito User Pool:

​
Development

  • Separate user pool for testing
  • Lower security requirements
  • Test users only

​
Staging

  • Separate user pool for staging
  • Production-like configuration
  • Staging users only

​
Production

  • Production user pool
  • Full security requirements
  • Production users only
Source: Source: Feature Inventory

​
Create Cognito User Pool

  1. Create AWS Cognito User Pool
  2. Note User Pool ID (format: region_xxxxxxxx)
  3. Create OIDC client in the User Pool
  4. Note Client ID
  5. Configure redirect URI (default: http://localhost:5173/ for development)
Source: /Users/vincentgraham/clearline-ui/src/app/auth/auth.js

​
Environment Variables

​
Deployment

​
Environment Isolation

Each environment maintains separate:
  • Users
  • TWU models
  • Agents
  • Integrations
  • Work ledger entries
Source: Source: Feature Inventory (all endpoints are instance-scoped)