shippy 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16d22f393393da56cb043a62389601922ba62bc3dc7ce8b0f6d11a7b3880f991
-  data.tar.gz: daae530d2031f02777ebee3ee60cc2d2988415498496e6ac37eda94c82b6ec99
+  metadata.gz: 88e53546e6bcac389ac600b0432bed0809b162857622e3bc560dbc98ea87da94
+  data.tar.gz: bc1e127d902f21cf04d3282d3f04c10db1aff3ea6113df213e2af0ceea8e69f4
 SHA512:
-  metadata.gz: fc45722dcf032d0b8d0f0023da31a1d03c97af039851cbd67c81ac1a907587d0f964a6b96c49af1aa05cbea96bb4264c1df6859bf49ad748711394fd9eb2ff93
-  data.tar.gz: 5e1efdbee18892ddcee10e52ad5078c60ed5aad448f98a536f8b54130c4ccae3081176a5262fbec06ab27abea5cb3cd400447fff780cd5c2c5fc1ac012e78b78
+  metadata.gz: 430ed1debda3020d516dd4d5902b6b176a747cb53d9775eed6e49ecf070fe5cd028b3ed343641d60c3e38959e918d9d8730d3bb9a6aba43a7650393aa24b55b1
+  data.tar.gz: 2596088fa15a92310a8fd4e5db8909267892b1c04b4cbaacbeffe37fceaf8ba1905c57580ac9d8cf277e94b64629cb88e97620aef6f7db9de6c81db4e5d3cbb4

data/README.md

@@ -1,24 +1,44 @@
 # Shippy
 
-TODO: Delete this and the text below, and describe your gem
+Container orchestration solution for homelabs inspired by [Capistrano](https://capistranorb.com/) and [mrsk](https://github.com/mrsked/mrsk) and built on top of [docker-compose](https://docs.docker.com/compose/).
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shippy`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Features
 
-## Installation
+- Ruby DSL to generate the docker-compose YAML files
+- Centralized source to define secrets
+- Uses Traefik as a reverse proxy with SSL wildcard support
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```shell
+$ bundle add shippy
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```shell
+$ gem install shippy
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+In you homelab directory execute:
+
+```shell
+homelab$ bundle exec shippy init
+```
+
+Or
+
+```shell
+homelab$ shippy init
+```
+
+This will generate the config files and the `apps` directory with Traefik in the `proxy` app. This can be used as a guide for other apps.
+
+Now `shippy` can be called using `bin/shippy` binstub and the other commands can be listed using `bin/shippy -h`.
 
 ## Development
 
@@ -28,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shippy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/shippy/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/mrbobin/shippy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Shippy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shippy/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Shippy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).

data/lib/shippy/cli/init.rb

@@ -0,0 +1,50 @@
+class Shippy::Cli::Init < Thor::Group
+  include Thor::Actions
+
+  def self.exit_on_failure?
+    true
+  end
+
+  def self.source_root
+    File.dirname(__FILE__)
+  end
+
+  def create_config_file
+    copy_file "templates/config/shippy.yml", "config/shippy.yml"
+  end
+
+  def create_secrets_file
+    copy_file "templates/config/secrets.yml", "config/secrets.yml"
+  end
+
+  def init_gemfile
+    return if ::File.exist?("Gemfile")
+
+    run "bundle init", abort_on_failure: false
+  end
+
+  def add_shippy_to_gemfile
+    insert_into_file "Gemfile", "gem 'shippy', '~> #{Shippy::VERSION}'"
+
+    run "bundle install", abort_on_failure: false
+  end
+
+  def generate_binstubs
+    run "bundle binstubs shippy"
+  end
+
+  def create_default_apps
+    directory "templates/apps", "apps"
+  end
+
+  def init_git
+    run "git init"
+  end
+
+  def genegate_gitignore
+    create_file ".gitignore"
+    insert_into_file ".gitignore", "/.bundle/\n"
+    insert_into_file ".gitignore", "/builds/\n"
+    insert_into_file ".gitignore", "/config/secrets.yml\n"
+  end
+end

data/lib/shippy/cli/main.rb

@@ -1,38 +1,9 @@
 require "thor"
 
 class Shippy::Cli::Main < Shippy::Cli::Base
-  desc "init", "Create config stub in config/shippy.yml"
-  option :bundle, type: :boolean, default: false, desc: "Add SHIPPY to the Gemfile and create a bin/shippy binstub"
+  desc "init", "Create config files and app setup"
   def init
-    require "fileutils"
-
-    if (config_file = Pathname.new(File.expand_path("config/shippy.yml"))).exist?
-      puts "Config file already exists in config/shippy.yml (remove first to create a new one)"
-    else
-      FileUtils.mkdir_p config_file.dirname
-      FileUtils.cp_r Pathname.new(File.expand_path("templates/shippy.yml", __dir__)), config_file
-      puts "Created configuration file in config/shippy.yml"
-    end
-
-    if Pathname.new(File.expand_path("apps")).exist?
-      puts "Apps directory already exists in ./apps (remove first to create a new one)"
-    else
-      FileUtils.mkdir_p "apps"
-      puts "Created apps directory in ./apps"
-    end
-
-    if options[:bundle]
-      if Pathname.new(File.expand_path("bin/shippy")).exist?
-        puts "Binstub already exists in bin/shippy (remove first to create a new one)"
-      else
-        puts "Adding SHIPPY to Gemfile and bundle..."
-        run_locally do
-          execute :bundle, :add, :shippy
-          execute :bundle, :binstubs, :shippy
-        end
-        puts "Created binstub file in bin/shippy"
-      end
-    end
+    Shippy::Cli::Init.new.invoke_all
   end
 
   desc "version", "Show SHIPPY version"

data/lib/shippy/cli/templates/apps/proxy/docker-compose.rb

@@ -0,0 +1,27 @@
+Shippy.define do
+  service :proxy do
+    image { "traefik:v2.9" }
+    command { "--configFile=/config/config.yml" }
+
+    environment do
+      {
+        CF_API_EMAIL: secrets(:cloudflare_email),
+        CF_DNS_API_TOKEN: secrets(:cloudflare_token)
+      }
+    end
+
+    ports do
+      ["80:80", "443:443", "8080:8080"]
+    end
+
+    volumes do
+      [
+        "/var/run/docker.sock:/var/run/docker.sock",
+        "./traefik:/config",
+        "acme:/etc/traefik/acme"
+      ]
+    end
+
+    use_default_options
+  end
+end

data/lib/shippy/cli/templates/apps/proxy/traefik/config.yml.erb

@@ -0,0 +1,27 @@
+providers:
+  docker:
+    exposedByDefault: false
+  file:
+    filename: "/config/dynamic_config.yml"
+
+api:
+  insecure: true
+  dashboard: true
+
+entryPoints:
+  web:
+    address: ":80"
+  websecure:
+    address: ":443"
+
+log:
+  level: TRACE
+accessLog: {}
+
+certificatesResolvers:
+  ssl-resolver:
+    acme:
+      email: <%= secrets(:cloudflare_email) %>
+      storage: /etc/traefik/acme/acme.json
+      dnsChallenge:
+        provider: cloudflare

data/lib/shippy/cli/templates/apps/proxy/traefik/dynamic_config.yml

@@ -0,0 +1,7 @@
+http:
+  routers:
+  middlewares:
+    secure-redirect-scheme:
+      redirectscheme:
+        scheme: https
+        permanent: true

data/lib/shippy/cli/templates/config/secrets.yml

@@ -0,0 +1,3 @@
+proxy:
+  cloudflare_email: me@example.org
+  cloudflare_token: token

data/lib/shippy/cli/templates/{shippy.yml → config/shippy.yml}

@@ -3,6 +3,5 @@ ssh:
   user: root
 wildcard_domain: 'local.homelab.com'
 local_domain: local
-secrets:
-  proxy:
-    token: TOKEN
+deploy_to: '/var/lib/homelab'
+secrets_file: 'config/secrets.yml'

data/lib/shippy/cli.rb

@@ -1,4 +1,5 @@
 require_relative "cli/base"
+require_relative "cli/init"
 require_relative "cli/server"
 require_relative "cli/app"
 require_relative "cli/prune"

data/lib/shippy/config.rb

@@ -4,13 +4,11 @@ module Shippy
 
     def initialize(file)
       @data = YAML.load_file(file).deep_symbolize_keys
+      @secrets = Secrets.new(@data.fetch(:secrets_file))
     end
 
     def secrets(app, name)
-      @data
-        .fetch(:secrets)
-        .fetch(app.to_sym)
-        .fetch(name.to_sym)
+      @secrets.fetch(app, name)
     end
 
     def ssh_options
@@ -30,15 +28,15 @@ module Shippy
     end
 
     def method_missing(name, *args)
-      if @data.key?(name)
-        @data.fetch(name)
+      if data.key?(name)
+        data.fetch(name)
       else
         super
       end
     end
 
     def respond_to_missing?(name, include_private = false)
-      @data.key?(name) || super
+      data.key?(name) || super
     end
   end
 end

data/lib/shippy/secrets.rb

@@ -0,0 +1,15 @@
+module Shippy
+  class Secrets
+    attr_reader :data
+
+    def initialize(file)
+      @data = YAML.load_file(file).deep_symbolize_keys
+    end
+
+    def fetch(app, name)
+      data
+        .fetch(app.to_sym)
+        .fetch(name.to_sym)
+    end
+  end
+end

data/lib/shippy/version.rb

@@ -1,3 +1,3 @@
 module Shippy
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/shippy.rb

@@ -9,6 +9,7 @@ require "minitar"
 require "zlib"
 
 require_relative "shippy/version"
+require_relative "shippy/secrets"
 require_relative "shippy/config"
 require_relative "shippy/commander"
 require_relative "shippy/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shippy
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Marius Bobin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-25 00:00:00.000000000 Z
+date: 2023-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -163,15 +163,21 @@ files:
 - lib/shippy/cli.rb
 - lib/shippy/cli/app.rb
 - lib/shippy/cli/base.rb
+- lib/shippy/cli/init.rb
 - lib/shippy/cli/main.rb
 - lib/shippy/cli/prune.rb
 - lib/shippy/cli/server.rb
-- lib/shippy/cli/templates/shippy.yml
+- lib/shippy/cli/templates/apps/proxy/docker-compose.rb
+- lib/shippy/cli/templates/apps/proxy/traefik/config.yml.erb
+- lib/shippy/cli/templates/apps/proxy/traefik/dynamic_config.yml
+- lib/shippy/cli/templates/config/secrets.yml
+- lib/shippy/cli/templates/config/shippy.yml
 - lib/shippy/commander.rb
 - lib/shippy/compiler.rb
 - lib/shippy/compose.rb
 - lib/shippy/config.rb
 - lib/shippy/repo.rb
+- lib/shippy/secrets.rb
 - lib/shippy/service.rb
 - lib/shippy/version.rb
 homepage: https://mbobin.me/shippy