Skip to content

Commit cb11860

Browse files
authored
Mention official feature in README.md (#202)
1 parent 45ed491 commit cb11860

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ expose service their status through the [gRPC Health Checking Protocol][hc].
99
`grpc_health_probe` is meant to be used for health checking gRPC applications in
1010
[Kubernetes][k8s], using the [exec probes][execprobe].
1111

12-
> :warning: [**Kubernetes v1.23 has now introduced built-in gRPC health checking**][k8s-new]
13-
> capability as an alpha feature. As a result, you might no longer need to use this tool and use the
14-
> native Kubernetes feature instead.
12+
> :warning: [**Kubernetes has now built-in gRPC health checking**][k8s-new]
13+
> capability as generally available. As a result, you might no longer need to use this tool and can use the native Kubernetes feature instead.
1514
>
1615
> This tool can still be useful if you are on older versions of Kubernetes,
1716
> or using advanced configuration (such as custom metadata, TLS or finer timeout tuning),
@@ -68,9 +67,9 @@ implementation details. This eliminates the need for you to implement the
6867

6968
## Example: gRPC health checking on Kubernetes
7069

71-
Kubernetes does not natively support gRPC health checking since it does not
72-
favor one RPC framework over another. Similarly, HTTP health probes Kubernetes
73-
has is not sufficient to craft a valid gRPC request. As a solution,
70+
Kubernetes now supports [gRPC health checking][k8s]. If your cluster is running a version that supports gRPC health checking, you can define a gRPC liveness probe in your Pod specification. For more information on how to define a gRPC liveness probe in Kubernetes, see the [Kubernetes documentation][k8s-new].
71+
72+
However, if your Kubernetes version does not support gRPC health checking or if you want to use some advanced features that Kubernetes does not support, you can use `grpc_health_probe` to health-check your gRPC server. As a solution,
7473
`grpc_health_probe` [can be used for Kubernetes][k8s] to health-check gRPC
7574
servers running in the Pod.
7675

0 commit comments

Comments
 (0)