diff --git a/README.md b/README.md index cab64d81d127483cd7e3241f890f9ecc1b26df31..4dd9a6aa57322f2723dee801d926dfa543ad140f 100644 --- a/README.md +++ b/README.md @@ -7,19 +7,19 @@ If you want to learn more about Quarkus, please visit its website: https://quark ## Configuring the application This properties must be configured to run the application -| Key | Value | Default | Mandatory | Description | -|-----------------------------------------------|----------------------------------------------------|------------------------| --------- |----------------------------------------------------------------| -| quarkus.oidc.auth-server-url | https://sso.dev.by.ozg-cloud.de/realms/sh-kiel-dev | none | yes | Url of the keycloak server with the realm | -| quarkus.mongodb.connection-string | mongodb://ozg-mongodb:27017 | none | yes | The connection string for the mongo db database | -| quarkus.mongodb.database | usermanager | usermanager | no | Name of the mongo db database | -| usermanager.keycloak.sync.period | 5m | 6h | no | Period between synchronizations | -| usermanager.keycloak.api.user | apiUser | none | yes | The name of the keycloak admin api user | -| usermanager.keycloak.api.password | **** | none | yes | The password of the keycloak admin api user | -| usermanager.keycloak.api.realm | realm-name | none | yes | The name of the realm | -| usermanager.keycloak.api.organisations-einheit-id-key | organisationseinheitId | organisationseinheitId | no | The key where the organisationsEinheitId of the group is saved | -| usermanager.keycloak.api.ldap-id-key | LDAP_ID | LDAP_ID | no | The key to get the keycloak user id from | -| usermanager.usermanager.url | http://localhost:8080 | none | yes | The external root url of the usermanager | -| keycloak.url | https://sso.service | none | yes | The root url of the keycloak service | +| Key | Value | Default | Mandatory | Description | +|----------------------------------------------------|----------------------------------------------------|------------------------| --------- |----------------------------------------------------------------| +| quarkus.oidc.auth-server-url | https://sso.dev.by.ozg-cloud.de/realms/sh-kiel-dev | none | yes | Url of the keycloak server with the realm | +| quarkus.mongodb.connection-string | mongodb://ozg-mongodb:27017 | none | yes | The connection string for the mongo db database | +| quarkus.mongodb.database | usermanager | usermanager | no | Name of the mongo db database | +| ozgcloud.keycloak.sync.period | 5m | 6h | no | Period between synchronizations | +| ozgcloud.keycloak.api.user | apiUser | none | yes | The name of the keycloak admin api user | +| ozgcloud.keycloak.api.password | **** | none | yes | The password of the keycloak admin api user | +| ozgcloud.keycloak.api.realm | realm-name | none | yes | The name of the realm | +| ozgcloud.keycloak.api.organisations-einheit-id-key | organisationseinheitId | organisationseinheitId | no | The key where the organisationsEinheitId of the group is saved | +| ozgcloud.keycloak.api.ldap-id-key | LDAP_ID | LDAP_ID | no | The key to get the keycloak user id from | +| ozgcloud.usermanager.url | http://localhost:8080 | none | yes | The external root url of the usermanager | +| keycloak.url | https://sso.service | none | yes | The root url of the keycloak service | ## Running the application in dev mode @@ -47,7 +47,7 @@ use below configuration in your IDE or CLI. ``` -Dquarkus.profile=local,remotekc -Dquarkus.oidc.auth-server-url=https://sso.dev.by.ozg-cloud.de/realms/sebo-test --Dusermanager.keycloak.api.realm=sebo-test +-Dozgcloud.keycloak.api.realm=sebo-test -Dozgcloud.usersync.period="5s" ``` @@ -123,7 +123,7 @@ Usermanager als über-jar erstellen und lokal starten: ./mvnw clean package -Dquarkus.package.type=uber-jar java -Dquarkus.oidc.auth-server-url=https://sso.dev.by.ozg-cloud.de/realms/by-kiel-dev \ - -Dusermanager.user-manager.url=http://localhost:8080 \ + -Dozgcloud.user-manager.url=http://localhost:8080 \ -Dkeycloak.url=https://sso.dev.by.ozg-cloud.de \ -jar ./target/user-manager-server-1.3.0-SNAPSHOT-runner.jar ``` @@ -136,12 +136,12 @@ Usermanager als native Anwendung erstellen und lokal starten: ./target/user-manager-server-1.3.0-SNAPSHOT-runner \ -Dquarkus.oidc.auth-server-url=https://sso.dev.by.ozg-cloud.de/realms/by-kiel-dev \ -Dquarkus.mongodb.connection-string=mongodb://localhost:27018 \ - -Dusermanager.user-manager.url=http://localhost:8080 \ + -Dozgcloud.user-manager.url=http://localhost:8080 \ -Dkeycloak.url=https://sso.dev.by.ozg-cloud.de \ - -Dusermanager.keycloak.api.user=usermanagerapiuser \ - -Dusermanager.keycloak.api.password=hlc_j1I1Ji0trC0 \ - -Dusermanager.keycloak.api.realm=by-kiel-dev \ - -Dusermanager.keycloak.api.client=alfa \ + -Dozgcloud.keycloak.api.user=usermanagerapiuser \ + -Dozgcloud.keycloak.api.password=hlc_j1I1Ji0trC0 \ + -Dozgcloud.keycloak.api.realm=by-kiel-dev \ + -Dozgcloud.keycloak.api.client=alfa \ -Dozgcloud.usersync.period="5m" \ -Xmx32m ``` diff --git a/src/main/helm/templates/api-password-secret.yaml b/src/main/helm/templates/api-password-secret.yaml index dd058817417fbb3f6de3353899b8543aa8913cc7..7402d8532ea15c212f1f6d4f1541260f00dccfae 100644 --- a/src/main/helm/templates/api-password-secret.yaml +++ b/src/main/helm/templates/api-password-secret.yaml @@ -7,5 +7,5 @@ metadata: {{- include "app.defaultLabels" . | indent 4 }} type: Opaque stringData: - password: {{ required "usermanager.keycloak.api.password must be set" .Values.usermanager.keycloak.api.password }} + password: {{ required "ozgcloud.keycloak.api.password must be set" .Values.ozgcloud.keycloak.api.password }} {{- end -}} \ No newline at end of file diff --git a/src/main/helm/templates/deployment.yaml b/src/main/helm/templates/deployment.yaml index 8506d1be8d73c50551720fa71358de112b0f2ead..b97170fb85bd63630fba0d4a067d7a3e9267ae47 100644 --- a/src/main/helm/templates/deployment.yaml +++ b/src/main/helm/templates/deployment.yaml @@ -71,7 +71,7 @@ spec: key: password optional: false - name: USERMANAGER_KEYCLOAK_API_USER - value: {{ .Values.usermanager.keycloak.api.user }} + value: {{ .Values.ozgcloud.keycloak.api.user }} {{- else }} - name: USERMANAGER_KEYCLOAK_API_PASSWORD valueFrom: diff --git a/src/main/helm/values.yaml b/src/main/helm/values.yaml index 49ea5ea4dda8c316c846b3db7cadbb4d5edb0e8d..06730ae8eed51e977b8b74ef13d244c8da6f904c 100644 --- a/src/main/helm/values.yaml +++ b/src/main/helm/values.yaml @@ -34,7 +34,7 @@ image: database: # username is always <release-name>-database-user databaseName: user-manager-database -usermanager: +ozgcloud: keycloak: api: user: userManagerApiUser diff --git a/src/test/unit-values.yaml b/src/test/unit-values.yaml index 1c14973f2e25c06a6325ae788a03345b758be9e6..ef7bd06c5e1b26a563664cfc4fc0c38e30602279 100644 --- a/src/test/unit-values.yaml +++ b/src/test/unit-values.yaml @@ -29,7 +29,7 @@ kop: bezeichner: helm environment: test -usermanager: +ozgcloud: keycloak: api: password: geheim diff --git a/user-manager-server/src/main/java/de/itvsh/kop/user/UserProfileResource.java b/user-manager-server/src/main/java/de/itvsh/kop/user/UserProfileResource.java index 5096f106ea65fb4064db3297e04b91e35782e27e..75135331fbdd58761575a3ba80da234c817f7b78 100644 --- a/user-manager-server/src/main/java/de/itvsh/kop/user/UserProfileResource.java +++ b/user-manager-server/src/main/java/de/itvsh/kop/user/UserProfileResource.java @@ -61,7 +61,7 @@ public class UserProfileResource { // TODO parameter in den resourceAssembler verschieben // TODO wozu ist der eigentlich gut? - bitte aus Request übernehmen - @ConfigProperty(name = "usermanager.user-manager.url") + @ConfigProperty(name = "ozgcloud.user-manager.url") String userManagerUrl; @GET diff --git a/user-manager-server/src/main/java/de/itvsh/kop/user/keycloak/KeycloakApiProperties.java b/user-manager-server/src/main/java/de/itvsh/kop/user/keycloak/KeycloakApiProperties.java index 4fbbf14d58a9dd47f6dd1dfebbf90d3b8178a9af..196b98fc31ce8cde4b0e18da7f1f4e1b3192a93c 100644 --- a/user-manager-server/src/main/java/de/itvsh/kop/user/keycloak/KeycloakApiProperties.java +++ b/user-manager-server/src/main/java/de/itvsh/kop/user/keycloak/KeycloakApiProperties.java @@ -27,7 +27,7 @@ import jakarta.validation.constraints.NotBlank; import io.smallrye.config.ConfigMapping; -@ConfigMapping(prefix = "usermanager.keycloak.api") +@ConfigMapping(prefix = "ozgcloud.keycloak.api") public interface KeycloakApiProperties { @NotBlank diff --git a/user-manager-server/src/main/java/de/itvsh/kop/user/settings/UserSettingsResource.java b/user-manager-server/src/main/java/de/itvsh/kop/user/settings/UserSettingsResource.java index b7b2245b9f70b63ec565b19c8b9cc5cfcb88b103..fef1c8c4463841035dc2f76f7fb5a0208b180394 100644 --- a/user-manager-server/src/main/java/de/itvsh/kop/user/settings/UserSettingsResource.java +++ b/user-manager-server/src/main/java/de/itvsh/kop/user/settings/UserSettingsResource.java @@ -63,7 +63,7 @@ public class UserSettingsResource { @Inject UserSettingsResourceAssembler resourceAssembler; - @ConfigProperty(name = "usermanager.user-manager.url") + @ConfigProperty(name = "ozgcloud.user-manager.url") String userManagerUrl; @GET diff --git a/user-manager-server/src/main/resources/application-e2e.yaml b/user-manager-server/src/main/resources/application-e2e.yaml index 8fd85772f9f12a9056de1f3380e5e4d68081477f..8271e98165715c5c001c00c88febd06af92a8198 100644 --- a/user-manager-server/src/main/resources/application-e2e.yaml +++ b/user-manager-server/src/main/resources/application-e2e.yaml @@ -14,17 +14,15 @@ quarkus: level: TRACE min-level: TRACE -usermanager: +keycloak: + url: https://sso.dev.by.ozg-cloud.de + +ozgcloud: keycloak: api: user: userManagerApiUser password: S9UEMuLG9y9ev99 realm: by-e2e-local-dev client: alfa - -keycloak: - url: https://sso.dev.by.ozg-cloud.de - -ozgcloud: usersync: period: disabled \ No newline at end of file diff --git a/user-manager-server/src/main/resources/application-local.yaml b/user-manager-server/src/main/resources/application-local.yaml index b9edd8d31b660d51f1c0d6deac59b3960f8337f4..ed73dcd875b0b22577007c10eea629a8a0dd9b86 100644 --- a/user-manager-server/src/main/resources/application-local.yaml +++ b/user-manager-server/src/main/resources/application-local.yaml @@ -6,7 +6,7 @@ quarkus: console: json: false -usermanager: +ozgcloud: user-manager: url: http://localhost:9092 diff --git a/user-manager-server/src/main/resources/application-remotekc.yaml b/user-manager-server/src/main/resources/application-remotekc.yaml index 6f314558b6a58eb260249863229b7fb6a83460a2..7522b73325d3ae81f5ac7dce0d490d69392930e5 100644 --- a/user-manager-server/src/main/resources/application-remotekc.yaml +++ b/user-manager-server/src/main/resources/application-remotekc.yaml @@ -13,7 +13,7 @@ quarkus: ~: true origins: http://localhost:4300 -usermanager: +ozgcloud: user-manager: url: http://localhost:9092 keycloak: @@ -24,7 +24,5 @@ usermanager: organisations-einheit-id-key: organisationseinheitId client: alfa ldap-id-key: LDAP_ID - -ozgcloud: usersync: period: disabled \ No newline at end of file diff --git a/user-manager-server/src/main/resources/application.yaml b/user-manager-server/src/main/resources/application.yaml index a1778062d8b777863ae6351f4e3122e019e9de21..2b4d4d46bbb8454c3a07367095923d2b59921254 100644 --- a/user-manager-server/src/main/resources/application.yaml +++ b/user-manager-server/src/main/resources/application.yaml @@ -36,7 +36,7 @@ grpc: server: enable-reflection-service: true -usermanager: +ozgcloud: keycloak: api: ldap-id-key: LDAP_ID @@ -45,7 +45,5 @@ usermanager: password: "-" realm: by-kiel-dev client: alfa - -ozgcloud: usersync: period: "6h" \ No newline at end of file diff --git a/user-manager-server/src/test/java/de/itvsh/kop/user/keycloak/KeycloakTestProfile.java b/user-manager-server/src/test/java/de/itvsh/kop/user/keycloak/KeycloakTestProfile.java index ecc3cb78b6cae2cac3217baaf6e73d1512de1084..7fa5e7a7d4b0dcd2495df841794ea7242bddcc03 100644 --- a/user-manager-server/src/test/java/de/itvsh/kop/user/keycloak/KeycloakTestProfile.java +++ b/user-manager-server/src/test/java/de/itvsh/kop/user/keycloak/KeycloakTestProfile.java @@ -29,13 +29,13 @@ import io.quarkus.test.junit.QuarkusTestProfile; public class KeycloakTestProfile implements QuarkusTestProfile { - private final String userKey = "usermanager.keycloak.api.user"; + private final String userKey = "ozgcloud.keycloak.api.user"; private final String userValue = "userManagerApiUser"; - private final String passwordKey = "usermanager.keycloak.api.password"; + private final String passwordKey = "ozgcloud.keycloak.api.password"; private final String passwordValue = "hlc_j1I1Ji0trC0"; - private final String realmKey = "usermanager.keycloak.api.realm"; + private final String realmKey = "ozgcloud.keycloak.api.realm"; private final String realmValue = "by-kiel-dev"; private final String urlKey = "keycloak.url"; diff --git a/user-manager-server/src/test/resources/application.yml b/user-manager-server/src/test/resources/application.yml index cef56f22c5f79db922365902d58e50e14be3a352..46b99472074ade5ea9df92f4b9a8baf2525e6598 100644 --- a/user-manager-server/src/test/resources/application.yml +++ b/user-manager-server/src/test/resources/application.yml @@ -16,7 +16,10 @@ quarkus: oidc: auth-server-url: https://sso.dev.by.ozg-cloud.de/realms/by-kiel-dev -usermanager: +keycloak: + url: http://localhost:8088 + +ozgcloud: keycloak: api: user: "-" @@ -27,9 +30,5 @@ usermanager: client: alfa user-manager: url: http://localhost:9092 -keycloak: - url: http://localhost:8088 - -ozgcloud: usersync: period: disabled \ No newline at end of file