Skip to content

docs(gen): add troubleshooting pages MTA-5446 #4687

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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
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
12 changes: 8 additions & 4 deletions pages/object-storage/troubleshooting/cannot-access-data.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
meta:
title: I cannot access my data
description: Troubleshoot issues related to accessing data in Scaleway Object Storage.
title: I cannot access my objects
description: Troubleshoot issues related to accessing objects in Scaleway Object Storage.
content:
h1: I cannot access my data
paragraph: Troubleshoot issues related to accessing data in Scaleway Object Storage.
h1: I cannot access my objects
paragraph: Troubleshoot issues related to accessing objects in Scaleway Object Storage.
tags: help troubleshooting object storage blocked data locked fail unable impossible
dates:
validation: 2024-12-09
Expand All @@ -26,6 +26,10 @@ I am experiencing issues while trying to access my buckets and objects stored on

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

- Make sure that you are using a valid [API key](https://console.scaleway.com/iam/api-keys).

- Make sure that the bearer of the API key (IAM [user](/iam/concepts/#user) or [application](/iam/concepts/#application)) has the appropriate [IAM permission set](/iam/how-to/view-permission-sets/) to perform the desired actions.

- Retrieve the logs of your buckets using any Amazon S3-compatible tool to identify the cause of the problem:
- [Rclone](https://rclone.org/docs/#logging)
- [S3cmd](https://s3tools.org/usage)
Expand Down
56 changes: 56 additions & 0 deletions pages/object-storage/troubleshooting/error-messages-access.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
meta:
title: I get error messages when trying to access a bucket
description: Solve errors encountered while trying to access your bucket with Scaleway Object Storage.
content:
h1: I get error messages when trying to access a bucket
paragraph: Solve errors encountered while trying to access your bucket with Scaleway Object Storage.
tags: help troubleshooting access bucket error message denied deny fail failed
dates:
validation: 2025-03-24
posted: 2025-03-24
categories:
- storage
- object-storage
---

<Macro id="requirements" />

- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization


## Problem

One of the following messages display when trying to access your bucket using Scaleway Object Storage:

- `Failed to preprocess target Error: S3 error: Access Denied`
- `Error: Shared memory connection was closed.`
- `Failed to upload disk 'shadowSpec>'`
- `Agent failed to process method {DataTransfer.SyncDisk}.`

#### Cause

The application cannot access the Object Storage resource.

#### Solution

If you encounter one or several of the error messages above:

- Check for issues with your API key by following [this procedure](/object-storage/troubleshooting/api-key-does-not-work/).

- make sure that you have the `ObjectStorageFullAccess` [IAM permission](/iam/concepts/#permission).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- make sure that you have the `ObjectStorageFullAccess` [IAM permission](/iam/concepts/#permission).
- Make sure that you have the `ObjectStorageFullAccess` [IAM permission](/iam/concepts/#permission).


- make sure that there is no [bucket policy](/object-storage/api-cli/bucket-policy/) preventing the application to access your bucket.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- make sure that there is no [bucket policy](/object-storage/api-cli/bucket-policy/) preventing the application to access your bucket.
- Make sure that there is no [bucket policy](/object-storage/api-cli/bucket-policy/) preventing the application to access your bucket.


## Going further

- If you did not manage to identify the error and solve it by yourself, [open a support ticket](/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:
- Object Storage 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
@@ -0,0 +1,48 @@
---
meta:
title: I am experiencing DNS/Edge Services issues
description: Learn to troubleshoot issues when using Edge Services or DNS with Scaleway Object Storage.
content:
h1: I am experiencing DNS/Edge Services issues
paragraph: Learn to troubleshoot issues when using Edge Services or DNS with Scaleway Object Storage.
tags: help troubleshooting object storage dns domains edge services cannot does not work
dates:
validation: 2025-03-24
posted: 2025-03-24
categories:
- storage
- object-storage
---

<Macro id="requirements" />

- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization

## Problem

I am experiencing DNS and/or Edge Services issues when using Scaleway Object Storage.

## Possible cause

There are many factors that can cause DNS and Edge Services issues with Scaleway Object Storage. However, most of the time, the root cause does not come from the Object Storage configuration, but from Domains and DNS, or Edge Services.

## Solutions

According to the type of issue you are experiencing:

- Refer to the [Edge Services troubleshooting documentation](/edge-services/troubleshooting/) for dedicated help pages.

- Refer to the [Domains and DNS troubleshooting documentation](/domains-and-dns/troubleshooting/) for dedicated help pages.

## Going further

If you did not manage to identify the error and solve it by yourself, [open a support ticket](/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:
- Object Storage 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)
56 changes: 56 additions & 0 deletions pages/object-storage/troubleshooting/request-rate-error.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
meta:
title: I am experiencing request rate errors
description: Solve issues linked to request rate limitations on Scaleway Object Storage.
content:
h1: I am experiencing request rate errors
paragraph: Solve issues linked to request rate limitations on Scaleway Object Storage.
tags: help troubleshooting rate limit throttle error bottleneck slowness slow low performance
dates:
validation: 2025-03-24
posted: 2025-03-24
categories:
- storage
- object-storage
---

<Macro id="requirements" />

- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization

## Problem

An error message similar to one of the following displays:

- `Error: S3 error: Too Many Requests`
- `Code: Too Many Requests`
- `Shared memory connection was closed.`
- `Agent failed to process method {DataTransfer.SyncDisk}.`

## Cause

Scaleway Object Storage applies a rate limit on PUT operations for safety reasons.

## Solution

Reduce the number of PUT operations sent by your deployment.

<Message type="note">
You may experience reduced throughput due to the limitation.
</Message>

### Going further

Refer to the documentation on [optimizing your Object Storage deployment](/object-storage/reference-content/optimize-object-storage-performance/).

If you did not manage to identify the error and solve it by yourself, [open a support ticket](/account/how-to/open-a-support-ticket/), and provide as many details as possible, along with the necessary information below:

- Object Storage 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
@@ -1,10 +1,10 @@
---
meta:
title: I am unable to deploy my image
description: Troubleshoot errors encountered while deploying images with Scaleway Serverless Containers.
title: I am unable to deploy container
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
title: I am unable to deploy container
title: I am unable to deploy my container

description: Troubleshoot errors encountered while deploying containers with Scaleway Serverless Containers.
content:
h1: I am unable to deploy my image
paragraph: Troubleshoot errors encountered while deploying images with Scaleway Serverless Containers.
h1: I am unable to deploy my container
paragraph: Troubleshoot errors encountered while deploying containers with Scaleway Serverless Containers.
tags: serverless containers troubleshooting issue error message deploy image failed
dates:
validation: 2024-11-07
Expand All @@ -15,7 +15,7 @@ categories:

## Problem

I am unable to deploy my image using Serverless Containers.
I am unable to deploy my container or image using Serverless Containers.

## Possible solutions

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
meta:
title: My container is in an error state
description: Troubleshoot problems encountered when Serverless Containers are in an error state.
content:
h1: My container is in an error state
paragraph: Troubleshoot problems encountered when Serverless Containers are in an error state.
tags: serverless containers troubleshooting issue error state container status fail
dates:
validation: 2025-04-10
posted: 2024-04-10
categories:
- serverless
---

## Problem

My container is in an error state.

## Cause

There are several factors that can put Serverless Containers in an error state:

- Your container image does not work properly
- Your container image does not contain a webserver
- Your deployment exceeds the [Serverless Containers limitations](/serverless-containers/reference-content/containers-limitations/)

## Possible solutions

- Try to build and run your image locally using [Docker](https://docs.docker.com/get-started/get-docker/).

- Make sure your image embarks a webserver (nginx, Apache, Alpine, etc.) that can process HTTP requests.

- Make sur your deployment does not exceed the [Serverless Containers limitations](/serverless-containers/reference-content/containers-limitations/).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Make sur your deployment does not exceed the [Serverless Containers limitations](/serverless-containers/reference-content/containers-limitations/).
- Make sure your deployment does not exceed the [Serverless Containers limitations](/serverless-containers/reference-content/containers-limitations/).


## Going further

Refer to the following troubleshooting pages for other solutions:

- [I am unable to deploy my image](/serverless-containers/troubleshooting/cannot-deploy-image/)
- [My container stopped working after a redeploy](/serverless-containers/troubleshooting/container-stopped-after-redeploy/)
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
meta:
title: My function does not build properly
description: Troubleshoot issues with build errors while using Scaleway Serverless Functions.
title: My function does not deploy properly
description: Troubleshoot issues with deployment errors while using Scaleway Serverless Functions.
content:
h1: My function does not build properly
paragraph: Troubleshoot issues with build errors while using Scaleway Serverless Functions.
h1: My function does not deploy properly
paragraph: Troubleshoot issues with deployment errors while using Scaleway Serverless Functions.
tags: serverless functions troubleshooting issue error build compile package
dates:
validation: 2025-02-10
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
meta:
title: My database is unavailable
description: Find solutions for unavailable databases with serverless SQL databases.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
description: Find solutions for unavailable databases with serverless SQL databases.
description: Find solutions for unavailable databases with Serverless SQL Databases.

content:
h1: My database is unavailable
paragraph: Find solutions for unavailable databases with serverless SQL databases.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
paragraph: Find solutions for unavailable databases with serverless SQL databases.
paragraph: Find solutions for unavailable databases with Serverless SQL Databases.

tags: database serverless-sql-database unavailable error state status
dates:
validation: 2025-04-10
posted: 2025-04-10
categories:
- serverless
---

## Problem

My database is unavailable or in an error state.

## Cause

There are several factors that can put Serverless SQL Databases in an error state:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
There are several factors that can put Serverless SQL Databases in an error state:
Several factors can put Serverless SQL Databases in an error state:


- Scheduled maintenance operations led by Scaleway
- Incident on the Scaleway infrastructure
- Incident on the Scaleway network

## Possible solutions

1. Using the [Scaleway console](https://console.scaleway.com/), check the status of your Serverless SQL Database from its **Overview** tab to make sure it is in an error state. If it is **Ready to use**, or **Running**, make sure that your [database connection is properly set](/serverless-sql-databases/how-to/connect-to-a-database/).

2. Refer to the [documentation on planned maintenance](/serverless-sql-databases/reference-content/planned-maintenance/) to check if you are currently in a maintenance period.

3. Go to the [Scaleway Status](https://status.scaleway.com/) website to check if an incident is currently ongoing.

4. Wait a few minutes, then check the status of your Serverless SQL Database using the [Scaleway console](https://console.scaleway.com/) again.
Loading