orchestration 0.4.2 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d589d50ab6d3d03c9822ba9b93ef34cf5ff8da72cf533fda977ff4636b02971f
-  data.tar.gz: fa76ff6d543d6b1b9163ae65eec399485afa6cd6c64e197075f63061cb9bc048
+  metadata.gz: 1de40b0bbbef8c548aa941a18486aa43c7ba6fe8433c9a14acd8cde13fc9e62b
+  data.tar.gz: b7b5cc3303a38971aabdd77217be5cb58ffa9519841724234ed8062854850de7
 SHA512:
-  metadata.gz: c628f61477317a5d0f59a74f20edf79f7f2f30558afcb39cd4a31d545b41b142873f8346fdf1fc20012d1fd77a7ac02261a3e3657372f48ed390355f73c02842
-  data.tar.gz: 1bd874621d3b9bac7f06d771c8f1c77fbeaafb0646a073f39e08b2262d4e1db22bfa57b80ac3312c32cbb59381959e217e39c8a9789d82e61e82b2a230c6c417
+  metadata.gz: fb4c23106ebec66f5eff4d2400a33e7370adffbd201800b4c4a9bda3eea0c5292b97d7011d0e5cf309f23f2ed6a5b4d599010062ee08327dc50d5b99e5a25c1d
+  data.tar.gz: 2fa9e0131222a6b368c321d9dcd314503c96e57ef639551847a17a04c4a624fa5606347ed4fdc80e3fc4535303f4fd93b65d1b241a45879423e137e9865848ad

data/README.md

@@ -1,5 +1,11 @@
 # Orchestration
 
+```
+I've got two tickets to the game
+It'd be great if I could take you to it this Sunday
+                                       --Nickelback
+```
+
 ## Overview
 
 _Orchestration_ aims to provide a convenient and consistent process for working with _Rails_ and _Docker_ without obscuring underlying components.
@@ -29,7 +35,7 @@ The below screenshot demonstrates _Orchestration_ being installed in a brand new
 Add _Orchestration_ to your Gemfile:
 
 ```ruby
-gem 'orchestration', '~> 0.4.2'
+gem 'orchestration', '~> 0.4.7'
 ```
 
 Install:
@@ -144,7 +150,7 @@ make push
 
 ### Development
 
-An [`.env`](https://docs.docker.com/compose/env-file/) is created automatically in your project root. This file is _not_ stored in version control. Set all application environment variables in this file.
+An [`.env` file](https://docs.docker.com/compose/env-file/) is created automatically in your project root. This file is _not_ stored in version control. Set all application environment variables in this file.
 
 #### Launching a development server
 
@@ -176,16 +182,59 @@ make test
 
 Note that _Orchestration_ will wait for all services to become fully available (i.e. running and providing valid responses) before attempting to run tests. This is specifically intended to facilitate testing in continuous integration environments.
 
+_(See [sidecar containers](#sidecar-containers) if you are running your test/development server inside _Docker_)_.
+
+Dependencies will be launched and then tested for readiness. The retry limit and interval time for readiness tests can be controlled by the following environment variables:
+
+```
+ORCHESTRATION_RETRY_LIMIT # default: 10
+ORCHESTRATION_RETRY_INTERVAL # default: 5 [seconds]
+```
+
+### (Local) Production
+
+Run a production environment locally to simulate your deployment platform:
+
+```
+make start env=production
+```
+
 ### Deployment to Docker Swarm
 
-To deploy your application to _Docker Swarm_:
+To deploy your application to a local _Docker Swarm_ use:
+```
+make deploy
+```
+
+#### Deploy to a remote swarm
+
+To connect via _SSH_ to a remote swarm and deploy, pass the `manager` parameter:
 ```
 make deploy manager=user@manager.swarm.example.com
 ```
 
-To use a custom `.env` file:
+#### Use a custom stack name
+
+The [_Docker_ stack](https://docs.docker.com/engine/reference/commandline/stack/) name defaults to the name of your repository (as defined in `.orchesration.yml`) and the _Rails_ environment, e.g. `anvil_production`.
+
+To override this default, pass the `project_name` parameter:
+```
+make deploy project_name=acme_anvil_production
+```
+
+This variable will also be available as `COMPOSE_PROJECT_NAME` for use within your `docker-compose.yml`. e.g. to explicitly name a network after the project name:
+
+```yaml
+networks:
+  myapp:
+    name: "${COMPOSE_PROJECT_NAME}"
+```
+
+#### Use a custom `.env` file
+
+Specify a path to a local `.env` file (see [Docker Compose documentation](https://docs.docker.com/compose/environment-variables/#the-env-file)):
 ```
-make deploy env_file=/path/to/.env manager=user@manager.swarm.example.com
+make deploy env_file=/path/to/.env
 ```
 
 Note that the following two variables _must_ be set in the relevant `.env` file (will look in the current working directory if no path provided):
@@ -268,6 +317,17 @@ An [entrypoint](https://docs.docker.com/engine/reference/builder/#entrypoint) sc
 * Adds a route `host.docker.internal` to the host machine running the container (mimicking the same route provided by _Docker_ itself on _Windows_ and _OS
   X_).
 
+<a name="sidecar-containers"></a>
+## Sidecar Containers
+
+If you need to start dependency services (databases, etc.) and connect to them from a _Docker_ container (an example use case of this would be running tests in _Jenkins_ using its _Docker_ agent) then the container that runs your tests must join the same _Docker_ network as your dependency services.
+
+To do this automatically, pass the `sidecar` parameter to the `start` or `test` targets:
+
+```bash
+make test sidecar=1
+```
+
 <a name="rabbitmq-configuration"></a>
 ## RabbitMQ Configuration
 

data/lib/orchestration/service_check.rb

@@ -2,8 +2,8 @@
 
 module Orchestration
   class ServiceCheck
-    ATTEMPT_LIMIT = 10
-    RETRY_INTERVAL = 3 # seconds
+    ATTEMPT_LIMIT = ENV.fetch('ORCHESTRATION_RETRY_LIMIT', '10').to_i
+    RETRY_INTERVAL = ENV.fetch('ORCHESTRATION_RETRY_INTERVAL', '5').to_i
 
     def initialize(service, terminal, options = {})
       @service = service
@@ -16,6 +16,8 @@ module Orchestration
     end
 
     def run
+      return echo_missing unless @service.configuration.configured?
+
       echo_start
       success = attempt_connection
       echo_ready if success
@@ -37,6 +39,14 @@ module Orchestration
       false
     end
 
+    def echo_missing
+      @terminal.write(
+        @service_name.to_sym,
+        "#{@service.configuration.error} (skipping)",
+        :error
+      )
+    end
+
     def echo_start
       @terminal.write(@service_name.to_sym, '', :status)
     end

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

@@ -3,7 +3,7 @@
 module Orchestration
   module Services
     module ConfigurationBase
-      attr_reader :service_name, :env
+      attr_reader :service_name, :env, :error
 
       def self.included(base)
         base.extend(ClassMethods)
@@ -33,6 +33,14 @@ module Orchestration
         @service_name
       end
 
+      def configured?
+        port
+        true
+      rescue KeyError => error
+        @error = error
+        false
+      end
+
       def port
         return @env.app_port if @service_name == 'app'
 

data/lib/orchestration/templates/Dockerfile.erb

@@ -1,8 +1,12 @@
 FROM ruby:<%= ruby_version %>
 ARG BUNDLE_BITBUCKET__ORG
 ARG BUNDLE_GITHUB__COM
-RUN apt-get update \
- && apt-get install -y node.js gosu sendmail \
+RUN curl -sL https://deb.nodesource.com/setup_10.x | bash - \
+ && apt-get update \
+ && DEBIAN_FRONTEND=noninteractive apt-get install -y \
+      nodejs \
+      gosu \
+      sendmail \
  && rm -rf /var/lib/apt/lists/* \
  && gem install bundler \
  && mkdir /app<%if defined?(Webpacker) %> \

data/lib/orchestration/templates/entrypoint.sh.erb

@@ -1,7 +1,6 @@
 #!/bin/sh
-set -ue
-echo "Host user ID: ${HOST_UID}"
-set +u
+HOST_UID=${HOST_UID:-$(id -u)}
+set -e
 id owner >/dev/null 2>&1 || useradd -u ${HOST_UID} -m -o owner
 mkdir -p /app/tmp/pids
 chown -Rf owner:owner /app/tmp /app/log /app/db

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

@@ -1,4 +1,3 @@
-is_container:=$(shell [ -f './.orchestration_container_flag' ] && echo -n '1' || echo -n '0')
 TERM ?= 'dumb'
 pwd:=$(shell pwd)
 ifdef mounted_orchestration

data/lib/orchestration/templates/mongoid.yml.erb

@@ -1,16 +1,12 @@
 development:
   clients:
     default:
-      hosts:
-        - 127.0.0.1:<%= compose.call('development').local_port('mongo') %>
-      database: development_db
+      uri: <%= "#{'<' + '%' + '='} ENV.fetch('MONGO_URL', 'mongodb://127.0.0.1:#{compose.call('development').local_port('mongo')}/development_db') #{'%' + '>'}" %>
 
 test:
   clients:
     default:
-      hosts:
-        - 127.0.0.1:<%= compose.call('test').local_port('mongo') %>
-      database: test_db
+      uri: <%= "#{'<' + '%' + '='} ENV.fetch('MONGO_URL', 'mongodb://127.0.0.1:#{compose.call('test').local_port('mongo')}/test_db') #{'%' + '>'}" %>
 
 production:
   clients:

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

@@ -32,17 +32,22 @@ else
 endif
 
 ifneq (,$(wildcard ${env_file}))
-  rake=. ${env_file} && ${rake}
+  rake_cmd:=${rake}
+  rake=. ${env_file} && ${rake_cmd}
 endif
 
 docker_organization=$(shell bash ${orchestration_dir}/yaml.bash docker_organization)
 docker_repository=$(shell bash ${orchestration_dir}/yaml.bash docker_repository)
 
+ifeq (,$(project_name))
+  project_name = ${docker_repository}_${env}
+endif
+
 compose_base=env HOST_UID=$(shell id -u) \
              DOCKER_ORGANIZATION="${docker_organization}" \
              DOCKER_REPOSITORY="${docker_repository}" \
+             COMPOSE_PROJECT_NAME="${project_name}" \
              docker-compose \
-             -p "${docker_repository}_${env}" \
              -f "${orchestration_dir}/docker-compose.yml"
 
 git_branch ?= $(if $(branch),$(branch),$(shell git rev-parse --abbrev-ref HEAD))
@@ -61,19 +66,22 @@ all: build
 ### Container management commands ###
 
 .PHONY: start
+ifndef network
+start: network := ${docker_repository}_${env}_default
+endif
 start: _clean-logs
 	@$(call print,'${yellow}Starting containers${reset} ...')
 ifeq (${env},$(filter ${env},test development))
-	@${compose} up -d --force-recreate ${services} ${log} || ${fail}
-	@[ '${is_container}' == '1' ] && \
+	@${compose} up --detach --force-recreate --renew-anon-volumes ${services} ${log} || ${fail}
+	@[ -n '${sidecar}' ] && \
          ( \
            docker network connect '${network}' '$(shell hostname)' ${log} \
            || \
            $(call println,'${yellow}Warning${reset}: Unable to join network: "${yellow}${network}${reset}". Container will not be able to connect to dependency services.') \
          ) \
-         || ( [ '${is_container}' == '0' ] || ${fail} )
+         || ( [ -z '${sidecar}' ] || ${fail} )
 else
-	@${compose} up -d --scale app=$${instances:-1} ${services} ${log} || ${fail}
+	@${compose} up --detach --scale app=$${instances:-1} ${services} ${log} || ${fail}
 endif
 	@$(call printrawln,' ${green}started${reset} ${tick}')
 	@$(call println,'${yellow}Waiting for services to become available${reset} ...')
@@ -201,13 +209,11 @@ endif
 
 .PHONY: deploy
 ifndef manager
-	@$(call println_error,'Missing `manager` parameter: `make deploy manager=swarm-manager.example.cor`')
+	@$(call println_error,'Missing `manager` parameter: `make deploy manager=swarm-manager.example.com`')
 endif
-deploy: env := production
-deploy: project_name = ${docker_repository}_${env}
-deploy: path = $(shell mktemp -d)
-deploy: RAILS_ENV = ${env}
-deploy: RACK_ENV = ${env}
+deploy: path := $(shell mktemp -d)
+deploy: RAILS_ENV := ${env}
+deploy: RACK_ENV := ${env}
 deploy: DOCKER_TAG = ${git_version}
 deploy:
 	@$(call println,'${yellow}Deploying stack via${reset} ${green}${manager}${reset} ...') && \
@@ -215,7 +221,7 @@ deploy:
             $(call make,_verify_compose env_file=${env_file} env=${env}) && \
             $(call make,bundle path='${path}/bundle.tar') ${log} && \
             cd '${path}' ${log} && \
-            tar xf './bundle.tar' ${log} && \
+            tar xf 'bundle.tar' ${log} && \
             cd '${docker_repository}' ${log} && \
                ( [ -z '${env_file}' ] || cp '${env_file}' './.env' ${log} ) && \
                $(call println,'${yellow}Deployment environment${reset}:') && \
@@ -276,7 +282,7 @@ build:
 <% if defined?(Webpacker) %>	@git show ${git_branch}:./package.json > ${orchestration_dir}/.build/package.json 2>${stderr} || ${fail}<% end %>
 <% if defined?(Webpacker) %>	@git show ${git_branch}:./yarn.lock > ${orchestration_dir}/.build/yarn.lock 2>${stderr} || ${fail}<% end %>
 	@git archive --format 'tar' -o '${context}' '${git_branch}' ${log} || ${fail}
-	@temp=$$(mktemp -d) ; ( cd "$${temp}" && touch './.orchestration_container_flag' && tar -uvf '${context}' . ) ${log} || ${fail}
+	@temp=$$(mktemp -d) ; ( cd "$${temp}" && tar -uvf '${context}' . ) ${log} || ${fail}
 	@$(call printrawln,'${green}complete.${reset} ${tick}')
 	@$(call print,'${yellow}Building image${reset} ...')
 	@docker build \

data/lib/orchestration/templates/rabbitmq.yml.erb

@@ -1,11 +1,11 @@
 <% if compose.call('development').services.key?('rabbitmq') %>
 development:
-  url: amqp://127.0.0.1:<%= compose.call('development').local_port('rabbitmq') %>
+  url: <%= "#{'<' + '%' + '='} ENV.fetch('RABBITMQ_URL', 'amqp://127.0.0.1:#{compose.call('development').local_port('rabbitmq')}') #{'%' + '>'}" %>
 <% end %>
 
 <% if compose.call('test').services.key?('rabbitmq') %>
 test:
-  url: amqp://127.0.0.1:<%= compose.call('test').local_port('rabbitmq') %>
+  url: <%= "#{'<' + '%' + '='} ENV.fetch('RABBITMQ_URL', 'amqp://127.0.0.1:#{compose.call('test').local_port('rabbitmq')}') #{'%' + '>'}" %>
 <% end %>
 
 production:

data/lib/orchestration/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.7
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url