provectus / kafka-ui-docs Goto Github PK

Issue submitter TODO list

• I've looked up my issue in FAQ
• I've searched for an already existing issues here
• I've tried running master-labeled docker image and the issue still persists there
• I'm running a supported version of the application which is listed here

Describe the bug (actual behavior)

The documentation for data masking: https://docs.kafka-ui.provectus.io/configuration/data-masking are not aligned with the code. Documentation suggests to add KAFKA_CLUSTERS_0_MASKING_2_PATTERN_X to mask the data in value or key, but this is not behaving as expected.

Looking into the code: https://github.com/provectus/kafka-ui/blob/master/kafka-ui-api/src/main/java/com/provectus/kafka/ui/config/ClustersProperties.java#L137 the variable name is maskingCharsReplacement and not pattern. Thus, in order to get the masking to work, the env variable needs to be named: KAFKA_CLUSTERS_0_MASKING_2_MASKING_CHARS_REPLACEMENT_X.

Expected behavior

Documentation and code should be aligned.
Currently, I don't think KAFKA_CLUSTERS_0_MASKING_2_MASKING_CHARS_REPLACEMENT_X is an appropriate and easy to use name.

Your installation details

Commit hash: 56fa824

Steps to reproduce

Running docker with the newest version of the code with following env variables:

KAFKA_CLUSTERS_0_MASKING_0_TYPE=MASK
KAFKA_CLUSTERS_0_MASKING_0_PATTERN_0=*
KAFKA_CLUSTERS_0_MASKING_0_PATTERN_1=*
KAFKA_CLUSTERS_0_MASKING_0_PATTERN_2=*
KAFKA_CLUSTERS_0_MASKING_0_PATTERN_3=*
KAFKA_CLUSTERS_0_MASKING_0_TOPICVALUESPATTERN=.my-secret-topic.

Not masking with **** but with the default pattern: Xxn-

Screenshots

No response

Logs

No response

Additional context

No response

Hello,

Hope you're well, I'm trying to setup kafka-ui basic authentication, however, I don't really know how to "extrapolate" this from docker compose files or k8s as this is being setup as environment variables.

Setup is being configured in Ubuntu 22.04 (without docker or k8s files, just going through java)
/bin/java -Dspring.config.additional-location=/opt/kafka-ui/application-local.yml --add-opens java.rmi/javax.rmi.ssl=ALL-UNNAMED -jar /opt/kafka-ui/kafka-ui-api-v0.7.2.jar

  AUTH_TYPE: "LOGIN_FORM"
  SPRING_SECURITY_USER_NAME: admin
  SPRING_SECURITY_USER_PASSWORD: pass

Could you please provide a basic working "application-local.yml" working with the mentioned variables so we can have a reference to work with?

Thanks in advance,
Regards.

Hey everyone,

regarding this file:
https://github.com/provectus/kafka-ui-docs/blob/main/quick-start/prerequisites/permissions/msk-+serverless-setup.md

you give group permissions on a topic resource:

            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "kafka-cluster:DeleteGroup",  <== this line
                "kafka-cluster:DescribeCluster",
                "kafka-cluster:ReadData",
                "kafka-cluster:DescribeTopicDynamicConfiguration",
                "kafka-cluster:AlterTopicDynamicConfiguration",
                "kafka-cluster:AlterGroup",  <== this line
                "kafka-cluster:AlterClusterDynamicConfiguration",
                "kafka-cluster:AlterTopic",
                "kafka-cluster:CreateTopic",
                "kafka-cluster:DescribeTopic",
                "kafka-cluster:AlterCluster",
                "kafka-cluster:DescribeGroup",  <== this line
                "kafka-cluster:DescribeClusterDynamicConfiguration",
                "kafka-cluster:Connect",
                "kafka-cluster:DeleteTopic",
                "kafka-cluster:WriteData"
            ],
            "Resource": "arn:aws:kafka:eu-central-1:297478128798:topic  <== the permissions are for topic

is this a mistake?

thanks a lot in advance.

Add configuration example for sticky session similar to nginx ingress to EKS and ALB ingress controller.