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
To get started deploying Kroxylicious, you will need to install a Java Runtime Environment (JRE) with minimum version 17. This does not come included with Kroxylicious.
17
17
@@ -27,15 +27,15 @@ If you get an error or the command doesn't return anything, you may not have a J
27
27
28
28
{% include bs-alert.html type="primary" icon="info-circle-fill" content=jre_note %}
You will also need a running Apache Kafka® cluster for Kroxylicious to proxy. The official Apache Kafka®[quickstart](https://kafka.apache.org/documentation/#quickstart) has instructions for setting up a local bare metal cluster.
33
33
34
-
Once your cluster is set up, the cluster bootstrap address used by Kroxylicious can be changed in the configuration YAML file (see the [**Configure**](#configure) section below).
34
+
Once your cluster is set up, the cluster bootstrap address used by Kroxylicious can be changed in the configuration YAML file (see the [**Configure**](#configure-deployment) section below).
Kroxylicious can be downloaded from the [releases](https://github.com/kroxylicious/kroxylicious/releases) page of the Kroxylicious GitHub repository, or from Maven Central.
41
41
@@ -49,14 +49,14 @@ If you're trying Kroxylicious out on Linux or macOS, you may find the `.tar.gz`
49
49
50
50
<br />
51
51
52
-
# Install
52
+
<h1id="install-deployment">Install</h1>
53
53
54
54
Extract the downloaded Kroxylicious Zip file into the directory you would like to install Kroxylicious in.
55
55
Ensure the `kroxylicious-start.sh` and `run-java.sh` files in the `bin/` directory within the extracted folder have at least read and execute (`r-x`) permissions for the owner.
56
56
57
57
<br />
58
58
59
-
# Configure
59
+
<h1id="configure-deployment">Configure</h1>
60
60
61
61
Kroxylicious is configured with YAML. From the configuration file you can specify how Kroxylicious presents each Apache Kafka® broker to clients, where Kroxylicious will locate the Apache Kafka® cluster(s) to be proxied, and which filters Kroxylicious should use along with any configuration for those filters.
62
62
@@ -68,7 +68,7 @@ If your machine uses a non-standard port configuration, or if you have used cust
68
68
69
69
<br />
70
70
71
-
# Run
71
+
<h1id="run-deployment">Run</h1>
72
72
73
73
From within the extracted Kroxylicious folder, run the following command:
74
74
@@ -80,7 +80,7 @@ To use your own configuration file instead of the example, just replace the file
80
80
81
81
<br />
82
82
83
-
# Use
83
+
<h1id="use-deployment">Use</h1>
84
84
85
85
To use your Kroxylicious proxy, your client(s) will need to point to the proxy (using the configured address) rather than directly at the Apache Kafka® cluster.
86
86
@@ -97,23 +97,23 @@ In each command below, substitute `$KROXYLICIOUS_BOOTSTRAP` for the bootstrap ad
97
97
98
98
<br />
99
99
100
-
##### 1. Create a topic via Kroxylicious
100
+
<h2class="fs-5">1. Create a topic via Kroxylicious</h2>
101
101
Create a topic called "my_topic" using the `kafka-topics.sh` command line client:
To start developing your own custom filters for Kroxylicious, you will need to install [JDK 21](https://openjdk.org/projects/jdk/21/).
16
16
17
17
You'll also need to install the [Apache Maven CLI](https://maven.apache.org/index.html) and one of either [Podman](https://podman.io/docs/installation) or [Docker](https://docs.docker.com/install/) (Note that if you are using Podman, you may encounter issues with the integration tests. There are instructions [here](https://github.com/kroxylicious/kroxylicious/blob/main/DEV_GUIDE.md#running-integration-tests-on-podman) to resolve this).
18
18
19
19
<br />
20
20
21
-
### Get the code
21
+
<h2class="fs-3"id="get-the-code-development">Get the code</h2>
22
22
23
23
The easiest way to learn how to build custom filters is with our `kroxylicious-sample` module, which contains some basic find-and-replace filters for you to experiment with.
24
24
Begin by downloading the latest `kroxylicious-sample` sources from the [Kroxylicious repository](https://github.com/kroxylicious/kroxylicious).
Filters can be added and removed by altering the `filters` list in the `sample-proxy-config.yml` file. You can also reconfigure the sample filters by changing the configuration values in this file.
63
63
@@ -68,7 +68,7 @@ The **SampleFetchResponseFilter** and **SampleProduceRequestFilter** each have t
The default configuration for **SampleProduceRequestFilter** is:
74
74
@@ -96,6 +96,6 @@ This means that it will search for the string `bar` in the fetch data and replac
96
96
97
97
<br />
98
98
99
-
#Modify
99
+
<h1 id="modify-development">Modify</h1>
100
100
101
101
Now that you know how the sample filters work, you can start modifying them! Replace the `SampleFilterTransformer` logic with your own code, change which messages they apply to, or whatever else you like!
0 commit comments