https://github.com/simp/pupmod-simp-swap
A SIMP Puppet module for managing swappiness
https://github.com/simp/pupmod-simp-swap
simp swap swappiness
Last synced: about 2 months ago
JSON representation
A SIMP Puppet module for managing swappiness
- Host: GitHub
- URL: https://github.com/simp/pupmod-simp-swap
- Owner: simp
- License: other
- Created: 2016-12-05T02:22:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T19:54:07.000Z (10 months ago)
- Last Synced: 2025-04-13T05:53:15.990Z (about 2 months ago)
- Topics: simp, swap, swappiness
- Language: Ruby
- Size: 129 KB
- Stars: 1
- Watchers: 16
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
[](http://www.apache.org/licenses/LICENSE-2.0.html)
[](https://bestpractices.coreinfrastructure.org/projects/73)
[](https://forge.puppetlabs.com/simp/swap)
[](https://forge.puppetlabs.com/simp/swap)
[](https://travis-ci.org/simp/pupmod-simp-swap)
#### Table of Contents
* [Description](#description)
* [This is a SIMP module](#this-is-a-simp-module)
* [Setup](#setup)
* [What swap affects](#what-swap-affects)
* [Beginning with swap](#beginning-with-swap)
* [Limitations](#limitations)
* [Development](#development)
* [Acceptance tests](#acceptance-tests)
## Description
This module manages the swappiness of a system, either directly or with a dynamic script.
See [REFERENCE.md](./REFERENCE.md) for API details.
### This is a SIMP module
This module is a component of the [System Integrity Management Platform](https://simp-project.com),
a compliance-management framework built on Puppet.
If you find any issues, they may be submitted to our [bug tracker](https://simp-project.atlassian.net/).
## Setup
### What swap affects
* The sysctl value `vm.swappiness`.
* If enabled, the ability for the system to monitor the amount of free RAM and
dynamically set the swappiness based on monitored conditions.
* See [manifests/init.pp](./manifests/init.pp) for details.
### Beginning with swap
To use this class, just include it on your system:
```puppet
include 'swap'
```
## Limitations
SIMP Puppet modules are generally intended for use on Red Hat Enterprise Linux
and compatible distributions, such as CentOS. Please see the [`metadata.json` file](./metadata.json)
for the most up-to-date list of supported operating systems, Puppet versions,
and module dependencies.
## Development
Please read our [Contribution Guide](https://simp.readthedocs.io/en/stable/contributors_guide/index.html).
### Acceptance tests
This module includes [Beaker](https://github.com/puppetlabs/beaker) acceptance
tests using the SIMP [Beaker
Helpers](https://github.com/simp/rubygem-simp-beaker-helpers). By default the
tests use [Vagrant](https://www.vagrantup.com/) with
[VirtualBox](https://www.virtualbox.org) as a back-end; Vagrant and VirtualBox
must both be installed to run these tests without modification. To execute the
tests run the following:
```shell
bundle install
bundle exec rake beaker:suites
```
Please refer to the [SIMP Beaker Helpers documentation](https://github.com/simp/rubygem-simp-beaker-helpers/blob/master/README.md) for more information.