GSP747

Overview

In this lab you create a pipeline for deploying websites based on Hugo, a static website builder. You store the website content in a GitHub repository, deploy the website with Firebase, then use Cloud Build to create a pipeline to automatically deploy new content that is committed to the repository.

Objectives

In this lab you perform the following:

• Read a static website overview.
• Set up a website with Hugo.
• Store website content in a GitHub repository.
• Deploy the website with Firebase
• Create a build pipeline with Cloud Build to automate the deployment.

Prerequisites

To complete this lab you need a personal GitHub account. If necessary, sign up for one at GitHub.com.

You may also find it helpful to have some hands-on experience with the services you will be using. Here are some other labs you may find helpful:

• Build a Serverless App with Cloud Run that Creates PDF Files
• Firebase Web

The benefits of static websites

Static site builders like Hugo have become popular because of their ability to produce websites that do not require web servers. With static web platforms there are no server operating systems or software to maintain. There are, however, various operational considerations. For example, you may want to version control your postings, host your web site on a content delivery network ("CDN") and provision an SSL certificate.

You can address these needs by using a Continuous Integration / Continuous Deployment pipeline on Google Cloud. A deployment pipeline enables developers to rapidly innovate by automating the entire deployment process. In this lab, you will learn to build a pipeline demonstrating this automation.

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 are made available to you.

This hands-on lab lets you do the lab activities in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials 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).

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

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 dialog opens for you to select your payment method. On the left is the Lab Details pane 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 pane.

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 pane.

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 access Google Cloud products and services, click the Navigation menu or type the service or product name in the Search field.

Process overview

Here's a diagram of what you are going to build:

The goal is to be able to commit code and have it trigger the pipeline, which in turn deploys the website. Your journey is in two parts. First, you build the website locally and manually deploy it to Firebase. Second, you automate the process by building a pipeline with Cloud Build.

Task 1. Manual deployment

First build the website manually on a Linux instance to learn the end-to-end process. You also use the Linux instance to perform some of the one-time tasks needed to get Firebase up and running.

Connect to the Linux instance

1. From the Navigation menu () select Compute Engine > VM Instances. Notice the instance that has been built for you.

At the end of the line you should see an External IP address and an SSH button as shown in the figure below. If these are obscured by an information panel, close that panel so you can see the entire line.

2. Record the External IP address for later use.
3. Click SSH. A window opens and you see a shell prompt.

Install Hugo

Now install Hugo in the Linux instance to locally test the website before you deploy it with Firebase. This lab provides a shell script to make this easier.

1. In the Linux instance shell, examine the file installhugo.sh:

Your output should be similar to the sample output below:

Output:

Note the use of the wget command to download Hugo and the tar command to unpack the Hugo archive. You will see similar commands later in this lab when you create the pipeline.

2. Enter the commands below to run the script and install Hugo:

When complete, you receive a message saying that Hugo has been installed into the /tmp directory as shown below.

You are now ready to build the website infrastructure.

Create a repository and the initial web site

Create a GitHub repository to hold the web site and then clone the repository to the Linux instance.

Cloning a repository creates a mirror of it in the shell. This allows you to implement the web site while in the shell, and then later commit your changes to the file system. Later in this lab, you will set up a pipeline that responds to these commits to the repository.

1. Install git and GitHub CLI on the Linux VM and set your project ID , project number and region. Save them as PROJECT_ID, PROJECT_NUMBER and REGION variables.

Enter the following commands in the Linux instance shell:

If prompted, answer Yes to all prompts.

2. Run the following commands to configure Git and GitHub:

3. Enter the following commands to create and clone a code repository:

The output provides confirmations about the creation of the repository and the cloning of the repository as shown in the figure below. Ignore the two warning messages about the repository charge and that the repository is empty.

Click Check my progress to verify the objective. Create a GitHub Repository

Now you are ready to create the site structure.

4. Enter the following commands below in the Linux shell:

Normally the hugo command creates the directory. The --force option will create the site in the repository directory, which already exists. This allows you to keep the Git-related information in the directory that you just cloned.

When complete, you see messages that the site has been created.

4. Now install the hello-friend-ng theme to provide a layout for your site. Enter the following commands in the Linux instance shell:

When complete, you see messages indicating that the theme has been cloned.

5. Remove the git files from the themes directory:

6. With the web site structure set up, you can now preview it. Enter the command below to launch the site at TCP port 8080:

Hugo builds the site and serves it for access on TCP port 8080. The server runs until it is stopped by pressing CTRL+C.

7. Open a browser tab and browse to the external IP address at port 8080. Use the following URL, replacing [EXTERNAL IP] with the external IP address of your instance:

The web site should look like this.

Click Check my progress to verify the objective. Launch the site at TCP port 8080

8. Go back to the Linux shell and press CTRL+C to stop the Hugo server.

Deploy the site to Firebase

1. Install Firebase CLI in the Linux instance shell:

2. Now you need to initialize Firebase. Enter the command below into the shell:

3. Select Hosting: Configure files for Firebase Hosting and (optionally) set up GitHub Action deploys using the arrow keys and spacebar and press ENTER.

• When asked for a project option, select Use an existing project, then use the arrow keys, spacebar, and the ENTER key to select the Project ID, .

• For the public directory, select the default value public.

• For configuring as a single page application, select the default value of N.

For setting up automatic builds and deploys with GitHub, select N.

If asked to overwrite any existing files, select Y.

4. You are ready to deploy the application. Enter the commands below into the Linux instance shell to rebuild the site with Hugo and to deploy it with Firebase:

5. After the application has been deployed, you receive a hosting URL. Click on it and to see the same website being served from the Firebase CDN (content delivery network).

If you receive a generic welcome message, wait a few minutes for the CDN to initialize and refresh the browser window. Record this hosting URL for later use.

You have now performed the entire deployment locally. Next, you automate the process from end to end using Cloud Build.

Task 2. Automate the deployment

Perform the initial commit

The goal of building the pipeline is to be able to trigger builds when changes are made to the repository. You start by performing an initial commit to the repository to validate your ability to make future changes.

1. Configure the git commands global parameters by entering the commands below into the Linux shell. Make sure to include the quotation marks:

2. In the Linux shell, enter the commands below to create a .gitignore file to exclude certain directories from the repository:

3. Perform the initial commit to the repository:

You have now committed (uploaded) the initial version of the website to Google Cloud.

Configure the build

Cloud Build uses a file named cloudbuild.yaml in the root directory of the repository to perform the build. The file is in YAML format. Spacing and indentation are important, so it has already been placed on the Linux instance for you.

1. In the Linux shell, enter the following command. Note the final period (".") at the end of the cp command:

2. Run the following command to see what the cloudbuild.yaml file looks like.

Some lines in the output have wrapped because of their length.

Output:

3. Here are some observations about the cloudbuild.yaml file:

• There are three named steps in this file, each of which is performed by a container image. The first two steps use a Google-supported builder to use curl to download the Hugo and Firebase tools. These two steps run in parallel. Using the curl builder is faster than installing curl manually.
• The third step uses a standard Ubuntu container to install Hugo and Firebase after which the site is built and deployed. Installing Hugo and Firebase for each deployment allows you to change the version of Hugo whenever you desire while also using the latest version of Firebase.
• The tar and wget commands are nearly identical to those used earlier in the installhugo.sh script.
• The file also uses a custom substitution variable (_HUGO_VERSION) and a Google-provided substitution variable (PROJECT_ID) to allow for this template to be used in different environments.
• The Hugo and Firebase binaries are created and installed in a temporary directory so that they do not inadvertently get deployed to the website itself.

Connect to a GitHub repository and create a Cloud Build repository

1. Initiate a connection to your GitHub repository in the Linux instance.

2. Find the actionUri:

   etag: yKV297keFBHzs1UcgMsbYJlEYvYdIkfFLJMYZfOADu8 githubConfig: {} installationState: actionUri: https://accounts.google.com/AccountChooser?continue=https%3A%2F%2Fconsole.cloud.google.com%2Fm%2Fgcb%2Fgithub%2Flocations%2Fus-east4%2Foauth_v2%3Fconnection_name%3Dprojects%252F921646058273%252Flocations%252Fus-east4%252Fconnections%252Fcloud-build-connection message: Please log in to https://github.com using a robot account and then follow this link to authorize Cloud Build to access that account. After authorization, your GitHub authorization token will be stored in Cloud Secret Manager. stage: PENDING_USER_OAUTH name: projects/qwiklabs-gcp-00-40e7d6bb49bb/locations/us-east4/connections/cloud-build-connection reconciling: false updateTime: '2024-12-12T08:52:48.505263316Z'

3. Open the actionUri in a new browser tab.

4. Click Continue.

Install the Cloud Build GitHub App in your account or in an organization you own. Permit the installation using your GitHub account.

4. Under Repository access, choose Only select repositories. Click Select repositories and select the repository .

5. Click Save.

6. Create a Cloud Build repository:

Click Check my progress to verify the objective. Connect to a GitHub repository and create Cloud Build repository

Create the Cloud Build trigger

Now create a trigger that responds to commits to the master branch of the repository.

1. In the Linux instance shell, enter the following command:

Click Check my progress to verify the objective. Create the Cloud Build trigger

The Cloud Build service account

The Cloud Build service account must have permissions to use Firebase to deploy the website.

Test the pipeline

Now that you have created the pipeline, make a change to the site then commit it to see if the change propagates.

1. In the Linux shell enter the command below to move to the repository directory:

2. Edit the file config.toml and change the title:

3. Enter the commands below to commit the changes to the repository and trigger the Cloud Build pipeline:

4. Check the build history to see the status of the build:

5. Check the build logs for the current build:

6. Grab the URL from the build performed:

7. Browse to the hosting URL to see the results.

You can also go to the Firebase console and examine the project to find the domain name.

Click Check my progress to verify the objective. Test the pipeline

Congratulations!

You have learned how Cloud Build can orchestrate a pipeline to quickly deploy Hugo websites to Firebase, which provides a CDN and SSL certificate. Cloud Build allows you to tailor the process to your needs. The short deployment times allow you to innovate quickly and test your website revisions with little effort. Consult the Cloud Build and Firebase documentation for more information.

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 February 11, 2024

Lab Last Tested February 10, 2024

Copyright 2025 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.