initializbuildpacks/node-engine

Node Engine CNB 镜像文档

镜像概述和主要用途

Node Engine CNB（Cloud Native Buildpack）是一个用于在Cloud Native Buildpacks构建流程中安装Node.js二进制文件的构建包。其核心功能是为构建过程和最终容器提供Node.js运行时环境，支持其他构建包依赖Node.js进行应用构建或运行，是Cloud Native Buildpacks生态系统中提供Node.js运行时支持的关键组件。

核心功能和特性

• Node.js二进制文件安装：自动下载并安装指定版本的Node.js二进制文件，确保构建和运行环境中存在可用的Node.js运行时。
• CNB生态兼容：遵循Cloud Native Buildpacks规范，可与其他构建包（如Node.js应用构建包、前端构建包等）无缝协同工作。
• 版本灵活性：支持指定多种Node.js版本，满足不同应用对Node.js版本的依赖需求。
• 运行时环境提供：将安装的Node.js二进制文件添加到最终容器的运行时环境中，确保应用运行时可访问Node.js。

使用场景和适用范围

Node Engine CNB适用于以下场景：

• 使用Cloud Native Buildpacks构建依赖Node.js运行时的应用，如Node.js后端应用、React/Vue/Angular等前端应用。
• 需要在构建过程中执行Node.js相关命令（如npm install、yarn build等）的应用构建流程。
• 构建基于Cloud Native Buildpacks的容器镜像，且应用运行时依赖Node.js环境的场景。

使用方法和配置说明

基本使用流程

Node Engine CNB通常作为Cloud Native Buildpacks构建流程的一部分使用，需配合pack CLI或其他CNB构建工具（如Tekton、Kpack等）。

使用pack CLI构建示例

1. 确保已安装pack CLI（参考pack安装文档）。
2. 在应用项目根目录执行构建命令，指定包含Node Engine CNB的构建器：

bash
pack build my-node-app --builder paketobuildpacks/builder:base

说明：主流CNB构建器（如Paketo Buildpacks）已内置Node Engine CNB，无需单独指定即可自动启用。

配置Node.js版本

可通过以下方式指定Node.js版本：

1. 环境变量配置

构建时通过--env参数指定Node.js版本：

bash
pack build my-node-app --builder paketobuildpacks/builder:base --env BP_NODE_VERSION=18.17.1

2. 项目配置文件（project.toml）

在项目根目录创建project.toml文件，配置Node.js版本：

toml
[[build.env]]
name = "BP_NODE_VERSION"
value = "18.17.1"

3. package.json配置（部分构建包支持）

在package.json中指定engines.node字段：

json
{
  "engines": {
    "node": "18.x"
  }
}

环境变量说明

使用场景和适用范围

Node Engine CNB适用于以下场景：

• 使用Cloud Native Buildpacks构建Node.js后端应用、前端应用（React/Vue等）的场景。
• 构建流程中需执行Node.js相关命令（如npm install、yarn build）的应用。
• 需要为最终容器提供Node.js运行时环境的Cloud Native Buildpacks构建流程。

注意事项

• 确保使用的构建器包含Node Engine CNB，或通过--buildpack参数显式指定（如--buildpack gcr.io/paketo-buildpacks/node-engine）。
• Node.js版本指定需符合构建包支持的版本范围，具体可参考对应构建包文档。
• 构建过程中需保证网络通畅，以便成功下载指定版本的Node.js二进制文件。