Action | -Description | -Default | -
---|---|---|
create | -- Sets the global version of Ruby to be used in all shells. See 3.1 - rbenv global(1) for more details. - | -Yes | -
Attribute | -Description | -Default Value | -
---|---|---|
rbenv_version | -- Name attribute: a version of Ruby being managed by rbenv. - Note: the version of Ruby must already be installed--this LWRP - will not install it automatically. - | -nil |
-
user | -
- A users's isolated rbenv installation on which to apply an action. The
- default value of nil denotes a system-wide rbenv
- installation is being targeted. Note: if specified, the user
- must already exist.
- |
- nil |
-
root_path | -
- The path prefix to rbenv installation, for example:
- /opt/rbenv .
- |
- nil |
-
Action | -Description | -Default | -
---|---|---|
run | -Run the script | -Yes | -
nothing | -Do not run this command | -- |
Attribute | -Description | -Default Value | -
---|---|---|
name | -- Name attribute: Name of the command to execute. - | -name | -
rbenv_version | -- A version of Ruby being managed by rbenv. - | -nil |
-
root_path | -
- The path prefix to rbenv installation, for example:
- /opt/rbenv .
- |
- nil |
-
code | -- Quoted script of code to execute. - | -nil |
-
creates | -- A file this command creates - if the file exists, the command will not - be run. - | -nil |
-
cwd | -- Current working director to run the command from. - | -nil |
-
environment | -- A has of environment variables to set before running this command. - | -nil |
-
group | -- A group or group ID that we should change to before running this - command. - | -nil |
-
path | -- An array of paths to use when searching for the command. - | -nil , uses system path |
-
returns | -- The return value of the command (may be an array of accepted values) - - this resource raises an exception if the return value(s) do not match. - | -0 |
-
timeout | -- How many seconds to let the command run before timing out. - | -nil |
-
user | -
- A users's isolated rbenv installation on which to apply an action. The
- default value of nil denotes a system-wide rbenv
- installation is being targeted. Note: if specified, the user
- must already exist.
- |
- nil |
-
umask | -- Umask for files created by the command. - | -nil |
-
Action | -Description | -Default | -
---|---|---|
install | -- Install a gem - if version is provided, install that specific version. - | -Yes | -
- Upgrade a gem - if version is provided, upgrade to that specific
- version.
- |
- |
- |
remove | -- Remove a gem. - | -- |
purge | -- Purge a gem. - | -- |
Attribute | -Description | -Default Value | -
---|---|---|
package_name | -- Name attribute: the name of the gem to install. - | -nil |
-
rbenv_version | -- A version of Ruby being managed by rbenv. - | -"global" |
-
root_path | -
- The path prefix to rbenv installation, for example:
- /opt/rbenv .
- |
- nil |
-
version | -- The specific version of the gem to install/upgrade. - | -nil |
-
options | -- Add additional options to the underlying gem command. - | -nil |
-
source | -
- Provide an additional source for gem providers (such as RubyGems).
- This can also include a file system path to a .gem file
- such as /tmp/json-1.5.1.gem .
- |
- nil |
-
user | -
- A users's isolated rbenv installation on which to apply an action. The
- default value of nil denotes a system-wide rbenv
- installation is being targeted. Note: if specified, the user
- must already exist.
- |
- nil |
-
Attribute | -Description | -Default Value | -
---|---|---|
name | -- Name attribute: the name of the plugin to install. - | -nil |
-
root_path | -
- The path prefix to rbenv installation, for example:
- /opt/rbenv .
- |
- nil |
-
git_url | -- The git URL of the plugin repository to clone. - | -nil |
-
git_ref | -- The git revision (branch name or SHA) of the repository to checkout. - | -'master' |
-
user | -
- A users's isolated rbenv installation on which to apply an action. The
- default value of nil denotes a system-wide rbenv
- installation is being targeted. Note: if specified, the user
- must already exist.
- |
- nil |
-
Action | -Description | -Default | -
---|---|---|
run | -Run the script | -Yes | -
nothing | -Do not run this command | -- |
Attribute | -Description | -Default Value | -
---|---|---|
name | -- Name attribute: Name of the command to execute. - | -name | -
user | -
- A users's isolated rbenv installation on which to apply an action. The
- default value of nil denotes a system-wide rbenv
- installation is being targeted. Note: if specified, the user
- must already exist.
- |
- nil |
-
root_path | -
- The path prefix to rbenv installation, for example:
- /opt/rbenv .
- |
- nil |
-
Action | -Description | -Default | -
---|---|---|
install | -- Build and install a Ruby from a definition file. See the ruby-build - readme(1) for more details. - | -Yes | -
reinstall | -- Force a recompiliation of the Ruby from source. The :install action - will skip a build if the target install directory already exists. - | -- |
Attribute | -Description | -Default Value | -
---|---|---|
definition | -- Name attribute: the name of a built-in definition(1) - or the name of the ruby installed by a ruby-build defintion file(2) - | -nil |
-
definition_file | -- The path to a ruby-build definition file. - | -nil |
-
user | -
- A users's isolated rbenv installation on which to apply an action. The
- default value of nil denotes a system-wide rbenv
- installation is being targeted. Note: if specified, the user
- must already exist.
- |
- nil |
-
root_path | -
- The path prefix to rbenv installation, for example:
- /opt/rbenv .
- |
- nil |
-
Action | -Description | -Default | -
---|---|---|
install | -- Build and install a Ruby from a definition file. See the ruby-build - readme(1) for more details. - | -Yes | -
reinstall | -- Force a recompiliation of the Ruby from source. The :install action - will skip a build if the target install directory already exists. - | -- |
Attribute | -Description | -Default Value | -
---|---|---|
definition | -- Name attribute: the name of a built-in definition(1) - or the path to a ruby-build definition file. - | -nil |
-
prefix_path | -The path to which the Ruby will be installed. | -nil |
-
user | -
- A user which will own the installed Ruby. The default value of
- nil denotes a system-wide Ruby (root-owned) is being
- targeted. Note: if specified, the user must already exist.
- |
- nil |
-
group | -
- A group which will own the installed Ruby. The default value of
- nil denotes a system-wide Ruby (root-owned) is being
- targeted. Note: if specified, the group must already exist.
- |
- nil |
-
environment | -
- A Hash of additional environment variables(2), such as
- CONFIGURE_OPTS or RUBY_BUILD_MIRROR_URL .
- |
- nil |
-