Running the Go Bookshelf on Kubernetes Engine

This tutorial shows how to run the Go Bookshelf sample app on Google Kubernetes Engine (GKE). Follow this tutorial to containerize and deploy an existing Go web app to GKE. It's recommended that you work through the Bookshelf app documentation as part of the tutorial for the App Engine standard environment.

Objectives

  • Create a GKE cluster.
  • Containerize a Go app.
  • Create a replicated frontend for the Bookshelf app.
  • Create a replicated backend for the Bookshelf app.
  • Create a load-balanced service to route HTTP traffic to the Bookshelf frontend.

Costs

This tutorial uses the following billable components of Google Cloud Platform:

You can use the pricing calculator to generate a cost estimate based on your projected usage. New GCP users might be eligible for a free trial.

When you finish this tutorial, you can avoid continued billing by deleting the resources you created. See Cleaning up for more detail.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a Google Cloud Platform project.

    Go to the Manage resources page

  3. Make sure that billing is enabled for your Google Cloud Platform project.

    Learn how to enable billing

  4. Enable the Cloud Datastore API, GKE API, Cloud Storage API, Cloud Pub/Sub API APIs.

    Enable the APIs

  5. Install and initialize the Cloud SDK.
  6. Install Docker. Docker is used to build container images locally.
  7. Install kubectl.
    gcloud components install kubectl

Creating a GKE cluster

A GKE cluster is a managed set of Compute Engine virtual machines (VMs) that operate as a single GKE cluster. This tutorial needs a cluster with a minimum of two nodes, and these nodes need access to all Google APIs.

  1. Create the cluster. Replace [YOUR_GCP_ZONE] with the GCP zone where you want to host your cluster.

    gcloud container clusters create bookshelf \
        --scopes "cloud-platform" \
        --num-nodes 2 \
        --enable-basic-auth \
        --issue-client-certificate \
        --enable-ip-alias \
        --zone [YOUR_GCP_ZONE]
    
  2. Verify that you have access to the cluster. The following command lists the nodes in your container cluster and indicates that your container cluster is running and that you have access to it.

    kubectl get nodes
    

You use the kubectl command to create resources in a GKE cluster. To learn more about kubectl, see GKE cluster operations. In general, you use gcloud to manage resources in your GCP project, and you use kubectl to manage resources within your GKE cluster. A single project can have multiple clusters, which makes it easy to have clusters that are made up of different machine types to satisfy different needs.

When you create a cluster with gcloud, authentication is set up automatically for kubectl. If you use the Google Cloud Platform Console to create clusters, you can set up authentication by using the gcloud container clusters get-credentials command.

Cloning the sample app

The sample app is available on GitHub at GoogleCloudPlatform/golang-samples.

  1. Clone the repository.

    go get -u -d github.com/GoogleCloudPlatform/golang-samples/getting-started/bookshelf
    
  2. Go to the sample directory.

    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/getting-started/bookshelf
    

Initializing Cloud Datastore

The Bookshelf app uses Cloud Datastore to store the books. To initialize Cloud Datastore in your project for the first time, complete the following steps:

  1. In the GCP Console, open the Cloud Datastore page.

    Go to the Cloud Datastore page

  2. Select a region for your datastore and click Continue until you reach the Create an Entity page. Close the window; the Bookshelf app is ready to create entities in Cloud Datastore.

Creating a Cloud Storage bucket

The Bookshelf app uses Cloud Storage to store image files.

The following instructions show how to create a Cloud Storage bucket. Buckets are the basic containers that hold your data in Cloud Storage.

  1. In a terminal window, enter the following command:

    gsutil mb gs://[YOUR-BUCKET-NAME]

    [YOUR-BUCKET-NAME] represents the name of your Cloud Storage bucket.

  2. To view uploaded images in the bookshelf app, set the bucket's default access control list (ACL) to public-read.

    gsutil defacl set public-read gs://[YOUR-BUCKET-NAME]

Configuring the app

  1. Copy the Dockerfile to the bookshelf directory.

    cp gke_deployment/Dockerfile .
    
  2. Open config.go for editing. This file contains the configuration settings for the sample app.

  3. Uncomment the following line, and replace <your-project-id> with your project ID:

    // DB, err = configureDatastoreDB("<your-project-id>")
    
  4. Uncomment the following lines, and replace <your-storage-bucket> with the name of the bucket you created in the previous step:

    // StorageBucketName = "<your-storage-bucket>"
    // StorageBucket, err = configureStorage(StorageBucketName)
    
  5. Uncomment the following line, and replace <your-project-id> with your project ID:

    // PubsubClient, err = configurePubsub("<your-project-id>")
    

Containerizing the app

The sample app includes a Dockerfile, which is used to create the app's Docker image. This Docker image runs the app on GKE.

FROM golang:alpine

ARG pkg=github.com/GoogleCloudPlatform/golang-samples/getting-started/bookshelf

RUN apk add --no-cache ca-certificates

COPY . $GOPATH/src/$pkg

RUN set -ex \
      && apk add --no-cache --virtual .build-deps \
              git \
      && go get -v $pkg/... \
      && apk del .build-deps

RUN go install $pkg/...

# Needed for templates for the front-end app.
WORKDIR $GOPATH/src/$pkg/app

# Users of the image should invoke either of the commands.
CMD echo "Use the app or pubsub_worker commands."; exit 1
  1. Build the app's Docker image.

    docker build -t gcr.io/[YOUR_PROJECT_ID]/bookshelf
    
  2. Push the image to Container Registry so that your cluster can access the image.

    gcloud docker -- push gcr.io/[YOUR_PROJECT_ID]/bookshelf
    

Deploying the Bookshelf frontend

The Bookshelf app has a frontend server that handles the web requests and a backend worker that processes books and adds additional information.

The cluster resources needed to run the frontend are defined in bookshelf-frontend.yaml. These resources are described as a GKE deployment. You can use deployments to create and update a replica set and its associated pods.

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This file configures the bookshelf application frontend. The frontend serves
# public web traffic.

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: bookshelf-frontend
  labels:
    app: bookshelf
    tier: frontend
# The bookshelf frontend replica set ensures that at least 3
# instances of the bookshelf app are running on the cluster.
# For more info about Pods see:
#   https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/
spec:
  replicas: 3
  template:
    metadata:
      labels:
        app: bookshelf
        tier: frontend
    spec:
      containers:
      - name: bookshelf-app
        # TODO: Replace [YOUR_PROJECT_ID] with your project ID.
        image: gcr.io/[YOUR_PROJECT_ID]/bookshelf:latest
        command: ["app"]
        # This setting makes nodes pull the docker image every time before
        # starting the pod. This is useful when debugging, but should be turned
        # off in production.
        imagePullPolicy: Always
        # The bookshelf process listens on port 8080 for web traffic by default.
        ports:
        - name: http-server
          containerPort: 8080
  1. In bookshelf-frontend.yaml, replace [YOUR_PROJECT_ID] with your project ID.

  2. Deploy the resources to the cluster.

    kubectl create -f bookshelf-frontend.yaml
    
  3. Track the status of the deployment.

    kubectl get deployments
    

    Once the deployment has the number of available pods that you want, the deployment is complete. If you run into issues with the deployment, you can delete it and start over.

    kubectl delete deployments bookshelf-frontend
    
  4. Once the deployment is complete, you can see the pods that the deployment created.

    kubectl get pods
    

Deploying the Bookshelf backend

The Bookshelf backend is deployed the same way as the frontend.

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This file configures the bookshelf application frontend. The frontend serves
# public web traffic.

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: bookshelf-worker
  labels:
    app: bookshelf
    tier: worker
# The bookshelf frontend replica set ensures that at least 3
# instances of the bookshelf app are running on the cluster.
# For more info about Pods see:
#   https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/
spec:
  replicas: 2
  template:
    metadata:
      labels:
        app: bookshelf
        tier: worker
    spec:
      containers:
      - name: bookshelf-worker
        # TODO: Replace [YOUR_PROJECT_ID] with your project ID.
        image: gcr.io/[YOUR_PROJECT_ID]/bookshelf:latest
        command: ["pubsub_worker"]
        # This setting makes nodes pull the docker image every time before
        # starting the pod. This is useful when debugging, but should be turned
        # off in production.
        imagePullPolicy: Always
  1. In bookshelf-worker.yaml, replace [YOUR_PROJECT_ID] with your project ID.

  2. Deploy the resources to the cluster.

    kubectl create -f bookshelf-worker.yaml
    
  3. Verify that the pods are running.

    kubectl get pods
    

Creating the Bookshelf service

GKE services provide a single point of access to a set of pods. While it's possible to access a single pod, pods are ephemeral, and it's more convenient to address a set of pods with a single endpoint. In the Bookshelf app, the Bookshelf service lets you access the Bookshelf frontend pods from a single IP address. This service is defined in bookshelf-service.yaml.

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# The bookshelf service provides a load-balancing proxy over the bookshelf
# frontend pods. By specifying the type as a 'LoadBalancer', Kubernetes Engine
# will create an external HTTP load balancer.
# For more information about Services see:
#   https://cloud.google.com/kubernetes-engine/docs/services/
# For more information about external HTTP load balancing see:
#   https://cloud.google.com/kubernetes-engine/docs/load-balancer
apiVersion: v1
kind: Service
metadata:
  name: bookshelf-frontend
  labels:
    app: bookshelf
    tier: frontend
spec:
  type: LoadBalancer
  ports:
  - port: 80
    targetPort: http-server
  selector:
    app: bookshelf
    tier: frontend

Notice that the pods and the service that uses the pods are separate. Kubernetes uses labels to select the pods that a service addresses. With labels, you can have a service that addresses pods from different replica sets and have multiple services that point to an individual pod.

  1. Create the Bookshelf service.

    kubectl create -f bookshelf-service.yaml
    
  2. Get the service's external IP address.

    kubectl describe service bookshelf
    

    It might take up to a minute to allocate the IP address. The external IP address is listed under LoadBalancer Ingress.

Accessing the Bookshelf app

You've now deployed all the resources needed to run the Bookshelf app on GKE. To load the app in your web browser and create books, use the external IP address from the previous step.

If you deployed the worker, the books are automatically updated with information from the Google Books API.

Cleaning up

To avoid incurring charges to your Google Cloud Platform account for the resources used in this tutorial:

Delete the project

The easiest way to eliminate billing is to delete the project that you created for the tutorial.

To delete the project:

  1. In the GCP Console, go to the Projects page.

    Go to the Projects page

  2. In the project list, select the project you want to delete and click Delete delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Delete the cluster

Deleting the cluster removes all GKE and Compute Engine resources, but you need to manually remove any resources in Cloud Storage, Cloud Datastore, and Cloud Pub/Sub.

Delete the cluster by using the following command. Replace [YOUR_GCP_ZONE] with the zone you used when creating the cluster.

gcloud container clusters delete bookshelf --zone [YOUR_GCP_ZONE]

What's next

  • Try out other Google Cloud Platform features for yourself. Have a look at our tutorials.
  • Explore other GCP services.
Was this page helpful? Let us know how we did:

Send feedback about...