Merge pull request #9 from infraspecdev/docs-updates

Add examples directory reference to README

Author: rajat-tomar

.gitignore

@@ -1,6 +1,5 @@
 .idea/
 terraform.tfstate*
 .terraform*
-examples/terraform.tfstate*
-examples/.terraform*
-.infracost/
+examples/gitlab-shell-runner-setup/terraform.tfstate*
+examples/gitlab-shell-runner-setup.terraform*

README.md

@@ -19,6 +19,10 @@ module "gitlab_shell_runner" {
 }
 ```
 
+## Examples
+
+[Example](examples/gitlab-shell-runner-setup)
+
 
 <!-- BEGIN_TF_DOCS -->
 ## Requirements

examples/gitlab-shell-runner-setup/README.md

@@ -0,0 +1,30 @@
+<!-- BEGIN_TF_DOCS -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.3.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.49.0 |
+
+## Providers
+
+No providers.
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_gitlab_shell_runner"></a> [gitlab\_shell\_runner](#module\_gitlab\_shell\_runner) | ../../ | n/a |
+
+## Resources
+
+No resources.
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.
+<!-- END_TF_DOCS -->

examples/main.tf renamed to examples/gitlab-shell-runner-setup/main.tf

@@ -1,8 +1,7 @@
 module "gitlab_shell_runner" {
-  source = "../"
+  source = "../../"
 
-  ami_id                    = "ami-0addfae420fd47aab"
-  instance_type             = "t2.micro"
+  instance_type             = "t2.medium"
   instance_count            = 2
   vpc_security_group_ids    = ["sg-0b0b0b0b0b0b0b0b0"]
   subnet_id                 = "subnet-0b0e1c4b5b1b1b1b1"

examples/outputs.tf renamed to examples/gitlab-shell-runner-setup/outputs.tf

@@ -7,11 +7,13 @@ variable "ami_id" {
 variable "instance_type" {
   description = "Type of instance to provision"
   type        = string
+  default     = "t2.micro"
 }
 
 variable "instance_count" {
   description = "Number of instances to provision"
   type        = number
+  default     = 1
 }
 
 variable "vpc_security_group_ids" {