README
¶
Iaido
A lightweight sidecar proxy for multi-region applications
Iaido is intended to ease the way for organizations to adopt multi-region application architectures without needing to roll out a full service mesh, global traffic direction, or other complicated infrastructure. Iaido provides a "just-works" approach with reasonable defaults for getting started.
Because Iaido is lightweight, it can be run as a "sidecar" for each
instance of your application without significantly impacting your CPU,
memory, or latency budgets. Configure Iaido with the desired proxy
configuration for an existing network service, and point your app at
localhost.
Features
- Enhance existing application stacks without code changes
- In-region connection distribution and tiered fail-over/fail-back.
- Minimal CPU, memory, and latency footprint, using the
splicesystem call where available. - File-based configuration that can be updated without restarting.
- Iaido will poll its configuration file for changes, or you can send
a
kill -HUPto force an immediate reload.
- Iaido will poll its configuration file for changes, or you can send
a
- Expands multi-A and multi-AAAA DNS records that may be published by an existing service mesh (e.g. a Kubernetes "headless" service)
Quickstart
Iaido uses a configuration file, however it will generate one for you with just a few inputs to specify a list of local ports and remote backends to forward to:
iaido --config iaido.yaml \
--bootstrapAddr 127.0.0.1 \
--bootstrap 26257:127.0.0.1:26258 \
--bootstrap 26257:127.0.0.1:26259 \
--bootstrap 26257:127.0.0.1:26260 \
--bootstrap 8080:127.0.0.1:8181
wrote bootstrapped configuration file to iaido.yaml
iaido -c iaido.yaml
listening on 127.0.0.1:26257
listening on 127.0.0.1:8080
The syntax for the binding is <local port>:<remote host>:<remote port>
and is similar to that used with SSH port-forwarding.
Demos
- CockroachDB local-cluster balancing
- Multi-region Kubernetes deployment (Coming soon)
Future Work
Currently, Iaido only acts on raw TCP streams. Direct support for HTTP, PostgreSQL, and other application protocols would enable more seamless traffic distribution and failover semantics.
TLS-stripping/wrapping would allow incremental adoption of secured, end-to-end network flows.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
balancer
Package balancer implements tiered pooling behavior across resolved backends.
|
Package balancer implements tiered pooling behavior across resolved backends. |
|
config
Package config contains the Iaido configuration format.
|
Package config contains the Iaido configuration format. |
|
copier
Package copier provides a utility type for simplex proxy connections.
|
Package copier provides a utility type for simplex proxy connections. |
|
diagnostics
Package diagnostics provides diagnostic informationg using the default HTTP mux.
|
Package diagnostics provides diagnostic informationg using the default HTTP mux. |
|
frontend
Package frontend contains the logic for running a network frontend that proxies connections to a backend pool.
|
Package frontend contains the logic for running a network frontend that proxies connections to a backend pool. |
|
frontend/tcp
Package tcp implements a TCP proxy service.
|
Package tcp implements a TCP proxy service. |
|
latch
Package latch provides a simple counter latch.
|
Package latch provides a simple counter latch. |
|
loop
Package loop implements a generic server loop.
|
Package loop implements a generic server loop. |
|
pool
Package pool contains an implementation of a hierarchical, weighted selection pool.
|
Package pool contains an implementation of a hierarchical, weighted selection pool. |
|
testing
Package testing contains various testing utilities.
|
Package testing contains various testing utilities. |