stackose 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78e1ae2368a649e93bc733155190ea791acd36ec
+  data.tar.gz: d3e0aec71ec3afbcce1b78b4cbe3c2412d25ae87
+SHA512:
+  metadata.gz: 0c75721a352ae19820b45e462dbff3c93f17e5f9eba8d79db22245946c222e70728855b428023f16150de96a6e855fba4747b254e3cd824dd3f245c6fe6bd488
+  data.tar.gz: c6358e7705080b4e46d16aa8eea19371851a04332e5ac6576155f68b6c059eedca22d8fc50b419301e2e046b4c3641c10b9c5a4be3054683b698f7434471a0f3

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+
+\.idea/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capistrano.gemspec
+gemspec
+
+gem "rspec"
+gem "rspec-core"
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    capose (0.1.0)
+      capistrano (>= 3.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.1.2)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.7.2)
+      airbrussh (>= 1.0.0)
+      capistrano-harrow
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-harrow (0.5.3)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    i18n (0.8.0)
+    method_source (0.8.2)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (4.0.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+    sshkit (1.11.5)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.4)
+  capose!
+  pry
+  rake
+  rspec
+  rspec-core
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -0,0 +1,101 @@
+# Stackose - A capistrano addon to use with docker stack [WIP]
+
+This gem is a refactoring to use the [capose](https://github.com/netguru/capose) gem, but with docker stack implementation.
+**The Documentation is owned from capose, and not so far complete for the docker stack, must be rewritten and cleared**
+
+This gem is a lighter version of docker-compose strategy found in [capistrano-docker](https://github.com/netguru/capistrano-docker) gem. 
+The idea is to be much simplier and more custom to use.
+
+
+### Installation
+
+  1. Ensure you already have `capistrano` gem in your project, with version at least `3.7`
+  2. Add the following line to your `Gemfile`: `gem 'stackose', require: false`
+  3. Add the following file to `Capfile`: `require 'stackose'`
+
+This gem will automatically hook up to the capistrano after `deploy:updated` hook to perform the deployment via `stackose:deploy` hook
+
+### Changelog
+
+
+### Defaults
+
+This gem uses couple variables which can be modified inside your deploy scripts, these are:
+
+    set :stackose_role - capistrano role for stackose, defaults to :web
+    set :stackose_copy - list of files/dirs to be copied from shared_path before first command (replaces :link_dirs/files), defaults to []
+    set :stackose_project - docker-compose project name, defaults to fetch(:application)
+    set :stackose_file - list of files for the docker-compose -f parameter (defauls to ["docker-compose.yml", "docker-compose-#{fetch(:stage)}.yml"]) and finaly the generated docker-compose-override
+    set :stackose_commands - list of commands to be run with docker-compose, defaults to []
+    set :stackose_docker_mount_point - mount point inside the application container, defaults to "/usr/share/www/"
+    set :stackose_linked_folders     - list of folders to link inside de image 
+    set :stackose_service_to_build   - name of the service that contains the application to run (default: app)
+
+### Folders to be linked
+If you need to link shared folders to the root of your application path, like capistrano standard linked_folders do,
+you can setup this like:
+
+       set :capose_linked_folders, [  'tmp/pids',
+                                     'tmp/cache',
+                                     'tmp/sockets',
+                                     'public/system',
+                                     'public/pictures',
+                                     'public/attachments',
+                                     'public/pages',
+                                     'public/assets',
+                                     'uploads']
+       
+For custom linking you can provide inside the array a hash with key->value of source->destination
+
+        set :capose_linked_folders, [
+           'tmp/pids',
+           'tmp/cache',
+            ....,
+           'uploads',
+            "/custom_path/#{fetch(:application)}/":"#{fetch(:capose_docker_mount_point)}/log",
+           ]
+           
+if you need the shared_path url in the key you can set `__shared_path__` as placeholder           
+        
+
+
+### Additional files before first command
+If you need to throw in to the "release" folder couple files (say secret files) before image is build, you can use `capose_copy` for that, ex:
+
+    set :capose_copy, %w(config/secrets.yml certs/google.crt certs/google.key)
+
+This command will copy the files from shared/ path before first command is executed, such as:
+
+    cp -aR [shared_path]/config/secrets.yml [release_path]/config/secrets.yml
+    cp -aR [shared_path]/config/google.crt [release_path]/config/google.crt
+    cp -aR [shared_path]/config/google.key [release_path]/config/google.key
+    docker-compose -p [application] -f ... build
+    docker-compose ...
+
+### Additional commands to run
+If your use-case contains more commands than `build` and `up -d`, then you can modify `capose_commands` to achieve that, ex:
+
+    set :capose_commands, ["build", "run --rm web rake db:migrate", "run --rm web rake assets:precompile", "up -d"]
+
+This will tell capistrano to run following commands:
+
+    docker-compose -p [application] -f docker-compose-[stage].yml -f docker-compose-image-override.yml build
+    docker-compose -p [application] -f docker-compose-[stage].yml -f docker-compose-image-override.yml run --rm web rake db:migrate
+    docker-compose -p [application] -f docker-compose-[stage].yml -f docker-compose-image-override.yml run --rm web rake assets:precompile
+    docker-compose -p [application] -f docker-compose-[stage].yml -f docker-compose-image-override.yml up -d
+
+### Custom docker-compose file paths
+
+If you want to add more compose files or change the name, then modify `capose_file` variable, ex:
+
+    set :stackose_file, ["docker-compose.yml", "docker-compose-override.yml"]
+
+This will tell capistrano to run commands as:
+
+    docker-compose -p [application] -f docker-compose.yml -f docker-compose-override.yml -f docker-compose-image-override.yml [command]
+
+### Docker-compose image override
+  
+This file is generated on deploy, it will create on the "app" service configurations to make it work more correctly:
+It append the image builded for the release (docker stack don't build images) and the user configuration, so the files generated
+from inside of the container will have the user oth the host system.

data/RailsSqliteTemplate.md

@@ -0,0 +1,24 @@
+
+### Template Per Rails e Alchemy
+
+
+`
+set :assets_dir, %w(public/system/. uploads/. public/pages/. public/noimage/.)
+set :local_assets_dir, %w(../../shared/public/system ../../shared/uploads ../../shared/public/pages ../../shared/public/noimage)
+
+set :stackose_copy, %w(config/secrets.yml)
+
+set :stackose_commands, ['run --rm --no-deps app rails assets:precompile', 'run --rm  --no-deps app rails db:migrate']
+
+set :stackose_linked_folders, [  'tmp/pids',
+                               'tmp/cache',
+                               'tmp/sockets',
+                               'public/system',
+                               'public/pictures',
+                               'public/attachments',
+                               'public/pages',
+                               'public/assets',
+                               'uploads',
+                               :"__shared_path__/db_volume"=>"/usr/share/application_storage"
+]
+`

data/lib/stackose.rb

@@ -0,0 +1,257 @@
+require 'json'
+namespace :deploy do
+  after :updated, 'stackose:deploy'
+  after :cleanup, 'stackose:cleanup'
+  before :check, 'stackose:create_linked_dirs'
+end
+
+namespace :stackose do
+  def _project
+    return "" if fetch(:stackose_project).nil?
+    "-p #{fetch(:stackose_project)}_tmp"
+  end
+
+  def _files
+    cmd = []
+
+    Array(fetch(:stackose_file)).each {|file| cmd << ["-f #{file}"]}
+
+    cmd.join(" ")
+  end
+
+  def _command(command)
+    [_project, _files, command].join(" ")
+  end
+
+  def normalized_stackose_linked_folders
+    files = []
+    fetch(:stackose_linked_folders).each do |f|
+
+      if f.is_a? Hash
+        f.each {|k, v| files << ["#{k.to_s.gsub('__shared_path__', shared_path.to_s)}", v]}
+      elsif f.is_a? String
+        files << ["#{shared_path}/#{f}", "#{fetch(:stackose_docker_mount_point)}/#{f}"]
+      end
+
+    end
+    files.to_h
+  end
+
+  # task :command do
+  #   _cmd = ENV["STACKOSE_COMMAND"]
+  #   if _cmd.nil?
+  #     puts "Usage: STACKOSE_COMMAND='command' bundle exec cap #{fetch(:stage)} stackose:command"
+  #     exit 1
+  #   end
+  #
+  #   on roles(fetch(:stackose_role)) do
+  #     within current_path do
+  #       execute :"docker-compose", _command(ENV["STACKOSE_COMMAND"])
+  #     end
+  #   end
+  # end
+  #
+  # task :stop do
+  #   on roles(fetch(:stackose_role)) do
+  #     within current_path do
+  #       execute :"docker-compose", _command("stop")
+  #     end
+  #   end
+  # end
+  #
+
+  desc "check linked dirs, and create this if there are not present"
+  task :create_linked_dirs do
+    on roles(fetch(:stackose_role)) do
+      execute :mkdir,'-p',normalized_stackose_linked_folders.keys.join(' ')
+    end
+  end
+
+  task :deploy do
+    on roles(fetch(:stackose_role)) do
+      within release_path do
+        fetch(:stackose_copy).each do |file|
+          execute :cp, " -aR #{shared_path}/#{file} #{release_path}/#{file}"
+        end
+      end
+    end
+
+    base_image_name = "#{fetch(:stackose_project)}:#{fetch(:stackose_image_tag)}"
+    compose_override = "docker-compose-image-override.yml"
+
+    ## costruiamo l'immagine
+    on roles(fetch(:stackose_role)) do
+      within release_path do
+        with fetch(:stackose_env) do
+
+          user_id = capture :id, '-u'
+          group_id = capture :id, '-g'
+
+          execute :docker, :build, ". -t #{base_image_name}"
+
+          compose_production = {
+            version: '3',
+            services: {
+              fetch(:stackose_service_to_build, 'app').to_sym => {
+                image: base_image_name,
+                user: "#{user_id}:#{group_id}"
+              }
+            }
+          }
+
+          contents = StringIO.new(JSON[compose_production.to_json].to_yaml)
+          upload! contents, "#{release_path}/#{compose_override}"
+
+          set :stackose_file, fetch(:stackose_file) + [compose_override]
+
+
+        end
+      end
+    end
+
+
+    on roles(fetch(:stackose_role)) do
+      within release_path do
+        with fetch(:stackose_env) do
+          fetch(:stackose_commands).each do |command|
+            execute :"docker-compose", _command(command)
+          end
+
+          execute :docker, :stack, :deploy, "-c #{fetch(:stackose_file).join(' -c ')} #{fetch(:stackose_project)}"
+
+        end
+      end
+    end
+  end
+
+
+  task :cleanup do
+    on roles(fetch(:stackose_role)) do
+      within release_path do
+        with fetch(:stackose_env) do
+          tags_list = capture :docker, :images, fetch(:stackose_project).to_sym, '--format "{{.Tag}}"'
+
+          list = tags_list.split
+          list.delete('latest')
+
+          releases = capture(:ls, "-x", releases_path).split
+
+          (list - releases).each do |r|
+            #delete image without release path
+            execute :docker, :image, :rm, "#{fetch(:stackose_project)}:#{r}"
+          end
+
+        end
+      end
+    end
+  end
+
+  desc "Create online docker-compose file, use the linked_folders parameter to generate the hash form the compose file"
+  task :create_online_docker_compose_file do
+
+    ask(:exposed_port, 30000)
+    ask(:server_name, 'example.tld')
+
+    ask(:need_redis_service, true)
+
+
+    compose_production = {
+      version: '3',
+      services: {
+        app: {
+          restart: 'unless-stopped',
+          environment: {:RAILS_ENV => fetch(:rails_env).to_s,
+                        :RAILS_SERVE_STATIC_FILES => 'true',
+                        :RAILS_MAX_THREADS => 5,
+                        :WEB_CONCURRENCY => 1},
+          deploy: {
+            replicas: 1,
+            resources: {
+              limits: {
+                cpus: '0.50',
+                memory: '250M'
+              }
+            }
+          },
+          volumes:
+            normalized_stackose_linked_folders.collect do |k|
+              k.join(':')
+            end,
+          ports: ["#{fetch(:exposed_port)}:3000"]
+        }
+      }
+    }
+
+    if fetch(:need_redis_service)
+      compose_production[:services][:redis] = {
+        restart: 'unless-stopped',
+        image: 'redis',
+        volumes: ["./config/redis.conf:/usr/local/etc/redis/redis.conf"],
+        deploy: {
+          resources: {
+            limits: {
+              memory: '50M'
+            }
+          }
+        }
+      }
+
+      File.open("config/redis.conf", 'w') {|file| file.write("maxmemory 50mb\nmaxmemory-policy allkeys-lfu")}
+    end
+
+    nginx_config = "server {
+      listen       80;
+      server_name  #{fetch(:server_name)};
+      location / {
+          proxy_pass         http://0.0.0.0:#{fetch(:exposed_port)}/;
+          proxy_redirect     off;
+
+          proxy_set_header   Host             $host;
+          proxy_set_header   X-Real-IP        $remote_addr;
+          proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for;
+
+          client_max_body_size       10m;
+          client_body_buffer_size    128k;
+
+          proxy_connect_timeout      90;
+          proxy_send_timeout         90;
+          proxy_read_timeout         90;
+
+          proxy_buffer_size          4k;
+          proxy_buffers              4 32k;
+          proxy_busy_buffers_size    64k;
+          proxy_temp_file_write_size 64k;
+       }
+     }"
+
+    puts "Configurazione NGINX:"
+    puts nginx_config
+    puts "Ricorda di cambiare anche la configurazione del database.yml per l'env specificato"
+    puts "
+    production:
+      <<: *default
+      pool: <%= ENV.fetch(\"RAILS_MAX_THREADS\") {5} %>
+      database: /usr/share/application_storage/production.sqlite3
+    "
+
+    File.open("docker-compose-production.yml", 'w') {|file| file.write(JSON[compose_production.to_json].to_yaml)}
+  end
+
+end
+
+namespace :load do
+  task :defaults do
+    set :stackose_role, -> {:web}
+    set :stackose_copy, -> {[]}
+    set :stackose_project, -> {fetch(:application)}
+    set :stackose_file, -> {["docker-compose.yml", "docker-compose-#{fetch(:stage)}.yml"]}
+    set :stackose_env, -> {{}}
+    set :stackose_image_tag, -> {fetch(:release_timestamp)}
+    set :stackose_service_to_build, -> {'app'}
+
+    set :stackose_commands, -> {[]}
+
+    set :stackose_linked_folders, -> {[]}
+    set :stackose_docker_mount_point, -> {'/usr/share/www'}
+  end
+end

data/stackose.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stackose'
+  spec.version       = '0.1.0'
+  spec.authors       = ["Marino Bonetti"]
+  spec.email         = ["marinobonetti@gmail.com"]
+  spec.description   = %q{Docker-Stack support for Capistrano 3.x}
+  spec.summary       = %q{Docker-Stack support for Capistrano 3.x}
+  spec.homepage      = 'https://github.com/oniram88/stackose'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'capistrano', '~> 3.7'
+  spec.add_development_dependency 'bundler', '~> 1.4'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: stackose
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marino Bonetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Docker-Stack support for Capistrano 3.x
+email:
+- marinobonetti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- RailsSqliteTemplate.md
+- lib/stackose.rb
+- stackose.gemspec
+homepage: https://github.com/oniram88/stackose
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Docker-Stack support for Capistrano 3.x
+test_files: []