release 2.7.0

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [2.7.0] - 2022-10-05
 
 ### Added
 * Add documentation for all parameters
@@ -169,7 +169,8 @@ This release adds the ability to manage the content of both `ds_389::add` and `d
 ## 1.0.0 - 2017-10-27
 * Initial release.
 
-[Unreleased]: https://github.com/markt-de/puppet-ds_389/compare/2.6.0...HEAD
+[Unreleased]: https://github.com/markt-de/puppet-ds_389/compare/2.7.0...HEAD
+[2.7.0]: https://github.com/markt-de/puppet-ds_389/compare/2.6.0...2.7.0
 [2.6.0]: https://github.com/markt-de/puppet-ds_389/compare/2.5.0...2.6.0
 [2.5.0]: https://github.com/markt-de/puppet-ds_389/compare/2.4.0...2.5.0
 [2.4.0]: https://github.com/markt-de/puppet-ds_389/compare/2.3.0...2.4.0

README.md

@@ -1,6 +1,6 @@
 # puppet-ds_389
 
-[![Build Status](https://travis-ci.org/markt-de/puppet-ds_389.png?branch=master)](https://travis-ci.org/markt-de/puppet-ds_389)
+[![Build Status](https://github.com/markt-de/puppet-ds_389/actions/workflows/ci.yaml/badge.svg)](https://github.com/markt-de/puppet-ds_389/actions/workflows/ci.yaml)
 [![Puppet Forge](https://img.shields.io/puppetforge/v/fraenki/ds_389.svg)](https://forge.puppetlabs.com/fraenki/ds_389)
 [![Puppet Forge](https://img.shields.io/puppetforge/f/fraenki/ds_389.svg)](https://forge.puppetlabs.com/fraenki/ds_389)
 

REFERENCE.md

@@ -48,6 +48,12 @@ include ds_389
 
 The following parameters are available in the `ds_389` class.
 
+##### `cacert_rehash`
+
+Data type: `String`
+
+The command that is used to rehash CA certificates.
+
 ##### `cacerts_path`
 
 Data type: `Stdlib::Absolutepath`
@@ -88,72 +94,67 @@ Data type: `Hash`
 
 A hash of ds_389::instance resources. Optional.
 
-##### `package_ensure`
+##### `limits_config_dir`
 
-Data type: `String`
+Data type: `Stdlib::Absolutepath`
 
-389 ds package state. Default 'installed'
+Target directory for resource limit configuration.
 
-##### `package_name`
+##### `nsstools_package_name`
 
-Data type: `Variant[String,Array]`
+Data type: `String`
 
-Name of the 389 ds package to install. Default: '389-ds-base'
+Name of the NSS tools package.
 
-##### `service_type`
+##### `package_ensure`
 
 Data type: `String`
 
-The service manager that should be used.
+389 ds package state. Default 'installed'
 
-##### `ssl_version_min_support`
+##### `package_name`
 
-Data type: `Boolean`
+Data type: `Variant[String,Array]`
 
-Obsolete parameter, only kept for compatibility with
-spacepants/puppet-ds_389. Will be removed in a later version.
+Name of the 389 ds package to install. Default: '389-ds-base'
 
-##### `user`
+##### `path`
 
 Data type: `String`
 
-User account 389 ds should run as. Default: 'dirsrv'
+Specifies the content of the PATH environment variable when running commands.
+Should usually NOT be altered.
 
-##### `cacert_rehash`
+##### `service_type`
 
 Data type: `String`
 
+The service manager that should be used.
 
-
-##### `limits_config_dir`
+##### `ssl_dir`
 
 Data type: `Stdlib::Absolutepath`
 
+Target directory for generated SSL certificates.
 
+##### `ssl_version_min_support`
 
-##### `nsstools_package_name`
-
-Data type: `String`
-
+Data type: `Boolean`
 
+Obsolete parameter, only kept for compatibility with
+spacepants/puppet-ds_389. Will be removed in a later version.
 
-##### `path`
+##### `user`
 
 Data type: `String`
 
-
-
-##### `ssl_dir`
-
-Data type: `Stdlib::Absolutepath`
-
-
+User account 389 ds should run as. Default: 'dirsrv'
 
 ##### `user_shell`
 
 Data type: `String`
 
-
+Shell for the user account. Usually a pseudo-shell to prevent console access.
 
 ## Defined types
 
@@ -333,6 +334,14 @@ PATH variable is automatically added to the environment.
 
 Default value: `[]`
 
+##### `protocol`
+
+Data type: `Enum['ldap','ldaps']`
+
+The protocol to use when performing the backup.
+
+Default value: `'ldaps'`
+
 ##### `root_dn_pass`
 
 Data type: `Variant[String,Sensitive[String]]`
@@ -391,14 +400,6 @@ Specify a path where upon successful backup a file should be created for checkin
 
 Default value: `'/tmp/389ds_backup_success'`
 
-##### `protocol`
-
-Data type: `Enum['ldap','ldaps']`
-
-
-
-Default value: `'ldaps'`
-
 ### `ds_389::instance`
 
 Manages a 389 ds instance.
@@ -987,6 +988,14 @@ Data type: `Variant[String,Sensitive[String]]`
 
 The password of the replication user. Required.
 
+##### `replication_user`
+
+Data type: `String`
+
+The user account to use for replication.
+
+Default value: `'Replication Manager'`
+
 ##### `role`
 
 Data type: `Enum['supplier','hub','consumer']`
@@ -1051,14 +1060,6 @@ The owner of the created ldif file. Default: $ds_389::user
 
 Default value: `$ds_389::user`
 
-##### `replication_user`
-
-Data type: `String`
-
-
-
-Default value: `'Replication Manager'`
-
 ### `ds_389::schema`
 
 Adds a schema extension ldif file to a 389 ds instance.

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "fraenki-ds_389",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "author": "markt.de",
   "summary": "Module for installing and managing 389 Directory Server",
   "license": "Apache-2.0",