Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brianshumate/ansible-jepsen
:telephone_receiver: Ansible role for Jepsen
https://github.com/brianshumate/ansible-jepsen
Last synced: 8 days ago
JSON representation
:telephone_receiver: Ansible role for Jepsen
- Host: GitHub
- URL: https://github.com/brianshumate/ansible-jepsen
- Owner: brianshumate
- License: bsd-2-clause
- Created: 2015-04-29T04:54:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-07-02T22:43:43.000Z (over 9 years ago)
- Last Synced: 2023-03-11T01:05:41.385Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 186 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
```
_
| |
| |
| |
_________|_|
| |
| (|||) |
| _________ |
|| ||
|| ||
||_________||
| |
|[1] [2] [3]| _
| | | | ___ _ __ ___ ___ _ __
|[4] [5] [6]| _ | |/ _ \ '_ \/ __|/ _ \ '_ \
| | | |_| | __/ |_) \__ \ __/ | | |
|[7] [8] [9]| \___/ \___| .__/|___/\___|_| |_|
| | |_|
| [0] |
| |
| (|||) |
|___________|CA15
```
This role prepares a cluster for testing various databases with
[Jepsen](https://github.com/aphyr/jepsen).
Be sure to read all of the great work Kyle Kingsbury has done with Jepsen
in his series of [Call me maybe posts](https://aphyr.com/tags/Jepsen). Also,
have a look at his related presentations to get a better idea of what Jepsen
is all about:
* [Call Me Maybe: Carly Rae Jepsen and the Perils of Network Partitions](https://www.youtube.com/watch?v=mxdpqr-loyA)
* [Jepsen II: Linearizable Boogaloo](https://www.youtube.com/watch?v=QdkS6ZjeR7Q)
* [Jepsen: ZK, NuoDB, Kafka, & Cassandra](https://www.youtube.com/watch?v=NsI51Mo6r3o)
## Requirements
This role is dependent on the Oracle Java JDK; you will need to manually
download the JDK package and specify its file name as the
`jepsen_java_tarball` variable in `defaults/main.yml`.
Then, place the actual
tarball into the `files` subdirectory of this role.
For example in `defaults/main.yml`:
```
jepsen_java_tarball: jdk-8u45-linux-x64.tar.gz
```
and the contents of the `files` directory:
```
ls -1 files
jdk-8u45-linux-x64.tar.gz
```
## Role Variables
The default variables for this project in `defaults/main.yml` are as follows:
| Name | Default | Description |
| ------------------------------------ | -------- | ---------------------------------------------- |
| jepsen_user | vagrant | OS username |
| jepsen_group | vagrant | OS groupname |
| jepsen_user_home | /home/vagrant | OS user home directory |
| jepsen_test_node_os_packages | list | OS packages to install for the test nodes |
| jepsen_java_tarball | jdk-8u45-linux-x64.tar.gz | Filename for the Oracle Java binary tarball |
| jepsen_java_package | oracle-j2sdk1.8_1.8.0+update45_amd64.deb | Filename for Debian package created from jepsen_java_tarball |
| jepsen_lein_script_url | https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein | URL to the Leiningen script |
|jepsen_lein_script_shasum | SHA 256 summary | The SHA 256 summary for Leiningen script |
## Role Dependencies
None
## Examples
What you'll find in the `examples` directory:
* `Vagrantfile` example Vagrantfile for 6 1GB RAM nodes; with
1 controller node and 5 test nodes
* `bin` directory
* `preinstall` convenience script to add hosts entries to `/etc/hosts`
and install the `vagrant-hosts` plugin
* `debian` The default hosts inventory file
* `jepsen_init.yml` example playbook containing all Jepsen related tasks
The example playbook, `jespsen_init.yml` can be executed like this against
any 6 arbitrary hosts running Debian 8:
```
ansible-playbook -i $HOSTS jepsen_init.yml
```
where `$HOSTS` represents the filename of your hosts inventory file.
## Quick Start with Vagrant
Add the hosts to `/etc/hosts` on the system from which you will execute
this role:
```
192.168.122.10 n0.local n0
192.168.122.11 n1.local n1
192.168.122.12 n2.local n2
192.168.122.13 n3.local n3
192.168.122.14 n4.local n4
192.168.122.15 n5.local n5
```
There is an included convenience script, `bin/preinstall.sh` which will
add the hosts and install the vagrant-hosts plugin for you.
Define your Ansible roles path (for convenience in the following steps):
```
export ROLESPATH=FULL_PATH_TO_ANSIBLE_ROLES
```
Install the playbook:
```
ansible-galaxy install brianshumate.jepsen
```
Then, copy your Java tarball to `$ROLESPATH/files` directory as described in
the **Requirements** section; don't forget to update the `jepsen_java_tarball`
and `jepsen_java_package` variables in `defaults/main.yml` as well.
If you did not use `bin/preinstall.sh`, ensure that you have installed the
vagrant-hosts plugin:
```
vagrant plugin install vagrant-hosts
```
Fire up Vagrant and kick off the playbook:
```
cd $ROLESPATH/examples
vagrant up
```
SSH into the control node and try a Jespsen test:
```
vagrant ssh n0
cd jepsen/$DATABASE
lein test
```
Pick your poison; substitute `$DATABASE` in the above example for one to run
Jepsen against as listed in the `jepsen` project directory:
* aerospike
* elasticsearch
* mongodb
### A Wee Spot of Ramshackle Troubleshooting
#### "Help, I'm using VirtualBox, seeing SSH timeouts, and the playbook fails!"
Re-run the playbook based on Ansible's `--limit` suggestion in the error
output while shaking your fist at VirtualBox and adjusting the onion
on your belt. For example:
```
ansible-playbook -i debian --limit @$HOME/jepsen_init.retry jepsen_init.yml
```
#### Help, I ran `lein test` and got this error: `com.jcraft.jsch.JSchException: reject HostKey: n1`
Probably your test node host keys are not in `known_hosts` on the controller
node even though that should have been done for you by the playbook; run
`~/bin/ssh_host_keys.sh` on the controller node to manually add them.
#### Ouch, I ran `lein test` and got this error: Could not find artifact some_clojure_jar_from_clojars in clojars (https://clojars.org/repo/) This could be due to a typo in :dependencies or network issues. If you are behind a proxy, try setting the 'http_proxy' environment variable. Tests failed.**
This can happen on overwhelmed VirtualBoxes with constrained resources, such
as when running this project on a little MacBook Pro with only 8GB of RAM.
Run `lein test` again to finish downloading the dependencies and think of an
excuse to get a speedier machine with 16GB of RAM and pray to the VirtualBox
globs or run this project on some decent virtual machines. ;)
**NOTE**: If the test fails on the same JAR each time, then it could be
possible that the JAR actually has not yet been pushed to Clojars.
## License
BSD
## Thanks
Thanks to the following people:
- [Kyle Kingsbury](https://aphyr.com/) ([@aphyr](https://github.com/aphyr))
for creating Jepsen and for all of the hard work he does in validating
database software with it
- [Brent Woodruff](http://www.brentwoodruff.com/) for his help with various
tips while I was making this role
## Author Information
[Brian Shumate](http://brianshumate.com)