diff --git a/README.md b/README.md index 2dec172..b2458c0 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ -# terraform-aws-module-template +![Module Structure](./static/banner.png) +# [terraform-aws-arc-security-group](https://github.com/sourcefuse/terraform-aws-arc-security-group) + +Latest Release Last Updated ![Terraform](https://img.shields.io/badge/terraform-%235835CC.svg?style=for-the-badge&logo=terraform&logoColor=white) ![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white) + +[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=sourcefuse_terraform-aws-arc-security-group&token=0e57ba3902cccbb2b9c0585a9859bccbf2d00e3c)](https://sonarcloud.io/summary/new_code?id=sourcefuse_terraform-aws-arc-security-group) + +[![Known Vulnerabilities](https://github.com/sourcefuse/terraform-aws-arc-security-group/actions/workflows/snyk.yaml/badge.svg)](https://github.com/sourcefuse/terraform-aws-arc-security-group/actions/workflows/snyk.yaml) ## Overview -SourceFuse AWS Reference Architecture (ARC) Terraform module for managing _________. +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. -## Usage +For more information about this repository and its usage, please see [Terraform AWS ARC DB Usage Guide](https://github.com/sourcefuse/terraform-aws-arc-security-group/blob/main/docs/module-usage-guide/README.md). -To see a full example, check out the [main.tf](./example/main.tf) file in the example folder. +## Module Usage -```hcl -module "this" { - source = "git::https://github.com/sourcefuse/terraform-aws-refarch-" -} -``` +To see a full example, check out the [main.tf](https://github.com/sourcefuse/terraform-aws-arc-security-group/blob/main/example/main.tf) file in the example folder. ## Requirements diff --git a/docs/module-usage-guide/README.md b/docs/module-usage-guide/README.md index 7ec9a8f..c5d42ce 100644 --- a/docs/module-usage-guide/README.md +++ b/docs/module-usage-guide/README.md @@ -1,14 +1,14 @@ -# Terraform AWS ARC (service-name) Module Usage Guide +# Terraform AWS ARC Security Group Module Usage Guide ## Introduction ### Purpose of the Document -This document provides guidelines and instructions for users looking to implement the Terraform ________ +This document provides guidelines and instructions for users looking to create and manage Security Groups ### Module Overview -The Terraform AWS ARC ________ module provides a secure and modular foundation for deploying ________ on AWS. +The Terraform AWS ARC Security Group module create and manage AWS security groups with customizable ingress and egress rules for secure network traffic control. ### Prerequisites @@ -16,7 +16,7 @@ Before using this module, ensure you have the following: - AWS credentials configured. - Terraform installed. -- A working knowledge of AWS VPC, ________, and Terraform concepts. +- A working knowledge of AWS VPC, security grouo, and Terraform concepts. ## Getting Started @@ -25,14 +25,14 @@ Before using this module, ensure you have the following: To use the module in your Terraform configuration, include the following source block: ```hcl -module "arc-________" { - source = "sourcefuse/arc-________/aws" - version = "1.5.0" - # insert the 6 required variables here +module "arc-sg" { + source = "sourcefuse/arc-security-group/aws" + version = "0.0.1" + # insert the required variables here } ``` -Refer to the [Terraform Registry](https://registry.terraform.io/modules/sourcefuse/arc-ecs/aws/latest) for the latest version. +Refer to the [Terraform Registry](https://registry.terraform.io/modules/sourcefuse/arc-security-group/aws/latest) for the latest version. ### Integration with Existing Terraform Configurations @@ -41,7 +41,7 @@ Refer to the Terraform Registry for the latest version. ## Integration with Existing Terraform Configurations Integrate the module with your existing Terraform mono repo configuration, follow the steps below: -- Create a new folder in terraform/ named ________. +- Create a new folder in terraform/ named security-group. - Create the required files, see the examples to base off of. - Configure with your backend: - Create the environment backend configuration file: config..hcl @@ -55,71 +55,59 @@ Integrate the module with your existing Terraform mono repo configuration, follo Ensure that the AWS credentials used to execute Terraform have the necessary permissions to create, list and modify: -- -- -- -- - ## Module Configuration ### Input Variables -For a list of input variables, see the README [Inputs]() section. +For a list of input variables, see the README [Inputs](https://github.com/sourcefuse/terraform-aws-arc-security-group?tab=readme-ov-file#inputs) section. ### Output Values -For a list of outputs, see the README [Outputs]() section. +For a list of outputs, see the README [Outputs](https://github.com/sourcefuse/terraform-aws-arc-security-group?tab=readme-ov-file#outputs) section. ## Module Usage ### Basic Usage -For basic usage, see the [example]() folder. +For basic usage, see the [example](https://github.com/sourcefuse/terraform-aws-arc-security-group/tree/main/example) folder. This example will create: -- -- +1. Security Group Example +This example demonstrates deploying a single RDS instance using the module, configuring an Amazon RDS database with basic settings like instance class, storage, and connectivity. It showcases options for database engine, encryption, and CloudWatch monitoring for a standalone RDS database. Ideal for simple, production-ready RDS setups. ### Tips and Recommendations -- The module focuses on provisioning ________. The convention-based approach enables downstream services to easily attach to the ________. Adjust the configuration parameters as needed for your specific use case. +The module can manage egress rules to security groups, S3 endpoints, and more. ## Troubleshooting ### Reporting Issues -If you encounter a bug or issue, please report it on the [GitHub repository](). +If you encounter a bug or issue, please report it on the [GitHub repository](https://github.com/sourcefuse/terraform-aws-arc-security-group/issues). ## Security Considerations ### AWS VPC -Understand the security considerations related to ________ on AWS when using this module. - -### Best Practices for AWS ___ - -Follow best practices to ensure secure ________ configurations: - -- [AWS ________ Security Best Practices]() +Understand the security considerations related to SEcurity Group ## Contributing and Community Support ### Contributing Guidelines -Contribute to the module by following the guidelines outlined in the [CONTRIBUTING.md]() file. +Contribute to the module by following the guidelines outlined in the [CONTRIBUTING.md](https://github.com/sourcefuse/terraform-aws-arc-security-group/blob/main/CONTRIBUTING.md) file. ### Reporting Bugs and Issues -If you find a bug or issue, report it on the [GitHub repository](). +If you find a bug or issue, report it on the [GitHub repository](https://github.com/sourcefuse/terraform-aws-arc-security-group/issues). ## License ### License Information -This module is licensed under the Apache 2.0 license. Refer to the [LICENSE]() file for more details. +This module is licensed under the Apache 2.0 license. Refer to the [LICENSE](https://github.com/sourcefuse/terraform-aws-arc-security-group/blob/main/LICENSE) file for more details. ### Open Source Contribution Contribute to open source by using and enhancing this module. Your contributions are welcome! - diff --git a/static/banner.png b/static/banner.png new file mode 100644 index 0000000..4b40cac Binary files /dev/null and b/static/banner.png differ