Deployment
There are two ways in which Kouncil can be configured:
simple - suitable for most cases, relying solely on
docker run
parametersadvanced - suitable for larger configurations. Provided as an external file, and thus can be tracked in version control. It also exposes additional configuration options, which are not available in the simple configuration
Docker - simple configuration
Simple configuration is passed directly into docker run
command using bootstrapServers
environment variable, just as we've seen in Quick start:
bootstrapServers
variable expects a comma-separated list of brokers, each belonging to a different cluster. Kouncil only needs to know about a single broker from the cluster in order to work.
The simplest possible configuration looks like this:
After that, visit http://localhost in your browser, and you should be greeted with a list of topics from your cluster.
If you have multiple clusters and wish to manage them all with Kouncil, you can do so by simply specifying one broker from each cluster using comma-separated list:
If you want to set Schema Registry url use schemaRegistryUrl
environment variable, for instance:
This url will be used for every cluster in boostrapServers
variable. If you want to be more specific go to Advanced configuration.
If you want to set list of headers to keep while resending events from one topic to another you can use resendHeadersToKeep
environment variable and pass list of comma-seperated header names, for example:
In order to change the port on which Kouncil listens for connections, just modify the -p
argument, like so:
That will cause Kouncil to listen on port 7070
.
Docker - advanced configuration
If you have many Kafka clusters, configuring them using bootstrapServers
may become cumbersome. It is also impossible to express more sophisticated configuration options using such a simple configuration pattern.
To address these issues Kouncil allows you to provide an external configuration in a yaml file.
Kouncil expects this configuration file to be named kouncil.yaml
. After that it's only a matter of binding a directory containing that file into docker - let's say your kouncil.yaml
lives in /home/users/test/Kouncil/config/
, that's how your docker run
should look:
Format of kouncil.yaml
is described below.
Advanced config example
This example shows two clusters, named transaction-cluster
and kouncil
respectively. Each cluster needs to have its name specified. After that comes a list of brokers that make up this cluster - each of which consisting of the broker's host and port on which it's listening on.
Last updated