Skip to content

Commit 5aa554f

Browse files
fix(serverless): improve architecture documentation (#3738)
* fix(serverless): improve architecture documentation * Apply suggestions from code review Co-authored-by: Rowena Jones <[email protected]> --------- Co-authored-by: Rowena Jones <[email protected]>
1 parent a38d6f8 commit 5aa554f

File tree

4 files changed

+15
-10
lines changed

4 files changed

+15
-10
lines changed

serverless/containers/reference-content/containers-limitations.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,11 @@ When container CPU and/or memory are not provided by the client, these default v
7878

7979
## Architecture
8080

81-
Scaleway Containers only supports `amd64` [architecture](https://github.com/docker-library/official-images#architectures-other-than-amd64/) for
81+
Scaleway Containers only supports `amd64` [architecture](https://github.com/docker-library/official-images?tab=readme-ov-file#architectures-other-than-amd64) for
8282
images.
8383

84-
For example, if you build an image using an ARM CPU, such as Apple Silicon, your image will be in the `arm64` architecture, and you will have an error message during deployment.
84+
For example, if you build an image using an ARM CPU, such as Apple Silicon M series, your image will be in the `arm64` architecture, and you will have an error message during deployment.
8585

86-
You must ensure to build your image to target `amd64` architecture.
86+
You must ensure that you build your image to target `amd64` architecture, to acheive this there are multiple solutions:
87+
* You can use the following Docker command: `docker buildx build --platform linux/amd64 .`, or
88+
* You can use an Instance with `amd64` architecture to run your builds.

serverless/containers/troubleshooting/common-errors.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ categories:
2323

2424
- Containers cannot start due to insufficient provisioned resources. Update your container's resources by provisioning more memory and more vCPU.
2525

26-
- Make sure you built your image for an `amd64` architecture, as `arm64` is not supported.
26+
- Make sure you built your image for an `amd64` architecture, as `arm64` is not supported. See [Architecture](/serverless/containers/reference-content/containers-limitations/#Architecture) documentation.
2727

2828
- Make sure your deployment does not exceed the limitations of [Serverless Containers](/serverless/containers/reference-content/containers-limitations/).
2929

@@ -45,4 +45,4 @@ This issue can happen for the following reasons:
4545

4646
### Possible solutions
4747

48-
Make sure that you did not exceed 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).
48+
Make sure that you did not exceed 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).

serverless/jobs/reference-content/jobs-limitations.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,14 @@ When the job vCPU and/or memory are not provided by the client, these default va
3838

3939
## Architecture
4040

41-
Scaleway Serverless Jobs only supports `amd64` architecture for images.
41+
Scaleway Serverless Jobs only supports `amd64` [architecture](https://github.com/docker-library/official-images?tab=readme-ov-file#architectures-other-than-amd64) for
42+
images.
4243

43-
For example, if you build an image using an ARM CPU, such as Apple Silicon, your image will be in the `arm64` architecture, and you will have an error message during deployment.
44+
For example, if you build an image using an ARM CPU, such as Apple Silicon M series, your image will be in the `arm64` architecture, and you will have an error message during deployment.
4445

45-
You must ensure that you build your image to target `amd64` architecture.
46+
You must ensure that you build your image to target `amd64` architecture, to acheive this there are multiple solutions:
47+
* You can use the following docker command: `docker buildx build --platform linux/amd64 .`, or
48+
* You can use an Instance with `amd64` architecture to run your builds.
4649

4750
## Ports restrictions
4851

serverless/jobs/troubleshooting/common-errors.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ categories:
1717

1818
### Possible solutions
1919

20-
- Make sure you built your image for an `amd64` architecture, as `arm64` is not supported.
20+
- Make sure you built your image for an `amd64` architecture, as `arm64` is not supported. See [Architecture](/serverless/jobs/reference-content/jobs-limitations/#Architecture) documentation.
2121

22-
- Make sure your deployment does not exceed the limitations of [Serverless Jobs](/serverless/jobs/reference-content/jobs-limitations/).
22+
- Make sure your deployment does not exceed the limitations of [Serverless Jobs](/serverless/jobs/reference-content/jobs-limitations/).

0 commit comments

Comments
 (0)