Configuring Backy on A tool for commands

Commands

Mon, 01 Jan 0001 00:00:00 +0000

The yaml top-level map can be any string.

The top-level name must be unique.

Example Config

commands:
  stop-docker-container:
    cmd: docker
    Args:
      - compose
      - -f /some/path/to/docker-compose.yaml
      - down
    # if host is not defined, command will be run locally
    # The host has to be defined in either the config file or the SSH Config files
    host: some-host
    hooks
      error:
        - some-other-command-when-failing
      success:
        - success-command
      final:
        - final-command
  backup-docker-container-script:
    cmd: /path/to/local/script
    # script file is input as stdin to SSH
    type: scriptFile # also can be script
    environment:
      - FOO=BAR
      - APP=$VAR

Values available for this section:

Command Lists

Mon, 01 Jan 0001 00:00:00 +0000

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.

Lists can go in a separate file. Command lists should be in a separate file if:

key ‘cmd-lists.file’ is found
hosts.yml or hosts.yaml is found in the same directory as the backy config file

  test2:
    name: test2
    order:
      - test
      - test2
    notifications:
      - mail.prod-email
      - matrix.sysadmin
    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 service(s) and ID(s) to use on success and failure. Must be `service.id`. See the notifications documentation page for more	`[]string`	no
`name`	Optional name of the list	`string`	no
`cron`	Time at which to schedule the list. Only has affect when cron subcommand is run.	`string`	no

Order

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

Notifications

Mon, 01 Jan 0001 00:00:00 +0000

Notifications can be sent on command list completion and failure.

The supported platforms for notifications are email (SMTP) and Matrix.

Notifications are defined by service, with the current form following below. Ids must come after the service.

notifications:
  mail:
    prod-email:
      host: yourhost.tld
      port: 587
      senderaddress: email@domain.tld
      to:
        - admin@domain.tld
      username: smtp-username@domain.tld
      password: your-password-here

  matrix:
    matrix:
      home-server: your-home-server.tld
      room-id: room-id
      access-token: your-access-token
      user-id: your-user-id

Sections recognized are mail and matrix

There must be a section with an id (eg. mail.test-svr) following one of these sections.

Vault

Mon, 01 Jan 0001 00:00:00 +0000

Vault is a tool for storing secrets and other data securely.

Vault config can be used by prefixing vault: in front of a password or ENV var.

This is the object in the config file:

vault:
  token: hvs.tXqcASvTP8wg92f7riyvGyuf
  address: http://127.0.0.1:8200
  enabled: false
  keys:
    - name: mongourl
      mountpath: secret
      path: mongo/url
      type:  # KVv1 or KVv2
    - name:
      path:
      type:
      mountpath: