shippy 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e53546e6bcac389ac600b0432bed0809b162857622e3bc560dbc98ea87da94
-  data.tar.gz: bc1e127d902f21cf04d3282d3f04c10db1aff3ea6113df213e2af0ceea8e69f4
+  metadata.gz: e6045bbdd9f3d3ec7b83b88dc28809c7d3f5391c421b1d8972793e468eb23486
+  data.tar.gz: 63a4e730a4a4637b5d8f4eb13be9330ec6058f622ea17d4bc4cea6e98be26355
 SHA512:
-  metadata.gz: 430ed1debda3020d516dd4d5902b6b176a747cb53d9775eed6e49ecf070fe5cd028b3ed343641d60c3e38959e918d9d8730d3bb9a6aba43a7650393aa24b55b1
-  data.tar.gz: 2596088fa15a92310a8fd4e5db8909267892b1c04b4cbaacbeffe37fceaf8ba1905c57580ac9d8cf277e94b64629cb88e97620aef6f7db9de6c81db4e5d3cbb4
+  metadata.gz: 1fbee88e84f54ad80aa02e4337586a0f5cba380ec20185e8b3fa45bbcb8ad927accef5e03fdda69b2d61a096d62d544100a51faef78e42ac991e81de217efba8
+  data.tar.gz: bef7b11ba7a7219c229f5da67d3caad8a66405514ed62d5c453051740aa9defe4875597866288b4ab7b7cc6bbd4829bc548b8518d53df863acc16ace04b8649d

data/README.md

@@ -40,6 +40,48 @@ This will generate the config files and the `apps` directory with Traefik in the
 
 Now `shippy` can be called using `bin/shippy` binstub and the other commands can be listed using `bin/shippy -h`.
 
+### Docker compose DSL:
+
+Conventions:
+
+- the file needs to be located at `apps/app_name/docker-compose.rb`
+- the `Shippy.define {}` block describes multiple services for the same compose file
+- `service :name` describes a docker service
+- most of the docker-compose keywords are implemented as [methods](./lib/shippy/service.rb) that accept a block.
+- `volumes` and `networks` are automatically defined
+
+Example:
+
+```ruby
+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
+```
+
 ## 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.

data/lib/shippy/service.rb

@@ -2,7 +2,7 @@ module Shippy
   class Service
     ATTRIBUTES = %i[
       build command depends_on devices entrypoint environment hostname image
-      labels logging networks ports restart volumes volumes_from working_dir
+      labels logging networks user ports restart volumes volumes_from working_dir
       security_opt
     ].freeze
 
@@ -56,17 +56,18 @@ module Shippy
       networks { ["lan_access"] }
     end
 
-    def use_traefik(name:, alt: nil, port: nil, healthcheck: nil)
+    def use_traefik(name:, alt: nil, port: nil, healthcheck: false)
       labels do
         all_labels = ["traefik.enable=true"]
-        all_labels += build_traefik_labels(name: name, port: port, healthcheck: healthcheck)
-        all_labels += build_traefik_labels(name: alt, port: port, healthcheck: healthcheck) if alt
+        all_labels += build_traefik_labels(name: name, port: port)
+        all_labels += build_traefik_labels(name: alt, port: port) if alt
+        all_labels += build_ihxator_labels(service: "https://#{name}.#{wildcard_domain}") if healthcheck
 
         all_labels
       end
     end
 
-    def build_traefik_labels(name:, port: nil, healthcheck: nil)
+    def build_traefik_labels(name:, port: nil)
       [
         "traefik.http.routers.websecure-#{name}.rule=Host(`#{name}.#{wildcard_domain}`)",
         "traefik.http.routers.websecure-#{name}.entrypoints=websecure",
@@ -92,14 +93,16 @@ module Shippy
           labels << "traefik.http.routers.web-#{name}.service=#{name}"
           labels << "traefik.http.routers.#{name}-local.service=#{name}"
         end
-
-        if healthcheck
-          labels << "traefik.http.services.#{name}.loadbalancer.healthcheck.path=#{healthcheck}"
-          labels << "traefik.http.services.#{name}.loadbalancer.healthcheck.interval=5s"
-        end
       end
     end
 
+    def build_ihxator_labels(service:)
+      [
+        "ihxator.enable=true",
+        "ihxator.service=#{service}"
+      ]
+    end
+
     def secrets(name)
       @app.secrets(name)
     end

data/lib/shippy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shippy
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Marius Bobin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport