README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#


# Name of this project
name: Terraform AZURE KEY-VAULT

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-key-vault

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-azure-key-vault.svg"
    url: "https://github.com/clouddrove/terraform-azure-key-vault/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-azure-key-vault/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-azure-key-vault/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"

#  description of this project
description: |-
  Terraform module to create key-vault resource on AZURE.

# extra content
include:
  - "terraform.md"

# How to use this project
# yamllint disable rule:line-length
usage: |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
    #### key-vault with access policy
  ```hcl
   module "key_vault" {
   source                    = "clouddrove/key-vault/azure"
   name                      = "anfdcc"
   environment               = "test"
   label_order               = ["name", "environment", ]
   resource_group_name       = "*****"
   location                  = "*****"
   admin_objects_ids         = [data.azurerm_client_config.current_client_config.object_id]
   virtual_network_id        = "*****"
   subnet_id                 = "*****"
   enable_rbac_authorization = false
   network_acls              = {
    bypass                   = "AzureServices"
    default_action           = "Deny"
    ip_rules                 = ["1.2.3.4/32"]
    }
   #private endpoint
   enable_private_endpoint   = false
   diagnostic_setting_enable = false
   }
  ```
  #### key-vault with RBAC
  ```hcl
   module "key_vault" {
   source                    = "clouddrove/key-vault/azure"
   name                      = "anfdcc"
   environment               = "test"
   label_order               = ["name", "environment", ]
   resource_group_name       = "*****"
   location                  = "*****"
   reader_objects_ids        = [data.azurerm_client_config.current_client_config.object_id]
   admin_objects_ids         = [data.azurerm_client_config.current_client_config.object_id]
   virtual_network_id        = "*****"
   subnet_id                 = "*****"
   enable_rbac_authorization = true
   network_acls              = {
    bypass                   = "AzureServices"
    default_action           = "Deny"
    ip_rules                 = ["1.2.3.4/32"]
    }
   #private endpoint
   enable_private_endpoint   = false
   diagnostic_setting_enable = false
   }
  ```