zero-module.yml

name: zero-backend-node
description: 'Zero module for a backend service in Node.js running in Kubernetes'
author: 'Commit'
zeroVersion: '>= 0.2.1'
commands:
  check: sh scripts/check.sh

dependsOn:
- zero-aws-eks-stack

template:
  strictMode: true
  delimiters:
    - '<%'
    - '%>'
  inputDir: 'templates'
  outputDir: 'backend-service'

requiredCredentials:
  - aws
  - circleci
  - github

parameters:
  - field: backendApplicationHosting
    label: How do you want to host the backend of your application?
    info: "Kubernetes is more complex and expensive, but significantly more feature-rich. The serverless approach can be cheaper but is limited in tooling.\nWe recommend Kubernetes for all but the most simple applications. See why: https://whyk8s.getzero.dev"
    default: "kubernetes"
    options:
      "kubernetes": "Kubernetes using AWS EKS"
      "serverless": "(BETA) Serverless using AWS SAM/Lambda"
  - field: useExistingAwsProfile
    label: "Use credentials from an existing AWS profile?"
    info: "You can choose either a currently existing profile if you've already configured your AWS CLI, or manually enter a pair of AWS access keys."
    options:
      "yes": "Yes"
      "no": "No"
    omitFromProjectFile: yes
  - field: profilePicker
    omitFromProjectFile: yes
    type: AWSProfilePicker
    conditions:
    - action: KeyMatchCondition
      whenValue: "yes"
      matchField: useExistingAwsProfile
  - field: accessKeyId
    label: AWS AccessKeyId
    info: "AWS access is controlled by a pair of keys tied to a user account.\nhttps://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html "
    envVarName: "AWS_ACCESS_KEY_ID"
    conditions:
    - action: KeyMatchCondition
      whenValue: "no"
      matchField: useExistingAwsProfile
  - field: secretAccessKey
    envVarName: "AWS_SECRET_ACCESS_KEY"
    label: AWS SecretAccessKey
    info: "AWS access is controlled by a pair of keys tied to a user account.\nhttps://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html "
    conditions:
    - action: KeyMatchCondition
      whenValue: "no"
      matchField: useExistingAwsProfile
  - field: githubAccessToken
    label: "Github API Key to setup your repository and optionally CI/CD"
    info: "This API key will let us set up new repositories to check in your code.\nhttps://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token"
    envVarName: GITHUB_ACCESS_TOKEN
  - field: region
    label: Select AWS Region
    info: "This is the region your resources will be created in.\nMost regions have all the same features and functionality, but depending on your product you may need to choose a different region for data sovereignty reasons."
    options:
      "us-east-1": "us-east-1 - US East (N. Virginia)"
      "us-east-2": "us-east-2 - US East (Ohio)"
      "us-west-2": "us-west-2 - US West (Oregon)"
      "ca-central-1": "ca-central-1 - Canada (Central)"
      "eu-west-1": "eu-west-1 - Europe (Ireland)"
      "ap-southeast-1": "ap-southeast-1 - Asia Pacific (Singapore)"
  - field: productionHostRoot
    label: Production Root Host Name (e.g. mydomain.com)
    info: "This must be the root of the chosen domain, not a subdomain. You will also be prompted for the subdomains to use for your application."
    fieldValidation:
      type: regex
      value: '^([a-z0-9]+(-[a-z0-9]+)*\.{1})+[a-z]{2,}$'
      errorMessage: Invalid root domain name
  - field: productionFrontendSubdomain
    label: Production Frontend Host Name (e.g. app.)
    info: "The subdomain that will point to the static assets of your frontend hosted in Cloudfront."
    default: app.
    fieldValidation:
      type: regex
      value: '^([a-z0-9]+(-[a-z0-9]+)*\.)$'
      errorMessage: Invalid subdomain (cannot contain special chars & must end with a '.')
  - field: productionBackendSubdomain
    label: Production Backend Host Name (e.g. api.)
    info: "The subdomain that will point to the API of your backend running in Kubernetes."
    default: api.
    fieldValidation:
      type: regex
      value: '^([a-z0-9]+(-[a-z0-9]+)*\.)$'
      errorMessage: Invalid subdomain (cannot contain special chars & must end with a '.')
  - field: stagingHostRoot
    label: Staging Root Host Name (e.g. mydomain-staging.com)
    info: "This must be the root of the chosen domain, not a subdomain. You will also be prompted for the subdomains to use for your application.\nIt's recommended that you use different hostnames for staging and production instead of trying to have staging as a subdomain of your production domain."
    fieldValidation:
      type: regex
      value: '^([a-z0-9]+(-[a-z0-9]+)*\.{1})+[a-z]{2,}$'
      errorMessage: Invalid root domain name
  - field: stagingFrontendSubdomain
    label: Staging Frontend Host Name (e.g. app.)
    info: "The subdomain that will point to the static assets of your frontend hosted in Cloudfront."
    default: app.
    fieldValidation:
      type: regex
      value: '^([a-z0-9]+(-[a-z0-9]+)*\.)$'
      errorMessage: Invalid subdomain (cannot contain special chars & must end with a '.')
  - field: stagingBackendSubdomain
    label: Staging Backend Host Name (e.g. api.)
    info: "The subdomain that will point to the API of your backend running in Kubernetes."
    default: api.
    fieldValidation:
      type: regex
      value: '^([a-z0-9]+(-[a-z0-9]+)*\.)$'
      errorMessage: Invalid subdomain (cannot contain special chars & must end with a '.')
  - field: database
    label: Database engine to use
    info: "This will set up a database for you using RDS.\nIt will be accessible only by your application, credentials will be created automatically."
    options:
      "postgres": "PostgreSQL"
      "mysql": "MySQL"
  - field: accountId
    label: AWS Account ID
    execute: aws sts get-caller-identity --query "Account" | tr -d '"'
  - field: randomSeed
    label: Random seed that will be shared between projects to come up with deterministic resource names
    execute: uuidgen | head -c 8
  - field: databaseName
    execute: echo "$projectName"| sed "s/[- ]//g"
  - field: fileUploads
    label: Enable file uploads using S3 and Cloudfront signed URLs?
    info: "This will allow secure file uploads and downloads through your application.\nIt will require manual creation of a Cloudfront keypair in AWS. See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-trusted-signers.html"
    default: yes
    options:
      "yes": "Yes"
      "no": "No"
  - field: userAuth
    label: Enable user management and auth access proxy?
    info: "This will enable infrastructure and application code that uses Kratos for user management and the Oathkeeper access proxy.\nhttps://ory.sh"
    default: yes
    options:
      "yes": "Yes"
      "no": "No"
  - field: apiType
    label: Which type of API do you want to expose?
    info: "REST is the most popular way of making HTTP APIs.\nGraphQL is newer but has some benefits when dealing with certain data types. https://www.graphql.com/"
    default: rest
    options:
      "rest": "REST API"
      "graphql": "GraphQL"
  - field: CIVendor
    label: Which CI vendor would you like to use?
    info: "Build pipelines will be set up which will deploy your code to your infrastructure whenever PRs are merged to the main branch."
    default: "circleci"
    options:
      "circleci": "CircleCI"
      "github-actions": "Github Actions"
  - field: circleciApiKey
    label: "CircleCI API Key"
    info: "This will let us configure your CircleCI account to automatically enable CI for these newly created projects.\nhttps://circleci.com/docs/2.0/managing-api-tokens/"
    envVarName: CIRCLECI_API_KEY
    conditions:
    - action: KeyMatchCondition
      matchField: CIVendor
      whenValue: "circleci"
  - field: billingEnabled
    label: "Enable billing support?"
    info: "Provides a subscription example using stripe in the backend and frontend repositories."
    options:
      "yes": "Yes"
      "no": "No"
  - field: stagingStripePublicApiKey
    label: "Staging Stripe public api key"
    info: "Used for the frontend repository. It's recommended to use a sandbox key while getting set up."
    conditions:
    - action: KeyMatchCondition
      matchField: billingEnabled
      whenValue: "yes"
  - field: stagingStripeSecretApiKey
    label: "Staging Stripe secret api key"
    info: "Used for the backend repository. It's recommended to use a sandbox key while getting set up."
    conditions:
    - action: KeyMatchCondition
      matchField: billingEnabled
      whenValue: "yes"
  - field: productionStripePublicApiKey
    label: "Production Stripe public api key"
    info: "Used for the frontend repository. It's recommended to use a sandbox key while getting set up."
    conditions:
    - action: KeyMatchCondition
      matchField: billingEnabled
      whenValue: "yes"
  - field: productionStripeSecretApiKey
    label: "Production Stripe secret api key"
    info: "Used for the backend repository. It's recommended to use a sandbox key while getting set up."
    conditions:
    - action: KeyMatchCondition
      matchField: billingEnabled
      whenValue: "yes"
  - field: cacheStore
    label: "Whether to use cacheStore"
    info: "Options of cache store include Redis/Memcached"
    options:
      "none": "none"
      "memcached": "Memcached"
      "redis": "Redis"
conditions:
  - action: ignoreFile
    matchField: fileUploads
    whenValue: "no"
    data:
    - src/app/file
  - action: ignoreFile
    matchField: userAuth
    whenValue: "no"
    data:
    - src/middleware/auth
    - src/app/auth
    - src/mockauth.js
    - kubernetes/base/auth.yml
    - kubernetes/overlays/staging/auth.yml
    - kubernetes/overlays/production/auth.yml
  - action: ignoreFile
    matchField: apiType
    whenValue: "rest"
    data:
    - src/graphql
    - src/graphql.js
    - src/db/model/Trip.js
    - src/service/trip.js
  - action: ignoreFile
    matchField: apiType
    whenValue: "graphql"
    data:
    - src/app
    - src/app.js
  - action: ignoreFile
    matchField: CIVendor
    whenValue: "circleci"
    data:
    - .github/
  - action: ignoreFile
    matchField: CIVendor
    whenValue: "github-actions"
    data:
    - .circleci/
  - action: ignoreFile
    matchField: billingEnabled
    whenValue: "no"
    data:
    - src/app/billing
    - scripts/stripe-example-setup.sh
  - action: ignoreFile
    matchField: backendApplicationHosting
    whenValue: "kubernetes"
    data:
    - auth
    - .github/workflows/sam.yml
    - config.toml
    - template.yaml
    - Dockerfile.sam