Puppet module for managing Foreman
Many Foreman plugins can be installed by adding additional
classes, extra compute resource support via
foreman::compute::* classes and
the Hammer CLI can be installed by adding
By default, it configures Foreman to run under Apache and Passenger plus
with a PostgreSQL database. A standalone service can be configured instead by
passenger to false, though this isn't recommended in production.
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
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.
This module supports configuration of either SQLite, PostgreSQL or MySQL as the
database for Foreman. The database type can be changed using the
parameter, or management disabled with
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. If using MySQL, the puppetlabs-mysql module must be added to
the modulepath, otherwise it's not required.
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
For Foreman 1.16 or older, please set the
dynflow_in_core parameter to false.
For Foreman 1.11 or older, please use the 5.x release series of this module.
Types and providers
foreman_config_entry can be used to manage settings in Foreman's database, as
seen in Administer > Settings. Provides:
foreman-raketo change settings (default)
foreman_hostgroup can create and manage host group in Foreman's database.
rest_v2provider uses API v2 with apipie-bindings and OAuth (default)
foreman_smartproxy can create and manage registered smart proxies in
Foreman's database. Providers:
rest_v3provider uses API v2 with Ruby HTTP library, OAuth and JSON (default)
rest_v2provider uses API v2 with apipie-bindings and OAuth
- 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.
foreman::plugin::* classes is a very useful place to start
contributing to this module.
See http://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 http://www.gnu.org/licenses/.