GoodJob background tasks for Tomo https://github.com/mattbrictson/tomo
MIT License
This is a tomo plugin that provides tasks for managing good_job via systemd, based on the recommendations in the good_job documentation. This plugin assumes that you are also using the tomo rbenv
and env
plugins, and that you are using a systemd-based Linux distribution like Ubuntu 18 LTS.
Run:
$ gem install tomo-plugin-good_job
Or add it to your Gemfile:
gem "tomo-plugin-good_job"
Then add the following to .tomo/config.rb
:
plugin "good_job"
setup do
# ...
run "good_job:setup_systemd"
end
deploy do
# ...
# Place this task at *after* core:symlink_current
run "good_job:restart"
end
This plugin installs good_job as a user-level service using systemctl --user. This allows good_job to be installed, started, stopped, and restarted without a root user or sudo. However, when provisioning the host you must make sure to run the following command as root to allow the good_job process to continue running even after the tomo deploy user disconnects:
# run as root
$ loginctl enable-linger <DEPLOY_USER>
Name | Purpose |
---|---|
good_job_systemd_service |
Name of the systemd unit that will be used to manage good*job Default: "good_job*%{application}.service"
|
good_job_systemd_service_path |
Location where the systemd unit will be installed Default: ".config/systemd/user/%{good_job_systemd_service}"
|
good_job_systemd_service_template_path |
Local path to the ERB template that will be used to create the systemd unit Default: service.erb |
Configures systemd to manage good_job. This means that good_job will automatically be restarted if it crashes, or if the host is rebooted. This task essentially does two things:
good_job.service
systemd unitsystemctl --user enable
Note that these units will be installed and run for the deploy user. You can use :good_job_systemd_service_template_path
to provide your own template and customize how good_job and systemd are configured.
good_job:setup_systemd
is intended for use as a setup task. It must be run before good_job can be started during a deploy.
Gracefully restarts the good_job service via systemd, or starts it if it isn't running already. Equivalent to:
systemctl --user restart good_job.service
Starts the good_job service via systemd, if it isn't running already. Equivalent to:
systemctl --user start good_job.service
Stops the good_job service via systemd. Equivalent to:
systemctl --user stop good_job.service
Prints the status of the good_job systemd service. Equivalent to:
systemctl --user status good_job.service
Uses journalctl
(part of systemd) to view the log output of the good_job service. This task is intended for use as a run task and accepts command-line arguments. The arguments are passed through to the journalctl
command. For example:
$ tomo run -- good_job:log -f
Will run this remote script:
journalctl -q --user-unit=good_job.service -f
If you want to report a bug, or have ideas, feedback or questions about the gem, let me know via GitHub issues and I will do my best to provide a helpful answer. Happy hacking!
The gem is available as open source under the terms of the MIT License.
Most of the code is taken from https://github.com/mattbrictson/tomo-plugin-sidekiq
Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Pull requests are welcome! Thanks @mattbrictson for Tomo 🙏