|
@@ -1,13 +1,13 @@
|
|
# How to configure SSO
|
|
# How to configure SSO
|
|
SSO require additionaly to configure TLS for application, in that example we will use self-signed certificate, in case of use legal certificates please skip step 1.
|
|
SSO require additionaly to configure TLS for application, in that example we will use self-signed certificate, in case of use legal certificates please skip step 1.
|
|
-#### Step 1
|
|
|
|
|
|
+## Step 1
|
|
At this step we will generate self-signed PKCS12 keypair.
|
|
At this step we will generate self-signed PKCS12 keypair.
|
|
``` bash
|
|
``` bash
|
|
mkdir cert
|
|
mkdir cert
|
|
keytool -genkeypair -alias ui-for-apache-kafka -keyalg RSA -keysize 2048 \
|
|
keytool -genkeypair -alias ui-for-apache-kafka -keyalg RSA -keysize 2048 \
|
|
-storetype PKCS12 -keystore cert/ui-for-apache-kafka.p12 -validity 3650
|
|
-storetype PKCS12 -keystore cert/ui-for-apache-kafka.p12 -validity 3650
|
|
```
|
|
```
|
|
-#### Step 2
|
|
|
|
|
|
+## Step 2
|
|
Create new application in any SSO provider, we will continue with [Auth0](https://auth0.com).
|
|
Create new application in any SSO provider, we will continue with [Auth0](https://auth0.com).
|
|
|
|
|
|
<img src="https://github.com/provectus/kafka-ui/raw/images/images/sso-new-app.png" width="70%"/>
|
|
<img src="https://github.com/provectus/kafka-ui/raw/images/images/sso-new-app.png" width="70%"/>
|
|
@@ -20,7 +20,7 @@ This is a main parameters required for enabling SSO
|
|
|
|
|
|
<img src="https://github.com/provectus/kafka-ui/raw/images/images/sso-parameters.png" width="70%"/>
|
|
<img src="https://github.com/provectus/kafka-ui/raw/images/images/sso-parameters.png" width="70%"/>
|
|
|
|
|
|
-#### Step 3
|
|
|
|
|
|
+## Step 3
|
|
To launch UI for Apache Kafka with enabled TLS and SSO run following:
|
|
To launch UI for Apache Kafka with enabled TLS and SSO run following:
|
|
``` bash
|
|
``` bash
|
|
docker run -p 8080:8080 -v `pwd`/cert:/opt/cert -e AUTH_TYPE=LOGIN_FORM \
|
|
docker run -p 8080:8080 -v `pwd`/cert:/opt/cert -e AUTH_TYPE=LOGIN_FORM \
|
|
@@ -46,5 +46,25 @@ docker run -p 8080:8080 -v `pwd`/cert:/opt/cert -e AUTH_TYPE=OAUTH2 \
|
|
provectuslabs/kafka-ui:latest
|
|
provectuslabs/kafka-ui:latest
|
|
```
|
|
```
|
|
|
|
|
|
-#### Step 4 (optional)
|
|
|
|
-If you're using load balancer/proxy and use HTTP between the proxy and the app, you might wanna set `server_forward-headers-strategy` to `native` as well, for more info refer to [this issue](https://github.com/provectus/kafka-ui/issues/1017).
|
|
|
|
|
|
+## Step 4 (Load Balancer HTTP) (optional)
|
|
|
|
+If you're using load balancer/proxy and use HTTP between the proxy and the app, you might want to set `server_forward-headers-strategy` to `native` as well (`SERVER_FORWARDHEADERSSTRATEGY=native`), for more info refer to [this issue](https://github.com/provectus/kafka-ui/issues/1017).
|
|
|
|
+
|
|
|
|
+## Step 5 (Azure) (optional)
|
|
|
|
+For Azure AD (Office365) OAUTH2 you'll want to add additional environment variables:
|
|
|
|
+
|
|
|
|
+```bash
|
|
|
|
+docker run -p 8080:8080 \
|
|
|
|
+ -e KAFKA_CLUSTERS_0_NAME="${cluster_name}"\
|
|
|
|
+ -e KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS="${kafka_listeners}" \
|
|
|
|
+ -e KAFKA_CLUSTERS_0_ZOOKEEPER="${zookeeper_servers}" \
|
|
|
|
+ -e KAFKA_CLUSTERS_0_KAFKACONNECT_0_ADDRESS="${kafka_connect_servers}"
|
|
|
|
+ -e AUTH_TYPE=OAUTH2 \
|
|
|
|
+ -e SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_AUTH0_CLIENTID=uhvaPKIHU4ZF8Ne4B6PGvF0hWW6OcUSB \
|
|
|
|
+ -e SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_AUTH0_CLIENTSECRET=YXfRjmodifiedTujnkVr7zuW9ECCAK4TcnCio-i \
|
|
|
|
+ -e SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_AUTH0_SCOPE="https://graph.microsoft.com/User.Read" \
|
|
|
|
+ -e SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_AUTH0_ISSUER_URI="https://login.microsoftonline.com/{tenant-id}/v2.0" \
|
|
|
|
+ -d provectuslabs/kafka-ui:latest"
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+Note that scope is created by default when Application registration is done in Azure portal.
|
|
|
|
+You'll need to update application registration manifest to include `"accessTokenAcceptedVersion": 2`
|