Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bodgit/puppet-yp
Puppet Module for managing YP/NIS
https://github.com/bodgit/puppet-yp
ldap nis puppet
Last synced: about 2 months ago
JSON representation
Puppet Module for managing YP/NIS
- Host: GitHub
- URL: https://github.com/bodgit/puppet-yp
- Owner: bodgit
- License: apache-2.0
- Created: 2015-07-29T14:51:57.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2021-06-18T22:02:48.000Z (over 3 years ago)
- Last Synced: 2024-11-15T22:44:07.901Z (3 months ago)
- Topics: ldap, nis, puppet
- Language: Ruby
- Homepage: https://forge.puppet.com/bodgit/yp
- Size: 215 KB
- Stars: 0
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# yp
[](https://travis-ci.org/bodgit/puppet-yp)
[](https://codecov.io/gh/bodgit/puppet-yp)
[](https://forge.puppetlabs.com/bodgit/yp)
[](https://forge.puppetlabs.com/bodgit/yp)
[](https://forge.puppetlabs.com/bodgit/yp)
#### Table of Contents
1. [Description](#description)
2. [Setup - The basics of getting started with yp](#setup)
* [What yp affects](#what-yp-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with yp](#beginning-with-yp)
3. [Usage - Configuration options and additional functionality](#usage)
4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
## Description
This module manages YP/NIS.
This module can configure the YP/NIS domain, manage the `ypbind` daemon to
bind a client to a YP server and create and maintain master & slave YP servers
using `ypserv` and associated daemons. It can also in the special case of
OpenBSD manage the `ypldap` daemon to fetch YP maps from LDAP.
## Setup
### What yp affects
On OpenBSD this module will add the traditional `+::...` entries to the bottom
of the `/etc/passwd` and `/etc/group` files.
### Setup Requirements
You will need to manage the RPC portmapper by using
[bodgit/portmap](https://forge.puppet.com/bodgit/portmap) or by other means.
On Linux you will need to adjust the `/etc/nsswitch.conf` file and PAM
configuration yourself. Both
[trlinkin/nsswitch](https://forge.puppet.com/trlinkin/nsswitch)
and
[herculesteam/augeasproviders_pam](https://forge.puppet.com/herculesteam/augeasproviders_pam)
are known to work and used in the examples and tests in this module.
### Beginning with yp
Bind a client to a YP domain using three YP servers:
```puppet
include ::portmap
class { '::yp':
domain => 'example.com',
}
class { '::yp::bind':
domain => 'example.com',
servers => ['192.0.2.1', '192.0.2.2', '192.0.2.3'],
}
Class['::portmap'] ~> Class['::yp::bind'] <~ Class['::yp']
if $::osfamily == 'RedHat' {
class { '::nsswitch':
passwd => ['files', 'nis', 'sss'],
shadow => ['files', 'nis', 'sss'],
group => ['files', 'nis', 'sss'],
hosts => ['files', 'nis', 'dns'],
netgroup => ['files', 'nis', 'sss'],
automount => ['files', 'nis'],
require => Class['::yp::bind'],
}
pam { 'nis':
ensure => present,
service => 'system-auth-ac',
type => 'password',
control => 'sufficient',
module => 'pam_unix.so',
arguments => [
'md5',
'shadow',
'nis',
'nullok',
'try_first_pass',
'use_authtok',
],
require => Class['::yp::bind'],
}
}
```
## Usage
Create a standalone YP server:
```puppet
include ::portmap
class { '::yp':
domain => 'example.com',
}
class { '::yp::serv':
domain => 'example.com',
}
Class['::portmap'] ~> Class['::yp::serv'] <- Class['::yp']
```
Create a master YP server with two additional slaves:
```puppet
include ::portmap
class { '::yp':
domain => 'example.com',
}
class { '::yp::serv':
domain => 'example.com',
maps => [
'passwd.byname',
'passwd.byuid',
'group.bygid',
'group.byname',
'netid.byname',
],
slaves => [
'192.0.2.2',
'192.0.2.3',
],
}
Class['::portmap'] ~> Class['::yp::serv'] <- Class['::yp']
```
Create a slave YP server pointing at the above master YP server:
```puppet
include ::portmap
class { '::yp':
domain => 'example.com',
}
class { '::yp::serv':
domain => 'example.com',
maps => [
'passwd.byname',
'passwd.byuid',
'group.bygid',
'group.byname',
'netid.byname',
],
master => '192.0.2.1',
}
class { '::yp::bind':
domain => 'example.com',
}
Class['::portmap'] ~> Class['::yp::serv'] <- Class['::yp']
Class['::yp::serv'] -> Class['::yp::bind'] <~ Class['::yp']
```
For OpenBSD only, set up `ypldap` to create YP maps from an LDAP server and
also bind to it. This is the equivalent to PAM/LDAP on Linux:
```puppet
include ::portmap
class { '::yp::ldap':
domain => 'example.com',
directories => {
'dc=example,dc=com' => {
bind_dn => 'cn=ypldap,dc=example,dc=com',
bind_pw => 'password',
server => '192.0.2.1',
},
},
}
class { '::yp':
domain => 'example.com',
}
class { '::yp::bind':
domain => 'example.com',
}
Class['::portmap'] ~> Class['::yp::ldap'] ~> Class['::yp::bind'] <~ Class['::yp']
```
## Reference
The reference documentation is generated with
[puppet-strings](https://github.com/puppetlabs/puppet-strings) and the latest
version of the documentation is hosted at
[https://bodgit.github.io/puppet-yp/](https://bodgit.github.io/puppet-yp/)
and available also in the [REFERENCE.md](https://github.com/bodgit/puppet-yp/blob/master/REFERENCE.md).
## Limitations
This module was primarily written with deploying `ypldap` on OpenBSD in mind
however to do that I realised I had classes for everything bar `ypserv` so I
added that and made sure it was portable enough to work on one other OS. It
works however I don't expect many people to still be using traditional YP/NIS.
This module has been built on and tested against Puppet 5 and higher.
The module has been tested on:
* RedHat Enterprise Linux 6/7
* OpenBSD 6.0/6.1/6.2/6.3
## Development
The module relies on [PDK](https://puppet.com/docs/pdk/1.x/pdk.html) and has
both [rspec-puppet](http://rspec-puppet.com) and
[beaker-rspec](https://github.com/puppetlabs/beaker-rspec) tests. Run them
with:
```
$ bundle exec rake spec
$ PUPPET_INSTALL_TYPE=agent PUPPET_INSTALL_VERSION=x.y.z bundle exec rake beaker:
```
Please log issues or pull requests at
[github](https://github.com/bodgit/puppet-yp).