Skip to content

Commit a88c3e4

Browse files
authored
Document Eventing istio integration (#5879)
Signed-off-by: Pierangelo Di Pilato <pierdipi@redhat.com>
1 parent 76df699 commit a88c3e4

File tree

3 files changed

+75
-0
lines changed

3 files changed

+75
-0
lines changed

config/nav.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,7 @@ nav:
288288
- EventType auto creation: eventing/features/eventtype-auto-creation.md
289289
- Transport Encryption: eventing/features/transport-encryption.md
290290
- Sender Identity: eventing/features/sender-identity.md
291+
- Eventing with Istio: eventing/features/istio-integration.md
291292
- FAQ: eventing/faq/README.md
292293
# Eventing reference docs
293294
- Reference:

docs/eventing/features/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,4 @@ Knative Eventing:
7575
| [New trigger filters](new-trigger-filters.md) | `new-trigger-filters` | Enables a new Trigger `filters` field that supports a set of powerful filter expressions. | Beta, enabled by default |
7676
| [Transport encryption](transport-encryption.md) | `transport-encryption` | Enables components to encrypt traffic using TLS by exposing HTTPS URL. | Beta, disabled by default |
7777
| [Sender Identity](sender-identity.md) | `authentication-oidc` | Enables Eventing sources to send authenticated requests and addressables to require authenticated requests. | Alpha, disabled by default |
78+
| [Eventing with Istio](istio-integration.md) | `istio` | Enables Eventing components to communicate with workloads in an Istio mesh. | Beta, disabled by default |
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Eventing integration with Istio service mesh
2+
3+
**Flag name**: `istio`
4+
5+
**Stage**: Beta, disabled by default
6+
7+
**Tracking issue**: [#6596](https://github.com/knative/eventing/issues/6596)
8+
9+
## Overview
10+
11+
Administrators can use Istio with Eventing to encrypt, authenticate and authorize requests to
12+
Eventing components.
13+
14+
## Prerequisites
15+
16+
- In order to enable the istio integration, you will need to install Istio by
17+
following [the Istio installation guides](https://istio.io/latest/docs/setup/install/).
18+
19+
## Installation
20+
21+
Some Eventing components use services of type `ExternalName` and with such services, Istio need to
22+
be manually configured to connect to such services using mutual TLS.
23+
24+
Eventing releases a controller that automatically configures Istio so that any pod that is part of
25+
an Istio mesh can communicate with Eventing components that are also part of the same Istio mesh.
26+
27+
1. Create the Eventing namespace and enable Istio injection:
28+
```shell
29+
kubectl create namespace knative-eventing --dry-run=client -oyaml | kubectl apply -f -
30+
kubectl label namespace knative-eventing istio-injection=enabled
31+
```
32+
2. [Follow Eventing installation](./../../install)
33+
34+
3. Install `eventing-istio-controller`:
35+
```shell
36+
kubectl apply -f {{ artifact(org="knative-extensions", repo="eventing-istio",file="eventing-istio.yaml")}}
37+
```
38+
4. Verify `eventing-istio-controller` is ready:
39+
```shell
40+
kubectl get deployment -n knative-eventing
41+
```
42+
Example output:
43+
```shell
44+
NAME ... READY
45+
eventing-istio-controller ... True
46+
# other deployments omitted ...
47+
```
48+
49+
## Enable istio integration
50+
51+
The `istio` feature flag is an enum configuration that configures the `eventing-istio-controller` to
52+
create Istio resources for Eventing resources.
53+
54+
The possible values for `istio` are:
55+
56+
- `disabled`
57+
- Disable Eventing integration with Istio
58+
- `enabled`
59+
- Enabled Eventing integration with Istio
60+
61+
For example, to enable `istio` integration, the `config-features` ConfigMap will look like
62+
the following:
63+
64+
```yaml
65+
apiVersion: v1
66+
kind: ConfigMap
67+
metadata:
68+
name: config-features
69+
namespace: knative-eventing
70+
data:
71+
istio: "enabled"
72+
```
73+

0 commit comments

Comments
 (0)