refa: get rid of code structure lab

why? because we dont need a dedicated lab for it
superluminar-io · May 9, 2022 · 0a5f622 · 0a5f622
1 parent 5ce16c3
commit 0a5f622
Show file tree

Hide file tree

Showing 67 changed files with 36 additions and 226 deletions.
diff --git a/1-static-hosting/README.md b/1-static-hosting/README.md
@@ -1,6 +1,6 @@
 # Static Hosting
 
-Welcome to the first lab! 🥳 Let's get started by bootstrapping Terraform and deploying some resources to AWS. Instead of just deploying some random resources, we want to create a S3 bucket and enable static website hosting. Ultimately, we serve a static HTML file.
+Welcome to the first lab! 🥳 Let's get started by bootstrapping Terraform and deploying some resources to AWS. Instead of just deploying some random resources, we want to create an S3 bucket and enable static website hosting. Ultimately, we serve a static HTML file.
 
 ## Bootstrap Terraform
 
@@ -38,11 +38,11 @@ Welcome to the first lab! 🥳 Let's get started by bootstrapping Terraform and
 
 We just created an empty S3 bucket. Go to the [S3 console](https://s3.console.aws.amazon.com/s3/buckets) and verify the existence. 
 
-What's going on here? We created a simple `.tf` file: Terraform comes with its own syntax called [HCL](https://www.terraform.io/language/syntax/configuration). In the `main.tf` file, we set the required Terraform version. After that, we configure a provider. Throughout the workshop, we focus on AWS and only deploy AWS resources. The [AWS provider](https://www.terraform.io/language/providers) gives us all the resources and data sources we need to interact with AWS.
+What's going on here? We created a simple `.tf` file: Terraform comes with its syntax called [HCL](https://www.terraform.io/language/syntax/configuration). In the `main.tf` file, we set the required Terraform version. After that, we configure a provider. Throughout the workshop, we focus on AWS and only deploy AWS resources. The [AWS provider](https://www.terraform.io/language/providers) gives us all the resources and data sources we need to interact with AWS.
 
 Bare in mind, that Terraform provides [dozens of providers](https://registry.terraform.io/browse/providers) (e.g. Azure, Google Cloud Plaform or even Auth0).
 
-Now, after the provider we have a data source and a resource. The resource block describes a simple S3 bucket. The configuration arguments (between `{` and `}`) describe the resource furthermore. S3 buckets always need an unique bucket name. To achieve this, we get the current AWS account id and append it to the bucket name. We get the AWS account id by using the `aws_caller_identity` data source. With data sources, we can fetch data outside of the Terraform stack and use it for resources.
+Now, after the provider, we have a data source and a resource. The resource block describes a simple S3 bucket. The configuration arguments (between `{` and `}`) describe the resource furthermore. S3 buckets always need a unique bucket name. To achieve this, we get the current AWS account id and append it to the bucket name. We get the AWS account id by using the `aws_caller_identity` data source. With data sources, we can fetch data outside of the Terraform stack and use it for resources.
 
 Finally, we run `terraform apply` to deploy the resources.
 
@@ -98,7 +98,14 @@ Let's extend the stack and deploy more resources:
     value = "http://${aws_s3_bucket_website_configuration.website.website_endpoint}"
   }
   ```
-3. Run `terraform apply` again and confirm with `yes`.
+3. Create another file `outputs.tf` next to the `main.tf`. Add the following lines:
+  ```tf
+  output "website_url" {
+    description = "Static website URL"
+    value = "http://${aws_s3_bucket_website_configuration.website.website_endpoint}"
+  }
+  ```
+4. Run `terraform apply` again and confirm with `yes`.
 
 The new resources enable static website hosting and upload the `index.html`. Feel free to go to the S3 console again. You should see the `index.html` file in the bucket.
 

diff --git a/1-static-hosting/main.tf b/1-static-hosting/main.tf
@@ -28,8 +28,3 @@ resource "aws_s3_bucket_website_configuration" "website" {
     suffix = "index.html"
   }
 }
-
-output "website_url" {
-  description = "Static website URL"
-  value = "http://${aws_s3_bucket_website_configuration.website.website_endpoint}"
-}
diff --git a/1-static-hosting/outputs.tf b/1-static-hosting/outputs.tf
@@ -0,0 +1,4 @@
+output "website_url" {
+  description = "Static website URL"
+  value = "http://${aws_s3_bucket_website_configuration.website.website_endpoint}"
+}
diff --git a/2-simple-api/README.md b/2-simple-api/README.md
@@ -45,12 +45,6 @@ In the first lab, we bootstrapped Terraform and created some resources. Finally,
     }
   }
 
-  variable "lambda_function_response" {
-    type        = string
-    description = "Body response of the hello world lambda function"
-    default     = "Hello from Lambda!"
-  }
-
   module "lambda_function" {
     source = "terraform-aws-modules/lambda/aws"
 
@@ -59,23 +53,21 @@ In the first lab, we bootstrapped Terraform and created some resources. Finally,
     runtime       = "nodejs12.x"
     source_path   = "./functions"
     environment_variables = {
-      "RESPONSE" = var.lambda_function_response
+      "RESPONSE" = "Hello from Lambda! 👋"
     }
   }
   ```
-5. Run `terraform init`, then `terraform apply` and confirm the changes with `yes`.
+5. Run `terraform init`, then `terraform apply`, and confirm the changes with `yes`.
 6. Go to the [Lambda console](https://eu-west-1.console.aws.amazon.com/lambda/home?region=eu-west-1#/functions/hello-world?tab=testing). You should see the deployed Lambda function. Now, scroll down a little bit and click on the `Test` button. Click on `Details`. You should see the output of the Lambda function:
   ```json
   {
-    "message": "Hello from Lambda!"
+    "message": "Hello from Lambda! 👋"
   }
   ```
 
-It's worth noting that we use environment variables to pass certain data to the Lambda function. The Terraform [input variable](https://www.terraform.io/language/values/variables) sets the response of the Lambda function. Feel free to play around with the default value and deploy the stack again. You should retrieve the new Lambda function response.
+We used a [module](https://www.terraform.io/language/modules/develop) for the first time. A *module* is a container for multiple resources. We use a third-party library called [*terraform-aws-modules/lambda/aws*](https://registry.terraform.io/modules/terraform-aws-modules/lambda/aws/latest) to describe a Lambda function. Essentially, the library does the heavy lifting for us. It bundles the function source code and uploads it to the public cloud. We could also use plain AWS resources and create the process by ourselves, but that's not good advice. Before reinventing the wheel, we should check for open-source modules already available. The [Terraform Registry](https://registry.terraform.io/) is a good starting point to find the right library.
 
-In addition, we also use a [module](https://www.terraform.io/language/modules/develop) for the first time. A *module* is a container for multiple resources. We use a third-party library called [*terraform-aws-modules/lambda/aws*](https://registry.terraform.io/modules/terraform-aws-modules/lambda/aws/latest) to describe a Lambda function. Essentially, the library does the heavy lifting for us. It bundles the function source code and uploads it to the public cloud. We could also use plain AWS resources and create the process by ourselves, but that's not good advice. Before reinventing the wheel, we should check for open-source modules already available. The [Terraform Registry](https://registry.terraform.io/) is a good starting point to find the right library.
-
-So, the Lambda function is in place and we can go to the next component. The API Gateway sitting in front of the Lambda function and processing HTTP(S) requests.
+So, the Lambda function is in place and we can go to the next component: The API Gateway sitting in front of the Lambda function and processing HTTP(S) requests.
 
 ## API Gateway
 
@@ -112,12 +104,6 @@ So, the Lambda function is in place and we can go to the next component. The API
     }
   }
 
-  variable "lambda_function_response" {
-    type        = string
-    description = "Body response of the hello world lambda function"
-    default     = "Hello from Lambda!"
-  }
-
   module "lambda_function" {
     source = "terraform-aws-modules/lambda/aws"
 
@@ -126,7 +112,7 @@ So, the Lambda function is in place and we can go to the next component. The API
     runtime       = "nodejs12.x"
     source_path   = "./functions"
     environment_variables = {
-      "RESPONSE" = var.lambda_function_response
+      "RESPONSE" = "Hello from Lambda! 👋"
     }
 
     publish = true
@@ -143,7 +129,9 @@ So, the Lambda function is in place and we can go to the next component. The API
     protocol_type = "HTTP"
     target        = module.lambda_function.lambda_function_arn
   }
-
+  ```
+2. Replace the `outputs.tf` file:
+  ```tf
   output "website_url" {
     description = "Static website URL"
     value       = "http://${aws_s3_bucket_website_configuration.website.website_endpoint}"
@@ -161,4 +149,4 @@ Okay, nothing really special here. We extended the stack and introduced more res
 
 ## Next
 
-The Terraform file is already growing and growing. Let's talk about some naming conventions and code structure best practices [in the next lab](../3-code-structure/).
+The [next lab](../3-environments/) covers a very important topic: Instead of just deploying the stack once, we want to deploy the stack for multiple environments. Imagine, we want to have a staging and production environment, probably with slightly different configurations.
diff --git a/2-simple-api/main.tf b/2-simple-api/main.tf
@@ -29,12 +29,6 @@ resource "aws_s3_bucket_website_configuration" "website" {
   }
 }
 
-variable "lambda_function_response" {
-  type        = string
-  description = "Body response of the hello world lambda function"
-  default     = "Hello from Lambda!"
-}
-
 module "lambda_function" {
   source = "terraform-aws-modules/lambda/aws"
 
@@ -43,7 +37,7 @@ module "lambda_function" {
   runtime       = "nodejs12.x"
   source_path   = "./functions"
   environment_variables = {
-    "RESPONSE" = var.lambda_function_response
+    "RESPONSE" = "Hello from Lambda! 👋"
   }
 
   publish = true
@@ -60,13 +54,3 @@ resource "aws_apigatewayv2_api" "hello_world" {
   protocol_type = "HTTP"
   target        = module.lambda_function.lambda_function_arn
 }
-
-output "website_url" {
-  description = "Static website URL"
-  value       = "http://${aws_s3_bucket_website_configuration.website.website_endpoint}"
-}
-
-output "api_url" {
-  description = "Hello World API URL"
-  value       = aws_apigatewayv2_api.hello_world.api_endpoint
-}
diff --git a/3-code-structure/outputs.tf → 2-simple-api/outputs.tf b/3-code-structure/outputs.tf → 2-simple-api/outputs.tf
@@ -1,6 +1,6 @@
 output "website_url" {
   description = "Static website URL"
-  value = "http://${aws_s3_bucket_website_configuration.website.website_endpoint}"
+  value       = "http://${aws_s3_bucket_website_configuration.website.website_endpoint}"
 }
 
 output "api_url" {

diff --git a/3-code-structure/README.md b/3-code-structure/README.md
diff --git a/3-code-structure/main.tf b/3-code-structure/main.tf
diff --git a/3-code-structure/variables.tf b/3-code-structure/variables.tf
diff --git a/3-code-structure/.terraform.lock.hcl → ...ironments/modules/api/.terraform.lock.hcl b/3-code-structure/.terraform.lock.hcl → ...ironments/modules/api/.terraform.lock.hcl
diff --git a/3-code-structure/functions/helloworld.js → ...ments/modules/api/functions/helloworld.js b/3-code-structure/functions/helloworld.js → ...ments/modules/api/functions/helloworld.js
diff --git a/4-environments/modules/api/main.tf → 3-environments/modules/api/main.tf b/4-environments/modules/api/main.tf → 3-environments/modules/api/main.tf
diff --git a/4-environments/modules/api/outputs.tf → 3-environments/modules/api/outputs.tf b/4-environments/modules/api/outputs.tf → 3-environments/modules/api/outputs.tf
diff --git a/4-environments/modules/api/variables.tf → 3-environments/modules/api/variables.tf b/4-environments/modules/api/variables.tf → 3-environments/modules/api/variables.tf
diff --git a/...ments/modules/website/.terraform.lock.hcl → ...ments/modules/website/.terraform.lock.hcl b/...ments/modules/website/.terraform.lock.hcl → ...ments/modules/website/.terraform.lock.hcl
diff --git a/3-code-structure/index.html → 3-environments/modules/website/index.html b/3-code-structure/index.html → 3-environments/modules/website/index.html
diff --git a/4-environments/modules/website/main.tf → 3-environments/modules/website/main.tf b/4-environments/modules/website/main.tf → 3-environments/modules/website/main.tf
diff --git a/4-environments/modules/website/outputs.tf → 3-environments/modules/website/outputs.tf b/4-environments/modules/website/outputs.tf → 3-environments/modules/website/outputs.tf
diff --git a/4-environments/modules/website/variables.tf → 3-environments/modules/website/variables.tf b/4-environments/modules/website/variables.tf → 3-environments/modules/website/variables.tf
diff --git a/...ironments/modules/api/.terraform.lock.hcl → 3-environments/prod/.terraform.lock.hcl b/...ironments/modules/api/.terraform.lock.hcl → 3-environments/prod/.terraform.lock.hcl
diff --git a/4-environments/prod/main.tf → 3-environments/prod/main.tf b/4-environments/prod/main.tf → 3-environments/prod/main.tf
diff --git a/4-environments/prod/outputs.tf → 3-environments/prod/outputs.tf b/4-environments/prod/outputs.tf → 3-environments/prod/outputs.tf
diff --git a/4-environments/prod/.terraform.lock.hcl → 3-environments/staging/.terraform.lock.hcl b/4-environments/prod/.terraform.lock.hcl → 3-environments/staging/.terraform.lock.hcl
diff --git a/4-environments/staging/main.tf → 3-environments/staging/main.tf b/4-environments/staging/main.tf → 3-environments/staging/main.tf
diff --git a/4-environments/staging/outputs.tf → 3-environments/staging/outputs.tf b/4-environments/staging/outputs.tf → 3-environments/staging/outputs.tf
diff --git a/4-environments/staging/.terraform.lock.hcl → ...e-backend/modules/api/.terraform.lock.hcl b/4-environments/staging/.terraform.lock.hcl → ...e-backend/modules/api/.terraform.lock.hcl
diff --git a/...ments/modules/api/functions/helloworld.js → ...ckend/modules/api/functions/helloworld.js b/...ments/modules/api/functions/helloworld.js → ...ckend/modules/api/functions/helloworld.js
diff --git a/5-remote-backend/modules/api/main.tf → 4-remote-backend/modules/api/main.tf b/5-remote-backend/modules/api/main.tf → 4-remote-backend/modules/api/main.tf
diff --git a/5-remote-backend/modules/api/outputs.tf → 4-remote-backend/modules/api/outputs.tf b/5-remote-backend/modules/api/outputs.tf → 4-remote-backend/modules/api/outputs.tf
diff --git a/5-remote-backend/modules/api/variables.tf → 4-remote-backend/modules/api/variables.tf b/5-remote-backend/modules/api/variables.tf → 4-remote-backend/modules/api/variables.tf
diff --git a/...ckend/modules/website/.terraform.lock.hcl → ...ckend/modules/website/.terraform.lock.hcl b/...ckend/modules/website/.terraform.lock.hcl → ...ckend/modules/website/.terraform.lock.hcl
diff --git a/4-environments/modules/website/index.html → 4-remote-backend/modules/website/index.html b/4-environments/modules/website/index.html → 4-remote-backend/modules/website/index.html
diff --git a/5-remote-backend/modules/website/main.tf → 4-remote-backend/modules/website/main.tf b/5-remote-backend/modules/website/main.tf → 4-remote-backend/modules/website/main.tf
diff --git a/5-remote-backend/modules/website/outputs.tf → 4-remote-backend/modules/website/outputs.tf b/5-remote-backend/modules/website/outputs.tf → 4-remote-backend/modules/website/outputs.tf
diff --git a/...mote-backend/modules/website/variables.tf → ...mote-backend/modules/website/variables.tf b/...mote-backend/modules/website/variables.tf → ...mote-backend/modules/website/variables.tf
diff --git a/...e-backend/modules/api/.terraform.lock.hcl → 4-remote-backend/prod/.terraform.lock.hcl b/...e-backend/modules/api/.terraform.lock.hcl → 4-remote-backend/prod/.terraform.lock.hcl
diff --git a/5-remote-backend/prod/main.tf → 4-remote-backend/prod/main.tf b/5-remote-backend/prod/main.tf → 4-remote-backend/prod/main.tf
diff --git a/5-remote-backend/prod/outputs.tf → 4-remote-backend/prod/outputs.tf b/5-remote-backend/prod/outputs.tf → 4-remote-backend/prod/outputs.tf
diff --git a/5-remote-backend/prod/.terraform.lock.hcl → 4-remote-backend/staging/.terraform.lock.hcl b/5-remote-backend/prod/.terraform.lock.hcl → 4-remote-backend/staging/.terraform.lock.hcl
diff --git a/5-remote-backend/staging/main.tf → 4-remote-backend/staging/main.tf b/5-remote-backend/staging/main.tf → 4-remote-backend/staging/main.tf
diff --git a/5-remote-backend/staging/outputs.tf → 4-remote-backend/staging/outputs.tf b/5-remote-backend/staging/outputs.tf → 4-remote-backend/staging/outputs.tf
diff --git a/5-remote-backend/staging/.terraform.lock.hcl → 5-terragrunt/modules/api/.terraform.lock.hcl b/5-remote-backend/staging/.terraform.lock.hcl → 5-terragrunt/modules/api/.terraform.lock.hcl
diff --git a/...ckend/modules/api/functions/helloworld.js → ...grunt/modules/api/functions/helloworld.js b/...ckend/modules/api/functions/helloworld.js → ...grunt/modules/api/functions/helloworld.js
diff --git a/6-terragrunt/modules/api/main.tf → 5-terragrunt/modules/api/main.tf b/6-terragrunt/modules/api/main.tf → 5-terragrunt/modules/api/main.tf
diff --git a/6-terragrunt/modules/api/outputs.tf → 5-terragrunt/modules/api/outputs.tf b/6-terragrunt/modules/api/outputs.tf → 5-terragrunt/modules/api/outputs.tf
diff --git a/6-terragrunt/modules/api/terragrunt.hcl → 5-terragrunt/modules/api/terragrunt.hcl b/6-terragrunt/modules/api/terragrunt.hcl → 5-terragrunt/modules/api/terragrunt.hcl
diff --git a/6-terragrunt/modules/api/variables.tf → 5-terragrunt/modules/api/variables.tf b/6-terragrunt/modules/api/variables.tf → 5-terragrunt/modules/api/variables.tf
diff --git a/...grunt/modules/website/.terraform.lock.hcl → ...grunt/modules/website/.terraform.lock.hcl b/...grunt/modules/website/.terraform.lock.hcl → ...grunt/modules/website/.terraform.lock.hcl
diff --git a/5-remote-backend/modules/website/index.html → 5-terragrunt/modules/website/index.html b/5-remote-backend/modules/website/index.html → 5-terragrunt/modules/website/index.html
diff --git a/6-terragrunt/modules/website/main.tf → 5-terragrunt/modules/website/main.tf b/6-terragrunt/modules/website/main.tf → 5-terragrunt/modules/website/main.tf
diff --git a/6-terragrunt/modules/website/outputs.tf → 5-terragrunt/modules/website/outputs.tf b/6-terragrunt/modules/website/outputs.tf → 5-terragrunt/modules/website/outputs.tf
diff --git a/6-terragrunt/modules/website/terragrunt.hcl → 5-terragrunt/modules/website/terragrunt.hcl b/6-terragrunt/modules/website/terragrunt.hcl → 5-terragrunt/modules/website/terragrunt.hcl
diff --git a/6-terragrunt/modules/website/variables.tf → 5-terragrunt/modules/website/variables.tf b/6-terragrunt/modules/website/variables.tf → 5-terragrunt/modules/website/variables.tf
diff --git a/6-terragrunt/modules/api/.terraform.lock.hcl → 5-terragrunt/prod/api/.terraform.lock.hcl b/6-terragrunt/modules/api/.terraform.lock.hcl → 5-terragrunt/prod/api/.terraform.lock.hcl
diff --git a/6-terragrunt/prod/api/terragrunt.hcl → 5-terragrunt/prod/api/terragrunt.hcl b/6-terragrunt/prod/api/terragrunt.hcl → 5-terragrunt/prod/api/terragrunt.hcl
diff --git a/6-terragrunt/prod/terragrunt.hcl → 5-terragrunt/prod/terragrunt.hcl b/6-terragrunt/prod/terragrunt.hcl → 5-terragrunt/prod/terragrunt.hcl
diff --git a/...rragrunt/prod/website/.terraform.lock.hcl → ...rragrunt/prod/website/.terraform.lock.hcl b/...rragrunt/prod/website/.terraform.lock.hcl → ...rragrunt/prod/website/.terraform.lock.hcl
diff --git a/6-terragrunt/prod/website/terragrunt.hcl → 5-terragrunt/prod/website/terragrunt.hcl b/6-terragrunt/prod/website/terragrunt.hcl → 5-terragrunt/prod/website/terragrunt.hcl
diff --git a/6-terragrunt/prod/api/.terraform.lock.hcl → 5-terragrunt/staging/api/.terraform.lock.hcl b/6-terragrunt/prod/api/.terraform.lock.hcl → 5-terragrunt/staging/api/.terraform.lock.hcl
diff --git a/6-terragrunt/staging/api/terragrunt.hcl → 5-terragrunt/staging/api/terragrunt.hcl b/6-terragrunt/staging/api/terragrunt.hcl → 5-terragrunt/staging/api/terragrunt.hcl
diff --git a/6-terragrunt/staging/terragrunt.hcl → 5-terragrunt/staging/terragrunt.hcl b/6-terragrunt/staging/terragrunt.hcl → 5-terragrunt/staging/terragrunt.hcl
diff --git a/...grunt/staging/website/.terraform.lock.hcl → ...grunt/staging/website/.terraform.lock.hcl b/...grunt/staging/website/.terraform.lock.hcl → ...grunt/staging/website/.terraform.lock.hcl
diff --git a/6-terragrunt/staging/website/terragrunt.hcl → 5-terragrunt/staging/website/terragrunt.hcl b/6-terragrunt/staging/website/terragrunt.hcl → 5-terragrunt/staging/website/terragrunt.hcl
diff --git a/6-terragrunt/modules/api/functions/helloworld.js b/6-terragrunt/modules/api/functions/helloworld.js
diff --git a/6-terragrunt/modules/website/index.html b/6-terragrunt/modules/website/index.html
diff --git a/6-terragrunt/staging/api/.terraform.lock.hcl b/6-terragrunt/staging/api/.terraform.lock.hcl
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # 🎓 Terraform Workshop
 > Learn infrastructure as code basics w/ Terraform and AWS
 
-The workshop addresses infrastructure as code and Terraform basics. Learn how to create the first Terraform stack and dpeloy some resources to AWS. We explore best practices and improve the growing code base over time.
+The workshop addresses infrastructure as code and Terraform basics. Learn how to create the first Terraform stack and deploy some resources to AWS. We explore best practices and improve the growing codebase over time.
 
 ## ✨ At a glance
 
@@ -27,11 +27,14 @@ We recommend you walk through the labs step by step and follow the instructions.
 
 1. [Static Hosting](./1-static-hosting): Get started with Terraform and deploy the first AWS resources
 2. [Simple API](./2-simple-api/): Extend the codebase and create a simple HTTP API using AWS API Gateway and AWS Lambda
-3. [Code Structure](./3-code-structure/): Refactor the codebase and learn more about naming conventions and commong code structures.
-4. [Environments](./4-environments/): Extend the codebase and prepare everything for multiple environments (e.g. staging and prod). Learn more about modules.
-5. [Remote Backend](./5-remote-backend/): Manage Terraform state remotely using AWS S3.
-6. [Terragrunt](./6-terragrunt/): Use Terragrunt to automate the creation of the remote state and clean up the environments.
-
+3. [Environments](./3-environments/): Extend the codebase and prepare everything for multiple environments (e.g. staging and prod). Learn more about modules.
+4. [Remote Backend](./4-remote-backend/): Manage Terraform state remotely using AWS S3.
+5. [Terragrunt](./5-terragrunt/): Use Terragrunt to automate the creation of the remote state and clean up the environments.
+
+## 📖 Further Reading
+
+- Best practices for [code structure](https://www.terraform-best-practices.com/code-structure) and [naming conventions](https://www.terraform-best-practices.com/naming)
+
 ## 👩‍⚖️ License
 
 See [LICENSE](./LICENSE.md).