diff --git a/content/docs/reference/commands/gals.html b/content/docs/reference/commands/galley/index.html similarity index 71% rename from content/docs/reference/commands/gals.html rename to content/docs/reference/commands/galley/index.html index c1004c40a3..ac1d2bdf73 100644 --- a/content/docs/reference/commands/gals.html +++ b/content/docs/reference/commands/galley/index.html @@ -1,8 +1,8 @@ --- -title: gals +title: galley description: Galley provides configuration management services for Istio. generator: pkg-collateral-docs -number_of_entries: 7 +number_of_entries: 6 ---

Galley provides configuration management services for Istio.

@@ -21,11 +21,11 @@ number_of_entries: 7 - + - + @@ -45,21 +45,33 @@ number_of_entries: 7 - + + + + + + + + + + + + +
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter] (default ``)Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter, mcp, runtime] (default ``)
--log_output_level <string>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, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:info`)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, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>
--log_stacktrace_level <string>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 [ads, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:none`)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 [ads, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray> 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]`)
--logcallerLogs filename and line number of callers to log
--loglevel <Level>loglevel, one of [Debug Verbose Info Warning Error Critical Fatal] (default `Info`)
--logprefix <string>Prefix to log lines before logged messages (default `> `)
--resyncPeriod <duration> Resync period for rescanning Kubernetes resources (default `0s`)
-

gals probe

+

galley probe

Check the liveness or readiness of a locally-running server

-
gals probe [flags]
+
galley probe [flags]
 
@@ -81,11 +93,11 @@ number_of_entries: 7 - + - + @@ -105,13 +117,25 @@ number_of_entries: 7 - + + + + + + + + + + + + + @@ -121,65 +145,9 @@ number_of_entries: 7
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter] (default ``)Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter, mcp, runtime] (default ``)
--log_output_level <string>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, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:info`)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, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>
--log_stacktrace_level <string>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 [ads, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:none`)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 [ads, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray> 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]`)
--logcallerLogs filename and line number of callers to log
--loglevel <Level>loglevel, one of [Debug Verbose Info Warning Error Critical Fatal] (default `Info`)
--logprefix <string>Prefix to log lines before logged messages (default `> `)
--probe-path <string> Path of the file for checking the availability. (default ``)
-

gals purge

-

Delete the internal configuration CRDs and resources.

-
gals purge [flags]
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagsDescription
--kubeconfig <string>Use a Kubernetes configuration file instead of in-cluster configuration (default ``)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter] (default ``)
--log_output_level <string>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, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>The path for the optional rotating log file (default ``)
--log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)
--log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)
--log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)
--log_stacktrace_level <string>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 [ads, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray>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]`)
--resyncPeriod <duration>Resync period for rescanning Kubernetes resources (default `0s`)
-

gals server

+

galley server

Starts Galley as a server

-
gals server [flags]
+
galley server [flags]
 
@@ -188,20 +156,44 @@ number_of_entries: 7 + + + + + + + + + + + + + + + + + + + + + + + + - + - + @@ -221,21 +213,49 @@ number_of_entries: 7 - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--address <string>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`)
--ctrlz_address <string>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `127.0.0.1`)
--ctrlz_port <uint16>The IP port to use for the ControlZ introspection facility (default `9876`)
--kubeConfig <string>Path to the Kube config file (default ``)
--kubeconfig <string> Use a Kubernetes configuration file instead of in-cluster configuration (default ``)
--livenessProbeInterval <duration>Interval of updating file for the liveness probe. (default `0s`)
--livenessProbePath <string>Path to the file for the liveness probe. (default ``)
--log_as_json Whether to format output as JSON or in plain console-friendly format
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter] (default ``)Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter, mcp, runtime] (default ``)
--log_output_level <string>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, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:info`)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, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>
--log_stacktrace_level <string>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 [ads, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:none`)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 [ads, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray> 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]`)
--logcallerLogs filename and line number of callers to log
--loglevel <Level>loglevel, one of [Debug Verbose Info Warning Error Critical Fatal] (default `Info`)
--logprefix <string>Prefix to log lines before logged messages (default `> `)
--maxConcurrentStreams <uint>Maximum number of outstanding RPCs per connection (default `1024`)
--maxReceivedMessageSize <uint>Maximum size of individual gRPC messages (default `1048576`)
--readinessProbeInterval <duration>Interval of updating file for the readiness probe. (default `0s`)
--readinessProbePath <string>Path to the file for the readiness probe. (default ``)
--resyncPeriod <duration> Resync period for rescanning Kubernetes resources (default `0s`)
-

gals validator

+

galley validator

Runs an https server for Istio configuration validation. Uses k8s validating webhooks to validate Pilot and Mixer configuration.

-
gals validator [flags]
+
galley validator [flags]
 
@@ -265,11 +285,11 @@ number_of_entries: 7 - + - + @@ -289,13 +309,25 @@ number_of_entries: 7 - + + + + + + + + + + + + + @@ -325,9 +357,9 @@ number_of_entries: 7
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter] (default ``)Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter, mcp, runtime] (default ``)
--log_output_level <string>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, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:info`)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, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>
--log_stacktrace_level <string>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 [ads, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:none`)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 [ads, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray> 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]`)
--logcallerLogs filename and line number of callers to log
--loglevel <Level>loglevel, one of [Debug Verbose Info Warning Error Critical Fatal] (default `Info`)
--logprefix <string>Prefix to log lines before logged messages (default `> `)
--mixer-webhook-name <string> Name of the mixer webhook entry in the webhook config. (default `mixer.validation.istio.io`)
-

gals version

+

galley version

Prints out build version information

-
gals version [flags]
+
galley version [flags]
 
@@ -349,12 +381,12 @@ number_of_entries: 7 - + - + @@ -379,7 +411,7 @@ number_of_entries: 7 - + @@ -387,6 +419,21 @@ number_of_entries: 7 + + + + + + + + + + + + + + + diff --git a/content/docs/reference/commands/istio_ca.html b/content/docs/reference/commands/istio_ca/index.html similarity index 100% rename from content/docs/reference/commands/istio_ca.html rename to content/docs/reference/commands/istio_ca/index.html diff --git a/content/docs/reference/commands/istioctl.html b/content/docs/reference/commands/istioctl/index.html similarity index 81% rename from content/docs/reference/commands/istioctl.html rename to content/docs/reference/commands/istioctl/index.html index f2e2ab3609..5440ef4ec4 100644 --- a/content/docs/reference/commands/istioctl.html +++ b/content/docs/reference/commands/istioctl/index.html @@ -2,7 +2,7 @@ title: istioctl description: Istio control interface generator: pkg-collateral-docs -number_of_entries: 22 +number_of_entries: 26 ---

Istio configuration command line utility.

@@ -1491,16 +1491,98 @@ istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml --injectConf

istioctl proxy-config

-

-Retrieves proxy configuration for the specified pod from the endpoint proxy or Pilot when running in Kubernetes. -It is also able to retrieve the state of the entire mesh by using mesh instead of <pod-name>. This is only available when querying Pilot.

-

Available configuration types:

-

Endpoint: - [clusters listeners routes bootstrap]

-

Pilot: - [ads eds]

-

-
istioctl proxy-config <endpoint|pilot> <pod-name|mesh> [<configuration-type>] [flags]
+

A group of commands used to retrieve information about proxy configuration from the Envoy config dump

+
--log_caller <string> Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter] (default ``)Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, attributes, default, grpcAdapter, mcp, runtime] (default ``)
--log_output_level <string> 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, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:info`)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, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>
--log_stacktrace_level <string> 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 [ads, attributes, default, grpcAdapter] and level can be one of [debug, info, warn, error, none] (default `default:none`)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 [ads, attributes, default, grpcAdapter, mcp, runtime] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray>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]`)
--logcallerLogs filename and line number of callers to log
--loglevel <Level>loglevel, one of [Debug Verbose Info Warning Error Critical Fatal] (default `Info`)
--logprefix <string>Prefix to log lines before logged messages (default `> `)
--resyncPeriod <duration> Resync period for rescanning Kubernetes resources (default `0s`)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default] (default ``)
--log_output_level <string>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, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>The path for the optional rotating log file (default ``)
--log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)
--log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)
--log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)
--log_stacktrace_level <string>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 [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray>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]`)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|short (default `short`)
--platform <string>-pIstio host platform (default `kube`)
+

Examples

+
  # Retrieve information about proxy configuration from an Envoy instance.
+  istioctl proxy-config <clusters|listeners|routes|bootstap> <pod-name>
+
+

istioctl proxy-config bootstrap

+

Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.

+
istioctl proxy-config bootstrap <pod-name> [flags]
 
@@ -1575,24 +1657,358 @@ It is also able to retrieve the state of the entire mesh by using mesh instead o + + + + +
Config namespace (default ``)
--output <string>-oOutput format: one of json|short (default `short`)
--platform <string> -p Istio host platform (default `kube`)
-

Examples

-
# Retrieve all config for productpage-v1-bb8d5cbc7-k7qbm pod from the endpoint proxy
-istioctl proxy-config endpoint productpage-v1-bb8d5cbc7-k7qbm
+

Examples

+
  # Retrieve full bootstrap configuration for a given pod from Envoy.
+  istioctl proxy-config bootstrap <pod-name>
 
-# Retrieve eds config for productpage-v1-bb8d5cbc7-k7qbm pod from Pilot
-istioctl proxy-config pilot productpage-v1-bb8d5cbc7-k7qbm eds
+
+

istioctl proxy-config cluster

+

Retrieve information about cluster configuration for the Envoy instance in the specified pod.

+
istioctl proxy-config cluster <pod-name> [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--direction <string>Filter clusters by Direction field (default ``)
--fqdn <string>Filter clusters by substring of Service FQDN field (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default] (default ``)
--log_output_level <string>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, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>The path for the optional rotating log file (default ``)
--log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)
--log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)
--log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)
--log_stacktrace_level <string>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 [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray>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]`)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|short (default `short`)
--platform <string>-pIstio host platform (default `kube`)
--port <int>Filter clusters by Port field (default `0`)
--subset <string>Filter clusters by subtring of Subset field (default ``)
+

Examples

+
  # Retrieve summary about cluster configuration for a given pod from Envoy.
+  istioctl proxy-config clusters <pod-name>
 
-# Retrieve ads config for the mesh from Pilot
-istioctl proxy-config pilot mesh ads
+  # Retrieve cluster summary for clusters with port 9080.
+  istioctl proxy-config clusters <pod-name> --port 9080
+
+  # Retrieve full cluster dump for clusters that are inbound with a FQDN of details.default.svc.cluster.local.
+  istioctl proxy-config clusters <pod-name> --fqdn details.default.svc.cluster.local --direction inbound -o json
+
+
+

istioctl proxy-config listener

+

Retrieve information about listener configuration for the Envoy instance in the specified pod.

+
istioctl proxy-config listener <pod-name> [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--address <string>Filter listeners by address field (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default] (default ``)
--log_output_level <string>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, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>The path for the optional rotating log file (default ``)
--log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)
--log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)
--log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)
--log_stacktrace_level <string>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 [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray>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]`)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|short (default `short`)
--platform <string>-pIstio host platform (default `kube`)
--port <int>Filter listeners by Port field (default `0`)
--type <string>Filter listeners by type field (default ``)
+

Examples

+
  # Retrieve summary about listener configuration for a given pod from Envoy.
+  istioctl proxy-config listeners <pod-name>
+
+  # Retrieve listener summary for listeners with port 9080.
+  istioctl proxy-config listeners <pod-name> --port 9080
+
+  # Retrieve full listener dump for HTTP listeners with a wildcard address (0.0.0.0).
+  istioctl proxy-config listeners <pod-name> --type HTTP --address 0.0.0.0 -o json
+
+
+

istioctl proxy-config route

+

Retrieve information about route configuration for the Envoy instance in the specified pod.

+
istioctl proxy-config route <pod-name> [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default] (default ``)
--log_output_level <string>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, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)
--log_rotate <string>The path for the optional rotating log file (default ``)
--log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)
--log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)
--log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)
--log_stacktrace_level <string>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 [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)
--log_target <stringArray>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]`)
--name <string>Filter listeners by route name field (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|short (default `short`)
--platform <string>-pIstio host platform (default `kube`)
+

Examples

+
  # Retrieve summary about route configuration for a given pod from Envoy.
+  istioctl proxy-config routes <pod-name>
+
+  # Retrieve route summary for route 9080.
+  istioctl proxy-config route <pod-name> --name 9080
+
+  # Retrieve full route dump for route 9080
+  istioctl proxy-config route <pod-name> --name 9080 -o json
 
-# Retrieve bootstrap config for productpage-v1-bb8d5cbc7-k7qbm pod in the application namespace from the endpoint proxy
-istioctl proxy-config endpoint -n application productpage-v1-bb8d5cbc7-k7qbm bootstrap
 

istioctl proxy-status

diff --git a/content/docs/reference/commands/mixc.html b/content/docs/reference/commands/mixc/index.html similarity index 100% rename from content/docs/reference/commands/mixc.html rename to content/docs/reference/commands/mixc/index.html diff --git a/content/docs/reference/commands/mixs.html b/content/docs/reference/commands/mixs/index.html similarity index 98% rename from content/docs/reference/commands/mixs.html rename to content/docs/reference/commands/mixs/index.html index 8a13e24c94..5f09968674 100644 --- a/content/docs/reference/commands/mixs.html +++ b/content/docs/reference/commands/mixs/index.html @@ -193,6 +193,11 @@ nexus for policy evaluation and telemetry reporting.

HTTP port to use for the exposing mixer self-monitoring information (default `9093`) +--numCheckCacheEntries <int32> + +Max number of entries in the check result cache (default `1500000`) + + --port <uint16> -p TCP port to use for Mixer's gRPC API, if the address option is not specified (default `9091`) diff --git a/content/docs/reference/commands/node_agent.html b/content/docs/reference/commands/node_agent/index.html similarity index 100% rename from content/docs/reference/commands/node_agent.html rename to content/docs/reference/commands/node_agent/index.html diff --git a/content/docs/reference/commands/pilot-agent.html b/content/docs/reference/commands/pilot-agent/index.html similarity index 100% rename from content/docs/reference/commands/pilot-agent.html rename to content/docs/reference/commands/pilot-agent/index.html diff --git a/content/docs/reference/commands/pilot-discovery.html b/content/docs/reference/commands/pilot-discovery/index.html similarity index 100% rename from content/docs/reference/commands/pilot-discovery.html rename to content/docs/reference/commands/pilot-discovery/index.html diff --git a/content/docs/reference/commands/sidecar-injector.html b/content/docs/reference/commands/sidecar-injector/index.html similarity index 100% rename from content/docs/reference/commands/sidecar-injector.html rename to content/docs/reference/commands/sidecar-injector/index.html diff --git a/content/docs/reference/config/istio.networking.v1alpha3.html b/content/docs/reference/config/istio.networking.v1alpha3/index.html similarity index 91% rename from content/docs/reference/config/istio.networking.v1alpha3.html rename to content/docs/reference/config/istio.networking.v1alpha3/index.html index 16dbd17d4d..b6ac094974 100644 --- a/content/docs/reference/config/istio.networking.v1alpha3.html +++ b/content/docs/reference/config/istio.networking.v1alpha3/index.html @@ -4,7 +4,7 @@ description: Configuration affecting traffic routing location: https://istio.io/docs/reference/config/istio.networking.v1alpha3.html layout: protoc-gen-docs generator: protoc-gen-docs -number_of_entries: 46 +number_of_entries: 48 ---

Configuration affecting traffic routing. Here are a few terms useful to define in the context of traffic routing.

@@ -689,7 +689,7 @@ The behavior is undefined if multiple EnvoyFilter configurations are specified for the same workload.

The following example for Kubernetes enables Envoy’s Lua filter for all -inbound calls arriving at port 18080 of the reviews service pod with +inbound calls arriving at service port 8080 of the reviews service pod with labels “app: reviews”.

apiVersion: networking.istio.io/v1alpha3
@@ -701,8 +701,8 @@ spec:
     app: reviews
   filters:
   - listenerMatch:
-      portNumber: 18080
-      listenerType: SIDECAR_INBOUND #will match with the listener for the podIP:18080
+      portNumber: 8080 
+      listenerType: SIDECAR_INBOUND #will match with the inbound listener for reviews:8080
     filterName: envoy.lua
     filterType: HTTP
     filterConfig:
@@ -937,8 +937,10 @@ to be applied to a listener.

portNumber uint32 -

Port associated with the listener. If not specified, matches all -listeners.

+

The service port/gateway port to which traffic is being +sent/received. If not specified, matches all listeners. Eventhough +inbound listeners are generated for the instance/pod ports, only +service ports should be used to match listeners.

@@ -1185,12 +1187,13 @@ spec: - my-gateway tcp: - match: - - port: - number: 27017 + - port: 27017 sourceSubnet: "172.17.16.0/24" route: - destination: host: mongo.prod.svc.cluster.local + port: + number: 5555
@@ -1874,15 +1877,6 @@ specifies a particular IP.

only expose a single port or label ports with the protocols they support, in these cases it is not required to explicitly select the port.

- - - - - - @@ -1901,8 +1895,8 @@ gateways specified at the top, it should include the reserved gateway @@ -2200,8 +2194,8 @@ service that can be ejected. Defaults to 10%.

@@ -2513,6 +2507,132 @@ spec: caCertificates: /etc/certs/rootcacerts.pem +

The following example uses a combination of service entry and TLS +routing in virtual service to demonstrate the use of SNI routing to +forward unterminated TLS traffic from the application to external +services via the sidecar. The sidecar inspects the SNI value in the +ClientHello message to route to the appropriate external service.

+ +
apiVersion: networking.istio.io/v1alpha3
+kind: ServiceEntry
+metadata:
+  name: external-svc-https
+spec:
+  hosts:
+  - api.dropboxapi.com
+  - www.googleapis.com
+  - api.facebook.com
+  location: MESH_EXTERNAL
+  ports:
+  - number: 443
+    name: https
+    protocol: HTTPS
+  resolution: DNS
+
+ +

And the associated VirtualService to route based on the SNI value.

+ +
apiVersion: networking.istio.io/v1alpha3
+kind: VirtualService
+metadata:
+  name: tls-routing
+spec:
+  hosts:
+  - api.dropboxapi.com
+  - www.googleapis.com
+  - api.facebook.com
+  tls:
+  - match:
+    - port: 443
+      sniHosts:
+      - api.dropboxapi.com
+    route:
+    - destination:
+        host: api.dropboxapi.com
+  - match:
+    - port: 443
+      sniHosts:
+      - www.googleapis.com
+    route:
+    - destination:
+        host: www.googleapis.com
+  - match:
+    - port: 443
+      sniHosts:
+      - api.facebook.com
+    route:
+    - destination:
+        host: api.facebook.com
+
+
+ +

The following example demonstrates the use of a dedicated egress gateway +through which all external service traffic is forwarded.

+ +
apiVersion: networking.istio.io/v1alpha3
+kind: ServiceEntry
+metadata:
+  name: external-svc-httpbin
+spec:
+  hosts:
+  - httpbin.com
+  location: MESH_EXTERNAL
+  ports:
+  - number: 80
+    name: http
+    protocol: HTTP
+  resolution: DNS
+
+ +

Define a gateway to to handle all egress traffic.

+ +
apiVersion: networking.istio.io/v1alpha3
+kind: Gateway
+metadata:
+ name: istio-egressgateway
+spec:
+ selector:
+   istio: egressgateway
+ servers:
+ - port:
+     number: 80
+     name: http
+     protocol: HTTP
+   hosts:
+   - "*"
+
+And the associated VirtualService to route from the sidecar to the
+gateway service (istio-egressgateway.istio-system.svc.cluster.local), as
+well as route from the gateway to the external service.
+
+```yaml
+apiVersion: networking.istio.io/v1alpha3
+kind: VirtualService
+metadata:
+  name: gateway-routing
+spec:
+  hosts:
+  - httpbin.com
+  gateways:
+  - mesh
+  - istio-egressgateway
+  http:
+  - match:
+    - port: 80
+      gateways:
+      - mesh
+    route:
+    - destination:
+        host: istio-egressgateway.istio-system.svc.cluster.local
+  - match:
+    - port: 80
+      gateway:
+      - istio-egressgateway
+    route:
+    - destination:
+        host: httpbin.com
+
+

The following example demonstrates the use of wildcards in the hosts for external services. If the connection has to be routed to the IP address requested by the application (i.e. application resolves DNS and attempts @@ -2559,8 +2679,8 @@ backed by multiple DNS addressable endpoints. In such a scenario, the application can use the HTTP_PROXY environment variable to transparently reroute API calls for the VirtualService to a chosen backend. For example, the following configuration creates a non-existent external -service called foo.bar.com backed by three domains: us.foo.bar.com:8443, -uk.foo.bar.com:9443, and in.foo.bar.com:7443

+service called foo.bar.com backed by three domains: us.foo.bar.com:8080, +uk.foo.bar.com:9080, and in.foo.bar.com:7080

apiVersion: networking.istio.io/v1alpha3
 kind: ServiceEntry
@@ -2571,40 +2691,26 @@ spec:
   - foo.bar.com
   location: MESH_EXTERNAL
   ports:
-  - number: 443
+  - number: 80
     name: https
     protocol: HTTP
   resolution: DNS
   endpoints:
   - address: us.foo.bar.com
     ports:
-      https: 8443
+      https: 8080
   - address: uk.foo.bar.com
     ports:
-      https: 9443
+      https: 9080
   - address: in.foo.bar.com
     ports:
-      https: 7443
+      https: 7080
 
-

and a DestinationRule to initiate TLS connections to the ServiceEntry.

- -
apiVersion: networking.istio.io/v1alpha3
-kind: DestinationRule
-metadata:
-  name: tls-foobar
-spec:
-  host: foo.bar.com
-  trafficPolicy:
-    tls:
-      mode: SIMPLE # initiates HTTPS
-
- -

With HTTP_PROXY=http://localhost:443, calls from the application to -http://foo.bar.com will be upgraded to HTTPS and load balanced across -the three domains specified above. In other words, a call to -http://foo.bar.com/baz would be translated to -https://uk.foo.bar.com/baz.

+

With HTTP_PROXY=http://localhost/, calls from the application to +http://foo.bar.com will be load balanced across the three domains +specified above. In other words, a call to http://foo.bar.com/baz would +be translated to http://uk.foo.bar.com/baz.

sourceSubnetstring -

IPv4 or IPv6 ip address of source with optional subnet. E.g., a.b.c.d/xx -form or just a.b.c.d

-
string[]

Names of gateways where the rule should be applied to. Gateway names -at the top of the VirtualService (if any) are overridden. The gateway match is -independent of sourceLabels.

+at the top of the VirtualService (if any) are overridden. The gateway +match is independent of sourceLabels.

string

REQUIRED: The protocol exposed on the port. -MUST BE one of HTTP|HTTPS|GRPC|HTTP2|MONGO|TCP|TCP-TLS. -TCP-TLS is used to indicate secure connections to non HTTP services.

+MUST BE one of HTTP|HTTPS|GRPC|HTTP2|MONGO|TCP|TLS. +TLS is used to indicate secure connections to non HTTP services.

@@ -2946,8 +3052,7 @@ specified at the DestinationRule level.

Describes match conditions and actions for routing TCP traffic. The following routing rule forwards traffic arriving at port 27017 for -mongo.prod.svc.cluster.local from 172.17.16.* subnet to another Mongo -server on port 5555.

+mongo.prod.svc.cluster.local to another Mongo server on port 5555.

apiVersion: networking.istio.io/v1alpha3
 kind: VirtualService
@@ -2959,7 +3064,6 @@ spec:
   tcp:
   - match:
     - port: 27017
-      sourceSubnet: "172.17.16.0/24"
     route:
     - destination:
         host: mongo.backup.svc.cluster.local
@@ -2996,6 +3100,142 @@ Currently, only one destination is allowed for TCP services. When TCP
 weighted routing support is introduced in Envoy, multiple destinations
 with weights can be specified.

+ + + +
+ +

TLSMatchAttributes

+
+

TLS connection match attributes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
destinationSubnetstring +

IPv4 or IPv6 ip address of destination with optional subnet. E.g., +a.b.c.d/xx form or just a.b.c.d. This is only valid when the +destination service has several IPs and the application explicitly +specifies a particular IP.

+ +
portuint32 +

Specifies the port on the host that is being addressed. Many services +only expose a single port or label ports with the protocols they +support, in these cases it is not required to explicitly select the +port.

+ +
sniHostsstring[] +

SNI (server name indicator) to match on. Wildcard prefixes can be used +in the SNI value. E.g., *.com will match foo.example.com as well as +example.com.

+ +
sourceLabelsmap<string, string> +

One or more labels that constrain the applicability of a rule to +workloads with the given labels. If the VirtualService has a list of +gateways specified at the top, it should include the reserved gateway +mesh in order for this field to be applicable.

+ +
gatewaysstring[] +

Names of gateways where the rule should be applied to. Gateway names +at the top of the VirtualService (if any) are overridden. The gateway +match is independent of sourceLabels.

+ +
+
+

TLSRoute

+
+

Describes match conditions and actions for routing unterminated TLS +traffic (TLS/HTTPS) The following routing rule forwards unterminated TLS +traffic arriving at port 443 of gateway called “mygateway” to internal +services in the mesh based on the SNI value.

+ +
apiVersion: networking.istio.io/v1alpha3
+kind: VirtualService
+metadata:
+  name: bookinfo-sni
+spec:
+  hosts:
+  - "*.bookinfo.com"
+  gateways:
+  - mygateway
+  tls:
+  - match:
+    - port: 443
+      sniHosts:
+      - login.bookinfo.com
+    route:
+    - destination:
+        host: login.prod.svc.cluster.local
+  - match:
+    - port: 443
+      sniHosts:
+      - reviews.bookinfo.com
+    route:
+    - destination:
+        host: reviews.prod.svc.cluster.local
+
+ + + + + + + + + + + + + + + + + + + @@ -3398,15 +3638,15 @@ only for services defined via the Gateway.

@@ -3414,8 +3654,27 @@ specify mesh as one of the gateway names.

+ + + + + @@ -3423,8 +3682,9 @@ The first rule matching an incoming request is used.

diff --git a/content/docs/reference/config/istio.rbac.v1alpha1.html b/content/docs/reference/config/istio.rbac.v1alpha1/index.html similarity index 100% rename from content/docs/reference/config/istio.rbac.v1alpha1.html rename to content/docs/reference/config/istio.rbac.v1alpha1/index.html diff --git a/content/docs/reference/config/istio.routing.v1alpha1.html b/content/docs/reference/config/istio.routing.v1alpha1/index.html similarity index 100% rename from content/docs/reference/config/istio.routing.v1alpha1.html rename to content/docs/reference/config/istio.routing.v1alpha1/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/circonus.html b/content/docs/reference/config/policy-and-telemetry/adapters/circonus/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/circonus.html rename to content/docs/reference/config/policy-and-telemetry/adapters/circonus/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/cloudwatch.html b/content/docs/reference/config/policy-and-telemetry/adapters/cloudwatch/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/cloudwatch.html rename to content/docs/reference/config/policy-and-telemetry/adapters/cloudwatch/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/datadog.html b/content/docs/reference/config/policy-and-telemetry/adapters/datadog/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/datadog.html rename to content/docs/reference/config/policy-and-telemetry/adapters/datadog/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/denier.html b/content/docs/reference/config/policy-and-telemetry/adapters/denier/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/denier.html rename to content/docs/reference/config/policy-and-telemetry/adapters/denier/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/fluentd.html b/content/docs/reference/config/policy-and-telemetry/adapters/fluentd/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/fluentd.html rename to content/docs/reference/config/policy-and-telemetry/adapters/fluentd/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv.html b/content/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv.html rename to content/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/list.html b/content/docs/reference/config/policy-and-telemetry/adapters/list/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/list.html rename to content/docs/reference/config/policy-and-telemetry/adapters/list/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/memquota.html b/content/docs/reference/config/policy-and-telemetry/adapters/memquota/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/memquota.html rename to content/docs/reference/config/policy-and-telemetry/adapters/memquota/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/opa.html b/content/docs/reference/config/policy-and-telemetry/adapters/opa/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/opa.html rename to content/docs/reference/config/policy-and-telemetry/adapters/opa/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/prometheus.html b/content/docs/reference/config/policy-and-telemetry/adapters/prometheus/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/prometheus.html rename to content/docs/reference/config/policy-and-telemetry/adapters/prometheus/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/rbac.html b/content/docs/reference/config/policy-and-telemetry/adapters/rbac/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/rbac.html rename to content/docs/reference/config/policy-and-telemetry/adapters/rbac/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/redisquota.html b/content/docs/reference/config/policy-and-telemetry/adapters/redisquota/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/redisquota.html rename to content/docs/reference/config/policy-and-telemetry/adapters/redisquota/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/servicecontrol.html b/content/docs/reference/config/policy-and-telemetry/adapters/servicecontrol/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/servicecontrol.html rename to content/docs/reference/config/policy-and-telemetry/adapters/servicecontrol/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/signalfx.html b/content/docs/reference/config/policy-and-telemetry/adapters/signalfx/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/signalfx.html rename to content/docs/reference/config/policy-and-telemetry/adapters/signalfx/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/solarwinds.html b/content/docs/reference/config/policy-and-telemetry/adapters/solarwinds/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/solarwinds.html rename to content/docs/reference/config/policy-and-telemetry/adapters/solarwinds/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/stackdriver.html b/content/docs/reference/config/policy-and-telemetry/adapters/stackdriver/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/stackdriver.html rename to content/docs/reference/config/policy-and-telemetry/adapters/stackdriver/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/statsd.html b/content/docs/reference/config/policy-and-telemetry/adapters/statsd/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/statsd.html rename to content/docs/reference/config/policy-and-telemetry/adapters/statsd/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/adapters/stdio.html b/content/docs/reference/config/policy-and-telemetry/adapters/stdio/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/adapters/stdio.html rename to content/docs/reference/config/policy-and-telemetry/adapters/stdio/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html b/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html rename to content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/apikey.html b/content/docs/reference/config/policy-and-telemetry/templates/apikey/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/apikey.html rename to content/docs/reference/config/policy-and-telemetry/templates/apikey/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/authorization.html b/content/docs/reference/config/policy-and-telemetry/templates/authorization/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/authorization.html rename to content/docs/reference/config/policy-and-telemetry/templates/authorization/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/checknothing.html b/content/docs/reference/config/policy-and-telemetry/templates/checknothing/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/checknothing.html rename to content/docs/reference/config/policy-and-telemetry/templates/checknothing/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/kubernetes.html b/content/docs/reference/config/policy-and-telemetry/templates/kubernetes/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/kubernetes.html rename to content/docs/reference/config/policy-and-telemetry/templates/kubernetes/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/listentry.html b/content/docs/reference/config/policy-and-telemetry/templates/listentry/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/listentry.html rename to content/docs/reference/config/policy-and-telemetry/templates/listentry/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/logentry.html b/content/docs/reference/config/policy-and-telemetry/templates/logentry/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/logentry.html rename to content/docs/reference/config/policy-and-telemetry/templates/logentry/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/metric.html b/content/docs/reference/config/policy-and-telemetry/templates/metric/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/metric.html rename to content/docs/reference/config/policy-and-telemetry/templates/metric/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/quota.html b/content/docs/reference/config/policy-and-telemetry/templates/quota/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/quota.html rename to content/docs/reference/config/policy-and-telemetry/templates/quota/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/reportnothing.html b/content/docs/reference/config/policy-and-telemetry/templates/reportnothing/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/reportnothing.html rename to content/docs/reference/config/policy-and-telemetry/templates/reportnothing/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/servicecontrolreport.html b/content/docs/reference/config/policy-and-telemetry/templates/servicecontrolreport/index.html similarity index 100% rename from content/docs/reference/config/policy-and-telemetry/templates/servicecontrolreport.html rename to content/docs/reference/config/policy-and-telemetry/templates/servicecontrolreport/index.html diff --git a/content/docs/reference/config/policy-and-telemetry/templates/tracespan.html b/content/docs/reference/config/policy-and-telemetry/templates/tracespan.html deleted file mode 100644 index f6a56245df..0000000000 --- a/content/docs/reference/config/policy-and-telemetry/templates/tracespan.html +++ /dev/null @@ -1,279 +0,0 @@ ---- -title: Trace Span -description: A template that represents\ an individual span within a distributed trace. -location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/tracespan.html -layout: protoc-gen-docs -generator: protoc-gen-docs -number_of_entries: 3 ---- -

The tracespan template represents an individual span within a distributed trace.

- -

Example config:

- -
apiVersion: "config.istio.io/v1alpha2"
-kind: tracespan
-metadata:
-  name: default
-  namespace: istio-system
-spec:
-  traceId: request.headers["x-b3-traceid"]
-  spanId: request.headers["x-b3-spanid"] | ""
-  parentSpanId: request.headers["x-b3-parentspanid"] | ""
-  spanName: request.path | "/"
-  startTime: request.time
-  endTime: response.time
-  spanTags:
-    http.method: request.method | ""
-    http.status_code: response.code | 200
-    http.url: request.path | ""
-    request.size: request.size | 0
-    response.size: response.size | 0
-    source.ip: source.ip | ip("0.0.0.0")
-    source.service: source.service | ""
-    source.user: source.user | ""
-    source.version: source.labels["version"] | ""
-
- -

See also: Distributed Tracing -for information on tracing within Istio.

- -

Template

-
-

TraceSpan represents an individual span within a distributed trace.

- -

When writing the configuration, the value for the fields associated with this template can either be a -literal or an expression. Please note that if the datatype of a field is not istio.policy.v1beta1.Value, -then the expression’s inferred type must match the datatype of the field.

- -
FieldTypeDescription
matchTLSMatchAttributes[] +

Match conditions to be satisfied for the rule to be activated. All +conditions inside a single match block have AND semantics, while the +list of match blocks have OR semantics. The rule is matched if any one +of the match blocks succeed.

+ +
routeDestinationWeight[] +

The destination to which the connection should be forwarded to. +Currently, only one destination is allowed for TLS services. When TCP +weighted routing support is introduced in Envoy, multiple destinations +with weights can be specified.

+
string[]

The names of gateways and sidecars that should apply these routes. A -single VirtualService is used for sidecars inside the mesh as well -as for one or more gateways. The selection condition imposed by this field -can be overridden using the source field in the match conditions of HTTP/TCP -routes. The reserved word mesh is used to imply all the sidecars in -the mesh. When this field is omitted, the default gateway (mesh) -will be used, which would apply the rule to all sidecars in the -mesh. If a list of gateway names is provided, the rules will apply -only to the gateways. To apply the rules to both gateways and sidecars, -specify mesh as one of the gateway names.

+single VirtualService is used for sidecars inside the mesh as well as +for one or more gateways. The selection condition imposed by this +field can be overridden using the source field in the match conditions +of protocol-specific routes. The reserved word mesh is used to imply +all the sidecars in the mesh. When this field is omitted, the default +gateway (mesh) will be used, which would apply the rule to all +sidecars in the mesh. If a list of gateway names is provided, the +rules will apply only to the gateways. To apply the rules to both +gateways and sidecars, specify mesh as one of the gateway names.

http HTTPRoute[] -

An ordered list of route rules for HTTP traffic. -The first rule matching an incoming request is used.

+

An ordered list of route rules for HTTP traffic. HTTP routes will be +applied to platform service ports named ‘http-’/‘http2-’/‘grpc-*’, gateway +ports with protocol HTTP/HTTP2/GRPC/ TLS-terminated-HTTPS and service +entry ports using HTTP/HTTP2/GRPC protocols. The first rule matching +an incoming request is used.

+ +
tlsTLSRoute[] +

An ordered list of route rule for non-terminated TLS & HTTPS +traffic. Routing is typically performed using the SNI value presented +by the ClientHello message. TLS routes will be applied to platform +service ports named ‘https-’, ‘tls-’, unterminated gateway ports using +HTTPS/TLS protocols (i.e. with “passthrough” TLS mode) and service +entry ports using HTTPS/TLS protocols. The first rule matching an +incoming request is used. NOTE: Traffic ‘https-’ or ‘tls-’ ports +without associated virtual service will be treated as opaque TCP +traffic.

tcp TCPRoute[] -

An ordered list of route rules for TCP traffic. -The first rule matching an incoming request is used.

+

An ordered list of route rules for opaque TCP traffic. TCP routes will +be applied to any port that is not a HTTP or TLS port. The first rule +matching an incoming request is used.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
traceIdstring -

Trace ID is the unique identifier for a trace. All spans from the same -trace share the same Trace ID.

- -

Required.

- -
spanIdstring -

Span ID is the unique identifier for a span within a trace. It is assigned -when the span is created.

- -

Optional.

- -
parentSpanIdstring -

Parent Span ID is the unique identifier for a parent span of this span -instance. If this is a root span, then this field MUST be empty.

- -

Optional.

- -
spanNamestring -

Span name is a description of the span’s operation.

- -

For example, the name can be a qualified method name or a file name -and a line number where the operation is called. A best practice is to use -the same display name within an application and at the same call point. -This makes it easier to correlate spans in different traces.

- -

Required.

- -
startTimeistio.policy.v1beta1.TimeStamp -

The start time of the span.

- -

Required.

- -
endTimeistio.policy.v1beta1.TimeStamp -

The end time of the span.

- -

Required.

- -
spanTagsmap<string, istio.policy.v1beta1.Value> -

Span tags are a set of < key, value > pairs that provide metadata for the -entire span. The values can be specified in the form of expressions.

- -

Optional.

- -
httpStatusCodeint64 -

HTTP status code used to set the span status. If unset or set to 0, the -span status will be assumed to be successful.

- -
-
-

istio.policy.v1beta1.TimeStamp

-
-

An instance field of type TimeStamp denotes that the expression for the field must evalaute to -ValueType.TIMESTAMP

- -

Objects of type TimeStamp are also passed to the adapters during request-time for the instance fields of -type TimeStamp

- - - - - - - - - - - - - - - - -
FieldTypeDescription
valuegoogle.protobuf.Timestamp -

TimeStamp encoded as google.protobuf.Timestamp.

- -
-
-

istio.policy.v1beta1.Value

-
-

An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any -ValueType enum values. For example, when -authoring an instance configuration for a template that has a field data of type istio.policy.v1beta1.Value, -both of the following expressions are valid data: source.ip | ip("0.0.0.0"), data: request.id | ""; -the resulting type is either ValueType.IP_ADDRESS or ValueType.STRING for the two cases respectively.

- -

Objects of type Value are also passed to the adapters during request-time. There is a 1:1 mapping between -oneof fields in Value and enum values inside ValueType. Depending on the expression’s evaluated ValueType, -the equivalent oneof field in Value is populated by Mixer and passed to the adapters.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
stringValuestring (oneof) -

Used for values of type STRING

- -
int64Valueint64 (oneof) -

Used for values of type INT64

- -
doubleValuedouble (oneof) -

Used for values of type DOUBLE

- -
boolValuebool (oneof) -

Used for values of type BOOL

- -
ipAddressValueistio.policy.v1beta1.IPAddress (oneof) -

Used for values of type IPAddress

- -
timestampValueistio.policy.v1beta1.TimeStamp (oneof) -

Used for values of type TIMESTAMP

- -
durationValueistio.policy.v1beta1.Duration (oneof) -

Used for values of type DURATION

- -
emailAddressValueistio.policy.v1beta1.EmailAddress (oneof) -

Used for values of type EmailAddress

- -
dnsNameValueistio.policy.v1beta1.DNSName (oneof) -

Used for values of type DNSName

- -
uriValueistio.policy.v1beta1.Uri (oneof) -

Used for values of type Uri

- -
-
diff --git a/content/docs/reference/config/policy-and-telemetry/templates/tracespan/index.html b/content/docs/reference/config/policy-and-telemetry/templates/tracespan/index.html new file mode 100644 index 0000000000..9af2495cf3 --- /dev/null +++ b/content/docs/reference/config/policy-and-telemetry/templates/tracespan/index.html @@ -0,0 +1,158 @@ +--- +title: Trace Span +description: A template that represents\ an individual span within a distributed trace. +location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/tracespan.html +layout: protoc-gen-docs +generator: protoc-gen-docs +number_of_entries: 1 +--- +

The tracespan template represents an individual span within a distributed trace.

+ +

Example config:

+ +
apiVersion: "config.istio.io/v1alpha2"
+kind: tracespan
+metadata:
+  name: default
+  namespace: istio-system
+spec:
+  traceId: request.headers["x-b3-traceid"]
+  spanId: request.headers["x-b3-spanid"] | ""
+  parentSpanId: request.headers["x-b3-parentspanid"] | ""
+  spanName: request.path | "/"
+  startTime: request.time
+  endTime: response.time
+  client_span: !context.reporter.local
+  spanTags:
+    http.method: request.method | ""
+    http.status_code: response.code | 200
+    http.url: request.path | ""
+    request.size: request.size | 0
+    response.size: response.size | 0
+    source.ip: source.ip | ip("0.0.0.0")
+    source.service: source.service | ""
+    source.user: source.user | ""
+    source.version: source.labels["version"] | ""
+
+ +

See also: Distributed Tracing +for information on tracing within Istio.

+ +

Template

+
+

TraceSpan represents an individual span within a distributed trace.

+ +

When writing the configuration, the value for the fields associated with this template can either be a +literal or an expression. Please note that if the datatype of a field is not istio.policy.v1beta1.Value, +then the expression’s inferred type must match the datatype of the field.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
traceIdstring +

Trace ID is the unique identifier for a trace. All spans from the same +trace share the same Trace ID.

+ +

Required.

+ +
spanIdstring +

Span ID is the unique identifier for a span within a trace. It is assigned +when the span is created.

+ +

Optional.

+ +
parentSpanIdstring +

Parent Span ID is the unique identifier for a parent span of this span +instance. If this is a root span, then this field MUST be empty.

+ +

Optional.

+ +
spanNamestring +

Span name is a description of the span’s operation.

+ +

For example, the name can be a qualified method name or a file name +and a line number where the operation is called. A best practice is to use +the same display name within an application and at the same call point. +This makes it easier to correlate spans in different traces.

+ +

Required.

+ +
startTimeistio.policy.v1beta1.TimeStamp +

The start time of the span.

+ +

Required.

+ +
endTimeistio.policy.v1beta1.TimeStamp +

The end time of the span.

+ +

Required.

+ +
spanTagsmap<string, istio.policy.v1beta1.Value> +

Span tags are a set of < key, value > pairs that provide metadata for the +entire span. The values can be specified in the form of expressions.

+ +

Optional.

+ +
httpStatusCodeint64 +

HTTP status code used to set the span status. If unset or set to 0, the +span status will be assumed to be successful.

+ +
clientSpanbool +

client_span indicates the span kind. True for client spans and False or +not provided for server spans. +Optional

+ +
+
diff --git a/scripts/grab_reference_docs.sh b/scripts/grab_reference_docs.sh index 00a95bfec1..0f74fb6b9f 100755 --- a/scripts/grab_reference_docs.sh +++ b/scripts/grab_reference_docs.sh @@ -34,7 +34,7 @@ cd .. popd # Given the name of a .pb.html file, extracts the $location marker and then proceeds to -# copy the file to that location in the _docs hierarchy. +# copy the file to the corresponding content/docs/ hierarchy. locate_file() { FILENAME=$1 @@ -47,8 +47,10 @@ locate_file() { fi FNP=${LOCATION:31} FN=$(echo $FNP | rev | cut -d'/' -f1 | rev) + FN=${FN%.html} PP=$(echo $FNP | rev | cut -d'/' -f2- | rev) - sed -e 's/href="https:\/\/istio.io/href="/g' ${FILENAME} >content/docs${PP}/${FN} + mkdir -p content/docs${PP}/${FN} + sed -e 's/href="https:\/\/istio.io/href="/g' ${FILENAME} >content/docs${PP}/${FN}/index.html } # Given the path and name to an Istio command, builds the command and then @@ -63,7 +65,9 @@ get_command_doc() { pushd $COMMAND_PATH go build - ./$COMMAND collateral -o $COMMAND_DIR --jekyll_html + mkdir -p $COMMAND_DIR/$COMMAND + ./$COMMAND collateral -o $COMMAND_DIR/$COMMAND --jekyll_html + mv $COMMAND_DIR/$COMMAND/$COMMAND.html $COMMAND_DIR/$COMMAND/index.html rm $COMMAND 2>/dev/null popd } @@ -91,7 +95,7 @@ get_command_doc $WORK_DIR/istio/pilot/cmd/pilot-discovery pilot-discovery get_command_doc $WORK_DIR/istio/pilot/cmd/sidecar-injector sidecar-injector get_command_doc $WORK_DIR/istio/security/cmd/istio_ca istio_ca get_command_doc $WORK_DIR/istio/security/cmd/node_agent node_agent -get_command_doc $WORK_DIR/istio/galley/cmd/gals gals +get_command_doc $WORK_DIR/istio/galley/cmd/galley galley # Copy all the example files over into the examples directory # cp $WORK_DIR/istio/Makefile examples/Makefile