Skip to content

Commit 84a3b59

Browse files
Fix issues reported by asciidoctor-dita-vale (Configuring User Authentication) (#4175)
* Drop attributes from RH and RHEL links * Drop non-critical additional references * Update xrefs * Split off procedures * Other minor changes --------- Co-authored-by: Maximilian Kolb <[email protected]>
1 parent bf958bb commit 84a3b59

File tree

39 files changed

+192
-203
lines changed

39 files changed

+192
-203
lines changed

guides/common/assembly_accessing-server.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ include::modules/con_accessing-server.adoc[]
55
include::modules/proc_logging-in-to-the-projectwebui.adoc[leveloffset=+1]
66

77
ifdef::katello,orcharhino,satellite[]
8-
include::modules/proc_importing-the-katello-root-ca-certificate.adoc[leveloffset=+1]
8+
include::modules/proc_importing-the-katello-root-ca-certificate-using-web-ui.adoc[leveloffset=+1]
9+
10+
include::modules/proc_importing-the-katello-root-ca-certificate-using-cli.adoc[leveloffset=+1]
911
endif::[]
1012

1113
include::modules/proc_resetting-the-administrative-user-password.adoc[leveloffset=+1]

guides/common/modules/con_configuring-an-ldap-server-as-an-external-identity-provider-for-project.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
[id="configuring-an-ldap-server-as-an-external-identity-provider-for-project_{context}"]
44
= Configuring an LDAP server as an external identity provider for {Project}
5-
[[Using_LDAP_satellite]]
6-
// Satellite web UI links to this section under the anchor Using_LDAP_satellite.
7-
// Adding a secondary ID ([[secondary_ID]]) ensures that the link does not break.
85

96
Lightweight Directory Access Protocol (LDAP) is a set of open protocols used to access centrally stored information over a network.
107
With {Project}, you can use one or multiple LDAP directories for external authentication.
@@ -13,7 +10,7 @@ With {Project}, you can use one or multiple LDAP directories for external authen
1310
====
1411
While you can configure the LDAP server integrated with {FreeIPA} as an external authentication source, {FreeIPA} users will not be able to log in by using single sign-on.
1512
Instead, consider configuring {FreeIPA} as an external identity provider.
16-
For more information, see xref:configuring-kerberos-sso-with-{FreeIPA-context}-in-{project-context}[].
13+
For more information, see xref:common/modules/con_configuring-kerberos-sso-with-freeipa-in-project.adoc#configuring-kerberos-sso-with-{FreeIPA-context}-in-{project-context}[].
1714
====
1815

1916
[IMPORTANT]

guides/common/modules/con_configuring-kerberos-sso-for-active-directory-users-in-project.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ You can also connect your {Project} deployment to AD in the following ways:
1717
1818
* By using indirect AD integration.
1919
With indirect integration, your {ProjectServer} is connected to a {FreeIPA} server which is then connected to AD.
20-
For more information, see xref:configuring-kerberos-sso-with-{FreeIPA-context}-in-{project-context}[].
20+
For more information, see xref:common/modules/con_configuring-kerberos-sso-with-freeipa-in-project.adoc#configuring-kerberos-sso-with-{FreeIPA-context}-in-{project-context}[].
2121
* By attaching the LDAP server of the AD domain as an external authentication source with no single sign-on support.
22-
For more information, see xref:configuring-an-ldap-server-as-an-external-identity-provider-for-project_{context}[].
22+
For more information, see xref:common/modules/con_configuring-an-ldap-server-as-an-external-identity-provider-for-project.adoc#configuring-an-ldap-server-as-an-external-identity-provider-for-project_{context}[].
2323
ifndef::orcharhino[]
2424
For an example configuration, see https://access.redhat.com/solutions/1498773[How to configure Active Directory authentication with TLS on {Project}].
2525
endif::[]

guides/common/modules/con_configuring-kerberos-sso-with-freeipa-in-project.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ If cross-forest trust is configured between {FreeIPA} and Active{nbsp}Directory,
1717
When cross-forest trust is configured between {FreeIPA} and Active{nbsp}Directory, Active{nbsp}Directory users can log in to {Project} with their user principal name (UPN) and password.
1818

1919
ifndef::orcharhino[]
20-
For information about {FreeIPA}, including its cross-forest trust functionality, see link:{RHELDocsBaseURL}9/html/planning_identity_management/index[{RHEL}{nbsp}9 _Planning Identity Management_] and link:{RHELDocsBaseURL}9/html/installing_identity_management/index[{RHEL}{nbsp}9 _Installing Identity Management_].
20+
For information about {FreeIPA}, including its cross-forest trust functionality, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/planning_identity_management/index[{RHEL}{nbsp}9 _Planning Identity Management_] and link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/installing_identity_management/index[{RHEL}{nbsp}9 _Installing Identity Management_].
2121
endif::[]

guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-quarkus-in-project.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ifndef::satellite,orcharhino[]
2222
endif::[]
2323

2424
ifdef::satellite[]
25-
For information about {RHBK}, see link:{RHDocsBaseURL}red_hat_build_of_keycloak[{RHBK} documentation].
25+
For information about {RHBK}, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak[{RHBK} documentation].
2626
endif::[]
2727
ifndef::satellite[]
2828
For information about {keycloak}, see link:https://www.keycloak.org/documentation[{keycloak} documentation].

guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-wildfly-in-project.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ifndef::satellite[]
1212
The default {keycloak} distribution is now based on Quarkus.
1313
1414
{keycloak-quarkus} replaces {keycloak-wildfly} in {Project} deployments.
15-
For information about configuring {keycloak-quarkus} authentication, see xref:configuring-sso-and-2fa-with-keycloak-in-project_keycloak-quarkus[].
15+
For information about configuring {keycloak-quarkus} authentication, see xref:common/modules/con_configuring-sso-and-2fa-with-keycloak-quarkus-in-project.adoc#configuring-sso-and-2fa-with-keycloak-in-project_keycloak-quarkus[].
1616
1717
For information about migrating from {keycloak-wildfly} to {keycloak-quarkus}, see link:https://www.keycloak.org/migration/migrating-to-quarkus[Migrating to Quarkus distribution].
1818
====
@@ -22,9 +22,9 @@ ifdef::satellite[]
2222
====
2323
The {keycloak-wildfly}{nbsp}7 product family has reached End of Full Support.
2424
Use {keycloak-quarkus} instead in your {Project} deployments.
25-
For information about configuring {keycloak-quarkus} authentication, see xref:configuring-sso-and-2fa-with-keycloak-in-project_keycloak-quarkus[].
25+
For information about configuring {keycloak-quarkus} authentication, see xref:common/modules/con_configuring-sso-and-2fa-with-keycloak-quarkus-in-project.adoc#configuring-sso-and-2fa-with-keycloak-in-project_keycloak-quarkus[].
2626
27-
For information about migrating from {keycloak-wildfly} to {keycloak-quarkus}, see link:{RHDocsBaseURL}red_hat_build_of_keycloak/26.0[documentation for {keycloak-quarkus}].
27+
For information about migrating from {keycloak-wildfly} to {keycloak-quarkus}, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0[documentation for {keycloak-quarkus}].
2828
====
2929
endif::[]
3030

@@ -47,5 +47,5 @@ ifndef::satellite,orcharhino[]
4747
endif::[]
4848

4949
ifdef::satellite[]
50-
For information about {RHSSO}, see link:{RHDocsBaseURL}red_hat_single_sign-on[{RHSSO} documentation].
50+
For information about {RHSSO}, see link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on[{RHSSO} documentation].
5151
endif::[]

guides/common/modules/con_prerequisites-for-configuring-project-with-keycloak-quarkus-authentication.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ On the {keycloak} side, ensure you meet the following requirements:
2626
To access a {keycloak} server initialized with `--http-relative-path=/auth` from its web UI, go to `https://_{keycloak-example-com}_:8443/auth`.
2727
** If you want to use a different context path, make manual adjustments after the initialization with `/auth` or configure the `_foreman-openidc_oidc_keycloak_Foreman_Realm_.conf` file of the HTTPd service manually.
2828
ifndef::orcharhino[]
29-
For more information about configuring a different context path, see the {RHDocsBaseURL}red_hat_build_of_keycloak/24.0/html-single/server_guide/index#reverseproxy-different-context-path-on-reverse-proxy[_{RHBK} Administration Guide_].
29+
For more information about configuring a different context path, see the https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/24.0/html-single/server_guide/index#reverseproxy-different-context-path-on-reverse-proxy[_{RHBK} Administration Guide_].
3030
endif::[]
3131
* If `keycloak-httpd-client-install` version 1.3 or later is installed, your {keycloak} server does not need to be initialized with the `--http-relative-path=/auth` context path.
3232
* Your {keycloak} server uses HTTPS instead of HTTP.
@@ -35,5 +35,5 @@ endif::[]
3535
* A realm is created on the {keycloak} server for {Project} user accounts, for example `_{Project}_Realm_`.
3636
* User accounts have been imported or added to {keycloak}.
3737
ifndef::orcharhino[]
38-
For more information on importing or creating users, see the {RHDocsBaseURL}red_hat_build_of_keycloak/24.0/html/server_administration_guide/user-storage-federation[_{RHBK} Administration Guide_].
38+
For more information on importing or creating users, see the https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/24.0/html/server_administration_guide/user-storage-federation[_{RHBK} Administration Guide_].
3939
endif::[]

guides/common/modules/con_prerequisites-for-configuring-project-with-keycloak-wildfly-authentication.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ On the {keycloak} side, ensure you meet the following requirements:
2121
* A realm is created on the {keycloak} server for {Project} user accounts, for example `_{Project}_Realm_`.
2222
* User accounts have been imported or added to {keycloak}.
2323
ifndef::orcharhino[]
24-
For more information about importing or creating users, see the {RHDocsBaseURL}red_hat_single_sign-on/7.6/html/server_administration_guide/assembly-managing-users_server_administration_guide#proc-creating-user_server_administration_guide[_{RHSSO} Server Administration Guide_].
24+
For more information about importing or creating users, see the https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html/server_administration_guide/assembly-managing-users_server_administration_guide#proc-creating-user_server_administration_guide[_{RHSSO} Server Administration Guide_].
2525
endif::[]

guides/common/modules/proc_adding-a-remote-console-connection-for-a-host-on-proxmox.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ ifndef::foreman-deb[]
5757
endif::[]
5858
ifdef::katello,satellite,orcharhino[]
5959
. If you use a {customssl} certificate, import the SSL certificate from {ProjectServer} into your browser.
60-
For more information, see {ConfiguringUserAuthenticationDocURL}importing-the-katello-root-ca-certificate[Importing the Katello root CA certificate] in _{ConfiguringUserAuthenticationDocTitle}_.
60+
For more information, see {ConfiguringUserAuthenticationDocURL}importing-the-katello-root-ca-certificate-using-{project-context}-web-ui[Importing the Katello root CA certificate using {ProjectWebUI}] in _{ConfiguringUserAuthenticationDocTitle}_.
6161
+
6262
The remote console connection to your host will fail if you choose to temporarily accept not checking the certificates in your browser.
6363
endif::[]

guides/common/modules/proc_configuring-a-cross-forest-trust-between-freeipa-and-active-directory-for-project.adoc

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,16 @@ When your {FreeIPA} deployment includes a cross-forest trust with Active Directo
77

88
.Prerequisites
99
* An existing {FreeIPA} server with a cross-forest trust with AD established.
10-
For more information, see link:{RHELDocsBaseURL}9/html/installing_trust_between_idm_and_ad[{RHEL}{nbsp}9 _Installing trust between IdM and AD_].
10+
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/installing_trust_between_idm_and_ad[{RHEL}{nbsp}9 _Installing trust between IdM and AD_].
1111

1212
.Procedure
13-
14-
On your {FreeIPA} server:
15-
16-
. Enable HBAC:
17-
.. Create an external group and add the AD group to it.
18-
.. Add the new external group to a POSIX group.
19-
.. Use the POSIX group in a HBAC rule.
20-
21-
On your {FreeIPA} server and all replicas in your {FreeIPA} topology, configure SSSD to transfer additional attributes of AD users:
22-
23-
. Add the AD user attributes to the _nss_ and _domain_ sections in `/etc/sssd/sssd.conf`.
13+
. On your {FreeIPA} server:
14+
.. Enable HBAC:
15+
... Create an external group and add the AD group to it.
16+
... Add the new external group to a POSIX group.
17+
... Use the POSIX group in a HBAC rule.
18+
. On your {FreeIPA} server and all replicas in your {FreeIPA} topology, configure SSSD to transfer additional attributes of AD users:
19+
.. Add the AD user attributes to the _nss_ and _domain_ sections in `/etc/sssd/sssd.conf`.
2420
For example:
2521
+
2622
[options="nowrap", subs="+quotes,verbatim,attributes"]
@@ -37,26 +33,26 @@ user_attributes=+email, +firstname, +lastname
3733
allowed_uids = ipaapi, root
3834
user_attributes=+email, +firstname, +lastname
3935
----
40-
. Clear the SSSD cache:
41-
.. Stop SSSD:
36+
.. Clear the SSSD cache:
37+
... Stop SSSD:
4238
+
4339
[options="nowrap", subs="+quotes,verbatim,attributes"]
4440
----
4541
# systemctl stop sssd
4642
----
47-
.. Clear the cache:
43+
... Clear the cache:
4844
+
4945
[options="nowrap", subs="+quotes,verbatim,attributes"]
5046
----
5147
# sss_cache -E
5248
----
53-
.. Start SSSD:
49+
... Start SSSD:
5450
+
5551
[options="nowrap", subs="+quotes,verbatim,attributes"]
5652
----
5753
# systemctl start sssd
5854
----
59-
. Verify the AD attributes value by using the `dbus-send` command on your {ProjectServer} and on your {FreeIPA} server.
55+
.. Verify the AD attributes value by using the `dbus-send` command on your {ProjectServer} and on your {FreeIPA} server.
6056
Make sure that both outputs match.
6157
+
6258
[options="nowrap", subs="+quotes,verbatim,attributes"]

0 commit comments

Comments
 (0)