adjust everything for compliance with puppet-lint

This commit is contained in:
Arne Teuke
2025-05-15 14:19:35 +02:00
parent 9d50c2888d
commit c956708cdb
40 changed files with 68 additions and 9329 deletions

View File

@@ -1,77 +1,59 @@
## haproxy_cd::params.pp
# Module name: haproxy_cd
# Author: Arne Teuke (arne_teuke@confdroid.com)
# @param [string] pkg_ensure
# @param [String] pkg_ensure
# which [package type](https://confdroid.com/2017/05/puppet-type-package/)
# to choose, i.e. `latest` or `present`.
# @param [array] reqpackages specify the packages to be installed
# @param [string] hy_host_fqdn the fqdn of the ha proxy host. must be fqdn,
# @param [String] hy_host_fqdn the fqdn of the ha proxy host. must be fqdn,
# not cname. specify multiple fqdns via array.
# @param [boolean] hy_manage_fw whether to manage the firewall.
# @param [string] hy_fw_order_no the rule number to control the order of the
# @param [Boolean] hy_manage_fw whether to manage the firewall.
# @param [String] hy_fw_order_no the rule number to control the order of the
# firewall rules.
# @param [string] hy_http_port the http port. used in firewall settings
# @param [string] hy_https_port the https port. used in firewall settings
# @param [string] hy_user_name the name of the haproxy service user.
# @param [string] hy_user_comment the comment of the haproxy user, shows up
# @param [String] hy_http_port the http port. used in firewall settings
# @param [String] hy_https_port the https port. used in firewall settings
# @param [String] hy_user_name the name of the haproxy service user.
# @param [String] hy_user_comment the comment of the haproxy user, shows up
# in emails sent from haproxy.
# @param [string] hy_user_home the home directory for the haproxy user.
# @param [string] hy_user_shell the shell for the haproxy user.
# @param [string] hy_log_target Where to send the logs for this haproxy.
# @param [String] hy_user_home the home directory for the haproxy user.
# @param [String] hy_user_shell the shell for the haproxy user.
# @param [String] hy_log_target Where to send the logs for this haproxy.
# Currently only local logging / rsyslog forwarding supported.
# @param [string] hy_log_facility which logging facility to use.
# @param [string] hy_chroot where the chroot should be
# @param [string] hy_pid the pid file to use.
# @param [string] hy_maxconn how many connections should we max allow.
# @param [boolean] hy_show_stats whether we want to display the statistics page
# @param [string] hy_stats_socket name and path of the stats socket
# @param [string] hy_default_mode which mode to use in the defaults block
# @param [string] hy_log_default should be used when the instance's logging
# @param [String] hy_log_facility which logging facility to use.
# @param [String] hy_chroot where the chroot should be
# @param [String] hy_pid the pid file to use.
# @param [String] hy_maxconn how many connections should we max allow.
# @param [Boolean] hy_show_stats whether we want to display the statistics page
# @param [String] hy_stats_socket name and path of the stats socket
# @param [String] hy_default_mode which mode to use in the defaults block
# @param [String] hy_log_default should be used when the instance's logging
# parameters are the same as the global ones.
# @param [boolean] hy_use_httplog whether to use httplogging option. Enable
# logging of HTTP request, session state and timers
# @param [boolean] hy_use_dontlognull Whether to enable or disable dontlognull
# option. true enables, false disables.
# @param [boolean] hy_use_http_server_close Enable or disable HTTP connection
# closing on the server side
# @param [boolean] hy_use_forward_for Enable insertion of the
# X-Forwarded-For header to requests sent to servers.
# @param [boolean] hy_use_redispatch Enable or disable session redistribution
# in case of connection failure.
# @param [string] hy_max_retries Set the number of retries to perform on a
# server after a connection failure.
# @param [string] hy_timeout_http_request Set the maximum allowed time to wait
# @param [String] hy_timeout_http_request Set the maximum allowed time to wait
# for a complete HTTP request.
# @param [string] hy_timeout_queue Set the maximum time to wait in the queue
# @param [String] hy_timeout_queue Set the maximum time to wait in the queue
# for a connection slot to be free.
# @param [string] hy_timeout_connect Set the maximum time to wait for a
# connection attempt to a server to succeed.
# @param [string] hy_timeout_client Set the maximum inactivity time on the
# client side.
# @param [string] hy_timeout_server Set the maximum inactivity time on the
# server side.
# @param [string] hy_timeout_http_keep_alive set the timeout value for
# @param [String] hy_timeout_http_keep_alive set the timeout value for
# keeping https connections alive
# @param [string] hy_timeout_check set the timeout value for how long to check
# @param [String] hy_timeout_check set the timeout value for how long to check
# if the timeout has occurred
# @param [boolean] hy_manage_fail2ban whether to integrate fail2ban
# @param [boolean] hy_use_http_server_close whether to use this in global mode
# @param [boolean] hy_use_forward_for whether to use this in global mode
# @param [boolean] hy_use_redispatch whether to use this in global mode
# @param [string] hy_max_retries max retries value
# @param [string] hy_timeout_connect timeout for connections
# @param [string] hy_timeout_client timeout for client connections
# @param [string] hy_timeout_server timeout for server response
# @param [boolean] hy_hard_stop whether to use hard stop for service restart
# @param [string] hy_hard_stop_value which value to use for hard stop
# @param [string] hy_stats_auth credentials to use for stats authentication
# @param [string] hy_log_local0 settings for logging to local0
# @param [string] hy_log_local1 settings for logging to local1
# @param [boolean] hy_use_tcplog whether to use tcplog as default
# @param [boolean] hy_use_httplog whether to use httplog as default
# @param [boolean] hy_use_dontlognull whether to use dontlognull as default
# @param [string] hy_be_userlist backend userlist comment
# @param [boolean] hy_manage_be_users whether to manage backend users
# @param [Boolean] hy_manage_fail2ban whether to integrate fail2ban
# @param [Boolean] hy_use_http_server_close whether to use this in global mode
# @param [Boolean] hy_use_forward_for whether to use this in global mode
# @param [Boolean] hy_use_redispatch whether to use this in global mode
# @param [String] hy_max_retries max retries value
# @param [String] hy_timeout_connect timeout for connections
# @param [String] hy_timeout_client timeout for client connections
# @param [String] hy_timeout_server timeout for server response
# @param [Boolean] hy_hard_stop whether to use hard stop for service restart
# @param [String] hy_hard_stop_value which value to use for hard stop
# @param [String] hy_stats_auth credentials to use for stats authentication
# @param [String] hy_log_local0 settings for logging to local0
# @param [String] hy_log_local1 settings for logging to local1
# @param [Boolean] hy_use_tcplog whether to use tcplog as default
# @param [Boolean] hy_use_httplog whether to use httplog as default
# @param [Boolean] hy_use_dontlognull whether to use dontlognull as default
# @param [String] hy_be_userlist backend userlist comment
# @param [Boolean] hy_manage_be_users whether to manage backend users
###############################################################################
class haproxy_cd::params (