Update docs with latest guide on health checks #377
Conversation
Pull Request Test Coverage Report for Build 6043366462
💛 - Coveralls |
| * Omitting `healthCheck` results in [VPC Lattice default behavior](https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-group-health-checks.html) depending on the protocol. | ||
| * Health check is enabled by default for HTTP1 target groups. | ||
| * Health check is disabled by default for HTTP2/gRPC target groups. | ||
| * For targets behind GRPCRoute, you should create a separate endpoint to enable health checks - HTTP/2 health check directly on gRPC endpoints is not supported. |
There was a problem hiding this comment.
What this mean? you should create a separate endpoint to enable health checks, other part LGTM
There was a problem hiding this comment.
slightly changed the wording there. It means you cannot directly perform HC on the target, so you need to enable another endpoint that is dedicated for health check.
| @@ -1,4 +1,4 @@ | |||
| ### Configuration Variables | |||
| ### Environment Variables | |||
There was a problem hiding this comment.
can you add please CLUSTER_NAME, since we start using it for tagging
| * Omitting `healthCheck` results in [VPC Lattice default behavior](https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-group-health-checks.html) depending on the protocol. | ||
| * Health check is enabled by default for HTTP1 target groups. | ||
| * Health check is disabled by default for HTTP2/gRPC target groups. | ||
| * For targets behind GRPCRoute, you should create a separate endpoint dedicated for health checks - HTTP/2 health check directly on gRPC endpoints is not supported. |
There was a problem hiding this comment.
you should create a separate endpoint dedicated for health checks
may be just copy aws docs?
Health checks do not support gRPC target group protocol versions. However, if you enable health checks, you must specify the health check protocol version as HTTP1 or HTTP2.
There was a problem hiding this comment.
I tried to address ambiguity from aws docs there, there are some cases users trying to put HTTP2 health checks on GRPC targets directly and we want to avoid it.
What type of PR is this?
documentation
Which issue does this PR fix:
What does this PR do / Why do we need it:
If an issue # is not available please add repro steps and logs from aws-gateway-controller showing the issue:
Testing done on this change:
Automation added to e2e:
Will this PR introduce any new dependencies?:
Will this break upgrades or downgrades. Has updating a running cluster been tested?:
Does this PR introduce any user-facing change?:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.