istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update reference docs.

This commit is contained in:
mtail 2018-09-29 11:12:19 -07:00
parent 02f30df80f
commit f204b6a9b9
9 changed files with 249 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
content/docs/reference/commands/mixc/index.html
View File

@ -37,6 +37,11 @@ which parameters in order to perform the checks and allocations.</p>
<td>List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default ``)</td>
</tr>
<tr>
<td><code>--concurrency &lt;int&gt;</code></td>
<td><code>-c</code></td>
<td>Controls the number of workers used to send requests to Mixer concurrently. (default `1`)</td>
</tr>
<tr>
<td><code>--double_attributes &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>List of name/value float64 attributes specified as name1=value1,name2=value2,... (default ``)</td>
@ -57,11 +62,21 @@ which parameters in order to perform the checks and allocations.</p>
<td>Address and port of a running Mixer instance (default `localhost:9091`)</td>
</tr>
<tr>
<td><code>--print_response</code></td>
<td></td>
<td>Whether to print mixer&#39;s response, useful when generating heavy load with mixc. </td>
</tr>
<tr>
<td><code>--quotas &lt;string&gt;</code></td>
<td><code>-q</code></td>
<td>List of quotas to allocate specified as name1=amount1,name2=amount2,... (default ``)</td>
</tr>
<tr>
<td><code>--rate &lt;int&gt;</code></td>
<td></td>
<td>Maximum number of requests per second sent by each worker. (default `-1`)</td>
</tr>
<tr>
<td><code>--repeat &lt;int&gt;</code></td>
<td><code>-r</code></td>
<td>Sends the specified number of requests in quick succession (default `1`)</td>
@ -128,6 +143,11 @@ which parameters in order to output the telemetry.</p>
<td>List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default ``)</td>
</tr>
<tr>
<td><code>--concurrency &lt;int&gt;</code></td>
<td><code>-c</code></td>
<td>Controls the number of workers used to send requests to Mixer concurrently. (default `1`)</td>
</tr>
<tr>
<td><code>--double_attributes &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>List of name/value float64 attributes specified as name1=value1,name2=value2,... (default ``)</td>
@ -148,6 +168,16 @@ which parameters in order to output the telemetry.</p>
<td>Address and port of a running Mixer instance (default `localhost:9091`)</td>
</tr>
<tr>
<td><code>--print_response</code></td>
<td></td>
<td>Whether to print mixer&#39;s response, useful when generating heavy load with mixc. </td>
</tr>
<tr>
<td><code>--rate &lt;int&gt;</code></td>
<td></td>
<td>Maximum number of requests per second sent by each worker. (default `-1`)</td>
</tr>
<tr>
<td><code>--repeat &lt;int&gt;</code></td>
<td><code>-r</code></td>
<td>Sends the specified number of requests in quick succession (default `1`)</td>

2
content/docs/reference/commands/pilot-agent/index.html
View File

@ -165,7 +165,7 @@ number_of_entries: 5
</tr>
<tr>
<td><code>--serviceregistry &lt;string&gt;</code></td>
<td>Select the platform for service registry, options are {Kubernetes, Consul, CloudFoundry, Mock, Config} (default `Kubernetes`)</td>
<td>Select the platform for service registry, options are {Kubernetes, Consul, MCP, Mock, Config} (default `Kubernetes`)</td>
</tr>
<tr>
<td><code>--statsdUdpAddress &lt;string&gt;</code></td>

7
content/docs/reference/commands/pilot-discovery/index.html
View File

@ -84,11 +84,6 @@ number_of_entries: 5
<td>The location of the certificate file for mutual TLS (default `/etc/istio/certs/cert-chain.pem`)</td>
</tr>
<tr>
<td><code>--cfConfig &lt;string&gt;</code></td>
<td></td>
<td>Cloud Foundry config file (default ``)</td>
</tr>
<tr>
<td><code>--clusterRegistriesConfigMap &lt;string&gt;</code></td>
<td></td>
<td>ConfigMap map for clusters config store (default ``)</td>
@ -236,7 +231,7 @@ number_of_entries: 5
<tr>
<td><code>--registries &lt;stringSlice&gt;</code></td>
<td></td>
<td>Comma separated list of platform service registries to read from (choose one or more from {Kubernetes, Consul, CloudFoundry, Mock, Config}) (default `[Kubernetes]`)</td>
<td>Comma separated list of platform service registries to read from (choose one or more from {Kubernetes, Consul, MCP, Mock, Config}) (default `[Kubernetes]`)</td>
</tr>
<tr>
<td><code>--resync &lt;duration&gt;</code></td>

340
content/docs/reference/config/istio.networking.v1alpha3/index.html
View File

@ -6,7 +6,7 @@ layout: protoc-gen-docs
generator: protoc-gen-docs
aliases:
- /docs/reference/config/istio.routing.v1alpha1/
number_of_entries: 50
number_of_entries: 51
---
<p>Configuration affecting traffic routing. Here are a few terms useful to define
in the context of traffic routing.</p>
@ -571,130 +571,6 @@ sizes, outlier detection).</p>
<p>One or more named sets that represent individual versions of a
service. Traffic policies can be overridden at subset level.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="DestinationWeight">DestinationWeight</h2>
<section>
<p>Each routing rule is associated with one or more service versions (see
glossary in beginning of document). Weights associated with the version
determine the proportion of traffic it receives. For example, the
following rule will route 25% of traffic for the &ldquo;reviews&rdquo; service to
instances with the &ldquo;v2&rdquo; tag and the remaining traffic (i.e., 75%) to
&ldquo;v1&rdquo;.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
name: reviews-route
spec:
hosts:
- reviews.prod.svc.cluster.local
http:
- route:
- destination:
host: reviews.prod.svc.cluster.local
subset: v2
weight: 25
- destination:
host: reviews.prod.svc.cluster.local
subset: v1
weight: 75
</code></pre>
<p>And the associated DestinationRule</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1alpha3
kind: DestinationRule
metadata:
name: reviews-destination
spec:
host: reviews.prod.svc.cluster.local
subsets:
- name: v1
labels:
version: v1
- name: v2
labels:
version: v2
</code></pre>
<p>Traffic can also be split across two entirely different services without
having to define new subsets. For example, the following rule forwards 25% of
traffic to reviews.com to dev.reviews.com</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
name: reviews-route-two-domains
spec:
hosts:
- reviews.com
http:
- route:
- destination:
host: dev.reviews.com
weight: 25
- destination:
host: reviews.com
weight: 75
</code></pre>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="DestinationWeight-destination">
<td><code>destination</code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
<p>REQUIRED. Destination uniquely identifies the instances of a service
to which the request/connection should be forwarded to.</p>
</td>
</tr>
<tr id="DestinationWeight-weight">
<td><code>weight</code></td>
<td><code>int32</code></td>
<td>
<p>REQUIRED. The proportion of traffic to be forwarded to the service
version. (0-100). Sum of weights across destinations SHOULD BE == 100.
If there is only one destination in a rule, the weight value is assumed to
be 100.</p>
</td>
</tr>
<tr id="DestinationWeight-append_headers">
<td><code>appendHeaders</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before forwarding a request to the
destination service.</p>
</td>
</tr>
<tr id="DestinationWeight-remove_response_headers">
<td><code>removeResponseHeaders</code></td>
<td><code>string[]</code></td>
<td>
<p>Http headers to remove before returning the response to the caller</p>
</td>
</tr>
<tr id="DestinationWeight-append_response_headers">
<td><code>appendResponseHeaders</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before returning a response to the
caller.</p>
</td>
</tr>
</tbody>
@ -1711,7 +1587,7 @@ number of retries attempted depends on the httpReqTimeout.</p>
<section>
<p>HTTPRewrite can be used to rewrite specific parts of a HTTP request
before forwarding the request to the destination. Rewrite primitive can
be used only with the DestinationWeights. The following example
be used only with HTTPRouteDestination. The following example
demonstrates how to rewrite the URL prefix for api call (/ratings) to
ratings service before making the actual API call.</p>
@ -1791,7 +1667,7 @@ is matched if any one of the match blocks succeed.</p>
</tr>
<tr id="HTTPRoute-route">
<td><code>route</code></td>
<td><code><a href="#DestinationWeight">DestinationWeight[]</a></code></td>
<td><code><a href="#HTTPRouteDestination">HTTPRouteDestination[]</a></code></td>
<td>
<p>A http rule can either redirect or forward (default) traffic. The
forwarding target can be one of several versions of a service (see
@ -1869,12 +1745,12 @@ for further details about cross origin resource sharing.</p>
</td>
</tr>
<tr id="HTTPRoute-append_headers">
<tr id="HTTPRoute-append_headers" class="deprecated ">
<td><code>appendHeaders</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before forwarding a request to the
destination service.</p>
<p>Use of <code>append_headers</code> is deprecated. Use the <code>append_request_headers</code>
field instead.</p>
</td>
</tr>
@ -1882,7 +1758,167 @@ destination service.</p>
<td><code>removeResponseHeaders</code></td>
<td><code>string[]</code></td>
<td>
<p>Http headers to remove before returning the response to the caller.</p>
<p>HTTP headers to remove before returning a response to the caller.</p>
</td>
</tr>
<tr id="HTTPRoute-append_response_headers">
<td><code>appendResponseHeaders</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before returning a response to the
caller.</p>
</td>
</tr>
<tr id="HTTPRoute-remove_request_headers">
<td><code>removeRequestHeaders</code></td>
<td><code>string[]</code></td>
<td>
<p>HTTP headers to remove before forwarding forwarding a request to the
destination service.</p>
</td>
</tr>
<tr id="HTTPRoute-append_request_headers">
<td><code>appendRequestHeaders</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before forwarding a request to the
destination service.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRouteDestination">HTTPRouteDestination</h2>
<section>
<p>Each routing rule is associated with one or more service versions (see
glossary in beginning of document). Weights associated with the version
determine the proportion of traffic it receives. For example, the
following rule will route 25% of traffic for the &ldquo;reviews&rdquo; service to
instances with the &ldquo;v2&rdquo; tag and the remaining traffic (i.e., 75%) to
&ldquo;v1&rdquo;.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
name: reviews-route
spec:
hosts:
- reviews.prod.svc.cluster.local
http:
- route:
- destination:
host: reviews.prod.svc.cluster.local
subset: v2
weight: 25
- destination:
host: reviews.prod.svc.cluster.local
subset: v1
weight: 75
</code></pre>
<p>And the associated DestinationRule</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1alpha3
kind: DestinationRule
metadata:
name: reviews-destination
spec:
host: reviews.prod.svc.cluster.local
subsets:
- name: v1
labels:
version: v1
- name: v2
labels:
version: v2
</code></pre>
<p>Traffic can also be split across two entirely different services without
having to define new subsets. For example, the following rule forwards 25% of
traffic to reviews.com to dev.reviews.com</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
name: reviews-route-two-domains
spec:
hosts:
- reviews.com
http:
- route:
- destination:
host: dev.reviews.com
weight: 25
- destination:
host: reviews.com
weight: 75
</code></pre>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRouteDestination-destination">
<td><code>destination</code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
<p>REQUIRED. Destination uniquely identifies the instances of a service
to which the request/connection should be forwarded to.</p>
</td>
</tr>
<tr id="HTTPRouteDestination-weight">
<td><code>weight</code></td>
<td><code>int32</code></td>
<td>
<p>REQUIRED. The proportion of traffic to be forwarded to the service
version. (0-100). Sum of weights across destinations SHOULD BE == 100.
If there is only one destination in a rule, the weight value is assumed to
be 100.</p>
</td>
</tr>
<tr id="HTTPRouteDestination-remove_response_headers">
<td><code>removeResponseHeaders</code></td>
<td><code>string[]</code></td>
<td>
<p>HTTP headers to remove before returning a response to the caller.</p>
</td>
</tr>
<tr id="HTTPRouteDestination-append_response_headers">
<td><code>appendResponseHeaders</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before returning a response to the
caller.</p>
</td>
</tr>
<tr id="HTTPRouteDestination-remove_request_headers">
<td><code>removeRequestHeaders</code></td>
<td><code>string[]</code></td>
<td>
<p>HTTP headers to remove before forwarding forwarding a request to the
destination service.</p>
</td>
</tr>
<tr id="HTTPRouteDestination-append_request_headers">
<td><code>appendRequestHeaders</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before forwarding a request to the
destination service.</p>
</td>
</tr>
@ -2334,6 +2370,42 @@ matching or selection for final routing.</p>
<td>
<p>Valid port number</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="RouteDestination">RouteDestination</h2>
<section>
<p>L4 routing rule weighted destination.</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="RouteDestination-destination">
<td><code>destination</code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
<p>REQUIRED. Destination uniquely identifies the instances of a service
to which the request/connection should be forwarded to.</p>
</td>
</tr>
<tr id="RouteDestination-weight">
<td><code>weight</code></td>
<td><code>int32</code></td>
<td>
<p>REQUIRED. The proportion of traffic to be forwarded to the service
version. (0-100). Sum of weights across destinations SHOULD BE == 100.
If there is only one destination in a rule, the weight value is assumed to
be 100.</p>
</td>
</tr>
</tbody>
@ -2565,7 +2637,7 @@ client certificates for authentication.</p>
<p><code>ServiceEntry</code> enables adding additional entries into Istio&rsquo;s internal
service registry, so that auto-discovered services in the mesh can
access/route to these manually specified services. A service entry
describes the properties of a service (DNS name, VIPs ,ports, protocols,
describes the properties of a service (DNS name, VIPs, ports, protocols,
endpoints). These services could be external to the mesh (e.g., web
APIs) or mesh-internal services that are not part of the platform&rsquo;s
service registry (e.g., a set of VMs talking to services in Kubernetes).</p>
@ -3205,7 +3277,7 @@ is matched if any one of the match blocks succeed.</p>
</tr>
<tr id="TCPRoute-route">
<td><code>route</code></td>
<td><code><a href="#DestinationWeight">DestinationWeight[]</a></code></td>
<td><code><a href="#RouteDestination">RouteDestination[]</a></code></td>
<td>
<p>The destination to which the connection should be forwarded to.
Currently, only one destination is allowed for TCP services. When TCP
@ -3340,7 +3412,7 @@ is matched if any one of the match blocks succeed.</p>
</tr>
<tr id="TLSRoute-route">
<td><code>route</code></td>
<td><code><a href="#DestinationWeight">DestinationWeight[]</a></code></td>
<td><code><a href="#RouteDestination">RouteDestination[]</a></code></td>
<td>
<p>The destination to which the connection should be forwarded to.
Currently, only one destination is allowed for TLS services. When TCP

8
content/docs/reference/config/policy-and-telemetry/adapters/apigee/index.html
View File

@ -4,6 +4,14 @@ description: Adapter for Apigee's distributed policy checks and analytics.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/apigee.html
layout: partner-component
generator: protoc-gen-docs
provider: Apigee
contact_email:
support_link: https://apigee.com/about/support/portal
source_link: https://github.com/apigee/istio-mixer-adapter
latest_release_link: https://github.com/apigee/istio-mixer-adapter/releases
helm_chart_link:
istio_versions: "1.0.0, 1.0.2"
supported_templates: authorization, analytics
number_of_entries: 3
---
<p>The Apigee Mixer adapter provides Apigee&rsquo;s distributed authentication and quota policy checks

2
content/docs/reference/config/policy-and-telemetry/adapters/cloudmonitor/index.html
View File

@ -2,7 +2,7 @@
title: CloudMonitor
description: Adapter for cloudmonitor metrics.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/cloudmonitor.html
layout: partner-adapter
layout: partner-component
generator: protoc-gen-docs
aliases:
- /docs/reference/config/adapters/cloudmonitor.html

2
content/docs/reference/config/policy-and-telemetry/adapters/wavefront/index.html
View File

@ -2,7 +2,7 @@
title: Wavefront by VMware
description: Adapter to deliver metrics to Wavefront by VMware.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/wavefront.html
layout: partner-adapter
layout: partner-component
generator: protoc-gen-docs
aliases:
- /docs/reference/config/adapters/wavefront.html

2
content/docs/reference/config/policy-and-telemetry/templates/analytics/index.html
View File

@ -2,7 +2,7 @@
title: Analytics
description: The Analytics template is used to dispatch runtime telemetry to Apigee.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/analytics.html
layout: partner-adapter
layout: partner-component
generator: protoc-gen-docs
number_of_entries: 1
---

1
layouts/_default/partner-component.html
View File

@ -41,7 +41,6 @@
{{ $base := .Site.BaseURL }}
{{ range $i, $t := $templates }}
{{- if ne $i 0 -}},{{- end -}}
<a href="{{ $base }}/docs/reference/config/policy-and-telemetry/templates/{{ trim $t " " }}"><code>{{ trim $t " " }}</code></a>
{{ end }}
</td>