Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Highlight use of TTL flag to specify backup retention #2399

Merged
merged 2 commits into from
Apr 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions site/docs/master/disaster-case.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you periodically back up your cluster's resources, you are able to return to
velero schedule create <SCHEDULE NAME> --schedule "0 7 * * *"
```

This creates a Backup object with the name `<SCHEDULE NAME>-<TIMESTAMP>`.
This creates a Backup object with the name `<SCHEDULE NAME>-<TIMESTAMP>`. The default backup retention period, expressed as TTL (time to live), is 30 days (720 hours); you can use the `--ttl <DURATION>` flag to change this as necessary. See [how velero works][1] for more information about backup expiry.

1. A disaster happens and you need to recreate your resources.

Expand All @@ -31,9 +31,11 @@ If you periodically back up your cluster's resources, you are able to return to

1. When ready, revert your backup storage location to read-write mode:

```bash
kubectl patch backupstoragelocation <STORAGE LOCATION NAME> \
```bash
kubectl patch backupstoragelocation <STORAGE LOCATION NAME> \
--namespace velero \
--type merge \
--patch '{"spec":{"accessMode":"ReadWrite"}}'
```

[1]: how-velero-works.md#set-a-backup-to-expire
4 changes: 3 additions & 1 deletion site/docs/master/how-velero-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,15 @@ For example, if the cluster being backed up has a `gizmos` resource in the `thin

## Set a backup to expire

When you create a backup, you can specify a TTL by adding the flag `--ttl <DURATION>`. If Velero sees that an existing backup resource is expired, it removes:
When you create a backup, you can specify a TTL (time to live) by adding the flag `--ttl <DURATION>`. If Velero sees that an existing backup resource is expired, it removes:

* The backup resource
* The backup file from cloud object storage
* All PersistentVolume snapshots
* All associated Restores

The TTL flag allows the user to specify the backup retention period with the value specified in hours, minutes and seconds in the form `--ttl 24h0m0s`. If not specified, a default TTL value of 30 days will be applied.

## Object storage sync

Velero treats object storage as the source of truth. It continuously checks to see that the correct backup resources are always present. If there is a properly formatted backup file in the storage bucket, but no corresponding backup resource in the Kubernetes API, Velero synchronizes the information from object storage to Kubernetes.
Expand Down
4 changes: 3 additions & 1 deletion site/docs/master/migration-case.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Velero can help you port your resources from one cluster to another, as long as
velero backup create <BACKUP-NAME>
```

The default TTL is 30 days (720 hours); you can use the `--ttl` flag to change this as necessary.
The default backup retention period, expressed as TTL (time to live), is 30 days (720 hours); you can use the `--ttl <DURATION>` flag to change this as necessary. See [how velero works][1] for more information about backup expiry.

1. *(Cluster 2)* Configure `BackupStorageLocations` and `VolumeSnapshotLocations`, pointing to the locations used by *Cluster 1*, using `velero backup-location create` and `velero snapshot-location create`. Make sure to configure the `BackupStorageLocations` as read-only
by using the `--access-mode=ReadOnly` flag for `velero backup-location create`.
Expand Down Expand Up @@ -46,3 +46,5 @@ Check that the second cluster is behaving as expected:
```

If you encounter issues, make sure that Velero is running in the same namespace in both clusters.

[1]: how-velero-works.md#set-a-backup-to-expire
8 changes: 5 additions & 3 deletions site/docs/v1.3.2/disaster-case.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you periodically back up your cluster's resources, you are able to return to
velero schedule create <SCHEDULE NAME> --schedule "0 7 * * *"
```

This creates a Backup object with the name `<SCHEDULE NAME>-<TIMESTAMP>`.
This creates a Backup object with the name `<SCHEDULE NAME>-<TIMESTAMP>`. The default backup retention period, expressed as TTL (time to live), is 30 days (720 hours); you can use the `--ttl <DURATION>` flag to change this as necessary. See [how velero works][1] for more information about backup expiry.

1. A disaster happens and you need to recreate your resources.

Expand All @@ -31,9 +31,11 @@ If you periodically back up your cluster's resources, you are able to return to

1. When ready, revert your backup storage location to read-write mode:

```bash
kubectl patch backupstoragelocation <STORAGE LOCATION NAME> \
```bash
kubectl patch backupstoragelocation <STORAGE LOCATION NAME> \
--namespace velero \
--type merge \
--patch '{"spec":{"accessMode":"ReadWrite"}}'
```

[1]: how-velero-works.md#set-a-backup-to-expire
4 changes: 3 additions & 1 deletion site/docs/v1.3.2/how-velero-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,15 @@ For example, if the cluster being backed up has a `gizmos` resource in the `thin

## Set a backup to expire

When you create a backup, you can specify a TTL by adding the flag `--ttl <DURATION>`. If Velero sees that an existing backup resource is expired, it removes:
When you create a backup, you can specify a TTL (time to live) by adding the flag `--ttl <DURATION>`. If Velero sees that an existing backup resource is expired, it removes:

* The backup resource
* The backup file from cloud object storage
* All PersistentVolume snapshots
* All associated Restores

The TTL flag allows the user to specify the backup retention period with the value specified in hours, minutes and seconds in the form `--ttl 24h0m0s`. If not specified, a default TTL value of 30 days will be applied.

## Object storage sync

Velero treats object storage as the source of truth. It continuously checks to see that the correct backup resources are always present. If there is a properly formatted backup file in the storage bucket, but no corresponding backup resource in the Kubernetes API, Velero synchronizes the information from object storage to Kubernetes.
Expand Down
4 changes: 3 additions & 1 deletion site/docs/v1.3.2/migration-case.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Velero can help you port your resources from one cluster to another, as long as
velero backup create <BACKUP-NAME>
```

The default TTL is 30 days (720 hours); you can use the `--ttl` flag to change this as necessary.
The default backup retention period, expressed as TTL (time to live), is 30 days (720 hours); you can use the `--ttl <DURATION>` flag to change this as necessary. See [how velero works][1] for more information about backup expiry.

1. *(Cluster 2)* Configure `BackupStorageLocations` and `VolumeSnapshotLocations`, pointing to the locations used by *Cluster 1*, using `velero backup-location create` and `velero snapshot-location create`. Make sure to configure the `BackupStorageLocations` as read-only
by using the `--access-mode=ReadOnly` flag for `velero backup-location create`.
Expand Down Expand Up @@ -46,3 +46,5 @@ Check that the second cluster is behaving as expected:
```

If you encounter issues, make sure that Velero is running in the same namespace in both clusters.

[1]: how-velero-works.md#set-a-backup-to-expire