This tutorial shows you how to deploy a simple example gRPC service with the Google Cloud Endpoints Extensible Service Proxy (ESP) on Google Kubernetes Engine. This tutorial uses the Python version of the bookstore-grpc sample. See the What's next section for gRPC samples in other languages.
The tutorial uses prebuilt container images of the sample code and ESP, which are stored in Google Container Registry. If you are unfamiliar with containers, see the following for more information:
Use the following high-level task list as you work through the tutorial. All tasks are required to successfully send requests to the API.
- Set up a Cloud Platform project, and download required software. See Before you begin.
- Copy and configure files from the bookstore-grpc sample. See Configuring Endpoints.
- Deploy the Endpoints configuration to create a Cloud Endpoints service. See Deploying the Endpoints configuration.
- Create a backend to serve the API and deploy the API. See Deploying the API backend.
- Get the service's external IP address: See Getting the service's external IP address.
- Send a request to the API. See Sending a request to the API.
- Avoid incurring charges to your Google Cloud Platform account. See Clean up.
Before you begin
Sign in to your Google Account.
If you don't already have one, sign up for a new account.
Select or create a GCP project.
Make sure that billing is enabled for your project.
- Note the project ID, because you'll need it later.
- Install and initialize the Cloud SDK.
- Update the Cloud SDK and install the Endpoints components.
gcloud components update
- Make sure that Cloud SDK (
gcloud) is authorized to access your data and services on Google Cloud Platform:
gcloud auth loginA new browser tab opens and you are prompted to choose an account.
- Set the default project to your project ID.
gcloud config set project [YOUR_PROJECT_ID]
[YOUR_PROJECT_ID]with your project ID. Do not include the square brackets.
If you have other Cloud Platform projects, and you want to use
gcloudto manage them, see Managing Cloud SDK Configurations.
gcloud components install kubectl
- Acquire new user credentials to use for Application Default Credentials.
The user credentials are needed to authorize
gcloud auth application-default loginA new browser tab opens and you are prompted to choose an account.
- Follow the steps in the gRPC Python Quickstart to install gRPC and the gRPC tools.
The bookstore-grpc sample contains the files that you need to copy locally and configure.
- Create a self-contained protobuf descriptor file from your service
- Save a copy of
bookstore.protofrom the example repo. This file defines the Bookstore service's API.
- Create the following directory:
- Create the descriptor file,
api_descriptor.pb, using the
protocprotocol buffers compiler. Run the following command in the directory where you saved
python -m grpc_tools.protoc \ --include_imports \ --include_source_info \ --proto_path=. \ --descriptor_set_out=api_descriptor.pb \ --python_out=generated_pb2 \ --grpc_python_out=generated_pb2 \ bookstore.proto
In the above command,
--proto_pathis set to the current working directory. In your gRPC build environment, if you use a different directory for
.protoinput files, change
--proto_pathso the compiler searches the directory where you saved
- Save a copy of
- Create a gRPC API Configuration YAML file:
- Save a copy of
api_config.yaml. This file defines the gRPC API configuration for the Bookstore service.
- Replace <MY_PROJECT_ID> in your
api_config.yamlfile with your GCP project ID. For example:
# # Name of the service configuration. # name: bookstore.endpoints.example-project-12345.cloud.goog
Note that the
apis.namefield value in this file exactly matches the fully-qualified API name from the
.protofile; otherwise deployment won't work. The
Bookstoreservice is defined in
endpoints.examples.bookstore. Its fully-qualified API name is
endpoints.examples.bookstore.Bookstore, just as it appears in
apis: - name: endpoints.examples.bookstore.Bookstore
- Save a copy of
See Configuring Endpoints for more information.
Deploying the Endpoints Configuration
To deploy the Endpoints configuration, you use the gcloud endpoints services deploy command. This command uses Service Infrastructure, Google’s foundational services platform, used by Cloud Endpoints and other services to create and manage APIs and services.
- Make sure you are in the directory where
- Deploy the proto descriptor file and the configuration file using the
gcloud endpoints services deploy api_descriptor.pb api_config.yaml
As it is creating and configuring the service, Service Management outputs a great deal of information to the terminal. On successful completion, you will see a line like the following that displays the service configuration ID and the service name:
Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
In the above example,
2017-02-13r0is the service configuration ID and
bookstore.endpoints.example-project.cloud.googis the service name. The service configuration ID consists of a date stamp followed by a revision number. If you deploy the Endpoints configuration again on the same day, the revision number is incremented in the service configuration ID.
If you get an error message, see Troubleshooting Endpoints Configuration Deployment.
See Deploying the Endpoints Configuration for additional information.
Deploying the API backend
So far you have deployed the service configuration to Service Management, but you have not yet deployed the code that will serve the API backend. This section walks you through creating a GKE cluster to host the API backend and deploying the API.
Creating a container cluster
To create a container cluster for our example:
- In the GCP Console, go to the Kubernetes clusters page.
Go to the Kubernetes clusters page
- Click Create cluster.
- Accept the default settings and click Create. Note the cluster name and zone, as you'll need them later in this tutorial.
Authenticating kubectl to the container cluster
kubectl to create and manager cluster resources, you need to get cluster credentials and make them available to
kubectl. To do this, invoke the following command, replacing
[NAME] with your new cluster name and
[ZONE] with its cluster zone. Do not include the square brackets.
gcloud container clusters get-credentials [NAME] --zone [ZONE]
Deploying the sample API and ESP to the cluster
To deploy the sample gRPC service to the cluster so that clients can use it:
- Save and open for editing a copy of the grpc-bookstore.yaml deployment manifest file.
SERVICE_NAMEwith the name of your Endpoints service. This is the same name that you configured in the
namefield in the
spec: containers: - name: esp image: gcr.io/endpoints-release/endpoints-runtime:1.16.0 args: [ "--http2_port=9000", "--service=SERVICE_NAME", "--rollout_strategy=managed", "--backend=grpc://127.0.0.1:8000" ] ports: - containerPort: 9000 - name: bookstore image: gcr.io/endpointsv2/python-grpc-bookstore-server:1 ports: - containerPort: 8000
--rollout_strategy=managed"option configures ESP to use the latest deployed service configuration. When you specify this option, within a minute after you deploy a new service configuration, ESP detects the change and automatically begins using it. We recommend that you specify this option instead of a specific configuration ID for ESP to use. For more details on the ESP arguments, see ESP Startup Options.
spec: containers: - name: esp image: gcr.io/endpoints-release/endpoints-runtime:1 args: [ "--http2_port=9000", "--service=bookstore.endpoints.example-project-12345.cloud.goog", "--rollout_strategy=managed", "--backend=grpc://127.0.0.1:8000" ]
- Start the service:
kubectl create -f grpc-bookstore.yaml
If you get an error message, see Troubleshooting Cloud Endpoints in Kubernetes Engine.
Getting the service's external IP address
You'll need the service's external IP address to send requests to the sample API. It can take a few minutes after you start your service in the container before the external IP address is ready.
To view the external IP address:
Invoke the command:
kubectl get service
Note the value for
EXTERNAL-IPand save it into a
SERVER_IPenvironment variable. We’ll use it when sending requests to the sample API.
Sending a request to the API
To send requests to the sample API, you can use a sample gRPC client written in Python.
Clone the git repo where the gRPC client code is hosted:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Change your working directory:
pip install virtualenv virtualenv env source env/bin/activate python -m pip install -r requirements.txt
Send a request to the sample API
python bookstore_client.py --host $SERVER_IP --port 80
Look at the activity graphs for your API in the Endpoints page.
View Endpoints activity graphs
It may take a few moments for the request to be reflected in the graphs.
- Look at the request logs for your API in the Logs Viewer page.
View Endpoints request logs
If you do not get a successful response, see Troubleshooting Response Errors.
You just deployed and tested an API in Cloud Endpoints!
To avoid incurring charges to your GCP account for the resources used in this quickstart:
Delete the API:
gcloud endpoints services delete [SERVICE_NAME]
Replace [SERVICE_NAME] with the name of your API. Do not include the square brackets.
Delete the Kubernetes cluster:
gcloud container clusters delete [NAME] --zone [ZONE]
[ZONE]with the name and zone of your Kubernetes cluster. Do not include the square brackets.