Merge pull request #16 from johanneswuerbach/include-features

chore: include feature details
humanitec-architecture · Apr 17, 2024 · 94ec176 · 94ec176
2 parents bdf834e + cb38994
commit 94ec176
Show file tree

Hide file tree

Showing 33 changed files with 206 additions and 160 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 GCP Cloud DNS
 
 ## Configuration
+
 This example configures a [dns](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#dns) Resource Definition using GCP Cloud DNS. A workload using the `dns` resource to create dns records looks like:
 
 ```yaml
@@ -45,29 +46,31 @@ graph LR;
   workload_3 --> shared.dns_1["shared.dns_1, resource_type: dns"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
 | terraform | >= 1.3.0 |
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | dns\_basic | ../../humanitec-resource-defs/dns/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -78,7 +81,7 @@ graph LR;
 | [humanitec_resource_account.humanitec_provisioner](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_account) | resource |
 | [humanitec_resource_definition_criteria.dns_basic](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/gcp-pubsub/README.md b/examples/gcp-pubsub/README.md
@@ -1,6 +1,13 @@
+---
+features:
+- workload-identity
+- multiple-access-classes
+--- 
+
 # Example: gcp-pubsub resource based on Google Cloud Pub/Sub
 
 ## Configuration
+
 This example configures a [gcp-pubsub-topic](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#gcp-pubsub-topic) and a [gcp-pubsub-subscription](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#gcp-pubsub-subscription) Resource Definition using Google Cloud Pub/Sub.
 
 Those Resource Definitions can be used in your Score file using:
@@ -39,6 +46,7 @@ resources:
 ```
 
 ## Infrastructure setup
+
 The workload service account will be automatically assigned to the necessary roles with the selected policies.
 
 ```mermaid
@@ -64,6 +72,7 @@ graph TD;
 ```
 
 ## Orchestrator setup
+
 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
@@ -74,23 +83,25 @@ graph LR;
   workload_3 --> shared.delegator_1 --> shared.gcp-pubsub-subscriber_2["shared.gcp-pubsub-subscriber_2, resource_type: gcp-pubsub-subscriber"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
 | terraform | >= 1.3.0 |
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
@@ -104,7 +115,7 @@ graph LR;
 | pubsub\_topic\_basic | ../../humanitec-resource-defs/gcp-pubsub-topic/basic | n/a |
 | workload | ../../humanitec-resource-defs/workload/service-account | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -123,7 +134,7 @@ graph LR;
 | [humanitec_resource_definition_criteria.pubsub_topic_basic](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 | [humanitec_resource_definition_criteria.workload](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/gcs/README.md b/examples/gcs/README.md
@@ -1,6 +1,13 @@
+---
+features:
+- workload-identity
+- multiple-access-classes
+--- 
+
 # Example: gcs resource based on Google Cloud Storage
 
 ## Configuration
+
 This example configures a [gcs](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#gcs) Resource Definition using Google Cloud Storage, with two different access policies:
 
 * `basic-admin` (full access)
@@ -22,6 +29,7 @@ resources:
 ```
 
 ## Infrastructure setup
+
 The workload service account will be automatically assigned to the necessary role with the selected policy.
 
 ```mermaid
@@ -37,6 +45,7 @@ graph TD;
 ```
 
 ## Orchestrator setup
+
 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
@@ -47,23 +56,25 @@ graph LR;
   workload_3 --> shared.delegator_1 --> shared.gcs_2["shared.gcs_2, resource_type: gcs"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
 | terraform | >= 1.3.0 |
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
@@ -76,7 +87,7 @@ graph LR;
 | k8s\_service\_account | ../../humanitec-resource-defs/k8s/service-account | n/a |
 | workload | ../../humanitec-resource-defs/workload/service-account | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -94,7 +105,7 @@ graph LR;
 | [humanitec_resource_definition_criteria.k8s_service_account](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 | [humanitec_resource_definition_criteria.workload](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/mysql/README.md b/examples/mysql/README.md
@@ -1,3 +1,9 @@
+---
+features:
+- shared-instance
+- static-database-authentication
+--- 
+
 # Example: mysql resource based on GCP CloudSQL
 
 ## Configuration
@@ -51,30 +57,32 @@ graph LR;
     shared.db_1 --> server
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
 | terraform | >= 1.3.0 |
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | mysql | ../../humanitec-resource-defs/mysql/basic | n/a |
 | mysql\_instance | ../../humanitec-resource-defs/mysql-instance/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -90,7 +98,7 @@ graph LR;
 | [humanitec_resource_definition_criteria.mysql_instance](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 | [google_compute_network.network](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/compute_network) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/postgres/README.md b/examples/postgres/README.md
@@ -1,3 +1,10 @@
+---
+features:
+- shared-instance
+- iam-database-authentication
+- workload-identity
+--- 
+
 # Example: postgres resource based on GCP CloudSQL
 
 ## Configuration
@@ -66,23 +73,25 @@ graph LR;
     shared.db_1 --> server
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
 | terraform | >= 1.3.0 |
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
@@ -93,7 +102,7 @@ graph LR;
 | postgres\_instance | ../../humanitec-resource-defs/postgres-instance/basic | n/a |
 | workload | ../../humanitec-resource-defs/workload/service-account | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -113,7 +122,7 @@ graph LR;
 | [humanitec_resource_definition_criteria.workload](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 | [google_compute_network.network](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/compute_network) | data source |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|

diff --git a/examples/redis/basic/README.md b/examples/redis/basic/README.md
@@ -1,6 +1,7 @@
 # Example: redis resource based on GCP Memorystore
 
 ## Configuration
+
 This example configures a [redis](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#redis) Resource Definition using GCP Memorystore. A workload using the `redis` resource to create redis cluster looks like:
 
 ```yaml
@@ -43,29 +44,31 @@ graph LR;
   workload_3 --> shared.cache_1["shared.cache_1, resource_type: redis"]
 ```
 
+## Terraform docs
+
 <!-- BEGIN_TF_DOCS -->
-## Requirements
+### Requirements
 
 | Name | Version |
 |------|---------|
 | terraform | >= 1.3.0 |
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Providers
+### Providers
 
 | Name | Version |
 |------|---------|
 | google | ~> 5.17 |
 | humanitec | ~> 1.0 |
 
-## Modules
+### Modules
 
 | Name | Source | Version |
 |------|--------|---------|
 | redis | ../../../humanitec-resource-defs/redis/basic | n/a |
 
-## Resources
+### Resources
 
 | Name | Type |
 |------|------|
@@ -76,7 +79,7 @@ graph LR;
 | [humanitec_resource_account.humanitec_provisioner](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_account) | resource |
 | [humanitec_resource_definition_criteria.redis](https://registry.terraform.io/providers/humanitec/humanitec/latest/docs/resources/resource_definition_criteria) | resource |
 
-## Inputs
+### Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|