mirror of https://github.com/istio/istio.io.git
619 lines
28 KiB
HTML
619 lines
28 KiB
HTML
---
|
|
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE https://github.com/istio/istio REPO
|
|
source_repo: https://github.com/istio/istio
|
|
title: galley
|
|
description: Galley provides configuration management services for Istio.
|
|
generator: pkg-collateral-docs
|
|
number_of_entries: 5
|
|
---
|
|
<p>Galley provides configuration management services for Istio.</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--config <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Config file containing args (default ``)</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_caller <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] (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, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] 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>
|
|
<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>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, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] 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>
|
|
<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>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="galley-probe">galley probe</h2>
|
|
<p>Check the liveness or readiness of a locally-running server</p>
|
|
<pre class="language-bash"><code>galley probe [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--config <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Config file containing args (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--interval <duration></code></td>
|
|
<td></td>
|
|
<td>Duration used for checking the target file's last modified time. (default `0s`)</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_caller <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] (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, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] 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>
|
|
<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>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, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] 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>
|
|
<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>--probe-path <string></code></td>
|
|
<td></td>
|
|
<td>Path of the file for checking the availability. (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="galley-server">galley server</h2>
|
|
<p>Starts Galley as a server</p>
|
|
<pre class="language-bash"><code>galley server [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--accessListFile <string></code></td>
|
|
<td></td>
|
|
<td>The access list yaml file that contains the allowd mTLS peer ids. (default `/etc/config/accesslist.yaml`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--caCertFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the caBundle that signed the cert/key specified by --tlsCertFile and --tlsKeyFile. (default `/etc/certs/root-cert.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--config <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Config file containing args (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--configPath <string></code></td>
|
|
<td></td>
|
|
<td>Istio config file path (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_address <string></code></td>
|
|
<td></td>
|
|
<td>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `localhost`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <uint16></code></td>
|
|
<td></td>
|
|
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--deployment-name <string></code></td>
|
|
<td></td>
|
|
<td>Name of the deployment for the validation pod (default `istio-galley`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--deployment-namespace <string></code></td>
|
|
<td></td>
|
|
<td>Namespace of the deployment for the validation pod (default `istio-system`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--disableResourceReadyCheck</code></td>
|
|
<td></td>
|
|
<td>Disable resource readiness checks. This allows Galley to start if not all resource types are supported </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--domain <string></code></td>
|
|
<td></td>
|
|
<td>DNS domain suffix (default `cluster.local`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--enable-server</code></td>
|
|
<td></td>
|
|
<td>Run galley server mode </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--enable-validation</code></td>
|
|
<td></td>
|
|
<td>Run galley validation mode </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--enableProfiling</code></td>
|
|
<td></td>
|
|
<td>Enable profiling for Galley </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--enableServiceDiscovery</code></td>
|
|
<td></td>
|
|
<td>Enable service discovery processing in Galley </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--excludedResourceKinds <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of resource kinds that should not generate source events (default `[Endpoints,Namespace,Node,Pod,Service]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--insecure</code></td>
|
|
<td></td>
|
|
<td>Use insecure gRPC communication </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td></td>
|
|
<td>Use a Kubernetes configuration file instead of in-cluster configuration (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--livenessProbeInterval <duration></code></td>
|
|
<td></td>
|
|
<td>Interval of updating file for the Galley liveness probe. (default `2s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--livenessProbePath <string></code></td>
|
|
<td></td>
|
|
<td>Path to the file for the Galley liveness probe. (default `/healthLiveness`)</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_caller <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] (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, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] 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>
|
|
<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>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, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] 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>
|
|
<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>--meshConfigFile <string></code></td>
|
|
<td></td>
|
|
<td>Path to the mesh config file (default `/etc/mesh-config/mesh`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--monitoringPort <uint></code></td>
|
|
<td></td>
|
|
<td>Port to use for exposing self-monitoring information (default `15014`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--pprofPort <uint></code></td>
|
|
<td></td>
|
|
<td>Port to use for exposing profiling (default `9094`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readinessProbeInterval <duration></code></td>
|
|
<td></td>
|
|
<td>Interval of updating file for the Galley readiness probe. (default `2s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readinessProbePath <string></code></td>
|
|
<td></td>
|
|
<td>Path to the file for the Galley readiness probe. (default `/healthReadiness`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--resyncPeriod <duration></code></td>
|
|
<td></td>
|
|
<td>Resync period for rescanning Kubernetes resources (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--server-address <string></code></td>
|
|
<td></td>
|
|
<td>Address to use for Galley's gRPC API, e.g. tcp://localhost:9092 or unix:///path/to/file (default `tcp://0.0.0.0:9901`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--server-maxConcurrentStreams <uint></code></td>
|
|
<td></td>
|
|
<td>Maximum number of outstanding RPCs per connection (default `1024`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--server-maxReceivedMessageSize <uint></code></td>
|
|
<td></td>
|
|
<td>Maximum size of individual gRPC messages (default `1048576`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--service-name <string></code></td>
|
|
<td></td>
|
|
<td>Name of the validation service running in the same namespace as the deployment (default `istio-galley`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--sinkAddress <string></code></td>
|
|
<td></td>
|
|
<td>Address of MCP Resource Sink server for Galley to connect to. Ex: 'foo.com:1234' (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--sinkAuthMode <string></code></td>
|
|
<td></td>
|
|
<td>Name of authentication plugin to use for connection to sink server. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--sinkMeta <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of key=values to attach as metadata to outgoing sink connections. Ex: 'key=value,key2=value2' (default `[]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsCertFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the x509 Certificate for HTTPS. (default `/etc/certs/cert-chain.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsKeyFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the x509 private key matching --tlsCertFile. (default `/etc/certs/key.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation-port <uint></code></td>
|
|
<td></td>
|
|
<td>HTTPS port of the validation service. Must be 443 if service has more than one port (default `443`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--validation-webhook-config-file <string></code></td>
|
|
<td></td>
|
|
<td>File that contains k8s validatingwebhookconfiguration yaml. Required if enable-validation is true. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--webhook-name <string></code></td>
|
|
<td></td>
|
|
<td>Name of the k8s validatingwebhookconfiguration (default `istio-galley`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p/>Accepts deep config files, like:
|
|
<pre class="language-yaml"><code>general:
|
|
introspection:
|
|
address: --ctrlz_address
|
|
port: --ctrlz_port
|
|
kubeconfig: --kubeconfig
|
|
processing:
|
|
domainsuffix: --domain
|
|
server:
|
|
address: --server-address
|
|
auth:
|
|
insecure: --insecure
|
|
enable: --enable-server
|
|
validation:
|
|
deploymentname: --deployment-name
|
|
deploymentnamespace: --deployment-namespace
|
|
enable: --enable-validation
|
|
servicename: --service-name
|
|
tls:
|
|
caCertificates: --validation.tls.caCertificates
|
|
clientCertificate: --validation.tls.clientCertificate
|
|
privateKey: --validation.tls.privateKey
|
|
webhookconfigfile: --validation-webhook-config-file
|
|
webhookname: --webhook-name
|
|
webhookport: --validation-port
|
|
|
|
</code></pre>
|
|
<h2 id="galley-version">galley version</h2>
|
|
<p>Prints out build version information</p>
|
|
<pre class="language-bash"><code>galley version [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<tr>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--config <string></code></td>
|
|
<td><code>-c</code></td>
|
|
<td>Config file containing args (default ``)</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_caller <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] (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, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] 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>
|
|
<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>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, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, runtime, server, validation] 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>
|
|
<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>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>One of 'yaml' or 'json'. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Use --short=false to generate full version information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="envvars">Environment variables</h2>
|
|
These environment variables affect the behavior of the <code>galley</code> command.
|
|
<table class="envvars">
|
|
<thead>
|
|
<tr>
|
|
<th>Variable Name</th>
|
|
<th>Type</th>
|
|
<th>Default Value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>AUTHZ_FAILURE_LOG_BURST_SIZE</code></td>
|
|
<td>Integer</td>
|
|
<td><code>1</code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>AUTHZ_FAILURE_LOG_FREQ</code></td>
|
|
<td>Time Duration</td>
|
|
<td><code>1m0s</code></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>BYPASS_OOP_MTLS_SAN_VERIFICATION</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>false</code></td>
|
|
<td>Whether or not to validate SANs for out-of-process adapters auth.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>ISTIO_LANG</code></td>
|
|
<td>String</td>
|
|
<td><code></code></td>
|
|
<td>Selects the attribute expression langauge runtime for Mixer.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="annotations">Annotations</h2>
|
|
These resource annotations are used by the <code>galley</code> command.
|
|
<table class="annotations">
|
|
<thead>
|
|
<tr>
|
|
<th>Annotation Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>policy.istio.io/check</code></td>
|
|
<td>Determines the policy for behavior when unable to connect to Mixer. If not set, FAIL_CLOSE is set, rejecting requests.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>policy.istio.io/checkBaseRetryWaitTime</code></td>
|
|
<td>Base time to wait between retries, will be adjusted by backoff and jitter. In duration format. If not set, this will be 80ms.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>policy.istio.io/checkMaxRetryWaitTime</code></td>
|
|
<td>Maximum time to wait between retries to Mixer. In duration format. If not set, this will be 1000ms.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>policy.istio.io/checkRetries</code></td>
|
|
<td>The maximum number of retries on transport errors to Mixer. If not set, this will be 0, indicating no retries.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>policy.istio.io/lang</code></td>
|
|
<td>Select a language runtime</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="metrics">Exported metrics</h2>
|
|
<table class="metrics">
|
|
<thead>
|
|
<tr><th>Metric Name</th><th>Type</th><th>Description</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td><code>galley_runtime_processor_event_span_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration between each incoming event</td></tr>
|
|
<tr><td><code>galley_runtime_processor_events_processed_total</code></td><td><code>Count</code></td><td>The number of events that have been processed</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshot_events_total</code></td><td><code>Distribution</code></td><td>The number of events per snapshot</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshot_lifetime_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration of each snapshot</td></tr>
|
|
<tr><td><code>galley_runtime_processor_snapshots_published_total</code></td><td><code>Count</code></td><td>The number of snapshots that have been published</td></tr>
|
|
<tr><td><code>galley_runtime_state_type_instances_total</code></td><td><code>LastValue</code></td><td>The number of type instances per type URL</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_on_change_total</code></td><td><code>Count</code></td><td>The number of times the strategy's onChange has been called</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_max_time_reached_total</code></td><td><code>Count</code></td><td>The number of times the max time has been reached</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_quiesce_reached_total</code></td><td><code>Count</code></td><td>The number of times a quiesce has been reached</td></tr>
|
|
<tr><td><code>galley_runtime_strategy_timer_resets_total</code></td><td><code>Count</code></td><td>The number of times the timer has been reset</td></tr>
|
|
<tr><td><code>galley_source_kube_dynamic_converter_failure_total</code></td><td><code>Count</code></td><td>The number of times a dynamnic kubernetes source failed converting a resources</td></tr>
|
|
<tr><td><code>galley_source_kube_dynamic_converter_success_total</code></td><td><code>Count</code></td><td>The number of times a dynamic kubernetes source successfully converted a resource</td></tr>
|
|
<tr><td><code>galley_source_kube_event_error_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source encountered errored while handling an event</td></tr>
|
|
<tr><td><code>galley_source_kube_event_success_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source successfully handled an event</td></tr>
|
|
<tr><td><code>galley_validation_cert_key_update_errors</code></td><td><code>Count</code></td><td>Galley validation webhook certificate updates errors</td></tr>
|
|
<tr><td><code>galley_validation_cert_key_updates</code></td><td><code>Count</code></td><td>Galley validation webhook certificate updates</td></tr>
|
|
<tr><td><code>galley_validation_config_load</code></td><td><code>Count</code></td><td>k8s webhook configuration (re)loads</td></tr>
|
|
<tr><td><code>galley_validation_config_load_error</code></td><td><code>Count</code></td><td>k8s webhook configuration (re)load error</td></tr>
|
|
<tr><td><code>galley_validation_config_update_error</code></td><td><code>Count</code></td><td>k8s webhook configuration update error</td></tr>
|
|
<tr><td><code>galley_validation_config_updates</code></td><td><code>Count</code></td><td>k8s webhook configuration updates</td></tr>
|
|
<tr><td><code>galley_validation_failed</code></td><td><code>Count</code></td><td>Resource validation failed</td></tr>
|
|
<tr><td><code>galley_validation_http_error</code></td><td><code>Count</code></td><td>Resource validation http serve errors</td></tr>
|
|
<tr><td><code>galley_validation_passed</code></td><td><code>Count</code></td><td>Resource is valid</td></tr>
|
|
<tr><td><code>mixer_config_adapter_info_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the adapter info configuration.</td></tr>
|
|
<tr><td><code>mixer_config_adapter_info_configs_total</code></td><td><code>LastValue</code></td><td>The number of known adapters in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_attributes_total</code></td><td><code>LastValue</code></td><td>The number of known attributes in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_handler_configs_total</code></td><td><code>LastValue</code></td><td>The number of known handlers in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_handler_validation_error_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered because handler validation returned error.</td></tr>
|
|
<tr><td><code>mixer_config_instance_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the instance configuration.</td></tr>
|
|
<tr><td><code>mixer_config_instance_configs_total</code></td><td><code>LastValue</code></td><td>The number of known instances in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_rule_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the rule configuration.</td></tr>
|
|
<tr><td><code>mixer_config_rule_config_match_error_total</code></td><td><code>LastValue</code></td><td>The number of rule conditions that was not parseable.</td></tr>
|
|
<tr><td><code>mixer_config_rule_configs_total</code></td><td><code>LastValue</code></td><td>The number of known rules in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_template_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the template configuration.</td></tr>
|
|
<tr><td><code>mixer_config_template_configs_total</code></td><td><code>LastValue</code></td><td>The number of known templates in the current config.</td></tr>
|
|
<tr><td><code>mixer_config_unsatisfied_action_handler_total</code></td><td><code>LastValue</code></td><td>The number of actions that failed due to handlers being unavailable.</td></tr>
|
|
<tr><td><code>mixer_dispatcher_destinations_per_request</code></td><td><code>Distribution</code></td><td>Number of handlers dispatched per request by Mixer</td></tr>
|
|
<tr><td><code>mixer_dispatcher_destinations_per_variety_total</code></td><td><code>LastValue</code></td><td>Number of Mixer adapter destinations by template variety type</td></tr>
|
|
<tr><td><code>mixer_dispatcher_instances_per_request</code></td><td><code>Distribution</code></td><td>Number of instances created per request by Mixer</td></tr>
|
|
<tr><td><code>mixer_handler_closed_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were closed during config transition.</td></tr>
|
|
<tr><td><code>mixer_handler_daemons_total</code></td><td><code>LastValue</code></td><td>The current number of active daemon routines in a given adapter environment.</td></tr>
|
|
<tr><td><code>mixer_handler_handler_build_failures_total</code></td><td><code>LastValue</code></td><td>The number of handlers that failed creation during config transition.</td></tr>
|
|
<tr><td><code>mixer_handler_handler_close_failures_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered while closing handlers during config transition.</td></tr>
|
|
<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_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>
|
|
</table>
|