capistrano-memcached 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08c7994a3efaa51855d4ef96394c6a77eb523e54
+  data.tar.gz: f3c50b41488b2e626b010480a77dc13ab24f11f6
+SHA512:
+  metadata.gz: 76e4cdd71f4d5f6acd2204f71006c30cdbd0fa8dc67a6f8a929cd12da99439333cbcfd2f244ed38f2b7557fa0c6467fca663bd882d7ea98bc4cd4ff05f9d100a
+  data.tar.gz: b80880afb79a280c72b10442e969ff1f25c6105cf2f9f6d1c1accb733709fef7755740023e89cd92a0d8a0e1f9e09ccc1a735b7592c2a9604aa6bb7df93d6ac1

data/README.md

@@ -17,7 +17,7 @@ see below for all available tasks
 `capistrano-memcached` works only with Capistrano 3!
 
 This project was heavily inspired (i.e. copied and reworked) by 
-[capistrano-nginx-unicorn](https://github.com/bruno-/capistrano-nginx-unicorn).
+[capistrano-nginx-unicorn](https://github.com/bruno-/capistrano-nginx-unicorn) and [capistrano-recipes](https://github.com/mattdbridges/capistrano-recipes).
 
 ### Installation
 
@@ -77,7 +77,9 @@ Location of memcached log file.
 The port memcached listens on.
 
 * `set :memcached_ip, "127.0.0.1" # default listen only on localhost (for security) `<br/>
-The IP memcached listens on.
+The IP memcached listens on. If set to `:all`, memcached will listen on all IP addresses.
+This parameter is one of the only security measures that memcached has, so make sure
+it's listening on a firewalled interface.
 
 * `set :memcached_roles, [:app]`<br/>
 The roles on which memcached will be installed. `memcached.yml` will be available to all :app roles.
@@ -103,7 +105,8 @@ You can also provide path, where to generate templates:
 
     
 ### TODO
-* SASL authentication setup for memcached when running on multiple servers. 
+* Configure memcached server and clients for distributed setup.
+* SASL authentication setup for memcached when running on multiple servers.
     
 ### More Capistrano automation?
 

data/lib/capistrano/memcached/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Memcached
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/capistrano/tasks/memcached.rake

@@ -9,11 +9,12 @@ namespace :load do
     set :memcached_memory_limit, 128
     set :memcached_log_file, "/var/log/memcached.log"
     set :memcached_port, 11211
-    set :memcached_ip, "127.0.0.1" # listen only on localhost (for security)
+    set :memcached_ip, "127.0.0.1" # listen only on localhost by default (for security)
 
     # this is where memcached will be installed. A handy memcached.yml file will be created on all :app roles in
     # shared/config
     set :memcached_roles, [:app]
+    set :memcached_client_roles, [:app]
     set :memcached_user, "memcache"
 
     set :memcached_app_config, -> { memcached_default_app_config_file }
@@ -22,42 +23,38 @@ namespace :load do
 end
 
 namespace :memcached do
+  %w[start stop restart].each do |command|
+    desc "#{command} Memcached"
+    task command do
+      on roles fetch(:memcached_roles) do
+        sudo :service, "memcached #{command}"
+      end
+    end
+  end
 
   desc "Setup Memcached config file"
   task :setup do
     on roles fetch(:memcached_roles) do
       sudo "useradd #{fetch(:memcached_user)}; true" # create user, but don't fail if it already exists
-      sudo "apt-get", "-y install memcached"
-
       sudo_upload! mem_template("memcached.erb"), memcached_config_file
-      invoke "memcached:restart"
     end
   end
+  after 'memcached:setup', 'memcached:restart'
 
   desc 'Setup Memcached app configuration'
   task :setup_app_config do
-    on roles :app do
+    on roles fetch(:memcached_client_roles) do
       execute :mkdir, '-pv', File.dirname(fetch(:memcached_app_config))
       upload! mem_template('memcached.yml.erb'), fetch(:memcached_app_config)
     end
   end
 
   task :memcached_yml_symlink do
-    on roles :app do
+    on roles fetch(:memcached_client_roles) do
       set :linked_files, fetch(:linked_files, []).push("config/memcached.yml")
     end
   end
-
   before 'deploy:symlink:linked_files', 'memcached:memcached_yml_symlink'
-
-  %w[start stop restart].each do |command|
-    desc "#{command} Memcached"
-    task command do
-      on roles fetch(:memcached_roles) do
-        sudo :service, "memcached #{command}"
-      end
-    end
-  end
 end
 
 desc 'Server setup tasks'

data/lib/generators/capistrano/memcached/templates/memcached.erb

@@ -1,15 +1,51 @@
-# run as a daemon
+# memcached default config file.
+# Adapted by capistrano-memcached gem: https://github.com/capistrano-plugins/capistrano-memcached
+# Last change: <%= Time.now.to_s %>
+# 2003 - Jay Bonci <jaybonci@debian.org>
+# This configuration file is read by the start-memcached script provided as
+# part of the Debian GNU/Linux distribution.
+
+# Run memcached as a daemon. This command is implied, and is not needed for the
+# daemon to run. See the README.Debian that comes with this package for more
+# information.
 -d
 
+# Log memcached's output to /var/log/memcached
 logfile <%= fetch(:memcached_log_file) %>
 
-# memory limit
+# Be verbose
+# -v
+
+# Be even more verbose (print client commands as well)
+# -vv
+
+# Start with a cap of 64 megs of memory. It's reasonable, and the daemon default
+# Note that the daemon will grow to this size, but does not start out holding this much
+# memory
 -m <%= fetch(:memcached_memory_limit) %>
 
-# port
+# Default connection port is 11211
 -p <%= fetch(:memcached_port) %>
 
-# user
+# Run the daemon as root. The start-memcached will default to running as root if no
+# -u command is present in this config file
 -u <%= fetch(:memcached_user) %>
 
--l <%= fetch(:memcached_ip) %>
+# Specify which IP address to listen on. The default is to listen on all IP addresses
+# This parameter is one of the only security measures that memcached has, so make sure
+# it's listening on a firewalled interface.
+<% unless fetch(:memcached_ip) == :all %>
+-l <%= fetch(:memcached_ip) %>
+<% end %>
+
+# Limit the number of simultaneous incoming connections. The daemon default is 1024
+# -c 1024
+
+# Lock down all paged memory. Consult with the README and homepage before you do this
+# -k
+
+# Return error when memory is exhausted (rather than removing items)
+# -M
+
+# Maximize core file limit
+# -r

data/lib/generators/capistrano/memcached/templates/memcached.yml.erb

@@ -1,2 +1,9 @@
 <%= fetch(:stage) %>:
-  host: '127.0.0.1:11211'
+  host:
+  <% if fetch(:memcached_ip) == :all %>
+    <% roles(fetch(:memcached_roles)).each do |role| %>
+    - '<%= role.hostname %>:<%= fetch(:memcached_port)%>'
+    <% end %>
+  <% else %>
+    '<%=fetch(:memcached_ip)%>:<%=fetch(:memcached_port)%>'
+  <% end %>

metadata

@@ -1,82 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-memcached
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Ruben Stranders
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Capistrano tasks for automatic and sensible memcached configuration.
-
+description: |
+  Capistrano tasks for automatic and sensible memcached configuration.
   Enables zero downtime deployments of Rails applications. Configs can be
-
   copied to the application using generators and easily customized.
-
   Works *only* with Capistrano 3+.
-
   Heavily inspired (i.e. copied and reworked) by https://github.com/bruno-/capistrano-unicorn-nginx
-
-'
 email:
 - r.stranders@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -94,26 +82,25 @@ files:
 - lib/generators/capistrano/memcached/templates/memcached.yml.erb
 homepage: https://github.com/rhomeister/capistrano-memcached
 licenses: []
+metadata: {}
 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.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Capistrano tasks for automatic and sensible memcached configuration.
 test_files: []