Foreman server configuration

The Foreman



729 latest version

5.0 quality score

Version information

  • 16.1.0 (latest)
  • 16.0.0
  • 15.1.2
  • 15.1.1
  • 15.1.0
  • 15.0.3
  • 15.0.2
  • 15.0.1
  • 15.0.0
  • 14.0.2
  • 14.0.1
  • 14.0.0
  • 13.1.0
  • 13.0.1
  • 13.0.0
  • 12.2.0
  • 12.1.0
  • 12.0.0
  • 11.0.3
  • 11.0.2
  • 11.0.1
  • 11.0.0
  • 10.0.0
  • 9.2.0
  • 9.1.0
  • 9.0.1
  • 9.0.0
  • 8.1.1
  • 8.1.0
  • 8.0.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 6.0.0
  • 5.2.2
  • 5.2.1
  • 5.2.0
  • 5.1.0
  • 5.0.2
  • 5.0.1
  • 5.0.0
  • 4.0.1
  • 4.0.0
  • 3.0.3
  • 3.0.2
  • 3.0.1
  • 3.0.0
  • 2.3.2
  • 2.3.1
  • 2.3.0
  • 2.2.4
  • 2.2.3
  • 2.2.2
  • 2.2.1
  • 2.2.0
  • 2.1.4
  • 2.1.3
  • 2.1.2
  • 2.1.1
  • 2.1.0
  • 2.0.1
  • 1.3.0
  • 1.2.0-rc3
  • 1.2.0-rc2
  • 1.2.0-rc1
  • 1.2.0
released Jan 28th 2021
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >= 5.5.8 < 7.0.0
  • RedHat

Start using this module

Tags: foreman


theforeman/foreman — version 16.1.0 Jan 28th 2021

Puppet Forge Build Status

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/0'], '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/0'],
    '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 2.0+.

If you're running Foreman instance older than Foreman 2.2 you need to change logging layout parameter from multiline_request_pattern to multiline_pattern due to compatibility.

Types and providers

foreman_config_entry can be used to manage settings in Foreman's database, as seen in Administer > Settings. Provides:

  • cli provider uses foreman-rake to change settings (default)

foreman_hostgroup can create and manage host group in Foreman's database. Providers:

  • rest_v2 provider uses API v2 with apipie-bindings and OAuth (default)

foreman_smartproxy can create and manage registered smart proxies in Foreman's database. Providers:

  • rest_v3 provider uses API v2 with Ruby HTTP library, OAuth and JSON (default)
  • rest_v2 provider uses API v2 with apipie-bindings and OAuth

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
  - name: "Foreman ENC"
    data_hash: foreman::enc

It is also possible to use HTTP basic auth by adding a username/password to the URL in the form of

Then within your manifests you can use lookup. For example, in manifests/site.pp:

node default {
  lookup('classes', {merge => unique}).include


  • 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 file for much more information.

Adding new foreman::plugin::* classes is a very useful place to start contributing to this module.

More info

See 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