confdroid/confdroid_apache
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Compare commits

base: confdroid:8b2ebce7792b726fc72b68e383842a7a07a22f23
Branches Tags
confdroid:master
confdroid:1.1.0-3.2026 confdroid:1.0.0
...
compare: confdroid:d9dfd8d919a0c8828d94261c7419f1b906776f34
Branches Tags
confdroid:master
confdroid:1.1.0-3.2026 confdroid:1.0.0

4 Commits
8b2ebce779 ... d9dfd8d919

Author SHA1 Message Date
Jenkins Server
d9dfd8d919 Recommit for updates in build 39 2026-03-14 13:20:39 +01:00
Jenkins Server
30267c62c3 Merge remote-tracking branch 'origin/master' into jenkins-build-39 2026-03-14 13:19:29 +01:00
12ww1160
e53a3acc1d OP#493 add option for reading client IPs behind loadbalanacer 2026-03-14 13:16:12 +01:00
Jenkins Server
357994f4eb Merge remote-tracking branch 'origin/master' into jenkins-build-38 2026-03-14 11:43:00 +01:00
9 changed files with 141 additions and 264 deletions
Expand all files Collapse all files

126
Jenkinsfile vendored
View File

@@ -1,126 +0,0 @@
pipeline {
agent {
label 'puppet'
}
post {
always {
deleteDir() /* clean up our workspace */
}
success {
updateGitlabCommitStatus state: 'success'
}
failure {
updateGitlabCommitStatus state: 'failed'
step([$class: 'Mailer', notifyEveryUnstableBuild: true, recipients: 'support@confdroid.com', sendToIndividuals: true])
}
}
options {
gitLabConnection('gitlab.confdroid.com')
}
stages {
stage('pull master') {
steps {
sshagent(['edd05eb6-26b5-4c7b-a5cc-ea2ab899f4fa']) {
sh '''
git config user.name "Jenkins Server"
git config user.email jenkins@confdroid.com
# Ensure we're on the development branch (triggered by push)
git checkout development
# Create jenkins branch from development
git checkout -b jenkins-build-$BUILD_NUMBER
# Optionally merge master into jenkins to ensure compatibility
git merge origin/master --no-ff || { echo "Merge conflict detected"; exit 1; }
'''
}
}
}
stage('puppet parser') {
steps {
sh '''for file in $(find . -iname \'*.pp\'); do
/opt/puppetlabs/bin/puppet parser validate --color false --render-as s --modulepath=modules $file || exit 1;
done;'''
}
}
stage('check templates') {
steps{
sh '''for file in $(find . -iname \'*.erb\');
do erb -P -x -T "-" $file | ruby -c || exit 1;
done;'''
}
}
stage('puppet-lint') {
steps {
sh '''/usr/local/bin/puppet-lint . \\
--no-variable_scope-check \\
|| { echo "Puppet lint failed"; exit 1; }
'''
}
}
stage('SonarScan') {
steps {
withCredentials([string(credentialsId: 'sonar-token', variable: 'SONAR_TOKEN')]) {
sh '''
/opt/sonar-scanner/bin/sonar-scanner \
-Dsonar.projectKey=confdroid_apache \
-Dsonar.sources=. \
-Dsonar.host.url=https://sonarqube.confdroid.com \
-Dsonar.token=$SONAR_TOKEN
'''
}
}
}
stage('create Puppet documentation') {
steps {
sh '/opt/puppetlabs/bin/puppet strings'
}
}
stage('update repo') {
steps {
sshagent(['edd05eb6-26b5-4c7b-a5cc-ea2ab899f4fa']) {
sh '''
git config user.name "Jenkins Server"
git config user.email jenkins@confdroid.com
git rm -r --cached .vscode || echo "No .vscode to remove from git"
git add -A && git commit -am "Recommit for updates in build $BUILD_NUMBER" || echo "No changes to commit"
git push origin HEAD:master
'''
}
}
}
stage('Mirror to Gitea') {
steps {
withCredentials([usernamePassword(
credentialsId: 'Jenkins-gitea',
usernameVariable: 'GITEA_USER',
passwordVariable: 'GITEA_TOKEN')]) {
script {
// Checkout from GitLab (already done implicitly)
sh '''
git checkout master
git pull origin master
git branch -D development
git branch -D jenkins-build-$BUILD_NUMBER
git rm -f Jenkinsfile
git rm -r --cached .vscode || echo "No .vscode to remove from git"
git commit --amend --no-edit --allow-empty
git remote add master https://sourcecode.confdroid.com/confdroid/confdroid_apache.git
git -c credential.helper="!f() { echo username=${GITEA_USER}; echo password=${GITEA_TOKEN}; }; f" \
push master --mirror
'''
}
}
}
}
}
}

4
README.md
View File

@@ -43,6 +43,10 @@ Configuration
- manage firewall settings (optional)
- manage nagios monitoring for the service (optional)
Optional
- manage remoteIP logging if running behind a Loadbalancer like HAproxy: if `ae_use_lb` is set to `true`, a configuration file `etc/httpd/conf.d/loadbalancer-remoteip.conf`is created and configures apache/httpd to use the remote header. This allows proper fail2ban protection even behind the Loadbalancer. Make sure to set `ae_trusted_proxy`to the proper IP or range for the loadbalancer!
Maintenance
- manage the service

5
doc/file.README.html
View File

@@ -122,6 +122,11 @@
<p>manage nagios monitoring for the service (optional)</p>
</li></ul>
<p>Optional</p>
<ul><li>
<p>manage remoteIP logging if running behind a Loadbalancer like HAproxy: if <code>ae_use_lb</code> is set to <code>true</code>, a configuration file <code>etc/httpd/conf.d/loadbalancer-remoteip.conf</code>is created and configures apache/httpd to use the remote header. This allows proper fail2ban protection even behind the Loadbalancer. Make sure to set <code>ae_trusted_proxy</code>to the proper IP or range for the loadbalancer!</p>
</li></ul>
<p>Maintenance</p>
<ul><li>
<p>manage the service</p>

5
doc/index.html
View File

@@ -122,6 +122,11 @@
<p>manage nagios monitoring for the service (optional)</p>
</li></ul>
<p>Optional</p>
<ul><li>
<p>manage remoteIP logging if running behind a Loadbalancer like HAproxy: if <code>ae_use_lb</code> is set to <code>true</code>, a configuration file <code>etc/httpd/conf.d/loadbalancer-remoteip.conf</code>is created and configures apache/httpd to use the remote header. This allows proper fail2ban protection even behind the Loadbalancer. Make sure to set <code>ae_trusted_proxy</code>to the proper IP or range for the loadbalancer!</p>
</li></ul>
<p>Maintenance</p>
<ul><li>
<p>manage the service</p>

172
doc/puppet_classes/confdroid_apache_3A_3Aparams.html
View File

@@ -129,118 +129,6 @@ inherited by all classes except defines.
</li>
<li>
<span class='name'>ae_manage_user</span>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>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 across all nodes.</p>
</div>
</li>
<li>
<span class='name'>ae_user_name</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Specify the user name for the httpd user. only active if ae_manage_user is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_user_uid</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Specify the UID for the httpd service user. only active if <code>ae_manage_user</code> is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_u_comment</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Specify the user comment for /etc/passwd. Shows up in email notifications as sender information. only active if <code>ae_manage_user</code> is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_u_groups</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Specify any secondary groups the httpd service user should be in. Must not contain the primary group. only active if <code>ae_manage_user</code> is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_user_home</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Specify the home of the httpd service user. only active if <code>ae_manage_user</code> is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_user_shell</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>Specify the shell for the httpd service user, which normally should not be allowed to log in . only active if <code>ae_manage_user</code> is set to true.</p>
</div>
</li>
<li>
<span class='name'>ae_manage_cfg</span>
@@ -435,6 +323,42 @@ inherited by all classes except defines.
&mdash;
<div class='inline'>
<p>List of packages to install.</p>
</div>
</li>
<li>
<span class='name'>ae_use_lb</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to use load balancer or not. If true, a configuration file will be created to allow reading the client ips from the X-Forwarded-For header, and the httpd service will be restarted to apply the changes. This is required when using httpd behind a load balancer like haproxy, otherwise all client ips will be logged as the load balancer ip.</p>
</div>
</li>
<li>
<span class='name'>ae_trusted_proxy</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10.0.1.0/24&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the IP address of the trusted proxy, i.e. the load balancer. This is required when <code>ae_use_lb</code> is set to true, and defaults to ‘10.0.1.0/24’.</p>
</div>
</li>
@@ -450,6 +374,16 @@ inherited by all classes except defines.
<pre class="lines">
37
38
39
40
41
42
43
44
45
46
47
48
49
@@ -509,14 +443,10 @@ inherited by all classes except defines.
103
104
105
106
107
108
109
110</pre>
106</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 47</span>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 37</span>
class confdroid_apache::params (
@@ -540,6 +470,10 @@ class confdroid_apache::params (
String $ae_http_port = &#39;80&#39;,
String $ae_https_port = &#39;443&#39;,
# loadbalancer
Boolean $ae_use_lb = false,
String $ae_trusted_proxy = &#39;10.0.1.0/24&#39;,
) {
# facts
$fqdn = $facts[&#39;networking&#39;][&#39;fqdn&#39;]
@@ -578,6 +512,8 @@ class confdroid_apache::params (
$ae_userdir_erb = &#39;confdroid_apache/userdir_conf.erb&#39;
$ae_index_file = &#39;/var/www/html/index.html&#39;
$ae_index_erb = &#39;confdroid_apache/index_html.erb&#39;
$ae_remoteip_file = &#39;/etc/httpd/conf.d/loadbalancer-remoteip.conf&#39;
$ae_remoteip_erb = &#39;confdroid_apache/loadbalancer_remoteip_conf.erb&#39;
# includes must be last
include confdroid_apache::main::config

32
doc/puppet_classes/confdroid_apache_3A_3Aserver_3A_3Afiles.html
View File

@@ -205,7 +205,22 @@
107
108
109
110</pre>
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/server/files.pp', line 6</span>
@@ -299,6 +314,21 @@ class confdroid_apache::server::files (
}
}
if $ae_use_lb == true {
file { $ae_remoteip_file:
ensure =&gt; file,
owner =&gt; &#39;root&#39;,
group =&gt; &#39;root&#39;,
mode =&gt; &#39;0644&#39;,
selrange =&gt; s0,
selrole =&gt; object_r,
seltype =&gt; httpd_conf_t,
seluser =&gt; system_u,
content =&gt; template($ae_remoteip_erb),
notify =&gt; Service[&#39;httpd&#39;],
}
}
# manage index.html
file { $ae_index_file:

34
manifests/params.pp
View File

@@ -5,25 +5,6 @@
# inherited by all classes except defines.
# @param [String] pkg_ensure Specify which
# package type 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 across 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 the 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 notifications as sender information.
# only active if `ae_manage_user` is set to true.
# @param [String] ae_u_groups Specify any secondary groups the httpd service
# user should be in. Must not contain the 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 the 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
@@ -43,6 +24,15 @@
# @param [String] ae_target_contacts which contacts to notify for nagios alerts
# @param [Boolean] ae_manage_fw whether to manage firewall settings
# @param [Array] reqpackages List of packages to install.
# @param [Boolean] ae_use_lb whether to use load balancer or not. If true,
# a configuration file will be created to allow reading the client ips
# from the X-Forwarded-For header, and the httpd service will be restarted
# to apply the changes. This is required when using httpd behind a
# load balancer like haproxy, otherwise all client ips will be logged
# as the load balancer ip.
# @param [String] ae_trusted_proxy the IP address of the trusted proxy,
# i.e. the load balancer. This is required when `ae_use_lb` is set to
# true, and defaults to '10.0.1.0/24'.
###########################################################################
class confdroid_apache::params (
@@ -66,6 +56,10 @@ class confdroid_apache::params (
String $ae_http_port = '80',
String $ae_https_port = '443',
# loadbalancer
Boolean $ae_use_lb = false,
String $ae_trusted_proxy = '10.0.1.0/24',
) {
# facts
$fqdn = $facts['networking']['fqdn']
@@ -104,6 +98,8 @@ class confdroid_apache::params (
$ae_userdir_erb = 'confdroid_apache/userdir_conf.erb'
$ae_index_file = '/var/www/html/index.html'
$ae_index_erb = 'confdroid_apache/index_html.erb'
$ae_remoteip_file = '/etc/httpd/conf.d/loadbalancer-remoteip.conf'
$ae_remoteip_erb = 'confdroid_apache/loadbalancer_remoteip_conf.erb'
# includes must be last
include confdroid_apache::main::config

15
manifests/server/files.pp
View File

@@ -92,6 +92,21 @@ class confdroid_apache::server::files (
}
}
if $ae_use_lb == true {
file { $ae_remoteip_file:
ensure => file,
owner => 'root',
group => 'root',
mode => '0644',
selrange => s0,
selrole => object_r,
seltype => httpd_conf_t,
seluser => system_u,
content => template($ae_remoteip_erb),
notify => Service['httpd'],
}
}
# manage index.html
file { $ae_index_file:

12
templates/loadbalancer/remoteip.conf.erb Normal file
View File

@@ -0,0 +1,12 @@
###############################################################################
########## parameterized remoteip config created by Puppet ##########
########## manual changes will be overwritten !!! ##########
###############################################################################
RemoteIPHeader X-Forwarded-For
RemoteIPTrustedProxy <%= @ae_trusted_proxy %>
RemoteIPInternalProxy <%= @ae_trusted_proxy %>
# mod_remoteip rewrites client address for %a; use it in common/combined logs.
LogFormat "%a %l %u %t \"%r\" %>s %b" common
LogFormat "%a %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" combined