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

docs(s3): add troubleshooting pages MTA-4640 #3269

Merged
merged 6 commits into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
16 changes: 16 additions & 0 deletions menu/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -2333,6 +2333,22 @@
},
{
"items": [
{
"label": "I am experiencing performance issues",
"slug": "low-performance"
},
{
"label": "I cannot delete my bucket",
"slug": "cannot-delete-bucket"
},
{
"label": "I cannot restore an object from Glacier",
"slug": "cannot-restore-glacier"
},
{
"label": "I cannot access my data",
"slug": "cannot-access-data"
},
{
"label": "I lost access to a bucket after putting a bucket policy",
"slug": "lost-bucket-access-bucket-policy"
Expand Down
15 changes: 14 additions & 1 deletion storage/object/troubleshooting/api-key-does-not-work.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,17 @@ You can change the preferred project of your API key:

You should now be able to list your buckets using a supported S3-compatible third-party tool.

Refer to the documentation on [using IAM API keys with Object Storage](/identity-and-access-management/iam/api-cli/using-api-key-object-storage/) for more information.
## Going further

- Refer to the documentation on [using IAM API keys with Object Storage](/identity-and-access-management/iam/api-cli/using-api-key-object-storage/) for more information.

- If you did not manage to identify the error and solve it by yourself, [open a support ticket](/console/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:
- S3 Endpoint (e.g. `s3.fr-par.scw.cloud`)
- Bucket name
- Object name (if the request concerns an object)
- Request type (PUT, GET, etc.)
- HTTP status code
- Date and time (timestamp)
- User-agent (SDK, client, console, etc.)
- Transaction ID (if possible)
- Log / trace of the error (if possible)
51 changes: 51 additions & 0 deletions storage/object/troubleshooting/cannot-access-data.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
meta:
title: I cannot access my data
description: I am experiencing issues while accessing my data stored on Scaleway Object Storage.
content:
h1: I cannot access my data
paragraph: I am experiencing issues while accessing my data stored on Scaleway Object Storage.
tags: help troubleshooting object storage blocked data locked fail unable impossible
dates:
validation: 2024-06-04
posted: 2024-06-04
categories:
- storage
- object-storage
---

<Macro id="requirements" />

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

## Problem

I am experiencing issues while trying to access my buckets and objects stored on Scaleway Object Storage.

## Solution

- Go to the [Status page](https://status.scaleway.com/) to see if there is an ongoing incident on the Scaleway infrastructure.

- Retrieve the logs of your buckets using any S3-compatible tool to identify the cause of the problem:
- [Rclone](https://rclone.org/docs/#logging)
- [S3cmd](https://s3tools.org/usage)
- [MinIO Client](https://min.io/docs/minio/linux/reference/minio-mc-admin/mc-admin-logs.html#mc-admin-logs)
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/logs/get-log-events.html)

- Make sure there is no [bucket policy](/storage/object/concepts/#bucket-policy) that prevents you from deleting the bucket. If there is one, make sure that it [explicitly allows you](/storage/object/api-cli/bucket-policy/) to perform the desired action.

- Make sure that [Object lock](/storage/object/api-cli/object-lock/) has not been enabled on the bucket you try to access.

## Going further

If you did not manage to identify the error and solve it by yourself, [open a support ticket](/console/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:
- S3 Endpoint (e.g. `s3.fr-par.scw.cloud`)
- Bucket name
- Object name (if the request concerns an object)
- Request type (PUT, GET, etc.)
- HTTP status code
- Date and time (timestamp)
- User-agent (SDK, client, console, etc.)
- Transaction ID (if possible)
- Log / trace of the error (if possible)

51 changes: 51 additions & 0 deletions storage/object/troubleshooting/cannot-delete-bucket.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
meta:
title: I cannot delete my bucket
description: I am experiencing issues when trying to delete my object sotrage bucket
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
content:
h1: I cannot delete my bucket
paragraph: I am experiencing issues when trying to delete my object storage bucket
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
tags: help troubleshooting object storage delete bucket fail unable impossible
dates:
validation: 2024-06-04
posted: 2024-06-04
categories:
- storage
- object-storage
---

<Macro id="requirements" />

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

## Problem

I cannot delete my Scaleway Object Storage bucket.

## Solution

- Make sure there is no [bucket policy](/storage/object/concepts/#bucket-policy) that prevents you from deleting the bucket.

- If there is a bucket policy, make sure that it [explicitly allows you](/storage/object/api-cli/bucket-policy/) to perform the desired action.

<Message type="note">
- The effective deletion of the bucket will start 24 hours after the deletion request.
- The bucket name will then be available for other customers to use.
- We recommend you erase all objects and versions in the bucket before requesting the deletion
- Files larger than 1 GB can take longer to be deleted.
</Message>

## Going further

- Refer to the documentation on [how to delete a bucket](/storage/object/how-to/delete-a-bucket/) for more information.

- If you did not manage to identify the error and solve it by yourself, [open a support ticket](/console/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:
- S3 Endpoint (e.g. `s3.fr-par.scw.cloud`)
- Bucket name
- Object name (if the request concerns an object)
- Request type (PUT, GET, etc.)
- HTTP status code
- Date and time (timestamp)
- User-agent (SDK, client, console, etc.)
- Transaction ID (if possible)
- Log / trace of the error (if possible)
67 changes: 67 additions & 0 deletions storage/object/troubleshooting/cannot-restore-glacier.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
meta:
title: I cannot restore my objects from Glacier
description: I am experiencing issues while restoring objects from Scaleway Glacier.
content:
h1: I cannot restore my objects from Glacier
paragraph: I am experiencing issues while restoring objects from Scaleway Glacier.
tags: help troubleshooting object storage restore glacier fail unable impossible
dates:
validation: 2024-06-04
posted: 2024-06-04
categories:
- storage
- object-storage
---

<Macro id="requirements" />

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

## Problem

I need to retrieve my data from Scaleway Glacier, but the restore operation does not seem to function.

## Cause

The time it takes to restore an object depends on the size of the object and if [multipart](/storage/object/concepts/#multipart) is configured. If your object is larger than 1 MB, it can take anywhere from a few minutes to 24 hours for restore to start.

## Solution

Run the following command in a terminal to retrieve the metadata of the object you want to restore:

```sh
aws s3api head-object --bucket <bucket-name> --key <object-name>
```

An output similar to the following displays:

```sh
{
"AcceptRanges": "bytes",
"Restore": "ongoing-request=\"true\"",
"LastModified": "2024-03-13T16:30:44+00:00",
"ContentLength": 5,
"ETag": "\"sd11r084349bc25d97e29393ced1d\"",
"ContentType": "application/octet-stream",
"Metadata": {},
"StorageClass": "GLACIER"
}
```

The `"Restore": "ongoing-request=\"true\"",` line indicates that the restore operation has already started.
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved

## Going further

- Refer to the documentation on [how to restore objects from Glacier](/storage/object/how-to/restore-an-object-from-glacier/) for more information.

- If you did not manage to identify the error and solve it by yourself, [open a support ticket](/console/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:
- S3 Endpoint (e.g. `s3.fr-par.scw.cloud`)
- Bucket name
- Object name (if the request concerns an object)
- Request type (PUT, GET, etc.)
- HTTP status code
- Date and time (timestamp)
- User-agent (SDK, client, console, etc.)
- Transaction ID (if possible)
- Log / trace of the error (if possible)
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,17 @@ If you have the permission to apply a bucket policy, you can also delete it. To
```
- [apply a new bucket policy](/storage/object/api-cli/create-bucket-policy/) in the bucket to allow yourself (or the desired principal) to perform the desired [storage operations](/storage/object/api-cli/using-api-call-list/).

<Message type="note">
Refer to the [bucket policies overview](/storage/object/api-cli/bucket-policy/) for more information on the different elements of a bucket policy.
</Message>
## Going further

- Refer to the [bucket policies overview](/storage/object/api-cli/bucket-policy/) for more information on the different elements of a bucket policy.

- If you did not manage to identify the error and solve it by yourself, [open a support ticket](/console/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:
- S3 Endpoint (e.g. `s3.fr-par.scw.cloud`)
- Bucket name
- Object name (if the request concerns an object)
- Request type (PUT, GET, etc.)
- HTTP status code
- Date and time (timestamp)
- User-agent (SDK, client, console, etc.)
- Transaction ID (if possible)
- Log / trace of the error (if possible)
49 changes: 49 additions & 0 deletions storage/object/troubleshooting/low-performance.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
meta:
title: I am experiencing performance issues
description: I am experiencing performance issues such as decreased throughput, timeouts, and overall instability.
content:
h1: I lost access to a bucket after applying a bucket policy
paragraph: I am experiencing performance issues such as decreased throughput, timeouts, and overall instability.
tags: help troubleshooting object storage poor performance issues slow
dates:
validation: 2024-06-04
posted: 2024-06-04
categories:
- storage
- object-storage
---

<Macro id="requirements" />

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

## Problem

I am noticing decreased throughputs, timeouts, high latency, and overall instability on my Scaleway Object Storage deployment.

## Solution

- Go to the [Status page](https://status.scaleway.com/) to see if there is an ongoing incident on the Scaleway infrastructure.

- Retrieve the logs of your buckets using any S3-compatible tool to identify the cause of the problem:
- [Rclone](https://rclone.org/docs/#logging)
- [S3cmd](https://s3tools.org/usage)
- [MinIO Client](https://min.io/docs/minio/linux/reference/minio-mc-admin/mc-admin-logs.html#mc-admin-logs)
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/logs/get-log-events.html)

## Going further

- Refer to the documentation on [how to optimize your Object Storage performance](/storage/object/reference-content/optimize-object-storage-performance/) for more information.

- If you did not manage to identify the error and solve it by yourself, [open a support ticket](/console/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:
- S3 Endpoint (e.g. `s3.fr-par.scw.cloud`)
- Bucket name
- Object name (if the request concerns an object)
- Request type (PUT, GET, etc.)
- HTTP status code
- Date and time (timestamp)
- User-agent (SDK, client, console, etc.)
- Transaction ID (if possible)
- Log / Trace of the error (if possible)