Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CN-1048, CN-1047] Add missing field descriptions #143

Merged
merged 3 commits into from
Nov 1, 2023
Merged

[CN-1048, CN-1047] Add missing field descriptions #143

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62b77cc
Add missing field descriptions
cagric0 Oct 30, 2023
b70c8eb
Fix typo
cagric0 Oct 30, 2023
ccfffea
Update management-center-ldap.adoc
cagric0 Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/modules/ROOT/examples/management-center-ldap.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ spec:
securityProvider:
ldap:
credentialsSecretName: ldap-credentianls
groupDn: ou=users,dc=example,dc=org
groupDN: ou=users,dc=example,dc=org
groupSearchFilter: member={0}
nestedGroupSearch: false
url: ldap://ldap-server-url:1389
userDn: ou=users,dc=example,dc=org
userDN: ou=users,dc=example,dc=org
userGroups:
- users
metricsOnlyGroups:
Expand Down
10 changes: 8 additions & 2 deletions docs/modules/ROOT/pages/management-center-ldap.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,16 @@ The following are the required fields to configure the LDAP Security provider.
|===
|Field|Description

|`url`
| URL of your LDAP server, including schema (ldap://) and port.

|`credentialsSecretName`
| The name of the secret that contains `username` and `password` keys of a user that has admin privileges on the LDAP server. The `username` must be the must be the distinguished name (DN) of the user. It is used to connect to the server when authenticating users.

|`userDn`
|`userDN`
| DN to be used for searching users.

|`groupDn`
|`groupDN`
| DN to be used for searching groups.

|`adminGroups`
Expand All @@ -41,6 +44,9 @@ The following are the required fields to configure the LDAP Security provider.
|`groupSearchFilter`
| LDAP search filter expression to search for the groups.

|`nestedGroupSearch`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is not required, as mentioned in the section above, that's why I didn't document it here. All the fields with the optional ones are included in the Refrence API doc page 😃

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm I didn't know that, I'll remove it back. How about URL field? It was missing or it's also intentionally removed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

URL is required, so it was just missing

| Set to `true` to enable searching for nested LDAP groups.

|===

=== Example Management Center LDAP Configuration
Expand Down
Loading