Skip to content

Commit 035310b

Browse files
bcarranzabcarranza
committed
add terraform docs
1 parent 2944eb8 commit 035310b

File tree

7 files changed

+209
-6
lines changed

7 files changed

+209
-6
lines changed

‎terraform-modules/digitalocean/droplet/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,45 @@
11
# Droplet
22
Docs: https://registry.terraform.io/providers/digitalocean/digitalocean/latest/docs/resources/droplet
3+
4+
<!-- BEGIN_TF_DOCS -->
5+
## Requirements
6+
7+
| Name | Version |
8+
|------|---------|
9+
| <a name="requirement_digitalocean"></a> [digitalocean](#requirement\_digitalocean) | 2.19.0 |
10+
11+
## Providers
12+
13+
| Name | Version |
14+
|------|---------|
15+
| <a name="provider_digitalocean"></a> [digitalocean](#provider\_digitalocean) | 2.19.0 |
16+
17+
## Modules
18+
19+
No modules.
20+
21+
## Resources
22+
23+
| Name | Type |
24+
|------|------|
25+
| [digitalocean_droplet.this](https://registry.terraform.io/providers/digitalocean/digitalocean/2.19.0/docs/resources/droplet) | resource |
26+
27+
## Inputs
28+
29+
| Name | Description | Type | Default | Required |
30+
|------|-------------|------|---------|:--------:|
31+
| <a name="input_droplet_image"></a> [droplet\_image](#input\_droplet\_image) | (Required) The Droplet image ID or slug | `string` | n/a | yes |
32+
| <a name="input_droplet_monitoring"></a> [droplet\_monitoring](#input\_droplet\_monitoring) | (Optional) Boolean controlling whether monitoring agent is installed. Defaults to false. If set to true, you can configure monitor alert policies monitor alert | `bool` | `false` | no |
33+
| <a name="input_droplet_name"></a> [droplet\_name](#input\_droplet\_name) | (Required) The Droplet name. | `string` | n/a | yes |
34+
| <a name="input_droplet_region"></a> [droplet\_region](#input\_droplet\_region) | (Required) The region to start in. | `string` | n/a | yes |
35+
| <a name="input_droplet_size"></a> [droplet\_size](#input\_droplet\_size) | (Required) The unique slug that indentifies the type of Droplet. You can find a list of available slugs on DigitalOcean API documentation. | `string` | n/a | yes |
36+
| <a name="input_droplet_user_data"></a> [droplet\_user\_data](#input\_droplet\_user\_data) | (Optional) A string of the desired User Data for the Droplet. | `string` | n/a | yes |
37+
| <a name="input_droplet_vpc_uuid"></a> [droplet\_vpc\_uuid](#input\_droplet\_vpc\_uuid) | The ID of the VPC where the Droplet will be located. | `string` | `null` | no |
38+
39+
## Outputs
40+
41+
| Name | Description |
42+
|------|-------------|
43+
| <a name="output_droplet_id"></a> [droplet\_id](#output\_droplet\_id) | The ID of the Droplet |
44+
| <a name="output_droplet_urn"></a> [droplet\_urn](#output\_droplet\_urn) | The uniform resource name of the Droplet |
45+
<!-- END_TF_DOCS -->

‎terraform-modules/digitalocean/droplet/variables.tf‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,9 @@ variable "droplet_vpc_uuid" {
2929
description = "The ID of the VPC where the Droplet will be located."
3030
default = null
3131
}
32+
33+
variable "droplet_user_data" {
34+
type = string
35+
description = "(Optional) A string of the desired User Data for the Droplet."
36+
}
3237

‎terraform-modules/digitalocean/droplet_volume/README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,39 @@
11
# Attach Volume to Droplet
22
Docs: https://registry.terraform.io/providers/digitalocean/digitalocean/latest/docs/resources/volume_attachment
3+
4+
<!-- BEGIN_TF_DOCS -->
5+
## Requirements
6+
7+
| Name | Version |
8+
|------|---------|
9+
| <a name="requirement_digitalocean"></a> [digitalocean](#requirement\_digitalocean) | 2.19.0 |
10+
11+
## Providers
12+
13+
| Name | Version |
14+
|------|---------|
15+
| <a name="provider_digitalocean"></a> [digitalocean](#provider\_digitalocean) | 2.19.0 |
16+
17+
## Modules
18+
19+
No modules.
20+
21+
## Resources
22+
23+
| Name | Type |
24+
|------|------|
25+
| [digitalocean_volume_attachment.this](https://registry.terraform.io/providers/digitalocean/digitalocean/2.19.0/docs/resources/volume_attachment) | resource |
26+
27+
## Inputs
28+
29+
| Name | Description | Type | Default | Required |
30+
|------|-------------|------|---------|:--------:|
31+
| <a name="input_droplet_id"></a> [droplet\_id](#input\_droplet\_id) | (Required) ID of the Droplet to attach the volume to. | `string` | n/a | yes |
32+
| <a name="input_volume_id"></a> [volume\_id](#input\_volume\_id) | (Required) ID of the Volume to be attached to the Droplet. | `string` | n/a | yes |
33+
34+
## Outputs
35+
36+
| Name | Description |
37+
|------|-------------|
38+
| <a name="output_droplet_volume_attachment"></a> [droplet\_volume\_attachment](#output\_droplet\_volume\_attachment) | The unique identifier for the volume attachment. |
39+
<!-- END_TF_DOCS -->

‎terraform-modules/digitalocean/project/README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,43 @@ No resources.
3434
|------|-------------|
3535
| `project_id` | The id of the project |
3636
| `project_owner_uuid` | the unique universal identifier of the project owner. |
37+
38+
<!-- BEGIN_TF_DOCS -->
39+
## Requirements
40+
41+
| Name | Version |
42+
|------|---------|
43+
| <a name="requirement_digitalocean"></a> [digitalocean](#requirement\_digitalocean) | 2.19.0 |
44+
45+
## Providers
46+
47+
| Name | Version |
48+
|------|---------|
49+
| <a name="provider_digitalocean"></a> [digitalocean](#provider\_digitalocean) | 2.19.0 |
50+
51+
## Modules
52+
53+
No modules.
54+
55+
## Resources
56+
57+
| Name | Type |
58+
|------|------|
59+
| [digitalocean_project.this](https://registry.terraform.io/providers/digitalocean/digitalocean/2.19.0/docs/resources/project) | resource |
60+
61+
## Inputs
62+
63+
| Name | Description | Type | Default | Required |
64+
|------|-------------|------|---------|:--------:|
65+
| <a name="input_project_description"></a> [project\_description](#input\_project\_description) | (Optional) The name of description | `string` | `"A project to represent development resources."` | no |
66+
| <a name="input_project_environment"></a> [project\_environment](#input\_project\_environment) | (Optional) Kind of dev, qa or prod | `string` | `"development"` | no |
67+
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | (Required) The name of the project | `string` | `"playground"` | no |
68+
| <a name="input_project_purpose"></a> [project\_purpose](#input\_project\_purpose) | (Optional) A purpose for the project | `string` | `"Web Application"` | no |
69+
70+
## Outputs
71+
72+
| Name | Description |
73+
|------|-------------|
74+
| <a name="output_project_id"></a> [project\_id](#output\_project\_id) | The id of the project |
75+
| <a name="output_project_owner_uuid"></a> [project\_owner\_uuid](#output\_project\_owner\_uuid) | The unique universal identifier of the project owner. |
76+
<!-- END_TF_DOCS -->

‎terraform-modules/digitalocean/volume/README.md‎

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
1-
# Volume
2-
NOTE:
3-
Volumes can be attached either directly on the digitalocean_droplet resource, or using the digitalocean_volume_attachment resource - but the two cannot be used together. If both are used against the same Droplet, the volume attachments will constantly drift.
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_digitalocean"></a> [digitalocean](#requirement\_digitalocean) | 2.19.0 |
7+
8+
## Providers
9+
10+
| Name | Version |
11+
|------|---------|
12+
| <a name="provider_digitalocean"></a> [digitalocean](#provider\_digitalocean) | 2.19.0 |
13+
14+
## Modules
15+
16+
No modules.
17+
18+
## Resources
19+
20+
| Name | Type |
21+
|------|------|
22+
| [digitalocean_volume.this](https://registry.terraform.io/providers/digitalocean/digitalocean/2.19.0/docs/resources/volume) | resource |
23+
24+
## Inputs
25+
26+
| Name | Description | Type | Default | Required |
27+
|------|-------------|------|---------|:--------:|
28+
| <a name="input_volume_description"></a> [volume\_description](#input\_volume\_description) | (Optional) A free-form text field up to a limit of 1024 bytes to describe a block storage volume.. | `string` | n/a | yes |
29+
| <a name="input_volume_initial_filesystem_type"></a> [volume\_initial\_filesystem\_type](#input\_volume\_initial\_filesystem\_type) | (Optional) Initial filesystem type (xfs or ext4) for the block storage volume. | `string` | n/a | yes |
30+
| <a name="input_volume_name"></a> [volume\_name](#input\_volume\_name) | (Required) A name for the block storage volume. Must be lowercase and be composed only of numbers, letters and -, up to a limit of 64 characters. | `string` | n/a | yes |
31+
| <a name="input_volume_region"></a> [volume\_region](#input\_volume\_region) | (Required) The region that the block storage volume will be created in. | `string` | n/a | yes |
32+
| <a name="input_volume_size"></a> [volume\_size](#input\_volume\_size) | (Required) The size of the block storage volume in GiB. If updated, can only be expanded. | `number` | `20` | no |
33+
34+
## Outputs
35+
36+
| Name | Description |
37+
|------|-------------|
38+
| <a name="output_volume_id"></a> [volume\_id](#output\_volume\_id) | The unique identifier for the volume. |
39+
| <a name="output_volume_urn"></a> [volume\_urn](#output\_volume\_urn) | The uniform resource name for the volume. |
40+
<!-- END_TF_DOCS -->

‎terraform-modules/digitalocean/volume/variables.tf‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
12
variable "volume_name" {
23
type = string
3-
description = "(Required) A name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters."
4+
description = "(Required) A name for the block storage volume. Must be lowercase and be composed only of numbers, letters and -, up to a limit of 64 characters."
45
}
56

67
variable "volume_region" {
@@ -10,6 +11,7 @@ variable "volume_region" {
1011

1112
variable "volume_size" {
1213
type = number
14+
default = 20
1315
description = "(Required) The size of the block storage volume in GiB. If updated, can only be expanded."
1416
}
1517

‎terraform-modules/digitalocean/vpc/README.md‎

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
1-
# Documentation under construction
2-
🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃🏃
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_digitalocean"></a> [digitalocean](#requirement\_digitalocean) | 2.19.0 |
7+
8+
## Providers
9+
10+
| Name | Version |
11+
|------|---------|
12+
| <a name="provider_digitalocean"></a> [digitalocean](#provider\_digitalocean) | 2.19.0 |
13+
14+
## Modules
15+
16+
No modules.
17+
18+
## Resources
19+
20+
| Name | Type |
21+
|------|------|
22+
| [digitalocean_vpc.this](https://registry.terraform.io/providers/digitalocean/digitalocean/2.19.0/docs/resources/vpc) | resource |
23+
24+
## Inputs
25+
26+
| Name | Description | Type | Default | Required |
27+
|------|-------------|------|---------|:--------:|
28+
| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | (Optional) The id of the project where the vpc will be associated | `string` | n/a | yes |
29+
| <a name="input_vpc_description"></a> [vpc\_description](#input\_vpc\_description) | (Optional) A free-form text field up to a limit of 255 characters to describe the VPC. | `string` | `"Your new vpc"` | no |
30+
| <a name="input_vpc_ip_range"></a> [vpc\_ip\_range](#input\_vpc\_ip\_range) | (Optional) The range of IP addresses for the VPC in CIDR notation. | `string` | `"10.10.10.0/24"` | no |
31+
| <a name="input_vpc_name"></a> [vpc\_name](#input\_vpc\_name) | (Required) A name for the VPC. Must be unique and contain alphanumeric characters, dashes, and periods only. | `string` | n/a | yes |
32+
| <a name="input_vpc_region"></a> [vpc\_region](#input\_vpc\_region) | (Required) The DigitalOcean region slug for the VPC's location. | `string` | n/a | yes |
33+
34+
## Outputs
35+
36+
| Name | Description |
37+
|------|-------------|
38+
| <a name="output_vpc_default"></a> [vpc\_default](#output\_vpc\_default) | A boolean indicating whether or not the VPC is the default one for the region. |
39+
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The unique identifier for the VPC. |
40+
| <a name="output_vpc_urn"></a> [vpc\_urn](#output\_vpc\_urn) | The uniform resource name (URN) for the VPC. |
41+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)