Merge branch 'puppetlabs-main' into main

Author: jjackzhn

.puppet-lint.rc

@@ -1,2 +1,3 @@
 --relative
 --no-anchor_resource-check
+--no-140chars-check

.sync.yml

@@ -38,3 +38,4 @@ changelog_since_tag: "3.2.0"
 Rakefile:
   extra_disabled_lint_checks:
     - anchor_resource
+    - 140chars

README.md

@@ -14,7 +14,6 @@
 [Installing Apache modules]: #installing-apache-modules
 [Installing arbitrary modules]: #installing-arbitrary-modules
 [Installing specific modules]: #installing-specific-modules
-[Configuring FastCGI servers]: #configuring-fastcgi-servers-to-handle-php-files
 [Load balancing examples]: #load-balancing-examples
 [apache affects]: #what-the-apache-module-affects
 
@@ -34,7 +33,6 @@
 [`apache_version`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apache_version
 [`apache::balancer`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachebalancer
 [`apache::balancermember`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachebalancermember
-[`apache::fastcgi::server`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachefastcgiserver
 [`apache::mod`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemod
 [`apache::mod::<MODULE NAME>`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#public-classes
 [`apache::mod::alias`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#apachemodalias
@@ -110,7 +108,6 @@
 [`ExtendedStatus`]: https://httpd.apache.org/docs/current/mod/core.html#extendedstatus
 
 [Facter]: http://docs.puppet.com/facter/
-[FastCGI]: https://fast-cgi.github.io/
 [FallbackResource]: https://httpd.apache.org/docs/current/mod/mod_dir.html#fallbackresource
 [`fallbackresource`]: https://forge.puppet.com/modules/puppetlabs/apache/reference#fallbackresource
 [`FileETag`]: https://httpd.apache.org/docs/current/mod/core.html#fileetag
@@ -272,7 +269,6 @@
     - [Beginning with Apache - Installation][Beginning with Apache]
 3. [Usage - The classes and defined types available for configuration][Usage]
     - [Configuring virtual hosts - Examples to help get started][Configuring virtual hosts]
-    - [Configuring FastCGI servers to handle PHP files][Configuring FastCGI servers]
     - [Load balancing with exported and non-exported resources][Load balancing examples]
 4. [Reference - An under-the-hood peek at what the module is doing and how][Reference]
 5. [Limitations - OS compatibility, etc.][Limitations]
@@ -316,7 +312,7 @@ When you declare this class with the default options, the module:
 
 - Installs the appropriate Apache software package and [required Apache modules][`default_mods`] for your operating system.
 - Places the required configuration files in a directory, with the [default location][`conf_dir`] Depends on operating system.
-- Configures the server with a default virtual host and standard port ('80') and address ('\*') bindings.
+- Configures the server with a default virtual host and standard port (80) and address ('\*') bindings.
 - Creates a document root directory Depends on operating system, typically `/var/www`.
 - Starts the Apache service.
 
@@ -345,7 +341,7 @@ To configure basic [name-based virtual hosts][], specify the [`port`][] and [`do
 
 ``` puppet
 apache::vhost { 'vhost.example.com':
-  port    => '80',
+  port    => 80,
   docroot => '/var/www/vhost',
 }
 ```
@@ -358,7 +354,7 @@ To configure user and group ownership for `docroot`, use the [`docroot_owner`][]
 
 ``` puppet
 apache::vhost { 'user.example.com':
-  port          => '80',
+  port          => 80,
   docroot       => '/var/www/user',
   docroot_owner => 'www-data',
   docroot_group => 'www-data',
@@ -367,11 +363,11 @@ apache::vhost { 'user.example.com':
 
 #### Configuring virtual hosts with SSL
 
-To configure a virtual host to use [SSL encryption][] and default SSL certificates, set the [`ssl`][] parameter. You must also specify the [`port`][] parameter, typically with a value of '443', to accommodate HTTPS requests:
+To configure a virtual host to use [SSL encryption][] and default SSL certificates, set the [`ssl`][] parameter. You must also specify the [`port`][] parameter, typically with a value of 443, to accommodate HTTPS requests:
 
 ``` puppet
 apache::vhost { 'ssl.example.com':
-  port    => '443',
+  port    => 443,
   docroot => '/var/www/ssl',
   ssl     => true,
 }
@@ -381,7 +377,7 @@ To configure a virtual host to use SSL and specific SSL certificates, use the pa
 
 ``` puppet
 apache::vhost { 'cert.example.com':
-  port     => '443',
+  port     => 443,
   docroot  => '/var/www/cert',
   ssl      => true,
   ssl_cert => '/etc/ssl/fourth.example.com.cert',
@@ -395,14 +391,14 @@ To configure a mix of SSL and unencrypted virtual hosts at the same domain, decl
 # The non-ssl virtual host
 apache::vhost { 'mix.example.com non-ssl':
   servername => 'mix.example.com',
-  port       => '80',
+  port       => 80,
   docroot    => '/var/www/mix',
 }
 
 # The SSL virtual host at the same domain
 apache::vhost { 'mix.example.com ssl':
   servername => 'mix.example.com',
-  port       => '443',
+  port       => 443,
   docroot    => '/var/www/mix',
   ssl        => true,
 }
@@ -413,15 +409,15 @@ To configure a virtual host to redirect unencrypted connections to SSL, declare
 ``` puppet
 apache::vhost { 'redirect.example.com non-ssl':
   servername      => 'redirect.example.com',
-  port            => '80',
+  port            => 80,
   docroot         => '/var/www/redirect',
   redirect_status => 'permanent',
   redirect_dest   => 'https://redirect.example.com/'
 }
 
 apache::vhost { 'redirect.example.com ssl':
   servername => 'redirect.example.com',
-  port       => '443',
+  port       => 443,
   docroot    => '/var/www/redirect',
   ssl        => true,
 }
@@ -434,7 +430,7 @@ Virtual hosts listen on all IP addresses ('\*') by default. To configure the vir
 ``` puppet
 apache::vhost { 'ip.example.com':
   ip      => '127.0.0.1',
-  port    => '80',
+  port    => 80,
   docroot => '/var/www/ip',
 }
 ```
@@ -444,7 +440,7 @@ You can also configure more than one IP address per virtual host by using an arr
 ``` puppet
 apache::vhost { 'ip.example.com':
   ip      => ['127.0.0.1','169.254.1.1'],
-  port    => '80',
+  port    => 80,
   docroot => '/var/www/ip',
 }
 ```
@@ -454,7 +450,7 @@ You can configure multiple ports per virtual host by using an array of ports for
 ``` puppet
 apache::vhost { 'ip.example.com':
   ip      => ['127.0.0.1'],
-  port    => ['80','8080']
+  port    => [80, 8080]
   docroot => '/var/www/ip',
 }
 ```
@@ -467,7 +463,7 @@ apache::vhost { 'aliases.example.com':
     'aliases.example.org',
     'aliases.example.net',
   ],
-  port          => '80',
+  port          => 80,
   docroot       => '/var/www/aliases',
 }
 ```
@@ -477,7 +473,7 @@ To set up a virtual host with a wildcard alias for the subdomain mapped to a dir
 ``` puppet
 apache::vhost { 'subdomain.loc':
   vhost_name      => '*',
-  port            => '80',
+  port            => 80,
   virtual_docroot => '/var/www/%-2+',
   docroot         => '/var/www',
   serveraliases   => ['*.loc',],
@@ -488,7 +484,7 @@ To configure a virtual host with [filter rules][], pass the filter directives as
 
 ``` puppet
 apache::vhost { 'subdomain.loc':
-  port    => '80',
+  port    => 80,
   filters => [
     'FilterDeclare  COMPRESS',
     'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/html',
@@ -505,13 +501,13 @@ To configure a virtual host to use the [Web Server Gateway Interface][] (WSGI) f
 
 ``` puppet
 apache::vhost { 'wsgi.example.com':
-  port                        => '80',
+  port                        => 80,
   docroot                     => '/var/www/pythonapp',
   wsgi_application_group      => '%{GLOBAL}',
   wsgi_daemon_process         => 'wsgi',
   wsgi_daemon_process_options => {
-    processes    => '2',
-    threads      => '15',
+    processes    => 2,
+    threads      => 15,
     display-name => '%{GROUP}',
   },
   wsgi_import_script          => '/var/www/demo.wsgi',
@@ -528,7 +524,7 @@ As of Apache 2.2.16, Apache supports [FallbackResource][], a simple replacement
 
 ``` puppet
 apache::vhost { 'wordpress.example.com':
-  port             => '80',
+  port             => 80,
   docroot          => '/var/www/wordpress',
   fallbackresource => '/index.php',
 }
@@ -540,7 +536,7 @@ To configure a virtual host with a designated directory for [Common Gateway Inte
 
 ``` puppet
 apache::vhost { 'cgi.example.com':
-  port        => '80',
+  port        => 80,
   docroot     => '/var/www/cgi',
   scriptalias => '/usr/lib/cgi-bin',
 }
@@ -550,7 +546,7 @@ To configure a virtual host for [Rack][], use the [`rack_base_uri`][] parameter:
 
 ``` puppet
 apache::vhost { 'rack.example.com':
-  port           => '80',
+  port           => 80,
   docroot        => '/var/www/rack',
   rack_base_uri => ['/rackapp1', '/rackapp2'],
 }
@@ -590,15 +586,15 @@ In this example, we add two IP-based virtual hosts on an IP address (in this exa
 apache::vhost { 'The first IP-based virtual host, non-ssl':
   servername => 'first.example.com',
   ip         => '10.0.0.10',
-  port       => '80',
+  port       => 80,
   ip_based   => true,
   docroot    => '/var/www/first',
 }
 
 apache::vhost { 'The first IP-based vhost, ssl':
   servername => 'first.example.com',
   ip         => '10.0.0.10',
-  port       => '443',
+  port       => 443,
   ip_based   => true,
   docroot    => '/var/www/first-ssl',
   ssl        => true,
@@ -610,13 +606,13 @@ Next, we add two name-based virtual hosts listening on a second IP address (10.0
 ``` puppet
 apache::vhost { 'second.example.com':
   ip      => '10.0.0.20',
-  port    => '80',
+  port    => 80,
   docroot => '/var/www/second',
 }
 
 apache::vhost { 'third.example.com':
   ip      => '10.0.0.20',
-  port    => '80',
+  port    => 80,
   docroot => '/var/www/third',
 }
 ```
@@ -625,13 +621,13 @@ To add name-based virtual hosts that answer on either 10.0.0.10 or 10.0.0.20, yo
 
 ``` puppet
 apache::vhost { 'fourth.example.com':
-  port       => '80',
+  port       => 80,
   docroot    => '/var/www/fourth',
   add_listen => false,
 }
 
 apache::vhost { 'fifth.example.com':
-  port       => '80',
+  port       => 80,
   docroot    => '/var/www/fifth',
   add_listen => false,
 }
@@ -676,54 +672,6 @@ apache::mod { 'mod_authnz_external': }
 
 There are several optional parameters you can specify when defining Apache modules this way. See the [defined type's reference][`apache::mod`] for details.
 
-<a id="configuring-fastcgi-servers-to-handle-php-files"></a>
-### Configuring FastCGI servers to handle PHP files
-
-#### FastCGI on Ubuntu 18.04
-
-On Ubuntu 18.04, `mod_fastcgi` is no longer supported. So considering:
-
-* an Apache Vhost with docroot set to `/var/www/html`
-* a FastCGI server listening on `127.0.0.1:9000`
-
-you can then use the [`custom_fragment`][] parameter to configure the virtual host to have the FastCGI server handle the specified file type:
-
-``` puppet
-apache::vhost { 'www':
-  ...
-  docroot         => '/var/www/html/',
-  custom_fragment => 'ProxyPassMatch ^/(.*\.php)$ fcgi://127.0.0.1:9000/var/www/html/$1',
-  ...
-}
-```
-
-Please note you have to adjust the second ProxyPassMatch parameter to your docroot value (here `/var/www/html/`).
-
-#### Other OSes
-
-Add the [`apache::fastcgi::server`][] defined type to allow [FastCGI][] servers to handle requests for specific files. For example, the following defines a FastCGI server at 127.0.0.1 (localhost) on port 9000 to handle PHP requests:
-
-``` puppet
-apache::fastcgi::server { 'php':
-  host       => '127.0.0.1:9000',
-  timeout    => 15,
-  flush      => false,
-  faux_path  => '/var/www/php.fcgi',
-  fcgi_alias => '/php.fcgi',
-  file_type  => 'application/x-httpd-php'
-}
-```
-
-You can then use the [`custom_fragment`][] parameter to configure the virtual host to have the FastCGI server handle the specified file type:
-
-``` puppet
-apache::vhost { 'www':
-  ...
-  custom_fragment => 'AddType application/x-httpd-php .php'
-  ...
-}
-```
-
 <a id="load-balancing-examples"></a> 
 ### Load balancing examples