Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudnationhq/terraform-azure-nw
Terraform module which creates network watcher resources used by workloads and accelerators.
https://github.com/cloudnationhq/terraform-azure-nw
azure terraform wam
Last synced: 7 days ago
JSON representation
Terraform module which creates network watcher resources used by workloads and accelerators.
- Host: GitHub
- URL: https://github.com/cloudnationhq/terraform-azure-nw
- Owner: CloudNationHQ
- License: mit
- Created: 2024-07-26T08:57:17.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-11T12:30:09.000Z (9 days ago)
- Last Synced: 2024-11-11T13:28:08.397Z (9 days ago)
- Topics: azure, terraform, wam
- Language: Go
- Homepage: https://registry.terraform.io/modules/CloudNationHQ/nw/azure/latest
- Size: 73.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Network Watcher
This terraform module simplifies the process of creating and managing network watcher (flow logs) on azure with customizable options and features, offering a flexible and powerful solution for managing network watchers through code.
## Goals
The main objective is to create a more logic data structure, achieved by combining and grouping related resources together in a complex object.
The structure of the module promotes reusability. It's intended to be a repeatable component, simplifying the process of building diverse workloads and platform accelerators consistently.
A primary goal is to utilize keys and values in the object that correspond to the REST API's structure. This enables us to carry out iterations, increasing its practical value as time goes on.
A last key goal is to separate logic from configuration in the module, thereby enhancing its scalability, ease of customization, and manageability.
## Non-Goals
These modules are not intended to be complete, ready-to-use solutions; they are designed as components for creating your own patterns.
They are not tailored for a single use case but are meant to be versatile and applicable to a range of scenarios.
Security standardization is applied at the pattern level, while the modules include default values based on best practices but do not enforce specific security standards.
End-to-end testing is not conducted on these modules, as they are individual components and do not undergo the extensive testing reserved for complete patterns or solutions.
## Features
- Support for multiple network watchers
- Allows multiple flow logs per network watcher
- utilization of terratest for robust validation
- Provides support for utilizing existing network watchers.
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | ~> 1.0 |
| [azurerm](#requirement\_azurerm) | ~> 4.0 |
## Providers
| Name | Version |
|------|---------|
| [azurerm](#provider\_azurerm) | ~> 4.0 |
## Resources
| Name | Type |
|------|------|
| [azurerm_network_watcher.watcher](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_watcher) | resource |
| [azurerm_network_watcher_flow_log.watcher_flowlog](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_watcher_flow_log) | resource |
| [azurerm_network_watcher.existing_watcher](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/network_watcher) | data source |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [location](#input\_location) | default azure region to be used. | `string` | `null` | no |
| [naming](#input\_naming) | Used for naming purposes | `map(string)` | `null` | no |
| [resource\_group](#input\_resource\_group) | default resource group to be used. | `string` | `null` | no |
| [tags](#input\_tags) | tags to be added to the resources | `map(string)` | `{}` | no |
| [watchers](#input\_watchers) | network watcher configuration | `any` | n/a | yes |
## Outputs
| Name | Description |
|------|-------------|
| [flowlog](#output\_flowlog) | contains all network watcher flow log details |
| [watcher](#output\_watcher) | contains network watcher details |
## Testing
For more information, please see our testing [guidelines](./TESTING.md)
## Notes
Using a dedicated module, we've developed a naming convention for resources that's based on specific regular expressions for each type, ensuring correct abbreviations and offering flexibility with multiple prefixes and suffixes.
Full examples detailing all usages, along with integrations with dependency modules, are located in the examples directory.
To update the module's documentation run `make doc`
## Authors
Module is maintained by [these awesome contributors](https://github.com/cloudnationhq/terraform-azure-nw/graphs/contributors).
## Contributing
We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your input is highly valued.
For more information, please see our contribution [guidelines](./CONTRIBUTING.md).
## License
MIT Licensed. See [LICENSE](./LICENSE) for full details.
## References
- [Documentation](https://learn.microsoft.com/en-us/azure/network-watcher/network-watcher-overview)
- [Rest Api](https://learn.microsoft.com/en-us/rest/api/network-watcher/)