[#316] Remove v5 prefix

Author: tung-nimblehq

.github/wiki/Architecture-overview.md

@@ -17,7 +17,6 @@ The project has the following main files and folders:
 │   │   └── versionControl # the templates files for version control
 │   └── terraform # the templates folders
 │       ├── core # the templates files for the core folder
-│       ├── core-v5 # the templates files for the v5 resource core folder
 │       └── shared # the templates files for the shared folder
 ├── src # the source code of the CLI
 │   ├── commands # the commands of the CLI

.github/wiki/Security.md

@@ -4,6 +4,21 @@ This document provides an overview of the security modules available in the infr
 
 ## Available Security Modules
 
+### CloudTrail
+
+The CloudTrail module provides comprehensive API activity logging and monitoring for your AWS infrastructure to enhance security auditing and compliance.
+
+#### Overview
+
+AWS CloudTrail records API calls and events across your AWS account. This module:
+
+- **Comprehensive event logging**: Captures management events, data events, and insight events based on configuration
+- **Multi-region support**: Can be configured to log events across all AWS regions for complete visibility
+- **CloudWatch integration**: Sends logs to CloudWatch for real-time monitoring and alerting
+- **S3 storage**: Stores all CloudTrail logs securely in Amazon S3 with configurable key prefix organization
+- **SNS notifications**: Integrates with SNS topics for immediate alerting on critical events
+- **Insight events**: Captures unusual activity patterns like API call rate and error rate anomalies
+
 ### VPC Flow Log
 
 The VPC Flow Log module captures network traffic information in your VPC to help with security monitoring and network analysis.

src/generators/addons/aws/constants.ts

@@ -1,6 +1,5 @@
 const AWS_DEFAULT_REGION = 'ap-southeast-1';
 const AWS_TEMPLATE_PATH = `addons/aws`;
-const AWS_PROVIDER_V5_PATH = `${AWS_TEMPLATE_PATH}/modules-v5/provider.tf`;
 const AWS_SECURITY_GROUP_PATH = `modules/security_group`;
 const AWS_SECURITY_GROUP_MAIN_PATH = `${AWS_SECURITY_GROUP_PATH}/main.tf`;
 const AWS_SECURITY_GROUP_OUTPUTS_PATH = `${AWS_SECURITY_GROUP_PATH}/outputs.tf`;
@@ -9,7 +8,6 @@ const AWS_SECURITY_GROUP_VARIABLES_PATH = `${AWS_SECURITY_GROUP_PATH}/variables.
 export {
   AWS_DEFAULT_REGION,
   AWS_TEMPLATE_PATH,
-  AWS_PROVIDER_V5_PATH,
   AWS_SECURITY_GROUP_PATH,
   AWS_SECURITY_GROUP_MAIN_PATH,
   AWS_SECURITY_GROUP_OUTPUTS_PATH,

src/generators/addons/aws/dependencies.ts

@@ -53,7 +53,7 @@ const AWS_MODULES: Record<AwsModuleName | string, AwsModule> = {
   },
   cloudtrail: {
     name: 'cloudtrail',
-    path: 'modules-v5/cloudtrail',
+    path: 'modules/cloudtrail',
     mainContent: 'module "cloudtrail"',
     applyModuleFunction: (options: AwsOptions) => applyAwsCloudtrail(options),
   },

src/generators/addons/aws/modules/cloudtrail.test.ts

@@ -38,44 +38,44 @@ describe('CloudTrail add-on', () => {
 
     it('creates expected files', () => {
       const expectedFiles = [
-        'core-v5/main.tf',
-        'core-v5/providers.tf',
-        'core-v5/outputs.tf',
-        'core-v5/variables.tf',
-        'modules-v5/cloudtrail/main.tf',
-        'modules-v5/cloudtrail/variables.tf',
-        'modules-v5/cloudtrail/outputs.tf',
-        'modules-v5/cloudtrail/s3-bucket-cloudtrail/main.tf',
-        'modules-v5/cloudtrail/s3-bucket-cloudtrail/variables.tf',
-        'modules-v5/cloudtrail/s3-bucket-cloudtrail/outputs.tf',
-        'modules-v5/cloudtrail/sns/main.tf',
-        'modules-v5/cloudtrail/sns/variables.tf',
-        'modules-v5/cloudtrail/sns/outputs.tf',
-        'modules-v5/cloudtrail/alerts/main.tf',
-        'modules-v5/cloudtrail/alerts/variables.tf',
-        'modules-v5/cloudtrail/alerts/outputs.tf',
+        'core/main.tf',
+        'core/providers.tf',
+        'core/outputs.tf',
+        'core/variables.tf',
+        'modules/cloudtrail/main.tf',
+        'modules/cloudtrail/variables.tf',
+        'modules/cloudtrail/outputs.tf',
+        'modules/cloudtrail/s3-bucket-cloudtrail/main.tf',
+        'modules/cloudtrail/s3-bucket-cloudtrail/variables.tf',
+        'modules/cloudtrail/s3-bucket-cloudtrail/outputs.tf',
+        'modules/cloudtrail/sns/main.tf',
+        'modules/cloudtrail/sns/variables.tf',
+        'modules/cloudtrail/sns/outputs.tf',
+        'modules/cloudtrail/alerts/main.tf',
+        'modules/cloudtrail/alerts/variables.tf',
+        'modules/cloudtrail/alerts/outputs.tf',
       ];
 
       expect(projectDir).toHaveFiles(expectedFiles);
     });
 
     it('adds cloudtrail module to main.tf', () => {
       expect(projectDir).toHaveContentInFile(
-        'core-v5/main.tf',
+        'core/main.tf',
         cloudtrailModuleContent
       );
     });
 
     it('adds cloudtrail variables to variables.tf', () => {
       expect(projectDir).toHaveContentInFile(
-        'core-v5/variables.tf',
+        'core/variables.tf',
         cloudtrailVariablesContent
       );
     });
 
     it('adds cloudtrail outputs to outputs.tf', () => {
       expect(projectDir).toHaveContentInFile(
-        'core-v5/outputs.tf',
+        'core/outputs.tf',
         cloudtrailOutputsContent
       );
     });

src/generators/addons/aws/modules/cloudtrail.ts

@@ -3,9 +3,9 @@ import { dedent } from 'ts-dedent';
 import { AwsOptions } from '@/generators/addons/aws';
 import { isAwsModuleAdded } from '@/generators/addons/aws/dependencies';
 import {
-  INFRA_CORE_V5_MAIN_PATH,
-  INFRA_CORE_V5_VARIABLES_PATH,
-  INFRA_CORE_V5_OUTPUTS_PATH,
+  INFRA_CORE_MAIN_PATH,
+  INFRA_CORE_VARIABLES_PATH,
+  INFRA_CORE_OUTPUTS_PATH,
 } from '@/generators/terraform/constants';
 import { appendToFile, copy } from '@/helpers/file';
 
@@ -63,7 +63,7 @@ const cloudtrailVariablesContent = dedent`
 
 const cloudtrailModuleContent = dedent`
   module "cloudtrail_s3_bucket" {
-    source = "../modules-v5/cloudtrail/s3-bucket-cloudtrail"
+    source = "../modules/cloudtrail/s3-bucket-cloudtrail"
 
     env_namespace      = local.env_namespace
     s3_bucket_name     = var.cloudtrail_s3_bucket_name
@@ -73,7 +73,7 @@ const cloudtrailModuleContent = dedent`
   }
 
   module "cloudtrail_sns" {
-    source = "../modules-v5/cloudtrail/sns"
+    source = "../modules/cloudtrail/sns"
 
     env_namespace = local.env_namespace
     sns_name      = var.cloudtrail_sns_topic_name
@@ -82,7 +82,7 @@ const cloudtrailModuleContent = dedent`
 
   module "cloudtrail" {
     depends_on = [module.cloudtrail_s3_bucket, module.cloudtrail_sns]
-    source     = "../modules-v5/cloudtrail"
+    source     = "../modules/cloudtrail"
 
     env_namespace              = local.env_namespace
     trail_name                 = var.cloudtrail_trail_name
@@ -99,7 +99,7 @@ const cloudtrailModuleContent = dedent`
   module "cloudtrail_alerts" {
     count      = var.cloudtrail_enable_alerts ? 1 : 0
     depends_on = [module.cloudtrail_sns]
-    source     = "../modules-v5/cloudtrail/alerts"
+    source     = "../modules/cloudtrail/alerts"
 
     env_namespace              = local.env_namespace
     cloudtrail_log_group_name  = "/aws/cloudtrail/\${var.cloudtrail_trail_name}"
@@ -116,29 +116,9 @@ const cloudtrailModuleContent = dedent`
   }`;
 
 const cloudtrailOutputsContent = dedent`
-  output "cloudtrail_s3_bucket_id" {
-    description = "The ID of the S3 bucket for CloudTrail logs"
-    value       = module.cloudtrail_s3_bucket.s3_bucket_id
-  }
-
-  output "cloudtrail_s3_bucket_arn" {
-    description = "The ARN of the S3 bucket for CloudTrail logs"
-    value       = module.cloudtrail_s3_bucket.s3_bucket_arn
-  }
-
   output "cloudtrail_arn" {
     description = "The ARN of the CloudTrail"
     value       = module.cloudtrail.cloudtrail_arn
-  }
-
-  output "cloudtrail_sns_topic_arn" {
-    description = "The ARN of the SNS topic for CloudTrail notifications"
-    value       = module.cloudtrail_sns.sns_topic_arn
-  }
-
-  output "cloudtrail_arm" {
-    description = "The ARN of CloudTrail"
-    value       = module.cloudtrail.cloudtrail_arn
   }`;
 
 const applyAwsCloudtrail = async (options: AwsOptions) => {
@@ -147,22 +127,22 @@ const applyAwsCloudtrail = async (options: AwsOptions) => {
   }
 
   copy(
-    `${AWS_TEMPLATE_PATH}/modules-v5/cloudtrail`,
-    'modules-v5/cloudtrail',
+    `${AWS_TEMPLATE_PATH}/modules/cloudtrail`,
+    'modules/cloudtrail',
     options.projectName
   );
   appendToFile(
-    INFRA_CORE_V5_VARIABLES_PATH,
+    INFRA_CORE_VARIABLES_PATH,
     cloudtrailVariablesContent,
     options.projectName
   );
   appendToFile(
-    INFRA_CORE_V5_MAIN_PATH,
+    INFRA_CORE_MAIN_PATH,
     cloudtrailModuleContent,
     options.projectName
   );
   appendToFile(
-    INFRA_CORE_V5_OUTPUTS_PATH,
+    INFRA_CORE_OUTPUTS_PATH,
     cloudtrailOutputsContent,
     options.projectName
   );

src/generators/addons/aws/modules/core/provider.ts

@@ -1,11 +1,7 @@
 import { AwsOptions } from '@/generators/addons/aws';
-import {
-  AWS_TEMPLATE_PATH,
-  AWS_PROVIDER_V5_PATH,
-} from '@/generators/addons/aws/constants';
+import { AWS_TEMPLATE_PATH } from '@/generators/addons/aws/constants';
 import {
   INFRA_CORE_PATH,
-  INFRA_CORE_V5_PATH,
   INFRA_SHARED_PATH,
 } from '@/generators/terraform/constants';
 import { copy } from '@/helpers/file';
@@ -21,15 +17,6 @@ const applyTerraformAwsProvider = async (options: AwsOptions) => {
     `${INFRA_SHARED_PATH}/providers.tf`,
     options.projectName
   );
-
-  // For advanced infrastructure, also copy to core-v5
-  if (options.infrastructureType === 'advanced') {
-    copy(
-      AWS_PROVIDER_V5_PATH,
-      `${INFRA_CORE_V5_PATH}/providers.tf`,
-      options.projectName
-    );
-  }
 };
 
 export default applyTerraformAwsProvider;

src/generators/terraform/constants.ts

@@ -8,11 +8,6 @@ const INFRA_SHARED_MAIN_PATH = `${INFRA_SHARED_PATH}/main.tf`;
 const INFRA_SHARED_OUTPUTS_PATH = `${INFRA_SHARED_PATH}/outputs.tf`;
 const INFRA_SHARED_VARIABLES_PATH = `${INFRA_SHARED_PATH}/variables.tf`;
 
-const INFRA_CORE_V5_PATH = 'core-v5/';
-const INFRA_CORE_V5_MAIN_PATH = `${INFRA_CORE_V5_PATH}/main.tf`;
-const INFRA_CORE_V5_OUTPUTS_PATH = `${INFRA_CORE_V5_PATH}/outputs.tf`;
-const INFRA_CORE_V5_VARIABLES_PATH = `${INFRA_CORE_V5_PATH}/variables.tf`;
-
 export {
   INFRA_CORE_PATH,
   INFRA_CORE_MAIN_PATH,
@@ -22,8 +17,4 @@ export {
   INFRA_SHARED_MAIN_PATH,
   INFRA_SHARED_OUTPUTS_PATH,
   INFRA_SHARED_VARIABLES_PATH,
-  INFRA_CORE_V5_PATH,
-  INFRA_CORE_V5_MAIN_PATH,
-  INFRA_CORE_V5_OUTPUTS_PATH,
-  INFRA_CORE_V5_VARIABLES_PATH,
 };

src/generators/terraform/index.ts

@@ -4,7 +4,6 @@ import { GeneralOptions } from '@/commands/generate';
 import {
   INFRA_CORE_MAIN_PATH,
   INFRA_SHARED_MAIN_PATH,
-  INFRA_CORE_V5_MAIN_PATH,
 } from '@/generators/terraform/constants';
 import { copy, rename, appendToFile } from '@/helpers/file';
 
@@ -21,7 +20,6 @@ const applyTerraformCore = async (generalOptions: GeneralOptions) => {
 
   appendToFile(INFRA_CORE_MAIN_PATH, coreLocalsContent, projectName);
   appendToFile(INFRA_SHARED_MAIN_PATH, coreLocalsContent, projectName);
-  appendToFile(INFRA_CORE_V5_MAIN_PATH, coreLocalsContent, projectName);
 
   // Need to rename .gitignore to gitignore because NPN package doesn't include .gitignore
   // https://github.com/npm/npm/issues/3763