orchestration 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0bd959d8a5186a473d26fe78039a6aaf752e8601136c77d3cc67611ee9e2a7c
-  data.tar.gz: 827da8b5d32566d8c15a3949de5671f06b61a63f41a818b22186d13076e99e34
+  metadata.gz: e312ede29eb601b4e9413df1b711881997f81629b6f208c0ea7e62102d4a6b44
+  data.tar.gz: 4483fd3532b1bf27bb9a6b76e38c996a02f046164ed23ce85d5df5720e933ff3
 SHA512:
-  metadata.gz: 65927e812ffa3dde5cefadfd458ce02bfc912263977a85634ef84170d727b61a97e955b817e1b0139238d669d5c622d06ac680ee410da4035bd9ec75d5db1e5c
-  data.tar.gz: d9e6fe7c2b46d601149cf6442953abaa5c3cba737ec7bbe9054f6779a57ad4a7b49c59b290a89d1610e4774b3aa6dc452b2aa5f09e5132cd6826f96a95122f5d
+  metadata.gz: 6539ea72eabd6683691749179cb4bd08c9f9e3f334ced7348236058a2926a6e25f6a09176c47efb1f40a0b22f57f96c9d1fb9ba4274c25036a4cd03e3d3f6ead
+  data.tar.gz: caed0598c1dc565457e0437943a0c031b78c3bef1ab99d5ae313368af6a4e0a84e7451bc46560e454457a5fa5c8e83c5ff6019fc114c3fd22e0a0dfac00d9c61

data/README.md

@@ -27,7 +27,7 @@ The below screenshot demonstrates _Orchestration_ being installed in a brand new
 Add _Orchestration_ to your Gemfile:
 
 ```ruby
-gem 'orchestration', '~> 0.5.4'
+gem 'orchestration', '~> 0.5.5'
 ```
 
 Install:
@@ -227,6 +227,8 @@ To connect via _SSH_ to a remote swarm and deploy, pass the `manager` parameter:
 make deploy manager=user@manager.swarm.example.com
 ```
 
+The file `orchestration/docker-compose.production.yml` is created automatically. If your `RAILS_ENV` is set to something other than `production` then another file will need to be created (e.g. `orchestration/docker-compose.staging.yml`). In most cases this file can be a _symlink_ to the original `production` configuration and environment variables can be used to customise the content.
+
 #### Roll back a deployment
 
 Roll back the `app` service of your stack:
@@ -270,7 +272,7 @@ Note that the following two variables _must_ be set in the relevant `.env` file
 
 ```
 # Published port for your application service:
-CONTAINER_PORT=3000
+PUBLISH_PORT=3000
 
 # Number of replicas of your application service:
 REPLICAS=5
@@ -325,7 +327,7 @@ See related documentation:
 | `WEB_HEALTHCHECK_PATH` | Path expected to return a successful response | `/` |
 | `WEB_HEALTHCHECK_READ_TIMEOUT` | Number of seconds to wait for data before failing healthcheck | `10` |
 | `WEB_HEALTHCHECK_OPEN_TIMEOUT` | Number of seconds to wait for connection before failing healthcheck | `10` |
-| `WEB_HEALTHCHECK_SUCCESS_CODES` | Comma-separated list of HTTP status codes that will be deemed a success | `200,202,204` |
+| `WEB_HEALTHCHECK_SUCCESS_CODES` | Comma-separated list of HTTP status codes that will be deemed a success | `200,201,202,204` |
 
 If your application does not have a suitable always-available route to use as a healthcheck, the following one-liner may be useful:
 

data/lib/orchestration.rb

@@ -11,7 +11,7 @@ require 'paint'
 begin
   require 'rails'
 rescue LoadError
-  warn('[orchestration] Rails not detected; skipping.')
+  warn('[orchestration] Running in non-Rails mode.')
 end
 
 I18n.load_path += Dir[File.join(File.expand_path('..', __dir__),

data/lib/orchestration/docker_compose/app_service.rb

@@ -113,7 +113,7 @@ module Orchestration
       end
 
       def ports
-        ['${CONTAINER_PORT:?CONTAINER_PORT must be provided}:8080']
+        ['${PUBLISH_PORT:?PUBLISH_PORT must be provided}:8080']
       end
     end
   end

data/lib/orchestration/docker_healthcheck.rb

@@ -40,7 +40,7 @@ module Orchestration
     end
 
     def success_codes
-      ENV.fetch('WEB_HEALTHCHECK_SUCCESS_CODES', '200,202,204').split(',')
+      ENV.fetch('WEB_HEALTHCHECK_SUCCESS_CODES', '200,201,202,204').split(',')
     end
 
     def success?(code)

data/lib/orchestration/environment.rb

@@ -82,7 +82,7 @@ module Orchestration
     end
 
     def app_port
-      ENV.fetch('CONTAINER_PORT', ENV.fetch('WEB_PORT', '3000')).to_i
+      ENV.fetch('PUBLISH_PORT', ENV.fetch('WEB_PORT', '3000')).to_i
     end
 
     def app_name

data/lib/orchestration/service_check.rb

@@ -18,9 +18,11 @@ module Orchestration
     def run
       return unless @service.configuration.configured?
 
+      @service.modify_environment
       echo_start
       success = attempt_connection
       echo_ready if success
+      @service.unmodify_environment
       success
     end
 

data/lib/orchestration/services/database/healthcheck.rb

@@ -19,6 +19,18 @@ module Orchestration
           [ActiveRecord::ConnectionNotEstablished].concat(adapter_errors)
         end
 
+        def modify_environment
+          @database_url = ENV.delete('DATABASE_URL')
+          @development_database_url = ENV.delete('DEVELOPMENT_DATABASE_URL')
+          @test_database_url = ENV.delete('TEST_DATABASE_URL')
+        end
+
+        def unmodify_environment
+          ENV['DATABASE_URL'] = @database_url
+          ENV['DEVELOPMENT_DATABASE_URL'] = @development_database_url
+          ENV['TEST_DATABASE_URL'] = @test_database_url
+        end
+
         private
 
         def adapter_errors

data/lib/orchestration/services/mixins/healthcheck_base.rb

@@ -26,6 +26,10 @@ module Orchestration
           @dependencies = args
         end
 
+        def modify_environment; end
+
+        def unmodify_environment; end
+
         private
 
         def load_dependencies

data/lib/orchestration/templates/application.mk.erb

@@ -15,8 +15,10 @@ test: test-setup
 
 # Start development containers and create/migrate/seed database
 .PHONY: develop
-develop: start
+develop:
 	bundle install
+	@$(MAKE) start env=test
+	@$(MAKE) start env=development
 	bundle exec rake db:create
 	bundle exec rake db:migrate
 	bundle exec rake db:seed

data/lib/orchestration/templates/deploy.mk.erb

@@ -8,8 +8,8 @@ else ifneq (,$(RACK_ENV))
 endif
 
 verify-environment:
-ifndef CONTAINER_PORT
-  @$(error `CONTAINER_PORT` must be defined in environment)
+ifndef PUBLISH_PORT
+  @$(error `PUBLISH_PORT` must be defined in environment)
 endif
 
 ifndef env

data/lib/orchestration/templates/orchestration.mk.erb

@@ -114,7 +114,7 @@ all: build
 ifndef network
 start: network := ${compose_project_name}_default
 endif
-start: _clean-logs
+start: _create-log-directory _clean-logs
 	@$(call print,'${yellow}Starting ${cyan}${env}${yellow} containers${reset} ...')
 ifeq (${env},$(filter ${env},test development))
 	@${compose} up --detach --force-recreate --renew-anon-volumes --remove-orphans ${services} ${log} || ${fail}
@@ -276,7 +276,7 @@ deploy:
 ifndef manager
 	@$(call println_error,'Missing `manager` parameter: `make deploy manager=swarm-manager.example.com`') ; exit 1
 endif
-	@$(call println,'${yellow}Deploying stack via${reset} ${green}${manager}${reset} ...') && \
+	@$(call println,'${yellow}Deploying ${green}${env}${reset} stack via${reset} ${green}${manager}${reset} ...') && \
           ( \
             $(call make,bundle path='${path}/bundle.tar') ${log} && \
             cd '${path}' ${log} && \
@@ -326,7 +326,7 @@ wait-listener:
 .PHONY: build
 build: build_dir = ${orchestration_dir}/.build
 build: context = ${build_dir}/context.tar
-build: check-local-changes
+build: _create-log-directory check-local-changes
 	@$(call print,'${yellow}Preparing build context from${reset} ${cyan}${git_branch}:${git_version}${reset} ... ')
 	@mkdir -p ${orchestration_dir}/.build ${log} || ${fail}
 ifndef dev
@@ -367,7 +367,7 @@ endif
 	@$(call println,'[${green}tag${reset}] ${cyan}${docker_organization}/${docker_repository}:${git_version}${reset}')
 
 .PHONY: push
-push:
+push: _create-log-directory
 	@$(call print,'${yellow}Pushing${reset} ${cyan}${docker_image}${reset} ...')
 	@docker push ${docker_image} ${log_progress} || ${fail}
 	@$(call printrawln,' ${green}complete${reset}. ${tick}')
@@ -389,3 +389,7 @@ endif
 _clean-logs:
 	@rm -f '${stdout}' '${stderr}'
 	@touch '${stdout}' '${stderr}'
+
+.PHONY: _create-log-directory
+_create-log-directory:
+	@mkdir -p log

data/lib/orchestration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orchestration
-  VERSION = '0.5.4'
+  VERSION = '0.5.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-05 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -322,10 +322,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/rspec
-- bin/rubocop
 - bin/setup
-- bin/strong_versions
 - config/locales/en.yml
 - doc/images/example.png
 - lib/Rakefile

data/bin/rspec

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rubocop' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rubocop", "rubocop")

data/bin/strong_versions

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'strong_versions' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("strong_versions", "strong_versions")