Skip to content

Commit 0a766c1

Browse files
committed
chore(gen): documentation review MTA-5379
1 parent 3b66993 commit 0a766c1

File tree

8 files changed

+63
-42
lines changed

8 files changed

+63
-42
lines changed

faq/objectstorage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ Find out [how to restore an object from Glacier](/storage/object/how-to/restore-
232232

233233
## Can I upload an object directly to Glacier?
234234

235-
Yes, you can select the storage class (`STANDARD`, `One Zone IA`, or `GLACIER`) when uploading objects using the Scaleway console. It is also possible to do so using the API. For more information, refer to our [dedicated documentation](/storage/object/how-to/edit-storage-class/).
235+
Yes, you can select the storage class (`Standard`, `One Zone IA`, or `GLACIER`) when uploading objects using the Scaleway console. It is also possible to do so using the API. For more information, refer to our [dedicated documentation](/storage/object/how-to/edit-storage-class/).
236236

237237
## Why are Glacier objects stored in Paris DC4? Is it accessible from buckets in all locations?
238238

storage/object/api-cli/managing-lifecycle-cliv2.mdx

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,22 @@ categories:
3030
- Downloaded [S3cmd](https://github.com/s3tools/s3cmd), [rclone](https://rclone.org/downloads/) and [mc](https://github.com/minio/mc)
3131

3232

33-
## Creating a configuration file for the Scaleway CLI
33+
## Creating an Object Storage configuration file for the Scaleway CLI
3434

3535
<Message type="important">
3636
Unless you add a region argument to your commands, the configuration file will be set for the default region.
3737
</Message>
3838

39-
1. Run the following command in a terminal to create a configuration file with `rclone`:
39+
<Message type="note">
40+
For more information about generating a configuration file, type the following command in your terminal:
41+
```
42+
scw object config get --help
43+
```
44+
</Message>
45+
46+
### Configuration file for Rclone
47+
48+
Run the following command in a terminal to create a configuration file with `rclone`:
4049

4150
```
4251
scw object config get type=rclone
@@ -61,7 +70,10 @@ categories:
6170
server_side_encryption =
6271
storage_class =
6372
```
64-
2. Run the following command in a terminal to create a configuration file with `s3cmd`:
73+
74+
### Configuration file for s3cmd
75+
76+
Run the following command in a terminal to create a configuration file with `s3cmd`:
6577

6678
```
6779
scw object config get type=s3cmd
@@ -80,6 +92,9 @@ categories:
8092
secret_key = 12345678-1234-1234-4321-123456789123
8193
use_https = True
8294
```
95+
96+
### Configuration file for MinIO Client
97+
8398
3. Run the following command in a terminal to create a configuration file with `mc`:
8499
```
85100
scw object config get type=mc
@@ -91,12 +106,6 @@ categories:
91106
{"version":"9","hosts":{"scaleway":{"url":"https://s3.nl-ams.scw.cloud","accessKey":"SCW1111111111111","secretKey":"12345678-1234-1234-4321-123456789123","api":"S3v4"}}}
92107
```
93108

94-
<Message type="note">
95-
For more information about generating a configuration file, type the following command in your terminal:
96-
```
97-
scw object config get --help
98-
```
99-
</Message>
100109

101110
## Installing a configuration file for Amazon S3-compatible tools (s3cmd, rclone, and mc)
102111

storage/object/how-to/create-a-bucket.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Create a new bucket in Scaleway Object Storage.
88
tags: object storage bucket object-storage
99
dates:
10-
validation: 2024-06-13
10+
validation: 2024-12-18
1111
posted: 2021-05-27
1212
categories:
1313
- storage
@@ -21,12 +21,11 @@ Object Storage allows you to store different types of objects (documents, images
2121
- A Scaleway account logged into the [console](https://console.scaleway.com)
2222
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2323

24-
2524
To get started with Object Storage, you must first create a bucket. Objects are gathered into buckets. Each bucket represents a space where objects are stored.
2625

2726
1. Click **Object Storage** on the left side menu of the console. The Object Storage dashboard displays.
2827
2. Click **+ Create bucket**. The bucket creation page displays.
29-
3. Select the geographical location in which to create your bucket. Scaleway Object Storage is currently available in three Regions.
28+
3. Select the [region](/storage/object/concepts/#region-and-availability-zone) in which to create your bucket:
3029
- Amsterdam, The Netherlands:
3130
- Region: `nl-ams`
3231
- Paris, France:
@@ -42,8 +41,8 @@ To get started with Object Storage, you must first create a bucket. Objects are
4241
5. Select a use case for your bucket.
4342
6. Enable [bucket versioning](/storage/object/how-to/use-bucket-versioning/) if you want to store multiple versions of your objects (this may lead to higher storage costs).
4443
7. If applicable, you can tick the **Activate 90-day free trial** to benefit from 750 GB of free [Multi-AZ class storage](/faq/objectstorage/#what-are-the-object-storage-classes-offered-by-scaleway) for buckets in your Organization, across all regions. Refer to our [dedicated FAQ](/faq/objectstorage/#how-can-i-benefit-from-the-object-storage-free-trial) for more information.
45-
8. Enter a name for your bucket.
44+
8. Enter a name for your bucket.
4645
9. Optionally, you can use the cost estimator to simulate your Object Storage costs.
4746
10. Click **Create bucket** to confirm. A list of your buckets displays, showing the newly created bucket.
4847

49-
You can find more information about your bucket by clicking on its name in the **Buckets** list and then on the **Bucket settings** tab.
48+
You can find more information about your bucket by clicking on its name in the **Buckets** list, and then on the **Bucket settings** tab.

storage/object/how-to/delete-a-bucket.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Delete unwanted buckets from Scaleway Object Storage.
88
tags: object storage object-storage bucket
99
dates:
10-
validation: 2024-06-13
10+
validation: 2024-12-19
1111
posted: 2021-01-04
1212
categories:
1313
- storage
@@ -38,4 +38,3 @@ Alternatively, you can delete a bucket by clicking the <Icon name="more" /> icon
3838

3939
Once the bucket is deleted, it disappears from your bucket list.
4040

41-

storage/object/how-to/manage-object-visibility.mdx

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ content:
77
paragraph: Control visibility settings for objects in Object Storage.
88
tags: object storage object-storage visibility
99
dates:
10-
validation: 2024-06-13
10+
validation: 2024-12-19
1111
posted: 2021-05-27
1212
categories:
1313
- storage
1414
- object-storage
1515
---
1616

17-
Visibility specifies whether your object is visible to others or not.
17+
Object visibility specifies whether your object is visible to others or not, independently from [bucket visibility](/storage/object/concepts/#visibility).
1818

1919
<Macro id="requirements" />
2020

@@ -26,19 +26,39 @@ Visibility specifies whether your object is visible to others or not.
2626
All objects are private by default, even if they are in a public bucket. A private file in a public bucket cannot be accessed publicly.
2727
</Message>
2828

29+
## Manage the visibility of a single object
30+
2931
1. Click **Object Storage** in the **Storage** section of the side menu. The list of your buckets displays.
3032
2. Click the name of your bucket. A list of your objects displays.
3133
3. Click <Icon name="more" /> next to the selected object name.
3234
4. Click **Visibility**. A pop-up appears.
3335
5. Check **Public** or **Private** according to your preference.
3436
6. Click **Update object visibility** to confirm.
3537

36-
<Message type="important">
37-
You can only configure the visibility (public or private) of one object at a time. It is not possible to perform this action on an entire bucket, on which visibility is defined by default as private. Allowing public visibility of a bucket only allows the viewing of a list of objects that are stored in the bucket.
38-
</Message>
39-
4038
<Message type="tip">
41-
If you upload a file using the CLI, you can make it public by using the `--acl public-read` parameter.
39+
If you upload a file using the CLI, you can make it public by using the `--acl public-read` parameter. However, [bucket policies](/storage/object/api-cli/bucket-policy/) take precedence over ACLs.
4240
</Message>
4341

42+
## Manage the visibility of multiple objects
43+
44+
You can manage the visibility of multiple ojects at a time using a [bucket policy](/storage/object/api-cli/bucket-policy/) as shown below. By allowing [GetObject](/storage/object/api-cli/object-operations/#getobject) operations to everyone, the desired objects can be accessed by any person with the link to the object.
4445

46+
```json
47+
{
48+
"Id": "object-visibility",
49+
"Version": "2023-04-17",
50+
"Statement": [
51+
{
52+
"Sid": "make-objects-visible",
53+
"Principal": "*",
54+
"Action": [
55+
"s3:GetObject"
56+
],
57+
"Effect": "Allow",
58+
"Resource": [
59+
"my-bucket/public-objects"
60+
]
61+
},
62+
]
63+
}
64+
```

storage/object/how-to/restore-an-object-from-glacier.mdx

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Retrieve objects from Glacier in Object Storage.
88
tags: object-storage object storage glacier
99
dates:
10-
validation: 2024-06-13
10+
validation: 2024-12-19
1111
posted: 2021-05-27
1212
categories:
1313
- storage
@@ -22,28 +22,26 @@ categories:
2222
- An object in [Glacier storage class](/storage/object/how-to/edit-storage-class/)
2323

2424
<Message type="important">
25-
Objects in `Glacier` can only be restored to `Standard` class.
25+
Objects in Glacier can only be restored to `Standard` class.
2626
</Message>
2727

2828
<Message type="tip">
29-
To facilitate the steps of restoration and ensure fast restitution of your data, we recommend you store average-sized files (larger than 1 MB) in `Glacier`, as opposed to several small files.
29+
To facilitate the steps of restoration and ensure fast restitution of your data, we recommend you store average-sized files (larger than 1 MB) in Glacier, as opposed to several small files.
3030
</Message>
3131

3232
## How to restore an object
3333

3434
1. Click **Object Storage** in the **Storage** section of the side menu. The list of your buckets displays.
3535

36-
2. Click the bucket name that contains the objects you want to restore to `STANDARD` class. The list of objects displays.
36+
2. Click the bucket name that contains the objects you want to restore to `Standard` class. The list of objects displays.
3737

38-
3. Click <Icon name="more" />, then select **Restore** from the drop-down menu.
38+
3. Click <Icon name="more" />, then select **Restore** from the drop-down menu. A pop-up appears.
3939

40-
A pop-up appears.
41-
42-
4. Enter the number of days after which the object will be transferred back to `Glacier`, or click the toggle to permanently restore the object.
40+
4. Enter the number of days after which the object will be transferred back to Glacier, or click the toggle to permanently restore the object.
4341

4442
5. Click **Restore object from Glacier**.
4543

46-
Your object remains available in `Standard` class for the duration you specified. It will be transferred automatically back to `Glacier` once the configured period is over.
44+
Your object remains available in `Standard` class for the duration you specified. It will be transferred automatically back to Glacier once the configured period is over.
4745

4846

4947
## How to restore all objects in a bucket
@@ -77,7 +75,7 @@ The time it takes to restore an object depends on the size of the object and if
7775

7876
For multipart objects, each part is equivalent to one object. Consequently, the more parts your object has, the longer the restore time will be.
7977

80-
To determine how many parts a multipart object has, you can run the following `aws-cli` command:
78+
To determine how many parts a multipart object has, run the following `aws-cli` command:
8179

8280
```
8381
aws s3api <object-name> --bucket <bucket-name> --key b
@@ -96,5 +94,3 @@ For a multipart object, the `Etag` includes a suffix that indicates the number o
9694
}
9795
```
9896
Therefore, in this example, the time it takes to restore the object (that has 14 parts) is equivalent to the time it takes to restore 14 objects.
99-
100-

storage/object/how-to/upload-files-into-a-bucket.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Upload files into your Scaleway Object Storage bucket.
88
tags: bucket object-storage object storage
99
dates:
10-
validation: 2024-06-14
10+
validation: 2024-12-19
1111
posted: 2021-05-27
1212
categories:
1313
- storage

storage/object/how-to/use-bucket-versioning.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Enable and manage bucket versioning for Object Storage.
88
tags: object storage object-storage bucket versioning archived
99
dates:
10-
validation: 2024-06-13
10+
validation: 2024-12-19
1111
posted: 2021-05-27
1212
categories:
1313
- storage
@@ -33,7 +33,7 @@ Versioning allows you to easily recover your objects in case of unintended user
3333
5. Type **ENABLE** to confirm your action, then click **Enable bucket versioning** to proceed.
3434

3535
<Message type="note">
36-
Once versioning is enabled, uploading an object with the same name as an existing object will create a new version of it, and will consume more storage, which may lead to higher costs.
36+
Once versioning is enabled, uploading an object with the same name as an existing object will create a new version of it. This new version will consume more storage, which may lead to higher costs.
3737
</Message>
3838

3939
## How to manage object versions
@@ -42,7 +42,7 @@ Once versioning is enabled, uploading an object with the same name as an existin
4242
2. Click the name of your selected bucket. A list of the objects it contains appears.
4343
3. Click <Icon name="more" /> next to the object you want to manage, then click **Versioning**. A list of the object versions displays.
4444

45-
4. Click <Icon name="more" /> next to a non-current object version to download or permanently delete it.
45+
4. Click <Icon name="more" /> next to a non-current object version to download it, or permanently delete it.
4646

4747
<Message type="note">
4848
To restore an object to a previous version, download the desired non-current version and upload it again. This action will replace the current version with the uploaded one.
@@ -59,5 +59,3 @@ To restore an object to a previous version, download the desired non-current ver
5959
<Message type="important">
6060
Once versioning is suspended, no new object versions will be created. Versions created up until this point will remain stored and billable. Uploading an object with the same name as an existing object will overwrite it.
6161
</Message>
62-
63-

0 commit comments

Comments
 (0)