Bug 56301 - Wrong Commands in Documentation for mariadb backend
Wrong Commands in Documentation for mariadb backend
Status: NEW
Product: UCS
Classification: Unclassified
Component: Keycloak
UCS 5.0
Other Linux
: P5 normal (vote)
: ---
Assigned To: UCS maintainers
UCS maintainers
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2023-07-11 06:36 CEST by Daniel Duchon
Modified: 2023-08-03 11:23 CEST (History)
1 user (show)

See Also:
What kind of report is it?: Bug Report
What type of bug is this?: 3: Simply Wrong: The implementation doesn't match the docu
Who will be affected by this bug?: 2: Will only affect a few installed domains
How will those affected feel about the bug?: 5: Blocking further progress on the daily work
User Pain: 0.171
Enterprise Customer affected?: Yes
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Daniel Duchon univentionstaff 2023-07-11 06:36:53 CEST
The Documentation for mariadb[1] as backend uses wrong startparameters for univention-app configure

1: The after installation step says, you have to specify a MariaDB database with following command:

univention-app configure keycloak \
--set kc/db/url "jdbc:mariadb://${database_hostname}:3306/keycloak" \
--set kc/db/password "database-password"

This is wrong and have to be

univention-app configure keycloak \
--set "kc/db/url=jdbc:mariadb://${database_hostname}:3306/keycloak" "kc/db/password=database-password"

2: the initial installation step says:
To specify a MariaDB database during installation, run

univention-app install \
--set kc/db/url="jdbc:mariadb://${database_hostname}:3306/keycloak" \
--set kc/db/password="database-password"

This is wrong and needs to be 

univention-app install --set "kc/db/url=jdbc:mariadb://${database_hostname}:3306/keycloak" "kc/db/password=database-password" keycloak



[1]: https://docs.software-univention.de/keycloak-app/latest/configuration.html#mariadb-as-database
Comment 1 Daniel Duchon univentionstaff 2023-07-11 06:42:05 CEST
Additionally: At least in our setup we needed to add the following variables in our "--set" startup parameter to get keycloak with mariadb as backend running on a already running keycloak installation:

"kc/db/ping/datatype=VARBINARY(255)" "kc/db/driver=org.mariadb.jdbc.Driver"


So our command was:
univention-app configure keycloak \
--set "kc/db/url=jdbc:mariadb://${database_hostname}:3306/keycloak" "kc/db/password=database-password" "kc/db/ping/datatype=VARBINARY(255)" "kc/db/driver=org.mariadb.jdbc.Driver"

Otherwise, keycloak was complaining about not existing database drivers