Skip to main content

Configuring Swap Memory on Ubuntu Using Ansible

Image

If we maintain a Linux machine with a low memory capacity while we are required to run an application with high memory consumption, enabling swap memory is an option. Ansible can be utilized as a helper tool to automate the creation of swap memory. A swap file can be allocated in the available storage of the machine. The swap file then can be assigned as a swap memory.

Firstly, we should prepare the inventory file. The following snippet is an example, you must provide your own configuration.

[server]
192.168.1.2

[server:vars]
ansible_user=root
ansible_ssh_private_key_file=~/.ssh/id_rsa

Secondly, we need to prepare the task file that contains not only the tasks but also some variables and connection information. For instance, we set /swapfile as the name of our swap file. We also set the swap memory size to 2GB and the swappiness level to 60. 

- hosts: server
  become: true
  vars:
    swap_vars:
      size: 2G
      swappiness: 60

For simplicity, we only check the existence of /swapfile for continuing the swap memory creation. The steps are as follows:

  1. Verify that /swapfile doesn't exist
  2. Fail the process if /swapfile exists
  3. Allocate /swapfile as a swap file
  4. Change the permission of /swapfile into 600
  5. Create a swap area on the swap file
  6. Activate the swap file as a swap memory
  7. Make the activation permanent
  8. Set the swappiness level of the swap memory
  9. Make the swappiness level permanent

tasks:
    - name: Check whether "/swapfile" exists
      register: idCheckSwap
      stat:
        path: /swapfile

    - name: Fail it if "/swapfile" exists
      fail:
        msg: Swap file exists
      when: idCheckSwap.stat.exists == true

    - name: Allocate the swap file
      shell: fallocate -l {{ swap_vars.size }} /swapfile

    - name: Change permission of the swap file
      file:
        path: /swapfile
        mode: 600
    
    - name: Create a swap area on the swap file
      shell: mkswap /swapfile
    
    - name: Activate the swap file as a swap memory
      shell: swapon /swapfile
    
    - name: Append configuration in /etc/fstab
      shell: echo "\n/swapfile swap swap defaults 0 0\n" >> /etc/fstab
    
    - name: Set swappiness level
      shell: sysctl vm.swappiness={{ swap_vars.swappiness }}
    
    - name: Append configuration in /etc/sysctl.conf
      shell: echo "\nvm.swappiness={{ swap_vars.swappiness }}\n" >> /etc/sysctl.conf

Labels:

Comments

  1. AnonymousDecember 4, 2023 at 1:23 AM

    Very useful article. Tested in Ansible and works like a charm. Thanks for saving me time!

    ReplyDelete
  2. AnonymousJuly 15, 2024 at 3:45 AM

    Thanks for this! I made a slightly upgraded version that also allows changing swap when needed, it requires two variables (swap.size_gb and swap.swappiness):

    ---
    - name: Get current swap
    shell: free -g --si | grep Swap | awk '{print $2}'
    register: current_swap_gb
    changed_when: false

    - name: Get current swappiness
    shell: cat /proc/sys/vm/swappiness
    register: current_swappiness
    changed_when: false

    - name: Exiting play early because no changes are required
    meta: end_play
    when: current_swap_gb.stdout|int == swap.size_gb|int and current_swappiness.stdout|int == swap.swappiness|int

    - name: Disable existing swap
    become: true
    command: swapoff -a
    ignore_errors: yes

    - name: Remove old swap file
    become: true
    file:
    path: /swapfile
    state: absent
    ignore_errors: yes

    - name: Allocate the swap file
    become: true
    shell: fallocate -l {{ swap.size_gb }}G /swapfile

    - name: Change permission of the swap file
    become: true
    file:
    path: /swapfile
    mode: 600

    - name: Create a swap area on the swap file
    become: true
    shell: mkswap /swapfile

    - name: Activate the swap file as a swap memory
    become: true
    shell: swapon /swapfile

    - name: Append configuration in /etc/fstab
    become: true
    shell: echo "\n/swapfile swap swap defaults 0 0\n" >> /etc/fstab

    - name: Set swappiness level
    become: true
    shell: sysctl vm.swappiness={{ swap.swappiness }}

    - name: Append configuration in /etc/sysctl.conf
    become: true
    shell: echo "\nvm.swappiness={{ swap.swappiness }}\n" >> /etc/sysctl.conf

    ReplyDelete
  3. AnonymousJuly 15, 2024 at 4:29 AM

    Or this might actually be better if you're using a role:

    ```
    ---
    - name: Get current swap
    shell: set -o pipefail && free -g --si | grep Swap | awk '{print $2}'
    args:
    executable: /bin/bash
    register: current_swap_gb
    changed_when: false

    - name: Get current swappiness
    command: cat /proc/sys/vm/swappiness
    register: current_swappiness
    changed_when: false

    - name: Set should_continue
    set_fact:
    should_continue: "{{ current_swap_gb.stdout|int != swap.size_gb|int or current_swappiness.stdout|int != swap.swappiness|int }}"

    - name: Disable existing swap
    become: true
    command: swapoff -a
    when: should_continue

    - name: Remove old swap file
    become: true
    file:
    path: /swapfile
    state: absent
    register: result
    when: should_continue

    - name: Allocate the swap file
    become: true
    command: fallocate -l {{ swap.size_gb }}G /swapfile
    when: should_continue

    - name: Change permission of the swap file
    become: true
    file:
    path: /swapfile
    mode: "0600"
    when: should_continue

    - name: Create a swap area on the swap file
    become: true
    command: mkswap /swapfile
    when: should_continue

    - name: Activate the swap file as a swap memory
    become: true
    command: swapon /swapfile
    when: should_continue

    - name: Append configuration in /etc/fstab
    become: true
    shell: echo "\n/swapfile swap swap defaults 0 0\n" >> /etc/fstab
    when: should_continue

    - name: Set swappiness level
    become: true
    command: sysctl vm.swappiness={{ swap.swappiness }}
    when: should_continue

    - name: Append configuration in /etc/sysctl.conf
    become: true
    shell: echo "\nvm.swappiness={{ swap.swappiness }}\n" >> /etc/sysctl.conf
    when: should_continue
    ```

    ReplyDelete

Post a Comment

Popular posts from this blog

Deliver SaaS According Twelve-Factor App

If you haven't heard of  the twelve-factor app , it gives us a recommendation or a methodology for developing SaaS or web apps structured into twelve items. The recommendation has some connections with microservice architecture and cloud-native environments which become more popular today. We can learn the details on its website . In this post, we will do a quick review of the twelve points. One Codebase Multiple Deployment We should maintain only one codebase for our application even though the application may be deployed into multiple environments like development, staging, and production. Having multiple codebases will lead to any kinds of complicated issues. Explicitly State Dependencies All the dependencies for running our application should be stated in the project itself. Many programming languages have a kind of file that maintains a list of the dependencies like package.json in Node.js. We should also be aware of the dependencies related to the pla...
2 comments
Read more

Rangkaian Sensor Infrared dengan Photo Dioda

Keunggulan photodioda dibandingkan LDR adalah photodioda lebih tidak rentan terhadap noise karena hanya menerima sinar infrared, sedangkan LDR menerima seluruh cahaya yang ada termasuk infrared. Rangkaian yang akan kita gunakan adalah seperti gambar di bawah ini. Pada saat intensitas Infrared yang diterima Photodiode besar maka tahanan Photodiode menjadi kecil, sedangkan jika intensitas Infrared yang diterima Photodiode kecil maka tahanan yang dimiliki photodiode besar. Jika  tahanan photodiode kecil  maka tegangan  V- akan kecil . Misal tahanan photodiode mengecil menjadi 10kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 10 / (10+10) x Vcc V- = (1/2) x 5 Volt V- = 2.5 Volt Sedangkan jika  tahanan photodiode besar  maka tegangan  V- akan besar  (mendekati nilai Vcc). Misal tahanan photodiode menjadi 150kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 150 / (1...
7 comments
Read more

API Gateway Using KrakenD

The increasing demands of users for high-quality web services create the need to integrate various technologies into our application. This will cause the code base to grow larger, making maintenance more difficult over time. A microservices approach offers a solution, where the application is built by combining multiple smaller services, each with a distinct function. For example, one service handles authentication, another manages business functions, another maintains file uploads, and so on. These services communicate and integrate through a common channel. On the client side, users don't need to understand how the application is built or how it functions internally. They simply send a request to a single endpoint, and processes like authentication, caching, or database querying happen seamlessly. This is where an API gateway is effective. It handles user requests and directs them to the appropriate handler. There are several tools available for building an API gateway, su...
Post a Comment
Read more

Deploying a Web Server on UpCloud using Terraform Modules

In my earlier post , I shared an example of deploying UpCloud infrastructure using Terraform from scratch. In this post, I want to share how to deploy the infrastructure using available Terraform modules to speed up the set-up process, especially for common use cases like preparing a web server. For instance, our need is to deploy a website with some conditions as follows. The website can be accessed through HTTPS. If the request is HTTP, it will be redirected to HTTPS. There are 2 domains, web1.yourdomain.com and web2.yourdomain.com . But, users should be redirected to "web2" if they are visiting "web1". There are 4 main modules that we need to set up the environment. Private network. It allows the load balancer to connect with the server and pass the traffic. Server. It is used to host the website. Load balancer. It includes backend and frontend configuration. Dynamic certificate. It is requ...
Post a Comment
Read more

Headless CMS for Building API Endpoints

Recently, someone introduced me to a tool called Directus, which is used for building backend systems and defining data structures. This also reminded me of a product I reviewed about two years ago, which was also built using Directus. After doing some online research, I decided to test another headless CMS solution called Strapi. When we think of CMS platforms, names like WordPress, Joomla, or Moodle might come to mind. But what does 'headless' mean in this context? A headless CMS is a type of CMS that focuses solely on the backend system, without providing the frontend interface. It can generate the API endpoints, letting developers build the frontend or client-side application separately. However, this doesn't mean headless CMS platforms lack a user interface entirely. Most, like Directus and Strapi, include a UI tool (an administrator dashboard) for designing and managing the backend system and resources. After spending some time testing and reviewing Stra...
Post a Comment
Read more