The Go Runtime
Overview
Your Cloud Function runs in an environment consisting of an operating system version plus add-on packages, language support, and the Functions Framework library that supports and invokes your function. This environment is identified by the language version, and is known as the runtime.
Cloud Functions supports the following Go runtimes:
- Go 1.20 (recommended)
- Go 1.19
- Go 1.18
- Go 1.16
- Go 1.13
- Go 1.11 (deprecated)
For information about runtimes in general, and to learn which Ubuntu version each Go runtime uses, see the Cloud Functions execution environment.
Select your runtime
You must specify a Go runtime to run your function when you deploy it. To specify your Go runtime:
gcloud
If you're using the Google Cloud CLI, specify the runtime
by using the --runtime
parameter with the Go runtime of your choice.
For example:
gcloud functions deploy FUNCTION_NAME --runtime go120 FLAGS...
FLAGS...
refers to arguments passed during the first
deployment of your function. For more information regarding required and
optional arguments, see
Deploy using the gcloud tool.
Console
If you're using the Google Cloud console, see the Google Cloud console quickstart for detailed instructions.
Function preparation
You can prepare a function directly from the Google Cloud console or write it on your local machine and upload it. To prepare your local machine for Go development, see Setting Up a Go Development Environment.
To get started quickly with Go on Cloud Functions, see the Quickstart.
Source code structure
For Cloud Functions to find your function's definition, your source code must follow a specific structure. See Writing Cloud Functions for more information.
Specifying dependencies
Cloud Functions in Go must provide all of their dependencies via either
Go modules with a go.mod
file, or a vendor
directory. For more information,
see Specifying dependencies in Go.
Environment variables
Your Go runtime automatically sets certain environment variables for your function to use as needed. For details, see Using Environment Variables.
Context
type
Go's context
package defines the Context
type, which carries deadlines, cancellation signals, and other request-scoped
values across API boundaries and between processes.
The following 2nd gen code shows an example of context access by a Pub/Sub client: