This is an auto-generated module.
This module was generated from terraform-google-module-template, which by default generates a module that simply creates a GCS bucket. As the module develops, this README should be updated.
The resources/services/activations/deletions that this module will create/trigger are:
- Create a GCS bucket with the provided name
To deploy this blueprint you must have an active billing account and billing permissions.
Upon successful provisioning, you should see an output similar to:
frontend_url = "http://11.222.333.444/"
neos_toc_url = "http://console.cloud.google.com?walkthrough_id=panels--sic--dynamic-javascript-web-app_toc"
run_service_name = "dev-journey"Basic usage of this module is as follows:
module "dynamic_web_app" {
source = "terraform-google-modules/dynamic-javascript-webapp/google"
version = "~> 0.1"
project_id = "<PROJECT ID>"
}Functional examples are included in the examples directory.
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| deployment_name | Identifier for the deployment. Used in some resource names. | string |
"dev-journey" |
no |
| enable_apis | Whether or not to enable underlying apis in this solution. | bool |
true |
no |
| init_firestore | Whether or not to initialize a Firestore instance. | bool |
true |
no |
| initial_run_image | Initial image to deploy to Cloud Run service. | string |
"gcr.io/hsa-public/developer-journey/app" |
no |
| labels | A set of key/value label pairs to assign to the resources deployed by this solution. | map(string) |
{} |
no |
| project_id | The project ID to deploy resources to. | string |
n/a | yes |
| region | Google Cloud region | string |
"us-central1" |
no |
| Name | Description |
|---|---|
| frontend_url | IP address to site. Load balancer expected to take ~5 minutes for it to warm up. |
| neos_toc_url | Tutorial URL |
| run_service_name | The name of the deployed Cloud Run service. |
These sections describe requirements for using this module.
The following dependencies must be available:
- Terraform v0.13
- Terraform Provider for GCP plugin v3.0
A service account with the following roles must be used to provision the resources of this module:
- Datastore Owner:
roles/datastore.owner - Cloud Run Invoker:
roles/run.invoker - Storage Object Viewer:
roles/storage.objectViewer - Secret Manager:
roles/secretmanager.secretAccessor
The Project Factory module and the IAM module may be used in combination to provision a service account with the necessary roles applied.
A project with the following APIs enabled must be used to host the resources of this module:
- Google Cloud Asset API:
cloudasset.googleapis.com - Google Cloud Build API:
cloudbuild.googleapis.com - Google Cloud Resource Manager API:
cloudresourcemanager.googleapis.com - Google Cloud Compute API:
compute.googleapis.com - Google Cloud Firestore API:
firestore.googleapis.com - Google Cloud IAM API:
iam.googleapis.com - Google Cloud Run API:
run.googleapis.com - Google Cloud Secret Manager API:
secretmanager.googleapis.com - Google Cloud Service Usage API:
serviceusage.googleapis.com - Google Cloud Storage JSON API:
storage.googleapis.com
The Project Factory module can be used to provision a project with the necessary APIs enabled.
Why isn't the app popping up right away after provisioning has completed?
Upon opening the given IP address (frontend_url output) from the load balancer,
you may have to wait around 5 minutes for your app to appear.
Why am I seeing a security warning when I open the app up with the given Cloud Run url after attempting to "login"?
If you are accessing the app through the Cloud Run given https (secure) url,
attempting to login will route you to the load balancer IP address (frontend_url output) which is currently http (not secured).
We recommend that when you access the app with the given IP address and not through the deployed url given through Cloud Run.
Refer to the contribution guidelines for information on contributing to this module.
Please see our security disclosure process.