Add aws_network flavor - VPC module #63
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add import project type documentation
Created new flavor 'aws_vpc_k8s' for network/aws_vpc module to provide a Kubernetes-optimized VPC configuration as an alternative to the existing 'aws_vpc' flavor. ## Why aws_vpc_k8s? The module is explicitly Kubernetes-optimized with the following features: - Private subnets sized at /19 (8,192 IPs/AZ) for K8s pod scaling - EKS-specific subnet tags (kubernetes.io/role/elb, kubernetes.io/role/internal-elb) - Auto-calculated subnet allocation to prevent IP exhaustion - VPC endpoints for EKS, ECR, and container workloads ## Naming Rationale **aws_vpc_k8s** is the recommended name because: 1. **Accurate**: Module has explicit Kubernetes optimizations (EKS tags, pod-scale IP ranges) 2. **Concise**: Short (10 chars) and memorable 3. **Clear differentiation**: Distinguishes from generic 'aws_vpc' system module 4. **Not workload-specific**: Works for any K8s workload (ML, web apps, batch jobs, etc.) ## Alternative Names Considered - **aws_vpc_ml**: Too workload-specific; module isn't ML-exclusive - **aws_vpc_optimized**: Vague; doesn't indicate what it's optimized for - **aws_vpc_auto**: Emphasizes auto-calculation over K8s optimization - **aws_vpc_eks**: Accurate but ties to AWS implementation; K8s is more generic - **aws_vpc_v2**: Version-based naming; doesn't convey purpose ## Technical Details Module characteristics: - /16 VPC CIDR requirement with automatic subdivision - 3-tier subnet architecture (private/public/database) - Configurable NAT gateway strategy (single or per-AZ) - Comprehensive VPC endpoint support - EKS subnet tagging for AWS Load Balancer Controller discovery Generated with Facets AI assistant
Changes: - Updated aws/network/aws_vpc/1.0/facets.yaml: - Changed flavor from 'aws_vpc' to 'aws_network' - Updated sample section to use new flavor name - Removed aws_vpc_k8s module directory (consolidating to single network module) Rationale: - Simplifies module naming - one network module per cloud provider - 'aws_network' is cleaner and more generic than 'aws_vpc' - Eliminates redundancy between aws_vpc and aws_vpc_k8s flavors - Module retains all Kubernetes-optimized features (8K IPs/AZ, EKS tags, VPC endpoints)
Changes: - Updated project-type/aws/project-type.yml to reference aws_network flavor - Updated docs/import-project-type-documentation.md example to use aws_network This completes the flavor rename from aws_vpc to aws_network.
bhat-akshay
changed the title
Contributor
|
Change the folder name as well to "aws_network" |
unni-facets
approved these changes
Jan 8, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds a new
aws_vpc_k8sflavor for thenetwork/aws_vpcmodule to provide a Kubernetes-optimized VPC configuration as an alternative to the existing systemaws_vpcmodule.Why a New Flavor?
The existing
aws_vpcis a system module. This new flavor allows teams to:Module Features
The
aws_vpc_k8smodule is explicitly optimized for Kubernetes workloads:Kubernetes-Specific Optimizations
kubernetes.io/role/elbon public subnets (external load balancers)kubernetes.io/role/internal-elbon private subnets (internal load balancers)Architecture
Naming Rationale
Why
aws_vpc_k8s?✅ Accurate: Module has explicit Kubernetes optimizations (EKS tags, pod-scale IP ranges)
✅ Concise: Short (10 characters) and memorable
✅ Clear differentiation: Distinguishes from generic
aws_vpcsystem module✅ Not workload-specific: Works for any K8s workload (ML, web apps, batch jobs, data processing)
✅ Generic enough: Not tied to specific Kubernetes distribution (works with EKS, self-managed K8s)
Alternative Names Considered
Technical Details
Subnet Allocation (for /16 VPC)
Key Configuration Options
vpc_cidr: /16 CIDR block (required)auto_select_azs: Automatically select 3 AZs (default: true)nat_gateway.strategy:singleorper_az(default: single)vpc_endpoints: Granular control over AWS service endpointsEKS Integration
Testing Recommendation
Files Changed
aws/network/aws_vpc_k8s/1.0/facets.yaml- Module metadata withaws_vpc_k8sflavoraws/network/aws_vpc_k8s/1.0/main.tf- VPC resources with K8s tagsaws/network/aws_vpc_k8s/1.0/locals.tf- Subnet calculations and EKS tagsaws/network/aws_vpc_k8s/1.0/outputs.tf- VPC attributes outputaws/network/aws_vpc_k8s/1.0/variables.tf- Standard Facets variablesaws/network/aws_vpc_k8s/1.0/README.md- Module documentationChecklist
aws_vpc_k8sby copyingaws_vpcfacets.yamlwith new flavor namesamplesection infacets.yamlGenerated by Facets AI assistant