Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

4.1.5: New paragraph describing how to explicitly turn off TLS on an MP gRPC client #9560

Merged
merged 1 commit into from
Dec 4, 2024
Merged

4.1.5: New paragraph describing how to explicitly turn off TLS on an MP gRPC client #9560

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/src/main/asciidoc/mp/grpc/client.adoc
View file
Open in desktop
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