|
1 |
| -# terraform-azure-certmanager |
2 |
| -Highly opinionated Terraform management of cert manager on Azure Kubernetes Service (AKS) |
| 1 | +# Terraform managemen of cert-manager on AKS |
| 2 | + |
| 3 | +## Introduction |
| 4 | + |
| 5 | +This module manages cert-manager on AKS (Azure Kubernetes Service) |
| 6 | + |
| 7 | +## K8S requirements |
| 8 | + |
| 9 | +This module requires Kubernetes >= 1.19, see https://cert-manager.io/docs/installation/helm/#option-2-install-crds-as-part-of-the-helm-release |
| 10 | + |
| 11 | +## Usage |
| 12 | + |
| 13 | +Instantiate the module by calling it from Terraform like this: |
| 14 | + |
| 15 | +```hcl |
| 16 | +module "azure-basics" { |
| 17 | + source = "dodevops/certmanager/azure" |
| 18 | + version = "<version>" |
| 19 | +} |
| 20 | +``` |
| 21 | + |
| 22 | + |
| 23 | +<!-- BEGIN_TF_DOCS --> |
| 24 | +## Requirements |
| 25 | + |
| 26 | +No requirements. |
| 27 | + |
| 28 | +## Providers |
| 29 | + |
| 30 | +The following providers are used by this module: |
| 31 | + |
| 32 | +- azurerm |
| 33 | + |
| 34 | +## Modules |
| 35 | + |
| 36 | +No modules. |
| 37 | + |
| 38 | +## Resources |
| 39 | + |
| 40 | +The following resources are used by this module: |
| 41 | + |
| 42 | +- [azurerm_management_lock.resource-group-level](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/management_lock) (resource) |
| 43 | +- [azurerm_proximity_placement_group.ppg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/proximity_placement_group) (resource) |
| 44 | +- [azurerm_resource_group.azure-resource-group](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) (resource) |
| 45 | + |
| 46 | +## Required Inputs |
| 47 | + |
| 48 | +The following input variables are required: |
| 49 | + |
| 50 | +### location |
| 51 | + |
| 52 | +Description: The azure location used for azure |
| 53 | + |
| 54 | +Type: `string` |
| 55 | + |
| 56 | +### project |
| 57 | + |
| 58 | +Description: Three letter project key |
| 59 | + |
| 60 | +Type: `string` |
| 61 | + |
| 62 | +### stage |
| 63 | + |
| 64 | +Description: Stage for this ressource group |
| 65 | + |
| 66 | +Type: `string` |
| 67 | + |
| 68 | +## Optional Inputs |
| 69 | + |
| 70 | +The following input variables are optional (have default values): |
| 71 | + |
| 72 | +### lock |
| 73 | + |
| 74 | +Description: Lock ressource group for deletion |
| 75 | + |
| 76 | +Type: `bool` |
| 77 | + |
| 78 | +Default: `true` |
| 79 | + |
| 80 | +### manage\_proximity\_placement\_group |
| 81 | + |
| 82 | +Description: Manage a proximity placement group for the resource group |
| 83 | + |
| 84 | +Type: `bool` |
| 85 | + |
| 86 | +Default: `true` |
| 87 | + |
| 88 | +### tags |
| 89 | + |
| 90 | +Description: Map of tags for the resources |
| 91 | + |
| 92 | +Type: `map(any)` |
| 93 | + |
| 94 | +Default: `{}` |
| 95 | + |
| 96 | +## Outputs |
| 97 | + |
| 98 | +The following outputs are exported: |
| 99 | + |
| 100 | +### location |
| 101 | + |
| 102 | +Description: The location input variable (can be used for dependency resolution) |
| 103 | + |
| 104 | +### ppg\_id |
| 105 | + |
| 106 | +Description: The ID of the generated proximity placement group |
| 107 | + |
| 108 | +### resource\_group |
| 109 | + |
| 110 | +Description: The name of the generated resource group |
| 111 | +<!-- END_TF_DOCS --> |
| 112 | + |
| 113 | +## Development |
| 114 | + |
| 115 | +Use [terraform-docs](https://terraform-docs.io/) to generate the API documentation by running |
| 116 | + |
| 117 | + terraform fmt . |
| 118 | + terraform-docs . |
0 commit comments