vps 0.1.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 591e2f6174b369e271f23bc60b9d9492045259f3
-  data.tar.gz: 5b325e542fbacd8a0cf33df939c58db68c17995b
+SHA256:
+  metadata.gz: c05fa45234177718e60d54da1b3fdf0405b832360a03e939271feb39237355d5
+  data.tar.gz: c3349feae30878a1c26477b4a290fa926ba2a2ed03cc17ae04075f9b4c90cbe5
 SHA512:
-  metadata.gz: 07edf2782cd06c64ad79478dfc51c168552822530083f3170dd702fc46aec3f61600390abb8846cfe1ce7de021f48e5f27a39f1530cfd2cca75ef859c42ce67e
-  data.tar.gz: 7b59c311ae6fda27227c2128c4dbf26338b6a2e8f4740e49b05cb321b24eb28f2d78d45eaf53e58c28b8d3360abeaf02a5d3cfc2c64572af81ed8bb3cd136f0d
+  metadata.gz: 71e6d995c7dbacd2b144782e051eae9c87cb809a01d0c181a896ad607a9fe3f35c6cc0ab80174ecfa7a4956852633ec833b3044d41abf9e99bc943fa76f46f7f
+  data.tar.gz: 58d5327bd2fbcbd2b42db20e6544fbbed5a27cbabdf1bdc38200ee48c90c651ade0d64aa4503fe0bc3734de94b19e76e3f64c83540f3347e310a57aa37177463

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 ## VPS CHANGELOG
 
+### Version 0.3.1 (October 3, 2020)
+
+* Support skipping certain image builds when deploying
+* Add more X-Forwarded headers to fix the origin error
+
+### Version 0.2.3 (January 2, 2020)
+
+* Support upstreams without domains
+
+### Version 0.2.2 (January 2, 2020)
+
+* Automatically add container names for upstreams and services
+* Add opportunity to add lines to the generated Dockerfile
+
+### Version 0.2.1 (January 2, 2020)
+
+* Support NodeJS based applications
+* Clean up default upstream specs
+* Set container name when adding upstream
+
+### Version 0.2.0 (December 31, 2019)
+
+* Provide ability to add both custom HTTP and HTTPS Nginx configs [BREAKING]
+
 ### Version 0.1.2 (September 29, 2019)
 
 * Run postload tasks at the end of deployment

data/README.md

@@ -96,7 +96,7 @@ For support, remarks and requests, please mail me at [pm_engel@icloud.com](mailt
 
 ## License
 
-Copyright (c) 2019 Paul Engel, released under the MIT license
+Copyright (c) 2020 Paul Engel, released under the MIT license
 
 http://github.com/archan937 – http://twitter.com/archan937 – pm_engel@icloud.com
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.3.1

data/lib/vps.rb

@@ -1,3 +1,4 @@
+require "tmpdir"
 require "vps/version"
 
 module VPS

data/lib/vps/cli.rb

@@ -29,7 +29,9 @@ module VPS
 
     Playbook.all.each do |playbook|
       desc playbook.usage, playbook.description
-      method_options playbook.options if playbook.options
+      playbook.options.each do |(name, options)|
+        method_option name, options
+      end
       define_method playbook.command do |*args|
         start = Time.now
         playbook.run!(args, options)

data/lib/vps/cli/domain.rb

@@ -11,7 +11,7 @@ module VPS
 
         if (upstream = config[:upstreams].detect{|upstream| upstream[:name] == name})
           upstream[:email] = email if email
-          upstream[:domains].push(domain).uniq!
+          (upstream[:domains] ||= []).push(domain).uniq!
           VPS.write_config(host, config)
         end
       end

data/lib/vps/cli/playbook.rb

@@ -61,8 +61,11 @@ module VPS
       end
 
       def options
-        options = playbook["options"] || {}
-        options[%w(-d --dry-run)] = :boolean
+        options = (playbook["options"] || {}).inject({}) do |hash, (key, value)|
+          hash[key.to_sym] = value.symbolize_keys
+          hash
+        end
+        options[:d] = {:type => :boolean, :aliases => "dry-run"}
         options
       end
 
@@ -86,6 +89,13 @@ module VPS
       def run!(args, options)
         hash = Hash[arguments.zip(args)]
         state = State.new(hash.merge(options))
+
+        self.options.each do |(name, opts)|
+          if opts[:aliases]
+            state[opts[:aliases].underscore] = state[name]
+          end
+        end
+
         run(state)
       end
 

data/lib/vps/cli/playbook/state.rb

@@ -5,9 +5,6 @@ module VPS
 
         class AuthenticationFailedError < VPS::CLI::Error; end
         class SSHMock
-          def initialize
-            puts "🏄‍♀️ ~> ".gray + "Mocking SSH connection with Ubuntu 18.04.2 LTS server".cyan
-          end
           def exec!(command)
             case command
             when "cat /etc/lsb-release"
@@ -32,7 +29,11 @@ module VPS
         end
 
         def dry_run?
-          !!fetch(:d)
+          !!fetch(:d) || skip?
+        end
+
+        def skip?
+          !!fetch(:_skip_)
         end
 
         def scope(constants = {})
@@ -57,7 +58,7 @@ module VPS
             (hash || {}).fetch(key)
           end.tap do |value|
             if to_domain && value
-              if (domain = value[:domains].first)
+              if (domain = (value[:domains] || ["-"]).first)
                 return domain.gsub(/https?:\/\//, "")
               end
             end
@@ -109,7 +110,9 @@ module VPS
             command = "sudo -u #{user} -H sh -c #{command.inspect}"
           end
           puts "🏄‍♀️ ~> ".gray + command.yellow
-          unless dry_run?
+          if dry_run?
+            puts "   skipped".gray if skip?
+          else
             start = Time.now
             result = []
 
@@ -132,18 +135,16 @@ module VPS
         end
 
         def home_directory
-          @home_directory ||= ssh.exec!("pwd").strip
+          ssh.exec!("pwd").strip
         end
 
         def server_version
-          @server_version ||= begin
-            release = ssh.exec!("cat /etc/lsb-release")
+          release = ssh.exec!("cat /etc/lsb-release")
 
-            distribution = release.match(/DISTRIB_ID=(.*)/)[1].underscore
-            release = release.match(/DISTRIB_RELEASE=(.*)/)[1]
+          distribution = release.match(/DISTRIB_ID=(.*)/)[1].underscore
+          release = release.match(/DISTRIB_RELEASE=(.*)/)[1]
 
-            [distribution, release].join("-")
-          end
+          [distribution, release].join("-")
         end
 
       private
@@ -153,12 +154,10 @@ module VPS
         end
 
         def ssh
-          @ssh ||= begin
-            if dry_run?
-              SSHMock.new
-            else
-              Net::SSH.start(fetch(:host), fetch(:user))
-            end
+          if dry_run?
+            SSHMock.new
+          else
+            Net::SSH.start(fetch(:host), fetch(:user))
           end
         rescue StandardError => e
           raise AuthenticationFailedError, e.message

data/lib/vps/cli/playbook/tasks.rb

@@ -86,7 +86,22 @@ module VPS
         end
 
         def when(state, options)
-          if state[options[:boolean]]
+          pass = false
+
+          if options.key?("boolean")
+            pass = !!state[options[:boolean]]
+          else
+            value = options.key?("value") ? state[options[:value]] : options[:string]
+            if options.key?("include")
+              pass = state[options[:include]].include?(value)
+            elsif options.key?("exclude")
+              pass = !state[options[:exclude]].include?(value)
+            end
+          end
+
+          scope = pass ? {} : {_skip_: true}
+
+          state.scope(scope) do
             puts_description(state, options)
             run_tasks(state, {:tasks => options[:run]})
           end
@@ -153,7 +168,9 @@ module VPS
           output = [options[:command]].flatten.inject(nil) do |_, command|
             command = state.resolve(command)
             puts "☕ ~> ".gray + command.yellow
-            unless state.dry_run?
+            if state.dry_run?
+              puts "   skipped".gray if state.skip?
+            else
               start = Time.now
               result = []
 

data/lib/vps/cli/upstream.rb

@@ -10,13 +10,9 @@ module VPS
 
         unless config[:upstreams].any?{|upstream| upstream[:name] == name}
           spec = derive_upstream(path)
-          spec[:nginx] ||= nil
           config[:upstreams].push(spec.merge({
             :name => name || File.basename(path),
-            :path => path,
-            :domains => [],
-            :email => nil,
-            :compose => nil
+            :path => path
           }))
           VPS.write_config(host, config)
         end
@@ -84,6 +80,20 @@ module VPS
               }
             end
           end
+        elsif Dir["#{path}/package.json"].any?
+          tmpfile = "#{Dir.tmpdir}/vps-debug.log"
+          pid = spawn("cd #{path} && npm start", :out => tmpfile, :err => "/dev/null")
+          Process.detach(pid)
+          sleep 5
+          `ps aux | grep -e "no[d]e #{path}"`.strip.split("\n").collect do |line|
+            `kill -9 #{line.split(" ")[1]}`
+          end
+          port = File.read(tmpfile).match(/on port (\d+)/).captures.first.to_i
+          {
+            type: "node",
+            node_version: `$SHELL -l -c 'cd #{path} && node -v'`.match(/[\d\.?]+/).to_s,
+            port: port
+          }
         end
       end
 

data/lib/vps/version.rb

@@ -1,7 +1,7 @@
 module VPS
   MAJOR = 0
-  MINOR = 1
-  TINY  = 2
+  MINOR = 3
+  TINY  = 1
 
   VERSION = [MAJOR, MINOR, TINY].join(".")
 end

data/playbooks/deploy.yml

@@ -6,6 +6,11 @@ usage:
 arguments:
   - host
   - tool
+options:
+  s:
+    type: array
+    aliases: skip-build
+    default: []
 tasks:
   - task: ensure
     argument: user

data/playbooks/deploy/docker.yml

@@ -13,23 +13,34 @@ tasks:
       - task: generate_file
         template: docker/upstream/Dockerfile.{{ upstream.type }}.erb
         target: "{{ config_path }}/{{ upstream.name }}/Dockerfile"
-      - description: Building '{{ upstream.name }}' image
-        task: execute
-        command: docker build --no-cache -f {{ config_path }}/{{ upstream.name }}/Dockerfile -t {{ upstream.name }} {{ upstream.path }}
+      - task: when
+        value: upstream.name
+        exclude: skip_build
+        run:
+          - task: execute
+            command: docker build --no-cache -f {{ config_path }}/{{ upstream.name }}/Dockerfile -t {{ upstream.name }} {{ upstream.path }}
   - description: Saving docker images as .gzip file
     task: loop
     through: << upstreams >>
     as: upstream
     run:
-      - task: execute
-        command: docker save {{ upstream.name }} | gzip > /tmp/{{ upstream.name }}.gzip
+      - task: when
+        value: upstream.name
+        exclude: skip_build
+        run:
+          - task: execute
+            command: docker save {{ upstream.name }} | gzip > /tmp/{{ upstream.name }}.gzip
   - description: Uploading images
     task: loop
     through: << upstreams >>
     as: upstream
     run:
-      - task: upload
-        file: /tmp/{{ upstream.name }}.gzip
+      - task: when
+        value: upstream.name
+        exclude: skip_build
+        run:
+          - task: upload
+            file: /tmp/{{ upstream.name }}.gzip
   - description: Stopping current containers
     task: remote_execute
     command: cd {{ release_path }} && docker-compose stop
@@ -38,15 +49,23 @@ tasks:
     through: << upstreams >>
     as: upstream
     run:
-      - task: remote_execute
-        command: docker container rm $(docker container ls -f ancestor={{ upstream.name }} -aq)
+      - task: when
+        value: upstream.name
+        exclude: skip_build
+        run:
+          - task: remote_execute
+            command: docker container rm $(docker container ls -f ancestor={{ upstream.name }} -aq)
   - description: Removing current images
     task: loop
     through: << upstreams >>
     as: upstream
     run:
-      - task: remote_execute
-        command: docker image rm {{ upstream.name }}
+      - task: when
+        value: upstream.name
+        exclude: skip_build
+        run:
+          - task: remote_execute
+            command: docker image rm {{ upstream.name }}
   - task: run_tasks
     tasks: << preload >>
   - description: Unzipping and loading docker images
@@ -54,8 +73,12 @@ tasks:
     through: << upstreams >>
     as: upstream
     run:
-      - task: remote_execute
-        command: gunzip < /tmp/{{ upstream.name }}.gzip | docker load
+      - task: when
+        value: upstream.name
+        exclude: skip_build
+        run:
+          - task: remote_execute
+            command: gunzip < /tmp/{{ upstream.name }}.gzip | docker load
   - task: generate_file
     template: docker/docker-compose.yml.erb
     target: "{{ docker_compose_file }}"
@@ -88,7 +111,7 @@ tasks:
           - cd {{ release_path }} && if [ ! -d "data/certbot/conf/live/{{ domain:upstream }}" ]; then yes Y | sudo ./init-letsencrypt/{{ upstream.name }}.sh; fi
   - description: Starting containers
     task: remote_execute
-    command: cd {{ release_path }} && docker-compose up {{ up }} -d
+    command: cd {{ release_path }} && docker-compose up -d
   - description: Checking running docker images
     task: remote_execute
     command: docker ps

data/templates/docker/data/nginx/app.conf.erb

@@ -3,7 +3,7 @@
 upstream <%= upstream[:name] %> {
   server <%= upstream[:name] %>:<%= upstream[:port] %>;
 }
-<%- upstream[:domains].partition{|domain| domain.include?("http://")}.reject(&:empty?).each do |domains| %>
+<%- (upstream[:domains] || []).partition{|domain| domain.include?("http://")}.reject(&:empty?).each do |domains| %>
 <%-
   https = domains.first.include?("https://")
   domains = domains.collect{|domain| domain.gsub(/https?:\/\//, "")}.join(" ")
@@ -18,6 +18,10 @@ server {
   server_name <%= domains %>;
   server_tokens off;
 
+  <%- end %>
+  <%- if nginx[:http] %>
+<%= nginx[:http].gsub("PROXY_PASS", proxy_pass).indent(2) %>
+
   <%- end %>
   <%- if https %>
   location /.well-known/acme-challenge/ {
@@ -47,8 +51,8 @@ server {
   try_files $uri @app;
 
   <%- end %>
-  <%- if nginx[:config] %>
-<%= nginx[:config].gsub("PROXY_PASS", proxy_pass).indent(2) %>
+  <%- if nginx[:https] %>
+<%= nginx[:https].gsub("PROXY_PASS", proxy_pass).indent(2) %>
 
   <%- end %>
   location <%= nginx[:try_files] ? "@app" : "/" %> {
@@ -56,6 +60,10 @@ server {
     proxy_set_header  Host $http_host;
     proxy_set_header  X-Real-IP $remote_addr;
     proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header  X-Forwarded-Proto $scheme;
+    proxy_set_header  X-Forwarded-Ssl on;
+    proxy_set_header  X-Forwarded-Port $server_port;
+    proxy_set_header  X-Forwarded-Host $host;
     <%- if nginx[:proxy_redirect] %>
     proxy_redirect    <%= nginx[:proxy_redirect] %>;
     <%- end %>

data/templates/docker/docker-compose.yml.erb

@@ -34,12 +34,13 @@ services:
   <%- services.to_h.each do |name, spec| %>
 
   <%= name %>:
-<%= OpenStruct.to_hash(spec).to_yaml.sub(/^.*?\n/, "").indent(4) %>
+<%= OpenStruct.to_hash(spec).to_yaml.sub(/^.*?\n/, "").sub("\n", "\ncontainer_name: #{name}\n").indent(4) %>
   <%- end %>
   <%- upstreams.each do |upstream| %>
 
   <%= upstream.name %>:
     image: <%= upstream.name %>
+    container_name: <%= upstream.name %>
     restart: always
     <%- unless upstream[:compose].inspect.match(/\bports\b/) %>
     ports:

data/templates/docker/upstream/Dockerfile.node.erb

@@ -0,0 +1,15 @@
+FROM node:<%= upstream.node_version %>-alpine
+
+RUN apk update \
+&& apk --no-cache --update add \
+  build-base nodejs tzdata
+
+WORKDIR /opt/app
+COPY . .
+
+ENV NODE_ENV=production
+<%- if upstream.dockerfile %>
+<%= upstream.dockerfile.strip %>
+<%- end %>
+RUN npm install
+CMD ["npm", "start"]

data/templates/docker/upstream/Dockerfile.phoenix.erb

@@ -9,5 +9,8 @@ WORKDIR /opt/app
 COPY . .
 
 ENV MIX_ENV=prod
+<%- if upstream.dockerfile %>
+<%= upstream.dockerfile.strip %>
+<%- end %>
 RUN mix do deps.get --only prod, deps.compile
 CMD ["sh", "-c", "mix phx.server"]

data/templates/docker/upstream/Dockerfile.plug.erb

@@ -9,5 +9,8 @@ WORKDIR /opt/app
 COPY . .
 
 ENV MIX_ENV=prod
+<%- if upstream.dockerfile %>
+<%= upstream.dockerfile.strip %>
+<%- end %>
 RUN mix do deps.get --only prod, deps.compile
 CMD ["sh", "-c", "mix run --no-halt"]

data/templates/docker/upstream/Dockerfile.rack.erb

@@ -11,6 +11,9 @@ WORKDIR /opt/app
 COPY . .
 
 ENV RACK_ENV=production
+<%- if upstream.dockerfile %>
+<%= upstream.dockerfile.strip %>
+<%- end %>
 RUN gem install bundler -v <%= upstream.bundler_version %>
 RUN bundle install --without development test
 CMD ["bundle", "exec", "rackup", "config.ru", "-o", "0.0.0.0"]

data/templates/docker/upstream/Dockerfile.rails.erb

@@ -10,8 +10,12 @@ RUN apk update \
 WORKDIR /opt/app
 COPY . .
 
-ENV RAILS_ENV=production
 EXPOSE <%= upstream.port %>
+
+ENV RAILS_ENV=production
+<%- if upstream.dockerfile %>
+<%= upstream.dockerfile.strip %>
+<%- end %>
 RUN gem install bundler -v <%= upstream.bundler_version %>
 RUN bundle install --without development test
 CMD ["rm", "-f", "tmp/pids/server.pid"]

data/templates/docker/upstream/init-letsencrypt.sh.erb

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-<%- if (domains = upstream[:domains].collect{|domain| domain.dup.gsub!("https://", "")}.compact).any? %>
+<%- if (domains = (upstream[:domains] || []).collect{|domain| domain.dup.gsub!("https://", "")}.compact).any? %>
 domains=(<%= domains.join(" ") %>)
 email="<%= upstream[:email] || "noreply@#{domains.first}" %>" # Adding a valid address is strongly recommended
 data_path="./data/certbot"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vps
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Paul Engel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-29 00:00:00.000000000 Z
+date: 2020-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -174,6 +174,7 @@ files:
 - script/console
 - templates/docker/data/nginx/app.conf.erb
 - templates/docker/docker-compose.yml.erb
+- templates/docker/upstream/Dockerfile.node.erb
 - templates/docker/upstream/Dockerfile.phoenix.erb
 - templates/docker/upstream/Dockerfile.plug.erb
 - templates/docker/upstream/Dockerfile.rack.erb
@@ -203,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Zero-config deployments of Plug, Phoenix, Rack and Rails apps on a clean