Skip to content

Commit 0c9f84d

Browse files
committed
feat(cold archive): improve getting starting guide
1 parent d7e022a commit 0c9f84d

File tree

1 file changed

+38
-39
lines changed
  • pages/storage_and_backup/object_storage/cold_archive_getting_started

1 file changed

+38
-39
lines changed

pages/storage_and_backup/object_storage/cold_archive_getting_started/guide.en-gb.md

Lines changed: 38 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@ updated: 2024-11-29
66

77
## Objective
88

9-
Cold Archive is a service for long-term data storage.
10-
When archived, every object of a bucket is stored on physical tapes.
11-
Restoration can take some time as it needs to be read on tapes.
9+
Cold Archive provides long-term data storage by archiving bucket objects onto physical tapes.
10+
Restoration may take some time since data is read from tapes.
1211

13-
**This guide explains how to set up storage on tapes with Cold Archive.**
12+
**This guide explains how to set up and manage storage on tapes with Cold Archive, in coexistence with your Object Storage.**
1413

1514
## Requirements
1615

@@ -19,14 +18,20 @@ Restoration can take some time as it needs to be read on tapes.
1918

2019
## Instructions
2120

21+
This section explains the step-by-step process to configure, archive, restore, and delete buckets with Cold Archive, in coexistence with your Object Storage.
22+
2223
In this tutorial, **awscli aliases** are used to simplify the commands.
2324

25+
### Initial Setup: create AWS CLI Aliases
26+
27+
To simplify commands, create or edit the ~/.aws/cli/alias file:
28+
2429
```bash
2530
mkdir -p ~/.aws/cli
2631
touch ~/.aws/cli/alias
2732
```
2833

29-
Add this content to the file:
34+
Add the following content:
3035

3136
```bash
3237
[toplevel]
@@ -44,50 +49,34 @@ delete-ovh-archive = s3api delete-bucket-intelligent-tiering-configuration --id
4449
>
4550
> - `Id` is a string used to identify the S3 **\*** Intelligent-Tiering configuration. Its value is arbitrary and up to you. It will be necessary for further PUT, GET and DELETE operations on the intelligent-tiering configuration.
4651
>
47-
> - `Status` and `Days` are mandatory but not used.
52+
> - `Status` and `Days` are mandatory but not used. Days is only meaningful with certain access tiers.
4853
>
4954
50-
To retrieve an Intelligent tiering configuration, use the get-bucket-intelligent-tiering-configuration command:
55+
### Check for Incomplete Multipart Uploads Before Archiving
56+
57+
Run this command to ensure there are no incomplete multipart uploads on your bucket:
5158

5259
```bash
53-
aws s3api get-bucket-intelligent-tiering-configuration --bucket example-bucket --id myid
60+
aws --endpoint-url https://s3.rbx-archive.io.cloud.ovh.net s3api list-multipart-uploads --bucket <bucket_name>
5461
```
5562

56-
```json
57-
{
58-
"Id": "myid",
59-
"Status": "Enabled",
60-
"Tierings": [
61-
{"Days": 999, "AccessTier": "OVH_ARCHIVE"}
62-
]
63-
}
64-
```
63+
### **Archive a Bucket**
6564

6665
> [!primary]
6766
>
68-
> If you have defined multiple profiles, add `--profile <profile>` to the command line.
67+
> Before archiving a bucket, make sure there are no incomplete multipart uploads.
6968
>
7069
71-
### Bucket archiving
72-
73-
Before archiving a bucket, make sure there are no incomplete multipart uploads.
74-
This can be done with:
75-
76-
```bash
77-
aws --endpoint-url https://s3.rbx-archive.io.cloud.ovh.net s3api list-multipart-uploads --bucket <bucket_name>
78-
```
79-
80-
#### Archive a bucket
8170

8271
```bash
8372
aws --endpoint-url https://s3.rbx-archive.io.cloud.ovh.net put-ovh-archive <bucket_name>
8473
```
8574

86-
After this request, the bucket is not archived yet.<br>
87-
It will take some time before it is archived on the tapes.<br>
88-
From this command and until a restoration, the bucket cannot accept any read or write requests on objects (listing objects is still allowed).
75+
- The bucket status changes to Archiving.
76+
- Objects cannot be read or written during this process; only listing is allowed.
77+
- Archiving to tapes takes some time.
8978

90-
#### Archive a bucket with retention lock
79+
### Archive a bucket with retention lock (WORM Compliance)
9180

9281
By default, an archive is not locked i.e you can still delete an archive after it has been written to tapes. To ensure your archive follows the WORM (Write Once Read Many) model, you can set a retention period in your intelligent tiering configuration using the `OVH_ARCHIVE_LOCK` access tier and a number of days. The archive will be then locked until the current date + the number of days specified.
9382

@@ -113,7 +102,7 @@ By default, an archive is not locked i.e you can still delete an archive after i
113102
> Similarly, you cannot have multiple access tiers in your intelligent tiering configuration i.e either you use the `OVH_ARCHIVE` access tier or you use the `OVH_ARCHIVE_LOCK` access tier but not both.
114103
>
115104
116-
#### Lock a bucket after it is archived
105+
### Lock an Already Archived Bucket
117106

118107
If you have buckets that have been previously archived without using the `OVH_ARCHIVE_LOCK` access tier, you can still lock them by re-applying an intelligent tiering configuration to your bucket using the `OVH_ARCHIVE_LOCK` access tier and specifying a retention duration in days.
119108

@@ -135,22 +124,22 @@ If you want to edit the retention period, similarly, re-apply the intelligent ti
135124
> - OVHcloud Cold Archive will return an error because 2024-02-23 + 5 days < 2024-03-03.
136125
>
137126
138-
### Bucket restoring
127+
### Restore a Bucket
139128

140129
Restore a bucket:
141130

142131
```bash
143132
aws --endpoint-url https://s3.rbx-archive.io.cloud.ovh.net put-ovh-restore <bucket_name>
144133
```
145134

146-
After this request, the bucket is not restored yet.<br>
147-
It will take some time before it is restored and for the objects to be accessible in read-only (writing objects is forbidden).
135+
- Bucket status changes to Restoring.
136+
- Objects become accessible in read-only mode once restoration completes.
148137

149-
### Bucket deletion
138+
### Delete an Archive
150139

151140
> [!primary]
152141
>
153-
> If you have locked your archive, trying to delete it before the end of the retention period will result in a 400 Bad Request error:
142+
> If the bucket is locked, deletion before the retention period expires will fail.
154143
> `An error occurred (BadRequest) when calling the DeleteBucketIntelligentTieringConfiguration operation: Archive deletion is locked until 2124-01-19T15:24:56.000Z`
155144
>
156145
@@ -180,7 +169,7 @@ Once the deletion is completed:
180169
aws s3 rb s3://<bucket_name>
181170
```
182171

183-
### Bucket status
172+
### Check Bucket Status and Retention Tags
184173

185174
Once an intelligent-tiering configuration has been pushed (via a `put-bucket-intelligent-tiering-configuration` operation) and until it is removed (via a `delete-bucket-intelligent-tiering-configuration` operation), the status of a bucket is readable through:
186175

@@ -221,6 +210,16 @@ aws --endpoint-url https://s3.rbx-archive.io.cloud.ovh.net s3api get-bucket-tagg
221210
| `Deleting` | Objects deletion from tapes (and disks if restored) in progress. | Listing |
222211
| `Flushed` | Bucket is empty and can safely be removed. | Listing (empty bucket) |
223212

213+
### Advanced Verification: Inspect Intelligent Tiering Configuration
214+
215+
To retrieve the full intelligent-tiering configuration JSON applied to your bucket:
216+
217+
```bash
218+
aws s3api get-bucket-intelligent-tiering-configuration --bucket <bucket_name> --id myid
219+
```
220+
221+
This command returns detailed configuration info useful for debugging or verification.
222+
224223
## Go further
225224

226225
If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.

0 commit comments

Comments
 (0)