Bug 32419 - API doc for UDM modules settings/ldapschema and settings/ldapacl
API doc for UDM modules settings/ldapschema and settings/ldapacl
Status: CLOSED FIXED
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P5 normal (vote)
: UCS 3.2
Assigned To: Arvid Requate
Stefan Gohmann
: interim-3
Depends on: 32411 32412
Blocks:
  Show dependency treegraph
 
Reported: 2013-08-28 16:43 CEST by Arvid Requate
Modified: 2015-04-01 13:28 CEST (History)
2 users (show)

See Also:
What kind of report is it?: ---
What type of bug is this?: ---
Who will be affected by this bug?: ---
How will those affected feel about the bug?: ---
User Pain:
Enterprise Customer affected?:
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 Arvid Requate univentionstaff 2013-08-28 16:43:08 CEST
Documentation of the new UDM modules ldap/schema and ldap/acl is required.
Comment 1 Arvid Requate univentionstaff 2013-09-04 16:45:10 CEST
Documentation commited to the UDM section of the developer guide.
Comment 2 Stefan Gohmann univentionstaff 2013-09-23 15:29:31 CEST
I think the documentation for the LDAP ACLs and for the LDAP schema should not be part of the UDM chapter. Maybe a LDAP chapter is better.
In this chapter the examples should be documented. Currently the example code is part of the App Center best practice. The App Center part should only link to the LDAP chapter.

Move to interim-3.
Comment 3 Arvid Requate univentionstaff 2013-10-07 19:39:56 CEST
Ok, now there is a separate chapter on LDAP related topics, which hosts the description of the corresponding two UDM modules.

The description of the ucs_registerLDAPExtension has been moved to the shell-univention-lib section in the "join" chapter, which also links to the LDAP and UDM chapters. The App chapter in turn now links to the shell-univention-lib section.
Comment 4 Stefan Gohmann univentionstaff 2013-10-25 21:29:43 CEST
(In reply to Arvid Requate from comment #3)
> Ok, now there is a separate chapter on LDAP related topics, which hosts the
> description of the corresponding two UDM modules.
> 
> The description of the ucs_registerLDAPExtension has been moved to the
> shell-univention-lib section in the "join" chapter, which also links to the
> LDAP and UDM chapters. The App chapter in turn now links to the
> shell-univention-lib section.

Wow, really great, specially the LDAP chapter (developer-reference-3.2.html#ldap:general). Can you remove the LDAP basics chapters in the UDM chapter (developer-reference-3.2.html#udm:ldap)? I think it is no longer necessary.

Can you give two mini join script examples in "4.2. Packaging LDAP Schema Extensions" and "4.3. Packaging LDAP ACL Extensions". Otherwise it is hard to follow the links.
Comment 5 Philipp Hahn univentionstaff 2013-10-28 08:01:48 CET
Just my 2 ¢ for <http://jenkins.knut.univention.de:8080/view/Doku/job/UCS-3.2-0%20Handbook%20Developer/lastSuccessfulBuild/artifact/webroot/developer-reference-3.2.html#ldap:general>

> An LDAP server provides authenticated and controlled access

What is "authenticated access"?

> For new the development of the UDM extensions on the other hand it is important to understand some of the essential concepts of LDAP as used in UCS.

→ "On the other hand for developing new UDM extensions it is ..."

> This way, a UCS backup can replace a UCS master in case the master needs to be replaced for some reason.

Strip the second half, which is redundant and adds no value.
Comment 6 Arvid Requate univentionstaff 2013-10-28 11:21:32 CET
> What is "authenticated access"?

Access with prior authentication. The opposite of anonymous access.

> → "On the other hand for developing new UDM extensions it is ..."

Ok, adjusted.

> > This way, a UCS backup can replace a UCS master in case the master needs to be replaced for some reason.
> 
> Strip the second half, which is redundant and adds no value.

It does, IMHO.
Comment 7 Stefan Gohmann univentionstaff 2013-10-29 12:16:41 CET
OK