https://github.com/trinitronx/ansible-role-wemux
Ansible role for installing wemux
https://github.com/trinitronx/ansible-role-wemux
Last synced: over 1 year ago
JSON representation
Ansible role for installing wemux
- Host: GitHub
- URL: https://github.com/trinitronx/ansible-role-wemux
- Owner: trinitronx
- Created: 2014-09-06T01:09:05.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2018-02-03T20:15:22.000Z (over 8 years ago)
- Last Synced: 2025-01-10T07:47:33.500Z (over 1 year ago)
- Language: Ruby
- Size: 34.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
wemux
=====
[](https://travis-ci.org/trinitronx/ansible-role-wemux)
[](https://galaxy.ansible.com/trinitronx/wemux/)
[](https://galaxy.ansible.com/trinitronx/wemux/)
Installs and configures [wemux][1] on a host.
Requirements
------------
This role depends on the [git][2] role by geerlingguy.
Role Variables
--------------
The default role variables in `defaults/main.yml` are:
---
# defaults file for wemux
wemux:
install_prefix: /usr/local
host_list: root
Dependencies
------------
- [geerlingguy.git][2]
- [trinitronx.tmux][8]
You may need to add this to your `Ansiblefile`:
#!/usr/bin/env ruby
#^syntax detection
site "https://galaxy.ansible.com/api/v1"
role "geerlingguy.git"
#role "geerlingguy.git" github: "geerlingguy/ansible-role-git"
Example Playbook
----------------
To run this playbook with default settings, create a basic playbook like this:
---
# This playbook deploys the wemux role for testing
- hosts: wemux-servers
user: root
roles:
- wemux
To change the default `host_list` setting in the `wemux.conf` file, or to change the `install_prefix` path:
- hosts: servers
roles:
- { role: trinitronx.wemux, wemux: { install_prefix: /opt/, host_list: [ root, foo, myuser ] } }
License
-------
MIT
Testing
-------
This role uses [`test-kitchen`][3] for integration testing!
To start out, you'll need to install `test-kitchen`. The way I recommend to do this is to install [ChefDK][4]
which bundles `test-kitchen` along with an embedded version of ruby in a known working set of gems. You may
also decide to install ruby and `test-kitchen` on your own in which case you should use bundler.
Install via Bundler
-------------------
Make sure you have a working Ruby and put
gem 'test-kitchen'
gem 'kitchen-vagrant'
gem 'kitchen-sync'
gem 'librarian-ansible'
gem 'kitchen-docker'
gem 'kitchen-ansible', :git => 'git://github.com/trinitronx/kitchen-ansible.git'
in your Gemfile. Then run `bundle install`
To run integration tests: `kitchen test`
Install via ChefDK
------------------
1. Download [ChefDK][4]
2. Install `kitchen-ansible` gem
`eval $(/opt/chefdk/bin/chef shell-init $(basename $SHELL)); sudo /opt/chefdk/embedded/bin/gem install kitchen-ansible; sudo /opt/chefdk/embedded/bin/gem librarian-ansible kitchen-docker kitchen-sync`
3. Checkout this role: `git clone https://github.com/trinitronx/ansible-role-wemux.git trinitronx.wemux && cd trinitronx.wemux`
4. Run Test Kitchen: `/opt/chefdk/bin/kitchen test` (Alternatively, with `kitchen-docker` driver: `KITCHEN_YAML=.kitchen.docker.local.yml kitchen test`)
Still Need Help?
----------------
Try checking out my other [ansible-tdd example repo][6]
Author Information
------------------
Original wemux tasks adapted from [Jon Doveston's ide role][7]
(c) 2014 Jon Doveston @hatoshi
(c) 2014-2018 James Cuzella @trinitronx
[1]: https://github.com/zolrath/wemux
[2]: https://github.com/geerlingguy/ansible-role-git
[3]: https://github.com/test-kitchen/test-kitchen
[4]: https://downloads.getchef.com/chef-dk
[5]: https://github.com/trinitronx/kitchen-ansible
[6]: https://github.com/trinitronx/ansible-tdd
[7]: https://github.com/hatoishi/ansible-dev/blob/master/ide/tasks/wemux.yml
[8]: https://github.com/trinitronx/ansible-role-tmux