updated the set of parameters accordingly to the release 5.8.1 (#11)

* updated the set of parameters accordingly to the release 5.8.1 Signed-off-by: Egor I <[email protected]> * adds first and last name atributes Signed-off-by: Egor I <[email protected]> * up the release ID Signed-off-by: Egor I <[email protected]> * up RELEASE_TO_DEPLOY Signed-off-by: Egor I <[email protected]> * fix lost param name Signed-off-by: Egor I <[email protected]> * fix incorrect parameter name Signed-off-by: Egor I <[email protected]> * moves the default role to the top Signed-off-by: Egor I <[email protected]> --------- Signed-off-by: Egor I <[email protected]>
qameta · Aug 16, 2024 · d3915e3 · d3915e3
1 parent b85af3c
commit d3915e3
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 15 deletions.
diff --git a/testops-demo/env-example b/testops-demo/env-example
@@ -6,7 +6,7 @@
 
 # Update this to install different release – check the release notes
 # Release notes: https://docs.qameta.io/allure-testops/release-notes/
-RELEASE_TO_DEPLOY=5.6.4
+RELEASE_TO_DEPLOY=5.8.1
 
 ########################################################################################
 # Registry Settings

diff --git a/testops-ldap/env-example b/testops-ldap/env-example
@@ -7,7 +7,7 @@
 # Release notes: https://docs.qameta.io/allure-testops/release-notes/
 # Migration to version 5 from version 4 is possible from 4.26.5 to 5.3.3
 ########################################################################################
-RELEASE_TO_DEPLOY=5.6.4
+RELEASE_TO_DEPLOY=5.8.1
 
 ########################################################################################
 # Registry Settings

diff --git a/testops-openid/docker-compose.yml b/testops-openid/docker-compose.yml
@@ -96,21 +96,31 @@ services:
 
       # openid settings
       ALLURE_LOGIN_PRIMARY: openid
+      ALLURE_LOGIN_OPENID_DEFAULTROLE: ${TESTOPS_OPENID_DEFAULTROLE}
       SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTNAME: ${TESTOPS_OPENID_CLIENTNAME}
       SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTID: ${TESTOPS_OPENID_CLIENTID}
       SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_CLIENTSECRET: ${TESTOPS_OPENID_CLIENTSECRET}
       SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_REDIRECTURI: ${TESTOPS_OPENID_REDIRECTURI}
-      SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_SCOPE: ${TESTOPS_OPENID_SCOPE}
-      SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_AUTHORIZATIONGRANTTYPE: authorization_code
+      SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_SCOPE: ${TESTOPS_OPENID_SCOPE}
+      SPRING_SECURITY_OAUTH2_CLIENT_REGISTRATION_OPENID_AUTHORIZATIONGRANTTYPE: ${TESTOPS_OPENID_AUTHORIZATIONGRANTTYPE}
       SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_AUTHORIZATIONURI: ${TESTOPS_OPENID_AUTHORIZATIONURI}
-      SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_USERINFOURI: ${TESTOPS_OPENID_USERINFOURI}
-      SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_ISSUERURI: ${TESTOPS_OPENID_ISSUERURI}
       SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_USERNAMEATTRIBUTE: ${TESTOPS_OPENID_USERNAMEATTRIBUTE}
+      SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_JWKSETURI: ${TESTOPS_OPENID_JWKSETURI}
+      SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_TOKENURI: ${TESTOPS_OPENID_TOKENURI}
+
+      # these are optional parameters you can enable if it's required by your openid provider
+      # SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_ISSUERURI: ${TESTOPS_OPENID_ISSUERURI}
+      # SPRING_SECURITY_OAUTH2_CLIENT_PROVIDER_OPENID_USERINFOURI: ${TESTOPS_OPENID_USERINFOURI}
+
+      ALLURE_LOGIN_OPENID_FIRSTNAMEATTRIBUTE: ${TESTOPS_OPENID_FIRSTNAMEATTRIBUTE}
+      ALLURE_LOGIN_OPENID_LASTAMEATTRIBUTE: ${TESTOPS_OPENID_LASTAMEATTRIBUTE}
+
+      # these parameters are for the usage with OpenID IdP groups to assign the global roles to users
+      # depending on the membership in OpenID provider groups      
       ALLURE_LOGIN_OPENID_SYNCROLES: ${TESTOPS_OPENID_SYNCROLES}
       ALLURE_LOGIN_OPENID_GROUPROLEATTRIBUTE: ${TESTOPS_OPENID_GROUPROLEATTRIBUTE}
       ALLURE_LOGIN_OPENID_GROUPAUTHORITIES_ROLEUSERGROUPS: ${TESTOPS_OPENID_GROUPAUTHORITIES_ROLEUSERGROUPS}
       ALLURE_LOGIN_OPENID_GROUPAUTHORITIES_ROLEADMINGROUPS: ${TESTOPS_OPENID_GROUPAUTHORITIES_ROLEADMINGROUPS}
-      ALLURE_LOGIN_OPENID_DEFAULTROLE: ${TESTOPS_OPENID_DEFAULTROLE}
 
       TZ: ${TZ}
       JAVA_TOOL_OPTIONS: >

diff --git a/testops-openid/env-example b/testops-openid/env-example
@@ -6,7 +6,7 @@
 # Update this to install different release – check the release notes
 # Release notes: https://docs.qameta.io/allure-testops/release-notes/
 
-RELEASE_TO_DEPLOY=5.6.4
+RELEASE_TO_DEPLOY=5.8.1
 
 ########################################################################################
 # Registry Settings
@@ -201,15 +201,25 @@ SMTP_SSL_TRUST=smtp.gmail.com
 # TESTOPS_OPENID_USERINFOURI - It is advertised in the server metadata
 # TESTOPS_OPENID_ISSUERURI - It is advertised in the server metadata
 
-TESTOPS_OPENID_CLIENTNAME=TestOps
+TESTOPS_OPENID_CLIENTNAME=testops
 TESTOPS_OPENID_CLIENTID=<YOUR_CLIENT_ID>
 TESTOPS_OPENID_CLIENTSECRET=<YOUR_CLIENT_SECRET_HERE>
-TESTOPS_OPENID_REDIRECTURI=https://<your-domain>/login/oauth2/code/openid
+TESTOPS_OPENID_REDIRECTURI=http://<your-testops-domain>/login/oauth2/code/openid
 TESTOPS_OPENID_SCOPE=openid,email,profile
-TESTOPS_OPENID_AUTHORIZATIONURI=http://<open_id_provider_url>/realms/<you_realm>/protocol/openid-connect/auth
-TESTOPS_OPENID_USERINFOURI=http://<open_id_provider_url>/realms/<you_realm>/protocol/openid-connect/userinfo
-TESTOPS_OPENID_ISSUERURI=http://<open_id_provider_url>/realms/<you_realm>
 TESTOPS_OPENID_USERNAMEATTRIBUTE=preferred_username
+TESTOPS_OPENID_AUTHORIZATIONGRANTTYPE=authorization_code
+TESTOPS_OPENID_AUTHORIZATIONURI=http://<open_id_provider_url>/somepath/openid-connect/auth
+TESTOPS_OPENID_JWKSETURI=http://<open_id_provider_url>/somepath/keys
+TESTOPS_OPENID_TOKENURI=http://<open_id_provider_url>/somepath/token
+
+# optional parameters commented in docker-compose.yml
+# uncomment these in docker-compose.yml if you know what you are doing and really need using these for the integration with IdP
+# TESTOPS_OPENID_ISSUERURI=http://<open_id_provider_url>/realms/<you_realm>
+# TESTOPS_OPENID_USERINFOURI=http://<open_id_provider_url>/realms/<you_realm>/protocol/openid-connect/userinfo
+
+# name of the parameter (claim) defining the name of the end user being authenticated
+TESTOPS_OPENID_FIRSTNAMEATTRIBUTE: first_name
+TESTOPS_OPENID_LASTAMEATTRIBUTE: last_name
 
 TESTOPS_OPENID_DEFAULTROLE=ROLE_GUEST
 # TESTOPS_OPENID_SYNCROLES - Defines whether TestOps should assign global roles based on the OpenID server group membership

diff --git a/testops-saml/env-example b/testops-saml/env-example
@@ -6,7 +6,7 @@
 # Release notes: https://docs.qameta.io/allure-testops/release-notes/
 # Migration to version 5 from version 4 is possible from 4.26.5 to 5.5.1
 
-RELEASE_TO_DEPLOY=5.6.4
+RELEASE_TO_DEPLOY=5.8.1
 
 ########################################################################################
 # Registry Settings

diff --git a/testops/env-example b/testops/env-example
@@ -6,7 +6,7 @@
 # Release notes: https://docs.qameta.io/allure-testops/release-notes/
 # Migration to version 5 from version 4 is possible from 4.26.5 to 5.5.1
 
-RELEASE_TO_DEPLOY=5.6.4
+RELEASE_TO_DEPLOY=5.8.1
 
 ########################################################################################
 # Registry Settings