Skip to content

Commit

Permalink
Update docs with new SSSD conf parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
eemperor committed Jun 21, 2023
1 parent f1cd6db commit f23de1b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 11 deletions.
39 changes: 28 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,17 @@ Set of parameters used for joining a AD-client to its domain:
- *`trusted_domains`*: (OPTIONAL) List of domains (within a multi-domin
forest) to trust

### Tool used for joining client to AD domain

There are a number of third-party and native options available for joining
Linux clients to AD domains. This parameter is used to tell the formula which
client-behavior should be used. Expected valid values will be 'centrify',
'pbis', 'quest', 'sssd' and 'winbind'. As of this version of the formula,
'pbis' and 'sssd' are supported (though use of 'pbis' is now HIGHLY
discouraged due to its discontinuation in late 2019).

- *` ad_connector`*: (e.g., 'sssd')

### Settings for the URI path-elements to the PBIS installer

These two values are used to determine where to locate the AD-client's
Expand All @@ -160,17 +171,6 @@ download methods may also work (but have not been tested).
- *`pbis-open-legacy`*: URL of the `pbis-open-legacy` RPM (infrequently used)
- *`pbis-open-upgrade`*: URL of the `pbis-open-upgrade` RPM

### Tool used for joining client to AD domain

There are a number of third-party and native options available for joining
Linux clients to AD domains. This parameter is used to tell the formula which
client-behavior should be used. Expected valid values will be 'centrify',
'pbis', 'quest', 'sssd' and 'winbind'. As of this version of the formula,
'pbis' and 'sssd' are supported (though use of 'pbis' is now HIGHLY
discouraged due to its discontinuation in late 2019).

- *` ad_connector`*: (e.g., 'sssd')

### Directories where (the PBIS) AD-client utilities are installed to the system

List of directories associated with the chosen `ad_connector` software/method.
Expand All @@ -184,6 +184,23 @@ connector-software files (e.g. `/var/lib/pbis`)
- *`install_db_dir`*: Primary directory hosting connector-software's
cache-databases (e.g., `/var/lib/pbis/db`)

### SSSD-specific pillar settings

SSSD configuration parameters for domain-specific `.conf` files under the
`/etc/sssd/conf.d/` directory can be provided using the following pillar dictionary
parameter:

- *`sssd_conf_parameters`*:
```yaml
sssd_conf_parameters:
<key1>: '<value1>'
...
<keyN>: '<valueN>'
```
Any parameter supported by `sssd` may be used within `sssd_conf_parameters` to
customize the operation of `sssd`.

### List of RPMs to look for

This is a list of RPMs associated with the AD client. For some client-types
Expand Down
7 changes: 7 additions & 0 deletions pillar.example
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,10 @@ join-domain:
# Note: this is only known to work with DNS systems based on Microsoft's
# DNS-integrated Active Directory service.
#update-dns: true

# Example for overriding or adding additional SSSD conf parameters
#sssd_conf_parameters:
# default_shell: '/bin/bash'
# override_homedir: '/home/%d/%f'
# shell_fallback: '/bin/sh'
# use_fully_qualified_names: 'True'

0 comments on commit f23de1b

Please sign in to comment.