NOTICE: we are on the early stages. ;)
Capistrano Deploy Recipes
Just a bunch of useful Capistrano V3 deploy recipes.
The need
We wanted a better way to deploy our apps into a blank VPS or server and we would be so happy if all the dependencies (ruby, unicorn, nginx, postgres and so on) get installed by Capistrano.
To make the stack deploy easier we can use a base image for the machines (which, by the way, we do have) or use tools like Puppet and Chef or services like configr. Those options are great and will fit for many situations, but (there is always a but)...
But sometimes wouldn't it be lovely if a simple cap production deploy
solve it all?
Watching RailsCast episode 337, Ryan Bates showed a simple way to achieve that.
Googling around we found some gems that seems to do that, but they dont have recipes to install the dependencies as we want.
Installation
group :development do
gem 'capistrano'
gem 'capistrano-deploy-recipes', github: 'mcorp/capistrano-deploy-recipes'
end
Usage
Add on your Capfile
file the recipes you want to use
require 'recipes/ruby'
require 'recipes/nodejs'
require 'recipes/nginx'
require 'recipes/postgres'
Those requires must go inside
Capfile
and not ondeploy.rb
Then on the shell just call
cap production recipes:install recipes:setup
It will install all the selected packages and then run extra configurations when needed on the setup phase.
You can also see and invoke just the tasks you want using cap -T
.
Some tasks have also other features like nginx
which have this options:
cap nginx:install # Install the latest stable release of nginx
cap nginx:restart # Restart nginx
cap nginx:setup # Setup nginx configuration for this application
cap nginx:start # Start nginx
cap nginx:stop # Stop nginx
Known issues
- no automated tests
- know to work on Ubuntu 12.04 LTS
- lots of outputs when running
- lack of (good) documentation
- don't allow user to select versions
- don't allow user to use its own templates
- don't generate templates to be modified
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
License
Copyright (c) 2014 mcorp.io
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.