diff --git a/docs/.github/img/kouncil_cluster_form.png b/docs/.github/img/kouncil_cluster_form.png new file mode 100644 index 00000000..da792aea Binary files /dev/null and b/docs/.github/img/kouncil_cluster_form.png differ diff --git a/docs/.github/img/kouncil_cluster_form_cluster_security.png b/docs/.github/img/kouncil_cluster_form_cluster_security.png new file mode 100644 index 00000000..78e8fcc3 Binary files /dev/null and b/docs/.github/img/kouncil_cluster_form_cluster_security.png differ diff --git a/docs/.github/img/kouncil_cluster_form_schema_registry.png b/docs/.github/img/kouncil_cluster_form_schema_registry.png new file mode 100644 index 00000000..c04cec58 Binary files /dev/null and b/docs/.github/img/kouncil_cluster_form_schema_registry.png differ diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 01d7bbb2..dcff3ce8 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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) diff --git a/docs/configuration/KAFKA_CLUSTER.md b/docs/configuration/KAFKA_CLUSTER.md new file mode 100644 index 00000000..67b694dd --- /dev/null +++ b/docs/configuration/KAFKA_CLUSTER.md @@ -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. + +

+ +

+ +### Cluster SSL/TLS configuration + +If your Kafka cluster requires any authentication you are able to configure `SASL`, `SSL` +or `AWS MSK` authentication. + +

+ +

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

+ +

+ +If your Schema Registry requires any authentication you are able to configure `SSL` +or `SSL with basic authentication` security. diff --git a/docs/configuration/kafka/AWS_MSK.md b/docs/configuration/kafka/AWS_MSK.md index 30ad95f4..9af26d36 100644 --- a/docs/configuration/kafka/AWS_MSK.md +++ b/docs/configuration/kafka/AWS_MSK.md @@ -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 diff --git a/docs/configuration/kafka/SASL_PLAIN.md b/docs/configuration/kafka/SASL_PLAIN.md index 513e6974..ddffa963 100644 --- a/docs/configuration/kafka/SASL_PLAIN.md +++ b/docs/configuration/kafka/SASL_PLAIN.md @@ -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 diff --git a/docs/configuration/kafka/TLS.md b/docs/configuration/kafka/TLS.md index 07dc5555..7b91bb07 100644 --- a/docs/configuration/kafka/TLS.md +++ b/docs/configuration/kafka/TLS.md @@ -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: diff --git a/docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL.md b/docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL.md index f71b3d63..25683afd 100644 --- a/docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL.md +++ b/docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL.md @@ -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 diff --git a/docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL_BASIC_AUTH.md b/docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL_BASIC_AUTH.md index 89c08dc2..e5924e10 100644 --- a/docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL_BASIC_AUTH.md +++ b/docs/configuration/schema-registry/SCHEMA_REGISTRY_SSL_BASIC_AUTH.md @@ -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. diff --git a/kouncil-backend/src/main/java/com/consdata/kouncil/config/cluster/ClusterConfigReader.java b/kouncil-backend/src/main/java/com/consdata/kouncil/config/cluster/ClusterConfigReader.java index 2976c5f8..2348bb1c 100644 --- a/kouncil-backend/src/main/java/com/consdata/kouncil/config/cluster/ClusterConfigReader.java +++ b/kouncil-backend/src/main/java/com/consdata/kouncil/config/cluster/ClusterConfigReader.java @@ -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 diff --git a/kouncil-backend/src/main/java/com/consdata/kouncil/config/security/UserGroupsConfigReader.java b/kouncil-backend/src/main/java/com/consdata/kouncil/config/security/UserGroupsConfigReader.java index 6254b3b5..b4661fb5 100644 --- a/kouncil-backend/src/main/java/com/consdata/kouncil/config/security/UserGroupsConfigReader.java +++ b/kouncil-backend/src/main/java/com/consdata/kouncil/config/security/UserGroupsConfigReader.java @@ -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