backy/command-lists.md at d9baf44199fc12543abfeb091276a210c59dcd58

* Getting environment variables and passwords from Vault (not tested
yet)
* Vault configuration to config (not tested yet)
* Ability to run scripts from file on local machine on the remote host
* Ability to get ouput in the notification of a list for individual
commands or all commands
* Make SSH connections close after all commands have been run; reuse
previous connections if needed

2023-07-01 21:46:54 -05:00

2.2 KiB

Raw Blame History

title	weight	description
Command Lists	2	This page tells you how to get started with Backy.

Command lists are for executing commands in sequence and getting notifications from them.

The top-level object key can be anything you want but not the same as another.

  test2:
    name: test2
    order:
      - test
      - test2
    notifications:
      - prod-email
      - matrix
    cron: "0 * * * * *"

key	description	type	required
`order`	Defines the sequence of commands to execute	`[]string`	yes
`getOutput`	Command(s) output is in the notification(s)	`bool`	no
`notifications`	The notification IDs to use on success and failure	`[]string`	no
`name`	Optional name of the list	`string`	no
`cron`	Time at which to schedule the list.	`string`	no

Order

The order is an array of commands to execute in order. Each command must be defined.

order:
  - cmd-1
  - cmd-2

getOutput

Get command output when a notification is sent.

Is not required. Can be true or false.

Notifications

An array of notification IDs to use on success and failure. Must match any of the notifications object map keys.

Name

Name is optional for logging. If name is not defined, name will be the object's map key.

Cron mode

Backy also has a cron mode, so one can run backy cron and start a process that schedules jobs to run at times defined in the configuration file.

Adding cron: 0 0 1 * * * to a cmd-configs object will schedule the list at 1 in the morning. See https://crontab.guru/ for reference.

{{% notice tip %}} Note: Backy uses the second field of cron, so add anything except * to the beginning of a regular cron expression. {{% /notice %}}

cmd-configs:
  cmds-to-run: # this can be any name you want
    # all commands have to be defined
    order:
      - stop-docker-container
      - backup-docker-container-script
      - shell-cmd
      - hostname
    notifications:
      - matrix
    name: backup-some-server
    cron: "0 0 1 * * *"
  hostname:
    name: hostname
    order:
      - hostname
    notifications:
      - prod-email

2.2 KiB Raw Blame History