foreman (16) Versions 1.0.0 Follow2

Provides custom resources for installing and configuring Foreman and Foreman Smart Proxy

Policyfile

Berkshelf

Knife

cookbook 'foreman', '~> 1.0.0', :supermarket

cookbook 'foreman', '~> 1.0.0'

knife supermarket install foreman

knife supermarket download foreman

README

Dependencies

Changelog

Quality 50%

Foreman cookbook

This cookbook now exposes custom resources for installing and configuring Foreman and Foreman Smart Proxy. The legacy recipes/ and attributes/ APIs were removed as part of the migration.

Migration notes: [migration.md](migration.md)
Platform and package constraints: [LIMITATIONS.md](LIMITATIONS.md)

Resources

foreman_app Installs Foreman, renders application configuration, optionally prepares the database, and manages the foreman service.
foreman_proxy Installs Smart Proxy, renders settings.yml and module fragments, optionally configures DNS/DHCP/TFTP helpers, and manages the foreman-proxy service.
foreman_repo Configures the official Foreman APT repositories.
foreman_plugins Installs Foreman or Smart Proxy plugin packages.
foreman_rake Runs foreman-rake tasks.
foreman_smartproxy Registers or removes a Smart Proxy through the Foreman API.
foreman_proxy_settings_file Renders a module file under /etc/foreman-proxy/settings.d/.

Supported platforms

Debian 12
Ubuntu 22.04

These limits are based on the current upstream package documentation summarized in [LIMITATIONS.md](LIMITATIONS.md).

Usage

Foreman server

foreman_app 'default' do
  server_name 'foreman.example'
  database(
    adapter: 'postgresql',
    host: '127.0.0.1',
    username: 'foreman',
    password: 'super-secret'
  )
end

foreman_plugins 'server-plugins' do
  packages %w[foreman-libvirt ruby-foreman-chef]
end

Foreman Smart Proxy

foreman_proxy 'default' do
  server_name 'foreman.example'
  register false
  dns(
    enabled: true,
    managed: true,
    interface: 'eth0'
  )
  dhcp(
    enabled: true,
    managed: true,
    interface: 'eth0',
    range: '10.0.0.10 10.0.0.20'
  )
  tftp(
    enabled: true
  )
end

Testing

cookstyle
chef exec rspec --format documentation
yamllint .
markdownlint-cli2 "**/*.md"
KITCHEN_LOCAL_YAML=kitchen.dokken.yml chef exec kitchen test default-ubuntu-2204 --destroy=always
KITCHEN_LOCAL_YAML=kitchen.dokken.yml chef exec kitchen test proxy-debian-12 --destroy=always

Dependent cookbooks

mysql2_chef_gem >= 0.0.0

postgresql >= 0.0.0

tftp >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Changelog

1.0.0 (2026-05-06)

⚠ BREAKING CHANGES

migrate Foreman cookbook to custom resources (#61)

Features

migrate Foreman cookbook to custom resources (#61) (0c32019)

Bug Fixes

ci: Update workflows to use release pipeline (#55) (beef973)

0.1.12 (2025-10-15)

Bug Fixes

ci: Update workflows to use release pipeline (#55) (beef973)

0.1.2 - 2023-03-02

Standardise files with files in sous-chefs/repo-management

0.1.1 - 2023-02-14

Remove delivery folder

0.1.0 - 2022-01-18

resolved cookstyle error: providers/smartproxy.rb:52:3 convention: Style/RedundantCondition

0.0.3 - 2021-08-31

Standardise files with files in sous-chefs/repo-management

0.0.2 - 2021-06-01

Adopted by Sous-Chefs

Collaborator Number Metric

1.0.0 passed this metric

Contributing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Cookstyle Metric

1.0.0 passed this metric

No Binaries Metric

1.0.0 passed this metric

Testing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Chef Supermarket

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

foreman (16) Versions 1.0.0 Follow2

Foreman cookbook

Resources

Supported platforms

Usage

Foreman server

Foreman Smart Proxy

Testing

Dependent cookbooks

Contingent cookbooks

Changelog

1.0.0 (2026-05-06)

⚠ BREAKING CHANGES

Features

Bug Fixes

0.1.12 (2025-10-15)

Bug Fixes

0.1.2 - 2023-03-02

0.1.1 - 2023-02-14

0.1.0 - 2022-01-18

0.0.3 - 2021-08-31

0.0.2 - 2021-06-01

Collaborator Number Metric

1.0.0 passed this metric

Contributing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Cookstyle Metric

1.0.0 passed this metric

No Binaries Metric

1.0.0 passed this metric

Testing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Details

Updated May 6, 2026 Created on November 8, 2013

Supported Platforms

License

Required Chef Infra Client

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

foreman (16) Versions 1.0.0 1.0.0 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0 0.0.3 0.0.2 0.0.1 Follow2

Foreman cookbook

Resources

Supported platforms

Usage

Foreman server

Foreman Smart Proxy

Testing

Dependent cookbooks

Contingent cookbooks

Changelog

1.0.0 (2026-05-06)

⚠ BREAKING CHANGES

Features

Bug Fixes

0.1.12 (2025-10-15)

Bug Fixes

0.1.2 - 2023-03-02

0.1.1 - 2023-02-14

0.1.0 - 2022-01-18

0.0.3 - 2021-08-31

0.0.2 - 2021-06-01

Collaborator Number Metric 1.0.0 passed this metric

Contributing File Metric 1.0.0 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Cookstyle Metric 1.0.0 passed this metric

No Binaries Metric 1.0.0 passed this metric

Testing File Metric 1.0.0 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric 1.0.0 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Details

Updated May 6, 2026 Created on November 8, 2013

Supported Platforms

License

Required Chef Infra Client

foreman (16) Versions 1.0.0 Follow2

Collaborator Number Metric

1.0.0 passed this metric

Contributing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Cookstyle Metric

1.0.0 passed this metric

No Binaries Metric

1.0.0 passed this metric

Testing File Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number