Skip to content

Commit 1f951b7

Browse files
MikeMcC399sxa
andcommitted
docs: add supported architectures section
Co-authored-by: Stewart X Addison <6487691+sxa@users.noreply.github.com>
1 parent f2e1347 commit 1f951b7

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ The official Node.js docker image, made with love by the node community.
3131
- [License](#license)
3232
- [Supported Docker versions](#supported-docker-versions)
3333
- [Supported Node.js versions](#supported-nodejs-versions)
34+
- [Supported architectures](#supported-architectures)
35+
- [musl builds for Alpine](#musl-builds-for-alpine)
3436
- [Yarn v1 Classic bundling](#yarn-v1-classic-bundling)
3537
- [Governance and Current Members](#governance-and-current-members)
3638
- [Docker Maintainers](#docker-maintainers)
@@ -268,6 +270,23 @@ for current Engine versions.
268270

269271
This project will support Node.js versions as still under active support as per the [Node.js release schedule](https://github.com/nodejs/Release).
270272

273+
## Supported architectures
274+
275+
`node` images are built for the Linux operating system and architecture combinations defined in [versions.json](https://github.com/nodejs/docker-node/blob/main/versions.json).
276+
277+
- The [Node.js Platform list](https://github.com/nodejs/node/blob/main/BUILDING.md#official-binary-platforms-and-toolchains) defines [Support Tiers](https://github.com/nodejs/node/blob/main/BUILDING.md#strategy) 1, 2 and Experimental for platform and architecture combinations of Node.js builds and for each separate Node.js release line
278+
- The [Docker official images library](https://github.com/docker-library/official-images#architectures-other-than-amd64) lists the supported architectures in the Docker build environment
279+
280+
Each of the architectures for Debian images belong to the Node.js support tier 1 or 2, recommended for production applications.
281+
282+
### musl builds for Alpine
283+
284+
`musl` builds for `amd64` are listed under support tier "Experimental" and are tested by the Node.js build process before being used in Docker images. "Experimental" status for Node.js is defined as:
285+
286+
> Experimental: May not compile or test suite may not pass. The core team does not create releases for these platforms. Test failures on experimental platforms do not block releases. Contributions to improve support for these platforms are welcome.
287+
288+
`musl` builds for other architectures, including `arm64`, are not rigorously tested before release.
289+
271290
## Yarn v1 Classic bundling
272291

273292
The [Yarn v1 Classic](https://classic.yarnpkg.com/) package manager is bundled in `node` image

0 commit comments

Comments
 (0)