ansible.sssd/README.md

94 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

2017-07-18 14:23:07 +02:00
# SSSD
1. [Overview](#overview)
2. [Role Variables](#role-variables)
* [OS Specific Variables](#os-specific-variables)
3. [Example Playbook](#example-playbook)
4. [Configuration](#configuration)
2017-07-19 19:34:43 +02:00
5. [Development](#development)
2017-07-18 14:23:07 +02:00
5. [License](#license)
6. [Author Information](#author-information)
## Overview
Manage LDAP authentication with **SSSD** (System Security Services Daemon).
Highly inspired by [Lae's system_ldap role][lae sssd galaxy] with minors updates (test only on Debian 9 and maybe on OpenSuse).
## Role Variables
* **sssd_pkg_state**: State of new sssd packages [default: `latest`].
* **sssd_conf_manage**: If SSSD configuration should be managed with this role [default: `true`].
* **sssd_main_conf_path**: Path to set main SSSD's configuration [default: `/etc/sssd/sssd.conf`].
* **sssd_main_conf_tpl**: Template used to generate the previous config file [default: `etc/sssd/sssd.conf.j2`].
* **sssd_mkhomedir**: If home directories should be created at login [default: `true`].
* **sssd_home_path**: Path where home directories are stored [default: `/home`].
* **sssd_sudoers_ldap**: If sudo must look to `sss` the list of sudoers [default: `false`].
2017-07-18 14:23:07 +02:00
* **sssd_service_name**: SSSD's service name [default: `sssd`].
### OS Specific Variables
2017-07-19 19:34:43 +02:00
Please see default value by Operating System file in [vars][vars directory] directory.
2017-07-18 14:23:07 +02:00
* **sssd_pkg_list**: The list of packages to install to provide `sssd`.
* Be careful, `sssd` may need additional packages to be able to establish a TLS connection to a LDAP/AD/… server (such as `ca-certificates`,…).
2017-07-18 14:23:07 +02:00
## Example Playbook
* Use defaults vars:
``` yml
- hosts: serverXYZ
roles:
2017-07-18 16:21:35 +02:00
- role: ipr-cnrs.sssd
2017-07-18 14:23:07 +02:00
```
* With a `group_vars/serverxyz.yml` file:
``` yml
sssd_domain: 'dotld'
sssd_uris:
- ldap://ldap.domain.tld
sssd_search_base: 'ou=People,dc=domain,dc=tld
sssd_bind_dn: 'cn=sssd_user,ou=apps,dc=domain,dc=tld'
```
* Then you also need to enter the `bind_dn_password` on the remote host (`/etc/sssd/conf.d/sssd_domain.conf`|`/etc/sssd/conf.d/dotld.conf`). If you want to define `bind_dn_password` in a playbook, please be sure to use [Vault][ansible vault] (or any other tool) to cipher your data!
2017-07-18 14:23:07 +02:00
## Configuration
This role will:
* Install needed packages to provide `sssd`.
* Manage the default `sssd` configuration file (`/etc/sssd/sssd.conf`).
* Create an additional configuration file to only store the bind_password (`/etc/sssd/conf.d/domain.bind.conf`).
* Remove `sss` directive for `sudoers` in `/etc/nsswitch.conf` file.
2017-07-18 14:23:07 +02:00
* Manage `sssd` service.
* Restart `systemd-logind` service.
2017-07-18 14:23:07 +02:00
2017-07-19 19:34:43 +02:00
## Development
This source code comes from our [Gogs instance][sssd source] and the [Github repo][sssd github] exist just to be able to send the role to Ansible Galaxy…
But feel free to send issue/PR here :)
Thanks to this [hook][gogs to github hook], Github automatically got updates from our [Gogs instance][sssd source] :)
2017-07-18 14:23:07 +02:00
## License
[WTFPL][wtfpl website]
## Author Information
Jérémy Gardais
2017-07-18 14:33:47 +02:00
* Source: [on IPR's Gogs][sssd source]
2017-07-18 14:23:07 +02:00
* [IPR][ipr website] (Institut de Physique de Rennes)
2017-07-19 19:34:43 +02:00
[vars directory]: ./vars
[ansible vault]: http://docs.ansible.com/ansible/latest/vault.html
2017-07-19 19:34:43 +02:00
[gogs to github hook]: https://stackoverflow.com/a/21998477
2017-07-18 14:33:47 +02:00
[sssd source]: https://git.ipr.univ-rennes1.fr/cellinfo/ansible.sssd
2017-07-19 19:34:43 +02:00
[sssd github]: https://github.com/ipr-cnrs/sssd
2017-07-18 14:23:07 +02:00
[wtfpl website]: http://www.wtfpl.net/about/
[ipr website]: https://ipr.univ-rennes1.fr/
[lae sssd galaxy]: https://galaxy.ansible.com/lae/system_ldap/