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.

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

Update/Reformat Helidon MP and SE gRPC documents #4569

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions docs/config/config_reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ The following section lists all configurable types in Helidon.
- xref:{rootdir}/config/io_helidon_faulttolerance_Retry_DelayingRetryPolicy.adoc[DelayingRetryPolicy (faulttolerance.Retry)]
- xref:{rootdir}/config/io_helidon_security_providers_common_EvictableCache.adoc[EvictableCache (security.providers.common)]
- xref:{rootdir}/config/io_helidon_security_providers_google_login_GoogleTokenProvider.adoc[GoogleTokenProvider (security.providers.google.login)]
- xref:{rootdir}/config/io_helidon_grpc_client_GrpcChannelDescriptor.adoc[GrpcChannelDescriptor (grpc.client)]
- xref:{rootdir}/config/io_helidon_grpc_server_GrpcServerConfiguration.adoc[GrpcServerConfiguration (grpc.server)]
- xref:{rootdir}/config/io_helidon_grpc_core_GrpcTlsDescriptor.adoc[GrpcTlsDescriptor (grpc.core)]
- xref:{rootdir}/config/io_helidon_security_providers_header_HeaderAtnProvider.adoc[HeaderAtnProvider (security.providers.header)]
- xref:{rootdir}/config/io_helidon_security_providers_httpsign_SignedHeadersConfig_HeadersConfig.adoc[HeadersConfig (security.providers.httpsign.SignedHeadersConfig)]
- xref:{rootdir}/config/io_helidon_health_HealthSupport.adoc[HealthSupport (health)]
Expand Down
54 changes: 54 additions & 0 deletions docs/config/io_helidon_grpc_client_GrpcChannelDescriptor.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2022 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.grpc.client.GrpcChannelDescriptor
:keywords: helidon, config, io.helidon.grpc.client.GrpcChannelDescriptor
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.grpc.client.GrpcChannelDescriptor
include::{rootdir}/includes/attributes.adoc[]

= GrpcChannelDescriptor (grpc.client) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.grpc.client/io/helidon/grpc/client/GrpcChannelDescriptor.html[io.helidon.grpc.client.GrpcChannelDescriptor]




== Configuration options
ljamen marked this conversation as resolved.
Show resolved Hide resolved



Optional configuration options:
[cols="3,3,2,5a"]

|===
|key |type |default value |description

|`host` |string |`localhost` |Set the host name to connect.
|`port` |int |`1408` |Set the port that will be used to connect to the server.
|`target` |string |{nbsp} |Set the target string, which can be either a valid io.grpc.NameResolver
compliant URI, or an authority string.
|`tls` |xref:{rootdir}/config/io_helidon_grpc_core_GrpcTlsDescriptor.adoc[GrpcTlsDescriptor] |{nbsp} |Set the GrpcTlsDescriptor. If `tlsDescriptor` is null or if the `tlsDescriptor.isEnabled()` is false,
then no TLS will be used.

|===

// end::config[]
53 changes: 53 additions & 0 deletions docs/config/io_helidon_grpc_core_GrpcTlsDescriptor.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2022 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.grpc.core.GrpcTlsDescriptor
:keywords: helidon, config, io.helidon.grpc.core.GrpcTlsDescriptor
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.grpc.core.GrpcTlsDescriptor
include::{rootdir}/includes/attributes.adoc[]

= GrpcTlsDescriptor (grpc.core) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.grpc.core/io/helidon/grpc/core/GrpcTlsDescriptor.html[io.helidon.grpc.core.GrpcTlsDescriptor]




== Configuration options
klustria marked this conversation as resolved.
Show resolved Hide resolved



Optional configuration options:
[cols="3,3,2,5a"]

|===
|key |type |default value |description

|`enabled` |boolean |`true` |Enable or disable TLS. If enabled is false then the rest of the TLS configuration properties are ignored.
ljamen marked this conversation as resolved.
Show resolved Hide resolved
|`jdk-ssl` |boolean |`false` |Sets the type of SSL implementation to be used.
|`tls-ca-cert` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Set the CA (certificate authority) certificate path.
|`tls-cert` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Set the client tlsCert path. Required only if mutual auth is desired.
|`tls-key` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Set the client private key path. Required only if mutual auth is desired.

|===

// end::config[]
59 changes: 59 additions & 0 deletions docs/config/io_helidon_grpc_server_GrpcServerConfiguration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2022 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.grpc.server.GrpcServerConfiguration
:keywords: helidon, config, io.helidon.grpc.server.GrpcServerConfiguration
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.grpc.server.GrpcServerConfiguration
include::{rootdir}/includes/attributes.adoc[]

= GrpcServerConfiguration (grpc.server) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.grpc.server/io/helidon/grpc/server/GrpcServerConfiguration.html[io.helidon.grpc.server.GrpcServerConfiguration]




== Configuration options
ljamen marked this conversation as resolved.
Show resolved Hide resolved



Optional configuration options:
[cols="3,3,2,5a"]

|===
|key |type |default value |description

|`name` |string |`grpc.server` |Set the name of the gRPC server.

Configuration key: `name`
|`native` |boolean |`false` |Specify if native transport should be used.
|`port` |int |`1408` |Sets server port. If port is `0` or less then any available ephemeral port will be used.

Configuration key: `port`
|`workers` |int |`Number of processors available to the JVM` |Sets a count of threads in pool used to process HTTP requests.
Default value is `CPU_COUNT * 2`.

Configuration key: `workers`

|===

// end::config[]
Loading