mirror of https://github.com/istio/istio.io.git
Automator: update istio.io@ reference docs (#15387)
This commit is contained in:
Istio Automation
GitHub
parent
bf04e733c4
commit
01de42add2
|
|
@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
|
|||
title: istioctl
|
||||
description: Istio control interface.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 101
|
||||
number_of_entries: 100
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istioctl '
|
||||
---
|
||||
|
|
@ -2859,87 +2859,6 @@ Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in
|
|||
# (Select a specific control plane in an in-cluster canary Istio configuration.)
|
||||
istioctl x version --xds-label istio.io/rev=default
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-wait">istioctl experimental wait</h2>
|
||||
<p>Waits for the specified condition to be true of an Istio resource.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental wait [flags] <type> <name>[.<namespace>]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--for <string></code></td>
|
||||
<td></td>
|
||||
<td>Wait condition, must be 'distribution' or 'delete' (default `distribution`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--generation <string></code></td>
|
||||
<td></td>
|
||||
<td>Wait for a specific generation of config to become current, rather than using whatever is latest in Kubernetes (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--proxy <string></code></td>
|
||||
<td></td>
|
||||
<td>Name of a specific proxy to wait for the condition to be satisfied (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--revision <string></code></td>
|
||||
<td><code>-r</code></td>
|
||||
<td>Control plane revision (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--threshold <float32></code></td>
|
||||
<td></td>
|
||||
<td>The ratio of distribution required for success (default `1`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--timeout <duration></code></td>
|
||||
<td></td>
|
||||
<td>The duration to wait before failing (default `30s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-wait Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Wait until the bookinfo virtual service has been distributed to all proxies in the mesh
|
||||
istioctl experimental wait --for=distribution virtualservice bookinfo.default
|
||||
|
||||
# Wait until the bookinfo virtual service has been distributed to a specific proxy
|
||||
istioctl experimental wait --for=distribution virtualservice bookinfo.default --proxy workload-instance.namespace
|
||||
|
||||
# Wait until 99% of the proxies receive the distribution, timing out after 5 minutes
|
||||
istioctl experimental wait --for=distribution --threshold=.99 --timeout=300s virtualservice bookinfo.default
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-workload">istioctl experimental workload</h2>
|
||||
<p>Commands to assist in configuring and deploying workloads running on VMs and other non-Kubernetes environments</p>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,100 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
|
||||
source_repo: https://github.com/istio/api
|
||||
title: ServiceEntry Status
|
||||
description: Status field for Istio ServiceEntry.
|
||||
location: https://istio.io/docs/reference/config/networking/serviceentry-status.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 2
|
||||
---
|
||||
<h2 id="ServiceEntryStatus">ServiceEntryStatus</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="ServiceEntryStatus-conditions">
|
||||
<td><code>conditions</code></td>
|
||||
<td><code><a href="/docs/reference/config/meta/v1beta1/istio-status/#IstioCondition">IstioCondition[]</a></code></td>
|
||||
<td>
|
||||
<p>Current service state of ServiceEntry.
|
||||
More info: <a href="/docs/reference/config/config-status/">https://istio.io/docs/reference/config/config-status/</a></p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ServiceEntryStatus-validation_messages">
|
||||
<td><code>validationMessages</code></td>
|
||||
<td><code><a href="/docs/reference/config/istio.analysis.v1alpha1/#AnalysisMessageBase">AnalysisMessageBase[]</a></code></td>
|
||||
<td>
|
||||
<p>Includes any errors or warnings detected by Istio’s analyzers.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ServiceEntryStatus-observed_generation">
|
||||
<td><code>observedGeneration</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Resource Generation to which the Reconciled Condition refers.
|
||||
When this value is not equal to the object’s metadata generation, reconciled condition calculation for the current
|
||||
generation is still in progress. See <a href="/docs/reference/config/config-status/">https://istio.io/latest/docs/reference/config/config-status/</a> for more info.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ServiceEntryStatus-addresses">
|
||||
<td><code>addresses</code></td>
|
||||
<td><code><a href="#ServiceEntryAddress">ServiceEntryAddress[]</a></code></td>
|
||||
<td>
|
||||
<p>List of addresses which were assigned to this ServiceEntry.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="ServiceEntryAddress">ServiceEntryAddress</h2>
|
||||
<section>
|
||||
<p>minor abstraction to allow for adding hostnames if relevant</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="ServiceEntryAddress-value">
|
||||
<td><code>value</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Value is the address (192.168.0.2)</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
|
|||
title: istioctl
|
||||
description: Istio control interface.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 101
|
||||
number_of_entries: 100
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istioctl '
|
||||
---
|
||||
|
|
@ -2859,87 +2859,6 @@ Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in
|
|||
# (Select a specific control plane in an in-cluster canary Istio configuration.)
|
||||
istioctl x version --xds-label istio.io/rev=default
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-wait">istioctl experimental wait</h2>
|
||||
<p>Waits for the specified condition to be true of an Istio resource.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental wait [flags] <type> <name>[.<namespace>]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--for <string></code></td>
|
||||
<td></td>
|
||||
<td>Wait condition, must be 'distribution' or 'delete' (default `distribution`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--generation <string></code></td>
|
||||
<td></td>
|
||||
<td>Wait for a specific generation of config to become current, rather than using whatever is latest in Kubernetes (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--proxy <string></code></td>
|
||||
<td></td>
|
||||
<td>Name of a specific proxy to wait for the condition to be satisfied (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--revision <string></code></td>
|
||||
<td><code>-r</code></td>
|
||||
<td>Control plane revision (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--threshold <float32></code></td>
|
||||
<td></td>
|
||||
<td>The ratio of distribution required for success (default `1`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--timeout <duration></code></td>
|
||||
<td></td>
|
||||
<td>The duration to wait before failing (default `30s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-wait Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Wait until the bookinfo virtual service has been distributed to all proxies in the mesh
|
||||
istioctl experimental wait --for=distribution virtualservice bookinfo.default
|
||||
|
||||
# Wait until the bookinfo virtual service has been distributed to a specific proxy
|
||||
istioctl experimental wait --for=distribution virtualservice bookinfo.default --proxy workload-instance.namespace
|
||||
|
||||
# Wait until 99% of the proxies receive the distribution, timing out after 5 minutes
|
||||
istioctl experimental wait --for=distribution --threshold=.99 --timeout=300s virtualservice bookinfo.default
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-workload">istioctl experimental workload</h2>
|
||||
<p>Commands to assist in configuring and deploying workloads running on VMs and other non-Kubernetes environments</p>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,100 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/api' REPO
|
||||
source_repo: https://github.com/istio/api
|
||||
title: ServiceEntry Status
|
||||
description: Status field for Istio ServiceEntry.
|
||||
location: https://istio.io/docs/reference/config/networking/serviceentry-status.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 2
|
||||
---
|
||||
<h2 id="ServiceEntryStatus">ServiceEntryStatus</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="ServiceEntryStatus-conditions">
|
||||
<td><code>conditions</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/meta/v1beta1/istio-status/#IstioCondition">IstioCondition[]</a></code></td>
|
||||
<td>
|
||||
<p>Current service state of ServiceEntry.
|
||||
More info: <a href="/zh/docs/reference/config/config-status/">https://istio.io/docs/reference/config/config-status/</a></p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ServiceEntryStatus-validation_messages">
|
||||
<td><code>validationMessages</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/istio.analysis.v1alpha1/#AnalysisMessageBase">AnalysisMessageBase[]</a></code></td>
|
||||
<td>
|
||||
<p>Includes any errors or warnings detected by Istio’s analyzers.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ServiceEntryStatus-observed_generation">
|
||||
<td><code>observedGeneration</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Resource Generation to which the Reconciled Condition refers.
|
||||
When this value is not equal to the object’s metadata generation, reconciled condition calculation for the current
|
||||
generation is still in progress. See <a href="/latest/docs/reference/config/config-status/">https://istio.io/latest/docs/reference/config/config-status/</a> for more info.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ServiceEntryStatus-addresses">
|
||||
<td><code>addresses</code></td>
|
||||
<td><code><a href="#ServiceEntryAddress">ServiceEntryAddress[]</a></code></td>
|
||||
<td>
|
||||
<p>List of addresses which were assigned to this ServiceEntry.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="ServiceEntryAddress">ServiceEntryAddress</h2>
|
||||
<section>
|
||||
<p>minor abstraction to allow for adding hostnames if relevant</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="ServiceEntryAddress-value">
|
||||
<td><code>value</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Value is the address (192.168.0.2)</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
Loading…
Reference in New Issue