orchestration 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2186d476519af97c595c422ec2e8e85244de7a21ba38ac57a9dac6078508147e
-  data.tar.gz: d62c7ae58f1c20eb34e94cf0120d1ccd2dafbfa5820a4f9cdde0a36e51a4942d
+  metadata.gz: 7cd01f40026116b804917069fba7d1e5c44d8aeee5a544b45e0815fb62f69ed5
+  data.tar.gz: cc69537b606cb64b5fa681af09f629cac90c7e2d4c2d98bcf173c3306b214588
 SHA512:
-  metadata.gz: 3c04057ada42ee20e573629778b56c4b35fc160325e1314e5055e30931b4e21c6948b1cdde40b6d0aff56e5076e708fd07af8ef55322d812f9b555f6ee7dbb03
-  data.tar.gz: 60a0c33ee614f8fb71a5feaae10e5788bd9f5cd8b45fbeb2a39b7cdcad0aa870bb5d61464a06c5478229a7ebf1f96a1a226ed0ff4ef0dc69280e0a617731310c
+  metadata.gz: 9ac9f6b9d04f74ed0cdea5e653296b300f9e1c04184340ede3dbb4a1e726ab4c32e2b3f6bc4e3bdddfc79315d2eaa8cb0ab1fe8877a3131f55179ca787268d86
+  data.tar.gz: a66c75b212e0992130b1e289781d516fe5b4be7bd5176c1a9a91c86bf927a9853ee8da7ed26192ecbf307d6cb66aa16dd579b5dd370bdd8e4f598df1b4d7ec38

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/MANIFEST

@@ -15,6 +15,7 @@ bin/rubocop
 bin/setup
 bin/strong_versions
 config/locales/en.yml
+doc/images/example.png
 lib/Rakefile
 lib/orchestration.rb
 lib/orchestration/docker_compose.rb

data/README.md

@@ -4,7 +4,7 @@
 
 _Orchestration_ aims to provide a convenient and consistent process for working with _Rails_ and _Docker_ without obscuring underlying components.
 
-At its core _Orchestration_ is just a `Makefile` and a set of `docker-compose.yml` files with sensible, general-purpose default settings. Users are encouraged to tailor the generated build-out to suit their application; once the build-out has been generated it belongs to the application.
+At its core _Orchestration_ is simply a `Makefile` and a set of `docker-compose.yml` files with sensible, general-purpose default settings. Users are encouraged to tailor the generated build-out to suit their application; once the build-out has been generated it belongs to the application.
 
 A typical _Rails_ application can be tested, built, pushed to _Docker Hub_, and deployed to _Docker Swarm_ with the following commands:
 
@@ -13,6 +13,13 @@ make test build push
 make deploy manager=user@swarm.example.com env_file=/var/configs/myapp.env
 ```
 
+_Orchestration_ has been successfully used to build continuous delivery pipelines for numerous production applications with a wide range or requirements.
+
+## Example
+
+The below screenshot demonstrates _Orchestration_ being installed in a brand new _Rails_ application with support for _PostgreSQL_ (via the _PG_ gem) and _RabbitMQ_ (via the _Bunny_ gem):
+![example](doc/images/example.png "https://hub.docker.com/r/rubyorchestration/sampleapp/tags")
+
 ## Getting Started
 
 [_Docker_](https://www.docker.com/get-started) and [_Docker Compose_](https://docs.docker.com/compose/install/) must be installed on your system.
@@ -43,7 +50,7 @@ rake orchestration:install server=unicorn # (or 'puma' [default], etc.)
 
 To rebuild all build-out at any time, pass `force=yes` to the above install command.
 
-You will be prompted to enter values for your _Docker_ organisation and repository name. For example, the _organisation_ and _repository_ for https://hub.docker.com/r/redislabs/redis/ are `redislabs` and `redis` respectively. If you are unsure of these values, they can be modified later by editing `.orchestration.yml` in the root of your project directory.
+You will be prompted to enter values for your _Docker_ organisation and repository name. For example, the _organisation_ and _repository_ for https://hub.docker.com/r/rubyorchestration/sampleapp are `rubyorchestration` and `sampleapp` respectively. If you are unsure of these values, they can be modified later by editing `.orchestration.yml` in the root of your project directory.
 
 #### Configuration files
 
@@ -51,7 +58,7 @@ _Orchestration_ generates the following files where appropriate. Backups are cre
 
 * `config/database.yml`
 * `config/mongoid.yml`
-* `config/rabbitmq.yml` (see [RabbitMQ Configuration](#markdown-header-rabbitmq-configuration) for more details)
+* `config/rabbitmq.yml` (see [RabbitMQ Configuration](#rabbitmq-configuration) for more details)
 * `config/unicorn.rb`
 * `config/puma.rb`
 
@@ -125,7 +132,7 @@ Note that `git archive` is used to generate the build context. Any uncommitted c
 make build
 ```
 
-See [build environment](#markdown-header-build-environment) for more details.
+See [build environment](#build-environment) for more details.
 
 #### Push latest image
 
@@ -191,8 +198,23 @@ CONTAINER_PORT=3000
 REPLICAS=5
 ```
 
-It is also recommended to set `SECRET_KEY_BASE` etc. in this file.
+It is also recommended to set `SECRET_KEY_BASE`, `DATABASE_URL` etc. in this file.
+
+## Logs
+
+The output from most underlying components is hidden in an effort to make continuous integration pipelines clear and concise. All output is retained in `log/orchestration.stdout.log` and `log/orchestration.stderr.log`. i.e. to view all output during a build:
+
+```bash
+tail -f log/orchestration*.log
+```
 
+A convenience `Makefile` target `dump` is provided which will output all consumed _stdout_ and _stderr_:
+
+```bash
+make dump
+```
+
+<a name="build-environment"></a>
 ## Build Environment
 
 The following environment variables will be passed as `ARG` variables when building images:
@@ -231,6 +253,12 @@ get '/healthcheck', to: proc { [200, { 'Content-Type' => 'text/html' }, ['']] }
 
 In this case, `WEB_HEALTHCHECK_PATH` must be set to `/healthcheck`.
 
+## Dockerfile
+
+A `Dockerfile` is automatically generated based on detected dependencies, required build steps, _Ruby_ version, etc.
+
+Real-world applications will inevitably need to make changes to this file. As with all _Orchestration_ build-out, the provided `Dockerfile` should be treated as a starting point and customisations should be applied as needed.
+
 ## Entrypoint
 
 An [entrypoint](https://docs.docker.com/engine/reference/builder/#entrypoint) script for your application is provided which does the following:
@@ -240,6 +268,7 @@ 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="rabbitmq-configuration"></a>
 ## RabbitMQ Configuration
 
 The [Bunny](https://github.com/ruby-amqp/bunny) _RabbitMQ_ gem does not recognise `config/rabbitmq.yml`. If your application uses _RabbitMQ_ then you must manually update your code to reference this file, e.g.:

data/lib/orchestration/templates/env.erb

@@ -5,6 +5,3 @@ CONTAINER_PORT=3000
 # Use this setting to control the number of replicas to create for your
 # application service:
 REPLICAS=1
-
-# Development database:
-DATABASE_URL=<%= env.database_url %>

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

@@ -64,7 +64,7 @@ all: build
 start: _clean-logs
 	@$(call print,'${yellow}Starting containers${reset} ...')
 ifeq (${env},$(filter ${env},test development))
-	@${compose} up -d --force-recreate ${services} ${log_progress} || ${fail}
+	@${compose} up -d --force-recreate ${services} ${log} || ${fail}
 	@[ '${is_container}' == '1' ] && \
          ( \
            docker network connect '${network}' '$(shell hostname)' ${log} \
@@ -73,7 +73,7 @@ ifeq (${env},$(filter ${env},test development))
          ) \
          || ( [ '${is_container}' == '0' ] || ${fail} )
 else
-	@${compose} up -d --scale app=$${instances:-1} ${services} ${log_progress} || ${fail}
+	@${compose} up -d --scale app=$${instances:-1} ${services} ${log} || ${fail}
 endif
 	@$(call printrawln,' ${green}started${reset} ${tick}')
 	@$(call println,'${yellow}Waiting for services to become available${reset} ...')
@@ -95,11 +95,11 @@ stop: _clean-logs
 	@$(call print,'${yellow}Stopping containers${reset} ...')
 	@if docker ps --format "{{.ID}}" | grep -q $(shell hostname) ; \
           then \
-            ( ${compose} down ${log_progress} || ${fail} ) \
+            ( ${compose} down ${log} || ${fail} ) \
             && \
             ( docker network connect ${docker_repository}_${env}_default $(shell hostname) ${log} || : ) ; \
           else \
-            ${compose} down ${log_progress} || ${fail} ; \
+            ${compose} down ${log} || ${fail} ; \
           fi
 	@$(call printrawln,' ${green}stopped${reset}. ${tick}')
 

data/lib/orchestration/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Bob Farrell
@@ -333,6 +333,7 @@ files:
 - bin/setup
 - bin/strong_versions
 - config/locales/en.yml
+- doc/images/example.png
 - lib/Rakefile
 - lib/orchestration.rb
 - lib/orchestration/docker_compose.rb