Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googlecloudplatform/terraform-google-three-tier-web-app

Deploys a three tier web application using Cloud Run and Cloud SQL
https://github.com/googlecloudplatform/terraform-google-three-tier-web-app

cft-terraform databases jump-start-solutions serverless-computing

Last synced: 1 day ago
JSON representation

Deploys a three tier web application using Cloud Run and Cloud SQL

Awesome Lists containing this project

README 

        
# Three-tier web app



This repository contains the Terraform deployed by the Jump Start Solution (JSS) titled [Three-tier web application](https://console.cloud.google.com/products/solutions/details/three-tier-web-app).

The source code for web application (frontend and middle tier) deployed by this JSS can be found at [github.com/GoogleCloudPlatform/deploystack-three-tier-app](https://github.com/GoogleCloudPlatform/deploystack-three-tier-app).



### Tagline

Create a web app using a three-tiered architecture



### Detailed

This solution quickly and securely creates a web app using a three-tiered architecture with a front end, middleware, and back end (PostgreSQL database).

You can choose whether to deploy your solution through the console directly or download as Terraform on GitHub to deploy later.



### Architecture

1. User requests are sent to the front end, which is deployed on two Cloud Run services as containers to support high scalability applications.

1. The request then lands on the middle tier, which is the API layer that provides access to the backend. This is also deployed on Cloud Run for scalability and ease of deployment in multiple languages. This middleware is a Golang based API.

1. The frequent requests are cached in Memorystore for Redis for serving the request fast in-memory. The response is then served back to the user.

1. For new requests from the users, Cloud SQL provides the backend as the database layer. The response is then served back to the user.

1. For DevOps, Cloud Build packages up the containers and deploys them to be available as Cloud Run services.



## Documentation

- [Architecture Diagram](assets/three_tier_web_app_v4.svg)



## Usage



Basic usage of this module is as follows:



```hcl

module "three_tier_app" {

  source  = "terraform-google-modules/three-tier-app/google"

  version = "~> 0.1"



  project_id  = var.project_id

  region = "us-central1"

  zone = "us-central1-a"

}

```



Functional examples are included in the

[examples](./examples/) directory.



## Inputs



| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

| database\_type | Cloud SQL Database flavor, mysql or postgresql | `string` | `"postgresql"` | no |

| deployment\_name | The name of this particular deployment, will get added as a prefix to most resources. | `string` | `"three-tier-app"` | no |

| enable\_apis | Whether or not to enable underlying apis in this solution. . | `string` | `true` | no |

| labels | A map of labels to apply to contained resources. | `map(string)` | 
{
  "three-tier-app": true
}
 | no |

| project\_id | The project ID to deploy to | `string` | n/a | yes |

| region | The Compute Region to deploy to | `string` | `"us-central1"` | no |

| run\_roles\_list | The list of roles that run needs | `list(string)` | 
[
  "roles/cloudsql.instanceUser",
  "roles/cloudsql.client"
]
 | no |

| zone | The Compute Zone to deploy to | `string` | `"us-central1-a"` | no |



## Outputs



| Name | Description |

|------|-------------|

| endpoint | The url of the front end which we want to surface to the user |

| neos\_toc\_url | The URL to launch the in-console tutorial for the Three Tier App solution |

| sqlservername | The name of the database that we randomly generated. |



## Requirements



These sections describe requirements for using this module.



### Software



The following dependencies must be available:



- [Terraform][terraform] v0.13

- [Terraform Provider for GCP][terraform-provider-gcp] plugin v3.0



### Service Account



A service account with the following roles must be used to provision

the resources of this module:



- Storage Admin: `roles/storage.admin`



The [Project Factory module][project-factory-module] and the

[IAM module][iam-module] may be used in combination to provision a

service account with the necessary roles applied.



### APIs



A project with the following APIs enabled must be used to host the

resources of this module:



- Google Cloud Storage JSON API: `storage-api.googleapis.com`



The [Project Factory module][project-factory-module] can be used to

provision a project with the necessary APIs enabled.



## Contributing



Refer to the [contribution guidelines](./CONTRIBUTING.md) for

information on contributing to this module.



[iam-module]: https://registry.terraform.io/modules/terraform-google-modules/iam/google

[project-factory-module]: https://registry.terraform.io/modules/terraform-google-modules/project-factory/google

[terraform-provider-gcp]: https://www.terraform.io/docs/providers/google/index.html

[terraform]: https://www.terraform.io/downloads.html



## Security Disclosures



Please see our [security disclosure process](./SECURITY.md).