mirror of https://github.com/istio/istio.io.git
Update reference docs. (#5054)
This commit is contained in:
Martin Taillefer
GitHub
parent
e606e95503
commit
0baea02755
|
|
@ -83,11 +83,11 @@ number_of_entries: 4
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, monitor] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, monitor] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -107,7 +107,7 @@ number_of_entries: 4
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, monitor] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -225,11 +225,11 @@ number_of_entries: 4
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, monitor] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, monitor] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -249,7 +249,7 @@ number_of_entries: 4
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, monitor] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -292,12 +292,12 @@ number_of_entries: 4
|
|||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, monitor] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, monitor] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -322,7 +322,7 @@ number_of_entries: 4
|
|||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, monitor] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, k8sController, monitor, pkiCaLog, serverCaLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
|
|||
|
|
@ -849,7 +849,7 @@ THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
|||
</code></pre>
|
||||
<h2 id="istioctl-experimental-analyze">istioctl experimental analyze</h2>
|
||||
<p>Analyze Istio configuration and print validation messages</p>
|
||||
<pre class="language-bash"><code>istioctl experimental analyze <file|globpattern>... [flags]
|
||||
<pre class="language-bash"><code>istioctl experimental analyze <file>... [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
|
|
@ -1445,7 +1445,7 @@ kubectl get deployment -o yaml | istioctl experimental kube-uninject -f - | kube
|
|||
<tr>
|
||||
<td><code>--filename <string></code></td>
|
||||
<td><code>-f</code></td>
|
||||
<td>Path to file containing IstioControlPlane CustomResource. (default ``)</td>
|
||||
<td>Path to file containing IstioControlPlane CustomResource (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
|
|
@ -1475,14 +1475,14 @@ kubectl get deployment -o yaml | istioctl experimental kube-uninject -f - | kube
|
|||
<tr>
|
||||
<td><code>--readiness-timeout <duration></code></td>
|
||||
<td></td>
|
||||
<td>Maximum seconds to wait for all Istio resources to be ready. The --wait flag must be set for this flag to apply. (default `5m0s`)</td>
|
||||
<td>Maximum seconds to wait for all Istio resources to be ready. The --wait flag must be set for this flag to apply (default `5m0s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--set <stringSlice></code></td>
|
||||
<td><code>-s</code></td>
|
||||
<td>Set a value in IstioControlPlane CustomResource. e.g. --set policy.enabled=true.
|
||||
Overrides the corresponding path value in the selected profile or passed through IstioControlPlane CR
|
||||
customization file. (default `[]`)</td>
|
||||
customization file (default `[]`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
|
|
@ -1492,13 +1492,18 @@ customization file. (default `[]`)</td>
|
|||
<tr>
|
||||
<td><code>--wait</code></td>
|
||||
<td><code>-w</code></td>
|
||||
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds. </td>
|
||||
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--yes</code></td>
|
||||
<td><code>-y</code></td>
|
||||
<td>Do not ask for confirmation </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-manifest-diff">istioctl experimental manifest diff</h2>
|
||||
<p>The diff subcommand compares manifests from two files or directories.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental manifest diff [flags]
|
||||
<pre class="language-bash"><code>istioctl experimental manifest diff <file|dir> <file|dir> [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
|
|
@ -1527,7 +1532,7 @@ customization file. (default `[]`)</td>
|
|||
<tr>
|
||||
<td><code>--ignore <string></code></td>
|
||||
<td></td>
|
||||
<td>ignoreResources ignores all listed items during comparison. It uses the same list format as selectResources. (default ``)</td>
|
||||
<td>ignoreResources ignores all listed items during comparison. It uses the same list format as selectResources (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
|
|
@ -1561,7 +1566,7 @@ customization file. (default `[]`)</td>
|
|||
The format of each list item is "::" and the items are comma separated. The "*" character represents wildcard selection.
|
||||
e.g.
|
||||
Deployment:istio-system:* - compare all deployments in istio-system namespace
|
||||
Service:*:istio-pilot - compare Services called "istio-pilot" in all namespaces. (default `::`)</td>
|
||||
Service:*:istio-pilot - compare Services called "istio-pilot" in all namespaces (default `::`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
|
|
@ -1596,7 +1601,7 @@ e.g.
|
|||
<tr>
|
||||
<td><code>--filename <string></code></td>
|
||||
<td><code>-f</code></td>
|
||||
<td>Path to file containing IstioControlPlane CustomResource. (default ``)</td>
|
||||
<td>Path to file containing IstioControlPlane CustomResource (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
|
|
@ -1626,14 +1631,14 @@ e.g.
|
|||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Manifest output directory path. (default ``)</td>
|
||||
<td>Manifest output directory path (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--set <stringSlice></code></td>
|
||||
<td><code>-s</code></td>
|
||||
<td>Set a value in IstioControlPlane CustomResource. e.g. --set policy.enabled=true.
|
||||
Overrides the corresponding path value in the selected profile or passed through IstioControlPlane CR
|
||||
customization file. (default `[]`)</td>
|
||||
customization file (default `[]`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
|
|
@ -1644,7 +1649,7 @@ customization file. (default `[]`)</td>
|
|||
</table>
|
||||
<h2 id="istioctl-experimental-manifest-migrate">istioctl experimental manifest migrate</h2>
|
||||
<p>The migrate subcommand migrates a configuration from Helm values format to IstioControlPlane format.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental manifest migrate [flags]
|
||||
<pre class="language-bash"><code>istioctl experimental manifest migrate [<filepath>] [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
|
|
@ -1698,7 +1703,7 @@ customization file. (default `[]`)</td>
|
|||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-manifest-versions">istioctl experimental manifest versions</h2>
|
||||
<p>List the version of Istio recommended for and supported by this version of the operator binary.</p>
|
||||
<p>List the versions of Istio recommended for and supported by this version of the operator binary.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental manifest versions [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
|
|
@ -1753,7 +1758,7 @@ customization file. (default `[]`)</td>
|
|||
<tr>
|
||||
<td><code>--versionsURI <string></code></td>
|
||||
<td><code>-u</code></td>
|
||||
<td>URI for operator versions to Istio versions map. (default `https://raw.githubusercontent.com/istio/operator/master/version/versions.yaml`)</td>
|
||||
<td>URI for operator versions to Istio versions map (default `https://raw.githubusercontent.com/istio/operator/master/version/versions.yaml`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1875,7 +1880,7 @@ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|||
</table>
|
||||
<h2 id="istioctl-experimental-profile-diff">istioctl experimental profile diff</h2>
|
||||
<p>The diff subcommand displays the differences between two Istio configuration profiles.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental profile diff [flags]
|
||||
<pre class="language-bash"><code>istioctl experimental profile diff <file1.yaml> <file2.yaml> [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
|
|
@ -1930,7 +1935,7 @@ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|||
</table>
|
||||
<h2 id="istioctl-experimental-profile-dump">istioctl experimental profile dump</h2>
|
||||
<p>The dump subcommand dumps the values in an Istio configuration profile.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental profile dump [flags]
|
||||
<pre class="language-bash"><code>istioctl experimental profile dump [<profile>] [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
|
|
@ -1944,7 +1949,7 @@ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|||
<tr>
|
||||
<td><code>--config-path <string></code></td>
|
||||
<td><code>-p</code></td>
|
||||
<td>The path the root of the configuration subtree to dump e.g. trafficManagement.components.pilot. By default, dump whole tree. (default ``)</td>
|
||||
<td>The path the root of the configuration subtree to dump e.g. trafficManagement.components.pilot. By default, dump whole tree (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
|
|
@ -1959,12 +1964,12 @@ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|||
<tr>
|
||||
<td><code>--filename <string></code></td>
|
||||
<td><code>-f</code></td>
|
||||
<td>Path to file containing IstioControlPlane CustomResource. (default ``)</td>
|
||||
<td>Path to file containing IstioControlPlane CustomResource (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--helm-values</code></td>
|
||||
<td></td>
|
||||
<td>If set, dumps the Helm values that IstioControlPlaceSpec is translated to before manifests are rendered. </td>
|
||||
<td>If set, dumps the Helm values that IstioControlPlaceSpec is translated to before manifests are rendered </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
|
|
@ -3381,6 +3386,7 @@ These environment variables affect the behavior of the <code>istioctl</code> com
|
|||
<tr><td><code>pilot_xds_eds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected EDS.</td></tr>
|
||||
<tr><td><code>pilot_xds_lds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected LDS.</td></tr>
|
||||
<tr><td><code>pilot_xds_push_context_errors</code></td><td><code>Sum</code></td><td>Number of errors (timeouts) initiating push context.</td></tr>
|
||||
<tr><td><code>pilot_xds_push_time</code></td><td><code>Distribution</code></td><td>Total time in second Pilot takes to push lds, rds, cds and eds.</td></tr>
|
||||
<tr><td><code>pilot_xds_pushes</code></td><td><code>Sum</code></td><td>Pilot build and send errors for lds, rds, cds and eds.</td></tr>
|
||||
<tr><td><code>pilot_xds_rds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected RDS.</td></tr>
|
||||
<tr><td><code>pilot_xds_write_timeout</code></td><td><code>Sum</code></td><td>Pilot XDS response write timeouts.</td></tr>
|
||||
|
|
|
|||
|
|
@ -145,6 +145,11 @@ nexus for policy evaluation and telemetry reporting.</p>
|
|||
<td>The location of the key file for mutual TLS (default `/etc/certs/key.pem`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--latencyEnforcementThreshold <ratelimit></code></td>
|
||||
<td></td>
|
||||
<td>Controls the threshold, in requests per second, above which the average latency threshold will be enforced for load-shedding (default `100`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--latencySampleHalflife <duration></code></td>
|
||||
<td></td>
|
||||
<td>Decay rate of samples in calculation of average response latency. (default `1s`)</td>
|
||||
|
|
@ -396,7 +401,8 @@ These environment variables affect the behavior of the <code>mixs</code> command
|
|||
<tr><td><code>mixer_handler_new_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were newly created during config transition.</td></tr>
|
||||
<tr><td><code>mixer_handler_reused_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were re-used during config transition.</td></tr>
|
||||
<tr><td><code>mixer_handler_workers_total</code></td><td><code>LastValue</code></td><td>The current number of active worker routines in a given adapter environment.</td></tr>
|
||||
<tr><td><code>mixer_loadshedding_requests_throttled</code></td><td><code>Count</code></td><td>The number of requests that have been dropped by the loadshedder.</td></tr>
|
||||
<tr><td><code>mixer_loadshedding_predicted_cost_shed_total</code></td><td><code>Sum</code></td><td>The total predicted cost of all requests that have been dropped.</td></tr>
|
||||
<tr><td><code>mixer_loadshedding_requests_throttled</code></td><td><code>Sum</code></td><td>The number of requests that have been dropped by the loadshedder.</td></tr>
|
||||
<tr><td><code>mixer_runtime_dispatch_duration_seconds</code></td><td><code>Distribution</code></td><td>Duration in seconds for adapter dispatches handled by Mixer.</td></tr>
|
||||
<tr><td><code>mixer_runtime_dispatches_total</code></td><td><code>Count</code></td><td>Total number of adapter dispatches handled by Mixer.</td></tr>
|
||||
</tbody>
|
||||
|
|
|
|||
|
|
@ -20,8 +20,8 @@ number_of_entries: 4
|
|||
<td>Paths to a kubeconfig. Only required if out-of-cluster. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--master <string></code></td>
|
||||
<td>The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster. (default ``)</td>
|
||||
<td><code>--master <--kubeconfig></code></td>
|
||||
<td>(Deprecated: switch to --kubeconfig) The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster. (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -94,8 +94,8 @@ number_of_entries: 4
|
|||
<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>--master <string></code></td>
|
||||
<td>The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster. (default ``)</td>
|
||||
<td><code>--master <--kubeconfig></code></td>
|
||||
<td>(Deprecated: switch to --kubeconfig) The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster. (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -118,9 +118,9 @@ number_of_entries: 4
|
|||
<td>Paths to a kubeconfig. Only required if out-of-cluster. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--master <string></code></td>
|
||||
<td><code>--master <--kubeconfig></code></td>
|
||||
<td></td>
|
||||
<td>The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster. (default ``)</td>
|
||||
<td>(Deprecated: switch to --kubeconfig) The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
|
|
|
|||
|
|
@ -21,11 +21,11 @@ number_of_entries: 5
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, authn, default, model, rbac] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -45,7 +45,7 @@ number_of_entries: 5
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -126,8 +126,8 @@ number_of_entries: 5
|
|||
<td>Settings of an Envoy gRPC Access Log Service API implementation (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--envoyMetricsServiceAddress <string></code></td>
|
||||
<td>Host and Port of an Envoy Metrics Service API implementation (e.g. metrics-service:15000) (default ``)</td>
|
||||
<td><code>--envoyMetricsService <string></code></td>
|
||||
<td>Settings of an Envoy gRPC Metrics Service API implementation (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--id <string></code></td>
|
||||
|
|
@ -159,11 +159,11 @@ number_of_entries: 5
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, authn, default, model, rbac] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -183,7 +183,7 @@ number_of_entries: 5
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -261,11 +261,11 @@ number_of_entries: 5
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, authn, default, model, rbac] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -285,7 +285,7 @@ number_of_entries: 5
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -314,12 +314,12 @@ number_of_entries: 5
|
|||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, authn, default, model, rbac] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -344,7 +344,7 @@ number_of_entries: 5
|
|||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -642,6 +642,7 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
|
|||
<tr><td><code>pilot_duplicate_envoy_clusters</code></td><td><code>LastValue</code></td><td>Duplicate envoy clusters caused by service entries with same hostname</td></tr>
|
||||
<tr><td><code>pilot_eds_no_instances</code></td><td><code>LastValue</code></td><td>Number of clusters without instances.</td></tr>
|
||||
<tr><td><code>pilot_endpoint_not_ready</code></td><td><code>LastValue</code></td><td>Endpoint found in unready state.</td></tr>
|
||||
<tr><td><code>pilot_invalid_out_listeners</code></td><td><code>LastValue</code></td><td>Number of invalid outbound listeners.</td></tr>
|
||||
<tr><td><code>pilot_jwks_resolver_network_fetch_fail_total</code></td><td><code>Sum</code></td><td>Total number of failed network fetch by pilot jwks resolver</td></tr>
|
||||
<tr><td><code>pilot_jwks_resolver_network_fetch_success_total</code></td><td><code>Sum</code></td><td>Total number of successfully network fetch by pilot jwks resolver</td></tr>
|
||||
<tr><td><code>pilot_no_ip</code></td><td><code>LastValue</code></td><td>Pods not found in the endpoint table, possibly invalid.</td></tr>
|
||||
|
|
|
|||
|
|
@ -680,6 +680,7 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
|
|||
<tr><td><code>pilot_xds_eds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected EDS.</td></tr>
|
||||
<tr><td><code>pilot_xds_lds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected LDS.</td></tr>
|
||||
<tr><td><code>pilot_xds_push_context_errors</code></td><td><code>Sum</code></td><td>Number of errors (timeouts) initiating push context.</td></tr>
|
||||
<tr><td><code>pilot_xds_push_time</code></td><td><code>Distribution</code></td><td>Total time in second Pilot takes to push lds, rds, cds and eds.</td></tr>
|
||||
<tr><td><code>pilot_xds_pushes</code></td><td><code>Sum</code></td><td>Pilot build and send errors for lds, rds, cds and eds.</td></tr>
|
||||
<tr><td><code>pilot_xds_rds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected RDS.</td></tr>
|
||||
<tr><td><code>pilot_xds_write_timeout</code></td><td><code>Sum</code></td><td>Pilot XDS response write timeouts.</td></tr>
|
||||
|
|
|
|||
|
|
@ -47,11 +47,11 @@ number_of_entries: 4
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, authn, default, model, rbac] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -71,7 +71,7 @@ number_of_entries: 4
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -153,11 +153,11 @@ number_of_entries: 4
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, authn, default, model, rbac] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -177,7 +177,7 @@ number_of_entries: 4
|
|||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -268,12 +268,12 @@ number_of_entries: 4
|
|||
<tr>
|
||||
<td><code>--log_caller <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac] (default ``)</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, authn, default, model, rbac] (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_rotate <string></code></td>
|
||||
|
|
@ -298,7 +298,7 @@ number_of_entries: 4
|
|||
<tr>
|
||||
<td><code>--log_stacktrace_level <string></code></td>
|
||||
<td></td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [all, authn, default, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_target <stringArray></code></td>
|
||||
|
|
@ -538,6 +538,7 @@ These environment variables affect the behavior of the <code>sidecar-injector</c
|
|||
<tr><td><code>pilot_duplicate_envoy_clusters</code></td><td><code>LastValue</code></td><td>Duplicate envoy clusters caused by service entries with same hostname</td></tr>
|
||||
<tr><td><code>pilot_eds_no_instances</code></td><td><code>LastValue</code></td><td>Number of clusters without instances.</td></tr>
|
||||
<tr><td><code>pilot_endpoint_not_ready</code></td><td><code>LastValue</code></td><td>Endpoint found in unready state.</td></tr>
|
||||
<tr><td><code>pilot_invalid_out_listeners</code></td><td><code>LastValue</code></td><td>Number of invalid outbound listeners.</td></tr>
|
||||
<tr><td><code>pilot_jwks_resolver_network_fetch_fail_total</code></td><td><code>Sum</code></td><td>Total number of failed network fetch by pilot jwks resolver</td></tr>
|
||||
<tr><td><code>pilot_jwks_resolver_network_fetch_success_total</code></td><td><code>Sum</code></td><td>Total number of successfully network fetch by pilot jwks resolver</td></tr>
|
||||
<tr><td><code>pilot_no_ip</code></td><td><code>LastValue</code></td><td>Pods not found in the endpoint table, possibly invalid.</td></tr>
|
||||
|
|
|
|||
|
|
@ -132,6 +132,8 @@ Istio supports to control its behavior.
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ description: Configuration affecting the service mesh as a whole.
|
|||
location: https://istio.io/docs/reference/config/istio.mesh.v1alpha1.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 24
|
||||
number_of_entries: 25
|
||||
---
|
||||
<p>Configuration affecting the service mesh as a whole.</p>
|
||||
|
||||
|
|
@ -79,9 +79,17 @@ Use fs:/// to specify a file-based backend with absolute path to the directory.<
|
|||
<td><code>tlsSettings</code></td>
|
||||
<td><code><a href="/docs/reference/config/networking/v1alpha3/destination-rule.html#TLSSettings">istio.networking.v1alpha3.TLSSettings</a></code></td>
|
||||
<td>
|
||||
<p>Use the tls_settings to specify the tls mode to use. If the MCP server
|
||||
<p>Use the tls<em>settings to specify the tls mode to use. If the MCP server
|
||||
uses Istio mutual TLS and shares the root CA with Pilot, specify the TLS
|
||||
mode as <code>ISTIO_MUTUAL</code>.</p>
|
||||
mode as ISTIO</em>MUTUAL.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="ConfigSource-subscribed_resources">
|
||||
<td><code>subscribedResources</code></td>
|
||||
<td><code><a href="#Resource">Resource[]</a></code></td>
|
||||
<td>
|
||||
<p>Describes the source of configuration, if nothing is specified default is MCP</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -852,7 +860,7 @@ inside a mesh and how to route to endpoints in each network. For example</p>
|
|||
<pre><code class="language-yaml">networks:
|
||||
network1:
|
||||
- endpoints:
|
||||
- fromRegistry: registry1 #must match secret name in Kubernetes
|
||||
- fromRegistry: registry1 #must match kubeconfig name in Kubernetes secret
|
||||
- fromCidr: 192.168.100.0/22 #a VM network for example
|
||||
gateways:
|
||||
- registryServiceName: istio-ingressgateway.istio-system.svc.cluster.local
|
||||
|
|
@ -1027,9 +1035,9 @@ ranges for endpoints from different networks must not overlap.</p>
|
|||
<td><code>string (oneof)</code></td>
|
||||
<td>
|
||||
<p>Add all endpoints from the specified registry into this network.
|
||||
The names of the registries should correspond to the secret name
|
||||
that was used to configure the registry (Kubernetes multicluster) or
|
||||
supplied by MCP server.</p>
|
||||
The names of the registries should correspond to the kubeconfig file name
|
||||
inside the secret that was used to configure the registry (Kubernetes
|
||||
multicluster) or supplied by MCP server.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -1312,6 +1320,30 @@ mode as <code>ISTIO_MUTUAL</code>.</p>
|
|||
<td>
|
||||
<p>If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Resource">Resource</h2>
|
||||
<section>
|
||||
<p>Resource describes the source of configuration</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Resource-SERVICE_REGISTRY">
|
||||
<td><code>SERVICE_REGISTRY</code></td>
|
||||
<td>
|
||||
<p>Set to only receive service entries that are generated by the platform.
|
||||
These auto generated service entries are combination of services and endpoints
|
||||
that are generated by a specific platform e.g. k8</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
|
|||
|
|
@ -326,6 +326,9 @@ Default is to use the OS level configuration
|
|||
</section>
|
||||
<h2 id="DestinationRule">DestinationRule</h2>
|
||||
<section>
|
||||
<p>DestinationRule defines policies that apply to traffic intended for a service
|
||||
after routing has occurred.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -80,7 +80,9 @@ spec:
|
|||
patch:
|
||||
operation: MERGE
|
||||
value:
|
||||
idle_timeout: 30s
|
||||
typed_config:
|
||||
"@type": "type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager"
|
||||
idle_timeout: 30s
|
||||
</code></pre>
|
||||
|
||||
<p>The following example enables Envoy’s Lua filter for all inbound
|
||||
|
|
@ -181,6 +183,9 @@ spec:
|
|||
|
||||
<h2 id="EnvoyFilter">EnvoyFilter</h2>
|
||||
<section>
|
||||
<p>EnvoyFilter provides a mechanism to customize the Envoy configuration
|
||||
generated by Istio Pilot.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -177,6 +177,9 @@ spec:
|
|||
|
||||
<h2 id="Gateway">Gateway</h2>
|
||||
<section>
|
||||
<p>Gateway describes a load balancer operating at the edge of the mesh
|
||||
receiving incoming or outgoing HTTP/TCP connections.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -310,6 +310,9 @@ spec:
|
|||
|
||||
<h2 id="ServiceEntry">ServiceEntry</h2>
|
||||
<section>
|
||||
<p>ServiceEntry enables adding additional entries into Istio’s internal
|
||||
service registry.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -465,6 +465,10 @@ there are no services or ServiceEntries for the destination port</p>
|
|||
</section>
|
||||
<h2 id="Sidecar">Sidecar</h2>
|
||||
<section>
|
||||
<p>Sidecar describes the configuration of the sidecar proxy that mediates
|
||||
inbound and outbound communication of the workload instance to which it is
|
||||
attached.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ description: Configuration affecting label/content routing, sni routing, etc.
|
|||
location: https://istio.io/docs/reference/config/networking/v1alpha3/virtual-service.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 22
|
||||
number_of_entries: 23
|
||||
---
|
||||
<p>Configuration affecting traffic routing. Here are a few terms useful to define
|
||||
in the context of traffic routing.</p>
|
||||
|
|
@ -864,8 +864,8 @@ number of retries attempted depends on the httpReqTimeout.</p>
|
|||
<td>
|
||||
<p>Specifies the conditions under which retry takes place.
|
||||
One or more policies can be specified using a ‘,’ delimited list.
|
||||
See the <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-grpc-on">supported policies</a>
|
||||
and <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-grpc-on">here</a> for more details.</p>
|
||||
See the <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on">retry policies</a>
|
||||
and <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-grpc-on">gRPC retry policies</a> for more details.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -1033,6 +1033,16 @@ mirrored cluster to respond before returning the response from the
|
|||
original destination. Statistics will be generated for the mirrored
|
||||
destination.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="HTTPRoute-mirror_percent">
|
||||
<td><code>mirrorPercent</code></td>
|
||||
<td><code><a href="#google-protobuf-UInt32Value">google.protobuf.UInt32Value</a></code></td>
|
||||
<td>
|
||||
<p>Percentage of the traffic to be mirrored by the <code>mirror</code> field.
|
||||
If this field is absent, all the traffic (100%) will be mirrored.
|
||||
Max value is 100.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="HTTPRoute-cors_policy">
|
||||
|
|
@ -1399,9 +1409,9 @@ matching or selection for final routing.</p>
|
|||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="PortSelector-number" class="oneof oneof-start">
|
||||
<tr id="PortSelector-number">
|
||||
<td><code>number</code></td>
|
||||
<td><code>uint32 (oneof)</code></td>
|
||||
<td><code>uint32</code></td>
|
||||
<td>
|
||||
<p>Valid port number</p>
|
||||
|
||||
|
|
@ -1674,6 +1684,8 @@ is matched if any one of the match blocks succeed.</p>
|
|||
</section>
|
||||
<h2 id="VirtualService">VirtualService</h2>
|
||||
<section>
|
||||
<p>Configuration affecting traffic routing.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
@ -1704,7 +1716,7 @@ for details.</p>
|
|||
<p><em>Note for Kubernetes users</em>: When short names are used (e.g. “reviews”
|
||||
instead of “reviews.default.svc.cluster.local”), Istio will interpret
|
||||
the short name based on the namespace of the rule, not the service. A
|
||||
rule in the “default” namespace containing a host “reviews will be
|
||||
rule in the “default” namespace containing a host “reviews” will be
|
||||
interpreted as “reviews.default.svc.cluster.local”, irrespective of
|
||||
the actual namespace associated with the reviews service. <em>To avoid
|
||||
potential misconfigurations, it is recommended to always use fully
|
||||
|
|
@ -1797,3 +1809,29 @@ defines an export to all namespaces.</p>
|
|||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="google-protobuf-UInt32Value">google.protobuf.UInt32Value</h2>
|
||||
<section>
|
||||
<p>Wrapper message for <code>uint32</code>.</p>
|
||||
|
||||
<p>The JSON representation for <code>UInt32Value</code> is JSON number.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="google-protobuf-UInt32Value-value">
|
||||
<td><code>value</code></td>
|
||||
<td><code>uint32</code></td>
|
||||
<td>
|
||||
<p>The uint32 value.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,175 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/newrelic/newrelic-istio-adapter' REPO
|
||||
source_repo: https://github.com/newrelic/newrelic-istio-adapter
|
||||
title: New Relic
|
||||
description: An Istio Mixer adapter to send telemetry data to New Relic.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/newrelic.html
|
||||
layout: partner-component
|
||||
generator: protoc-gen-docs
|
||||
provider: New Relic, Inc.
|
||||
source_link: https://github.com/newrelic/newrelic-istio-adapter
|
||||
latest_release_link: https://github.com/newrelic/newrelic-istio-adapter/releases
|
||||
supported_templates: metric, tracespan
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>An Istio Mixer adapter to send telemetry data to New Relic.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>newrelic</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-namespace">
|
||||
<td><code>namespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Optional. The namespace is used as a prefix for metric names in New Relic.
|
||||
An example: for a metric named <code>requestSize</code> with a namespace of <code>istio</code>,
|
||||
the full metric name in New Relic becomes <code>istio.requestSize</code>.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metrics">
|
||||
<td><code>metrics</code></td>
|
||||
<td><code>map<string, <a href="#Params-MetricInfo">Params.MetricInfo</a>></code></td>
|
||||
<td>
|
||||
<p>Map of Istio metric instance names and the corresponding New Relic
|
||||
MetricInfo specification. This identifies what to send New Relic and
|
||||
in what form it should be sent.</p>
|
||||
|
||||
<p>Any metric instances Istio sends to the adapter but not specified here
|
||||
will be dropped and not exported to New Relic.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent an Istio metric instance in New Relic.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Recommended. The name of the metric (scoped by namespaces) in New Relic.</p>
|
||||
|
||||
<p>The name must not be empty and the fully qualified name (prefixed
|
||||
with the namespace) must contain 255 16-bit code units (UTF-16) or
|
||||
less. Otherwise, an error will be logged and no metric will be sent
|
||||
to New Relic.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-type">
|
||||
<td><code>type</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Type">Params.MetricInfo.Type</a></code></td>
|
||||
<td>
|
||||
<p>Required. New Relic metric type to interpret the Istio instance as.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Type">Params.MetricInfo.Type</h2>
|
||||
<section>
|
||||
<p>New Relic Metric types.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Type-UNSPECIFIED">
|
||||
<td><code>UNSPECIFIED</code></td>
|
||||
<td>
|
||||
<p>Default and invalid unspecified type.</p>
|
||||
|
||||
<p>An error will be logged and the metric dropped if unspecified.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-GAUGE">
|
||||
<td><code>GAUGE</code></td>
|
||||
<td>
|
||||
<p>A New Relic <code>Gauge</code> type.</p>
|
||||
|
||||
<p>This metric type represents the instantaneous state of something
|
||||
or process that can both increase and decrease in value.</p>
|
||||
|
||||
<p>For example, this metric type would be used to record:</p>
|
||||
|
||||
<ul>
|
||||
<li>the network throughput of a service</li>
|
||||
<li>the storage capacity used on a server</li>
|
||||
<li>the size of a queue</li>
|
||||
</ul>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-COUNT">
|
||||
<td><code>COUNT</code></td>
|
||||
<td>
|
||||
<p>A New Relic <code>Count</code> type.</p>
|
||||
|
||||
<p>This metric type represents the number of occurrences for an event
|
||||
within a time window. It is important to note that this is not the
|
||||
cumulative tally of occurrences since the beginning of
|
||||
measurements. Rather, this metric type represents the change in the
|
||||
cumulative tally of events within a time window.</p>
|
||||
|
||||
<p>For example, this metric type would be used to record:</p>
|
||||
|
||||
<ul>
|
||||
<li>the number of requests to a service</li>
|
||||
<li>the number of tasks submitted to a processor</li>
|
||||
<li>the number of errors produced</li>
|
||||
</ul>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-SUMMARY">
|
||||
<td><code>SUMMARY</code></td>
|
||||
<td>
|
||||
<p>New Relic <code>Summary</code> type.</p>
|
||||
|
||||
<p>This metric type reports aggregated information about discrete
|
||||
events. The information is recorded as a count of events, average
|
||||
event values, sum of event values, and the minimum and maximum
|
||||
event values observed within a time window.</p>
|
||||
|
||||
<p>For example, this metric type would be used to record:</p>
|
||||
|
||||
<ul>
|
||||
<li>the duration and count of requests to service</li>
|
||||
<li>the duration and count of database transactions</li>
|
||||
<li>the time each message spent in a queue</li>
|
||||
</ul>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -72,7 +72,7 @@ by the StackDriver SDK.</p>
|
|||
<td><code>apiKey</code></td>
|
||||
<td><code>string (oneof)</code></td>
|
||||
<td>
|
||||
<p>The API Key to be used for auth.</p>
|
||||
<p>The API Key to be used for auth. API Key is no longer supported, use service account instead.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ helm_chart_link:
|
|||
istio_versions: "1.0.3, 1.0.4"
|
||||
supported_templates: metric
|
||||
logo_link: https://github.com/vmware/wavefront-adapter-for-istio/raw/master/docs/images/logo.png
|
||||
number_of_entries: 8
|
||||
number_of_entries: 9
|
||||
---
|
||||
<p>The <code>wavefront</code> adapter collects metrics and makes them available to
|
||||
<a href="https://www.wavefront.com/">Wavefront by VMware</a>.</p>
|
||||
|
|
@ -81,6 +81,38 @@ number_of_entries: 8
|
|||
<td>
|
||||
<p>The set of metrics to publish to Wavefront.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-logs">
|
||||
<td><code>logs</code></td>
|
||||
<td><code><a href="#Params-Logs">Params.Logs</a></code></td>
|
||||
<td>
|
||||
<p>The log configuration.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Logs">Params.Logs</h2>
|
||||
<section>
|
||||
<p>Describes the logging configuration.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Logs-level">
|
||||
<td><code>level</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The log level (one of error, warn, info, debug, or none). Ex: info</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
|
|||
|
|
@ -441,30 +441,13 @@ The example is in the form of a Kubernetes resource:
|
|||
### Note: if connection information is not specified, the adapter configuration is directly inside
|
||||
### `spec` block. This is going to be DEPRECATED in favor of Sample-2
|
||||
apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: prometheus
|
||||
kind: handler
|
||||
metadata:
|
||||
name: handler
|
||||
name: requestcount
|
||||
namespace: istio-system
|
||||
spec:
|
||||
metrics:
|
||||
- name: request_count
|
||||
instance_name: requestcount.metric.istio-system
|
||||
kind: COUNTER
|
||||
label_names:
|
||||
- source_service
|
||||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
---
|
||||
### Sample-2: With connection information (for out-of-process adapters)
|
||||
### Note: Unlike sample-1, the adapter configuration is parallel to `connection` and is nested inside `param` block.
|
||||
apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: prometheus
|
||||
metadata:
|
||||
name: handler
|
||||
namespace: istio-system
|
||||
spec:
|
||||
param:
|
||||
compiledAdapter: prometheus
|
||||
params:
|
||||
metrics:
|
||||
- name: request_count
|
||||
instance_name: requestcount.metric.istio-system
|
||||
|
|
@ -474,8 +457,29 @@ spec:
|
|||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
connection:
|
||||
address: localhost:8090
|
||||
---
|
||||
### Sample-2: With connection information (for out-of-process adapters)
|
||||
### Note: Unlike sample-1, the adapter configuration is parallel to `connection` and is nested inside `param` block.
|
||||
apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: handler
|
||||
metadata:
|
||||
name: requestcount
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledAdapter: prometheus
|
||||
params:
|
||||
param:
|
||||
metrics:
|
||||
- name: request_count
|
||||
instance_name: requestcount.metric.istio-system
|
||||
kind: COUNTER
|
||||
label_names:
|
||||
- source_service
|
||||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
connection:
|
||||
address: localhost:8090
|
||||
---
|
||||
</code></pre>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue