n8n 中文文档

在 AWS 上部署您的第一个 n8n 实例

本演练使用 terraform-aws-n8n 模块的 small 示例,用六个步骤带您从空文件夹得到一个在 AWS 上运行的 n8n 实例。您只需编写一个文件 main.tf,然后运行 terraform init、terraform plan 和 terraform apply。

您不需要克隆仓库。该示例以 n8n-io/n8n/aws 的形式位于 Terraform Registry 中,terraform init 会为您下载它。示例已经包含 VPC 和 provider 设置,因此本页上的配置就是您需要编写的全部 Terraform。

从 terraform apply 到可以访问编辑器,预计大约需要 30 分钟。

提示

功能可用性

本模块默认部署的多 main 拓扑适用于:

  • Self-hosted: Enterprise

如果设置 n8n_main_hpa_min_replicas = 1 以运行单个 main Pod,Business 许可证也可以使用。该模式会改变哪些行为,请参阅在 AWS 上扩展并以高可用运行。

先决条件

开始之前,请确认您已经具备:

  • 已安装 Terraform CLI 1.11 或更高版本。
  • 已安装 AWS CLI,并配置了能够创建 EKS、RDS、ElastiCache、IAM、VPC、KMS、S3、ACM 和 Route 53 资源的凭据。
  • 一个父区域托管在 AWS Route 53 中的域名。您需要该托管区 ID。例如,要在 n8n.example.com 上运行 n8n,您需要 example.com 的托管区。
  • 一个 n8n Enterprise 许可证密钥;如果设置 n8n_main_hpa_min_replicas = 1,则使用 Business 许可证密钥。

第 1 步:创建项目文件夹

Terraform 以您运行它的文件夹为工作目录,因此先创建一个空文件夹:

mkdir n8n-aws
cd n8n-aws

第 2 步:选择部署规模

terraform-aws-n8n 模块附带三种规模示例。本演练部署 small,它适合开发或小型团队实例:

small(默认) medium large
目标规模 开发或小型团队 约 500 万–1500 万次执行/天 约 5000 万–6000 万以上次执行/天
节点类型 t3.xlarge m6i.2xlarge m7i.4xlarge
估算月费用(按需) 约 $440 约 $2,000 约 $21,000+

完整比较(包括 Pod 数量、数据库规模和预留实例价格)请参阅使用 Terraform 部署到 AWS上的规模表。如果不确定,请从 small 开始:从 small 换到 medium 比较直接,换到 large 则涉及基础设施变更。

要改为部署更大的层级,请把 main.tf 中模块的 source 指向该示例的子路径。examples/medium 接受与 small 相同的输入,examples/large 会额外增加 certificate_arn 和 aurora_instance_class。

第 3 步:创建 main.tf

在项目文件夹中创建一个文件 main.tf。它把注册表中的 small 示例 作为模块引用,并固定为 0.5.0:

variable "n8n_license_key" {
  type      = string
  sensitive = true
}

module "n8n" {
  source  = "n8n-io/n8n/aws//examples/small"
  version = "0.5.0"

  n8n_domain      = "n8n.example.com"
  route53_zone_id = "<hosted-zone-id>"
  n8n_license_key = var.n8n_license_key

  # 应用于每个资源,用于成本跟踪和归属。
  tags = {
    Environment = "development"
    Owner       = "platform-team"
  }

  # aws_region   = "eu-west-1"   # 可选,默认为 us-east-1
  # cluster_name = "n8n-cluster" # 可选,不超过 14 个字符
}

output "n8n_url" {
  description = "The URL to open once the load balancer finishes provisioning."
  value       = module.n8n.n8n_url
}

output "n8n_encryption_key" {
  description = "Back this up in a password manager. n8n emits it once."
  value       = module.n8n.n8n_encryption_key
  sensitive   = true
}

cluster_name 不得超过 14 个字符。模块派生的 ElastiCache 集群 ID 为 <cluster-name>-redis,AWS 将这些 ID 限制为 20 个字符。

第 4 步:设置您的值

在 main.tf 中替换:

  • 把 n8n_domain 换成您要运行 n8n 的域名。
  • 把 route53_zone_id 换成该域名父区域的托管区 ID。
  • 把 tags 换成您的组织用于成本跟踪和归属的标签。

然后把许可证密钥作为环境变量提供,这样它就不会进入文件:

export TF_VAR_n8n_license_key="<your-license-key>"

第 5 步:初始化 Terraform

terraform init

这会下载 n8n 模块、VPC 模块,以及 aws、kubernetes 和 helm provider。

第 6 步:计划并应用

预览 Terraform 将创建的内容:

terraform plan

查看计划,然后应用:

terraform apply

出现提示时输入 yes,或加上 -auto-approve 以跳过确认。置备大约需要 20 到 25 分钟,此后负载均衡器还需要大约 5 分钟才能访问。

完成后,打开 n8n_url 输出中的 URL:

terraform output -raw n8n_url

n8n 会显示设置界面。输入电子邮件、名字、姓氏和密码,以创建所有者账户。完成或跳过问卷后即可进入工作区。

危险

立即保存加密密钥

n8n 只会生成一次加密密钥。没有它,每条已存储的凭据都将无法读取,而且没有人能替您恢复。在继续之前,运行 terraform output -raw n8n_encryption_key,并把该值存入密码管理器。

保护您的 Terraform state 文件

Terraform 会在项目文件夹中写入 terraform.tfstate 文件。它记录您的基础设施,并以明文存储密钥:n8n 加密密钥、数据库密码和许可证密钥。把输出标记为 sensitive 只会在终端中隐藏它,不会把它从 state 文件中移除。

请遵守两条规则:

  • 切勿把 terraform.tfstate 提交到版本控制。
  • 除了快速试用之外,请把 state 远程存放在 HCP Terraform 或 S3 存储桶中,并配置加密、版本控制、state 锁定和严格的访问控制。

清理

要拆除本示例创建的全部内容:

terraform destroy

出现提示时输入 yes,或加上 -auto-approve。

small 示例附带便于拆除的默认值,因此 terraform destroy 可以顺利运行:RDS 实例会跳过最终快照,S3 存储桶会强制销毁。在把这套配置提升到生产环境之前,请复查这些设置。生产值请参阅维护并拆除 AWS 部署。请注意,模块会把其 KMS 密钥安排在 destroy 之后 7 天删除,这会阻止从任何保留的快照中恢复。

相关资源

您的实例正在运行模块的默认值。接下来:

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。