Skip to content

Commit c5b1a4a

Browse files
committed
docs: add userRegistration and syncRolesAt
1 parent 2fa7a00 commit c5b1a4a

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

docs/modules/airflow/pages/usage-guide/security.adoc

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,21 @@ spec:
4040
productVersion: 3.1.6
4141
clusterConfig:
4242
authentication:
43-
- authenticationClass: ldap # <1>
44-
userRegistrationRole: Admin # <2>
43+
- authenticationClass: ldap # <1>
44+
userRegistration: true # <2>
45+
userRegistrationRole: Admin # <3>
46+
syncRolesAt: Registration # <4>
4547
----
4648

4749
<1> The reference to an AuthenticationClass called `ldap`
48-
<2> The default role that all users are assigned to
50+
<2> Whether users that are not yet in Airflow's user database are created automatically on their first login (defaults to `true`)
51+
<3> The default role that all users are assigned to
52+
<4> When user roles are synchronized with the identity provider: `Registration` (only on first login, the default) or `Login` (on every login)
4953

5054
Users that log in with LDAP are assigned to a default {airflow-access-control-docs}[role{external-link-icon}^] which is specified with the `userRegistrationRole` property.
5155

56+
TLS verification for the authentication connection cannot be disabled; the operator rejects an AuthenticationClass that turns it off.
57+
5258
You can follow the xref:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass reference {external-link-icon}^].
5359

5460
The users and roles can be viewed as before in the Webserver UI, but the blue "+" button is not available when authenticating via LDAP:
@@ -77,15 +83,21 @@ spec:
7783
- authenticationClass: keycloak # <1>
7884
oidc:
7985
clientCredentialsSecret: airflow-keycloak-client # <2>
80-
userRegistrationRole: User # <3>
86+
userRegistration: true # <3>
87+
userRegistrationRole: User # <4>
88+
syncRolesAt: Registration # <5>
8189
----
8290

8391
<1> The reference to an AuthenticationClass called `keycloak`
8492
<2> The reference to the Secret containing the Airflow client credentials
85-
<3> The default role to which all users are assigned
93+
<3> Whether users that are not yet in Airflow's user database are created automatically on their first login (defaults to `true`)
94+
<4> The default role to which all users are assigned
95+
<5> When user roles are synchronized with the identity provider: `Registration` (only on first login, the default) or `Login` (on every login)
8696

8797
Users that log in with OpenID Connect are assigned to a default {airflow-access-control-docs}[role{external-link-icon}^] which is specified with the `userRegistrationRole` property.
8898

99+
TLS verification for the authentication connection cannot be disabled; the operator rejects an AuthenticationClass that turns it off.
100+
89101
The Secret containing the Airflow client credentials:
90102

91103
[source,yaml]

0 commit comments

Comments
 (0)