-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating the test playbook and the readme
- Loading branch information
Matthew Finlayson
committed
Sep 19, 2014
1 parent
46f5bc7
commit 82d821b
Showing
2 changed files
with
70 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,92 @@ | ||
Role Name | ||
Ansible Thumbor | ||
========= | ||
|
||
A brief description of the role goes here. | ||
`thumbor` is an [ansible](http://www.ansible.com) role which: | ||
|
||
Requirements | ||
* installs nginx | ||
* installs thumbor | ||
* configures thumbor | ||
* starts both as services | ||
|
||
Installation | ||
------------ | ||
|
||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. | ||
Using `ansible-galaxy`: | ||
|
||
``` | ||
$ ansible-galaxy install savagegus.thumbor | ||
``` | ||
|
||
Using `git`: | ||
|
||
``` | ||
$ git clone https://github.com/jivesoftware/ansible-thumbor.git | ||
``` | ||
|
||
Role Variables | ||
-------------- | ||
|
||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. | ||
``` | ||
thumbor_aws_access_key: '' | ||
thumbor_aws_secret_key: '' | ||
thumbor_aws_loader_bucket: '' | ||
thumbor_aws_version: a0c4bcc02601af317072adab32ce0be14d0cd492 | ||
thumbor_server_name: localhost | ||
thumbor_user: thumbor | ||
thumbor_group: thumbor | ||
thumbor_home: /home/thumbor | ||
thumbor_config_file: /etc/thumbor.conf | ||
thumbor_key_file: /etc/thumbor.key | ||
thumbor_log_file: /var/log/thumbor | ||
thumbor_working_directory: /var/lib/thumbor | ||
thumbor_default: /etc/default/thumbor | ||
thumbor_server_name: localhost | ||
thumbor_bind_address: 127.0.0.1 | ||
thumbor_loader: thumbor_aws.loaders.s3_loader | ||
``` | ||
|
||
Dependencies | ||
------------ | ||
|
||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. | ||
franklinkim.nginx | ||
|
||
Example Playbook | ||
---------------- | ||
|
||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: | ||
``` | ||
- hosts: all | ||
roles: | ||
- ansible-thumbor | ||
vars: | ||
nginx_remove_default: yes | ||
nginx_worker_processes: 1 | ||
nginx_worker_connections: 1024 | ||
thumbor_aws_access_key: XXX | ||
thumbor_aws_secret_key: XXX | ||
thumbor_aws_loader_bucket: XXX | ||
``` | ||
|
||
- hosts: servers | ||
roles: | ||
- { role: username.rolename, x: 42 } | ||
Testing | ||
_______ | ||
|
||
License | ||
------- | ||
``` | ||
$ git clone https://github.com/jivesoftware/ansible-thumbor.git | ||
$ cd ansible-thumbor | ||
$ vagrant up | ||
``` | ||
|
||
Contributing | ||
____________ | ||
|
||
BSD | ||
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests and examples for any new or changed functionality. | ||
|
||
Author Information | ||
------------------ | ||
1. Fork it | ||
2. Create your feature branch (`git checkout -b my-new-feature`) | ||
3. Commit your changes (`git commit -am 'Add some feature'`) | ||
4. Push to the branch (`git push origin my-new-feature`) | ||
5. Create new Pull Request | ||
|
||
License | ||
_______ | ||
|
||
An optional section for the role authors to include contact information, or a website (HTML is not allowed). | ||
Copyright (c) Jive Software under the Apache license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,4 @@ | ||
--- | ||
|
||
- hosts: all | ||
roles: | ||
- ansible-thumbor | ||
|