The Ruby 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 Ruby runtimes:

  • Ruby 3.2 (recommended)
  • Ruby 3.0
  • Ruby 2.7
  • Ruby 2.6

For information about runtimes in general, and to learn which Ubuntu version each Ruby runtime uses, see the Cloud Functions execution environment.

Select your runtime

You must specify a Ruby runtime to run your function when you deploy it. To specify your Ruby runtime:

gcloud

If you're using the Google Cloud CLI, specify the runtime by using the --runtime parameter. NAME specifies the function name. For example:

gcloud functions deploy NAME --runtime ruby32 --trigger-http

For more deployment parameters, see Deploy using the gcloud tool.

Console

If you're using the Google Cloud console, see the Google Cloud console quickstart for detailed instructions.

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.

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 Ruby development, see Setting up a Ruby development environment. The library that invokes your function is the Ruby Functions Framework.

Specifying dependencies

You can specify dependencies for your function by adding them to a project file. For more information, see Specifying dependencies in Ruby.

What's next