Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'theforeman-foreman', '25.2.2'
Learn more about managing modules with a PuppetfileDocumentation
Puppet module for managing Foreman
Installs and configures Foreman, part of the Foreman installer or to be used as a Puppet module.
Many Foreman plugins can be installed by adding additional foreman::plugin::*
classes, extra compute resource support via foreman::compute::*
classes and
the Hammer CLI can be installed by adding foreman::cli
.
By default, it configures Foreman to run as a standalone service fronted by Apache as a reverse proxy with a PostgreSQL database.
The web interface is configured to use Puppet's SSL certificates by default, so
ensure they're present first, reconfigure server_ssl_*
or disable the ssl
parameter. When used with the 'puppet' module, it will generate a new CA and
the required certificate.
Lots of parameters are supplied to tune the default installation, which may be found in the class documentation at the top of each manifest.
Other modules may be used in combination with this one: puppet for managing a Puppet master and agent, and foreman_proxy to configure Foreman's Smart Proxy and related services.
Database support
The default database is PostgreSQL, which will be fully installed and managed
on the host this module is applied to. Databases will be created with using the
en_US.utf8
locale, which means a respective OS locale must be available on
the database host. The database management can be disabled with db_manage
.
Rails Cache support
Foreman supports different backends as Rails cache. This is handled by this
module using the parameter rails_cache_store
. The parameter takes a hash
containing the type and options specfic to the backend.
The default is the file backend, configured via {'type' => 'file'}
. To
setup for redis use a hash similar to {'type' => 'redis', 'urls' => ['localhost:8479/4'], 'options' => {'compress' => 'true', 'namespace' => 'foreman'}}
where urls
takes an array of redis urls which get prepended with redis://
and options
using a hash with options from rails
falling back to {'compress' => 'true', 'namespace' => 'foreman'}
if no
option is provided.
An example configuration for activating the redis backend with a local instance could look like this:
class { 'foreman':
rails_cache_store => {
'type' => 'redis',
'urls' => ['localhost:8479/4'],
'options' => {
'compress' => 'true',
'namespace' => 'foreman'
}
}
}
Support policy
At any time, the module supports two releases, however the previous version may require parameters to be changed from their default values. These should be noted below.
Thus 'master' will support the upcoming major version and the current stable. The latest release (git tag, Puppet Forge) should support current and the previous stable release.
Foreman version compatibility notes
This module targets Foreman 3.1+. The module can not be used to manage Foreman installations on EL7.
This module configures Apache to serve static assets from
/var/lib/foreman/public
directly. This requires an appropriate
SELinux policy, like the one introduced in foreman-selinux
version 3.5.
Additionally, some plugin packages might be incomplatible with such
a deployment. To serve assets via Rails again, set
foreman::config::apache::proxy_assets
to true
.
Types and providers
foreman_config_entry
can be used to manage settings in Foreman's database, as
seen in Administer > Settings. The cli
provider uses foreman-rake
to change settings.
foreman_smartproxy
can create and manage registered smart proxies in
Foreman's database. The rest_v3
provider uses the API with Ruby's HTTP library, OAuth and JSON.
foreman_hostgroup
can be used to create and destroy hostgroups. Nested hostgroups are supported
and hostgroups can be assigned to locations/organizations.
The type currently doesn't support other properties such as environment
, puppet classes
etc.
Foreman ENC via hiera
There is a function foreman::enc
to retrieve the ENC data. This returns the
data as a hash and can be used in Hiera. This requires the URL to use the
Puppet CA infrastructure:
---
version: 5
hierarchy:
- name: "Foreman ENC"
data_hash: foreman::enc
options:
url: https://foreman.example.com
It is also possible to use HTTP basic auth by adding a username/password to the
URL in the form of https://username:password@foreman.example.com
.
Then within your manifests you can use lookup
. For example, in
manifests/site.pp
:
node default {
lookup('classes', {merge => unique}).include
}
Contributing
- Fork the project
- Commit and push until you are happy with your contribution
- Send a pull request with a description of your changes
See the CONTRIBUTING.md file for much more information.
Adding new foreman::plugin::*
classes is a very useful place to start
contributing to this module.
More info
See https://theforeman.org or at #theforeman irc channel on freenode
Copyright (c) 2010-2013 Ohad Levy and their respective owners
Except where specified in provided modules, this program and entire repository is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
Changelog
25.2.2 (2024-09-18)
Fixed bugs:
25.2.1 (2024-09-04)
Fixed bugs:
25.2.0 (2024-08-14)
Implemented enhancements:
Fixed bugs:
25.1.0 (2024-08-12)
Implemented enhancements:
- always log foreman-rake output #1170 (evgeni)
- Update puppet_metadata to ~> 4.0 and voxpupuli-acceptance to ~> 3.0 #1169 (archanaserver)
- Add AlmaLinux 8 & 9 support #1168 (archanaserver)
25.0.0 (2024-05-16)
Breaking changes:
- Fixes #33974 - Change the pool size to threads + 4 #1161 (ShimShtein)
- Refs #37296 - Drop foreman-hooks #1159 (adamruzicka)
- Refs #37212 - Drop foreman_setup plugin support #1155 (ekohl)
Implemented enhancements:
- Allow puppet/redis 11.x #1163 (evgeni)
- Allow puppet/systemd 7.x #1162 (gcoxmoz)
- Fixes #35832 - set default_domain_suffix in sssd.conf #1160 (adamruzicka)
- Add support for Debian 12 #1158 (evgeni)
- Allow puppetlabs/apache 12.x #1157 (evgeni)
- Add support for Ubuntu 22.04 #1156 (evgeni)
Fixed bugs:
24.2.0 (2024-02-19)
Implemented enhancements:
- Mark compatible with puppet/redis 10.x #1153 (ekohl)
- Support EL9 #1152 (ekohl)
- Add hiera data manager (HDM) plugin #1149 (tuxmea)
- Only install dnf module on EL8 #1147 (ekohl)
24.1.0 (2023-11-29)
Implemented enhancements:
- Add hammer-cli-foreman-rh-cloud package #1145 (ShimShtein)
24.0.0 (2023-11-14)
Breaking changes:
- Drop deprecated non-namespaced functions #1141 (ekohl)
- Fixes #36801: Make Redis the default cache type #1134 (ehelms)
- require puppetlabs/stdlib 9.x #1125 (bastelfreak)
Implemented enhancements:
- Mark compatible with puppetlabs/postgresql 10.x #1143 (ekohl)
- Use JSON to parse Foreman API responses #1142 (ekohl)
- Include settings header via concat #1140 (ekohl)
- Add Puppet 8 support #1139 (ekohl)
- Mark compatible with puppet-extlib 7.x #1138 (ekohl)
- Fixes #36090 - Support REX cockpit removal #1111 (ekohl)
23.2.0 (2023-10-10)
Implemented enhancements:
- Fixes #36812 - allow setting (fc)ct_location #1135 (evgeni)
- Mark compatible with puppetlabs/apache 11.x #1131 (ekohl)
- Allow puppet/systemd 5.x and 6.x #1129 (evgeni)
Fixed bugs:
23.1.0 (2023-08-16)
Implemented enhancements:
- Fixes #36582 - Detect logging layout based on type #1124 (ekohl)
- Fixes #36645 - Change the default Redis cache DB to 4 #1122 (ekohl)
- allow puppet/redis 9.x #1121 (evgeni)
23.0.0 (2023-05-16)
Breaking changes:
- Sunsetting foreman_column_view because functionality being integrated in Foreman itself #1119 (dgoetz)
- Refs #36345 - Raise minimum Puppet version to 7.0.0 #1118 (ekohl)
- drop memcache plugin support #1114 (evgeni)
- Remove Docker, Spacewalk & DigitalOcean plugins #1097 (ekohl)
Implemented enhancements:
- Mark compatible with puppetlabs/concat 8.x & puppetlabs/apache 10.x & puppetlabs/postgresql 9.x #1117 (ekohl)
- Refs #36319 - Add fog_proxmox plugin support #1115 (maximiliankolb)
- Bump puppetlabs/apache to \< 10.0.0 #1110 (gcoxmoz)
22.2.0 (2023-02-21)
Implemented enhancements:
- Fixes #36037 - Manage Redis service for Redis cache #1109 (ekohl)
- Add basic external auth for API #1108 (ofedoren)
- bump puppet/systemd to \< 5.0.0 #1104 (jhoblitt)
22.1.2 (2023-02-01)
Fixed bugs:
22.1.1 (2023-01-26)
Fixed bugs:
22.1.0 (2022-12-14)
Implemented enhancements:
22.0.0 (2022-11-03)
Breaking changes:
- drop abrt and chef plugins #1094 (evgeni)
- drop support for host_reports, the plugin was dropped #1081 (evgeni)
- Drop /pulp2 and /streamer from no_proxy_uris #1080 (evgeni)
- Fixes #33956 - serve static assets directly via Apache #1078 (evgeni)
Implemented enhancements:
- Refs #35414 - Expect a different message in journal #1096 (ekohl)
- Fixes #35685 - allow setting GssapiLocalName to Off #1093 (evgeni)
- Refs #35675 - Add hammer-cli-foreman-google plugin #1090 (ofedoren)
- Allow sensitive type for plugin configuration #1088 (kobybr)
- Fixes #35524 - Require puppetlabs-apache 8.x #1086 (ekohl)
- Refs #33956 - make it easier to toggle asset proxying #1085 (evgeni)
- Refs #35473 - Configure Apache for API extlogin #1083 (ofedoren)
Fixed bugs:
Merged pull requests:
21.2.0 (2022-09-20)
Implemented enhancements:
- puppetlabs/apt: Allow 9.x #1082 (bastelfreak)
21.1.0 (2022-08-26)
Implemented enhancements:
- Add hammer plugin for ssh #1076 (dgoetz)
- Allow puppetlabs/apache 8.x #1075 (ekohl)
- Fixes #35356 - Don't proxy /server-status #1074 (ekohl)
21.0.0 (2022-08-04)
Breaking changes:
- remove support for Debian 10 buster #1068 (evgeni)
- Stop accepting UNSET as a value and rewrite db.yml to EPP #1066 (ekohl)
- Drop EL7 support #1061 (ehelms)
- Fixes #34977: Drop apipie_dsl:cache generation #1056 (ehelms)
Implemented enhancements:
- Use Integer type for vhost ssl_verify_depth #1071 (wbclark)
- Update to voxpupuli-test 5 #1063 (ekohl)
- Add foreman plugin for netbox #1060 (dgoetz)
- Add foreman plugin for git_templates #1059 (dgoetz)
- Add foreman plugin for vault #1058 (dgoetz)
- Add foreman plugin for scc_manager #1057 (dgoetz)
- Replace template with to_symbolized_yaml function #1017 (ekohl)
- Move static parameters to init.pp #978 (ekohl)
Fixed bugs:
20.2.0 (2022-06-21)
Implemented enhancements:
- add foreman_global_parameter type #1054 (jhoblitt)
- derive base_url from foreman-proxy/settings.yml by default #1053 (jhoblitt)
20.1.0 (2022-05-24)
Implemented enhancements:
- use instance debug instead of Puppet.debug #1052 (jhoblitt)
- Fixes #34943: Allow configuration of additional cockpit origins #1051 (ehelms)
- Fixes #34602 - restart services after plugin installation #1046 (evgeni)
20.0.0 (2022-04-29)
Breaking changes:
Implemented enhancements:
- Add Foreman Google plugin #1040 (stejskalleos)
Fixed bugs:
19.3.0 (2022-04-08)
Implemented enhancements:
- Include apache::mod::env #1038 (wbclark)
- Allow puppetlabs/postgresql 8.x #1031 (ekohl)
- Refs #34505 - Add hammer plugin for foreman_host_reports #1030 (ofedoren)
Fixed bugs:
- metadata.json: Use https URL to git repo #1036 (bastelfreak)
- Use the new GPG key for Debian packages #1034 (ekohl)
19.2.1 (2022-02-21)
Fixed bugs:
19.2.0 (2022-02-04)
Implemented enhancements:
- puppet/extlib: Allow 6.x #1027 (bastelfreak)
- Reflect Foreman 3.2+ support for Debian 11 #1025 (ekohl)
- Explicitly enable the foreman dnf module on Foreman 3.2+ #1023 (evgeni)
- Introduce foreman::settings_fragment #1016 (ekohl)
19.1.1 (2022-01-26)
Fixed bugs:
19.1.0 (2022-01-25)
Implemented enhancements:
- Fixes #34089 - Add trusted proxies setting #1011 (sbernhard)
- puppetlabs/apache: Allow 7.x #1006 (bastelfreak)
- puppetlabs/stdlib: Allow 8.x #1004 (bastelfreak)
- Add basic
foreman_hostgroup
type #1002 (alexjfisher)
Fixed bugs:
- Fixes #34308 - Explicitly notify db:seed from db:migrate #1020 (ekohl)
- foreman::repo: use the package resource 'ensure' parameter to specify the desired ruby stream #1015 (bastelfreak)
- Fixes #34161 - Run apipie:cache:index after db:migrate #1010 (ekohl)
- Fix lack of idempotency in foreman_smartproxy_host provider #1009 (ehelms)
- Fixes #33973 - Restart foreman.service when configuration changes #1008 (wbclark)
Merged pull requests:
19.0.0 (2021-11-09)
Breaking changes:
- Drop server_ssl_certs_dir parameter #1003 (ekohl)
- Add Ubuntu 20.04 support & drop Ubuntu 18.04 #981 (ekohl)
- Fixes #33789 - Mark host where the installer is running as foreman #965 (adamruzicka)
Implemented enhancements:
- Refs #33760 - Add host_reports plugin #1000 (ofedoren)
- Switch to puppet/systemd #997 (jovandeginste)
- Apply version restrictions to all packages #996 (nbarrientos)
Fixed bugs:
- Remove outdated providers docs #999 (alexjfisher)
- Fixes #33511 - configure redis before dynflow workers #995 (evgeni)
Closed issues:
- foreman_config_entry consuming polluted value #989
18.2.0 (2021-08-24)
Implemented enhancements:
- Fixes #33320 - Refer to FQDN instead of "Foreman server" in SmartProx… #988 (wbclark)
- Fixes #33277: Change Puma default workers to 1.5 * CPU, max threads to 5 #986 (ehelms)
Fixed bugs:
18.1.0 (2021-08-04)
Implemented enhancements:
- Add hammer plugin for foreman_puppet #979 (amirfefer)
- Add hammer plugin for foreman_webhooks #977 (ofedoren)
18.0.0 (2021-07-26)
Breaking changes:
- Fixes #33106 - Move user, app_root, rails_env & vhost_prio to globals #975 (ekohl)
- Fixes #33089 - move (hammer_)plugin_prefix to globals #974 (evgeni)
- Drop Puppet 5 support #958 (ehelms)
Implemented enhancements:
- Let Function to_symbolized_yaml handle Datatype Sensitive #972 (cocker-cc)
- Match Foreman user to what packaging creates #971 (ekohl)
- Handle duplicate file declaration for foreman::app_root #969 (chr1s692)
- Fixes #32947 - Use Apache module variables #968 (ekohl)
- Fixes #32352 - use mod_auth_gssapi instead of mod_auth_kerb #967 (evgeni)
- Autorequire provider in smartproxy type #966 (ekohl)
- Use to_symbolized_yaml instead of a template for supervisory #964 (ekohl)
- Use EPP instead of ERB for some templates #962 (cocker-cc)
- Fixes #32827 - Add sendmail config options #961 (ekohl)
- Add ACD plugin #957 (sbernhard)
- Mark compatible with camptocamp/systemd 3.x #956 (ekohl)
- Allow puppet/redis 7.x #955 (ekohl)
- Allow customising ProxyAddHeaders #953 (nbarrientos)
- Support setting the priority of the Yum repositories #950 (nbarrientos)
- Allow Puppet 7 compatible versions of mods #947 (ekohl)
- Allow customising the list of HTTP headers to unset #944 (nbarrientos)
- Customisable Yum repository base URL and GPG key path #943 (nbarrientos)
- Refs #32885: Add puppet user to user_groups only if server or client certificate contains puppet path #938 (ehelms)
- Fixes #29649 - Drop default_server argument in IPA #935 (ekohl)
- Support Puppet 7 #921 (ekohl)
- Configurable: email_reply_address, email_subject_prefix #913 (knorx)
- added foreman_datacenter #868 (Zenya)
Fixed bugs:
- Remove unused suburi template #970 (ekohl)
- Make database.yml and settings.yaml have consistent headers #945 (gcoxmoz)
Closed issues:
- Allow customising ProxyAddHeaders #952
- Allow configuring the priority of the Yum repositories #949
- foreman-report_v2 disappeared from master branch ? #939
17.0.0 (2021-04-26)
Breaking changes:
- Drop Puppetserver integration #933 (ekohl)
- Remove old email.yaml and cronjob cleanups #931 (ekohl)
- Fixes #29780 - Drop Passenger support and target Foreman 2.4+ #928 (ekohl)
- Fixes #31964 - Assign equal weight to sidekiq queues #927 (ekohl)
- Fixes #29817 - Implement a dynflow worker pool #843 (ekohl)
Implemented enhancements:
- Enable Ruby 2.7 module for EL8 on Foreman 2.5+ #937 (ehelms)
- Refs #32276: Add Katello hammer plugin #936 (ehelms)
- Mark compatible with puppetlabs/postgresql 7.x #930 (ekohl)
- use deb gpg key from our server, not the gpg network #924 (evgeni)
- Fixes #32175: Allow toggling task backup when cleaning them up #922 (ehelms)
- Add foreman_webhooks plugin #920 (adamruzicka)
- Add foreman_puppet plugin #917 (ezr-ondrej)
Fixed bugs:
- Fixes #32208 - accept trailing slash in Krb auth url #926 (ezr-ondrej)
16.1.0 (2021-01-28)
Implemented enhancements:
- Fixes #31670 - don't timeout when running db:migrate #915 (evgeni)
- Fixes #30284 - Improve smartproxy registration failure error messages #912 (wbclark)
- Set the reverse proxy host to the name of the service #909 (ehelms)
- Use apache::mod::auth_openidc #906 (ekohl)
- CLI: Allow to configure use_sessions setting #905 (neomilium)
- CLI: make refresh_cache and request_timeout params global #884 (neomilium)
- Fixes #30803: Bind to socket for Puma and Apache #883 (ehelms)
Fixed bugs:
Merged pull requests:
16.0.0 (2020-10-30)
Breaking changes:
- Drop Rackspace compute resource that was dropped in Foreman 2.1 #894 (ehelms)
- fixes #29938 - change default logging layout #847 (domitea)
Implemented enhancements:
- Set compute resource version parameter to advanced #886 (ehelms)
- Fixes #31215 - Generate DSL docs #892 (ofedoren)
Fixed bugs:
- Refs #30535 - Correctly unset remote user groups #896 (tbrisker)
- Drop foreman_compute that was removed in 1.22 #895 (ehelms)
15.1.1 (2020-10-14)
Fixed bugs:
- Fixes #30535 - Set HTTP headers proxy requests #872 (hsahmed)
- Fixes #30789 - Set DB pool size dynamically #882 (ekohl)
15.1.0 (2020-08-07)
Implemented enhancements:
- Fixes #30078 - add parameter to accept a hostgroup config hash #863 (apatelKmd)
- Fixes #29892 - Use server certs for websockets #846 (ekohl)
- Switch to postgresql::postgresql_password #845 (mmoll)
15.0.2 (2020-08-03)
Implemented enhancements:
- Add foreman_statistics plugin #855 (ezr-ondrej)
- add plugin foreman_column_view #601 (dgoetz)
Fixed bugs:
- Fixes #30456 - Fix missing icons on /pub page #867 (adamruzicka)
- fix: indent for rails_cache_store redis type #859 (ministicraft)
15.0.1 (2020-06-15)
Fixed bugs:
15.0.0 (2020-05-15)
Breaking changes:
- Use modern facts #841
- Prefix ipa and sssd facts with foreman_ #839 (ekohl)
- Remove unused parameters from puppetmaster #824 (ekohl)
- Rename inventory_upload to rh_cloud #821 (ShimShtein)
- Refactor repository handling #815 (ekohl)
- Use plugin_prefix to determine plugin packages #809 (ekohl)
- Fixes #29148 - Use Puma instead of Passenger by default #802 (sthirugn)
Implemented enhancements:
- Allow puppet/redis 6.x #840 (ekohl)
- Refs #29601: Drop foreman-release-scl in favor of centos-release-scl-rh #838 (ehelms)
- Switch AIO detection to use aio_agent_version fact #834 (ekohl)
- Add Leapp plugin #833 (stejskalleos)
- Fixes #29212 - support el8 #828 (wbclark)
- Only install foreman-release-scl on CentOS EL 7 #822 (ehelms)
- Allow extlib 5.x #820 (mmoll)
- Refs #29144 - Use systemd socket activation #814 (ekohl)
- Fixes #29255 - Set plugin config file mode to 0640 #807 (ekohl)
- Fixes #28955 - Add puma configuration tuning options #790 (sthirugn)
- Fixes #28436 - Add keycloak support #779 (ekohl)
- Add options for rails_cache_store #762 (dgoetz)
Fixed bugs:
- Ensure Foreman is provisioned before configuring cockpit #835 (ekohl)
- Drop the separate rails repository #826 (ekohl)
- Refs #29148: Do not proxy /pulp2 to Puma #811 (ehelms)
- Correct casing on Stdlib::HTTPUrl #806 (ekohl)
- Fixes #28739: Fix static asset caching when using Puma #788 (ehelms)
Closed issues:
- db_username changes do not work #750
Merged pull requests:
- Make camptocamp/systemd a hard dependency #825 (ekohl)
- Make foreman::config::apache standalone #800 (ekohl)
14.0.0 (2020-02-12)
Breaking changes:
- Drop foreman::config::passenger::fragment #799 (ekohl)
- Ensure plugins are installed before the database #792 (ekohl)
- Drop keepalive parameters #785 (ekohl)
- Drop listen_on_interface #784 (ekohl)
- Drop the selinux parameter #783 (ekohl)
- Drop multiple database support #781 (ekohl)
- Drop Debian 9 and Ubuntu 16.04, add Debian 10 #777 (mmoll)
- Fixes #28067 - dynflow sidekiq services config #761 (ezr-ondrej)
Implemented enhancements:
- Run migrations if there are pending migrations #778 (ehelms)
- Fixes #26739 - Add admin users locale and timezone setting #731 (sbernhard)
Fixed bugs:
13.1.0 (2019-11-25)
Implemented enhancements:
Fixed bugs:
- Fixes #28200 - Change cockpit port from 9999 to 19090 #768 (adamruzicka)
13.0.1 (2019-10-31)
Fixed bugs:
- Fixes #28146 - Drop double leading slash from cockpit url #764 (adamruzicka)
13.0.0 (2019-10-24)
Breaking changes:
- Sunsetting foreman_cockpit because functionality being integrated in remote execution #756 (dgoetz)
- Drop compatibility with Foreman 1.20 and older + puppetrun parameter #745 (ekohl)
- Rewrite to support reverse proxy #677 (ekohl)
Implemented enhancements:
- Fixes #27932 - Add REX Cockpit support #760 (ekohl)
- Drop Puppet \< 3.4 compatibility code #755 (ekohl)
- Add supervisory_authority plugin #754 (laugmanuel)
- Rely on Puppet data types to ensure variables content is valid in apache::fragment #753 (neomilium)
- Add support for foreman_inventory_upload plugin #749 (ShimShtein)
- Implement a foreman::enc function #742 (ekohl)
Fixed bugs:
Merged pull requests:
12.2.0 (2019-06-12)
Implemented enhancements:
Merged pull requests:
- allow newer versions of dependencies #737 (mmoll)
- Allow
puppetlabs/stdlib
6.x #732 (alexjfisher)
12.1.0 (2019-05-21)
Implemented enhancements:
- Add hammer plugin for foreman_kubevirt #733 (shiramax)
- Adding foreman_kubevirt Plugin #730 (masayag)
- allow puppetlabs-apt 7.x and puppetlabs-postgresql 7.x #728 (mmoll)
Fixed bugs:
12.0.0 (2019-04-18)
Breaking changes:
- Drop support for $use_vhost #726 (ekohl)
- Refactor running with a service to Foreman 1.22 #723 (ekohl)
- drop Puppet 4 #719 (mmoll)
Implemented enhancements:
- Add Parameters for jobs_service #725 (cocker-cc)
- Refactor f::config::passenger to f::config::apache #722 (ekohl)
- Add certname to error output in external_node_v2.rb #718 (antaflos)
- Avoid processing fact yaml files with empty 'values' hash #717 (antaflos)
- Expose options to the http and https vhosts #716 (ekohl)
- add cors domains parameter #715 (timogoebel)
11.0.1 (2019-04-02)
Fixed bugs:
- Fixup yaml facts prior to parsing in node.rb #714 (alexjfisher)
Closed issues:
- Locations and Organizations get turned on by default in 11.0.0 and authentication off #711
Merged pull requests:
11.0.0 (2019-01-14)
Breaking changes:
- Remove default repo management #708 (ekohl)
- Fixes #25787 - Make login and taxonomy settings optional #707 (tbrisker)
- Fixes #25170 - Prefix user params with initial_ #701 (chris1984)
Implemented enhancements:
- allow puppetlabs-apache 4.x #709 (mmoll)
- Fixes #23054 - Refactor class inclusion #700 (ekohl)
- Declare Foreman group explicitly #697 (ehelms)
- Allow single node fact upload #692 (ahmet2mir)
- Clean up acceptance tests + make the apt repo parameters #687 (ekohl)
- Add hammer plugin for foreman_ansible #686 (xprazak2)
- Reuse initialize_http in external_node_v2 #683 (ekohl)
- Add Puppet 6 support #678 (ekohl)
- namespace extlib functions #675 (mmoll)
Fixed bugs:
- fix foreman config location for ssl = false and use_vhost = false #705 (Dimonyga)
- Handle websockets_encrypt as a boolean #702 (ekohl)
- Fix wrong variable name in enc function #694 (ahmet2mir)
- Trying to fix rescue syntax in ENC script #685 (qingbo)
10.0.0 (2018-10-18)
Breaking changes:
- Remove remote_file #664 (ekohl)
- Clean up providers #663 (ekohl)
- Refactor Puppet handling #662 (ekohl)
- Set release compatibility to 1.17+ #661 (ekohl)
- Refactor repo handling #660 (ekohl)
- Fixes #24399 - Drop email configuration via files #656 (ekohl)
Implemented enhancements:
- Notify when the ENC cache is used #673 (ekohl)
- allow puppetlabs-stdlib 5.x #667 (mmoll)
- allow puppetlabs-concat 5.x #666 (mmoll)
- allow puppetlabs-apt 6.x #665 (mmoll)
Closed issues:
- Use of HTTP without TLS #655
Merged pull requests:
- Use contain over anchor #676 (ekohl)
- Refactor extras repo handling #672 (ekohl)
- Allow puppet/extlib 3 #671 (alexjfisher)
- Use stricter datatypes #669 (ekohl)
- metadata.json: bump allowed version of puppetlabs-apt to 6.0.0 #657 (mateusz-gozdek-sociomantic)
9.2.0 (2018-07-11)
Implemented enhancements:
- Adding rescue plugin #648 (cocker-cc)
- Adding wreckingball Plugin #647 (cocker-cc)
- Adding dlm plugin #646 (cocker-cc)
- Adding spacewalk plugin #645 (cocker-cc)
- Add support for foreman_virt_who_configure #642 (ekohl)
Fixed bugs:
Merged pull requests:
9.1.0 (2018-05-29)
Implemented enhancements:
- Ensure foreman-telemetry is installed if needed #638 (ekohl)
- Fixes #23101 - add telemetry options #637 (ares)
- Add classes for hammer cli commands #636 (ekohl)
- Refs #22559 - Add parameters for structured logging #631 (ekohl)
- permit puppetlabs-apache 3.x #628 (mmoll)
Fixed bugs:
- Refs #15963 - Correct documentation typos #641 (itsbill)
- Handle releases/ properly for yum plugins repo #634 (ekohl)
Closed issues:
- This puppet module breaks foreman installation #640
Merged pull requests:
- Add a basic acceptance test #635 (ekohl)
- Run acceptance tests on Debian 9 instead of Debian 8 #632 (ekohl)
- Reduce PARALLEL_TEST_PROCESSORS to 8 #630 (ekohl)
- Add remote_file acceptance test #627 (sean797)
- Use selboolean for httpd_dbus_sssd #622 (ekohl)
9.0.1 (2018-02-28)
Fixed bugs:
9.0.0 (2018-01-29)
Breaking changes:
- Convert ipa and sssd facts to structured facts #618 (ekohl)
- Fixes #18757 - Handle dynflow service in foreman core #602 (ekohl)
- Remove discovery image downloading #583 (ekohl)
Implemented enhancements:
- Use puppet4 functions-api #623 (juliantodt)
- Refs #22165 - Add installer support for disabling hsts #614 (tbrisker)
- remove EOL OSes, add new ones #607 (mmoll)
- Add unattended_url parameter #606 (matonb)
- Manage puppetdb_api_version config entry #604 (treydock)
- Fixes #21023 - Update start-timeout to 90 #603 (chris1984)
- Fixes #20819 - Allow turning task cleanup cron on and off #582 (adamruzicka)
- Add ability to set SSLProtocol for Apache vhost #600 (ehelms)
Fixed bugs:
- fixes #22196 - use ssl chain for hammer if available #615 (stbenjam)
- Change to safe working directory in external_node_v2.rb #612 (antaflos)
- Fixes #21072 - build apipie cache after plugins #592 (mbacovsky)
8.1.1
- New classes to install Foreman plugins:
- Add foreman::plugin::foreman_userdata
- Add foreman::plugin::foreman_snapshot_management
- Other changes and fixes:
- Add retry to foreman reporting script
- Add the ability to get data by using the proxy SSL authentication configuration
- Allow configuring Dynflow pool size
- Bump allowed version of puppet-extlib to 2.0.0
8.1.0
- Other changes and fixes:
- update node.rb for Puppet5 env fact
- use apache module classes for mod_{authnz_pam,intercept_form_submit,lookup_identity}
8.0.0
- Drop Puppet 3 support
- New or changed parameters:
- Add
$db_root_cert
to set the root SSL certificate used to verify SSL connections to PostgreSQL - Add
features
property toforeman_smartproxy
provider to check enabled features
- Add
- Other changes and fixes:
- Support login via smart card certificates
7.2.0
- New or changed parameters:
- Add
$ssl_ca_file
to foreman::cli to specify the path to the SSL CA file for hammer_cli - Add
$access_log_format
to foreman::config:passenger. This is passed to apache::vhost to allow overriding the apache log format.
- Add
- Other changes and fixes:
- Extend gzip file serving to /public/webpack
- Restrict gzip asset serving to known extensions
- Remove a possibly undefined requirement in foreman::plugin::discovery
- Add open_timeout to the report and external node script
- Add param for timeout to foreman() parser function
- Allow including foreman::repo standalone
7.1.0
- New or changed parameters:
- Add SSL certificate/key parameters to foreman::plugin::puppetdb
- Other changes and fixes:
- Disable docroot management in apache::vhost, remove workaround
- Remove default values from parameter documentation
- Extended tests for plugin classes
7.0.0
- New classes to install Foreman plugins:
- foreman::plugin::monitoring to install monitoring plugin
- foreman::plugin::omaha to install Omaha plugin
- foreman::cli::openscap to install Hammer CLI OpenSCAP plugin
- New or changed parameters:
- Add db_managed_rake parameter to allow db_manage to be false while still managing DB migration/setup by default
- Add email_config_method parameter to support database configuration of email settings with Foreman 1.14+
- Add version parameter to foreman::cli class to enable updates
- Other changes and fixes:
- Add environment from agent node YAML to ENC fact upload
- Use ENC node cache when fact upload fails (GH-492)
- Configure foreman-tasks plugin from Azure plugin class (GH-480)
- Fix ordering of Apache service to happen inside foreman::service
- Fix ordering of Puppet CA generation to Foreman startup (#17133)
- Fix restarting service on config changes with db_manage disabled (GH-502)
- Fix incorrect FreeIPA enrollment error on enrolled host
- Permit extlib 1.x, tftp 2.x
- Move advanced parameters into new documentation section (#16250)
- Change parameter documentation to use Puppet 4 style typing
- Add default parameters for Arch Linux, for ENC support
- Compatibility warnings:
- Drop support for Ruby 1.8.7
- If using
db_manage => false
, also setdb_managed_rake
to false if managing DB migrations/seed externally
6.0.0
- New classes to install Foreman plugins:
- foreman::plugin::azure to install Azure compute resource plugin
- foreman::plugin::expire_hosts to install expire hosts plugin
- foreman::plugin::host_extra_validator to install hostname validator plugin
- New or changed parameters:
- Add server_port, server_ssl_port parameters to change Apache vhost ports
- Rename environment parameter to rails_env to fix compatibility with data bindings
- Other changes and fixes:
- node.rb: skip facts upload when facts file is missing, retrieves ENC output anyway
- node.rb: improve logging for empty facts and failed fact uploads
- Change reports upload to use new config_reports API
- Change Yum GPG key URLs to HTTPS
- Fix missing default parameters for strict variables compatibility, requiring Puppet 3.7.5 or higher
- Add SVG images to automatic gzip serving list
- Move keepalive settings from a template to apache::vhost parameters
- List Fedora 24 compatibility
- Compatibility warnings:
- Requires Puppet 3.6 or higher to use the module
- environment parameter renamed to rails_env
- Remove Debian 7 (Wheezy) and Ubuntu 12.04 (Precise) support
- Remove configure_openscap_repo parameter from
foreman::plugin::openscap
- Remove rest (v1) smart proxy provider and foreman_api installation
- Remove
foreman::install::repos
define, useforeman::repos
- Remove
apipie_task
parameter
5.2.2
- Fix interpolation of IPA variables in Apache configs (#15642)
- Fix inotify detection of new facts in node.rb watch facts
5.2.1
- Fix Apache config includes when VirtualHost priority is changed
5.2.0
- New or changed parameters:
- Add clientssl* parameters to control SSL cert used by Foreman to communicate with its smart proxies (GH-441)
- Add puppet_ssldir parameter, supporting new AIO paths and setting the
puppetssldir
value in settings.yaml - Add keepalive, max_keepalive_requests and keepalive_timeout parameters, defaulting to enabled for performance (#8489)
- Add vhost_priority parameter to control Apache vhost priority (GH-418)
- Add plugin_version parameter to change ensure property of plugin packages
- Other features:
- Search for ENC/report configuration in Puppet AIO paths (GH-413)
- Support report_timeout configuration in report processor
- Add 'puppetmaster_fqdn' value to ENC facts upload
- Add foreman::providers class to install type/provider dependencies
- Document types/providers available in this module
- Add rest_v3 provider for foreman_smartproxy with minimal dependencies, also supplied for AIO (#14455)
- Other changes and fixes:
- Change apt repository configuration to use puppetlabs-apt 2.x (GH-428)
- Change configure_scl_repo to true on RHEL for 1.12 compatibility
- Manage ENC YAML directories, modes and ownership (GH-242)
- Fix inconsistencies in Yum repos versus foreman-release (GH-388)
- Fix nil provider error in foreman_config_entry prefetching (GH-420)
- Fix foreman_smartproxy idempotency for proxy names with spaces (GH-421)
- Fix foreman_smartproxy to only refresh when currently registered (GH-431)
- Fix timeout usage warning in ENC under Ruby 2.3 (GH-438)
- Fix ordering of Puppet server installation before Foreman user (#14942)
- Fix ordering of foreman::cli after repo setup
- Change Red Hat name in parameter docs (#14197)
- Note requirement for en_US.utf8 locale (GH-417)
- Compatibility warnings:
foreman::install::repos
has been moved toforeman::repos
. The old define has been deprecated and will issue a warning.foreman::compute::openstack
andforeman::compute::rackspace
default to Foreman 1.12 package names, passpackage => 'foreman-compute'
for pre-1.12 compatibility.rest
provider for foreman_smartproxy is deprecated, use rest_v3 or v2foreman::plugin::openscap
has configure_openscap_repo disabled by default, OS repos should now supply dependencies (#14520)
5.1.0
- New classes to install Foreman plugins:
- foreman::plugin::ansible to install Ansible support
- foreman::plugin::cockpit to install Cockpit support
- foreman::plugin::memcache to install memcache support
- New or changed parameters:
- Add puppetrun parameter, allowing you to enable the "Run puppet" button (and functionality) on individual host pages
- Add address and dashboard_address parameters to foreman::plugin::puppetdb
- Add ssl_certs_dir parameter to control SSLCACertificatePath, disabled by default
- Add serveraliases parameter to manage virtual host aliases
- Other features:
- Support and test with Puppet 4
- Add hostgroup provider and type
- Add filter_result parameter to foreman() search function, to filter out a single or set of fields from the results
- Load OAuth keys in providers from /etc/foreman/settings.yaml if possible
- Other changes and fixes:
- Support Puppet 3.0 minimum
- Support Fedora 21, add Ubuntu 16.04
- Use lower case FQDN to access Foreman smart proxy registration (#8389)
- Configure PassengerRuby to use foreman-ruby symlink on Debian/Ubuntu
- Fix key/value splitting in foreman_config_entry resource
- Fix qualified call to postgresql defined type (GH-386)
- Fix installation of the JSON package to use ensure_packages
- Fix installation of remote execution plugin to restart foreman-tasks
- Compatibility warnings:
- The puppetrun setting is now managed, ensure the parameter is set to true if you have already set it to true in the UI. The default value in the params class is "false", and it will override your manual setting in the database.
- Users of the puppetdb class may need to set address/dashboard_address parameters, which are now managed and default to "localhost".
5.0.2
- Install tasks plugin with remote_execution, chef and salt
5.0.1
- Remove fail() from plugin params classes when running on FreeBSD
- Test speed improvements
5.0.0
- New or changed parameters:
- Add package parameter to foreman::plugin::ovirt_provision, puppetdb and tasks classes
- Add plugin_prefix parameter to main class to override package prefixes
- Removed the configure_ipa_repo parameter
- Other features:
- Support Puppet master (ENC etc.) setup on FreeBSD
- Add foreman::plugin::remote_execution class for remote execution plugin
- Add foreman::plugin::dhcp_browser class for DHCP browser plugin
- Other changes and fixes:
- Explicitly set permissions on yaml directory
- Use absolute variables throughout manifests
- Do not install Passenger packages when passenger parameter is false
- Change case statement for service management to an if statement
- Change EL RPM package prefix to 'tfm' for Foreman 1.10
- Allow newer puppetlabs/apt 2.x module
- Set PostgreSQL database encoding to UTF-8 (#11681)
- Move Discovery plugin paramater validation into conditional
- Set HTTP timeout in ENC script according to timeout setting
- Prefer Puppet agent SSL CRL for Apache virtualhost configuration
- Remove cache_data/random_password in favor of puppet/extlib module
- Add ExportCertData option to Apache SSL virtualhost
- Fix README typos
- Compatibility warnings:
- Foreman 1.9 or older users on EL must set additional parameters to change package prefixes, see the README.md for details
- The configure_ipa_repo parameter was removed
- The cache_data/random_password parser functions were removed
4.0.1
- Fix missing brightbox/passenger-legacy PPA on Ubuntu 12.04 (#11069)
4.0.0
- New or changed parameters:
- Add logging_level and loggers parameters to control log config on Foreman 1.9+ (#5838)
- Add email_* parameters to set up email.yml configuration
- Other features:
- Replace theforeman/concat_native with puppetlabs/concat
- Add version parameter to foreman::compute::* classes
- Support foreman::plugin::tasks on Debian
- Improve smart proxy registration error message (#10466)
- Other changes and fixes:
- Replace virtual resources in foreman::compute with classes
- Use foreman-rake console instead of foreman-config, requires 1.7+
- Fix support for puppetlabs/mysql 3.0
- Fix websockets_encrypt entry in config file as on/off
- Remove obsolete entries from settings.yaml
- Test under future parser
3.0.2
- Fix default foreman::plugin::openscap parameter values
- foreman_config_entry: ensure HOME is set on all Puppet versions
- foreman_config_entry: change foreman-config to foreman-rake
- spec fixes for concat_native changes
3.0.1
- Fix support for mysql by removing inclusion of mysql class which was removed by puppetlabs/mysql in version 3.0.0
- Fix foreman_config_entry checking of dry parameter
3.0.0
- New classes to install Foreman plugins:
- foreman::plugin::abrt to install ABRT support
- foreman::plugin::digitalocean for DigitalOcean compute resources
- foreman::plugin::docker for Docker container management
- foreman::plugin::openscap to install OpenSCAP support
- foreman::plugin::salt for Salt management support
- New or changed parameters:
- Add db_pool parameter to control database connection pool size
- Add manage_user parameter to disable 'foreman' user resource
- Add server_ssl_crl parameter to change SSL CRL used
- Add apipie_task parameter for Foreman 1.7 compatibility
- Add puppet_user/group parameters to foreman::puppetmaster
- Add timeout parameter to foreman::puppetmaster, increase timeout from 10 to 60 seconds
- Add config/config_file parameters to foreman::plugin
- Add package parameter to foreman::compute::ec2 for Foreman 1.7 compatibility
- Rename facts parameter to receive_facts, due to trusted variables conflict, an incompatible change (#8944)
- Changes to foreman::plugin::discovery parameters
- Remove deprecated passenger_scl parameter, use passenger_ruby and passenger_ruby_package instead
- Other features:
- Add support for Discovery Image 2.0 deployment
- Add support to deploy Foreman on sub-URI with Passenger by changing the foreman_url parameter
- Configure foreman-plugins repo, remove unused 'rc' repo support (#8880)
- Enable SSL CRL checking to Foreman virtual host
- Add additional resource types to foreman() search function (#9155)
- Other changes and fixes:
- Use pending DB migration/seed flags in Foreman to re-run DB tasks when they fail on subsequent runs, requiring Foreman 1.7+ (#4611, #7353)
- Use puppetlabs/apache 1.2.0 features
- Improve ENC encoding handling to fix facts uploads from Windows
- Improve tests with rspec-puppet-facts
- Improvements for Puppet 4 and future parser support
- Refreshed README
- Fix apt-key installation from refreshonly to unless clause
- Fix dependency on LSB facts (#9449)
- Fix custom facts error when trying to load ruby-augeas
- Fix class parameters documentation display in foreman-installer (#6904)
- Fix mod_lookup_identity concatentation of multiple email addresses
- Fix hard references to theforeman/puppet in foreman::puppetmaster
- Fix foreman.yaml path in report processor comment
- Fix minimum adrien/alternatives version to released 0.3.0
- Fix spelling error in configure_scl_repo description
- Fix metadata.json quality issues, pinning dependencies
2.3.2
- Refresh db:migrate if DB class changes (#9101)
2.3.1
- Ensure Foreman DB settings are initialised before Apache starts to prevent race condition (#4611, #7353)
- Remove timeout on apipie:cache rake task (#8381)
- Fix puppetdb_foreman Debian package name
2.3.0
- Add foreman_config_entry resource type and provider
- Configure Brightbox Ruby NG PPA on Ubuntu 12.04 (#7227)
- Set PassengerRuby to ruby1.9.1 and install appropriate Passenger package
- Keep Ruby alternative on 1.8 via alternatives module dependency (#7970)
- Add foreman::plugin::ovirt_provision class for ovirt_provision_plugin
- Install foreman-release-scl on EL clones (#7234)
- Refacter SSSD facts for faster runs
- Add docs to all classes/defines
- Remove expensive directory recursion on $vardir/yaml
- Deprecated: passenger_scl parameter has been replaced by passenger_ruby and passenger_ruby_package
2.2.4
- Set GPG keys for each Foreman repo
- Enable EPEL7 GPG checking (#6015)
- Wrap API parameters for new apipie-bindings
- Fix errors with strict variables
- Fix failed status calculation when log processor enabled
2.2.3
- Fix apipie-bindings cache path to prevent installer/master conflict
- Sync module configs
2.2.2
- Expose Apache vhost ServerName via servername parameter
- Fix dependency on TFTP directory in discovery image download
- Fix apipie-bindings cache directory when HOME is unset in daemon (#7063)
- Unit test and lint fixes
2.2.1
- Move ENC and report processor configuration to /etc/puppet/foreman.yaml
2.2.0
- Add ipa_authentication parameter to configure Foreman authentication against IPA using Kerberos etc (#6445)
- Add foreman::cli class to install and configure Hammer CLI
- Add admin_* parameters for initial admin username and password (Foreman 1.6)
- Add initial_* parameters to create an initial organization or location (#6802)
- Add foreman::plugin::tasks class to install foreman_tasks plugin
- install_images parameter added to foreman::plugin::discovery to download discovery images to TFTP root
- Change ENC and report processor configuration to /etc/foreman/puppet.yaml instead of embedded and templated settings
- Add foreman_smartproxy provider that uses apipie-bindings, adds a timeout parameter
- Configure websockets_ssl* in Foreman settings (#3601)
- Purge configuration files under Foreman httpd directories
- Extend startup timeout for Passenger, add parameters to control
- Refresh proxy features when foreman_smartproxy is notified (#3185)
- Fix future parser compatibility in random_password() and manifests
- Add Windows and SUSE to params class
- Remove v1 node and report processors
- Remove workaround for passenger.conf being replaced by pl-apache
- Refactor foreman::config::enc into foreman::puppetmaster
2.1.4
- Report processor: increment error counter for non-resource Puppet errors (#3851)
2.1.3
- Fix ordering of Apache and foreman_smartproxy resources
- Workaround Travis CI/REE issue
2.1.2
- Fix user shell path so it's valid on Debian (#5390)
- Remove obsolete test conditional for Facter 2 compat
2.1.1
- Fix SSL configuration with upper case hostnames (#4679)
2.1.0
- Add compute resource and new plugin classes (#3308)
- Add support for parallel fact pushes in node.rb
- Add event driven fact pushing (--watch-facts) in node.rb
- Add server_ssl_chain parameter to set SSLCertificateChainFile
- Add support for plugins to add virtual host entries
- Use alphanumeric ordering for vhosts (#4225)
- Use the production CentOS SCL repo, use centos-release-SCL
- Add Debian plugins repo
- Update to puppetlabs-apache 1.0
- Trigger db:seed too when DB changes
- Run foreman-rake apipie:cache after installation
- Ensure plugins are installed after core
- Improve node.rb response when server-side error occurs
- Remove template source from header for Puppet 3.5 compatibility
- Add basic Archlinux support for agent classes
- Fix Modulefile specification for Forge compatibility
- Cleanup of foreman::config
2.0.1
- Bump stdlib dependency to fix Forge upload error
2.0.0
- Add Foreman 1.4 support (default)
- Switch to puppetlabs-apache from theforeman-apache
- Switch to puppetlabs-postgresql version 3+
- Add foreman::plugin define and classes
- Set far-future expires headers for web UI assets
- Add db:seed support after db:migrate
- Add EPEL and SCL yum repository configuration
- Add $serverssl* parameters to configure vhost SSL certs
- Set PostgreSQL DB owner to foreman for db:drop support
- Create cache file properly to prevent re-sending of fact files (node.rb)
- Add support for running node.rb as a different user
- Skip empty host fact files (node.rb)
- Fix running DB migrations for SQLite
- Fix JSON package name on Debian 6 (Squeeze)
- Fix proxy registration under foreman_api 0.1.18+
- Only chown files in cache_data if puppet user exists
- Quote database passwords in database.yml
- Updated foreman() parser function instructions
- Move passenger restart to foreman::service class
- Drop Puppet 3.0 and 3.1 tests
- Update tests for rspec-puppet 1.0.0
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppet/systemd (>= 3.1.0 < 8.0.0)
- puppetlabs/apache (>= 8.0.0 < 13.0.0)
- puppetlabs/apt (>= 2.0.0 < 10.0.0)
- puppetlabs/concat (>= 1.0.0 < 10.0.0)
- puppetlabs/postgresql (>= 6.5.0 < 11.0.0)
- puppetlabs/stdlib (>= 9.0.0 < 10.0.0)
- puppet/extlib (>= 3.0.0 < 8.0.0)
- puppet/redis (>= 5.0.0 < 12.0.0)
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS