Mention official feature in README.md
#202
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cneyang
approved these changes
May 28, 2024
ahmetb
requested changes
May 28, 2024
| @@ -10,7 +10,7 @@ expose service their status through the [gRPC Health Checking Protocol][hc]. | |||
| [Kubernetes][k8s], using the [exec probes][execprobe]. | |||
|
|
|||
| > :warning: [**Kubernetes v1.23 has now introduced built-in gRPC health checking**][k8s-new] | |||
| > capability as an alpha feature. As a result, you might no longer need to use this tool and use the | |||
There was a problem hiding this comment.
Lets remove alpha mention and keep only GA.
README.md
Outdated
| Kubernetes does not natively support gRPC health checking since it does not | ||
| favor one RPC framework over another. Similarly, HTTP health probes Kubernetes | ||
| has is not sufficient to craft a valid gRPC request. As a solution, | ||
| Kubernetes now supports [gRPC health checking][k8s]. If your cluster is running a version of Kubernetes that supports gRPC health checking, you can use the following example to define a liveness probe for your gRPC server: |
There was a problem hiding this comment.
Please remove the example code snippet. This repo is not for duplicating Kubernetes documentation.
There are still probably reasons to use this tool on Kubernetes. For example Kubernetes doesn't provide most of the configuration flags that this tool does.
There was a problem hiding this comment.
@ahmetb I removed code and add some reasons to use this tool. Could you review it once again?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now that k8s supports liveness checks using grpc, we need to mention this in the README.