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

IKC-398 Documentation #374

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/.github/img/kouncil_cluster_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [Authentication](configuration/security/AUTHENTICATION.md)
* [Authorization](configuration/security/AUTHORIZATION.md)
* SSL/TLS Configuration
* [Configuration](configuration/KAFKA_CLUSTER.md)
* Kafka
* [TLS configuration](configuration/kafka/TLS.md)
* [Broker SSL configuration](configuration/kafka/SASL_PLAIN.md)
Expand Down
29 changes: 29 additions & 0 deletions docs/configuration/KAFKA_CLUSTER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Managing Kafka clusters

Starting from version 1.9 you will be able to configure and secure your Kafka clusters from UI. To
do it log in to the app and select Clusters menu item. You will see your clusters list. To add new
cluster click `Add new cluster` button and cluster form will be opened.

<p align="left">
<img src="../.github/img/kouncil_cluster_form.png" width="820">
</p>

### Cluster SSL/TLS configuration

If your Kafka cluster requires any authentication you are able to configure `SASL`, `SSL`
or `AWS MSK` authentication.

<p align="left">
<img src="../.github/img/kouncil_cluster_form_cluster_security.png" width="820">
</p>

### Schema registry

Within this form you are able to add Schema Registry to your cluster.

<p align="left">
<img src="../.github/img/kouncil_cluster_form_schema_registry.png" width="820">
</p>

If your Schema Registry requires any authentication you are able to configure `SSL`
or `SSL with basic authentication` security.
6 changes: 6 additions & 0 deletions docs/configuration/kafka/AWS_MSK.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Advanced config - Amazon MSK Kafka cluster

{% hint style="warning" %}
**WARNING**

This configuration will be deprecated in version 1.9 and removed in the future. In version 1.9 this configuration will be used to preload your clusters.
{% endhint %}

If one of your brokers in cluster environment is located in Amazon MSK cluster you should specify `saslMechanism`, `saslProtocol`, `saslJassConfig` and `saslCallbackHandler` for this broker, like this:

```yaml
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/kafka/SASL_PLAIN.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Advanced config - SASL Plain Authentication

{% hint style="warning" %}
**WARNING**

This configuration will be deprecated in version 1.9 and removed in the future. In version 1.9 this configuration will be used to preload your clusters.
{% endhint %}

If one of your brokers in cluster environment needs SASL authentication you should specify `saslMechanism`, `saslProtocol` and `saslJassConfig` for this broker, like this:

```yaml
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/kafka/TLS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Advanced config - TLS

{% hint style="warning" %}
**WARNING**

This configuration will be deprecated in version 1.9 and removed in the future. In version 1.9 this configuration will be used to preload your clusters.
{% endhint %}

Let's assume that your Kafka is secured and you need mTLS to connect. You need to provide a client truststore, containing CA public certificate and keystore with both client private key and CA signed certificate.
Then add "kafka" node to your yaml with the following values:

Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Advanced config - SSL Schema registry

{% hint style="warning" %}
**WARNING**

This configuration will be deprecated in version 1.9 and removed in the future. In version 1.9 this configuration will be used to preload your clusters.
{% endhint %}

Let's assume that your SchemaRegistry is secured and you need SSL to connect. You need to provide a client truststore, containing CA public certificate and keystore with both client private key and CA signed certificate.

```yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
## Advanced config - Schema registry SSL and BASIC Authentication

{% hint style="warning" %}
**WARNING**

This configuration will be deprecated in version 1.9 and removed in the future. In version 1.9 this configuration will be used to preload your clusters.
{% endhint %}

Let's assume that your SchemaRegistry is secured and you need SSL and BASIC authentication to connect. You need to provide a client truststore, containing CA public certificate and keystore with both client private key and CA signed certificate.
And fot the BASIC authentication you need to provide user-info which will be use to authenticate when Kouncil will connect to Schema Registry.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@
import org.springframework.stereotype.Component;

/**
* @deprecated will be removed in version 1.10.
* @deprecated will be removed in the future.
*/
@Deprecated(since = "version 1.10")
@Deprecated
@Component
@Data
@RequiredArgsConstructor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
import org.springframework.stereotype.Component;

/**
* @deprecated will be removed in version 1.10.
* @deprecated will be removed in the future.
*/
@Deprecated(since = "version 1.10")
@Deprecated
@Component
@Data
@RequiredArgsConstructor
Expand Down
Loading