diff --git a/docs/.terraform-docs.yaml b/docs/.terraform-docs.yaml index 702851b..4c9cc8f 100644 --- 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 index 27062ee..f963220 100644 --- 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,8 +46,10 @@ graph LR; workload_3 --> shared.dns_1["shared.dns_1, resource_type: dns"] ``` +## Terraform docs + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -54,20 +57,20 @@ graph LR; | 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 index b3c3303..0aead6b 100644 --- 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,8 +83,10 @@ graph LR; workload_3 --> shared.delegator_1 --> shared.gcp-pubsub-subscriber_2["shared.gcp-pubsub-subscriber_2, resource_type: gcp-pubsub-subscriber"] ``` +## Terraform docs + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -83,14 +94,14 @@ graph LR; | 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 index 5a95dc4..b43d63a 100644 --- 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,8 +56,10 @@ graph LR; workload_3 --> shared.delegator_1 --> shared.gcs_2["shared.gcs_2, resource_type: gcs"] ``` +## Terraform docs + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -56,14 +67,14 @@ graph LR; | 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 index e3591d8..4cc52f3 100644 --- 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,8 +57,10 @@ graph LR; shared.db_1 --> server ``` +## Terraform docs + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -60,21 +68,21 @@ graph LR; | 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 index b8de371..3f266cb 100644 --- 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,8 +73,10 @@ graph LR; shared.db_1 --> server ``` +## Terraform docs + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -75,14 +84,14 @@ graph LR; | 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 index 603e81a..7a4c33d 100644 --- 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,8 +44,10 @@ graph LR; workload_3 --> shared.cache_1["shared.cache_1, resource_type: redis"] ``` +## Terraform docs + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -52,20 +55,20 @@ graph LR; | 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 | |------|-------------|------|---------|:--------:| diff --git a/humanitec-resource-defs/dns/basic/README.md b/humanitec-resource-defs/dns/basic/README.md index 29e376d..325d117 100644 --- a/humanitec-resource-defs/dns/basic/README.md +++ b/humanitec-resource-defs/dns/basic/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -32,7 +32,7 @@ | resource\_packs\_gcp\_rev | n/a | `string` | `"ref/heads/main"` | no | | resource\_packs\_gcp\_url | n/a | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/gcp-iam-policy-binding/basic/README.md b/humanitec-resource-defs/gcp-iam-policy-binding/basic/README.md index f3cfc98..5b7f7b7 100644 --- a/humanitec-resource-defs/gcp-iam-policy-binding/basic/README.md +++ b/humanitec-resource-defs/gcp-iam-policy-binding/basic/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -29,7 +29,7 @@ | scope\_value | The name of the resource the scope is applied to, e.g. my-bucket or my-topic | `string` | n/a | yes | | type | The type of binding that should be created, e.g. storage\_bucket or pubsub\_topic | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/gcp-pubsub-subscription/basic/README.md b/humanitec-resource-defs/gcp-pubsub-subscription/basic/README.md index 301b1cb..5e24ca4 100644 --- a/humanitec-resource-defs/gcp-pubsub-subscription/basic/README.md +++ b/humanitec-resource-defs/gcp-pubsub-subscription/basic/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | resource\_packs\_gcp\_rev | GCP Resource Pack git ref | `string` | `"refs/heads/main"` | no | | resource\_packs\_gcp\_url | GCP Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/gcp-pubsub-subscription/delegator/README.md b/humanitec-resource-defs/gcp-pubsub-subscription/delegator/README.md index 19a0720..7ec57e0 100644 --- a/humanitec-resource-defs/gcp-pubsub-subscription/delegator/README.md +++ b/humanitec-resource-defs/gcp-pubsub-subscription/delegator/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -26,7 +26,7 @@ | policy\_resource\_class | n/a | `string` | n/a | yes | | prefix | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/gcp-pubsub-topic/basic/README.md b/humanitec-resource-defs/gcp-pubsub-topic/basic/README.md index 301b1cb..5e24ca4 100644 --- a/humanitec-resource-defs/gcp-pubsub-topic/basic/README.md +++ b/humanitec-resource-defs/gcp-pubsub-topic/basic/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | resource\_packs\_gcp\_rev | GCP Resource Pack git ref | `string` | `"refs/heads/main"` | no | | resource\_packs\_gcp\_url | GCP Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/gcp-pubsub-topic/delegator/README.md b/humanitec-resource-defs/gcp-pubsub-topic/delegator/README.md index 13ae322..9b420bb 100644 --- a/humanitec-resource-defs/gcp-pubsub-topic/delegator/README.md +++ b/humanitec-resource-defs/gcp-pubsub-topic/delegator/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -26,7 +26,7 @@ | policy\_resource\_class | n/a | `string` | n/a | yes | | prefix | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/gcp-service-account/workload/README.md b/humanitec-resource-defs/gcp-service-account/workload/README.md index 4cefcc4..b2e7a89 100644 --- a/humanitec-resource-defs/gcp-service-account/workload/README.md +++ b/humanitec-resource-defs/gcp-service-account/workload/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -31,7 +31,7 @@ | resource\_packs\_gcp\_url | GCP Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | | roles | List of roles to assign to the service account | `set(string)` | `[]` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/gcs/basic/README.md b/humanitec-resource-defs/gcs/basic/README.md index e914f8d..d39d8b7 100644 --- a/humanitec-resource-defs/gcs/basic/README.md +++ b/humanitec-resource-defs/gcs/basic/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -32,7 +32,7 @@ | resource\_packs\_gcp\_rev | GCP Resource Pack git ref | `string` | `"refs/heads/main"` | no | | resource\_packs\_gcp\_url | GCP Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/gcs/delegator/README.md b/humanitec-resource-defs/gcs/delegator/README.md index c12e527..51316dd 100644 --- a/humanitec-resource-defs/gcs/delegator/README.md +++ b/humanitec-resource-defs/gcs/delegator/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -26,7 +26,7 @@ | policy\_resource\_class | n/a | `string` | n/a | yes | | prefix | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/k8s/service-account/README.md b/humanitec-resource-defs/k8s/service-account/README.md index 34f56fc..ab640e1 100644 --- a/humanitec-resource-defs/k8s/service-account/README.md +++ b/humanitec-resource-defs/k8s/service-account/README.md @@ -1,30 +1,30 @@ -## 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 | |------|-------------|------|---------|:--------:| | prefix | n/a | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/mysql-instance/basic/README.md b/humanitec-resource-defs/mysql-instance/basic/README.md index 6b37838..b859c5b 100644 --- a/humanitec-resource-defs/mysql-instance/basic/README.md +++ b/humanitec-resource-defs/mysql-instance/basic/README.md @@ -1,24 +1,24 @@ -## 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\_gcp\_rev | n/a | `string` | `"ref/heads/main"` | no | | resource\_packs\_gcp\_url | n/a | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/mysql/basic/README.md b/humanitec-resource-defs/mysql/basic/README.md index 250f41f..3d5b8e3 100644 --- a/humanitec-resource-defs/mysql/basic/README.md +++ b/humanitec-resource-defs/mysql/basic/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -32,7 +32,7 @@ | resource\_packs\_gcp\_rev | n/a | `string` | `"ref/heads/main"` | no | | resource\_packs\_gcp\_url | n/a | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/postgres-instance/basic/README.md b/humanitec-resource-defs/postgres-instance/basic/README.md index 6b37838..b859c5b 100644 --- a/humanitec-resource-defs/postgres-instance/basic/README.md +++ b/humanitec-resource-defs/postgres-instance/basic/README.md @@ -1,24 +1,24 @@ -## 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\_gcp\_rev | n/a | `string` | `"ref/heads/main"` | no | | resource\_packs\_gcp\_url | n/a | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/postgres/basic/README.md b/humanitec-resource-defs/postgres/basic/README.md index 250f41f..3d5b8e3 100644 --- a/humanitec-resource-defs/postgres/basic/README.md +++ b/humanitec-resource-defs/postgres/basic/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -32,7 +32,7 @@ | resource\_packs\_gcp\_rev | n/a | `string` | `"ref/heads/main"` | no | | resource\_packs\_gcp\_url | n/a | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/postgres/workload-identity/README.md b/humanitec-resource-defs/postgres/workload-identity/README.md index 71dfe9d..7bbefa9 100644 --- a/humanitec-resource-defs/postgres/workload-identity/README.md +++ b/humanitec-resource-defs/postgres/workload-identity/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -33,7 +33,7 @@ | resource\_packs\_gcp\_rev | n/a | `string` | `"ref/heads/main"` | no | | resource\_packs\_gcp\_url | n/a | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/redis/basic/README.md b/humanitec-resource-defs/redis/basic/README.md index 9db8261..3bfa462 100644 --- a/humanitec-resource-defs/redis/basic/README.md +++ b/humanitec-resource-defs/redis/basic/README.md @@ -1,24 +1,24 @@ -## 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 | |------|-------------|------|---------|:--------:| @@ -40,7 +40,7 @@ | resource\_packs\_gcp\_url | n/a | `string` | `"https://github.com/humanitec-architecture/resource-packs-gcp.git"` | no | | weekly\_maintenance\_windows | n/a | `any` | `{}` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/workload/service-account/README.md b/humanitec-resource-defs/workload/service-account/README.md index 34f56fc..ab640e1 100644 --- a/humanitec-resource-defs/workload/service-account/README.md +++ b/humanitec-resource-defs/workload/service-account/README.md @@ -1,30 +1,30 @@ -## 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 | |------|-------------|------|---------|:--------:| | prefix | n/a | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/cloudsql-instance/basic/README.md b/modules/cloudsql-instance/basic/README.md index e25bbb6..4daf251 100644 --- a/modules/cloudsql-instance/basic/README.md +++ b/modules/cloudsql-instance/basic/README.md @@ -1,5 +1,5 @@ -## Requirements +### Requirements | Name | Version | |------|---------| @@ -7,19 +7,19 @@ | google | ~> 5.17 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.17 | -## Resources +### Resources | Name | Type | |------|------| | [google_sql_database_instance.main](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/sql_database_instance) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -35,7 +35,7 @@ | tier | The machine type to use. | `string` | n/a | yes | | name | Resource name | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/cloudsql/basic/README.md b/modules/cloudsql/basic/README.md index c0db684..03b5dbc 100644 --- a/modules/cloudsql/basic/README.md +++ b/modules/cloudsql/basic/README.md @@ -1,5 +1,5 @@ -## Requirements +### Requirements | Name | Version | |------|---------| @@ -7,14 +7,14 @@ | google | ~> 5.17 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.17 | | random | ~> 3.5 | -## Resources +### Resources | Name | Type | |------|------| @@ -22,7 +22,7 @@ | [google_sql_user.main](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/sql_user) | resource | | [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -36,7 +36,7 @@ | res\_id | n/a | `string` | n/a | yes | | name | Resource name | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/cloudsql/workload-identity/README.md b/modules/cloudsql/workload-identity/README.md index 05995b5..41bb1fc 100644 --- a/modules/cloudsql/workload-identity/README.md +++ b/modules/cloudsql/workload-identity/README.md @@ -1,5 +1,5 @@ -## Requirements +### Requirements | Name | Version | |------|---------| @@ -7,14 +7,14 @@ | google | ~> 5.17 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.17 | | random | ~> 3.5 | -## Resources +### Resources | Name | Type | |------|------| @@ -25,7 +25,7 @@ | [random_integer.proxy_port](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/integer) | resource | | [random_string.service_account_suffix](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -39,7 +39,7 @@ | res\_id | n/a | `string` | n/a | yes | | name | Resource name | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/dns/basic/README.md b/modules/dns/basic/README.md index ac5d834..1593468 100644 --- a/modules/dns/basic/README.md +++ b/modules/dns/basic/README.md @@ -1,24 +1,24 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | google | ~> 5.17 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.17 | -## Resources +### Resources | Name | Type | |------|------| | [google_dns_record_set.main](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/dns_record_set) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -34,7 +34,7 @@ | ipv6\_address | The IPv6 address that the DNS name should resolve to. | `string` | `""` | no | | name | A valid fully qualified domain name that the DNS name should resolve to. | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/gcp-pubsub-subscription/basic/README.md b/modules/gcp-pubsub-subscription/basic/README.md index 0f817c9..765e04d 100644 --- a/modules/gcp-pubsub-subscription/basic/README.md +++ b/modules/gcp-pubsub-subscription/basic/README.md @@ -1,24 +1,24 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | google | ~> 5.1 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.1 | -## Resources +### Resources | Name | Type | |------|------| | [google_pubsub_subscription.main](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/pubsub_subscription) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | topic\_name | Name of the topic resource | `string` | n/a | yes | | name | n/a | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/gcp-pubsub-topic/basic/README.md b/modules/gcp-pubsub-topic/basic/README.md index abf27ef..cbe6266 100644 --- a/modules/gcp-pubsub-topic/basic/README.md +++ b/modules/gcp-pubsub-topic/basic/README.md @@ -1,24 +1,24 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | google | ~> 5.1 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.1 | -## Resources +### Resources | Name | Type | |------|------| | [google_pubsub_topic.main](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/pubsub_topic) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -29,7 +29,7 @@ | res\_id | n/a | `string` | n/a | yes | | name | n/a | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/gcp-service-account/workload/README.md b/modules/gcp-service-account/workload/README.md index 7891ede..d3ce816 100644 --- a/modules/gcp-service-account/workload/README.md +++ b/modules/gcp-service-account/workload/README.md @@ -1,18 +1,18 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | google | ~> 5.17 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.17 | -## Resources +### Resources | Name | Type | |------|------| @@ -24,7 +24,7 @@ | [google_service_account_iam_member.workload_identity_k8s_service_account](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/service_account_iam_member) | resource | | [google_storage_bucket_iam_member.main](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket_iam_member) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -38,7 +38,7 @@ | roles | List of project-level roles to grant to the service account | `set(string)` | n/a | yes | | name | Resource name | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/gcs/basic/README.md b/modules/gcs/basic/README.md index cd7d94e..35d394b 100644 --- a/modules/gcs/basic/README.md +++ b/modules/gcs/basic/README.md @@ -1,24 +1,24 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | google | ~> 5.17 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.17 | -## Resources +### Resources | Name | Type | |------|------| | [google_storage_bucket.main](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -31,7 +31,7 @@ | force\_destroy | Whether to force destroy the bucket when deleting | `bool` | `false` | no | | name | Resource name | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/redis/basic/README.md b/modules/redis/basic/README.md index 5d37ebb..8d035f9 100644 --- a/modules/redis/basic/README.md +++ b/modules/redis/basic/README.md @@ -1,24 +1,24 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | google | ~> 5.17 | -## Providers +### Providers | Name | Version | |------|---------| | google | ~> 5.17 | -## Resources +### Resources | Name | Type | |------|------| | [google_redis_instance.cache](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/redis_instance) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -39,7 +39,7 @@ | reserved\_ip\_range | n/a | `string` | `null` | no | | weekly\_maintenance\_windows | n/a | `any` | `{}` | no | -## Outputs +### Outputs | Name | Description | |------|-------------|