ndenv Cookbook

This cookbook installs and configures ndenv.

Requirements

cookbooks

apt - https://supermarket.getchef.com/cookbooks/apt
build-essential - https://supermarket.getchef.com/cookbooks/build-essential
git - https://supermarket.getchef.com/cookbooks/git

platforms

The following platforms and versions are tested and supported using Opscode’s test-kitchen.

Ubuntu 12.04
Debian 7.2

Attributes

ndenv::default

Key	Type	Description	Default
`[‘ndenv’][‘user’]`	String	User to use for ndenv install, create if not exists.	`ndenv`
`[‘ndenv’][‘user_home’]`	String	User home	`/home/ndenv`
`[‘ndenv’][‘group’]`	String	Group to use for ndenv install, create if not exists.	`ndenv`
`[‘ndenv’][‘group_users’]`	Array	List of users to add to specified group.	`[]`
`[‘ndenv’][‘manage_home’]`	Boolean	Manage user home. Used for `user` resource.	`true`
`[‘ndenv’][‘root_path’]`	String	Ndenv root path.	`/opt/ndenv`
`[‘ndenv’][‘profile_path’]`	String	Profile.d path where will be stored ndenv init script.	`/etc/profile.d`
`[‘ndenv’][‘git_repository’]`	String	Git repository for ndenv.	`https://github.com/riywo/ndenv.git`
`[‘ndenv’][‘git_reference]`	String	Git reference for ndenv.	`master`
`[‘node_build’][‘git_repository’]`	String	Git repository for node-build.	`https://github.com/riywo/node-build.git`
`[‘node_build’][‘git_reference]`	String	Git reference for node-build.	`master`

ndenv::install

`[‘ndenv’][‘installs’]`	Array	List of node.js versions to install.	`[‘0.10.26’]`
`[‘ndenv’][‘global’]`	String	Node.js version to set as global.	`0.10.26`

Usage

ndenv::default

This recipe install and configure ndenv for specified user/group.
Just include ndenv in your node’s run_list:

{
"name":"my_node",
  "run_list": [
    "recipe[ndenv]"
  ]
}

ndenv::install

This recipe install specified node.js versions. Ndenv must be installed to use this recipe!
Set installs and global attributes and include ndenv::install in your node’s run_list:

{
"name":"my_node",
  "run_list": [
    "recipe[ndenv]"
    "recipe[ndenv::install]"
  ],
  "attributes": [
    "ndenv": [
      "installs": ["0.10.20", "0.10.26"],
      "global": "0.10.26"
    ]
  ]
}

Resources/Providers

ndenv_node

Install specified version of Node.js to be managed by ndenv.

Actions

Action	Description	Default
install	Install the version of Nodejs	Yes

Attributes

Attribute	Description	Default
node_version	the node version you wish to install	name
force	install even if this version is already present (reinstall)	false
global	set this node.js version as the global version	false

ndenv_npm

Install NPM package for specified Node.js version.

Actions

Action	Description	Default
install	Install NPM package	Yes
upgrade	Update NPM package to the latest version	No
remove	Remove NPM package	No

Attributes

Attribute	Description	Default
package_name	the package’s name to install	name
version	the package’s version to install	nil
source	the package’s source to install (tarball, github..)	nil
node_version	the node version you wish to use	nil
response_file	not used	nil

Examples

Installing Node.js 0.10.20

ndenv_node "v0.10.20"

Forcefully install Node.js 0.10.20

ndenv_node "Node.js 0.10.20" do
  node_version "v0.10.20"
  force true
end

Install grunt package version 0.4.5 for Node.js v0.10.20

ndenv_npm "grunt" do
  node_version "v0.10.20"
  version "0.4.5"
end

Install latest grunt-cli package for Node.js v0.10.20

ndenv_npm "grunt-cli" do
  node_version "v0.10.20"
end

Install require.js package from github

ndenv_npm "r.js from github" do
  node_version "v0.10.20"
  source "nathanfaucett/require.js"
end

Install forever package from tarball

ndenv_npm "forever from tarball" do
  node_version "v0.10.20"
  source "https://github.com/indexzero/forever/tarball/v0.5.6"
end

Update grunt package to the latest version

ndenv_npm "grunt" do
  action :upgrade
  node_version "v0.10.20"
end

Remove grunt package

ndenv_npm "grunt" do
  action :remove
  node_version "v0.10.20"
end

Contributing

Fork the repository on Github
Create a named feature branch (like add_component_x)
Write your change
Write tests for your change (if applicable)
Run the tests, ensuring they all pass
Submit a Pull Request using Github

License and Authors


Author	Antoine Rouyer antoine.rouyer@numergy.com

Copyright	Copyright (c) 2014 Numergy

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.