Skip to content

Commit

Permalink
docs: adjust README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kimdre committed Jun 29, 2024
1 parent 1b46839 commit c20e58b
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,13 @@ all available variables.

### backup_type

Type of backup to create. Can be `snapshot` or `backup`.
Type of backup to create.

#### Possible formats:

- `snapshot` is generally cheaper with smaller servers and disk usage and there is no limit on the number of snapshots
that can be created
- `backup` needs to be enabled first for the server and only 7 backups can be created per server
that can be created.
- `backup` needs to be enabled first for the server and only 7 backups can be created per server before they get rotated.

#### Default value

Expand All @@ -65,7 +67,11 @@ backup_description: "{{ inventory_hostname }} {{ now(fmt='%Y-%m-%d %H:%M:%S') }}
### backup_labels

List of labels of the snapshot/backup.
Format: `key: "value"` or `key: ""` for labels without a value.

#### Possible formats:

- `key: "value"`
- `key: ""` for labels without a value.

#### Default value

Expand All @@ -83,7 +89,10 @@ List of labels to identify snapshots for rotation, should overlap with [`backup_

Only used when [`backup_type`](#backup_type) is set to `snapshot`.

Format: `key: "value"` or `key: ""` for labels without a value
#### Possible formats:

- `key: "value"`
- `key: ""` for labels without a value.

#### Default value

Expand Down Expand Up @@ -160,7 +169,7 @@ delegation: "{{ inventory_hostname }}"
vars:
api_token: "your-hcloud-api-token"
backup_type: "snapshot"
keep_snapshots: 8
keep_snapshots: 7
```

## Dependencies
Expand Down

0 comments on commit c20e58b

Please sign in to comment.