shippy 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a2298a6d94f32d0806671b2a6bac47a04cfeb628b40e4c7d265c9212de2a9a5
-  data.tar.gz: 6afec3af342b493695d3afdb34a7f4bf6c1ab839393e595c123005fb9e3a6d93
+  metadata.gz: 1fe36006872a9b130eecbfa26b391a3a645dafaced62917c530ac9510944abd8
+  data.tar.gz: a8c0268d4cdb6c776600a21038eeb5de722c7601a770a8f33630bb8b414f0fc6
 SHA512:
-  metadata.gz: ec171c742bd1808a0647b2c5a017d4db62ed26e6e0c832844fc2438b966eb5cf5bb5474b958f7cc92f8f91e127f4ee60fe5df31ee3489a1e28404d5b685961b8
-  data.tar.gz: 46c255b01d31766abd742c1321d1316abdfa8ad73fef2862c803420ffe25f535e3621c98c7e60d294770eb25b3d6f0b54d54d02f213702321d0de4cfe1d75136
+  metadata.gz: 7b70994648b3f4c7c842460b335faf0f9a70ae62fff47a3236bcf145d052d45a189c05bddf72cbc1be14ce692f854366df846b925fa248a7ca841c65354a7340
+  data.tar.gz: abd35fa707247d73707c3c41ec15e5f65cb46d01a386aa48a7c003f92640b341ccb3cfd229224e03c759dcdf064cf2cfd960663bc0af79c085ea866897a51dd5

data/README.md

@@ -1,44 +1,33 @@
-# Shippy
+# 🚢 Shippy
 
-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/).
+Shippy is a lightweight container orchestration tool designed specifically for homelabs. It combines the simplicity of Docker Compose with a powerful Ruby DSL, inspired by the deployment workflows of Capistrano and Kamal.
 
 ## Features
 
 - Ruby DSL to generate the docker-compose YAML files
 - Centralized source to define secrets
 - Uses Traefik as a reverse proxy with SSL wildcard support
+- Manage the entire lab with a local `bin/shippy` command.
 
-## Installation
+## 🚀 Getting Started
 
-Install the gem and add to the application's Gemfile by executing:
-
-```shell
-$ bundle add shippy
-```
-
-Or
+Install the gem:
 
 ```shell
 $ gem install shippy
 ```
 
-## Usage
-
 In you homelab directory execute:
 
 ```shell
-homelab$ bundle exec shippy init
-```
-
-Or
-
-```shell
+home$ mkdir homelab && cd homelab
 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`.
+This creates the core structure:
+- `apps/`: Where your service definitions live.
+- `config/`: Shippy configuration and secrets.
+- `bin/shippy`: Your local entry point for all commands.
 
 ### Docker compose DSL:
 
@@ -55,7 +44,7 @@ Example:
 ```ruby
 Shippy.define do
   service :proxy do
-    image { "traefik:v2.9" }
+    image { "traefik:v3.6" }
     command { "--configFile=/config/config.yml" }
 
     environment do
@@ -71,17 +60,22 @@ Shippy.define do
 
     volumes do
       [
-        "/var/run/docker.sock:/var/run/docker.sock",
+        "/var/run/docker.sock:/var/run/docker.sock:ro",
         "./traefik:/config",
         "acme:/etc/traefik/acme"
       ]
     end
 
-    use_default_options
+    use_default_options # Automatically handles networks, logging, and restart policies
   end
 end
+
 ```
 
+By running `bin/shippy deploy proxy` the DSL gets converted to YAML and deployed on the server.
+
+See the examples directory for more options.
+
 ## 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/cli/app.rb

@@ -57,8 +57,40 @@ class Shippy::Cli::App < Shippy::Cli::Base
   desc "compile", "Compile application"
   def compile
     say "Compiling #{app_name}...", :magenta
-    # Load app config and pass to builder
     app_config = Shippy::Repo.load_app(app_name)
     Shippy::Builder.new(app_config).compile
   end
+
+  desc "rollback", "Rollback to a previous release"
+  method_option :step, aliases: "-n", type: :numeric, default: 1, desc: "Releases to go back"
+  def rollback
+    steps = options[:step]
+
+    backups = @remote_app.list_backups
+    if backups.empty?
+      error "No backups found."
+      exit(1)
+    end
+
+    target_index = steps - 1
+    if target_index < 0 || target_index >= backups.length
+      error "Cannot rollback #{steps} steps. Only #{backups.length} backups available."
+      exit(1)
+    end
+
+    target_ts = backups[target_index]
+    say "Rolling back #{steps} step(s) to: #{target_ts}", :yellow
+
+    @docker.compose_down(@remote_app.current_path)
+
+    say "Restoring files...", :blue
+    @remote_app.restore_backup(target_ts)
+
+    say "Starting restored application...", :green
+    app_config = Shippy::Repo.load_app(app_name)
+    @docker.compose_up(@remote_app.current_path, flags: app_config&.deploy_flags)
+  rescue => e
+    error "Rollback failed: #{e.message}"
+    exit(1)
+  end
 end

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

@@ -11,12 +11,12 @@ Shippy.define do
     end
 
     ports do
-      ["80:80", "443:443", "8080:8080"]
+      ["80:80", "443:443"]
     end
 
     volumes do
       [
-        "/var/run/docker.sock:/var/run/docker.sock",
+        "/var/run/docker.sock:/var/run/docker.sock:ro",
         "./traefik:/config",
         "acme:/etc/traefik/acme"
       ]

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

@@ -4,10 +4,6 @@ providers:
   file:
     filename: "/config/dynamic_config.yml"
 
-api:
-  insecure: true
-  dashboard: true
-
 entryPoints:
   web:
     address: ":80"

data/lib/shippy/remote/app.rb

@@ -63,6 +63,36 @@ module Shippy
         end
       end
 
+      def list_backups
+        base = backups_path
+        data = []
+
+        on(@host) do
+          if test("[ -d #{base} ]")
+            data = capture(:ls, "-1r", base).split
+          end
+        end
+
+        data
+      end
+
+      def restore_backup(target_ts)
+        backup_source = backups_path.join(target_ts, @app_name)
+        target = current_path
+
+        on(@host) do
+          unless test("[ -d #{backup_source} ]")
+            raise "Backup directory #{backup_source} does not exist"
+          end
+        end
+
+        backup_current_release
+
+        on(@host) do
+          execute :mv, backup_source, target
+        end
+      end
+
       def current_path
         SHIPPY.deploy_path.join("apps", @app_name)
       end

data/lib/shippy/secrets_manager.rb

@@ -33,7 +33,11 @@ module Shippy
         @config.read
       else
         "# Add your secrets here. They will be encrypted on save.\n" \
-        "# keys: values\n"
+        "# proxy:\n" \
+        "#   cloudflare_token: value\n" \
+        "#   cloudflare_email: name@example.com\n" \
+        "# other_service:\n" \
+        "#   value: secret\n"
       end
 
       Tempfile.create(["secrets", ".yml"]) do |tmp_file|

data/lib/shippy/version.rb

@@ -1,3 +1,3 @@
 module Shippy
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shippy
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Marius Bobin