Skip to content

Commit

Permalink
Improve docs/usage/immutable_snapshots.md, adding example commands …
Browse files Browse the repository at this point in the history
…to make buckets immutable. (#806)
  • Loading branch information
renormalize authored Nov 29, 2024
1 parent 43a44d3 commit 56cdd62
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/usage/immutable_snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,27 @@ Etcd-backup-restore supports immutable objects, typically at what cloud provider

It is also possible to enable immutability retroactively by making appropriate API calls to your cloud provider, allowing the immutable snapshots feature to be used with existing buckets. For information on such configurations, please refer to your cloud provider's documentation.

The behaviour of bucket's objects uploaded before a bucket is set to immutable varies among storage providers. Etcd-backup-restore manages these objects and will perform garbage collection according to the configured garbage collection policy and the object's immutability expiry.
Setting the immutability period at the bucket level through the CLI can be done through the following commands:

- Google Cloud Storage would be done like so:

```sh
gcloud storage buckets update <your-bucket> --retention-period=<desired-immutability-period>
```

- Azure Blob Storage Container would be done like so:

```sh
az storage container immutability-policy create --resource-group <your-resource-group> --account-name <your-account-name> --container-name <your-container-name> --period <desired-immutability-period>
```

The behaviour of bucket's objects uploaded before a bucket is set to immutable varies among storage providers. etcd-backup-restore manages these objects and will perform garbage collection according to the configured garbage collection policy and the object's immutability expiry.

> Note: If immutable snapshots are not enabled then the object's immutability expiry will be considered as zero, hence causing no effect on current functionality.
## Current Capabilities
Etcd-backup-restore does not require configurations related to the immutability period of bucket's objects as this information is derived from the bucket's existing immutability settings. The etcd-backup-restore process also verifies the immutability expiry time of an object prior to initiating its garbage collection.
etcd-backup-restore does not require configurations related to the immutability period of bucket's objects as this information is derived from the bucket's existing immutability settings. The etcd-backup-restore process also verifies the immutability expiry time of an object prior to initiating its garbage collection.
Therefore, it is advisable to configure your garbage collection policies based on the duration you want your objects to remain immutable.
Expand Down

0 comments on commit 56cdd62

Please sign in to comment.