Ansible Rolle: kimdre.hcloud-backup

Ansible-Rolle zum Erstellen und Rotieren von Backups und Snapshots von Servern in der Hetzner Cloud.

• Anforderungen
• Rollenvariablen
  • api_token
• Standardvariablen
• Beispiel-Playbook
• Lizenz
• Autor

Anforderungen

• Ansible 2.15 oder neuer

Rollenvariablen

api_token

Hetzner Cloud API-Token.

Beispiel

api_token: "dein-hcloud-token"

Kann auch als Umgebungsvariable HCLOUD_TOKEN gesetzt werden.

Standardvariablen

Siehe hcloud-backup/defaults/main.yml für alle verfügbaren Variablen.

backup_type

Art des zu erstellenden Backups.

Mögliche Formate:

• snapshot ist in der Regel günstiger bei kleineren Servern und weniger Speicherplatz, und es gibt keine Begrenzung für die Anzahl der zu erstellenden Snapshots.
• backup muss zuerst für den Server aktiviert werden und es können nur 7 Backups pro Server erstellt werden, bevor sie rotiert werden.

Standardwert

backup_type: snapshot

backup_description

Beschreibung des Snapshots/Backups.

Standardwert

backup_description: "{{ inventory_hostname }} {{ now(fmt='%Y-%m-%d %H:%M:%S') }}"

backup_labels

Liste der Labels des Snapshots/Backups.

Mögliche Formate:

• key: "value"
• key: "" für Labels ohne Wert.

Standardwert

backup_labels:
    created_by: "ansible.hcloud-backup"
    created_at: "{{ now(fmt='%Y-%m-%d_%H-%M-%S') }}"
    host: "{{ inventory_hostname }}"
    rotation: "true"

label_selector

Liste von Labels zur Identifizierung von Snapshots zur Rotation, sollte mit backup_labels übereinstimmen.

Wird nur verwendet, wenn backup_type auf snapshot gesetzt ist.

Mögliche Formate:

• key: "value"
• key: "" für Labels ohne Wert.

Standardwert

label_selector:
    created_by: ansible.hcloud-backup
    host: "{{ inventory_hostname }}"
    rotation: "true"

rotate_snapshots

Snapchat rotieren. Wenn auf true gesetzt, werden die ältesten gefundenen Snapshots gelöscht, abhängig von der Variable keep_snapshots und der Anzahl vorhandener Snapshots.

Wird nur verwendet, wenn backup_type auf snapshot gesetzt ist.

Standardwert

rotate_snapshots: true

keep_snapshots

Anzahl der zu behaltenden Snapshots, ältere Snapshots werden gelöscht.

Wird nur verwendet, wenn backup_type auf snapshot gesetzt ist und rotate_snapshots auf true gesetzt ist.

Standardwert

keep_snapshots: 5

backup_check_retries

Anzahl der Wiederholungsversuche für die Überprüfung der Backup-Erstellung.

Standardwert

backup_check_retries: 40

backup_check_delay

Verzögerung in Sekunden zwischen den Wiederholungsversuchen für die Überprüfung der Backup-Erstellung.

Standardwert

backup_check_delay: 15

delegation

Host, von dem aus die Rollenaufgaben ausgeführt werden

Standardwert

delegation: "{{ inventory_hostname }}"

Beispiel-Playbook

- name: "Snapshot des Hosts erstellen"
  hosts: '{{ target | default("all") }}'
  roles:
    - role: kimdre.hcloud-backup
      vars:
        api_token: "dein-hcloud-api-token"
        backup_type: "snapshot"
        keep_snapshots: 7

Lizenz

Apache-2.0

Autor

• Kim Oliver Drechsel