aboutsummaryrefslogtreecommitdiffstats
path: root/meta/argument_specs.yml
blob: a6e640c007ec2f29124cc019e719966f6cd848f7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
---
argument_specs:
  main:
    options:

      ################################################################################
      # Required
      ################################################################################
      borg_server_host:
        type: str
        required: true

      borg_server_host_ssh_key:
        type: str
        required: true

      ################################################################################
      # Optional
      ################################################################################
      borg_server_user:
        type: str
        required: false
        default: borg

      borg_server_user_create:
        type: bool
        required: false
        default: true

      borg_client_user:
        type: str
        required: false
        default: root

      borg_client_user_home:
        type: str
        required: false

      borg_ssh_key_type:
        type: str
        required: false
        default: rsa

      borg_ssh_key_per_repo:
        type: bool
        required: false
        default: false

      borg_server_host_url:
        type: str
        required: false
        default: "{{ borg_server_host }}"

      borg_server_user_home:
        type: str
        required: false
        default: /opt/borg

      borg_repo_name:
        type: str
        required: false
        default: "{{ inventory_hostname }}"

      borg_backup_name_format:
        type: str
        required: false
        default: "{hostname}-{now:%Y-%m-%dT%H:%M:%S}"

      borg_mode_append_only:
        type: bool
        required: false
        default: false

      borg_storage_quota:
        type: str
        required: false
        default: ""

      borg_compression:
        type: str
        required: false
        default: zstd

      borg_included_dirs:
        type: list
        elements: str
        required: false
        default: []
      borg_excluded_dirs:
        type: list
        elements: str
        required: false
        default: []
      borg_passphrase:
        type: str
        required: false

      borg_decryption_keys_yaml_path:
        type: str
        required: false
        default: "{{ inventory_dir }}/decryption_keys.yml"

      borg_backup_script_location:
        type: str
        required: false
        default: /usr/local/bin/run_borg_backup

      borg_backup_timer_name:
        type: str
        required: false
        default: borg_backup

      borg_backup_service_name:
        type: str
        required: false
        default: borg_backup

      borg_backup_argument:
        type: str
        required: false
        default: "{{ borg_server_host_url }}"

      borg_backup_service_successful_exit_status:
        type: list
        elements: str
        required: false
        default: []

      borg_systemd_oncalendar:
        type: str
        required: false
        default: "*-*-* 02:00:00"

      borg_systemd_accuracysec:
        type: str
        required: false
        default: 60min