supporting_cast 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in supporting_cast.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ross Kaffenberger
+
+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
+NONINFRINGEMENT. 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.

data/README.md

@@ -0,0 +1,47 @@
+# SupportingCast
+
+Opinionated generators for common Rails backing services, e.g. Redis, nginx, sidekiq, nginx, i.e., the supporting cast.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'supporting_cast', :group => :development
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install supporting_cast
+
+## Usage
+
+    $ rails g supporting_cast:config          # Bootstrap the whole supporting cast
+
+    $ rails g supporting_cast:<name>_config   # Generate config for given cast member
+
+## Configurations
+
+SupportingCast is intended to make it easier to get backing services up and running for Rails local (development and test) environments. A guiding principle, largely inspired by the [12 Factor App](http://www.12factor.net/), is to minimize divergence between local and production environments.
+
+### Redis
+
+As Francis Hwang said in his post, [Testing Rails Against a Running Redis Instance](http://fhwang.net/2010/09/23/Testing-Rails-against-a-running-Redis-instance-and-doing-it-with-Hydra-to-boot):
+
+> If your Rails app uses Redis, there are basically three approaches you can take for when the code under test hits Redis.
+>
+> 1. Mock Redis
+> 2. Stub Redis
+> 3. Stop messing around and just use Redis
+
+SupportingCast will generate configurations for running separate Redis instances for development and test. Paired with the foreman configuration, it's dead simple to start/stop multiple Redis instances for local environments. You could [use Redis namespaces to separate environments](http://dev.af83.com/2012/07/31/should-we-namespace-redis.html), but why mess around?
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/supporting_cast/config_generator.rb

@@ -0,0 +1,19 @@
+module SupportingCast
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc "Generate configuration files for development and test"
+
+      def generate_config_files
+        Rails::Generators.invoke "supporting_cast:redis_config" if yes?("Configure redis? [yn]")
+        Rails::Generators.invoke "supporting_cast:database_config" if yes?("Configure database.yml? [yn]")
+        Rails::Generators.invoke "supporting_cast:elasticsearch_config" if yes?("Configure elasticsearch? [yn]")
+        Rails::Generators.invoke "supporting_cast:sunspot_config" if yes?("Configure sunspot? [yn]")
+        Rails::Generators.invoke "supporting_cast:foreman_config" if yes?("Add Procfile for foreman? [yn]")
+        Rails::Generators.invoke "supporting_cast:nginx_config" if yes?("Configure nginx? [yn]")
+        Rails::Generators.invoke "supporting_cast:unicorn_config" if yes?("Configure unicorn? [yn]")
+        Rails::Generators.invoke "supporting_cast:sidekiq_config" if yes?("Configure sidekiq? [yn]")
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/database_config_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class DatabaseConfigGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+
+      desc "Generate database.yml file from template"
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def database_yml
+        template 'database.yml.erb', "config/database.yml"
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/elasticsearch_config_generator.rb

@@ -0,0 +1,46 @@
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class ElasticsearchConfigGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+
+      desc "Generate elasticsearch.yml and elasticsearch config files for development and test"
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      attr_accessor :env, :port
+
+      def default_port
+        9200
+      end
+
+      def elasticsearch_options
+        {
+          "test" => { hosts: ["127.0.0.1:#{test_port}"] },
+          "development" => { hosts: ["127.0.0.1:#{development_port}"] }
+        }
+      end
+
+      def mkdir_elasticsearch_conf
+        empty_directory "config/elasticsearch"
+      end
+
+      def development_elasticsearch_conf
+        env = 'development'
+        port = development_port
+        template 'elasticsearch_config.yml.erb', "config/elasticsearch/#{env}.conf"
+      end
+
+      def test_elasticsearch_conf
+        env = 'test'
+        port = test_port
+        template 'elasticsearch_config.yml.erb', "config/elasticsearch/#{env}.conf"
+      end
+
+      def redis_yml
+        template 'elasticsearch.yml.erb', "config/elasticsearch.yml"
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/foreman_config_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class ForemanConfigGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      desc "Generate a Procfile for use with foreman"
+
+      def procfile
+        template 'Procfile.erb', "Procfile"
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/generator_helpers.rb

@@ -0,0 +1,23 @@
+module SupportingCast
+  module Generators
+    module GeneratorHelpers
+
+      def application_name
+        ENV['APPLICATION_NAME'] || ::Rails.application.class.name.split('::').first.downcase
+      end
+
+      def rails_root
+        Rails.root
+      end
+
+      def development_port
+        @development_port ||= default_port + 1 + rand(100)
+      end
+
+      def test_port
+        @test_port ||= development_port + 1
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/nginx_config_generator.rb

@@ -0,0 +1,25 @@
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class NginxConfigGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      desc 'Generate nginx configuration for development'
+
+      def mkdir_nginx_conf
+        empty_directory 'config/nginx'
+      end
+
+      def nginx_conf
+        template 'nginx.conf.erb', 'config/nginx/nginx.conf'
+      end
+
+      def ssl_certificate
+        Rails::Generators.invoke "supporting_cast:ssl_certificate" if yes?("Add self-signed ssl ssl_certificate for nginx? [yn]")
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/redis_config_generator.rb

@@ -0,0 +1,39 @@
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class RedisConfigGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+
+      desc "Generate environment-specific redis.yml and redis conf files from template"
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      attr_reader :env, :port
+
+      def default_port
+        6379
+      end
+
+      def mkdir_redis_conf
+        empty_directory "config/redis"
+      end
+
+      def development_redis_conf
+        @env = 'development'
+        @port = development_port
+        template 'redis.conf.erb', "config/redis/#{env}.conf"
+      end
+
+      def test_redis_conf
+        @env = 'test'
+        @port = test_port
+        template 'redis.conf.erb', "config/redis/#{env}.conf"
+      end
+
+      def redis_yml
+        template 'redis.yml.erb', "config/redis.yml"
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/sidekiq_config_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class SidekiqConfigGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+
+      desc "Generate sidekiq.yml file from template"
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def sidekiq_yml
+        template 'sidekiq.yml.erb', "config/sidekiq.yml"
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/ssl_certificate_generator.rb

@@ -0,0 +1,33 @@
+# openssl req -new -nodes -keyout server.key -out server.csr
+
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class SslCertificateGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+
+      desc "Generate ssl certificate files"
+
+      def openssl
+        inside('config/nginx') do
+          run('rm server.key server.csr server.crt')
+
+          # generate private key and certificate signing request
+          run('openssl req -new -nodes -keyout server.key -out server.csr')
+
+          # generate certificate
+          run('openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt')
+        end
+      end
+
+      def own
+        inside('config/nginx') do
+          run('chmod 400 *.key *.crt')
+          run('sudo chown root *.key *.crt')
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/sunspot_config_generator.rb

@@ -0,0 +1,23 @@
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class SunspotConfigGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+
+      desc "Generate sunspot.yml and sunspot config files for development and test"
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      attr_accessor :env, :port
+
+      def default_port
+        8988
+      end
+
+      def sunspot_yml
+        template 'sunspot.yml.erb', "config/sunspot.yml"
+      end
+
+    end
+  end
+end

data/lib/generators/supporting_cast/templates/Procfile.erb

@@ -0,0 +1,24 @@
+# make sure processes run in the foreground
+# thin:         bundle exec thin start -p $PORT
+# unicorn:      nohup bundle exec unicorn -c config/unicorn/unicorn.rb
+# nginx:        sudo /usr/local/sbin/nginx -c <%= rails_root %>/config/nginx/nginx.conf -g "daemon off;"
+# redis_dev:    redis-server ./config/redis/development.conf
+# redis_test:   redis-server ./config/redis/test.conf
+# guard:        bundle exec guard
+# solr:         bundle exec rake sunspot:solr:run
+# elastic_dev:  elasticsearch -f -Des.config=./config/elasticsearch/development.yml
+# elastic_test: elasticsearch -f -Des.config=./config/elasticsearch/test.yml
+# resque:       bundle exec rake resque:work QUEUE=*
+# sidekiq:      bundle exec sidekiq
+
+# Optional but useful
+
+# zeus:         zeus start
+# spork:        bundle exec spork --port 9899
+# spork_challenges:      cd engines/challenges && bundle exec spork --port 9901
+# spork_groups_cucumber: cd engines/groups && bundle exec spork cucumber --port 9902
+# spork_groups_rspec:    cd engines/groups && bundle exec spork rspec --port 9903
+# evergreen:    bundle exec evergreen serve
+# redis-commander --port 8081 --redis-host localhost --redis-port 9464
+# memcache:     /usr/local/bin/memcached -l localhost
+

data/lib/generators/supporting_cast/templates/database.yml.erb

@@ -0,0 +1,11 @@
+development: &default
+  adapter: mysql2
+  database: <%= application_name %>_development
+  username: root
+  pool: 5
+  timeout: 5000
+  reconnect: true
+
+test:
+  <<: *default
+  database: <%= application_name %>_test

data/lib/generators/supporting_cast/templates/elasticsearch.yml.erb

@@ -0,0 +1 @@
+<%= elasticsearch_options.to_yaml %>

data/lib/generators/supporting_cast/templates/elasticsearch_config.yml.erb

@@ -0,0 +1,359 @@
+##################### ElasticSearch Configuration Example #####################
+
+# This file contains an overview of various configuration settings,
+# targeted at operations staff. Application developers should
+# consult the guide at <http://elasticsearch.org/guide>.
+#
+# The installation procedure is covered at
+# <http://elasticsearch.org/guide/reference/setup/installation.html>.
+#
+# ElasticSearch comes with reasonable defaults for most settings,
+# so you can try it out without bothering with configuration.
+#
+# Most of the time, these defaults are just fine for running a production
+# cluster. If you're fine-tuning your cluster, or wondering about the
+# effect of certain configuration option, please _do ask_ on the
+# mailing list or IRC channel [http://elasticsearch.org/community].
+
+# Any element in the configuration can be replaced with environment variables
+# by placing them in ${...} notation. For example:
+#
+# node.rack: ${RACK_ENV_VAR}
+
+# See <http://elasticsearch.org/guide/reference/setup/configuration.html>
+# for information on supported formats and syntax for the configuration file.
+
+
+################################### Cluster ###################################
+
+# Cluster name identifies your cluster for auto-discovery. If you're running
+# multiple clusters on the same network, make sure you're using unique names.
+#
+cluster.name: elasticsearch_<%= application_name %>_<%= env %>
+
+#################################### Node #####################################
+
+# Node names are generated dynamically on startup, so you're relieved
+# from configuring them manually. You can tie this node to a specific name:
+#
+# node.name: "Franz Kafka"
+
+# Every node can be configured to allow or deny being eligible as the master,
+# and to allow or deny to store the data.
+#
+# Allow this node to be eligible as a master node (enabled by default):
+#
+# node.master: true
+#
+# Allow this node to store data (enabled by default):
+#
+# node.data: true
+
+# You can exploit these settings to design advanced cluster topologies.
+#
+# 1. You want this node to never become a master node, only to hold data.
+#    This will be the "workhorse" of your cluster.
+#
+# node.master: false
+# node.data: true
+#
+# 2. You want this node to only serve as a master: to not store any data and
+#    to have free resources. This will be the "coordinator" of your cluster.
+#
+# node.master: true
+# node.data: false
+#
+# 3. You want this node to be neither master nor data node, but
+#    to act as a "search load balancer" (fetching data from nodes,
+#    aggregating results, etc.)
+#
+# node.master: false
+# node.data: false
+
+# Use the Cluster Health API [http://localhost:9200/_cluster/health], the
+# Node Info API [http://localhost:9200/_cluster/nodes] or GUI tools
+# such as <http://github.com/lukas-vlcek/bigdesk> and
+# <http://mobz.github.com/elasticsearch-head> to inspect the cluster state.
+
+# A node can have generic attributes associated with it, which can later be used
+# for customized shard allocation filtering, or allocation awareness. An attribute
+# is a simple key value pair, similar to node.key: value, here is an example:
+#
+# node.rack: rack314
+
+# By default, multiple nodes are allowed to start from the same installation location
+# to disable it, set the following:
+# node.max_local_storage_nodes: 1
+
+
+#################################### Index ####################################
+
+# You can set a number of options (such as shard/replica options, mapping
+# or analyzer definitions, translog settings, ...) for indices globally,
+# in this file.
+#
+# Note, that it makes more sense to configure index settings specifically for
+# a certain index, either when creating it or by using the index templates API.
+#
+# See <http://elasticsearch.org/guide/reference/index-modules/> and
+# <http://elasticsearch.org/guide/reference/api/admin-indices-create-index.html>
+# for more information.
+
+# Set the number of shards (splits) of an index (5 by default):
+#
+# index.number_of_shards: 5
+
+# Set the number of replicas (additional copies) of an index (1 by default):
+#
+# index.number_of_replicas: 1
+
+# Note, that for development on a local machine, with small indices, it usually
+# makes sense to "disable" the distributed features:
+#
+# index.number_of_shards: 1
+# index.number_of_replicas: 0
+
+# These settings directly affect the performance of index and search operations
+# in your cluster. Assuming you have enough machines to hold shards and
+# replicas, the rule of thumb is:
+#
+# 1. Having more *shards* enhances the _indexing_ performance and allows to
+#    _distribute_ a big index across machines.
+# 2. Having more *replicas* enhances the _search_ performance and improves the
+#    cluster _availability_.
+#
+# The "number_of_shards" is a one-time setting for an index.
+#
+# The "number_of_replicas" can be increased or decreased anytime,
+# by using the Index Update Settings API.
+#
+# ElasticSearch takes care about load balancing, relocating, gathering the
+# results from nodes, etc. Experiment with different settings to fine-tune
+# your setup.
+
+# Use the Index Status API (<http://localhost:9200/A/_status>) to inspect
+# the index status.
+
+
+#################################### Paths ####################################
+
+# Path to directory containing configuration (this file and logging.yml):
+#
+# path.conf: /path/to/conf
+
+# Path to directory where to store index data allocated for this node.
+#
+path.data: /usr/local/var/elasticsearch/
+#
+# Can optionally include more than one location, causing data to be striped across
+# the locations (à la RAID 0) on a file level, favouring locations with most free
+# space on creation. For example:
+#
+path.data: /usr/local/var/elasticsearch/
+
+# Path to temporary files:
+#
+# path.work: /path/to/work
+
+# Path to log files:
+#
+path.logs: /usr/local/var/log/elasticsearch/
+
+# Path to where plugins are installed:
+#
+# path.plugins: /path/to/plugins
+
+
+#################################### Plugin ###################################
+
+# If a plugin listed here is not installed for current node, the node will not start.
+#
+# plugin.mandatory: mapper-attachments,lang-groovy
+
+
+################################### Memory ####################################
+
+# ElasticSearch performs poorly when JVM starts swapping: you should ensure that
+# it _never_ swaps.
+#
+# Set this property to true to lock the memory:
+#
+# bootstrap.mlockall: true
+
+# Make sure that the ES_MIN_MEM and ES_MAX_MEM environment variables are set
+# to the same value, and that the machine has enough memory to allocate
+# for ElasticSearch, leaving enough memory for the operating system itself.
+#
+# You should also make sure that the ElasticSearch process is allowed to lock
+# the memory, eg. by using `ulimit -l unlimited`.
+
+
+############################## Network And HTTP ###############################
+
+# ElasticSearch, by default, binds itself to the 0.0.0.0 address, and listens
+# on port [9200-9300] for HTTP traffic and on port [9300-9400] for node-to-node
+# communication. (the range means that if the port is busy, it will automatically
+# try the next port).
+
+# Set the bind address specifically (IPv4 or IPv6):
+#
+# network.bind_host: 192.168.0.1
+
+# Set the address other nodes will use to communicate with this node. If not
+# set, it is automatically derived. It must point to an actual IP address.
+#
+# network.publish_host: 192.168.0.1
+
+# Set both 'bind_host' and 'publish_host':
+#
+network.host: localhost
+
+# Set a custom port for the node to node communication (9300 by default):
+#
+# transport.tcp.port: 9300
+
+# Enable compression for all communication between nodes (disabled by default):
+#
+# transport.tcp.compress: true
+
+# Set a custom port to listen for HTTP traffic:
+#
+http.port: <%= port %>
+
+# Set a custom allowed content length:
+#
+# http.max_content_length: 100mb
+
+# Disable HTTP completely:
+#
+# http.enabled: false
+
+
+################################### Gateway ###################################
+
+# The gateway allows for persisting the cluster state between full cluster
+# restarts. Every change to the state (such as adding an index) will be stored
+# in the gateway, and when the cluster starts up for the first time,
+# it will read its state from the gateway.
+
+# There are several types of gateway implementations. For more information,
+# see <http://elasticsearch.org/guide/reference/modules/gateway>.
+
+# The default gateway type is the "local" gateway (recommended):
+#
+# gateway.type: local
+
+# Settings below control how and when to start the initial recovery process on
+# a full cluster restart (to reuse as much local data as possible when using shared
+# gateway).
+
+# Allow recovery process after N nodes in a cluster are up:
+#
+# gateway.recover_after_nodes: 1
+
+# Set the timeout to initiate the recovery process, once the N nodes
+# from previous setting are up (accepts time value):
+#
+# gateway.recover_after_time: 5m
+
+# Set how many nodes are expected in this cluster. Once these N nodes
+# are up (and recover_after_nodes is met), begin recovery process immediately
+# (without waiting for recover_after_time to expire):
+#
+# gateway.expected_nodes: 2
+
+
+############################# Recovery Throttling #############################
+
+# These settings allow to control the process of shards allocation between
+# nodes during initial recovery, replica allocation, rebalancing,
+# or when adding and removing nodes.
+
+# Set the number of concurrent recoveries happening on a node:
+#
+# 1. During the initial recovery
+#
+# cluster.routing.allocation.node_initial_primaries_recoveries: 4
+#
+# 2. During adding/removing nodes, rebalancing, etc
+#
+# cluster.routing.allocation.node_concurrent_recoveries: 2
+
+# Set to throttle throughput when recovering (eg. 100mb, by default unlimited):
+#
+# indices.recovery.max_size_per_sec: 0
+
+# Set to limit the number of open concurrent streams when
+# recovering a shard from a peer:
+#
+# indices.recovery.concurrent_streams: 5
+
+
+################################## Discovery ##################################
+
+# Discovery infrastructure ensures nodes can be found within a cluster
+# and master node is elected. Multicast discovery is the default.
+
+# Set to ensure a node sees N other master eligible nodes to be considered
+# operational within the cluster. Set this option to a higher value (2-4)
+# for large clusters (>3 nodes):
+#
+# discovery.zen.minimum_master_nodes: 1
+
+# Set the time to wait for ping responses from other nodes when discovering.
+# Set this option to a higher value on a slow or congested network
+# to minimize discovery failures:
+#
+# discovery.zen.ping.timeout: 3s
+
+# See <http://elasticsearch.org/guide/reference/modules/discovery/zen.html>
+# for more information.
+
+# Unicast discovery allows to explicitly control which nodes will be used
+# to discover the cluster. It can be used when multicast is not present,
+# or to restrict the cluster communication-wise.
+#
+# 1. Disable multicast discovery (enabled by default):
+#
+# discovery.zen.ping.multicast.enabled: false
+#
+# 2. Configure an initial list of master nodes in the cluster
+#    to perform discovery when new nodes (master or data) are started:
+#
+# discovery.zen.ping.unicast.hosts: ["host1", "host2:port", "host3[portX-portY]"]
+
+# EC2 discovery allows to use AWS EC2 API in order to perform discovery.
+#
+# You have to install the cloud-aws plugin for enabling the EC2 discovery.
+#
+# See <http://elasticsearch.org/guide/reference/modules/discovery/ec2.html>
+# for more information.
+#
+# See <http://elasticsearch.org/tutorials/2011/08/22/elasticsearch-on-ec2.html>
+# for a step-by-step tutorial.
+
+
+################################## Slow Log ##################################
+
+# Shard level query and fetch threshold logging.
+
+#index.search.slowlog.level: TRACE
+#index.search.slowlog.threshold.query.warn: 10s
+#index.search.slowlog.threshold.query.info: 5s
+#index.search.slowlog.threshold.query.debug: 2s
+#index.search.slowlog.threshold.query.trace: 500ms
+
+#index.search.slowlog.threshold.fetch.warn: 1s
+#index.search.slowlog.threshold.fetch.info: 800ms
+#index.search.slowlog.threshold.fetch.debug: 500ms
+#index.search.slowlog.threshold.fetch.trace: 200ms
+
+################################## GC Logging ################################
+
+#monitor.jvm.gc.ParNew.warn: 1000ms
+#monitor.jvm.gc.ParNew.info: 700ms
+#monitor.jvm.gc.ParNew.debug: 400ms
+
+#monitor.jvm.gc.ConcurrentMarkSweep.warn: 10s
+#monitor.jvm.gc.ConcurrentMarkSweep.info: 5s
+#monitor.jvm.gc.ConcurrentMarkSweep.debug: 2s

data/lib/generators/supporting_cast/templates/nginx.conf.erb

@@ -0,0 +1,129 @@
+user nobody;
+worker_processes 2;
+pid /var/run/nginx.pid;
+
+error_log  <%= rails_root %>/log/nginx.error.log info;
+
+events {
+    worker_connections  256;
+}
+
+http {
+  default_type  application/octet-stream;
+
+  log_format main '$remote_addr - $remote_user [$time_local] '
+                  '"$request" $status $body_bytes_sent "$http_referer" '
+                  '"$http_user_agent" "$http_x_forwarded_for"';
+
+  access_log  <%= rails_root %>/log/nginx.access.log  main;
+
+  sendfile on;
+
+  keepalive_timeout  65;
+
+  upstream <%= application_name %>_upstream {
+    server 0.0.0.0:5000;
+  }
+
+  upstream <%= application_name %>_upstream_ssl {
+    server 0.0.0.0:5000;
+  }
+
+  server {
+    listen       80;
+    server_name  *.dev;
+
+    root <%= rails_root %>/public;
+
+    access_log <%= rails_root %>/log/<%= application_name %>.access.log main;
+    error_log <%= rails_root %>/log/<%= application_name %>.error.log notice;
+
+    # needed to forward user's IP address to rails
+    proxy_set_header  X-Real-IP         $remote_addr;
+    proxy_set_header  X-Forwarded-For   $proxy_add_x_forwarded_for;
+    proxy_set_header  Host              $http_host;
+    proxy_set_header  X-Forwarded-Proto $scheme;
+
+    proxy_redirect off;
+    proxy_max_temp_file_size 0;
+
+    if (-f $request_filename) {
+      break;
+    }
+
+    location / {
+      client_max_body_size 5M;
+      if (!-f $request_filename) {
+        proxy_pass http://<%= application_name %>_upstream;
+        break;
+      }
+    }
+
+    location ~* \.(eot|ttf|woff|svg)$ {
+      add_header Access-Control-Allow-Origin *;
+      if (!-f $request_filename) {
+        proxy_pass http://<%= application_name %>_upstream;
+        break;
+      }
+    }
+
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   html;
+    }
+  }
+
+  server {
+    listen       443;
+    server_name  *.dev;
+
+    ssl                  on;
+    ssl_certificate      server.crt;
+    ssl_certificate_key  server.key;
+
+    ssl_session_timeout  5m;
+
+    ssl_protocols  SSLv2 SSLv3 TLSv1;
+    ssl_ciphers  HIGH:!aNULL:!MD5;
+    ssl_prefer_server_ciphers   on;
+
+    root <%= rails_root %>/public;
+
+    access_log <%= rails_root %>/log/<%= application_name %>.access.log main;
+    error_log <%= rails_root %>/log/<%= application_name %>.error.log notice;
+
+    # needed to forward user's IP address to rails
+    proxy_set_header  X-Real-IP         $remote_addr;
+    proxy_set_header  X-Forwarded-For   $proxy_add_x_forwarded_for;
+    proxy_set_header  Host              $http_host;
+    proxy_set_header  X-Forwarded-Proto $scheme;
+
+    proxy_redirect off;
+    proxy_max_temp_file_size 0;
+
+    if (-f $request_filename) {
+      break;
+    }
+
+    location / {
+      client_max_body_size 5M;
+      if (!-f $request_filename) {
+        proxy_pass http://<%= application_name %>_upstream_ssl;
+        break;
+      }
+    }
+
+    location ~* \.(eot|ttf|woff|svg)$ {
+      add_header Access-Control-Allow-Origin *;
+      if (!-f $request_filename) {
+        proxy_pass http://<%= application_name %>_upstream_ssl;
+        break;
+      }
+    }
+
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   html;
+    }
+  }
+}

data/lib/generators/supporting_cast/templates/redis.conf.erb

@@ -0,0 +1,13 @@
+# Redis configuration
+daemonize no
+pidfile ./tmp/pids/redis_<%= env %>.pid
+port <%= port %>
+timeout 300
+save 900 1
+save 300 10
+save 60 10000
+dbfilename ./db/<%= env %>.rdb
+loglevel debug
+logfile ./log/redis_<%= env %>.log
+databases 1
+glueoutputbuf yes

data/lib/generators/supporting_cast/templates/redis.yml.erb

@@ -0,0 +1,7 @@
+development:
+  host: localhost
+  port: <%= development_port %>
+
+test:
+  host: localhost
+  port: <%= test_port %>

data/lib/generators/supporting_cast/templates/sidekiq.yml.erb

@@ -0,0 +1,9 @@
+# Options here can still be overridden by cmd line args.
+#   sidekiq -C config/sidekiq.yml
+---
+:verbose: true
+:concurrency:  25
+:queues:
+  - [often, 7]
+  - [default, 5]
+  - [seldom, 3]

data/lib/generators/supporting_cast/templates/sunspot.yml.erb

@@ -0,0 +1,11 @@
+test:
+  solr:
+    hostname: localhost
+    port: <%= test_port %>
+    log_level: WARNING
+
+development:
+  solr:
+    hostname: localhost
+    port: <%= development_port %>
+    log_level: WARNING

data/lib/generators/supporting_cast/templates/unicorn.rb.erb

@@ -0,0 +1,55 @@
+working_directory '<%= rails_root %>'
+worker_processes 1
+listen '<%= rails_root %>/unicorn_<%= application_name %>.sock', :backlog => 1024
+timeout 15
+pid "<%= rails_root %>/log/unicorn_<%= application_name %>.pid"
+
+# Based on http://gist.github.com/206253
+
+logger Logger.new("log/unicorn.log")
+
+# Load the app into the master before forking workers for super-fast worker spawn times
+preload_app true
+
+# some applications/frameworks log to stderr or stdout, so prevent
+# them from going to /dev/null when daemonized here:
+stderr_path "log/unicorn.stderr.log"
+stdout_path "log/unicorn.stdout.log"
+
+# REE - http://www.rubyenterpriseedition.com/faq.html#adapt_apps_for_cow
+if GC.respond_to?(:copy_on_write_friendly=)
+  GC.copy_on_write_friendly = true
+end
+
+before_fork do |server, worker|
+
+  ##
+  # When sent a USR2, Unicorn will suffix its pidfile with .oldbin and
+  # immediately start loading up a new version of itself (loaded with a new
+  # version of our app). When this new Unicorn is completely loaded
+  # it will begin spawning workers. The first worker spawned will check to
+  # see if an .oldbin pidfile exists. If so, this means we've just booted up
+  # a new Unicorn and need to tell the old one that it can now die. To do so
+  # we send it a QUIT.
+  #
+  # Using this method we get 0 downtime deploys.
+  old_pid = "#{server.config[:pid]}.oldbin"
+
+  if File.exists?(old_pid) && server.pid != old_pid
+    begin
+      sig = (worker.nr + 1) >= server.worker_processes ? :TERM : :TTOU
+      Process.kill(sig, File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+      # someone else did our job for us
+    end
+  end
+  sleep 1
+end
+
+after_fork do |server, worker|
+  worker_pid = File.join(File.dirname(server.config[:pid]), "unicorn_worker_<%= application_name %>_#{worker.nr}.pid")
+  File.open(worker_pid, "w") { |f| f.puts Process.pid }
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.establish_connection
+  end
+end

data/lib/generators/supporting_cast/unicorn_config_generator.rb

@@ -0,0 +1,21 @@
+require 'generators/supporting_cast/generator_helpers'
+
+module SupportingCast
+  module Generators
+    class UnicornConfigGenerator < Rails::Generators::Base
+      include GeneratorHelpers
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      desc 'Generate unicorn configuration for development'
+
+      def mkdir_unicorn_conf
+        empty_directory 'config/unicorn'
+      end
+
+      def nginx_conf
+        template 'unicorn.rb.erb', 'config/unicorn/unicorn.rb'
+      end
+
+    end
+  end
+end

data/lib/supporting_cast.rb

@@ -0,0 +1,5 @@
+module SupportingCast
+end
+
+require "supporting_cast/version"
+require 'supporting_cast/railtie' if defined?(Rails)

data/lib/supporting_cast/railtie.rb

@@ -0,0 +1,12 @@
+require 'supporting_cast'
+require 'rails'
+
+module SupportingCast
+  class Railtie < Rails::Railtie
+    railtie_name :supporting_cast
+
+    rake_tasks do
+      load "tasks/supporting_cast.rake"
+    end
+  end
+end

data/lib/supporting_cast/version.rb

@@ -0,0 +1,3 @@
+module SupportingCast
+  VERSION = "0.0.1"
+end

data/lib/tasks/supporting_cast.rake

@@ -0,0 +1,53 @@
+namespace :supporting_cast do
+
+  task :require do
+    require 'rails/generators'
+  end
+
+  desc "Generate redis.yml and redis config files for development and test"
+  task :redis => :require do
+    Rails::Generators.invoke "supporting_cast:redis_config"
+  end
+
+  desc "Generate database.yml for development and test"
+  task :database => :require do
+    Rails::Generators.invoke "supporting_cast:database_config"
+  end
+
+  desc "Generate elasticsearch.yml and elasticsearch config files for development and test"
+  task :elasticsearch => :require do
+    Rails::Generators.invoke "supporting_cast:elasticsearch_config"
+  end
+
+  desc "Generate sunspot.yml and sunspot config files for development and test"
+  task :sunspot => :require do
+    Rails::Generators.invoke "supporting_cast:sunspot_config"
+  end
+
+  desc "Generate a Procfile for use with foreman"
+  task :foreman => :require do
+    Rails::Generators.invoke "supporting_cast:foreman_config"
+  end
+
+  desc "Generate nginx configuration for development"
+  task :nginx => :require do
+    Rails::Generators.invoke "supporting_cast:nginx_config"
+  end
+
+  desc "Generate unicorn configuration for development"
+  task :unicorn => :require do
+    Rails::Generators.invoke "supporting_cast:unicorn_config"
+  end
+
+  desc "Generate sidekiq configuration for development"
+  task :sidekiq => :require do
+    Rails::Generators.invoke "supporting_cast:sidekiq_config"
+  end
+
+  task :default => :require do
+    Rails::Generators.invoke "supporting_cast:config"
+  end
+end
+
+desc "Bootstrap all supporting_cast configuration files"
+task :supporting_cast => "supporting_cast:default"

data/supporting_cast.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'supporting_cast/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "supporting_cast"
+  gem.version       = SupportingCast::VERSION
+  gem.authors       = ["Ross Kaffenberger"]
+  gem.email         = ["rosskaff@gmail.com"]
+  gem.description   = "Opinionated generators for common Rails supporting cast services, or 'supporting_casts'"
+  gem.summary       = "Opinionated generators for common Rails supporting cast services, or 'supporting_casts'"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: supporting_cast
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ross Kaffenberger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-16 00:00:00.000000000 Z
+dependencies: []
+description: Opinionated generators for common Rails supporting cast services, or
+  'supporting_casts'
+email:
+- rosskaff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/supporting_cast/config_generator.rb
+- lib/generators/supporting_cast/database_config_generator.rb
+- lib/generators/supporting_cast/elasticsearch_config_generator.rb
+- lib/generators/supporting_cast/foreman_config_generator.rb
+- lib/generators/supporting_cast/generator_helpers.rb
+- lib/generators/supporting_cast/nginx_config_generator.rb
+- lib/generators/supporting_cast/redis_config_generator.rb
+- lib/generators/supporting_cast/sidekiq_config_generator.rb
+- lib/generators/supporting_cast/ssl_certificate_generator.rb
+- lib/generators/supporting_cast/sunspot_config_generator.rb
+- lib/generators/supporting_cast/templates/Procfile.erb
+- lib/generators/supporting_cast/templates/database.yml.erb
+- lib/generators/supporting_cast/templates/elasticsearch.yml.erb
+- lib/generators/supporting_cast/templates/elasticsearch_config.yml.erb
+- lib/generators/supporting_cast/templates/nginx.conf.erb
+- lib/generators/supporting_cast/templates/redis.conf.erb
+- lib/generators/supporting_cast/templates/redis.yml.erb
+- lib/generators/supporting_cast/templates/sidekiq.yml.erb
+- lib/generators/supporting_cast/templates/sunspot.yml.erb
+- lib/generators/supporting_cast/templates/unicorn.rb.erb
+- lib/generators/supporting_cast/unicorn_config_generator.rb
+- lib/supporting_cast.rb
+- lib/supporting_cast/railtie.rb
+- lib/supporting_cast/version.rb
+- lib/tasks/supporting_cast.rake
+- supporting_cast.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Opinionated generators for common Rails supporting cast services, or 'supporting_casts'
+test_files: []
+has_rdoc: