mirror of https://github.com/istio/istio.io.git
Update reference docs.
This commit is contained in:
mtail
parent
3e13d4a3bc
commit
054ce6164c
|
|
@ -14,6 +14,10 @@ number_of_entries: 4
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--append-dns-names</code></td>
|
||||
<td>Append DNS names to the certificates for webhook services. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--cert-chain <string></code></td>
|
||||
<td>Path to the certificate chain file (default ``)</td>
|
||||
</tr>
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: istioctl
|
||||
overview: Istio control interface
|
||||
layout: pkg-collateral-docs
|
||||
number_of_entries: 14
|
||||
number_of_entries: 16
|
||||
---
|
||||
<p>
|
||||
Istio configuration command line utility.</p>
|
||||
|
|
@ -435,6 +435,173 @@ istioctl delete routerule productpage-default
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl experimental">istioctl experimental</h2>
|
||||
<p>Experimental commands that may be modified or deprecated</p>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<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 `$KUBECONFIG else $HOME/.kube/config`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_as_json</code></td>
|
||||
<td></td>
|
||||
<td>Whether to format output as JSON or in plain console-friendly format </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_callers</code></td>
|
||||
<td></td>
|
||||
<td>Include caller information, useful for debugging </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td></td>
|
||||
<td>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
<td></td>
|
||||
<td>The path for the optional rotating log file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate_max_age <int></code></td>
|
||||
<td></td>
|
||||
<td>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate_max_backups <int></code></td>
|
||||
<td></td>
|
||||
<td>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate_max_size <int></code></td>
|
||||
<td></td>
|
||||
<td>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td></td>
|
||||
<td>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
<td></td>
|
||||
<td>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--platform <string></code></td>
|
||||
<td><code>-p</code></td>
|
||||
<td>Istio host platform (default `kube`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl experimental convert-networking-config">istioctl experimental convert-networking-config</h2>
|
||||
<p>Converts sets of v1alpha1 configs to v1alpha3 equivalents on a best effort basis. The output should be considered a starting point for your v1alpha3 configs and probably require some minor modification. Warnings will (hopefully) be generated where configs cannot be converted perfectly, or in certain edge cases. The input must be the set of configs that would be in place in an environment at a given time. This allows the command to attempt to create and merge output configs intelligently.Output configs are given the namespace and domain of the first input config so it is recommended that input configs be part of the same namespace and domain.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental convert-networking-config [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--filenames <stringSlice></code></td>
|
||||
<td><code>-f</code></td>
|
||||
<td>Input filename (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 `$KUBECONFIG else $HOME/.kube/config`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_as_json</code></td>
|
||||
<td></td>
|
||||
<td>Whether to format output as JSON or in plain console-friendly format </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_callers</code></td>
|
||||
<td></td>
|
||||
<td>Include caller information, useful for debugging </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td></td>
|
||||
<td>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
<td></td>
|
||||
<td>The path for the optional rotating log file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate_max_age <int></code></td>
|
||||
<td></td>
|
||||
<td>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate_max_backups <int></code></td>
|
||||
<td></td>
|
||||
<td>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate_max_size <int></code></td>
|
||||
<td></td>
|
||||
<td>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td></td>
|
||||
<td>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
<td></td>
|
||||
<td>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`)</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>
|
||||
<tr>
|
||||
<td><code>--platform <string></code></td>
|
||||
<td><code>-p</code></td>
|
||||
<td>Istio host platform (default `kube`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl experimental convert-networking-config Examples">Examples</h3>
|
||||
<pre class="language-bash"><code>istioctl experimental convert-networking-config -f v1alpha1/default-route.yaml -f v1alpha1/header-delay.yaml
|
||||
</code></pre>
|
||||
<h2 id="istioctl gen-deploy">istioctl gen-deploy</h2>
|
||||
<p>istioctl gen-deploy produces deployment files to run the minimum Istio control for the set of features requested by the --feature flag. If no features are provided, we create deployments for the default control plane: Pilot, Mixer, CA, and Ingress Proxies, with mTLS enabled.</p>
|
||||
<pre class="language-bash"><code>istioctl gen-deploy [flags]
|
||||
|
|
|
|||
|
|
@ -108,11 +108,6 @@ nexus for policy evaluation and telemetry reporting.</p>
|
|||
<td>URL of the config store. Use k8s://path_to_kubeconfig or fs:// for file system. If path_to_kubeconfig is empty, in-cluster kubeconfig is used. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--expressionEvalCacheSize <int></code></td>
|
||||
<td></td>
|
||||
<td>Number of entries in the expression cache (default `1024`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--livenessProbeInterval <duration></code></td>
|
||||
<td></td>
|
||||
<td>Interval of updating file for the liveness probe. (default `0s`)</td>
|
||||
|
|
@ -222,11 +217,6 @@ nexus for policy evaluation and telemetry reporting.</p>
|
|||
<td></td>
|
||||
<td>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--useNewRuntime</code></td>
|
||||
<td></td>
|
||||
<td>Use the new runtime code for processing requests. </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="mixs validator">mixs validator</h2>
|
||||
|
|
|
|||
|
|
@ -670,12 +670,14 @@ audiences will be accepted.</p>
|
|||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>URL of the provider’s public key set to validate signature of the
|
||||
JWT. See <a href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata">OpenID Discovery</a>.</p>
|
||||
JWT. See <a href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata">OpenID
|
||||
Discovery</a>.</p>
|
||||
|
||||
<p>Optional if the key set document can either (a) be retrieved from
|
||||
<a href="https://openid.net/specs/openid-connect-discovery-1_0.html">OpenID Discovery</a>
|
||||
of the issuer or (b) inferred from the email domain of the issuer
|
||||
(e.g. a Google service account).</p>
|
||||
<a href="https://openid.net/specs/openid-connect-discovery-1_0.html">OpenID
|
||||
Discovery</a> of
|
||||
the issuer or (b) inferred from the email domain of the issuer (e.g. a
|
||||
Google service account).</p>
|
||||
|
||||
<p>Example: https://www.googleapis.com/oauth2/v1/certs</p>
|
||||
|
||||
|
|
@ -686,7 +688,8 @@ of the issuer or (b) inferred from the email domain of the issuer
|
|||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>If true, forward the entire base64 encoded JWT in the HTTP request.
|
||||
If false, remove the JWT from the HTTP request and do not forward to the application.</p>
|
||||
If false, remove the JWT from the HTTP request and do not forward to the
|
||||
application.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
|
|
|||
|
|
@ -5,6 +5,35 @@ location: https://istio.io/docs/reference/config/istio.networking.v1alpha3.html
|
|||
layout: protoc-gen-docs
|
||||
number_of_entries: 36
|
||||
---
|
||||
<p>Configuration affecting traffic routing. Here are a few terms useful to define
|
||||
in the context of traffic routing.</p>
|
||||
|
||||
<p><em>Service</em> a unit of application behavior bound to a unique name in a
|
||||
service registry. Services consist of multiple network <em>endpoints</em>
|
||||
implemented by workload instances running on pods, containers, VMs etc.</p>
|
||||
|
||||
<p><em>Service versions (subsets)</em> - In a continuous deployment scenario, for
|
||||
a given service, there can be distinct subsets of instances running
|
||||
different variants of the application binary. These variants are not
|
||||
necessarily different API versions. They could be iterative changes to
|
||||
the same service, deployed in different environments (prod, staging,
|
||||
dev, etc.). Common scenarios where this occurs include A/B testing,
|
||||
canary rollouts, etc. The choice of a particular version can be decided
|
||||
based on various criterion (headers, url, etc.) and/or by weights
|
||||
assigned to each version. Each service has a default version consisting
|
||||
of all its instances.</p>
|
||||
|
||||
<p><em>Source</em> - A downstream client calling a service.</p>
|
||||
|
||||
<p><em>Host</em> - The address used by a client when attempting to connect to a
|
||||
service.</p>
|
||||
|
||||
<p><em>Access model</em> - Applications address only the destination service
|
||||
(Host) without knowledge of individual service versions (subsets). The
|
||||
actual choice of the version is determined by the proxy/sidecar, enabling the
|
||||
application code to decouple itself from the evolution of dependent
|
||||
services.</p>
|
||||
|
||||
<h2 id="ConnectionPoolSettings">ConnectionPoolSettings</h2>
|
||||
<section>
|
||||
<p>Connection pool settings for an upstream host. The settings apply to
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Mixer Adapter Model
|
|||
overview: Definitions used to create adapters and templates
|
||||
location: https://istio.io/docs/reference/config/mixer/istio.mixer.adapter.model.v1beta1.html
|
||||
layout: protoc-gen-docs
|
||||
number_of_entries: 22
|
||||
number_of_entries: 23
|
||||
---
|
||||
<p>This package defines the service and types used by adapter code to serve requests from Mixer.
|
||||
This package also defines the types that are used to create Mixer templates.</p>
|
||||
|
|
@ -233,6 +233,60 @@ DO NOT USE !! Under Development</p>
|
|||
<section>
|
||||
<p>IPAddress is used inside templates for fields that are of ValueType “IP_ADDRESS”</p>
|
||||
|
||||
</section>
|
||||
<h3 id="Info">Info</h3>
|
||||
<section>
|
||||
<p>Info describes an adapter or a backend that wants to provide telemetry and policy functionality to Mixer as an
|
||||
out of process adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Info.name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Name of the adapter. It must be an RFC 1035 compatible DNS label
|
||||
matching the <code>^[a-z]([-a-z0-9]*[a-z0-9])?$</code> regular expression.
|
||||
Name is used in Istio configuration, therefore it should be descriptive but short.
|
||||
example: denier
|
||||
Vendor adapters should use a vendor prefix.
|
||||
example: mycompany-denier</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Info.description">
|
||||
<td><code>description</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>User-friendly description of the adapter.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Info.templates">
|
||||
<td><code>templates</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td>
|
||||
<p>Base64 encoded proto descriptor of all the templates the adapter wants to serve.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Info.config">
|
||||
<td><code>config</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Base64 encoded proto descriptor of the adapter configuration.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h3 id="QuotaRequest">QuotaRequest</h3>
|
||||
<section>
|
||||
|
|
|
|||
|
|
@ -19,6 +19,7 @@ COMMAND_DIR=$ISTIO_BASE/_docs/reference/commands
|
|||
pushd $WORK_DIR
|
||||
git clone https://github.com/istio/api.git
|
||||
git clone https://github.com/istio/istio.git
|
||||
rm -fr istio/vendor
|
||||
popd
|
||||
|
||||
# Given the name of a .pb.html file, extracts the $location marker and then proceeds to
|
||||
|
|
@ -36,7 +37,7 @@ locate_file() {
|
|||
FNP=${LOCATION:31}
|
||||
FN=$(echo $FNP | rev | cut -d'/' -f1 | rev)
|
||||
PP=$(echo $FNP | rev | cut -d'/' -f2- | rev)
|
||||
sed -e 's/href="https:\/\/istio.io/href="{{site.baseurl}}/g' ${FILENAME} >_docs/${PP}/${FN}
|
||||
sed -e 's/href="https:\/\/istio.io/href="{{site.baseurl}}/g' ${FILENAME} >_docs${PP}/${FN}
|
||||
}
|
||||
|
||||
# Given the path and name to an Istio command, builds the command and then
|
||||
|
|
|
|||
Loading…
Reference in New Issue