[Feature]: LGSM would utilize user-provided file for CRONTAB jobs

Open
#4,584 1 comment 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
bash, linux, shell
Domain
cli, devops

Research direction

Start in app/lgsm/modules/command_start.sh, where the issue's proof of concept imports ${HOME}/.crontab, and inspect config-lgsm/_default.cfg for the suggested shared configuration approach. Confirm how startup currently creates scheduled jobs and define completion as consistently loading a user-provided CRONTAB file without manual console edits after restart.

Written by the indexing model from the issue text.

Description

command: backup command: console command: update-lgsm distro: Ubuntu game: 7 Days to Die info: docker info: tmux type: feature
User story

As a LGSM user, I want LGSM to create its instance of CRONTAB jobs from a user-provided file to allow customization & rapid (re)deployment

Game

7Days2Die

Linux distro

Ubuntu 22.04

Command

command: console

Further information

Would like to be able to create a file {EG: '.crontab'} in the /DATA folder that, if present, will be used to generate that docker's instance of all scheduled jobs via CRONTAB.

As, upon every STOP/START+ of the container, I have to manually modify CRONTAB via the console (miss a few & becomes quite tedious, running multiple servers) since it resets.

Keep the .YML clean(er) as well.

Default upon starting-up:

linuxgsm@599e2cfa8d46:/app$ crontab -l
*/60 * * * * /app/sdtdserver update > /dev/null 2>&1

vs. (mock code change)

[ -f "${CRONTAB_FILE}" ]]; then
     cat /data/.config|crontab -
fi

Giving (mock from file):

linuxgsm@599e2cfa8d46:/app$ crontab -l
## EVERY SUN @ 00:00
0 0 * * 0 /usr/bin/truncate --size 0 /data/log/crontab.log /data/log/rcon.log
## EVERY SUN @ 00:30
30 0 * * 0 /app/*server update-lgsm >> /data/log/crontab.log 2>&1
## EVERY DAY @ 05:00
1 5 * * * /data/RCON/rcon_send_backup_msg.sh sdtd 1 >> /data/log/crontab.log 2>&1
2 5 * * * /data/my_backup.sh >> /data/log/crontab.log 2>&1
## EVERY M,W,F @ 05:30
0 5 * * 1,3,5 /data/RCON/rcon_send_reboot_msg.sh sdtd 30 >> /data/log/crontab.log 2>&1
15 5 * * 1,3,5 /data/RCON/rcon_send_reboot_msg.sh sdtd 15 >> /data/log/crontab.log 2>&1
20 5 * * 1,3,5 /data/RCON/rcon_send_reboot_msg.sh sdtd 10 >> /data/log/crontab.log 2>&1
25 5 * * 1,3,5 /data/RCON/rcon_send_reboot_msg.sh sdtd 5 >> /data/log/crontab.log 2>&1
29 5 * * 1,3,5 /data/RCON/rcon_send_reboot_msg.sh sdtd 1 >> /data/log/crontab.log 2>&1
30 5 * * 1,3,5 /app/*server restart >> /data/log/crontab.log 2>&1

Edit (6/9/24)
Hand-jammed a proof of concept:

sudo nano /app/lgsm/modules/command_start.sh

Find:

fn_print_dots "${servername}"
if [ "${shortname}" == "jk2" ]; then
        fn_start_jk2
else
        fn_start_tmux
fi

New code to add just below:

# If user defined CRONTAB is present, ingest
if [ -f "${HOME}/.crontab" ]; then
        fn_script_log_info "Importing CRONTAB file"
        cat "${HOME}/.crontab" | crontab -
else
        fn_script_log_info "No CRONTAB file to import"
fi

Post-Addition:

...
fn_print_dots "${servername}"
if [ "${shortname}" == "jk2" ]; then
        fn_start_jk2
else
        fn_start_tmux
fi

# If user defined CRONTAB is present, ingest
#
#     Better to utilize 'config-lgsm/_default.cfg' for cross-server usage, ease of use?
#
if [ -f "${HOME}/.crontab" ]; then
        fn_script_log_pass "Importing CRONTAB file"
        cat "${HOME}/.crontab" | crontab -
else
        fn_script_log_info "No CRONTAB file to import"
fi

# Remove starting lockfile when command ends.
...

Test output:

Jun 09 13:42:24.719 pwserver: START: PASS: Started LinuxGSM
Jun 09 13:42:24.822 pwserver: START: PASS: Started LinuxGSM
Jun 09 13:42:24.824 pwserver: START: PASS: Importing CRONTAB file
Jun 09 13:42:24.834 pwserver: RESTART: INFO: LinuxGSM version: v24.2.1
Jun 09 13:42:24.835 pwserver: RESTART: PASS: core_exit.sh exiting with code: 0
Dominant language
Shell
Stars
4.9k
Forks
866
Avg merge
17h 58m
Merged PRs (30d)
100

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from GameServerManagers/LinuxGSM

All issues in GameServerManagers/LinuxGSM

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.