node-formula
Formula to install Node.js on GNU/Linux, MacOS, and BSD.
The default method is package. See pillar.example file for other ideas.
Table of Contents
General notes
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA
file and/or git tag
,
which contains the currently released version. This formula is versioned according to Semantic Versioning.
See Formula Versioning Section for more details.
If you need (non-default) configuration, please pay attention to the pillar.example
file and/or Special notes section.
Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute for more details.
Special notes
None.
Available states
node
Meta-state (This is a state that includes other states).
This installs Node package, manages Node configuration file and then starts the associated node service.
node.package
This state will install Node package only.
node.archive
This state will install Node from archive only.
node.source
This state will install Node from source only.
node.config
This state will configure npmrc and/or environment and has a dependency on node.install
via include list.
node.clean
Meta-state (This is a state that includes other states).
this state will undo everything performed in the node
meta-state in reverse order, i.e.
removes the configuration file and
then uninstalls the package.
node.config.clean
This state will remove the configuration of Node and has a
dependency on node.package.clean
via include list.
node.package.clean
This state will remove Node package and has a dependency on
node.config.clean
via include list.
node.source.clean
This state will remove Node package and has a dependency on
node.config.clean
via include list.
node.archive.clean
This state will remove Node package and has a dependency on
node.config.clean
via include list.
Testing
Linux testing is done with kitchen-salt
.
Requirements
- Ruby
- Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]
Where [platform]
is the platform name defined in kitchen.yml
,
e.g. debian-9-2019-2-py3
.
bin/kitchen converge
Creates the docker instance and runs the node
main state, ready for testing.
bin/kitchen verify
Runs the inspec
tests on the actual instance.
bin/kitchen destroy
Removes the docker instance.
bin/kitchen test
Runs all of the stages above in one go: i.e. destroy
+ converge
+ verify
+ destroy
.
bin/kitchen login
Gives you SSH access to the instance for manual testing.