• Stars
    star
    148
  • Rank 249,983 (Top 5 %)
  • Language
    Python
  • License
    GNU General Publi...
  • Created over 7 years ago
  • Updated 7 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Ansible modules for interacting with the Foreman API and various plugin APIs such as Katello

Foreman Ansible Modules Build Status

Ansible modules for interacting with the Foreman API and various plugin APIs such as Katello.

Documentation

A list of all modules and their documentation can be found at theforeman.org/plugins/foreman-ansible-modules.

Support

Supported Foreman and plugins versions

Modules should support any currently stable Foreman release and the matching set of plugins. Some modules have additional features/arguments that are only applied when the corresponding plugin is installed.

We actively test the modules against the latest stable Foreman release and the matching set of plugins.

Supported Ansible Versions

The supported Ansible versions are aligned with currently maintained Ansible versions that support Collections (2.9+). You can find the list of maintained Ansible versions here.

Supported Python Versions

Ansible only supports Python 2.7 and 3.5 (and higher). These are also the only Python versions we develop and test the modules against.

Known issues

  • Some modules, e.g. repository_sync and content_view_version, trigger long running tasks on the server side. It might be beneficial to your playbook to wait for their completion in an asynchronous manner. As Ansible has facilities to do so, the modules will wait unconditionally. See the Ansible documentation for putting tasks in the background. Please make sure to set a high enough async value, as otherwise Ansible might abort the execution of the module while there is still a task running on the server, making status reporting fail.

  • According to Ansible documentation, using loop over Ansible resources can leak sensitive data. This applies to all modules, but especially those which require more secrets than the API credentials (auth_source_ldap, compute_resource, host, hostgroup, http_proxy, image, repository, scc_account, user). You can prevent this by using no_log: true on the task.

    eg:

    - name: Create compute resources
      theforeman.foreman.compute_resource:
        server_url: https://foreman.example.com
        username: admin
        password: changeme
        validate_certs: true
        name: "{{ item.name }}"
        organizations: "{{ item.organizations | default(omit) }}"
        locations: "{{ item.locations | default(omit) }}"
        description: "{{ item.description | default(omit) }}"
        provider: "{{ item.provider }}"
        provider_params: "{{ item.provider_params | default(omit) }}"
        state: "{{ item.state | default('present') }}"
      loop: "{{ compute_resources }}"
      no_log: true
  • Modules require write access to ~/.cache (or wherever $XDG_CACHE_HOME points at). Otherwise the API documentation cannot be downloaded and you get errors like [Errno 13] Permission denied: '/home/runner/.cache/apypie. If on your system ~/.cache is not writeable, please set the $XDG_CACHE_HOME environment variable to a directory Ansible can write to.

Installation

There are currently two ways to use the modules in your setup: install directly from Ansible Galaxy or via packages.

Installation from Ansible Galaxy

You can install the collection from Ansible Galaxy by running ansible-galaxy collection install theforeman.foreman.

After the installation, the modules are available as theforeman.foreman.<module_name>. Please see the Using Ansible collections documentation for further details.

Installation via packages

The collection is also available as ansible-collection-theforeman-foreman from the plugins repository on yum.theforeman.org for Enterprise Linux systems and from the plugins repository on deb.theforeman.org for Debian and Ubuntu systems.

After installing the package, you can use the modules in the same way as when they are installed directly from Ansible Galaxy.

Installation From Source

For development or testing purposes, you can install the collection from source git repository. For production usage, see the instructions above on installing the latest stable release.

Installation from Github Repository

With Ansible >= 2.10, you can install from a Github repository (such as this one or your fork):

$ ansible-galaxy collection install git+https://github.com/theforeman/foreman-ansible-modules.git

If you have configured GitHub to use SSH instead of HTTPS, you can do:

$ ansible-galaxy collection install [email protected]/theforeman/foreman-ansible-modules.git

You can also specify a branch to use such as devel (below) or a feature branch that you are working with:

$ ansible-galaxy collection install git+https://github.com/theforeman/foreman-ansible-modules.git,devel

To install from a requirements.yml file (useful when installing multiple collections) add a snippet to your requirements.yml like

---
collections:
  - name: https://github.com/theforeman/foreman-ansible-modules.git
    type: git
    version: devel

And install all specified requirements with ansible-galaxy install -r requirements.yml

Building and Installing the Collection Locally

For all currently supported versions of Ansible (i.e. Ansible >= 2.9, and particularly Ansible < 2.10 where the above approach is not yet supported), you can build the collection locally:

$ make dist

And install it with:

$ ansible-galaxy collection install ./theforeman-foreman-*.tar.gz

Dependencies

These dependencies are required for the Ansible controller, not the Foreman server.

  • PyYAML
  • requests
  • ipaddress for the subnet module on Python 2.7
  • rpm for the RPM support in the content_upload module
  • debian for the DEB support in the content_upload module

Foreman Ansible Roles

Roles using the Foreman Ansible Modules to configure Foreman and its plugins.

Documentation

For individual role documentation, check the README defined at roles/rolename/README.md.

Common Role Variables

  • foreman_server_url: URL of the Foreman server. If the variable is not specified, the value of environment variable FOREMAN_SERVER_URL will be used instead.
  • foreman_username: Username accessing the Foreman server. If the variable is not specified, the value of environment variable FOREMAN_USERNAME will be used instead.
  • foreman_password: Password of the user accessing the Foreman server. If the variable is not specified, the value of environment variable FOREMAN_PASSWORD will be used instead.
  • foreman_validate_certs: Whether or not to verify the TLS certificates of the Foreman server. If the variable is not specified, the value of environment variable FOREMAN_VALIDATE_CERTS will be used instead.
  • foreman_organization: Organization where configuration will be applied.

More Repositories

1

foreman

an application that automates the lifecycle of servers
Ruby
2,398
star
2

foreman_ansible

▶️ Ansible integration in Foreman
JavaScript
211
star
3

smart-proxy

RESTful proxies for DNS, DHCP, TFTP, BMC and Puppet
Ruby
210
star
4

forklift

Helpful deployment scripts for Foreman and Katello
Shell
169
star
5

theforeman.org

The new and improved Foreman website.
HTML
144
star
6

community-templates

A place to share templates for various OSes for Foreman's provisioning
HTML
144
star
7

foreman_docker

This plugin enables management of Docker containers and images in Foreman
Ruby
117
star
8

foreman-installer

Automated Foreman installation and configuration
Ruby
116
star
9

foreman_fog_proxmox

Foreman plugin to add Proxmox compute resource based on fog-proxmox gem
Ruby
106
star
10

puppet-foreman

Puppet module for Foreman
Ruby
101
star
11

hammer-cli

Next-gen CLI tool for foreman
Ruby
94
star
12

puppet-puppet

Puppet module for Puppet client and server
Puppet
88
star
13

foreman_bootdisk

ISO and USB boot disk support for Foreman
JavaScript
76
star
14

foreman_ansible_inventory

Foreman dynamic inventory script for ansible - Now merged into Ansible itself
Python
70
star
15

safemode

A library for safe evaluation of Ruby code based on ParseTree/RubyParser and Ruby2Ruby. Provides Rails ActionView template handlers for ERB and Haml.
Ruby
68
star
16

foreman_salt

Foreman plug-in for Salt
Ruby
67
star
17

kafo

A gem for making installations based on puppet user friendly
Ruby
57
star
18

foreman_discovery

A plugin to enable Metal-as-a-Service discovery functionality in foreman
JavaScript
56
star
19

foreman_maintain

The Foreman/Satellite maintenance tool
Ruby
55
star
20

foreman_hooks

Run custom hook scripts on Foreman events
Ruby
53
star
21

puppet-foreman_proxy

Puppet module for Foreman Smart Proxy
Ruby
42
star
22

foreman-discovery-image

Foreman discovery image live distro
Ruby
39
star
23

foreman_openscap

Foreman plug-in for displaying OpenSCAP audit reports
JavaScript
39
star
24

foreman-packaging

Packaging files (RPMs, debs) for Foreman and its dependencies
39
star
25

foreman_templates

A plugin for Foreman to sync provisioning templates from an external source
JavaScript
39
star
26

hammer-cli-foreman

Next-gen CLI tool for foreman (Foreman-specific commands)
Ruby
37
star
27

staypuft

Openstack Foreman Installer
Ruby
34
star
28

puppetdb_foreman

PuppetDB proxy in Foreman
Ruby
32
star
29

foreman-tasks

Tasks management engine and plugin for Foreman
Ruby
31
star
30

foreman-digitalocean

Plugin to enable management of DigitalOcean droplets in Foreman
Ruby
29
star
31

foreman_remote_execution

A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality
JavaScript
29
star
32

foreman-xen

Provision and manage Xen Server in Foreman
Ruby
25
star
33

foreman_dhcp_browser

Web UI browser and editor for DHCP leases
Ruby
24
star
34

foreman-infra

Puppet modules and scripts to manage Foreman project infrastructure
Puppet
23
star
35

foreman_column_view

A simple Foreman plugin showcasing Deface for altering the Hosts view
Ruby
23
star
36

foreman_chef

Foreman extensions that are required for better Chef integration.
JavaScript
22
star
37

foreman_datacenter

This plugin lets you document your physical servers across multiple datacenters
Ruby
21
star
38

chef-handler-foreman

This handler allow Chef to send reports to Foreman
Ruby
20
star
39

foreman-documentation

Documentation for the Foreman Project and its ecosystem
SCSS
19
star
40

ldap_fluff

An LDAP gem for querying LDAP in various styles: Active Directory, FreeIPA & POSIX
Ruby
19
star
41

foreman_monitoring

Foreman plugin for monitoring system integration
Ruby
18
star
42

puppet-dhcp

ISC DHCP server module for Puppet
Ruby
18
star
43

puppet-dns

Installs and manages an ISC BIND DNS server with zones
Ruby
18
star
44

foreman_cockpit

🚀 Display console and journal of Cockpit-enabled hosts in Foreman - now replaced by Remote Execution's cockpit integration
Ruby
18
star
45

puppet-pulp

Puppet module for setting up Pulp 2 as part of Katello installation
Ruby
16
star
46

foreman_setup

Plugin for Foreman that helps set up provisioning
Ruby
15
star
47

journald-logger

RubyGem: Logger for systemd-journal
Ruby
15
star
48

smart_proxy_vault

Hashicorp Vault plugin for Smart Proxy
Ruby
14
star
49

foreman_api

[Deprecated][Archived] Ruby bindings for Forman's rest API
Ruby
14
star
50

puppet-foreman_scap_client

Puppet module for OpenSCAP
Ruby
13
star
51

foreman-installer-staypuft

Foreman installer plugin that helps with staypuft Foreman plugin installation
Ruby
13
star
52

puppet-tftp

Puppet module for managing tftp
Ruby
13
star
53

foreman-bats

BATS installation and cli end-to-end testing scripts
Shell
13
star
54

puppet-katello

Puppet module for setting Katello specific configuration. Also includes provider for manipulating with Katello resources.
Ruby
13
star
55

npm2rpm

🎁 Convert npm packages to RPM packages
JavaScript
12
star
56

smart_proxy_dns_infoblox

Ruby
12
star
57

puppet-git

Puppet module for git
Ruby
12
star
58

foreman_host_rundeck

API for Rundeck to pull host data from Foreman
Ruby
12
star
59

foreman_graphite

Send performance metrics to Graphite
Ruby
11
star
60

foreman-selinux

SELinux policy for Foreman
Shell
11
star
61

foreman_default_hostgroup

A plugin to set the default hostgroup when hosts are created.
Ruby
11
star
62

foreman-js

Foreman js tools
JavaScript
10
star
63

foreman-operations-collection

Ansible collection for management of Foreman servers
Makefile
10
star
64

obal

packaging wrapper using ansible
Python
9
star
65

smart_proxy_dns_route53

Route 53 DNS provider plugin for Foreman's smart proxy
Ruby
9
star
66

rfcs

RFCs for TheForeman
9
star
67

foreman_azure_rm

Adds Azure Resource Manager as a compute resource for The Foreman
JavaScript
9
star
68

foreman_memcache

Adds memcache integeration to foreman
Ruby
9
star
69

foreman_kubevirt

Kubevirt as compute resource for Foreman
JavaScript
9
star
70

foreman_pipeline

This project makes Foreman and Jenkins play together nicely. Jenkins can deploy stuff onto newly provisioned hosts by Foreman.
Ruby
9
star
71

smart_proxy_realm_ad_plugin

foreman-proxy realm plugin for Active Directory
Ruby
9
star
72

puppet-passenger

Deprecated puppet module for passenger, use puppetlabs-apache
Ruby
9
star
73

foreman_abrt

Foreman plugin for displaying reports from Automatic Bug Reporting Tool
Ruby
9
star
74

smart_proxy_dhcp_infoblox

foreman smart proxy for dhcp w/ infoblox
Ruby
9
star
75

smart_proxy_remote_execution_ssh

SSH remote execution provider for Foreman smart proxy
Ruby
8
star
76

foreman_omaha

Foreman Plugin to allow CoreOS Updates via Omaha Protocol.
Ruby
8
star
77

foreman_deployments

Plugin to support multi-host deployments
Ruby
8
star
78

smart_proxy_salt

Smart Proxy plug-in for Salt
Ruby
8
star
79

hammer-cli-foreman-ssh

Adds Remote SSH support for Hammer Foreman CLI
Ruby
7
star
80

puppet-apache

Deprecated puppet module for Apache webserver, use the puppetlabs one
Puppet
7
star
81

smart_proxy_dhcp_dnsmasq

dnsmasq DHCP plugin for Foreman smart-proxy
Ruby
7
star
82

foreman_puppet

JavaScript
7
star
83

smart_proxy_monitoring

Smart proxy plugin for monitoring system integration
Ruby
7
star
84

hammer-cli-foreman-admin

Plugin for Hammer CLI for administrative tasks on the Foreman and Smart Proxy servers.
Ruby
6
star
85

foreman-live

kickstart files to build a livecd with foreman pre-installed and configured on boot.
Shell
6
star
86

foreman_rh_cloud

a plugin to Foreman that generates and uploads reports to the Red Hat cloud
Ruby
6
star
87

smart_proxy_ansible

Ansible plugin for smart proxy, with Ansible remote execution provider
Ruby
6
star
88

smart_proxy_dhcp_bluecat

foreman smart proxy plugin for bluecat dhcp
Ruby
6
star
89

puppet-xinetd

Deprecated puppet module for xinetd, use the puppetlabs one
Puppet
6
star
90

smart_proxy_dns_powerdns

Foreman SmartProxy PowerDNS plugin
Ruby
6
star
91

foreman-bootloaders

Binary builds of PXE bootloaders from various Linux distributions
Shell
6
star
92

journald-native

systemd-journal logging interface wrapper for ruby
C
6
star
93

foreman_snapshot

Plugin to handle taking a snapshot of a host group and pushing it back to a Compute Resource as a new image
Ruby
5
star
94

foreman_virt_who_configure

JavaScript
5
star
95

foreman_azure

Old Plugin to have Azure as a Compute Resource in Foreman
Ruby
5
star
96

foreman_expire_hosts

Foreman plugin for limiting host lifetime
Ruby
5
star
97

puppet-certs

Puppet module for dealing with SSL certs across other modules used in Katello
Ruby
5
star
98

hammer_cli_foreman_remote_execution

CLI plugin for Remote Execution
Ruby
5
star
99

foreman_content

A content (Packages and Configuration) management plugin for Foreman
Ruby
5
star
100

smart_proxy_dhcp_remote_isc

Smart Proxy dhcp provider for NFS-accessible ISC dhcpd servers.
Ruby
5
star