feat: Implement Terraform code to automate Online Boutique GKE quickstart #918

jaspermai · 2022-07-15T17:50:18Z

This Pull Request introduces a new Terraform module that automates Online Boutique's GKE quickstart process.

Background

Online Boutique (microservices-demo) is a sample web application that simulates a web-based e-commerce application for users to browse items, add them to cart, and purchase them. The sample application demonstrates using an 11-tier microservices application deployed using Kubernetes/GKE.

Currently, the microservices-demo repo contains instructions in the Quickstart (GKE) section on how to deploy the sample application on your own GCP project. The process requires many intermediate steps with varying processing time in between each step. The usage of an incoming Terraform module will simplify all of the Quickstart steps into one Terraform command and combine the individual processing times into one waiting period for the user.

Summary of Changes

1. New File: main.tf
This file contains the main Terraform script instructions. When running the script, the script will be executing the following actions:

Enable the required Google APIs outlined in "Quickstart (GKE)"
Create an autopilot GKE cluster and point kubectl at the new cluster (get-credentials)
Apply the kubernetes manifest file in release/kubernetes-manifests.yaml
Wait on all the Pods to be ready

2. New File: variables.tf
This file contains variables that may need customization in future projects. These variables include "apis", "cluster name", "cluster region", "Pods namespace", and "Kubernetes manifest filepath".

3. New File: output.tf
This file contains output variables that are shown after running the Terraform script. These variables include "location of the cluster" and "name of the cluster".

4. New File: README.md
This file contains detailed instructions on how to setup, run, and destroy the Terraform script.

Testing Procedure

Refer to the instructions in the terraform/README.md file. This file contains instructions of setting up and using the Terraform file. Link to README: https://github.com/GoogleCloudPlatform/microservices-demo/blob/7d2517ef8f1e9cfbfd110e855bc801081988eb45/terraform/README.md

github-actions · 2022-07-15T17:53:16Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-15T17:55:02Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-15T18:00:23Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-15T21:20:08Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-15T21:22:24Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-15T21:23:37Z

🚲 PR staged at http://34.170.66.255

NimJay

I realize that this pull-request is in "Draft" mode.
But I left some preliminary comments/suggestions.
Feel free to reject any of my suggestions — all of them are minor.

I have not yet tested the instructions myself (i.e., I didn't run the terraform commands).
I will do that as soon as this pull-requests come out of draft mode. :)

Things are looking good! Great work so far, Jasper. 👏

terraform/README.md

terraform/main.tf

terraform/variables.tf

terraform/README.md

Co-authored-by: Nim Jayawardena <nimjay@google.com>

github-actions · 2022-07-18T14:15:57Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-18T14:16:43Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-18T14:18:36Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-18T14:19:41Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-18T14:21:31Z

🚲 PR staged at http://34.170.66.255

…croservices-demo into terraform

github-actions · 2022-07-18T14:25:36Z

🚲 PR staged at http://34.170.66.255

github-actions · 2022-07-18T15:15:40Z

🚲 PR staged at http://34.170.66.255

Shabirmean

Thanks for addressing all my comments!

NimJay

@jaspermai

Thank you so, so much for addressing most of our feedback!
Your changes have come a long way since you first drafted this pull-request (PR).
It was already excellent when you created the PR so your extra efforts (to address our comments) are highly appreciated.

I approve this change.

Before merging, please:

Get Ahrar's approval.
Merge the latest changes from main into this branch (click "Update branch").
Wait for all 4 Checks to pass (it'll take a few minutes).

ahrarmonsur · 2022-07-22T17:46:50Z

This is regarding @Shabirmean's suggestion to use terraform-docs to generate docs similar to this. Great suggestion. But I'll let @ahrarmonsur decide whether we should proceed. Ahrar, if you do decide to use terraform-docs, let's do it outside this pull-request. I want to make sure all our feedback & requests don't demotivate Jasper. :)

Both of you, good suggestion and supporting references. I agree, let's consider this improvement out-of-scope for this PR. Jasper and I will discuss his interest in implementing this and incorporating references to the docs into the README, after the fact.

…croservices-demo into terraform

jaspermai · 2022-07-22T20:09:49Z

@minherz @ckim328 @ahrarmonsur (+ @NimJay & @Shabirmean if necessary) - requesting a final code look-through after many of your comments have been addressed! Here are the main changes to the Terraform module:

"gcloud get-credentials" command is now taken care of in the gcloud module (CC: @minherz , @ckim328 , @Shabirmean )
users are prompted to change the gcp_project_id variable in terraform.tfvars instead of variables.tf (CC: @ckim328 , @ahrarmonsur )
providers.tf and copyright messages have been added where necessary (CC: @minherz )
README.md and .tf file styling looks much better
.gitignore is properly populated (CC: @ckim328 )
Note: There is a unique workaround in main.tf that uses local variables to implicitly declare a dependency between module gcloud and resource google_container_cluster.

terraform/main.tf

Shabirmean

Thanks for the changes @jaspermai
Left two minor improvements.

LGTM!!!

Co-authored-by: Shabir Mohamed Abdul Samadh <7249208+Shabirmean@users.noreply.github.com>

github-actions · 2022-07-25T15:59:22Z

🚲 PR staged at http://34.170.66.255

.gitignore

xtineskim

good job Jasper, and thank you for addressing all our comments! just one last comment from myself

ahrarmonsur

Excellent job incorporating everyone's feedback, Jasper, including my own for the README!
Your diligence with you the contribution is evident, and the final state is much improved since you submitted the PR!

LGTM!

github-actions · 2022-07-26T15:30:05Z

🚲 PR staged at http://34.170.66.255

…tart (GoogleCloudPlatform#918) * basic files upload - main, output, variables, README, LICENSE * Delete LICENSE * Update README.md * Updated README.md * Updated README.md * Updated README.md * Update terraform/README.md Co-authored-by: Nim Jayawardena <nimjay@google.com> * Update terraform/README.md Co-authored-by: Nim Jayawardena <nimjay@google.com> * Update terraform/main.tf Co-authored-by: Nim Jayawardena <nimjay@google.com> * Update terraform/variables.tf Co-authored-by: Nim Jayawardena <nimjay@google.com> * Update terraform/README.md Co-authored-by: Nim Jayawardena <nimjay@google.com> * Updated README.md * Updated README.md * updated .gitignore file with unneccessary tf-generated files * updated README as per nimjay@ * updated README.md * .gitignore and README.md changes as per christineskim@ * updated README.md * Updated README.md * Updated main.tf and variables.tf as per leoy@ * Updated README and .tf files as per christineskim@, leoy@, ahrar@, shabirmean@. Providers-related code in progress * Ran terraform fmt and updated README * Transitioned to terraform.tfvars and providers definition * Using gcloud module for get-credentials * Updated styling * Updated styling * Update terraform/main.tf Co-authored-by: Shabir Mohamed Abdul Samadh <7249208+Shabirmean@users.noreply.github.com> * Changed naming of cluster_id_parts * Changed cluster_id_parts * Updated README.md for formatting * Reverted tfvars variable to project_id_here * Updated .gitignore Co-authored-by: Nim Jayawardena <nimjay@google.com> Co-authored-by: Christine Kim <35876108+ckim328@users.noreply.github.com> Co-authored-by: Shabir Mohamed Abdul Samadh <7249208+Shabirmean@users.noreply.github.com>

jaspermai and others added 2 commits July 15, 2022 17:36

basic files upload - main, output, variables, README, LICENSE

4c51ba1

Delete LICENSE

c3c8fa4

Update README.md

bb02f4a

Updated README.md

106ffa4

jaspermai added 2 commits July 15, 2022 21:20

Updated README.md

3f03dfa

Updated README.md

62aa7fb

NimJay requested changes Jul 18, 2022

View reviewed changes

jaspermai self-assigned this Jul 18, 2022

ahrarmonsur self-requested a review July 18, 2022 14:09

jaspermai and others added 5 commits July 18, 2022 10:14

Update terraform/README.md

9ec1a34

Co-authored-by: Nim Jayawardena <nimjay@google.com>

Update terraform/README.md

6368a49

Co-authored-by: Nim Jayawardena <nimjay@google.com>

Update terraform/main.tf

1f0da12

Co-authored-by: Nim Jayawardena <nimjay@google.com>

Update terraform/variables.tf

739dd79

Co-authored-by: Nim Jayawardena <nimjay@google.com>

Update terraform/README.md

3a34b3a

Co-authored-by: Nim Jayawardena <nimjay@google.com>

jaspermai added 2 commits July 18, 2022 14:22

Updated README.md

1e18930

Merge branch 'terraform' of https://github.com/GoogleCloudPlatform/mi…

7a2fca4

…croservices-demo into terraform

Updated README.md

7d2517e

Shabirmean approved these changes Jul 21, 2022

View reviewed changes

NimJay approved these changes Jul 22, 2022

View reviewed changes

jaspermai and others added 5 commits July 22, 2022 19:50

Using gcloud module for get-credentials

f2667c8

Merge branch 'main' into terraform

ca148f2

Updated styling

101a591

Merge branch 'terraform' of https://github.com/GoogleCloudPlatform/mi…

fb9310a

…croservices-demo into terraform

Updated styling

be05733

Shabirmean reviewed Jul 23, 2022

View reviewed changes

terraform/main.tf Outdated Show resolved Hide resolved

Shabirmean reviewed Jul 23, 2022

View reviewed changes

terraform/main.tf Outdated Show resolved Hide resolved

Shabirmean approved these changes Jul 23, 2022

View reviewed changes

jaspermai and others added 6 commits July 25, 2022 10:17

Update terraform/main.tf

78265f1

Co-authored-by: Shabir Mohamed Abdul Samadh <7249208+Shabirmean@users.noreply.github.com>

Changed naming of cluster_id_parts

2bc399c

Changed cluster_id_parts

f558859

Updated main.tf

70cb8ff

Updated README.md for formatting

12e714b

Reverted tfvars variable to project_id_here

45f8753

xtineskim requested a review from a team July 25, 2022 15:57

xtineskim reviewed Jul 25, 2022

View reviewed changes

.gitignore Show resolved Hide resolved

xtineskim approved these changes Jul 25, 2022

View reviewed changes

Updated .gitignore

28b6c71

ahrarmonsur approved these changes Jul 25, 2022

View reviewed changes

jaspermai requested a review from a team July 26, 2022 15:28

jaspermai merged commit 359be44 into main Jul 26, 2022

jaspermai deleted the terraform branch July 26, 2022 17:32

jaspermai mentioned this pull request Aug 15, 2022

Docs: Update Online Boutique README files with Kustomize Changes #952

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement Terraform code to automate Online Boutique GKE quickstart #918

feat: Implement Terraform code to automate Online Boutique GKE quickstart #918

jaspermai commented Jul 15, 2022 •

edited by NimJay

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

NimJay left a comment

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

Shabirmean left a comment

NimJay left a comment •

edited

ahrarmonsur commented Jul 22, 2022

jaspermai commented Jul 22, 2022

Shabirmean left a comment

github-actions bot commented Jul 25, 2022

xtineskim left a comment •

edited

ahrarmonsur left a comment

github-actions bot commented Jul 26, 2022

feat: Implement Terraform code to automate Online Boutique GKE quickstart #918

feat: Implement Terraform code to automate Online Boutique GKE quickstart #918

Conversation

jaspermai commented Jul 15, 2022 • edited by NimJay

Background

Summary of Changes

Testing Procedure

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

github-actions bot commented Jul 15, 2022

NimJay left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

github-actions bot commented Jul 18, 2022

Shabirmean left a comment

Choose a reason for hiding this comment

NimJay left a comment • edited

Choose a reason for hiding this comment

ahrarmonsur commented Jul 22, 2022

jaspermai commented Jul 22, 2022

Shabirmean left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 25, 2022

xtineskim left a comment • edited

Choose a reason for hiding this comment

ahrarmonsur left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 26, 2022

jaspermai commented Jul 15, 2022 •

edited by NimJay

NimJay left a comment •

edited

xtineskim left a comment •

edited