mirror of https://github.com/istio/istio.io.git
Update reference docs. (#5290)
This commit is contained in:
Martin Taillefer
GitHub
parent
72ac49375e
commit
c9ec2cef42
|
|
@ -132,10 +132,15 @@ The available front matter fields are:
|
|||
|`keywords` | An array of keywords describing the page, used to create the web of See Also links
|
||||
|`draft` | When true, prevents the page from showing up in any navigation area
|
||||
|`aliases` | See [Renaming, moving, or deleting pages](#renaming-moving-or-deleting-pages) below for details on this item
|
||||
|`skip_toc` | Set this to true to prevent the page from having a table of contents generated for it
|
||||
|`skip_byline` | Set this to true to prevent the page from having a byline under the main title
|
||||
|`skip_seealso` | Set this to true to prevent the page from having a "See also" section generated for it
|
||||
|
||||
A few fields control the auto-generated table of contents present on most pages:
|
||||
|
||||
|`skip_toc` | Set this to true to prevent the page from having a table of contents generated for it
|
||||
|`force_inline_toc` | Set this to true to force the generated table of contents to be inserted inline in the text instead of in a sidebar
|
||||
|`max_toc_level` | Set to 2, 3, 4, 5, or 6 to indicate the maximum heading level to show in the table of contents
|
||||
|`remove_toc_prefix` | Set this to a string that will be removed from the start of every entry in the table of contents if present
|
||||
|
||||
A few front-matter fields are specific to section pages (i.e. for files names `_index.md`):
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ title: galley
|
|||
description: Galley provides configuration management services for Istio.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 5
|
||||
force_inline_toc: true
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'galley '
|
||||
---
|
||||
<p>Galley provides configuration management services for Istio.</p>
|
||||
<table class="command-flags">
|
||||
|
|
@ -30,17 +31,12 @@ force_inline_toc: true
|
|||
<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, analysis, attributes, conversions, default,
|
||||
grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, validation] (default ``)
|
||||
</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing,
|
||||
rbac, resource, runtime, server, source, validation] 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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>
|
||||
|
|
@ -65,10 +61,7 @@ force_inline_toc: true
|
|||
<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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing,
|
||||
rbac, resource, runtime, server, source, validation] 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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>
|
||||
|
|
@ -108,17 +101,12 @@ force_inline_toc: true
|
|||
<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, analysis, attributes, conversions, default,
|
||||
grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, validation] (default ``)
|
||||
</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing,
|
||||
rbac, resource, runtime, server, source, validation] 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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>
|
||||
|
|
@ -143,10 +131,7 @@ force_inline_toc: true
|
|||
<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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing,
|
||||
rbac, resource, runtime, server, source, validation] 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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>
|
||||
|
|
@ -286,17 +271,12 @@ force_inline_toc: true
|
|||
<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, analysis, attributes, conversions, default,
|
||||
grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, validation] (default ``)
|
||||
</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing,
|
||||
rbac, resource, runtime, server, source, validation] 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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>
|
||||
|
|
@ -321,10 +301,7 @@ force_inline_toc: true
|
|||
<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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing,
|
||||
rbac, resource, runtime, server, source, validation] 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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>
|
||||
|
|
@ -424,9 +401,7 @@ force_inline_toc: true
|
|||
<tr>
|
||||
<td><code>--validation.tls.caCertificates <string></code></td>
|
||||
<td></td>
|
||||
<td>File containing the caBundle that signed the cert/key specified by --validation.tls.clientCertificate and --validation.tls.privateKey. (default
|
||||
``)
|
||||
</td>
|
||||
<td>File containing the caBundle that signed the cert/key specified by --validation.tls.clientCertificate and --validation.tls.privateKey. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--validation.tls.clientCertificate <string></code></td>
|
||||
|
|
@ -498,17 +473,12 @@ validation:
|
|||
<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, analysis, attributes, conversions, default,
|
||||
grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, validation] (default ``)
|
||||
</td>
|
||||
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing,
|
||||
rbac, resource, runtime, server, source, validation] 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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>
|
||||
|
|
@ -533,10 +503,7 @@ validation:
|
|||
<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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing,
|
||||
rbac, resource, runtime, server, source, validation] 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, analysis, attributes, conversions, default, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, processing, rbac, resource, runtime, server, source, 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>
|
||||
|
|
@ -584,167 +551,39 @@ These environment variables affect the behavior of the <code>galley</code> comma
|
|||
<h2 id="metrics">Exported metrics</h2>
|
||||
<table class="metrics">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Metric Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<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>istio_build</code></td>
|
||||
<td><code>LastValue</code></td>
|
||||
<td>Istio component build info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>istio_mcp_clients_total</code></td>
|
||||
<td><code>LastValue</code></td>
|
||||
<td>The number of streams currently connected.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>istio_mcp_message_sizes_bytes</code></td>
|
||||
<td><code>Distribution</code></td>
|
||||
<td>Size of messages received from clients.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>istio_mcp_reconnections</code></td>
|
||||
<td><code>Sum</code></td>
|
||||
<td>The number of times the sink has reconnected.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>istio_mcp_recv_failures_total</code></td>
|
||||
<td><code>Sum</code></td>
|
||||
<td>The number of recv failures in the source.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>istio_mcp_request_acks_total</code></td>
|
||||
<td><code>Sum</code></td>
|
||||
<td>The number of request acks received by the source.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>istio_mcp_request_nacks_total</code></td>
|
||||
<td><code>Sum</code></td>
|
||||
<td>The number of request nacks received by the source.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>istio_mcp_send_failures_total</code></td>
|
||||
<td><code>Sum</code></td>
|
||||
<td>The number of send failures in the source.</td>
|
||||
</tr>
|
||||
<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>istio_build</code></td><td><code>LastValue</code></td><td>Istio component build info</td></tr>
|
||||
<tr><td><code>istio_mcp_clients_total</code></td><td><code>LastValue</code></td><td>The number of streams currently connected.</td></tr>
|
||||
<tr><td><code>istio_mcp_message_sizes_bytes</code></td><td><code>Distribution</code></td><td>Size of messages received from clients.</td></tr>
|
||||
<tr><td><code>istio_mcp_reconnections</code></td><td><code>Sum</code></td><td>The number of times the sink has reconnected.</td></tr>
|
||||
<tr><td><code>istio_mcp_recv_failures_total</code></td><td><code>Sum</code></td><td>The number of recv failures in the source.</td></tr>
|
||||
<tr><td><code>istio_mcp_request_acks_total</code></td><td><code>Sum</code></td><td>The number of request acks received by the source.</td></tr>
|
||||
<tr><td><code>istio_mcp_request_nacks_total</code></td><td><code>Sum</code></td><td>The number of request nacks received by the source.</td></tr>
|
||||
<tr><td><code>istio_mcp_send_failures_total</code></td><td><code>Sum</code></td><td>The number of send failures in the source.</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ title: istio_ca
|
|||
description: Istio Certificate Authority (CA).
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 4
|
||||
force_inline_toc: true
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istio_ca '
|
||||
---
|
||||
<p>Istio Certificate Authority (CA).</p>
|
||||
<pre class="language-bash"><code>istio_ca [flags]
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
|
|||
title: istioctl
|
||||
description: Istio control interface.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 78
|
||||
number_of_entries: 76
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istioctl '
|
||||
---
|
||||
|
|
@ -1189,7 +1189,7 @@ the cluster results of the client pod and the listener results of the server pod
|
|||
<tr>
|
||||
<td><code>--service-account <string></code></td>
|
||||
<td></td>
|
||||
<td>create a secret with this service account's credentials. (default `istio-multi`)</td>
|
||||
<td>create a secret with this service account's credentials. (default `istio-pilot`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1207,63 +1207,6 @@ istioctl --Kubeconfig=c0.yaml x create-remote-secret \
|
|||
istioctl --Kubeconfig=c0.yaml x create-remote-secret --auth-type=plugin --auth-plugin-name=gcp \
|
||||
| kubectl -n istio-system --Kubeconfig=c1.yaml apply -f -
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-create-trust-anchor">istioctl experimental create-trust-anchor</h2>
|
||||
<p>Establish trust between two or more clustersByContext by appending each
|
||||
cluster's public root CA cert to other cluster's list of trusted roots. This is
|
||||
useful when form a multi-cluster mesh from existing clustersByContext with their own unique
|
||||
CAs.</p>
|
||||
<p>
|
||||
</p>
|
||||
<pre class="language-bash"><code>istioctl experimental create-trust-anchor [<cluster-name>] [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of the kubeconfig context to use (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--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 [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-create-trust-anchor Examples">Examples</h3>
|
||||
<pre class="language-bash"><code>
|
||||
# Create a trust anchor configmap with c0's root CA cert and install it in cluster c1.
|
||||
istioctl --Kubeconfig=c0.yaml x create-trust-anchor c0 \
|
||||
| kubectl -n istio-system --Kubeconfig=c1.yaml apply -f -
|
||||
|
||||
# Delete a trust anchor configmap that was previously installed in c1
|
||||
istioctl --Kubeconfig=c0.yaml x create-trust-anchor c1 \
|
||||
| kubectl -n istio-system --Kubeconfig=c1.yaml delete -f -
|
||||
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-dashboard">istioctl experimental dashboard</h2>
|
||||
<p>(dashboard has graduated. Use `istioctl dashboard`)</p>
|
||||
|
|
@ -1619,6 +1562,51 @@ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-multicluster-apply">istioctl experimental multicluster apply</h2>
|
||||
<p>Update clusters in a multi-cluster mesh based on mesh topology</p>
|
||||
<pre class="language-bash"><code>istioctl experimental multicluster apply -f <mesh.yaml> [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of the kubeconfig context to use (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--filename <string></code></td>
|
||||
<td><code>-f</code></td>
|
||||
<td>filename of the multicluster mesh description (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--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 [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-multicluster-describe">istioctl experimental multicluster describe</h2>
|
||||
<p>Describe status of the multi-cluster mesh's control plane' </p>
|
||||
<pre class="language-bash"><code>istioctl experimental multicluster describe -f <mesh.yaml> [--all] [flags]
|
||||
|
|
@ -1670,46 +1658,8 @@ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-multicluster-generate">istioctl experimental multicluster generate</h2>
|
||||
<p>generate configuration for setting up a multi-cluster mesh</p>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of the kubeconfig context to use (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--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 [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-multicluster-generate-values">istioctl experimental multicluster generate values</h2>
|
||||
<p>generate a cluster-specific values.yaml file based on the mesh description and runtime state </p>
|
||||
<pre class="language-bash"><code>istioctl experimental multicluster generate values -f <mesh.yaml> [flags]
|
||||
<p>generate a cluster-specific control plane configuration based on the mesh description and runtime state</p>
|
||||
<pre class="language-bash"><code>istioctl experimental multicluster generate -f <mesh.yaml> [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
|
|
@ -1731,59 +1681,9 @@ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|||
<td>filename of the multicluster mesh description (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--log_output_level <string></code></td>
|
||||
<td><code>--from <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 [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-multicluster-join">istioctl experimental multicluster join</h2>
|
||||
<p>Join multiple clustersByContext into a single multi-cluster mesh</p>
|
||||
<pre class="language-bash"><code>istioctl experimental multicluster join -f <mesh.yaml> [--discovery] [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--all</code></td>
|
||||
<td></td>
|
||||
<td>join all clustersByContext together in the mesh </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of the kubeconfig context to use (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--discovery</code></td>
|
||||
<td></td>
|
||||
<td>link Istio service discovery with the clustersByContext service registriesS </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--filename <string></code></td>
|
||||
<td><code>-f</code></td>
|
||||
<td>filename of the multicluster mesh description (default ``)</td>
|
||||
<td>optional source configuration to generate multicluster aware configuration from (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
|
|
@ -1805,6 +1705,11 @@ istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
|||
<td><code>-n</code></td>
|
||||
<td>Config namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--wait-for-gateways</code></td>
|
||||
<td></td>
|
||||
<td>wait for all cluster's istio-ingressgateway IPs to be ready before generating configuration. </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-post-install">istioctl experimental post-install</h2>
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ title: mixs
|
|||
description: Mixer is Istio's abstraction on top of infrastructure backends.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 5
|
||||
force_inline_toc: true
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'mixs '
|
||||
---
|
||||
<p>Mixer is Istio's point of integration with infrastructure backends and is the
|
||||
nexus for policy evaluation and telemetry reporting.</p>
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ title: node_agent
|
|||
description: Istio security per-node agent.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 3
|
||||
force_inline_toc: true
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'node_agent '
|
||||
---
|
||||
<p>Istio security per-node agent.</p>
|
||||
<pre class="language-bash"><code>node_agent [flags]
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ title: pilot-agent
|
|||
description: Istio Pilot agent.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 5
|
||||
force_inline_toc: true
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'pilot-agent '
|
||||
---
|
||||
<p>Istio Pilot agent runs in the sidecar or gateway container and bootstraps Envoy.</p>
|
||||
<table class="command-flags">
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ title: pilot-discovery
|
|||
description: Istio Pilot.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 5
|
||||
force_inline_toc: true
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'pilot-discovery '
|
||||
---
|
||||
<p>Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh.</p>
|
||||
<table class="command-flags">
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ title: sidecar-injector
|
|||
description: Kubernetes webhook for automatic Istio sidecar injection.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 4
|
||||
force_inline_toc: true
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'sidecar-injector '
|
||||
---
|
||||
<p>Kubernetes webhook for automatic Istio sidecar injection.</p>
|
||||
<pre class="language-bash"><code>sidecar-injector [flags]
|
||||
|
|
|
|||
Loading…
Reference in New Issue