Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cloudnationhq/terraform-azure-kv

Terraform module which creates keyvault resources used by workloads and accelerators.
https://github.com/cloudnationhq/terraform-azure-kv

azure terraform wam

Last synced: 7 days ago
JSON representation

Terraform module which creates keyvault resources used by workloads and accelerators.

Awesome Lists containing this project

README 

        
# Keyvault



 This terraform module simplifies the creation and management of azure key vault resources, providing customizable options for access policies, key and secret management, and auditing, all managed 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



- capability to handle keys, secrets, and certificates.

- includes support for certificate issuers.

- utilization of terratest for robust validation.

- supports key rotation policy for enhanced security and compliance.

- integrates seamlessly with private endpoint capabilities for direct and secure connectivity.



## Requirements



| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | ~> 1.0 |

|  [azurerm](#requirement\_azurerm) | ~> 4.0 |

|  [random](#requirement\_random) | ~> 3.6 |

|  [tls](#requirement\_tls) | ~> 4.0 |



## Providers



| Name | Version |

|------|---------|

|  [azurerm](#provider\_azurerm) | ~> 4.0 |

|  [random](#provider\_random) | ~> 3.6 |

|  [tls](#provider\_tls) | ~> 4.0 |



## Resources



| Name | Type |

|------|------|

| [azurerm_key_vault.keyvault](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault) | resource |

| [azurerm_key_vault_certificate.cert](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_certificate) | resource |

| [azurerm_key_vault_certificate_contacts.example](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_certificate_contacts) | resource |

| [azurerm_key_vault_certificate_issuer.issuer](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_certificate_issuer) | resource |

| [azurerm_key_vault_key.kv_keys](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_key) | resource |

| [azurerm_key_vault_secret.secret](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) | resource |

| [azurerm_key_vault_secret.secret_defined](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) | resource |

| [azurerm_key_vault_secret.tls_private_key_secret](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) | resource |

| [azurerm_key_vault_secret.tls_public_key_secret](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) | resource |

| [azurerm_role_assignment.admins](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |

| [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |

| [tls_private_key.tls_key](https://registry.terraform.io/providers/hashicorp/tls/latest/docs/resources/private_key) | resource |

| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) | data source |

| [azurerm_subscription.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subscription) | data source |



## Inputs



| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [location](#input\_location) | default azure region to be used. | `string` | `null` | no |

|  [naming](#input\_naming) | contains naming convention | `map(string)` | `{}` | 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 |

|  [vault](#input\_vault) | describes key vault related configuration | `any` | n/a | yes |



## Outputs



| Name | Description |

|------|-------------|

|  [certs](#output\_certs) | contains all certificates |

|  [keys](#output\_keys) | contains all keys |

|  [secrets](#output\_secrets) | contains all secrets |

|  [subscription\_id](#output\_subscription\_id) | contains the current subscription id |

|  [tls\_private\_keys](#output\_tls\_private\_keys) | contains all tls private keys |

|  [tls\_public\_keys](#output\_tls\_public\_keys) | contains all tls public keys |

|  [vault](#output\_vault) | contains all key vault config |



## 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-kv/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](https://github.com/CloudNationHQ/terraform-azure-kv/blob/main/CONTRIBUTING.md).



## License



MIT Licensed. See [LICENSE](https://github.com/cloudnationhq/terraform-azure-kv/blob/main/LICENSE) for full details.



## References



- [Documentation](https://learn.microsoft.com/en-us/azure/key-vault/)

- [Rest Api](https://learn.microsoft.com/en-us/rest/api/keyvault/)

- [Rest Api Specs](https://github.com/Azure/azure-rest-api-specs/tree/1f449b5a17448f05ce1cd914f8ed75a0b568d130/specification/keyvault)