Forge Home

foreman_proxy

Foreman Smart Proxy configuration

384,766 downloads

405 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 25.3.0 (latest)
  • 25.2.0
  • 25.1.0
  • 25.0.0
  • 24.2.0
  • 24.1.0
  • 24.0.1
  • 24.0.0
  • 23.0.1
  • 23.0.0
  • 22.1.3
  • 22.1.2
  • 22.1.1
  • 22.1.0
  • 22.0.0
  • 21.0.0
  • 20.1.0
  • 20.0.0
  • 19.0.1
  • 19.0.0
  • 18.2.0
  • 18.1.0
  • 18.0.0
  • 17.1.1
  • 17.1.0
  • 17.0.0
  • 16.1.0
  • 16.0.2
  • 16.0.1
  • 16.0.0
  • 15.3.1
  • 15.3.0
  • 15.2.0
  • 15.1.0
  • 15.0.0
  • 14.1.2
  • 14.1.1
  • 14.1.0
  • 14.0.2
  • 14.0.1
  • 14.0.0
  • 13.0.0
  • 12.1.0
  • 12.0.1
  • 12.0.0
  • 11.1.1
  • 11.1.0
  • 11.0.0
  • 10.1.0
  • 10.0.0
  • 9.1.0
  • 9.0.0
  • 8.0.2
  • 8.0.1
  • 8.0.0
  • 7.2.3
  • 7.2.2
  • 7.2.1
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 6.0.3
  • 6.0.2
  • 6.0.1
  • 6.0.0
  • 5.1.4
  • 5.1.3
  • 5.1.2
  • 5.1.1
  • 5.1.0
  • 5.0.0
  • 4.0.3
  • 4.0.2
  • 4.0.1
  • 4.0.0
  • 3.0.1
  • 3.0.0
  • 2.5.0
  • 2.4.2
  • 2.4.1
  • 2.4.0
  • 2.3.1 (deleted)
  • 2.3.0
  • 2.2.3
  • 2.2.2
  • 2.2.1
  • 2.2.0
  • 2.1.0
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.6.1
  • 1.6.0
  • 1.5.0
  • 1.4.0
  • 1.3.0
  • 1.2.0
  • 1.2.0-rc3 (pre-release)
  • 1.2.0-rc2 (pre-release)
  • 1.2.0-rc1 (pre-release)
released Jun 13th 2019
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
  • , , , , , , Archlinux,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'theforeman-foreman_proxy', '11.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add theforeman-foreman_proxy
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install theforeman-foreman_proxy --version 11.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

theforeman/foreman_proxy — version 11.1.0 Jun 13th 2019

Puppet Forge Build Status

Puppet module for managing the Foreman Smart Proxy

Installs and configures the Foreman Smart Proxy and services that it can interact with, e.g. DNS, DHCP and Puppet and TFTP.

Part of the Foreman installer: https://github.com/theforeman/foreman-installer

Compatibility

Module version Proxy versions Notes
11.x 1.19 and newer See compatibility notes in its README for 1.19-1.21
10.x 1.19 - 1.21
5.x - 9.x 1.16 - 1.20 See compatibility notes in its README for 1.16-1.18
4.x 1.12 - 1.17 See compatibility notes in its README for 1.15+
3.x 1.11
2.x 1.5 - 1.10
1.x 1.4 and older

Starting version 1.22 the Puppet CA configuration is split depending on the provider. When using the module with 1.19 - 1.21, set puppetca_split_configs to false.

Examples

Minimal setup for Puppet/PuppetCA Smart Proxy

class{'::foreman_proxy':
  puppet   => true,
  puppetca => true,
  tftp     => false,
  dhcp     => false,
  dns      => false,
  bmc      => false,
  realm    => false,
}

PowerDNS support

To use the PowerDNS plugin, the following variables need to be set on the main foreman_proxy class.

class{'::foreman_proxy':
  dns          => true,
  dns_managed  => false,
  dns_provider => 'powerdns',
}

Then you also need to include foreman_proxy::plugin::dns::powerdns.

The powerdns plugin can optionally manage the database. If that's used, then the puppetlabs-mysql module must be added to the modulepath, otherwise it's not required.

Remote Execution User Management

This module can also be used to manage the ssh user on Foreman Remote Execution clients.

include foreman_proxy::plugin::remote_execution::ssh_user

The class will make use of the remote_execution_* host parameters available in the ENC data provided by Foreman.

It will manage the user, (by default foreman_ssh), install/update the ssh keys and manage the sudo rules (using saz/sudo if available in your environment).

Contributing

  • Fork the project
  • Commit and push until you are happy with your contribution
  • Send a pull request with a description of your changes

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/.