kitsune-kit 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 508f86259061cf1c767fc1a1678aeb8195aaf174214c2c7f9be5557aa1b73c2a
-  data.tar.gz: 38f6179c02ad9a59608bb3e3d3f62bd7b23648bb0bb24a6cdbd9fba179af3255
+  metadata.gz: 2860b56f9307be49ac06572e05cdf79e02bf76946262e64651d36c729505c8a8
+  data.tar.gz: c38a154d06774e6755dfec97f35a75d4ad2208b262ac37bb3ce20a25612836a7
 SHA512:
-  metadata.gz: 65b84489d96cc8228afe78113dcd08065d3297957b77fcece8dfb9fe1d5722695086f18cc6387c400a9888342ac82ce56feaa7d2f9d67c780bf6abedb4c7da3e
-  data.tar.gz: 59a28feaca900d703eb9ebe9943993cb1709b66784d7160425dc50f682bf7e93296408f8cdaedac04f3b2583a7757e74e69f7538515cc83abf3bf0f7088a1411
+  metadata.gz: 45ca3cd5d65502bb6c4e2fbdfa965152426d19bb732812651aee0957988d05eff5fe93432758825120e9ac2f20d8041afee8f7d34ac80aab438931c6948c15ad
+  data.tar.gz: f53ede98dd9cbf482e42ed91530cd07ddba5ed1744df1fcc46a92e6e5797f9629180057ff1a5e53cd80987f2ef0892d41400caff2b3a51273310b1676e9f93c5

data/README.md

@@ -18,6 +18,7 @@
 - ♻️ Enables automatic security updates (unattended-upgrades)
 - 💾 Configures swap space for better performance
 - 📊 Installs [DigitalOcean monitoring agent](https://docs.digitalocean.com/products/monitoring/how-to/install-agent/)
+- 🌐 **Automatically links** domains or subdomains (A records) to your server using DigitalOcean DNS
 - 🐳 Installs and configures Docker Engine and private networking
 - 🐘 Deploys PostgreSQL via Docker Compose with healthcheck
 - 🗄️ Deploys Redis via Docker Compose with healthcheck

data/lib/kitsune/blueprints/.env.template

@@ -7,6 +7,11 @@ IMAGE=
 SSH_KEY_ID=
 TAG_NAME=
 ENABLE_DO_METRICS=true
+# If you want DNS records to be created automatically, set the following variables:
+# DOMAIN_NAMES=example.com,test.example.org # (optional, comma-separated list of domain names to add to the droplet)
+# DNS_TTL=3600 # (optional, time-to-live for DNS records in seconds, default is 3600)
+# Check the DigitalOcean documentation for more information on domain names:
+# https://docs.digitalocean.com/products/networking/dns/getting-started/dns-registrars/
 
 # SSH
 SSH_KEY_PATH=

data/lib/kitsune/kit/ansi_color.rb

@@ -0,0 +1,78 @@
+module AnsiColor
+  COLORS = {
+    black:   30,
+    red:     31,
+    green:   32,
+    yellow:  33,
+    blue:    34,
+    magenta: 35,
+    cyan:    36,
+    white:   37,
+
+    light_black:   90,
+    light_red:     91,
+    light_green:   92,
+    light_yellow:  93,
+    light_blue:    94,
+    light_magenta: 95,
+    light_cyan:    96,
+    light_white:   97
+  }
+
+  BACKGROUNDS = {
+    black:   40,
+    red:     41,
+    green:   42,
+    yellow:  43,
+    blue:    44,
+    magenta: 45,
+    cyan:    46,
+    white:   47,
+
+    light_black:   100,
+    light_red:     101,
+    light_green:   102,
+    light_yellow:  103,
+    light_blue:    104,
+    light_magenta: 105,
+    light_cyan:    106,
+    light_white:   107
+  }
+
+  STYLES = {
+    bold:      1,
+    italic:    3,
+    underline: 4
+  }
+
+  def self.colorize(text, color: nil, background: nil, style: nil)
+    codes = []
+    codes << COLORS[color] if color
+    codes << BACKGROUNDS[background] if background
+    codes << STYLES[style] if style
+
+    raise ArgumentError, "No valid formatting options given" if codes.empty?
+
+    "\e[#{codes.join(';')}m#{text}\e[0m"
+  end
+
+  def self.demo
+    puts "Text Colors:"
+    COLORS.each_key do |color|
+      puts colorize("  #{color.to_s.ljust(15)}", color: color)
+    end
+  
+    puts "\nBackground Colors:"
+    BACKGROUNDS.each_key do |bg|
+      puts colorize("  #{bg.to_s.ljust(15)}", background: bg)
+    end
+  
+    puts "\nStyles:"
+    STYLES.each_key do |style|
+      puts colorize("  #{style.to_s.ljust(15)}", color: :white, style: style)
+    end
+  
+    puts "\nCombined Example:"
+    puts colorize("  bold green on light_black  ", color: :green, background: :light_black, style: :bold)
+  end
+end

data/lib/kitsune/kit/cli.rb

@@ -1,9 +1,10 @@
 require "thor"
-require "colorize"
+require_relative "ansi_color"
 require_relative "env_loader"
 require_relative "commands/init"
 require_relative "commands/switch_env"
 require_relative "commands/provision"
+require_relative "commands/dns"
 require_relative "commands/setup_user"
 require_relative "commands/setup_firewall"
 require_relative "commands/setup_unattended"
@@ -16,6 +17,7 @@ require_relative "commands/postinstall_docker"
 require_relative "commands/bootstrap_docker"
 require_relative "commands/setup_postgres_docker"
 require_relative "commands/setup_redis_docker"
+require_relative "commands/ssh"
 
 module Kitsune
   module Kit
@@ -47,6 +49,9 @@ module Kitsune
       desc "provision SUBCOMMAND", "Provisioning tasks"
       subcommand "provision", Kitsune::Kit::Commands::Provision
 
+      desc "dns SUBCOMMAND", "Manage DNS"
+      subcommand "dns", Kitsune::Kit::Commands::Dns
+
       desc "setup_user SUBCOMMAND", "Create or rollback deploy user on remote server"
       subcommand "setup_user", Kitsune::Kit::Commands::SetupUser
 
@@ -82,6 +87,9 @@ module Kitsune
 
       desc "setup_redis_docker SUBCOMMAND", "Setup Redis via Docker Compose on remote server"
       subcommand "setup_redis_docker", Kitsune::Kit::Commands::SetupRedisDocker
+
+      desc "ssh connect", "SSH into the server"
+      subcommand "ssh", Kitsune::Kit::Commands::Ssh
     end
   end
 end

data/lib/kitsune/kit/commands/bootstrap.rb

@@ -44,6 +44,7 @@ module Kitsune
             run_cli("setup_unattended create", droplet_ip, filled_options)
             run_cli("setup_swap create", droplet_ip, filled_options)
             run_cli("setup_do_metrics create", droplet_ip, filled_options)
+            run_cli("dns link", droplet_ip, filled_options.merge(domains: ENV["DOMAIN_NAMES"]))
           end
 
           def rollback_sequence(filled_options)
@@ -75,10 +76,11 @@ module Kitsune
             run_cli("setup_user rollback", droplet_ip, filled_options)
 
             unless filled_options[:keep_server]
+              run_cli("dns rollback", droplet_ip, filled_options.merge(domains: ENV["DOMAIN_NAMES"]))
               say "▶️ Running: kitsune kit provision rollback", :blue
               Kitsune::Kit::CLI.start(%w[provision rollback])
             else
-              say "⏭️  Skipping droplet deletion (--keep-server enabled)", :yellow
+              say "⏭️  Skipping droplet deletion (--keep-server enabled), DNS rollback won't be executed", :yellow
             end
           end
 
@@ -99,12 +101,18 @@ module Kitsune
           def run_cli(command, droplet_ip, filled_options)
             say "\n▶️ Running: kitsune kit #{command} --server-ip #{droplet_ip}", :blue
             subcommand, action = command.split(" ", 2)
-            Kitsune::Kit::CLI.start([
-              subcommand, action,
-              "--server-ip", droplet_ip,
-              "--ssh-port", filled_options[:ssh_port],
-              "--ssh-key-path", filled_options[:ssh_key_path]
-            ])
+
+            args = [subcommand, action, "--server-ip", droplet_ip]
+
+            if subcommand != "dns"
+              args += ["--ssh-port", filled_options[:ssh_port], "--ssh-key-path", filled_options[:ssh_key_path]]
+            end
+
+            if subcommand == "dns" && ENV["DOMAIN_NAMES"]
+              args += ["--domains", ENV["DOMAIN_NAMES"]]
+            end
+
+            Kitsune::Kit::CLI.start(args)
           rescue SystemExit => e
             abort "❌ Command failed: #{command} (exit #{e.status})"
           end

data/lib/kitsune/kit/commands/dns.rb

@@ -0,0 +1,112 @@
+require "droplet_kit"
+require "thor"
+
+module Kitsune
+  module Kit
+    module Commands
+      class Dns < Thor
+        namespace "dns"
+
+        class_option :domains, type: :string, desc: "Comma-separated domain list (or from ENV['DOMAIN_NAMES'])"
+        class_option :server_ip, type: :string, required: true, desc: "IPv4 to assign to domain(s)"
+        class_option :ttl, type: :numeric, default: 3600, desc: "TTL in seconds for DNS records"
+
+        desc "link", "Link domains to a given IP using A records"
+        def link
+          validate_ip!
+
+          domains = resolve_domains
+          return if domains.empty?
+
+          ip = options[:server_ip]
+          ttl = ENV.fetch("DNS_TTL", options[:ttl]).to_i
+
+          client = DropletKit::Client.new(access_token: ENV.fetch("DO_API_TOKEN"))
+
+          domains.each do |fqdn|
+            parts = fqdn.split('.')
+            next if parts.size < 2
+
+            root_domain = parts[-2..].join('.')
+            subdomain = parts[0..-3].join('.')
+            name_for_a = subdomain.empty? ? "@" : subdomain
+
+            puts "\n🌐 Linking '#{fqdn}' to IP #{ip} (domain: #{root_domain}, record: #{name_for_a})"
+
+            records = client.domain_records.all(for_domain: root_domain)
+            existing = records.find { |r| r.type == "A" && r.name == name_for_a }
+
+            domain_record = DropletKit::DomainRecord.new(
+              type: "A",
+              name: name_for_a,
+              data: ip,
+              ttl: ttl
+            )
+
+            msg = "'#{AnsiColor.colorize(name_for_a, color: :green)}.#{AnsiColor.colorize(root_domain, color: :green)}' → #{AnsiColor.colorize(ip, color: :light_cyan)}"
+            if existing
+              client.domain_records.update(
+                domain_record,
+                for_domain: root_domain,
+                id: existing.id
+              )
+              puts "✅ Updated A record #{msg}"
+            else
+              client.domain_records.create(
+                domain_record,
+                for_domain: root_domain
+              )
+              puts "✅ Created A record #{msg}"
+            end
+          end
+        end
+
+        desc "rollback", "Remove A records for the specified domains"
+        def rollback
+          domains = resolve_domains
+          return if domains.empty?
+
+          client = DropletKit::Client.new(access_token: ENV.fetch("DO_API_TOKEN"))
+
+          domains.each do |fqdn|
+            parts = fqdn.split('.')
+            next if parts.size < 2
+
+            root_domain = parts[-2..].join('.')
+            subdomain = parts[0..-3].join('.')
+            name_for_a = subdomain.empty? ? "@" : subdomain
+
+            puts "\n🗑️ Attempting to delete A record for '#{fqdn}' (domain: #{root_domain}, record: #{name_for_a})"
+
+            records = client.domain_records.all(for_domain: root_domain)
+            existing = records.find { |r| r.type == "A" && r.name == name_for_a }
+
+            if existing
+              client.domain_records.delete(for_domain: root_domain, id: existing.id)
+              puts "✅ Deleted A record '#{name_for_a}.#{root_domain}'"
+            else
+              puts "💡 No A record found for '#{name_for_a}.#{root_domain}', nothing to delete"
+            end
+          end
+        end
+
+        no_commands do
+          def validate_ip!
+            if options[:server_ip].nil? || options[:server_ip].empty?
+              abort "❌ Missing required option: --server-ip"
+            end
+          end
+
+          def resolve_domains
+            raw = options[:domains] || ENV["DOMAIN_NAMES"]
+            if raw.nil? || raw.strip.empty?
+              puts "⏭️  No domains provided. Skipping DNS operation."
+              return []
+            end
+            raw.split(',').map(&:strip).reject(&:empty?)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitsune/kit/commands/ssh.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "thor"
+require "droplet_kit"
+
+module Kitsune
+  module Kit
+    module Commands
+      class Ssh < Thor
+        namespace "ssh"
+        default_task :connect
+
+        desc "connect", "Connect to a remote server via SSH"
+        option :ip, type: :string, desc: "Server IP address (optional)"
+        option :user, type: :string, default: "deploy", desc: "SSH user"
+        def connect
+          Kitsune::Kit::EnvLoader.load!
+
+          ip = options[:ip] || fetch_server_ip
+          user = options[:user]
+          key_path = Kitsune::Kit::Defaults.ssh[:ssh_key_path]
+
+          say "🔗 Connecting to #{user}@#{ip}...", :green
+          exec "ssh -i #{key_path} -o StrictHostKeyChecking=no #{user}@#{ip}"
+        end
+
+        no_commands do
+          def fetch_server_ip
+            token = ENV.fetch("DO_API_TOKEN") { abort "❌ DO_API_TOKEN is missing" }
+
+            client = DropletKit::Client.new(access_token: token)
+            name = Kitsune::Kit::Defaults.infra[:droplet_name]
+
+            droplet = client.droplets.all.find { |d| d.name == name }
+            abort "❌ Droplet '#{name}' not found on DigitalOcean" unless droplet
+
+            ip = droplet.networks.v4.find { |n| n.type == "public" }&.ip_address
+            abort "❌ No public IP found for droplet '#{name}'" unless ip
+
+            ip
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitsune/kit/defaults.rb

@@ -2,11 +2,11 @@ module Kitsune
   module Kit
     module Defaults
       DROPLET = {
-        droplet_name: "app-prod",
+        droplet_name: "app-dev",
         region: "sfo3",
         size: "s-1vcpu-1gb",
         image: "ubuntu-22-04-x64",
-        tag: "rails-prod"
+        tag: "rails-dev"
       }.freeze
 
       SSH = {
@@ -15,7 +15,6 @@ module Kitsune
       }.freeze
 
       POSTGRES = {
-        db_prefix: "myapp_db",
         user: "postgres",
         password: "secret",
         port: "5432",
@@ -59,7 +58,7 @@ module Kitsune
         env = ENV.fetch('KIT_ENV', 'development')
 
         {
-          postgres_db: ENV.fetch('POSTGRES_DB') { "#{POSTGRES[:db_prefix]}_#{env}" },
+          postgres_db: ENV.fetch('POSTGRES_DB') { "myapp_db_#{env}" },
           postgres_user: ENV.fetch('POSTGRES_USER', POSTGRES[:user]),
           postgres_password: ENV.fetch('POSTGRES_PASSWORD', POSTGRES[:password]),
           postgres_port: ENV.fetch('POSTGRES_PORT', POSTGRES[:port]),

data/lib/kitsune/kit/env_loader.rb

@@ -18,8 +18,8 @@ module Kitsune
 
         if found
           Dotenv.load(found)
-          puts "🧪 Loaded Kitsune environment from #{found.light_cyan}"
-          puts "=======================================================================\n".light_cyan
+          puts AnsiColor.colorize("🧪 Loaded Kitsune environment from #{found}", color: :light_cyan)
+          puts AnsiColor.colorize("=======================================================================\n", color: :light_cyan)
         else
           puts "⚠️  No Kitsune infra config found for environment '#{env}' (looked for infra.#{env}.env and infra.env)"
         end

data/lib/kitsune/kit/provisioner.rb

@@ -9,9 +9,7 @@ module Kitsune
         @size         = opts[:size]
         @image        = opts[:image]
         @tag          = opts[:tag]
-        @ssh_key_id   = opts[:ssh_key_id] do
-          abort "❌ You must export SSH_KEY_ID or use --ssh_key_id"
-        end
+        @ssh_key_id   = opts[:ssh_key_id] { abort "❌ You must export SSH_KEY_ID or use --ssh_key_id" }
 
         @client       = DropletKit::Client.new(access_token: ENV.fetch("DO_API_TOKEN"))
       end

data/lib/kitsune/kit/version.rb

@@ -2,6 +2,6 @@
 
 module Kitsune
   module Kit
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitsune-kit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Omar Herrera
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-04 00:00:00.000000000 Z
+date: 2025-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -187,9 +173,11 @@ files:
 - lib/kitsune/blueprints/docker/redis.yml
 - lib/kitsune/blueprints/kit.env.template
 - lib/kitsune/kit.rb
+- lib/kitsune/kit/ansi_color.rb
 - lib/kitsune/kit/cli.rb
 - lib/kitsune/kit/commands/bootstrap.rb
 - lib/kitsune/kit/commands/bootstrap_docker.rb
+- lib/kitsune/kit/commands/dns.rb
 - lib/kitsune/kit/commands/init.rb
 - lib/kitsune/kit/commands/install_docker_engine.rb
 - lib/kitsune/kit/commands/postinstall_docker.rb
@@ -202,6 +190,7 @@ files:
 - lib/kitsune/kit/commands/setup_swap.rb
 - lib/kitsune/kit/commands/setup_unattended.rb
 - lib/kitsune/kit/commands/setup_user.rb
+- lib/kitsune/kit/commands/ssh.rb
 - lib/kitsune/kit/commands/switch_env.rb
 - lib/kitsune/kit/defaults.rb
 - lib/kitsune/kit/env_loader.rb