Skip to content

Terraform module which creates automation related resources used by workloads and accelerators.

License

Notifications You must be signed in to change notification settings

CloudNationHQ/terraform-azure-aa

Repository files navigation

Automation Account

This terraform module simplifies the process of creating and managing automation accounts on azure with customizable options and features, offering a flexible and powerful solution for managing azure automation 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 variable objects
  • ability to have multiple credentials for versatile access management
  • utilization of terratest for robust validation
  • capability to add multiple modules, including both generic and powershell modules
  • ability to associate multiple runbooks with one or more schedules
  • dynamic type inference for automation variables

Requirements

Name Version
terraform ~> 1.0
azurerm ~> 3.61

Providers

Name Version
azurerm ~> 3.61

Modules

Name Source
runbooks resource

Resources

Name Type
azurerm_automation_account resource
azurerm_automation_credential resource
azurerm_automation_module resource
azurerm_automation_powershell72_module resource
azurerm_automation_variable_object resource
azurerm_automation_variable_string resource
azurerm_automation_variable_bool resource
azurerm_automation_variable_int resource
azurerm_automation_variable_datetime resource
azurerm_user_assigned_identity resource
azurerm_automation_job_schedule resource
azurerm_automation_runbook resource
azurerm_automation_schedule resource

Inputs

Name Description Type Required
config contains automation account details any yes
naming contains naming convention string yes
location default azure region to be used string no
resource_group default resource group to be used string no
tags tags to be added to the resources map(string) no

Outputs

Name Description
config automation account details

Testing

As a prerequirement, please ensure that both go and terraform are properly installed on your system.

The Makefile includes two distinct variations of tests. The first one is designed to deploy different usage scenarios of the module. These tests are executed by specifying the TF_PATH environment variable, which determines the different usages located in the example directory.

To execute this test, input the command make test TF_PATH=default, substituting default with the specific usage you wish to test.

The second variation is known as a extended test. This one performs additional checks and can be executed without specifying any parameters, using the command make test_extended.

Both are designed to be executed locally and are also integrated into the github workflow.

Each of these tests contributes to the robustness and resilience of the module. They ensure the module performs consistently and accurately under different scenarios and 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.

Authors

Module is maintained by these awesome 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.

License

MIT Licensed. See LICENSE for full details.

References

About

Terraform module which creates automation related resources used by workloads and accelerators.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •