Skip to content

fix(serverless): improve architecture documentation #3738

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 25, 2024
Merged

fix(serverless): improve architecture documentation #3738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cb7acd
fix(serverless): improve architecture documentation
thomas-tacquet Sep 24, 2024
90a1a7d
Apply suggestions from code review
thomas-tacquet Sep 24, 2024
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
8 changes: 5 additions & 3 deletions serverless/containers/reference-content/containers-limitations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,11 @@ When container CPU and/or memory are not provided by the client, these default v

## Architecture

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

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

You must ensure to build your image to target `amd64` architecture.
You must ensure that you build your image to target `amd64` architecture, to acheive this there are multiple solutions:
* You can use the following Docker command: `docker buildx build --platform linux/amd64 .`, or
* You can use an Instance with `amd64` architecture to run your builds.
4 changes: 2 additions & 2 deletions serverless/containers/troubleshooting/common-errors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ categories:

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

- Make sure you built your image for an `amd64` architecture, as `arm64` is not supported.
- 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.

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

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

### Possible solutions

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).
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).
9 changes: 6 additions & 3 deletions serverless/jobs/reference-content/jobs-limitations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,14 @@ When the job vCPU and/or memory are not provided by the client, these default va

## Architecture

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

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

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

## Ports restrictions

Expand Down
4 changes: 2 additions & 2 deletions serverless/jobs/troubleshooting/common-errors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ categories:

### Possible solutions

- Make sure you built your image for an `amd64` architecture, as `arm64` is not supported.
- 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.

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