capistrano-lazy_cleanup 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf005c37322af39afaf4bcee9a0bd1688f5a91aa
-  data.tar.gz: a2e9d14168f5f86b767bb3f159a4f694dd85c56d
+  metadata.gz: 878aba5677332a555449014b36377fa1f5d3b05b
+  data.tar.gz: b29aafae15aee742faf39f162db3e92cb0c2e18c
 SHA512:
-  metadata.gz: 51bf43bbc1ac8f075be26263cd14018705d76bc78d11c945f97aab4462d4d902c9591688845a1fd3e18455550691099477765cecc559e9ee71488a147e185e17
-  data.tar.gz: efff4364a823d48d899328d5afe4d595d3918694511c1394b88fa38dc2f7fabff213abd0c65260624b38183044906bd4dde019255dc818952cec60c37d946490
+  metadata.gz: f76d038cc88b5b60102368ad39bbf20e5eec18dcb234ddd01eb41cff88db4b1c29b65ec300459d5fabff8952743ec1d0eca5e24ab9fb9b8a3e428d821a8d0159
+  data.tar.gz: a90dcf4bf5958ec2ae1abd4987f457ea1a1c5cb6a9cce32b167f489b15601c09a283af09f246efa29096b6712288c93851d8fddd3a53f0ecb074d3df95cf5eb6

data/README.md

@@ -21,13 +21,38 @@ Or install it yourself as:
 
 ## Usage
 
+Capfile
+
 ```ruby
-require 'capistrano/deploy' # This should be required in advance
+# Load DSL and set up stages
+require "capistrano/setup"
+
+# Include default deployment tasks
+require "capistrano/deploy" # This should be required in advance
 
 # Capfile
 require 'capistrano/lazy_cleanup'
 ```
 
+## Configuration
+
+Capistrano::LazyCleanup can be used out of the box, but you can further customize the configuration at your `deploy.rb`.
+
+```ruby
+# Defaults to "#{fetch(:tmp_dir)}/cap-lazy-cleanup-#{fetch(:application)}.XXXXXXXXXX"
+set :lazy_cleanup_old_releases_path_template, "/tmp/my-old-releases.XXXXXXXXXX"
+```
+
+## What exactly does the `offloading` mean?
+
+On heavy application, it takes time to execute `deploy:cleanup` and `deploy:cleanup_rollback`. This is mainly due to heavy I/O caused by `rm -rf`. The kernel visits and unlink all the directories and files in old release paths. This costs heavy I/O as well as CPU cost.
+
+This gem replaces `rm -rf` with `mktemp` and `mv`. The old release paths are moved to temporary directory. Capistrano and the kernel should handle only the top directory on deployment. After the deployment, files in temporary directory will be eventually cleaned up by low-priorty processes provided by OS.
+
+## Caveats
+
+This gem heavily uses `fetch(:tmp_dir)` as the temporary directory. Therefore, when the combination of deployment size and frequency overwhelms cleanup cycle of your OS, you might encounter disk full issue. You can mitigate this by specifying additional fast cleanup rule on `lazy_cleanup_old_releases_path_template`. (e.g. `tmpwatch -umc 1 /tmp/cap-lazy-cleanup*`)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/capistrano/lazy_cleanup.rb

@@ -1,4 +1,5 @@
 require "capistrano/lazy_cleanup/version"
+require "capistrano/lazy_cleanup/defaults"
 
 module Capistrano
   module LazyCleanup

data/lib/capistrano/lazy_cleanup/defaults.rb

@@ -0,0 +1,14 @@
+require 'rake'
+
+module Capistrano
+  module LazyCleanup
+    module Defaults
+    end
+  end
+end
+
+# TODO: If Capistrano::Plugin system becomes stable, refactor these code.
+
+Rake::Task.define_task('load:defaults') do
+  set_if_empty :lazy_cleanup_old_releases_path_template, -> { "#{fetch(:tmp_dir)}/cap-lazy-cleanup-#{fetch(:application)}.XXXXXXXXXX" }
+end

data/lib/capistrano/lazy_cleanup/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module LazyCleanup
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/capistrano/tasks/lazy_cleanup.rake

@@ -24,7 +24,7 @@ namespace :capistrano do
             debug t(:no_current_release, host: host.to_s)
           end
           if directories.any?
-            temp_dir = capture(:mktemp, '-d')
+            temp_dir = capture(:mktemp, '-d', fetch(:lazy_cleanup_old_releases_path_template))
             execute :mv, *directories, temp_dir
           else
             info t(:no_old_releases, host: host.to_s, keep_releases: fetch(:keep_releases))
@@ -42,7 +42,7 @@ namespace :capistrano do
           execute :tar, "-czf",
                   deploy_path.join("rolled-back-release-#{last_release}.tar.gz"),
                   last_release_path
-          temp_dir = capture(:mktemp, '-d')
+          temp_dir = capture(:mktemp, '-d', fetch(:lazy_cleanup_old_releases_path_template))
           execute :mv, last_release_path, temp_dir
         else
           debug "Last release is the current release, skip cleanup_rollback."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-lazy_cleanup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Takumasa Ochi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -100,6 +100,7 @@ files:
 - bin/setup
 - capistrano-lazy_cleanup.gemspec
 - lib/capistrano/lazy_cleanup.rb
+- lib/capistrano/lazy_cleanup/defaults.rb
 - lib/capistrano/lazy_cleanup/version.rb
 - lib/capistrano/tasks/lazy_cleanup.rake
 homepage: https://github.com/aeroastro/capistrano-lazy_cleanup