New paragraph describing how to explicitly turn off TLS on an MP gRPC…

… client. (#9519) (#9560) Signed-off-by: Santiago Pericas-Geertsen <[email protected]> Co-authored-by: Santiago Pericas-Geertsen <[email protected]>
helidon-io · Dec 4, 2024 · d9f48b4 · d9f48b4
1 parent 8c10f01
commit d9f48b4
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/src/main/asciidoc/mp/grpc/client.adoc b/docs/src/main/asciidoc/mp/grpc/client.adoc
@@ -116,6 +116,25 @@ TLS in the gRPC MP client section is configured in the same way as in other Heli
 components such as the webserver. For more information see
 xref:{rootdir}/se/webserver.adoc#_configuring_tls[Configuring TLS].
 
+Given that TLS is enabled by default in gRPC, it must be explicitly turned off by
+setting the `enabled` flag to `false` when connecting to an unsecure endpoint.
+For example, to turn off TLS for the `string-channel` above use:
+
+[source,yaml]
+----
+grpc:
+  client:
+    channels:
+      - name: "string-channel"
+        port: 8080
+        tls:
+          enabled: "false"
+----
+
+NOTE: It is not sufficient to omit the TLS section in the configuration above. The
+TLS section must be present and explicitly disabled. It is generally discouraged
+to expose unsecure gRPC endpoints.
+
 == Usage
 
 === Defining a Client Interface