diff --git a/content/en/docs/reference/config/istio.mesh.v1alpha1/index.html b/content/en/docs/reference/config/istio.mesh.v1alpha1/index.html index 5c7d38019b..4ffa0978b2 100644 --- a/content/en/docs/reference/config/istio.mesh.v1alpha1/index.html +++ b/content/en/docs/reference/config/istio.mesh.v1alpha1/index.html @@ -432,6 +432,19 @@ No All control planes running in the same service mesh should specify the same mesh ID. Mesh ID is used to label telemetry reports for cases where telemetry from multiple meshes is mixed together.

+ + +No + + + +readinessProbe +ReadinessProbe + +

VM Health Checking readiness probe. This health check config exactly mirrors the +kubernetes readiness probe configuration both in schema and logic. +Only one health check method of 3 can be set at a time.

+ No diff --git a/content/en/docs/reference/config/networking/workload-group/index.html b/content/en/docs/reference/config/networking/workload-group/index.html index 1d76ccb60d..d87541189c 100644 --- a/content/en/docs/reference/config/networking/workload-group/index.html +++ b/content/en/docs/reference/config/networking/workload-group/index.html @@ -8,7 +8,7 @@ layout: protoc-gen-docs generator: protoc-gen-docs schema: istio.networking.v1alpha3.WorkloadGroup aliases: [/docs/reference/config/networking/v1alpha3/workload-group] -number_of_entries: 2 +number_of_entries: 7 ---

WorkloadGroup describes a collection of workload instances. It provides a specification that the workload instances can use to bootstrap @@ -42,6 +42,20 @@ spec: grpc: 3550 http: 8080 serviceAccount: default + probe: + initialDelaySeconds: 5 + timeoutSeconds: 3 + periodSeconds: 4 + successThreshold: 3 + failureThreshold: 3 + httpGet: + path: /foo/bar + host: 127.0.0.1 + port: 3100 + scheme: https + httpHeaders: + - name: Lit-Header + value: Im-The-Best

{{}} @@ -92,6 +106,298 @@ workload group, and inherit the labels and annotations from the above meta Yes + +probe +ReadinessProbe + +

ReadinessProbe describes the configuration the user must provide for healthchecking on their workload. +This configuration mirrors K8S in both syntax and logic for the most part.

+ + + +No + + + + + +

ReadinessProbe

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
initialDelaySecondsint32 +

Number of seconds after the container has started before readiness probes are initiated.

+ +
+No +
timeoutSecondsint32 +

Number of seconds after which the probe times out. +Defaults to 1 second. Minimum value is 1.

+ +
+No +
periodSecondsint32 +

How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.

+ +
+No +
successThresholdint32 +

Minimum consecutive successes for the probe to be considered successful after having failed. +Defaults to 1.

+ +
+No +
failureThresholdint32 +

Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3.

+ +
+No +
httpGetHTTPHealthCheckConfig (oneof) +

an http get is performed to a given endpoint +and the status/able to connect determines health.

+ +
+No +
tcpSocketTCPHealthCheckConfig (oneof) +

health is determined by if the proxy is able to connect.

+ +
+No +
execExecHealthCheckConfig (oneof) +

health is determined by how the command that is executed exited.

+ +
+No +
+
+

HTTPHealthCheckConfig

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
pathstring +

Path to access on the HTTP server.

+ +
+No +
portuint32 +

port on which the endpoint lives.

+ +
+No +
hoststring +

Host name to connect to, defaults to the pod IP. You probably want to set +“Host” in httpHeaders instead.

+ +
+No +
schemestring +

http or https, defaults to http

+ +
+No +
httpHeadersHTTPHeader[] +

headers the proxy will pass on to make the request. +allows repeated headers.

+ +
+No +
+
+

HTTPHeader

+
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
namestring +

The header field name

+ +
+No +
valuestring +

The header field value

+ +
+No +
+
+

TCPHealthCheckConfig

+
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
hoststring +

host to connect to, defaults to localhost

+ +
+No +
portuint32 +

port of host

+ +
+No +
+
+

ExecHealthCheckConfig

+
+ + + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
commandstring[] +

command to run. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

+ +
+No +