mirror of https://github.com/istio/istio.io.git
389 lines
17 KiB
HTML
389 lines
17 KiB
HTML
---
|
|
title: galley
|
|
description: Galley provides configuration management services for Istio.
|
|
generator: pkg-collateral-docs
|
|
number_of_entries: 6
|
|
---
|
|
<p>Galley provides configuration management services for Istio.</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td>Use a Kubernetes configuration file instead of in-cluster configuration (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_as_json</code></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>Comma-separated list of scopes for which to include caller information, scopes can be any of [attributes, default, grpcAdapter, mcp, runtime, snapshot] (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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></code></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>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>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>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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></code></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>--resyncPeriod <duration></code></td>
|
|
<td>Resync period for rescanning Kubernetes resources (default `0s`)</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>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--interval <duration></code></td>
|
|
<td>Duration used for checking the target file's last modified time. (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td>Use a Kubernetes configuration file instead of in-cluster configuration (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_as_json</code></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>Comma-separated list of scopes for which to include caller information, scopes can be any of [attributes, default, grpcAdapter, mcp, runtime, snapshot] (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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></code></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>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>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>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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></code></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>Path of the file for checking the availability. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--resyncPeriod <duration></code></td>
|
|
<td>Resync period for rescanning Kubernetes resources (default `0s`)</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>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--address <string></code></td>
|
|
<td>Address to use for Galley's gRPC API, e.g. tcp://127.0.0.1:9092 or unix:///path/to/file (default `tcp://127.0.0.1:9901`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_address <string></code></td>
|
|
<td>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `127.0.0.1`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <uint16></code></td>
|
|
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeConfig <string></code></td>
|
|
<td>Path to the Kube config file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td>Use a Kubernetes configuration file instead of in-cluster configuration (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--livenessProbeInterval <duration></code></td>
|
|
<td>Interval of updating file for the liveness probe. (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--livenessProbePath <string></code></td>
|
|
<td>Path to the file for the liveness probe. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_as_json</code></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>Comma-separated list of scopes for which to include caller information, scopes can be any of [attributes, default, grpcAdapter, mcp, runtime, snapshot] (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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></code></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>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>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>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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></code></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>--maxConcurrentStreams <uint></code></td>
|
|
<td>Maximum number of outstanding RPCs per connection (default `1024`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--maxReceivedMessageSize <uint></code></td>
|
|
<td>Maximum size of individual gRPC messages (default `1048576`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readinessProbeInterval <duration></code></td>
|
|
<td>Interval of updating file for the readiness probe. (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--readinessProbePath <string></code></td>
|
|
<td>Path to the file for the readiness probe. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--resyncPeriod <duration></code></td>
|
|
<td>Resync period for rescanning Kubernetes resources (default `0s`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="galley-validator">galley validator</h2>
|
|
<p>Runs an https server for Istio configuration validation. Uses k8s validating webhooks to validate Pilot and Mixer configuration.</p>
|
|
<pre class="language-bash"><code>galley validator [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--caCertFile <string></code></td>
|
|
<td>File containing the caBundle that signed the cert/key specified by --tlsCertFile and --tlsKeyFile. (default `/etc/istio/certs/root-cert.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--healthCheckFile <string></code></td>
|
|
<td>File that should be periodically updated if health checking is enabled (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--healthCheckInterval <duration></code></td>
|
|
<td>Configure how frequently the health check file specified by --healhCheckFile should be updated (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td>Use a Kubernetes configuration file instead of in-cluster configuration (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_as_json</code></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>Comma-separated list of scopes for which to include caller information, scopes can be any of [attributes, default, grpcAdapter, mcp, runtime, snapshot] (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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></code></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>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>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>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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></code></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>--mixer-webhook-name <string></code></td>
|
|
<td>Name of the mixer webhook entry in the webhook config. (default `mixer.validation.istio.io`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--monitoringPort <uint></code></td>
|
|
<td>Port to use for the exposing self-monitoring information (default `9093`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--pilot-webhook-name <string></code></td>
|
|
<td>Name of the pilot webhook entry in the webhook config. (default `pilot.validation.istio.io`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <uint></code></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>--resyncPeriod <duration></code></td>
|
|
<td>Resync period for rescanning Kubernetes resources (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsCertFile <string></code></td>
|
|
<td>File containing the x509 Certificate for HTTPS. (default `/etc/istio/certs/cert-chain.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsKeyFile <string></code></td>
|
|
<td>File containing the x509 private key matching --tlsCertFile. (default `/etc/istio/certs/key.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--webhook-name <string></code></td>
|
|
<td>Name of the ValidatingWebhookConfiguration resource in Kubernetes (default `istio-galley`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<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>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<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>--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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] (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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, 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 [attributes, default, grpcAdapter, mcp, runtime, snapshot] and level can be one of [debug, info, warn, error, 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>--resyncPeriod <duration></code></td>
|
|
<td></td>
|
|
<td>Resync period for rescanning Kubernetes resources (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Displays a short form of the version information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|