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 b556d6e..7fd277a 100644 --- 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 + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -44,7 +47,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| @@ -52,13 +55,13 @@ graph LR; | 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 index 6ecfd67..5ae59e3 100644 --- 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 + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -43,7 +46,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| @@ -51,13 +54,13 @@ graph LR; | 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 index 40814d2..bedff3b 100644 --- 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 + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -44,7 +46,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| @@ -52,13 +54,13 @@ graph LR; | 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 index 4223b6f..70d9973 100644 --- 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 + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -43,7 +46,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| @@ -51,13 +54,13 @@ graph LR; | 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 index a3ad16b..bc915f3 100644 --- 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 + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -43,7 +46,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| @@ -51,13 +54,13 @@ graph LR; | 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 index a1c89b0..b3c7258 100644 --- 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 + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -44,7 +47,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| @@ -52,13 +55,13 @@ graph LR; | 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 | |------|-------------|------|---------|:--------:| diff --git a/examples/s3/README.md b/examples/s3/README.md index fa68940..ae66bb7 100644 --- a/examples/s3/README.md +++ b/examples/s3/README.md @@ -1,6 +1,13 @@ +--- +features: +- workload-identity +- multiple-access-classes +--- + # Example: s3 resource based on AWS S3 ## Configuration + This example configures a [s3](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#s3) Resource Definition using AWS S3, with two different access policies: * `basic-admin` (full access) @@ -17,6 +24,7 @@ resources: ``` ## Infrastructure setup + The workload service account will be automatically assigned to the necessary AWS IAM Role with the selected IAM Policy. ```mermaid @@ -34,6 +42,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 @@ -44,8 +53,10 @@ graph LR; workload_3 --> shared.delegator_1 --> shared.s3_2["shared.s3_2, resource_type: s3"] ``` +## Terraform docs + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -54,7 +65,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| @@ -62,7 +73,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Modules +### Modules | Name | Source | Version | |------|--------|---------| @@ -75,7 +86,7 @@ graph LR; | s3\_basic\_read\_only | ../../humanitec-resource-defs/s3/delegator | n/a | | workload | ../../humanitec-resource-defs/workload/service-account | n/a | -## Resources +### Resources | Name | Type | |------|------| @@ -94,7 +105,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/sqs/README.md b/examples/sqs/README.md index f2a7668..105d1c6 100644 --- a/examples/sqs/README.md +++ b/examples/sqs/README.md @@ -1,6 +1,13 @@ +--- +features: +- workload-identity +- multiple-access-classes +--- + # Example: sqs resource based on AWS SQS ## Configuration + This example configures a [sqs](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#sqs) Resource Definition using AWS SQS, with two different access policies: * `basic-publisher` (allowed to send messages) @@ -17,6 +24,7 @@ resources: ``` ## Infrastructure setup + The workload service account will be automatically assigned to the necessary AWS IAM Role with the selected IAM Policy. ```mermaid @@ -34,6 +42,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 @@ -44,8 +53,10 @@ graph LR; workload_3 --> shared.delegator_1 --> shared.sqs_2["shared.sqs_2, resource_type: sqs"] ``` +## Terraform docs + -## Requirements +### Requirements | Name | Version | |------|---------| @@ -54,7 +65,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| @@ -62,7 +73,7 @@ graph LR; | humanitec | ~> 1.0 | | random | ~> 3.5 | -## Modules +### Modules | Name | Source | Version | |------|--------|---------| @@ -75,7 +86,7 @@ graph LR; | sqs\_basic\_publisher | ../../humanitec-resource-defs/sqs/delegator | n/a | | workload | ../../humanitec-resource-defs/workload/service-account | n/a | -## Resources +### Resources | Name | Type | |------|------| @@ -94,7 +105,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/humanitec-resource-defs/dns/basic/README.md b/humanitec-resource-defs/dns/basic/README.md index 76fd7c6..2221788 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 | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | resource\_packs\_aws\_rev | AWS Resource Pack git branch | `string` | `"refs/heads/main"` | no | | resource\_packs\_aws\_url | AWS Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-aws.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/iam-policy/ecr-create-repository/README.md b/humanitec-resource-defs/iam-policy/ecr-create-repository/README.md index c5383bf..1259e54 100644 --- a/humanitec-resource-defs/iam-policy/ecr-create-repository/README.md +++ b/humanitec-resource-defs/iam-policy/ecr-create-repository/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 @@ | append\_logs\_to\_error | Append Terraform logs to error messages. | `bool` | `false` | no | | resource\_packs\_aws\_url | AWS Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-aws.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/iam-policy/s3/README.md b/humanitec-resource-defs/iam-policy/s3/README.md index b8142fd..b750593 100644 --- a/humanitec-resource-defs/iam-policy/s3/README.md +++ b/humanitec-resource-defs/iam-policy/s3/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 @@ | append\_logs\_to\_error | Append Terraform logs to error messages. | `bool` | `false` | no | | resource\_packs\_aws\_url | AWS Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-aws.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/iam-policy/sqs/README.md b/humanitec-resource-defs/iam-policy/sqs/README.md index d7ecd84..60a7108 100644 --- a/humanitec-resource-defs/iam-policy/sqs/README.md +++ b/humanitec-resource-defs/iam-policy/sqs/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 @@ | append\_logs\_to\_error | Append Terraform logs to error messages. | `bool` | `false` | no | | resource\_packs\_aws\_url | AWS Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-aws.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/iam-role/service-account/README.md b/humanitec-resource-defs/iam-role/service-account/README.md index 263e462..45269c1 100644 --- a/humanitec-resource-defs/iam-role/service-account/README.md +++ b/humanitec-resource-defs/iam-role/service-account/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 @@ | policy\_classes | Humanitec aws-policy classes to provision by default for this role. | `list(string)` | `[]` | no | | resource\_packs\_aws\_url | AWS Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-aws.git"` | no | -## 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/aurora/README.md b/humanitec-resource-defs/mysql/aurora/README.md index 71d01a2..422184e 100644 --- a/humanitec-resource-defs/mysql/aurora/README.md +++ b/humanitec-resource-defs/mysql/aurora/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 | |------|-------------|------|---------|:--------:| @@ -55,7 +55,7 @@ | storage\_type | n/a | `string` | `"aurora"` | no | | type | n/a | `string` | `"mysql"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/mysql/basic/README.md b/humanitec-resource-defs/mysql/basic/README.md index 6365212..3d9e5ad 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 | |------|-------------|------|---------|:--------:| @@ -62,7 +62,7 @@ | skip\_final\_snapshot | n/a | `bool` | `true` | no | | type | n/a | `string` | `"mysql"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/postgres/aurora/README.md b/humanitec-resource-defs/postgres/aurora/README.md index e8f8212..79dab6e 100644 --- a/humanitec-resource-defs/postgres/aurora/README.md +++ b/humanitec-resource-defs/postgres/aurora/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 | |------|-------------|------|---------|:--------:| @@ -55,7 +55,7 @@ | storage\_type | n/a | `string` | `"aurora"` | no | | type | n/a | `string` | `"postgres"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/postgres/basic/README.md b/humanitec-resource-defs/postgres/basic/README.md index f2ed1e4..d0ae14f 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 | |------|-------------|------|---------|:--------:| @@ -62,7 +62,7 @@ | skip\_final\_snapshot | n/a | `bool` | `true` | no | | type | n/a | `string` | `"postgres"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/redis/basic/README.md b/humanitec-resource-defs/redis/basic/README.md index d9512f5..efd8ea2 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 | |------|-------------|------|---------|:--------:| @@ -35,7 +35,7 @@ | parameter\_group\_name | AWS ElastiCache parameter group name | `string` | `"default.redis7.cluster.on"` | no | | resource\_packs\_aws\_url | AWS Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-aws.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/s3/basic/README.md b/humanitec-resource-defs/s3/basic/README.md index 5962dc4..4fca318 100644 --- a/humanitec-resource-defs/s3/basic/README.md +++ b/humanitec-resource-defs/s3/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 @@ | name | Resource name (can contain placeholders like ${context.app.id}) | `string` | `""` | no | | resource\_packs\_aws\_url | AWS Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-aws.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/s3/delegator/README.md b/humanitec-resource-defs/s3/delegator/README.md index c2836bf..eed57c0 100644 --- a/humanitec-resource-defs/s3/delegator/README.md +++ b/humanitec-resource-defs/s3/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 @@ | prefix | n/a | `string` | n/a | yes | | s3\_resource\_class | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/sqs/basic/README.md b/humanitec-resource-defs/sqs/basic/README.md index 5f55067..6543b02 100644 --- a/humanitec-resource-defs/sqs/basic/README.md +++ b/humanitec-resource-defs/sqs/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 @@ | name | Resource name (can contain placeholders like ${context.app.id}) | `string` | `""` | no | | resource\_packs\_aws\_url | AWS Resource Pack git url | `string` | `"https://github.com/humanitec-architecture/resource-packs-aws.git"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/humanitec-resource-defs/sqs/delegator/README.md b/humanitec-resource-defs/sqs/delegator/README.md index 650791c..c5e522b 100644 --- a/humanitec-resource-defs/sqs/delegator/README.md +++ b/humanitec-resource-defs/sqs/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 @@ | prefix | n/a | `string` | n/a | yes | | sqs\_resource\_class | n/a | `string` | n/a | yes | -## 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/dns/basic/README.md b/modules/dns/basic/README.md index 132e7c3..39d155a 100644 --- a/modules/dns/basic/README.md +++ b/modules/dns/basic/README.md @@ -1,25 +1,25 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| | [aws_route53_record.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | | [aws_route53_zone.hosted_zone](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source | -## 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/iam-policy/ecr-create-repository/README.md b/modules/iam-policy/ecr-create-repository/README.md index d2e2f67..5b5491d 100644 --- a/modules/iam-policy/ecr-create-repository/README.md +++ b/modules/iam-policy/ecr-create-repository/README.md @@ -1,25 +1,25 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| | [aws_iam_policy.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | [aws_iam_policy_document.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -29,7 +29,7 @@ | region | n/a | `string` | n/a | yes | | res\_id | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/iam-policy/s3-admin/README.md b/modules/iam-policy/s3-admin/README.md index f74abbb..13e07b5 100644 --- a/modules/iam-policy/s3-admin/README.md +++ b/modules/iam-policy/s3-admin/README.md @@ -1,25 +1,25 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| | [aws_iam_policy.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | [aws_iam_policy_document.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | res\_id | n/a | `string` | n/a | yes | | s3\_bucket\_arn | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/iam-policy/s3-read-only/README.md b/modules/iam-policy/s3-read-only/README.md index f74abbb..13e07b5 100644 --- a/modules/iam-policy/s3-read-only/README.md +++ b/modules/iam-policy/s3-read-only/README.md @@ -1,25 +1,25 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| | [aws_iam_policy.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | [aws_iam_policy_document.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | res\_id | n/a | `string` | n/a | yes | | s3\_bucket\_arn | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/iam-policy/sqs-admin/README.md b/modules/iam-policy/sqs-admin/README.md index 0c3f414..c6a221a 100644 --- a/modules/iam-policy/sqs-admin/README.md +++ b/modules/iam-policy/sqs-admin/README.md @@ -1,25 +1,25 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| | [aws_iam_policy.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | [aws_iam_policy_document.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | res\_id | n/a | `string` | n/a | yes | | sqs\_queue\_arn | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/iam-policy/sqs-consumer/README.md b/modules/iam-policy/sqs-consumer/README.md index 0c3f414..c6a221a 100644 --- a/modules/iam-policy/sqs-consumer/README.md +++ b/modules/iam-policy/sqs-consumer/README.md @@ -1,25 +1,25 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| | [aws_iam_policy.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | [aws_iam_policy_document.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | res\_id | n/a | `string` | n/a | yes | | sqs\_queue\_arn | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/iam-policy/sqs-publisher/README.md b/modules/iam-policy/sqs-publisher/README.md index 0c3f414..c6a221a 100644 --- a/modules/iam-policy/sqs-publisher/README.md +++ b/modules/iam-policy/sqs-publisher/README.md @@ -1,25 +1,25 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| | [aws_iam_policy.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource | | [aws_iam_policy_document.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -30,7 +30,7 @@ | res\_id | n/a | `string` | n/a | yes | | sqs\_queue\_arn | n/a | `string` | n/a | yes | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/iam-role/service-account/README.md b/modules/iam-role/service-account/README.md index 19ccd1f..9b4c3e0 100644 --- a/modules/iam-role/service-account/README.md +++ b/modules/iam-role/service-account/README.md @@ -1,18 +1,18 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| @@ -21,7 +21,7 @@ | [aws_iam_role_policy_attachment.policies](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | | [aws_iam_policy_document.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 | |------|-------------|------|---------|:--------:| @@ -35,7 +35,7 @@ | res\_id | n/a | `string` | n/a | yes | | name | Resource name | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/rds/aurora/README.md b/modules/rds/aurora/README.md index 389a648..084f3a6 100644 --- a/modules/rds/aurora/README.md +++ b/modules/rds/aurora/README.md @@ -1,19 +1,19 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Modules +### Modules | Name | Source | Version | |------|--------|---------| | aurora | terraform-aws-modules/rds-aurora/aws | 9.0.0 | | kms | terraform-aws-modules/kms/aws | ~> 2.1 | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -48,7 +48,7 @@ | storage\_encrypted | n/a | `bool` | `true` | no | | storage\_type | n/a | `string` | `"aurora"` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/rds/basic/README.md b/modules/rds/basic/README.md index 03dda1f..3a8cd4c 100644 --- a/modules/rds/basic/README.md +++ b/modules/rds/basic/README.md @@ -1,18 +1,18 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Modules +### Modules | Name | Source | Version | |------|--------|---------| | db | terraform-aws-modules/rds/aws | 6.3.0 | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -54,7 +54,7 @@ | port | n/a | `number` | `5432` | no | | skip\_final\_snapshot | n/a | `bool` | `true` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/redis/basic/README.md b/modules/redis/basic/README.md index 11cd467..9cbc766 100644 --- a/modules/redis/basic/README.md +++ b/modules/redis/basic/README.md @@ -1,5 +1,5 @@ -## Requirements +### Requirements | Name | Version | |------|---------| @@ -7,21 +7,21 @@ | aws | ~> 5.0 | | random | ~> 3.5 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | | random | ~> 3.5 | -## Resources +### Resources | Name | Type | |------|------| | [aws_elasticache_replication_group.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_replication_group) | resource | | [random_password.auth_token](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -38,7 +38,7 @@ | parameter\_group\_name | AWS ElastiCache parameter group name | `string` | `"default.redis7.cluster.on"` | no | | port | Port to use for the AWS ElastiCache cluster | `number` | `6379` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/s3/basic/README.md b/modules/s3/basic/README.md index 0b2e207..d5da93a 100644 --- a/modules/s3/basic/README.md +++ b/modules/s3/basic/README.md @@ -1,18 +1,18 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Providers +### Providers | Name | Version | |------|---------| | aws | ~> 5.0 | -## Resources +### Resources | Name | Type | |------|------| @@ -20,7 +20,7 @@ | [aws_s3_bucket_server_side_encryption_configuration.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource | | [aws_s3_bucket_versioning.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -32,7 +32,7 @@ | force\_destroy | n/a | `bool` | `true` | no | | name | Resource name | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------| diff --git a/modules/sqs/basic/README.md b/modules/sqs/basic/README.md index 5f2b6d7..0520646 100644 --- a/modules/sqs/basic/README.md +++ b/modules/sqs/basic/README.md @@ -1,18 +1,18 @@ -## Requirements +### Requirements | Name | Version | |------|---------| | terraform | >= 1.3.0 | | aws | ~> 5.0 | -## Modules +### Modules | Name | Source | Version | |------|--------|---------| | sqs | terraform-aws-modules/sqs/aws | ~> 4 | -## Inputs +### Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| @@ -23,7 +23,7 @@ | res\_id | n/a | `string` | n/a | yes | | name | Resource name | `string` | `""` | no | -## Outputs +### Outputs | Name | Description | |------|-------------|