System Requirements

Before deploying Gluesync, ensure your environment meets these requirements for optimal performance.

Prerequisites Checklist

Containerized Deployment Setup

Gluesync is designed to run efficiently in containerized environments. We recommend using Docker, Podman, or Kubernetes for deployment, depending on your needs and familiarity.

Docker/Podman Setup

Requirement Details

Container Runtime & Compose

Ensure one of the following is installed on your system: * Docker Engine and Docker Compose * Podman and Podman Compose (or Docker Compose with Podman)

These are required to run the Gluesync Compose kit.

Installation Guides

Docker: Gluesync’s comprehensive Docker installation guide

Podman: Gluesync’s comprehensive Podman installation guide

Additional reference guides:

Docker: * Docker Desktop (Windows, macOS, Linux - for POC/Demo) * Docker Engine binaries (Production Linux) * WSL2 installation (Production Windows)

Podman: * Official Podman Installation Guide

Gluesync Compose Kit

After installation, follow the Gluesync documentation for using the Compose kit you received via email. See Useful Links below.

Note

Gluesync documentation provides basic installation guides for both Docker and Podman. For more detailed instructions, refer to the official container runtime documentation or community tutorials.

Cannot access container registries due to security constraints?

For Docker: Allow (whitelist) Docker registry at your proxy/firewall level, specifically allowing the following trusted domains: .docker.io, .docker.com, *.dckr.io

For Podman: Ensure access to the required container registries is allowed. Podman can use the same registries as Docker by default, plus additional ones if configured.

Otherwise, you can save the images via docker image XYZ save > image.tar and load them on either your private registry (if any) or in the machine where docker is installed (it will load them in its own local registry) via docker image load < image.tar

Verify System Requirements

You can autonomously verify if your system meets all the requirements by running our pre-flight checker tool. This tool performs various system checks and provides a detailed report of any missing requirements.

  • Download and run the pre-flight checker: Gluesync Pre-flight Checker

  • Follow the instructions in the repository to execute the checks

  • Review the generated report to identify and address any issues

The pre-flight checker verifies:

  • System resources (CPU, RAM, disk space)

  • Required software versions

  • Network connectivity

  • Container runtime configuration

  • And other environment-specific requirements

Kubernetes Setup

Requirement Details

Kubernetes Cluster

A running Kubernetes cluster (e.g., Minikube for testing, or a production-grade cluster for deployment). LTS Linux is recommended for production.

kubectl CLI

Install and configure kubectl to interact with your cluster.

Supported Distributions

Kubernetes (recommended), OpenShift, or an equivalent orchestrator. See production specs above for hardware guidance.

Installation Guides

* Kubernetes install guide * kubectl install guide

Gluesync Kubernetes Deployment

Refer to Gluesync documentation or contact support for deployment guides specific to Kubernetes environments.

Note

Gluesync documentation does not cover Kubernetes installation. For setup help, refer to the official Kubernetes documentation.

Source Database Requirements

Requirement Details

Connection Details

* Username and password * Connection string (IP address/port) * Table names * TLS certificates (if secure authentication required)

Access Permissions

Database user must have appropriate read permissions

Target System Requirements

Requirement Details

Connection Details

* Destination (bucket or database) * Connection string (IP address/port) * Username and password * TLS certificates (if secure authentication required)

Access Permissions

Write permissions to target location

We recommend using a database management tool for easier setup and testing. Our QA team regularly uses:

Note: These are suggestions only - use any database tool you’re comfortable with.

Environment Specifications

POC / Demo Environment

Component Requirement

Operating System

Windows, macOS, or Linux

Container Platform

Docker, Docker Compose, or Kubernetes

Hardware

* 8 GB RAM (minimum) * 8 vCPU * 10 GB free disk space (Additional space needed for Prometheus monitoring)

Production Environment

Recommended specs for handling ~35,000 transactions per second (TPS)

Component Requirement

Operating System

Linux (LTS version recommended)

Container Platform

Kubernetes (recommended), OpenShift, or equivalent orchestrator

Cluster Configuration

3 Kubernetes nodes for High Availability (HA)

Total Hardware Resources

* 32 GB RAM * 16 vCPU * 100 GB free disk space (Additional space needed for Prometheus monitoring)

These specifications are baseline recommendations. Actual requirements may vary based on:

  • Data volume

  • Number of concurrent connections

  • Complexity of transformations

  • Monitoring requirements