Skip to content

Commit 5bac19a

Browse files
committed
docs(S3): update mentions of S3 in documentation MTA-5188
1 parent d06381b commit 5bac19a

File tree

69 files changed

+179
-179
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+179
-179
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Migration to the new S3 backend (HIVE) for all regions
2+
title: Migration to the new Object Storage backend (HIVE) for all regions
33
status: changed
44
author:
55
fullname: 'Join the #container-registry channel on Slack.'
@@ -9,4 +9,4 @@ category: containers
99
product: container-registry
1010
---
1111

12-
All regions were migrated to the new S3 backend (HIVE) and are now using its highly redundant #MultiAZ infrastructure in `FR-PAR`. As a result, almost all recent issues regarding the registry are resolved.
12+
All regions were migrated to the new Object Storage backend (HIVE) and are now using its highly redundant #MultiAZ infrastructure in `FR-PAR`. As a result, almost all recent issues regarding the registry are resolved.

components/docs-editor.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ At top of `.mdx` file, you MUST add data in frontmatter:
259259

260260
```
261261
---
262-
title: Migration to the new S3 backend (HIVE) for all regions
262+
title: Migration to the new Object Storage backend (HIVE) for all regions
263263
status: changed
264264
author:
265265
fullname: 'Join the #container-registry channel on Slack.'

compute/instances/api-cli/snapshot-import-export-feature.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ More information on the QCOW2 file format, and how to use it can be found in the
3535

3636
1. Create a Scaleway Object Storage bucket.
3737

38-
You need an S3 bucket to export your QCOW2 file into. Any bucket that belongs to the same project as the snapshot can be used. However, if you do not have one already, you can [create it](/storage/object/how-to/create-a-bucket/) in the console.
38+
You need an Object Storage bucket to export your QCOW2 file into. Any bucket that belongs to the same project as the snapshot can be used. However, if you do not have one already, you can [create it](/storage/object/how-to/create-a-bucket/) in the console.
3939
2. Create a snapshot from a volume.
4040

4141
To use this functionality, you must [create a snapshot](/compute/instances/how-to/create-a-snapshot/#how-to-create-a-snapshot) from the volume you want to export.
@@ -53,7 +53,7 @@ More information on the QCOW2 file format, and how to use it can be found in the
5353
- The secret key of your API key pair (`<secret_key>`)
5454
- The snapshot ID (`<snapshot_uuid>`)
5555
- The name of the Object Storage bucket to store the snapshot (which has to exist in the same Scaleway region as the snapshot)
56-
- A key (can be any acceptable key/object name for Scaleway S3 (suffixing qcow2 images with `.qcow2`))
56+
- A key (can be any acceptable key/object name for Scaleway Object Storage (suffixing qcow2 images with `.qcow2`))
5757

5858
The API returns an output as in the following example:
5959
```json

compute/instances/troubleshooting/bootscript-eol.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,10 @@ If your Instance is using the bootscript option to boot in normal mode you are i
9090
</TabsTab>
9191
<TabsTab label="Option 2">
9292

93-
#### Create a snapshot of the volume(s) and export it to S3 to retrieve the data
93+
#### Create a snapshot of the volume(s) and export it to Object Storage to retrieve the data
9494

9595
1. [Create a snapshot](/compute/instances/how-to/create-a-snapshot/) of the volume using the **l_ssd** type of snapshot.
96-
2. [Export](/compute/instances/how-to/snapshot-import-export-feature/) the snapshot to an S3 bucket in the same region as the Instance.
96+
2. [Export](/compute/instances/how-to/snapshot-import-export-feature/) the snapshot to an Object Storage bucket in the same region as the Instance.
9797
3. Retrieve your data from the Object Storage bucket and reuse it at your convenience.
9898
4. Delete the old Instance that was using a bootscript once you have recovered your data.
9999

containers/kubernetes/how-to/edit-kosmos-cluster.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ In order to add external nodes to your multi-cloud cluster, you must first [crea
111111
The Kubernetes version of the existing nodes in your multi-cloud pool can be upgraded in place. Your workload will theoretically keep running during the upgrade, but it is best to drain the node before the upgrade.
112112

113113
1. In the Pools section of your Kosmos cluster, click **Upgrade** next to the node pool. This will not cause any of your existing nodes to upgrade, but will instead ensure that any new nodes added to the pool will start up with the newer version.
114-
2. Run the installer program as you would do for a fresh node install, with the additional option `-self-update`. If the option is not available, redownload the program from S3 bucket.
114+
2. Run the installer program as you would do for a fresh node install, with the additional option `-self-update`. If the option is not available, redownload the program from the Object Storage bucket.
115115
3. Now the node will register itself with the Apiserver. Once it is ready, you will see the same node with two kubelet versions. The older node should end up `NotReady` after 5m, you can safely delete it with `kubectl`.
116116
4. Detach the older node in Scaleway API.
117117

faq/objectstorage.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
meta:
33
title: Object Storage FAQ
4-
description: Discover S3 Object Storage.
4+
description: Discover Scaleway Object Storage.
55
content:
66
h1: Object Storage
77
hero: assets/objectstorage.webp
@@ -13,14 +13,14 @@ category: storage
1313

1414
## What is Object Storage?
1515

16-
Object Storage is a service based on the S3 protocol. It allows you to store any kind of object (documents, images, videos, etc.).
16+
Object Storage is a service based on the Amazon S3 protocol. It allows you to store any kind of object (documents, images, videos, etc.).
1717

1818
Scaleway provides an integrated UI in the [console](https://console.scaleway.com) for convenience. As browsing infinite storage through the web requires some technical trade-offs, some actions are limited in the console for Object Storage:
1919

2020
- batch deletion is limited to 1000 objects.
2121
- empty files are not reported as empty folders.
2222

23-
We provide an S3-compatible API for programmatic access or usage with any compatible software. Therefore, we recommend using dedicated tools such as `s3cmd` to manage large data sets.
23+
We provide an Amazon Amazon S3-compatible API for programmatic access or usage with any compatible software. Therefore, we recommend using dedicated tools such as `s3cmd` to manage large data sets.
2424

2525
## How am I billed for Object Storage?
2626

@@ -283,4 +283,4 @@ Large objects can be uploaded using [multipart uploads](/storage/object/api-cli/
283283

284284
Yes, a best practice is to create a [lifecycle rule](/storage/object/how-to/manage-lifecycle-rules/) targeting all objects in the bucket, or using a filter with an empty prefix.
285285
In this case, all files contained within the selected bucket will have their storage class altered automatically on the dates stipulated by you.
286-
However, due to S3 Protocol restrictions, a lifecycle rule cannot be created to modify the storage class from Glacier to Standard.
286+
However, due to some restrictions on Amazon's S3 protocol, a lifecycle rule cannot be created to modify the storage class from Glacier to Standard.

identity-and-access-management/iam/api-cli/using-api-key-object-storage.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ meta:
55
content:
66
h1: Using IAM API keys with Object Storage
77
paragraph: This page explains how to use IAM API keys with Object Storage
8-
tags: API key Projects IAM API-key Preferred-project Object-Storage S3
8+
tags: API key Projects IAM API-key Preferred-project Object-Storage Amazon-S3
99
dates:
1010
validation: 2024-05-27
1111
posted: 2022-11-02
@@ -15,7 +15,7 @@ categories:
1515

1616
You can carry out actions on Scaleway Object Storage resources either via the [Scaleway console](https://console.scaleway.com/), or via a third-party API or CLI, such as [the AWS CLI](/storage/object/api-cli/object-storage-aws-cli/), [MinIOClient](/storage/object/api-cli/installing-minio-client/) or [Rclone](/storage/object/api-cli/installing-rclone/).
1717

18-
While the Scaleway console gives you the option to specify the [Scaleway Project](#what-is-a-project) to carry out your Object Storage actions in, this option is not available via third-party API/CLI tools. These tools are based on a [standard S3 programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services), which does not accept Project ID as a parameter. Therefore, when you create a Scaleway API key with IAM, you are prompted to specify the API key's **preferred Project for Object Storage**. This API key will always use this Project when carrying out Object Storage actions via any API/CLI.
18+
While the Scaleway console gives you the option to specify the [Scaleway Project](#what-is-a-project) to carry out your Object Storage actions in, this option is not available via third-party API/CLI tools. These tools are based on a [standard Amazon S3 programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services), which does not accept Project ID as a parameter. Therefore, when you create a Scaleway API key with IAM, you are prompted to specify the API key's **preferred Project for Object Storage**. This API key will always use this Project when carrying out Object Storage actions via any API/CLI.
1919
<Lightbox src="scaleway-preferred-project.webp" alt="" />
2020

2121
In this document, we explain the concept of preferred Projects for Object Storage, explain how to configure your IAM API key for this, and give some code examples for overriding the preferred Project when making an API call.
@@ -35,13 +35,13 @@ When you generate an API key with IAM, the key is associated with a specific [IA
3535

3636
## The impact of preferred Projects
3737

38-
When you perform an action on Scaleway Object Storage resources using a third-party API or CLI, such as [the AWS CLI](/storage/object/api-cli/object-storage-aws-cli/), [MinIOClient](/storage/object/api-cli/installing-minio-client/) or [Rclone](/storage/object/api-cli/installing-rclone/), you are using tools based on a [standard S3 programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services). This standard interface does not accept Project ID as a parameter. Therefore, when you create a Scaleway API key with IAM, you are prompted to specify the API key's **preferred Project for Object Storage**. This API key will always use this Project when carrying out Object Storage actions via any API/CLI. The preferred Project is specified when creating the API key (or can be edited at a later date).
38+
When you perform an action on Scaleway Object Storage resources using a third-party API or CLI, such as [the AWS CLI](/storage/object/api-cli/object-storage-aws-cli/), [MinIOClient](/storage/object/api-cli/installing-minio-client/) or [Rclone](/storage/object/api-cli/installing-rclone/), you are using tools based on a [standard Amazon S3 programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services). This standard interface does not accept Project ID as a parameter. Therefore, when you create a Scaleway API key with IAM, you are prompted to specify the API key's **preferred Project for Object Storage**. This API key will always use this Project when carrying out Object Storage actions via any API/CLI. The preferred Project is specified when creating the API key (or can be edited at a later date).
3939

4040
<Message type="important">
4141
Setting the preferred Project does not automatically give the API key bearer permissions for Object Storage in this Project. Ensure that the user/application is either the Owner of the Organization, or has a [policy](/identity-and-access-management/iam/concepts/#policy) giving them appropriate permissions for Object Storage in this Project. Note that the application of Object Storage permissions can take up to 5 minutes after creating a new rule or policy.
4242
</Message>
4343

44-
When using the S3 CLI:
44+
When using the AWS S3 CLI:
4545
- An action of listing the buckets (`aws s3 ls`) will list the buckets of the preferred Project
4646
- An action of creating a bucket (`aws s3 mb`) will create a new bucket inside the preferred Project
4747
- An action of moving an object from a bucket to another (`aws s3 mv source destination`) will only work if the source bucket and the destination buckets are in the preferred Project for an API key

identity-and-access-management/iam/concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ For each policy rule, you specify one or more permission sets (e.g. "list all In
9595

9696
## Preferred Project
9797

98-
You can carry out actions on Scaleway Object Storage resources either via the [Scaleway console](https://console.scaleway.com), or via a third-party API or CLI, such as [the AWS CLI](/storage/object/api-cli/object-storage-aws-cli/), [MinIOClient](/storage/object/api-cli/installing-minio-client/) or [Rclone](/storage/object/api-cli/installing-rclone/). While the Scaleway console gives you the option to specify the [Scaleway Project](#what-is-a-project) to carry out your Object Storage actions in, this option is not available via third-party API/CLI tools. These tools are based on a [standard S3 programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services), which does not accept Project ID as a parameter. Therefore, when you create a Scaleway API key with IAM, you are prompted to specify the API key's **preferred Project for Object Storage**. This API key will always use this Project when carrying out Object Storage actions via any API/CLI. See our page on [using API keys with Object Storage](/identity-and-access-management/iam/api-cli/using-api-key-object-storage/) for more information.
98+
You can carry out actions on Scaleway Object Storage resources either via the [Scaleway console](https://console.scaleway.com), or via a third-party API or CLI, such as [the AWS CLI](/storage/object/api-cli/object-storage-aws-cli/), [MinIOClient](/storage/object/api-cli/installing-minio-client/) or [Rclone](/storage/object/api-cli/installing-rclone/). While the Scaleway console gives you the option to specify the [Scaleway Project](#what-is-a-project) to carry out your Object Storage actions in, this option is not available via third-party API/CLI tools. These tools are based on a [standard Amazon S3 programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services), which does not accept Project ID as a parameter. Therefore, when you create a Scaleway API key with IAM, you are prompted to specify the API key's **preferred Project for Object Storage**. This API key will always use this Project when carrying out Object Storage actions via any API/CLI. See our page on [using API keys with Object Storage](/identity-and-access-management/iam/api-cli/using-api-key-object-storage/) for more information.
9999

100100
## Principal
101101

managed-services/iot-hub/api-cli/iot-hub-routes.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ categories:
99
- managed-services
1010
dates:
1111
validation: 2024-04-22
12-
tags: iot iot-hub mqtt cli s3cmd s3
12+
tags: iot iot-hub mqtt cli s3cmd amazon-s3
1313
---
1414

1515
Routes are integrations with the Scaleway ecosystem: they can forward MQTT messages to Scaleway services.
@@ -26,9 +26,9 @@ Routes are integrations with the Scaleway ecosystem: they can forward MQTT messa
2626
- Installed the [Scaleway CLI](https://github.com/scaleway/scaleway-cli#scaleway-cli-v2) and [read the accompanying IoT document](/managed-services/iot-hub/api-cli/getting-started-with-iot-hub-cli/)
2727
- Installed and configured [`s3cmd`](/tutorials/s3cmd/) for Scaleway
2828

29-
## S3 Routes
29+
## Amazon S3 Routes
3030

31-
The S3 route allows you to put the payload of MQTT messages directly into Scaleway's Object Storage.
31+
The Amazon S3 route allows you to put the payload of MQTT messages directly into Scaleway's Object Storage.
3232

3333
<Message type="important">
3434
This section is a continuation of the [Iot Hub CLI quickstart](/managed-services/iot-hub/api-cli/getting-started-with-iot-hub-cli/). Make sure to follow the quickstart before beginning.
@@ -41,9 +41,9 @@ The S3 route allows you to put the payload of MQTT messages directly into Scalew
4141
PREFIX="iot/messages"
4242
# Create the bucket
4343
s3cmd mb --region "$REGION" "s3://$BUCKET"
44-
# Grant write access to IoT Hub S3 Route Service to your bucket
44+
# Grant write access to IoT Hub Amazon S3 Route Service to your bucket
4545
s3cmd setacl --region "$REGION" "s3://$BUCKET" --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031
46-
# Create the IoT Hub S3 Route
46+
# Create the IoT Hub Amazon S3 Route
4747
scw iot route create \
4848
hub-id=$(jq -r '.id' hub.json) \
4949
name=route-s3-cli topic="hello/world" \

managed-services/iot-hub/concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Increasing the QoS level decreases message throughput because of the additional
9696

9797
## Routes
9898

99-
IoT Routes forward messages to non publish/subscribe destinations such as databases, REST APIs, Serverless functions and S3 buckets. See [Understanding Routes](/managed-services/iot-hub/reference-content/routes/) for further information.
99+
IoT Routes forward messages to non publish/subscribe destinations such as databases, REST APIs, Serverless functions and Object Storage buckets. See [Understanding Routes](/managed-services/iot-hub/reference-content/routes/) for further information.
100100

101101
## TLS
102102

0 commit comments

Comments
 (0)