Manage ruby installations and gemsets with RVM, the Ruby Version Manager.
salt.modules.rvm.
do
(ruby, command, runas=None, cwd=None, env=None)¶Execute a command in an RVM controlled environment.
Which ruby to use
The rvm command to execute
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
The directory from which to run the rvm command. Defaults to the user's home directory.
CLI Example:
salt '*' rvm.do 2.0.0 <command>
salt.modules.rvm.
gemset_copy
(source, destination, runas=None)¶Copy all gems from one gemset to another.
The name of the gemset to copy, complete with ruby version
The destination gemset
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.gemset_copy foobar bazquo
salt.modules.rvm.
gemset_create
(ruby, gemset, runas=None)¶Creates a gemset.
The ruby version for which to create the gemset
The name of the gemset to create
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.gemset_create 2.0.0 foobar
salt.modules.rvm.
gemset_delete
(ruby, gemset, runas=None)¶Delete a gemset
The ruby version to which the gemset belongs
The gemset to delete
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.gemset_delete 2.0.0 foobar
salt.modules.rvm.
gemset_empty
(ruby, gemset, runas=None)¶Remove all gems from a gemset.
The ruby version to which the gemset belongs
The gemset to empty
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.gemset_empty 2.0.0 foobar
salt.modules.rvm.
gemset_list
(ruby='default', runas=None)¶List all gemsets for the given ruby.
The ruby version for which to list the gemsets
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.gemset_list
salt.modules.rvm.
gemset_list_all
(runas=None)¶List all gemsets for all installed rubies.
Note that you must have set a default ruby before this can work.
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.gemset_list_all
salt.modules.rvm.
get
(version='stable', runas=None)¶Update RVM
Which version of RVM to install, (e.g. stable or head)
CLI Example:
salt '*' rvm.get
salt.modules.rvm.
install
(runas=None)¶Install RVM system-wide
The user under which to run the rvm installer script. If not specified, then it be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.install
salt.modules.rvm.
install_ruby
(ruby, runas=None, opts=None, env=None)¶Install a ruby implementation.
The version of ruby to install
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
Environment to set for the install command. Useful for exporting compilation flags such as RUBY_CONFIGURE_OPTS
List of options to pass to the RVM installer (ie -C, --patch, etc)
CLI Example:
salt '*' rvm.install_ruby 1.9.3-p385
salt.modules.rvm.
is_installed
(runas=None)¶Check if RVM is installed.
CLI Example:
salt '*' rvm.is_installed
salt.modules.rvm.
list_
(runas=None)¶List all rvm-installed rubies
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.list
salt.modules.rvm.
reinstall_ruby
(ruby, runas=None, env=None)¶Reinstall a ruby implementation
The version of ruby to reinstall
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.reinstall_ruby 1.9.3-p385
salt.modules.rvm.
rubygems
(ruby, version, runas=None)¶Installs a specific rubygems version in the given ruby
The ruby for which to install rubygems
The version of rubygems to install, or 'remove' to use the version that ships with 1.9
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.rubygems 2.0.0 1.8.24
salt.modules.rvm.
set_default
(ruby, runas=None)¶Set the default ruby
The version of ruby to make the default
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
CLI Example:
salt '*' rvm.set_default 2.0.0
salt.modules.rvm.
wrapper
(ruby_string, wrapper_prefix, runas=None, *binaries)¶Install RVM wrapper scripts
Ruby/gemset to install wrappers for
What to prepend to the name of the generated wrapper binaries
The user under which to run rvm. If not specified, then rvm will be run as the user under which Salt is running.
The names of the binaries to create wrappers for. When nothing is given, wrappers for ruby, gem, rake, irb, rdoc, ri and testrb are generated.
CLI Example:
salt '*' rvm.wrapper <ruby_string> <wrapper_prefix>