Merge pull request #16 from johanneswuerbach/include-features

chore: include feature details
humanitec-architecture · Apr 17, 2024 · deebea1 · deebea1
2 parents 6b4c985 + e559175
commit deebea1
Show file tree

Hide file tree

Showing 36 changed files with 209 additions and 179 deletions.
diff --git a/docs/.terraform-docs.yaml b/docs/.terraform-docs.yaml
@@ -9,6 +9,7 @@ sort:
 
 
 settings:
+  indent: 3
   anchor: false
   hide-empty: true
   lockfile: false
diff --git a/examples/blob-storage/README.md b/examples/blob-storage/README.md
@@ -1,3 +1,10 @@
+---
+features:
+- workload-identity
+- multiple-access-classes
+- remote-terraform-state
+--- 
+
 # Example: azure-blob resource based on Azure Blob Storage
 
 ## Configuration
@@ -44,7 +51,6 @@ graph TD;
 
 The Resource Graph is using [delegator resources](https://developer.humanitec.com/platform-orchestrator/examples/resource-graph-patterns/#delegator-resource) to expose shared resources with different access policies.
 
-
 ```mermaid
 graph TD;
     workload_1 --> k8s_sa_1["k8s_service_account_1, resource_type: k8s-service-account"]:::policy 
@@ -64,8 +70,10 @@ graph TD;
     classDef policy fill:#f96
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -75,7 +83,7 @@ graph TD;
 | humanitec | ~> 1.0 |
 | random | ~> 3.6 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
@@ -84,7 +92,7 @@ graph TD;
 | humanitec | ~> 1.0 |
 | random | ~> 3.6 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
@@ -100,7 +108,7 @@ graph TD;
 | role\_definition\_reader | ../../humanitec-resource-defs/azure-role-definition/echo | n/a |
 | workload | ../../humanitec-resource-defs/workload/service-account | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -126,7 +134,7 @@ graph TD;
 | [random_string.storage_account_suffix](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
 | [azurerm_resource_group.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/dns/README.md b/examples/dns/README.md
@@ -37,8 +37,10 @@ graph TD;
     workload_2 --> shared_dns_1
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -47,21 +49,21 @@ graph TD;
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | azuread | ~> 2.47 |
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | dns | ../../humanitec-resource-defs/dns/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -74,7 +76,7 @@ graph TD;
 | [humanitec_resource_definition_criteria.dns](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 | [azurerm_resource_group.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/mysql/README.md b/examples/mysql/README.md
@@ -39,8 +39,10 @@ graph TD;
     workload_2 --> shared_db_1
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -49,21 +51,21 @@ graph TD;
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | azuread | ~> 2.47 |
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | mysql | ../../humanitec-resource-defs/mysql/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -76,7 +78,7 @@ graph TD;
 | [humanitec_resource_definition_criteria.mysql](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 | [azurerm_resource_group.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
@@ -91,4 +93,4 @@ graph TD;
 | prefix | Prefix of the created resources | `string` | `"hum-rp-mysql-ex-"` | no |
 | resource\_packs\_azure\_rev | Azure Resource Pack git branch. | `string` | `"refs/heads/main"` | no |
 | resource\_packs\_azure\_url | Azure Resource Pack git url. | `string` | `"https://github.com/humanitec-architecture/resource-packs-azure.git"` | no |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->
diff --git a/examples/postgres/README.md b/examples/postgres/README.md
@@ -1,3 +1,8 @@
+---
+features:
+- shared-instance
+--- 
+
 # Example: postgres resource based on Azure Database for PostgresSQL
 
 ---
@@ -56,8 +61,10 @@ graph LR;
     shared.db_1 --> server
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -66,22 +73,22 @@ graph LR;
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | azuread | ~> 2.47 |
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | postgres | ../../humanitec-resource-defs/postgres/basic | n/a |
 | postgres\_instance | ../../humanitec-resource-defs/postgres-instance/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -97,7 +104,7 @@ graph LR;
 | [azurerm_resource_group.resource](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
 | [azurerm_resource_group.workload](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/redis/README.md b/examples/redis/README.md
@@ -35,8 +35,10 @@ graph TD;
     workload_2 --> shared_cache_1
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -45,21 +47,21 @@ graph TD;
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | azuread | ~> 2.47 |
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | redis | ../../humanitec-resource-defs/redis/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -72,7 +74,7 @@ graph TD;
 | [humanitec_resource_definition_criteria.redis](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 | [azurerm_resource_group.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
@@ -82,4 +84,4 @@ graph TD;
 | prefix | Prefix of the created resources | `string` | `"hum-rp-redis-ex-"` | no |
 | resource\_packs\_azure\_rev | Azure Resource Pack git branch. | `string` | `"refs/heads/main"` | no |
 | resource\_packs\_azure\_url | Azure Resource Pack git url. | `string` | `"https://github.com/humanitec-architecture/resource-packs-azure.git"` | no |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->
diff --git a/examples/service-bus/README.md b/examples/service-bus/README.md
@@ -1,3 +1,9 @@
+---
+features:
+- workload-identity
+- multiple-access-classes
+--- 
+
 # Example: azure-service-bus-queue resource based on Azure Service Bus Queue
 
 ## Configuration
@@ -61,8 +67,10 @@ graph TD;
     classDef policy fill:#f96
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -71,15 +79,15 @@ graph TD;
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | azuread | ~> 2.47 |
 | azurerm | ~> 3.91 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
@@ -94,7 +102,7 @@ graph TD;
 | service\_bus\_publisher | ../../humanitec-resource-defs/azure-service-bus-queue/delegator | n/a |
 | workload | ../../humanitec-resource-defs/workload/service-account | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -116,7 +124,7 @@ graph TD;
 | [humanitec_resource_definition_criteria.workload](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 | [azurerm_resource_group.main](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
@@ -128,4 +136,4 @@ graph TD;
 | resource\_packs\_azure\_rev | Azure Resource Pack git branch. | `string` | `"refs/heads/main"` | no |
 | resource\_packs\_azure\_url | Azure Resource Pack git url. | `string` | `"https://github.com/humanitec-architecture/resource-packs-azure.git"` | no |
 | sku | Defines which tier to use. | `string` | `"Standard"` | no |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->
diff --git a/humanitec-resource-defs/azure-blob-account/basic/README.md b/humanitec-resource-defs/azure-blob-account/basic/README.md
@@ -1,24 +1,24 @@
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
 | terraform | >= 1.3.0 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | humanitec | ~> 1.0 |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
 | [humanitec_resource_definition.main](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition) | resource |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
@@ -34,7 +34,7 @@
 | resource\_packs\_azure\_url | Azure Resource Pack git url. | `string` | `"https://github.com/humanitec-architecture/resource-packs-azure.git"` | no |
 | terraform\_state | Use terraform remote state. | <pre>object({<br>    subscription_id      = string<br>    resource_group_name  = string<br>    storage_account_name = string<br>    container_name       = string<br>    key_prefix           = optional(string)<br>  })</pre> | `null` | no |
 
-## Outputs
+### Outputs
 
 | Name | Description |
 |------|-------------|