chef / chef/chef-web-docs

Add missing docs for ldap attribute configuration

Open Beginner friendly
#1,989 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect: Documentation Component: Chef Infra Server
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

User Story

As a SysAdmin, I will use this work when I want to customize the LDAP configuration to support LDAP installations that use email for a users mail attribute instead of mail.

Description

In Chef Server 12.15.0 a several new configuration option were added for ldap attribute fields but never added to the documentation.

Feature announcement here: https://github.com/chef/chef-server/blob/master/RELEASE_NOTES.md#user-customization-of-field-mapping

Here is the code with the various new configs that are available: https://github.com/chef/chef-server/blob/ac11df3d7c88b164a16beccdd18c12d403e87967/omnibus/files/private-chef-cookbooks/private-chef/templates/default/oc_erchef.config.erb#L102-L108

            %% LDAP Attribute Mappings
            {display_name_attribute, "<%= node['private_chef']['ldap']['display_name_attribute'] || 'displayname' %>" },
            {first_name_attribute,   "<%= node['private_chef']['ldap']['first_name_attribute']   || 'givenname' %>" },
            {last_name_attribute,    "<%= node['private_chef']['ldap']['last_name_attribute']    || 'sn' %>" },
            {common_name_attribute,  "<%= node['private_chef']['ldap']['common_name_attribute']  || 'cn' %>" },
            {country_attribute,      "<%= node['private_chef']['ldap']['country_attribute']      || 'c' %>" },
            {city_attribute,         "<%= node['private_chef']['ldap']['city_attribute']         || 'l' %>" },
            {email_attribute,        "<%= node['private_chef']['ldap']['email_attribute']        || 'mail' %>" },

The documentation should be added to:
https://docs.chef.io/config_rb_server_optional_settings.html#ldap
and
https://docs.chef.io/server_ldap.html

The warning at the under https://docs.chef.io/server_ldap.html#configure-ldap should also be updated to indicate the mail attribute is now configurable instead of being required.

Chef Version

>= 12.15.0

Platform Version

All supported by Chef-Server

Definition of Done
Demo Script / Repro Steps

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the LDAP sections in config_rb_server_optional_settings.html#ldap and server_ldap.html, then compare them with the referenced oc_erchef.config.erb attribute mappings and the release announcement. Document the configurable LDAP attributes, including their defaults, in both locations and update the configure-ldap warning to reflect that the mail attribute is configurable.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.