From e86e069671f3c42f61b95014cd0dc4f75456df5e Mon Sep 17 00:00:00 2001 From: clouddrove-ci Date: Tue, 9 Apr 2024 03:36:33 +0000 Subject: [PATCH] update README.md --- README.md | 278 ++++++++++++++++++++--------------------------------- docs/io.md | 50 ++++++++++ 2 files changed, 156 insertions(+), 172 deletions(-) create mode 100644 docs/io.md diff --git a/README.md b/README.md index aa7a383..562a075 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ - -

- - +[![Banner](https://github.com/clouddrove/terraform-gcp-vpc/blob/master/docs/CloudDrove.png)][website]

Terraform AZURE SUBNET

-

- Terraform module to create subnet resource on AZURE. -

+

+ With our comprehensive DevOps toolkit - streamline operations, automate workflows, enhance collaboration and, most importantly, deploy with confidence. +

+

@@ -30,6 +28,9 @@ + + + @@ -41,198 +42,131 @@

-We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure. +We are a group of DevOps engineers & architects, joining hands in this ever evolving digital landscape. With our strong belief in Automation; just like microservices, always on the lookout to split the the infrastructure into smaller connected resources (database, cluster and more) which could be standardized, are manageable, scalable, secure & follow industry best practices. + -This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself. +This module includes Terraform open source, examples, and automation tests (for better understanding), which would help you create and improve your infrastructure with minimalistic coding. -We have [*fifty plus terraform modules*][terraform_modules]. A few of them are comepleted and are available for open source usage while a few others are in progress. -## Prerequisites -This module has a few dependencies: + + +## Examples + +**IMPORTANT:** Since the master branch used in source varies based on new modifications, we recommend using the [release versions](https://github.com/clouddrove/terraform-azure-subnet/releases). + +πŸ“Œ For additional usage examples, check the complete list under [`examples/`](./examples) directory. + + + +## Inputs and Outputs + +Refer to complete documentation: [here](docs/io.md) + + + + + + +## πŸ“‘ Changelog + +Refer [here](CHANGELOG.md). + + + + +## ✨ Contributors + +Big thanks to our contributors for elevating our project with their dedication and expertise! But, we do not wish to stop there, would like to invite contributions from the community in improving these projects and making them more versatile for better reach. Remember, every bit of contribution is immensely valuable, as, together, we are moving in only 1 direction, i.e. forward. + + + + +
+
+ + If you're considering contributing to our project, here are a few quick guidelines that we have been following (Got a suggestion? We are all ears!): + +- **Fork the Repository:** Create a new branch for your feature or bug fix. +- **Coding Standards:** You know the drill. +- **Clear Commit Messages:** Write clear and concise commit messages to facilitate understanding. +- **Thorough Testing:** Test your changes thoroughly before submitting a pull request. +- **Documentation Updates:** Include relevant documentation updates if your changes impact it. + + -## Examples -**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-azure-subnet/releases). - - -### Simple Example -Here is an example of how you can use this module in your inventory structure: -### Default Subnet -```hcl - module "subnet" { - source = "clouddrove/subnet/azure" - name = local.name - environment = local.environment - label_order = local.label_order - resource_group_name = module.resource_group.resource_group_name - location = module.resource_group.resource_group_location - virtual_network_name = join("", module.vnet.vnet_name) - - #subnet - subnet_names = ["subnet1", "subnet2"] - subnet_prefixes = ["10.0.1.0/24", "10.0.2.0/24"] - - # route_table - enable_route_table = true - route_table_name = "default_subnet" - routes = [ - { - name = "rt-test" - address_prefix = "0.0.0.0/0" - next_hop_type = "Internet" - } - ] - } -``` -### Name_Specific Subnet -```hcl - module "name_specific_subnet" { - source = "clouddrove/subnet/azure" - name = local.name - environment = local.environment - label_order = local.label_order - resource_group_name = module.resource_group.resource_group_name - location = module.resource_group.resource_group_location - virtual_network_name = join("", module.vnet.vnet_name) - - #subnet - specific_name_subnet = true - specific_subnet_names = "SpecificSubnet" - subnet_prefixes = ["10.0.1.0/24"] - - # route_table - enable_route_table = true - route_table_name = "name_specific_subnet" - routes = [ - { - name = "rt-test" - address_prefix = "0.0.0.0/0" - next_hop_type = "Internet" - } - ] - } -``` -### Nat_Gateway Subnet -```hcl - module "name_specific_subnet" { - source = "clouddrove/subnet/azure" - name = local.name - environment = local.environment - label_order = local.label_order - resource_group_name = module.resource_group.resource_group_name - location = module.resource_group.resource_group_location - virtual_network_name = join("", module.vnet.vnet_name) - - #subnet - create_nat_gateway = true - subnet_names = ["subnet1", "subnet2"] - subnet_prefixes = ["10.0.1.0/24", "10.0.2.0/24"] - - # route_table - enable_route_table = true - route_table_name = "nat_gateway" - routes = [ - { - name = "rt-test" - address_prefix = "0.0.0.0/0" - next_hop_type = "Internet" - } - ] - } -``` - - - - - - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| allocation\_method | Defines the allocation method for this IP address. Possible values are Static or Dynamic. | `string` | `"Static"` | no | -| create\_nat\_gateway | Flag to control nat gateway creation. | `bool` | `false` | no | -| delegation | Configuration delegations on subnet
object({
name = object({
name = string,
actions = list(string)
})
}) | `map(list(any))` | `{}` | no | -| disable\_bgp\_route\_propagation | Boolean flag which controls propagation of routes learned by BGP on that route table. | `bool` | `false` | no | -| enable | Flag to control the module creation | `bool` | `true` | no | -| enable\_route\_table | Flag to control route table creation. | `bool` | `true` | no | -| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `null` | no | -| extra\_tags | Variable to pass extra tags. | `map(string)` | `null` | no | -| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | 
[
  "name",
  "environment"
]
| no | -| location | The location/region where the virtual network is created. Changing this forces a new resource to be created. | `string` | `null` | no | -| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"hello@clouddrove.com"` | no | -| name | Name (e.g. `app` or `cluster`). | `string` | `null` | no | -| nat\_gateway\_idle\_timeout | Idle timeout configuration in minutes for Nat Gateway | `number` | `4` | no | -| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-azure-subnet.git"` | no | -| resource\_group\_name | The name of an existing resource group to be imported. | `string` | `null` | no | -| route\_table\_name | The name of the route table. | `string` | `null` | no | -| routes | List of objects that represent the configuration of each route. | `list(map(string))` | `[]` | no | -| service\_endpoint\_policy\_ids | The list of IDs of Service Endpoint Policies to associate with the subnet. | `list(string)` | `null` | no | -| service\_endpoints | A map with key (string) `subnet name`, value (list(string)) to indicate enabled service endpoints on the subnet. Default value is []. | `list(string)` | `[]` | no | -| sku | The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created. | `string` | `"Standard"` | no | -| sku\_name | The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard. | `string` | `"Standard"` | no | -| specific\_name\_subnet | fName of the specific subnet. | `bool` | `false` | no | -| specific\_subnet\_names | A list of subnets inside the vNet. | `list(string)` | 
[
  ""
]
| no | -| subnet\_enforce\_private\_link\_endpoint\_network\_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | `bool` | `false` | no | -| subnet\_enforce\_private\_link\_service\_network\_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | `bool` | `true` | no | -| subnet\_names | A list of public subnets inside the vNet. | `list(string)` | `[]` | no | -| subnet\_prefixes | The address prefix to use for the subnet. | `list(string)` | `[]` | no | -| virtual\_network\_name | The name of the virtual network in which the subnet is created in | `string` | `null` | no | -| zones | Public ip Zones to configure. | `list(string)` | `null` | no | - -## Outputs - -| Name | Description | -|------|-------------| -| default\_subnet\_address\_prefixes | The address prefixes for the subnet. | -| default\_subnet\_id | The subnet ID. | -| default\_subnet\_name | The name of the subnet. | -| nat\_gateway\_id | The ID of the NAT Gateway. | -| public\_ip\_address | The IP address value that was allocated. | -| public\_ip\_id | The ID of this Public IP. | -| route\_table\_associated\_subnets | The collection of Subnets associated with this route table. | -| route\_table\_id | The Route Table ID. | -| specific\_subnet\_address\_prefixes | The address prefixes for the subnet. | -| specific\_subnet\_id | The name of the subnet. | -| specific\_subnet\_name | The name of the subnet. | - - - - -## Testing -In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system. - -You need to run the following command in the testing folder: -```hcl - go test -run Test -``` ## Feedback -If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-azure-subnet/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com). +Spot a bug or have thoughts to share with us? Let's squash it together! Log it in our [issue tracker](https://github.com/clouddrove/terraform-azure-subnet/issues), feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com). + +Show some love with a β˜… on [our GitHub](https://github.com/clouddrove/terraform-azure-subnet)! if our work has brightened your day! – your feedback fuels our journey! + + +## :rocket: Our Accomplishment + +We have [*100+ Terraform modules*][terraform_modules] πŸ™Œ. You could consider them finished, but, with enthusiasts like yourself, we are able to ever improve them, so we call our status - improvement in progress. + +- [Terraform Module Registry:](https://registry.terraform.io/namespaces/clouddrove) Discover our Terraform modules here. + +- [Terraform Modules for AWS/Azure Modules:](https://github.com/clouddrove/toc) Explore our comprehensive Table of Contents for easy navigation through our documentation for modules pertaining to AWS, Azure & GCP. + +- [Terraform Modules for Digital Ocean:](https://github.com/terraform-do-modules/toc) Check out our specialized Terraform modules for Digital Ocean. + + + + +## Join Our Slack Community + +Join our vibrant open-source slack community and embark on an ever-evolving journey with CloudDrove; helping you in moving upwards in your career path. +Join our vibrant Open Source Slack Community and embark on a learning journey with CloudDrove. Grow with us in the world of DevOps and set your career on a path of consistency. + +πŸŒπŸ’¬What you'll get after joining this Slack community: + +- πŸš€ Encouragement to upgrade your best version. +- 🌈 Learning companionship with our DevOps squad. +- 🌱 Relentless growth with daily updates on new advancements in technologies. + +Join our tech elites [Join Now][slack] πŸš€ + + +## Explore Our Blogs -If you have found it worth your time, go ahead and give us a β˜… on [our GitHub](https://github.com/clouddrove/terraform-azure-subnet)! + Click [here][blog] :books: :star2: -## About us +## Tap into our capabilities +We provide a platform for organizations to engage with experienced top-tier DevOps & Cloud services. Tap into our pool of certified engineers and architects to elevate your DevOps and Cloud Solutions. -At [CloudDrove][website], we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering. +At [CloudDrove][website], has extensive experience in designing, building & migrating environments, securing, consulting, monitoring, optimizing, automating, and maintaining complex and large modern systems. With remarkable client footprints in American & European corridors, our certified architects & engineers are ready to serve you as per your requirements & schedule. Write to us at [business@clouddrove.com](mailto:business@clouddrove.com).

We are The Cloud Experts!

-

We ❀️ Open Source and you can check out our other modules to get help with your new Cloud ideas.

+

We ❀️ Open Source and you can check out our other modules to get help with your new Cloud ideas.

[website]: https://clouddrove.com + [blog]: https://blog.clouddrove.com + [slack]: https://www.launchpass.com/devops-talks [github]: https://github.com/clouddrove [linkedin]: https://cpco.io/linkedin [twitter]: https://twitter.com/clouddrove/ diff --git a/docs/io.md b/docs/io.md new file mode 100644 index 0000000..84a5a23 --- /dev/null +++ b/docs/io.md @@ -0,0 +1,50 @@ +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| allocation\_method | Defines the allocation method for this IP address. Possible values are Static or Dynamic. | `string` | `"Static"` | no | +| create\_nat\_gateway | Flag to control nat gateway creation. | `bool` | `false` | no | +| delegation | Configuration delegations on subnet
object({
name = object({
name = string,
actions = list(string)
})
}) | `map(list(any))` | `{}` | no | +| disable\_bgp\_route\_propagation | Boolean flag which controls propagation of routes learned by BGP on that route table. | `bool` | `false` | no | +| enable | Flag to control the module creation | `bool` | `true` | no | +| enable\_route\_table | Flag to control route table creation. | `bool` | `true` | no | +| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `null` | no | +| extra\_tags | Variable to pass extra tags. | `map(string)` | `null` | no | +| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | 
[
  "name",
  "environment"
]
| no | +| location | The location/region where the virtual network is created. Changing this forces a new resource to be created. | `string` | `null` | no | +| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"hello@clouddrove.com"` | no | +| name | Name (e.g. `app` or `cluster`). | `string` | `null` | no | +| nat\_gateway\_idle\_timeout | Idle timeout configuration in minutes for Nat Gateway | `number` | `4` | no | +| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-azure-subnet.git"` | no | +| resource\_group\_name | The name of an existing resource group to be imported. | `string` | `null` | no | +| route\_table\_name | The name of the route table. | `string` | `null` | no | +| routes | List of objects that represent the configuration of each route. | `list(map(string))` | `[]` | no | +| service\_endpoint\_policy\_ids | The list of IDs of Service Endpoint Policies to associate with the subnet. | `list(string)` | `null` | no | +| service\_endpoints | A map with key (string) `subnet name`, value (list(string)) to indicate enabled service endpoints on the subnet. Default value is []. | `list(string)` | `[]` | no | +| sku | The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created. | `string` | `"Standard"` | no | +| sku\_name | The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard. | `string` | `"Standard"` | no | +| specific\_name\_subnet | fName of the specific subnet. | `bool` | `false` | no | +| specific\_subnet\_names | A list of subnets inside the vNet. | `list(string)` | 
[
  ""
]
| no | +| subnet\_enforce\_private\_link\_endpoint\_network\_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | `bool` | `false` | no | +| subnet\_enforce\_private\_link\_service\_network\_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | `bool` | `true` | no | +| subnet\_names | A list of public subnets inside the vNet. | `list(string)` | `[]` | no | +| subnet\_prefixes | The address prefix to use for the subnet. | `list(string)` | `[]` | no | +| virtual\_network\_name | The name of the virtual network in which the subnet is created in | `string` | `null` | no | +| zones | Public ip Zones to configure. | `list(string)` | `null` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| default\_subnet\_address\_prefixes | The address prefixes for the subnet. | +| default\_subnet\_id | The subnet ID. | +| default\_subnet\_name | The name of the subnet. | +| nat\_gateway\_id | The ID of the NAT Gateway. | +| public\_ip\_address | The IP address value that was allocated. | +| public\_ip\_id | The ID of this Public IP. | +| route\_table\_associated\_subnets | The collection of Subnets associated with this route table. | +| route\_table\_id | The Route Table ID. | +| specific\_subnet\_address\_prefixes | The address prefixes for the subnet. | +| specific\_subnet\_id | The name of the subnet. | +| specific\_subnet\_name | The name of the subnet. | +