puppet-f_upgrade

Table of Contents

1. Overview
2. Requirements
3. Usage
   • Basic usage
   • Custom configuration
   • Using hooks
4. Reference
5. Development
   • Contributing

Overview

A Puppet module to install and configure the f-upgrade service. It automates the process of installing FreeBSD operating system updates.

Usage

Basic usage

Assuming that the system is currently running FreeBSD 13.2 and should be upgraded to FreeBSD 14.0, the following configuration should be used:

class { 'f_upgrade':
  upgrade => '14.0',
}

NOTE: Please read the f-upgrade documentation carefully before attempting an operating system upgrade.

Custom configuration

In order to change the f-upgrade configuration file, options may be added to the $config parameter:

class { 'f_upgrade':
  config  => {
    free_diskspace => 2048,
    log_debug      => 2,
    task_timeout   => 28800,
  },
  upgrade => '14.0',
}

Using hooks

Hooks make it possible to customize the upgrade process. They need to have valid POSIX shell syntax. Hooks may either be specified directly using the content parameter or by specifying an alternative download source using the source parameter:

class { 'f_upgrade':
  hooks => {
    '1000.pre' => {
      content => "echo hello world\n exit 0",
    },
    '1000.post.14' => {
      content => "echo task 1000 completed\n exit 0",
    },
    '5000.post.14.0' => {
      source => 'puppet:///modules/example/hook_5000.sh',
    },
    '8000.post.12.2' => {
      ensure => absent,
    },
  },
  upgrade => '14.0',
}

Note that hooks can be removed by adding ensure => absent.

Reference

Classes and parameters are documented in REFERENCE.md.

Development

Contributing

Please use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.

Reference

Table of Contents

Classes

Public Classes

• f_upgrade: Install and configure f-upgrade

Private Classes

• f_upgrade::config: Manage the f-upgrade configuration file
• f_upgrade::hooks: Manage hook files for f-upgrade
• f_upgrade::install: Install f-upgrade
• f_upgrade::service: Enable and start the f-upgrade upgrade process

Classes

f_upgrade

Install and configure f-upgrade

Parameters

The following parameters are available in the f_upgrade class.

config

Data type: Hash

A list of options and values that should be added to the f-upgrade configuration file. Note that the "upgrade" option should not be listed here, the parameter $upgrade should be used instead. If an option is set to an empty string, it will be removed from the file.

config_file

Data type: Stdlib::Absolutepath

The path to the f-upgrade configuration file.

cronjob_options

Data type: Hash

Options for the f-upgrade cron job.

hook_dir

Data type: Stdlib::Absolutepath

The target directory for hook files.

hooks

Data type: Hash

A list of hooks. The content may be specified either directly using the "content" parameter or by specifying the "source" parameter – as supported by the file resource.

manage_cronjob

Data type: Boolean

Enables the f-upgrade cron job. By default it runs hourly to start or resume the upgrade process.

package_ensure

Data type: Enum['absent', 'installed', 'latest']

The desired state for the f-upgrade package.

package_name

Data type: String

The name of the f-upgrade package.

upgrade

Data type: Optional[String]

The target FreeBSD version for the upgrade. When this parameter is specified, the module immediately starts the f-upgrade service and the upgrade process should begin only a few seconds later.

Default value: undef

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v1.1.0 - 2025-01-10

Changed

• Enable quiet mode in cron job
• Update PDK to 3.4.0

v1.0.0 - 2023-12-01

Initial release