zram

• zram
  • Overview
  • Module Description
  • Setup
    • What zram affects
    • Setup Requirements
    • Beginning with zram
  • Usage
  • Reference
  • Limitations
  • Development

Overview

This module configures zram swap using udev rules (no init scripts or systemd units needed).

Module Description

Want to know more about zram? Read the Linux kernel documentation.

Setup

What zram affects

Creates the following files:

• /lib/udev/zram
• /etc/udev/rules.d/01-zram.rules
• /etc/modprobe.d/zram.conf

Finally, it loads the zram module.

Setup Requirements

This module requires puppetlabs-stdlib and puppet-kmod.

Beginning with zram

Make sure you are using a kernel that includes the zram module.

Usage

class { 'zram': }

Reference

The zram class accepts the following parameters:

• numdevices Number of zram devices. Defaults to the number of processors ($facts['processorcount']).

• disksize Size of zram devices. Defaults to half of memory divided by numdevices.

See REFERENCE.md for more details.

Limitations

This module has been tested on a number of systems. (See metadata.json for a full list.) It should work on any Linux distribution that includes the zram kernel module.

Development

Send me a pull request on GitHub.

Reference

Table of Contents

Classes

• zram: Configures and loads zram kernel module
• zram::config: Configuration for the zram module
• zram::install: Add or remove packages to enable zram management
• zram::load: Loads the zram kernel module

Tasks

• reload: Reloads the zram kernel module

Classes

zram

zram

This module configures zram using udev rules (no init scripts or systemd units needed).

Examples

include zram

Parameters

The following parameters are available in the zram class:

• numdevices
• disksize
• ensure
• swapoff
• swapoff_timeout

numdevices

Data type: Integer

Number of zram devices. Defaults to the number of processors ($facts['processorcount']).

Default value: $facts['processors']['count']

disksize

Data type: Integer

Size of zram devices. Defaults to half of memory divided by numdevices.

Default value: (($facts['memory']['system']['total_bytes'] / 2) / $numdevices

ensure

Data type:

Enum[
    'present',
    'absent'
  ]

Set to absent to remove zram.

Default value: 'present'

swapoff

Data type: Boolean

When ensure is absent, attempt to disable zram swap before unloading the kernel module. Without this set, you will need to proactively run swapoff on each /dev/zram* device or reboot following a failed unload attempt.

Default value: false

swapoff_timeout

Data type: Optional[Integer[0]]

Timeout for the swapoff command. (See the exec timeout attribute documentation for details.)

Default value: undef

zram::config

Configuration for the zram module

Parameters

The following parameters are available in the zram::config class:

• ensure
• file_ensure

ensure

Data type:

Enum[
    'present',
    'absent'
  ]

Set to absent to remove the configuration

Default value: $zram::ensure

file_ensure

Data type:

Enum[
    'file',
    'absent'
  ]

Set to absent to remove the configuration files

Default value:

$ensure ? {
    'absent' => 'absent',
    default  => 'file'

zram::install

Add or remove packages to enable zram management

Parameters

The following parameters are available in the zram::install class:

• required
• conflicts
• required_ensure
• conflicts_ensure
• ensure

required

Data type:

Variant[
    Undef,
    String[1],
    Array[String[1]]
  ]

Packages required for zram to function

Default value: undef

conflicts

Data type:

Variant[
    Undef,
    String[1],
    Array[String[1]]
  ]

Packages that conflict with zram

Default value: undef

required_ensure

Data type: String[1]

ensure attribute of required packages

Default value: 'installed'

conflicts_ensure

Data type: String[1]

ensure attribute of conflicts packages

Default value: 'absent'

ensure

Data type:

Enum[
    'present',
    'absent'
  ]

Set to absent to skip package operations

Default value: $zram::ensure

zram::load

Loads the zram kernel module

Parameters

The following parameters are available in the zram::load class:

• ensure
• swapoff
• swapoff_timeout

ensure

Data type:

Enum[
    'present',
    'absent'
  ]

Set to absent to unload the kernel module

Default value: $zram::ensure

swapoff

Data type: Boolean

When ensure is absent, attempt to disable zram swap before unloading the kernel module

Default value: $zram::swapoff

swapoff_timeout

Data type: Optional[Integer[0]]

Timeout for the swapoff command

Default value: $zram::swapoff_timeout

Tasks

reload

Reloads the zram kernel module

Supports noop? true

Parameters

verbose

Data type: Optional[Boolean]

Enable verbose output