Apache ShenYu

This is a repackaged open source software product wherein additional charges apply for cloudimg support services.

Overview

Apache ShenYu is a high performance, reactive open source API gateway built on Java and Spring WebFlux. It provides dynamic routing, load balancing, traffic control, rate limiting, circuit breaking, authentication and observability through a rich hot pluggable plugin ecosystem, all managed from a graphical admin console and a REST API. This image delivers ShenYu fully installed and configured as a system service, with the shenyu-admin control plane, the shenyu-bootstrap data plane gateway and a MySQL config store, so a production grade API gateway is running within minutes of launch.

Application Stack

The shenyu-admin control plane console and REST API installed from the official Apache ShenYu binary distribution and run by a dedicated service account on OpenJDK 17. The shenyu-bootstrap reactive data plane gateway that proxies your traffic and applies the configured plugins. A MySQL config store, the durable source of truth for every selector, rule and plugin, with its data directory on a dedicated data disk so the gateway configuration is independently resizable and survives instance replacement. An nginx reverse proxy that publishes the admin console on port 80. Systemd services that start the whole stack on boot and restart it on failure.

API Gateway

Route and proxy traffic to your upstream services with dynamic, hot reloaded configuration synced from the control plane to the data plane in real time. Apply divide and load balancing, rate limiting, circuit breaking, authentication, request and response rewriting, CORS, monitoring and dozens more plugins per selector and rule. Configure everything through the admin console or the REST API, with no gateway restart required.

Secure First Boot

On the first boot of your instance a one shot service generates a fresh admin console password, unique to that instance, writes it into the config store before any service starts and records it in a root only file, so the well known default ShenYu credential no longer works. The MySQL config store, the admin REST API and the gateway all bind to the loopback interface only and are never exposed. No shared or default application credentials ship in the image.

Ready To Use

The shenyu-admin console is served on port 80 through nginx. Sign in with the generated administrator credentials to create selectors and rules, attach plugins, register upstreams and watch traffic. The reactive gateway data plane listens on the loopback interface inside the instance; publish it behind your own ingress and TLS for production traffic as described in the user guide.

cloudimg Support

24/7 technical support by email and chat. Help with deployment, selector and rule design, plugin configuration, authentication and rate limiting, the MySQL config store, the admin console, TLS and gateway tuning.

Use Cases

A unified API gateway and reverse proxy for microservices. North south and east west traffic management on virtual machines and in the cloud. Authentication, rate limiting and circuit breaking for public APIs. A Kong or Spring Cloud Gateway alternative built on reactive open source. Canary releases, traffic splitting and request transformation at the edge.

Apache ShenYu is a trademark of the Apache Software Foundation. All product and company names are trademarks or registered trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.