Forge Home

f_upgrade

Unattended FreeBSD operating system updates

137 downloads

137 latest version

3.1 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

  • 1.0.0 (latest)
released Nov 30th 2023
This version is compatible with:
  • Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
  • Puppet >= 7.24 < 9.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'fraenki-f_upgrade', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add fraenki-f_upgrade
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install fraenki-f_upgrade --version 1.0.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

fraenki/f_upgrade — version 1.0.0 Nov 30th 2023

puppet-f_upgrade

Puppet Forge Puppet Forge

Table of Contents

  1. Overview
  2. Requirements
  3. Usage
  4. Reference
  5. Development

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.

Limitations

Upgrades of ActiveMQ Artemis are supported to a certain degree, provided that the new version is compatible with this module. Please note that in-place upgrades are performed and the official upgrade script is not used. This may have unwanted side-effect. Overall this upgrade procedure should be pretty safe for multi-instance primary/backup setups.

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.