AILERON Gateway is the secure and high-performance general purpose API Gateway for enterprise systems. Visit our website to get more information.

Key Features

• Networking
• Routing: Path based, query value based, header value based, etc.
• LoadBalancing: RoundRobin, Random, Maglev, RingHash, etc.
• Authentication/Authorization
• OAuth2 / OpenID Connect
• Financial-grade API
• OpenPolicyAgent
• Observability for cloud native environment.
• Metrics: Prometheus
• Tracing: OpenTelemetry
• Profiling: Profiling endpoint.

Integration

We integrate and leverage the following products and specifications.

Install AILERON Gateway

[!TIP] See the Installation for full documentation.

Install options are:

1. Pre-built binary: Download from Releases.
2. Linux package: Download from Releases.
3. RPM packages *.rpm
4. Debian packages *.deb
5. Alpine packages *.apk
6. Arch Linux packages *.pkg.tar.zst
7. Container image: Pull from GitHub Container Registry.
8. Build from source code:
9. Latest release: go install github.com/aileron-gateway/aileron-gateway/cmd/aileron@latest
10. Main branch: go install github.com/aileron-gateway/aileron-gateway/cmd/aileron@main

Getting Started

[!TIP] See the Getting Started and the Tutorials for full documentation.

Command line options

$ aileron --help

Options :
  -e, --env stringArray    env file path. each line be 'KEY=VALUE'
  -f, --file stringArray   config file or directory path. absolute or relative
  -h, --help               show help message
  -i, --info               show build information
  -o, --out string         template output format. yaml or json (default "yaml")
  -t, --template string    show template config. value format be 'Group/Version/Kind(/Namespace/Name)'
  -v, --version            show version

Run a reverse proxy example

Example configs are available under ./_example/*. Here we start with a simple reverse proxy using _example/reverse_proxy/.

Just run the AILERON Gateway with the config. Config paths can be relative or absolute, file path or directory path, *.yaml or *.yml or *.json. A reverse proxy server will listen on the port :8080.

$ aileron -f examples/reverse-proxy/

{"time":"2025-03-15 18:20:12","level":"INFO","msg":"server started. listening on [::]:8080","datetime":{"date":"2025-03-15","time":"18:20:12.556","zone":"Local"},"location":{"file":"httpserver/server.go","func":"httpserver.(*runner).Run","line":56}}

In this example, the reverse proxy server is pointing on the https://httpbin.org/. So, we can access to the https://httpbin.org/ via http://localhost:8080/ like below.

$ curl http://localhost:8080/get

{
  "args": {},
  "headers": {
    "Accept": "*/*",
    "Host": "httpbin.org",
    "User-Agent": "curl/7.68.0",
    "X-Amzn-Trace-Id": "Root=1-67d5479b-217d6f167e89a49e1c785584",
    "X-Forwarded-Host": "localhost:8080"
  },
  "origin": "127.0.0.1, 106.73.5.65",
  "url": "http://localhost:8080/get"
}

Tested Environment

Operating System:

• Linux: ubuntu-latest
• Windows: windows-latest
• macOS: macos-latest

Go:

• See the go.mod file.
• Main branch supports only latest go release.

In addition to the environment above, following platforms are tested on ubuntu using QEMU User space emulator.

• x86: amd64, 386
• arm: arm/v5, arm/v6, arm/v7, arm64
• risc: riscv64, loong64
• ppc: ppc64, ppc64le
• mips: mips, mips64, mips64le, mipsle
• ibm: s390x

Release Cycle

• Versions follow Semantic Versioning.
• vX.Y.Z
• vX.Y.Z-beta.N
• vX.Y.Z-alpha.N
• Minor release (update Y) is twice a year.
• Patch release (update Z) is almost once a month.

Contributing

[!IMPORTANT] Thank you for being interested in contributing to our community!!

We apologize, but we could not merge any PRs until we make all legal problems clear. For example, preparing code of conduct, contributor license agreement and so on. We are now actively working on this hard as we can merge PRs soon as possible.

Thank you for your understanding. March 15th, 2025.

See the Contributing for full documentation.

Support

See the Support for full documentation.

Need enterprise support?

Contact us: aileron-gateway@nri.co.jp