mirror of https://github.com/istio/istio.io.git
Automator: update istio.io@ reference docs (#8124)
This commit is contained in:
Istio Automation
GitHub
parent
2c1bdd68be
commit
c9b4a84da7
|
|
@ -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.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ProxyConfig-readiness_probe">
|
||||
<td><code>readinessProbe</code></td>
|
||||
<td><code><a href="/docs/reference/config/networking/workload-group/#ReadinessProbe">ReadinessProbe</a></code></td>
|
||||
<td>
|
||||
<p>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.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
<p><code>WorkloadGroup</code> 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
|
||||
</code></pre>
|
||||
|
||||
<p>{{</tab>}}
|
||||
|
|
@ -92,6 +106,298 @@ workload group, and inherit the labels and annotations from the above <code>meta
|
|||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="WorkloadGroup-probe">
|
||||
<td><code>probe</code></td>
|
||||
<td><code><a href="#ReadinessProbe">ReadinessProbe</a></code></td>
|
||||
<td>
|
||||
<p><code>ReadinessProbe</code> 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.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="ReadinessProbe">ReadinessProbe</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="ReadinessProbe-initial_delay_seconds">
|
||||
<td><code>initialDelaySeconds</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Number of seconds after the container has started before readiness probes are initiated.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ReadinessProbe-timeout_seconds">
|
||||
<td><code>timeoutSeconds</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Number of seconds after which the probe times out.
|
||||
Defaults to 1 second. Minimum value is 1.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ReadinessProbe-period_seconds">
|
||||
<td><code>periodSeconds</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>How often (in seconds) to perform the probe.
|
||||
Default to 10 seconds. Minimum value is 1.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ReadinessProbe-success_threshold">
|
||||
<td><code>successThreshold</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Minimum consecutive successes for the probe to be considered successful after having failed.
|
||||
Defaults to 1.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ReadinessProbe-failure_threshold">
|
||||
<td><code>failureThreshold</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Minimum consecutive failures for the probe to be considered failed after having succeeded.
|
||||
Defaults to 3.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ReadinessProbe-http_get" class="oneof oneof-start">
|
||||
<td><code>httpGet</code></td>
|
||||
<td><code><a href="#HTTPHealthCheckConfig">HTTPHealthCheckConfig (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>an http get is performed to a given endpoint
|
||||
and the status/able to connect determines health.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ReadinessProbe-tcp_socket" class="oneof">
|
||||
<td><code>tcpSocket</code></td>
|
||||
<td><code><a href="#TCPHealthCheckConfig">TCPHealthCheckConfig (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>health is determined by if the proxy is able to connect.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ReadinessProbe-exec" class="oneof">
|
||||
<td><code>exec</code></td>
|
||||
<td><code><a href="#ExecHealthCheckConfig">ExecHealthCheckConfig (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>health is determined by how the command that is executed exited.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="HTTPHealthCheckConfig">HTTPHealthCheckConfig</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="HTTPHealthCheckConfig-path">
|
||||
<td><code>path</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Path to access on the HTTP server.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="HTTPHealthCheckConfig-port">
|
||||
<td><code>port</code></td>
|
||||
<td><code>uint32</code></td>
|
||||
<td>
|
||||
<p>port on which the endpoint lives.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="HTTPHealthCheckConfig-host">
|
||||
<td><code>host</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Host name to connect to, defaults to the pod IP. You probably want to set
|
||||
“Host” in httpHeaders instead.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="HTTPHealthCheckConfig-scheme">
|
||||
<td><code>scheme</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>http or https, defaults to http</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="HTTPHealthCheckConfig-http_headers">
|
||||
<td><code>httpHeaders</code></td>
|
||||
<td><code><a href="#HTTPHeader">HTTPHeader[]</a></code></td>
|
||||
<td>
|
||||
<p>headers the proxy will pass on to make the request.
|
||||
allows repeated headers.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="HTTPHeader">HTTPHeader</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="HTTPHeader-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The header field name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="HTTPHeader-value">
|
||||
<td><code>value</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The header field value</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="TCPHealthCheckConfig">TCPHealthCheckConfig</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="TCPHealthCheckConfig-host">
|
||||
<td><code>host</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>host to connect to, defaults to localhost</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="TCPHealthCheckConfig-port">
|
||||
<td><code>port</code></td>
|
||||
<td><code>uint32</code></td>
|
||||
<td>
|
||||
<p>port of host</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="ExecHealthCheckConfig">ExecHealthCheckConfig</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="ExecHealthCheckConfig-command">
|
||||
<td><code>command</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td>
|
||||
<p>command to run. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
|
|||
Loading…
Reference in New Issue