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): docs review MTA-5778 #4684

Merged
merged 3 commits into from
Mar 24, 2025
Merged
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
179 changes: 89 additions & 90 deletions pages/object-storage/api-cli/installing-rclone.mdx
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ content:
paragraph: Install and configure rclone for Scaleway Object Storage integration.
tags: object storage rclone command-line command archived
dates:
validation: 2024-08-05
validation: 2025-03-24
posted: 2021-08-25
categories:
- storage
@@ -66,48 +66,36 @@ For example, on Linux:
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
1 / 1Fichier
\ "fichier"
2 / Alias for an existing remote
\ "alias"
3 / Amazon Drive
\ "amazon cloud drive"
4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc)
\ "s3"
\ (fichier)
2 / Akamai NetStorage
\ (netstorage)
3 / Alias for an existing remote
\ (alias)
4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)

[...]
Storage>
```
3. Type `s3` and hit enter to confirm this storage type. The following output displays:
```
Choose your Amazon S3 provider.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
Choose a number from below, or type in your own value.
Press Enter to leave empty.
1 / Amazon Web Services (AWS) S3
\ "AWS"
\ (AWS)
2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun
\ "Alibaba"
3 / Ceph Object Storage
\ "Ceph"
4 / Digital Ocean Spaces
\ "DigitalOcean"
5 / Dreamhost DreamObjects
\ "Dreamhost"
6 / IBM COS S3
\ "IBMCOS"
7 / Minio Object Storage
\ "Minio"
8 / Netease Object Storage (NOS)
\ "Netease"
9 / Scaleway Object Storage
\ "Scaleway"
10 / StackPath Object Storage
\ "StackPath"
11 / Tencent Cloud Object Storage (COS)
\ "TencentCOS"
12 / Wasabi Object Storage
\ "Wasabi"
13 / Any other Amazon S3 compatible provider
\ "Other"
\ (Alibaba)
3 / Arvan Cloud Object Storage (AOS)
\ (ArvanCloud)
4 / Ceph Object Storage
\ (Ceph)

[...]
24 / Scaleway Object Storage
\ (Scaleway)

[...]
```
4. Type `Scaleway` and hit enter to confirm this Amazon S3 provider. The following output displays:
```
@@ -138,68 +126,81 @@ For example, on Linux:
7. Enter your API secret key and hit enter. The following output displays:
```
Region to connect to.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
Choose a number from below, or type in your own value.
Press Enter to leave empty.
1 / Amsterdam, The Netherlands
\ "nl-ams"
\ (nl-ams)
2 / Paris, France
\ "fr-par"
region>
\ (fr-par)
3 / Warsaw, Poland
\ (pl-waw)
```
8. Enter your chosen region and hit enter. Here we choose `fr-par`. The following output displays:
```
Endpoint for Scaleway Object Storage.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
Choose a number from below, or type in your own value.
Press Enter to leave empty.
1 / Amsterdam Endpoint
\ "s3.nl-ams.scw.cloud"
\ (s3.nl-ams.scw.cloud)
2 / Paris Endpoint
\ "s3.fr-par.scw.cloud"
endpoint>
\ (s3.fr-par.scw.cloud)
3 / Warsaw Endpoint
\ (s3.pl-waw.scw.cloud)
```
9. Enter your chosen endpoint and hit enter. Here we choose `s3.fr-par.scw.cloud`. The following output displays:
```
Option acl.
Canned ACL used when creating buckets and storing or copying objects.

This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too.

For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl

Note that this ACL is applied when server side copying objects as S3
Note that this ACL is applied when server-side copying objects as S3
doesn't copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
1 / Owner gets FULL_CONTROL. No one else has access rights (default).
\ "private"
2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.
\ "public-read"
/ Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
3 | Granting this on a bucket is generally not recommended.
\ "public-read-write"
4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
\ "authenticated-read"
/ Object owner gets FULL_CONTROL. Bucket owner gets READ access.
5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
\ "bucket-owner-read"
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
/ Owner gets FULL_CONTROL.
1 | No one else has access rights (default).
\ (private)
/ Owner gets FULL_CONTROL.
2 | The AllUsers group gets READ access.
\ (public-read)
/ Owner gets FULL_CONTROL.
3 | The AllUsers group gets READ and WRITE access.
| Granting this on a bucket is generally not recommended.
\ (public-read-write)
/ Owner gets FULL_CONTROL.
4 | The AuthenticatedUsers group gets READ access.
\ (authenticated-read)
/ Object owner gets FULL_CONTROL.
5 | Bucket owner gets READ access.
| If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
\ (bucket-owner-read)
/ Both the object owner and the bucket owner get FULL_CONTROL over the object.
6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
\ "bucket-owner-full-control"
acl>
\ (bucket-owner-full-control)
acl>
```
10. Enter your chosen ACL and hit enter. Here we choose `private` (`1`). The following output displays:
```
Option storage_class.
The storage class to use when storing new objects in S3.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
1 / Default
\ ""
2 / The Standard class for any upload; suitable for on-demand content like streaming or CDN.
\ "STANDARD"
3 / Archived storage; prices are lower, but it needs to be restored first to be accessed.
\ "GLACIER"
storage_class>
4 / One Zone Infrequent Access storage class
\ "ONEZONE_IA"
Choose a number from below, or type in your own value.
Press Enter to leave empty.
1 / Default.
\ ()
/ The Standard class for any upload.
2 | Suitable for on-demand content like streaming or CDN.
| Available in all regions.
\ (STANDARD)
/ Archived storage.
3 | Prices are lower, but it needs to be restored first to be accessed.
| Available in FR-PAR and NL-AMS regions.
\ (GLACIER)
/ One Zone - Infrequent Access.
4 | A good choice for storing secondary backup copies or easily re-creatable data.
| Available in the FR-PAR region only.
\ (ONEZONE_IA)
```
11. Enter your chosen storage class and hit enter. Here we choose `STANDARD` (`2`). The following output displays:
```
@@ -210,23 +211,21 @@ For example, on Linux:
```
12. Type `n` and hit enter. A summary of your config displays:
```
Remote config
--------------------
[remote-sw-paris]
type = s3
provider = Scaleway
env_auth = false
access_key_id = <ACCESS-KEY>
secret_access_key = <SECRET-KEY>
region = fr-par
endpoint = s3.fr-par.scw.cloud
acl = private
storage_class = STANDARD
--------------------
Configuration complete.
Options:
- type: s3
- provider: Scaleway
- access_key_id: <ACCESS-KEY>
- secret_access_key: <SECRET-KEY>
- region: fr-par
- endpoint: s3.fr-par.scw.cloud
- acl: private
- storage_class: STANDARD
Keep this "remote-scw-paris" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d>
y/e/d>
```
13. Type `y` to confirm that this remote config is OK, and hit enter.

@@ -236,7 +235,7 @@ For example, on Linux:

Name Type
==== ====
tuto s3
remote-scw-paris s3

e) Edit existing remote
n) New remote
8 changes: 4 additions & 4 deletions pages/object-storage/how-to/abort-incomplete-mpu.mdx
Original file line number Diff line number Diff line change
@@ -7,17 +7,17 @@ content:
paragraph: Steps to view and abort incomplete multipart uploads from the Scaleway console.
tags: object storage object-storage mpu multipart upload abort
dates:
validation: 2024-09-13
validation: 2025-03-24
posted: 2024-09-13
categories:
- storage
- object-storage
---

The [Scaleway console](https://console.scaleway.com/) lists your Object Storage incomplete multipart uploads to allow you to consult them and manually abort them to clear storage space and optimize your storage costs.
The [Scaleway console](https://console.scaleway.com/) lists your Object Storage incomplete multipart uploads to allow you to consult them, and manually abort them to clear storage space and optimize your storage costs.

<Message type="note">
Incomplete multipart uploads are charged even though they are not finished as they use storage space.
Incomplete multipart uploads are charged even though they are not finished, as they use storage space.
</Message>

You can automate the process of aborting incomplete multipart uploads using [lifecycle rules](/object-storage/how-to/manage-lifecycle-rules).
@@ -53,7 +53,7 @@ Refer to the [dedicated documentation](/object-storage/api-cli/multipart-uploads
3. Click the **Incomplete MPU** tab. A list of your incomplete multipart uploads displays.
4. Click <Icon name="more" /> next to the object you want to abort.
5. Click **Abort**. A confirmation pop-up displays.
6. Type **ABORT** then click **Abort multipart upload** to confirm your action.
6. Type **ABORT**, then click **Abort multipart upload** to confirm your action.

<Message type="note">
This action will permanently delete the upload, and all the parts uploaded so far. You can also abort an incomplete multipart upload from its [information page](#how-to-view-the-information-of-an-incomplete-multipart-upload).
4 changes: 2 additions & 2 deletions pages/object-storage/how-to/manage-lifecycle-rules.mdx
Original file line number Diff line number Diff line change
@@ -5,9 +5,9 @@ meta:
content:
h1: How to manage lifecycle rules from the console
paragraph: Set and manage lifecycle rules for Object Storage.
tags: object storage object-storage lifecycle lifecycle-rule abort incompelte multipart upload expire version
tags: object storage object-storage lifecycle lifecycle-rule abort incomplete multipart upload expire version
dates:
validation: 2024-09-13
validation: 2025-03-24
posted: 2021-05-27
categories:
- storage
Original file line number Diff line number Diff line change
@@ -7,15 +7,15 @@ content:
paragraph: Deploy containers using the Scaleway CLI.
tags: containers cli deploy
dates:
validation: 2024-08-28
validation: 2025-03-24
posted: 2021-08-18
categories:
- serverless
---

## Scaleway Command Line Interface Overview

[The Scaleway Command Line Interface (CLI)](https://github.com/scaleway/scaleway-cli) allows you to pilot your Scaleway infrastructure directly from your terminal, providing a faster way to administer and monitor your resources. Scaleway CLI is easy to set up and use, and an essential tool for operating efficiently in your cloud environment. The CLI provides many functionalities, including the ability to create and deploy Serverless Containers.
[The Scaleway Command Line Interface (CLI)](https://github.com/scaleway/scaleway-cli) allows you to pilot your Scaleway infrastructure directly from your terminal, providing a faster way to administer and monitor your resources. The Scaleway CLI is easy to set up and use, and an essential tool for operating efficiently in your cloud environment. The CLI provides many functionalities, including the ability to create and deploy Serverless Containers.

<Macro id="requirements" />

Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ content:
paragraph: Step-by-step guide to connect to a Scaleway Serverless SQL Database.
tags: database serverless-sql-database serverless-db serverless-database postgresql
dates:
validation: 2024-08-28
validation: 2025-03-25
posted: 2023-08-11
categories:
- serverless
@@ -24,7 +24,7 @@ To connect to a Serverless SQL Database, you can either use a **connection strin
postgres://[user-or-application-id]:[api-secret-key]@[database-hostname]:5432/[database-name]?sslmode=require
```
<Message type="note">
The `?sslmode=require` is mandatory to connect to your database. Refer to the [dedicated documentation](/serverless-sql-databases/api-cli/secure-connection-ssl-tls/) for more information about SSL connection to Serverless SQL Databases.
The `?sslmode=require` parameter is mandatory to connect to your database. Refer to the [dedicated documentation](/serverless-sql-databases/api-cli/secure-connection-ssl-tls/) for more information about SSL connection to Serverless SQL Databases.
</Message>

- Connection parameters provide the necessary information and parameters to connect an [IAM user](/iam/concepts/#user) or [application](/iam/concepts/#application) to a database. The parameters are expressed in the `KEY="value"` format, as follows: