├── .travis.yml ├── LICENSE ├── README.md ├── defaults └── main.yml ├── meta └── main.yml ├── tasks ├── borgbackup_client.yml ├── borgbackup_server.yml ├── install.yml ├── install_arch.yml ├── install_binary.yml ├── install_debian.yml └── main.yml ├── templates ├── job.sh.j2 └── prune_job.sh.j2 └── tests ├── inventory └── test.yml /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | language: python 3 | python: "2.7" 4 | 5 | # Use the new container infrastructure 6 | sudo: false 7 | 8 | # Install ansible 9 | addons: 10 | apt: 11 | packages: 12 | - python-pip 13 | 14 | install: 15 | # Install ansible 16 | - pip install ansible 17 | 18 | # Check ansible version 19 | - ansible --version 20 | 21 | # Create ansible.cfg with correct roles_path 22 | - printf '[defaults]\nroles_path=../' >ansible.cfg 23 | 24 | script: 25 | # Basic role syntax check 26 | - ansible-playbook tests/test.yml -i tests/inventory --syntax-check 27 | 28 | notifications: 29 | webhooks: https://galaxy.ansible.com/api/v1/notifications/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Borgbackup 2 | ========== 3 | 4 | Ansible [Borgbackup](https://borgbackup.readthedocs.io/en/stable/) role. 5 | 6 | Features: 7 | * Repository or binary installation 8 | * Schedules regular backup jobs 9 | * Schedules regular prune jobs to keep backup windows clean 10 | * Flexible configuration to list backup targets 11 | 12 | Role Variables 13 | -------------- 14 | 15 | see `defaults/main.yml` 16 | 17 | Example Playbook 18 | ---------------- 19 | 20 | - hosts: all 21 | roles: 22 | - role: SphericalElephant.borgbackup 23 | borgbackup_client: True 24 | borgbackup_client_backup_server: backup01.example.com 25 | borgbackup_client_jobs: 26 | - name: system 27 | day: "*" 28 | hour: "0" 29 | minute: "{{ 59 | random }}" 30 | directories: 31 | - /etc 32 | - /home 33 | - /var 34 | excludes: 35 | - 're:^/var/lib/apt' 36 | - 're:^/var/[^/]+\/cache/' 37 | borgbackup_prune_jobs: 38 | - name: system 39 | prune_options: "--keep-daily=7 --keep-weekly=4" 40 | day: "*" 41 | hour: "8" 42 | minute: "0" 43 | 44 | You can easily assign client and server attributes from your inventory with something similar to the following: 45 | 46 | borgbackup_client: "{{ (inventory_hostname in groups.borgbackup_server)|ternary(False, True) }}" 47 | borgbackup_client_backup_server: "{{ groups.borgbackup_server[0] }}" 48 | 49 | License 50 | ------- 51 | 52 | Apache 2.0 53 | -------------------------------------------------------------------------------- /defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | borgbackup_install_from_binary: True 4 | borgbackup_install_from_repo: False 5 | 6 | borgbackup_binary_version: "1.0.9" 7 | borgbackup_binary_platform: "borg-linux64" 8 | borgbackup_binary_uri: "https://github.com/borgbackup/borg/releases/download/{{ borgbackup_binary_version }}/{{ borgbackup_binary_platform }}" 9 | borgbackup_binary: "/usr/local/bin/borg" 10 | 11 | borgbackup_client: False 12 | # Specify the SSH private key type to use. By default role will generate 13 | # ED25519 keys if they are supported by the remote host, otherwise RSA keys 14 | # will be generated. 15 | borgbackup_client_ssh_key_type: '{{ "ed25519" 16 | if ("ssh-ed25519" in borgbackup_register_key_types.stdout_lines) 17 | else "rsa" }}' 18 | borgbackup_client_ssh_key_file: "/root/.ssh/id_{{ borgbackup_client_ssh_key_type }}-backup" 19 | borgbackup_client_ssh_key_comment: 'root@{{ ansible_hostname }} generated by Ansible' 20 | borgbackup_client_scripts_dir: "/etc/borg" 21 | borgbackup_encryption_mode: "none" 22 | borgbackup_passphrase: "yoursecret" 23 | #borgbackup_client_backup_server: backup01.example.com 24 | #borgbackup_client_jobs: 25 | # - name: system 26 | # options: "--compression zlib,6" 27 | # day: "*" 28 | # hour: "{{ 6 | random }}" 29 | # minute: "{{ 59 | random }}" 30 | # directories: 31 | # - "/etc/" 32 | # - "/home" 33 | # excludes: [] 34 | 35 | borgbackup_server: False 36 | borgbackup_server_user: "borgbackup" 37 | borgbackup_server_group: "borgbackup" 38 | borgbackup_server_home: "/srv/borgbackup" 39 | borgbackup_server_pool: "{{ borgbackup_server_home }}/repos" 40 | 41 | borgbackup_prune_enabled: yes 42 | borgbackup_prune_jobs: 43 | - name: system 44 | prune_options: "--keep-daily=7 --keep-weekly=4" 45 | day: "*" 46 | hour: "{{ 4 }}" 47 | minute: "{{ 0 }}" 48 | - name: scripts 49 | prune_options: "--keep-within=10d" 50 | day: "*" 51 | hour: "{{ 4 }}" 52 | minute: "{{ 0 }}" 53 | -------------------------------------------------------------------------------- /meta/main.yml: -------------------------------------------------------------------------------- 1 | galaxy_info: 2 | author: Farhad Shahbazi 3 | description: Borgbackup 4 | company: Spherical Elephant GmbH 5 | license: Apache 6 | min_ansible_version: 2.1 7 | platforms: 8 | - name: Ubuntu 9 | versions: 10 | - all 11 | - name: Debian 12 | versions: 13 | - jessie 14 | - sid 15 | - stretch 16 | - name: Archlinux 17 | galaxy_tags: 18 | - backup 19 | 20 | dependencies: [] 21 | -------------------------------------------------------------------------------- /tasks/borgbackup_client.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: check available SSH key types 4 | shell: ssh -Q key 2>/dev/null || echo "ssh-rsa" 5 | register: borgbackup_register_key_types 6 | changed_when: False 7 | check_mode: no 8 | 9 | - name: generate backup ssh-key 10 | user: 11 | name: root 12 | ssh_key_file: "{{ borgbackup_client_ssh_key_file }}" 13 | ssh_key_type: "{{ borgbackup_client_ssh_key_type }}" 14 | ssh_key_comment: "{{ borgbackup_client_ssh_key_comment }}" 15 | ssh_key_bits: 4096 16 | generate_ssh_key: yes 17 | 18 | - name: fetch backup ssh-pubkey 19 | command: "cat {{ borgbackup_client_ssh_key_file }}.pub" 20 | check_mode: no 21 | register: borgbackup_client_ssh_pubkey_file 22 | changed_when: False 23 | 24 | - name: add ssh-pubkey to backup server 25 | delegate_to: "{{ borgbackup_client_backup_server }}" 26 | # Start the delegate from the ansible master to avoid distributing more keys 27 | connection: local 28 | authorized_key: 29 | user: "{{ borgbackup_server_user }}" 30 | key: "{{ borgbackup_client_ssh_pubkey_file.stdout }}" 31 | key_options: 'command="cd {{ borgbackup_server_pool }}/{{ inventory_hostname }};borg serve --restrict-to-path {{ borgbackup_server_pool }}/{{ inventory_hostname }}",no-port-forwarding,no-X11-forwarding,no-pty,no-agent-forwarding,no-user-rc' 32 | 33 | - name: create repo path for host 34 | delegate_to: "{{ borgbackup_client_backup_server }}" 35 | # Start the delegate from the ansible master to avoid distributing more keys 36 | connection: local 37 | file: 38 | path: "{{ borgbackup_server_pool }}/{{ inventory_hostname }}" 39 | owner: "{{ borgbackup_server_user }}" 40 | group: "{{ borgbackup_server_group }}" 41 | mode: 0700 42 | state: directory 43 | 44 | - name: backup scripts dir 45 | file: 46 | path: "{{ borgbackup_client_scripts_dir }}" 47 | owner: root 48 | group: root 49 | mode: 0750 50 | state: directory 51 | 52 | - name: check if the repositories already exist 53 | command: "{{ borgbackup_binary }} list {{ borgbackup_server_user }}@{{ borgbackup_client_backup_server }}:{{ item.name }}" 54 | environment: 55 | - BORG_RSH: "ssh -o StrictHostKeyChecking=no -i {{ borgbackup_client_ssh_key_file }}" 56 | - BORG_PASSPHRASE: "{{ borgbackup_passphrase }}" 57 | with_items: "{{ borgbackup_client_jobs }}" 58 | register: list_repos 59 | failed_when: False 60 | changed_when: False 61 | check_mode: no 62 | 63 | - name: initialize empty list of initialized repositories 64 | set_fact: 65 | initialized_repos: [] 66 | 67 | - name: store only initialized repositories in the list 68 | set_fact: 69 | initialized_repos: "{{ initialized_repos }} + [ '{{ item.item.name }}' ]" 70 | with_items: "{{ list_repos.results }}" 71 | when: item.rc == 0 72 | 73 | - name: initialize repositories 74 | command: "{{ borgbackup_binary }} init --encryption {{ borgbackup_encryption_mode }} {{ borgbackup_server_user }}@{{ borgbackup_client_backup_server }}:{{ item.name }}" 75 | environment: 76 | - BORG_RSH: "ssh -o StrictHostKeyChecking=no -i {{ borgbackup_client_ssh_key_file }}" 77 | - BORG_PASSPHRASE: "{{ borgbackup_passphrase }}" 78 | with_items: "{{ borgbackup_client_jobs }}" 79 | register: borgbackup_initialize_result 80 | failed_when: (borgbackup_initialize_result.rc != 0) and (borgbackup_initialize_result.stderr != "") and ('already exists' not in borgbackup_initialize_result.stderr) 81 | when: item.name not in initialized_repos 82 | 83 | - name: backup scripts 84 | template: 85 | dest: "{{ borgbackup_client_scripts_dir }}/{{ item.name }}.sh" 86 | src: job.sh.j2 87 | owner: root 88 | group: root 89 | mode: 0700 90 | with_items: "{{ borgbackup_client_jobs }}" 91 | 92 | - name: backup cronjobs 93 | cron: 94 | name: "borg backup {{ item.name }}" 95 | user: root 96 | job: "{{ borgbackup_client_scripts_dir }}/{{ item.name }}.sh 2>&1 | /usr/bin/logger -t borgbackup" 97 | day: "{{ item.day | default('*') }}" 98 | hour: "{{ item.hour | default('1') }}" 99 | minute: "{{ item.minute | default('0') }}" 100 | state: present 101 | cron_file: "borgbackup_backup" 102 | with_items: "{{ borgbackup_client_jobs }}" 103 | 104 | - name: deploy prune scripts 105 | template: 106 | dest: "{{ borgbackup_client_scripts_dir }}/prune_{{ item.name }}.sh" 107 | src: prune_job.sh.j2 108 | owner: root 109 | group: root 110 | mode: 0700 111 | with_items: "{{ borgbackup_prune_jobs }}" 112 | when: borgbackup_prune_enabled 113 | 114 | - name: schedule prune scripts on cron 115 | cron: 116 | name: "borg prune {{ item.name }}" 117 | user: root 118 | job: "{{ borgbackup_client_scripts_dir }}/prune_{{ item.name }}.sh 2>&1 | /usr/bin/logger -t borgbackup" 119 | day: "{{ item.day | default('*') }}" 120 | hour: "{{ item.hour | default('1') }}" 121 | minute: "{{ item.minute | default('0') }}" 122 | state: present 123 | cron_file: "borgbackup_prune" 124 | with_items: "{{ borgbackup_prune_jobs }}" 125 | when: borgbackup_prune_enabled 126 | -------------------------------------------------------------------------------- /tasks/borgbackup_server.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: create group for borg 4 | group: 5 | name: "{{ borgbackup_server_group }}" 6 | state: present 7 | 8 | - name: create user for borg 9 | user: 10 | name: "{{ borgbackup_server_user }}" 11 | group: "{{ borgbackup_server_group }}" 12 | home: "{{ borgbackup_server_home }}" 13 | createhome: yes 14 | state: present 15 | 16 | - name: manage permissions 17 | file: 18 | path: "{{ item }}" 19 | owner: "{{ borgbackup_server_user }}" 20 | group: "{{ borgbackup_server_group }}" 21 | mode: 0700 22 | state: directory 23 | with_items: 24 | - "{{ borgbackup_server_home }}" 25 | - "{{ borgbackup_server_home }}/.ssh" 26 | - "{{ borgbackup_server_pool }}" 27 | 28 | - name: manage permissions for authorized_keys 29 | file: 30 | path: "{{ borgbackup_server_home }}/.ssh/authorized_keys" 31 | owner: "{{ borgbackup_server_user }}" 32 | group: "{{ borgbackup_server_group }}" 33 | mode: 0600 34 | state: touch 35 | -------------------------------------------------------------------------------- /tasks/install.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - assert: 3 | that: 4 | - (borgbackup_install_from_binary and borgbackup_install_from_repo) == false 5 | - (borgbackup_install_from_binary or borgbackup_install_from_repo) == true 6 | msg: > 7 | - Please choose only one installation method 8 | 9 | - include: install_debian.yml 10 | when: ansible_os_family == "Debian" and borgbackup_install_from_repo 11 | 12 | - include: install_arch.yml 13 | when: ansible_os_family == "Archlinux" and borgbackup_install_from_repo 14 | 15 | - include: install_binary.yml 16 | when: borgbackup_install_from_binary 17 | -------------------------------------------------------------------------------- /tasks/install_arch.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: install borgbackup 4 | pacman: 5 | name: borg 6 | state: present 7 | 8 | - name: Install cron 9 | pacman: 10 | name: cronie 11 | state: present 12 | 13 | - name: Enable cron with systemd 14 | systemd: 15 | daemon_reload: yes 16 | service: cronie 17 | enabled: yes 18 | state: started 19 | 20 | -------------------------------------------------------------------------------- /tasks/install_binary.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Download borg binary 4 | get_url: url="{{ borgbackup_binary_uri }}" dest="{{ borgbackup_binary }}" mode=755 5 | -------------------------------------------------------------------------------- /tasks/install_debian.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: enable backports 4 | apt_repository: 5 | repo: "deb http://cdn.debian.net/debian {{ ansible_distribution_release }}-backports main contrib non-free" 6 | state: present 7 | when: ansible_distribution_release == "jessie" 8 | 9 | - name: install borgbackup 10 | apt: 11 | name: borgbackup 12 | default_release: "{{ ansible_distribution_release }}-backports" 13 | state: present 14 | when: ansible_distribution_release == "jessie" 15 | 16 | - name: install borgbackup 17 | apt: 18 | name: borgbackup 19 | state: present 20 | when: ansible_distribution_release != "jessie" 21 | 22 | - name: Configure borg binary location based on installed version 23 | set_fact: 24 | borgbackup_binary: "/usr/bin/borg" 25 | -------------------------------------------------------------------------------- /tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - include: install.yml 4 | tags: ['install', 'borgbackup'] 5 | 6 | - include: borgbackup_server.yml 7 | when: borgbackup_server 8 | tags: borgbackup 9 | 10 | - include: borgbackup_client.yml 11 | when: borgbackup_client 12 | tags: borgbackup 13 | 14 | - debug: msg="Neither borgbackup_server nor borgbackup_client is enabled for this host" 15 | when: borgbackup_server == False and borgbackup_client == False 16 | tags: borgbackup 17 | -------------------------------------------------------------------------------- /templates/job.sh.j2: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | 5 | export BORG_RSH="ssh -i {{ borgbackup_client_ssh_key_file }}" 6 | export BORG_PASSPHRASE="{{ borgbackup_passphrase }}" 7 | 8 | REPOSITORY={{ borgbackup_server_user }}@{{ borgbackup_client_backup_server }}:{{ item.name }} 9 | 10 | {{ borgbackup_binary }} create \ 11 | {{ item.options | default('--compression zlib,6') }} \ 12 | $REPOSITORY::{{ ansible_hostname }}-$(date -I) \ 13 | {{ item.directories | join(' ') }} \ 14 | {% for e in item.excludes %} 15 | --exclude '{{ e }}' \ 16 | {% endfor %} 17 | -------------------------------------------------------------------------------- /templates/prune_job.sh.j2: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | 5 | export BORG_RSH="ssh -i {{ borgbackup_client_ssh_key_file }}" 6 | export BORG_PASSPHRASE="{{ borgbackup_passphrase }}" 7 | 8 | REPOSITORY={{ borgbackup_server_user }}@{{ borgbackup_client_backup_server }}:{{ item.name }} 9 | 10 | {{ borgbackup_binary }} prune \ 11 | {{ item.prune_options }} \ 12 | $REPOSITORY 13 | -------------------------------------------------------------------------------- /tests/inventory: -------------------------------------------------------------------------------- 1 | localhost -------------------------------------------------------------------------------- /tests/test.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | remote_user: root 4 | roles: 5 | - borgbackup --------------------------------------------------------------------------------