pm2-cookbook

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 23 Open GitHub ↗

Chef cookbook to install and manage PM2.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PM2 Cookbook

[![Cookbook](https://img.shields.io/cookbook/v/pm2.svg)](https://supermarket.chef.io/cookbooks/pm2)
[![Build Status](https://travis-ci.org/Mindera/pm2-cookbook.svg?branch=master)](https://travis-ci.org/Mindera/pm2-cookbook)

Chef coookbook to install and manage [PM2](https://github.com/Unitech/pm2).

## Requirements

Depends on the cookbooks:

* [poise-javascript](https://github.com/poise/poise-javascript)

## Platforms

* Centos 6+
 * Amazon Linux
 * Ubuntu 14+
 * Debian 7+

## Attributes

### default.rb

<table>
    <tr>
        <th>Attribute</th>
        <th>Type</th>
        <th>Description</th>
        <th>Default</th>
    </tr>
    <tr>
        <td><tt>['pm2']['node_version']</tt></td>
        <td>String</td>
        <td>Node version to install</td>
        <td><tt>4.5.0</tt></td>
    </tr>
    <tr>
        <td><tt>['pm2']['pm2_version']</tt></td>
        <td>String</td>
        <td>PM2 node module version to install</td>
        <td><tt>latest</tt></td>
    </tr>
    <tr>
        <td><tt>['pm2']['npm_version']</tt></td>
        <td>String</td>
        <td>NPM node module version to install</td>
        <td><tt>latest</tt></td>
    </tr>
</table>

## Recipes

### default.rb

Installs PM2 as a global node module using a specific version if specified in the `default` attributes described above.

### Example

To install PM2:

Add the `pm2` cookbook as a dependency:

```ruby
depends 'pm2'
```

Include the `pm2::default` recipe:

```ruby
include_recipe 'pm2::default'
```

## Providers

### pm2_application

The `pm2_application` provider manages a json configuration file for a node application and controls it with PM2.

It only start processes from a json configuration (located in `/etc/pm2/conf.d`) and it does not support starting processes by calling the PM2 CLI directly.

#### Actions

The available actions try to represent some of the PM2 CLI control [actions](https://github.com/Unitech/PM2/blob/master/ADVANCED_README.md#raw-examples).

<table>
    <tr>
        <th>Action</th>
        <th>Description</th>
        <th>Notes</th>
    </tr>
    <tr>
        <td><tt>:deploy</tt></td>
        <td>Create a json configuration file for a node application</td>
        <td>All configuration files are deployed in <tt>/etc/pm2/conf.d</tt></td>
    </tr>
    <tr>
        <td><tt>:start</tt></td>
        <td>Start an application defined as a json file</td>
        <td>It does not change the state of a running application - use one of the start_or_restart/start_or_reload methods instead</td>
    </tr>
    <tr>
        <td><tt>:stop</tt></td>
        <td>Stop an application</td>
        <td>Invokes the PM2 CLI to stop an application by name</td>
    </tr>
    <tr>
        <td><tt>:restart</tt></td>
        <td>Restart an application</td>
        <td>Invokes the PM2 CLI to restart an application by name only if it is running</td>
    </tr>
    <tr>
        <td><tt>:reload</tt></td>
        <td>Reload an application</td>
        <td>Invokes the PM2 CLI to reload an application by name only if it is running</td>
    </tr>
    <tr>
        <td><tt>:graceful_reload</tt></td>
        <td>Gracefully reload an application</td>
        <td>Invokes the PM2 CLI to gracefully reload an application by name only if it is running</td>
    </tr>
    <tr>
        <td><tt>:start_or_restart</tt></td>
        <td>Start or restart an application</td>
        <td>Invokes the PM2 CLI to start or restart an application by name</td>
    </tr>
    <tr>
        <td><tt>:start_or_reload</tt></td>
        <td>Start or reload an application</td>
        <td>Invokes the PM2 CLI to start or reload an application by name</td>
    </tr>
    <tr>
        <td><tt>:start_or_graceful_reload</tt></td>
        <td>Start or gracefully reload an application</td>
        <td>Invokes the PM2 CLI to start or gracefully reload an application by name</td>
    </tr>
    <tr>
        <td><tt>:delete</tt></td>
        <td>Stop and delete an application json file</td>
        <td>Invokes the PM2 CLI to stop an application and deletes the json file from the filesystem</td>
    </tr>
    <tr>
        <td><tt>:startup</tt></td>
        <td>Configures PM2 to start on boot</td>
        <td>Invokes the PM2 CLI to configure the startup process for the running platform</td>
    </tr>
</table>

If no action is specified then the default action `[:deploy, :start_or_restart, :startup]` will be used.

#### Attributes

The available attributes try to represent the PM2 json definition options [schema](https://github.com/Unitech/PM2/blob/master/ADVANCED_README.md#schema).

<table>
    <tr>
        <th>Attribute</th>
        <th>Type</th>
        <th>Description</th>
        <th>Required</th>
    </tr>
    <tr>
        <td><tt>name</tt></td>
        <td>String</td>
        <td>Name of the application - See PM2 documentation for reference - Note: this is the resource name attribute</td>
        <td>Yes</td>
    </tr>
    <tr>
        <td><tt>script</tt></td>
        <td>String</td>
        <td>Node script to execute - See PM2 documentation for reference</td>
        <td>Yes</td>
    </tr>
    <tr>
        <td><tt>user</tt></td>
        <td>String</td>
        <td>User to execute the node process - defaults to `root`</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>home</tt></td>
        <td>String</td>
        <td>Value of the PM2_HOME environmental variable - Note: a .pm2 directory will be appended to the PM2_HOME value if missing</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>args</tt></td>
        <td>Array</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>node_args</tt></td>
        <td>Array</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>max_memory_restart</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>instances</tt></td>
        <td>Integer</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>log_file</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>error_file</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>out_file</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>pid_file</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>cron_restart</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>cwd</tt></td>
        <td>String</td>
        <td>Location of the node script to execute - See PM2 documentation for reference</td>
        <td>Yes</td>
    </tr>
    <tr>
        <td><tt>merge_logs</tt></td>
        <td>TrueClass/FalseClass</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>ignore_watch</tt></td>
        <td>Array</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>watch_options</tt></td>
        <td>Hash</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>env</tt></td>
        <td>Hash</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>log_data_format</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>min_uptime</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>max_restart</tt></td>
        <td>Integer</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>exec_mode</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>exec_interpreter</tt></td>
        <td>String</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>write</tt></td>
        <td>TrueClass/FalseClass</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
    <tr>
        <td><tt>force</tt></td>
        <td>TrueClass/FalseClass</td>
        <td>See PM2 documentation for reference</td>
        <td>No</td>
    </tr>
</table>

#### Example

To deploy and start (or restart) a `test.js` application that lives in `/tmp/test.js`:

Install PM2 as described in the `Recipes` example above.

Use the `pm2_application` provider - most basic example:

```ruby
pm2_application 'test' do
  script 'test.js'
  cwd '/tmp'
  action [:deploy, :start_or_restart]
end
```

This will deploy a `/etc/pm2/conf.d/test.json` configuration file and start/restart the application with PM2.

#### References

* PM2 advanced [documentation](https://github.com/Unitech/PM2/blob/master/ADVANCED_README.md)

## Development / Contributing

### Dependencies

* [Ruby](https://www.ruby-lang.org)
 * [Bundler](http://bundler.io)

### Installation

```bash
$ git clone git@github.com:Mindera/pm2-cookbook.git
$ cd pm2-cookbook
$ bundle install
```

### Tests

To run lint tests (rubocop, foodcritic):
```bash
$ bundle exec rake lint
```

To run integration tests (kitchen-ci, serverspec):
```bash
$ bundle exec rake integration
```

pm2-cookbook

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README