Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 7.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'bahner-mkhomedir', '0.0.1'
Learn more about managing modules with a PuppetfileDocumentation
mkhomedir
Welcome to your new module. A short overview of the generated parts can be found in the PDK documentation.
The README template below provides a starting point with details about what information to include in your README.
Table of Contents
- Description
- Setup - The basics of getting started with mkhomedir
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
Briefly tell users why they might want to use your module. Explain what your module does and what kind of problems users can solve with it.
This should be a fairly short description helps the user decide if your module is what they want.
Setup
What mkhomedir affects OPTIONAL
If it's obvious what your module touches, you can skip this section. For example, folks can probably figure out that your mysql_instance module affects their MySQL instances.
If there's more that they should know about, though, this is the place to mention:
- Files, packages, services, or operations that the module will alter, impact, or execute.
- Dependencies that your module automatically installs.
- Warnings or other important notices.
Setup Requirements OPTIONAL
If your module requires anything extra before setting up (pluginsync enabled, another module, etc.), mention it here.
If your most recent release breaks compatibility or requires particular steps for upgrading, you might want to include an additional "Upgrading" section here.
Beginning with mkhomedir
The very basic steps needed for a user to get the module up and running. This can include setup steps, if necessary, or it can be an example of the most basic use of the module.
Usage
Include usage examples for common use cases in the Usage section. Show your users how to use your module to solve problems, and be sure to include code examples. Include three to five examples of the most important or common tasks a user can accomplish with your module. Show users how to accomplish more complex tasks that involve different types, classes, and functions working in tandem.
Reference
This section is deprecated. Instead, add reference information to your code as Puppet Strings comments, and then use Strings to generate a REFERENCE.md in your module. For details on how to add code comments and generate documentation with Strings, see the Puppet Strings documentation and style guide.
If you aren't ready to use Strings yet, manually create a REFERENCE.md in the root of your module directory and list out each of your module's classes, defined types, facts, functions, Puppet tasks, task plans, and resource types and providers, along with the parameters for each.
For each element (class, defined type, function, and so on), list:
- The data type, if applicable.
- A description of what the element does.
- Valid values, if the data type doesn't make it obvious.
- Default value, if any.
For example:
### `pet::cat`
#### Parameters
##### `meow`
Enables vocalization in your cat. Valid options: 'string'.
Default: 'medium-loud'.
Limitations
In the Limitations section, list any incompatibilities, known issues, or other warnings.
Development
In the Development section, tell other users the ground rules for contributing to your project and how they should submit their work.
Release Notes/Contributors/Etc. Optional
If you aren't using changelog, put your release notes here (though you should
consider using changelog). You can also add any additional sections you feel are
necessary or important to include here. Please use the ##
header.
Reference
Table of Contents
Classes
mkhomedir
: Install and enable pam_oddjob_mkhomedirmkhomedir::debian
: Install and configures mkhomedir or vice versamkhomedir::params
: Default settings for mkhomedirmkhomedir::redhat
: Install and configures mkhomedir or vice versa
Classes
mkhomedir
A description of what this class does
$pam_service_name:: The name of the pam.d/FILE to modify Debian only.
$pam_module_args:: Arguments to pass to the module, eg. umask=0007 or umask=0077 Debian only
$enable:: Wheter to enable or disable the oddjob-mkhomedir module in pam.
Examples
include mkhomedir
Parameters
The following parameters are available in the mkhomedir
class.
enable
Data type: Boolean
Default value: $mkhomedir::params::enable
package_name
Data type: String
Default value: $mkhomedir::params::package_name
package_ensure
Data type: Boolean
Default value: $mkhomedir::params::package_ensure
pam_module_args
Data type: Array[String]
Default value: $mkhomedir::params::pam_module_args
pam_module_name
Data type: String
Default value: $mkhomedir::params::pam_module_name
pam_service_name
Data type: String
Default value: $mkhomedir::params::pam_service_name
mkhomedir::debian
The class can install or uninstall, enable or disable pam_mkhomedir on RedHat family systems. If the oddjob package isnæt installed, If the oddjob-mkhomedir isn't installed pam_mkhomedir can still be enabled, default to standard pam_mkhomedir.
This class is dependent on herculesteam/augeasproviders_pam
Examples
include mkhomedir
mkhomedir::params
This class set defaults
Examples
include mkhomedir::params
mkhomedir::redhat
The class can install or uninstall, enable or disable pam_mkhomedir on RedHat family systems. If the oddjob package isnæt installed, If the oddjob-mkhomedir isn't installed pam_mkhomedir can still be enabled, default to standard pam_mkhomedir.
This class is dependent on yguenane/authconfig.
Examples
include mkhomedir
Dependencies
- yguenane/authconfig (>= 0.6.0 <1.0.0)
- herculesteam/augeasproviders_pam (>= 2.0.0 < 3.0.0)