capistrano-wal-e 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072ffb56e2a0439ff3f8a3cbf3bec5f0fe3cc538
-  data.tar.gz: 87624c5ef9dea8021aed4429c76346125fdb7dd0
+  metadata.gz: 2457e5c70bd35faba8fe885ee1d227f57154e989
+  data.tar.gz: 6e72856c895517d2aeaa074ab3caf5083bc6fb91
 SHA512:
-  metadata.gz: 1f32bfb5d69ab0233472947cc3f06b7624278221e65bb19482c58163d5d1c3dd7757f5bd00df870f06db97199c5a45842b34b67cb2db0a870c8d74ac6a129987
-  data.tar.gz: 52acbe72649fefe9fdab03f09e79203ae72a8e191d07df99fbc5aa88db254cf3e96a6a7500a6c5c8d88e2ceb5a857f4a5263cfb4b98ee209535929775052fa2c
+  metadata.gz: 24bba8fc8f1ab253b6a04b62a766f139e67b2a5f079da2354d91ee427cfb07ea2d6fee3bf0115505f66cb6f3abbfc657cbeebc0f9dbd34c74b12be9c9b2aef6b
+  data.tar.gz: b1fd3a9d70bbb2d8106fdf2d7fca185565228d0de1870f514a6fa75ea474efaf9ecae1967aefa1c0894dffbe976987f3ffd44412216cef5dcf4fca8d71817c8c

data/README.md

@@ -1,41 +1,49 @@
-# Capistrano::Wal::E
+# Capistrano::UnicornNginx
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capistrano/wal/e`. To experiment with that code, run `bin/console` for an interactive prompt.
+Capistrano tasks for automatic and sensible WAL-E configuration
 
-TODO: Delete this and the text above, and describe your gem
+Goals of this plugin:
 
-## Installation
+* automatic configuration for setting up WAL-E for continuous backups of
+  PostgreSQL.
 
-Add this line to your application's Gemfile:
+Specifics:
 
-```ruby
-gem 'capistrano-wal-e'
-```
-
-And then execute:
+* generates environment variables for WAL-e
+* sets up cronjobs for base backups and deleting old ones
 
-    $ bundle
+Almost all the setup has been done by capistrano. There is just one manual step 
+that needs to be done.
 
-Or install it yourself as:
+* Uncomment and modify these lines in your postgresql.conf file under /etc/postgresql/9.3/main/
 
-    $ gem install capistrano-wal-e
-
-## Usage
+```
+wal_level = archive
+archive_mode = on
+archive_command = 'envdir /etc/wal-e.d/env /usr/local/bin/wal-e wal-push %p'
+archive_timeout = 60
+```
 
-TODO: Write usage instructions here
+Then restart postgres: `service postgresql restart`.
 
-## Development
+* Test by making the first snapshot backup:
+```
+/usr/bin/envdir /etc/wal-e.d/env /usr/local/bin/wal-e backup-push /var/lib/postgresql/9.3/main
 
-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.
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`capistrano-wal-e` works only with Capistrano 3!
 
-## Contributing
+### Installation
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-wal-e. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Add this to `Gemfile`:
 
+    group :development do
+      gem 'capistrano', '~> 3.2.1'
+      gem 'capistrano-wal-e', '~> 0.1.1'
+    end
 
-## License
+And then:
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+    $ bundle install
 

data/lib/capistrano/tasks/wal_e.rake

@@ -4,36 +4,41 @@ namespace :load do
   end
 end
 
-namespace :wal_e do
-  task :setup_env do
-    on roles :db do |role|
-      sudo 'mkdir -p /etc/wal-e.d/env'
-      sudo_upload! StringIO.new(fetch(:aws_access_key_id)), '/etc/wal-e.d/env/AWS_ACCESS_KEY_ID'
-      sudo_upload! StringIO.new(fetch(:aws_secret_access_key)), '/etc/wal-e.d/env/AWS_SECRET_ACCESS_KEY'
-      sudo_upload! StringIO.new(fetch(:aws_region)), '/etc/wal-e.d/env/AWS_REGION'
-      sudo_upload! StringIO.new("#{fetch(:wale_s3_prefix)}_#{role}"), '/etc/wal-e.d/env/WALE_S3_PREFIX'
-      sudo 'chown -R root:postgres /etc/wal-e.d'
+namespace :postgresql do
+  namespace :wal_e do
+    desc 'Setup the WAL-E environment variables'
+    task :setup_env do
+      on roles :db do |role|
+        sudo 'mkdir -p /etc/wal-e.d/env'
+        sudo_upload! StringIO.new(fetch(:aws_access_key_id)), '/etc/wal-e.d/env/AWS_ACCESS_KEY_ID'
+        sudo_upload! StringIO.new(fetch(:aws_secret_access_key)), '/etc/wal-e.d/env/AWS_SECRET_ACCESS_KEY'
+        sudo_upload! StringIO.new(fetch(:aws_region)), '/etc/wal-e.d/env/AWS_REGION'
+        sudo_upload! StringIO.new("#{fetch(:wale_s3_prefix)}_#{role}"), '/etc/wal-e.d/env/WALE_S3_PREFIX'
+        sudo 'chown -R root:postgres /etc/wal-e.d'
+      end
     end
-  end
 
-  task :setup_cron do
-    on roles :db do
-      cron = <<-EOF.gsub(/^\s+/, '')
+    desc 'Setup the WAL-E cron jobs for backup and cleanup'
+    task :setup_cron do
+      on roles :db do
+        cron = <<-EOF.gsub(/^\s+/, '')
         0 3 * * * /usr/bin/envdir /etc/wal-e.d/env /usr/local/bin/wal-e backup-push /var/lib/postgresql/9.3/main
         0 5 * * * envdir /etc/wal-e.d/env /usr/local/bin/wal-e delete --confirm retain 5
-      EOF
-      sudo_upload! StringIO.new(cron), "#{shared_path}/postgres-cron"
-      sudo "chown -R root:postgres #{shared_path}/postgres-cron"
-      sudo "-u postgres crontab #{shared_path}/postgres-cron"
+        EOF
+        sudo_upload! StringIO.new(cron), "#{shared_path}/postgres-cron"
+        sudo "chown -R root:postgres #{shared_path}/postgres-cron"
+        sudo "-u postgres crontab #{shared_path}/postgres-cron"
+      end
     end
-  end
 
-  task :setup do
-    invoke 'wal_e:setup_env'
-    invoke 'wal_e:setup_cron'
+    desc 'Setup WAL-E for continuous PostgreSQL backups'
+    task :setup do
+      invoke 'postgresql:wal_e:setup_env'
+      invoke 'postgresql:wal_e:setup_cron'
+    end
   end
 end
 
 task :setup do
-  invoke 'wal_e:setup'
+  invoke 'postgresql:wal_e:setup'
 end

data/lib/capistrano/wal_e/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module WalE
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-wal-e
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ruben Stranders