postgresinator 0.0.5 → 0.1.0

data/lib/postgresinator/config.rb

@@ -1,36 +1,28 @@
 require 'resolv'
 require 'hashie'
 
-namespace :pg do
+namespace :postgresinator do
 
   desc 'Write example config files'
   task :write_example_configs do
     run_locally do
-      execute "mkdir -p ./templates/postgresql"
-
-      # example postgresinator.rb
-      config = File.read(File.dirname(__FILE__) + '/examples/postgresinator_example.rb')
-      File.open('./postgresinator_example.rb', 'w') { |f| f.write(config) }
-      info "Wrote './postgresinator_example.rb'"
-      info "Run `mv postgresinator_example.rb postgrestinator.rb` or diff those files and add the needed lines."
-
-      # example postgresql.conf.erb
-      config = File.read(File.dirname(__FILE__) + '/examples/postgresql_example.conf.erb')
-      File.open('./templates/postgresql/postgresql_example.conf.erb', 'w') { |f| f.write(config) }
-      info "Wrote './templates/postgresql/postgres_example.conf.erb'"
-      info "Run `mv templates/postgresql/postgresql_example.conf.erb templates/postgresql/postgresql.conf.erb` or diff those files and add the needed lines."
-
-      # example pg_hba.conf.erb
-      config = File.read(File.dirname(__FILE__) + '/examples/pg_hba_example.conf.erb')
-      File.open('./templates/postgresql/pg_hba_example.conf.erb', 'w') { |f| f.write(config) }
-      info "Wrote './templates/postgresql/pg_hba_example.conf.erb'"
-      info "Run `mv templates/postgresql/pg_hba_example.conf.erb templates/postgresql/pg_hba.conf.erb` or diff those files and add the needed lines."
-
-      # example recovery.conf.erb
-      config = File.read(File.dirname(__FILE__) + '/examples/recovery_example.conf.erb')
-      File.open('./templates/postgresql/recovery_example.conf.erb', 'w') { |f| f.write(config) }
-      info "Wrote './templates/postgresql/recovery_example.conf.erb'"
-      info "Run `mv templates/postgresql/recovery_example.conf.erb templates/postgresql/recovery.conf.erb` or diff those files and add the needed lines."
+      execute "mkdir", "-p", "config/deploy", "templates/postgresql"
+      {
+        'examples/Capfile'                                  => 'Capfile_example',
+        'examples/config/deploy.rb'                         => 'config/deploy_example.rb',
+        'examples/config/deploy_postgresinator.rb'          => 'config/deploy_postgresinator_example.rb',
+        'examples/config/deploy/staging.rb'                 => 'config/deploy/staging_example.rb',
+        'examples/config/deploy/staging_postgresinator.rb'  => 'config/deploy/staging_postgresinator_example.rb',
+        'examples/Dockerfile'                               => 'templates/postgresql/Dockerfile_example',
+        'examples/postgresql.conf.erb'                      => 'templates/postgresql/postgresql_example.conf.erb',
+        'examples/pg_hba.conf.erb'                          => 'templates/postgresql/pg_hba_example.conf.erb',
+        'examples/recovery.conf.erb'                        => 'templates/postgresql/recovery_example.conf.erb'
+      }.each do |source, destination|
+        config = File.read(File.dirname(__FILE__) + "/#{source}")
+        File.open("./#{destination}", 'w') { |f| f.write(config) }
+        info "Wrote '#{destination}'"
+      end
+      info "Now remove the '_example' portion of their names or diff with existing files and add the needed lines."
     end
   end
 
@@ -38,16 +30,37 @@ end
 
 namespace :config do
 
+  # TODO refactor to load all settings via capistrano configs
   task :load_settings do
-    cluster = Hashie::Mash.new(PostgresCluster.settings)
+    cluster = Hashie::Mash.new()
+    cluster.image               = {}
+    set :pg_image_name,         -> { fetch(:postgres_image_name) }
+    cluster.image.name          = fetch(:pg_image_name)
+    set :pg_config_files,       -> { fetch(:postgres_config_files) }
+    cluster.image.config_files  = fetch(:pg_config_files)
+    set :pg_data_path,          -> { fetch(:postgres_data_path) }
+    cluster.image.data_path     = fetch(:pg_data_path)
+    set :pg_conf_path,          -> { fetch(:postgres_conf_path) }
+    cluster.image.conf_path     = fetch(:pg_conf_path)
+    set :pg_sock_path,          -> { fetch(:postgres_sock_path) }
+    cluster.image.sock_path     = fetch(:pg_sock_path)
+    set :pg_uid,                -> { fetch(:postgres_uid) }
+    cluster.image.postgres_uid  = fetch(:pg_uid)
+    set :pg_gid,                -> { fetch(:postgres_gid) }
+    cluster.image.postgres_gid  = fetch(:pg_gid)
+    set :pg_databases,          -> { fetch(:databases) }
+    cluster.databases           = fetch(:pg_databases)
+    set :pg_servers,            -> { fetch(:servers) }
+    cluster.servers             = fetch(:pg_servers)
+
     cluster.ssh_user            = ENV["USER"]
     cluster.servers.each do |server|
       server.ip = Resolv.getaddress(server.domain)
-      server.master_or_slave    = server.master ? "master" : "slave"
+      master_or_slave    = server.master ? "master" : "slave"
       server.master_domain      = cluster.servers.collect { |s| s.domain if s.master }.first
       server.master_ip          = Resolv.getaddress(server.master_domain)
       server.master_port        = cluster.servers.collect { |s| s.port if s.master }.first
-      server.container_name     = "#{server.master_domain}-postgres-#{server.port}-#{server.master_or_slave}"
+      server.container_name     = "#{server.master_domain}-postgres-#{server.port}-#{master_or_slave}"
       server.data_path          = "/#{server.container_name}-data"
       server.conf_path          = "/#{server.container_name}-conf"
       server.docker_run_command = [
@@ -79,7 +92,7 @@ namespace :config do
     @cluster = cluster
   end
 
-  task :ensure_cluster_data_uniqueness => :load_settings do
+  task :ensure_cluster_data_uniqueness do
     cluster = @cluster
     run_locally do
       names = cluster.servers.collect { |s| s.container_name }
@@ -133,7 +146,7 @@ namespace :config do
     run_locally do
       role_found = false
       cluster.databases.each do |database|
-        next unless database.role == args.role_name
+        next unless database.db_role == args.role_name
         role_found = true
       end
       fatal "Role #{args.role_name} not found in the configuration" and raise unless role_found

data/lib/postgresinator/examples/Capfile

@@ -0,0 +1,27 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails
+#
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
+# require 'capistrano/chruby'
+# require 'capistrano/bundler'
+# require 'capistrano/rails/assets'
+# require 'capistrano/rails/migrations'
+
+require 'postgresinator'
+
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

data/lib/postgresinator/examples/Dockerfile

@@ -0,0 +1,11 @@
+# vi: ft=config
+FROM ubuntu:12.04
+MAINTAINER david amick <docker@davidamick.com>
+
+RUN /bin/bash -l -c "apt-get update -qq && apt-get install -qy postgresql-9.1 libpq-dev postgresql-contrib nodejs rsync"
+RUN /bin/bash -l -c "/etc/init.d/postgresql start && /etc/init.d/postgresql stop"
+
+EXPOSE 5432
+USER postgres
+ENTRYPOINT ["/usr/lib/postgresql/9.1/bin/postgres"]
+CMD ["-D", "/var/lib/postgresql/9.1/main", "-c", "config_file=/etc/postgresql/9.1/main/postgresql.conf"]

data/lib/postgresinator/examples/config/deploy/staging.rb

@@ -0,0 +1,50 @@
+# Simple Role Syntax
+# ==================
+# Supports bulk-adding hosts to roles, the primary server in each group
+# is considered to be the first unless any hosts have the primary
+# property set.  Don't declare `role :all`, it's a meta role.
+
+set  :domain,           "my-app.example.com"
+set  :deploy_username,  "deployer"
+set  :user_host,        "#{fetch(:deploy_username)}@#{fetch(:domain)}"
+
+role :app, fetch(:user_host)
+role :web, fetch(:user_host)
+role :db,  fetch(:user_host)
+
+# Extended Server Syntax
+# ======================
+# This can be used to drop a more detailed server definition into the
+# server list. The second argument is a, or duck-types, Hash and is
+# used to set extended properties on the server.
+
+#server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value
+
+
+# Custom SSH Options
+# ==================
+# You may pass any option but keep in mind that net/ssh understands a
+# limited set of options, consult[net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start).
+#
+# Global options
+# --------------
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+#
+# And/or per server (overrides global)
+# ------------------------------------
+# server 'example.com',
+#   user: 'user_name',
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: 'user_name', # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: 'please use keys'
+#   }
+
+require './config/deploy/staging_postgresinator.rb'

data/lib/postgresinator/examples/config/deploy/staging_postgresinator.rb

@@ -0,0 +1,43 @@
+## For a standard Ubuntu 12.04 Nginx Docker image you should only
+##  need to change the following values to get started:
+
+set :domain,                    "my-app.example.com"
+set :postgres_image_name,       "snarlysodboxer/postgresql:0.0.1"
+set :postgres_config_files,     ["postgresql.conf", "pg_hba.conf", "recovery.conf"]
+set :postgres_data_path,        "/var/lib/postgresql/9.1/main"
+set :postgres_conf_path,        "/etc/postgresql/9.1/main"
+set :postgres_sock_path,        "/var/run/postgresql"
+set :postgres_uid,              "101"
+set :postgres_gid,              "104"
+set :databases,                 [
+  {
+    "name"                        => "client",
+    "db_role"                     => "client",
+    "pass"                        => "client"
+  }
+]
+set :servers,                   -> {
+  [
+    {
+      "master"                      => true,
+      "domain"                      => fetch(:domain),
+      "port"                        => "5432"
+    },
+    {
+      "master"                      => false,
+      "domain"                      => "my-app-other.example.com",
+      "port"                        => "5433"
+    }
+  ]
+}
+
+
+
+## The values below may be commonly changed to match specifics
+##  relating to a particular Docker image or setup:
+
+
+
+## The values below are not meant to be changed and shouldn't
+##  need to be under the majority of circumstances:
+

data/lib/postgresinator/examples/config/deploy.rb

@@ -0,0 +1,60 @@
+# config valid only for Capistrano 3.1
+lock '3.2.1'
+
+set :application, 'my_app_name'
+set :repo_url, 'git@example.com:me/my_repo.git'
+
+# Default branch is :master
+# ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }.call
+
+# Default deploy_to directory is /var/www/my_app
+# set :deploy_to, '/var/www/my_app'
+
+# Default value for :scm is :git
+# set :scm, :git
+
+# Default value for :format is :pretty
+# set :format, :pretty
+
+# Default value for :log_level is :debug
+# set :log_level, :debug
+
+# Default value for :pty is false
+# set :pty, true
+
+# Default value for :linked_files is []
+# set :linked_files, %w{config/database.yml}
+
+# Default value for linked_dirs is []
+# set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
+
+# Default value for default_env is {}
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+# Default value for keep_releases is 5
+# set :keep_releases, 5
+
+namespace :deploy do
+
+  desc 'Restart application'
+  task :restart do
+    on roles(:app), in: :sequence, wait: 5 do
+      # Your restart mechanism here, for example:
+      # execute :touch, release_path.join('tmp/restart.txt')
+    end
+  end
+
+  after :publishing, :restart
+
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      # Here we can do anything such as:
+      # within release_path do
+      #   execute :rake, 'cache:clear'
+      # end
+    end
+  end
+
+end
+
+require './config/deploy_postgresinator.rb'

data/lib/postgresinator/examples/config/deploy_postgresinator.rb

@@ -0,0 +1 @@
+# Only stage-specific postgresinator config options are needed.

data/lib/postgresinator/pg.rb

@@ -1,12 +1,10 @@
 require 'erb'
 
-require './postgresinator.rb' if File.exists?('./postgresinator.rb')
-
 ## NOTES:
 # tasks without 'desc' description lines are for manual debugging of this
 #   deployment code.
 #
-# we've choosen to only pass strings (if anything) to tasks. this allows tasks to be
+# only pass strings (if anything) to tasks. this allows tasks to be
 #   debugged individually. only private methods take ruby objects.
 
 namespace :pg do
@@ -70,9 +68,9 @@ namespace :pg do
             Rake::Task['pg:create_role'].reenable
           end
           cluster.databases.each do |database|
-            unless pg_role_exists?(cluster, server, database.role)
-              info "Creating role #{database.role} on #{server.domain}"
-              Rake::Task['pg:create_role'].invoke(server.domain, database.role)
+            unless pg_role_exists?(cluster, server, database.db_role)
+              info "Creating role #{database.db_role} on #{server.domain}"
+              Rake::Task['pg:create_role'].invoke(server.domain, database.db_role)
               Rake::Task['pg:create_role'].reenable
             end
             unless pg_database_exists?(cluster, server, database)
@@ -351,7 +349,7 @@ namespace :pg do
     server = cluster.servers.select { |s| s.domain == args.domain }.first
     on "#{cluster.ssh_user}@#{args.domain}" do
       execute("echo", "\"CREATE", "DATABASE", "\\\"#{database.name}\\\"",
-        "WITH", "OWNER", "\\\"#{database.role}\\\"", "TEMPLATE",
+        "WITH", "OWNER", "\\\"#{database.db_role}\\\"", "TEMPLATE",
         "template0", "ENCODING", "'UTF8';\"", "|",
         "docker", "run", "--rm", "--interactive",
         "--entrypoint", "/bin/bash",
@@ -367,7 +365,7 @@ namespace :pg do
     server = cluster.servers.select { |s| s.domain == args.domain }.first
     on "#{cluster.ssh_user}@#{args.domain}" do
       execute("echo", "\"GRANT", "ALL", "PRIVILEGES", "ON", "DATABASE",
-        "\\\"#{database.name}\\\"", "to", "\\\"#{database.role}\\\";\"", "|",
+        "\\\"#{database.name}\\\"", "to", "\\\"#{database.db_role}\\\";\"", "|",
         "docker", "run", "--rm", "--interactive",
         "--entrypoint", "/bin/bash",
         "--volumes-from", server.container_name,
@@ -389,7 +387,11 @@ namespace :pg do
             "--volume", "#{server.data_path}:#{cluster.image.data_path}:rw",
             cluster.image.name, "-s", "/etc/ssl/certs/ssl-cert-snakeoil.pem", inner_server_crt
           )
-          execute("chown", "root.", outer_server_crt)
+          execute("docker", "run",
+            "--rm", "--user", "root", "--entrypoint", "/bin/chown",
+            "--volume", "#{server.data_path}:#{cluster.image.data_path}:rw",
+            cluster.image.name, "root:root", inner_server_crt
+          )
         end
         inner_server_key = "#{cluster.image.data_path}/server.key"
         outer_server_key = "#{server.data_path}/server.key"
@@ -399,7 +401,11 @@ namespace :pg do
             "--volume", "#{server.data_path}:#{cluster.image.data_path}:rw",
             cluster.image.name, "-s", "/etc/ssl/private/ssl-cert-snakeoil.key", inner_server_key
           )
-          execute("chown", "root.", outer_server_key)
+          execute("docker", "run",
+            "--rm", "--user", "root", "--entrypoint", "/bin/chown",
+            "--volume", "#{server.data_path}:#{cluster.image.data_path}:rw",
+            cluster.image.name, "root:root", inner_server_key
+          )
         end
       end
     end
@@ -448,14 +454,14 @@ namespace :pg do
       ERB.new(File.new(template_path).read).result(binding)
     end
 
-    def pg_role_exists?(cluster, server, role)
-      test("echo", "\"SELECT", "*", "FROM", "pg_user", "WHERE", "usename", "=", "'#{role}';\"", "|",
+    def pg_role_exists?(cluster, server, db_role)
+      test("echo", "\"SELECT", "*", "FROM", "pg_user", "WHERE", "usename", "=", "'#{db_role}';\"", "|",
         "docker", "run", "--rm", "--interactive",
         "--entrypoint", "/bin/bash",
         "--volumes-from", server.container_name,
         cluster.image.name,
         "-c", "'/usr/bin/psql", "-U", "postgres'", "|",
-        "grep", "-q", "'#{role}'")
+        "grep", "-q", "'#{db_role}'")
     end
 
     def pg_database_exists?(cluster, server, database)

data/lib/postgresinator.rb

@@ -1,6 +1,5 @@
-require 'rake'
-require 'sshkit'
-require 'sshkit/dsl'
+require 'capistrano/setup'
+require 'capistrano/deploy'
 
 load 'postgresinator/pg.rb'
 load 'postgresinator/config.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postgresinator
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2014-11-11 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.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -68,10 +84,15 @@ files:
 - lib/postgresinator.rb
 - lib/postgresinator/pg.rb
 - lib/postgresinator/config.rb
-- lib/postgresinator/examples/postgresinator_example.rb
-- lib/postgresinator/examples/postgresql_example.conf.erb
-- lib/postgresinator/examples/pg_hba_example.conf.erb
-- lib/postgresinator/examples/recovery_example.conf.erb
+- lib/postgresinator/examples/Dockerfile
+- lib/postgresinator/examples/Capfile
+- lib/postgresinator/examples/config/deploy.rb
+- lib/postgresinator/examples/config/deploy_postgresinator.rb
+- lib/postgresinator/examples/config/deploy/staging.rb
+- lib/postgresinator/examples/config/deploy/staging_postgresinator.rb
+- lib/postgresinator/examples/postgresql.conf.erb
+- lib/postgresinator/examples/pg_hba.conf.erb
+- lib/postgresinator/examples/recovery.conf.erb
 homepage: https://github.com/snarlysodboxer/postgresinator
 licenses:
 - GNU

data/lib/postgresinator/examples/postgresinator_example.rb

@@ -1,35 +0,0 @@
-class PostgresCluster
-  def self.settings
-    {
-      "image"                       => {
-        "name"                        => "snarlysodboxer/postgresql:0.0.1",
-        "config_files"                => ["postgresql.conf", "pg_hba.conf", "recovery.conf"],
-        "data_path"                   => "/var/lib/postgresql/9.1/main",
-        "conf_path"                   => "/etc/postgresql/9.1/main",
-        "sock_path"                   => "/var/run/postgresql",
-        "postgres_uid"                => "101",
-        "postgres_gid"                => "104"
-
-      },
-      "databases"                   => [
-        {
-          "name"                        => "client",
-          "role"                        => "client",
-          "pass"                        => "client"
-        }
-      ],
-      "servers"                     => [
-        {
-          "master"                      => true,
-          "domain"                      => "client.example.com",
-          "port"                        => "5432"
-        },
-        {
-          "master"                      => false,
-          "domain"                      => "client-other.example.com",
-          "port"                        => "5433"
-        }
-      ]
-    }
-  end
-end