foreman

A puppet module to install and configure Foreman.

Project URL RSS Feed Report issues

Module Stats

6,741 downloads

6,560 latest version

4.6 quality score

Version information

released Oct 10th 2016

This version is compatible with:

This module has been deprecated by its author since Jan 18th 2019.

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'simp-foreman', '0.2.2'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add simp-foreman

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install simp-foreman --version 0.2.2

Tags: foreman, enc, simp

Documentation

simp/foreman — version 0.2.2 Oct 10th 2016

foreman

Overview
Module Description - What the SIMP Foreman module provides
Setup - The basics of getting started with Foreman
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

Overview

A SIMP specific implementation of the Foreman. Designed to be able to incorporate the Foreman into a previously existing and configured puppet master.

Module Description

The SIMP Foreman module allows for a functioning Foreman web UI, capable of handling smart-proxies, LDAP authentication, and user management. Puppet reports are sent to the foreman reporting tool where they are displayed in the default dashboard. For this release, only the monitoring based services are being supported.

This module is limited to the above functionality. Currently, support for the Foreman provisioning software has not been incorporated. In future releases this can be expected. Initially, however, this module was designed to provide a graphical tool to monitor Puppet, and specifically SIMP, systems.

NOTE: All aspects of this module are known to work with SELinux in enforcing mode.

Setup

What Foreman affects

Services Affected:

postgresql
foreman
foreman-proxy
httpd

WARNINGS:

This installation of SIMP Foreman is tied heavily to the ruby-193 Software Collection
All changes made to the Foreman via the Puppet module will take precedence over any manual changes made in the web UI. All manual changes will be overridden on the ensuing Puppet run if there is a conflict.

Setup Requirements

Minimum Requirements:

2 CPUs
2GB RAM

Repositories:

Some repositories and software collections must be imported to use the Foreman module. They are as follows.

Foreman - http://yum.theforeman.org/releases/
Foreman-plugins - http://yum.theforeman.org/plugins/
V3814 - https://www.softwarecollections.org/en/scls/rhscl/v8314/
Httpd24 - https://www.softwarecollections.org/en/scls/rhscl/httpd24/
Ruby 193 - https://www.softwarecollections.org/en/scls/rhscl/ruby193/

Beginning with Foreman

For basic information on the Foreman, see http://theforeman.org/

In order to setup the Foreman web UI, you'll want to set the following in Hiera:

# By default, the admin user password will be autogenerated and nonsensical looking.
# Set that here if you wish to have control over it.
foreman::admin_password : 'No one will ever hack this!'

# These are the hosts that will connect to your Foreman proxy. You'll want to make sure
# all hosts who are reporting to Foreman appear here.
foreman::proxy::trusted_hosts :
  - your.first.host
  - your.second.host
  - your.nth.host

# Make sure reporting is turned on in Puppet!
pupmod::report : true

# Obviously include all other necessary classes for this host. This is only to show
# some sample site data you may wish to have. If the default configuration works for you,
# then this won't be needed.
classes:
  - foreman
  - site::foreman

If you wish to be able to add users to connect via an LDAP server, add the following code to something like site::foreman.pp

# This class assumes foreman has already been included somewhere. Add 'include foreman'
# as the first line inside of the class if that is not true.
class site::foreman {

  # Adds an LDAP authentication source to Foreman. This assumes this authentication source
  # is LDAP and already exists.
  foreman::auth_source { 'my_awesome_ldap_server':
    ldap_server => $::fqdn,
    onthefly_register => true
  }

  # If onthefly_register is not true then you will need to
  # add uses like this.   If they are in the LDAP server
  # the password from the LDAP Server will over write the
  # one entered here but it fails if you do not give a
  # password parameter.
  foreman::user { 'amazing.user':
    auth_source => 'my_awesome_ldap_server',
    web_admin   => true,
    firstname   => 'Amazing',
    lastname    => 'User',
    password    => 'Mypassword'
  }

  foreman::user { 'untrustworth.user':
    auth_source => 'my_awesome_ldap_server',
    web_admin   => false, # This is the default, but want to show the difference from above.
    firstname   => 'Untrustworthy',
    lastname    => 'User',
    password    => 'Mypassword'
  }
}

Use onthefly_register if you want foreman to automatically create accounts when users log in using an LDAP account. To give LDAP users a default role, add groups to foreman and link them to LDAP groups and foreman roles and put LDAP users in the LDAP group. See http://theforeman.org/manuals/1.10/index.html#4.1.1LDAPAuthentication, the "Linking user groups to LDAP" section for more info.

And voila! Here is your working Foreman instance complete with LDAP authentication and users to login.

Usage

Foreman classes:

foreman
foreman::params
foreman::passenger
foreman::proxy
foreman::proxy::facts
foreman::proxy::puppet
foreman::proxy::puppetca
foreman::ssl

Foreman defines:

foreman::auth_source
foreman::smart_proxy
foreman::user

Custom Types:

foreman_auth_source
foreman_user
foreman_smart_proxy

Facts Used:

domain
fqdn
hostname

Reference

Limitations

Supported Operating Systems:

RHEL 6.6/7.0
CentOS 6.6/7.0

Supported Puppet Versions:

Puppet 3.7
Puppet 4.0

Supported Configuration Data Tools

Hiera

Development

If you would like to contribute to the SIMP Foreman module, please contact the SIMP team with patches, ideas, and suggestions.

Release Notes/Contributors/Etc

Release Notes:

For all SIMP foreman release notes, please see the RPM changelog.

Initial Contributors:

Kendall Moore kmoore@keywcorp.com
Trevor Vaughan tvaughan@onyxpoint.com
Chris Tessmer ctessmer@onyxpoint.com
Jacob Gingrich jgingrich@onyxpoint.com
Nick Markowski nmarkowski@keywcorp.com
Michael Riddle mriddle@onyxpoint.com

Types in this module release

foreman_smart_proxy

Adds a smart proxy to the Foreman database.

Parameters
admin_password	The password the for the admin user that connects to Foreman's REST API.
admin_user	The admin user that connects to Foreman's REST API.
ensure
host	The host that the Foreman service is running on.
name	The name of the auth source to add.
provider
ssl_ca_file	The CA file by which the the :host should be validated
ssl_client_cert	The client PKI certificate that will be recognized by the :host
ssl_client_key	The client PKI private key that will be recognized by the :host
ssl_version	The SSL version that should be negotiated with the remote host `You can get a list of valid versions by running the following on the client system: ruby -ropenssl -e 'puts OpenSSL::SSL::SSLContext::METHODS'`

Properties
url	The URL of the smart proxy, optionally with port.

Providers
smart_proxy	Provider for adding a smart proxy source to the Foreman web console.

foreman_user

Adds a new (local) user to authenticate with the Foreman web UI.

Parameters
admin_password	The password for the Foreman admin user.
admin_user	The admin user for the Foreman REST API.
api_admin	Whether or not to make the user an interal API admin.
ensure
host	The host that the foreman server is running on.
name	The name of the user to be added.
provider
ssl_ca_file	The CA file by which the the :host should be validated
ssl_client_cert	The client PKI certificate that will be recognized by the :host
ssl_client_key	The client PKI private key that will be recognized by the :host
ssl_version	The SSL version that should be negotiated with the remote host `You can get a list of valid versions by running the following on the client system: ruby -ropenssl -e 'puts OpenSSL::SSL::SSLContext::METHODS'`

Properties
auth_source	The name of the authentication source. Either 'Internal' or the name of the LDAP server that has already been defined in Foreman.
email	The optional email address of the user.
firstname	The first name of the user.
lastname	The first name of the user.
password	The password to authenticate the user with.
web_admin	Whether or not to make the user an admin in the web UI.

Providers
user	Provider for adding a user who can login to the Foreman web console.

foreman_location

Adds a location to the Foreman database.

Parameters
admin_password	The password the for the admin user that connects to Foreman's REST API.
admin_user	The admin user that connects to Foreman's REST API.
ensure
host	The host that the Foreman service is running on.
name	The name of the location to add.
provider
ssl_ca_file	The CA file by which the the :host should be validated
ssl_client_cert	The client PKI certificate that will be recognized by the :host
ssl_client_key	The client PKI private key that will be recognized by the :host
ssl_version	The SSL version that should be negotiated with the remote host `You can get a list of valid versions by running the following on the client system: ruby -ropenssl -e 'puts OpenSSL::SSL::SSLContext::METHODS'`

Providers
location	Provider for adding a location to the Foreman web console.

foreman_add_auth_source

Adds an auth source to the foreman database for user authentication.

Parameters
ensure
name	The name of the auth source to add.

Properties
account	The account used to authenticate.
account_password	The password associated with the authenticating user.
admin_password	The password the for the admin user that connects to Foreman's REST API.
admin_user	The admin user that connects to Foreman's REST API.
attr_firstname	The first name attribute of a user logging in.
attr_lastname	The last name attribute of a user logging in.
attr_login	The login attribute of the user logging in, usually the user ID.
attr_mail	The email address of the user logging in.
attr_photo	The photo to assocaite with a given user.
base_dn	The type of auth source to use.
host	The host the auth source will connect to.
ldap_filter	The (optional) LDAP filter to use when connecting.
onthefly_register	Whether or not to register users on the fly.
port	The port used to establish the connection.
tls	Whether or not to use TLS to connect to the auth source.

foreman_auth_source

Adds an auth source to the Foreman database for user authentication.

Parameters
admin_password	The password the for the admin user that connects to Foreman's REST API.
admin_user	The admin user that connects to Foreman's REST API.
ensure
host	The host the auth source will connect to.
name	The name of the auth source to add.
provider
ssl_ca_file	The CA file by which the the :host should be validated
ssl_client_cert	The client PKI certificate that will be recognized by the :host
ssl_client_key	The client PKI private key that will be recognized by the :host
ssl_version	The SSL version that should be negotiated with the remote host `You can get a list of valid versions by running the following on the client system: ruby -ropenssl -e 'puts OpenSSL::SSL::SSLContext::METHODS'`

Properties
account	The account used to authenticate.
account_password	The password associated with the authenticating user.
attr_firstname	The first name attribute of a user logging in.
attr_lastname	The last name attribute of a user logging in.
attr_login	The login attribute of the user logging in, usually the user ID.
attr_mail	The email address of the user logging in.
attr_photo	The photo to assocaite with a given user.
base_dn	The base dn for the auth source.
groups_base	The group base dn for the auth source.
ldap_filter	The (optional) LDAP filter to use when connecting.
ldap_server	The LDAP server to connect to.
onthefly_register	Whether or not to register users on the fly.
port	The port used to establish the connection.
tls	Whether or not to use TLS to connect to the auth source.

Providers
auth_source	Provider for adding an auth source to the Foreman web console.

Fri Sep 28 2016 Chris Tessmer chris.tessmer@onyxpoint.com - 0.2.1-0

Update project origin to github.com/simp

Fri Jul 29 2016 Trevor Vaughan tvaughan@onyxpoint.com - 0.2.0-0

Update to the new naming scheme

Wed Nov 04 2015 Chris Tessmer chris.tessmer@onyxpoint.com - 0.1.0-1

Initial package, minor bug fixes and structural updates in preparation for inclusion in next SIMP release.

Thu Sep 10 2015 kendall-moore kendall8688@gmail.com - 0.1.0-0

Initial module (on behalf of Kendall Moore, original author).

pupmod-simp-foreman - A Puppet Module for managing the Foreman

--

Per Section 105 of the Copyright Act of 1976, these works are not entitled to
domestic copyright protection under US Federal law.

The US Government retains the right to pursue copyright protections outside of
the United States.

The United States Government has unlimited rights in this software and all
derivatives thereof, pursuant to the contracts under which it was developed and
the License under which it falls.

---

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

foreman

Deprecated

Version information

This version is compatible with:

This module has been deprecated by its author since Jan 18th 2019.

Start using this module

Documentation

foreman

Table of Contents

Overview

Module Description

Setup

What Foreman affects

Setup Requirements

Beginning with Foreman

Usage

Reference

Limitations

Development

Release Notes/Contributors/Etc

Types in this module release

foreman_smart_proxy

foreman_user

foreman_location

foreman_add_auth_source

foreman_auth_source

Dependencies