Configuration

Kasho uses environment variables for service configuration and a YAML file for transformation rules.

Environment Variables

Database URL Format

postgresql://[user[:password]@][host][:port][/database][?param=value&...]

# Basic connection without SSL
postgresql://kasho:mypassword@localhost:5432/mydb?sslmode=disable
 
# Connection with SSL required
postgresql://kasho:mypassword@prod-db.example.com:5432/mydb?sslmode=require
 
# Connection with timeout and app name
postgresql://kasho:mypassword@db:5432/mydb?connect_timeout=10&application_name=kasho

mysql://[user[:password]@][host][:port][/database][?param=value&...]

# Basic connection without TLS
mysql://kasho:mypassword@localhost:3306/mydb?tls=false
 
# Connection with TLS required
mysql://kasho:mypassword@prod-db.example.com:3306/mydb?tls=true
 
# Connection with timeout and time parsing
mysql://kasho:mypassword@db:3306/mydb?timeout=10s&parseTime=true

Transform Configuration

translicator requires a transforms.yml file that defines how data should be transformed during replication.

File Location

The transforms file must be mounted at /app/config/transforms.yml in the translicator container. How you mount this file depends on your deployment platform:

• Kubernetes: ConfigMap or Volume mount
• ECS: Task definition with mounted file from S3 or EFS
• Docker: Direct volume mount
• Other platforms: Use your platform’s file mounting mechanism

Basic Structure

version: v1
tables:
  schema.table_name:
    column_name: TransformationType

Example Configuration

version: v1
tables:
  public.users:
    email: FakeEmail
    phone: FakePhone
    address: FakeStreetAddress
 
  public.orders:
    customer_email: FakeEmail
    billing_address: FakeStreetAddress

See the Transform Configuration guide for detailed information about available transforms.

Production Deployment

For production deployments, mount the transforms configuration using your orchestration platform’s configuration management:

• Kubernetes: Use ConfigMaps or mounted volumes
• ECS: Use task definition volumes with S3 or EFS
• Docker Swarm: Use configs or secrets
• Other platforms: Follow your platform’s configuration mounting practices

The key requirement is that transforms.yml must be available at /app/config/transforms.yml inside the translicator container.

Configuration Best Practices

1. Use Environment Files

   • Keep sensitive data in .env files
   • Never commit .env files to version control
   • Use .env.example as a template

2. Security

   • Use strong passwords for database users
   • Enable SSL for production deployments
   • Restrict network access to services

3. Monitoring

   • Check change-stream service status: grpcurl -plaintext <host>:50051 change_stream.ChangeStream/GetStatus
   • Check service logs regularly
   • For PostgreSQL: Monitor replication slot status with SELECT * FROM pg_replication_slots WHERE slot_name = 'kasho_slot'
   • For MySQL: Monitor binlog position with SHOW MASTER STATUS

Next Steps

• Set up the Bootstrap Process for existing data
• Configure Data Transforms
• Review the Quick Start guide