Getting Started with FluxGate

Open-source API gateway for microservices

$ fluxgate version --short
v2.1.4 (build 8942f1a) • control plane ready

Before You Begin

System Prerequisites

Ensure your environment meets the baseline requirements before initializing the routing engine and certificate store.

Kubernetes v1.24+

Requires RBAC enabled and metrics-server running. Helm 3.8.0 or later is required for chart templating and CRD validation.

Docker Desktop 4.20+

Minimum 2 CPU cores and 4GB RAM allocated to the daemon. Host ports 8080 and 9090 must be unbound for ingress and telemetry.

FluxGate CLI v2.1.4

Used for local config validation and certificate rotation. Install via brew install fluxgate/tap/fluxgate or download the static binary.

Deployment

Install via Helm or Docker

Choose your preferred deployment method. Both options initialize the default routing table and enable automatic TLS termination.

Kubernetes Helm Chart

Add the official repository and deploy the gateway controller with two replicas for high availability.

helm repo add fluxgate https://charts.fluxgate.io
helm install fg-gateway fluxgate/fluxgate --set controller.replicas=2 --set ingress.tls.enabled=true

Docker Container

Run the lightweight daemon in detached mode, mapping the HTTP ingress and Prometheus metrics ports.

docker run -d --name fg-node -p 8080:8080 -p 9090:9090 \
  -v ~/.fluxgate/config.yaml:/etc/fluxgate/config.yaml \
  fluxgate/gateway:2.1.4

Verification

Send Your First Request

Validate the gateway pipeline by hitting the default health endpoint and routing to a downstream service.

$ curl -X POST http://localhost:8080/api/v1/routes/activate \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkZXZfbW9kZSJ9.x7K9pQ" \
-d '{"upstream": "payment-svc.internal:443", "timeout_ms": 3000}'
{ "status": "active", "route_id": "rt_8842a1", "latency_ms": 12 }

A successful response returns a 200 OK with a JSON payload containing the active route identifier, upstream latency, and pool assignment. Verify real-time throughput and error rates by navigating to the built-in dashboard at http://localhost:9090/metrics. The gateway will automatically begin distributing traffic across your registered microservices.