Console
Start free

Get started with Python

This tutorial is intended for those new to building apps in the cloud, such as engineers and web developers, who want to learn key app development concepts as they apply to Google Cloud.

Objectives

Costs

In this document, you use the following billable components of Google Cloud:

The instructions in this document are designed to keep your resource usage within the limits of Google Cloud's Always Free tier. To generate a cost estimate based on your projected usage, use the pricing calculator.

New Google Cloud users might be eligible for a free trial.

When you finish the tasks that are described in this document, you can avoid continued billing by deleting the resources that you created. For more information, see Clean up.

Before you begin

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

  6. To create a Firestore database in Native mode, complete the following steps:
    1. In the Google Cloud console, go to the Firestore create database page.

      Go to Firestore create database

    2. From the Select a Cloud Firestore mode screen, click Select Native Mode.
    3. Select a location for your Firestore database. This location setting is the default Google Cloud resource location for your Google Cloud project . This location is used for Google Cloud services in your Google Cloud project that require a location setting, specifically, your default Cloud Storage bucket and your Cloud Run app.
    4. Click Create Database.

  7. Enable the Cloud Run Admin, Cloud Storage, Cloud Logging, and Error Reporting APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  8. Clone the sample repo and open the sample application in Cloud Shell:
    Go to Cloud Shell

    Cloud Shell provides command-line access to your Google Cloud resources directly from the browser.

  9. To download the sample code and change into the app directory, click Proceed.

  10. In Cloud Shell, configure the gcloud tool to use your new Google Cloud project: 

    # Configure gcloud for your project
gcloud config set project PROJECT_ID

    Replace PROJECT_ID with the Google Cloud project ID that you created using the Google Cloud console.

    The Google Cloud CLI is the primary way you interact with your Google Cloud resources from the command line. In this tutorial, you use the gcloud tool to deploy and monitor your app.

Run your app

  1. In Cloud Shell, install your app dependencies using pip: 
    pip3 install -r requirements.txt --user
  2. Run the Gunicorn HTTP server: 
    ~/.local/bin/gunicorn -b :8080 main:app
  3. In Cloud Shell, click Web preview , and select Preview on port 8080. This opens a new window with your running app.

Deploy your app to Cloud Run

Google Cloud offers several options for running your code. For this example, you use Cloud Run to deploy a scalable app to Google Cloud. Cloud Run doesn't require you to manage servers and automatically scales to support traffic spikes.

  • Use Cloud Build to build a Docker container and publish to Container Registry:
    gcloud builds submit --tag gcr.io/PROJECT_ID/bookshelf .

    Replace PROJECT_ID with the Google Cloud project ID that you created.

    • Run the container with Cloud Run: 
    gcloud run deploy bookshelf --image gcr.io/PROJECT_ID/bookshelf \
--platform managed --region us-central1 --allow-unauthenticated

    Your app is now viewable at the URL displayed in the output of gcloud run:

    Service [bookshelf] revision [bookshelf-00001] has been deployed and is serving 100 percent of traffic. 
Service URL: https://bookshelf-swsmmh5s5a-uc.a.run.app
     Copy the URL into your web browser to view the app.

    Bookshelf app homepage

    For more information on deploying to Cloud Run, see the Cloud Run documentation.

    Persist your data with Firestore

    You cannot store information on your Cloud Run instances, because it is lost if the instance is restarted, and doesn't exist when new instances are created. Instead, you use a database that all your instances read from and write to.

    Google Cloud offers several options for storing your data. In this example, you use Firestore to store the data for each book. Firestore is a fully managed, serverless, NoSQL document database that lets you store and query data. Firestore auto scales to meet your app needs, and scales to zero when you're not using it. Add your first book now.

    1. To create a book for your deployed app, click Add book.

      Add a book to the Bookshelf app
    2. In the Title field, enter Moby Dick.
    3. In the Author field, enter Herman Melville.

    4. Click Save. There is now an entry to your Bookshelf app.

      Moby Dick Bookshelf app entry
    5. In the Google Cloud console, to refresh the Firestore page, click Refresh . The data appears in Firestore. The Bookshelf app stores each book as a Firestore document with a unique ID, and all these documents are stored in a Firestore collection. For the purposes of this tutorial, the collection is called books. Example of a Firestore document.

    Firestore stores the books by using the Firestore Client Library. Here is an example of fetching a Firestore document: 

    from google.cloud import firestore
     
    db = firestore.Client()
book_ref = db.collection(u'Book').document(book_id)
snapshot = book_ref.get()

    For more information on using Firestore, see Adding data to Firestore.

    Store file uploads in Cloud Storage

    Now that you've added a book, it's time to add the book cover image. You cannot store files on your instances. A database isn't the right choice for image files. Instead, you use Cloud Storage.

    Cloud Storage is the primary blob store for Google Cloud. You can use Cloud Storage to host app assets that you want to share across Google Cloud. To use Cloud Storage, you need to create a Cloud Storage bucket, a basic container to hold your data.

    1. In the Google Cloud console, go to the Cloud Storage Browser page.

      Go to the Cloud Storage Browser page

    2. Click Create bucket.
    3. In the Create bucket dialog, enter a name for your bucket by appending your Google Cloud project ID to the string _bucket so the name looks like YOUR_PROJECT_ID_bucket. This name is subject to the bucket name requirements. All other fields can remain at their default values.
    4. Click Create.
    5. After your bucket is created, objects must be made publicly accessible to be viewed by users. To make your objects publicly accessible see Making Data Public.
    6. Click Edit book, and select an image to upload as your book's cover. For example, you can use this public domain image:
      Moby Dick book cover
    7. Click Save. You're redirected to the homepage, where there is an entry to your Bookshelf app.
      Moby Dick Bookshelf app entry

    The bookshelf app sends uploaded files to Cloud Storage by using the Cloud Storage Client Library. 

    client = storage.Client()
bucket = client.bucket(bucketname)
blob = bucket.blob(filename)

blob.upload_from_string(
    file_stream,
    content_type=content_type)
# Ensure the file is publicly readable.
blob.make_public()

url = blob.public_url

    For more information on using Cloud Storage, see the Cloud Storage introduction.

    Monitor your app using Google Cloud Observability

    You've deployed your app and created and modified books. To monitor these events for your users, use Application Performance Management.

    Monitor logs with Cloud Logging

    1. In the Google Cloud, go to the Logs Explorer

      Go to Logs Explorer

      You can monitor your app in real time. If you have any issues with your app, this is one of the first places to look.

      Stackdriver Log Viewer
    2. In the Resource drop-down list, select Cloud Run Revision, bookshelf.

    Monitor errors with Error Reporting

    1. In the Google Cloud console, go to the Error Reporting page.
      Go to Error Reporting page
      Error Reporting highlights errors and exceptions in your app and lets you set up alerting around them.
    2. In your browser, go to the /errors URL in your app.
      YOUR_CLOUD_RUN_URL/errors

      This generates a new test exception and sends it to Google Cloud Observability.

    3. In the Google Cloud console, return to the Error Reporting page, and in a few moments the new error is visible. Click Auto Reload so you don't need to manually refresh the page.

      Error message from Error Reporting.

    Clean up

    To avoid incurring charges to your Google Cloud account for the resources used in this tutorial, either delete the project that contains the resources, or keep the project and delete the individual resources.

    Delete the project

    1. In the Google Cloud console, go to the Manage resources page.

      Go to Manage resources

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

    What's next