Spring Cloud: API gateway upgrade & configuration in the cloud
8 likes2,251 views
The document discusses the upgrade and configuration of the Spring Cloud API Gateway, detailing its architecture, API design, and various features such as Zuul and Spring Cloud Gateway. It emphasizes the importance of simplicity, minimal code changes, and rapid release cycles in microservices architecture. Additionally, it covers configuration management using Spring Cloud Config, including dynamic refresh capabilities and encryption support.
![Zuul
• Spring Cloud Netflix.
@SpringBootApplication
@EnableZuulProxy
public class ApiGateway {
public static void main(String[] args) {
SpringApplication.run(ApiGateway.class, args);
}
}
17](https://image.slidesharecdn.com/springcloud-apigatewayupgradeconfigurationinthecloud-180527125246/85/Spring-Cloud-API-gateway-upgrade-configuration-in-the-cloud-17-320.jpg)
![Predicates
• Date-based route predicate factories:
• After - matches requests that happen after the provided datetime.
• Before - matches requests that happen before the provided datetime.
• Between - matches requests that happen between two dates.
spring:
cloud:
gateway:
routes:
- id: test_route
uri: http://example.org
predicates:
- After=2017-01-20T17:42:47.789-07:00[America/Denver]
25](https://image.slidesharecdn.com/springcloud-apigatewayupgradeconfigurationinthecloud-180527125246/85/Spring-Cloud-API-gateway-upgrade-configuration-in-the-cloud-25-320.jpg)
![Spring Cloud Config
• Config server:
@SpringBootApplication
@EnableConfigServer
public class ConfigServer {
public static void main(String[] args) {
SpringApplication.run(ConfigServer.class, args);
}
}
spring.cloud.config.server.git:
uri: http://git.xyz/config-repo
username: user
password: passkey
43](https://image.slidesharecdn.com/springcloud-apigatewayupgradeconfigurationinthecloud-180527125246/85/Spring-Cloud-API-gateway-upgrade-configuration-in-the-cloud-43-320.jpg)
Spring Cloud: API gateway upgrade & configuration in the cloud
- 1. Spring Cloud API gateway upgrade & configuration in the cloud.
- 2. Speaker Orkhan Gasimov Solution design & implementation. 15 years of software engineering; Teaching training courses. Architecture, Java, JavaScript / TypeScript. Author of training courses. Microservice, Spring Cloud, Akka for Java. 2
- 4. Agenda API Gateway Configuration in the cloud 4
- 5. Monolith -> Microservices The price we pay.
- 6. Monolithic Architecture Client Application Database 6
- 8. Priorities & Objectives • Keep things simple. 8
- 9. Priorities & Objectives • Keep things simple. • Minimum code change. 9
- 10. Priorities & Objectives • Keep things simple. • Minimum code change. • Short release cycles. 10
- 11. Priorities & Objectives • Keep things simple. • Minimum code change. • Short release cycles. • Quick changes if necessary. 11
- 12. API Design
- 13. API Gateway – the single entry point. API Design DBService API DBService DBService 13
- 14. API Service – deliver API for a special kind of clients. API Design 14 DBService API DBService DBService Web API Mobile API
- 15. API Versioning – evolve API supporting existing clients. API Design 15 DBService API DBService DBService Mobile API Web API v2 Web API v1
- 17. Zuul • Spring Cloud Netflix. @SpringBootApplication @EnableZuulProxy public class ApiGateway { public static void main(String[] args) { SpringApplication.run(ApiGateway.class, args); } } 17
- 18. Zuul • Spring Cloud Netflix. • Simple configuration. zuul: ignored-services: '*’ routes: api-v2: path: /api/v2/** stripPrefix: true serviceId: apiService api-v1: path: /api/v1/** stripPrefix: true url: http://service.old 18
- 19. Zuul • Spring Cloud Netflix. • Simple configuration. • Advanced filters: • Pre filters. • Routing filters. • Post filters. “pre” filters “routing” filter(s) “post” filters “error” filters “custom” filters 19
- 20. Zuul • Spring Cloud Netflix. • Simple configuration. • Advanced filters: • Pre filters. • Routing filters. • Post filters. • Advanced configuration? zuul: ignored-services: '*’ routes: api-v2: path: /api/v2/** stripPrefix: true serviceId: apiService api-v1: path: /api/v1/** stripPrefix: true url: http://service.old “pre” filters “routing”filter(s) “post” filters “error” filters “custom” filters 20
- 21. Spring Cloud New API Gateway
- 22. Spring Cloud Gateway • Predicates & Filters. • Advanced coding. • Advanced configuration. Client Gateway Proxied Service Predicates Filters 22
- 24. Predicates • Check whether a request should be proxied. Client Gateway Proxied ServicePredicate 1 Predicate N 24
- 25. Predicates • Date-based route predicate factories: • After - matches requests that happen after the provided datetime. • Before - matches requests that happen before the provided datetime. • Between - matches requests that happen between two dates. spring: cloud: gateway: routes: - id: test_route uri: http://example.org predicates: - After=2017-01-20T17:42:47.789-07:00[America/Denver] 25
- 26. Predicates • Cookie and Header based route predicate factories: • Cookie - matches a cookie by name and it’s value by regex. • Header - matches a header by name and it’s value by regex. spring: cloud: gateway: routes: - id: test_route uri: lb://serviceId predicates: - Cookie=chocolate, ch.p - Header=X-Request-Id, d+ 26
- 27. Predicates • Host & Remote Address based route predicate factories: • Host - matches the Host header that matches the Ant-style pattern. • RemoteAddr - matches a list of CIDR-notation (IPv4 or IPv6) strings. spring: cloud: gateway: routes: - id: test_route uri: http://example.org predicates: - Host=**.somehost.org - RemoteAddr=192.168.1.1/24 27
- 28. Predicates • Request details based route predicate factories: • Method - matches HTTP method. • Path - matches the request path using a Spring PathMatcher pattern. • Query - matches a query param by name and optionally it’s value by regex. spring: cloud: gateway: routes: - id: test_route uri: http://example.org predicates: - Method=GET - Path=/foo/{segment} - Query=baz 28
- 30. Filters • Decorate request before downstreaming to the proxied service. • Decorate response before upstreaming to the client. Client Gateway Proxied ServiceFilter N Filter 1 30
- 31. Filters • Filter Factories: • AddRequestHeader - add a downstream header. • AddRequestParameter - add a downstream request param. • AddResponseHeader - add an header to downstream’s response (upstream). spring: cloud: gateway: routes: - id: test_route uri: http://example.org filters: - AddRequestHeader=X-Request-Foo, Bar - AddRequestParameter=foo, bar - AddResponseHeader=X-Response-Foo, Bar 31
- 32. Filters • Filter Factories: • Hystrix - wrap filters to Hystrix Command with provided name. • RequestRateLimiter - set per second limits for requests made by user. • RedirectTo - send a 300 series status with a redirect url. • SetStatus - set upstream HTTP status. spring: cloud: gateway: routes: - id: hytstrix_route uri: lb://serviceId filters: - Hystrix=myCommandName 32
- 33. Filters • Filter Factories: • RemoveNonProxyHeaders - removes headers from forwarded requests. • RemoveRequestHeader - remove a downstream header. • RemoveResponseHeader - remove an upstream headers. • SetResponseHeader – set an upstream header (add or replace). • SecureHeaders - add security headers to the response. • PreserveHostHeader - send original Host header or the one determined by http client. 33
- 34. Filters • Filter Factories: • PrefixPath - add a prefix to downstream request. • RewritePath - rewrite request path matched by regexp. • SetPath – manipulate request path using segmented Spring uri templates. • StripPrefix - strip prefix parts (as many as provided by parts param). • SaveSession – ensure session is saved before forwarding the call (E.g. SpringSession with lazy data store). 34
- 35. Java API Spring Cloud Gateway
- 36. Java API @Bean public RouteLocator customRouteLocator(RouteLocatorBuilder builder, ThrottleGatewayFilterFactory throttle) { return builder.routes() .route(r -> r.host("**.abc.org").and().path("/image/png") .filters(f -> f.addResponseHeader("X-TestHeader", "foobar")) .uri("http://httpbin.org:80") ) .route(r -> r.path("/image/webp") .filters(f -> f.addResponseHeader("X-AnotherHeader", "baz")) .uri("http://httpbin.org:80") ) .route(r -> r.order(-1) .host("**.throttle.org").and().path("/get") .filters(f -> f.filter(throttle.apply(1, 1, 10, TimeUnit.SECONDS))) .uri("http://httpbin.org:80") ) .build(); } 36
- 37. Java API vs Configuration Spring Cloud Gateway
- 38. Pros & Cons • Java API: • Predicates benefit from and(), or() and negate() operators. • Requires rebuild upon change. 38
- 39. Pros & Cons • Java API: • Predicates benefit from and(), or() and negate() operators. • Requires rebuild upon change. • Configuration: • Predicates are stacked using logical and. • Benefit from external configuration store. 39
- 40. Spring Cloud Config Configuration Management with External Config Store
- 41. Spring Cloud Config • Load configurations using HTTP instead of local files. App (Config Client) Config Server Config Repo 41
- 42. Spring Cloud Config • Load configurations using HTTP instead of local files. • Config repo: • Git is default. • May use SVN, File-based, Vault, JDBC and etc. App (Config Client) Config Server Config Repo 42
- 43. Spring Cloud Config • Config server: @SpringBootApplication @EnableConfigServer public class ConfigServer { public static void main(String[] args) { SpringApplication.run(ConfigServer.class, args); } } spring.cloud.config.server.git: uri: http://git.xyz/config-repo username: user password: passkey 43
- 44. Spring Cloud Config • Config repo may contain: • application.yml (or .properties) for common properties. • AppName.yml for app-specific properties • AppName-profile.yml for profile-specific properties. App Specific Common Profile Specific 44
- 45. Spring Cloud Config • Config client • requires a bootstrap.yml file. spring: application.name: AppName cloud.config.uri: http://host:8182 45
- 46. Spring Cloud Config • Config client • requires a bootstrap.yml file. • Supports fail-fast & retry: spring: application.name: AppName cloud.config.uri: http://host:8182 spring.cloud.config.failFast: true spring.cloud.config.retry.initialInterval: 1000 spring.cloud.config.retry.maxAttempts: 6 spring.cloud.config.retry.maxInterval: 2000 spring.cloud.config.retry.multiplier: 1.1 46
- 47. Spring Cloud Config • Encryption & Decryption. • Supports encrypted values. • /encrypt & /decrypt endpoints. • Key may be a symmetric (shared) or an asymmetric one (RSA key pair). • Values are decrypted by server before sending to client. • Client-side decryption is also possible. spring: datasource: username: dbuser password: {cipher}FKSAJDFGYOS8F7GLHAKERGFHLSAJ 47
- 48. Spring Cloud Config • Dynamic refresh. App (Config Client) Config Server Config Repo Cloud Bus 48
- 49. Spring Cloud Config • Dynamic refresh. App (Config Client) Config Server Config Repo Cloud Bus 49
- 50. Spring Cloud Config • Dynamic refresh. App (Config Client) Config Server Config Repo Cloud Bus 50
- 51. Spring Cloud Config • Dynamic refresh. App (Config Client) Config Server Config Repo Cloud Bus 51
- 52. Spring Cloud Config • Dynamic refresh. App (Config Client) Config Server Config Repo Cloud Bus 52
- 53. Spring Cloud Config • Dynamic refresh. App (Config Client) Config Server Config Repo Cloud Bus 53
- 54. Spring Cloud Config • Dynamic refresh. • @Value & @RefreshScope. App (Config Client) Config Server Config Repo Cloud Bus 54
- 55. Spring Cloud Config • Dynamic refresh. • @Value & @RefreshScope. • Spring Boot Actuator /refresh endpoint. App (Config Client) Config Server Config Repo Cloud Bus 55
- 56. Spring Cloud Config • Dynamic refresh. • @Value & @RefreshScope. • Spring Boot Actuator /refresh endpoint. • Spring Cloud Config Monitor for push notifications. App (Config Client) Config Server Config Repo Cloud Bus 56
- 57. Spring Cloud Config • Dynamic refresh. • @Value & @RefreshScope. • Spring Boot Actuator /refresh endpoint. • Spring Cloud Config Monitor for push notifications. • Spring Cloud Bus for app refresh notifications. App (Config Client) Config Server Config Repo Cloud Bus 57
- 58. Summary
- 59. Summary • Spring Cloud API Gateway: • Zuul – Spring Cloud Netflix. • Spring Cloud Gateway. 59
- 60. Summary • Spring Cloud API Gateway: • Zuul – Spring Cloud Netflix. • Spring Cloud Gateway. • Spring Cloud Config: • Configuration management in the cloud. • Quick configuration refresh (zero-downtime). 60
- 61. Summary • Spring Cloud API Gateway: • Zuul – Spring Cloud Netflix. • Spring Cloud Gateway. • Spring Cloud Config: • Configuration management in the cloud. • Quick configuration refresh (zero-downtime). • Additional modules required: • Spring Cloud Bus • Spring Cloud Monitor 61