contained 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4175520c4ec751558d7d28563a476fcc23eb3f46ee06bac71580fb77312aaae4
-  data.tar.gz: b30a71a1728939c95220ddcd62f037051451d76b8d9bb201d18824ff4dd14b38
+  metadata.gz: de44c4a9646409b70c951f868cf1f60d753f72f6f14f9c68df242a493033b285
+  data.tar.gz: e460580a09f0fc0c18261b32d2d3cbaa7420324b938ea1f7a64325cfcaef0759
 SHA512:
-  metadata.gz: 3828f26f88c6de1cfb04973053ea874ed3d2d26697bad3196fbcd65c164bc2d0c2e0ae67f3fd64053d1694acc3dcd5481e12f00862a14aa62e8d666a8613b1b4
-  data.tar.gz: 2243642c5d055fce876311a111945cc75895f2d6f924c3c20c2b46b79d1499b05152cb5f40f96eb7e0e2317c49478a6cceac55fd300085fc34d4227f2622b861
+  metadata.gz: b3f08b9ae3eb66e9ca3cf22e2daf4d3091c2ad1b010453b8b6f328151a1d67c0f0174016350a06757f43fc9f2d32b07d198e2967a38648857c52965c50aa3a4c
+  data.tar.gz: 2c5351508f495084d7b303216047452fd2cd8b13c017ca2b9fedccbe7e26c59bd3f5d955e1124f46f73de3da8c063d6e8044a1961bab1b6fc3ecde92e0531beb

data/Gemfile

@@ -7,5 +7,10 @@ gemspec
 gem "irb"
 gem "rake"
 gem "rspec"
+gem "rspec_junit_formatter"
 gem "rubocop"
 gem "rubocop-basic"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "yard"

data/README.md

@@ -1,6 +1,28 @@
 # Contained
 
-## Example
+[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/contained/blob/main/LICENSE)
+[![RubyGems](https://img.shields.io/gem/v/contained)](https://rubygems.org/gems/contained)
+[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/contained)
+[![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://contained.ksylvest.com)
+[![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/contained)](https://circleci.com/gh/ksylvest/contained)
+
+Deploy using [Docker Swarm](https://docs.docker.com/engine/swarm/) via SSH across multiple and environments.
+
+## Installation
+
+```bash
+gem install contained
+```
+
+## Commands
+
+### Init
+
+The `contained init` command copies / pastes the following into your project:
+
+```bash
+contained init
+```
 
 **config/deploy.yml**
 
@@ -8,13 +30,19 @@
 stack: example
 
 environments:
-  production: hosts
-    - 1.2.3.4
-    - 5.6.7.8
-  test: hosts
-    - 4.3.2.1
-    - 8.7.6.5
+  production:
+    hosts:
+      - 1.2.3.4
+      - 5.6.7.8
+  test:
+    hosts:
+      - 4.3.2.1
+      - 8.7.6.5
+```
 
+**config/deploy/compose.yml**
+
+```yaml
 config:
   services:
     caddy:
@@ -48,15 +76,15 @@ config:
     caddy_config:
 ```
 
-```bash
-gem install contained
-```
+### Setup
+
+The `contained setup` command connects to all the hosts within an environment via SSH and configures docker swarm using a stack defined in the **config/deploy/compose.yml** file.
 
 ```bash
-contained setup
+contained setup --environment production
 ```
 
-## Usage
+## Examples
 
 ### w/ Caddy
 

data/lib/contained/cli/deploy.rb

@@ -11,7 +11,7 @@ module Contained
         config = Contained::Config.load_file(path: arguments.fetch(:config))
         environment = arguments.fetch(:environment)
 
-        Contained::Command::Deploy.execute!(stdin: @stdin, stdout: @stdout, environment:, config:)
+        Contained::Task::Deploy.execute!(stdin: @stdin, stdout: @stdout, environment:, config:)
       end
 
     private

data/lib/contained/cli/init.rb

@@ -61,7 +61,8 @@ module Contained
       def setup_config_deploy_yml(path:)
         if File.exist?("#{path}/config/deploy.yml")
           @stdout.puts("overwrite '#{path}/config/deploy.yml' (yes/no)?")
-          @stdin.gets { |response| return unless response.strip.eql?("yes") }
+          response = @stdin.gets
+          return unless response.strip.eql?("yes")
         end
 
         File.write("#{path}/config/deploy.yml", CONFIG_DEPLOY_YML)
@@ -71,7 +72,8 @@ module Contained
       def setup_config_deploy_compose_yml(path:)
         if File.exist?("#{path}/config/deploy/compose.yml")
           @stdout.puts("overwrite '#{path}/config/deploy/compose.yml' (yes/no)?")
-          @stdin.gets { |response| return unless response.strip.eql?("yes") }
+          response = @stdin.get
+          return unless response.strip.eql?("yes")
         end
 
         File.write("#{path}/config/deploy/compose.yml", CONFIG_DEPLOY_COMPOSE_YML)

data/lib/contained/cli/setup.rb

@@ -11,7 +11,7 @@ module Contained
         config = Contained::Config.load_file(path: arguments.fetch(:config))
         environment = arguments.fetch(:environment)
 
-        Contained::Command::Setup.execute!(stdin: @stdin, stdout: @stdout, environment:, config:)
+        Contained::Task::Setup.execute!(stdin: @stdin, stdout: @stdout, environment:, config:)
       end
 
     private

data/lib/contained/command/base.rb

@@ -8,28 +8,25 @@ module Contained
     class Base
       include SSHKit::DSL
 
-      def self.execute!(...)
-        new(...).execute!
+      def self.command(...)
+        new(...).command
       end
 
-      # @param stdin [IO]
-      # @param stdout [IO]
       # @environment [String]
       # @config [Contained::Config]
-      def initialize(stdin:, stdout:, environment:, config:)
-        @stdin = stdin
-        @stdout = stdout
+      def initialize(environment:, config:)
         @environment = environment
         @config = config
       end
 
-      def execute!
+      # @return [Array<Symbol,String>] e.g. [:docker, :login, "hub.docker.com", "-u", "root", "-p", "secret"]
+      def command
         raise NotImplementedError, "#execute! undefined"
       end
 
     protected
 
-      # @return [Array<Hash>]
+      # @return [Array<Hash<{ hostname: String }>>]
       def hosts
         @config.dig("environments", @environment, "hosts").map do |hostname|
           @config.fetch("ssh", {}).merge({ hostname: })

data/lib/contained/command/docker_login.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Contained
+  module Command
+    # User to `docker login` to a registry using a provided username and password.
+    #
+    # @example
+    #   Contained::Task::Login.command(environment: "production", config: {
+    #     registry: {
+    #     server: "hub.docker.com",
+    #     username: "root",
+    #     password: "secret",
+    #   }) # => [:docker, :login, "hub.docker.com", "-u", "root", "-p", "secret"]
+    class DockerLogin < Base
+      DEFAULT_SERVER = "hub.docker.com"
+
+      # @return [Array<Symbol,String>]
+      def command
+        [
+          :docker,
+          :login,
+          server,
+          "-u", username,
+          "-p", password,
+        ]
+      end
+
+    private
+
+      # @return [String, nil]
+      def username
+        @config.dig("registry", "username")
+      end
+
+      # @return [String, nil]
+      def password
+        @config.dig("registry", "username")
+      end
+
+      # @return [String]
+      def server
+        @config.dig("registry", "server") || DEFAULT_SERVER
+      end
+    end
+  end
+end

data/lib/contained/command/docker_logout.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Contained
+  module Command
+    # User to `docker login` to a registry using a provided username and password.
+    #
+    # @example
+    #   Contained::Task::Login.command(environment: "production", config: {
+    #     registry: {
+    #     server: "hub.docker.com",
+    #   }) # => [:docker, :login, "hub.docker.com"]
+    class DockerLogout < Base
+      DEFAULT_SERVER = "hub.docker.com"
+
+      # @return [Array<Symbol,String>]
+      def command
+        [
+          :docker,
+          :logout,
+          server,
+        ]
+      end
+
+    private
+
+      # @return [String]
+      def server
+        @config.dig("registry", "server") || DEFAULT_SERVER
+      end
+    end
+  end
+end

data/lib/contained/task/base.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "sshkit"
+
+module Contained
+  module Task
+    # @abstract
+    class Base
+      include SSHKit::DSL
+
+      def self.execute!(...)
+        new(...).execute!
+      end
+
+      # @param stdin [IO]
+      # @param stdout [IO]
+      # @environment [String]
+      # @config [Contained::Config]
+      def initialize(stdin:, stdout:, environment:, config:)
+        @stdin = stdin
+        @stdout = stdout
+        @environment = environment
+        @config = config
+      end
+
+      def execute!
+        raise NotImplementedError, "#execute! undefined"
+      end
+
+    protected
+
+      # @return [Array<Hash<{ hostname: String }>>]
+      def hosts
+        @config.dig("environments", @environment, "hosts").map do |hostname|
+          @config.fetch("ssh", {}).merge({ hostname: })
+        end
+      end
+    end
+  end
+end

data/lib/contained/task/deploy.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# .contained/itva/compose.yml
+# .contained/itva/.env
+module Contained
+  module Task
+    # @example
+    #   Contained::Task::Deploy.execute(environment: "production", config: {})
+    class Deploy < Base
+      def execute!
+        stack = @config.fetch("stack")
+        registry = @config.fetch("registry", { "server" => "hub.docker.com" })
+        username = ENV["DOCKER_LOGIN"]
+        password = ENV["DOCKER_PASSWORD"]
+
+        @stdout.puts("[deploy] stack=#{stack} environment=#{@environment}")
+
+        on hosts, in: :sequence do
+          if username && password
+            execute(:docker, :login, registry.fetch("server", "hub.docker.com"), "-u", username, "-p", password)
+          end
+
+          execute(<<~BASH)
+            source ./.contained/#{stack}/.env
+            docker stack deploy -c ./.contained/#{stack}/compose.yml #{stack} --with-registry-auth
+          BASH
+        end
+      end
+    end
+  end
+end

data/lib/contained/{command → task}/setup.rb

@@ -1,20 +1,27 @@
 # frozen_string_literal: true
 
 module Contained
-  module Command
+  module Task
     # @example
-    #   Contained::Command::Setup.execute(environment: "production", config: {})
+    #   Contained::Task::Setup.execute(environment: "production", config: {})
     class Setup < Base
       def execute!
         stack = @config.fetch("stack")
+        registry = @config.fetch("registry", { "server" => "hub.docker.com" })
+        username = ENV["DOCKER_LOGIN"]
+        password = ENV["DOCKER_PASSWORD"]
 
         deploy_compose_yml = File.open("./config/deploy/compose.yml")
         deploy_env = File.open("./config/deploy/.env.#{@environment}")
 
-        @stdout.puts("[setup] stack=#{stack} environment=#{@environment} hosts=#{hosts}")
+        @stdout.puts("[setup] stack=#{stack} environment=#{@environment}")
 
-        on hosts, in: :sequence do |host|
-          puts("[starting] host=#{host.hostname}")
+        on hosts, in: :sequence do
+          execute(:docker, :swarm, :init) unless capture(:docker, :info).include?("Swarm: active")
+
+          if username && password
+            execute(:docker, :login, registry.fetch("server", "hub.docker.com"), "-u", username, "-p", password)
+          end
 
           execute("mkdir -p ./.contained/#{stack}")
 
@@ -25,8 +32,6 @@ module Contained
             source ./.contained/#{stack}/.env
             docker stack deploy -c ./.contained/#{stack}/compose.yml #{stack} --with-registry-auth
           BASH
-
-          puts("[done] host=#{host.hostname}")
         end
       end
     end

data/lib/contained/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Contained
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/contained.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'zeitwerk'
-require 'optparse'
+require "zeitwerk"
+require "optparse"
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect "cli" => "CLI"

data/templates/config/deploy/compose.yml

@@ -0,0 +1,10 @@
+services:
+  app:
+    image: example/app
+    ports:
+      - "80:80"
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost/up" ]
+      interval: 30s
+      timeout: 10s
+      retries: 3

data/templates/config/deploy.yml

@@ -0,0 +1,21 @@
+stack: example
+
+registry:
+  server: hub.docker.com
+  username:
+    - DOCKER_USERNAME
+  password:
+    - DOCKER_PASSWORD
+
+ssh:
+  user: root
+
+environments:
+  production:
+    hosts:
+      - 1.2.3.4
+      - 5.6.7.8
+  test:
+    hosts:
+      - 4.3.2.1
+      - 8.7.6.5

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: contained
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -112,14 +112,16 @@ files:
 - lib/contained/cli/deploy.rb
 - lib/contained/cli/init.rb
 - lib/contained/cli/setup.rb
-- lib/contained/command.rb
 - lib/contained/command/base.rb
-- lib/contained/command/deploy.rb
-- lib/contained/command/login.rb
-- lib/contained/command/setup.rb
+- lib/contained/command/docker_login.rb
+- lib/contained/command/docker_logout.rb
 - lib/contained/config.rb
-- lib/contained/config/registry.rb
+- lib/contained/task/base.rb
+- lib/contained/task/deploy.rb
+- lib/contained/task/setup.rb
 - lib/contained/version.rb
+- templates/config/deploy.yml
+- templates/config/deploy/compose.yml
 homepage: https://github.com/ksylvest/contained
 licenses:
 - MIT

data/lib/contained/command/deploy.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# .contained/itva/compose.yml
-# .contained/itva/.env
-module Contained
-  module Command
-    # @example
-    #   Contained::Command::Deploy.execute(environment: "production", config: {})
-    class Deploy < Base
-      def execute!
-        stack = @config.fetch("stack")
-
-        @stdout.puts("[deploying] stack=#{stack} environment=#{@environment}")
-
-        on hosts, in: :sequence do |host|
-          puts("[starting] host=#{host.hostname}")
-          execute(<<~BASH)
-            source ./.contained/#{stack}/.env
-            docker stack deploy -c ./.contained/#{stack}/compose.yml #{stack} --with-registry-auth
-          BASH
-          puts("[done] host=#{host.hostname}")
-        end
-      end
-    end
-  end
-end

data/lib/contained/command/login.rb

@@ -1,24 +0,0 @@
-class Contained::Command::Login
-  # @param stdin [IO]
-  # @param stdout [IO]
-  # @param argv [Array<String>]
-  def initialize(stdin:, stdout:, argv:)
-    @stdin = stdin
-    @stdout = stdout
-    @argv = argv
-  end
-
-  def execute!
-    raise NotImplementedError, "#handle! undefined"
-  end
-
-  # @return [String]
-  def username!
-    @options.fetch(:username)
-  end
-
-  # @return [String]
-  def password
-    @options.fetch(:password)
-  end
-end

data/lib/contained/command.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module Contained
-  module Command
-  end
-end