Back to Rivet

dev-host - Auto-generated Docker Compose Template

engine/docker/dev-host/README.md

2.2.12.2 KB
Original Source

dev-host - Auto-generated Docker Compose Template

! Auto-generated: This directory and its contents are automatically generated by docker/template/. Do not edit these files directly as your changes will be overwritten.

Overview

This Docker Compose configuration provides a complete development environment for Rivet with the following services:

  • Rivet Engine: Main orchestration service
  • Rivet Shell: Interactive shell for debugging
  • Runner: Executes user code
  • ClickHouse: Analytics and time-series database
  • PostgreSQL: Relational database
  • Vector Server: Log aggregation and processing
  • OpenTelemetry Collector: Observability data collection

Port Configuration

ServicePort(s)Description
Rivet Engine6420Public endpoint
Runner5050Code execution service
PostgreSQL5432Database
ClickHouse HTTP9300Database HTTP interface
ClickHouse Native9301Database native protocol
OpenTelemetry gRPC4317OTLP gRPC endpoint
OpenTelemetry HTTP4318OTLP HTTP endpoint

Template Configuration

Template Name: dev-host
Base Port: 6420
Network Mode: host

Datacenters

  • 1: 1 engine(s), 1 runner(s)

Usage

  1. Start all services:

    bash
    docker-compose up -d
    
  2. Check service health:

    bash
    docker-compose ps
    
  3. View logs:

    bash
    docker-compose logs -f [service-name]
    
  4. Stop all services:

    bash
    docker-compose down
    

Generated Files

This template generates the following files and directories:

  • docker-compose.yml - Main Docker Compose configuration
  • core/ - Core services shared across datacenters:
    • clickhouse/ - ClickHouse configuration and initialization
    • vector-server/ - Vector aggregator configuration
    • otel-collector-server/ - OpenTelemetry Collector server configuration
  • datacenters/ - Datacenter-specific configurations:
    • 1/ - Configuration for datacenter 1:
      • postgres/ - PostgreSQL setup scripts
      • rivet-engine/ - Rivet Engine configuration
      • vector-client/ - Vector client configuration
      • otel-collector-client/ - OpenTelemetry Collector client configuration
  • README.md - This file