Skip to content

Commit

Permalink
New paragraph describing how to explicitly turn off TLS on an MP gRPC…
Browse files Browse the repository at this point in the history
… client. (#9519)

Signed-off-by: Santiago Pericas-Geertsen <[email protected]>
  • Loading branch information
spericas authored Nov 21, 2024
1 parent 3af58fe commit c087857
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/src/main/asciidoc/mp/grpc/client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c087857

Please sign in to comment.