From e34465269c127c5a5e591cab9c59ca72e32b10f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20W=C3=BCrbach?= Date: Fri, 9 Feb 2024 11:21:38 +0100 Subject: [PATCH 1/4] chore: first docs cleanup --- README.md | 23 +++++++++++-------- examples/{route53 => dns}/README.md | 2 +- examples/{route53 => dns}/main.tf | 2 +- examples/{route53 => dns}/providers.tf | 0 .../{route53 => dns}/terraform.tfvars.example | 0 examples/{route53 => dns}/variables.tf | 0 .../{route53 => dns}/basic/README.md | 0 .../{route53 => dns}/basic/main.tf | 2 +- .../{route53 => dns}/basic/outputs.tf | 0 .../{route53 => dns}/basic/providers.tf | 0 .../basic/terraform.tfvars.example | 0 .../{route53 => dns}/basic/variables.tf | 0 modules/{route53 => dns}/basic/README.md | 0 modules/{route53 => dns}/basic/main.tf | 0 modules/{route53 => dns}/basic/outputs.tf | 0 modules/{route53 => dns}/basic/providers.tf | 0 .../basic/terraform.tfvars.example | 0 modules/{route53 => dns}/basic/variables.tf | 0 18 files changed, 17 insertions(+), 12 deletions(-) rename examples/{route53 => dns}/README.md (95%) rename examples/{route53 => dns}/main.tf (91%) rename examples/{route53 => dns}/providers.tf (100%) rename examples/{route53 => dns}/terraform.tfvars.example (100%) rename examples/{route53 => dns}/variables.tf (100%) rename humanitec-resource-defs/{route53 => dns}/basic/README.md (100%) rename humanitec-resource-defs/{route53 => dns}/basic/main.tf (95%) rename humanitec-resource-defs/{route53 => dns}/basic/outputs.tf (100%) rename humanitec-resource-defs/{route53 => dns}/basic/providers.tf (100%) rename humanitec-resource-defs/{route53 => dns}/basic/terraform.tfvars.example (100%) rename humanitec-resource-defs/{route53 => dns}/basic/variables.tf (100%) rename modules/{route53 => dns}/basic/README.md (100%) rename modules/{route53 => dns}/basic/main.tf (100%) rename modules/{route53 => dns}/basic/outputs.tf (100%) rename modules/{route53 => dns}/basic/providers.tf (100%) rename modules/{route53 => dns}/basic/terraform.tfvars.example (100%) rename modules/{route53 => dns}/basic/variables.tf (100%) diff --git a/README.md b/README.md index fe49b90..e3c0388 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,27 @@ --- -A collection of AWS resources ready to be used with [Humanitec](https://humanitec.com/). +The AWS Resource Pack contains various reference implementation of connecting AWS with [Humanitec](https://humanitec.com/). + +You can find more details about Resource Packs and how to use them [inside the Humanitec documentation](https://developer.humanitec.com/platform-orchestrator/resources/resource-packs/). The following resources are included: +* [dns/basic](./humanitec-resource-defs/dns/basic): A `dns` resource using Route 53. * [iam-policy/ecr-create-repository](./humanitec-resource-defs/iam-policy/ecr-create-repository): IAM policy for to create ECR repositories. -* [iam-policy/s3-admin](./humanitec-resource-defs/iam-policy/s3-admin): IAM policy for admin access for a S3 bucket. -* [iam-policy/sqs-admin](./humanitec-resource-defs/iam-policy/sqs-admin): IAM policy for admin access for an SQS queue. +* [iam-policy/s3](./humanitec-resource-defs/iam-policy/s3): IAM policy for for an S3 bucket. +* [iam-policy/sqs](./humanitec-resource-defs/iam-policy/sqs): IAM policy for an SQS queue. * [iam-role/service-account](./humanitec-resource-defs/iam-role/service-account): An assumable IAM role, by a k8s service account. -* [k8s/service-account](./humanitec-resource-defs/k8s/service-account): A k8s service account linked to an IAM role. -* [redis/basic](./humanitec-resource-defs/redis/basic): AWS ElastiCache resource. -* [s3/basic](./humanitec-resource-defs/s3/basic): A basic S3 bucket. -* [sqs/basic](./humanitec-resource-defs/sqs/basic): A basic SQS queue. -* [workload/service-account](./humanitec-resource-defs/workload/service-account): A workload service account. +* [k8s/service-account](./humanitec-resource-defs/k8s/service-account): A `k8s-service-account` linked to an IAM role. +* [rds/aurora](./humanitec-resource-defs/redis/basic): A `postgres` or `mysql` resource using AWS RDS Aurora. +* [rds/basic](./humanitec-resource-defs/redis/basic): A `postgres` or `mysql` resource using AWS RDS. +* [redis/basic](./humanitec-resource-defs/redis/basic): A `redis` resource using AWS ElastiCache. +* [s3/basic](./humanitec-resource-defs/s3/basic): A basic `s3` bucket. +* [sqs/basic](./humanitec-resource-defs/sqs/basic): A basic `sqs` queue. +* [workload/service-account](./humanitec-resource-defs/workload/service-account): Inject a k8s service account into a `workload`. The `humanitec-resource-defs` directory includes the respective resource definitions. The `modules` directory includes the Terraform modules used by the [Humanitec Terraform Driver](https://developer.humanitec.com/integration-and-extensions/drivers/generic-drivers/terraform/) to provision the actual resources. -Checkout `examples/main.tf` for an example application using S3 & SQS. +Checkout `examples/` for example application using the resource definitions listed above. diff --git a/examples/route53/README.md b/examples/dns/README.md similarity index 95% rename from examples/route53/README.md rename to examples/dns/README.md index c27eb00..a9fe29d 100644 --- a/examples/route53/README.md +++ b/examples/dns/README.md @@ -16,7 +16,7 @@ | Name | Source | Version | |------|--------|---------| -| route53 | ../../humanitec-resource-defs/route53/basic | n/a | +| route53 | ../../humanitec-resource-defs/dns/basic | n/a | ## Resources diff --git a/examples/route53/main.tf b/examples/dns/main.tf similarity index 91% rename from examples/route53/main.tf rename to examples/dns/main.tf index 99d3db1..c031dce 100644 --- a/examples/route53/main.tf +++ b/examples/dns/main.tf @@ -8,7 +8,7 @@ resource "humanitec_application" "example" { } module "route53" { - source = "../../humanitec-resource-defs/route53/basic" + source = "../../humanitec-resource-defs/dns/basic" access_key = var.access_key secret_key = var.secret_key diff --git a/examples/route53/providers.tf b/examples/dns/providers.tf similarity index 100% rename from examples/route53/providers.tf rename to examples/dns/providers.tf diff --git a/examples/route53/terraform.tfvars.example b/examples/dns/terraform.tfvars.example similarity index 100% rename from examples/route53/terraform.tfvars.example rename to examples/dns/terraform.tfvars.example diff --git a/examples/route53/variables.tf b/examples/dns/variables.tf similarity index 100% rename from examples/route53/variables.tf rename to examples/dns/variables.tf diff --git a/humanitec-resource-defs/route53/basic/README.md b/humanitec-resource-defs/dns/basic/README.md similarity index 100% rename from humanitec-resource-defs/route53/basic/README.md rename to humanitec-resource-defs/dns/basic/README.md diff --git a/humanitec-resource-defs/route53/basic/main.tf b/humanitec-resource-defs/dns/basic/main.tf similarity index 95% rename from humanitec-resource-defs/route53/basic/main.tf rename to humanitec-resource-defs/dns/basic/main.tf index 19bb985..a1a62da 100644 --- a/humanitec-resource-defs/route53/basic/main.tf +++ b/humanitec-resource-defs/dns/basic/main.tf @@ -14,7 +14,7 @@ resource "humanitec_resource_definition" "main" { values_string = jsonencode({ source = { - path = "modules/route53/basic" + path = "modules/dns/basic" rev = var.resource_packs_aws_rev url = var.resource_packs_aws_url } diff --git a/humanitec-resource-defs/route53/basic/outputs.tf b/humanitec-resource-defs/dns/basic/outputs.tf similarity index 100% rename from humanitec-resource-defs/route53/basic/outputs.tf rename to humanitec-resource-defs/dns/basic/outputs.tf diff --git a/humanitec-resource-defs/route53/basic/providers.tf b/humanitec-resource-defs/dns/basic/providers.tf similarity index 100% rename from humanitec-resource-defs/route53/basic/providers.tf rename to humanitec-resource-defs/dns/basic/providers.tf diff --git a/humanitec-resource-defs/route53/basic/terraform.tfvars.example b/humanitec-resource-defs/dns/basic/terraform.tfvars.example similarity index 100% rename from humanitec-resource-defs/route53/basic/terraform.tfvars.example rename to humanitec-resource-defs/dns/basic/terraform.tfvars.example diff --git a/humanitec-resource-defs/route53/basic/variables.tf b/humanitec-resource-defs/dns/basic/variables.tf similarity index 100% rename from humanitec-resource-defs/route53/basic/variables.tf rename to humanitec-resource-defs/dns/basic/variables.tf diff --git a/modules/route53/basic/README.md b/modules/dns/basic/README.md similarity index 100% rename from modules/route53/basic/README.md rename to modules/dns/basic/README.md diff --git a/modules/route53/basic/main.tf b/modules/dns/basic/main.tf similarity index 100% rename from modules/route53/basic/main.tf rename to modules/dns/basic/main.tf diff --git a/modules/route53/basic/outputs.tf b/modules/dns/basic/outputs.tf similarity index 100% rename from modules/route53/basic/outputs.tf rename to modules/dns/basic/outputs.tf diff --git a/modules/route53/basic/providers.tf b/modules/dns/basic/providers.tf similarity index 100% rename from modules/route53/basic/providers.tf rename to modules/dns/basic/providers.tf diff --git a/modules/route53/basic/terraform.tfvars.example b/modules/dns/basic/terraform.tfvars.example similarity index 100% rename from modules/route53/basic/terraform.tfvars.example rename to modules/dns/basic/terraform.tfvars.example diff --git a/modules/route53/basic/variables.tf b/modules/dns/basic/variables.tf similarity index 100% rename from modules/route53/basic/variables.tf rename to modules/dns/basic/variables.tf From 3073addaffb95aa2156cce2d679bc930df7da2d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20W=C3=BCrbach?= Date: Fri, 9 Feb 2024 11:40:02 +0100 Subject: [PATCH 2/4] chore: example docs --- examples/dns/README.md | 15 ++++++++++++++- .../{rds/aurora-mysql => mysql/aurora}/README.md | 15 ++++++++++++++- .../{rds/aurora-mysql => mysql/aurora}/main.tf | 0 .../aurora-mysql => mysql/aurora}/providers.tf | 0 .../aurora}/terraform.tfvars.example | 0 .../aurora-mysql => mysql/aurora}/variables.tf | 0 .../{rds/basic-mysql => mysql/basic}/README.md | 15 ++++++++++++++- examples/{rds/basic-mysql => mysql/basic}/main.tf | 0 .../aurora-postgres => mysql/basic}/providers.tf | 0 .../basic}/terraform.tfvars.example | 0 .../aurora-postgres => mysql/basic}/variables.tf | 0 .../aurora-postgres => postgres/aurora}/README.md | 15 ++++++++++++++- .../aurora-postgres => postgres/aurora}/main.tf | 0 .../basic-mysql => postgres/aurora}/providers.tf | 0 .../aurora}/terraform.tfvars.example | 0 .../basic-mysql => postgres/aurora}/variables.tf | 0 .../basic-postgres => postgres/basic}/README.md | 15 ++++++++++++++- .../basic-postgres => postgres/basic}/main.tf | 0 .../basic}/providers.tf | 0 .../basic}/terraform.tfvars.example | 0 .../basic}/variables.tf | 0 examples/redis/README.md | 15 ++++++++++++++- examples/s3/README.md | 6 +++--- examples/sqs/README.md | 8 ++++---- 24 files changed, 91 insertions(+), 13 deletions(-) rename examples/{rds/aurora-mysql => mysql/aurora}/README.md (84%) rename examples/{rds/aurora-mysql => mysql/aurora}/main.tf (100%) rename examples/{rds/aurora-mysql => mysql/aurora}/providers.tf (100%) rename examples/{rds/aurora-mysql => mysql/aurora}/terraform.tfvars.example (100%) rename examples/{rds/aurora-mysql => mysql/aurora}/variables.tf (100%) rename examples/{rds/basic-mysql => mysql/basic}/README.md (86%) rename examples/{rds/basic-mysql => mysql/basic}/main.tf (100%) rename examples/{rds/aurora-postgres => mysql/basic}/providers.tf (100%) rename examples/{rds/aurora-postgres => mysql/basic}/terraform.tfvars.example (100%) rename examples/{rds/aurora-postgres => mysql/basic}/variables.tf (100%) rename examples/{rds/aurora-postgres => postgres/aurora}/README.md (83%) rename examples/{rds/aurora-postgres => postgres/aurora}/main.tf (100%) rename examples/{rds/basic-mysql => postgres/aurora}/providers.tf (100%) rename examples/{rds/basic-mysql => postgres/aurora}/terraform.tfvars.example (100%) rename examples/{rds/basic-mysql => postgres/aurora}/variables.tf (100%) rename examples/{rds/basic-postgres => postgres/basic}/README.md (86%) rename examples/{rds/basic-postgres => postgres/basic}/main.tf (100%) rename examples/{rds/basic-postgres => postgres/basic}/providers.tf (100%) rename examples/{rds/basic-postgres => postgres/basic}/terraform.tfvars.example (100%) rename examples/{rds/basic-postgres => postgres/basic}/variables.tf (100%) diff --git a/examples/dns/README.md b/examples/dns/README.md index a9fe29d..69db9b9 100644 --- a/examples/dns/README.md +++ b/examples/dns/README.md @@ -1,3 +1,16 @@ +# Example: dns resource based on AWS Route 53 + +This example configures a [dns](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#dns) resource definition using AWS Route 53. + +The created resource definition can be used in your score file using: + +```yaml +resources: + ... + dns: + type: dns +``` + ## Requirements @@ -36,4 +49,4 @@ | secret\_key | AWS Secret Key | `string` | n/a | yes | | 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 | - \ No newline at end of file + diff --git a/examples/rds/aurora-mysql/README.md b/examples/mysql/aurora/README.md similarity index 84% rename from examples/rds/aurora-mysql/README.md rename to examples/mysql/aurora/README.md index 15c8eb9..ce80375 100644 --- a/examples/rds/aurora-mysql/README.md +++ b/examples/mysql/aurora/README.md @@ -1,3 +1,16 @@ +# Example: mysql resource based on AWS RDS Aurora + +This example configures a [mysql](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#mysql) resource definition using AWS RDS Aurora. + +The created definition can be used in your score file using: + +```yaml +resources: + ... + db: + type: mysql +``` + ## Requirements @@ -42,4 +55,4 @@ | humanitec\_host | Humanitec API host url | `string` | `"https://api.humanitec.io"` | no | | 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 | - \ No newline at end of file + diff --git a/examples/rds/aurora-mysql/main.tf b/examples/mysql/aurora/main.tf similarity index 100% rename from examples/rds/aurora-mysql/main.tf rename to examples/mysql/aurora/main.tf diff --git a/examples/rds/aurora-mysql/providers.tf b/examples/mysql/aurora/providers.tf similarity index 100% rename from examples/rds/aurora-mysql/providers.tf rename to examples/mysql/aurora/providers.tf diff --git a/examples/rds/aurora-mysql/terraform.tfvars.example b/examples/mysql/aurora/terraform.tfvars.example similarity index 100% rename from examples/rds/aurora-mysql/terraform.tfvars.example rename to examples/mysql/aurora/terraform.tfvars.example diff --git a/examples/rds/aurora-mysql/variables.tf b/examples/mysql/aurora/variables.tf similarity index 100% rename from examples/rds/aurora-mysql/variables.tf rename to examples/mysql/aurora/variables.tf diff --git a/examples/rds/basic-mysql/README.md b/examples/mysql/basic/README.md similarity index 86% rename from examples/rds/basic-mysql/README.md rename to examples/mysql/basic/README.md index 7ea2196..d89ba13 100644 --- a/examples/rds/basic-mysql/README.md +++ b/examples/mysql/basic/README.md @@ -1,3 +1,16 @@ +# Example: mysql resource based on AWS RDS + +This example configures a [mysql](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#mysql) resource definition using AWS RDS. + +The created resource definition can be used in your score file using: + +```yaml +resources: + ... + db: + type: mysql +``` + ## Requirements @@ -45,4 +58,4 @@ | humanitec\_host | Humanitec API host url | `string` | `"https://api.humanitec.io"` | no | | 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 | - \ No newline at end of file + diff --git a/examples/rds/basic-mysql/main.tf b/examples/mysql/basic/main.tf similarity index 100% rename from examples/rds/basic-mysql/main.tf rename to examples/mysql/basic/main.tf diff --git a/examples/rds/aurora-postgres/providers.tf b/examples/mysql/basic/providers.tf similarity index 100% rename from examples/rds/aurora-postgres/providers.tf rename to examples/mysql/basic/providers.tf diff --git a/examples/rds/aurora-postgres/terraform.tfvars.example b/examples/mysql/basic/terraform.tfvars.example similarity index 100% rename from examples/rds/aurora-postgres/terraform.tfvars.example rename to examples/mysql/basic/terraform.tfvars.example diff --git a/examples/rds/aurora-postgres/variables.tf b/examples/mysql/basic/variables.tf similarity index 100% rename from examples/rds/aurora-postgres/variables.tf rename to examples/mysql/basic/variables.tf diff --git a/examples/rds/aurora-postgres/README.md b/examples/postgres/aurora/README.md similarity index 83% rename from examples/rds/aurora-postgres/README.md rename to examples/postgres/aurora/README.md index 15c8eb9..f98d0b0 100644 --- a/examples/rds/aurora-postgres/README.md +++ b/examples/postgres/aurora/README.md @@ -1,3 +1,16 @@ +# Example: postgres resource based on AWS RDS Aurora + +This example configures a [postgres](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#postgres) resource definition using AWS RDS Aurora. + +The created resource definition can be used in your score file using: + +```yaml +resources: + ... + db: + type: postgres +``` + ## Requirements @@ -42,4 +55,4 @@ | humanitec\_host | Humanitec API host url | `string` | `"https://api.humanitec.io"` | no | | 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 | - \ No newline at end of file + diff --git a/examples/rds/aurora-postgres/main.tf b/examples/postgres/aurora/main.tf similarity index 100% rename from examples/rds/aurora-postgres/main.tf rename to examples/postgres/aurora/main.tf diff --git a/examples/rds/basic-mysql/providers.tf b/examples/postgres/aurora/providers.tf similarity index 100% rename from examples/rds/basic-mysql/providers.tf rename to examples/postgres/aurora/providers.tf diff --git a/examples/rds/basic-mysql/terraform.tfvars.example b/examples/postgres/aurora/terraform.tfvars.example similarity index 100% rename from examples/rds/basic-mysql/terraform.tfvars.example rename to examples/postgres/aurora/terraform.tfvars.example diff --git a/examples/rds/basic-mysql/variables.tf b/examples/postgres/aurora/variables.tf similarity index 100% rename from examples/rds/basic-mysql/variables.tf rename to examples/postgres/aurora/variables.tf diff --git a/examples/rds/basic-postgres/README.md b/examples/postgres/basic/README.md similarity index 86% rename from examples/rds/basic-postgres/README.md rename to examples/postgres/basic/README.md index 11e4914..70ebcc1 100644 --- a/examples/rds/basic-postgres/README.md +++ b/examples/postgres/basic/README.md @@ -1,3 +1,16 @@ +# Example: postgres resource based on AWS RDS + +This example configures a [postgres](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#postgres) resource definition using AWS RDS. + +The created resource definition can be used in your score file using: + +```yaml +resources: + ... + db: + type: postgres +``` + ## Requirements @@ -45,4 +58,4 @@ | humanitec\_host | Humanitec API host url | `string` | `"https://api.humanitec.io"` | no | | 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 | - \ No newline at end of file + diff --git a/examples/rds/basic-postgres/main.tf b/examples/postgres/basic/main.tf similarity index 100% rename from examples/rds/basic-postgres/main.tf rename to examples/postgres/basic/main.tf diff --git a/examples/rds/basic-postgres/providers.tf b/examples/postgres/basic/providers.tf similarity index 100% rename from examples/rds/basic-postgres/providers.tf rename to examples/postgres/basic/providers.tf diff --git a/examples/rds/basic-postgres/terraform.tfvars.example b/examples/postgres/basic/terraform.tfvars.example similarity index 100% rename from examples/rds/basic-postgres/terraform.tfvars.example rename to examples/postgres/basic/terraform.tfvars.example diff --git a/examples/rds/basic-postgres/variables.tf b/examples/postgres/basic/variables.tf similarity index 100% rename from examples/rds/basic-postgres/variables.tf rename to examples/postgres/basic/variables.tf diff --git a/examples/redis/README.md b/examples/redis/README.md index 78b294a..a323c6d 100644 --- a/examples/redis/README.md +++ b/examples/redis/README.md @@ -1,3 +1,16 @@ +# Example: redis resource based on AWS ElastiCache + +This example configures a [redis](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#redis) resource definition using AWS ElastiCache. + +The created resource definition can be used in your score file using: + +```yaml +resources: + ... + redis: + type: redis +``` + ## Requirements @@ -43,4 +56,4 @@ | name | Name of the example application | `string` | `"redis-test"` | no | | 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 | - \ No newline at end of file + diff --git a/examples/s3/README.md b/examples/s3/README.md index 6881e3b..24f82f4 100644 --- a/examples/s3/README.md +++ b/examples/s3/README.md @@ -1,11 +1,11 @@ -# AWS S3 +# Example: s3 resource based on AWS S3 -This example configures an S3 bucket resource definition, with two different access policies: +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) * `basic-read-only` (read-only access) -Those resources can be used in your score file like: +Those resource definitions can be used in your score file using: ```yaml resources: diff --git a/examples/sqs/README.md b/examples/sqs/README.md index 58baf1a..e4cb4f5 100644 --- a/examples/sqs/README.md +++ b/examples/sqs/README.md @@ -1,16 +1,16 @@ -# AWS SQS +# Example: sqs resource based on AWS SQS -This example configures an SQS queue resource definition, with two different access policies: +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) * `basic-consumer` (allowed to receive messages) -Those resources can be used in your score file like: +Those resource definitions can be used in your score file using: ```yaml resources: ... - sqs: + queue: type: sqs class: basic-publisher ``` From 4629bc56964fa5232e5c9431eef296515a0361c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20W=C3=BCrbach?= Date: Fri, 9 Feb 2024 12:04:36 +0100 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Tobias Babin <140624220+TobiasBabin@users.noreply.github.com> --- README.md | 8 ++++---- examples/dns/README.md | 4 ++-- examples/mysql/aurora/README.md | 4 ++-- examples/mysql/basic/README.md | 4 ++-- examples/postgres/aurora/README.md | 4 ++-- examples/postgres/basic/README.md | 4 ++-- examples/redis/README.md | 4 ++-- examples/s3/README.md | 4 ++-- examples/sqs/README.md | 4 ++-- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e3c0388..2d3ddac 100644 --- a/README.md +++ b/README.md @@ -18,15 +18,15 @@ The following resources are included: * [iam-policy/sqs](./humanitec-resource-defs/iam-policy/sqs): IAM policy for an SQS queue. * [iam-role/service-account](./humanitec-resource-defs/iam-role/service-account): An assumable IAM role, by a k8s service account. * [k8s/service-account](./humanitec-resource-defs/k8s/service-account): A `k8s-service-account` linked to an IAM role. -* [rds/aurora](./humanitec-resource-defs/redis/basic): A `postgres` or `mysql` resource using AWS RDS Aurora. -* [rds/basic](./humanitec-resource-defs/redis/basic): A `postgres` or `mysql` resource using AWS RDS. +* [rds/aurora](./humanitec-resource-defs/rds/aurora): A `postgres` or `mysql` resource using AWS RDS Aurora. +* [rds/basic](./humanitec-resource-defs/rds/basic): A `postgres` or `mysql` resource using AWS RDS. * [redis/basic](./humanitec-resource-defs/redis/basic): A `redis` resource using AWS ElastiCache. * [s3/basic](./humanitec-resource-defs/s3/basic): A basic `s3` bucket. * [sqs/basic](./humanitec-resource-defs/sqs/basic): A basic `sqs` queue. * [workload/service-account](./humanitec-resource-defs/workload/service-account): Inject a k8s service account into a `workload`. -The `humanitec-resource-defs` directory includes the respective resource definitions. +The `humanitec-resource-defs` directory includes the respective Resource Definitions. The `modules` directory includes the Terraform modules used by the [Humanitec Terraform Driver](https://developer.humanitec.com/integration-and-extensions/drivers/generic-drivers/terraform/) to provision the actual resources. -Checkout `examples/` for example application using the resource definitions listed above. +Checkout `examples/` for example usage of the Resource Definitions listed above. diff --git a/examples/dns/README.md b/examples/dns/README.md index 69db9b9..9dc57d3 100644 --- a/examples/dns/README.md +++ b/examples/dns/README.md @@ -1,8 +1,8 @@ # Example: dns resource based on AWS Route 53 -This example configures a [dns](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#dns) resource definition using AWS Route 53. +This example configures a [dns](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#dns) Resource Definition using AWS Route 53. -The created resource definition can be used in your score file using: +The created Resource Definition can be used in your Score file using: ```yaml resources: diff --git a/examples/mysql/aurora/README.md b/examples/mysql/aurora/README.md index ce80375..dc19f90 100644 --- a/examples/mysql/aurora/README.md +++ b/examples/mysql/aurora/README.md @@ -1,8 +1,8 @@ # Example: mysql resource based on AWS RDS Aurora -This example configures a [mysql](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#mysql) resource definition using AWS RDS Aurora. +This example configures a [mysql](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#mysql) Resource Definition using AWS RDS Aurora. -The created definition can be used in your score file using: +The created definition can be used in your Score file using: ```yaml resources: diff --git a/examples/mysql/basic/README.md b/examples/mysql/basic/README.md index d89ba13..450d9e0 100644 --- a/examples/mysql/basic/README.md +++ b/examples/mysql/basic/README.md @@ -1,8 +1,8 @@ # Example: mysql resource based on AWS RDS -This example configures a [mysql](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#mysql) resource definition using AWS RDS. +This example configures a [mysql](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#mysql) Resource Definition using AWS RDS. -The created resource definition can be used in your score file using: +The created Resource Definition can be used in your Score file using: ```yaml resources: diff --git a/examples/postgres/aurora/README.md b/examples/postgres/aurora/README.md index f98d0b0..b487bb7 100644 --- a/examples/postgres/aurora/README.md +++ b/examples/postgres/aurora/README.md @@ -1,8 +1,8 @@ # Example: postgres resource based on AWS RDS Aurora -This example configures a [postgres](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#postgres) resource definition using AWS RDS Aurora. +This example configures a [postgres](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#postgres) Resource Definition using AWS RDS Aurora. -The created resource definition can be used in your score file using: +The created Resource Definition can be used in your Score file using: ```yaml resources: diff --git a/examples/postgres/basic/README.md b/examples/postgres/basic/README.md index 70ebcc1..1bab5b1 100644 --- a/examples/postgres/basic/README.md +++ b/examples/postgres/basic/README.md @@ -1,8 +1,8 @@ # Example: postgres resource based on AWS RDS -This example configures a [postgres](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#postgres) resource definition using AWS RDS. +This example configures a [postgres](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#postgres) Resource Definition using AWS RDS. -The created resource definition can be used in your score file using: +The created Resource Definition can be used in your Score file using: ```yaml resources: diff --git a/examples/redis/README.md b/examples/redis/README.md index a323c6d..1cf8f15 100644 --- a/examples/redis/README.md +++ b/examples/redis/README.md @@ -1,8 +1,8 @@ # Example: redis resource based on AWS ElastiCache -This example configures a [redis](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#redis) resource definition using AWS ElastiCache. +This example configures a [redis](https://developer.humanitec.com/platform-orchestrator/reference/resource-types/#redis) Resource Definition using AWS ElastiCache. -The created resource definition can be used in your score file using: +The created Resource Definition can be used in your Score file using: ```yaml resources: diff --git a/examples/s3/README.md b/examples/s3/README.md index 24f82f4..e3f9b10 100644 --- a/examples/s3/README.md +++ b/examples/s3/README.md @@ -1,11 +1,11 @@ # Example: s3 resource based on AWS S3 -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: +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) * `basic-read-only` (read-only access) -Those resource definitions can be used in your score file using: +Those Resource Definitions can be used in your Score file using: ```yaml resources: diff --git a/examples/sqs/README.md b/examples/sqs/README.md index e4cb4f5..6099783 100644 --- a/examples/sqs/README.md +++ b/examples/sqs/README.md @@ -1,11 +1,11 @@ # Example: sqs resource based on AWS SQS -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: +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) * `basic-consumer` (allowed to receive messages) -Those resource definitions can be used in your score file using: +Those Resource Definitions can be used in your Score file using: ```yaml resources: From 8fb64e4da3431f4d599f8cf18f1f5eafeaeb675c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20W=C3=BCrbach?= Date: Fri, 9 Feb 2024 12:14:52 +0100 Subject: [PATCH 4/4] chore: clarify product name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2d3ddac..b99d2fb 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ --- -The AWS Resource Pack contains various reference implementation of connecting AWS with [Humanitec](https://humanitec.com/). +The AWS Resource Pack contains various reference implementation of connecting AWS with [the Humanitec Platform Orchestrator](https://developer.humanitec.com/platform-orchestrator/overview/). You can find more details about Resource Packs and how to use them [inside the Humanitec documentation](https://developer.humanitec.com/platform-orchestrator/resources/resource-packs/).