Skip to content

Commit 90c20ff

Browse files
committed
rework docs
1 parent c83d8e8 commit 90c20ff

File tree

5 files changed

+29
-6
lines changed

5 files changed

+29
-6
lines changed

introduction/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ There are many [Reactive Streams](https://www.reactive-streams.org/) implementat
118118
* [RxJS](https://rxjs.dev/)
119119
* [Project Reactor](https://projectreactor.io/)
120120

121+
#### Project Reactor & Spring Webflux
122+
121123
[Spring WebFlux](https://docs.spring.io/spring-framework/docs/current/reference/html/web-reactive.html#spring-web-reactive) builds upon [Project Reactor](https://projectreactor.io/).
122124

123125
Reactor fully implements [Reactive Streams](https://www.reactive-streams.org/) and extends it by offering two reactive and composable APIs:
@@ -148,6 +150,7 @@ public class BooksApi {
148150
}
149151
```
150152

153+
To get a really fast introduction into reactive streams with project reactor look into the _reactive-playground_ project as part of this workshop or look for the [Reactive Spring Security 5 Workshop](https://github.com/andifalk/reactive-spring-security-5-workshop).
151154

152155

153156

lab5/solution/api-gateway/src/main/java/com/example/apigateway/filter/CustomGlobalFilter.java

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ public class CustomGlobalFilter implements GlobalFilter, Ordered {
1515
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
1616
return chain.filter(exchange)
1717
.then(Mono.just(exchange))
18+
.log()
1819
.map(serverWebExchange -> {
1920
//adds header to response
2021
serverWebExchange.getResponse().getHeaders().set("CUSTOM-RESPONSE-HEADER",

prerequisites/README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88

99
## System Requirements
1010

11-
* LTS version 17 of the [Java SDK](https://adoptopenjdk.net/), other versions later than 17 might also work but are not tested
12-
* A Java IDE (like [Eclipse](https://www.eclipse.org/downloads/), [SpringToolSuite](https://spring.io/tools), [IntelliJ](https://www.jetbrains.com/idea/download), [Visual Studio Code](https://code.visualstudio.com/))
13-
* [Postman](https://www.getpostman.com/downloads/) or any alternative tool like [curl](https://curl.se/) or [httpie](https://httpie.io/) to test requests to the REST Api
14-
* For the Redis Rate Limiter in Lab 2 you need to have installed [docker](https://docs.docker.com/get-docker/) and [docker compose](https://docs.docker.com/compose/install/).
11+
* Mandatory for all hands-on labs
12+
* LTS version 17 of the [Java SDK](https://adoptopenjdk.net/), other versions later than 17 might also work but are not tested
13+
* A Java IDE (like [Eclipse](https://www.eclipse.org/downloads/), [SpringToolSuite](https://spring.io/tools), [IntelliJ](https://www.jetbrains.com/idea/download), [Visual Studio Code](https://code.visualstudio.com/))
14+
* [Postman](https://www.getpostman.com/downloads/) or any alternative tool like [curl](https://curl.se/) or [httpie](https://httpie.io/) to test requests to the REST Api
15+
* Only required for lab 2 (request rate limiter)
16+
* [Docker](https://docs.docker.com/get-docker/) or another container runtime plus [docker compose](https://docs.docker.com/compose/install/)
17+
* Only required for lab 4 (TLS/SSL)
18+
* [mkcert](https://github.com/FiloSottile/mkcert) to create a local CA and issue certificate to configure TLS/SSL.

reactive-playground/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The following resources might be helpful for first steps into the reactive world
99

1010
* [Which operator do I need?](https://projectreactor.io/docs/core/release/reference/#which-operator)
1111

12-
This playground contains a starting point to play around with the reactive stuff.
12+
This playground contains a starting point to play around with the reactive stuff.
13+
Just execute tests in the class `BasicReactivePlaygroundTests` to learn more about the reactive streams api.
1314

14-
Just execute tests in the class `BasicReactivePlaygroundTests` to learn the reactive streams api.
15+
If you want to learn more about the project reactor and reactive streams you may also want to check another GitHub repository for a [Reactive Spring Security 5 Workshop](https://github.com/andifalk/reactive-spring-security-5-workshop).

setup/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,17 @@ You can use the following users to log into the custom Spring Authorization Serv
4343
| pparker / parker | USER, ADMIN |
4444
| ckent / kent | USER |
4545

46+
## Docker and docker compose
47+
48+
If you want to follow configuring a rate limiter as part of hands-on lab 2 you will need to run a container image with a redis database.
49+
Therefore a container runtime is required.
50+
51+
If you don't have already _docker_ installed on your machine please open the corresponding [docker installation](https://docs.docker.com/get-docker/) location and follow instructions there.
52+
With Docker Desktop you already have docker compose installed. Other installations like standalone engine on Linux require an additional [installation of docker compose](https://docs.docker.com/get-started/08_using_compose/).
53+
54+
> In case you have installed another container runtime like [Rancher Desktop](https://rancherdesktop.io/) this should also work, as long as docker compose is supported by that solution.
55+
56+
## mkcert - Create a local Certificate Authority (CA)
57+
58+
[mkcert](https://github.com/FiloSottile/mkcert) is a helpful tool to create a local CA for Lab 4 to configure TLS/SSL for the api gateway.
59+
Please follow the [mkcert installation](https://github.com/FiloSottile/mkcert#installation) section on how to install this on your local machine.

0 commit comments

Comments
 (0)