Pulsar

Manage your Capistrano deployments with ease

View the Project on GitHub nebulab/pulsar

Gem Version Build Status Coverage Status Code Climate

The easy Capistrano deploy and configuration manager.

Pulsar allows you to run capistrano tasks via a separate repository where all your deploy configurations are stored. Once you have your own repository, you can gradully add configurations and recipes so that you never have to duplicate code again.

The way Pulsar works means that you can deploy without actually having the application on your local machine (and neither have all your application dependencies installed). This lets you integrate Pulsar with nearly any deploy strategy you can think of.

Some of the benefits of using Pulsar:

Installation

The most useful way of installing Pulsar is as a system gem:

$ gem install pulsar

This will install two commands: pulsar and pulsar-utils. The first command is required to run capistrano, the other is for everything else.


You'll need to create your own configuration repo:

$ pulsar-utils init ~/Desktop/pulsar-conf

This will create a basic start point for building your configuration repository. As soon as you're done configuring you should consider storing this folder as an actual git repository.

Here it is possible to see how this configuration repository will look like: Pulsar Conf Demo

NOTE: Pulsar only supports git and *nix systems.

Configuration

This is an example repository configuration layout:

pulsar-conf/
  |── Gemfile
  ├── Gemfile.lock
  ├── apps
  │   ├── base.rb
  │   └── my_application
  │       ├── defaults.rb
  │       ├── production.rb
  │       ├── recipes
  │       │   └── custom_recipe.rb
  │       └── staging.rb
  └── recipes
      ├── generic
      │   ├── cleanup.rb
      │   ├── maintenance_mode.rb
      │   ├── notify.rb
      │   └── rake.rb
      ├── rails
      │   ├── passenger.rb
      │   ├── repair_permissions.rb
      │   ├── symlink_configs.rb
      │   ├── unicorn.rb
      │   └── whenever.rb
      └── spree_1
          └── symlink_assets.rb

Pulsar uses these files to build capistrano configurations on the fly, depending on how you invoke the pulsar command. Since Pulsar it's basically a capistrano wrapper, the content of these files is plain old capistrano syntax.

apps directory

This directory contains your application configurations. You'll have one directory per application.

recipes directory

This directory contains your recipes. You can create any number of directories to organize your recipes. To load a recipe from your configurations you can use the load_recipes helper:

#
# Somewhere inside apps/
#
load_recipes do
  rails :repair_permissions, :unicorn
  generic :cleanup, :rake
end

This will use capistrano's load method to include recipes from rails/ and generic/.


Another way to include your recipes is by using the Gemfile. Many gems already include custom recipes for capistrano so you just need to require those. An example with Whenever:

#
# Inside Gemfile
#
gem 'whenever'

#
# Inside recipes/rails/whenever.rb
#
require 'whenever/capistrano'

set :whenever_command, "bundle exec whenever"

#
# Somewhere inside apps/
#
load_recipes do
  rails :whenever
end

You can specify some recipes to be loaded only when you run Pulsar from inside a Rack application directory. This is useful with recipes that require something inside that directory (like retrieving the database/assets from a staging environment).

You can do that like this:

#
# Somewhere inside apps/
#

#
# These recipes will be available only if you're running
# Pulsar inside a Rack application (like Rails) directory
#
load_recipes(app_only: true) do
  rails :assets_pull, :database_pull
end

Loading the repository

Once the repository is ready, you'll need to tell Pulsar where it is. The repository location can be specified either as a full git path or a github repository path (gh-user/pulsar-conf).

Since Pulsar requires the repository for everything, there are multiple ways to store this information so that you don't have to type it everytime. You can also use local repository, which is useful while developing your deployment.

You have three possibilities:

The fastest way is probably the .pulsar hidden file inside your home directory:

#
# Inside ~/.pulsar
#
PULSAR_CONF_REPO="gh-user/pulsar-conf"

#
# You can use local repository for development so you don't need to push changes every time
#
# PULSAR_CONF_REPO="/full/path/to/repository"

#
# Also supported
#
# PULSAR_CONF_REPO="git://github.com/gh-user/pulsar-conf.git"

Pulsar will read this file and set the environment variables properly.


If you don't want to add another file to your home directory you can export the variables yourself:

#
# Inside ~/.bash_profile or ~/.zshrc
#
export PULSAR_CONF_REPO="gh-user/pulsar-conf"

Usage

After the repository is ready, running Pulsar is straightforward. To deploy my_application to production:

$ pulsar my_application production

As a rule of thumb, anything that's added at the end of the command is passed to capistrano. Some examples:

$ pulsar my_application production --tasks

$ pulsar my_application staging deploy:migrations

$ pulsar my_application staging shell

#
# Deploy multiple apps by using commas
#
$ pulsar my_app1,my_app2,my_app3 production

Running inside a Rack application (e.g. Ruby on Rails application)

In case you frequently work from a Rack application and would like a workflow similar to that of capistrano, Pulsar supports running from inside a Rack application directory. If you use this a lot, you should consider installing Pulsar via the application Gemfile.

When deploying from inside a Rack application you can omit the application name:

$ cd /path/to/my_application

$ pulsar production

$ pulsar staging deploy:migrations

If you need a particular configuration for an application you can store a .pulsar file inside the application directory:

#
# Inside /path/to/my_application/.pulsar
#
PULSAR_CONF_REPO="gh-user/pulsar-conf"

#
# If the application directory name is different than what
# you configured inside the Pulsar configuration repository
#
# PULSAR_APP_NAME="my-application"

Integrations

Pulsar is easy to integrate, you just need access to the configurations repository and the ability to run a command.

Hubot

https://gist.github.com/mtylty/5324075

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes with tests (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request