Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(gen): documentation review MTA-5394 #4146

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions serverless/jobs/how-to/delete-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn to delete jobs effectively on Scaleway Serverless platform.
tags: delete serverless job scaleway
dates:
validation: 2024-06-17
validation: 2024-12-24
posted: 2021-11-14
categories:
- serverless
Expand All @@ -33,5 +33,3 @@ This page shows you how to delete a Serverless Job.
<Message type="tip">
You can also delete a job from its **Settings** tab.
</Message>


8 changes: 5 additions & 3 deletions serverless/jobs/how-to/monitor-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ content:
paragraph: Monitor job execution and performance on Scaleway Serverless.
tags: serverless jobs logs metrics cockpit grafana activity
dates:
validation: 2024-06-17
validation: 2024-12-24
posted: 2023-11-20
categories:
- serverless
- jobs
---

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.
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.

<Macro id="requirements" />

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

- Click **Metrics** to access the Grafana metrics overview page for this job run.
- Click **Logs** to access the Grafana logs page for this job run.
- Click **Logs** to access the Grafana logs page for this job run.

You are directed to the selected Grafana dashboard.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn to troubleshoot connection timeout issues in Scaleway serverless SQL databases.
tags: database serverless-sql-database timeout connection troubleshooting error
dates:
validation: 2024-06-17
validation: 2024-12-24
posted: 2023-11-27
categories:
- serverless
Expand Down
17 changes: 10 additions & 7 deletions storage/object/api-cli/bucket-policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Implement and manage bucket policies in Scaleway Object Storage.
tags: object-storage bucket bucket-policy s3
dates:
validation: 2024-06-17
validation: 2024-12-24
posted: 2021-02-17
categories:
- storage
Expand All @@ -18,11 +18,11 @@ categories:

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

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.
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.

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

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.
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.

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

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

## Bucket policies description

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`.
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`.

### Version

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

**Description**
: Provides a way to include information about an individual statement.
: Statement ID. Provides a way to include information about an individual statement.

**Required**
: No
Expand Down Expand Up @@ -274,7 +274,7 @@ Bucket policies use a JSON-based access policy language and are composed of stri
### Principal

**Description**
: 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".
: 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".

**Required**
: Yes
Expand Down Expand Up @@ -517,6 +517,7 @@ Bucket policies use a JSON-based access policy language and are composed of stri
]
}
```

### Condition

**Description**
Expand Down Expand Up @@ -605,7 +606,9 @@ Bucket policies use a JSON-based access policy language and are composed of stri
]
}
```

#### Supported conditions

- `IpAddress`
- `NotIpAddress`
- `StringEquals`
Expand Down
20 changes: 13 additions & 7 deletions storage/object/api-cli/lifecycle-rules-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Use the API to manage lifecycle rules in Scaleway Object Storage.
tags: object storage object-storage lifecycle
dates:
validation: 2024-06-17
validation: 2024-12-24
posted: 2019-05-14
categories:
- storage
Expand All @@ -19,7 +19,7 @@ categories:
- [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
- An [Object Storage bucket](/storage/object/how-to/create-a-bucket/)

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.
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.

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

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.
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.

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).

Expand Down Expand Up @@ -68,20 +68,23 @@ Each `Rule` consists of the following:
## Available XML tokens

### Rule

**Description**
: Container for a lifecycle rule. There is a limit of one thousand (1000) rules per bucket.

**Parent**
: `LifecycleConfiguration`

### Filter

**Description**
: 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.

**Parent**
: `Rule`

### And

**Description**
: Container for chaining rule filters.

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

### Prefix

**Description**
: Object key prefix identifying one or more objects to which the rule applies. Object Storage limits this token to 1 per `Filter` Rule.

**Parent**
: `Filter` or `And`

### Tag

**Description**
: Container for specifying a `Key` and a `Value`.

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

### Transition
### Transition

**Description**
: Specifies a period and a destination for an object's lifetime

**Parent**
: `Rule`

### Days
### Day

**Description**
: Specifies the number of days after object creation when the rule takes effect.

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

### Expiration

**Description**
: Describes the expiration of the object lifetime. If versioning is enabled, this rule only deletes the current version of an object.

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


12 changes: 9 additions & 3 deletions storage/object/api-cli/multipart-uploads.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Manage large object uploads efficiently with multipart uploads in Scaleway.
tags: object storage object-storage multipart multipart-upload
dates:
validation: 2024-06-17
validation: 2024-12-24
posted: 2019-04-19
categories:
- storage
Expand Down Expand Up @@ -70,6 +70,7 @@ Date: Fri, 17 May 2019 12:54:17 GMT
<UploadId>Y2VhZDUxYjAtNjVjMC00NTIxLWEwNWUtNWM3NDAyOTQ4ZWYz</UploadId>
</InitiateMultipartUploadResult>'
```

## Uploading a part

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

<Message type="important">
Incomplete multipart uploads that have not been aborted are still subject to billing. For more information on how to view and abort incomplete MPUs, refere to the [dedicated documentation](/storage/object/how-to/abort-incomplete-mpu/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Incomplete multipart uploads that have not been aborted are still subject to billing. For more information on how to view and abort incomplete MPUs, refere to the [dedicated documentation](/storage/object/how-to/abort-incomplete-mpu/).
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/).

</Message>

To upload a part of an object in an initiated multipart upload, send a POST request as follows:

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

**Sample request**

```
GET /?uploads&max-uploads=2 HTTP/1.1
Host: bucketname.s3.nl-ams.scw.cloud
Expand All @@ -185,14 +191,14 @@ Authorization: authorization string
```

**Sample response**

```xml
x-amz-id-2: txa0875396ef3e47e9ac144-005f50efc4
Content-Length: 1609
x-amz-request-id: txa0875396ef3e47e9ac144-005f50efc4
Content-Type: application/xml
Date: Thu, 03 Sep 2020 13:29:40 GMT


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

<Message type="note">
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).
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).
</Message>

To abort an active multipart upload session, send a `DELETE` request to the platform, as follows:
Expand Down
15 changes: 9 additions & 6 deletions storage/object/api-cli/setting-cors-rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Set CORS rules to manage cross-origin requests in Scaleway Object Storage.
tags: object storage object-storage aws-s3 bucket cors cors-rule
dates:
validation: 2024-06-17
validation: 2024-12-24
posted: 2021-05-19
categories:
- storage
Expand All @@ -16,17 +16,19 @@ categories:

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.

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.

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/).

<Macro id="requirements" />

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

## CORS overview

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.

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/).

## Setting CORS on an Object Storage bucket

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

If there are no CORS rules set for the bucket, an error message appears:
If there are no CORS rules set for the bucket, an error message displays:
```
An error occurred (NoSuchCORSConfiguration) when calling the GetBucketCors operation: The CORS configuration does not exist
```

## Verifying the CORS configuration of a bucket

To verify the CORS rules of a bucket, use `curl` with the desired methods (`GET`, `POST`, etc.), for example:
Expand Down
23 changes: 5 additions & 18 deletions storage/object/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Quickly get started with Scaleway Object Storage.
tags: object-storage object storage bucket archived
dates:
validation: 2024-06-17
validation: 2024-12-24
posted: 2021-05-26
categories:
- storage
Expand All @@ -21,10 +21,6 @@ categories:
- A Scaleway account logged into the [console](https://console.scaleway.com)
- [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

<Message type="tip">
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/).
</Message>

## How to create a bucket

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

## How to download files from a bucket

1. Click the name of your selected bucket in the buckets list. A list of your objects displays.
2. Run your cursor over the name of the object you wish to download. The <Icon name="download" /> icon appears.
3. Click the icon to begin the download of the object into your local file system.

Alternatively, you can click the <Icon name="more" /> icon for your selected object and click **Download**.
1. Click the name of the bucket in the buckets list. A list of your objects displays.
2.Click the <Icon name="download" /> icon next to the object you want to download.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2.Click the <Icon name="download" /> icon next to the object you want to download.
2. Click the <Icon name="download" /> icon next to the object you want to download.


## How to delete a bucket

Expand All @@ -86,13 +79,7 @@ When you delete a bucket, every object stored inside it is deleted with it.
1. Click **Object Storage** in the **Storage** section of the side menu. The list of your buckets displays.
2. Click the name of your selected bucket in the buckets list.
3. Click the **Bucket settings** tab.
4. Scroll to the end of the page and click **Delete bucket**.

A pop-up appears warning that:

<Message type="important">
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.
</Message>
4. Scroll to the end of the page and click **Delete bucket**. A pop-up appears.
5. If you understand and agree to the conditions, type **DELETE** in the box and click **Delete bucket**.

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

<Message type="note">
For operational reasons, you have to wait 24 hours before creating a bucket with the same name as the one you have just deleted.
</Message>
</Message>
5 changes: 4 additions & 1 deletion storage/object/videos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,11 @@ categories:
- object-storage
---

## What is Object Storage? Quickstart tutorial with use cases
<Message type="important">
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.
</Message>

## What is Object Storage? Quickstart tutorial with use cases

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.

Expand Down
Loading