feat: Code refresh (#82)

stawii · web-flow · commit 7069b4ba22b9 · 2024-04-12T15:01:48.000+02:00
* vars

* code

* outputs

* docs

* exmples

* no python here

* exmples
diff --git a/.tool-versions b/.tool-versions
@@ -2,4 +2,3 @@ terraform 1.5.7
 terraform-docs 0.17.0
 tflint 0.50.3
 pre-commit 3.7.0
-# python 3.11.2
diff --git a/README.md b/README.md
@@ -14,12 +14,12 @@ What does the module provide?
 
 ```hcl
 module "module_name" {
-  source  = "github.com/opsd-io/module_name?ref=v0.0.1"
+  source = "github.com/opsd-io/terraform-module-template?ref=VERSION"
 
-  # Variables
-  variable_1 = "foo"
-  variable_2 = "bar"
+  name = "module-template"
+  size = 9000
 }
+
 ```
 
 **IMPORTANT**: Make sure not to pin to master because there may be breaking changes between releases.
@@ -29,27 +29,39 @@ module "module_name" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.7 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.5 |
 
 ## Providers
 
-No providers.
+| Name | Version |
+|------|---------|
+| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
 
 ## Modules
 
 No modules.
 
 ## Resources
 
-No resources.
+| Name | Type |
+|------|------|
+| [terraform_data.main](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/resources/data) | resource |
 
 ## Inputs
 
-No inputs.
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_name"></a> [name](#input\_name) | A name for the test resource. | `string` | n/a | yes |
+| <a name="input_parent_id"></a> [parent\_id](#input\_parent\_id) | The ID of the parent resource. Change will trigger a recreation. | `string` | `null` | no |
+| <a name="input_size"></a> [size](#input\_size) | A size for the test resource in MiB. | `number` | `256` | no |
 
 ## Outputs
 
-No outputs.
+| Name | Description |
+|------|-------------|
+| <a name="output_byte_size"></a> [byte\_size](#output\_byte\_size) | The size of the resource, in bytes. |
+| <a name="output_full_name"></a> [full\_name](#output\_full\_name) | The full name of the resource. |
+| <a name="output_id"></a> [id](#output\_id) | A string value unique to the resource instance. |
 <!-- END_TF_DOCS -->
 
 ## Examples of usage
diff --git a/examples/basic/.tool-versions b/examples/basic/.tool-versions
diff --git a/examples/basic/main.tf b/examples/basic/main.tf
@@ -0,0 +1,6 @@
+module "example" {
+  source = "github.com/opsd-io/terraform-module-template?ref=main"
+
+  name = "module-test"
+  size = 9000
+}
diff --git a/examples/basic/outputs.tf b/examples/basic/outputs.tf
@@ -0,0 +1,4 @@
+output "example" {
+  description = "Outputs from example module."
+  value       = module.example
+}
diff --git a/examples/basic/override.tf b/examples/basic/override.tf
@@ -0,0 +1,5 @@
+# Make sure we're using working version (from local directory, not git).
+
+module "example" {
+  source = "./../.."
+}
diff --git a/examples/basic/terraform.tf b/examples/basic/terraform.tf
@@ -0,0 +1,14 @@
+terraform {
+  required_version = ">= 1.5.5"
+
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 5.0.0"
+    }
+  }
+}
+
+provider "aws" {
+  region = "us-east-1"
+}
diff --git a/examples/example_of_use/README.mkdn b/examples/example_of_use/README.mkdn
diff --git a/examples/example_of_use/main.tf b/examples/example_of_use/main.tf
diff --git a/examples/example_of_use/versions.tf b/examples/example_of_use/versions.tf
diff --git a/main.tf b/main.tf
@@ -1,24 +1,36 @@
 terraform {
-  required_version = ">= 1.5.7"
+  required_version = ">= 1.5.5"
 
   required_providers {
-    #    aws = {
-    #      source  = "hashicorp/aws"
-    #      version = ">= 5.44.0"
-    #    }
-    #    azurerm = {
-    #      source  = "hashicorp/azurerm"
-    #      version = ">= 3.98.0"
-    #    }
-    #    digitalocean = {
-    #      source  = "digitalocean/digitalocean"
-    #      version = ">= 2.36.0"
-    #    }
-    #    github = {
-    #      source  = "integrations/github"
-    #      version = ">= 6.2.1"
-    #    }
+    # aws = {
+    #   source  = "hashicorp/aws"
+    #   version = ">= 5.0.0"
+    # }
+    # azurerm = {
+    #   source  = "hashicorp/azurerm"
+    #   version = ">= 3.0.0"
+    # }
+    # digitalocean = {
+    #   source  = "digitalocean/digitalocean"
+    #   version = ">= 2.0.0"
+    # }
+    # github = {
+    #   source  = "integrations/github"
+    #   version = ">= 6.0.0"
+    # }
+    # vault = {
+    #   source  = "hashicorp/vault"
+    #   version = ">= 3.0.0"
+    # }
   }
 }
 
-# TODO: Add resources here.
+resource "terraform_data" "main" {
+  triggers_replace = {
+    parent_id = var.parent_id
+  }
+  input = {
+    full_name = upper(var.name),
+    byte_size = var.size * 1024 * 1024,
+  }
+}
diff --git a/outputs.tf b/outputs.tf
@@ -1,4 +1,14 @@
-# output "variable" {
-#   description = "output variable description"
-#   value       = variable.main.name
-# }
+output "id" {
+  description = "A string value unique to the resource instance."
+  value       = terraform_data.main.id
+}
+
+output "full_name" {
+  description = "The full name of the resource."
+  value       = terraform_data.main.output.full_name
+}
+
+output "byte_size" {
+  description = "The size of the resource, in bytes."
+  value       = terraform_data.main.output.byte_size
+}
diff --git a/variables.tf b/variables.tf
@@ -1,12 +1,17 @@
-# variable "variable_name" {
-#	  description = "variable description"
-#   type        = number
-#   default     = 1
-# }
+variable "name" {
+  description = "A name for the test resource."
+  type        = string
+  nullable    = false
+}
 
-# variable "variable_password" {
-#	  description = "variable description"
-#   type        = string
-#   sensitive   = true
-#   default     = "abc"
-# }
+variable "parent_id" {
+  description = "The ID of the parent resource. Change will trigger a recreation."
+  type        = string
+  default     = null
+}
+
+variable "size" {
+  description = "A size for the test resource in MiB."
+  type        = number
+  default     = 256
+}
