Skip to content
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

docs(managing-ingress): rewrite Gateway page to Managing Ingress Traffic #1582

Merged
merged 35 commits into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
11a2174
docs(managing-ingress): rewrite Gateway page to Managing Ingress Traffic
michaelbeaumont Jan 15, 2024
aebf588
Merge branch 'master' into docs/gateway-rewrite
lukidzi Jan 29, 2024
9e5f25f
review changes
lukidzi Jan 29, 2024
98175b8
fix bar
lukidzi Jan 29, 2024
246490e
fix links
lukidzi Jan 29, 2024
84bf2e9
refactor and image
lukidzi Jan 29, 2024
745badd
change size
lukidzi Jan 29, 2024
e8d9bcf
fix links
lukidzi Jan 29, 2024
b723a77
fix links
lukidzi Jan 29, 2024
c8c3eae
fix link
lukidzi Jan 29, 2024
f92e7fb
copy file and change links
lukidzi Jan 29, 2024
7947f8c
Merge branch 'master' into docs/gateway-rewrite
lukidzi Jan 29, 2024
4b821f1
fix link
lukidzi Jan 29, 2024
d88bf0e
Merge branch 'docs/gateway-rewrite' of github.com:michaelbeaumont/kum…
lukidzi Jan 29, 2024
0ad6ac5
fix link
lukidzi Jan 29, 2024
cf52454
try fixing json schema
lukidzi Jan 30, 2024
a774cab
fix
lukidzi Jan 30, 2024
6047f90
fix regex
lukidzi Jan 30, 2024
3bc47c3
fix regex
lukidzi Jan 30, 2024
109c18f
fix regex
lukidzi Jan 30, 2024
bd93725
try
lukidzi Jan 30, 2024
41a8017
try
lukidzi Jan 30, 2024
1f6ab9a
escape slash
lukidzi Jan 30, 2024
b0ed7af
escape slash
lukidzi Jan 30, 2024
ff567d6
remove new lines from description
lukidzi Jan 30, 2024
c3e9929
escape new line
lukidzi Jan 30, 2024
a757058
Merge branch 'master' into docs/gateway-rewrite
lukidzi Jan 30, 2024
3e531b0
Merge branch 'master' into docs/gateway-rewrite
lukidzi Jan 31, 2024
58dc26a
Update app/_src/using-mesh/managing-ingress-traffic/overview.md
slonka Feb 1, 2024
66184de
Merge branch 'master' into docs/gateway-rewrite
lahabana Feb 1, 2024
1e507e5
Update app/_src/using-mesh/managing-ingress-traffic/gateway-api.md
lahabana Feb 1, 2024
f81f8df
Update app/_src/using-mesh/managing-ingress-traffic/overview.md
slonka Feb 1, 2024
b18e2b6
fix links
lahabana Feb 1, 2024
e46006b
Update app/_src/using-mesh/managing-ingress-traffic/delegated.md
lahabana Feb 1, 2024
27e56e8
Update app/_src/using-mesh/managing-ingress-traffic/delegated.md
lahabana Feb 1, 2024
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: 16 additions & 0 deletions app/_data/docs_nav_kuma_dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,22 @@ items:
url: /production/upgrades-tuning/fine-tuning/
- text: Init containers
url: /production/init-containers/
- title: Using Kong Mesh
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
group: true
items:
- text: Managing ingress traffic
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
url: /using-mesh/managing-ingress-traffic/overview/
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
items:
- text: Delegated gateways
url: /using-mesh/managing-ingress-traffic/delegated/
- text: Built-in gateways
url: /using-mesh/managing-ingress-traffic/builtin/
- text: Configuring built-in listeners
url: /using-mesh/managing-ingress-traffic/builtin-listeners/
- text: Configuring built-in routes
url: /using-mesh/managing-ingress-traffic/builtin-routes/
- text: Using the Kubernetes Gateway API
url: /using-mesh/managing-ingress-traffic/gateway-api/
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
- title: Explore
group: true
items:
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
360 changes: 360 additions & 0 deletions app/_src/using-mesh/managing-ingress-traffic/builtin-listeners.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,360 @@
---
title: Configuring built-in listeners
---

For configuring built-in gateway listeners, use the [`MeshGateway`](/docs/{{ page.version }}/policies/meshgateway) resource.

{% tip %}
These are {{site.mesh_product_name}} policies so if you are running on multi-zone they need to be created on the Global CP.
See the [dedicated section](#multi-zone) for using builtin gateways on
multi-zone.
{% endtip %}

The `MeshGateway` resource specifies what network ports the gateway should listen on and how network traffic should be accepted.
A builtin gateway Dataplane can have exactly one `MeshGateway` resource bound to it.
This binding uses standard, tag-based {{site.mesh_product_name}} matching semantics:

{% tabs binding useUrlFragment=false %}
{% tab binding Kubernetes %}

```yaml
apiVersion: kuma.io/v1alpha1
kind: MeshGateway
mesh: default
metadata:
name: edge-gateway
spec:
selectors:
- match:
kuma.io/service: edge-gateway
```

{% endtab %}
{% tab binding Universal %}

```yaml
type: MeshGateway
mesh: default
name: edge-gateway
selectors:
- match:
kuma.io/service: edge-gateway
```

{% endtab %}
{% endtabs %}
lukidzi marked this conversation as resolved.
Show resolved Hide resolved

A `MeshGateway` can have any number of listeners, where each listener represents an endpoint that can accept network traffic.
Note that the `MeshGateway` doesn’t specify which IP addresses are listened on; the `Dataplane` resource specifies that.

To configure a listener, you need to specify at least the port number and network protocol.
Each listener may also have its own set of {{site.mesh_product_name}} tags so that {{site.mesh_product_name}} policy configuration can be targeted to specific listeners.

{% tabs listener useUrlFragment=false %}
{% tab listener Kubernetes %}

```yaml
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
spec:
...
conf:
listeners:
- port: 8080
protocol: HTTP
tags:
port: http/8080
```

{% endtab %}
{% tab listener Universal %}

```yaml
conf:
listeners:
- port: 8080
protocol: HTTP
tags:
port: http/8080
```

{% endtab %}
{% endtabs %}

#### Hostname

An HTTP or HTTPS listener can also specify a `hostname`.

Note that listeners can share both `port` and `protocol` but differ on `hostname`.
This way routes can be attached to requests to specific _hostnames_ but share
the port/protocol with other routes attached to other hostnames.

{% tabs usage useUrlFragment=false %}
{% tab usage Kubernetes %}

```yaml
spec:
...
conf:
listeners:
- port: 8080
protocol: HTTP
hostname: foo.example.com
tags:
port: http/8080
```

{% endtab %}
{% tab usage Universal %}

```yaml
conf:
listeners:
- port: 8080
protocol: HTTP
hostname: foo.example.com
tags:
port: http/8080
```

{% endtab %}
{% endtabs %}

In this example, the gateway proxy listens for HTTP protocol connections on TCP port 8080 but restricts the `Host` header to `foo.example.com`.

{% tabs selectors useUrlFragment=false %}
{% tab selectors Kubernetes %}

```yaml
apiVersion: kuma.io/v1alpha1
kind: MeshGateway
mesh: default
metadata:
name: edge-gateway
spec:
selectors:
- match:
kuma.io/service: edge-gateway
conf:
listeners:
- port: 8080
protocol: HTTP
hostname: foo.example.com
tags:
vhost: foo.example.com
- port: 8080
protocol: HTTP
hostname: bar.example.com
tags:
vhost: bar.example.com
```

{% endtab %}
{% tab selectors Universal %}

```yaml
type: MeshGateway
mesh: default
name: edge-gateway
selectors:
- match:
kuma.io/service: edge-gateway
conf:
listeners:
- port: 8080
protocol: HTTP
hostname: foo.example.com
tags:
vhost: foo.example.com
- port: 8080
protocol: HTTP
hostname: bar.example.com
tags:
vhost: bar.example.com
```

{% endtab %}
{% endtabs %}
lukidzi marked this conversation as resolved.
Show resolved Hide resolved

Above shows a `MeshGateway` resource with two HTTP listeners on the same port.
In this example, the gateway proxy will be configured to listen on port 8080, and accept HTTP requests for both hostnames.

Note that because each listener entry has its own {{site.mesh_product_name}} tags, policy can still be targeted to a specific listener.
{{site.mesh_product_name}} generates a set of tags for each listener by combining the tags from the listener, the `MeshGateway` and the `Dataplane`.
{{ site.mesh_product_name}} matches policies against this set of combined tags.

| `Dataplane` tags | Listener tags | Final Tags |
| -------------------------------- | ------------------------------------------ | -------------------------------------------------- |
| kuma.io/service=edge-gateway | vhost=foo.example.com | kuma.io/service=edge-gateway,vhost=foo.example.com |
| kuma.io/service=edge-gateway | kuma.io/service=example,domain=example.com | kuma.io/service=example,domain=example.com |
| kuma.io/service=edge,location=us | version=2 | kuma.io/service=edge,location=us,version=2 |
slonka marked this conversation as resolved.
Show resolved Hide resolved

## TLS Termination

TLS sessions are terminated on a Gateway by specifying the "HTTPS" protocol, and providing a server certificate configuration.
Below, the gateway listens on port 8443 and terminates TLS sessions.

{% tabs tls-termination useUrlFragment=false %}
{% tab tls-termination Kubernetes %}

```yaml
apiVersion: kuma.io/v1alpha1
kind: MeshGateway
mesh: default
metadata:
name: edge-gateway
spec:
selectors:
- match:
kuma.io/service: edge-gateway
conf:
listeners:
- port: 8443
protocol: HTTPS
hostname: foo.example.com
tls:
mode: TERMINATE
certificates:
- secret: foo-example-com-certificate
tags:
name: foo.example.com
```

{% endtab %}
{% tab tls-termination Universal %}

```yaml
type: MeshGateway
mesh: default
name: edge-gateway
selectors:
- match:
kuma.io/service: edge-gateway
conf:
listeners:
- port: 8443
protocol: HTTPS
hostname: foo.example.com
tls:
mode: TERMINATE
certificates:
- secret: foo-example-com-certificate
tags:
name: foo.example.com
```

{% endtab %}
{% endtabs %}
lukidzi marked this conversation as resolved.
Show resolved Hide resolved

The server certificate is provided through a {{site.mesh_product_name}} datasource reference, in this case naming a secret that must contain both the server certificate and the corresponding private key.

### Server Certificate Secrets

A TLS server certificate secret is a collection of PEM objects in a {{site.mesh_product_name}} datasource (which may be a file, a {{site.mesh_product_name}} secret, or inline data).

There must be at least a private key and the corresponding TLS server certificate.
The CA certificate chain may also be present, but if it is, the server certificate must be the first certificate in the secret.

{{site.mesh_product_name}} gateway supports serving both RSA and ECDSA server certificates.
To enable this support, generate two server certificate secrets and provide them both to the listener TLS configuration.
The `kumactl` tool supports generating simple, self-signed TLS server certificates. The script below shows how to do this.

{% tabs tls-secret useUrlFragment=false %}
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
{% tab tls-secret Kubernetes %}

```yaml
apiVersion: v1
kind: Secret
metadata:
name: foo-example-com-certificate
namespace: { { site.mesh_namespace } }
lukidzi marked this conversation as resolved.
Show resolved Hide resolved
labels:
kuma.io/mesh: default
data:
value: "$(kumactl generate tls-certificate --type=server --hostname=foo.example.com --key-file=- --cert-file=- | base64 -w0)"
type: system.kuma.io/secret
```

{% endtab %}
{% tab tls-secret Universal %}

```yaml
type: Secret
mesh: default
name: foo-example-com-certificate
data: $(kumactl generate tls-certificate --type=server --hostname=foo.example.com --key-file=- --cert-file=- | base64 -w0)
```

{% endtab %}
{% endtabs %}

### Cross-mesh

The `Mesh` abstraction allows users
to encapsulate and isolate services
inside a kind of submesh with its own CA.
With a cross-mesh `MeshGateway`,
you can expose the services of one `Mesh`
to other `Mesh`es by defining an API with `MeshGatewayRoute`s.
All traffic remains inside the {{site.mesh_product_name}} data plane protected by mTLS.

All meshes involved in cross-mesh communication must have mTLS enabled.
To enable cross-mesh functionality for a `MeshGateway` listener,
set the `crossMesh` property.

```
...
mesh: default
selectors:
- match:
kuma.io/service: cross-mesh-gateway
conf:
listeners:
- port: 8080
protocol: HTTP
crossMesh: true
hostname: default.mesh
```

#### Hostname

If the listener includes a `hostname` value,
the cross-mesh listener will be reachable
from all `Mesh`es at this `hostname` and `port`.
In this case, the URL `http://default.mesh:8080`.

Otherwise it will be reachable at the host:
`internal.<gateway-name>.<mesh-of-gateway-name>.mesh`.

#### Without transparent proxy

If transparent proxy isn't set up, you'll have to add the listener explicitly as
an outbound to your `Dataplane` objects if you want to access it:

```
...
outbound
- port: 8080
tags:
kuma.io/service: cross-mesh-gateway
kuma.io/mesh: default
```

#### Limitations

{% if_version lte:1.8.x %}
Cross-mesh functionality isn't supported across zones at the
moment but will be in a future release.

{% endif_version %}
The only `protocol` supported is `HTTP`.
Like service to service traffic,
all traffic to the gateway is protected with mTLS
but appears to be HTTP traffic
to the applications inside the mesh.
In the future, this limitation may be relaxed.

There can be only one entry in `selectors`
for a `MeshGateway` with `crossMesh: true`.

## All options

{% json_schema MeshGateway type=proto %}
Loading
Loading