Skip to content

Commit 565230c

Browse files
authoredApr 9, 2019
Include instructions for deploying to Cloud Run
The Functions Framework is compatible with Knative-based environments like Cloud Run/Cloud Run on GKE. This PR updates the README to reflect that you can deploy your built functions to those environments.
1 parent 24e8dac commit 565230c

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed
 

‎README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ different environments, including:
88

99
* [Google Cloud Functions](https://cloud.google.com/functions/)
1010
* Your local development machine
11+
* [Cloud Run and Cloud Run on GKE](https://cloud.google.com/run/)
1112
* [Knative](https://github.com/knative/)-based environments
1213

1314
The framework allows you to go from:
@@ -125,10 +126,15 @@ After you've written your function, you can simply deploy it from your local
125126
machine using the `gcloud` command-line tool.
126127
[Check out the Cloud Functions quickstart](https://cloud.google.com/functions/docs/quickstart).
127128

129+
## Cloud Run/Cloud Run on GKE
130+
131+
Once you've written your function, added the Functions Framework and updated your `start` script in `package.json`, all that's left is to create a container image. [Check out the Cloud Run quickstart](https://cloud.google.com/run/docs/quickstarts/build-and-deploy) for Node.js to create a container image and deploy it to Cloud Run. You'll write a `Dockerfile` when you build your container. This `Dockerfile` allows you to specify exactly what goes into your container (including custom binaries, a specific operating system, and more).
132+
133+
If you want even more control over the environment, you can [deploy your container image to Cloud Run on GKE](https://cloud.google.com/run/docs/quickstarts/prebuilt-deploy-gke). With Cloud Run on GKE, you can run your function on a GKE cluster, which gives you additional control over the environment (including use of GPU-based instances, longer timeouts and more).
134+
128135
## Container environments based on Knative
129136

130-
The Functions Framework is designed to be compatible with Knative environments.
131-
Just build and deploy your container to a Knative environment.
137+
Cloud Run and Cloud Run on GKE both implement the [Knative Serving API](https://www.knative.dev/docs/). The Functions Framework is designed to be compatible with Knative environments. Just build and deploy your container to a Knative environment.
132138

133139
# Configure the Functions Framework
134140

0 commit comments

Comments
 (0)
Failed to load comments.