Deploying the Node.js Bookshelf app using Cloud Deployment Manager

This tutorial shows how to deploy the Node.js Bookshelf sample app using Cloud Deployment Manager.

Deployment Manager lets you create the necessary Google Cloud Platform (GCP) resources for a deployment in a single step through a declarative, repeatable process. With Deployment Manager, you can update your deployments, track your modifications over time, create templates using Jinja or Python, and parameterize your templates, so that similar deployments share a template.

Objectives

  • Clone and configure the Bookshelf sample app.
  • Create Deployment Manager configurations and templates.
  • Create Deployment Manager deployments.
  • Deploy the Bookshelf sample app using Deployment Manager.

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. For more information, see Cleaning up.

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 GCP project.

    Go to the project selector 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, Cloud Storage API, Cloud Pub/Sub API APIs.

    Enable the APIs

  5. Install and initialize the Cloud SDK.
  6. Install Node.js and npm by using the official installer.

Creating a Cloud Storage bucket

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]

Cloning the sample app

The sample app is available on GitHub at GoogleCloudPlatform/nodejs-getting-started.

  1. Clone the repository:

    git clone https://github.com/GoogleCloudPlatform/nodejs-getting-started.git
    
  2. Go to the sample directory:

    cd nodejs-getting-started/7-gce
    

Configuring the app

In the 7-gce directory, create a file named config.json with the following contents:

{
    "GCLOUD_PROJECT": "[YOUR_PROJECT_ID]",
    "CLOUD_BUCKET": "[YOUR_BUCKET_NAME]",
    "DATA_BACKEND": "datastore",
    "OAUTH2_CLIENT_ID": "none",
    "OAUTH2_CLIENT_SECRET": "none",
    "OAUTH2_CALLBACK": "http://localhost:8080/auth/google/callback"
}

Replace [YOUR_PROJECT_ID] with your GCP project ID and [YOUR_BUCKET_NAME] with the name of your Cloud Storage bucket.

Running the app on your local computer

Follow these steps to run the app locally.

  1. Install dependencies by running npm install.

  2. Start the app by running npm start.

    To view the locally running app, go to http://localhost:8080.

    To stop the local web server, press Control+C.

Deploying the sample app

Push your code to a repository

You can get your code onto a running Compute Engine instance in several ways. One way is to use Cloud Source Repositories. Every project includes a Git repository that is available to Compute Engine instances. Your instances then pull the latest version of your app's code during startup. Using a Git repository is convenient because updating your app doesn't require configuring new images or instances; just restart an existing instance or create one.

If this is your first time using Git, use git config --global to set up your identity.

  1. In your GCP Console, create a repository:

    Create repository

  2. Then push your app code to your project's repository:

    git commit -am "Updating configuration"
    git config credential.helper gcloud.sh
    git remote add cloud https://source.developers.google.com/p/[YOUR_PROJECT_ID]/r/[YOUR_REPO]
    git push cloud master
    

    where [YOUR_PROJECT_ID] is your project ID and [YOUR_REPO] is the name of your repository.

Create the deployment

After your configuration is committed and your code is uploaded to Cloud Source Repositories, you can use the Deployment Manager to create the deployment:

  1. Go to the deployment_manager directory:

    cd nodejs-getting-started/7-gce/gce/deployment-manager
    
  2. Create the deployment:

    gcloud deployment-manager deployments create my-deployment --config config.yaml
    
  3. View a list of all the deployments:

    gcloud deployment-manager deployments list
    
  4. Get a description of the deployment and the resources it created:

    gcloud deployment-manager deployments describe my-deployment
    

View your app

After you create the forwarding rule, it can take several minutes for your configuration to propagate and for traffic to be routed to your instances.

  1. To check the progress:

    gcloud compute backend-services get-health bookshelf-my-deployment-frontend --global
    
  2. When at least one of your instances reports HEALTHY, get the forwarding IP address for the load balancer:

    gcloud compute forwarding-rules list --global
    

    Your forwarding-rules IP address is in the IP_ADDRESS column.

  3. In your browser, enter the IP address from the list.

    Your app is now running on GCP.

Understanding the code

Configure the deployment

You can see how the deployment is configured in config.yaml:

imports:
- name: bookshelf.jinja
  path: ./bookshelf.jinja

resources:
- name: bookshelf
  type: bookshelf.jinja
  properties:
    zone: us-central1-f
    machine-type: n1-standard-1
    machine-image: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/images/family/debian-8
    min-instances: 1
    max-instances: 10
    target-utilization: 0.6
    scopes:
    - https://www.googleapis.com/auth/cloud-platform

The configuration file imports the template file as a resource and uses it to define a resource named bookshelf. The template takes several properties as parameters. For more information about creating Deployment Manager configuration files, see Creating a configuration.

Configure the deployment template's schema

Look at the schema file bookshelf.jinja.schema, which defines and documents the parameters that the deployment is expected to provide in its configuration file. For more information about configuration schemas, see Using schemas.

info:
  title: Bookshelf GCE Deploy
  author: Google Inc.
  description: Creates a GCE Deployment

imports:
- name: startup-script
  path: ../startup-script.sh

required:
- zone
- machine-type
- min-instances
- max-instances
- scopes

properties:
  zone:
    description: Zone to create the resources in.
    type: string
  machine-type:
    description: Type of machine to use
    type: string
  machine-image:
    description: The OS image to use on the machines
    type: string
  min-instances:
    description: The minimum number of VMs the autoscaler will create
    type: integer
  max-instances:
    description: The maximum number of VMs the autoscaler will create
    type: integer
  target-utilization:
    description: The target CPU usage for the autoscaler to base its scaling on
    type: number
  scopes:
    description: A list of scopes to create the VM with
    type: array
    minItems: 1
    items:
      type: string

Configure the deployment template

The template defines several resources needed to create an autoscaled, load- balanced, managed instance group. See the comments in the template for a full description of the resources created, and review the Bookshelf on Compute Engine tutorial for a more thorough explanation of the resources being created.

Keep in mind that Deployment Manager provides a way to declaratively define resources, but most of the configuration for a given resource is defined by its API. For example, most of the configuration options for the instance template resource are found in the Instance template resource definition in the reference documentation for the Compute Engine API.

The template is written using the Jinja templating language. When writing Deployment Manager templates, you can either use Jinja or Python. Jinja has the advantage of being more declarative, which can be more readable and easier to understand than Python. For some complex deployments, the full expressiveness of Python might make things simpler. In this case, Jinja is sufficient to create the necessary resources.

In a template, certain environment variables are automatically set, and you can access these variables by using the env dictionary. In this case, the name of the deployment is referenced as a name to be reused when assigning names to the resources that are created. For more information about available environment variables, see Using environment variables in the Deployment Manager documentation:

{% set NAME = "bookshelf-" + env["deployment"] %}
{% set SERVICE = "bookshelf-" + env["deployment"] + "-frontend" %}

The template uses the same startup script that is used in the Compute Engine tutorial. The script's content is inserted into the template, and the Jinja indent directive indents the content correctly:

            value: |
{{imports['startup-script']|indent(14, true)}}

In a Deployment Manager Jinja template, you can also refer to resources created elsewhere in the template. In the following example, the backend service uses the reference of the managed instance group to obtain the instance group it should point to:

- group: $(ref.{{ NAME }}-frontend-group.instanceGroup)
  zone: {{ properties['zone'] }}

Properties specified in config.yaml can be used in the template:

minNumReplicas: {{ properties['min-instances'] }}
maxNumReplicas: {{ properties['max-instances'] }}
loadBalancingUtilization:
  utilizationTarget: {{ properties['target-utilization'] }}

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 .
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Delete your deployment

Enter the following command to delete your deployment. This deletes the load balancer and any Compute Engine instances associated with your deployment:

gcloud deployment-manager deployments delete my-deployment

What's next

هل كانت هذه الصفحة مفيدة؟ يرجى تقييم أدائنا:

إرسال تعليقات حول...