Skip to content

Doc clarifications #365

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
merged 3 commits into from
Feb 13, 2018
Merged

Doc clarifications #365

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
9c10d83
Doc clarifications
frankbu Feb 8, 2018
bb6ea13
regenerate go files
frankbu Feb 8, 2018
a5ff25b
Merge branch 'master' into gateway-clarifications
Feb 9, 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
16 changes: 9 additions & 7 deletions routing/v1alpha2/gateway.pb.go
View file
Open in desktop

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

16 changes: 9 additions & 7 deletions routing/v1alpha2/gateway.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ option go_package = "istio.io/api/routing/v1alpha2";
// For example, the following gateway spec sets up a proxy to act as a load
// balancer exposing port 80 and 9080 (http), 443 (https), and port 2379
// (TCP) for ingress. The gateway will be applied to the proxy running on
// a pod with labels "podRole: gateway-pod". While Istio will configure the
// a pod with labels "app: my-gateway-controller". While Istio will configure the
// proxy to listen on these ports, it is the responsibility of the user to
// ensure that external traffic to these ports are allowed into the mesh.
//
Expand All @@ -39,7 +39,7 @@ option go_package = "istio.io/api/routing/v1alpha2";
// name: my-gateway
// spec:
// selector:
// - podRole: gatweway-pod
// - app: my-gatweway-controller
// servers:
// - port:
// number: 80
Expand Down Expand Up @@ -145,8 +145,10 @@ message Gateway {
// REQUIRED: A list of server specifications.
repeated Server servers = 1;

// REQUIRED: One or more labels that indicate a specific set of pods/VMs
// One or more labels that indicate a specific set of pods/VMs
// on which this gateway configuration should be applied.
// If no selectors are provided, the gateway will be implemented by
// the default istio-ingress controller.
map<string, string> selector = 2;
}

Expand All @@ -159,7 +161,7 @@ message Gateway {
// name: my-ingress
// spec:
// selector:
// - podRole: ingress-gateway
// - app: my-ingress-controller
// servers:
// - port:
// number: 80
Expand All @@ -173,7 +175,7 @@ message Gateway {
// name: my-tcp-ingress
// spec:
// selector:
// - podRole: tcp-ingress-pod
// - app: my-tcp-ingress-controller
// servers:
// - port:
// number: 27018
Expand All @@ -184,10 +186,10 @@ message Gateway {
// apiVersion: config.istio.io/v1alpha2
// kind: Gateway
// metadata:
// name: my-ingress
// name: my-tls-ingress
// spec:
// selector:
// - podRole: ingress-tls
// - app: my-tls-ingress-controller
// servers:
// - port:
// number: 443
Expand Down
18 changes: 10 additions & 8 deletions routing/v1alpha2/istio.routing.v1alpha2.pb.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -933,7 +933,7 @@ <h2 id="Gateway">Gateway</h2>
<p>For example, the following gateway spec sets up a proxy to act as a load
balancer exposing port 80 and 9080 (http), 443 (https), and port 2379
(TCP) for ingress. The gateway will be applied to the proxy running on
a pod with labels &ldquo;podRole: gateway-pod&rdquo;. While Istio will configure the
a pod with labels &ldquo;app: my-gateway-controller&rdquo;. While Istio will configure the
proxy to listen on these ports, it is the responsibility of the user to
ensure that external traffic to these ports are allowed into the mesh.</p>

Expand All @@ -943,7 +943,7 @@ <h2 id="Gateway">Gateway</h2>
name: my-gateway
spec:
selector:
- podRole: gatweway-pod
- app: my-gatweway-controller
servers:
- port:
number: 80
Expand Down Expand Up @@ -1069,8 +1069,10 @@ <h2 id="Gateway">Gateway</h2>
<td><code>selector</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>
<p>One or more labels that indicate a specific set of pods/VMs
on which this gateway configuration should be applied.
If no selectors are provided, the gateway will be implemented by
the default istio-ingress controller.</p>

</td>
</tr>
Expand Down Expand Up @@ -2281,7 +2283,7 @@ <h2 id="Server">Server</h2>
name: my-ingress
spec:
selector:
- podRole: ingress-gateway
- app: my-ingress-controller
servers:
- port:
number: 80
Expand All @@ -2296,7 +2298,7 @@ <h2 id="Server">Server</h2>
name: my-tcp-ingress
spec:
selector:
- podRole: tcp-ingress-pod
- app: my-tcp-ingress-controller
servers:
- port:
number: 27018
Expand All @@ -2308,10 +2310,10 @@ <h2 id="Server">Server</h2>
<pre><code>apiVersion: config.istio.io/v1alpha2
kind: Gateway
metadata:
name: my-ingress
name: my-tls-ingress
spec:
selector:
- podRole: ingress-tls
- app: my-tls-ingress-controller
servers:
- port:
number: 443
Expand Down