You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: app/_how-tos/knep/get-started-with-event-gateway.md
+50-9Lines changed: 50 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,12 +22,12 @@ description: Use this tutorial to get started with {{site.event_gateway}}.
22
22
tldr:
23
23
q: How can I get started with {{site.event_gateway}}?
24
24
a: |
25
-
Get started with {{site.event_gateway}} by setting up a {{site.konnect_short_name}} control plane and data plane, then configuring a backend cluster, virtual cluster, listener, and policy with the {{site.event_gateway}} API.
25
+
Get started with {{site.event_gateway}} by setting up a {{site.konnect_short_name}} control plane and data plane, then configuring a backend cluster, virtual cluster, listener, and policies with the {{site.event_gateway}} API.
26
26
27
27
{:.info}
28
28
> **Note:**
29
29
> This quickstart runs a pre-configured demo Docker container to explore {{ site.base_gateway }}'s capabilities.
30
-
If you want to run {{ site.base_gateway }} as a part of a production-ready platform, start with the [Install](/event-gateway/#install) page.
30
+
If you want to run {{ site.base_gateway }} as a part of a production-ready platform, set up your control plane and data planes through the [{{site.konnect_short_name}} UI](/event-gateway/?tab=konnect-ui#install-event-gateway), or using [Terraform](/terraform/).
31
31
32
32
tools:
33
33
- konnect-api
@@ -65,7 +65,7 @@ faqs:
65
65
* Ensure that `acl_mode` is set to `passthrough` in the virtual cluster. If set to `enforce_on_gateway`, you won't see any topics listed without an ACL policy.
66
66
---
67
67
68
-
{{site.event_gateway}} lets you configure virtual clusters, which act as a proxy interface between the client and the Kafka cluster.
68
+
{{site.event_gateway}} lets you configure virtual clusters, which act as a proxy interface between the Kafka client and the Kafka cluster.
69
69
With virtual clusters, you can:
70
70
* Apply transformations, filtering, and custom policies
71
71
* Route messages based on specific rules to different Kafka clusters
@@ -92,11 +92,14 @@ Copy and paste this into your terminal to configure your session.
92
92
93
93
{:.info}
94
94
> This quickstart script is meant for demo purposes only, therefore it runs locally with default parameters and a small number of exposed ports.
95
-
If you want to run {{ site.base_gateway }} as a part of a production-ready platform, start with the [Install](/event-gateway/#install) page.
95
+
If you want to run {{ site.base_gateway }} as a part of a production-ready platform, set up your control plane and data planes through the [{{site.konnect_short_name}} UI](/event-gateway/?tab=konnect-ui#install-event-gateway), or using [Terraform](/terraform/).
96
96
97
97
## Add a backend cluster
98
98
99
-
Run the following command to create a new backend cluster linked to the local Kafka server we created in the [prerequisites](#start-a-local-kafka-server):
99
+
[Backend clusters](/event-gateway/entities/backend-cluster/) are abstractions of your real Kafka clusters, and they store connection and configuration details required for {{site.event_gateway}} to proxy traffic to Kafka.
100
+
You need at least one backend cluster.
101
+
102
+
Run the following command to create a new backend cluster linked to the local Kafka server we created in the [prerequisites](#start-a-local-kafka-cluster):
*`bootstrap_servers`: Points the backend cluster to the three bootstrap servers that we launched in the prerequisites.
124
+
*`authentication` and `insecure_allow_anonymous_virtual_cluster_auth`: For demo purposes, we're allowing insecure `anonymous` connections, which means no authentication required.
125
+
*`tls`: TLS is disabled so that we can easily test the connection.
126
+
119
127
Export the backend cluster ID to your environment:
[Virtual clusters](/event-gateway/entities/virtual-cluster/) are the connection point for Kafka clients.
135
+
Instead of connecting clients directly to your Kafka cluster, you can set up virtual clusters to customize how clients connect, and what requirements they need to have.
136
+
From the client's point of view, they're just connecting to a regular Kafka cluster.
137
+
138
+
Virtual clusters provide environment isolation and let you enforce policies, manage authentication, and more.
139
+
Each virtual cluster can connect to one backend cluster, though a backend cluster can have many virtual clusters connected to it.
140
+
126
141
Run the following command to create a new virtual cluster associated with our backend cluster:
Copy file name to clipboardExpand all lines: app/event-gateway/entities/virtual-cluster.md
+1-5Lines changed: 1 addition & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ breadcrumbs:
40
40
41
41
## What is a virtual cluster?
42
42
43
-
Virtual clusters are the primary way clients interact with the {{site.event_gateway_short}} proxy.q
43
+
Virtual clusters are the primary way clients interact with the {{site.event_gateway_short}} proxy.
44
44
They allow you to isolate clients from each other when connecting to the same [backend cluster](/event-gateway/entities/backend-cluster/),
45
45
and provide each client with modified view while still appearing as a standard Kafka cluster.
46
46
@@ -110,10 +110,6 @@ You will need to increase the number of virtual clusters if you want to create m
110
110
111
111
Here are some common patterns:
112
112
113
-
***Environment isolation**: You can create isolated `dev`, `test`, and `prod` namespaces on top of the same physical Kafka cluster.
114
-
If you have a topic named `orders` in each virtual cluster, this will map transparently to different backend topics: `dev-orders`, `test-orders`, and `prod-orders`.
115
-
This provides isolation and automatic name resolution per environment.
116
-
117
113
***Environment isolation**: You can create isolated `dev`, `test`, and `prod` namespaces on top of the same physical Kafka cluster.
118
114
If you have a topic named `orders` in each virtual cluster, this will map transparently to different backend topics: `dev-orders`, `test-orders`, and `prod-orders`.
119
115
This provides isolation and automatic name resolution per environment.
0 commit comments