This terraform module simplifies the creation and management of kubernetes resources on Azure, offering customizable options for cluster, node pool, network settings, and add-ons to ensure efficient deployment of kubernetes clusters.
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.
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.
| Name | Version |
|---|---|
| terraform | ~> 1.0 |
| azurerm | ~> 4.0 |
| random | ~> 3.0 |
| tls | ~> 4.0 |
| Name | Version |
|---|---|
| azurerm | ~> 4.0 |
| random | ~> 3.0 |
| tls | ~> 4.0 |
| Name | Type |
|---|---|
| azurerm_key_vault_secret.secret | resource |
| azurerm_key_vault_secret.tls_private_key_secret | resource |
| azurerm_key_vault_secret.tls_public_key_secret | resource |
| azurerm_kubernetes_cluster.aks | resource |
| azurerm_kubernetes_cluster_extension.ext | resource |
| azurerm_kubernetes_cluster_node_pool.pools | resource |
| azurerm_role_assignment.role | resource |
| azurerm_user_assigned_identity.cluster_identity | resource |
| random_password.password | resource |
| tls_private_key.tls_key | resource |
| azurerm_subscription.current | data source |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| cluster | contains all aks cluster config | any |
n/a | yes |
| keyvault | keyvault to store secrets | string |
null |
no |
| location | default azure region to be used. | string |
null |
no |
| resource_group | default resource group to be used. | string |
null |
no |
| tags | tags to be added to the resources | map(string) |
{} |
no |
| Name | Description |
|---|---|
| cluster | contains all aks configuration |
| identity | contains the user assigned identity configuration |
| subscription_id | contains the current subscription id |
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.
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
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.
Module is maintained by these awesome contributors.
MIT Licensed. See LICENSE for full details.