Puppet Class: puppetboard::apache::vhost

Defined in:
manifests/apache/vhost.pp

Summary

Sets up an apache::vhost to run PuppetBoard, and writes an appropriate wsgi.py from template

Overview

Parameters:

  • vhost_name (String[1])

    The vhost ServerName.

  • wsgi_alias (Stdlib::Unixpath) (defaults to: '/')

    WSGI script alias source

  • ip (Optional[Stdlib::IP::Address]) (defaults to: undef)

    IP for the vhost to bind to

  • port (Stdlib::Port) (defaults to: 5000)

    Port for the vhost to listen on.

  • ssl (Boolean) (defaults to: false)

    If vhost should be configured with ssl

  • ssl_cert (Optional[Stdlib::AbsolutePath]) (defaults to: undef)

    Path to server SSL cert

  • ssl_key (Optional[Stdlib::AbsolutePath]) (defaults to: undef)

    Path to server SSL key

  • ssl_chain (Optional[Stdlib::AbsolutePath]) (defaults to: undef)

    Path to server CA Chain file

  • threads (Integer[1]) (defaults to: 5)

    Number of WSGI threads to use.

  • user (String[1]) (defaults to: $puppetboard::user)

    WSGI daemon process user, and daemon process name

  • group (String[1]) (defaults to: $puppetboard::group)

    WSGI daemon process group owner, and daemon process group

  • basedir (Stdlib::AbsolutePath) (defaults to: $puppetboard::basedir)

    Base directory where to build puppetboard vcsrepo and python virtualenv.

  • override (Variant[Array[String[1]], String[1]]) (defaults to: $puppetboard::override)

    Sets the Apache AllowOverride value

  • enable_ldap_auth (Boolean) (defaults to: $puppetboard::enable_ldap_auth)

    Whether to enable LDAP auth

  • ldap_bind_dn (Optional[String[1]]) (defaults to: undef)

    LDAP Bind DN

  • ldap_bind_password (Optional[String[1]]) (defaults to: undef)

    LDAP password

  • ldap_url (Optional[String[1]]) (defaults to: undef)

    LDAP connection string

  • ldap_bind_authoritative (Optional[String[1]]) (defaults to: undef)

    Determines if other authentication providers are used when a user can be mapped to a DN but the server cannot bind with the credentials

  • ldap_require_group (Boolean) (defaults to: $puppetboard::ldap_require_group)

    LDAP group to require on login

  • ldap_require_group_dn (Optional[String[1]]) (defaults to: undef)

    LDAP group DN for LDAP group

  • ldap_require_user (Optional[String[1]]) (defaults to: undef)

    if set, list of uids for Require ldap-user directive

  • ldap_require_dn (Optional[String[1]]) (defaults to: undef)

    if set, dn to be matched by Require ldap-dn directive

  • ldap_require_attribute (Optional[String[1]]) (defaults to: undef)

    if set, attributes of LDAP users for Require ldap-attribute directive

  • ldap_require_filter (Optional[String[1]]) (defaults to: undef)

    if set, LDAP search filter for Require ldap-filter directive

  • virtualenv_dir (Stdlib::Absolutepath) (defaults to: $puppetboard::virtualenv_dir)

    Set location where virtualenv will be installed

  • custom_apache_parameters (Hash) (defaults to: {})

    A hash passed to the ‘apache::vhost` for custom settings



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'manifests/apache/vhost.pp', line 29

class puppetboard::apache::vhost (
  String[1] $vhost_name,
  Stdlib::Unixpath $wsgi_alias                 = '/',
  Optional[Stdlib::IP::Address] $ip            = undef,
  Stdlib::Port $port                           = 5000,
  Boolean $ssl                                 = false,
  Optional[Stdlib::AbsolutePath] $ssl_cert     = undef,
  Optional[Stdlib::AbsolutePath] $ssl_key      = undef,
  Optional[Stdlib::AbsolutePath] $ssl_chain    = undef,
  Integer[1] $threads                          = 5,
  String[1] $user                              = $puppetboard::user,
  String[1] $group                             = $puppetboard::group,
  Stdlib::AbsolutePath $basedir                = $puppetboard::basedir,
  Variant[Array[String[1]], String[1]] $override = $puppetboard::override,
  Boolean $enable_ldap_auth                    = $puppetboard::enable_ldap_auth,
  Optional[String[1]] $ldap_bind_dn            = undef,
  Optional[String[1]] $ldap_bind_password      = undef,
  Optional[String[1]] $ldap_url                = undef,
  Optional[String[1]] $ldap_bind_authoritative = undef,
  Boolean $ldap_require_group                  = $puppetboard::ldap_require_group,
  Optional[String[1]] $ldap_require_group_dn   = undef,
  Optional[String[1]] $ldap_require_user          = undef,
  Optional[String[1]] $ldap_require_dn            = undef,
  Optional[String[1]] $ldap_require_attribute     = undef,
  Optional[String[1]] $ldap_require_filter        = undef,
  Stdlib::Absolutepath $virtualenv_dir         = $puppetboard::virtualenv_dir,
  Hash $custom_apache_parameters               = {},
) {
  $wsgi = $facts['os']['family'] ? {
    'Debian' => {
      package_name => 'libapache2-mod-wsgi-py3',
      mod_path     => '/usr/lib/apache2/modules/mod_wsgi.so',
    },
    default  => {},
  }
  class { 'apache::mod::wsgi':
    * => $wsgi,
  }

  $docroot = "${basedir}/puppetboard"

  $wsgi_script_aliases = {
    "${wsgi_alias}" => "${docroot}/wsgi.py",
  }

  $wsgi_daemon_process = {
    $user => {
      threads     => $threads,
      group       => $group,
      user        => $user,
      python-home => $virtualenv_dir,
    },
  }

  file { "${docroot}/wsgi.py":
    ensure  => file,
    content => file("${module_name}/wsgi.py"),
    owner   => $user,
    group   => $group,
  }

  if $enable_ldap_auth {
    $ldap_additional_includes = ["${puppetboard::apache_confd}/puppetboard-ldap.part"]
    $ldap_require = File["${puppetboard::apache_confd}/puppetboard-ldap.part"]
    file { 'puppetboard-ldap.part':
      ensure  => file,
      path    => "${puppetboard::apache_confd}/puppetboard-ldap.part",
      owner   => 'root',
      group   => 'root',
      content => epp("${module_name}/apache/ldap.epp",
        {
          'ldap_bind_authoritative' => $ldap_bind_authoritative,
          'ldap_bind_dn'            => $ldap_bind_dn,
          'ldap_bind_password'      => $ldap_bind_password,
          'ldap_require_group_dn'   => $ldap_require_group_dn,
          'ldap_require_group'      => $ldap_require_group,
          'ldap_require_user'       => $ldap_require_user,
          'ldap_require_dn'         => $ldap_require_dn,
          'ldap_require_attribute'  => $ldap_require_attribute,
          'ldap_require_filter'     => $ldap_require_filter,
          'ldap_url'                => $ldap_url,
        },
      ),
      require => File["${docroot}/wsgi.py"],
      notify  => Service[$puppetboard::apache_service],
    }
  }
  else {
    $ldap_additional_includes = undef
    $ldap_require = undef
  }
  apache::vhost { $vhost_name:
    port                => $port,
    ip                  => $ip,
    docroot             => $docroot,
    manage_docroot      => false,
    ssl                 => $ssl,
    ssl_cert            => $ssl_cert,
    ssl_key             => $ssl_key,
    ssl_chain           => $ssl_chain,
    additional_includes => $ldap_additional_includes,
    wsgi_daemon_process => $wsgi_daemon_process,
    wsgi_process_group  => $group,
    wsgi_script_aliases => $wsgi_script_aliases,
    override            => [$override].flatten,
    require             => [File["${docroot}/wsgi.py"], $ldap_require],
    notify              => Service[$puppetboard::apache_service],
    *                   => $custom_apache_parameters,
  }

  File[$puppetboard::settings_file] ~> Service[$puppetboard::apache_service]
}