Do not bind the "grpc" container port when configured to use same server

These changes will read the runtime property `quarkus.grpc.server.use-separate-server` and if false, it won't expose the gRPC port in the generated K8s deployment resources. Relates quarkusio#33437 (comment)
gsmet · May 26, 2023 · 4ccaea0 · 4ccaea0
1 parent c662569
commit 4ccaea0
Show file tree

Hide file tree

Showing 14 changed files with 408 additions and 3 deletions.
diff --git a/extensions/grpc/deployment/src/main/java/io/quarkus/grpc/deployment/GrpcServerProcessor.java b/extensions/grpc/deployment/src/main/java/io/quarkus/grpc/deployment/GrpcServerProcessor.java
@@ -497,9 +497,15 @@ private void validateBindableService(BeanInfo bean, Type generatedBeanType,
     @BuildStep(onlyIf = IsNormal.class)
     KubernetesPortBuildItem registerGrpcServiceInKubernetes(List<BindableServiceBuildItem> bindables) {
         if (!bindables.isEmpty()) {
-            int port = ConfigProvider.getConfig().getOptionalValue("quarkus.grpc.server.port", Integer.class)
-                    .orElse(9000);
-            return new KubernetesPortBuildItem(port, "grpc");
+            boolean useSeparateServer = ConfigProvider.getConfig().getOptionalValue("quarkus.grpc.server.use-separate-server",
+                    Boolean.class)
+                    .orElse(true);
+            if (useSeparateServer) {
+                // Only expose the named port "grpc" if the gRPC server is exposed using a separate server.
+                int port = ConfigProvider.getConfig().getOptionalValue("quarkus.grpc.server.port", Integer.class)
+                        .orElse(9000);
+                return new KubernetesPortBuildItem(port, "grpc");
+            }
         }
         return null;
     }

diff --git a/...s/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc-same-server/invoker.properties b/...s/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc-same-server/invoker.properties
@@ -0,0 +1 @@
+invoker.goals=clean package
diff --git a/...ration-tests/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc-same-server/pom.xml b/...ration-tests/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc-same-server/pom.xml
@@ -0,0 +1,121 @@
+<?xml version="1.0"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>org.acme</groupId>
+  <artifactId>kubernetes-with-grpc-same-server</artifactId>
+  <version>0.1-SNAPSHOT</version>
+  <properties>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+    <surefire-plugin.version>3.0.0</surefire-plugin.version>
+    <maven.compiler.source>11</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <maven.compiler.target>11</maven.compiler.target>
+  </properties>
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>io.quarkus</groupId>
+        <artifactId>quarkus-bom</artifactId>
+        <version>@project.version@</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+  <dependencies>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-grpc</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-resteasy-reactive</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-kubernetes</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-junit5</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>io.rest-assured</groupId>
+      <artifactId>rest-assured</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>io.quarkus</groupId>
+        <artifactId>quarkus-maven-plugin</artifactId>
+        <version>@project.version@</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>build</goal>
+              <goal>generate-code</goal>
+              <goal>generate-code-tests</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>${surefire-plugin.version}</version>
+        <configuration>
+          <systemPropertyVariables>
+            <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+            <maven.home>${maven.home}</maven.home>
+          </systemPropertyVariables>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+  <profiles>
+    <profile>
+      <id>native</id>
+      <activation>
+        <property>
+          <name>native</name>
+        </property>
+      </activation>
+      <properties>
+        <quarkus.package.type>native</quarkus.package.type>
+      </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <configuration>
+              <skipTests>${native.surefire.skip}</skipTests>
+            </configuration>
+          </plugin>
+          <plugin>
+            <artifactId>maven-failsafe-plugin</artifactId>
+            <version>${surefire-plugin.version}</version>
+            <executions>
+              <execution>
+                <goals>
+                  <goal>integration-test</goal>
+                  <goal>verify</goal>
+                </goals>
+                <configuration>
+                  <systemPropertyVariables>
+                    <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
+                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+                    <maven.home>${maven.home}</maven.home>
+                  </systemPropertyVariables>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+</project>
diff --git a/...-way/src/it/kubernetes-with-grpc-same-server/src/main/java/org/acme/GrpcHelloService.java b/...-way/src/it/kubernetes-with-grpc-same-server/src/main/java/org/acme/GrpcHelloService.java
@@ -0,0 +1,15 @@
+package org.acme;
+
+import io.grpc.stub.StreamObserver;
+
+@io.quarkus.grpc.GrpcService
+public class GrpcHelloService extends GreeterGrpc.GreeterImplBase {
+
+    @Override
+    public void sayHello(HelloRequest request, StreamObserver<HelloReply> responseObserver) {
+        String name = request.getName();
+        String message = "Hello " + name;
+        responseObserver.onNext(HelloReply.newBuilder().setMessage(message).build());
+        responseObserver.onCompleted();
+    }
+}
diff --git a/...ven-invoker-way/src/it/kubernetes-with-grpc-same-server/src/main/java/org/acme/Hello.java b/...ven-invoker-way/src/it/kubernetes-with-grpc-same-server/src/main/java/org/acme/Hello.java
@@ -0,0 +1,16 @@
+package org.acme;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.core.MediaType;
+
+@Path("/hello")
+public class Hello {
+
+    @GET
+    @Produces(MediaType.TEXT_PLAIN)
+    public String hello() {
+        return "hello";
+    }
+}
diff --git a/...maven-invoker-way/src/it/kubernetes-with-grpc-same-server/src/main/proto/helloworld.proto b/...maven-invoker-way/src/it/kubernetes-with-grpc-same-server/src/main/proto/helloworld.proto
@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_outer_classname = "HelloWorldProto";
+
+package org.acme;
+
+// The greeting service definition.
+service Greeter {
+  // Sends a greeting
+  rpc SayHello (HelloRequest) returns (HelloReply) {}
+}
+
+// The request message containing the user's name.
+message HelloRequest {
+  string name = 1;
+}
+
+// The response message containing the greetings
+message HelloReply {
+  string message = 1;
+}
diff --git a/...ker-way/src/it/kubernetes-with-grpc-same-server/src/main/resources/application.properties b/...ker-way/src/it/kubernetes-with-grpc-same-server/src/main/resources/application.properties
@@ -0,0 +1 @@
+quarkus.grpc.server.use-separate-server=false
diff --git a/...-tests/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc-same-server/verify.groovy b/...-tests/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc-same-server/verify.groovy
@@ -0,0 +1,34 @@
+import io.dekorate.utils.Serialization
+import io.fabric8.kubernetes.api.model.ContainerPort
+import io.fabric8.kubernetes.api.model.KubernetesList
+import io.fabric8.kubernetes.api.model.Service
+import io.fabric8.kubernetes.api.model.ServicePort
+import io.fabric8.kubernetes.api.model.apps.Deployment;
+
+//Check that file exits
+String base = basedir
+File kubernetesYml = new File(base, "target/kubernetes/kubernetes.yml")
+assert kubernetesYml.exists()
+kubernetesYml.withInputStream { stream -> 
+    //Check that its parse-able
+    KubernetesList list = Serialization.unmarshalAsList(stream)
+    assert list != null
+
+    Deployment deployment = list.items.find{r -> r.kind == "Deployment"}
+
+    //Check that ti contains the Deployment with the expected ports
+    assert deployment != null
+    assert deployment.metadata.name == "kubernetes-with-grpc-same-server"
+    List<ContainerPort> containerPorts = deployment.spec.template.spec.containers.get(0).ports
+    assert containerPorts.stream().anyMatch(p -> p.getName() == "http" && p.containerPort == 8080);
+    assert containerPorts.stream().noneMatch(p -> p.getName() == "grpc");
+
+    Service service = list.items.find{ r -> r.kind == "Service"}
+
+    //Check that ti contains the Service with the expected ports
+    assert service != null
+    assert service.metadata.name == "kubernetes-with-grpc-same-server"
+    List<ServicePort> servicePorts = service.spec.ports
+    assert servicePorts.stream().anyMatch(p -> p.getName() == "http" && p.targetPort.intVal == 8080);
+    assert servicePorts.stream().noneMatch(p -> p.getName() == "grpc");
+}
diff --git a/...gration-tests/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc/invoker.properties b/...gration-tests/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc/invoker.properties
@@ -0,0 +1 @@
+invoker.goals=clean package
diff --git a/integration-tests/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc/pom.xml b/integration-tests/kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc/pom.xml
@@ -0,0 +1,117 @@
+<?xml version="1.0"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>org.acme</groupId>
+  <artifactId>kubernetes-with-grpc</artifactId>
+  <version>0.1-SNAPSHOT</version>
+  <properties>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+    <surefire-plugin.version>3.0.0</surefire-plugin.version>
+    <maven.compiler.source>11</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <maven.compiler.target>11</maven.compiler.target>
+  </properties>
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>io.quarkus</groupId>
+        <artifactId>quarkus-bom</artifactId>
+        <version>@project.version@</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+  <dependencies>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-grpc</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-kubernetes</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-junit5</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>io.rest-assured</groupId>
+      <artifactId>rest-assured</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>io.quarkus</groupId>
+        <artifactId>quarkus-maven-plugin</artifactId>
+        <version>@project.version@</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>build</goal>
+              <goal>generate-code</goal>
+              <goal>generate-code-tests</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>${surefire-plugin.version}</version>
+        <configuration>
+          <systemPropertyVariables>
+            <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+            <maven.home>${maven.home}</maven.home>
+          </systemPropertyVariables>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+  <profiles>
+    <profile>
+      <id>native</id>
+      <activation>
+        <property>
+          <name>native</name>
+        </property>
+      </activation>
+      <properties>
+        <quarkus.package.type>native</quarkus.package.type>
+      </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <configuration>
+              <skipTests>${native.surefire.skip}</skipTests>
+            </configuration>
+          </plugin>
+          <plugin>
+            <artifactId>maven-failsafe-plugin</artifactId>
+            <version>${surefire-plugin.version}</version>
+            <executions>
+              <execution>
+                <goals>
+                  <goal>integration-test</goal>
+                  <goal>verify</goal>
+                </goals>
+                <configuration>
+                  <systemPropertyVariables>
+                    <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
+                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+                    <maven.home>${maven.home}</maven.home>
+                  </systemPropertyVariables>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+</project>
diff --git a/...aven-invoker-way/src/it/kubernetes-with-grpc/src/main/java/org/acme/GrpcHelloService.java b/...aven-invoker-way/src/it/kubernetes-with-grpc/src/main/java/org/acme/GrpcHelloService.java
@@ -0,0 +1,15 @@
+package org.acme;
+
+import io.grpc.stub.StreamObserver;
+
+@io.quarkus.grpc.GrpcService
+public class GrpcHelloService extends GreeterGrpc.GreeterImplBase {
+
+    @Override
+    public void sayHello(HelloRequest request, StreamObserver<HelloReply> responseObserver) {
+        String name = request.getName();
+        String message = "Hello " + name;
+        responseObserver.onNext(HelloReply.newBuilder().setMessage(message).build());
+        responseObserver.onCompleted();
+    }
+}
diff --git a/.../kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc/src/main/proto/helloworld.proto b/.../kubernetes/maven-invoker-way/src/it/kubernetes-with-grpc/src/main/proto/helloworld.proto
@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_outer_classname = "HelloWorldProto";
+
+package org.acme;
+
+// The greeting service definition.
+service Greeter {
+  // Sends a greeting
+  rpc SayHello (HelloRequest) returns (HelloReply) {}
+}
+
+// The request message containing the user's name.
+message HelloRequest {
+  string name = 1;
+}
+
+// The response message containing the greetings
+message HelloReply {
+  string message = 1;
+}
diff --git a/...s/maven-invoker-way/src/it/kubernetes-with-grpc/src/main/resources/application.properties b/...s/maven-invoker-way/src/it/kubernetes-with-grpc/src/main/resources/application.properties