amazon_kamal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8db14a7ce60a9ac6b3450f9d57d14b50948f681dfe5645bdd3a7fba0494fbcc3
+  data.tar.gz: 38745a121879d8ea5050d04714d9f8b9abc79725ac739f73bbe774ccd9e14298
+SHA512:
+  metadata.gz: c8946f5804e3d6d75ba8756ae8611f6df87379de14ccef0165ea9d828156a5e58007c8db233ccad196de92ba032ef048997f3cc56f53bf832baa3ea262040c92
+  data.tar.gz: 45c2f165d124a485cb8cde9aef14625b9cd3ed3ff6794827b78dab5affa6a4b04d08efd99a9f76835e60e86795fa6fae4be75549aaf5797276a091b320d07a25

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Brightways Learning
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Amazon Kamal
+A set of command line tools for bootstrapping and managing Amazon Linux servers running Kamal.
+
+## Installation
+Add this line to your application’s Gemfile:
+```ruby
+gem "amazon_kamal"
+```
+
+And then execute:
+```sh
+bundle install
+```
+
+## Commands
+### Bootstrap
+Bootstraps an Amazon Linux 2023 server by updating packages, installing and configuring Docker, and disabling unnecessary services.
+
+```sh
+amazon-kamal bootstrap       # Update packages and setup docker
+```
+
+### Runner
+Installs the **kamal-rails-runner** script into `/usr/local/bin` and makes it executable. This script simplifies running `rails runner` commands inside Kamal containers.
+
+See [kamal-rails-runner](https://github.com/wwidea/kamal-rails-runner) for more information.
+
+```sh
+amazon-kamal runner add      # Install kamal-rails-runner
+amazon-kamal runner remove   # Remove kamal-rails-runner
+```
+
+### Timers
+Installs systemd services and timers located in the `config/systemd` directory on the primary Kamal server.
+
+#### Usage
+1. Create a service and corresponding timer file in `config/systemd`
+2. Run **amazon-kamal timers add** to copy the files to the primary server and enable the timer
+3. Run **amazon-kamal timers show** to display the timers installed on the primary server.
+4. Run **amazon-kamal timers remove** to remove the timers defined in **config/systemd** from the primary server.
+
+```sh
+amazon-kamal timers add      # Add systemd timers
+amazon-kamal timers remove   # Remove systemd timers
+amazon-kamal timers show     # Show timers
+```
+
+#### Example systemd files
+```ini
+# config/systemd/app-cleanup-job.service
+[Unit]
+Description=Run App CleanupJob
+
+[Service]
+Type=oneshot
+ExecStart=/usr/local/bin/kamal-rails-runner app "CleanupJob.perform_now"
+```
+
+```ini
+# config/systemd/app-cleanup-job.timer
+[Unit]
+Description=Schedule App CleanupJob
+
+[Timer]
+OnCalendar=*-*-* 00:00:00
+Persistent=true
+
+[Install]
+WantedBy=timers.target
+```
+
+### Version
+```sh
+amazon-kamal version         # Show AmazonKamal version
+```
+
+## Options
+Specify the destination option to run commands on a defined Kamal destination.
+
+```sh
+# Bootstrap production servers
+amazon-kamal bootstrap -d production
+
+# Show timers on primary staging server
+amazon-kamal timers show -d staging
+```
+
+## License
+Amazon Kamal is available as open source under the terms of the [MIT License](https://opensource.org/license/MIT).

data/bin/amazon-kamal

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# Prevent failures from being reported twice.
+Thread.report_on_exception = false
+
+require "bundler/setup"
+require "amazon_kamal"
+
+AmazonKamal::Cli::Main.start(ARGV)

data/lib/amazon_kamal/cli/main.rb

@@ -0,0 +1,48 @@
+class AmazonKamal::Cli::Main < Kamal::Cli::Base
+  # include SSHKit::DSL
+
+  desc "bootstrap", "Update packages and setup docker"
+  def bootstrap
+    say "Bootstrapping hosts...", :magenta
+
+    with_lock do
+      on(KAMAL.hosts) do |host|
+        info("Bootstrapping #{host}")
+
+        as "root" do
+          # Update and install packages
+          execute :dnf, "update -y"
+          execute :dnf, "install -y docker htop git"
+
+          # Add ssh user to docker group
+          execute :usermod, "-a -G docker #{KAMAL.config.ssh.user}"
+
+          # Start and enable docker service
+          execute :systemctl, "enable --now docker"
+
+          # Disable unnecessary services
+          %w[
+            amazon-ssm-agent
+            gssproxy
+            systemd-homed
+            systemd-userdbd.socket
+            systemd-userdbd
+          ].each do |service|
+            execute :systemctl, "disable --now #{service}"
+          end
+        end
+      end
+    end
+  end
+
+  desc "version", "Show AmazonKamal version"
+  def version
+    puts AmazonKamal::VERSION
+  end
+
+  desc "runner", "Manage kamal-rails-runner"
+  subcommand "runner", AmazonKamal::Cli::Runner
+
+  desc "timers", "Manage systemd timers"
+  subcommand "timers", AmazonKamal::Cli::Timers
+end

data/lib/amazon_kamal/cli/runner.rb

@@ -0,0 +1,23 @@
+class AmazonKamal::Cli::Runner < Kamal::Cli::Base
+  KAMAL_RAILS_RUNNER_URL = "https://raw.githubusercontent.com/wwidea/kamal-rails-runner/main/kamal-rails-runner.sh"
+  KAMAL_RAILS_RUNNER_PATH = "/usr/local/bin/kamal-rails-runner"
+
+  desc "add", "Install kamal-rails-runner"
+  def add
+    say "Installing kamal-rails-runner on #{KAMAL.primary_host}...", :magenta
+    on(KAMAL.primary_host) do
+      as "root" do
+        execute :curl, "-sSL #{KAMAL_RAILS_RUNNER_URL} -o #{KAMAL_RAILS_RUNNER_PATH}"
+        execute :chmod, "+x #{KAMAL_RAILS_RUNNER_PATH}"
+      end
+    end
+  end
+
+  desc "remove", "Remove kamal-rails-runner"
+  def remove
+    say "Removing kamal-rails-runner from #{KAMAL.primary_host}...", :magenta
+    on(KAMAL.primary_host) do
+      execute :sudo, :rm, KAMAL_RAILS_RUNNER_PATH
+    end
+  end
+end

data/lib/amazon_kamal/cli/timers.rb

@@ -0,0 +1,77 @@
+class AmazonKamal::Cli::Timers < Kamal::Cli::Base
+  class_option :systemd_path, default: "config/systemd", desc: "Path to systemd files"
+
+  desc "add", "Add systemd timers"
+  def add
+    say "Adding systemd timers to #{KAMAL.primary_host}...", :magenta
+
+    path = options[:systemd_path]
+
+    timers do |timer|
+      say "Adding timer: #{timer}"
+
+      on(KAMAL.primary_host) do
+        # Upload files
+        puts method(:upload!).source_location.inspect
+        upload!("#{path}/#{timer}.timer", "/tmp")
+        upload!("#{path}/#{timer}.service", "/tmp")
+
+        as "root" do
+          # Move files to systemd directory and set permissions
+          execute :mv, "/tmp/#{timer}.*", "/etc/systemd/system/"
+          execute :chown, "root:root", "/etc/systemd/system/#{timer}.*"
+          execute :chmod, "644", "/etc/systemd/system/#{timer}.*"
+
+          # Enable and start the timer
+          execute :systemctl, "daemon-reload"
+          execute :systemctl, "enable --now #{timer}.timer"
+        end
+      end
+    end
+  end
+
+  desc "remove", "Remove systemd timers"
+  def remove
+    say "Removing systemd timers from #{KAMAL.primary_host}...", :magenta
+
+    timers do |timer|
+      puts "Removing timer: #{timer}"
+
+      on(KAMAL.primary_host) do
+        as "root" do
+          # Stop and disable the timer
+          execute :systemctl, "stop #{timer}.timer"
+          execute :systemctl, "disable #{timer}.timer"
+
+          # Remove timer files
+          execute :rm, "/etc/systemd/system/#{timer}.*"
+
+          # Reload systemd daemon
+          execute :systemctl, "daemon-reload"
+        end
+      end
+    end
+  end
+
+  desc "show", "Show timers"
+  def show
+    say "Calling systemctl list-timers on #{KAMAL.primary_host}...", :magenta
+    on(KAMAL.primary_host) do
+      puts capture(:systemctl, "list-timers")
+    end
+  end
+
+  private
+
+  def timers(&)
+    timer_files = Dir.glob("#{options[:systemd_path]}/*.timer")
+
+    if timer_files.empty?
+      say "No timers found in #{options[:systemd_path]}.", :red
+    else
+      timer_files.each do |path|
+        yield File.basename(path, ".timer")
+      end
+    end
+  end
+end

data/lib/amazon_kamal/version.rb

@@ -0,0 +1,3 @@
+module AmazonKamal
+  VERSION = "0.1.0"
+end

data/lib/amazon_kamal.rb

@@ -0,0 +1,6 @@
+require "kamal"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+loader.eager_load_namespace(AmazonKamal::Cli)

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: amazon_kamal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Baldwin
+- Brightways Learning
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kamal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+email: baldwina@brightwayslearning.org
+executables:
+- amazon-kamal
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- bin/amazon-kamal
+- lib/amazon_kamal.rb
+- lib/amazon_kamal/cli/main.rb
+- lib/amazon_kamal/cli/runner.rb
+- lib/amazon_kamal/cli/timers.rb
+- lib/amazon_kamal/version.rb
+homepage: https://github.com/wwidea/amazon_kamal
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Provision Amazon Linux servers for use with Kamal.
+test_files: []