Skip to content

Commit

Permalink
added Kamaln7 ansible swapfile role
Browse files Browse the repository at this point in the history
  • Loading branch information
jasperf committed Jun 13, 2017
1 parent f558c06 commit 8bb81bc
Show file tree
Hide file tree
Showing 6 changed files with 151 additions and 0 deletions.
21 changes: 21 additions & 0 deletions roles/swapfile/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2014 Kamal Nasser <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
70 changes: 70 additions & 0 deletions roles/swapfile/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
ansible-swapfile
================

This role configures a swapfile (/swapfile) with the (default) size of 512MB.

## Dependencies

None.

## Variables

* `swapfile_use_dd` [default: `False`]: if set to False, `fallocate` is used to create the swapfile, otherwise, `dd` is used. You may need to set this to True if your filesystem does not support `fallocate` -- see Issue #3.

* `swapfile_size` [default: `512MB`]: the size of the swapfile to create in the format that `fallocate` expects:

The length and offset arguments may be followed by binary (2^N) suffixes KiB, MiB, GiB, TiB, PiB and EiB (the "iB" is optional, e.g. "K" has the same meaning as "KiB") or decimal (10^N) suffixes KB, MB, GB, PB and EB.

If `swapfile_use_dd` is set to True, `swapfile_size` must be set to the amount of megabytes to write, e.g. `512`.

* `swapfile_location` [default: `/swapfile`]: the location of where the swapfile will be created

### Optional

The following variables are set to `False` by default and will not have any effect on your hosts. Setting them to any value other than `False` will update your hosts' sysctl.conf file.

* `swapfile_swappiness` [default: `False`]: the swappiness percentage (vm.swappiness) -- the lower it is, the less your system swaps memory pages

* `swapfile_vfs_cache_pressure` [default: `False`]: "this percentage value controls the tendency of the kernel to reclaim the memory which is used for caching of directory and inode objects."

## Usage

```yaml
- hosts: all
roles:
- kamaln7.swapfile
```
or:
```yaml
- hosts: all
roles:
- { role: kamaln7.swapfile, swapfile_size: 1GB, swapfile_swappiness: 10, swapfile_location: /mnt/swapfile }
```
You can also set the variables described above in `group_vars` or `host_vars` (see `defaults/main.yml`).

## License

The MIT License (MIT)

Copyright (c) 2014 Kamal Nasser <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
6 changes: 6 additions & 0 deletions roles/swapfile/defaults/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
swapfile_location: /swapfile
swapfile_size: 512MB
swapfile_swappiness: False
swapfile_vfs_cache_pressure: False
swapfile_use_dd: False
3 changes: 3 additions & 0 deletions roles/swapfile/handlers/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
- name: Reload sysctl
command: sysctl -p
10 changes: 10 additions & 0 deletions roles/swapfile/meta/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
galaxy_info:
author: "Kamal Nasser"
description: swapfile
license: MIT
min_ansible_version: 1.4
version: 0.4
categories:
- system
dependencies: []
41 changes: 41 additions & 0 deletions roles/swapfile/tasks/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
- name: Write swapfile
command: |
{% if swapfile_use_dd %}
dd if=/dev/zero of={{ swapfile_location }} bs=1M count={{ swapfile_size }} creates={{ swapfile_location }}
{% else %}
fallocate -l {{ swapfile_size }} {{ swapfile_location }} creates={{ swapfile_location }}
{% endif %}
register: write_swapfile
when: swapfile_size != false

- name: Set swapfile permissions
file: path={{ swapfile_location }} mode=600
when: swapfile_size != false

- name: Create swapfile
command: mkswap {{ swapfile_location }}
environment:
PATH: "{{ (ansible_env|default({})).PATH|default('') }}:/usr/local/sbin:/usr/sbin:/sbin"
register: create_swapfile
when: swapfile_size != false and write_swapfile.changed

- name: Enable swapfile
command: swapon {{ swapfile_location }}
environment:
PATH: "{{ (ansible_env|default({})).PATH|default('') }}:/usr/local/sbin:/usr/sbin:/sbin"
when: swapfile_size != false and create_swapfile.changed

- name: Add swapfile to /etc/fstab
lineinfile: dest=/etc/fstab line="{{ swapfile_location }} none swap sw 0 0" state=present
when: swapfile_size != false

- name: Configure vm.swappiness
lineinfile: dest=/etc/sysctl.conf line="vm.swappiness = {{ swapfile_swappiness }}" regexp="^vm.swappiness[\s]?=" state=present
notify: Reload sysctl
when: swapfile_swappiness != false

- name: Configure vm.vfs_cache_pressure
lineinfile: dest=/etc/sysctl.conf line="vm.vfs_cache_pressure = {{ swapfile_vfs_cache_pressure }}" regexp="^vm.vfs_cache_pressure[\s]?=" state=present
notify: Reload sysctl
when: swapfile_vfs_cache_pressure != false

0 comments on commit 8bb81bc

Please sign in to comment.