From a95018f62e2c2cabaeed746b05f4c4c4ddce1fc5 Mon Sep 17 00:00:00 2001 From: Eric Van Norman Date: Wed, 29 Apr 2020 12:47:10 -0500 Subject: [PATCH] Another Manual doc update (#7183) --- .../reference/commands/istioctl/index.html | 89 ++++++++----------- .../docs/reference/commands/mixs/index.html | 12 +-- .../reference/commands/operator/index.html | 12 +-- .../reference/commands/pilot-agent/index.html | 12 +-- .../commands/pilot-discovery/index.html | 27 ++++-- .../accesslogpolicy/index.html | 62 +++++++++++++ .../attributegen/index.html | 84 ++++++++--------- .../metadata_exchange/index.html | 3 +- .../proxy_extensions/stackdriver/index.html | 2 - 9 files changed, 179 insertions(+), 124 deletions(-) create mode 100644 content/en/docs/reference/config/proxy_extensions/accesslogpolicy/index.html rename content/en/docs/reference/config/{ => proxy_extensions}/attributegen/index.html (98%) diff --git a/content/en/docs/reference/commands/istioctl/index.html b/content/en/docs/reference/commands/istioctl/index.html index e635137312..61c7b3e6c8 100644 --- a/content/en/docs/reference/commands/istioctl/index.html +++ b/content/en/docs/reference/commands/istioctl/index.html @@ -2321,6 +2321,14 @@ THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE. +--charts <string> +-d +Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator) +or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). + (default ``) + + --context <string> The name of the kubeconfig context to use (default ``) @@ -2471,7 +2479,7 @@ istioctl experimental wait --for=distribution --threshold=.99 --timeout=300 virt --charts <string> -d Specify a path to a directory of charts and profiles -(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator) +(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). (default ``) @@ -2727,7 +2735,7 @@ istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \ --charts <string> -d Specify a path to a directory of charts and profiles -(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator) +(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). (default ``) @@ -2900,7 +2908,7 @@ e.g. --charts <string> -d Specify a path to a directory of charts and profiles -(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator) +(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). (default ``) @@ -3124,7 +3132,7 @@ https://istio.io/docs/reference/config/istio.operator.v1alpha12.pb/#IstioControl --charts <string> -d Specify a path to a directory of charts and profiles -(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator) +(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). (default ``) @@ -3192,7 +3200,7 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/ --charts <string> -d Specify a path to a directory of charts and profiles -(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator) +(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). (default ``) @@ -3237,11 +3245,6 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/ The namespace the operator controller is installed into (default `istio-operator`) ---readiness-timeout <duration> - -Maximum seconds to wait for the Istio operator to be ready. The --wait flag must be set for this flag to apply (default `5m0s`) - - --tag <string> The tag for the operator controller image (default `unknown`) @@ -3251,11 +3254,6 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/ Verbose output. - ---wait --w -Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds -

istioctl operator remove

@@ -3272,14 +3270,6 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/ ---charts <string> --d -Specify a path to a directory of charts and profiles -(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator) -or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). - (default ``) - - --context <string> The name of the kubeconfig context to use (default ``) @@ -3290,21 +3280,11 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/ Console/log output only, make no changes. ---filename <string> --f -Path to file containing IstioOperator custom resource (default ``) - - --force Proceed even with errors ---hub <string> - -The hub for the operator controller image (default `unknown`) - - --istioNamespace <string> -i Istio system namespace (default `istio-system`) @@ -3325,25 +3305,10 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/ The namespace the operator controller is installed into (default `istio-operator`) ---readiness-timeout <duration> - -Maximum seconds to wait for the Istio operator to be ready. The --wait flag must be set for this flag to apply (default `5m0s`) - - ---tag <string> - -The tag for the operator controller image (default `unknown`) - - --verbose Verbose output. - ---wait --w -Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds -

istioctl options

@@ -3485,6 +3450,14 @@ istioctl manifest apply --set profile=demo # Use a profile from the list +--charts <string> +-d +Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator) +or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). + (default ``) + + --config-path <string> -p The path the root of the configuration subtree to dump e.g. components.pilot. By default, dump whole tree (default ``) @@ -4250,6 +4223,14 @@ Retrieves last sent and last acknowledged xDS sync from Pilot to each Envoy in t +--charts <string> +-d +Specify a path to a directory of charts and profiles +(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator) +or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz). + (default ``) + + --context <string> The name of the kubeconfig context to use (default ``) @@ -4534,6 +4515,12 @@ These environment variables affect the behavior of the istioctl com Defines the cluster and service registry that this Istiod instance is belongs to +ENABLE_CA_SERVER +Boolean +true +If this is set to false, will not create CA server in istiod. + + GKE_CLUSTER_URL String @@ -4606,12 +4593,6 @@ These environment variables affect the behavior of the istioctl com namespace that nodeagent/citadel run in -PILOT_CERT_DIR -String - - - - PILOT_CERT_PROVIDER String istiod diff --git a/content/en/docs/reference/commands/mixs/index.html b/content/en/docs/reference/commands/mixs/index.html index 5cab120d54..73705412f8 100644 --- a/content/en/docs/reference/commands/mixs/index.html +++ b/content/en/docs/reference/commands/mixs/index.html @@ -359,6 +359,12 @@ These environment variables affect the behavior of the mixs command Defines the cluster and service registry that this Istiod instance is belongs to +ENABLE_CA_SERVER +Boolean +true +If this is set to false, will not create CA server in istiod. + + ISTIOD_ADDR String @@ -401,12 +407,6 @@ These environment variables affect the behavior of the mixs command Path for a kubeconfig file. -PILOT_CERT_DIR -String - - - - PILOT_CERT_PROVIDER String istiod diff --git a/content/en/docs/reference/commands/operator/index.html b/content/en/docs/reference/commands/operator/index.html index 2706e4809a..c29576a488 100644 --- a/content/en/docs/reference/commands/operator/index.html +++ b/content/en/docs/reference/commands/operator/index.html @@ -153,6 +153,12 @@ These environment variables affect the behavior of the operator com Defines the cluster and service registry that this Istiod instance is belongs to +ENABLE_CA_SERVER +Boolean +true +If this is set to false, will not create CA server in istiod. + + ISTIOD_ADDR String @@ -183,12 +189,6 @@ These environment variables affect the behavior of the operator com The JWT validation policy. -PILOT_CERT_DIR -String - - - - PILOT_CERT_PROVIDER String istiod diff --git a/content/en/docs/reference/commands/pilot-agent/index.html b/content/en/docs/reference/commands/pilot-agent/index.html index 2e1eb9059a..f932946f36 100644 --- a/content/en/docs/reference/commands/pilot-agent/index.html +++ b/content/en/docs/reference/commands/pilot-agent/index.html @@ -574,6 +574,12 @@ These environment variables affect the behavior of the pilot-agent Protocol and DNS server to use. Currently only tcp-tls: is supported. +ENABLE_CA_SERVER +Boolean +true +If this is set to false, will not create CA server in istiod. + + ENABLE_INGRESS_GATEWAY_SDS Boolean false @@ -694,12 +700,6 @@ These environment variables affect the behavior of the pilot-agent The output directory for the key and certificate. If empty, key and certificate will not be saved. Must be set for VMs using provisioning certificates. -PILOT_CERT_DIR -String - - - - PILOT_CERT_PROVIDER String istiod diff --git a/content/en/docs/reference/commands/pilot-discovery/index.html b/content/en/docs/reference/commands/pilot-discovery/index.html index 06b8204738..c13144e32f 100644 --- a/content/en/docs/reference/commands/pilot-discovery/index.html +++ b/content/en/docs/reference/commands/pilot-discovery/index.html @@ -94,6 +94,11 @@ remove_toc_prefix: 'pilot-discovery ' Restrict the applications namespace the controller manages; if not set, controller watches all namespaces (default ``) +--caCertFile <string> + +File containing the x509 Server CA Certificate (default ``) + + --clusterID <string> The ID of the cluster that this Istiod instance resides (default `Kubernetes`) @@ -264,6 +269,16 @@ remove_toc_prefix: 'pilot-discovery ' Controller resync interval (default `1m0s`) +--tlsCertFile <string> + +File containing the x509 Server Certificate (default ``) + + +--tlsKeyFile <string> + +File containing the x509 private key matching --tlsCertFile (default ``) + + --trust-domain <string> The domain serves to identify the system with spiffe (default ``) @@ -532,6 +547,12 @@ These environment variables affect the behavior of the pilot-discoveryProtocol and DNS server to use. Currently only tcp-tls: is supported. +ENABLE_CA_SERVER +Boolean +true +If this is set to false, will not create CA server in istiod. + + ENABLE_INCREMENTAL_MCP Boolean false @@ -616,12 +637,6 @@ These environment variables affect the behavior of the pilot-discovery -PILOT_CERT_DIR -String - - - - PILOT_CERT_PROVIDER String istiod diff --git a/content/en/docs/reference/config/proxy_extensions/accesslogpolicy/index.html b/content/en/docs/reference/config/proxy_extensions/accesslogpolicy/index.html new file mode 100644 index 0000000000..62d6496613 --- /dev/null +++ b/content/en/docs/reference/config/proxy_extensions/accesslogpolicy/index.html @@ -0,0 +1,62 @@ +--- +WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/proxy' REPO +source_repo: https://github.com/istio/proxy +title: AccessLogPolicy Config +description: Configuration for AccessLogPolicy Filter. +location: https://istio.io/docs/reference/config/proxy_extensions/accesslogpolicy.html +layout: protoc-gen-docs +generator: protoc-gen-docs +weight: 20 +number_of_entries: 1 +--- +

Accesslog Policy plugin is a stateful http log sampler. +It decides whether a request is logged based on the following rules. + 1. All requests resulting in errors are logged. + 2. First successful request within logwindowduration from a specific + source ip (source principal) is logged. +The plugin records its decision in the istio.accesslogpolicy attribute with +a value of “no”. A downstream plugin may honor the the attribute. For +example, Stackdriver plugin will not produce an access log entry if this +attribute is set.

+ +

AccessLogPolicyConfig

+
+

Top level Config for Access Log Policy Config Filter.

+ + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
logWindowDurationDuration +

Optional. Allows specifying logging window for successful requests. +The default duration is 12h.

+ +		 +No +
maxClientCacheSizeint32 +

Optional. Allows specifying max client cache size. +The default is 500 entries.

+ +		 +No +
+
diff --git a/content/en/docs/reference/config/attributegen/index.html b/content/en/docs/reference/config/proxy_extensions/attributegen/index.html similarity index 98% rename from content/en/docs/reference/config/attributegen/index.html rename to content/en/docs/reference/config/proxy_extensions/attributegen/index.html index b8c7b51bae..512e02c697 100644 --- a/content/en/docs/reference/config/attributegen/index.html +++ b/content/en/docs/reference/config/proxy_extensions/attributegen/index.html @@ -3,7 +3,7 @@ WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL source_repo: https://github.com/istio/proxy title: AttributeGen Config description: Configuration for Attribute Generation plugin. -location: https://istio.io/docs/reference/config/attributegen.html +location: https://istio.io/docs/reference/config/proxy_extensions/attributegen.html layout: protoc-gen-docs generator: protoc-gen-docs schema: istio.attributegen @@ -106,47 +106,6 @@ example, all response codes in 200s are mapped to 2xx.

If multiple AttributeGene configurations produce the same attribute, the result of the last configuration will be visible to downstream filters.

-

PluginConfig

-
-

Top level configuration to generate new attributes based on attributes of the -proxied traffic.

- - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescriptionRequired
debugbool -

The following settings should be rarely used. -Enable debug for this filter.

- -		 -No -
attributesAttributeGeneration[] -

Multiple independent attribute generation configurations.

- -		 -No -
-

AttributeGeneration

AttributeGeneration define generation of one attribute.

@@ -279,3 +238,44 @@ No
+

PluginConfig

+
+

Top level configuration to generate new attributes based on attributes of the +proxied traffic.

+ + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescriptionRequired
debugbool +

The following settings should be rarely used. +Enable debug for this filter.

+ +		 +No +
attributesAttributeGeneration[] +

Multiple independent attribute generation configurations.

+ +		 +No +
+
diff --git a/content/en/docs/reference/config/proxy_extensions/metadata_exchange/index.html b/content/en/docs/reference/config/proxy_extensions/metadata_exchange/index.html index 4feb5c0928..946d7a2c01 100644 --- a/content/en/docs/reference/config/proxy_extensions/metadata_exchange/index.html +++ b/content/en/docs/reference/config/proxy_extensions/metadata_exchange/index.html @@ -25,8 +25,7 @@ number_of_entries: 2 maxPeerCacheSize UInt32Value -

next id: 2 -maximum size of the peer metadata cache. +

maximum size of the peer metadata cache. A long lived proxy that connects with many transient peers can build up a large cache. To turn off the cache, set this field to zero.

diff --git a/content/en/docs/reference/config/proxy_extensions/stackdriver/index.html b/content/en/docs/reference/config/proxy_extensions/stackdriver/index.html index fe3ddab240..694ece5a70 100644 --- a/content/en/docs/reference/config/proxy_extensions/stackdriver/index.html +++ b/content/en/docs/reference/config/proxy_extensions/stackdriver/index.html @@ -11,8 +11,6 @@ number_of_entries: 1 ---

PluginConfig

-

next id: 9

-