Skip to content

Commit 0b4ae95

Browse files
committed
chore(gen): content review
1 parent 25ce412 commit 0b4ae95

9 files changed

+42
-81
lines changed

storage/object/api-cli/bucket-operations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Perform various operations on buckets in Scaleway Object Storage using the CLI.
88
tags: object storage object-storage bucket
99
dates:
10-
validation: 2024-07-04
10+
validation: 2025-01-15
1111
posted: 2018-09-14
1212
categories:
1313
- storage

storage/object/api-cli/bucket-website-api.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Configure bucket websites using the API in Scaleway Object Storage.
88
tags: object storage object-storage bucket static-website api
99
dates:
10-
validation: 2024-07-03
10+
validation: 2025-01-15
1111
posted: 2021-02-17
1212
categories:
1313
- storage
@@ -142,7 +142,9 @@ After setting up the basic bucket website configuration with `put-bucket-website
142142

143143
You can also upload the rest of the static web page files that make up your website.
144144

145-
>**Note:** If this is your first time uploading objects into a bucket, you can follow the step-by-step on [this documentation page](/storage/object/how-to/upload-files-into-a-bucket/).
145+
<Message type="note">
146+
If this is your first time uploading objects into a bucket, you can follow the step-by-step on [this documentation page](/storage/object/how-to/upload-files-into-a-bucket/).
147+
</Message>
146148

147149
### Configuring access
148150

@@ -179,12 +181,10 @@ If you want your website to be accessible, you need to set up a bucket policy.
179181

180182
### Configuring your URL
181183

182-
You can access your website using the website endpoint of your bucket, generated by Amazon S3 under the default format:
184+
You can access your website using the website endpoint of your bucket, generated by Scaleway Object Storage under the default format:
183185

184186
`https://<bucket_name>.s3-website.<bucket_region>.scw.cloud`
185187

186188
Replace `<bucket_name>` and `<bucket_region>` accordingly.
187189

188190
Alternatively, you can [configure a CNAME Record](/tutorials/s3-customize-url-cname/) for your bucket URL, to be able to access the website through a domain name of your choice.
189-
190-

storage/object/api-cli/common-operations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Perform common operations efficiently using Scaleway Object Storage CLI.
88
tags: object storage object-storage api api-operation getservice
99
dates:
10-
validation: 2024-07-03
10+
validation: 2025-01-15
1111
posted: 2018-09-13
1212
categories:
1313
- storage

storage/object/api-cli/generate-aws4-auth-signature.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Generate AWS Signature Version 4 for authentication in Scaleway Object Storage.
88
tags: object-storage object storage awsv4 aws authentication
99
dates:
10-
validation: 2024-07-03
10+
validation: 2025-01-15
1111
posted: 2018-07-16
1212
categories:
1313
- storage
@@ -53,7 +53,7 @@ The canonical request included in the signature is made up of:
5353

5454
This means that the following example:
5555

56-
```
56+
```sh
5757
GET /?acl HTTP/1.1
5858

5959
Host: my-bucket.s3.ams-nl.scw.cloud
@@ -63,7 +63,7 @@ x-amz-date: 20190411T101653Z
6363

6464
Would be based on the following canonical code:
6565

66-
```
66+
```sh
6767
GET
6868
/
6969
acl=
@@ -77,7 +77,7 @@ e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
7777

7878
**Example authorization header**
7979

80-
```
80+
```sh
8181
Authorization: AWS4-HMAC-SHA256
8282
Credential=SCWN63TF9BMCPVNARV5A/20190411/nl-ams/s3/aws4_request,
8383
SignedHeaders=host;x-amz-acl;x-amz-content-sha256;x-amz-date,
@@ -86,7 +86,7 @@ Signature=6cab03bef74a80a0441ab7fd33c829a2cdb46bba07e82da518cdb78ac238fda5
8686

8787
**Signing example (pseudo code)**
8888

89-
```
89+
```sh
9090
canonicalRequest = `
9191
${HTTPMethod}\n
9292
${canonicalURI}\n
@@ -108,5 +108,3 @@ signingKey = HMAC-SHA256(dateRegionServiceKey, "aws4_request")
108108

109109
signature = Hex(HMAC-SHA256(signingKey, stringToSign))
110110
```
111-
112-

storage/object/api-cli/installing-minio-client.mdx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Install and configure the MinIO client for Scaleway Object Storage.
88
tags: object-storage object storage minio mc minio-client
99
dates:
10-
validation: 2024-07-04
10+
validation: 2025-01-15
1111
posted: 2021-08-25
1212
categories:
1313
- storage
@@ -18,10 +18,9 @@ The [MinIO Client](https://min.io/docs/minio/linux/reference/minio-mc.html) (`mc
1818

1919
<Macro id="requirements" />
2020

21-
- [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
21+
- [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.
2222

23-
24-
1. Follow the instructions given in the [official MinIO documentation](https://min.io/docs/minio/linux/reference/minio-mc.html#id3) to install the MinIO client (`mc`) for your OS.
23+
1. Follow the instructions given in the [official MinIO documentation](hhttps://min.io/docs/minio/linux/reference/minio-mc.html#install-mc) to install the MinIO client (`mc`) for your OS.
2524
<Message type="note">
2625
Make sure that you download the binary somewhere that is in your `$PATH`.
2726
</Message>
@@ -30,7 +29,7 @@ The [MinIO Client](https://min.io/docs/minio/linux/reference/minio-mc.html) (`mc
3029
```
3130
mc alias set <ALIAS> <YOUR-S3-ENDPOINT> <YOUR-ACCESS-KEY> <YOUR-SECRET-KEY> --api <API-SIGNATURE>
3231
```
33-
For example, if your Scaleway Object Storage endpoint is in the `nl-ams` region, you can use the following command (replace the two fields in pointy brackets with your access key and secret key):
32+
For example, if your Scaleway Object Storage endpoint is in the `nl-ams` region, you can use the following command (replace the two placeholders with your access key and secret key):
3433
```
3534
mc alias set s3 https://s3.nl-ams.scw.cloud <YOUR-ACCESS-KEY> <YOUR-SECRET-KEY> --api S3v4
3635
```
@@ -57,4 +56,3 @@ The [MinIO Client](https://min.io/docs/minio/linux/reference/minio-mc.html) (`mc
5756
```
5857
mc --help
5958
```
60-

storage/object/api-cli/manage-bucket-permissions-ip.mdx

Lines changed: 3 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Manage bucket permissions based on IP addresses in Scaleway Object Storage.
88
tags: object storage bucket ip permission
99
dates:
10-
validation: 2024-07-03
10+
validation: 2025-01-15
1111
posted: 2021-05-18
1212
categories:
1313
- storage
@@ -56,49 +56,8 @@ In the example below, we allow the `192.0.2.0/24` IP range to perform the `s3:Li
5656
]
5757
}
5858
```
59-
You can have the same result if you `Deny` actions for IP addresses specified under the `NotIpAddress` condition:
60-
```json
61-
{
62-
"Version": "2023-04-17",
63-
"Id": "MyBucketPolicy",
64-
"Statement": [
65-
{
66-
"Sid": "Grant List and GET from my Instances",
67-
"Effect": "Deny",
68-
"Principal": "*",
69-
"Action": ["s3:ListBucket", "s3:GetObject"],
70-
"Resource": ["<BUCKET_NAME>", "<BUCKET_NAME>/*"],
71-
"Condition": {
72-
"NotIpAddress": {
73-
"aws:SourceIp": "198.51.100.0/24"
74-
}
75-
}
76-
}
77-
]
78-
}
79-
```
80-
Alternatively, you can block certain IP addresses or IP address ranges from performing actions on your bucket. You can also use `NotIpAddress` with the `Allow` Effect:
81-
```json
82-
{
83-
"Version": "2023-04-17",
84-
"Id": "MyBucketPolicy",
85-
"Statement": [
86-
{
87-
"Sid": "Grant List and GET from my Instances",
88-
"Effect": "Allow",
89-
"Principal": "*",
90-
"Action": ["s3:ListBucket", "s3:GetObject"],
91-
"Resource": ["<BUCKET_NAME>", "<BUCKET_NAME>/*"],
92-
"Condition": {
93-
"NotIpAddress": {
94-
"aws:SourceIp": "2001:db8::/32"
95-
}
96-
}
97-
}
98-
]
99-
}
100-
```
101-
Or the `Deny` effect paired with the `IpAddress` condition:
59+
60+
Alternatively, you can block certain IP addresses or IP address ranges from performing actions on your bucket:
10261
```json
10362
{
10463
"Version": "2023-04-17",

storage/object/api-cli/object-lock.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn to use object locking in Scaleway Object Storage for data protection.
88
tags: object storage object-storage object-lock bucket-test bucket test
99
dates:
10-
validation: 2024-07-04
10+
validation: 2025-01-15
1111
posted: 2021-05-27
1212
categories:
1313
- storage
@@ -190,16 +190,16 @@ aws s3api create-bucket --object-lock-enabled-for-bucket --bucket test-is-lock
190190
```
191191
By default, object lock is not activated on buckets. To activate it, you can run the following command:
192192

193-
<Message type="note">
194-
In the example below, the `object-lock-configuration` is set to 50 days on the specified bucket.
195-
</Message>
196-
197-
```
193+
```sh
198194
aws s3api put-object-lock-configuration \
199195
--bucket my-bucket-with-object-lock \
200196
--object-lock-configuration '{ "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Mode": "COMPLIANCE", "Days": 50 }}}'
201197
```
202198

199+
<Message type="note">
200+
In the example above, the `object-lock-configuration` is set to 50 days on the specified bucket.
201+
</Message>
202+
203203
To view the object lock configuration of a bucket, run the following command:
204204

205205
```sh
@@ -277,7 +277,7 @@ Places an object retention configuration on an object.
277277

278278
**Sample Request**
279279
```xml
280-
PUT /lockedbucked/myobject?retention HTTP/1.1
280+
PUT /lockedbucket/myobject?retention HTTP/1.1
281281
X-Amz-Date: 20201028T052225Z
282282
X-Amz-Content-SHA256: c6998888096fe13a5d84de6db902e3b3c0b623565cd5f2be70330d6ed40dca91
283283
Authorization: XXX
@@ -291,7 +291,7 @@ Content-Length: 149
291291

292292
**Sample Request**
293293
```xml
294-
PUT /lockedbucked/myobject?retention HTTP/1.1
294+
PUT /lockedbucket/myobject?retention HTTP/1.1
295295
X-Amz-Date: 20201028T052346Z
296296
X-Amz-Content-SHA256: 470bfbbffadc821f4b4a398154e9c300d741093205ddbdb25514351b64d64b31
297297
Authorization: XXX
@@ -375,7 +375,7 @@ Applies a legal hold configuration to the specified object.
375375

376376
**Sample Request**
377377
```xml
378-
PUT /lockedbucked/myobject?legal-hold HTTP/1.1
378+
PUT /lockedbucket/myobject?legal-hold HTTP/1.1
379379
X-Amz-Date: 20201028T052448Z
380380
X-Amz-Content-SHA256: 96b73c95a8d33e664ab2170e095025b47ebd55978bb71cebd6a51e394bf96722
381381
Authorization: XXX
@@ -388,7 +388,7 @@ Content-Length: 90
388388

389389
**Sample Request**
390390
```xml
391-
PUT /lockedbucked/myobject?legal-hold HTTP/1.1
391+
PUT /lockedbucket/myobject?legal-hold HTTP/1.1
392392
X-Amz-Date: 20201028T052547Z
393393
X-Amz-Content-SHA256: 33cb1c62439a66fbcbca4ffb243b013ceb212075048f72ab4383f73afb5c4bd9
394394
Authorization: XXX
@@ -405,7 +405,7 @@ Returns the legal hold configuration of the specified object.
405405

406406
**Sample Request**
407407
```xml
408-
GET /lockedbucked/myobject?legal-hold HTTP/1.1
408+
GET /lockedbucket/myobject?legal-hold HTTP/1.1
409409
```
410410
**Sample Response**
411411
```xml
@@ -416,7 +416,7 @@ GET /lockedbucked/myobject?legal-hold HTTP/1.1
416416

417417
**Sample Request**
418418
```xml
419-
GET /lockedbucked/myobject?legal-hold HTTP/1.1
419+
GET /lockedbucket/myobject?legal-hold HTTP/1.1
420420
```
421421

422422
**Sample Response**

storage/object/api-cli/object-operations.mdx

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Perform various operations on objects within Scaleway Object Storage.
88
tags: object storage object-storage operation
99
dates:
10-
validation: 2024-07-04
10+
validation: 2025-01-15
1111
posted: 2018-09-13
1212
categories:
1313
- storage
@@ -16,9 +16,15 @@ categories:
1616

1717
## DeleteObject
1818

19-
This operation allows you to remove the *null* version (if available) of an object and inserts a delete marker, which becomes the latest version of the object.
19+
This operation allows you to remove an object from a bucket. Its behavior depends on the versioning configuration of the bucket:
2020

21-
If there is no *null* version, no object is removed.
21+
- If versioning is not enabled, the object is permanently deleted.
22+
23+
- If versioning is enabled, the operation inserts a delete marker, which becomes the latest version of the object.
24+
25+
- If versioning is suspended, the operation deletes the version with a null `versionID` (if any), then inserts a delete marker, which becomes the latest version of the object.
26+
27+
To delete an object that has a `versionId`, you must add the `versionId` to your request.
2228

2329
<Message type="note">
2430
If the operation is successful, no output will be returned.
@@ -174,7 +180,7 @@ aws s3api get-object-acl --bucket BucketName --key ObjectName
174180
```
175181
## GetObjectLockConfiguration
176182

177-
This operation returns the lock configuration.
183+
This operation returns the object lock configuration.
178184

179185
**Sample request**
180186
```xml

storage/object/api-cli/post-object.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn to upload objects to Scaleway Object Storage using POST requests.
88
tags: object storage object-storage post bucket
99
dates:
10-
validation: 2024-07-03
10+
validation: 2025-01-15
1111
posted: 2021-05-19
1212
categories:
1313
- storage

0 commit comments

Comments
 (0)