https://github.com/sourcefuse/terraform-aws-arc-security-group
ARC module for AWS Security Group
https://github.com/sourcefuse/terraform-aws-arc-security-group
Last synced: 4 months ago
JSON representation
ARC module for AWS Security Group
- Host: GitHub
- URL: https://github.com/sourcefuse/terraform-aws-arc-security-group
- Owner: sourcefuse
- License: apache-2.0
- Created: 2024-11-27T14:03:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-04T08:36:00.000Z (8 months ago)
- Last Synced: 2025-08-01T05:55:59.045Z (6 months ago)
- Language: HCL
- Size: 4.15 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# [terraform-aws-arc-security-group](https://github.com/sourcefuse/terraform-aws-arc-security-group)
 
[](https://sonarcloud.io/summary/new_code?id=sourcefuse_terraform-aws-arc-security-group)
[](https://github.com/sourcefuse/terraform-aws-arc-security-group/actions/workflows/snyk.yaml)
## Introduction
The SourceFuse AWS Reference Architecture (ARC) Terraform module for creating and managing AWS security groups with customizable rules. It simplifies defining inbound and outbound rules for specific protocols, ports, and CIDR ranges, ensuring secure and efficient network traffic control in your infrastructure.
For more information about this repository and its usage, please see [Terraform AWS ARC Security Group Module Usage Guide](docs/module-usage-guide/README.md).
### Prerequisites
Before using this module, ensure you have the following:
- AWS credentials configured.
- Terraform installed.
- A working knowledge of Terraform.
## Usage
See the `examples` folder for a complete example.
```hcl
locals {
security_group_data = {
create = true
description = "Security Group for Loadbalancer"
ingress_rules = [
{
description = "Allow VPC traffic"
cidr_block = data.aws_vpc.this.cidr_block
from_port = 0
ip_protocol = "tcp"
to_port = 65535
},
{
description = "Allow traffic from self"
self = true
from_port = 0
ip_protocol = "tcp"
to_port = 65535
},
{
description = "Allow traffic from security group"
source_security_group_id = data.aws_security_group.default.id
from_port = 0
ip_protocol = "tcp"
to_port = 65535
}
]
egress_rules = [
{
description = "Allow all outbound traffic"
cidr_block = "0.0.0.0/0"
from_port = -1
ip_protocol = "-1"
to_port = -1
}
]
}
}
module "arc_security_group" {
source = "sourcefuse/arc-security-group/aws"
version = "0.0.1"
name = "${var.namespace}-${var.environment}-sg"
vpc_id = data.aws_vpc.this.id
ingress_rules = local.security_group_data.ingress_rules
egress_rules = local.security_group_data.egress_rules
tags = module.tags.tags
}
```
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | > 1.4, < 2.0.0 |
| [aws](#requirement\_aws) | ~> 5.0 |
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | 5.80.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [aws_security_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
| [aws_vpc_security_group_egress_rule.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_security_group_egress_rule) | resource |
| [aws_vpc_security_group_ingress_rule.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_security_group_ingress_rule) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [description](#input\_description) | (optional) Description of Security Group | `string` | `null` | no |
| [egress\_rules](#input\_egress\_rules) | (optional) List of egress rules for the security group. |
list(object({
description = optional(string, null)
cidr_block = optional(string, null)
destination_security_group_id = optional(string, null)
from_port = number
ip_protocol = string
to_port = string
prefix_list_id = optional(string, null)
})) | `[]` | no |
| [ingress\_rules](#input\_ingress\_rules) | (optional) List of ingress rules for the security group. | list(object({
description = optional(string, null)
cidr_block = optional(string, null)
source_security_group_id = optional(string, null)
from_port = number
ip_protocol = string
to_port = string
self = optional(bool, false)
})) | `[]` | no |
| [name](#input\_name) | Security Group name | `string` | n/a | yes |
| [tags](#input\_tags) | Tags for Security Group | `map(string)` | `{}` | no |
| [vpc\_id](#input\_vpc\_id) | VPC Id for creating security group | `string` | n/a | yes |
## Outputs
| Name | Description |
|------|-------------|
| [id](#output\_id) | Security Group ID |
## Versioning
This project uses a `.version` file at the root of the repo which the pipeline reads from and does a git tag.
When you intend to commit to `main`, you will need to increment this version. Once the project is merged,
the pipeline will kick off and tag the latest git commit.
## Development
### Prerequisites
- [terraform](https://learn.hashicorp.com/terraform/getting-started/install#installing-terraform)
- [terraform-docs](https://github.com/segmentio/terraform-docs)
- [pre-commit](https://pre-commit.com/#install)
- [golang](https://golang.org/doc/install#install)
- [golint](https://github.com/golang/lint#installation)
### Configurations
- Configure pre-commit hooks
```sh
pre-commit install
```
### Versioning
while Contributing or doing git commit please specify the breaking change in your commit message whether its major,minor or patch
For Example
```sh
git commit -m "your commit message #major"
```
By specifying this , it will bump the version and if you don't specify this in your commit message then by default it will consider patch and will bump that accordingly
### Tests
- Tests are available in `test` directory
- Configure the dependencies
```sh
cd test/
go mod init github.com/sourcefuse/terraform-aws-refarch-
go get github.com/gruntwork-io/terratest/modules/terraform
```
- Now execute the test
```sh
go test -timeout 30m
```
## Authors
This project is authored by:
- SourceFuse ARC Team