Spring Cloud Zuul Route Cassandra Store
A Spring Cloud Cassandra store for Zuul routes.
Features
Extends the Spring Cloud's ProxyRouteLocator
with capabilities of loading routes out of the configured Cassandra database.
Instead of configuring your routes through zuul.routes
like fallows:
zuul:
ignoredServices: '*'
routes:
resource:
path: /api/**
serviceId: rest-service
oauth2:
path: /uaa/**
serviceId: oauth2-service
stripPrefix: false
You can store the routes in Cassandra.
Keep in mind that the other properties except for routes are still relevant.
zuul:
ignoredServices: '*'
store:
cassandra:
enabled: true
Setup
Add the Spring Cloud starter to your project:
<dependency>
<groupId>io.jmnarloch</groupId>
<artifactId>zuul-route-cassandra-spring-cloud-starter</artifactId>
<version>1.0.0</version>
</dependency>
Connect to Cassandra and create a keyspace:
CREATE KEYSPACE IF NOT EXISTS zuul WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 3 };
USE zuul;
CREATE TABLE zuul_routes (
id text,
path text,
service_id text,
url text,
strip_prefix boolean,
retryable boolean,
PRIMARY KEY(id)
);
Register CassandraOperations
bean within your application:
@SpringBootApplication
public static class Application {
@Bean
public Cluster cluster() {
return Cluster.builder()
.addContactPoints(InetAddress.getLoopbackAddress())
.withPort(9142)
.build();
}
@Bean
public CassandraOperations cassandraTemplate(Cluster cluster) {
return new CassandraTemplate(cluster.connect("zuul"));
}
}
Configure the Cassandra to be used for loading the Zuul routes:
zuul:
store:
cassandra:
enabled: true
Finally enable the Zuul proxy with @EnableZuulProxyStore
- use this annotation as a replacement for standard @EnableZuulProxy
:
@EnableZuulProxyStore
@SpringBootApplication
public static class Application {
...
}
Properties
zuul.store.cassandra.enabled=true# false by default
License
Apache 2.0