From e795a779c4940438d1dea9409544bcfb534b953e Mon Sep 17 00:00:00 2001 From: Martin Taillefer Date: Thu, 1 Feb 2018 21:04:37 -0800 Subject: [PATCH] Regenerate docs with latest tooling. (#926) --- _docs/guides/bookinfo.md | 2 +- _docs/reference/api/istio.mixer.v1.html | 30 +- _docs/reference/commands/istio_ca.html | 265 ++++ _docs/reference/commands/istio_ca.md | 73 - _docs/reference/commands/istioctl.html | 1257 +++++++++++++++++ _docs/reference/commands/istioctl.md | 442 ------ _docs/reference/commands/mixc.html | 242 ++++ _docs/reference/commands/mixc.md | 90 -- _docs/reference/commands/mixs.html | 663 +++++++++ _docs/reference/commands/mixs.md | 212 --- _docs/reference/commands/node_agent.html | 180 +++ _docs/reference/commands/node_agent.md | 56 - _docs/reference/commands/pilot-agent.html | 321 +++++ _docs/reference/commands/pilot-agent.md | 90 -- _docs/reference/commands/pilot-discovery.html | 346 +++++ _docs/reference/commands/pilot-discovery.md | 95 -- .../reference/commands/sidecar-injector.html | 205 +++ _docs/reference/commands/sidecar-injector.md | 61 - .../reference/config/istio.mesh.v1alpha1.html | 14 +- .../config/istio.mixer.v1.config.client.html | 46 +- .../config/istio.mixer.v1.config.html | 14 +- .../reference/config/istio.rbac.v1alpha1.html | 12 +- .../config/istio.routing.v1alpha1.html | 56 +- .../istio.mixer.v1.config.descriptor.html | 2 +- .../config/mixer/istio.mixer.v1.template.html | 2 +- _docs/setup/kubernetes/quick-start.md | 2 +- _docs/tasks/traffic-management/egress.md | 2 +- _layouts/pkg-collateral-docs.html | 4 + scripts/grab_reference_docs.sh | 5 +- 29 files changed, 3576 insertions(+), 1213 deletions(-) create mode 100644 _docs/reference/commands/istio_ca.html delete mode 100644 _docs/reference/commands/istio_ca.md create mode 100644 _docs/reference/commands/istioctl.html delete mode 100644 _docs/reference/commands/istioctl.md create mode 100644 _docs/reference/commands/mixc.html delete mode 100644 _docs/reference/commands/mixc.md create mode 100644 _docs/reference/commands/mixs.html delete mode 100644 _docs/reference/commands/mixs.md create mode 100644 _docs/reference/commands/node_agent.html delete mode 100644 _docs/reference/commands/node_agent.md create mode 100644 _docs/reference/commands/pilot-agent.html delete mode 100644 _docs/reference/commands/pilot-agent.md create mode 100644 _docs/reference/commands/pilot-discovery.html delete mode 100644 _docs/reference/commands/pilot-discovery.md create mode 100644 _docs/reference/commands/sidecar-injector.html delete mode 100644 _docs/reference/commands/sidecar-injector.md create mode 100644 _layouts/pkg-collateral-docs.html diff --git a/_docs/guides/bookinfo.md b/_docs/guides/bookinfo.md index 5a868dcb0e..99d9256e89 100644 --- a/_docs/guides/bookinfo.md +++ b/_docs/guides/bookinfo.md @@ -97,7 +97,7 @@ To start the application, follow the instructions below corresponding to your Is ``` The `istioctl kube-inject` command is used to manually modify the `bookinfo.yaml` - file before creating the deployments as documented [here]({{home}}/docs/reference/commands/istioctl.html#istioctl-kube-inject). + file before creating the deployments as documented [here]({{home}}/docs/reference/commands/istioctl.html#istioctl kube-inject). Either of the above commands launches all four microservices and creates the gateway ingress resource as illustrated in the above diagram. diff --git a/_docs/reference/api/istio.mixer.v1.html b/_docs/reference/api/istio.mixer.v1.html index 82795575b9..0b872cc9ff 100644 --- a/_docs/reference/api/istio.mixer.v1.html +++ b/_docs/reference/api/istio.mixer.v1.html @@ -10,7 +10,7 @@ redirect_from: /docs/reference/api/mixer/mixer.html

How an attribute’s value was matched

- +
@@ -84,7 +84,7 @@ Following places may use this message: 2) Service IDL definition to extract api attributes for active requests. 3) Forward attributes from client proxy to server proxy for HTTP requests.

-
Name Description
+
@@ -104,7 +104,7 @@ Following places may use this message:

Specifies one attribute value with different type.

-
Field Type
+
@@ -164,7 +164,7 @@ Following places may use this message:

Defines a string map.

-
Field Type
+
@@ -182,7 +182,7 @@ Following places may use this message:

Used to get a thumbs-up/thumbs-down before performing an action.

-
Field Type
+
@@ -232,7 +232,7 @@ per call, where the same UUID is used for retries of the same call.

parameters for a quota allocation

-
Field Type
+
@@ -258,7 +258,7 @@ per call, where the same UUID is used for retries of the same call.

CheckResponse

-
Field Type
+
@@ -284,7 +284,7 @@ per call, where the same UUID is used for retries of the same call.

CheckResponse.PreconditionResult

-
Field Type
+
@@ -341,7 +341,7 @@ along with matching conditions.

CheckResponse.QuotaResult

-
Field Type
+
@@ -385,7 +385,7 @@ dictionary instead. The message-level dictionary is carried by the words field of this message, the deployment-wide dictionary is determined via configuration.

-
Field Type
+
@@ -459,7 +459,7 @@ the message-level dictionary.

Describes the attributes that were used to determine the response. This can be used to construct a response cache.

-
Field Type
+
@@ -486,7 +486,7 @@ on using dictionaries.

ReferencedAttributes.AttributeMatch

-
Field Type
+
@@ -541,7 +541,7 @@ entire STRING_MAP will be used.

Used to report telemetry after performing one or more actions.

-
Field Type
+
@@ -602,7 +602,7 @@ To detect global dictionary out of sync between client and server.

A map of string to string. The keys and values in this map are dictionary indices (see the Attributes message for an explanation)

-
Field Type
+
@@ -675,7 +675,7 @@ represented directly using the Status message.

be used directly after any stripping needed for security/privacy reasons.

-
Field Type
+
diff --git a/_docs/reference/commands/istio_ca.html b/_docs/reference/commands/istio_ca.html new file mode 100644 index 0000000000..732cc34cf5 --- /dev/null +++ b/_docs/reference/commands/istio_ca.html @@ -0,0 +1,265 @@ +--- +title: istio_ca +overview: Istio Certificate Authority (CA) +layout: pkg-collateral-docs +--- +

Istio Certificate Authority (CA)

+
istio_ca [flags]
+
+
Field Type
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--ca-cert-ttl <duration>The TTL of self-signed CA root certificate (default `8760h0m0s`)
--cert-chain <string>Speicifies path to the certificate chain file (default ``)
--grpc-hostname <string>Specifies the hostname for GRPC server. (default `localhost`)
--grpc-port <int>Specifies the port number for GRPC server. If unspecified, Istio CA will not server GRPC request. (default `0`)
--istio-ca-storage-namespace <string>Namespace where the Istio CA pods is running. Will not be used if explicit file or other storage mechanism is specified. (default `istio-system`)
--kube-config <string>Specifies path to kubeconfig file. This must be specified when not running inside a Kubernetes pod. (default ``)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_dir <string>If non-empty, write log files in this directory (default ``)
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--logtostderrlog to standard error instead of files
--max-workload-cert-ttl <duration>The max TTL of issued workload certificates (default `168h0m0s`)
--namespace <string>Select a namespace for the CA to listen to. If unspecified, Istio CA tries to use the ${NAMESPACE} environment variable. If neither is set, Istio CA listens to all namespaces. (default ``)
--root-cert <string>Specifies path to the root certificate file (default ``)
--self-signed-caIndicates whether to use auto-generated self-signed CA certificate. When set to true, the '--signing-cert' and '--signing-key' options are ignored.
--self-signed-ca-org <string>The issuer organization used in self-signed CA certificate (default to k8s.cluster.local) (default `k8s.cluster.local`)
--signing-cert <string>Specifies path to the CA signing certificate file (default ``)
--signing-key <string>Specifies path to the CA signing key file (default ``)
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
--workload-cert-ttl <duration>The TTL of issued workload certificates (default `1h0m0s`)
+

istio_ca version

+

Prints out build version information

+
istio_ca version [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_dir <string>If non-empty, write log files in this directory (default ``)
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--logtostderrlog to standard error instead of files
--short-sDisplays a short form of the version information
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
diff --git a/_docs/reference/commands/istio_ca.md b/_docs/reference/commands/istio_ca.md deleted file mode 100644 index b2574c3cdd..0000000000 --- a/_docs/reference/commands/istio_ca.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: istio_ca -overview: Istio Certificate Authority (CA) -layout: docs ---- -Istio Certificate Authority (CA) -```bash -istio_ca [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--ca-cert-ttl `||The TTL of self-signed CA root certificate (default `8760h0m0s`) -|`--cert-chain `||Speicifies path to the certificate chain file (default `""`) -|`--grpc-hostname `||Specifies the hostname for GRPC server. (default `"localhost"`) -|`--grpc-port `||Specifies the port number for GRPC server. If unspecified, Istio CA will not server GRPC request. (default `0`) -|`--istio-ca-storage-namespace `||Namespace where the Istio CA pods is running. Will not be used if explicit file or other storage mechanism is specified. (default `"istio-system"`) -|`--kube-config `||Specifies path to kubeconfig file. This must be specified when not running inside a Kubernetes pod. (default `""`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--logtostderr`||log to standard error instead of files -|`--max-workload-cert-ttl `||The max TTL of issued workload certificates (default `168h0m0s`) -|`--namespace `||Select a namespace for the CA to listen to. If unspecified, Istio CA tries to use the ${NAMESPACE} environment variable. If neither is set, Istio CA listens to all namespaces. (default `""`) -|`--root-cert `||Specifies path to the root certificate file (default `""`) -|`--self-signed-ca-org `||The issuer organization used in self-signed CA certificate (default to k8s.cluster.local) (default `"k8s.cluster.local"`) -|`--self-signed-ca`||Indicates whether to use auto-generated self-signed CA certificate. When set to true, the '--signing-cert' and '--signing-key' options are ignored. -|`--signing-cert `||Specifies path to the CA signing certificate file (default `""`) -|`--signing-key `||Specifies path to the CA signing key file (default `""`) -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) -|`--workload-cert-ttl `||The TTL of issued workload certificates (default `1h0m0s`) - - -## istio_ca version - -Prints out build version information -```bash -istio_ca version [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--logtostderr`||log to standard error instead of files -|`--short`|`-s`|Displays a short form of the version information -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - diff --git a/_docs/reference/commands/istioctl.html b/_docs/reference/commands/istioctl.html new file mode 100644 index 0000000000..200b72c86f --- /dev/null +++ b/_docs/reference/commands/istioctl.html @@ -0,0 +1,1257 @@ +--- +title: istioctl +overview: Istio control interface +layout: pkg-collateral-docs +--- +

+Istio configuration command line utility.

+

Create, list, modify, and delete configuration resources in the Istio +system.

+

Available routing and traffic management configuration types:

+

[routerule ingressrule egressrule destinationpolicy]

+

See https://istio.io/docs/reference/ for an overview of routing rules +and destination policies.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--platform <string>-pIstio host platform (default `kube`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

istioctl context-create

+

Create a kubeconfig file suitable for use with istioctl in a non kubernetes environment

+
istioctl context-create --api-server http://<ip>:<port> [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--api-server <string>URL for Istio api server (default ``)
--context <string>Kubernetes configuration file context name (default `istio`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--platform <string>-pIstio host platform (default `kube`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

Examples

+
# Create a config file for the api server.
+istioctl context-create --api-server http://127.0.0.1:8080
+
+
+

istioctl create

+

Create policies and rules

+
istioctl create [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--file <string>-fInput file with the content of the configuration objects (if not set, command reads from the standard input) (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--platform <string>-pIstio host platform (default `kube`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

Examples

+
istioctl create -f example-routing.yaml
+
+

istioctl delete

+

Delete policies or rules

+
istioctl delete <type> <name> [<name2> ... <nameN>] [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--file <string>-fInput file with the content of the configuration objects (if not set, command reads from the standard input) (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--platform <string>-pIstio host platform (default `kube`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

Examples

+
# Delete a rule using the definition in example-routing.yaml.
+istioctl delete -f example-routing.yaml
+
+# Delete the rule productpage-default
+istioctl delete routerule productpage-default
+
+
+

istioctl deregister

+

De-registers a service instance

+
istioctl deregister <svcname> <ip> [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--platform <string>-pIstio host platform (default `kube`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

istioctl gen-deploy

+

istioctl gen-deploy produces deployment files to run the minimum Istio control for the set of features requested by the --feature flag. If no features are provided, we create deployments for the default control plane: Pilot, Mixer, CA, and Ingress Proxies, with mTLS enabled.

+
istioctl gen-deploy [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--debugIf true, uses debug images instead of release images
--features <stringArray>-fList of Istio features to enable. Accepts any combination of "mtls", "telemetry", "routing", "ingress", "policy", "sidecar-injector". (default `[]`)
--helm-chart-dir <string>The directory to find the helm charts used to render Istio deployments. -o yaml uses these to render the helm chart locally. (default `.`)
--hyperkube-hub <string>The container registry to pull Hyperkube images from (default `quay.io/coreos/hyperkube`)
--hyperkube-tag <Hyperkube>The tag to use to pull the Hyperkube container (default `0.4.0`)
--ingress-node-port <uint16>If provided, Istio ingress proxies will run as a NodePort service mapped to the port provided by this flag. Note that this flag is ignored unless the "ingress" feature flag is provided too. (default `0`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--out <string>-oOutput format. Acceptable values are'helm' to produce contents of values.yaml or 'helm' to produces Kubernetes deployments (default `helm`)
--platform <string>-pIstio host platform (default `kube`)
--v <Level>-vlog level for V logs (default `0`)
--values <string>Path to the Helm values.yaml file used to render YAML deployments locally when --out=yaml. Flag values are ignored in favor of using the file directly. (default ``)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

Examples

+
istioctl gen-deploy --features routing,policy,sidecar-injector -o helm
+
+

istioctl get

+

Retrieve policies and rules

+
istioctl get <type> [<name>] [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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:yaml|short (default `short`)
--platform <string>-pIstio host platform (default `kube`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

Examples

+
# List all route rules
+istioctl get routerules
+
+# List all destination policies
+istioctl get destinationpolicies
+
+# Get a specific rule named productpage-default
+istioctl get routerule productpage-default
+
+
+

istioctl kube-inject

+

+

kube-inject manually injects envoy sidecar into kubernetes +workloads. Unsupported resources are left unmodified so it is safe to +run kube-inject over a single file that contains multiple Service, +ConfigMap, Deployment, etc. definitions for a complex application. Its +best to do this when the resource is initially created.

+

k8s.io/docs/concepts/workloads/pods/pod-overview/#pod-templates is +updated for Job, DaemonSet, ReplicaSet, and Deployment YAML resource +documents. Support for additional pod-based resource types can be +added as necessary.

+

The Istio project is continually evolving so the Istio sidecar +configuration may change unannounced. When in doubt re-run istioctl +kube-inject on deployments to get the most up-to-date changes. +

+
istioctl kube-inject [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--coreDumpEnable/Disable core dumps in injected Envoy sidecar (--coreDump=true affects all pods in a node and should only be used the cluster admin)
--debugUse debug images and settings for the sidecar
--emitTemplateEmit sidecar template based on parameterized flags
--filename <string>-fInput Kubernetes resource filename (default ``)
--hub <string>Docker hub (default `unknown`)
--imagePullPolicy <string>Sets the container image pull policy. Valid options are Always,IfNotPresent,Never.The default policy is IfNotPresent. (default `IfNotPresent`)
--includeIPRanges <string>Comma separated list of IP ranges in CIDR form. If set, only redirect outbound traffic to Envoy for IP ranges. Otherwise all outbound traffic is redirected (default ``)
--injectConfigFile <string>injection configuration filename (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--meshConfigFile <string>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)
--meshConfigMapName <string>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oModified output Kubernetes resource filename (default ``)
--platform <string>-pIstio host platform (default `kube`)
--setVersionString <string>Override version info injected into resource (default ``)
--sidecarProxyUID <uint>Envoy sidecar UID (default `1337`)
--tag <string>Docker tag (default `unknown`)
--v <Level>-vlog level for V logs (default `0`)
--verbosity <int>Runtime verbosity (default `2`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

Examples

+

+# Update resources on the fly before applying.
+kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
+
+# Create a persistent version of the deployment with Envoy sidecar
+# injected.
+istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
+
+# Update an existing deployment.
+kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
+
+
+

istioctl register

+

Registers a service instance (e.g. VM) joining the mesh

+
istioctl register <svcname> <ip> [name1:]port1 [name2:]port2 ... [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--annotations <stringSlice>-aList of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,test,x=y (default `[]`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--labels <stringSlice>-lList of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--platform <string>-pIstio host platform (default `kube`)
--serviceaccount <string>-sService account to link to the service (default `default`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

istioctl replace

+

Replace existing policies and rules

+
istioctl replace [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--file <string>-fInput file with the content of the configuration objects (if not set, command reads from the standard input) (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--platform <string>-pIstio host platform (default `kube`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

Examples

+
istioctl replace -f example-routing.yaml
+
+

istioctl version

+

Prints out build version information

+
istioctl version [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default `/Users/mtail/.kube/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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 ``)
--platform <string>-pIstio host platform (default `kube`)
--short-sDisplays a short form of the version information
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
diff --git a/_docs/reference/commands/istioctl.md b/_docs/reference/commands/istioctl.md deleted file mode 100644 index 867101f45e..0000000000 --- a/_docs/reference/commands/istioctl.md +++ /dev/null @@ -1,442 +0,0 @@ ---- -title: istioctl -overview: Istio control interface -layout: docs ---- - -Istio configuration command line utility. - -Create, list, modify, and delete configuration resources in the Istio -system. - -Available routing and traffic management configuration types: - - [routerule ingressrule egressrule destinationpolicy] - -See https://istio.io/docs/reference/ for an overview of routing rules -and destination policies. - - - -|Option|Shorthand|Description -|------|---------|----------- -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## istioctl context-create - -Create a kubeconfig file suitable for use with istioctl in a non kubernetes environment -```bash -istioctl context-create --api-server http://: [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--api-server `||URL for Istio api server (default `""`) -|`--context `||Kubernetes configuration file context name (default `"istio"`) -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -### Examples - -```bash -# Create a config file for the api server. -istioctl context-create --api-server http://127.0.0.1:8080 - -``` - - -## istioctl create - -Create policies and rules -```bash -istioctl create [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--file `|`-f`|Input file with the content of the configuration objects (if not set, command reads from the standard input) (default `""`) -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -### Examples - -```bash -istioctl create -f example-routing.yaml -``` - - -## istioctl delete - -Delete policies or rules -```bash -istioctl delete [ ... ] [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--file `|`-f`|Input file with the content of the configuration objects (if not set, command reads from the standard input) (default `""`) -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -### Examples - -```bash -# Delete a rule using the definition in example-routing.yaml. -istioctl delete -f example-routing.yaml - -# Delete the rule productpage-default -istioctl delete routerule productpage-default - -``` - - -## istioctl deregister - -De-registers a service instance -```bash -istioctl deregister [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## istioctl gen-deploy - -istioctl gen-deploy produces deployment files to run the minimum Istio control for the set of features requested by the --feature flag. If no features are provided, we create deployments for the default control plane: Pilot, Mixer, CA, and Ingress Proxies, with mTLS enabled. -```bash -istioctl gen-deploy [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--debug`||If true, uses debug images instead of release images -|`--features `|`-f`|List of Istio features to enable. Accepts any combination of "mtls", "telemetry", "routing", "ingress", "policy", "sidecar-injector". (default `[]`) -|`--helm-chart-dir `||The directory to find the helm charts used to render Istio deployments. -o yaml uses these to render the helm chart locally. (default `"."`) -|`--hyperkube-hub `||The container registry to pull Hyperkube images from (default `"quay.io/coreos/hyperkube"`) -|`--hyperkube-tag `||The tag to use to pull the Hyperkube container (default `"0.4.0"`) -|`--ingress-node-port `||If provided, Istio ingress proxies will run as a NodePort service mapped to the port provided by this flag. Note that this flag is ignored unless the "ingress" feature flag is provided too. (default `0`) -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--out `|`-o`|Output format. Acceptable values are'helm' to produce contents of values.yaml or 'helm' to produces Kubernetes deployments (default `"helm"`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--values `||Path to the Helm values.yaml file used to render YAML deployments locally when --out=yaml. Flag values are ignored in favor of using the file directly. (default `""`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -### Examples - -```bash -istioctl gen-deploy --features routing,policy,sidecar-injector -o helm -``` - - -## istioctl get - -Retrieve policies and rules -```bash -istioctl get [] [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--output `|`-o`|Output format. One of:yaml|short (default `"short"`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -### Examples - -```bash -# List all route rules -istioctl get routerules - -# List all destination policies -istioctl get destinationpolicies - -# Get a specific rule named productpage-default -istioctl get routerule productpage-default - -``` - - -## istioctl kube-inject - - - -kube-inject manually injects envoy sidecar into kubernetes -workloads. Unsupported resources are left unmodified so it is safe to -run kube-inject over a single file that contains multiple Service, -ConfigMap, Deployment, etc. definitions for a complex application. Its -best to do this when the resource is initially created. - -k8s.io/docs/concepts/workloads/pods/pod-overview/#pod-templates is -updated for Job, DaemonSet, ReplicaSet, and Deployment YAML resource -documents. Support for additional pod-based resource types can be -added as necessary. - -The Istio project is continually evolving so the Istio sidecar -configuration may change unannounced. When in doubt re-run istioctl -kube-inject on deployments to get the most up-to-date changes. - -```bash -istioctl kube-inject [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--coreDump`||Enable/Disable core dumps in injected Envoy sidecar (--coreDump=true affects all pods in a node and should only be used the cluster admin) -|`--debug`||Use debug images and settings for the sidecar -|`--emitTemplate`||Emit sidecar template based on parameterized flags -|`--filename `|`-f`|Input Kubernetes resource filename (default `""`) -|`--hub `||Docker hub (default `"unknown"`) -|`--imagePullPolicy `||Sets the container image pull policy. Valid options are Always,IfNotPresent,Never.The default policy is IfNotPresent. (default `"IfNotPresent"`) -|`--includeIPRanges `||Comma separated list of IP ranges in CIDR form. If set, only redirect outbound traffic to Envoy for IP ranges. Otherwise all outbound traffic is redirected (default `""`) -|`--injectConfigFile `||injection configuration filename (default `""`) -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--meshConfigFile `||mesh configuration filename. Takes precedence over --meshConfigMapName if set (default `""`) -|`--meshConfigMapName `||ConfigMap name for Istio mesh configuration, key should be "mesh" (default `"istio"`) -|`--namespace `|`-n`|Config namespace (default `""`) -|`--output `|`-o`|Modified output Kubernetes resource filename (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--setVersionString `||Override version info injected into resource (default `""`) -|`--sidecarProxyUID `||Envoy sidecar UID (default `1337`) -|`--tag `||Docker tag (default `"unknown"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--verbosity `||Runtime verbosity (default `2`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -### Examples - -```bash - -# Update resources on the fly before applying. -kubectl apply -f <(istioctl kube-inject -f ) - -# Create a persistent version of the deployment with Envoy sidecar -# injected. -istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml - -# Update an existing deployment. -kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f - - -``` - - -## istioctl register - -Registers a service instance (e.g. VM) joining the mesh -```bash -istioctl register [name1:]port1 [name2:]port2 ... [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--annotations `|`-a`|List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,test,x=y (default `[]`) -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--labels `|`-l`|List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--serviceaccount `|`-s`|Service account to link to the service (default `"default"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## istioctl replace - -Replace existing policies and rules -```bash -istioctl replace [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--file `|`-f`|Input file with the content of the configuration objects (if not set, command reads from the standard input) (default `""`) -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -### Examples - -```bash -istioctl replace -f example-routing.yaml -``` - - -## istioctl version - -Prints out build version information -```bash -istioctl version [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--istioNamespace `|`-i`|Istio system namespace (default `"istio-system"`) -|`--kubeconfig `|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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 `|`-n`|Config namespace (default `""`) -|`--platform `|`-p`|Istio host platform (default `"kube"`) -|`--short`|`-s`|Displays a short form of the version information -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - diff --git a/_docs/reference/commands/mixc.html b/_docs/reference/commands/mixc.html new file mode 100644 index 0000000000..1d69bb381b --- /dev/null +++ b/_docs/reference/commands/mixc.html @@ -0,0 +1,242 @@ +--- +title: mixc +overview: Utility to trigger direct calls to Mixer's API. +layout: pkg-collateral-docs +--- +

This command lets you interact with a running instance of +Mixer. Note that you need a pretty good understanding of Mixer's +API in order to use this command.

+ + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--trace_jaeger_url <string>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)
--trace_log_spansWhether or not to log trace spans.
--trace_zipkin_url <string>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)
+

mixc check

+

The Check method is used to perform precondition checks and quota allocations. Mixer +expects a set of attributes as input, which it uses, along with +its configuration, to determine which adapters to invoke and with +which parameters in order to perform the checks and allocations.

+
mixc check [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--attributes <string>-aList of name/value auto-sensed attributes specified as name1=value1,name2=value2,... (default ``)
--bool_attributes <string>-bList of name/value bool attributes specified as name1=value1,name2=value2,... (default ``)
--bytes_attributes <string>List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default ``)
--double_attributes <string>-dList of name/value float64 attributes specified as name1=value1,name2=value2,... (default ``)
--duration_attributes <string>List of name/value duration attributes specified as name1=value1,name2=value2,... (default ``)
--int64_attributes <string>-iList of name/value int64 attributes specified as name1=value1,name2=value2,... (default ``)
--mixer <string>-mAddress and port of a running Mixer instance (default `localhost:9091`)
--quotas <string>-qList of quotas to allocate specified as name1=amount1,name2=amount2,... (default ``)
--repeat <int>-rSends the specified number of requests in quick succession (default `1`)
--string_attributes <string>-sList of name/value string attributes specified as name1=value1,name2=value2,... (default ``)
--stringmap_attributes <string>List of name/value string map attributes specified as name1=k1:v1;k2:v2,name2=k3:v3... (default ``)
--timestamp_attributes <string>-tList of name/value timestamp attributes specified as name1=value1,name2=value2,... (default ``)
--trace_jaeger_url <string>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)
--trace_log_spansWhether or not to log trace spans.
--trace_zipkin_url <string>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)
+

mixc report

+

The Report method is used to produce telemetry. Mixer +expects a set of attributes as input, which it uses, along with +its configuration, to determine which adapters to invoke and with +which parameters in order to output the telemetry.

+
mixc report [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--attributes <string>-aList of name/value auto-sensed attributes specified as name1=value1,name2=value2,... (default ``)
--bool_attributes <string>-bList of name/value bool attributes specified as name1=value1,name2=value2,... (default ``)
--bytes_attributes <string>List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default ``)
--double_attributes <string>-dList of name/value float64 attributes specified as name1=value1,name2=value2,... (default ``)
--duration_attributes <string>List of name/value duration attributes specified as name1=value1,name2=value2,... (default ``)
--int64_attributes <string>-iList of name/value int64 attributes specified as name1=value1,name2=value2,... (default ``)
--mixer <string>-mAddress and port of a running Mixer instance (default `localhost:9091`)
--repeat <int>-rSends the specified number of requests in quick succession (default `1`)
--string_attributes <string>-sList of name/value string attributes specified as name1=value1,name2=value2,... (default ``)
--stringmap_attributes <string>List of name/value string map attributes specified as name1=k1:v1;k2:v2,name2=k3:v3... (default ``)
--timestamp_attributes <string>-tList of name/value timestamp attributes specified as name1=value1,name2=value2,... (default ``)
--trace_jaeger_url <string>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)
--trace_log_spansWhether or not to log trace spans.
--trace_zipkin_url <string>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)
+

mixc version

+

Prints out build version information

+
mixc version [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--short-sDisplays a short form of the version information
--trace_jaeger_url <string>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)
--trace_log_spansWhether or not to log trace spans.
--trace_zipkin_url <string>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)
diff --git a/_docs/reference/commands/mixc.md b/_docs/reference/commands/mixc.md deleted file mode 100644 index ab279a5065..0000000000 --- a/_docs/reference/commands/mixc.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: mixc -overview: Utility to trigger direct calls to Mixer's API. -layout: docs ---- -This command lets you interact with a running instance of -Mixer. Note that you need a pretty good understanding of Mixer's -API in order to use this command. - -|Option|Shorthand|Description -|------|---------|----------- -|`--trace_jaeger_url `||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`) -|`--trace_log_spans`||Whether or not to log trace spans. -|`--trace_zipkin_url `||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`) - - -## mixc check - -The Check method is used to perform precondition checks and quota allocations. Mixer -expects a set of attributes as input, which it uses, along with -its configuration, to determine which adapters to invoke and with -which parameters in order to perform the checks and allocations. -```bash -mixc check [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--attributes `|`-a`|List of name/value auto-sensed attributes specified as name1=value1,name2=value2,... (default `""`) -|`--bool_attributes `|`-b`|List of name/value bool attributes specified as name1=value1,name2=value2,... (default `""`) -|`--bytes_attributes `||List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default `""`) -|`--double_attributes `|`-d`|List of name/value float64 attributes specified as name1=value1,name2=value2,... (default `""`) -|`--duration_attributes `||List of name/value duration attributes specified as name1=value1,name2=value2,... (default `""`) -|`--int64_attributes `|`-i`|List of name/value int64 attributes specified as name1=value1,name2=value2,... (default `""`) -|`--mixer `|`-m`|Address and port of a running Mixer instance (default `"localhost:9091"`) -|`--quotas `|`-q`|List of quotas to allocate specified as name1=amount1,name2=amount2,... (default `""`) -|`--repeat `|`-r`|Sends the specified number of requests in quick succession (default `1`) -|`--string_attributes `|`-s`|List of name/value string attributes specified as name1=value1,name2=value2,... (default `""`) -|`--stringmap_attributes `||List of name/value string map attributes specified as name1=k1:v1;k2:v2,name2=k3:v3... (default `""`) -|`--timestamp_attributes `|`-t`|List of name/value timestamp attributes specified as name1=value1,name2=value2,... (default `""`) -|`--trace_jaeger_url `||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`) -|`--trace_log_spans`||Whether or not to log trace spans. -|`--trace_zipkin_url `||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`) - - -## mixc report - -The Report method is used to produce telemetry. Mixer -expects a set of attributes as input, which it uses, along with -its configuration, to determine which adapters to invoke and with -which parameters in order to output the telemetry. -```bash -mixc report [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--attributes `|`-a`|List of name/value auto-sensed attributes specified as name1=value1,name2=value2,... (default `""`) -|`--bool_attributes `|`-b`|List of name/value bool attributes specified as name1=value1,name2=value2,... (default `""`) -|`--bytes_attributes `||List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default `""`) -|`--double_attributes `|`-d`|List of name/value float64 attributes specified as name1=value1,name2=value2,... (default `""`) -|`--duration_attributes `||List of name/value duration attributes specified as name1=value1,name2=value2,... (default `""`) -|`--int64_attributes `|`-i`|List of name/value int64 attributes specified as name1=value1,name2=value2,... (default `""`) -|`--mixer `|`-m`|Address and port of a running Mixer instance (default `"localhost:9091"`) -|`--repeat `|`-r`|Sends the specified number of requests in quick succession (default `1`) -|`--string_attributes `|`-s`|List of name/value string attributes specified as name1=value1,name2=value2,... (default `""`) -|`--stringmap_attributes `||List of name/value string map attributes specified as name1=k1:v1;k2:v2,name2=k3:v3... (default `""`) -|`--timestamp_attributes `|`-t`|List of name/value timestamp attributes specified as name1=value1,name2=value2,... (default `""`) -|`--trace_jaeger_url `||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`) -|`--trace_log_spans`||Whether or not to log trace spans. -|`--trace_zipkin_url `||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`) - - -## mixc version - -Prints out build version information -```bash -mixc version [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--short`|`-s`|Displays a short form of the version information -|`--trace_jaeger_url `||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`) -|`--trace_log_spans`||Whether or not to log trace spans. -|`--trace_zipkin_url `||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`) - diff --git a/_docs/reference/commands/mixs.html b/_docs/reference/commands/mixs.html new file mode 100644 index 0000000000..7888b6dd3e --- /dev/null +++ b/_docs/reference/commands/mixs.html @@ -0,0 +1,663 @@ +--- +title: mixs +overview: Mixer is Istio's abstraction on top of infrastructure backends. +layout: pkg-collateral-docs +--- +

Mixer is Istio's point of integration with infrastructure backends and is the +nexus for policy evaluation and telemetry reporting.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_dir <string>If non-empty, write log files in this directory (default ``)
--logtostderrlog to standard error instead of files
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

mixs crd

+

CRDs (CustomResourceDefinition) available in Mixer

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_dir <string>If non-empty, write log files in this directory (default ``)
--logtostderrlog to standard error instead of files
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

mixs crd adapter

+

List CRDs for available adapters

+
mixs crd adapter [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_dir <string>If non-empty, write log files in this directory (default ``)
--logtostderrlog to standard error instead of files
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

mixs crd all

+

List all CRDs

+
mixs crd all [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_dir <string>If non-empty, write log files in this directory (default ``)
--logtostderrlog to standard error instead of files
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

mixs crd instance

+

List CRDs for available instance kinds (mesh functions)

+
mixs crd instance [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_dir <string>If non-empty, write log files in this directory (default ``)
--logtostderrlog to standard error instead of files
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

mixs probe

+

Check the liveness or readiness of a locally-running server

+
mixs probe [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--interval <duration>Duration used for checking the target file's last modified time. (default `0s`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_dir <string>If non-empty, write log files in this directory (default ``)
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--logtostderrlog to standard error instead of files
--probe-path <string>Path of the file for checking the availability. (default ``)
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

mixs server

+

Starts Mixer as a server

+
mixs server [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--adapterWorkerPoolSize <int>Max number of goroutines in the adapter worker pool (default `1024`)
--alsologtostderrlog to standard error as well as files
--apiWorkerPoolSize <int>Max number of goroutines in the API worker pool (default `1024`)
--configDefaultNamespace <string>Namespace used to store mesh wide configuration. (default `istio-system`)
--configStoreURL <string>URL of the config store. Use k8s://path_to_kubeconfig or fs:// for file system. If path_to_kubeconfig is empty, in-cluster kubeconfig is used. (default ``)
--expressionEvalCacheSize <int>Number of entries in the expression cache (default `1024`)
--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_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_dir <string>If non-empty, write log files in this directory (default ``)
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--logtostderrlog to standard error instead of files
--maxConcurrentStreams <uint>Maximum number of outstanding RPCs per connection (default `1024`)
--maxMessageSize <uint>Maximum size of individual gRPC messages (default `1048576`)
--monitoringPort <uint16>HTTP port to use for the exposing mixer self-monitoring information (default `9093`)
--port <uint16>-pTCP port to use for Mixer's gRPC API (default `9091`)
--readinessProbeInterval <duration>Interval of updating file for the readiness probe. (default `0s`)
--readinessProbePath <string>Path to the file for the readiness probe. (default ``)
--singleThreadedIf true, each request to Mixer will be executed in a single go routine (useful for debugging)
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--trace_jaeger_url <string>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)
--trace_log_spansWhether or not to log trace spans.
--trace_zipkin_url <string>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

mixs validator

+

Runs an https server for validations. Works as an external admission webhook for k8s

+
mixs validator [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--external-admission-webook-name <string>the name of the external admission webhook registration. Needs to be a domain with at least three segments separated by dots. (default `mixer-webhook.istio.io`)
--kubeconfig <string>Use a Kubernetes configuration file instead of in-cluster configuration (default ``)
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_dir <string>If non-empty, write log files in this directory (default ``)
--logtostderrlog to standard error instead of files
--namespace <string>the namespace where this webhook is deployed (default `istio-system`)
--port <int>-pthe port number of the webhook (default `9099`)
--registration-delay <duration>Time to delay webhook registration after starting webhook server (default `5s`)
--secret-name <string>The name of k8s secret where the certificates are stored (default ``)
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--target-namespaces <stringArray>the list of namespaces where changes should be validated. Empty means to validate everything. Used for test only. (default `[]`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
--webhook-name <string>the name of the webhook (default `istio-mixer-webhook`)
+

mixs version

+

Prints out build version information

+
mixs version [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--alsologtostderrlog to standard error as well as files
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_dir <string>If non-empty, write log files in this directory (default ``)
--logtostderrlog to standard error instead of files
--short-sDisplays a short form of the version information
--stderrthreshold <severity>logs at or above this threshold go to stderr (default `2`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
diff --git a/_docs/reference/commands/mixs.md b/_docs/reference/commands/mixs.md deleted file mode 100644 index 8e79f10e0e..0000000000 --- a/_docs/reference/commands/mixs.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -title: mixs -overview: Mixer is Istio's abstraction on top of infrastructure backends. -layout: docs ---- -Mixer is Istio's point of integration with infrastructure backends and is the -nexus for policy evaluation and telemetry reporting. - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--logtostderr`||log to standard error instead of files -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## mixs crd - -CRDs (CustomResourceDefinition) available in Mixer - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--logtostderr`||log to standard error instead of files -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## mixs crd adapter - -List CRDs for available adapters -```bash -mixs crd adapter [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--logtostderr`||log to standard error instead of files -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## mixs crd all - -List all CRDs -```bash -mixs crd all [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--logtostderr`||log to standard error instead of files -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## mixs crd instance - -List CRDs for available instance kinds (mesh functions) -```bash -mixs crd instance [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--logtostderr`||log to standard error instead of files -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## mixs probe - -Check the liveness or readiness of a locally-running server -```bash -mixs probe [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--interval `||Duration used for checking the target file's last modified time. (default `0s`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--logtostderr`||log to standard error instead of files -|`--probe-path `||Path of the file for checking the availability. (default `""`) -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## mixs server - -Starts Mixer as a server -```bash -mixs server [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--adapterWorkerPoolSize `||Max number of goroutines in the adapter worker pool (default `1024`) -|`--alsologtostderr`||log to standard error as well as files -|`--apiWorkerPoolSize `||Max number of goroutines in the API worker pool (default `1024`) -|`--configDefaultNamespace `||Namespace used to store mesh wide configuration. (default `"istio-system"`) -|`--configStoreURL `||URL of the config store. Use k8s://path_to_kubeconfig or fs:// for file system. If path_to_kubeconfig is empty, in-cluster kubeconfig is used. (default `""`) -|`--expressionEvalCacheSize `||Number of entries in the expression cache (default `1024`) -|`--livenessProbeInterval `||Interval of updating file for the liveness probe. (default `0s`) -|`--livenessProbePath `||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_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--logtostderr`||log to standard error instead of files -|`--maxConcurrentStreams `||Maximum number of outstanding RPCs per connection (default `1024`) -|`--maxMessageSize `||Maximum size of individual gRPC messages (default `1048576`) -|`--monitoringPort `||HTTP port to use for the exposing mixer self-monitoring information (default `9093`) -|`--port `|`-p`|TCP port to use for Mixer's gRPC API (default `9091`) -|`--readinessProbeInterval `||Interval of updating file for the readiness probe. (default `0s`) -|`--readinessProbePath `||Path to the file for the readiness probe. (default `""`) -|`--singleThreaded`||If true, each request to Mixer will be executed in a single go routine (useful for debugging) -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--trace_jaeger_url `||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`) -|`--trace_log_spans`||Whether or not to log trace spans. -|`--trace_zipkin_url `||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## mixs validator - -Runs an https server for validations. Works as an external admission webhook for k8s -```bash -mixs validator [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--external-admission-webook-name `||the name of the external admission webhook registration. Needs to be a domain with at least three segments separated by dots. (default `"mixer-webhook.istio.io"`) -|`--kubeconfig `||Use a Kubernetes configuration file instead of in-cluster configuration (default `""`) -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--logtostderr`||log to standard error instead of files -|`--namespace `||the namespace where this webhook is deployed (default `"istio-system"`) -|`--port `|`-p`|the port number of the webhook (default `9099`) -|`--registration-delay `||Time to delay webhook registration after starting webhook server (default `5s`) -|`--secret-name `||The name of k8s secret where the certificates are stored (default `""`) -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--target-namespaces `||the list of namespaces where changes should be validated. Empty means to validate everything. Used for test only. (default `[]`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) -|`--webhook-name `||the name of the webhook (default `"istio-mixer-webhook"`) - - -## mixs version - -Prints out build version information -```bash -mixs version [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--alsologtostderr`||log to standard error as well as files -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_dir `||If non-empty, write log files in this directory (default `""`) -|`--logtostderr`||log to standard error instead of files -|`--short`|`-s`|Displays a short form of the version information -|`--stderrthreshold `||logs at or above this threshold go to stderr (default `2`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - diff --git a/_docs/reference/commands/node_agent.html b/_docs/reference/commands/node_agent.html new file mode 100644 index 0000000000..7bd17f12b3 --- /dev/null +++ b/_docs/reference/commands/node_agent.html @@ -0,0 +1,180 @@ +--- +title: node_agent +overview: Istio security per-node agent +layout: pkg-collateral-docs +--- +

Istio security per-node agent

+
node_agent [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--aws-root-cert <string>Root Certificate file in AWS environment (default `/etc/certs/root-cert.pem`)
--ca-address <string>Istio CA address (default `istio-ca:8060`)
--env <string>Node Environment : onprem | gcp | aws (default `onprem`)
--gcp-ca-address <string>Istio CA address in GCP environment (default `istio-ca:8060`)
--gcp-root-cert <string>Root Certificate file in GCP environment (default `/etc/certs/root-cert.pem`)
--key-size <int>Size of generated private key (default `2048`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--onprem-cert-chain <string>Node Agent identity cert file in on premise environment (default `/etc/certs/cert-chain.pem`)
--onprem-key <string>Node identity private key file in on premise environment (default `/etc/certs/key.pem`)
--onprem-root-cert <string>Root Certificate file in on premise environment (default `/etc/certs/root-cert.pem`)
--org <string>Organization for the cert (default ``)
--workload-cert-ttl <duration>The requested TTL for the workload (default `12h0m0s`)
+

node_agent version

+

Prints out build version information

+
node_agent version [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--short-sDisplays a short form of the version information
diff --git a/_docs/reference/commands/node_agent.md b/_docs/reference/commands/node_agent.md deleted file mode 100644 index 251584b680..0000000000 --- a/_docs/reference/commands/node_agent.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: node_agent -overview: Istio security per-node agent -layout: docs ---- -Istio security per-node agent -```bash -node_agent [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--aws-root-cert `||Root Certificate file in AWS environment (default `"/etc/certs/root-cert.pem"`) -|`--ca-address `||Istio CA address (default `"istio-ca:8060"`) -|`--env `||Node Environment : onprem | gcp | aws (default `"onprem"`) -|`--gcp-ca-address `||Istio CA address in GCP environment (default `"istio-ca:8060"`) -|`--gcp-root-cert `||Root Certificate file in GCP environment (default `"/etc/certs/root-cert.pem"`) -|`--key-size `||Size of generated private key (default `2048`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--onprem-cert-chain `||Node Agent identity cert file in on premise environment (default `"/etc/certs/cert-chain.pem"`) -|`--onprem-key `||Node identity private key file in on premise environment (default `"/etc/certs/key.pem"`) -|`--onprem-root-cert `||Root Certificate file in on premise environment (default `"/etc/certs/root-cert.pem"`) -|`--org `||Organization for the cert (default `""`) -|`--workload-cert-ttl `||The requested TTL for the workload (default `12h0m0s`) - - -## node_agent version - -Prints out build version information -```bash -node_agent version [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--short`|`-s`|Displays a short form of the version information - diff --git a/_docs/reference/commands/pilot-agent.html b/_docs/reference/commands/pilot-agent.html new file mode 100644 index 0000000000..a7d9670072 --- /dev/null +++ b/_docs/reference/commands/pilot-agent.html @@ -0,0 +1,321 @@ +--- +title: pilot-agent +overview: Istio Pilot agent +layout: pkg-collateral-docs +--- +

Istio Pilot provides management plane functionality to the Istio service mesh and Istio Mixer.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

pilot-agent proxy

+

Envoy proxy agent

+
pilot-agent proxy [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--availabilityZone <string>Availability zone (default ``)
--binaryPath <string>Path to the proxy binary (default `/usr/local/bin/envoy`)
--configPath <string>Path to the generated configuration file directory (default `/etc/istio/proxy`)
--connectTimeout <duration>Connection timeout used by Envoy for supporting services (default `1s`)
--controlPlaneAuthPolicy <string>Control Plane Authentication Policy (default `NONE`)
--customConfigFile <string>Path to the generated configuration file directory (default ``)
--discoveryAddress <string>Address of the discovery service exposing xDS (e.g. istio-pilot:8080) (default `istio-pilot:15003`)
--discoveryRefreshDelay <duration>Polling interval for service discovery (used by EDS, CDS, LDS, but not RDS) (default `1s`)
--domain <string>DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local (default ``)
--drainDuration <duration>The time in seconds that Envoy will drain connections during a hot restart (default `2s`)
--id <string>Proxy unique ID. If not provided uses ${POD_NAME}.${POD_NAMESPACE} from environment variables (default ``)
--ip <string>Proxy IP address. If not provided uses ${INSTANCE_IP} environment variable. (default ``)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--parentShutdownDuration <duration>The time in seconds that Envoy will wait before shutting down the parent process during a hot restart (default `3s`)
--proxyAdminPort <int>Port on which Envoy should listen for administrative commands (default `15000`)
--proxyLogLevel <string>The log level used to start the Envoy proxy (choose from {trace, debug, info, warn, err, critical, off}) (default `info`)
--serviceCluster <string>Service cluster (default `istio-proxy`)
--serviceregistry <string>Select the platform for service registry, options are {Kubernetes, Consul, Eureka} (default `Kubernetes`)
--statsdUdpAddress <string>IP Address and Port of a statsd UDP listener (e.g. 10.75.241.127:9125) (default ``)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
--zipkinAddress <string>Address of the Zipkin service (e.g. zipkin:9411) (default ``)
+

pilot-agent version

+

Prints out build version information

+
pilot-agent version [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--short-sDisplays a short form of the version information
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
diff --git a/_docs/reference/commands/pilot-agent.md b/_docs/reference/commands/pilot-agent.md deleted file mode 100644 index ae72d165f4..0000000000 --- a/_docs/reference/commands/pilot-agent.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: pilot-agent -overview: Istio Pilot agent -layout: docs ---- -Istio Pilot provides management plane functionality to the Istio service mesh and Istio Mixer. - -|Option|Shorthand|Description -|------|---------|----------- -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## pilot-agent proxy - -Envoy proxy agent -```bash -pilot-agent proxy [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--availabilityZone `||Availability zone (default `""`) -|`--binaryPath `||Path to the proxy binary (default `"/usr/local/bin/envoy"`) -|`--configPath `||Path to the generated configuration file directory (default `"/etc/istio/proxy"`) -|`--connectTimeout `||Connection timeout used by Envoy for supporting services (default `1s`) -|`--controlPlaneAuthPolicy `||Control Plane Authentication Policy (default `"NONE"`) -|`--customConfigFile `||Path to the generated configuration file directory (default `""`) -|`--discoveryAddress `||Address of the discovery service exposing xDS (e.g. istio-pilot:8080) (default `"istio-pilot:15003"`) -|`--discoveryRefreshDelay `||Polling interval for service discovery (used by EDS, CDS, LDS, but not RDS) (default `1s`) -|`--domain `||DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local (default `""`) -|`--drainDuration `||The time in seconds that Envoy will drain connections during a hot restart (default `2s`) -|`--id `||Proxy unique ID. If not provided uses ${POD_NAME}.${POD_NAMESPACE} from environment variables (default `""`) -|`--ip `||Proxy IP address. If not provided uses ${INSTANCE_IP} environment variable. (default `""`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--parentShutdownDuration `||The time in seconds that Envoy will wait before shutting down the parent process during a hot restart (default `3s`) -|`--proxyAdminPort `||Port on which Envoy should listen for administrative commands (default `15000`) -|`--proxyLogLevel `||The log level used to start the Envoy proxy (choose from {trace, debug, info, warn, err, critical, off}) (default `"info"`) -|`--serviceCluster `||Service cluster (default `"istio-proxy"`) -|`--serviceregistry `||Select the platform for service registry, options are {Kubernetes, Consul, Eureka} (default `"Kubernetes"`) -|`--statsdUdpAddress `||IP Address and Port of a statsd UDP listener (e.g. 10.75.241.127:9125) (default `""`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) -|`--zipkinAddress `||Address of the Zipkin service (e.g. zipkin:9411) (default `""`) - - -## pilot-agent version - -Prints out build version information -```bash -pilot-agent version [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--short`|`-s`|Displays a short form of the version information -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - diff --git a/_docs/reference/commands/pilot-discovery.html b/_docs/reference/commands/pilot-discovery.html new file mode 100644 index 0000000000..b08ea26c58 --- /dev/null +++ b/_docs/reference/commands/pilot-discovery.html @@ -0,0 +1,346 @@ +--- +title: pilot-discovery +overview: Istio Pilot +layout: pkg-collateral-docs +--- +

Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

pilot-discovery discovery

+

Start Istio proxy discovery service

+
pilot-discovery discovery [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--admission-registration-delay <duration>Time to delay webhook registration after starting webhook server (default `0s`)
--admission-secret <string>Name of k8s secret for pilot webhook certs (default `pilot-webhook`)
--admission-service <string>Service name the admission controller uses during registration (default `istio-pilot`)
--admission-service-port <int>HTTPS port of the admission service. Must be 443 if service has more than one port (default `443`)
--admission-webhook-name <string>Webhook name for Pilot admission controller (default `pilot-webhook.istio.io`)
--appNamespace <string>-aRestrict the applications namespace the controller manages; if not set, controller watches all namespaces (default ``)
--cfConfig <string>Cloud Foundry config file (default ``)
--configDir <string>Directory to watch for updates to config yaml files. If specified, the files will be used as the source of config, rather than a CRD client. (default ``)
--consulconfig <string>Consul Config file for discovery (default ``)
--consulserverInterval <duration>Interval (in seconds) for polling the Consul service registry (default `2s`)
--consulserverURL <string>URL for the Consul server (default ``)
--discovery_cacheEnable caching discovery service responses
--domain <string>DNS domain suffix (default `cluster.local`)
--eurekaserverInterval <duration>Interval (in seconds) for polling the Eureka service registry (default `2s`)
--eurekaserverURL <string>URL for the Eureka server (default ``)
--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_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--meshConfig <string>File name for Istio mesh configuration. If not specified, a default mesh will be used. (default `/etc/istio/config/mesh`)
--monitoringPort <int>HTTP port to use for the exposing pilot self-monitoring information (default `9093`)
--namespace <string>-nSelect a namespace where the controller resides. If not set, uses ${POD_NAMESPACE} environment variable (default ``)
--port <int>Discovery service port (default `8080`)
--profileEnable profiling via web interface host:port/debug/pprof
--registries <stringSlice>Comma separated list of platform service registries to read from (choose one or more from {Kubernetes, Consul, Eureka, CloudFoundry, Mock}) (default `[Kubernetes]`)
--resync <duration>Controller resync interval (default `1m0s`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
--webhookEndpoint <string>Webhook API endpoint (supports DNS, IP, and unix domain socket. (default ``)
+

pilot-discovery version

+

Prints out build version information

+
pilot-discovery version [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--short-sDisplays a short form of the version information
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
diff --git a/_docs/reference/commands/pilot-discovery.md b/_docs/reference/commands/pilot-discovery.md deleted file mode 100644 index eb72247c40..0000000000 --- a/_docs/reference/commands/pilot-discovery.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: pilot-discovery -overview: Istio Pilot -layout: docs ---- -Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh. - -|Option|Shorthand|Description -|------|---------|----------- -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## pilot-discovery discovery - -Start Istio proxy discovery service -```bash -pilot-discovery discovery [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--admission-registration-delay `||Time to delay webhook registration after starting webhook server (default `0s`) -|`--admission-secret `||Name of k8s secret for pilot webhook certs (default `"pilot-webhook"`) -|`--admission-service `||Service name the admission controller uses during registration (default `"istio-pilot"`) -|`--admission-service-port `||HTTPS port of the admission service. Must be 443 if service has more than one port (default `443`) -|`--admission-webhook-name `||Webhook name for Pilot admission controller (default `"pilot-webhook.istio.io"`) -|`--appNamespace `|`-a`|Restrict the applications namespace the controller manages; if not set, controller watches all namespaces (default `""`) -|`--cfConfig `||Cloud Foundry config file (default `""`) -|`--configDir `||Directory to watch for updates to config yaml files. If specified, the files will be used as the source of config, rather than a CRD client. (default `""`) -|`--consulconfig `||Consul Config file for discovery (default `""`) -|`--consulserverInterval `||Interval (in seconds) for polling the Consul service registry (default `2s`) -|`--consulserverURL `||URL for the Consul server (default `""`) -|`--discovery_cache`||Enable caching discovery service responses -|`--domain `||DNS domain suffix (default `"cluster.local"`) -|`--eurekaserverInterval `||Interval (in seconds) for polling the Eureka service registry (default `2s`) -|`--eurekaserverURL `||URL for the Eureka server (default `""`) -|`--kubeconfig `||Use a Kubernetes configuration file instead of in-cluster configuration (default `""`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--meshConfig `||File name for Istio mesh configuration. If not specified, a default mesh will be used. (default `"/etc/istio/config/mesh"`) -|`--monitoringPort `||HTTP port to use for the exposing pilot self-monitoring information (default `9093`) -|`--namespace `|`-n`|Select a namespace where the controller resides. If not set, uses ${POD_NAMESPACE} environment variable (default `""`) -|`--port `||Discovery service port (default `8080`) -|`--profile`||Enable profiling via web interface host:port/debug/pprof -|`--registries `||Comma separated list of platform service registries to read from (choose one or more from {Kubernetes, Consul, Eureka, CloudFoundry, Mock}) (default `[Kubernetes]`) -|`--resync `||Controller resync interval (default `1m0s`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) -|`--webhookEndpoint `||Webhook API endpoint (supports DNS, IP, and unix domain socket. (default `""`) - - -## pilot-discovery version - -Prints out build version information -```bash -pilot-discovery version [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--short`|`-s`|Displays a short form of the version information -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - diff --git a/_docs/reference/commands/sidecar-injector.html b/_docs/reference/commands/sidecar-injector.html new file mode 100644 index 0000000000..95c99b97c3 --- /dev/null +++ b/_docs/reference/commands/sidecar-injector.html @@ -0,0 +1,205 @@ +--- +title: sidecar-injector +overview: Kubernetes webhook for automatic Istio sidecar injection +layout: pkg-collateral-docs +--- +

Kubernetes webhook for automatic Istio sidecar injection

+
sidecar-injector [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--injectConfig <string>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--meshConfig <string>File containing the Istio mesh configuration (default `/etc/istio/config/mesh`)
--port <int>Webhook port (default `443`)
--tlsCertFile <string>File containing the x509 Certificate for HTTPS. (default `/etc/istio/certs/cert.pem`)
--tlsKeyFile <string>File containing the x509 private key matching --tlsCertFile. (default `/etc/istio/certs/key.pem`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
+

sidecar-injector version

+

Prints out build version information

+
sidecar-injector version [flags]
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--injectConfig <string>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_backtrace_at <traceLocation>when logging hits line file:N, emit a stack trace (default `:0`)
--log_callersInclude caller information, useful for debugging
--log_output_level <string>The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (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>The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
--meshConfig <string>File containing the Istio mesh configuration (default `/etc/istio/config/mesh`)
--port <int>Webhook port (default `443`)
--short-sDisplays a short form of the version information
--tlsCertFile <string>File containing the x509 Certificate for HTTPS. (default `/etc/istio/certs/cert.pem`)
--tlsKeyFile <string>File containing the x509 private key matching --tlsCertFile. (default `/etc/istio/certs/key.pem`)
--v <Level>-vlog level for V logs (default `0`)
--vmodule <moduleSpec>comma-separated list of pattern=N settings for file-filtered logging (default ``)
diff --git a/_docs/reference/commands/sidecar-injector.md b/_docs/reference/commands/sidecar-injector.md deleted file mode 100644 index 84aa44d133..0000000000 --- a/_docs/reference/commands/sidecar-injector.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: sidecar-injector -overview: Kubernetes webhook for automatic Istio sidecar injection -layout: docs ---- -Kubernetes webhook for automatic Istio sidecar injection -```bash -sidecar-injector [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--injectConfig `||File containing the Istio sidecar injection configuration and template (default `"/etc/istio/inject/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--meshConfig `||File containing the Istio mesh configuration (default `"/etc/istio/config/mesh"`) -|`--port `||Webhook port (default `443`) -|`--tlsCertFile `||File containing the x509 Certificate for HTTPS. (default `"/etc/istio/certs/cert.pem"`) -|`--tlsKeyFile `||File containing the x509 private key matching --tlsCertFile. (default `"/etc/istio/certs/key.pem"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - - -## sidecar-injector version - -Prints out build version information -```bash -sidecar-injector version [flags] -``` - - -|Option|Shorthand|Description -|------|---------|----------- -|`--injectConfig `||File containing the Istio sidecar injection configuration and template (default `"/etc/istio/inject/config"`) -|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format -|`--log_backtrace_at `||when logging hits line file:N, emit a stack trace (default `:0`) -|`--log_callers`||Include caller information, useful for debugging -|`--log_output_level `||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`) -|`--log_rotate `||The path for the optional rotating log file (default `""`) -|`--log_rotate_max_age `||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 `||The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`) -|`--log_rotate_max_size `||The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`) -|`--log_stacktrace_level `||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (default `"none"`) -|`--log_target `||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]`) -|`--meshConfig `||File containing the Istio mesh configuration (default `"/etc/istio/config/mesh"`) -|`--port `||Webhook port (default `443`) -|`--short`|`-s`|Displays a short form of the version information -|`--tlsCertFile `||File containing the x509 Certificate for HTTPS. (default `"/etc/istio/certs/cert.pem"`) -|`--tlsKeyFile `||File containing the x509 private key matching --tlsCertFile. (default `"/etc/istio/certs/key.pem"`) -|`--v `|`-v`|log level for V logs (default `0`) -|`--vmodule `||comma-separated list of pattern=N settings for file-filtered logging (default ``) - diff --git a/_docs/reference/config/istio.mesh.v1alpha1.html b/_docs/reference/config/istio.mesh.v1alpha1.html index 43651a02b9..a28ab9191c 100644 --- a/_docs/reference/config/istio.mesh.v1alpha1.html +++ b/_docs/reference/config/istio.mesh.v1alpha1.html @@ -13,7 +13,7 @@ different scopes (mesh, service …), and the most narrow scope with non-INHERIT value will be used. Mesh policy cannot be INHERIT.

- +
@@ -46,7 +46,7 @@ policy.

TODO AuthPolicy needs to be removed and merged with AuthPolicy defined above

-
Name Description
+
@@ -69,7 +69,7 @@ policy.

MeshConfig.IngressControllerMode

-
Name Description
+
@@ -111,7 +111,7 @@ cloud-provided ingress controller).

MeshConfig defines mesh-wide variables shared by all Envoy instances in the Istio service mesh.

-
Name Description
+
@@ -262,7 +262,7 @@ Instead, use service-level annotations to overwrite the authentication policy.

ProxyConfig defines variables for individual Envoy instances.

-
Field Type
+
@@ -412,13 +412,11 @@ Increase the value of this field if you find that the metrics from Envoys are tr - - diff --git a/_docs/reference/config/istio.mixer.v1.config.client.html b/_docs/reference/config/istio.mixer.v1.config.client.html index 153e5339d2..8524c2d66a 100644 --- a/_docs/reference/config/istio.mixer.v1.config.client.html +++ b/_docs/reference/config/istio.mixer.v1.config.client.html @@ -7,7 +7,7 @@ layout: protoc-gen-docs

Enumerations

TransportConfig.NetworkFailPolicy

-
Field Type
concurrency int32 -

The number of worker threads to run in Envoy. Default value is number of cores on the machine.

+

The number of worker threads to run. Default value is number of cores on the machine.
+
@@ -37,7 +37,7 @@ layout: protoc-gen-docs

See https://swagger.io/docs/specification/authentication/api-keys for a general overview of API keys as defined by OpenAPI.

-
Name Description
+
@@ -96,7 +96,7 @@ Cookie: X-API-KEY=abcdef12345

Specifies a match clause to match Istio attributes

-
Field Type
+
@@ -125,7 +125,7 @@ Each map element specifies one condition to match.

Determines how to apply auth policies for individual requests.

-
Field Type
+
@@ -168,7 +168,7 @@ include a JWT.

EndUserAuthenticationPolicySpecBinding defines the binding between EndUserAuthenticationPolicySpecs and one or more IstioService.

-
Field Type
+
@@ -196,7 +196,7 @@ that should be mapped to the specified service(s).

EndUserAuthenticationPolicySpecReference

-
Field Type
+
@@ -270,7 +270,7 @@ spec: - query: api-key -
Field Type
+
@@ -332,7 +332,7 @@ spec: namespace: default -
Field Type
+
@@ -373,7 +373,7 @@ generated.

uriTemplate: /foo/bar -
Field Type
+
@@ -443,7 +443,7 @@ HTTPAPISpecReference for service foo in namespace bar. namespace: bar -
Field Type
+
@@ -473,7 +473,7 @@ HTTPAPISpecBinding’s metadata namespace field.

Defines the client config for HTTP.

-
Field Type
+
@@ -533,7 +533,7 @@ includes the “source.ip” and “source.uid” attributes.

-
Field Type
+
@@ -600,7 +600,7 @@ audiences: jwks_uri: https://example.com/.well-known/jwks.json -
Field Type
+
@@ -706,7 +706,7 @@ locations are tried in order:

https://tools.ietf.org/html/rfc6750#section-2.3) -
Field Type
+
@@ -741,7 +741,7 @@ query parameter name.

Specifies a quota to use with quota name and amount.

-
Field Type
+
@@ -770,7 +770,7 @@ query parameter name.

Specifies a rule with list of matches and list of quotas. If any clause matched, the list of quotas will be used.

-
Field Type
+
@@ -799,7 +799,7 @@ If any of match is true, it is matched.

Determines the quotas used for individual requests.

-
Field Type
+
@@ -820,7 +820,7 @@ If any of match is true, it is matched.

QuotaSpecBinding defines the binding between QuotaSpecs and one or more IstioService.

-
Field Type
+
@@ -848,7 +848,7 @@ conditions defined in the QuotaSpecs should not overlap.

QuotaSpecBinding.QuotaSpecReference

-
Field Type
+
@@ -878,7 +878,7 @@ metadata namespace field.

Defines the per-service client configuration.

-
Field Type
+
@@ -940,7 +940,7 @@ typically includes the “destination.service” attribute.

Describes how to match a given string in HTTP headers. Match is case-sensitive.

-
Field Type
+
@@ -976,7 +976,7 @@ case-sensitive.

Defines the client config for TCP.

-
Field Type
+
@@ -1041,7 +1041,7 @@ should not be less than 1 second, otherwise it will be reset to 1 second.

Defines the transport config on how to call Mixer.

-
Field Type
+
diff --git a/_docs/reference/config/istio.mixer.v1.config.html b/_docs/reference/config/istio.mixer.v1.config.html index a4d354a99d..5c0d16f724 100644 --- a/_docs/reference/config/istio.mixer.v1.config.html +++ b/_docs/reference/config/istio.mixer.v1.config.html @@ -18,7 +18,7 @@ constructed using the instance ‘RequestCountByService’

- RequestCountByService

-
Field Type
+
@@ -51,7 +51,7 @@ The constructed objects are then passed to the handler referenced w

AttributeManifest describes a set of Attributes produced by some component of an Istio deployment.

-
Field Type
+
@@ -142,7 +142,7 @@ REST APIs. The design is to map one attribute to one HTTP header, the attribute name and value becomes the HTTP header name and value. The actual encoding scheme will be decided later.

-
Field Type
+
@@ -180,7 +180,7 @@ adapter: prometheus params:

-
Field Type
+
@@ -238,7 +238,7 @@ Instances produced with this instance can be referenced by Act destination_ip: destination.ip

-
Field Type
+
@@ -291,7 +291,7 @@ instance constructed using the ‘RequestCountByService’ instance.

- RequestCountByService

-
Field Type
+
@@ -338,7 +338,7 @@ with the proto support for the language.

The JSON representation for Struct is JSON object.

-
Field Type
+
diff --git a/_docs/reference/config/istio.rbac.v1alpha1.html b/_docs/reference/config/istio.rbac.v1alpha1.html index aab3239ffc..2cdb933fc8 100644 --- a/_docs/reference/config/istio.rbac.v1alpha1.html +++ b/_docs/reference/config/istio.rbac.v1alpha1.html @@ -92,7 +92,7 @@ spec:

AccessRule defines a permission to access a list of services.

-
Field Type
+
@@ -152,7 +152,7 @@ The above ServiceRole examples shows an example of constraint “version&rdq one of the “properties” in the “action” part of the “authorization” template (https://github.com/istio/istio/blob/master/mixer/template/authorization/template.proto).

-
Field Type
+
@@ -184,7 +184,7 @@ or “alpha2” (suffix match).

RoleRef refers to a role object.

-
Field Type
+
@@ -217,7 +217,7 @@ object.

This represent the “Spec” part of the ServiceRole object. The name and namespace of the ServiceRole is specified in “metadata” section of the ServiceRole object.

-
Field Type
+
@@ -240,7 +240,7 @@ This represents the “Spec” part of the ServiceRoleBinding object. Th of the ServiceRoleBinding is specified in “metadata” section of the ServiceRoleBinding object.

-
Field Type
+
@@ -271,7 +271,7 @@ a group or identified by a set of “properties”. The name of the &ldq the “properties” in the “subject” part of the “authorization” template (https://github.com/istio/istio/blob/master/mixer/template/authorization/template.proto).

-
Field Type
+
diff --git a/_docs/reference/config/istio.routing.v1alpha1.html b/_docs/reference/config/istio.routing.v1alpha1.html index 8bc592fd18..e44b52fd93 100644 --- a/_docs/reference/config/istio.routing.v1alpha1.html +++ b/_docs/reference/config/istio.routing.v1alpha1.html @@ -40,7 +40,7 @@ decouple itself from the evolution of dependent services.

Load balancing algorithms supported by Envoy.

-
Field Type
+
@@ -85,7 +85,7 @@ See Envoy’s and outlier detection for more details.

-
Name Description
+
@@ -151,7 +151,7 @@ spec: httpDetectionInterval: 5m -
Field Type
+
@@ -269,7 +269,7 @@ spec: maxAge: "1d" -
Field Type
+
@@ -383,7 +383,7 @@ tagged instances are explicitly routed to. In other words, for every destination policy defined, at least one route rule must refer to the service version indicated in the destination policy.

-
Field Type
+
@@ -457,7 +457,7 @@ spec: weight: 75 -
Field Type
+
@@ -523,7 +523,7 @@ spec: protocol: https -
Field Type
+
@@ -570,7 +570,7 @@ These dedicated egress nodes could then be more closely monitored for security v

Port describes the properties of a specific TCP port of an external service.

-
Field Type
+
@@ -606,7 +606,7 @@ proxying of requests. A fault rule MUST HAVE delay or abort or both.

Note: Delay and abort faults are independent of one another, even if both are specified simultaneously.

-
Field Type
+
@@ -657,7 +657,7 @@ return to the caller. The optional percent field, a value between 0 and 100, is used to only abort a certain percentage of requests. If not specified, all requests are aborted.

-
Field Type
+
@@ -728,7 +728,7 @@ seconds. An optional percent field, a value between 0 and 100, can be used to only delay a certain percentage of requests. If left unspecified, all request will be delayed.

-
Field Type
+
@@ -794,7 +794,7 @@ spec: authority: bookratings.default.svc.cluster.local -
Field Type
+
@@ -842,7 +842,7 @@ spec: perTryTimeout: 2s -
Field Type
+
@@ -866,7 +866,7 @@ spec:

HTTPRetry.SimpleRetryPolicy

-
Field Type
+
@@ -927,7 +927,7 @@ spec: version: v1 -
Field Type
+
@@ -972,7 +972,7 @@ spec: timeout: 10s -
Field Type
+
@@ -996,7 +996,7 @@ spec:

HTTPTimeout.SimpleTimeoutPolicy

-
Field Type
+
@@ -1039,7 +1039,7 @@ also effective.

WARNING: This API is experimental and under active development

-
Field Type
+
@@ -1117,7 +1117,7 @@ of the service and therefore the IstioService’s labels field MUST be empty The FQDN of the service is composed from the name, namespace, and implementation-specific domain suffix (e.g. on Kubernetes, “reviews” + “default” + “svc.cluster.local” -> “reviews.default.svc.cluster.local”).

-
Field Type
+
@@ -1178,7 +1178,7 @@ end). Bandwidth throttling for failure testing should not be confused with the rate limiting policy enforcement provided by the Mixer component. L4 fault injection is not supported at the moment. –)

-
Field Type
+
@@ -1209,7 +1209,7 @@ We first throttle (if set) and then terminate the connection.

Abruptly reset (terminate) the Tcp connection after it has been established, emulating remote server crash or link failure.

-
Field Type
+
@@ -1238,7 +1238,7 @@ express time interval related configs.

Bandwidth throttling for Tcp and Udp connections

-
Field Type
+
@@ -1304,7 +1304,7 @@ will be throttled for its lifetime.

(– L4 connection match attributes. Note that L4 connection matching support is incomplete. –)

-
Field Type
+
@@ -1348,7 +1348,7 @@ spec: name: RANDOM -
Field Type
+
@@ -1405,7 +1405,7 @@ spec:

MatchCondition CANNOT be empty. At least one source or request header must be specified.

-
Field Type
+
@@ -1449,7 +1449,7 @@ request header must be specified.

MatchRequest specifies the attributes of an HTTP request to be used for matching a request.

-
Field Type
+
@@ -1511,7 +1511,7 @@ spec: weight: 100 -
Field Type
+
@@ -1665,7 +1665,7 @@ destnation service.

Describes how to match a given string in HTTP headers. Match is case-sensitive.

-
Field Type
+
diff --git a/_docs/reference/config/mixer/istio.mixer.v1.config.descriptor.html b/_docs/reference/config/mixer/istio.mixer.v1.config.descriptor.html index 440fca9c39..4d18620ac4 100644 --- a/_docs/reference/config/mixer/istio.mixer.v1.config.descriptor.html +++ b/_docs/reference/config/mixer/istio.mixer.v1.config.descriptor.html @@ -11,7 +11,7 @@ are used to describe the type of Attributes at run time, describe the type of the result of evaluating an expression, and to describe the runtime type of fields of other descriptors.

-
Field Type
+
diff --git a/_docs/reference/config/mixer/istio.mixer.v1.template.html b/_docs/reference/config/mixer/istio.mixer.v1.template.html index c2da89775c..7e3b78f15c 100644 --- a/_docs/reference/config/mixer/istio.mixer.v1.template.html +++ b/_docs/reference/config/mixer/istio.mixer.v1.template.html @@ -12,7 +12,7 @@ field datatype to express the equivalent ValueType for the expressions the field

Specifies the varity of the the Template.

-
Name Description
+
diff --git a/_docs/setup/kubernetes/quick-start.md b/_docs/setup/kubernetes/quick-start.md index d0cfdbb811..307f152b00 100644 --- a/_docs/setup/kubernetes/quick-start.md +++ b/_docs/setup/kubernetes/quick-start.md @@ -174,7 +174,7 @@ kubectl create -n -f .yaml ``` If you do not have the Istio-sidecar-injector installed, you must -use [istioctl kube-inject]({{home}}/docs/reference/commands/istioctl.html#istioctl-kube-inject) to +use [istioctl kube-inject]({{home}}/docs/reference/commands/istioctl.html#istioctl kube-inject) to manuallly inject Envoy containers in your application pods before deploying them: ```bash kubectl create -f <(istioctl kube-inject -f .yaml) diff --git a/_docs/tasks/traffic-management/egress.md b/_docs/tasks/traffic-management/egress.md index 1db2fbc6f3..25ada4444d 100644 --- a/_docs/tasks/traffic-management/egress.md +++ b/_docs/tasks/traffic-management/egress.md @@ -165,7 +165,7 @@ or if you want to completely bypass Istio for a specific IP range, you will need to configure the source service's Envoy sidecar to prevent it from [intercepting]({{home}}/docs/concepts/traffic-management/request-routing.html#communication-between-services) the external requests. This can be done using the `--includeIPRanges` option of -[istioctl kube-inject]({{home}}/docs/reference/commands/istioctl.html#istioctl-kube-inject) +[istioctl kube-inject]({{home}}/docs/reference/commands/istioctl.html#istioctl kube-inject) when starting the service. The simplest way to use the `--includeIPRanges` option is to pass it the IP range(s) diff --git a/_layouts/pkg-collateral-docs.html b/_layouts/pkg-collateral-docs.html new file mode 100644 index 0000000000..147a6590df --- /dev/null +++ b/_layouts/pkg-collateral-docs.html @@ -0,0 +1,4 @@ +--- +layout: docs +--- +{{content}} diff --git a/scripts/grab_reference_docs.sh b/scripts/grab_reference_docs.sh index 75b26f1d25..b63c1a73b4 100755 --- a/scripts/grab_reference_docs.sh +++ b/scripts/grab_reference_docs.sh @@ -49,9 +49,10 @@ get_command_doc() { COMMAND_PATH=$1 COMMAND=$2 - cd $COMMAND_PATH + pushd $COMMAND_PATH go build - ./$COMMAND collateral -o $COMMAND_DIR --markdown + ./$COMMAND collateral -o $COMMAND_DIR --jekyll_html + popd } # First delete all the current generated files so that any stale files are removed
Name Description