Merge pull request #539 from yidongnan/examples/condense-cloud-discovery

Condense/Simplify examples

Author: yidongnan

examples/README.md

@@ -1,6 +1,6 @@
 # gRPC spring boot starter Examples
 
-## Local Mode
+## Local Setup
 
 1. Try the local-grpc-server example first run:
 
@@ -16,28 +16,41 @@
 
 3. Visit http://localhost:8080/ to see the result.
 
-## Cloud Mode
+## Cloud Discovery Setup
 
-1. Try the cloud-eureka-server example first run:
+1. Choose a cloud discovery implementation:
+
+   - `consul`
+   - `eureka`
+   - `nacos`
+
+    > **Note:** In your actual application you are free to choose any cloud discovery implementation,
+    > but only the above and `zookeeper` will automatically register the server at the discovery service.
+    > So you might have to write a few extra lines in your server application.
+    > Generic registration support is planned for a future release.
+    > No additional configuration is required for clients.
+
+2. Start the discovery server (only the chosen one):
 
     ````sh
+    # Consul
+    docker run --name=consul -p 8500:8500 consul
+    # Eureka
     ./gradlew :example:cloud-eureka-server:bootRun
+    # Nacos
+    docker run --env MODE=standalone --name nacos -d --rm -p 8848:8848 nacos/nacos-server
     ````
 
-2. Run zipkin-server
-
-    https://github.com/openzipkin/zipkin#quick-start
-
-3. In a different terminal window run:
+3. Insert the selected implementation and start the server application (in a new terminal window):
 
     ````sh
-    ./gradlew :example:cloud-grpc-server:bootRun
+    ./gradlew -Pdiscovery=$discovery :example:cloud-grpc-server:bootRun
     ````
 
-4. In a different terminal window run:
+4. Insert the selected implementation and start the client application (in a new terminal window):
 
     ````sh
-    ./gradlew :example:cloud-grpc-client:bootRun
+    ./gradlew -Pdiscovery=$discovery :example:cloud-grpc-client:bootRun
     ````
 
 5. Visit http://localhost:8080/ to see the result.
@@ -59,71 +72,3 @@
 3. Visit http://localhost:8080/ to see the result.
 
 *You can configure the client's username in the application.yml.*
-
-## With Bearer auth security
-
-1. Try the security-grpc-bearerAuth-server example first run:
-
-    ````sh
-    ./gradlew :example:security-grpc-bearerAuth-server:bootRun
-    ````
-
-2. In a different terminal window run:
-
-    ````sh
-    ./gradlew :example:security-grpc-bearerAuth-client:bootRun
-    ````
-
-3. Visit http://localhost:8080/ to see the result.
-
-This will not run out of the box since one needs to set up an identity provider service, like
-for example Keycloak. Keycloak provides an endpoint to retrieve the necessary configuration (Public RSA key, etc).
-The URI to this endpoint needs to be provided in the server's `SecurityConfiguration.java` in the `jwtDecoder()` method.
-
-Additionally you will need to obtain a valid access token from the Keycloak server. This token has to be provided in
-the client's `SecurityConfiguration.java`
-
-To obtain an access token you can use Postman and perform an HTTP POST call to:
-`http://127.0.0.1:8080/auth/realms/YOURREALM/protocol/openid-connect/token`
-with basic authentication. Username and password are the client id and secret of the client you configured in the
-Keycloak admin panel (http://127.0.0.1:8080/).
-
-*You can configure the bearer token in the `SecurityConfiguration.java`*
-
-**Advice for testing/development:**
-
-When testing/developing it is not always possible to have an IDP service ready. In that case you can add the following
-line:
-
-````java
-providers.add(anonymousAuthenticationProvider());
-````
-
-right above (your actual authentication providers)
-
-````java
-providers.add(jwtAuthenticationProvider());
-````
-
-in the `authenticationManager()` bean method of the server's `SecurityConfiguration.java`
-This will of course require an appropriate Bean like such:
-
-````java
-@Bean
-AnonymousAuthenticationProvider anonymousAuthenticationProvider() {
-   return new AnonymousAuthenticationProvider("dev");
-}
-````
-
-and in the authenticationReader() Bean replace the return with:
-
-````java
-return new AnonymousAuthenticationReader("dev", "developer", AuthorityUtils.createAuthorityList("ROLE_TEST"));
-````
-
-You can add/change the roles there to your liking.
-
-Overall what happens here is that the BearerAuthenticationReader is replaced by AnonymousAuthenticationReader, which
-ignores the Bearer token and creates an AnonymousAuthenticationToken which is processed by the
-`AnonymousAuthenticationProvider`. This way you can temporarily bypass the bearer token auth.
-You might want to toggle this behavior with a `dev` or `debug` property.

examples/cloud-eureka-server/src/main/java/net/devh/boot/grpc/examples/cloud/server/EurekaServerApplication.java

@@ -21,11 +21,19 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
 
+/**
+ * Eureka cloud discovery server application.
+ */
 @EnableEurekaServer
 @SpringBootApplication
 public class EurekaServerApplication {
 
-    public static void main(String[] args) {
+    /**
+     * Starts the Eureka cloud discovery server application.
+     *
+     * @param args The arguments to pass to the application.
+     */
+    public static void main(final String... args) {
         SpringApplication.run(EurekaServerApplication.class, args);
     }