Merge pull request #20 from mateuszjenek/add_diagrams

feat: add infrastructure and orchestrator diagrams
humanitec-architecture · Mar 19, 2024 · 81f8cd0 · 81f8cd0
2 parents d4610d9 + 0618d3a
commit 81f8cd0
Show file tree

Hide file tree

Showing 23 changed files with 210 additions and 146 deletions.
diff --git a/examples/dns/README.md b/examples/dns/README.md
@@ -1,8 +1,7 @@
 # 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:
+## 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
 resources:
@@ -11,6 +10,30 @@ resources:
     type: dns
 ```
 
+## Infrastructure setup
+
+```mermaid
+graph TD;
+  subgraph AWS Hosted zone
+    record["record"]
+  end
+
+  subgraph EKS Cluster
+    pod[workload pod]
+  end
+  record --> pod
+```
+
+## Orchestrator setup
+
+```mermaid
+graph LR;
+  workload_1 --> dns_1["dns_1, resource_type: dns"]
+  workload_2 --> dns_2["dns_2, resource_type: dns"]
+  workload_2 --> shared.dns_1["shared.dns_1, resource_type: dns"]
+  workload_3 --> shared.dns_1["shared.dns_1, resource_type: dns"]
+```
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 

diff --git a/examples/dns/providers.tf b/examples/dns/providers.tf
@@ -9,4 +9,5 @@ terraform {
   required_version = ">= 1.3.0"
 }
 
-provider "humanitec" {}
+provider "humanitec" {
+}
diff --git a/examples/mysql/aurora/README.md b/examples/mysql/aurora/README.md
@@ -1,8 +1,7 @@
 # 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:
+## 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
 resources:
@@ -11,6 +10,29 @@ resources:
     type: mysql
 ```
 
+## Infrastructure setup
+
+```mermaid
+graph TD;
+  subgraph VPC
+    database["MySQl AWS RDS Aurora instance"]
+    subgraph EKS Cluster
+      pod[workload pod]
+    end
+    database -- security group --> pod
+  end
+```
+
+## Orchestrator setup
+
+```mermaid
+graph LR;
+  workload_1 --> db_1["db_1, resource_type: mysql"]
+  workload_2 --> db_2["db_2, resource_type: mysql"]
+  workload_2 --> shared.db_1["shared.db_1, resource_type: mysql"]
+  workload_3 --> shared.db_1["shared.db_1, resource_type: mysql"]
+```
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -44,14 +66,11 @@ resources:
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | access\_key | AWS Access Key | `string` | n/a | yes |
-| humanitec\_org\_id | Humanitec organization where resource definitions will be applied | `string` | n/a | yes |
-| humanitec\_token | Humanitec API token | `string` | n/a | yes |
 | k8s\_node\_security\_group\_id | AWS Security Group ID of the kubernetes nodes to allow access to the AWS RDS cluster | `string` | n/a | yes |
 | region | AWS Region to create resources | `string` | n/a | yes |
 | secret\_key | AWS Secret Key | `string` | n/a | yes |
 | subnet\_ids | AWS Subnet IDs to use for the AWS RDS cluster | `set(string)` | n/a | yes |
 | vpc\_id | AWS VPC ID | `string` | n/a | yes |
-| humanitec\_host | Humanitec API host url | `string` | `"https://api.humanitec.io"` | no |
 | name | Name of the example application | `string` | `"hum-rp-mysql-example"` | no |
 | prefix | Prefix of the created resources | `string` | `"hum-rp-mysql-ex-"` | no |
 | resource\_packs\_aws\_rev | AWS Resource Pack git branch | `string` | `"refs/heads/main"` | no |

diff --git a/examples/mysql/aurora/providers.tf b/examples/mysql/aurora/providers.tf
@@ -23,7 +23,4 @@ provider "aws" {
 }
 
 provider "humanitec" {
-  host   = var.humanitec_host
-  org_id = var.humanitec_org_id
-  token  = var.humanitec_token
 }
diff --git a/examples/mysql/aurora/terraform.tfvars.example b/examples/mysql/aurora/terraform.tfvars.example
@@ -2,15 +2,6 @@
 # AWS Access Key
 access_key = ""
 
-# Humanitec API host url
-humanitec_host = "https://api.humanitec.io"
-
-# Humanitec organization where resource definitions will be applied
-humanitec_org_id = ""
-
-# Humanitec API token
-humanitec_token = ""
-
 # AWS Security Group ID of the kubernetes nodes to allow access to the AWS RDS cluster
 k8s_node_security_group_id = ""
 

diff --git a/examples/mysql/aurora/variables.tf b/examples/mysql/aurora/variables.tf
@@ -13,22 +13,6 @@ variable "region" {
   description = "AWS Region to create resources"
 }
 
-variable "humanitec_org_id" {
-  type        = string
-  description = "Humanitec organization where resource definitions will be applied"
-}
-
-variable "humanitec_token" {
-  type        = string
-  description = "Humanitec API token"
-}
-
-variable "humanitec_host" {
-  type        = string
-  default     = "https://api.humanitec.io"
-  description = "Humanitec API host url"
-}
-
 variable "resource_packs_aws_url" {
   description = "AWS Resource Pack git url"
   type        = string

diff --git 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.
 
-The created Resource Definition can be used in your Score file using:
+## 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
 resources:
@@ -11,6 +11,29 @@ resources:
     type: mysql
 ```
 
+## Infrastructure setup
+
+```mermaid
+graph TD;
+  subgraph VPC
+    database["MySQl AWS RDS instance"]
+    subgraph EKS Cluster
+      pod[workload pod]
+    end
+    database -- security group --> pod
+  end
+```
+
+## Orchestrator setup
+
+```mermaid
+graph LR;
+  workload_1 --> db_1["db_1, resource_type: mysql"]
+  workload_2 --> db_2["db_2, resource_type: mysql"]
+  workload_2 --> shared.db_1["shared.db_1, resource_type: mysql"]
+  workload_3 --> shared.db_1["shared.db_1, resource_type: mysql"]  
+```
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -47,14 +70,11 @@ resources:
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | access\_key | AWS Access Key | `string` | n/a | yes |
-| humanitec\_org\_id | Humanitec organization where resource definitions will be applied | `string` | n/a | yes |
-| humanitec\_token | Humanitec API token | `string` | n/a | yes |
 | k8s\_node\_security\_group\_id | AWS Security Group ID of the kubernetes nodes to allow access to the AWS RDS cluster | `string` | n/a | yes |
 | region | AWS Region to create resources | `string` | n/a | yes |
 | secret\_key | AWS Secret Key | `string` | n/a | yes |
 | subnet\_ids | AWS Subnet IDs to use for the AWS RDS cluster | `set(string)` | n/a | yes |
 | vpc\_id | AWS VPC ID | `string` | n/a | yes |
-| humanitec\_host | Humanitec API host url | `string` | `"https://api.humanitec.io"` | no |
 | name | Name of the example application | `string` | `"hum-rp-mysql-example"` | no |
 | prefix | Prefix of the created resources | `string` | `"hum-rp-mysql-ex-"` | no |
 | resource\_packs\_aws\_rev | AWS Resource Pack git branch | `string` | `"refs/heads/main"` | no |

diff --git a/examples/mysql/basic/providers.tf b/examples/mysql/basic/providers.tf
@@ -23,7 +23,4 @@ provider "aws" {
 }
 
 provider "humanitec" {
-  host   = var.humanitec_host
-  org_id = var.humanitec_org_id
-  token  = var.humanitec_token
 }
diff --git a/examples/mysql/basic/terraform.tfvars.example b/examples/mysql/basic/terraform.tfvars.example
@@ -2,15 +2,6 @@
 # AWS Access Key
 access_key = ""
 
-# Humanitec API host url
-humanitec_host = "https://api.humanitec.io"
-
-# Humanitec organization where resource definitions will be applied
-humanitec_org_id = ""
-
-# Humanitec API token
-humanitec_token = ""
-
 # AWS Security Group ID of the kubernetes nodes to allow access to the AWS RDS cluster
 k8s_node_security_group_id = ""
 

diff --git a/examples/mysql/basic/variables.tf b/examples/mysql/basic/variables.tf
@@ -13,22 +13,6 @@ variable "region" {
   description = "AWS Region to create resources"
 }
 
-variable "humanitec_org_id" {
-  type        = string
-  description = "Humanitec organization where resource definitions will be applied"
-}
-
-variable "humanitec_token" {
-  type        = string
-  description = "Humanitec API token"
-}
-
-variable "humanitec_host" {
-  type        = string
-  default     = "https://api.humanitec.io"
-  description = "Humanitec API host url"
-}
-
 variable "resource_packs_aws_url" {
   description = "AWS Resource Pack git url"
   type        = string

diff --git a/examples/postgres/aurora/README.md b/examples/postgres/aurora/README.md
@@ -1,8 +1,7 @@
 # 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:
+## 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
 resources:
@@ -11,6 +10,29 @@ resources:
     type: postgres
 ```
 
+## Infrastructure setup
+
+```mermaid
+graph TD;
+  subgraph VPC
+    database["Postgres AWS RDS Aurora instance"]
+    subgraph EKS Cluster
+      pod[workload pod]
+    end
+    database -- security group --> pod
+  end
+```
+
+## Orchestrator setup
+
+```mermaid
+graph LR;
+  workload_1 --> db_1["db_1, resource_type: postgres"]
+  workload_2 --> db_2["db_2, resource_type: postgres"]
+  workload_2 --> shared.db_1["shared.db_1, resource_type: postgres"]
+  workload_3 --> shared.db_1["shared.db_1, resource_type: postgres"]
+```
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 
@@ -44,14 +66,11 @@ resources:
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | access\_key | AWS Access Key | `string` | n/a | yes |
-| humanitec\_org\_id | Humanitec organization where resource definitions will be applied | `string` | n/a | yes |
-| humanitec\_token | Humanitec API token | `string` | n/a | yes |
 | k8s\_node\_security\_group\_id | AWS Security Group ID of the kubernetes nodes to allow access to the AWS RDS cluster | `string` | n/a | yes |
 | region | AWS Region to create resources | `string` | n/a | yes |
 | secret\_key | AWS Secret Key | `string` | n/a | yes |
 | subnet\_ids | AWS Subnet IDs to use for the AWS RDS cluster | `set(string)` | n/a | yes |
 | vpc\_id | AWS VPC ID | `string` | n/a | yes |
-| humanitec\_host | Humanitec API host url | `string` | `"https://api.humanitec.io"` | no |
 | name | Name of the example application | `string` | `"hum-rp-postgres-example"` | no |
 | prefix | Prefix of the created resources | `string` | `"hum-rp-postgres-ex-"` | no |
 | resource\_packs\_aws\_rev | AWS Resource Pack git branch | `string` | `"refs/heads/main"` | no |

diff --git a/examples/postgres/aurora/providers.tf b/examples/postgres/aurora/providers.tf
@@ -23,7 +23,4 @@ provider "aws" {
 }
 
 provider "humanitec" {
-  host   = var.humanitec_host
-  org_id = var.humanitec_org_id
-  token  = var.humanitec_token
 }
diff --git a/examples/postgres/aurora/terraform.tfvars.example b/examples/postgres/aurora/terraform.tfvars.example
@@ -2,15 +2,6 @@
 # AWS Access Key
 access_key = ""
 
-# Humanitec API host url
-humanitec_host = "https://api.humanitec.io"
-
-# Humanitec organization where resource definitions will be applied
-humanitec_org_id = ""
-
-# Humanitec API token
-humanitec_token = ""
-
 # AWS Security Group ID of the kubernetes nodes to allow access to the AWS RDS cluster
 k8s_node_security_group_id = ""
 

diff --git a/examples/postgres/aurora/variables.tf b/examples/postgres/aurora/variables.tf
@@ -13,22 +13,6 @@ variable "region" {
   description = "AWS Region to create resources"
 }
 
-variable "humanitec_org_id" {
-  type        = string
-  description = "Humanitec organization where resource definitions will be applied"
-}
-
-variable "humanitec_token" {
-  type        = string
-  description = "Humanitec API token"
-}
-
-variable "humanitec_host" {
-  type        = string
-  default     = "https://api.humanitec.io"
-  description = "Humanitec API host url"
-}
-
 variable "resource_packs_aws_url" {
   description = "AWS Resource Pack git url"
   type        = string