Skip to content

Updating description of network definitions #664

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.

Sign up for GitHub

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
rshriram merged 3 commits into from
Oct 21, 2018
Merged

Updating description of network definitions #664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4d370f
clarity
Oct 19, 2018
11ceb83
renaming
Oct 19, 2018
ec51eb9
nits
Oct 21, 2018
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
2 changes: 1 addition & 1 deletion mesh/v1alpha1/config.pb.go
View file
Open in desktop

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

71 changes: 64 additions & 7 deletions mesh/v1alpha1/istio.mesh.v1alpha1.pb.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
generator: protoc-gen-docs
aliases:
- /docs/reference/config/service-mesh.html
number_of_entries: 10
number_of_entries: 11
---
<h2 id="AuthenticationPolicy">AuthenticationPolicy</h2>
<section>
Expand Down Expand Up @@ -285,13 +285,13 @@ <h2 id="Network">Network</h2>

</td>
</tr>
<tr id="Network-registries">
<td><code>registries</code></td>
<td><code>string[]</code></td>
<tr id="Network-endpoints">
<td><code>endpoints</code></td>
<td><code><a href="#Network-NetworkEndpoints">Network.NetworkEndpoints[]</a></code></td>
<td>
<p>One or more service registries that are in this network. Endpoints
from these registries will be directly reachable to one another.
The names of the registries should correspond to the data sources.</p>
<p>The list of endpoints in the network (obtained through the constituent
service registries or from CIDR ranges). All endpoints in the network
are directly accessible to one another.</p>

</td>
</tr>
Expand Down Expand Up @@ -355,6 +355,63 @@ <h2 id="Network-IstioNetworkGateway">Network.IstioNetworkGateway</h2>
<td>
<p>The locality associated with an explicitly specified gateway (i.e. ip)</p>

</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Network-NetworkEndpoints">Network.NetworkEndpoints</h2>
<section>
<p>NetworkEndpoints describes how the network associated with an endpoint
should be inferred. An endpoint will be assigned to a network based on
the following rules:</p>

<ol>
<li><p>Implicitly: If the registry explicitly provides information about
the network to which the endpoint belongs to. In some cases, its
possible to indicate the network associated with the endpoint by
adding ISTIO<em>META</em>NETWORK environment variable to the sidecar.</p></li>

<li><p>Explicitly:</p></li>
</ol>

<p>a. By matching the registry name with one of the &ldquo;from<em>registries&rdquo;
in the mesh config. A &ldquo;from</em>registry&rdquo; can only be assinged to a
single network.</p>

<p>b. By matching the IP against one of the CIDR ranges in a mesh
config network. The CIDR ranges must not overlap and be assigned to
a single network.</p>

<p>(2) will override (1) if both are present.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Network-NetworkEndpoints-from_cidr" class="oneof oneof-start">
<td><code>fromCidr</code></td>
<td><code>string (oneof)</code></td>
<td>
<p>A CIDR range for the set of endpoints in this network. The CIDR
ranges for endpoints from different networks must not overlap.</p>

</td>
</tr>
<tr id="Network-NetworkEndpoints-from_registry" class="oneof">
<td><code>fromRegistry</code></td>
<td><code>string (oneof)</code></td>
<td>
<p>Add all endpoints from the specified registry into this network.
The names of the registries should correspond to the secret name
that was used to configure the registry (kubernetes multicluster) or
supplied by MCP server.</p>

</td>
</tr>
</tbody>
Expand Down
Loading