capistrano_dockerbuild 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d0d051fdc506aceb1bbc232079f1f04fb2e0b9f
+  data.tar.gz: c0182416f4b9c3fc338fc63d6f89c8d933fe6847
+SHA512:
+  metadata.gz: b94b0a4e491a17c8a1c32fc2f3898031296438dd3603c40b21606871f6d607acf031a70f49b3e37e1b37fb6988c58ce4d5bed9007755f42cc6cd9239e07092d1
+  data.tar.gz: e483d3ff6866501200b070b7910d218cc73cc1fbeff7ca8cc77f85b9d80f5ee8f187c4f92c1c5b579773beba045c9fa96d8e333387a157d69790dfd89710eb16

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  # Exclude:
+  #   - 'db/schema.rb'
+  #   - 'db/migrate/*.rb'
+
+Style/RedundantReturn:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: false
+Style/UnneededPercentQ:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/UnlessElse:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLines:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+  Max: 160
+
+Bundler/OrderedGems:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-docker-build.gemspec
+gemspec
+
+gem 'byebug'
+gem 'rspec'
+gem 'rspec-core'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Eric Shorkey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README-deploy-compose.md

@@ -0,0 +1,45 @@
+    This content is specific to deployments using docker-compose; if you haven't yet reviewed README.md, you should probably start there.
+
+# docker:compose
+
+This deploy strategy copies a docker-compose.yml file to all the servers you specify, and then runs `docker-compose up` across the whole lot.
+
+This is a very basic deployment strategy; I wouldn't recommend for anything complex, but it will probably work fine for small projects with a single deploy target, or if you just want to make sure all the servers are running the same set of containers and don't mind getting your hands dirty if/when it randomly breaks in the middle.
+
+There is no blue/green, rolling update, auto rollback on failure, or anything even close. Have fun!
+
+
+### Roles:
+
+This gem adds the `docker_compose` role, identifying hosts where the docker_compose_file should be copied and ran.
+
+If the `docker_build` role is defined, it will identify the source of the docker_compose_file
+
+```ruby
+# using the `server` command
+server 'my.remote.server', roles: %w{docker_compose}
+server 'my_other.remote.server', roles: %w{docker_compose}
+
+# or using the `role` command
+role :docker_compose,  %w{localhost} # places localhost within the docker_compose role
+
+# The docker_build role is used to identify the source of the docker_compose_file
+role :docker_build,  %w{my.build.server} # copies the docker_compose_file from my.build.server and distributes it to all docker_compose roles
+
+# It is also acceptable to have no docker_build role defined
+# role :docker_build,  %w{commented.out} # no docker_build role (commented out), so the docker_compose_file is copied from local workstation project directory
+```
+
+
+### Configurable options:
+
+```ruby
+set :docker_compose_project -> { fetch(:application) }        # (required) name of the docker-compose project
+set :docker_compose_file, 'docker-compose.yml'                # name of compose file to use for deploy
+set :docker_compose_cmd, 'docker-compose'                     # name/path to `docker-compose` command on host
+set :docker_compose_opts, nil                                 # general args for `docker-compose`; default is none; (ex: '--project-name myproject --tls')
+set :docker_compose_up_opts, '-d --no-build --remove-orphans' # args for `docker-compose up` command; these are the defaults
+set :docker_compose_stop_opts, nil                            # args for `docker-compose stop` command; default is none; (ex: '--timeout 20')
+set :docker_compose_path -> { deploy_path }                   # path on remote hosts for docker-compose deployments
+set :dockercompose_deployhook, true                           # set false to skip default deploy hook; default is true
+```

data/README-deploy-swarm.md

@@ -0,0 +1,30 @@
+    This content is specific to deployments using Docker Swarm; if you haven't yet reviewed README.md, you should probably start there.
+
+# docker:swarm
+
+
+
+
+### Configurable options:
+
+```ruby
+set :docker_stack_name -> { fetch(:application) }                # (required) name of the docker swarm stack
+set :docker_compose_file, 'docker-compose.yml'                   # name of compose file to use for stack deploys
+set :docker_swarm_docker_cmd -> { fetch(:docker_cmd, 'docker') } # name/path to `docker-compose` command on docker_swarm hosts
+set :docker_stack_deploy_opts, '--prune'                         # args for `docker stack deploy` command; this is the default
+set :docker_compose_path -> { deploy_path }                      # path on remote hosts for docker_compose_file deployments
+
+set :dockerswarm_deployhook, true                                # set false to skip default deploy hook; default is true
+```
+
+----
+
+```ruby
+set :docker_compose_project -> { fetch(:application) }        # (required) name of the docker-compose project
+set :docker_compose_file, 'docker-compose.yml'                # name of compose file to use for deploy
+set :docker_compose_cmd, 'docker-compose'                     # name/path to `docker-compose` command on host
+set :docker_compose_opts, nil                                 # general args for `docker-compose`; default is none; (ex: '--project-name myproject --tls')
+set :docker_compose_up_opts, '-d --no-build --remove-orphans' # args for `docker-compose up` command; these are the defaults
+set :docker_compose_stop_opts, nil                            # args for `docker-compose stop` command; default is none; (ex: '--timeout 20')
+set :dockercompose_deployhook, true                           # set false to skip default deploy hook; default is true
+```

data/README.md

@@ -0,0 +1,122 @@
+# capistrano_dockerbuild
+
+Docker image creation, tagging, and repository tasks (and a few optional deployment schemes) for Capistrano v3
+
+```sh
+cap production docker:build_push # build image and then push to repository
+```
+
+This plugin also hooks into the default `cap <environment> deploy` flow as a build action. See [Usage](#usage) for more details.
+
+
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.11'
+gem 'capistrano_dockerbuild', '~> 1.0'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install capistrano_dockerbuild
+```
+
+## Usage
+
+#### Require in Capfile:
+
+```ruby
+require 'capistrano/dockerbuild'
+```
+
+#### Optionally define a docker_build host:
+
+```ruby
+role :docker_build,  %w{localhost} # role syntax, making localhost the build agent
+# or...
+server 'my.build.server', roles: %w{docker_build} # server syntax, declaring a remote server
+```
+
+If no `:docker_build` host is defined, the docker image will be built directly from the current working project directory. A maximum of one `:docker_build` host can be defined; any additional should raise an error.
+
+#### Run a deploy:
+
+The plugin automatically hooks the [Capistrano deploy flow](https://capistranorb.com/documentation/getting-started/flow/) after `deploy:published` (ie, you can run `cap <environment> deploy`).
+
+To opt-out of the default deploy hook, add this line to your `config/deploy.rb` or to a specific `config/deploy/<stage>.rb` file:
+
+```ruby
+set :dockerbuild_deployhook, false
+```
+
+You can also run tasks in isolation. For example:
+
+- `cap development docker:build`
+- `cap development docker:push`
+- `cap test docker:build_push`
+
+Run `cap -T docker:` for details
+
+*Be aware that `docker:build` tasks ran in isolation currently only generate the `:latest` and `:release-<timestamp>` docker image tags.*
+
+### Configurable options:
+
+```ruby
+set :docker_build_image -> { fetch(:application) } # (required) name of the image
+set :docker_build_opts, nil                        # additional `docker build` args; default is none; (ex: '--pull --no-cache --force-rm')
+set :docker_build_tag, 'latest'                    # specific tag name for this build; you can change this and 'latest' tag will still be applied
+set :docker_repo_url, nil                          # name/url of remote docker image repository for push
+set :docker_build_context, '.'                     # context passed to `docker build` (within :build_from)
+set :dockerfile, 'Dockerfile'                      # name of Dockerfile to use for build
+set :docker_cmd, 'docker'                          # name/path to `docker` command on build host
+set :build_from, '.'                               # directory within source repo to run build from
+set :dockerbuild_deployhook, true                  # set false to skip default deploy hook; default is true
+set :dockerbuild_trim_release_roles, true          # set false to prevent no_release from being auto-added to all non docker_build servers
+```
+
+### Created Docker image tags
+Under most use cases the `docker:build` task creates several image tags on the build host upon completion, all pointing to the same image SHA. By default, all of these tags are also pushed up to the docker image repository during the `docker:push` task. You may not want your repository (or build host) filled with a ton of tags, so this gem offers a few ways to control that sprawl.
+
+  docker_build_image_latest_tag,
+  docker_build_image_revision_tag,
+  docker_build_image_shortrev_tag,
+  docker_build_image_release_tag,
+  docker_build_image_tag,
+
+### Deployment to docker-compose, Docker Swarm, Kubernetes, Marathon, etc
+The primary purpose of this gem is currently to provide tasks for Docker image creation and repository push/transfer. However, some basic deployment tasks are included as optionals, should you decide to use them. Each deploy strategy needs to be specifically enabled by a separate `requires` statement within your Capfile.
+
+Refer to the specific deployment documentation for details:
+
+- [Deploying with Docker Compose](README-deploy-compose.md)
+- [Deploying with Docker Swarm](README-deploy-swarm.md)
+
+## Why?
+
+Because.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/eshork/capistrano_dockerbuild
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'capistrano/docker/build'
+
+# 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 'irb'
+IRB.start(__FILE__)

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/capistrano-docker-build.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano_dockerbuild'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Eric Shorkey']
+  spec.email         = ['eric.shorkey@gmail.com']
+
+  spec.summary       = 'docker build/push plugin for Capistrano'
+  spec.description   = 'Build, push and deploy your Docker container images as part of your Capistrano workflow. Pretty simple.'
+  spec.homepage      = 'https://github.com/eshork/capistrano_dockerbuild'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  # spec.files = `git ls-files -z`.split("\x0").reject do |f|
+  #   f.match(%r{^(test|spec|features)/})
+  # end
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '>= 3.11'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  # spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/capistrano/dockerbuild/hooks.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path('../../tasks/dockerbuild_hooks.rake', __FILE__)

data/lib/capistrano/dockerbuild/tasks.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path('../../tasks/dockerbuild.rake', __FILE__)

data/lib/capistrano/dockerbuild.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Capistrano::DSL::Paths re-open
+require_relative 'dsl/paths.rb'
+
+# dockerbuild standard tasks and cap flow hooks
+require_relative 'dockerbuild/tasks'
+require_relative 'dockerbuild/hooks'

data/lib/capistrano/dockercompose/hooks.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path('../../tasks/dockercompose_hooks.rake', __FILE__)

data/lib/capistrano/dockercompose/tasks.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path('../../tasks/dockercompose.rake', __FILE__)

data/lib/capistrano/dockercompose.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# dockercompose standard tasks and cap flow hooks
+require_relative 'dockercompose/tasks'
+require_relative 'dockercompose/hooks'

data/lib/capistrano/dockerswarm/hooks.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path('../../tasks/dockerswarm_hooks.rake', __FILE__)

data/lib/capistrano/dockerswarm/tasks.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path('../../tasks/dockerswarm.rake', __FILE__)

data/lib/capistrano/dockerswarm.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# dockerswarm standard tasks and cap flow hooks
+require_relative 'dockerswarm/tasks'
+require_relative 'dockerswarm/hooks'

data/lib/capistrano/dsl/paths.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module DSL
+    module Paths
+
+      def build_from
+        fetch(:build_from)
+      end
+
+      # directory within which the build is to be executed
+      # respects relative paths (not starting with /)
+      def build_path
+        return deploy_path.join(fetch(:current_directory, 'current')) if build_from.nil?
+        return Pathname.new(build_from.strip) if build_from.strip[0] == '/'
+        return deploy_path.join(fetch(:current_directory, 'current'), build_from)
+      end
+
+    end
+  end
+end