ansible-modules-pm2

Ansible Module to Manage Processes via PM2

• Manage the state of processes via pm2 process manager
• Start/Stop/Restart/Reload/Delete applications

Tested on:

• Host Python: 3.8
• Target host Python: 2.7, 3.5, 3.6, 3.7, 3.8
• Ansible: 2.8.10, 2.9.6 (Should work with older versions)

Installation

Install via pip:

pip install ansible-modules-pm2

PM2 package have to be installed to target hosts. For example, add following to your playbook to install pm2 globally:

- npm:
    name: pm2
    global: yes

Usage

Basic usage is similar to service or supervisorctl module: specify the name and its state. To start an app, give either script or config.

Examples

---
- name: Start myapp with process config file, if not running
  pm2:
    name: myapp
    config: /path/to/myapp/myapp.json
    state: started

- name: Start myapp.js, if not running
  pm2:
    name: myapp
    script: /path/to/myapp/myapp.js
    state: started

- name: Stop process named myapp, if running
  pm2:
    name: myapp
    state: stopped

- name: Restart myapp, in all cases
  pm2:
    name: myapp
    state: restarted

- name: Reload myapp, in all cases
  pm2:
    name: myapp
    state: reloaded

- name: Delete myapp, if exists
  pm2:
    name: myapp
    state: absent

- name: Specify pm2 executable path
  pm2:
    name: myapp
    state: started
    config: /path/to/myapp/myapp.json
    executable: /path/to/myapp/node_modules/.bin/pm2

- name: Also specify working directory where running pm2 command
  pm2:
    name: myapp
    state: started
    config: /path/to/myapp/myapp.json
    executable: /path/to/myapp/node_modules/.bin/pm2
    chdir: /path/to/working/directory

Arguments

License

This software is licensed under GPLv3. See LICENSE for details.