Skip to content
This repository has been archived by the owner on Feb 2, 2021. It is now read-only.

jwhitcraft/dockercompose-generator

Repository files navigation

DockerCompose::Generator

Build Status Coverage Status Code Climate Gem Version

Generate a Docker-Compose Yaml file

Installation

Add this line to your application's Gemfile:

gem 'dockercompose-generator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dockercompose-generator

Usage

generator = DockerCompose::Generator
mysql = generator.create_service('db', 'mysql:5.6')
mysql.add_environment('mysql_root_password', 'root')
mysql.add_environment('mysql_database', 'test')
mysql.add_environment('mysql_user', 'test')
mysql.add_environment('mysql_password', 'test')
elastic = generator.create_service('elastic', 'elasticsearch:1.4')
web = generator.create_service('web', 'php:5.6-apache')
web.add_link(elastic)
web.add_link(mysql, 'mysql')
puts generator.to_yaml

will output

db:
  image: mysql:5.6
  environment:
    MYSQL_ROOT_PASSWORD: root
    MYSQL_DATABASE: test
    MYSQL_USER: test
    MYSQL_PASSWORD: test
elastic:
  image: elasticsearch:1.4
web:
  image: php:5.6-apache
  links:
  - elastic
  - db:mysql

TODO

  • Support more options than links, ports, and environment variables
  • Add an Importer to seed the services

Contributing

  1. Fork it ( https://github.com/jwhitcraft/dockercompose-generator/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request