Amazon Kamal

A set of command line tools for bootstrapping and managing Amazon Linux servers running Kamal.

Add this line to your application’s Gemfile:

gem "amazon_kamal"

And then execute:

bundle install

Launch a new AWS EC2 Amazon Linux instance and add it to the servers section of the Kamal deploy.yml file.

Run the amazon-kamal bootstrap command to install docker:

amazon-kamal bootstrap

Then proceed with Kamal setup:

kamal setup

Bootstraps an Amazon Linux 2023 server by updating packages, installing and configuring Docker, and disabling unnecessary services.

amazon-kamal bootstrap       # Update packages and setup docker

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 for more information.

amazon-kamal runner add      # Install kamal-rails-runner
amazon-kamal runner remove   # Remove kamal-rails-runner

Installs systemd services and timers located in the config/systemd directory on the primary Kamal server.

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.

amazon-kamal timers add      # Add systemd timers
amazon-kamal timers remove   # Remove systemd timers
amazon-kamal timers show     # Show timers
amazon-kamal timers logs     # Show logs for systemd timers

# 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"

# config/systemd/app-cleanup-job.timer
[Unit]
Description=Schedule App CleanupJob

[Timer]
OnCalendar=*-*-* 00:00:00
Persistent=true

[Install]
WantedBy=timers.target

amazon-kamal version         # Show AmazonKamal version

Specify the destination option to run commands on a defined Kamal destination.

# Bootstrap production servers
amazon-kamal bootstrap -d production

# Show timers on primary staging server
amazon-kamal timers show -d staging

Amazon Kamal is available as open source under the terms of the MIT License.