rat_deployer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 262cf16b057028e511cd9d5e4e9396248c0cd725
-  data.tar.gz: c08531236e1d4ec9257344c42e367812239b7f19
+  metadata.gz: 651e4b450f1f05eb1a0279f7f845b37fdb092e27
+  data.tar.gz: a8598ab364a0f71b3f559776a9e8cc4ac5e9ffd7
 SHA512:
-  metadata.gz: cbbc4deeef649ba8bf002bfdd14bdcf99633624a301bf074e494ea4c3393a11c2b72e1d3fca01915a8e2e4f8dfedf929cc767576b79af8d8296791a37cd2ecd7
-  data.tar.gz: dec480736bdfc188b5b3e9c66e0f88b8651fc4d5063950d7741a69b3b2a3a01c84b809b1cc77f3e56c516dff1f850a1c8b0f65305a7827db98f056b4273075be
+  metadata.gz: 5385a41194697d5e64cada895388125cc2795b1f1b6b6b621f785d79474ded56296626a66e45ad586515228ea261ced93ba3c29bb13c13eda10019c7ca2fb799
+  data.tar.gz: a4adc275b24fbf132979fc6bb1d2631b3d8e9f0e9fdde86017d416bac1f4bb09725a029f267405b0300a78eaa320de5dc108f24dfdec7ff3b88ca2470cf74098

data/README.md

@@ -0,0 +1,96 @@
+[![build status](https://gitlab.alfred.yavende.com/dev_ops/rat_deployer/badges/master/build.svg)](https://gitlab.alfred.yavende.com/dev_ops/rat_deployer/commits/master)
+[![coverage report](https://gitlab.alfred.yavende.com/dev_ops/rat_deployer/badges/master/coverage.svg)](https://gitlab.alfred.yavende.com/dev_ops/rat_deployer/commits/master)
+
+# Rat
+
+Rat is a deploy tool for docker users. It implements a facade around 2 docker CLIs:
+  - docker
+  - docker-compose
+  
+It is not very flexible and it is ~~**untested**~~ lightly tested.
+I wrote this to avoid running a bunch of time consuming commands in a row.
+
+![rat](http://mauveart.esy.es/img/rats/1_big.jpg)
+
+I named it rat because it is a rather little and ugly ball of code, but it does the job for now.
+
+## Features
+Rat deployer adds a thin layer of abstraction over docker-compose to make commands more DRY.
+Main features it adds are:
+
+  - Enviromental overrides by using multiple compose files
+  - Easier remote usage by linking environments to machines
+  - Slack notifier
+
+## Installation
+
+~~~bash
+$ gem install rat_deployer
+~~~
+
+## Configuration
+Rat searches for a file called `rat_config.yml` in the working dir. The options are:
+
+- **project_name**: together with the environment, is part of the prefix passed to the `--project` option for `docker-compose`
+- **environments**: holds environemntal config
+  - **[*env*]**: parametric environment name
+    - **machine**: configuration for remote usage. Links environment to a remote host. All paths can be relative to `rat_config.yml` file
+      - **host**: IP for the remote machine
+      - **ca_cert**: path to CA certificate
+      - **cert**: path to SSL certificate used
+      - **key**: path to SSL certificate key
+
+Example config file:
+
+~~~yaml
+project_name: myapp
+
+environments:
+  staging:
+    machine:
+      host:    tcp://107.170.36.78:2376
+      ca_cert: certs/ca.pem
+      cert:    certs/cert.pem
+      key:     certs/key.pem
+~~~
+
+## Env variable configuration
+Rat most used options are set via environent variables to avoid having to type them all the time.
+
+- **RAT_ENV**: current enviroment.
+- **RAT_REMOTE**: whether or not to execute commands on remote host. Acceptable values are `true` and `false`. Defaults to `true`.
+
+I recommend to export them if you are going to work on a environment for a long time:
+
+~~~bash
+$ export RAT_ENV=production RAT_REMOTE=false
+~~~
+
+## Usage
+
+- `rat compose cmd`: proxies command to docker-compose adding flags `-f config/default.yml -f config/<env>.yml -p <prefix>`. If `RAT_REMOTE` is `true` adds flags for running on remote host.
+- `rat deploy [services]`: just an alias for `rat compose pull [services] && rat compose up -d [services]`.
+- `rat docker cmd`: proxies command to docker-compose adding flags for remote host ff `RAT_REMOTE` is `true`.
+
+Example usage:
+
+~~~base
+$ export RAT_ENV=staging
+$ rat compose up -d
+||=> Running command `docker-compose -f config/default.yml -f config/staging.yml -p cognituz_staging up -d`
+~~~
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rat_deployer.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rat_deployer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rat_deployer/commands/compose.rb

@@ -0,0 +1,67 @@
+require 'rat_deployer/command'
+require 'rat_deployer/config'
+require 'active_support/concern'
+
+module RatDeployer
+  module Commands
+    # This command proxies to `docker-compose` binary,
+    # adding the following flags:
+    #
+    # - -f for each config file.
+    #
+    # Defaults to current_env.config_files or
+    # config/default.yml and config/<current_env>.yml
+    #
+    # - -p with the configured project_name
+    #
+    # It is possible to include the current_env in the
+    # prohect name by using the token `{env}`, E.g.: project_name_{env}
+    module Compose
+      extend Command
+
+      def self.perform(cmd, *cmd_flags, silent: false)
+        run(
+          [
+            'docker-compose',
+            flags,
+            cmd,
+            cmd_flags
+          ].flatten.join(' '),
+          silent: silent
+        )
+          .fetch(:output)
+      end
+
+      def self.flags
+        config_files =
+          Config.for_env['config_files'] || %W[
+            config/default.yml
+            config/#{Config.env}.yml
+          ]
+
+        flags = [
+          config_files.map { |cf| "-f #{cf}" },
+          "-p #{Config.project_name}"
+        ]
+
+        flags.unshift(Config.remote_machine_flags) if Config.remote
+
+        flags
+      end
+
+      # Meant to be included in RatDeployer::Cli
+      module Extension
+        extend ActiveSupport::Concern
+
+        included do
+          desc \
+            'compose ARGS...',
+            'runs docker-compose command with default flags'
+          def compose(cmd, *cmd_flags, silent: false)
+            Commands::Compose.perform(cmd, *cmd_flags, silent: silent)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rat_deployer/commands/deploy.rb

@@ -0,0 +1,53 @@
+require 'active_support/concern'
+require 'active_support/core_ext/string/strip'
+
+require 'rat_deployer/config'
+require 'rat_deployer/notifier'
+require 'rat_deployer/commands/compose'
+
+module RatDeployer
+  module Commands
+    # This command runs `compose pull` and
+    # `compose up -d` for the given services.
+    # Adittionally, notifies to slack if configured to do so.
+    module Deploy
+      extend Command
+
+      def self.perform(*services)
+        Notifier.notify_deploy_start
+        deploy(*services)
+        Notifier.notify_deploy_end
+      rescue StandardError => e
+        Notifier.notify <<-STR.strip_heredoc
+          Failed deploy on #{Config.env}
+          Reason:
+            #{e.message}
+        STR
+        raise e
+      end
+
+      def self.deploy(*services)
+        if services.any?
+          services_str = services.join(' ')
+          Compose.perform("pull #{services_str}")
+          Compose.perform("up -d --no-deps --force-recreate #{services_str}")
+        else
+          Compose.perform('pull')
+          Compose.perform('up -d')
+        end
+      end
+
+      # Meant to be included in RatDeployer::Cli
+      module Extension
+        extend ActiveSupport::Concern
+
+        included do
+          desc 'deploy', 'deploys current environment'
+          def deploy(*services)
+            Commands::Deploy.perform(*services)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rat_deployer/commands/docker.rb

@@ -0,0 +1,34 @@
+require 'active_support/concern'
+
+require 'rat_deployer/command'
+require 'rat_deployer/config'
+
+module RatDeployer
+  module Commands
+    # This command proxies to the `docker` binary
+    # adding remote flags if configuration for
+    # remote machine is present
+    module Docker
+      extend Command
+
+      def self.perform(cmd, *cmd_flags)
+        flags = []
+        flags.unshift(Config.remote_machine_flags) if Config.remote
+        cmd = run "docker #{flags.join(' ')} #{cmd} #{cmd_flags.join(' ')}"
+        cmd.fetch(:output)
+      end
+
+      # Meant to be included in RatDeployer::Cli
+      module Extension
+        extend ActiveSupport::Concern
+
+        included do
+          desc 'docker ARGS...', 'runs docker command with default flags'
+          def docker(cmd, *cmd_flags)
+            Commands::Docker.perform(cmd, *cmd_flags)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rat_deployer/version.rb

@@ -1,3 +1,3 @@
 module RatDeployer
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rat_deployer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nicolas Oga
@@ -200,10 +200,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- bin/console
 - bin/rat
+- bin/setup
 - lib/rat_deployer.rb
 - lib/rat_deployer/cli.rb
 - lib/rat_deployer/command.rb
+- lib/rat_deployer/commands/compose.rb
+- lib/rat_deployer/commands/deploy.rb
+- lib/rat_deployer/commands/docker.rb
 - lib/rat_deployer/config.rb
 - lib/rat_deployer/notifier.rb
 - lib/rat_deployer/version.rb