Skip to content

Commit c831e80

Browse files
committed
Format client config address schemes
1 parent a0974c8 commit c831e80

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

docs/en/client/configuration.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -52,29 +52,31 @@ grpc.client.__name__.address=static://localhost:9090
5252
There are a number of supported schemes, that you can use to determine the target server (Priorities 0 (low) - 10
5353
(high)):
5454

55-
- `static` (Prio 4):
56-
A simple static list of IPs (both v4 and v6), that can be use connect to the server (Supports `localhost`).
55+
- `static` (Prio 4): \
56+
A simple static list of IPs (both v4 and v6), that can be use connect to the server (Supports `localhost`). \
5757
Example: `static://192.168.1.1:8080,10.0.0.1:1337`
58-
- [`dns`](https://github.com/grpc/grpc-java/blob/master/core/src/main/java/io/grpc/internal/DnsNameResolver.java#L66) (Prio 5):
58+
- [`dns`](https://github.com/grpc/grpc-java/blob/master/core/src/main/java/io/grpc/internal/DnsNameResolver.java#L66)
59+
(Prio 5): \
5960
Resolves all addresses that are bound to the given DNS name. The addresses will be cached and will only be refreshed
60-
if an existing connection is shutdown/fails. More options such as `SVC` lookups (useful for kubernetes) can be enabled
61-
via system properties.
62-
Example: `dns:///example.my.company`
63-
- `discovery` (Prio 6):
61+
if an existing connection is shutdown/fails. \
62+
Example: `dns:///example.my.company` \
63+
Notice: There is also a `dns` resolver that is included in grpclb, that has a higher priority (`6`) than the default
64+
one and also supports `SVC` lookups.
65+
- `discovery` (Prio 6): \
6466
(Optional) Uses spring-cloud's `DiscoveryClient` to lookup appropriate targets. The connections will be refreshed
6567
automatically during `HeartbeatEvent`s. Uses the `gRPC.port` metadata to determine the port, otherwise uses the
66-
service port.
68+
service port. \
6769
Example: `discovery:///service-name`
68-
- `self` (Prio 0):
70+
- `self` (Prio 0): \
6971
The self address or scheme is a keyword that is available, if you also use `grpc-server-spring-boot-starter` and
7072
allows you to connect to the server without specifying the own address/port. This is especially useful for tests
71-
where you might want to use random server ports to avoid conflicts.
73+
where you might want to use random server ports to avoid conflicts. \
7274
Example: `self` or `self:self`
73-
- `in-process`:
75+
- `in-process`: \
7476
This is a special scheme that will bypass the normal channel factory and will use the `InProcessChannelFactory`
75-
instead. Use it to connect to the [`InProcessServer`](../server/configuration.md#enabling-the-inprocessserver).
77+
instead. Use it to connect to the [`InProcessServer`](../server/configuration.md#enabling-the-inprocessserver). \
7678
Example: `in-process:foobar`
77-
- *custom*:
79+
- *custom*: \
7880
You can define custom
7981
[`NameResolverProvider`s](https://javadoc.io/page/io.grpc/grpc-all/latest/io/grpc/NameResolverProvider.html) those
8082
will be picked up, by either via Java's `ServiceLoader` or from spring's application context and registered in

0 commit comments

Comments
 (0)