From 271e6273ab6c9772a07bf05f79ee2814fe783381 Mon Sep 17 00:00:00 2001
From: florianow <64468897+florianow@users.noreply.github.com>
Date: Fri, 14 Jun 2024 14:20:10 +0200
Subject: [PATCH] chore: changing readme path

---
 .../buildingblocks/budget-alert/README.md     |  9 +++-
 .../budget-alert/backplane/README.md          | 54 -------------------
 .../budget-alert/documentation.tf             | 12 -----
 kit/azure/buildingblocks/budget-alert/main.tf | 22 --------
 .../buildingblocks/budget-alert/variables.tf  | 22 --------
 .../buildingblocks/budget-alert/versions.tf   | 11 ----
 .../connectivity/{backplane => }/README.md    |  0
 .../github-repo/{buildingblock => }/README.md |  0
 .../subscription/{backplane => }/README.md    |  0
 9 files changed, 7 insertions(+), 123 deletions(-)
 delete mode 100644 kit/azure/buildingblocks/budget-alert/backplane/README.md
 delete mode 100644 kit/azure/buildingblocks/budget-alert/documentation.tf
 delete mode 100644 kit/azure/buildingblocks/budget-alert/main.tf
 delete mode 100644 kit/azure/buildingblocks/budget-alert/variables.tf
 delete mode 100644 kit/azure/buildingblocks/budget-alert/versions.tf
 rename kit/azure/buildingblocks/connectivity/{backplane => }/README.md (100%)
 rename kit/azure/buildingblocks/github-repo/{buildingblock => }/README.md (100%)
 rename kit/azure/buildingblocks/subscription/{backplane => }/README.md (100%)

diff --git a/kit/azure/buildingblocks/budget-alert/README.md b/kit/azure/buildingblocks/budget-alert/README.md
index 3ec41bda..c8d52064 100644
--- a/kit/azure/buildingblocks/budget-alert/README.md
+++ b/kit/azure/buildingblocks/budget-alert/README.md
@@ -45,5 +45,10 @@ No modules.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_documentation_md"></a> [documentation\_md](#output\_documentation\_md) | n/a |
-<!-- END_TF_DOCS -->
\ No newline at end of file
+| <a name="output_documentation_md"></a> [documentation\_md](#output\_documentation\_md) | Markdown documentation with information about the Budget Alert building block backplane |
+| <a name="output_role_assignment_ids"></a> [role\_assignment\_ids](#output\_role\_assignment\_ids) | The IDs of the role assignments for the service principals. |
+| <a name="output_role_assignment_principal_ids"></a> [role\_assignment\_principal\_ids](#output\_role\_assignment\_principal\_ids) | The principal IDs of the service principals that have been assigned the role. |
+| <a name="output_role_definition_id"></a> [role\_definition\_id](#output\_role\_definition\_id) | The ID of the role definition that enables deployment of the building block to subscriptions. |
+| <a name="output_role_definition_name"></a> [role\_definition\_name](#output\_role\_definition\_name) | The name of the role definition that enables deployment of the building block to subscriptions. |
+| <a name="output_scope"></a> [scope](#output\_scope) | The scope where the role definition and role assignments are applied. |
+<!-- END_TF_DOCS -->
diff --git a/kit/azure/buildingblocks/budget-alert/backplane/README.md b/kit/azure/buildingblocks/budget-alert/backplane/README.md
deleted file mode 100644
index 4982e357..00000000
--- a/kit/azure/buildingblocks/budget-alert/backplane/README.md
+++ /dev/null
@@ -1,54 +0,0 @@
----
-name: Azure Building Block - Subscription Budget Alert
-summary: |
-  Building block module for adding a simple monthly budget alert to a subscription.
----
-
-# Azure Subscription Budget Alert
-
-This documentation is intended as a reference documentation for cloud foundation or platform engineers using this module.
-
-## Permissions
-
-This is a very simple building block, which means we let the SPN have access to deploy budget alerts
-across all subscriptions underneath a management group (typically the top-level management group for landing zones).
-
-<!-- BEGIN_TF_DOCS -->
-## Requirements
-
-| Name | Version |
-|------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
-| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 3.71.0 |
-
-## Modules
-
-No modules.
-
-## Resources
-
-| Name | Type |
-|------|------|
-| [azurerm_role_assignment.buildingblock_deploy](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
-| [azurerm_role_definition.buildingblock_deploy](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_definition) | resource |
-| [azurerm_subscription.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subscription) | data source |
-
-## Inputs
-
-| Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:--------:|
-| <a name="input_name"></a> [name](#input\_name) | name of the building block, used for naming resources | `string` | `"budget-alert"` | no |
-| <a name="input_principal_ids"></a> [principal\_ids](#input\_principal\_ids) | set of principal ids that will be granted permissions to deploy the building block | `set(string)` | n/a | yes |
-| <a name="input_scope"></a> [scope](#input\_scope) | Scope where the building block should be deployable, typically the parent of all Landing Zones. | `string` | n/a | yes |
-
-## Outputs
-
-| Name | Description |
-|------|-------------|
-| <a name="output_documentation_md"></a> [documentation\_md](#output\_documentation\_md) | Markdown documentation with information about the Budget Alert building block backplane |
-| <a name="output_role_assignment_ids"></a> [role\_assignment\_ids](#output\_role\_assignment\_ids) | The IDs of the role assignments for the service principals. |
-| <a name="output_role_assignment_principal_ids"></a> [role\_assignment\_principal\_ids](#output\_role\_assignment\_principal\_ids) | The principal IDs of the service principals that have been assigned the role. |
-| <a name="output_role_definition_id"></a> [role\_definition\_id](#output\_role\_definition\_id) | The ID of the role definition that enables deployment of the building block to subscriptions. |
-| <a name="output_role_definition_name"></a> [role\_definition\_name](#output\_role\_definition\_name) | The name of the role definition that enables deployment of the building block to subscriptions. |
-| <a name="output_scope"></a> [scope](#output\_scope) | The scope where the role definition and role assignments are applied. |
-<!-- END_TF_DOCS -->
\ No newline at end of file
diff --git a/kit/azure/buildingblocks/budget-alert/documentation.tf b/kit/azure/buildingblocks/budget-alert/documentation.tf
deleted file mode 100644
index 39fedf4f..00000000
--- a/kit/azure/buildingblocks/budget-alert/documentation.tf
+++ /dev/null
@@ -1,12 +0,0 @@
-output "documentation_md" {
-  value = <<EOF
-# Building Block - Subscription Budget Alert
-
-The Budget Alert Building block configures a simple monthly budget alert for subscriptions.
-We highly recommend (and for some landing zones enforce) that application teams set up an alert as a simple
-mechanism to prevent unintentional cost overruns.
-
-We encourage application teams to deploy additional alerts with fine-grained notification rules according to the
-specific needs of their application and infrastructure.
-EOF
-}
diff --git a/kit/azure/buildingblocks/budget-alert/main.tf b/kit/azure/buildingblocks/budget-alert/main.tf
deleted file mode 100644
index 417c17d5..00000000
--- a/kit/azure/buildingblocks/budget-alert/main.tf
+++ /dev/null
@@ -1,22 +0,0 @@
-data "azurerm_subscription" "current" {
-}
-
-resource "azurerm_role_definition" "buildingblock_deploy" {
-  name        = "${var.name}-deploy"
-  description = "Enables deployment of the ${var.name} building block to subscriptions"
-  scope       = var.scope
-
-  permissions {
-    actions = [
-      "Microsoft.Consumption/budgets/*",
-    ]
-  }
-}
-
-resource "azurerm_role_assignment" "buildingblock_deploy" {
-  for_each = var.principal_ids
-
-  role_definition_id = azurerm_role_definition.buildingblock_deploy.role_definition_resource_id
-  principal_id       = each.value
-  scope              = var.scope
-}
diff --git a/kit/azure/buildingblocks/budget-alert/variables.tf b/kit/azure/buildingblocks/budget-alert/variables.tf
deleted file mode 100644
index ee7d43a2..00000000
--- a/kit/azure/buildingblocks/budget-alert/variables.tf
+++ /dev/null
@@ -1,22 +0,0 @@
-variable "name" {
-  type        = string
-  nullable    = false
-  default     = "budget-alert"
-  description = "name of the building block, used for naming resources"
-  validation {
-    condition     = can(regex("^[-a-z0-9]+$", var.name))
-    error_message = "Only alphanumeric lowercase characters and dashes are allowed"
-  }
-}
-
-variable "scope" {
-  type        = string
-  nullable    = false
-  description = "Scope where the building block should be deployable, typically the parent of all Landing Zones."
-}
-
-variable "principal_ids" {
-  type        = set(string)
-  nullable    = false
-  description = "set of principal ids that will be granted permissions to deploy the building block"
-}
\ No newline at end of file
diff --git a/kit/azure/buildingblocks/budget-alert/versions.tf b/kit/azure/buildingblocks/budget-alert/versions.tf
deleted file mode 100644
index 804ffa0a..00000000
--- a/kit/azure/buildingblocks/budget-alert/versions.tf
+++ /dev/null
@@ -1,11 +0,0 @@
-terraform {
-  required_version = ">= 1.0"
-
-  required_providers {
-    azurerm = {
-      source  = "hashicorp/azurerm"
-      version = "~> 3.71.0"
-    }
-  }
-}
-
diff --git a/kit/azure/buildingblocks/connectivity/backplane/README.md b/kit/azure/buildingblocks/connectivity/README.md
similarity index 100%
rename from kit/azure/buildingblocks/connectivity/backplane/README.md
rename to kit/azure/buildingblocks/connectivity/README.md
diff --git a/kit/azure/buildingblocks/github-repo/buildingblock/README.md b/kit/azure/buildingblocks/github-repo/README.md
similarity index 100%
rename from kit/azure/buildingblocks/github-repo/buildingblock/README.md
rename to kit/azure/buildingblocks/github-repo/README.md
diff --git a/kit/azure/buildingblocks/subscription/backplane/README.md b/kit/azure/buildingblocks/subscription/README.md
similarity index 100%
rename from kit/azure/buildingblocks/subscription/backplane/README.md
rename to kit/azure/buildingblocks/subscription/README.md