Containerise deployment

Use only container stack for Heroku deployment.

Use heroku.yml manifest for image building.

Create image to run all processes in one dyno.

Remove sqlite as development option (CircleCI and other things use
postgres now).

Alter some environment options to match defaults.

Author: Vidas P

.circleci/config.yml

@@ -7,15 +7,24 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:2.6.3-node-browsers
+      - image: circleci/ruby:2.6.6-node-browsers
+        environment:
+          RAILS_ENV: test
+          RACK_ENV: test
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
       # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
+      - image: circleci/postgres:9.6-alpine
+        environment:
+          POSTGRES_USER: aw
+          POSTGRES_DB: aw_test
 
     working_directory: ~/repo
 
+    environment:
+      DATABASE_URL: "postgres://aw@localhost:5432/aw_test"
+
     steps:
       - checkout
 
@@ -37,8 +46,11 @@ jobs:
           key: v1-dependencies-{{ checksum "Gemfile.lock" }}
 
       # Database setup
-      - run: bundle exec rake db:create
-      - run: bundle exec rake db:schema:load
+      - run:
+          name: create database
+          command: |
+            bundle exec rake db:schema:load
+            bundle exec rake db:migrate
 
       # run tests!
       - run:

.env

@@ -10,27 +10,26 @@ SECRET_KEY_BASE=REPLACE_ME_NOW!
 
 # Concurrency options
 
-WEB_CONCURRENCY=2
+WEB_CONCURRENCY=1
 RAILS_MAX_THREADS=5
 RACK_TIMEOUT_SERVICE_TIMEOUT=20
 
 
 # Database setup
 
-#DATABASE_ADAPTER=sqlite3
 #DATABASE_ENCODING=utf8
 #DATABASE_RECONNECT=true
-#DATABASE_NAME=db/development.sqlite3
+#DATABASE_NAME=active_workflow
 #DATABASE_POOL=20
 #DATABASE_USERNAME=
 #DATABASE_PASSWORD=""
 #DATABASE_HOST=
 #DATABASE_PORT=
 #TEST_DATABASE_NAME=
 
-#DO_NOT_CREATE_DATABASE
+#CREATE_DATABASE=1
 #DO_NOT_MIGRATE=
-SEED_DATABASE=1
+#DO_NOT_SEED=1
 SEED_EMAIL=admin@example.com
 SEED_USERNAME=admin
 SEED_PASSWORD=password

CHANGELOG.md

@@ -19,6 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Remove SchedulerAgent (to be implemented as a core functionality).
 - Refactor agent runner and scheduler.
+- `SEED_DATABASE` and `DO_NOT_CREATE_DATABASE` environment flags where inverted and replaced with 
+  `DO_NOT_SEED` and `CREATE_DATABASE` correspondingly to represent default execution path.
+- You can now use Heroku single button deployment for both demonstration
+  purposes running on free tier and production with scalable dyno formations.
+  This is controlled with a single environment variable `SINGLE_DYNO`.
 
 
 ## [0.9.8] - 2020-05-11

Dockerfile

@@ -9,14 +9,14 @@ COPY ./ /app/
 
 # Get rid of annoying "fatal: Not a git repository (or any of the parent directories): .git" messages
 RUN umask 002 && git init && \
-    LC_ALL=en_US.UTF-8 RAILS_ENV=production SECRET_KEY_BASE=secret DATABASE_ADAPTER=postgresql bundle install --without "test development" --path vendor/bundle -j 4 --no-local --no-cache --force  && \
-    LC_ALL=en_US.UTF-8 RAILS_ENV=production SECRET_KEY_BASE=secret DATABASE_ADAPTER=postgresql bundle exec rake assets:clean assets:precompile && \
+    LC_ALL=en_US.UTF-8 RAILS_ENV=production SECRET_KEY_BASE=secret bundle install --without "test development" --path vendor/bundle -j 4 --no-local --no-cache --force  && \
+    LC_ALL=en_US.UTF-8 RAILS_ENV=production SECRET_KEY_BASE=secret bundle exec rake assets:clean assets:precompile && \
     chmod g=u /app/Gemfile.lock /app/config/ /app/tmp/
 
 
 EXPOSE 3000
 
-COPY ["docker/scripts/setup_env", "docker/scripts/init", "/scripts/"]
+COPY docker/scripts/init /scripts/
 CMD ["/scripts/init"]
 
 USER 1001

Gemfile

@@ -38,6 +38,7 @@ gem 'dotenv', '~> 2.5.0'
 gem 'faraday', '~> 0.9'
 gem 'faraday_middleware', '~> 0.12.2'
 gem 'feedjira', '~> 2.2'
+# TODO: use font-awesome-rails?
 gem 'font-awesome-sass', '~> 5.12.0'
 gem 'httparty', '~> 0.16'
 gem 'jquery-rails', '~> 4.3.5'
@@ -57,7 +58,6 @@ gem 'rails-html-sanitizer', '~> 1.3.0'
 gem 'coffee-rails', '~> 4.2.2'
 # TODO: update
 gem 'rufus-scheduler', '~> 3.4.2', require: false
-gem 'sass-rails', '~> 5.0'
 gem 'sassc', '~>2.3.0'
 # TODO: update
 gem 'select2-rails', '~> 3.5.4'
@@ -71,9 +71,9 @@ gem 'jquery-datatables', '~> 1.10.19'
 gem 'grape', '~> 1.3.2'
 gem 'grape-entity', '~> 0.8.0'
 gem 'jwt', '~> 2.2.1'
+gem 'foreman', '~> 0.87.1'
 
 group :development do
-  gem 'foreman', '~> 0.87.1'
   gem 'bullet', '~> 6.1.0'
   gem 'sqlite3', '~> 1.4.2'
   gem 'better_errors', '~> 2.7.0'
@@ -114,11 +114,4 @@ end
 
 gem 'puma', '~> 4.3.5'
 
-ENV['DATABASE_ADAPTER'] ||=
-  if ENV['RAILS_ENV'] == 'production'
-    'postgresql'
-  else
-    'sqlite3'
-  end
-
 gem 'pg', '~> 1.2.3'

Gemfile.lock

@@ -197,7 +197,7 @@ GEM
       faraday_middleware (>= 0.9)
       loofah (>= 2.0)
       sax-machine (>= 1.0)
-    ffi (1.12.2)
+    ffi (1.13.1)
     font-awesome-sass (5.12.0)
       sassc (>= 1.11)
     foreman (0.87.1)
@@ -508,12 +508,6 @@ GEM
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    sass-rails (5.1.0)
-      railties (>= 5.2.0)
-      sass (~> 3.1)
-      sprockets (>= 2.8, < 4.0)
-      sprockets-rails (>= 2.0, < 4.0)
-      tilt (>= 1.1, < 3)
     sassc (2.3.0)
       ffi (~> 1.9)
     sassc-rails (2.1.2)
@@ -666,7 +660,6 @@ DEPENDENCIES
   rturk (~> 2.12.1)
   rubocop (~> 0.82.0)
   rufus-scheduler (~> 3.4.2)
-  sass-rails (~> 5.0)
   sassc (~> 2.3.0)
   select2-rails (~> 3.5.4)
   selenium-webdriver (~> 3.142.7)

Makefile

@@ -9,15 +9,6 @@ build-image:
 HEROKU_APP = $(shell heroku apps:info | grep 'Web URL' | awk -F'[/.]' '{print $$3}')
 HEROKU_CONTAINER = registry.heroku.com/${HEROKU_APP}/web
 
-.PHONY: heroku-docker-push
-heroku-docker-push:
-	docker tag local/active_workflow ${HEROKU_CONTAINER}
-	docker push ${HEROKU_CONTAINER}
-
-.PHONY: heroku-docker-release
-heroku-docker-release:
-	heroku container:release web
-
 .PHONY: test
 test:
 	bundle exec rspec spec

Procfile

@@ -1,23 +1,3 @@
-# Use configuration bellow to run jobs on a separate dyno.
 web: bundle exec puma
-scheduler: bundle exec rails runner bin/pro_scheduler.rb
-worker: bundle exec script/delayed_job -n 4 run
-
-###############################
-# Multiple DelayedJob workers #
-###############################
-# Per default ActiveWorkflow can just run one agent at a time. Using a lot of agents or calling slow
-# external services frequently might require more DelayedJob workers (an indicator for this is
-# a backlog in your 'Job Management' page).
-# Every uncommented line starts an additional DelayedJob worker. This works for development, production
-# and for the threaded and separate worker processes. Keep in mind one worker needs about 300MB of RAM.
-#
-#dj2: bundle exec script/delayed_job -i 2 run
-#dj3: bundle exec script/delayed_job -i 3 run
-#dj4: bundle exec script/delayed_job -i 4 run
-#dj5: bundle exec script/delayed_job -i 5 run
-#dj6: bundle exec script/delayed_job -i 6 run
-#dj7: bundle exec script/delayed_job -i 7 run
-#dj8: bundle exec script/delayed_job -i 8 run
-#dj9: bundle exec script/delayed_job -i 9 run
-#dj10: bundle exec script/delayed_job -i 10 run
+scheduler: bundle exec rails runner bin/scheduler.rb
+worker: bundle exec script/delayed_job -n 2 run

README.md

@@ -327,24 +327,13 @@ button bellow and fill in the environment variables for your seed user (admin):
 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/automaticmode/active_workflow)
 
 A free Heroku plan could be used to try out ActiveWorkflow, but it wouldn't be
-enough for real use. That's because the limited run time and automatic turning
-off of unused workers inhibits ActiveWorkflow from running scheduled tasks.
+enough for real use. This is controlled by setting `SINGLE_DYNO` environment
+variable to '1'. In such a case all the processes (web, scheduler, workers) are
+run in a single dyno. This is only recommended for demonstration purposes,
+though. For production use you should unset `SINGLE_DYNO` (or set to an empty
+value) and run web, scheduler and worker dynos separately. Note: you should
+never create more than one scheduler dyno.
 
-### Manual Heroku Deployment
-
-If you would like more control or intend to deploy ActiveWorkflow from a modified
-source tree, you could do that using Heroku's command line interface.
-
-Please install Heroku's command line interface tool from
-[Heroku Toolbelt](https://toolbelt.heroku.com).
-
-For additional configuration options please take a look at the `.env` file.
-Don't forget to set any configuration options you may require using the
-`heroku config` command line tool.
-
-FIXME:
-The default ActiveWorkflow configuration uses the same single dyno to run both
-the web server and workers.
 
 ### Deployment with Docker
 
@@ -377,34 +366,6 @@ make build-image
 This creates an image named `local/active_workflow`.
 
 
-#### Deployment with Docker to Heroku
-
-You may prefer to use Heroku in a container mode (instead of deploying via
-GitHub). Please be sure to login to Heroku docker registry before doing that:
-
-```sh
-heroku container:login
-```
-
-Docker deployment to Heroku happens in two steps. Push:
-
-```sh
-make heroku-docker-push
-```
-
-And release:
-
-```sh
-make heroku-docker-release
-```
-
-If you no longer wish to use image based deployment to Heroku you will need to
-reset Heroku stack to `heroku-18` like this:
-
-```sh
-heroku stack:set heroku-18
-```
-
 ## Development
 
 ### Requirements
@@ -427,11 +388,23 @@ brew install graphviz
 
 ### Running Locally without Docker
 
-If you want to test out ActiveWorkflow locally you can start a demo instance
-using a local sqlite database. First prepare the database with:
+ActiveWorkflow uses Postgres database to store all the data. If you have
+Postgres database set up all you need is set environment variable DATABASE_URL
+for the ActiveWorkflow to use like this:
+
+```sh
+export DATABASE_URL=postgres://mydbusername:password@localhost:5432/dbname
+```
+
+> You can also reuse postgres docker image preconfigured for use with
+> ActiveWorkflow when running it with docker-compose. You can start it with
+> `docker-compose up postgres` and stop with `Ctrl+C` and `docker-compose down`
+> afterwards.
+
+Before running ActiveWorkflow you have to prepare the database with:
 
 ```sh
-bundle exec rake db:create
+#bundle exec rake db:create # Optionally create database if you haven't created it in advance
 bundle exec rake db:migrate
 bundle exec rake db:seed
 ```

app.json

@@ -3,24 +3,28 @@
     "description": "Business process automation platform.",
     "website": "https://github.com/automaticmode/active_workflow",
     "repository": "https://github.com/automaticmode/active_workflow",
-    "buildpacks": [
-      {
-        "url": "heroku/ruby"
-      },
-      {
-        "url": "https://github.com/weibeld/heroku-buildpack-graphviz.git"
+    "stack": "container",
+    "formation": {
+      "web": {
+        "quantity": 1,
+        "size": "free"
       }
-    ],
+    },
     "env": {
+        "SINGLE_DYNO": {
+          "description": "Set to '1' if you want to run all the processes in a single dyno, leave empty otherwise. Usable only for demonstration purposes. Do not run scheduler and worker dynos if running in SINGLE_DYNO mode.",
+          "value": "1"
+        },
         "SEED_USERNAME": "admin",
         "SEED_PASSWORD": "password",
         "SEED_EMAIL": "admin@example.com",
         "SECRET_KEY_BASE": {
             "generator": "secret"
-        }
-    },
-    "scripts": {
-      "postdeploy": "bundle exec rake db:migrate db:seed"
+        },
+        "RAILS_ENV": "production",
+        "RAILS_LOG_TO_STDOUT": "enabled",
+        "RAILS_MAX_THREADS": "2",
+        "RAILS_SERVE_STATIC_FILES": "enabled"
     },
     "addons": ["heroku-postgresql"],
     "success_url": "/"