ActiveHealthCheckPolicy
ActiveHealthCheckPolicy API reference.
Proto: active_health_check_policy.proto
Package: resilience.policy.gloo.solo.io
Use the ingress gateway to periodically check the health of an upstream service in your cluster. If an upstream service is unavailable, the service is removed from the load balancing pool until health is re-established. Active healthcheck policies are applied at the Destination level. For more information, see the Envoy healthcheck configuration.
Example
For detailed information about the settings in this example, see Configure active healthcheck policies.
apiVersion: resilience.policy.gloo.solo.io/v2
kind: ActiveHealthCheckPolicy
metadata:
annotations:
cluster.solo.io/cluster: ""
name: active-health-check-policy-httbin-unhealthy
namespace: bookinfo
spec:
applyToDestinations:
- port:
number: 8000
selector:
name: httpbin
namespace: httpbin
config:
healthCheck:
alwaysLogHealthCheckFailures: true
eventLogPath: /dev/stdout
healthyThreshold: 1
httpHealthCheck:
host: httpbin.httpbin.svc.cluser.local
path: /status/500
interval: 1s
noTrafficInterval: 1s
timeout: 5s
unhealthyThreshold: 1
virtualGateways:
- cluster: cluster-1
name: istio-ingressgateway
namespace: bookinfo
ActiveHealthCheckPolicyReport
The report shows the resources that the policy selects after the policy is successfully applied.
Field | Description |
---|---|
workspaces | (repeated ActiveHealthCheckPolicyReport.WorkspacesEntry )A list of workspaces in which the policy can apply to destinations. |
selectedDestinationPorts | (repeated common.gloo.solo.io.DestinationReference )Destination ports selected by the policy. |
ActiveHealthCheckPolicyReport.WorkspacesEntry
Field | Description |
---|---|
key | (string ) |
value | (common.gloo.solo.io.Report ) |
ActiveHealthCheckPolicySpec
Specifications for the policy.
Field | Description |
---|---|
applyToDestinations | (repeated common.gloo.solo.io.DestinationSelector )Destinations to actively health check. If empty, no healthchecks are performed. |
config | (ActiveHealthCheckPolicySpec.Config )Details of the healthcheck policy to apply to the selected destinations. |
ActiveHealthCheckPolicySpec.Config
Details of the healthcheck policy to apply to the selected destinations.
Field | Description |
---|---|
healthCheck | (envoy.config.core.v3.HealthCheck )Configuration for the Envoy healthcheck. For more info, see the Envoy healthcheck config reference. |
virtualGateways | (repeated common.gloo.solo.io.ObjectReference )A list of references to virtual gateways that perform the healthchecks. |
ActiveHealthCheckPolicyStatus
The status of the policy after it is applied to your Gloo environment.
Field | Description |
---|---|
common | (common.gloo.solo.io.Status )The state and workspace conditions of the applied policy. |
numSelectedDestinationPorts | (uint32 )The number of destination ports selected by the policy. |