Skip to content

Update the reference docs. #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 9, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
layout: protoc-gen-docs
number_of_entries: 6
---
{% raw %}
<p>This package defines user-facing authentication policy as well as configs that
the sidecar proxy uses to perform authentication.</p>

Expand Down Expand Up @@ -184,7 +183,7 @@ <h2 id="Policy">Policy</h2>
spec:
match:
peers:
- mtls: {}
- mtls: &lbrace;}
</code></pre>

<p>Policy to enable mTLS, and use JWT for productpage:9000</p>
Expand Down Expand Up @@ -425,4 +424,3 @@ <h2 id="istio.routing.v1alpha2.Destination">istio.routing.v1alpha2.Destination</
</tbody>
</table>
</section>
{% endraw %}
4 changes: 3 additions & 1 deletion authentication/v1alpha1/policy.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions mixer/v1/config/client/istio.mixer.v1.config.client.pb.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h2 id="AttributeMatch">AttributeMatch</h2>
<tbody>
<tr id="AttributeMatch.clause">
<td><code>clause</code></td>
<td><code>map&lt;string, <a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td>
<p>Map of attribute names to StringMatch type.
Each map element specifies one condition to match.</p>
Expand Down Expand Up @@ -507,7 +507,7 @@ <h2 id="HttpClientConfig">HttpClientConfig</h2>
</tr>
<tr id="HttpClientConfig.service_configs">
<td><code>serviceConfigs</code></td>
<td><code>map&lt;string, <a href="#ServiceConfig">ServiceConfig</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#ServiceConfig">ServiceConfig</a>&gt;</code></td>
<td>
<p>Map of control configuration indexed by destination.service. This
is used to support per-service configuration for cases where a
Expand Down Expand Up @@ -595,7 +595,7 @@ <h2 id="IstioService">IstioService</h2>
</tr>
<tr id="IstioService.labels">
<td><code>labels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>Optional one or more labels that uniquely identify the service version.</p>

Expand Down Expand Up @@ -1270,7 +1270,7 @@ <h2 id="istio.mixer.v1.Attributes">istio.mixer.v1.Attributes</h2>
<tbody>
<tr id="istio.mixer.v1.Attributes.attributes">
<td><code>attributes</code></td>
<td><code>map&lt;string, <a href="#istio.mixer.v1.Attributes.AttributeValue">istio.mixer.v1.Attributes.AttributeValue</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#istio.mixer.v1.Attributes.AttributeValue">istio.mixer.v1.Attributes.AttributeValue</a>&gt;</code></td>
<td>
<p>A map of attribute name to its value.</p>

Expand Down
4 changes: 2 additions & 2 deletions mixer/v1/config/istio.mixer.v1.config.pb.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h2 id="AttributeManifest">AttributeManifest</h2>
</tr>
<tr id="AttributeManifest.attributes">
<td><code>attributes</code></td>
<td><code>map&lt;string, <a href="#AttributeManifest.AttributeInfo">AttributeManifest.AttributeInfo</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#AttributeManifest.AttributeInfo">AttributeManifest.AttributeInfo</a>&gt;</code></td>
<td>
<p>The set of attributes this Istio component will be responsible for producing at runtime.
We map from attribute name to the attribute&rsquo;s specification. The name of an attribute,
Expand Down Expand Up @@ -370,7 +370,7 @@ <h2 id="google.protobuf.Struct">google.protobuf.Struct</h2>
<tbody>
<tr id="google.protobuf.Struct.fields">
<td><code>fields</code></td>
<td><code>map&lt;string, <a href="#google.protobuf.Value">google.protobuf.Value</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#google.protobuf.Value">google.protobuf.Value</a>&gt;</code></td>
<td>
<p>Unordered map of dynamically typed values.</p>

Expand Down
26 changes: 13 additions & 13 deletions mixer/v1/istio.mixer.v1.pb.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3 id="Attributes">Attributes</h3>
<tbody>
<tr id="Attributes.attributes">
<td><code>attributes</code></td>
<td><code>map&lt;string, <a href="#Attributes.AttributeValue">Attributes.AttributeValue</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#Attributes.AttributeValue">Attributes.AttributeValue</a>&gt;</code></td>
<td>
<p>A map of attribute name to its value.</p>

Expand Down Expand Up @@ -196,7 +196,7 @@ <h3 id="Attributes.StringMap">Attributes.StringMap</h3>
<tbody>
<tr id="Attributes.StringMap.entries">
<td><code>entries</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>Holds a set of name/value pairs.</p>

Expand Down Expand Up @@ -250,7 +250,7 @@ <h3 id="CheckRequest">CheckRequest</h3>
</tr>
<tr id="CheckRequest.quotas">
<td><code>quotas</code></td>
<td><code>map&lt;string, <a href="#CheckRequest.QuotaParams">CheckRequest.QuotaParams</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#CheckRequest.QuotaParams">CheckRequest.QuotaParams</a>&gt;</code></td>
<td>
<p>The individual quotas to allocate</p>

Expand Down Expand Up @@ -314,7 +314,7 @@ <h3 id="CheckResponse">CheckResponse</h3>
</tr>
<tr id="CheckResponse.quotas">
<td><code>quotas</code></td>
<td><code>map&lt;string, <a href="#CheckResponse.QuotaResult">CheckResponse.QuotaResult</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#CheckResponse.QuotaResult">CheckResponse.QuotaResult</a>&gt;</code></td>
<td>
<p>The resulting quota, one entry per requested quota.</p>

Expand Down Expand Up @@ -457,63 +457,63 @@ <h3 id="CompressedAttributes">CompressedAttributes</h3>
</tr>
<tr id="CompressedAttributes.strings">
<td><code>strings</code></td>
<td><code>map&lt;int32, int32&gt;</code></td>
<td><code>map&lt;int32,int32&gt;</code></td>
<td>
<p>Holds attributes of type STRING, DNS<em>NAME, EMAIL</em>ADDRESS, URI</p>

</td>
</tr>
<tr id="CompressedAttributes.int64s">
<td><code>int64s</code></td>
<td><code>map&lt;int32, int64&gt;</code></td>
<td><code>map&lt;int32,int64&gt;</code></td>
<td>
<p>Holds attributes of type INT64</p>

</td>
</tr>
<tr id="CompressedAttributes.doubles">
<td><code>doubles</code></td>
<td><code>map&lt;int32, double&gt;</code></td>
<td><code>map&lt;int32,double&gt;</code></td>
<td>
<p>Holds attributes of type DOUBLE</p>

</td>
</tr>
<tr id="CompressedAttributes.bools">
<td><code>bools</code></td>
<td><code>map&lt;int32, bool&gt;</code></td>
<td><code>map&lt;int32,bool&gt;</code></td>
<td>
<p>Holds attributes of type BOOL</p>

</td>
</tr>
<tr id="CompressedAttributes.timestamps">
<td><code>timestamps</code></td>
<td><code>map&lt;int32, <a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp">google.protobuf.Timestamp</a>&gt;</code></td>
<td><code>map&lt;int32,<a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp">google.protobuf.Timestamp</a>&gt;</code></td>
<td>
<p>Holds attributes of type TIMESTAMP</p>

</td>
</tr>
<tr id="CompressedAttributes.durations">
<td><code>durations</code></td>
<td><code>map&lt;int32, <a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a>&gt;</code></td>
<td><code>map&lt;int32,<a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a>&gt;</code></td>
<td>
<p>Holds attributes of type DURATION</p>

</td>
</tr>
<tr id="CompressedAttributes.bytes">
<td><code>bytes</code></td>
<td><code>map&lt;int32, bytes&gt;</code></td>
<td><code>map&lt;int32,bytes&gt;</code></td>
<td>
<p>Holds attributes of type BYTES</p>

</td>
</tr>
<tr id="CompressedAttributes.string_maps">
<td><code>stringMaps</code></td>
<td><code>map&lt;int32, <a href="#StringMap">StringMap</a>&gt;</code></td>
<td><code>map&lt;int32,<a href="#StringMap">StringMap</a>&gt;</code></td>
<td>
<p>Holds attributes of type STRING_MAP</p>

Expand Down Expand Up @@ -740,7 +740,7 @@ <h3 id="StringMap">StringMap</h3>
<tbody>
<tr id="StringMap.entries">
<td><code>entries</code></td>
<td><code>map&lt;int32, int32&gt;</code></td>
<td><code>map&lt;int32,int32&gt;</code></td>
<td>
<p>Holds a set of name/value pairs.</p>

Expand Down
2 changes: 1 addition & 1 deletion rbac/v1alpha1/istio.rbac.v1alpha1.pb.html
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ <h2 id="Subject">Subject</h2>
</tr>
<tr id="Subject.properties">
<td><code>properties</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>Optional. The set of properties that identify the subject.
In the above ServiceRoleBinding example, the second subject has two properties:
Expand Down
8 changes: 4 additions & 4 deletions routing/v1alpha1/istio.routing.v1alpha1.pb.html
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ <h2 id="DestinationWeight">DestinationWeight</h2>
</tr>
<tr id="DestinationWeight.labels">
<td><code>labels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>Sometimes required. Service version identifier for the destination service.
(&ndash; N.B. The map is used instead of pstruct due to lack of serialization support
Expand Down Expand Up @@ -1213,7 +1213,7 @@ <h2 id="IstioService">IstioService</h2>
</tr>
<tr id="IstioService.labels">
<td><code>labels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>Optional one or more labels that uniquely identify the service version.</p>

Expand Down Expand Up @@ -1581,7 +1581,7 @@ <h2 id="MatchRequest">MatchRequest</h2>
<tbody>
<tr id="MatchRequest.headers">
<td><code>headers</code></td>
<td><code>map&lt;string, <a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td>
<p>Set of HTTP match conditions based on HTTP/1.1, HTTP/2, GRPC request
metadata, such as <em>uri</em>, <em>scheme</em>, <em>authority</em>. The header keys must be
Expand Down Expand Up @@ -1780,7 +1780,7 @@ <h2 id="RouteRule">RouteRule</h2>
</tr>
<tr id="RouteRule.append_headers">
<td><code>appendHeaders</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before forwarding a request to the
destnation service.</p>
Expand Down
16 changes: 8 additions & 8 deletions routing/v1alpha2/istio.routing.v1alpha2.pb.html
Original file line number Diff line number Diff line change
Expand Up @@ -904,7 +904,7 @@ <h2 id="ExternalService.Endpoint">ExternalService.Endpoint</h2>
</tr>
<tr id="ExternalService.Endpoint.ports">
<td><code>ports</code></td>
<td><code>map&lt;string, uint32&gt;</code></td>
<td><code>map&lt;string,uint32&gt;</code></td>
<td>
<p>Set of ports associated with the endpoint. The ports must be
associated with a port name that was declared as part of the
Expand All @@ -914,7 +914,7 @@ <h2 id="ExternalService.Endpoint">ExternalService.Endpoint</h2>
</tr>
<tr id="ExternalService.Endpoint.labels">
<td><code>labels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>One or more labels associated with the endpoint.</p>

Expand Down Expand Up @@ -1067,7 +1067,7 @@ <h2 id="Gateway">Gateway</h2>
</tr>
<tr id="Gateway.selector">
<td><code>selector</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>REQUIRED: One or more labels that indicate a specific set of pods/VMs
on which this gateway configuration should be applied.</p>
Expand Down Expand Up @@ -1363,7 +1363,7 @@ <h2 id="HTTPMatchRequest">HTTPMatchRequest</h2>
</tr>
<tr id="HTTPMatchRequest.headers">
<td><code>headers</code></td>
<td><code>map&lt;string, <a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td><code>map&lt;string,<a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td>
<p>The header keys must be lowercase and use hyphen as the separator,
e.g. <em>x-request-id</em>.</p>
Expand Down Expand Up @@ -1397,7 +1397,7 @@ <h2 id="HTTPMatchRequest">HTTPMatchRequest</h2>
</tr>
<tr id="HTTPMatchRequest.source_labels">
<td><code>sourceLabels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>One or more labels that constrain the applicability of a rule to
workloads with the given labels. If the route rule has a list of
Expand Down Expand Up @@ -1704,7 +1704,7 @@ <h2 id="HTTPRoute">HTTPRoute</h2>
</tr>
<tr id="HTTPRoute.append_headers">
<td><code>appendHeaders</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>Additional HTTP headers to add before forwarding a request to the
destination service.</p>
Expand Down Expand Up @@ -1765,7 +1765,7 @@ <h2 id="L4MatchAttributes">L4MatchAttributes</h2>
</tr>
<tr id="L4MatchAttributes.source_labels">
<td><code>sourceLabels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>One or more labels that constrain the applicability of a rule to
workloads with the given labels. If the route rule has a list of
Expand Down Expand Up @@ -2573,7 +2573,7 @@ <h2 id="Subset">Subset</h2>
</tr>
<tr id="Subset.labels">
<td><code>labels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,string&gt;</code></td>
<td>
<p>REQUIRED. Labels apply a filter over the endpoints of a service in the
service registry. See route rules for examples of usage.</p>
Expand Down