Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update readme to voxpupuli #13

Merged
merged 4 commits into from
Sep 20, 2024
Merged

fix: update readme to voxpupuli #13

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a9a4dd
fix: update readme to voxpupuli
rwaffen Sep 20, 2024
1113473
fix: typo
rwaffen Sep 20, 2024
5635b65
Update README.md
rwaffen Sep 20, 2024
d5dcf2e
Update README.md
rwaffen Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 27 additions & 14 deletions README.markdown → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# swap_file

[![Puppet
Forge](http://img.shields.io/puppetforge/v/petems/swap_file.svg)](https://forge.puppetlabs.com/petems/swap_file) [![Build Status](https://travis-ci.org/petems/petems-swap_file.svg?branch=master)](https://travis-ci.org/petems/petems-swap_file) [![Puppet Forge
Downloads](http://img.shields.io/puppetforge/dt/petems/swap_file.svg)](https://forge.puppetlabs.com/petems/swap_file) [![Puppet Forge
Endorsement](https://img.shields.io/puppetforge/e/petems/swap_file.svg)](https://forge.puppetlabs.com/petems/swap_file)
[![CI](https://github.com/voxpupuli/puppet-swap_file/actions/workflows/ci.yml/badge.svg)](https://github.com/voxpupuli/puppet-swap_file/actions/workflows/ci.yml)
[![License](https://img.shields.io/github/license/voxpupuli/puppet-swap_file.svg)](https://github.com/voxpupuli/puppet-swap_file/blob/master/LICENSE)
[![puppetmodule.info docs](https://www.puppetmodule.info/images/badge.png)](https://www.puppetmodule.info/m/puppet-swap_file)
rwaffen marked this conversation as resolved.
Show resolved Hide resolved
[![Donated by petems](https://img.shields.io/badge/donated%20by-petems-fb7047.svg)](#transfer-notice)

#### Table of Contents
[![Puppet Forge Endorsement](https://img.shields.io/puppetforge/e/puppet/swap_file.svg)](https://forge.puppetlabs.com/puppet/swap_file)
[![Puppet Forge Version](https://img.shields.io/puppetforge/v/puppet/swap_file.svg)](https://forge.puppetlabs.com/puppet/swap_file)
[![Puppet Forge Score](https://img.shields.io/puppetforge/f/puppet/swap_file.svg)](https://forge.puppetlabs.com/puppet/swap_file)
[![Puppet Forge Downloads](https://img.shields.io/puppetforge/dt/puppet/swap_file.svg)](https://forge.puppetlabs.com/puppet/swap_file)

## Table of Contents

1. [Overview](#overview)
2. [Module Description](#module-description)
3. [Setup](#setup)
1. [Setup](#setup)
* [What swap_file affects](#what-swap_file-affects)
4. [Usage](#usage)
5. [Limitations](#limitations)
6. [Upgrading from 1.0.1 Release](#upgrading-from-101-release)
7. [Development](#development)
1. [Usage](#usage)
1. [Limitations](#limitations)
1. [Upgrading from 1.0.1 Release](#upgrading-from-101-release)
1. [Development](#development)

## Overview

Expand All @@ -24,7 +28,8 @@ Manage [swap files](http://en.wikipedia.org/wiki/Paging) for your Linux environm

### What swap_file affects

* Creating a swap-file on disk. This uses `dd` by default, but can use `fallocate` optionally for performance reasons. **Note: Using fallocate to create a ZFS file system will fail: https://bugzilla.redhat.com/show_bug.cgi?id=1129205**
* Creating a swap-file on disk. This uses `dd` by default, but can use `fallocate` optionally for performance reasons.
**Note: Using fallocate to create a ZFS file system will fail: <https://bugzilla.redhat.com/show_bug.cgi?id=1129205>**
* Swapfiles on the system
* Any mounts of swapfiles

Expand Down Expand Up @@ -73,7 +78,7 @@ swap_file::files { 'tmp file swap':

To choose the size of the swap file instead of defaulting to memory size:

```
```puppet
swap_file::files { '5GB Swap':
ensure => present,
swapfile => '/mnt/swap.5gb',
Expand All @@ -82,6 +87,7 @@ swap_file::files { '5GB Swap':
```

### hiera

You can also use hiera to call this module and set the configuration.

The simplest use of the module with hiera is this:
Expand Down Expand Up @@ -117,13 +123,14 @@ swap_file::files:
```

This hiera config will respectively:

* create a file `/tmp/swapfile.custom` using /bin/dd with the default size taken from the `$::memorysize` fact without creating a `mount` for it.
* create a file `/tmp/swapfile.fallocate` using /usr/bin/fallocate with the default size taken from the `$::memorysize` fact and creating a `mount` for it.
* deactivates the swapfile `/tmp/swapfile.old`, deletes it and removes the `mount`.

Set `$files_hiera_merge` to `true` to merge all found instances of `swap_file::files` in Hiera. This is useful for specifying swap files at different levels of the hierachy and having them all included in the catalog.

##Upgrading from 1.0.1 Release
## Upgrading from 1.0.1 Release

Previously you would create swapfiles with the `swap_file` class:

Expand Down Expand Up @@ -177,3 +184,9 @@ Right now there is no BSD support, but I'm planning on adding it in the future
## Development

Follow the CONTRIBUTING guidelines! :)

## Transfer Notice

This project was originally authored by [Peter Souter](https://github.com/petems).
The maintainer preferred that Vox Pupuli take ownership of the project for future improvement and maintenance.
Existing pull requests and issues were transferred over, please fork and continue to contribute here.
Loading