Minke

Minke is an opinionated build system for Microservices and Docker, like a little envelope of quality it scaffolds the build, run and test (unit test and functional tests) phases of your microservice project allowing you to simply run and test your images using Docker Compose. Currently supporting Google's Go, extensions are planned for Node.js or HTML / Javascript sites with Grunt or Gulp based builds.

Installation

Add this line to your application's Gemfile:

gem 'minke'

And then execute:

$ bundle

Or install it yourself as:

$ gem install minke

Dependencies

Docker

You need to have docker, docker-machine, and docker-compose installed on your build machine and the docker environment variables must be set. If using the docker-toolkit on a mac you can set these by running...

eval "$(docker-machine env default)"

Usage

Include the rake tasks in your Rakefile

require 'minke'

spec = Gem::Specification.find_by_name 'minke'
Rake.add_rakelib "#{spec.gem_dir}/lib/minke/rake"

By default Go builder looks for a config file (config.yml) in the same folder as your Rakefile

Go builder provides the following tasks...

rake app:test

Gets your packages dependencies then executes go test against the package.

rake app:build

Creates a linux binary for your application, runs app:test before execution.

rake app:build_server

Creates a docker image for your application, runs app:build before execution.

rake app:build_and_run

Creates a docker image for your application then starts the application using docker-compose, runs app:build_server before execution.

rake app:cucumber[optional feature tag]

Starts the application and then runs cucumber to execute your features, you can optionally pass a feature tag to this command to configure which part of your test suite you would like to run. Does not build the server before running, this needs to be done when you change your source code with app:build_server.

rake app:push

Pushes the built image to the configured registry, does not build the image before execution, this can be done manually with app:build_server.

Config File

The config file config.yml is where you set the various configuration for the build process.

Example Config File

go:
  namespace: 'github.com/nicholasjackson'
  application_name: 'event-sauce'
docker_registry:
  url: <%= ENV['DOCKER_REGISTRY_URL'] %>
  user: <%= ENV['DOCKER_REGISTRY_USER'] %>
  password: <%= ENV['DOCKER_REGISTRY_PASS'] %>
  email: <%= ENV['DOCKER_REGISTRY_EMAIL'] %>
  namespace: <%= ENV['DOCKER_NAMESPACE'] %>
docker:
  docker_file: './'
  compose_file: './'
  build_args:
    image: 'golang:latest'
    env:
      - 'CGO_ENABLED=0' # used for alpine linux static linking
    working_directory: '/go/src/github.com/nicholasjackson/event-sauce'
run:
  consul_loader:
    enabled: true
    config_file: './config.yml'
    url: <%= "http://#{ENV['DOCKER_IP']}:9500" %>
cucumber:
  consul_loader:
    enabled: true
    config_file: './config.yml'
    url: <%= "http://#{ENV['DOCKER_IP']}:9500" %>
  health_check:
    enabled: true
    url: <%= "http://#{ENV['DOCKER_IP']}:8001/v1/health" %>
  after_start:
    - 'wait_for_elastic_search'
after_build:
  copy_assets:
    -
      from: <%= "#{ENV['GOPATH']}/src/github.com/nicholasjackson/event-sauce/event-sauce" %>
      to: './docker/event-sauce'
    -
      from: './swagger_spec/swagger.yml'
      to: './dockerfile/event-sauce/swagger_spec/swagger.yml'

go:

This section contains the configuration for the build process.
namespace: namespace for your application code within your GOPATH, this is generally the same as your repository.
application_name: name of the built binary.

docker_registry:

This section contains the configuration for the docker registry to push the image to. Images are pushed to the registry prefixed with the namespace and application_name, e.g. nicholasjackson/event-sauce:latest.
url: url for the docker registry.
user: username to use when logging into the registry.
password: password to use when logging into the registry.
email: email address to use when logging into the registry.
namespace: namespace of your image to use when pushing the image to the registry.

docker:

This section contains configuration for the Docker build and run process.
docker_file: path to the folder containing your Dockerfile used by the build_server task.
compose_file: path to your docker-compose file for run and cucumber tasks.

run:

consul_loader:

When the application is run using docker-compose you can load some default config into your consul server. Told you this was opinionated, if you are building microservices you are using consul right?
enabled: boolean determining if this feature is enabled.
config_file: path to a yaml file containing the key values you would like to load into consul. consul_loader flattens the structure of your yaml file and converts this into key values. For more information please see

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/go_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.