├── infra ├── module │ ├── vpc │ │ ├── data.tf │ │ ├── vars.tf │ │ ├── outputs.tf │ │ └── main.tf │ ├── autoscale │ │ ├── outputs.tf │ │ ├── config │ │ │ └── init.yaml │ │ ├── data.tf │ │ ├── vars.tf │ │ ├── security.tf │ │ └── autoscale.tf │ ├── alb │ │ ├── vars.tf │ │ ├── security.tf │ │ └── loadbalancer.tf │ └── rds │ │ ├── outputs.tf │ │ ├── vars.tf │ │ ├── security.tf │ │ └── main.tf └── global-config │ └── kms_sops │ ├── outputs.tf │ ├── data.tf │ ├── vars.tf │ ├── main.tf │ └── policy.tf ├── images ├── aws.png ├── role.png ├── github.png ├── role2.png ├── identity.png └── github_oidc.png ├── terragrunt ├── dev │ └── us-east-1 │ │ ├── autoscale │ │ ├── config │ │ │ └── init.yaml │ │ └── terragrunt.hcl │ │ ├── env.yaml │ │ ├── alb │ │ └── terragrunt.hcl │ │ ├── vpc │ │ └── terragrunt.hcl │ │ └── rds │ │ └── terragrunt.hcl ├── prod │ └── cn-northwest-1 │ │ ├── env.yaml │ │ ├── alb │ │ └── terragrunt.hcl │ │ ├── autoscale │ │ └── terragrunt.hcl │ │ ├── vpc │ │ └── terragrunt.hcl │ │ └── rds │ │ └── terragrunt.hcl ├── kms-sops │ ├── us-east-1 │ │ ├── env.yaml │ │ └── kms_sops │ │ │ └── terragrunt.hcl │ └── cn-northwest-1 │ │ ├── env.yaml │ │ └── kms_sops │ │ └── terragrunt.hcl ├── stage │ └── ap-southeast-1 │ │ ├── env.yaml │ │ ├── vpc │ │ └── terragrunt.hcl │ │ └── rds │ │ └── terragrunt.hcl ├── common │ ├── vpc.hcl │ ├── rds.hcl │ ├── alb.hcl │ └── autoscale.hcl ├── .sops.yaml ├── terragrunt.hcl ├── secrets.china.yaml └── secrets.global.yaml ├── renovate.json ├── .github ├── workflows │ ├── production-terrascan.yaml │ ├── production-checkov.yaml │ ├── production-tfsec.yaml │ ├── production-terragrunt.yaml │ └── pull-request.yaml └── action │ ├── checkov-action │ └── action.yaml │ ├── terrascan-action │ └── action.yaml │ ├── tfsec-action │ └── action.yaml │ ├── terragrunt-action │ └── action.yaml │ └── infracost-action │ └── action.yaml ├── makefile ├── .gitignore ├── README.md └── LICENSE /infra/module/vpc/data.tf: -------------------------------------------------------------------------------- 1 | data "aws_availability_zones" "current_zones" {} -------------------------------------------------------------------------------- /infra/global-config/kms_sops/outputs.tf: -------------------------------------------------------------------------------- 1 | output "kms_arn" { 2 | value = aws_kms_key.key.arn 3 | } -------------------------------------------------------------------------------- /infra/global-config/kms_sops/data.tf: -------------------------------------------------------------------------------- 1 | data "aws_caller_identity" "current" {} 2 | data "aws_partition" "current" {} -------------------------------------------------------------------------------- /images/aws.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/startuplcoud/infra-multi-account-region-startup-kit/HEAD/images/aws.png -------------------------------------------------------------------------------- /images/role.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/startuplcoud/infra-multi-account-region-startup-kit/HEAD/images/role.png -------------------------------------------------------------------------------- /images/github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/startuplcoud/infra-multi-account-region-startup-kit/HEAD/images/github.png -------------------------------------------------------------------------------- /images/role2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/startuplcoud/infra-multi-account-region-startup-kit/HEAD/images/role2.png -------------------------------------------------------------------------------- /images/identity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/startuplcoud/infra-multi-account-region-startup-kit/HEAD/images/identity.png -------------------------------------------------------------------------------- /infra/module/vpc/vars.tf: -------------------------------------------------------------------------------- 1 | variable "vpc_cidr" { 2 | type = string 3 | } 4 | 5 | variable "vpc_name" { 6 | type = string 7 | } -------------------------------------------------------------------------------- /images/github_oidc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/startuplcoud/infra-multi-account-region-startup-kit/HEAD/images/github_oidc.png -------------------------------------------------------------------------------- /infra/module/autoscale/outputs.tf: -------------------------------------------------------------------------------- 1 | output "autoscaling_group_name" { 2 | value = aws_autoscaling_group.autoscaling_group.name 3 | } -------------------------------------------------------------------------------- /terragrunt/dev/us-east-1/autoscale/config/init.yaml: -------------------------------------------------------------------------------- 1 | #cloud-config 2 | packages: 3 | - nginx 4 | runcmd: 5 | - systemctl start nginx -------------------------------------------------------------------------------- /terragrunt/dev/us-east-1/env.yaml: -------------------------------------------------------------------------------- 1 | aws_region: us-east-1 2 | account_id: 733051034790 3 | environment: dev 4 | project: startupcloud-kit 5 | -------------------------------------------------------------------------------- /terragrunt/prod/cn-northwest-1/env.yaml: -------------------------------------------------------------------------------- 1 | aws_region: cn-north-1 2 | environment: prod 3 | project: startupcloud-kit 4 | account_id: 527109613237 -------------------------------------------------------------------------------- /infra/module/autoscale/config/init.yaml: -------------------------------------------------------------------------------- 1 | #cloud-config 2 | package_update: true 3 | package_upgrade: true 4 | package_reboot_if_required: true 5 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:base" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /terragrunt/kms-sops/us-east-1/env.yaml: -------------------------------------------------------------------------------- 1 | aws_region: us-east-1 2 | account_id: 733051034790 3 | environment: global 4 | project: startupkit-kms 5 | -------------------------------------------------------------------------------- /terragrunt/kms-sops/cn-northwest-1/env.yaml: -------------------------------------------------------------------------------- 1 | aws_region: cn-northwest-1 2 | environment: china-kms 3 | project: startupkit-kms 4 | account_id: 527109613237 -------------------------------------------------------------------------------- /terragrunt/stage/ap-southeast-1/env.yaml: -------------------------------------------------------------------------------- 1 | aws_region: ap-southeast-1 2 | account_id: 594962198840 3 | environment: stage 4 | project: startupcloud-kit 5 | -------------------------------------------------------------------------------- /terragrunt/dev/us-east-1/alb/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | include "common" { 6 | path = "${dirname(find_in_parent_folders())}/common/alb.hcl" 7 | expose = true 8 | } 9 | -------------------------------------------------------------------------------- /terragrunt/dev/us-east-1/vpc/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | include "common" { 6 | path = "${dirname(find_in_parent_folders())}/common/vpc.hcl" 7 | expose = true 8 | } 9 | -------------------------------------------------------------------------------- /terragrunt/prod/cn-northwest-1/alb/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | include "common" { 6 | path = "${dirname(find_in_parent_folders())}/common/alb.hcl" 7 | expose = true 8 | } 9 | -------------------------------------------------------------------------------- /infra/module/alb/vars.tf: -------------------------------------------------------------------------------- 1 | variable "vpc_id" { 2 | type = string 3 | } 4 | 5 | variable "service_name" { 6 | type = string 7 | } 8 | 9 | variable "load_balancer_subnets" { 10 | type = list(string) 11 | } 12 | 13 | variable "target_port" { 14 | type = number 15 | } 16 | 17 | variable "autoscaling_group_name" { 18 | type = string 19 | } -------------------------------------------------------------------------------- /terragrunt/common/vpc.hcl: -------------------------------------------------------------------------------- 1 | terraform { 2 | source = "../../../..//infra/module/vpc" 3 | extra_arguments "common_vars" { 4 | commands = get_terraform_commands_that_need_vars() 5 | } 6 | } 7 | 8 | locals { 9 | vpc_cidr = "10.0.0.0/16" 10 | vpc_name = "startupcloud" 11 | } 12 | 13 | inputs = { 14 | vpc_cidr = local.vpc_cidr 15 | vpc_name = local.vpc_name 16 | } -------------------------------------------------------------------------------- /terragrunt/prod/cn-northwest-1/autoscale/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | include "common" { 6 | path = "${dirname(find_in_parent_folders())}/common/autoscale.hcl" 7 | expose = true 8 | } 9 | 10 | locals { 11 | ami_owner_id = "837727238323" 12 | } 13 | 14 | inputs = { 15 | ami_owner_id = local.ami_owner_id 16 | } 17 | -------------------------------------------------------------------------------- /infra/global-config/kms_sops/vars.tf: -------------------------------------------------------------------------------- 1 | variable "key_alias" { 2 | type = string 3 | default = "terragrunt" 4 | } 5 | 6 | variable "multi_region" { 7 | type = bool 8 | default = true 9 | } 10 | 11 | variable "role_arn_list" { 12 | type = list(string) 13 | default = [] 14 | } 15 | 16 | variable "user_arn_list" { 17 | type = list(string) 18 | default = [] 19 | } -------------------------------------------------------------------------------- /infra/module/autoscale/data.tf: -------------------------------------------------------------------------------- 1 | data "aws_availability_zones" "zones" {} 2 | 3 | data "aws_ami" "ubuntu" { 4 | owners = [var.ami_owner_id] 5 | most_recent = true 6 | filter { 7 | name = "name" 8 | values = ["ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-arm64-server-*"] 9 | } 10 | filter { 11 | name = "virtualization-type" 12 | values = ["hvm"] 13 | } 14 | } 15 | 16 | -------------------------------------------------------------------------------- /terragrunt/stage/ap-southeast-1/vpc/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | include "common" { 6 | path = "${dirname(find_in_parent_folders())}/common/vpc.hcl" 7 | expose = true 8 | } 9 | 10 | locals { 11 | vpc_cidr = "12.0.0.0/16" 12 | vpc_name = "startupcloud-stage" 13 | } 14 | 15 | inputs = { 16 | vpc_cidr = local.vpc_cidr 17 | vpc_name = local.vpc_name 18 | } -------------------------------------------------------------------------------- /terragrunt/prod/cn-northwest-1/vpc/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | include "common" { 6 | path = "${dirname(find_in_parent_folders())}/common/vpc.hcl" 7 | expose = true 8 | } 9 | 10 | 11 | locals { 12 | vpc_cidr = "11.0.0.0/16" 13 | vpc_name = "startupcloud-cn" 14 | } 15 | 16 | inputs = { 17 | vpc_cidr = local.vpc_cidr 18 | vpc_name = local.vpc_name 19 | } 20 | -------------------------------------------------------------------------------- /infra/module/vpc/outputs.tf: -------------------------------------------------------------------------------- 1 | output "private_subnet_ids" { 2 | value = module.vpc.private_subnets 3 | } 4 | 5 | output "public_subnet_ids" { 6 | value = module.vpc.public_subnets 7 | } 8 | 9 | output "default_vpc_security_group_id" { 10 | value = module.vpc.default_security_group_id 11 | } 12 | 13 | output "vpc_id" { 14 | value = module.vpc.vpc_id 15 | } 16 | 17 | output "vpc_cidr_block" { 18 | value = module.vpc.vpc_cidr_block 19 | } -------------------------------------------------------------------------------- /infra/global-config/kms_sops/main.tf: -------------------------------------------------------------------------------- 1 | resource "aws_kms_key" "key" { 2 | multi_region = var.multi_region 3 | key_usage = "ENCRYPT_DECRYPT" 4 | customer_master_key_spec = "SYMMETRIC_DEFAULT" 5 | deletion_window_in_days = 7 6 | policy = data.aws_iam_policy_document.policy.json 7 | } 8 | 9 | 10 | resource "aws_kms_alias" "alias" { 11 | target_key_id = aws_kms_key.key.key_id 12 | name = "alias/${var.key_alias}" 13 | } -------------------------------------------------------------------------------- /terragrunt/dev/us-east-1/rds/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | locals { 6 | secrets = yamldecode(sops_decrypt_file("${dirname(find_in_parent_folders())}/secrets.global.yaml"))["dev"]["us-east-1"] 7 | db_password = local.secrets["db_password"] 8 | } 9 | 10 | include "common" { 11 | path = "${dirname(find_in_parent_folders())}/common/rds.hcl" 12 | expose = true 13 | } 14 | 15 | inputs = { 16 | password = local.db_password 17 | } -------------------------------------------------------------------------------- /terragrunt/prod/cn-northwest-1/rds/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | include "common" { 6 | path = "${dirname(find_in_parent_folders())}/common/rds.hcl" 7 | expose = true 8 | } 9 | 10 | locals { 11 | secrets = yamldecode(sops_decrypt_file("${dirname(find_in_parent_folders())}/secrets.china.yaml"))["prod"]["cn-northwest-1"] 12 | db_password = local.secrets["db_password"] 13 | } 14 | 15 | inputs = { 16 | password = local.db_password 17 | } -------------------------------------------------------------------------------- /terragrunt/stage/ap-southeast-1/rds/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | locals { 6 | secrets = yamldecode(sops_decrypt_file("${dirname(find_in_parent_folders())}/secrets.global.yaml"))["stage"]["ap-southeast-1"] 7 | db_password = local.secrets["db_password"] 8 | } 9 | 10 | include "common" { 11 | path = "${dirname(find_in_parent_folders())}/common/rds.hcl" 12 | expose = true 13 | } 14 | 15 | inputs = { 16 | password = local.db_password 17 | } -------------------------------------------------------------------------------- /infra/module/rds/outputs.tf: -------------------------------------------------------------------------------- 1 | output "db_password" { 2 | value = module.postgres.db_instance_password 3 | sensitive = true 4 | } 5 | 6 | output "db_uri" { 7 | value = module.postgres.db_instance_address 8 | } 9 | 10 | output "db_username" { 11 | value = module.postgres.db_instance_username 12 | sensitive = true 13 | } 14 | 15 | output "db_database_name" { 16 | value = module.postgres.db_instance_name 17 | } 18 | 19 | output "db_port" { 20 | value = module.postgres.db_instance_port 21 | } 22 | -------------------------------------------------------------------------------- /infra/module/rds/vars.tf: -------------------------------------------------------------------------------- 1 | variable "instance_class" { 2 | type = string 3 | default = "db.t4g.micro" 4 | } 5 | 6 | variable "vpc_id" { 7 | type = string 8 | } 9 | 10 | variable "security_cidr_blocks" { 11 | type = string 12 | } 13 | 14 | variable "subnet_ids" { 15 | type = list(string) 16 | } 17 | 18 | variable "db_name" { 19 | type = string 20 | } 21 | 22 | variable "identifier" { 23 | type = string 24 | } 25 | 26 | variable "username" { 27 | type = string 28 | } 29 | 30 | variable "password" { 31 | type = string 32 | } -------------------------------------------------------------------------------- /terragrunt/kms-sops/cn-northwest-1/kms_sops/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | terraform { 6 | source = "../../../..//infra/global-config/kms_sops" 7 | extra_arguments "common_vars" { 8 | commands = get_terraform_commands_that_need_vars() 9 | } 10 | } 11 | 12 | locals { 13 | role_arn_list = [ 14 | "arn:aws-cn:iam::527109613237:role/terragrunt" 15 | ] 16 | } 17 | 18 | inputs = { 19 | multi_region = false 20 | key_alias = "terragrunt-startup" 21 | role_arn_list = local.role_arn_list 22 | } 23 | -------------------------------------------------------------------------------- /terragrunt/.sops.yaml: -------------------------------------------------------------------------------- 1 | creation_rules: 2 | - path_regex: \.global\.yaml$ 3 | # aws kms key global region 4 | # aws iam user/terragrunt role have the kms key permission 5 | kms: 'arn:aws:kms:us-east-1:733051034790:key/mrk-5d09ec752c914b6392427f6c52d96bab' 6 | # aws_profile: terragrunt 7 | pgp: '01D0D800C76AC893E74990B44BB1CE513349E336' 8 | 9 | # aws china region 10 | - path_regex: \.china\.yaml$ 11 | # aws_profile: wwc 12 | kms: 'arn:aws-cn:kms:cn-northwest-1:527109613237:key/d315eb9b-99a3-446b-b105-fd0126d10b0e' 13 | pgp: '01D0D800C76AC893E74990B44BB1CE513349E336' -------------------------------------------------------------------------------- /.github/workflows/production-terrascan.yaml: -------------------------------------------------------------------------------- 1 | name: 'Terrascan Check' 2 | on: 3 | push: 4 | branches: 5 | - main 6 | paths-ignore: 7 | - makefile 8 | - images/* 9 | - README.md 10 | jobs: 11 | terrascan-action: 12 | name: Terrascan 13 | runs-on: ubuntu-latest 14 | continue-on-error: true 15 | permissions: 16 | security-events: write 17 | actions: read 18 | contents: read 19 | steps: 20 | - name: Checkout repo 21 | uses: actions/checkout@v3 22 | - name: Terrascan terraform modules 23 | uses: ./.github/action/terrascan-action 24 | -------------------------------------------------------------------------------- /infra/module/rds/security.tf: -------------------------------------------------------------------------------- 1 | module "security_group" { 2 | source = "terraform-aws-modules/security-group/aws" 3 | name = "${var.identifier}-rds-security-group" 4 | description = "PostgreSQL security group" 5 | vpc_id = var.vpc_id 6 | use_name_prefix = false 7 | 8 | # ingress 9 | ingress_with_cidr_blocks = [ 10 | { 11 | from_port = 5432 12 | to_port = 5432 13 | protocol = "tcp" 14 | description = "PostgreSQL access from within VPC" 15 | cidr_blocks = var.security_cidr_blocks 16 | }, 17 | ] 18 | egress_rules = ["all-all"] 19 | } -------------------------------------------------------------------------------- /terragrunt/kms-sops/us-east-1/kms_sops/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | terraform { 6 | source = "../../../..//infra/global-config/kms_sops" 7 | extra_arguments "common_vars" { 8 | commands = get_terraform_commands_that_need_vars() 9 | } 10 | } 11 | 12 | locals { 13 | role_arn_list = [ 14 | "arn:aws:iam::594962198840:role/terragrunt" 15 | ] 16 | user_arn_list = [ 17 | "arn:aws:iam::733051034790:user/admin" 18 | ] 19 | } 20 | 21 | inputs = { 22 | key_alias = "terragrunt-startup" 23 | role_arn_list = local.role_arn_list 24 | user_arn_list = local.user_arn_list 25 | } -------------------------------------------------------------------------------- /.github/workflows/production-checkov.yaml: -------------------------------------------------------------------------------- 1 | name: 'checkov' 2 | on: 3 | push: 4 | branches: 5 | - main 6 | paths-ignore: 7 | - makefile 8 | - images/* 9 | - README.md 10 | 11 | jobs: 12 | checkov-action: 13 | name: checkov scan terraform modules 14 | runs-on: ubuntu-latest 15 | continue-on-error: true 16 | permissions: 17 | security-events: write 18 | contents: read 19 | actions: read 20 | id-token: write 21 | steps: 22 | - name: Checkout repo 23 | uses: actions/checkout@v3 24 | - name: checkov scan terraform modules 25 | uses: ./.github/action/checkov-action 26 | 27 | -------------------------------------------------------------------------------- /.github/action/checkov-action/action.yaml: -------------------------------------------------------------------------------- 1 | name: "checkov check the terraform modules" 2 | description: checkov init and check terraform modules 3 | 4 | runs: 5 | using: "composite" 6 | steps: 7 | - name: Run checkov action 8 | # https://github.com/bridgecrewio/checkov-action 9 | uses: bridgecrewio/checkov-action@master 10 | continue-on-error: true 11 | with: 12 | directory: infra/module 13 | framework: terraform 14 | container_user: 1000 15 | 16 | - name: Upload SARIF file 17 | uses: github/codeql-action/upload-sarif@v2 18 | with: 19 | sarif_file: results.sarif 20 | category: checkov 21 | 22 | -------------------------------------------------------------------------------- /infra/module/autoscale/vars.tf: -------------------------------------------------------------------------------- 1 | variable "ami_owner_id" { 2 | type = string 3 | default = "099720109477" 4 | } 5 | 6 | variable "instance_type" { 7 | type = string 8 | default = "t4g.small" 9 | } 10 | 11 | variable "user_data" { 12 | type = map(string) 13 | default = {} 14 | } 15 | 16 | variable "vpc_id" { 17 | type = string 18 | } 19 | 20 | variable "ssh_key" { 21 | type = string 22 | } 23 | 24 | variable "autoscaling_name" { 25 | type = string 26 | } 27 | 28 | variable "private_subnets" { 29 | type = list(string) 30 | } 31 | 32 | variable "instance_port" { 33 | type = string 34 | } 35 | 36 | variable "vpc_security_group_id" { 37 | type = string 38 | } 39 | 40 | -------------------------------------------------------------------------------- /.github/workflows/production-tfsec.yaml: -------------------------------------------------------------------------------- 1 | name: 'tfsec Check' 2 | on: 3 | push: 4 | branches: 5 | - main 6 | paths-ignore: 7 | - makefile 8 | - images/* 9 | - README.md 10 | jobs: 11 | tfsec-action: 12 | name: tfsec check terraform modules 13 | runs-on: ubuntu-latest 14 | continue-on-error: true 15 | permissions: 16 | security-events: write 17 | actions: read 18 | contents: read 19 | steps: 20 | - name: Checkout repo 21 | uses: actions/checkout@v3 22 | 23 | - name: tfsec check terraform modules 24 | uses: ./.github/action/tfsec-action 25 | with: 26 | working_directory: "./infra/module" 27 | -------------------------------------------------------------------------------- /.github/action/terrascan-action/action.yaml: -------------------------------------------------------------------------------- 1 | name: "terrascan check the terraform module" 2 | description: terrascan init and check 3 | 4 | runs: 5 | using: "composite" 6 | steps: 7 | - name: setup terrascan 8 | # https://github.com/tenable/terrascan-action 9 | uses: tenable/terrascan-action@main 10 | with: 11 | iac_type: 'terraform' 12 | iac_version: 'v14' 13 | policy_type: 'aws' 14 | only_warn: true 15 | iac_dir: "./infra/module" 16 | sarif_upload: true 17 | 18 | - name: Upload SARIF file 19 | uses: github/codeql-action/upload-sarif@v2 20 | with: 21 | sarif_file: terrascan.sarif 22 | category: terrascan 23 | -------------------------------------------------------------------------------- /infra/module/autoscale/security.tf: -------------------------------------------------------------------------------- 1 | module "load_balancer_security" { 2 | source = "terraform-aws-modules/security-group/aws" 3 | version = "4.17.1" 4 | name = "${var.autoscaling_name}-load-balancer-group" 5 | description = "${var.autoscaling_name} load balancer security group" 6 | vpc_id = var.vpc_id 7 | use_name_prefix = false 8 | 9 | ingress_with_source_security_group_id = [ 10 | { 11 | from_port = var.instance_port 12 | to_port = var.instance_port 13 | protocol = "tcp" 14 | source_security_group_id = var.vpc_security_group_id 15 | } 16 | ] 17 | egress_rules = ["all-all"] 18 | } -------------------------------------------------------------------------------- /.github/action/tfsec-action/action.yaml: -------------------------------------------------------------------------------- 1 | name: "tfsec check the terraform module" 2 | description: tfsec init and check 3 | inputs: 4 | working_directory: 5 | required: false 6 | default: "." 7 | description: "terraform directory" 8 | 9 | runs: 10 | using: "composite" 11 | steps: 12 | - name: setup tfsec 13 | # https://github.com/aquasecurity/tfsec-action 14 | 15 | uses: aquasecurity/tfsec-sarif-action@v0.1.4 16 | with: 17 | sarif_file: tfsec.sarif 18 | working_directory: ${{ inputs.working_directory }} 19 | 20 | - name: Upload SARIF file 21 | uses: github/codeql-action/upload-sarif@v2 22 | with: 23 | sarif_file: tfsec.sarif 24 | category: tfsec 25 | -------------------------------------------------------------------------------- /infra/module/alb/security.tf: -------------------------------------------------------------------------------- 1 | module "load_balancer_security" { 2 | source = "terraform-aws-modules/security-group/aws" 3 | version = "4.17.1" 4 | name = "${var.service_name}-load-balancer-group" 5 | description = "${var.service_name} load balancer security group" 6 | vpc_id = var.vpc_id 7 | use_name_prefix = false 8 | ingress_with_cidr_blocks = [ 9 | { 10 | from_port = 80 11 | to_port = 80 12 | protocol = "tcp" 13 | cidr_blocks = "0.0.0.0/0" 14 | }, 15 | { 16 | from_port = 443 17 | to_port = 443 18 | protocol = "tcp" 19 | cidr_blocks = "0.0.0.0/0" 20 | } 21 | ] 22 | egress_rules = ["all-all"] 23 | } -------------------------------------------------------------------------------- /terragrunt/dev/us-east-1/autoscale/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | include { 2 | path = find_in_parent_folders() 3 | } 4 | 5 | include "common" { 6 | path = "${dirname(find_in_parent_folders())}/common/autoscale.hcl" 7 | expose = true 8 | } 9 | 10 | terraform { 11 | source = "../../../..//infra/module/autoscale" 12 | extra_arguments "common_vars" { 13 | commands = get_terraform_commands_that_need_vars() 14 | } 15 | before_hook "cloud-init" { 16 | commands = ["apply", "plan"] 17 | execute = ["cp", "${get_original_terragrunt_dir()}/config/init.yaml", "./config/init.yaml"] 18 | run_on_error = false 19 | } 20 | } 21 | 22 | 23 | locals { 24 | ami_owner_id = "099720109477" 25 | } 26 | 27 | inputs = { 28 | ami_owner_id = local.ami_owner_id 29 | } 30 | -------------------------------------------------------------------------------- /infra/module/vpc/main.tf: -------------------------------------------------------------------------------- 1 | module "vpc" { 2 | source = "terraform-aws-modules/vpc/aws" 3 | version = "4.0.1" 4 | cidr = var.vpc_cidr 5 | azs = data.aws_availability_zones.current_zones.names 6 | 7 | public_subnets = [ 8 | for num in range(length(data.aws_availability_zones.current_zones.names)) : 9 | cidrsubnet(var.vpc_cidr, 8, num + length(data.aws_availability_zones.current_zones.names) + 1) 10 | /// //10.0.3.0/24,10.0.4.0/24,10.0.5.0/24 11 | ] 12 | 13 | private_subnets = [ 14 | for num in range(length(data.aws_availability_zones.current_zones.names)) : 15 | cidrsubnet(var.vpc_cidr, 8, num) 16 | /// // 10.0.0.0/24, 10.0.1.0/24,10.0.2.0/24 17 | ] 18 | public_subnet_tags = { 19 | Tier = "public" 20 | } 21 | private_subnet_tags = { 22 | Tier = "private" 23 | } 24 | 25 | enable_dns_hostnames = true 26 | enable_dns_support = true 27 | 28 | enable_nat_gateway = true 29 | single_nat_gateway = true 30 | 31 | } -------------------------------------------------------------------------------- /terragrunt/common/rds.hcl: -------------------------------------------------------------------------------- 1 | terraform { 2 | source = "../../../..//infra/module/rds" 3 | extra_arguments "common_vars" { 4 | commands = get_terraform_commands_that_need_vars() 5 | } 6 | } 7 | 8 | dependency "vpc" { 9 | config_path = "${get_original_terragrunt_dir()}/..//vpc" 10 | mock_outputs = { 11 | private_subnet_ids = ["ssss", "sssss"] 12 | vpc_id = "xxxxxx" 13 | default_vpc_security_group_id = "xxxxx" 14 | vpc_cidr_block = "10.1.0.0/16" 15 | } 16 | } 17 | 18 | locals { 19 | db_name = "test" 20 | identifier = "test" 21 | username = "postgres" 22 | } 23 | 24 | inputs = { 25 | vpc_id = dependency.vpc.outputs.vpc_id 26 | security_cidr_blocks = dependency.vpc.outputs.vpc_cidr_block 27 | subnet_ids = dependency.vpc.outputs.private_subnet_ids 28 | username = local.username 29 | db_name = local.db_name 30 | identifier = local.identifier 31 | } -------------------------------------------------------------------------------- /terragrunt/common/alb.hcl: -------------------------------------------------------------------------------- 1 | terraform { 2 | source = "../../../..//infra/module/alb" 3 | extra_arguments "common_vars" { 4 | commands = get_terraform_commands_that_need_vars() 5 | } 6 | } 7 | 8 | dependency "vpc" { 9 | config_path = "${get_original_terragrunt_dir()}/..//vpc" 10 | mock_outputs = { 11 | public_subnet_ids = ["ssss", "sssss"] 12 | vpc_id = "xxxxxx" 13 | } 14 | } 15 | 16 | dependency "autoscale" { 17 | config_path = "${get_original_terragrunt_dir()}/..//autoscale" 18 | mock_outputs = { 19 | autoscaling_group_name = "xxxx" 20 | } 21 | } 22 | 23 | locals { 24 | target_port = 80 25 | service_name = "nginx" 26 | } 27 | 28 | inputs = { 29 | service_name = local.service_name 30 | target_port = local.target_port 31 | vpc_id = dependency.vpc.outputs.vpc_id 32 | load_balancer_subnets = dependency.vpc.outputs.public_subnet_ids 33 | autoscaling_group_name = dependency.autoscale.outputs.autoscaling_group_name 34 | } -------------------------------------------------------------------------------- /terragrunt/common/autoscale.hcl: -------------------------------------------------------------------------------- 1 | terraform { 2 | source = "../../../..//infra/module/autoscale" 3 | extra_arguments "common_vars" { 4 | commands = get_terraform_commands_that_need_vars() 5 | } 6 | } 7 | 8 | dependency "vpc" { 9 | config_path = "${get_original_terragrunt_dir()}/..//vpc" 10 | mock_outputs = { 11 | private_subnet_ids = ["ssss", "sssss"] 12 | vpc_id = "xxxxxx" 13 | default_vpc_security_group_id = "xxxxx" 14 | } 15 | } 16 | 17 | dependencies { 18 | paths = [ 19 | "${get_original_terragrunt_dir()}/..//vpc", 20 | "${get_original_terragrunt_dir()}/..//rds" 21 | ] 22 | } 23 | 24 | 25 | locals { 26 | port = 80 27 | ssh_key = "startupcloud" 28 | name = "startupcloud" 29 | } 30 | 31 | inputs = { 32 | ssh_key = local.ssh_key 33 | instance_port = local.port 34 | autoscaling_name = local.name 35 | vpc_id = dependency.vpc.outputs.vpc_id 36 | private_subnets = dependency.vpc.outputs.private_subnet_ids 37 | vpc_security_group_id = dependency.vpc.outputs.default_vpc_security_group_id 38 | } 39 | -------------------------------------------------------------------------------- /terragrunt/terragrunt.hcl: -------------------------------------------------------------------------------- 1 | locals { 2 | env_vars = yamldecode(file("${find_in_parent_folders("env.yaml")}")) 3 | aws_region = local.env_vars["aws_region"] 4 | project_name = local.env_vars["project"] 5 | account_id = local.env_vars["account_id"] 6 | environment = local.env_vars["environment"] 7 | } 8 | 9 | generate "providers" { 10 | path = "providers.tf" 11 | if_exists = "overwrite_terragrunt" 12 | contents = < $dir/plan.json 83 | planjsons=(${planjsons[@]} "$dir/plan.json") 84 | done 85 | 86 | # Sort the plan JSONs so we get consistent project ordering in the config file 87 | IFS=$'\n' planjsons=($(sort <<<"${planjsons[*]}")) 88 | 89 | # Generate Infracost config file 90 | echo -e "version: 0.1\n\nprojects:\n" > infracost-generated.yml 91 | for planjson in "${planjsons[@]}"; do 92 | echo -e " - path: $planjson" >> infracost-generated.yml 93 | done 94 | 95 | # Infracost CLI commands 96 | infracost breakdown --config-file=infracost-generated.yml 97 | # generate cost result 98 | infracost breakdown --config-file=infracost-generated.yml --format=json --out-file=/tmp/infracost-${{ inputs.env-dir }}-${{ inputs.aws-region }}.json 99 | 100 | - name: archive the infracost result 101 | uses: actions/upload-artifact@v3 102 | with: 103 | name: infracost 104 | path: /tmp/infracost-${{ inputs.env-dir }}-${{ inputs.aws-region }}.json 105 | 106 | 107 | 108 | 109 | -------------------------------------------------------------------------------- /.github/workflows/pull-request.yaml: -------------------------------------------------------------------------------- 1 | name: Pull Request Build 2 | 3 | on: 4 | pull_request: 5 | branches: 6 | - main 7 | paths-ignore: 8 | - makefile 9 | 10 | jobs: 11 | terrascan: 12 | name: terrascan check terraform modules 13 | continue-on-error: true 14 | runs-on: ubuntu-latest 15 | permissions: 16 | security-events: write 17 | 18 | steps: 19 | - name: checkout repo 20 | uses: actions/checkout@v3 21 | 22 | - name: terrascan check 23 | continue-on-error: true 24 | uses: ./.github/action/terrascan-action 25 | 26 | checkov: 27 | name: checkov check terraform modules 28 | continue-on-error: true 29 | permissions: 30 | security-events: write 31 | runs-on: ubuntu-latest 32 | steps: 33 | - name: checkout repo 34 | uses: actions/checkout@v3 35 | 36 | - name: checkov check 37 | continue-on-error: true 38 | uses: ./.github/action/checkov-action 39 | 40 | tfsec: 41 | name: tfsec check terraform modules 42 | continue-on-error: true 43 | permissions: 44 | security-events: write 45 | 46 | runs-on: ubuntu-latest 47 | steps: 48 | - name: checkout repo 49 | uses: actions/checkout@v3 50 | 51 | - name: tfsec check 52 | continue-on-error: true 53 | uses: ./.github/action/tfsec-action 54 | 55 | 56 | terragrunt-infracost-action: 57 | strategy: 58 | matrix: 59 | include: 60 | - env-dir: dev 61 | aws-region: us-east-1 62 | aws-account-id: 733051034790 63 | aws-role: terragrunt 64 | aws: aws 65 | aws-audience: sts.amazonaws.com 66 | 67 | - env-dir: prod 68 | aws-region: cn-northwest-1 69 | aws-account-id: 527109613237 70 | aws-role: terragrunt 71 | aws: aws-cn 72 | aws-audience: sts.cn-northwest-1.amazonaws.com.cn 73 | 74 | - env-dir: stage 75 | aws-region: ap-southeast-1 76 | aws-account-id: 594962198840 77 | aws-role: terragrunt 78 | aws: aws 79 | aws-audience: sts.amazonaws.com 80 | 81 | runs-on: ubuntu-latest 82 | continue-on-error: true 83 | 84 | permissions: 85 | id-token: write 86 | actions: read 87 | steps: 88 | 89 | - name: Checkout repo 90 | uses: actions/checkout@v3 91 | 92 | - name: infracost estimates the cost 93 | uses: ./.github/action/infracost-action 94 | with: 95 | role-to-assume: arn:${{ matrix.aws }}:iam::${{ matrix.aws-account-id }}:role/${{ matrix.aws-role }} 96 | role-session-name: github-action 97 | aws-region: ${{ matrix.aws-region }} 98 | env-dir: ${{ matrix.env-dir }} 99 | aws-audience: ${{ matrix.aws-audience }} 100 | infracost_api_key: ${{ secrets.INFRACOST_API_KEY }} 101 | create_pr: 'true' 102 | 103 | infracost-report: 104 | needs: 105 | - terragrunt-infracost-action 106 | runs-on: ubuntu-latest 107 | 108 | permissions: 109 | id-token: write 110 | contents: read 111 | actions: read 112 | pull-requests: write 113 | steps: 114 | - name: Setup Infracost 115 | # https://github.com/infracost/actions 116 | # https://github.com/infracost/actions/tree/master/setup for other inputs 117 | uses: infracost/actions/setup@v2 118 | with: 119 | api-key: ${{ secrets.INFRACOST_API_KEY }} 120 | 121 | - name: download-artifact 122 | uses: actions/download-artifact@v3 123 | with: 124 | name: infracost 125 | path: ~/infracost 126 | 127 | - name: concat the infracost result 128 | working-directory: /home/runner/infracost/ 129 | run: | 130 | infracost output --path "infracost-*.json" --format json --out-file /tmp/infracost.json 131 | 132 | - name: Post Infracost comment 133 | run: | 134 | infracost comment github --path=/tmp/infracost.json \ 135 | --repo=$GITHUB_REPOSITORY \ 136 | --github-token=${{ github.token }} \ 137 | --pull-request=${{ github.event.pull_request.number }} \ 138 | --behavior=update 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Setup CI/CD workflow pipeline with multiple AWS regions & accounts using Terragrunt & Terraform 2 | 3 | [![Deploy Prod Infrastructure](https://github.com/startuplcoud/infra-multi-account-region-startup-kit/actions/workflows/production-terragrunt.yaml/badge.svg?branch=main)](https://github.com/startuplcoud/infra-multi-account-region-startup-kit/actions/workflows/production-terragrunt.yaml) 4 | [![Terrascan Check](https://github.com/startuplcoud/infra-multi-account-region-startup-kit/actions/workflows/production-terrascan.yaml/badge.svg?branch=main)](https://github.com/startuplcoud/infra-multi-account-region-startup-kit/actions/workflows/production-terrascan.yaml) 5 | [![tfsec Check](https://github.com/startuplcoud/infra-multi-account-region-startup-kit/actions/workflows/production-tfsec.yaml/badge.svg)](https://github.com/startuplcoud/infra-multi-account-region-startup-kit/actions/workflows/production-tfsec.yaml) 6 | [![checkov](https://github.com/startuplcoud/infra-multi-account-region-startup-kit/actions/workflows/production-checkov.yaml/badge.svg)](https://github.com/startuplcoud/infra-multi-account-region-startup-kit/actions/workflows/production-checkov.yaml) 7 | 8 | Set up AWS infrastructure with terragrunt and terraform in multiple accounts and regions demo kit. 9 | Goals: 10 | 11 | 1. Provisioning AWS infrastructure resources with terraform and terragrunt. 12 | 2. Support AWS with multiple accounts and regions. 13 | 3. Running the CI/CD workflow pipeline in parallel. 14 | 4. GitHub OIDC provider with AWS IAM role, no need to provide the AWS 15 | credentials. 16 | 5. Pattern: Separate terraform modules, keep the minimum AWS resources, avoid terraform state getting locked, and reduce duplicated codes. 17 | 6. Security solutions with vulnerability scan tools (tfsec, checkov, terrascan, etc.). 18 | 7. Store the secret values such as passwords in the git repository with SOPS. 19 | 8. AWS Infrastructure cost estimate preview with Infracost. 20 | 21 | ## AWS Services Architecture 22 | 23 | This tutorial will show how to set up the AWS VPC, RDS, and EC2 Autoscaling group, with the application load balancer and how to use the terraform & terragrunt to manage the AWS infrastructure. 24 | 25 | ### The Auto Scaling & ALB Architecture Diagram 26 | 27 | ![aws](images/aws.png) 28 | 29 | ### Terraform layout 30 | 31 | Create Terraform separate modules to manage AWS resources, do **NOT** manage terraform states in terraform modules, and try to separate the AWS resources into different modules, such as AWS VPC only 32 | manage the AWS VPC resources. 33 | Useful links about Google best practices for [terraform](https://cloud.google.com/docs/terraform/best-practices-for-terraform#minimize-resources). 34 | 35 | This project terraform modules separate the AWS resources into four parts, VPC & Auto Scaling & RDS & Application Load Balancer. 36 | 37 | ``` 38 | infra 39 | └── module 40 | ├── alb # application load balancer module 41 | │ ├── loadbalancer.tf 42 | │ ├── security.tf 43 | │ └── vars.tf 44 | ├── autoscale # autoscaling module 45 | │ ├── autoscale.tf 46 | │ ├── config 47 | │ │ └── init-config.yaml 48 | │ ├── data.tf 49 | │ ├── security.tf 50 | │ └── vars.tf 51 | ├── rds 52 | │ ├── main.tf 53 | │ ├── outputs.tf 54 | │ ├── security.tf 55 | │ └── vars.tf 56 | └── vpc # vpc module 57 | ├── data.tf 58 | ├── main.tf 59 | ├── outputs.tf 60 | └── vars.tf 61 | ``` 62 | 63 | ### Terragrunt layout 64 | 65 | Terragrunt is a thin wrapper around Terraform that provide remote state management, terraform modules dependencies, reduce 66 | repetition and also support multiple AWS accounts and regions. 67 | 68 | ``` 69 | ├── common # common configuration and input variables both can be used for the different aws account environment 70 | │ ├── alb.hcl 71 | │ ├── autoscale.hcl 72 | │ ├── rds.hcl 73 | │ └── vpc.hcl 74 | ├── dev # development account environment folder 75 | │ └── us-east-1 # only provisioning AWS resources in us-east-1 76 | │ ├── env.yaml global configuration parameters 77 | │ ├── alb 78 | │ │ └── terragrunt.hcl 79 | │ ├── autoscale 80 | │ │ └── terragrunt.hcl 81 | │ ├── rds 82 | │ │ └── terragrunt.hcl 83 | │ └── vpc 84 | │ └── terragrunt.hcl 85 | ├── prod 86 | │ └── cn-north-1 87 | │ ├── env.yaml 88 | │ ├── alb 89 | │ │ └── terragrunt.hcl 90 | │ ├── autoscale 91 | │ │ └── terragrunt.hcl 92 | │ ├── rds 93 | │ │ └── terragrunt.hcl 94 | │ └── vpc 95 | │ └── terragrunt.hcl 96 | ├── stage 97 | │ └── ap-southeast-1 98 | │ ├── env.yaml 99 | │ ├── rds 100 | │ │ └── terragrunt.hcl 101 | │ └── vpc 102 | │ └── terragrunt.hcl 103 | ├── secrets.global.yaml # sops generate secret values in global conguration 104 | ├── .sops.yaml # sops configuration 105 | └── terragrunt.hcl # Global terragrunt configuration 106 | 107 | ``` 108 | 109 | ### Global Variable and terragrunt auto generate for the global providers. 110 | 111 | In the `env.yaml`, for the different region and accounts 112 | we need to set the AWS account id and region variables or env common variables 113 | 114 | #### Global env.yaml 115 | 116 | ``` 117 | aws_region: us-east-1 118 | account_id: xxxxxxx 119 | environment: dev 120 | project: xxxx 121 | ``` 122 | 123 | #### terragrunt.hcl global 124 | 125 | In the global terragrunt file, we can retrieve the `aws_region` and `account_id` in the `env.yaml`. 126 | 127 | ```hcl 128 | locals { 129 | env_vars = yamldecode(file("${find_in_parent_folders("env.yaml")}")) 130 | aws_region = local.env_vars["aws_region"] 131 | project = local.env_vars["project"] 132 | account_id = local.env_vars["account_id"] 133 | } 134 | ``` 135 | 136 | then, in the auto generate provider syntax, it will generate the `providers.tf` in each terraform module, and 137 | the provider already strict the AWS region and account. 138 | 139 | ```hcl 140 | generate "providers" { 141 | path = "providers.tf" 142 | if_exists = "overwrite_terragrunt" 143 | contents = < 422 | sub cv25519 2022-07-18 [E] [expires：2024-07-17] 423 | ``` 424 | 425 | ### create secret key with SOPS (NOT recommended) 426 | 427 | sops -pgp 01D0D800C76AC893E74990B44BB1CE513349E336 ./secrets.yaml 428 | 429 | Edit in the YAML file set the db_password like this and save it to local file `secrets.yaml`: 430 | 431 | ```yaml 432 | db_password: xxxxxx 433 | ``` 434 | 435 | Generator YAML file with SOPS. 436 | 437 | ```yaml 438 | db_password: ENC[AES256_GCM,data:Glso+g==,iv:xa1LZUNbVg1Mno9x7ywXz2U2PFleoEr3q8ZO6G3BuVo=,tag:Mw2xjSieVsP49qFYnlcsKQ==,type:str] 439 | sops: 440 | kms: [ ] 441 | gcp_kms: [ ] 442 | azure_kv: [ ] 443 | hc_vault: [ ] 444 | age: [ ] 445 | lastmodified: "2022-07-18T08:33:15Z" 446 | mac: ENC[AES256_GCM,data:kyWGR+oO6KOvZj6AcLBQca04dhtN4fD+W2sz2X6U+rKe21hBzF8SldsHSgZJcK3L+zmHduFYK8yAbnCXlp/n9wFOzEiC+LrsQJZ2MKUTwLdSsRuz8eFJxChcGPu+2bcduiHb/oQDOIhfwnNy9T8SOfcGC13SaAGJu3n7GCIi7jU=,iv:GFRaLFdVQYm3uyvrtxo/dzZzXSmpzRjidFPuDvi7tkE=,tag:pqGgFOEgHBIAQRz7ZXCPqA==,type:str] 447 | pgp: 448 | - created_at: "2022-07-18T08:32:33Z" 449 | enc: | 450 | -----BEGIN PGP MESSAGE----- 451 | 452 | hF4DD+gJKRAEVSYSAQdA6uH391JK8rksm63xardQcwATT5nrC9mz7N3cafJQ/xkw 453 | zqHX1L1jEy40N1wh/PjYgf8f1c46jLfeTQqGSn3tdxLo2eIaV86/jOqp4e2yO2FK 454 | 1GgBCQIQa1dBfCd873wIsj86KfUUX5rEXainUegvT+JF0QkPVZ4PgC7HFbAOtG07 455 | izdEf+5k5qj6Z3dy7Z3r2M6bVp7te+BYXt56yohCDqVqxsWDcis6pfCWD61w56+8 456 | PtJqcXGFNfTKmg== 457 | =XdTX 458 | -----END PGP MESSAGE----- 459 | fp: 01D0D800C76AC893E74990B44BB1CE513349E336 460 | unencrypted_suffix: _unencrypted 461 | version: 3.7.3 462 | ``` 463 | 464 | Decrypt the secrets.yaml with terragrunt 465 | 466 | ```hcl 467 | # database config read the password from local secrets 468 | locals { 469 | environment = "development" 470 | secrets = yamldecode(sops_decrypt_file("${dirname(find_in_parent_folders())}/secrets.yaml")) 471 | db_password = local.secrets["db_password"] 472 | } 473 | ``` 474 | 475 | Apply or plan the rds module, we must provide the gpg password to retrieve the encrypted yaml. 476 | 477 | ### set up the AWS IAM role and PGP 478 | 479 | 1. Create a KMS key using the SOPS to encrypt & decrypt the sensitive values. 480 | 2. For multiple regions take effects need to enable the multiple region option. 481 | 3. For multiple accounts, editor the KMS key policy to allow other account IAM roles to have the corresponding permission to access the key. 482 | 4. To avoid if the AWS KMS key is broken, also need use the GPG to rotate the key. 483 | 5. For different env (accounts) or regions (AWS China or global region), create the SOPS rules `.sops.yaml` to generate different environment configuration. 484 | 7. Make sure the GitHub action IAM role and user role have the permission to encrypt or decrypt with the KMS key. 485 | 486 | #### apply terragrunt module to generate AWS KMS key 487 | 488 | Using terraform and terragrunt to create KMS key to generate the SOPS secret credentials. 489 | If we want to use a single KMS key that can be encrypted in multiple accounts, add the other AWS account IAM role arn 490 | or user arn as the terraform input values. 491 | 492 | terragunt role arn list and user arn list 493 | 494 | ```hcl 495 | role_arn_list = [ 496 | "arn:aws:iam::594962198840:role/terragrunt" 497 | ] 498 | user_arn_list = [ 499 | "arn:aws:iam::733051034790:user/admin" 500 | ] 501 | ``` 502 | 503 | Apply the kms_sops module to get the `kms_arn` output value, then create the `.sops.yaml` rules templates. 504 | 505 | ```shell 506 | make apply-module directory=kms-global/us-east-1 module=kms_sops 507 | ``` 508 | 509 | Copy the GPG value with this command `gpg --fingerprint 365504029@qq.com` 510 | 511 | pub ed25519 2022-07-18 [SC] [expires：2024-07-17] 512 | 01D0 D800 C76A C893 E749 90B4 4BB1 CE51 3349 E336 513 | uid [ uid ] winton <365504029@qq.com> 514 | sub cv25519 2022-07-18 [E] [expires：2024-07-17] 515 | 516 | #### create `.sops.yaml` rules with KMS key & PGP 517 | 518 | ```yaml 519 | creation_rules: 520 | - path_regex: \.global\.yaml$ 521 | # aws kms key global region 522 | kms: 'arn:aws:kms:us-east-1:733051034790:key/mrk-222444666c2f4b62ad5066365e84aeb8' 523 | pgp: '01D0D800C76AC893E74990B44BB1CE513349E336' 524 | 525 | # aws china region 526 | - path_regex: \.china\.yaml$ 527 | kms: 'arn:aws-cn:kms:cn-northwest-1:733051034790:key/mrk-f24f28b41b0d49419df429946e774safd' 528 | pgp: '01D0D800C76AC893E74990B44BB1CE513349E336' 529 | 530 | ``` 531 | 532 | #### generate secrets.global.yaml 533 | 534 | Create file name extension must match the regex pattern `.global.yaml` 535 | 536 | ```shell 537 | AWS_PROFILE=terragrunt sops secrets.global.yaml 538 | ``` 539 | 540 | edit the secret values in the yaml file: 541 | 542 | ```yaml 543 | dev: # for the aws dev account 544 | db_password: xxxxxx 545 | #stage: # for aws stage account 546 | # db_password: xxxxxx 547 | ``` 548 | 549 | comment the `aws_profile` in the generated YAML file. 550 | 551 | ```yaml 552 | dev: 553 | db_password: ENC[AES256_GCM,data:kmtaxwBA,iv:FelpjBTuPMwfE2IueHh7fWxrHcKwGZf15oar9JeDpsA=,tag:wmkIHhAiUkH1iseqF7R0vw==,type:int] 554 | sops: 555 | kms: 556 | - arn: arn:aws:kms:us-east-1:733051034790:key/mrk-222444666c2f4b62ad5066365e84aeb8 557 | created_at: "2022-07-19T15:52:49Z" 558 | enc: AQICAHgDKXq49C3kkzpf84wGoN9nR2bnic4C850M0a1Q6F7ZywHwFjdqpxJAFhhcwrNaDC3QAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMTCX5INMF7egCoTKZAgEQgDtCO7U4BfdrVZMFxJdvjq3BRoHLgWceFaLCQPxwdbVmMmyWe9R2WFvfAX48MVEvBIP69fdsstn2UMSFUQ== 559 | # aws_profile: terragrunt # disable 560 | gcp_kms: [ ] 561 | azure_kv: [ ] 562 | hc_vault: [ ] 563 | age: [ ] 564 | lastmodified: "2022-07-19T15:53:18Z" 565 | mac: ENC[AES256_GCM,data:fGOwBKVLCuOOJpyIWMAdZYLVYq4XP1mmfQgnabsKa6qB1o3Zke5q3lW+QSXBjOMMWqnM4TTNMYrJIuxqVoKKo9Jsm+Syq7PUrcLvzE+VcvrlySwpTgXikzczqryHzjvFQHGI+j7uV7Sw5p+8/gozCQ7ay1hfmmHgCeQekBRCjo4=,iv:/tVYsiXabhdtuItkPGbZOYkFuifEdgKEZxpOz5lxucY=,tag:LH0aWW4OjRIz7rFfZuIiww==,type:str] 566 | pgp: 567 | - created_at: "2022-07-19T15:52:49Z" 568 | enc: | 569 | -----BEGIN PGP MESSAGE----- 570 | 571 | hF4DD+gJKRAEVSYSAQdAgm5i6ZNi5K59CTVo6bbawyhJnISJ7oESN7DVP8k2RR8w 572 | r4ga9LnNwGDHlL8it8IVaoYgaBjGB/vOJG0vrlzUH/fvfz2N1rumylVcMKSqEdjm 573 | 1GgBCQIQ3IIepfyi7mme9PvDs8lEn1bb4IbGUEoubRBmtkE/vC5IHBuveAANsAUK 574 | hfqWs7mGDgoWD0jrusNuYQON9cyvy1xkikBeSlayibuYPYqcsDHd+pGCzSUpjZSH 575 | m1AzxfgAUUULow== 576 | =MVSz 577 | -----END PGP MESSAGE----- 578 | fp: 01D0D800C76AC893E74990B44BB1CE513349E336 579 | unencrypted_suffix: _unencrypted 580 | version: 3.7.3 581 | ``` 582 | 583 | #### Retrieve the `db_password` value with terragrunt. 584 | 585 | ```hcl 586 | locals { 587 | environment = "development" 588 | secrets = yamldecode(sops_decrypt_file("${dirname(find_in_parent_folders())}/secrets.global.yaml"))["dev"] 589 | db_password = local.secrets["db_password"] 590 | } 591 | ``` 592 | 593 | ### Terraform code Vulnerability scan tools 594 | 595 | Vulnerability tools: 596 | 597 | 1. [tfsec](https://github.com/aquasecurity/tfsec) 598 | 2. [terrascan](https://github.com/tenable/terrascan) 599 | 3. [checkov](https://github.com/bridgecrewio/checkov) 600 | 601 | In the pull request GitHub action, after analyzing terraform code, 602 | the analysis result will automatically upload to the Github security adviser. 603 | 604 | ## AWS Resources Cost Preview in the Pull Request 605 | 606 | Cost estimates with [Infracost](https://www.infracost.io/). 607 | 608 | How to estimate the AWS resources will spend for a month, use the Infracost to generate the total summary of the AWS resources. 609 | Directly check this Pull Request, 610 | https://github.com/startuplcoud/infra-multi-account-region-startup-kit/pull/5 611 | 612 | ## Contact 613 | 614 | If you have any questions, please contact with the email contact@startupcloud.tech 615 | 616 | 617 | 618 | 619 | 620 | 621 | 622 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------