arrow_back

Running a Node.js Container on Google Kubernetes Engine

Join Sign in

Running a Node.js Container on Google Kubernetes Engine

40 minutes 1 Credit

GSP015

Google Cloud selp-paced labs logo

Overview

Google Kubernetes Engine makes it easy to run Docker containers in the cloud. Google Kubernetes Engine uses Kubernetes, an open source container scheduler, to ensure that your cluster is running exactly the way you want it to at all times.

In this lab you will learn how to launch a container and how to launch replicas of that container on Google Kubernetes Engine.

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 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 Console. 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 from the Lab Details panel and paste it into the Sign in dialog. Click Next.

  4. Copy the Password from the Lab Details panel and paste it into the Welcome dialog. Click Next.

    Important: You must use the credentials from the left panel. Do not use your Google Cloud Skills Boost credentials. Note: Using your own Google Cloud account for this lab may incur extra charges.
  5. 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 Cloud Console opens in this tab.

Note: You can view the menu with a list of Google Cloud Products and Services by clicking the Navigation menu at the top-left. Navigation menu icon

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. In the Cloud Console, in the top right toolbar, click the Activate Cloud Shell button.

Cloud Shell icon

  1. Click Continue.

It takes a few moments to provision and connect to the environment. 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 YOUR_PROJECT_ID

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

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

gcloud auth list

(Output)

ACTIVE: * ACCOUNT: student-01-xxxxxxxxxxxx@qwiklabs.net To set the active account, run: $ gcloud config set account `ACCOUNT`
  1. (Optional) You can list the project ID with this command:

gcloud config list project

(Output)

[core] project = <project_ID>

(Example output)

[core] project = qwiklabs-gcp-44776a13dea667a6 For full documentation of gcloud, in Google Cloud, Cloud SDK documentation, see the gcloud command-line tool overview.

Creating a Cluster

In this section you'll create a Google Kubernetes Engine cluster.

Set Compute Zone

Cloud Shell is a browser based terminal to a virtual machine that has the Google Cloud tools installed on it and some additional tools (like editors and compilers) that are handy when you are developing or debugging your cloud application.

You'll be using the gcloud command to create the cluster. First, set the compute zone so that the virtual machines in your cluster are created in the correct region. Do this using gcloud config set compute/zone.

Enter the following in Cloud Shell:

gcloud config set compute/zone us-central1-a

Understanding Regions and Zones

Certain Compute Engine resources live in regions or zones. A region is a specific geographical location where you can run your resources. Each region has one or more zones. For example, the us-central1 region denotes a region in the Central United States that has zones us-central1-a, us-central1-b, us-central1-c, and us-central1-f.

regions_and_zones.png

Resources that live in a zone are referred to as zonal resources. Virtual machine Instances and persistent disks live in a zone. To attach a persistent disk to a virtual machine instance, both resources must be in the same zone. Similarly, if you want to assign a static IP address to an instance, the instance must be in the same region as the static IP.

Learn more about regions and zones and see a complete list in Regions & Zones documentation).

Create a New Cluster

Create a new container cluster with the gcloud command like this:

gcloud container clusters create hello-world

This command creates a new cluster called hello-world with three nodes (VMs). You can configure this command with additional flags to change the number of nodes, the default permissions, and other variables. See the documentation for more details.

Hint: If you get an error when running gcloud container clusters create ensure that you have enabled both the Google Kubernetes Engine and Compute Engine APIs.

Launching the cluster may take a few minutes. Once it is up you should see output in Cloud Shell that looks like this:

NAME LOCATION MASTER_VERSION MASTER_IP MACHINE_TYPE NODE_VERSION NUM_NODES STATUS hello-world us-central1-a 1.12.7-gke.10 35.239.64.154 n1-standard-1 1.12.7-gke.10 3 RUNNING

Test Completed Task

Click Check my progress to verify your performed task. If you have completed the task successfully you will be granted with an assessment score.

Create a Kubernetes Cluster (zone: us-central1-a).

Building and Publishing the Node.js App

Next, build and publish a container that contains your code. You will use Docker to build the container, and Google Container Registry to securely publish it.

Set your project ID

You will use Project ID in many of the commands in this lab. The Project ID is conveniently stored in an environment variable in Cloud Shell. You can see it here:

echo $DEVSHELL_PROJECT_ID

Get the sample code

Run the following to clone the samples:

git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

Change directories:

cd nodejs-docs-samples/containerengine/hello-world/

Build the container

Docker containers are built using a Dockerfile. The sample code provides a basic Dockerfile that we can use.

cat Dockerfile

Here is the contents of the file:

... # [START all] FROM node:6-alpine EXPOSE 8080 COPY server.js . CMD node server.js # [END all]

To build the container, run the following command:

docker build -t gcr.io/$DEVSHELL_PROJECT_ID/hello-node:1.0 .

This will build a Docker container image stored locally.

Publish the container

In order for Kubernetes to access your image, you need to store it in a container registry.

Run the following command to publish your container image:

gcloud docker -- push gcr.io/$DEVSHELL_PROJECT_ID/hello-node:1.0

Deploying the Node.js App

Now that we have a cluster running and our application built, it is time to deploy it.

Create Your Deployment

A deployment is a core component of Kubernetes that makes sure your application is always running. A deployment schedules and manages a set of pods on the cluster. A pod is one or more containers that "travel together". That might mean they are administered together or they have the same network requirements. For this lab there is only one container in your pod.

Typically you would create a yaml file with the configuration for the deployment. For this lab will skip this step and instead directly create the deployment on the command line.

Create the pod using kubectl:

kubectl create deployment hello-node --image=gcr.io/$DEVSHELL_PROJECT_ID/hello-node:1.0 Note: You can safely ignore any command deprecation warnings.

This command starts up one copy of the Docker image on one of the nodes in the cluster.

Test Completed Task

Click Check my progress to verify your performed task. If you have completed the task successfully you will be granted with an assessment score.

Build and Deploy Nodejs App (hello-node)

Run the following to see the deployment you created using kubectl:

kubectl get deployments

You should get back a result that looks something like:

NAME READY UP-TO-DATE AVAILABLE AGE hello-node 1/1 1 1 30s

You can see the pod running using kubectl as well:

kubectl get pods

You should get back a result that looks something like:

NAME READY STATUS RESTARTS AGE hello-node-3375482827-7hs3q 1/1 Running 0 1m

Allow External Traffic

By default, a pod is only accessible to other machines inside the cluster. In order to use the node.js container that was created, it needs to be exposed as a service.

Typically, you would create a yaml file with the configuration for the service. For this lab will skip this step and instead directly create the deployment on the command line.

Run the following to expose the deployment with the kubectl expose command:

kubectl expose deployment hello-node --name=hello-node --type=LoadBalancer --port=80 --target-port=8080

kubectl expose creates a service, the forwarding rules for the load balancer, and the firewall rules that allow external traffic to be sent to the pod. The --type=LoadBalancer flag creates a Google Cloud Network Load Balancer that will accept external traffic.

To get the IP address for your service, run the following command:

kubectl get svc hello-node

You should get back a result that looks something like:

NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE Hello-node LoadBalancer 10.3.247.85 104.198.151.208 80/TCP 8m Note: It may take a minute or so for the External-IP to populate. If you see <pending> for the External-IP, wait 30 seconds and try again.

Test Completed Task

Click Check my progress to verify your performed task. If you have completed the task successfully you will be granted with an assessment score.

Allow external traffic to hello-node deployment.

Verify the Deployment

Open a new browser window or tab and navigate to the external IP address from the previous step. You should see the sample code up and running!

deployment_response.png

Test your Understanding

Below are multiple-choice questions to reinforce your understanding of this lab's concepts. Answer them to the best of your abilities.

Congratulations!

Google Kubernetes Engine provides a powerful and flexible way to run containers on Google Cloud. Kubernetes can also be used on your own hardware or on other Cloud Providers.

This lab only used a single container, but it is simple to set up multiple container environments, or multiple instances of a single container.

What was covered

  • Google Kubernetes Engine

  • How to build and launch a simple Node.js container on Google Kubernetes Engine

Take Your Next Lab

Try out another lab, like:

Next Steps / Learn More

Google Cloud Training & 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 April 14, 2021
Lab Last Tested April 14, 2021

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