Skip to content

Commit 1e33e93

Browse files
SamyOubouazizLaure-di
authored andcommitted
chore(gen): documentation review MTA-5394 (scaleway#4146)
1 parent 6587ab8 commit 1e33e93

File tree

9 files changed

+57
-49
lines changed

9 files changed

+57
-49
lines changed

serverless/jobs/how-to/delete-job.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn to delete jobs effectively on Scaleway Serverless platform.
88
tags: delete serverless job scaleway
99
dates:
10-
validation: 2024-06-17
10+
validation: 2024-12-24
1111
posted: 2021-11-14
1212
categories:
1313
- serverless
@@ -33,5 +33,3 @@ This page shows you how to delete a Serverless Job.
3333
<Message type="tip">
3434
You can also delete a job from its **Settings** tab.
3535
</Message>
36-
37-

serverless/jobs/how-to/monitor-job.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ content:
77
paragraph: Monitor job execution and performance on Scaleway Serverless.
88
tags: serverless jobs logs metrics cockpit grafana activity
99
dates:
10-
validation: 2024-06-17
10+
validation: 2024-12-24
1111
posted: 2023-11-20
1212
categories:
1313
- serverless
1414
- jobs
1515
---
1616

17-
You can monitor the activity of your Serverless Jobs using the [Scaleway console](https://console.scaleway.com) to check the current status, RAM, and CPU consumption of your runs. Also, Serverless Jobs is fully integrated into Scaleway’s Observability [Cockpit](/observability/cockpit/quickstart/) and allows you to quickly access your logs.
17+
You can monitor the activity of your Serverless Jobs using the [Scaleway console](https://console.scaleway.com) to check the current status, RAM, and CPU consumption of your runs. Also, Serverless Jobs is fully integrated into Scaleway’s Observability [Cockpit](/observability/cockpit/quickstart/), and allows you to quickly access your logs.
1818

1919
<Macro id="requirements" />
2020

@@ -60,4 +60,6 @@ Make sure that you have created a Grafana user and [retrieved their username and
6060
3. Click <Icon name="more" /> next to the job run you want to monitor, then:
6161

6262
- Click **Metrics** to access the Grafana metrics overview page for this job run.
63-
- Click **Logs** to access the Grafana logs page for this job run.
63+
- Click **Logs** to access the Grafana logs page for this job run.
64+
65+
You are directed to the selected Grafana dashboard.

serverless/sql-databases/troubleshooting/connection-timeout.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Learn to troubleshoot connection timeout issues in Scaleway serverless SQL databases.
88
tags: database serverless-sql-database timeout connection troubleshooting error
99
dates:
10-
validation: 2024-06-17
10+
validation: 2024-12-24
1111
posted: 2023-11-27
1212
categories:
1313
- serverless

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

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Implement and manage bucket policies in Scaleway Object Storage.
88
tags: object-storage bucket bucket-policy s3
99
dates:
10-
validation: 2024-06-17
10+
validation: 2024-12-24
1111
posted: 2021-02-17
1212
categories:
1313
- storage
@@ -18,11 +18,11 @@ categories:
1818

1919
<Macro id="storage-bucket-policy" />
2020

21-
The different component strings of a bucket policy allow you to [configure fine-grained permissions](/storage/object/api-cli/combining-iam-and-object-storage/) when combined with [Identity and Access Management (IAM)](/identity-and-access-management/iam/concepts/#iam), as shown in the table below.
21+
The different elements of a bucket policy allow you to [configure fine-grained permissions](/storage/object/api-cli/combining-iam-and-object-storage/) when combined with [Identity and Access Management (IAM)](/identity-and-access-management/iam/concepts/#iam), as shown in the table below.
2222

23-
<Lightbox src="scaleway-bucket-policy-iam-table.webp" alt="" />
23+
<Lightbox src="scaleway-bucket-policy-iam-table.webp" alt="bucket policy and IAM interaction table" />
2424

25-
Bucket policies behave like objects: they can be uploaded into buckets. Once you upload, or "put", a bucket policy into a bucket, it takes immediate effect and will from then on define who can access and perform actions on the bucket and the objects it contains.
25+
Bucket policies behave like objects: they can be uploaded into buckets. Once you upload, or "put" a bucket policy into a bucket, it takes immediate effect and will from then on define who can access and perform actions on the bucket, and the objects it contains.
2626

2727
<Macro id="important-bucket-policy" />
2828

@@ -39,7 +39,7 @@ Bucket policies behave like objects: they can be uploaded into buckets. Once you
3939

4040
## Bucket policies description
4141

42-
Bucket policies use a JSON-based access policy language and are composed of strings, such as: `Version`, `Id`, `Statement`, `Sid`, `Principal`, `Action`, `Effect`, `Resource`, and `Condition`.
42+
Bucket policies use a JSON-based access policy language, and are composed of strings, such as: `Version`, `Id`, `Statement`, `Sid`, `Principal`, `Action`, `Effect`, `Resource`, and `Condition`.
4343

4444
### Version
4545

@@ -200,7 +200,7 @@ Bucket policies use a JSON-based access policy language and are composed of stri
200200
### Sid
201201

202202
**Description**
203-
: Provides a way to include information about an individual statement.
203+
: Statement ID. Provides a way to include information about an individual statement.
204204

205205
**Required**
206206
: No
@@ -274,7 +274,7 @@ Bucket policies use a JSON-based access policy language and are composed of stri
274274
### Principal
275275

276276
**Description**
277-
: Defines the targets of the bucket policy, which can be a [user](/identity-and-access-management/iam/concepts#user) or an [application](/identity-and-access-management/iam/concepts#application). You must use the `user_id` and/or `application_id`, or `*` to grant access to "everyone".
277+
: Defines the targets of the bucket policy, which can be a [user](/identity-and-access-management/iam/concepts#user) or an [application](/identity-and-access-management/iam/concepts#application). You must use `user_id` and/or `application_id`, or `*` to grant access to "everyone".
278278

279279
**Required**
280280
: Yes
@@ -517,6 +517,7 @@ Bucket policies use a JSON-based access policy language and are composed of stri
517517
]
518518
}
519519
```
520+
520521
### Condition
521522

522523
**Description**
@@ -605,7 +606,9 @@ Bucket policies use a JSON-based access policy language and are composed of stri
605606
]
606607
}
607608
```
609+
608610
#### Supported conditions
611+
609612
- `IpAddress`
610613
- `NotIpAddress`
611614
- `StringEquals`

storage/object/api-cli/lifecycle-rules-api.mdx

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Use the API to manage lifecycle rules in Scaleway Object Storage.
88
tags: object storage object-storage lifecycle
99
dates:
10-
validation: 2024-06-17
10+
validation: 2024-12-24
1111
posted: 2019-05-14
1212
categories:
1313
- storage
@@ -19,7 +19,7 @@ categories:
1919
- [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
2020
- An [Object Storage bucket](/storage/object/how-to/create-a-bucket/)
2121

22-
It is possible to configure the lifecycle of a group of objects so that their storage costs can be effectively managed. A lifecycle configuration is a set of rules that defines actions applied to a group of objects stored on Object Storage.
22+
You can configure the lifecycle of a group of objects so that their storage costs can be effectively managed. A lifecycle configuration is a set of rules that defines actions applied to a group of objects stored on Object Storage.
2323

2424
Currently, the **expiration**, **transition**, and **incomplete multipart uploads** actions are supported on the platform:
2525
* **Expiration** defines when objects expire. This allows for the automatic deletion of objects on your behalf.
@@ -35,7 +35,7 @@ Currently, the **expiration**, **transition**, and **incomplete multipart upload
3535
Refer to our [dedicated documentation](/storage/object/how-to/edit-storage-class/) to manually change the storage class of your objects.
3636
</Message>
3737

38-
There might, for example, be a need to store log files for a week or a month, after which they become obsolete. It is possible to set a lifecycle rule to delete them automatically when they become obsolete. If you consider that a 3-month-old object is rarely used but still has a value, you might want to configure a rule to send it automatically to [Scaleway Glacier](https://www.scaleway.com/en/glacier-cold-storage/), for example.
38+
There might, for example, be a need to store log files for a week or a month, after which they become obsolete. It is possible to set a lifecycle rule to delete them automatically when they become obsolete. If you consider that a 3-month-old object is rarely used but still has a value, you might want to configure a rule to send it automatically to [Scaleway Glacier](/faq/objectstorage/#what-is-the-cold-storage-glacier-class), for example.
3939

4040
Lifecycle management on Object Storage is available on every Amazon S3 compliant tool (sdk, aws-cli, boto, etc), as well as from the Scaleway [console](https://console.scaleway.com/organization).
4141

@@ -68,20 +68,23 @@ Each `Rule` consists of the following:
6868
## Available XML tokens
6969

7070
### Rule
71+
7172
**Description**
7273
: Container for a lifecycle rule. There is a limit of one thousand (1000) rules per bucket.
7374

7475
**Parent**
7576
: `LifecycleConfiguration`
7677

7778
### Filter
79+
7880
**Description**
7981
: Container for elements that describes the subset of the object the rule applies for. If the content of the tag is empty, the rule applies to all objects in the bucket.
8082

8183
**Parent**
8284
: `Rule`
8385

8486
### And
87+
8588
**Description**
8689
: Container for chaining rule filters.
8790

@@ -101,13 +104,15 @@ Each `Rule` consists of the following:
101104
This applies the `Prefix` rule *and* the `Tag`.
102105

103106
### Prefix
107+
104108
**Description**
105109
: Object key prefix identifying one or more objects to which the rule applies. Object Storage limits this token to 1 per `Filter` Rule.
106110

107111
**Parent**
108112
: `Filter` or `And`
109113

110114
### Tag
115+
111116
**Description**
112117
: Container for specifying a `Key` and a `Value`.
113118

@@ -125,14 +130,16 @@ This applies the `Prefix` rule *and* the `Tag`.
125130
**Values**
126131
: `Enabled`, `Disabled`
127132

128-
### Transition
133+
### Transition
134+
129135
**Description**
130136
: Specifies a period and a destination for an object's lifetime
131137

132138
**Parent**
133139
: `Rule`
134140

135-
### Days
141+
### Day
142+
136143
**Description**
137144
: Specifies the number of days after object creation when the rule takes effect.
138145

@@ -147,6 +154,7 @@ This applies the `Prefix` rule *and* the `Tag`.
147154
: `Transition`
148155

149156
### Expiration
157+
150158
**Description**
151159
: Describes the expiration of the object lifetime. If versioning is enabled, this rule only deletes the current version of an object.
152160

@@ -249,5 +257,3 @@ Send a [putbucketlifecycleconfiguration](/storage/object/api-cli/bucket-operatio
249257
```bash
250258
aws s3api put-bucket-lifecycle-configuration --bucket my-bucket --lifecycle-configuration file://incomplete-upload-lifecycle-policy.json
251259
```
252-
253-

storage/object/api-cli/multipart-uploads.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Manage large object uploads efficiently with multipart uploads in Scaleway.
88
tags: object storage object-storage multipart multipart-upload
99
dates:
10-
validation: 2024-06-17
10+
validation: 2024-12-24
1111
posted: 2019-04-19
1212
categories:
1313
- storage
@@ -70,6 +70,7 @@ Date: Fri, 17 May 2019 12:54:17 GMT
7070
<UploadId>Y2VhZDUxYjAtNjVjMC00NTIxLWEwNWUtNWM3NDAyOTQ4ZWYz</UploadId>
7171
</InitiateMultipartUploadResult>'
7272
```
73+
7374
## Uploading a part
7475

7576
Once the multipart upload is initiated, Object Storage keeps all parts of the upload until it is completed or aborted.
@@ -78,6 +79,10 @@ When uploading a part, a part number must be specified in addition to the upload
7879
During the lifecycle of a multipart upload, billing will occur for all storage and bandwidth usage for its associated parts.
7980
If a multipart upload is aborted, all parts already uploaded are deleted and billing for these resources stops.
8081

82+
<Message type="important">
83+
Incomplete multipart uploads that have not been aborted are still subject to billing. For more information on how to view and abort incomplete MPUs, refer to the [dedicated documentation](/storage/object/how-to/abort-incomplete-mpu/).
84+
</Message>
85+
8186
To upload a part of an object in an initiated multipart upload, send a POST request as follows:
8287

8388
```
@@ -177,6 +182,7 @@ To get a list of in-progress multipart uploads, send a `GET` request to the URI
177182
```
178183

179184
**Sample request**
185+
180186
```
181187
GET /?uploads&max-uploads=2 HTTP/1.1
182188
Host: bucketname.s3.nl-ams.scw.cloud
@@ -185,14 +191,14 @@ Authorization: authorization string
185191
```
186192

187193
**Sample response**
194+
188195
```xml
189196
x-amz-id-2: txa0875396ef3e47e9ac144-005f50efc4
190197
Content-Length: 1609
191198
x-amz-request-id: txa0875396ef3e47e9ac144-005f50efc4
192199
Content-Type: application/xml
193200
Date: Thu, 03 Sep 2020 13:29:40 GMT
194201

195-
196202
<?xml version='1.0' encoding='UTF-8'?>
197203
<ListMultipartUploadsResult
198204
xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
@@ -275,7 +281,7 @@ If the multipart upload is not completed, the parts will not be assembled and no
275281
In case these parts are no longer needed, it is possible to clear them by aborting the multipart upload session.
276282

277283
<Message type="note">
278-
You can also abort incomplete multipart uploads manually using the [Scaleway console](https://console.scaleway.com/), or automatically using [lifecycle rules](/storage/object/how-to/manage-lifecycle-rules).
284+
You can also [abort incomplete multipart uploads manually](/storage/object/how-to/abort-incomplete-mpu/) using the Scaleway console, or automatically using [lifecycle rules](/storage/object/how-to/manage-lifecycle-rules).
279285
</Message>
280286

281287
To abort an active multipart upload session, send a `DELETE` request to the platform, as follows:

storage/object/api-cli/setting-cors-rules.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Set CORS rules to manage cross-origin requests in Scaleway Object Storage.
88
tags: object storage object-storage aws-s3 bucket cors cors-rule
99
dates:
10-
validation: 2024-06-17
10+
validation: 2024-12-24
1111
posted: 2021-05-19
1212
categories:
1313
- storage
@@ -16,17 +16,19 @@ categories:
1616

1717
The [CORS standard](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) describes new HTTP headers that provide browsers a way to request remote URLs only when they have permission. Although some validation and authorization can be performed by the server, it is generally the browser's responsibility to support these headers and honor the restrictions they impose.
1818

19-
Before CORS became standardized, it was not possible to call an API endpoint or other content under different domains for security reasons. This was (and to some degree still is) blocked by the Same-Origin Policy introduced with Netscape Navigator 2.0 in 1995.
20-
21-
An example of a cross-origin request: The frontend JavaScript code for a web application served from `http://webapplication.com` uses `XMLHttpRequest` to make a request for `http://customerapi.io/data.json`. Another example might be JavaScript that calls files in an Object Storage bucket, like web fonts, downloads, etc. It is possible to configure CORS for each bucket with the [AWS CLI](/storage/object/api-cli/object-storage-aws-cli/).
22-
2319
<Macro id="requirements" />
2420

2521
- A Scaleway account logged into the [console](https://console.scaleway.com)
2622
- [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
2723
- Installed the [AWS CLI](/storage/object/api-cli/object-storage-aws-cli/)
2824
- An [Object Storage bucket](/storage/object/how-to/create-a-bucket/)
2925

26+
## CORS overview
27+
28+
Before CORS became standardized, it was not possible to call an API endpoint or other content under different domains for security reasons. This was (and to some degree still is) blocked by the Same-Origin Policy introduced with Netscape Navigator 2.0 in 1995.
29+
30+
An example of a cross-origin request: The frontend JavaScript code for a web application served from `http://webapplication.com` uses `XMLHttpRequest` to make a request for `http://customerapi.io/data.json`. Another example might be JavaScript that calls files in an Object Storage bucket, like web fonts, downloads, etc. It is possible to configure CORS for each bucket with the [AWS CLI](/storage/object/api-cli/object-storage-aws-cli/).
31+
3032
## Setting CORS on an Object Storage bucket
3133

3234
1. Enter the **Object Storage** section in the left menu of the console.
@@ -90,10 +92,11 @@ If CORS rules are set for the bucket, the API returns a JSON list like this exam
9092
}
9193
```
9294

93-
If there are no CORS rules set for the bucket, an error message appears:
95+
If there are no CORS rules set for the bucket, an error message displays:
9496
```
9597
An error occurred (NoSuchCORSConfiguration) when calling the GetBucketCors operation: The CORS configuration does not exist
9698
```
99+
97100
## Verifying the CORS configuration of a bucket
98101

99102
To verify the CORS rules of a bucket, use `curl` with the desired methods (`GET`, `POST`, etc.), for example:

storage/object/quickstart.mdx

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Quickly get started with Scaleway Object Storage.
88
tags: object-storage object storage bucket archived
99
dates:
10-
validation: 2024-06-17
10+
validation: 2024-12-24
1111
posted: 2021-05-26
1212
categories:
1313
- storage
@@ -21,10 +21,6 @@ categories:
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-
<Message type="tip">
25-
As an alternative or complement to this documentation page, check out our video: [What is Object Storage? Quickstart guide with use cases](/storage/object/videos/).
26-
</Message>
27-
2824
## How to create a bucket
2925

3026
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.
@@ -73,11 +69,8 @@ A list of the bucket's objects displays including the newly uploaded objects.
7369

7470
## How to download files from a bucket
7571

76-
1. Click the name of your selected bucket in the buckets list. A list of your objects displays.
77-
2. Run your cursor over the name of the object you wish to download. The <Icon name="download" /> icon appears.
78-
3. Click the icon to begin the download of the object into your local file system.
79-
80-
Alternatively, you can click the <Icon name="more" /> icon for your selected object and click **Download**.
72+
1. Click the name of the bucket in the buckets list. A list of your objects displays.
73+
2. Click the <Icon name="download" /> icon next to the object you want to download.
8174

8275
## How to delete a bucket
8376

@@ -86,13 +79,7 @@ When you delete a bucket, every object stored inside it is deleted with it.
8679
1. Click **Object Storage** in the **Storage** section of the side menu. The list of your buckets displays.
8780
2. Click the name of your selected bucket in the buckets list.
8881
3. Click the **Bucket settings** tab.
89-
4. Scroll to the end of the page and click **Delete bucket**.
90-
91-
A pop-up appears warning that:
92-
93-
<Message type="important">
94-
Every object stored inside this bucket will be lost, and another customer will be allowed to reuse the name of this bucket. The deletion of your bucket will be triggered today at 11.59 pm UTC.
95-
</Message>
82+
4. Scroll to the end of the page and click **Delete bucket**. A pop-up appears.
9683
5. If you understand and agree to the conditions, type **DELETE** in the box and click **Delete bucket**.
9784

9885
Alternatively, you can delete a bucket by clicking the <Icon name="more" /> icon and then **Delete** in your bucket list.
@@ -101,4 +88,4 @@ Once the bucket is deleted, it disappears from your bucket list.
10188

10289
<Message type="note">
10390
For operational reasons, you have to wait 24 hours before creating a bucket with the same name as the one you have just deleted.
104-
</Message>
91+
</Message>

storage/object/videos.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@ categories:
1414
- object-storage
1515
---
1616

17-
## What is Object Storage? Quickstart tutorial with use cases
17+
<Message type="important">
18+
This video presents Scaleway Object Storage as of December, 2021, and does not reflect the current state of this product. Refer to the [Quickstart](/storage/object/quickstart/) page to discover Scaleway Object Storage.
19+
</Message>
1820

21+
## What is Object Storage? Quickstart tutorial with use cases
1922

2023
Object Storage allows you to store different types of objects (documents, images, videos, etc) and distribute them instantly, anywhere in the world. We explain some core Object Storage concepts, take you step by step through the creation of an Object Storage bucket in the cloud, and tell you about some common use cases. You'll learn how to store and share files, how to host a static website from a bucket, and more.
2124

0 commit comments

Comments
 (0)