Forge Home

nodesite

Nodejs web app deployments

10,072 downloads

9,851 latest version

1.3 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.3 (latest)
  • 0.0.1 (deleted)
released Aug 24th 2014
This version is compatible with:
  • Puppet 3.x

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'brettswift-nodesite', '0.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add brettswift-nodesite
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install brettswift-nodesite --version 0.0.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

brettswift/nodesite — version 0.0.3 Aug 24th 2014

#Nodesite

State: experimental

A Puppet module to allow fast deployment to test nodejs applications.

Pass in your .git URI and the file used to run your app (if it's something other than app.js). Pass your database configuration in via node_params (that will be passed to the command line) or optionally put configuration into a git branch of your source project, and tell nodesite which git_branch to run.

If the DB configuration is successful, you will have a running nodejs app.

Typically you will configure a database on the same host. To see an example of this module in action, see my vagrant-nodeJsServer project

###Git deploys Enabled by default. Nodesite will check for upstream changes on each puppet run. If there are any it will run a git pull, npm prune, npm install and restart the service.

##Usage

###Basic with all defaults

  class {'nodesite':
    git_uri       => "https://github.com/brettswift/uptime.git",
  }

###Extended

 class {'nodesite':
    node_version  => "v0.10.26",
    git_uri       => "https://github.com/brettswift/uptime.git",
    git_branch    => $featureBranch,
    file_to_run   => "app.js",
    user          => "${project}",
    node_params   => "NODE_CONFIG={\"mongodb\":{\"database\":\"${db_name}\", \"user\":\"${db_user}\", \"password\":\"${db_password}\"}}"
  }

###Parameters

  • node_version - optional.
    • default: 'stable'
  • git_uri - required
    • use link as shown above.
  • git_branch - optional.
    • default: 'master'
    • note: should work with a git hash or tag as well. (currently not tested)
  • file_to_run - optional. This is the entry point for the app. Ie: node app.js
    • default: 'app.js'
  • user - optional. The user which the process should run under. (Will be created)
    • default: 'nodejs'
  • node_params - optional.
    • command line parameters to pass to the process. In the example above, node config options are passed in.
  • npm_proxy - optional
  • repo_dir - optional
    • default: /usr/local/share/nodesite_repos

TODO (6)

  1. git.pp:9 this code is duplicated.. fix it.
  2. init.pp:1 unit tests!
  3. project.pp:12 validate node version to: vX.X.X or latest or stable
  4. project.pp:61 pull start scripts into separate files
  5. init.conf.erb:19 set node_env variable, and other node variables
  6. init.conf.erb:35 use npm start

##Known Bugs upstart is configured for puppet 3.5 only, and is currently broken. pre puppet 3.5 works with system V startup scripts.

##Contributing Pull Requests

Feature Branches