From 92b11e66cd333e98b244e8a99914c03adf466897 Mon Sep 17 00:00:00 2001 From: Martin Taillefer Date: Thu, 13 Jun 2019 10:46:51 -0700 Subject: [PATCH] Update reference docs (#4389) Also run the SVG optimizer. --- content/about/community/partners/wso2.svg | 41 +- .../diagrams/diagram-guidelines.svg | 2571 +---------------- content/docs/concepts/what-is-istio/arch.svg | 158 +- .../docs/reference/commands/galley/index.html | 6 + .../reference/commands/istio_ca/index.html | 6 + .../reference/commands/istioctl/index.html | 6 + .../docs/reference/commands/mixc/index.html | 275 -- .../docs/reference/commands/mixs/index.html | 6 + .../reference/commands/pilot-agent/index.html | 6 + .../commands/pilot-discovery/index.html | 6 + .../commands/sidecar-injector/index.html | 6 + .../networking/v1alpha3/sidecar/index.html | 2 +- .../istio.policy.v1beta1/index.html | 2 +- scripts/grab_reference_docs.sh | 1 - src/icons/download.svg | 2 +- 15 files changed, 48 insertions(+), 3046 deletions(-) delete mode 100644 content/docs/reference/commands/mixc/index.html diff --git a/content/about/community/partners/wso2.svg b/content/about/community/partners/wso2.svg index 4ff68dcedd..61a35be5a5 100644 --- a/content/about/community/partners/wso2.svg +++ b/content/about/community/partners/wso2.svg @@ -1,40 +1 @@ - - - - - - - - - - - - - - - - - + \ No newline at end of file diff --git a/content/about/contribute/diagrams/diagram-guidelines.svg b/content/about/contribute/diagrams/diagram-guidelines.svg index 60e6cafc58..0a018d6503 100644 --- a/content/about/contribute/diagrams/diagram-guidelines.svg +++ b/content/about/contribute/diagrams/diagram-guidelines.svg @@ -1,2570 +1 @@ - - - - - - -image/svg+xmlIstio Diagram Creation Guidelines - -Service - -Service - -Service - -Use a gray rectangle with rounded corners to represent a VM or pod place a label on the top left corner. - -Use a white rectangle with round corners to represent a service. Include the compute icon to represent specific workloads. - -Add the Envoy logo on a white rectangle with round corners to represent an Envoy proxy. Combine the visual cues as needed to represent the appropriate level of detail. - -Represent configuration objects as services with their own backends and Envoy proxies. Add the Istio logo to distinguish them. - -Use the following RGB values: - -Use the FontAwesome icons whenever possible. - -Use official logos only with permission and with the appropriate legal disclaimer. - -Example: Configurable traffic routing rules - -* All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement. - -Use lines to connect the components.Avoid crossing lines. Add arrows to determine direction. Place labels below the line to avoid typography issues. - -Use a blue-dashed rectangle without filling and with round corners to represent an Istio mesh. Use the Istio logo or “Istio Mesh” as a label - -My Backend: VM or pod - -Istio Mesh - -Bidirectional monitoring traffic - -Data plane traffic - -Control plane traffic or configuration - -Represent Istio components as services in their own backend. Label them accordingly: Pilot, Galley, Mixer, or Citadel. Add the Istio logo and labels to distinguish them from other services. - -Pilot - -Mixer - -Blue-dashed lines denote control traffic or configurations - -Green-solid lines denote data plane traffic. - - Orange-dotted lines denote monitoring or telemetry traffic. - -External traffic - - Gray lines denote traffic outside the mesh. - -To represent multiple workloads within a backend, just stack and label the representations. - -Service 1 - -Service 2 - -Virtual service - -Gateway - -Service entry - -Certificate -CertificateAuthority - -Container - -Discovery - -Encrypted -Cloud - -Kurbernetes* - -Multiple services on a single backend. - -Service v1 - -Service v2 - -Multiple versions of a service. - -Configurable traffic routing rules - -Service entry - -Egress - -Service - -Service v1 - -Service v2 - -Ingress - -Virtual service - -BlueR=51 G=102 B=153 - -GreenR=0 G=153B=0 - -PinkR=255G=0B=255 - -GrayR=102G=102B=102 - -OrangeR=255G=102B=0 - - \ No newline at end of file +Istio Diagram Creation GuidelinesServiceServiceServiceUse a gray rectangle with rounded corners to represent a VM or pod place a label on the top left corner.Use a white rectangle with round corners to represent a service. Include the compute icon to represent specific workloads.Add the Envoy logo on a white rectangle with round corners to represent an Envoy proxy. Combine the visual cues as needed to represent the appropriate level of detail.Represent configuration objects as services with their own backends and Envoy proxies. Add the Istio logo to distinguish them.Use the following RGB values:Use the FontAwesome icons whenever possible.Use official logos only with permission and with the appropriate legal disclaimer.Example: Configurable traffic routing rules* All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.Use lines to connect the components.Avoid crossing lines. Add arrows to determine direction. Place labels below the line to avoid typography issues.Use a blue-dashed rectangle without filling and with round corners to represent an Istio mesh. Use the Istio logo or “Istio Mesh” as a labelMy Backend: VM or podIstio MeshBidirectional monitoring trafficData plane trafficControl plane traffic or configurationRepresent Istio components as services in their own backend. Label them accordingly: Pilot, Galley, Mixer, or Citadel. Add the Istio logo and labels to distinguish them from other services.PilotMixerBlue-dashed lines denote control traffic or configurationsGreen-solid lines denote data plane traffic.Orange-dotted lines denote monitoring or telemetry traffic.External trafficGray lines denote traffic outside the mesh.To represent multiple workloads within a backend, just stack and label the representations.Service 1Service 2Virtual serviceGatewayService entryCertificateCertificateAuthorityContainerDiscoveryEncryptedCloudKurbernetes*Multiple services on a single backend.Service v1Service v2Multiple versions of a service.Configurable traffic routing rulesService entryEgressServiceService v1Service v2IngressVirtual serviceBlueR=51 G=102 B=153GreenR=0 G=153B=0PinkR=255G=0B=255GrayR=102G=102B=102OrangeR=255G=102B=0 \ No newline at end of file diff --git a/content/docs/concepts/what-is-istio/arch.svg b/content/docs/concepts/what-is-istio/arch.svg index 26512a87f7..2ecad1fb92 100644 --- a/content/docs/concepts/what-is-istio/arch.svg +++ b/content/docs/concepts/what-is-istio/arch.svg @@ -1,157 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + \ No newline at end of file diff --git a/content/docs/reference/commands/galley/index.html b/content/docs/reference/commands/galley/index.html index c43882794b..dd634dc874 100644 --- a/content/docs/reference/commands/galley/index.html +++ b/content/docs/reference/commands/galley/index.html @@ -587,6 +587,12 @@ These environment variables affect the behavior of the galley comma EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. +PILOT_ENABLE_REDIS_FILTER +Boolean +false +EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. + + PILOT_ENABLE_WAIT_CACHE_SYNC String diff --git a/content/docs/reference/commands/istio_ca/index.html b/content/docs/reference/commands/istio_ca/index.html index f40a3123fc..87ed26f00d 100644 --- a/content/docs/reference/commands/istio_ca/index.html +++ b/content/docs/reference/commands/istio_ca/index.html @@ -420,6 +420,12 @@ These environment variables affect the behavior of the istio_ca com EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. +PILOT_ENABLE_REDIS_FILTER +Boolean +false +EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. + + PILOT_ENABLE_WAIT_CACHE_SYNC String diff --git a/content/docs/reference/commands/istioctl/index.html b/content/docs/reference/commands/istioctl/index.html index 46eb27ac3a..95b8b86761 100644 --- a/content/docs/reference/commands/istioctl/index.html +++ b/content/docs/reference/commands/istioctl/index.html @@ -1824,6 +1824,12 @@ These environment variables affect the behavior of the istioctl com EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. +PILOT_ENABLE_REDIS_FILTER +Boolean +false +EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. + + PILOT_ENABLE_WAIT_CACHE_SYNC String diff --git a/content/docs/reference/commands/mixc/index.html b/content/docs/reference/commands/mixc/index.html deleted file mode 100644 index 1a57c2f745..0000000000 --- a/content/docs/reference/commands/mixc/index.html +++ /dev/null @@ -1,275 +0,0 @@ ---- -WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE https://github.com/istio/istio REPO -source_repo: https://github.com/istio/istio -title: mixc -description: Utility to trigger direct calls to Mixer's API. -generator: pkg-collateral-docs -number_of_entries: 5 ---- -

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.

-

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 ``)
--concurrency <int>-cControls the number of workers used to send requests to Mixer concurrently. (default `1`)
--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`)
--print_responseWhether to print mixer's response, useful when generating heavy load with mixc.
--quotas <string>-qList of quotas to allocate specified as name1=amount1,name2=amount2,... (default ``)
--rate <int>Maximum number of requests per second sent by each worker. (default `-1`)
--repeat <int>-rSends the specified number of requests in quick succession (default `1`)
--report_batch_size <int>Maximum number of report instances to include in each report API call. (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_sampling_rate <float>Sampling rate for generating trace data. Must be a value in the range [0.0, 1.0]. (default `0`)
--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 ``)
--concurrency <int>-cControls the number of workers used to send requests to Mixer concurrently. (default `1`)
--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`)
--print_responseWhether to print mixer's response, useful when generating heavy load with mixc.
--rate <int>Maximum number of requests per second sent by each worker. (default `-1`)
--repeat <int>-rSends the specified number of requests in quick succession (default `1`)
--report_batch_size <int>Maximum number of report instances to include in each report API call. (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_sampling_rate <float>Sampling rate for generating trace data. Must be a value in the range [0.0, 1.0]. (default `0`)
--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
--output <string>-oOne of 'yaml' or 'json'. (default ``)
--short-sDisplays a short form of the version information
-

Exported Metrics

- - - - - - -
Metric NameTypeDescription
diff --git a/content/docs/reference/commands/mixs/index.html b/content/docs/reference/commands/mixs/index.html index e63430f90d..50326b87f6 100644 --- a/content/docs/reference/commands/mixs/index.html +++ b/content/docs/reference/commands/mixs/index.html @@ -412,6 +412,12 @@ These environment variables affect the behavior of the mixs command EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. +PILOT_ENABLE_REDIS_FILTER +Boolean +false +EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. + + PILOT_ENABLE_WAIT_CACHE_SYNC String diff --git a/content/docs/reference/commands/pilot-agent/index.html b/content/docs/reference/commands/pilot-agent/index.html index 4b0795bcd1..cd62ee1181 100644 --- a/content/docs/reference/commands/pilot-agent/index.html +++ b/content/docs/reference/commands/pilot-agent/index.html @@ -502,6 +502,12 @@ These environment variables affect the behavior of the pilot-agent EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. +PILOT_ENABLE_REDIS_FILTER +Boolean +false +EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. + + PILOT_ENABLE_WAIT_CACHE_SYNC String diff --git a/content/docs/reference/commands/pilot-discovery/index.html b/content/docs/reference/commands/pilot-discovery/index.html index 8afa0012b5..400cc16a7d 100644 --- a/content/docs/reference/commands/pilot-discovery/index.html +++ b/content/docs/reference/commands/pilot-discovery/index.html @@ -534,6 +534,12 @@ These environment variables affect the behavior of the pilot-discoveryEnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. +PILOT_ENABLE_REDIS_FILTER +Boolean +false +EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. + + PILOT_ENABLE_WAIT_CACHE_SYNC String diff --git a/content/docs/reference/commands/sidecar-injector/index.html b/content/docs/reference/commands/sidecar-injector/index.html index 4957ca7707..49e93c8d9e 100644 --- a/content/docs/reference/commands/sidecar-injector/index.html +++ b/content/docs/reference/commands/sidecar-injector/index.html @@ -412,6 +412,12 @@ These environment variables affect the behavior of the sidecar-injectorEnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. +PILOT_ENABLE_REDIS_FILTER +Boolean +false +EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. + + PILOT_ENABLE_WAIT_CACHE_SYNC String diff --git a/content/docs/reference/config/networking/v1alpha3/sidecar/index.html b/content/docs/reference/config/networking/v1alpha3/sidecar/index.html index 108c50d015..d782b19b2e 100644 --- a/content/docs/reference/config/networking/v1alpha3/sidecar/index.html +++ b/content/docs/reference/config/networking/v1alpha3/sidecar/index.html @@ -107,7 +107,7 @@ spec: app: productpage ingress: - port: - number: 9080 # binds to 0.0.0.0:9080 + number: 9080 # binds to proxy_instance_ip:9080 (0.0.0.0:9080, if no unicast IP is available for the instance) protocol: HTTP name: somename defaultEndpoint: 127.0.0.1:8080 diff --git a/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html b/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html index ff752abd9a..f207c3a87d 100644 --- a/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html +++ b/content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/index.html @@ -1117,7 +1117,7 @@ if the match evaluates to true.

  • an empty match evaluates to true
  • true, a boolean literal; a rule with this match will always be executed
    • -
  • match(destination.service.host, "ratings.*) selects any request targeting a service whose +
  • match(destination.service.host, "ratings.*") selects any request targeting a service whose name starts with “ratings”
  • attr1 == "20" && attr2 == "30" logical AND, OR, and NOT are also available
diff --git a/scripts/grab_reference_docs.sh b/scripts/grab_reference_docs.sh index 5728c2300c..647a5ac7ba 100755 --- a/scripts/grab_reference_docs.sh +++ b/scripts/grab_reference_docs.sh @@ -21,7 +21,6 @@ REPOS=( # The components to build and extract usage docs from. COMPONENTS=( - https://github.com/istio/istio.git@master@mixer/cmd/mixc@mixc https://github.com/istio/istio.git@master@mixer/cmd/mixs@mixs https://github.com/istio/istio.git@master@istioctl/cmd/istioctl@istioctl https://github.com/istio/istio.git@master@pilot/cmd/pilot-agent@pilot-agent diff --git a/src/icons/download.svg b/src/icons/download.svg index 230a9ecb31..78d68a2046 100644 --- a/src/icons/download.svg +++ b/src/icons/download.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file