Files
ansible-role-rvm/README.md

119 lines
3.8 KiB
Markdown

## What is rvm1-ansible? [![Build Status](https://secure.travis-ci.org/nickjj/ansible-ruby.png)](http://travis-ci.org/nickjj/ansible-ruby)
It is an [ansible](http://www.ansible.com/home) role to install and manage ruby versions using rvm.
### What problem does it solve and why is it useful?
I wasn't happy with any of the solutions that existed because they required you to either compile ruby on your server or they were not idempotent. Compiling ruby on a low end VPS/instance could easily take 10 minutes and during that time your CPU is going to be pegged at 100%.
ansible-ruby solves this by using rvm to install 1 or more versions of ruby. It makes installing and upgrading ruby versions very easy.
## Role variables
Below is a list of default values along with a description of what they do.
```
# Which user should own all of rvm's files?
rvm1_user: '{{ ansible_ssh_user }}'
# Which group should rvm be installed to?
rvm1_group: 'rvm'
# Install 1 or more versions of ruby, just add them to the list.
# The last version listed will be set as the default ruby.
# Change it to `ruby_rubies:` if you want no rubies installed.
rvm1_rubies:
- 'ruby-2.1.2'
# Where should the rvm-installer and other temp files be downloaded to?
rvm1_temp_download_path: '/usr/local/src'
# Where should rvm be installed to?
rvm1_install_path: '/usr/local/rvm'
# Which url or local path contains the rvm-installer script?
# If you use a url, it must include http:// or https:// at the start.
rvm1_rvm_latest_installer: 'https://raw.githubusercontent.com/wayneeseguin/rvm/master/binscripts/rvm-installer'
# Which url or value contains the stable version number of rvm?
# If you use a url, it must include http:// or https:// at the start.
# If you use a value, it should be something like 1.25.27 or any legal version number.
# If you want to lock rvm to a specific version you could enter in the version number
# that you have installed and the role would assume you always have the latest stable version.
rvm1_rvm_stable_version_number: 'https://raw.githubusercontent.com/wayneeseguin/rvm/master/VERSION'
# Force upgrade the rvm-installer to the latest version.
rvm1_rvm_force_upgrade_installer: false
```
## Exposed variables for use in other roles
You will likely want to use various ruby related commands in other roles. This role exposes a number of popular paths and variables for easy access.
- `rvm1_default_ruby_version`
- The default ruby version that is selected
- `rvm1`
- The path to the rvm binary
- `rvm1_default_wrappers`:
- The path containing all of the wrapped ruby related binaries
- `rvm1_ruby`
- The path to the ruby binary
- `rvm1_gem`
- The path to the gem binary
- `rvm1_bundle`
- The path to the bundle binary
- `rvm1_rake`
- The path to the rake binary with bundle exec already applied
### Example
If you wanted to run a database migration in rails you would use `{{ rvm1_rake }} db:migrate`.
## Example playbook
For the sake of this example let's assume you have a group called **app** and you have a typical `site.yml` file.
To use this role edit your `site.yml` file to look something like this:
```
---
- name: ensure app servers are configured
- hosts: app
roles:
- { role: nickjj.ruby, tags: ruby }
```
Let's say you want to edit a few values, you can do this by opening or creating `group_vars/app.yml` which is located relative to your `inventory` directory and then making it look something like this:
```
---
rvm1_rubies:
- 'ruby-2.1.0'
- 'ruby-2.1.2'
rvm1_rvm_stable_version_number: 1.25.26
```
## Installation
`$ ansible-galaxy install rvm_io.rvm1-ruby`
## Requirements
Tested on ubuntu 12.04 LTS but it should work on other versions that are similar.
## Ansible galaxy
You can find it on the official [ansible galaxy](https://galaxy.ansible.com/list#/roles/796) if you want to rate it.
## License
MIT