n8n IaC

Infrastructure as code for Studion's self-hosted n8n, built with infra-code-blocks. Originally intended for n8n instances under the *.n8n.gostudion.com domain, but can be easily customized for others as well.

Requierments

• Pulumi account (can be avoided for testing or prototyping by using the local backend)
• Set of AWS credentials with privilege to manage target resources

Usage

• Checkout the code

git clone [email protected]:ExtensionEngine/n8n-infra.git

• Install dependencies

pnpm i

• Install Pulumi

# macOS
brew install pulumi/tap/pulumi

# Linux
curl -fsSL https://get.pulumi.com | sh

• Log in to Pulumi account, see https://www.pulumi.com/docs/iac/concepts/state-and-backends/
• Install AWS CLI

# macOS
brew install awscli

# Linux
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install

• Set up AWS CLI, see https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
• Set up n8n environment using AWS Parameter Store on the target AWS Account by:
  • Defining plain parameters using hierarchy and configuring n8n:envPath on the stack level:
    • N8N_LOG_LEVEL - one of debug, info, warn, error
    • N8N_SMTP_HOST - SMTP server name
    • N8N_SMTP_PORT - use STARTTLS port, e.g. 587, since SSL for SMTP is disabled
    • N8N_SMTP_USER - SMTP username
    • N8N_SMTP_SENDER - sender email address, e.g. [email protected]
    • N8N_EDITOR_BASE_URL - URL to access the instance, e.g. https://dev.n8n.gostudion.com/
    • WEBHOOK_URL - URL for webhooks with external services, e.g. https://dev.n8n.gostudion.com/
  • Defining secret parameter using hierarchy and configuring n8n:secretsPath on the stack level:
    • N8N_SMTP_PASS - SMTP password
• Create a new stack for a custom use case

pulumi stack init <custom-stack-name>

• To list stacks and select a default stack to operate on

# List stacks
pulumi stack ls

# Select a default stack to operate on, i.e. choose an active stack
pulumi stack select <custom-stack-name>

• Deploy stack

pulumi up

# Optionally provide stack to operate on if you want to use non-active stack
pulumi up -s <custom-stack-name>

# Optionally provide `AWS_PROFILE` env if you want to use non-default AWS profile
AWS_PROFILE=n8n.dev pulumi up