Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: include feature details #22

Merged
merged 1 commit into from
Apr 17, 2024
Merged

chore: include feature details #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.terraform-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ sort:


settings:
indent: 3
anchor: false
hide-empty: true
lockfile: false
13 changes: 8 additions & 5 deletions examples/dns/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -34,8 +35,10 @@ graph LR;
workload_3 --> shared.dns_1["shared.dns_1, resource_type: dns"]
```

## Terraform docs

<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
Expand All @@ -44,21 +47,21 @@ graph LR;
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Providers
### Providers

| Name | Version |
|------|---------|
| aws | ~> 5.0 |
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Modules
### Modules

| Name | Source | Version |
|------|--------|---------|
| route53 | ../../humanitec-resource-defs/dns/basic | n/a |

## Resources
### Resources

| Name | Type |
|------|------|
Expand All @@ -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 |
|------|-------------|------|---------|:--------:|
Expand Down
13 changes: 8 additions & 5 deletions examples/mysql/aurora/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -33,8 +34,10 @@ graph LR;
workload_3 --> shared.db_1["shared.db_1, resource_type: mysql"]
```

## Terraform docs

<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
Expand All @@ -43,21 +46,21 @@ graph LR;
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Providers
### Providers

| Name | Version |
|------|---------|
| aws | ~> 5.0 |
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Modules
### Modules

| Name | Source | Version |
|------|--------|---------|
| mysql | ../../../humanitec-resource-defs/mysql/aurora | n/a |

## Resources
### Resources

| Name | Type |
|------|------|
Expand All @@ -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 |
|------|-------------|------|---------|:--------:|
Expand Down
14 changes: 8 additions & 6 deletions examples/mysql/basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -34,8 +34,10 @@ graph LR;
workload_3 --> shared.db_1["shared.db_1, resource_type: mysql"]
```

## Terraform docs

<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
Expand All @@ -44,21 +46,21 @@ graph LR;
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Providers
### Providers

| Name | Version |
|------|---------|
| aws | ~> 5.0 |
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Modules
### Modules

| Name | Source | Version |
|------|--------|---------|
| mysql | ../../../humanitec-resource-defs/mysql/basic | n/a |

## Resources
### Resources

| Name | Type |
|------|------|
Expand All @@ -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 |
|------|-------------|------|---------|:--------:|
Expand Down
13 changes: 8 additions & 5 deletions examples/postgres/aurora/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -33,8 +34,10 @@ graph LR;
workload_3 --> shared.db_1["shared.db_1, resource_type: postgres"]
```

## Terraform docs

<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
Expand All @@ -43,21 +46,21 @@ graph LR;
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Providers
### Providers

| Name | Version |
|------|---------|
| aws | ~> 5.0 |
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Modules
### Modules

| Name | Source | Version |
|------|--------|---------|
| postgres | ../../../humanitec-resource-defs/postgres/aurora | n/a |

## Resources
### Resources

| Name | Type |
|------|------|
Expand All @@ -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 |
|------|-------------|------|---------|:--------:|
Expand Down
13 changes: 8 additions & 5 deletions examples/postgres/basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -33,8 +34,10 @@ graph LR;
workload_3 --> shared.db_1["shared.db_1, resource_type: postgres"]
```

## Terraform docs

<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
Expand All @@ -43,21 +46,21 @@ graph LR;
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Providers
### Providers

| Name | Version |
|------|---------|
| aws | ~> 5.0 |
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Modules
### Modules

| Name | Source | Version |
|------|--------|---------|
| postgres | ../../../humanitec-resource-defs/postgres/basic | n/a |

## Resources
### Resources

| Name | Type |
|------|------|
Expand All @@ -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 |
|------|-------------|------|---------|:--------:|
Expand Down
13 changes: 8 additions & 5 deletions examples/redis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -34,8 +35,10 @@ graph LR;
workload_3 --> shared.cache_1["shared.cache_1, resource_type: redis"]
```

## Terraform docs

<!-- BEGIN_TF_DOCS -->
## Requirements
### Requirements

| Name | Version |
|------|---------|
Expand All @@ -44,21 +47,21 @@ graph LR;
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Providers
### Providers

| Name | Version |
|------|---------|
| aws | ~> 5.0 |
| humanitec | ~> 1.0 |
| random | ~> 3.5 |

## Modules
### Modules

| Name | Source | Version |
|------|--------|---------|
| redis | ../../humanitec-resource-defs/redis/basic | n/a |

## Resources
### Resources

| Name | Type |
|------|------|
Expand All @@ -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 |
|------|-------------|------|---------|:--------:|
Expand Down
Loading
Loading