Skip to content

Commit 0e76499

Browse files
SamyOubouaziznerda-codesRoRoJ
authored
docs(srv): split troubleshootings into multiple pages MTA-5198 (#3955)
* docs(srv): split troubleshootings into multiple pages MTA-5198 * docs(srv): update * docs(srv): update * docs(srv): update * docs(srv): update * Apply suggestions from code review Co-authored-by: nerda-codes <[email protected]> * Update serverless/containers/troubleshooting/cannot-create-namespace.mdx Co-authored-by: Rowena Jones <[email protected]> * Update serverless/functions/troubleshooting/handler-not-found.mdx Co-authored-by: Rowena Jones <[email protected]> * Update serverless/functions/troubleshooting/cannot-create-namespace.mdx Co-authored-by: Rowena Jones <[email protected]> --------- Co-authored-by: nerda-codes <[email protected]> Co-authored-by: Rowena Jones <[email protected]>
1 parent 66caa8b commit 0e76499

19 files changed

+538
-291
lines changed

menu/navigation.json

Lines changed: 78 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3703,16 +3703,6 @@
37033703
"label": "API/CLI",
37043704
"slug": "api-cli"
37053705
},
3706-
{
3707-
"items": [
3708-
{
3709-
"label": "Common errors",
3710-
"slug": "common-errors"
3711-
}
3712-
],
3713-
"label": "Troubleshooting",
3714-
"slug": "troubleshooting"
3715-
},
37163706
{
37173707
"items": [
37183708
{
@@ -3770,6 +3760,40 @@
37703760
],
37713761
"label": "Additional Content",
37723762
"slug": "reference-content"
3763+
},
3764+
{
3765+
"items": [
3766+
{
3767+
"label": "Unable to create a namespace",
3768+
"slug": "cannot-create-namespace"
3769+
},
3770+
{
3771+
"label": "I cannot inject secrets or variables in my job",
3772+
"slug": "cannot-inject-secret-variable"
3773+
},
3774+
{
3775+
"label": "My function is in an error state",
3776+
"slug": "function-in-error-state"
3777+
},
3778+
{
3779+
"label": "My function stopped working after a redeploy",
3780+
"slug": "function-stopped-after-redeploy"
3781+
},
3782+
{
3783+
"label": "Handler not found",
3784+
"slug": "handler-not-found"
3785+
},
3786+
{
3787+
"label": "I am experiencing timeout errors",
3788+
"slug": "timeout-error"
3789+
},
3790+
{
3791+
"label": "My function fails after too many retries",
3792+
"slug": "too-many-retries"
3793+
}
3794+
],
3795+
"label": "Troubleshooting",
3796+
"slug": "troubleshooting"
37733797
}
37743798
],
37753799
"label": "Functions",
@@ -3869,16 +3893,6 @@
38693893
"label": "API/CLI",
38703894
"slug": "api-cli"
38713895
},
3872-
{
3873-
"items": [
3874-
{
3875-
"label": "Common errors",
3876-
"slug": "common-errors"
3877-
}
3878-
],
3879-
"label": "Troubleshooting",
3880-
"slug": "troubleshooting"
3881-
},
38823896
{
38833897
"items": [
38843898
{
@@ -3920,6 +3934,32 @@
39203934
],
39213935
"label": "Additional Content",
39223936
"slug": "reference-content"
3937+
},
3938+
{
3939+
"items": [
3940+
{
3941+
"label": "I cannot create a namespace",
3942+
"slug": "cannot-create-namespace"
3943+
},
3944+
{
3945+
"label": "I cannot deploy my image",
3946+
"slug": "cannot-deploy-image"
3947+
},
3948+
{
3949+
"label": "I cannot inject secrets or variables in my job",
3950+
"slug": "cannot-inject-secret-variable"
3951+
},
3952+
{
3953+
"label": "I cannot retrieve external images",
3954+
"slug": "cannot-retrieve-external-image"
3955+
},
3956+
{
3957+
"label": "My container stopped working after a redeploy",
3958+
"slug": "container-stopped-after-redeploy"
3959+
}
3960+
],
3961+
"label": "Troubleshooting",
3962+
"slug": "troubleshooting"
39233963
}
39243964
],
39253965
"label": "Containers",
@@ -3977,16 +4017,6 @@
39774017
"label": "How to",
39784018
"slug": "how-to"
39794019
},
3980-
{
3981-
"items": [
3982-
{
3983-
"label": "Common errors",
3984-
"slug": "common-errors"
3985-
}
3986-
],
3987-
"label": "Troubleshooting",
3988-
"slug": "troubleshooting"
3989-
},
39904020
{
39914021
"items": [
39924022
{
@@ -4022,6 +4052,24 @@
40224052
],
40234053
"label": "Additional Content",
40244054
"slug": "reference-content"
4055+
},
4056+
{
4057+
"items": [
4058+
{
4059+
"label": "My job is in an error state",
4060+
"slug": "job-in-error-state"
4061+
},
4062+
{
4063+
"label": "I cannot inject secrets or variables in my job",
4064+
"slug": "cannot-inject-secret-variable"
4065+
},
4066+
{
4067+
"label": "I cannot retrieve external images",
4068+
"slug": "cannot-retrieve-external-image"
4069+
}
4070+
],
4071+
"label": "Troubleshooting",
4072+
"slug": "troubleshooting"
40254073
}
40264074
],
40274075
"label": "Jobs",
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
meta:
3+
title: I am unable to create a Serverless Containers namespace
4+
description: Troubleshoot problems encountered while creating namespaces for Scaleway Serverless Containers.
5+
content:
6+
h1: I am unable to create a Serverless Containers namespace
7+
paragraph: Troubleshoot problems encountered while creating namespaces for Scaleway Serverless Containers.
8+
tags: serverless Containers troubleshooting issue error namespace creation unable
9+
dates:
10+
validation: 2024-11-06
11+
posted: 2024-11-06
12+
categories:
13+
- serverless
14+
---
15+
16+
## Problem
17+
18+
I cannot create a Serverless Containers namespace.
19+
20+
### Cause
21+
22+
This issue can happen for the following reasons:
23+
24+
- You have created too many Serverless Containers namespaces and reached [your account's quota](/identity-and-access-management/organizations-and-projects/additional-content/organization-quotas/#serverless-containers).
25+
26+
- You have created too many Registry namespaces and reached [your account's quota](/identity-and-access-management/organizations-and-projects/additional-content/organization-quotas/#container-registry).
27+
28+
### Possible solutions
29+
30+
Make sure that you have not exceeded the maximum number of allowed namespaces with the [Scaleway console](https://console.scaleway.com/) or with the [API](https://www.scaleway.com/en/developers/api/serverless-containers/#path-namespaces-list-all-your-namespaces).
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
meta:
3+
title: I am unable to deploy my image
4+
description: Troubleshoot errors encountered while deploying images with Scaleway Serverless Containers.
5+
content:
6+
h1: I am unable to deploy my image
7+
paragraph: Troubleshoot errors encountered while deploying images with Scaleway Serverless Containers.
8+
tags: serverless containers troubleshooting issue error message deploy image failed
9+
dates:
10+
validation: 2024-11-07
11+
posted: 2024-11-07
12+
categories:
13+
- serveless
14+
---
15+
16+
## Problem
17+
18+
I am unable to deploy my image using Serverless Containers.
19+
20+
## Possible solutions
21+
22+
- Make sure the container is listening on the specified PORT for HTTP requests (or use variable `$PORT`).
23+
24+
- Make sure the container is bound to `0.0.0.0`.
25+
26+
- Containers cannot start due to insufficient provisioned resources. Update your container's resources by provisioning more memory and more vCPU.
27+
28+
- Make sure you have built your image for an `amd64` architecture, as `arm64` is not supported. See the [Architecture](/serverless/containers/reference-content/containers-limitations/#Architecture) documentation for more information.
29+
30+
- Make sure your deployment does not exceed the limitations of [Serverless Containers](/serverless/containers/reference-content/containers-limitations/).
31+
32+
<Message type="tip">
33+
Run the [`docker inspect`](https://docs.docker.com/engine/reference/commandline/inspect/) command to get detailed information on your image:
34+
```
35+
docker inspect myimage
36+
```
37+
</Message>
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
meta:
3+
title: My secrets and variables are not injected properly in my container
4+
description: Troubleshoot issues with secrets and environment variables while using Scaleway Serverless Containers.
5+
content:
6+
h1: My secrets and variables are not injected properly in my container
7+
paragraph: Troubleshoot issues with secrets and environment variables while using Scaleway Serverless Containers.
8+
tags: serverless containers troubleshooting issue error image env var environment variables secrets secret manager
9+
dates:
10+
validation: 2024-11-06
11+
posted: 2024-11-06
12+
categories:
13+
- serverless
14+
---
15+
16+
## Problem
17+
18+
My environment variables and secrets are not properly injected in my Serverless Container.
19+
20+
## Cause
21+
22+
Environment variables or secrets that are too large, contain carriage returns and spread over several lines, as shown below, will not be injected properly.
23+
24+
```
25+
"hello
26+
world
27+
.
28+
"
29+
```
30+
31+
### Solution
32+
33+
To avoid issues while injecting environment variables and secrets, we recommend encoding them to `base64`.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
meta:
3+
title: I am unable to retrieve an external image for my container
4+
description: Troubleshoot errors while retrieving external images while using Scaleway Serverless Containers.
5+
content:
6+
h1: I am unable to retrieve an external image for my container
7+
paragraph: Troubleshoot errors while retrieving external images while using Scaleway Serverless Containers.
8+
tags: serverless containers troubleshooting issue error image retrieve external public registry
9+
dates:
10+
validation: 2024-11-06
11+
posted: 2024-11-06
12+
categories:
13+
- serverless
14+
---
15+
16+
## Problem
17+
18+
I am experiencing issues when retrieving an image stored in an external container registry.
19+
20+
## Cause
21+
22+
Serverless products support external public registries (such as [Docker Hub](https://hub.docker.com/)), but we do not recommend using them due to uncontrolled rate limiting, which can lead to failures when starting resources, unexpected usage conditions, and pricing changes.
23+
24+
## Solution
25+
26+
We recommend using the [Scaleway Container Registry](/containers/container-registry/) instead, as it allows for a seamless integration with Serverless Containers and Containers at a [competitive price](/faq/containerregistry/#how-am-i-billed-for-scaleway-container-registry).
27+
28+
Refer to the [dedicated documentation](/serverless/containers/api-cli/migrate-external-image-to-scaleway-registry/) for more information on how to migrate images to the Scaleway Container Registry.

serverless/containers/troubleshooting/common-errors.mdx

Lines changed: 0 additions & 85 deletions
This file was deleted.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
meta:
3+
title: My container stopped working after a redeploy
4+
description: Troubleshoot issues with Scaleway Serverless Containers not working properly following a redeploy.
5+
content:
6+
h1: My container stopped working after a redeploy
7+
paragraph: Troubleshoot issues with Scaleway Serverless Containers not working properly following a redeploy.
8+
tags: serverless containers troubleshooting issue error state failed fail redeploy
9+
dates:
10+
validation: 2024-11-06
11+
posted: 2024-11-06
12+
categories:
13+
- serverless
14+
---
15+
16+
## Problem
17+
18+
My Serverless Container stopped working (up to several hours) after a redeploy.
19+
20+
## Cause
21+
22+
The new deploy failed, and the [fallback mechanism has been triggered](/serverless/containers/reference-content/containers-limitations/#versioning-and-rollback).
23+
24+
## Possible solution
25+
26+
Identify the element that caused the deployment to fail, fix the error, and deploy the container again.

0 commit comments

Comments
 (0)