Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudnationhq/terraform-azure-mag
Terraform module which creates monitor action groups used by workloads and accelerators.
https://github.com/cloudnationhq/terraform-azure-mag
azure terraform wam
Last synced: about 1 month ago
JSON representation
Terraform module which creates monitor action groups used by workloads and accelerators.
- Host: GitHub
- URL: https://github.com/cloudnationhq/terraform-azure-mag
- Owner: CloudNationHQ
- License: mit
- Created: 2024-08-26T13:12:30.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-11T12:42:58.000Z (about 1 month ago)
- Last Synced: 2024-10-14T20:40:20.450Z (about 1 month ago)
- Topics: azure, terraform, wam
- Language: HCL
- Homepage:
- Size: 104 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
# Monitor Action Groups
This terraform module simplifies the process of creating a monitor action groups on azure with customizable options and features, offering a flexible and powerful solution for managing action groups 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
- offers support for action groups with e-mail and phone notifications.
- utilization of terratest for robust validation.
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | ~> 1.0 |
| [azurerm](#requirement\_azurerm) | ~> 4.0 |
| [random](#requirement\_random) | ~> 3.6 |
## Providers
| Name | Version |
|------|---------|
| [azurerm](#provider\_azurerm) | ~> 4.0 |
## Resources
| Name | Type |
|------|------|
| [azurerm_monitor_action_group.groups](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/monitor_action_group) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [groups](#input\_groups) | describes monitor action group related configuration | `any` | n/a | yes |
| [location](#input\_location) | default azure region to be used. | `string` | `null` | no |
| [resource\_group](#input\_resource\_group) | default resource group to be used. | `string` | `null` | no |
| [tags](#input\_tags) | default tags to be added to the resources | `map(string)` | `{}` | no |
## Outputs
| Name | Description |
|------|-------------|
| [groups](#output\_groups) | monitor action group configuration specifics |
## Testing
Ensure go and terraform are installed.
Run tests for different usage scenarios by specifying the EXAMPLE environment variable. Usage examples are in the examples directory.
To execute a test, run `make test EXAMPLE=default`
Replace default with the specific example you want to test. These tests ensure the module performs reliably across various configurations.
## 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-mag/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/azure-monitor/alerts/action-groups)
- [Rest Api](https://learn.microsoft.com/en-us/rest/api/monitor/action-groups)
- [Rest Api Specs](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/monitor/resource-manager)