aboutsummaryrefslogtreecommitdiffstats
path: root/meta/argument_specs.yml
blob: 984b1cad2be32b8f72b6cdcf2aae021c4f1994ea (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
---
argument_specs:
  main:
    options:

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

      borg_server_host_ssh_key:
        type: str
        required: true

      ################################################################################
      # State Configuration
      ################################################################################
      state:
        type: str
        required: false
        default: present
        choices:
          - present
          - absent

      borg_dangerously_delete_backups:
        type: bool
        required: false
        default: false

      ################################################################################
      # 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_create_additional_arguments:
        type: str
        required: false
        default: ""

      borg_prune_enabled:
        type: bool
        required: false
        default: false

      borg_prune_trigger:
        type: str
        required: false
        default: after_backup
        choices:
          - after_backup
          - timer

      borg_prune_additional_arguments:
        type: str
        required: false
        default: ""

      borg_prune_glob_archives:
        type: str
        required: false
        default: "{hostname}-*"

      borg_prune_force:
        type: bool
        required: false
        default: false

      borg_prune_stats:
        type: bool
        required: false
        default: true

      borg_prune_list:
        type: bool
        required: false
        default: false

      borg_prune_save_space:
        type: bool
        required: false
        default: false

      borg_prune_checkpoint_interval:
        type: int
        required: false
        default: 1800

      borg_prune_keep_within:
        type: str
        required: false
        default: ""

      borg_prune_keep_last:
        type: str
        required: false
        default: ""

      borg_prune_keep_minutely:
        type: str
        required: false
        default: ""

      borg_prune_keep_hourly:
        type: str
        required: false
        default: ""

      borg_prune_keep_daily:
        type: str
        required: false
        default: ""

      borg_prune_keep_weekly:
        type: str
        required: false
        default: ""

      borg_prune_keep_monthly:
        type: str
        required: false
        default: ""

      borg_prune_keep_13weekly:
        type: str
        required: false
        default: ""

      borg_prune_keep_3monthly:
        type: str
        required: false
        default: ""

      borg_prune_keep_yearly:
        type: str
        required: false
        default: ""

      borg_prune_compact_enabled:
        type: bool
        required: false
        default: true

      borg_compact_additional_arguments:
        type: str
        required: false
        default: ""

      borg_compact_cleanup_commits:
        type: bool
        required: false
        default: false

      borg_compact_threshold:
        type: int
        required: false
        default: 10

      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_prune_script_location:
        type: str
        required: false
        default: /usr/local/bin/run_borg_prune

      borg_backup_timer_name:
        type: str
        required: false
        default: borg_backup

      borg_backup_service_name:
        type: str
        required: false
        default: borg_backup

      borg_prune_timer_name:
        type: str
        required: false
        default: borg_prune

      borg_prune_service_name:
        type: str
        required: false
        default: borg_prune

      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_prune_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

      borg_prune_systemd_oncalendar:
        type: str
        required: false
        default: "*-*-* 03:30:00"

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