mirror of https://github.com/istio/istio.io.git
Automator: update istio.io@ reference docs (#8669)
This commit is contained in:
Istio Automation
GitHub
parent
9726049d12
commit
3e71d5a314
|
|
@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
|
|||
title: istioctl
|
||||
description: Istio control interface.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 88
|
||||
number_of_entries: 82
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istioctl '
|
||||
---
|
||||
|
|
@ -415,54 +415,6 @@ All names except label and annotation keys support '*' glob matching pat
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-convert-ingress">istioctl convert-ingress</h2>
|
||||
<p>Converts Ingresses into VirtualService configuration on a best effort basis. The output should be considered a starting point for your Istio configuration and probably require some minor modification. Warnings will be generated where configs cannot be converted perfectly. The input must be a Kubernetes Ingress. The conversion of v1alpha1 Istio rules has been removed from istioctl.</p>
|
||||
<pre class="language-bash"><code>istioctl convert-ingress [flags]
|
||||
</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>The name of the kubeconfig context to use (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--filenames <stringSlice></code></td>
|
||||
<td><code>-f</code></td>
|
||||
<td>Input filenames (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>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output filename (default `-`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-convert-ingress Examples">Examples</h3>
|
||||
<pre class="language-bash"><code>istioctl convert-ingress -f samples/bookinfo/platform/kube/bookinfo-ingress.yaml
|
||||
</code></pre>
|
||||
<h2 id="istioctl-dashboard">istioctl dashboard</h2>
|
||||
<p>Access to Istio web UIs</p>
|
||||
<pre class="language-bash"><code>istioctl dashboard [flags]
|
||||
|
|
@ -2173,294 +2125,6 @@ calculated over a time interval of 1 minute.
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-post-install">istioctl experimental post-install</h2>
|
||||
<p>Commands related to post-install</p>
|
||||
<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>The name of the kubeconfig context to use (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>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-post-install-webhook">istioctl experimental post-install webhook</h2>
|
||||
<p>webhook command to manage webhook configurations [Deprecated, it will be removed in Istio 1.9]</p>
|
||||
<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>The name of the kubeconfig context to use (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>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-post-install-webhook-disable">istioctl experimental post-install webhook disable</h2>
|
||||
<p>Disable webhook configurations</p>
|
||||
<pre class="language-bash"><code>istioctl experimental post-install webhook disable [flags]
|
||||
</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>The name of the kubeconfig context to use (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--injection</code></td>
|
||||
<td></td>
|
||||
<td>Disable mutating webhook (default true). </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--injection-config <string></code></td>
|
||||
<td></td>
|
||||
<td>The mutating webhook configuration to disable. (default `istio-sidecar-injector`)</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>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--validation</code></td>
|
||||
<td></td>
|
||||
<td>Disable validating webhook (default true). </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--validation-config <string></code></td>
|
||||
<td></td>
|
||||
<td>The validating webhook configuration to disable. (default `istio-galley`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-post-install-webhook-disable Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Disable all webhooks
|
||||
istioctl experimental post-install webhook disable
|
||||
|
||||
# Disable all webhooks except injection
|
||||
istioctl experimental post-install webhook disable --injection=false
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-post-install-webhook-enable">istioctl experimental post-install webhook enable</h2>
|
||||
<p>This command is used to enable webhook configurations after installing Istio.
|
||||
For previous Istio versions (e.g., 1.2, 1.3, etc), this command is not needed
|
||||
because in previous versions webhooks manage their own configurations.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental post-install webhook enable [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--ca-bundle-file <string></code></td>
|
||||
<td></td>
|
||||
<td>PEM encoded CA bundle which will be used to validate the webhook's server certificates. If this is empty, the kube-apisever's root CA is used if it can be confirmed to have signed the webhook's certificates. This condition is sometimes true but is not guaranteed (see https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping) (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of the kubeconfig context to use (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--injection</code></td>
|
||||
<td></td>
|
||||
<td>Enable injection webhook (default true). </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--injection-path <string></code></td>
|
||||
<td></td>
|
||||
<td>The file path of the injection webhook configuration. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--injection-service <string></code></td>
|
||||
<td></td>
|
||||
<td>The service name of the injection webhook to manage. (default `istio-pilot`)</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>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--read-cert-timeout <duration></code></td>
|
||||
<td></td>
|
||||
<td> Max time for waiting the webhook certificate to be readable. (default `1m0s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--timeout <duration></code></td>
|
||||
<td></td>
|
||||
<td> Max time for checking the validating webhook server. If the validating webhook server is not readyin the given time, exit. Otherwise, apply the webhook configuration. (default `1m0s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--validation</code></td>
|
||||
<td></td>
|
||||
<td>Enable validatation webhook (default true). </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--validation-path <string></code></td>
|
||||
<td></td>
|
||||
<td>The file path of the validation webhook configuration. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--validation-service <string></code></td>
|
||||
<td></td>
|
||||
<td>The service name of the validation webhook to manage. (default `istio-galley`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--webhook-secret <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of an existing Kubernetes secret of a webhook. istioctl will verify that the webhook certificate is issued by the CA certificate. (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-post-install-webhook-enable Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Enable the webhook configuration of Galley with the given webhook configuration
|
||||
istioctl experimental post-install webhook enable --validation --webhook-secret istio.webhook.galley
|
||||
--namespace istio-system --validation-path validatingwebhookconfiguration.yaml
|
||||
|
||||
# Enable the webhook configuration of Galley with the given webhook configuration and CA certificate
|
||||
istioctl experimental post-install webhook enable --validation --webhook-secret istio.webhook.galley
|
||||
--namespace istio-system --validation-path validatingwebhookconfiguration.yaml --ca-bundle-file ./k8s-ca-cert.pem
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-post-install-webhook-status">istioctl experimental post-install webhook status</h2>
|
||||
<p>Get webhook configurations</p>
|
||||
<pre class="language-bash"><code>istioctl experimental post-install webhook status [flags]
|
||||
</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>The name of the kubeconfig context to use (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--injection</code></td>
|
||||
<td></td>
|
||||
<td>Display the injection webhook configuration. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--injection-config <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of the MutatingWebhookConfiguration to display. (default `istio-sidecar-injector`)</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>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--validation</code></td>
|
||||
<td></td>
|
||||
<td>Display the validating webhook configuration. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--validation-config <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of the ValidatingWebhookConfiguration to display. (default `istio-galley`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-post-install-webhook-status Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # Display the webhook configuration of Galley
|
||||
istioctl experimental post-install webhook status --validation --validation-config istio-galley
|
||||
|
||||
# Display the webhook configuration of Galley and Sidecar Injector
|
||||
istioctl experimental post-install webhook status --validation --validation-config istio-galley
|
||||
--injection --injection-config istio-sidecar-injector
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-precheck">istioctl experimental precheck</h2>
|
||||
<p>
|
||||
precheck inspects a Kubernetes cluster for Istio install requirements.
|
||||
|
|
|
|||
Loading…
Reference in New Issue