shippy 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e53546e6bcac389ac600b0432bed0809b162857622e3bc560dbc98ea87da94
-  data.tar.gz: bc1e127d902f21cf04d3282d3f04c10db1aff3ea6113df213e2af0ceea8e69f4
+  metadata.gz: e28ff568f47b1c6ab79cd83a7f136a07187f9966d71fc134200396f9a7f235c4
+  data.tar.gz: c3d4d946f98cfc6c993e00ff3e5bc685261a34e05bad9b1e9e7c776a5fe26bf2
 SHA512:
-  metadata.gz: 430ed1debda3020d516dd4d5902b6b176a747cb53d9775eed6e49ecf070fe5cd028b3ed343641d60c3e38959e918d9d8730d3bb9a6aba43a7650393aa24b55b1
-  data.tar.gz: 2596088fa15a92310a8fd4e5db8909267892b1c04b4cbaacbeffe37fceaf8ba1905c57580ac9d8cf277e94b64629cb88e97620aef6f7db9de6c81db4e5d3cbb4
+  metadata.gz: c964e8762f426cae3ed46adb35c117dc327a15f9a378a39015ebe30b17bc045418a6bbbe786988f48884cb96e71863436693fd53267ca6fb9662efd272b045af
+  data.tar.gz: e87db690c30bb9939114fd95a06f315c0356f79efceff5353baaf99ea9cadabfe54d0e89465f7f5e5c0d8c7cc43cd3d39e024123a8803b8581a310542fc7d4c1

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
 

data/lib/shippy/version.rb

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

metadata

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