minos 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3e9853e5a1c81483e6f0e946d8e670d1dc947ba9f1d17d045a32c9af2d121c3
+  data.tar.gz: 62b4000e486b49a2fa3002d40b4921926e89ad891e9483c5451ef0fe18a3725a
+SHA512:
+  metadata.gz: 8358d1a238ed0510a5a5d85bd1341d736e9c41a099eb87ced95d8c2db44d3cf555474a2fc9e9ba8ac4233a2022cbfffd04dd867cd227b574fb61f4a4487c0367
+  data.tar.gz: b01639fef57b52f125f5157d1225556aba660a80c0d195c6d5f43bd9c37595a019333ce579e9166a75be74d9f013eaa6fc9d925ba399fd95819e52666e74069d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 pierrelouis.gottfrois@gmail.com. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in minos.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    minos (0.2.0)
+      activesupport (~> 5.2)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.4)
+    i18n (1.5.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minos!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pierre-Louis Gottfrois
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+# Minos
+
+Minos is a gem created at TextMaster to ease our docker deployments on Kubernetes.
+
+## Installation
+
+Run:
+
+```ruby
+gem install minos
+```
+
+## Usage
+
+Minos comes with a binary. You can see its usage with:
+
+    $ minos help
+
+Minos is divided into two components:
+
+  1. Building and publishing docker artifacts
+  2. Deploying docker artifacts on a Kubernetes cluster
+
+### Build
+
+To build docker artifacts, Minos use a declarative config file written in YAML.
+By default Minos will look for a file called `minos.yaml` under the
+current directory. See `--manifest` option to provide in different config file.
+For example:
+
+```yaml
+build:
+  artifacts:
+  - name: builder
+    image: textmasterapps/foo
+    tags:
+    - "$TARGET-latest"
+    docker:
+      # file: MyDockerfile
+      tag: "$IMAGE:$TARGET" # $IMAGE and $TARGET are automatically populated as env vars for you
+      target: builder
+      cacheFrom:
+      - textmasterapps/foo:builder
+      - textmasterapps/foo:builder-latest
+  - name: release
+    image: textmasterapps/foo
+    tags:
+    - "$REVISION" # you can reference ENV variables from your shell
+    - "latest"
+    docker:
+      # file: MyDockerfile
+      tag: "$IMAGE:$TARGET"
+      target: release
+      buildArg:
+        ENV: "production"
+        REVISION: "$REVISION"
+      cacheFrom:
+      - textmasterapps/foo:builder
+      - textmasterapps/foo:$REVISION
+      - textmasterapps/foo:latest
+```
+
+With the following `Dockerfile`, leveraging [multi-stages](https://docs.docker.com/develop/develop-images/multistage-build/):
+
+```
+######################
+# Stage: builder
+FROM ruby:2.5.3-alpine3.7 as builder
+
+ENV HOME /home/app
+WORKDIR $HOME
+
+# Copy the Gemfile and Gemfile.lock
+COPY Gemfile* $HOME/
+
+# Install build deps and gems from all environments under vendor/bundle path
+#
+# - build-base -- used to install gcc, make, etc.
+# - git -- used to install git based gems
+# - libxml2-dev -- used to install nokogiri native extension
+# - libxslt-dev -- used to install nokogiri native extension
+RUN apk add --update --no-cache --virtual .build-deps \
+    build-base \
+    git \
+    libxml2-dev \
+    libxslt-dev \
+ && bundle config build.nokogiri --use-system-libraries \
+ && bundle install --frozen --deployment --jobs 4 --retry 3 \
+ # Remove unneeded build deps
+ && apk del .build-deps
+
+###############################
+# Stage release
+FROM ruby:2.5.3-alpine3.7 as release
+LABEL description="Builds a release image removing unneeded files and dependencies"
+
+# Install runtime deps and create a non-root user
+#
+# - libcurl -- runtime deps for faraday
+# - git -- used to run `git` command in *.gemspec
+# - libxml2 -- used to run nokogiri
+# - libxslt -- used to run nokogiri
+# - tzdata -- used to install TZinfo data
+RUN apk add --update --no-cache \
+    libcurl \
+    git \
+    libxml2 \
+    libxslt \
+    tzdata
+
+# Copy bundle config from builder stage
+COPY --from=builder /usr/local/bundle/config /usr/local/bundle/config
+# Copy bundled gems from builder stage
+COPY --from=builder $HOME/vendor $HOME/vendor
+# Copy source files according to .dockerignore policy
+# Make sure your .dockerignore file is properly configure to ensure proper layer caching
+COPY . $HOME
+
+# Removes development and test gems by re-running the bundle install command
+# using cached gems and simply removing unneeded gems using the clean option.
+RUN bundle install --local --clean --without development test \
+ # Remove unneeded cached gems
+ && find vendor/bundle/ -name "*.gem" -delete \
+ # Remove unneeded files and folders
+ && rm -rf spec tmp/cache node_modules app/assets vendor/assets lib/assets
+
+ENV PORT 8080
+EXPOSE 8080
+
+ENTRYPOINT ["bundle", "exec"]
+
+CMD ["puma", "-C", "config/puma.rb"]
+
+ARG ENV=production
+ARG REVISION
+
+ENV RAILS_ENV $ENV
+ENV REVISION $REVISION
+```
+
+More details about our Dockerfiles at TextMaster can be found on our [Blog](https://medium.com/textmaster-engineering/how-textmaster-reduced-deployment-time-by-using-multi-stages-dockerfile-in-its-ci-pipeline-ffb5e153bfc7)
+
+### Deploy
+
+WIP
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gottfrois/minos. 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 [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Minos project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gottfrois/minos/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "minos"
+
+# 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(__FILE__)

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

data/exe/minos

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'minos'
+
+Minos::CLI.start

data/lib/minos/artifact.rb

@@ -0,0 +1,95 @@
+require 'active_support/core_ext/string/inflections'
+
+module Minos
+  class Artifact
+    attr_reader :artifact, :options
+
+    def initialize(artifact, options: {})
+      @artifact = artifact
+      @options = options
+    end
+
+    def pull
+      caches.each do |cache|
+        docker_pull(cache)
+      end
+    end
+
+    def build
+      docker_build
+    end
+
+    def push
+      docker_push
+    end
+
+    private
+
+    def docker_pull(cache)
+      run "docker inspect #{cache} -f '{{json .ID}}' > /dev/null 2>&1 || docker pull #{cache} 2> /dev/null"
+    end
+
+    def docker_build
+      run "docker build #{to_args(docker)} ."
+    end
+
+    def docker_push
+      tags.each do |tag|
+        run "docker tag #{image}:#{target} #{image}:#{tag}"
+        run "docker push #{image}:#{tag}"
+      end
+    end
+
+    def run(cmd)
+      system("#{envs_as_cmd} && #{cmd}")
+    end
+
+    def envs
+      {
+        'IMAGE'  => image,
+        'TARGET' => target,
+      }
+    end
+
+    def envs_as_cmd
+      envs.map { |k, v| "#{k}=\"#{v}\"" }.join(' ')
+    end
+
+    def docker
+      artifact['docker']
+    end
+
+    def caches
+      docker['cacheFrom']
+    end
+
+    def image
+      artifact['image']
+    end
+
+    def target
+      docker['target']
+    end
+
+    def tags
+      artifact['tags'].to_a
+    end
+
+    def to_args(args)
+      args.map do |key, value|
+        case value
+        when Array
+          value.map do |v|
+            "--#{key.underscore.gsub('_', '-')} #{v}"
+          end
+        when Hash
+          value.map do |k, v|
+            "--#{key.underscore.gsub('_', '-')} #{k}=#{v}"
+          end
+        else
+          "--#{key.underscore.gsub('_', '-')} #{value}"
+        end
+      end.flatten.join(' ')
+    end
+  end
+end

data/lib/minos/cli.rb

@@ -0,0 +1,22 @@
+module Minos
+  class CLI < Thor
+    class_option :manifest, default: "./minos.yaml", desc: "Manifest config file describing docker artifacts"
+    class_option :only, type: :array, default: [], desc: "Process only given artifacts"
+    class_option :except, type: :array, default: [], desc: "Process all but given artifacts"
+
+    desc "build", "Build docker artifacts specified in the manifest"
+    def build
+      invoke 'minos:docker:build', []
+    end
+
+    desc "push", "Publish docker artifacts specified in the manifest"
+    def push
+      invoke 'minos:docker:push', []
+    end
+
+    desc "deploy", "Deploy docker artifacts specified in the manifest"
+    def deploy
+      invoke 'minos:k8s:deploy', []
+    end
+  end
+end

data/lib/minos/docker.rb

@@ -0,0 +1,41 @@
+module Minos
+  class Docker < Thor
+    class_option :manifest, default: "./minos.yaml", desc: "Manifest config file describing docker artifacts"
+    class_option :only, type: :array, default: [], desc: "Process only given artifacts"
+    class_option :except, type: :array, default: [], desc: "Process all but given artifacts"
+
+    desc "build", "Build docker artifacts specified in the manifest"
+    def build
+      artifacts.each do |a|
+        artifact = Artifact.new(a, options: options)
+        artifact.pull
+        artifact.build
+      end
+    end
+
+    desc "push", "Publish docker artifacts specified in the manifest"
+    def push
+      artifacts.each do |a|
+        artifact = Artifact.new(a, options: options)
+        artifact.push
+      end
+    end
+
+    private
+
+    def artifacts
+      artifacts = parse['build']['artifacts'].to_a
+      artifacts.reject! { |a| options[:except].include?(a['name']) } if options[:except].count > 0
+      artifacts.select! { |a| options[:only].include?(a['name']) } if options[:only].count > 0
+      artifacts
+    end
+
+    def parse
+      @parse ||= YAML.load(read)
+    end
+
+    def read
+      File.read(options[:manifest])
+    end
+  end
+end

data/lib/minos/k8s.rb

@@ -0,0 +1,8 @@
+module Minos
+  class K8s < Thor
+    desc "deploy", "Deploy docker artifacts specified in the manifest"
+    def deploy
+      puts "not implemented"
+    end
+  end
+end

data/lib/minos/version.rb

@@ -0,0 +1,3 @@
+module Minos
+  VERSION = '0.2.0'
+end

data/lib/minos.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+require 'thor'
+
+require 'minos/artifact'
+require 'minos/docker'
+require 'minos/k8s'
+require 'minos/cli'
+require 'minos/version'
+
+module Minos
+  class Error < StandardError; end
+end

data/minos.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "minos/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "minos"
+  spec.version       = Minos::VERSION
+  spec.authors       = ["Pierre-Louis Gottfrois"]
+  spec.email         = ["pierre-louis@textmaster.com"]
+
+  spec.summary       = %q{Easy and repeatable Kubernetes deployment based on Docker images}
+  spec.description   = %q{Easy and repeatable Kubernetes deployment based on Docker images}
+  spec.homepage      = "https://github.com/textmaster/minos"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 5.2"
+  spec.add_dependency "thor", "~> 0.20"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: minos
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Pierre-Louis Gottfrois
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Easy and repeatable Kubernetes deployment based on Docker images
+email:
+- pierre-louis@textmaster.com
+executables:
+- minos
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/minos
+- lib/minos.rb
+- lib/minos/artifact.rb
+- lib/minos/cli.rb
+- lib/minos/docker.rb
+- lib/minos/k8s.rb
+- lib/minos/version.rb
+- minos.gemspec
+homepage: https://github.com/textmaster/minos
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Easy and repeatable Kubernetes deployment based on Docker images
+test_files: []