Docker Deployment Overview

DBConvert Streams is designed with containerization in mind, making Docker the recommended deployment method for both development and production environments. Docker provides consistent deployment across any infrastructure while simplifying setup and maintenance.

Deployment Options

DBConvert Streams offers flexible Docker deployment options to suit your specific requirements:

Local Development Deployment

Ideal for:

• Setting up a development or testing environment
• Personal projects or evaluation
• Learning the platform before production deployment
• Environments where you have direct access to the host machine

This deployment method is optimized for ease of setup and quick iteration, with minimal infrastructure requirements.

Cloud Hosting Deployment

Perfect for:

• Production environments
• Team collaboration scenarios
• Scenarios requiring high availability
• Deployments needing scalability options

Deploy to any cloud provider that supports Docker:

• Amazon Web Services (AWS)
• Google Cloud Platform (GCP)
• Microsoft Azure
• DigitalOcean
• Linode/Akamai
• Any other VPS or cloud infrastructure provider

DigitalOcean 1-Click App

For the fastest cloud setup experience:

• Pre-configured deployment with optimal settings
• Zero configuration required
• Immediate access to the platform
• Automatic updates available

Available through the DBConvert Streams on DigitalOcean Marketplace

Common Prerequisites

• Docker Engine 20.10.0 or newer
• Docker Compose v2.0.0 or newer
• Either curl OR wget for downloading files

Tested Linux Distributions

DBConvert Streams has been tested and confirmed to work on the following Linux distributions:

• Ubuntu 20.04 LTS and newer
• Debian 10+ (Buster and newer)
• CentOS 7, 8, and Stream
• Fedora 33+
• Amazon Linux 2
• Red Hat Enterprise Linux 8+

Quick Start

The fastest way to get started is using our automated installer:

# Using curl
curl -fsSL https://dbconvert.nyc3.digitaloceanspaces.com/downloads/streams/latest/docker-install.sh | sh

# Using wget
wget -qO- https://dbconvert.nyc3.digitaloceanspaces.com/downloads/streams/latest/docker-install.sh | sh

Service Architecture

DBConvert Streams consists of several containerized services:

1. Infrastructure Services:

   • NATS: Message streaming and service communication (internal only)
   • Consul: Service discovery, health monitoring, and configuration storage (internal only)
   • Vault: Secrets management for database credentials and certificates (internal only)
   • Nginx: Reverse proxy handling HTTP/HTTPS for UI and API access

2. Core Services:

   • stream-api: REST API for managing database connections and stream configurations (available via Nginx at /api/)
   • stream-reader: Source database reader
   • stream-writer: Target database writer
   • streams-ui: Web interface

INFO

Stream logs are now delivered via Server-Sent Events (SSE) through the Nginx proxy.

Common Commands

Regardless of deployment environment, these commands are used to manage the services:

# Start services
./start.sh

# Start services with HTTPS enabled
./start.sh --secure

# Stop services
./stop.sh

# Update to latest version
./update.sh

# Uninstall
./uninstall.sh

For detailed usage instructions, refer to the specific deployment guides.