Merge pull request #22 from johanneswuerbach/include-features

chore: include feature details
humanitec-architecture · Apr 17, 2024 · 83c7cea · 83c7cea
2 parents e1aacf0 + 99d9bab
commit 83c7cea
Show file tree

Hide file tree

Showing 38 changed files with 223 additions and 183 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/dns/README.md b/examples/dns/README.md
@@ -1,6 +1,7 @@
 # Example: dns resource based on AWS Route 53
 
 ## Configuration
+
 This example configures a [dns](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#dns) Resource Definition using AWS Route 53. A workload using the `dns` resource to create dns records looks like:
 
 ```yaml
@@ -34,8 +35,10 @@ graph LR;
   workload_3 --> shared.dns_1["shared.dns_1, resource_type: dns"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -44,21 +47,21 @@ graph LR;
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | aws | ~> 5.0 |
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | route53 | ../../humanitec-resource-defs/dns/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -70,7 +73,7 @@ graph LR;
 | [random_password.external_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
 | [aws_iam_policy_document.instance_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/mysql/aurora/README.md b/examples/mysql/aurora/README.md
@@ -1,6 +1,7 @@
 # Example: mysql resource based on AWS RDS Aurora
 
 ## Configuration
+
 This example configures a [mysql](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#mysql) Resource Definition using AWS RDS Aurora. A workload using the `mysql` resource to create database instance looks like:
 
 ```yaml
@@ -33,8 +34,10 @@ graph LR;
   workload_3 --> shared.db_1["shared.db_1, resource_type: mysql"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -43,21 +46,21 @@ graph LR;
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | aws | ~> 5.0 |
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | mysql | ../../../humanitec-resource-defs/mysql/aurora | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -69,7 +72,7 @@ graph LR;
 | [random_password.external_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
 | [aws_iam_policy_document.instance_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/mysql/basic/README.md b/examples/mysql/basic/README.md
@@ -1,7 +1,7 @@
 # Example: mysql resource based on AWS RDS
 
-
 ## Configuration
+
 This example configures a [mysql](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#mysql) Resource Definition using AWS RDS. A workload using the `mysql` resource to create database instance looks like:
 
 ```yaml
@@ -34,8 +34,10 @@ graph LR;
   workload_3 --> shared.db_1["shared.db_1, resource_type: mysql"]  
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -44,21 +46,21 @@ graph LR;
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | aws | ~> 5.0 |
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | mysql | ../../../humanitec-resource-defs/mysql/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -72,7 +74,7 @@ graph LR;
 | [random_password.external_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
 | [aws_iam_policy_document.instance_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/postgres/aurora/README.md b/examples/postgres/aurora/README.md
@@ -1,6 +1,7 @@
 # Example: postgres resource based on AWS RDS Aurora
 
 ## Configuration
+
 This example configures a [postgres](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#postgres) Resource Definition using AWS RDS Aurora. A workload using the `postgres` resource to create database instance looks like:
 
 ```yaml
@@ -33,8 +34,10 @@ graph LR;
   workload_3 --> shared.db_1["shared.db_1, resource_type: postgres"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -43,21 +46,21 @@ graph LR;
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | aws | ~> 5.0 |
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | postgres | ../../../humanitec-resource-defs/postgres/aurora | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -69,7 +72,7 @@ graph LR;
 | [random_password.external_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
 | [aws_iam_policy_document.instance_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/postgres/basic/README.md b/examples/postgres/basic/README.md
@@ -1,6 +1,7 @@
 # Example: postgres resource based on AWS RDS
 
 ## Configuration
+
 This example configures a [postgres](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#postgres) Resource Definition using AWS RDS. A workload using the `postgres` resource to create database instance looks like:
 
 ```yaml
@@ -33,8 +34,10 @@ graph LR;
   workload_3 --> shared.db_1["shared.db_1, resource_type: postgres"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -43,21 +46,21 @@ graph LR;
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | aws | ~> 5.0 |
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | postgres | ../../../humanitec-resource-defs/postgres/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -71,7 +74,7 @@ graph LR;
 | [random_password.external_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
 | [aws_iam_policy_document.instance_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/redis/README.md b/examples/redis/README.md
@@ -1,6 +1,7 @@
 # Example: redis resource based on AWS ElastiCache
 
 ## Configuration
+
 This example configures a [redis](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#redis) Resource Definition using AWS ElastiCache. A workload using the `redis` resource to create redis cluster looks like:
 
 ```yaml
@@ -34,8 +35,10 @@ graph LR;
   workload_3 --> shared.cache_1["shared.cache_1, resource_type: redis"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
@@ -44,21 +47,21 @@ graph LR;
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | aws | ~> 5.0 |
 | humanitec | ~> 1.0 |
 | random | ~> 3.5 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | redis | ../../humanitec-resource-defs/redis/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -73,7 +76,7 @@ graph LR;
 | [random_password.external_id](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
 | [aws_iam_policy_document.instance_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|