Bug 57195 - Missing documentation for keycloak/server/sso/fqdn
Summary: Missing documentation for keycloak/server/sso/fqdn
Status: NEW
Alias: None
Product: UCS
Classification: Unclassified
Component: Keycloak
Version: UCS 5.0
Hardware: Other Linux
: P5 minor
Target Milestone: ---
Assignee: UCS maintainers
QA Contact: UCS maintainers
URL:
Keywords:
: 57687 (view as bug list)
Depends on:
Blocks: 57459
  Show dependency treegraph
 
Reported: 2024-03-27 09:12 CET by Robert Heyer
Modified: 2025-06-24 16:33 CEST (History)
7 users (show)

See Also:
What kind of report is it?: Bug Report
What type of bug is this?: 6: Setup Problem: Issue for the setup process
Who will be affected by this bug?: 4: Will affect most installed domains
How will those affected feel about the bug?: 2: A Pain – users won’t like this once they notice it
User Pain: 0.274
Enterprise Customer affected?:
School Customer affected?: Yes
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number: 2024071521000107, 2024100821000089, 2025062421000162
Bug group (optional):
Customer ID:
Max CVSS v3 score:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Robert Heyer univentionstaff 2024-03-27 09:12:03 CET
There is no info for UCRV "keycloak/server/sso/fqdn", but it should be.
Comment 1 Erik Damrose univentionstaff 2024-03-27 17:02:06 CET
It is an app setting, you must set it with the UMC App Center module or with by using univention-app. App settings are also represented as UCR variables.

It is documented here: https://docs.software-univention.de/keycloak-app/latest/configuration.html#envvar-keycloak-server-sso-fqdn
Comment 2 Robert Heyer univentionstaff 2024-03-28 07:11:23 CET
I was aware of the function of the UCRV. I wanted it to be uniform, so regardless of the fact that this is in the manual, the description should be available for each UCR variable via CLI.
Comment 3 Erik Damrose univentionstaff 2024-03-28 09:24:46 CET
I think there is a bug about it, but i can not find it. Having just a UCRv info will lead people into thinking that it is just a UCR variable, and wonder why it does not work. We need to make it explizit for every App setting that they may not be changed via UCR, or prevent modifying them via UCR at all.
Comment 4 Jürn Brodersen univentionstaff 2024-07-19 17:17:33 CEST
We need to document that keycloak/server/sso/fqdn needs to be set on all servers in the domain. Otherwise, 92univention-management-console-web-server.inst will fail because univention-keycloak get-keycloak-base-url fails.


root@srv-bbs2-edu:~# univention-keycloak get-keycloak-base-url
HTTPSConnectionPool(host='ucs-sso-ng.example.de', port=443): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSConnection
object at 0x7f8f17f8a0b8>: Failed to establish a new connection: [Errno -2] Name or service not known'))
ERROR: Could not connect to keycloak server on https://ucs-sso-ng.example.de/:

HTTPSConnectionPool(host='ucs-sso-ng.example.de', port=443): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSCon
nection object at 0x7f8f17f8a0b8>: Failed to establish a new connection: [Errno -2] Name or service not known'))

Please check the UCR settings for keycloak/server/sso/fqdn and keycloak/server/sso/path,
and make sure that keycloak and apache are running on the keycloak server!
Comment 5 Christina Scheinig univentionstaff 2024-08-28 10:31:30 CEST
(In reply to Erik Damrose from comment #3)
> I think there is a bug about it, but i can not find it. Having just a UCRv
> info will lead people into thinking that it is just a UCR variable, and
> wonder why it does not work. We need to make it explizit for every App
> setting that they may not be changed via UCR, or prevent modifying them via
> UCR at all.

So we use this bug, to make that explicit?
Comment 6 Jan-Luca Kiok univentionstaff 2024-08-28 12:15:44 CEST
(In reply to Christina Scheinig from comment #5)
> (In reply to Erik Damrose from comment #3)
> > I think there is a bug about it, but i can not find it. Having just a UCRv
> > info will lead people into thinking that it is just a UCR variable, and
> > wonder why it does not work. We need to make it explizit for every App
> > setting that they may not be changed via UCR, or prevent modifying them via
> > UCR at all.
> 
> So we use this bug, to make that explicit?

I guess the bug you are looking for is this one: https://forge.univention.org/bugzilla/show_bug.cgi?id=57469
Comment 7 Jan-Luca Kiok univentionstaff 2024-10-22 11:12:57 CEST
Cited from Bug 57687:

> Currently the documentation specifies e.g. in 'External FQDN different from
> internal UCS name' for 'Each Keycloak instance in your UCS domain' to
> perform the following configuration:
> 
> SSO_FQDN="sso.internet.domain"
> ucr set keycloak/server/sso/fqdn="${SSO_FQDN}"
> 
> This is also mandatory on replica and non-keycloak systems, otherwise tools
> like univention-keycloak will result in the following error message:
> 
> root@ucs-replica:~# univention-keycloak get-keycloak-base-url
> HTTPSConnectionPool(host='ucs-sso-ng.univention-school.intranet', port=443):
> Max retries exceeded with url: / (Caused by
> SSLError(SSLCertVerificationError("hostname
> 'ucs-sso-ng.univention-school.intranet' doesn't match either of
> 'ucs-primary.univention-school.intranet', 'ucs-primary'")))
> ERROR: Could not connect to keycloak server on
> https://ucs-sso-ng.univention-school.intranet/:
> 
>         HTTPSConnectionPool(host='ucs-sso-ng.univention-school.intranet',
> port=443): Max retries exceeded with url: / (Caused by
> SSLError(SSLCertVerificationError("hostname
> 'ucs-sso-ng.univention-school.intranet' doesn't match either of
> 'ucs-primary.univention-school.intranet', 'ucs-primary'")))
> 
> Please check the UCR settings for keycloak/server/sso/fqdn and
> keycloak/server/sso/path,
> and make sure that keycloak and apache are running on the keycloak server!
Comment 8 Jan-Luca Kiok univentionstaff 2024-10-22 11:13:33 CEST
*** Bug 57687 has been marked as a duplicate of this bug. ***