GSP702

Overview

Go is an open source programming language by Google that makes it easy to build fast, reliable, and efficient software at scale. In this lab you explore the basics of Go by deploying a simple Go app to Cloud Run Functions and App Engine. You then use the Go app to access data in BigQuery and Firestore.

What you'll do

In this lab, you perform the following:

• Set up your Firestore Database and import data
• Get an introduction to the power of Cloud Build
• Explore data in BigQuery and Firestore
• Deploy a Go app to App Engine and Cloud Run Functions
• Examine the Go app code
• Test the app on the each of the platforms

Setup and requirements

Before you click the Start Lab button

Read these instructions. Labs are timed and you cannot pause them. The timer, which starts when you click Start Lab, shows how long Google Cloud resources will be made available to you.

This hands-on lab lets you do the lab activities yourself in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials that you use to sign in and access Google Cloud for the duration of the lab.

To complete this lab, you need:

• Access to a standard internet browser (Chrome browser recommended).

Note: Use an Incognito or private browser window to run this lab. This prevents any conflicts between your personal account and the Student account, which may cause extra charges incurred to your personal account.

• Time to complete the lab---remember, once you start, you cannot pause a lab.

Note: If you already have your own personal Google Cloud account or project, do not use it for this lab to avoid extra charges to your account.

How to start your lab and sign in to the Google Cloud console

1. Click the Start Lab button. If you need to pay for the lab, a pop-up opens for you to select your payment method. On the left is the Lab Details panel with the following:

   • The Open Google Cloud console button
   • Time remaining
   • The temporary credentials that you must use for this lab
   • Other information, if needed, to step through this lab

2. Click Open Google Cloud console (or right-click and select Open Link in Incognito Window if you are running the Chrome browser).

   The lab spins up resources, and then opens another tab that shows the Sign in page.

   Tip: Arrange the tabs in separate windows, side-by-side.

   Note: If you see the Choose an account dialog, click Use Another Account.

3. If necessary, copy the Username below and paste it into the Sign in dialog.

   {{{user_0.username | "Username"}}}

   You can also find the Username in the Lab Details panel.

4. Click Next.

5. Copy the Password below and paste it into the Welcome dialog.

   {{{user_0.password | "Password"}}}

   You can also find the Password in the Lab Details panel.

6. Click Next.

   Important: You must use the credentials the lab provides you. Do not use your Google Cloud account credentials. Note: Using your own Google Cloud account for this lab may incur extra charges.

7. Click through the subsequent pages:

   • Accept the terms and conditions.
   • Do not add recovery options or two-factor authentication (because this is a temporary account).
   • Do not sign up for free trials.

After a few moments, the Google Cloud console opens in this tab.

Note: To view a menu with a list of Google Cloud products and services, click the Navigation menu at the top-left.

Activate Cloud Shell

Cloud Shell is a virtual machine that is loaded with development tools. It offers a persistent 5GB home directory and runs on the Google Cloud. Cloud Shell provides command-line access to your Google Cloud resources.

1. Click Activate Cloud Shell at the top of the Google Cloud console.

When you are connected, you are already authenticated, and the project is set to your Project_ID, . The output contains a line that declares the Project_ID for this session:

Your Cloud Platform project in this session is set to {{{project_0.project_id | "PROJECT_ID"}}}

gcloud is the command-line tool for Google Cloud. It comes pre-installed on Cloud Shell and supports tab-completion.

2. (Optional) You can list the active account name with this command:

gcloud auth list

3. Click Authorize.

Output:

ACTIVE: * ACCOUNT: {{{user_0.username | "ACCOUNT"}}} To set the active account, run: $ gcloud config set account `ACCOUNT`

4. (Optional) You can list the project ID with this command:

gcloud config list project

Output:

[core] project = {{{project_0.project_id | "PROJECT_ID"}}} Note: For full documentation of gcloud, in Google Cloud, refer to the gcloud CLI overview guide.

What is Go?

Go (golang) is a general-purpose language designed with systems programming in mind. It is strongly typed and garbage-collected and has first class support for concurrent programming. Programs are constructed from packages, whose properties allow efficient management of dependencies.

Unlike Python and Javascript, Go is compiled not interpreted. Go source code is compiled into machine code before execution. As a result, Go is typically faster and more efficient than interpreted languages and requires no installed runtime like Node, Python, or JDK to execute.

Serverless platforms

Serverless computing enables developers to focus on writing code without worrying about infrastructure. It offers a variety of benefits over traditional computing, including zero server management, no up-front provisioning, auto-scaling, and paying only for the resources used. These advantages make serverless ideal for use cases like stateless HTTP applications, web, mobile, IoT backends, batch and stream data processing, chatbots, and more.

Go is perfect for cloud applications because of its efficiency, portability, and how easy it is to learn. This lab shows you how to use Cloud Build to deploy a Go app to the Cloud Run Functions and App Engine, all Google serverless platforms:

• Cloud Run Functions
• App Engine

Note: Refer to Serverless Options for information on which serverless platform is best adapted for your needs.

Cloud Build

Cloud Build is a service that executes your builds on Google Cloud infrastructure. Cloud Build can import source code from Cloud Storage, GitHub, or Bitbucket, execute a build to your specifications, and produce artifacts such as Docker containers.

Cloud Build executes your build as a series of build steps, where each build step is run in a Docker container. A build step can do anything that a container can do irrespective of the environment. For more information, refer to the Cloud Build documentation.

Cloud Run Functions

Cloud Run Functions is Google Cloud's event-driven serverless compute platform. Because Go compiles to a machine code binary, has no dependent frameworks to start, and does not require an interpreter, Go cold start time is between 80 and 1400ms. This means that the applications and services can remain dormant without costing anything, and then startup and start cold serving traffic in 1400ms or less. After this initial start, the function serves traffic instantly. This factor alone makes Go an ideal language for a Cloud Run Functions deployment.

Architecture

When you deploy your sample Go app, Google Cloud Data Drive, to Cloud Run Functions, the data flow architecture looks like this:

App Engine

The App Engine standard environment is based on container instances running on Google's infrastructure. Containers are preconfigured with one of several available runtimes.

Architecture

When you deploy your sample Go app, Google Cloud Data Drive, to App Engine, the data flow architecture looks like this:

Google Cloud Data Drive source code

In this lab you deploy a simple app called Google Cloud Data Drive. Google developed and open sourced this app to extract data from Google Cloud quickly. The Google Cloud Data Drive app is one of a series of tools that demonstrates effective usage patterns for using Cloud API's and services.

The Google Cloud Data Drive Go app exposes a simple composable URL path to retrieve data in JSON format from supported Google Cloud data platforms. The application currently supports BigQuery and Firestore, but has a modular design that can support any number of data sources.

These HTTP URL patterns are used to get data from Google Cloud running Google Cloud Data Drive.

• Firestore : [SERVICE_URL]/fs/[PROJECT_ID]/[COLLECTION]/[DOCUMENT]

• BigQuery: [SERVICE_URL]/bq/[PROJECT_ID]/[DATASET]/[TABLE]

Where:

Parameter	Description
[SERVICE URL]	The base URL for the application from App Engine or Cloud Run Functions. For App Engine this will look like https://[PROJECT ID].appspot.com/.
[PROJECT ID]	The Project ID of the Firestore Collection or BigQuery Dataset you want to access. You find the Project ID in the left panel of your lab.
[COLLECTION]	The Firestore Collection ID (symbols/product)
[DOCUMENT]	The Firestore document you would like to return (symbol)
[DATASET]	The BigQuery Dataset name (publicviews)
[TABLE]	The BigQuery Table name (ca_zip_codes)

Note: Although this lab uses curl to test the app, you can create the URLs yourself for an added functionality test in a browser.

Task 1. Setup your environment

1. In Cloud Shell, enter the following command to create an environment variable to store the Project ID to use later in this lab:

gcloud config set compute/region {{{ project_0.default_region | "filled in at lab startup." }}} export REGION=$(gcloud config get compute/region) export PROJECT_ID=$(gcloud info --format="value(config.project)")

2. Get the sample code for this lab by copying from Google Cloud Storage (GCS):

mkdir DIY-Tools gsutil cp -R gs://spls/gsp702/DIY-Tools/* DIY-Tools/

Prepare your databases

This lab uses sample data in BigQuery and Firestore to test your Go app.

BigQuery database

BigQuery is a serverless, future proof data warehouse with numerous features for machine learning, data partitioning, and segmentation. This lets you analyze gigabytes to petabytes of data using ANSI SQL at blazing-fast speeds, and with zero operational overhead.

The BigQuery dataset is a view of California zip codes and was created for you when the lab started.

Firestore database

Firestore, is a serverless document database, with super fast document lookup and real-time eventing features. It is also capable of a 99.999% SLA. To use data in Firestore to test your app, you must initialize Firestore in native mode and then import the sample data.

A Firestore native mode database instance has been created.

1. In the Cloud Console, click Navigation menu > Firestore to open Firestore in the Console.

Wait for the Firestore Database instance to initialize. This process also initializes App Engine in the same region, which allows you to deploy the application to App Engine without first creating an App Engine instance.

2. In Cloud Shell, launch a Firestore import job that provides sample Firestore data for the lab:

gcloud firestore import gs://$PROJECT_ID-firestore/prd-back

This import job loads a Cloud Firestore backup of a collection called symbols into the $PROJECT_ID-firestore storage bucket.

This import job takes up to 5 minutes to complete. Start the next section while you wait.

Check Firestore Database Deployment

Configure permissions for Cloud Build

Cloud Build is a service that executes your builds on Google Cloud infrastructure. By default, Cloud Build does not have sufficient permissions to deploy applications to

• App Engine
• Cloud Run Functions

You must enable these services before you can use Cloud Build to deploy the Google Cloud Data Drive app.

1. In the Console, click Navigation menu > Cloud Build > Settings.
2. Set the Status for Cloud Functions to Enable.

3. When prompted, click Grant access to All Service Accounts.
4. Set the Status for Cloud Run to Enable.
5. Set the Status for App Engine to Enable.

Task 2. Deploy to Cloud Run Functions

Cloud Run Functions is Google Cloud's event-driven serverless compute platform. When you combine Go and Cloud Run Functions, you get the best serverless has to offer in terms of fast spin up times and infinite scale so your application can have the best event driven response times possible.

Have a look at the source code and see how to reuse the Google Cloud Data Drive source code in a Cloud Run Function.

Review the main function

1. At the start of the main function in DIY-Tools/gcp-data-drive/cmd/webserver/main.go, you tell the web server to send all HTTP requests to the gcpdatadrive.GetJSONData Go function.

func main() { // Register the initial HTTP handler. http.HandleFunc("/", gcpdatadrive.GetJSONData) port := os.Getenv("PORT") ...

2. View the main function in main.go on GitHub.

In a Cloud Run Function, the main.go is not used, instead the Cloud Run Function runtime is configured to send HTTP requests directly to the gcpdatadrive.GetJSONData Go function that is defined in the DIY-Tools/gcp-data-drive/gcpdatadrive.go file.

3. You can see how this is done by looking at how the Google Cloud Data Drive application is deployed to Cloud Run Functions using Cloud Build with cloudbuild_gcf.yaml:

Note: The comments have been removed for clarity.

4. View the cloudbuild_gcf.yaml on GitHub.

These Cloud Build steps are also similar to those used to deploy the application to Cloud Run, but in this case, you deploy the application to Cloud Run Functions using the gcloud functions deploy command.

Notice that the Cloud Run Functions --entrypoint parameter is used to specify the GetJSONData function and not the main function in the main Go package that is used when it is deployed to App Engine or Cloud Run.

Deploy the Google Cloud Data Drive app

1. In Cloud Shell, change to the directory for the application that you cloned from GitHub:

cd ~/DIY-Tools/gcp-data-drive

2. Enter the command below to fetch the project details to grant the pubsub.publisher permission to service account.

PROJECT_ID=$(gcloud config get-value project) PROJECT_NUMBER=$(gcloud projects list --filter="project_id:$PROJECT_ID" --format='value(project_number)') SERVICE_ACCOUNT=$(gcloud storage service-agent --project=$PROJECT_ID) gcloud projects add-iam-policy-binding $PROJECT_ID \ --member serviceAccount:$SERVICE_ACCOUNT \ --role roles/pubsub.publisher

3. Deploy the Google Cloud Data Drive app to Cloud Run Functions with Cloud Build:

gcloud builds submit --config cloudbuild_gcf.yaml --project $PROJECT_ID --no-source --substitutions=_GIT_SOURCE_BRANCH="master",_GIT_SOURCE_URL="https://github.com/GoogleCloudPlatform/DIY-Tools",_GCP_REGION="{{{project_0.default_region}}}" Note: If you get a 403 permission error, wait a minute and retry the build command. It typically takes a couple of minutes for the service account permissions to propagate.

4. Enter the following command to allow unauthorized access to the Google Cloud Data Drive Cloud Run Function:

gcloud alpha functions add-iam-policy-binding gcp-data-drive --member=allUsers --role=roles/cloudfunctions.invoker

If asked, Would you like to run this command and additionally grant [allUsers] permission to invoke function [gcp-data-drive] (Y/n)?, enter Y.

5. Store the Cloud Run Functions HTTP Trigger URL in an environment variable:

export CF_TRIGGER_URL=$(gcloud functions describe gcp-data-drive --format="value(url)")

6. Use curl to call the application to query data from the Firestore symbols collection in your project:

curl $CF_TRIGGER_URL/fs/$PROJECT_ID/symbols/product/symbol | jq .

This responds with the contents of a JSON file containing the values from the symbols collection in your project .

[ { "asin": "", "brand": "", "category": "", "docid": "914600502073", "fbafees": 0, "lastMatchLookup": "0001-01-01T00:00:00Z", "listPrice": 0, "manufacturer": "", "pkgquantity": 0, "salesrank": 0, "smallImage": "", "title": "", "upc": "914600502073" }, { "asin": "0744018307", "bbw": true, "brand": "", "category": "book_display_on_website", "cpip": 2000, "docid": "9780744018301", "fba": false, "fbafees": 722, "inStock": "NOW", "lastMatchLookup": "2020-03-13T14:00:10.209183Z", "lastOfferLookup": "2020-03-13T14:00:13.670858Z", "listPrice": 3999, "manufacturer": "Prima Games", "pkgquantity": 0, "salesrank": 337073, "sfbc": 0, "sfbr": 0, "smallImage": "http://ecx.images-amazon.com/images/I/51NFIAHRfTL._SL75_.jpg", "title": "Wolfenstein II: The New Colossus: Prima Collector's Edition Guide", "upc": "9780744018301" } ]

7. Use curl to call the application to query data from the BigQuery publicviews.ca_zip_codes table in your lab project:

curl $CF_TRIGGER_URL/bq/$PROJECT_ID/publicviews/ca_zip_codes

This responds with the contents of a JSON file containing the results of the BigQuery SQL statement SELECT * FROM publicviews.ca_zip_codes;.

[ { "Zipcode": "96090", "area_land_miles": 1.027, "state_code": "CA" }, { "Zipcode": "94929", "area_land_miles": 1.062, "state_code": "CA" } ] Check Cloud Run Functions application Deployment

Task 3. Additional Cloud Run Functions triggers

Cloud Run Functions has an event driven architecture. The app you deployed uses an HTTP request as an event. Explore the code of another Go app that takes in a different event type. The function is triggered on a Firestore write event.

The Go source code below is adapted from the Go Code sample guide:

package mygopackage import ( "context" "fmt" "log" "time" "cloud.google.com/go/functions/metadata" ) // FirestoreEvent is the payload of a Firestore event. type FirestoreEvent struct { OldValue FirestoreValue `json:"oldValue"` Value FirestoreValue `json:"value"` UpdateMask struct { FieldPaths []string `json:"fieldPaths"` } `json:"updateMask"` } // FirestoreValue holds Firestore fields. type FirestoreValue struct { CreateTime time.Time `json:"createTime"` Fields interface{} `json:"fields"` Name string `json:"name"` UpdateTime time.Time `json:"updateTime"` } // DoSomeThingOnWrite is triggered by // a change to a Firestore document. func DoSomeThingOnWrite(ctx context.Context, e FirestoreEvent) error { meta, err := metadata.FromContext(ctx) if err != nil { return fmt.Errorf("metadata.FromContext: %v", err) } // The variables e and meta contain // the information from the event // so now we can Go do some logic // work with the data. In this case // we are simply writing it to the log. log.Printf("Function triggered by change to: %v", meta.Resource) log.Printf("Old value: %+v", e.OldValue) log.Printf("New value: %+v", e.Value) return nil }

View the example source code on GitHub.

This example contains code that can be used to deploy Cloud Run Functions that handle Firestore events, instead of the HTTP request trigger used in the lab sample application. You register this function with a Cloud Firestore event trigger using DoSomeThingOnWrite as the Cloud Run Functions entrypoint.

Cloud Run Functions currently support the following event triggers.

The example above is a simple case, but you can imagine the potential. Simple Go Cloud Run Functions do tasks that used to come with the burden of managing an operating system. For example, you can use a function like this to run Data Loss Prevention (DLP) to sanitize data when a customer writes something to Cloud Firestore via a mobile app.

The Cloud Run Function could rewrite a summary report to Firestore for web consumption based on a pub/sub event. Any number of small processes that are event based are good candidates for Go Cloud Run Functions. Best of all, there are zero servers to patch.

Task 4. Deploy to App Engine

App Engine is well suited for running Go applications. App Engine is a serverless compute platform that is fully managed to scale up and down as workloads fluctuate. Go applications are compiled to a single binary executable file during deployment. Go cold startup times for applications are often between 80 and 1400 in milliseconds and when running, App Engine can horizontally scale to meet the most demanding global scale workloads in seconds.

Review the Cloud Build YAML config file

The Cloud Build YAML file, DIY-Tools/gcp-data-drive/cloudbuild_appengine.yaml, shown below contains the Cloud Build step definitions that deploy your application to App Engine. You use this file to deploy the application to App Engine.

The first step executes the git command to clone the source repository that contains the application. This step is parameterized to allow you to easily switch between application branches.

The second step executes the sed command to replace the runtime: go113 line in the app.yaml file with runtime: go121. This is necessary because the Go 1.13 runtime is deprecated and will be removed in the future. Note that this is just a patch to keep the app running. You should update the app to use the latest Go runtime in your own projects.

The third step executes the gcloud app deploy command to deploy the application to App Engine.

As with the other examples, you could manually deploy this app using gcloud app deploy, but Cloud Build allows you to offload this to Google infrastructure, for example if you want to create a serverless CI/CD pipeline.

Note: The comments from the file have been removed for clarity. steps: - name: 'gcr.io/cloud-builders/git' args: ['clone','--single-branch','--branch', '${_GIT_SOURCE_BRANCH}','${_GIT_SOURCE_URL}'] - name: 'ubuntu' # Or any base image containing 'sed' args: ['sed', '-i', 's/runtime: go113/runtime: go121/', 'app.yaml'] # Replace go113 with go121 dir: 'DIY-Tools/gcp-data-drive/cmd/webserver' - name: 'gcr.io/cloud-builders/gcloud' args: ['app','deploy','app.yaml','--project','$PROJECT_ID'] dir: 'DIY-Tools/gcp-data-drive/cmd/webserver'

View cloudbuild_appengine.yaml on GitHub.

Deploy the Google Cloud Data Drive app

1. Still in DIY-Tools/gcp-data-drive, deploy the Go webserver app to App Engine using Cloud Build:

gcloud builds submit --config cloudbuild_appengine.yaml \ --project $PROJECT_ID --no-source \ --substitutions=_GIT_SOURCE_BRANCH="master",_GIT_SOURCE_URL="https://github.com/GoogleCloudPlatform/DIY-Tools"

Deployment takes a few minutes to complete.

2. Store the App Engine URL in an environment variable to use in the command to call the app:

Note: The App Engine URL is the target url in the output. export TARGET_URL=https://$(gcloud app describe --format="value(defaultHostname)")

3. Use curl to call the application running on App Engine to query data from Firestore:

curl $TARGET_URL/fs/$PROJECT_ID/symbols/product/symbol | jq .

This responds with the contents of a JSON file containing three values from the symbols collection in your project.

[ { "asin": "", "brand": "", "category": "", "docid": "914600502073", "fbafees": 0, "lastMatchLookup": "0001-01-01T00:00:00Z", "listPrice": 0, "manufacturer": "", "pkgquantity": 0, "salesrank": 0, "smallImage": "", "title": "", "upc": "914600502073" }, { "asin": "0744018307", "bbw": true, "brand": "", "category": "book_display_on_website", "cpip": 2000, "docid": "9780744018301", "fba": false, "fbafees": 722, "inStock": "NOW", "lastMatchLookup": "2020-03-13T14:00:10.209183Z", "lastOfferLookup": "2020-03-13T14:00:13.670858Z", "listPrice": 3999, "manufacturer": "Prima Games", "pkgquantity": 0, "salesrank": 337073, "sfbc": 0, "sfbr": 0, "smallImage": "http://ecx.images-amazon.com/images/I/51NFIAHRfTL._SL75_.jpg", "title": "Wolfenstein II: The New Colossus: Prima Collector's Edition Guide", "upc": "9780744018301" } ]

4. Use curl to call the app running on App Engine to query data from BigQuery:

curl $TARGET_URL/bq/$PROJECT_ID/publicviews/ca_zip_codes | jq .

This responds with the contents of a JSON file containing the results of the BigQuery SQL statement SELECT * FROM publicviews.ca_zip_codes;.

[ { "Zipcode": "96090", "area_land_miles": 1.027, "state_code": "CA" }, { "Zipcode": "94929", "area_land_miles": 1.062, "state_code": "CA" } ]

Increase the load

Increase the load to see what happens.

1. Use the nano editor to create a simple shell script to put some load on the application:

nano loadgen.sh

2. Type or paste the following script into the editor:

#!/bin/bash for ((i=1; i<=1000; i++)); do curl "$TARGET_URL/bq/$PROJECT_ID/publicviews/ca_zip_codes" > /dev/null & done

3. Press Ctrl+X, Y, and then Enter to save the new file.
4. Make the script executable:

chmod +x loadgen.sh

5. Run the load test:

./loadgen.sh

6. In the Console, click Navigation menu > App Engine > Instances.

The Instances window opens and shows a summary of requests/second and a list of instances spawned when you ran the load test in Cloud Shell. Notice how App Engine automatically created additional app instances and distributed the incoming HTTP traffic.

Note: It may take 3 to 5 minutes for the Summary graph to show data. Don't forget to refresh the Instances window!

7. In Cloud Shell, press Ctrl+C to end the load test if it is still running.

Check App Engine application Deployment

Congratulations!

In this self-paced lab, you explored how to use the Go programming language to deploy to the all Google Cloud serverless compute platforms. The following are key takeaways:

• The Go programming language has awesome profitability and efficiency features that make it an excellent fit for modern cloud and on prem applications.
• The same Go code base can be deployed to all Google Cloud serverless, container based, and Anthos compute platforms without modification.
• Cloud Build (also serverless) is a key part of a cloud based CI/CD pipeline to provide consistency in delivering to your application lifecycles.
• Cloud Run Functions, and App Engine are simple serverless platforms that operate at Google scale and are easy to deploy to.
• Google Cloud Data Drive is an open source data extraction library that I can use in my existing Google Cloud environment.

Next steps / Learn more

• To learn more about Go, see The Go Programming Language.
• Check out Go on GitHub.

Google Cloud training and certification

...helps you make the most of Google Cloud technologies. Our classes include technical skills and best practices to help you get up to speed quickly and continue your learning journey. We offer fundamental to advanced level training, with on-demand, live, and virtual options to suit your busy schedule. Certifications help you validate and prove your skill and expertise in Google Cloud technologies.

Manual Last Updated November 05, 2024

Lab Last Tested November 05, 2024

Copyright 2024 Google LLC All rights reserved. Google and the Google logo are trademarks of Google LLC. All other company and product names may be trademarks of the respective companies with which they are associated.