orchparty 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f89243d6fae72722e405faaebd5474333b809fe7
+  data.tar.gz: f91105683995435802fd753a8898e70dc5ecc280
+SHA512:
+  metadata.gz: 817fbaaa5bfed13ca75119641c50f30c59acfeb96d4570628595406bec6d2b1932ca8f45d960034954132d8f889e52b65befe96c601534e974d6aa6ee18f9d77
+  data.tar.gz: c9d8e7430128f01d17623e509ad5896892a6a2105fec115f1a84f4f6d2853307e6547aa85c87a6986ca5e372500799a79a1d0d566248914fc702629e70bc9729

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+language: ruby
+rvm:
+- 2.2
+- 2.3
+- 2.4
+before_install: gem install bundler -v 1.13.6
+install: bundle install
+script: bundle exec rspec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: XnUBF2iCbMQXD/hUDcbOF2Y66x2A+Fjg0qx5ceJB7ctOnh2Q6NWMjcxF0oINteryzY78gbI3BB0GnemX8nrvJ/kLxgVWSOPBPlR1ufREekSkElPnccGi6oH8D6goI0d3rtB81cwOzJl+BhXCLFiJRvySOmDBw87ENhianMwhNf+6oW/QgAHKHKuu9hJM91u5Z+8dw8x5iqMtxxiiCPSmd9T6PDknJDD3sz2XdSOMGRQO9EqFQSdngX6AbRRgOewY+klXCut44Vc8SefIqtmRQ6/VF5onTNeLL4ZJkiazS2r4Xi93jl0/lzIamqDIinbVFx5xVH1Kb3JyjkRnW/Ah6tHtwQZlJUuJLQbRFKDY+w3dXKKn7rLaV3neQ9q/0TxlHuUQqQsLV6cY38Xb0y/x+xYvNaWy7oDLe836dHIvxec3Ea7t0wt2HMk5jVuFDNm3TnSvu7mYbF+ZoYyYLFLtX35KMu7WMDQnHU6zvJPdE6EFENoximY/MiX0vvco0Z4HiQmJFRrmvA/gGKgn7qpan+6oysrLg/oVWOgYbc5BQmLoX9jxnb//BSWlxxD85tBGlG/IO1pOU/FAFNlbheqxfoF/YUyWJQCIX0V1H13+10KuLBSSX+lg4BkxmluWC4VsqMeMwTHtEgKb7x7nIJsRxmcvyqIeD/noCoSooLgUH+A=
+  gem: orchparty
+  on:
+    tags: true
+    repo: jannishuebl/orchparty
+    rvm: 2.4

data/CNAME

@@ -0,0 +1 @@
+orch.party

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jannis.huebl@web.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in orchparty.gemspec
+gemspec
+gem 'byebug'

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,363 @@
+# Orchparty
+
+[![Build Status](https://travis-ci.org/jannishuebl/orchparty.svg?branch=master)](https://travis-ci.org/jannishuebl/orchparty)
+
+Write your orchestration configuration with a Ruby DSL that allows you to have mixins, imports and variables.
+
+```ruby
+import "../logging.rb"
+
+application 'my-cool-app' do
+  variables do
+    var port: 8080
+  end
+
+  service "api" do
+    mix "logging.syslog"
+    image "my-cool-image:latest"
+    commad -> { "bundle exec rails s -b 0.0.0.0 -p #{port}" }
+  end
+
+end
+```
+
+## Why the Hell?
+
+### 1. Powerfull Ruby DSL as a YAML replacement
+
+Yaml is great when it comes to Configuration, it gives a clean syntax that is
+build for humans, but is still maschine readable. For most of the
+configurations it is good enough. It even supports features like referencing,
+inheritence and multiline Strings. 
+
+In our company we run a microservcie architecture with multiple applications,
+that by themselves consits of multiple services (container types).
+But what we have realizes was that our orchestration configuration grew and got
+hell complex, which made globle changes like replacing our logging
+infrastucture quite painfull, because we need to touch every single service.
+
+Some features that we wanted to have:
+
+  1. Mixin support
+  1. Import from diffrent files
+  1. Using Variables in imported config eg. Stack/Service names
+
+
+Some of the features are build in YAML but were to complex for us to use.
+
+
+### 2. Use Ruby instead of Templating engines
+
+Most of the Orchestrationframeworks are using a docker-compose.yml derivat.
+But what most of them realized is that yml is not enough for komplex
+orchestration.
+
+So most of the framework teams stated to allow a templatingengine in the
+docker-compose configuration.
+
+But why keep going with a data serialization language when we want to program
+our configuration anyway?
+
+### 3. Have one config for multiple Orchestrationframeworks
+
+How much effort is it to get a application running on an
+Orchestrationframeworks? We am glad when we find a prebuild docker-compose file
+that we can modify eg. for kontena.io, but when we have done it for konena.io we
+have to redo nearly all the work for rancher, kubernets etc.
+
+It would be nice if people start to write the opensource application configs in
+orchparty and we simple compile the config for all popular orchestrationframeworks.
+
+## Installation
+
+For installation it is nessery to have setup a ruby environment, at lease ruby
+2.2 is needed.
+
+Install from rubygems.org
+
+    $ gem install orchparty
+
+Maybe in the future it is possible to run it in a docker container, so no local
+ruby environment is needed.
+
+## Usage
+
+See the commandline usage instrucution by running:
+
+    $ orchparty help
+
+## DSL spec
+
+So lets do an example let us orchparty a beutiful app called [app_perf](https://github.com/randy-girard/app_perf) that is a
+open source replacement of new relic !
+
+### Applications
+
+app_perf need a postgres to store data, redis for a queing system, a web
+handler, where all metrics are send to, and a worker that process the metrics
+and inserts them to the postgres db.
+
+```ruby
+application "app_perf" do
+
+  service "web" do
+    image "blasterpal/app_perf"
+    command "bundle exec rails s -p 5000"
+    expose 5000
+    links do 
+      link "redis"
+      link "postgres"
+    end
+  end
+
+  service "worker" do
+    image "blasterpal/app_perf"
+    command "bundle exec sidekiq"
+    links do 
+      link "redis"
+      link "postgres"
+    end
+  end
+
+  service "redis" do
+    image "redis"
+  end
+
+  service "postgres" do
+    image "postgres"
+  end
+
+end
+```
+
+
+### Applevel Mixins
+
+But maybe we would want a production setup where we do not shipp a postgres
+because we want to use an exteral services like RDS from AWS.
+
+```ruby
+mixin "app_perf" do
+
+  service "web" do
+    image "blasterpal/app_perf"
+    command "bundle exec rails s -p 5000"
+    expose 5000
+    links do 
+      link "redis"
+    end
+  end
+
+  service "worker" do
+    image "blasterpal/app_perf"
+    command "bundle exec sidekiq"
+    links do 
+      link "redis"
+    end
+  end
+
+  service "redis" do
+    image "redis"
+  end
+
+end
+
+application 'app_perf-dev' do
+  mix "app_perf"
+
+  service "web" do
+    links do 
+      link "postgres"
+    end
+  end
+
+  service "worker" do
+    links do 
+      link "postgres"
+    end
+  end
+
+  service "postgres" do
+    image "postgres"
+  end
+
+end
+
+application 'app_perf-prod' do
+  mix "app_perf"
+
+  service "web" do
+    environment do
+      env POSTGRES_HOST: "rds-domain.amazon.com"
+    end
+  end
+
+  service "worker" do
+    environment do
+      env POSTGRES_HOST: "rds-domain.amazon.com"
+    end
+  end
+
+end
+```
+
+### Service level Mixin
+
+But we might also mixin a logging config in production.
+
+```ruby
+mixin "logging" do
+
+  service "syslog" do
+    logging do 
+      conf driver: "syslog"
+      options do
+        opt syslog-address: "tcp://192.168.0.42:123"
+      end
+    end
+  end
+
+end
+
+
+application 'app_perf-prod' do
+  mix "app_perf"
+
+  service "web" do
+    mix "logging.syslog"
+    environment do
+      env POSTGRES_HOST: "rds-domain.amazon.com"
+    end
+  end
+
+  service "worker" do
+    mix "logging.fluentd"
+    environment do
+      env POSTGRES_HOST: "rds-domain.amazon.com"
+    end
+  end
+
+end
+```
+
+### Commonblock
+
+Maybe we want to add something to all services in one application. Of cause
+this also adds the mix "logging.syslog" and environment variables to the redis and postgres service.
+
+```ruby
+application 'app_perf-prod' do
+  mix "app_perf"
+
+  all do
+    mix "logging.syslog"
+    environment do
+      env POSTGRES_HOST: "rds-domain.amazon.com"
+    end
+  end
+
+  service "web" do
+  end
+
+  service "worker" do
+  end
+
+end
+```
+
+### Variables
+
+You want to use variables right? Becase DRY ;) well you can: 
+
+```ruby
+application "app_perf" do
+  variables do
+    var image: "blasterpal/app_perf"
+  end
+
+  service "web" do
+    variables do
+      # service local variables
+    end
+    image -> { image }
+    command -> { "bundle exec rails s -p #{ service.expose }" }
+    expose 5000
+    links do 
+      link "redis"
+      link "postgres"
+    end
+  end
+
+  service "worker" do
+    image -> { image }
+    command "bundle exec sidekiq"
+    links do 
+      link "redis"
+      link "postgres"
+    end
+  end
+
+  service "redis" do
+    image "redis"
+  end
+
+  service "postgres" do
+    image "postgres"
+  end
+
+end
+```
+
+special variables:
+
+  1. service:
+    - service.name
+  1. application:
+    - application.name
+
+### Import
+
+Above we assumend that everything is written in one file. If you donot want to
+to that use the import feature.
+
+```ruby
+import "../logging.rb"
+import "./app_perf.rb"
+
+application 'app_perf-prod' do
+  mix "app_perf"
+
+  all do
+    mix "logging.syslog"
+    environment do
+      env POSTGRES_HOST: "rds-domain.amazon.com"
+    end
+  end
+
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jannishuebl/orchparty.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [GNU Lesser General Public License v3.0](http://www.gnu.de/documents/lgpl-3.0.en.html).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "orchparty"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here