added Puppet documentation, Jenkinsfile and Gemfile for CI

This commit is contained in:
Arne Teuke
2017-07-07 16:15:43 +01:00
parent 08e4559e67
commit 44a6e4aa08
13 changed files with 298 additions and 71 deletions

View File

@@ -19,8 +19,42 @@
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# @summary This class holds all parameters for the cd_apache module, which are
# inherited by all classes except defines.
# @param [string] pkg_ensure Specify which
# [package type] (https://confdroid.com/2017/05/puppet-type-package/)
# to use, i.e. `latest`, `present` or `absent`.
# @param [boolean] ae_manage_user Whether or not to manage details for the
# httpd service user. This is generally only required when using httpd on
# a number of servers sharing storage resources, i.e. NFS, where UID and GID
# settings must be same accross all nodes.
# @param [string] ae_user_name Specify the user name for the httpd user.
# only active if `ae_manage_user` is set to true.
# @param [string] ae_user_uid Specify the UID for teh httpd service user.
# only active if `ae_manage_user` is set to true.
# @param [string] ae_u_comment Specify the user comment for /etc/passwd.
# Shows up in email notofications as sender informations.
# only active if `ae_manage_user` is set to true.
# @param [string] ae_u_groups Specify any secondary groups the httpd service
# user shoould be in. Must not contain teh primary group.
# only active if `ae_manage_user` is set to true.
# @param [string] ae_user_home Specify the home of the httpd service user.
# only active if `ae_manage_user` is set to true.
# @param [string] ae_user_shell Specify the shell for teh httpd service user,
# which normally should not be allowed to log in .
# only active if `ae_manage_user` is set to true.
# @param [boolean] ae_manage_cfg Whether or not to manage the httpd
# configuration. httpd is very often a sub system used by many other services,
# and the required configuration depends on the use case. If using httpd as
# sub-service ( i.e. for phpmyadmin, Nagios etc.), the main configuration
# should be done on that end, not in cd_apache. IN that case, set `ae_manage_cfg`
# to `false`.
# @param [boolean] ae_manage_dirs Whether or not main directories required
# to run httpd should be managed. Tyically this should be set to true.
# @param [boolean] ae_allow_user_dirs Whether or not to allow user directories
# should be allowed to share content through httpd. Usually this is a security
# problem and as such should be disabled.
##############################################################################
class cd_apache::params (
$pkg_ensure = 'latest',